give / includes / database / class-give-db-sessions.php

class-give-db-sessions.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at includes/database/class-give-db-sessions.php

249 lines 5.2 KB

Raw Download Zip

1	<?php
2	/**
3	* Session Database Handler
4	*
5	* @package Give
6	* @subpackage Classes/Give_Session
7	* @copyright Copyright (c) 2018, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 2.2.0
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17	/**
18	* Class Give_DB_Sessions
19	*/
20	class Give_DB_Sessions extends Give_DB {
21	/**
22	* Cache group name
23	*
24	* @since 2.2.0
25	* @access private
26	*
27	* @var string
28	*/
29	private $cache_group = 'give_sessions';
30
31	/**
32	* Cache incrementer name
33	*
34	* @since 2.2.0
35	* @access private
36	*
37	* @var string
38	*/
39	private $incrementer_name = 'give_sessions';
40
41
42	/**
43	* Class Constructor
44	*
45	* @since 2.2.0
46	* @access public
47	*/
48	public function __construct() {
49	global $wpdb;
50	$this->table_name = "{$wpdb->prefix}give_sessions";
51	$this->primary_key = 'session_key';
52	$this->version = '1.0';
53
54	// Set cache group id.
55	$current_blog_id = get_current_blog_id();
56	$this->incrementer_name = "give-cache-incrementer-sessions-{$current_blog_id}";
57	$incrementer_value = wp_cache_get( $this->incrementer_name );
58	$incrementer_value = ! empty( $incrementer_value ) ? $incrementer_value : microtime( true );
59	$this->cache_group = "{$this->cache_group}_{$current_blog_id}_{$incrementer_value}";
60
61	parent::__construct();
62	}
63
64
65	/**
66	* Whitelist of columns
67	*
68	* @since 2.2.0
69	* @access public
70	*
71	* @return array Columns and formats.
72	*/
73	public function get_columns() {
74	return array(
75	'session_id' => '%d',
76	'session_key' => '%s',
77	'session_value' => '%s',
78	'session_expiry' => '%d',
79	);
80	}
81
82	/**
83	* Create Meta Tables.
84	*
85	* @since 2.2.0
86	* @access public
87	*/
88	public function create_table() {
89	global $wpdb;
90
91	$charset_collate = $wpdb->get_charset_collate();
92
93	$sql = "CREATE TABLE {$this->table_name} (
94	session_id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
95	session_key char(32) NOT NULL,
96	session_value longtext NOT NULL,
97	session_expiry BIGINT UNSIGNED NOT NULL,
98	PRIMARY KEY (session_key),
99	UNIQUE KEY session_id (session_id)
100	) {$charset_collate};";
101
102	require_once ABSPATH . 'wp-admin/includes/upgrade.php';
103	dbDelta( $sql );
104
105	update_option( $this->table_name . '_db_version', $this->version, false );
106	}
107
108
109	/**
110	* Returns the session.
111	*
112	* @todo: add cache logic
113	*
114	* @since 4.16.7.2 Restrict unserialize to prevent object instantiation.
115	* @param string $donor_id Donor ID.
116	* @param mixed $default Default session value.
117	*
118	* @return mixed
119	*/
120	public function get_session( $donor_id, $default = false ) {
121	global $wpdb;
122
123	if ( defined( 'WP_SETUP_CONFIG' ) ) {
124	return false;
125	}
126
127	if ( ! ( $value = wp_cache_get( $donor_id, $this->cache_group ) ) ) { // @codingStandardsIgnoreLine
128
129	// @codingStandardsIgnoreStart
130	$value = $wpdb->get_var(
131	$wpdb->prepare(
132	"
133	SELECT session_value
134	FROM $this->table_name
135	WHERE session_key = %s
136	",
137	$donor_id
138	)
139	);
140	// @codingStandardsIgnoreEnd
141
142	if ( is_null( $value ) ) {
143	$value = $default;
144	}
145
146	wp_cache_add( $donor_id, $value, $this->cache_group );
147	}
148
149	return is_serialized( $value ) ? unserialize( $value, [ 'allowed_classes' => false ] ) : $value;
150	}
151
152	/**
153	* Update the session expiry timestamp.
154	*
155	* @param string $donor_id Donor ID.
156	* @param int $timestamp Timestamp to expire the cookie.
157	*/
158	public function update_session_timestamp( $donor_id, $timestamp ) {
159	global $wpdb;
160
161	// @codingStandardsIgnoreStart.
162	$wpdb->update(
163	$this->table_name,
164	array(
165	'session_expiry' => $timestamp,
166	),
167	array(
168	'session_key' => $donor_id,
169	),
170	array(
171	'%d'
172	)
173	);
174	// @codingStandardsIgnoreEnd.
175	}
176
177	/**
178	* Delete the session from the cache and database.
179	*
180	* @since 2.2.0
181	* @access public
182	*
183	* @param int $donor_id Customer ID.
184	*/
185	public function delete_session( $donor_id ) {
186	global $wpdb;
187
188	wp_cache_delete( $donor_id, $this->cache_group );
189
190	// @codingStandardsIgnoreStart
191	$wpdb->delete(
192	$this->table_name,
193	array(
194	'session_key' => $donor_id,
195	)
196	);
197	// @codingStandardsIgnoreEnd
198	}
199
200
201	/**
202	* Cleanup session data from the database and clear caches.
203	* Note: for internal logic only.
204	*
205	* @since 2.2.0
206	* @access public
207	*/
208	public function delete_expired_sessions() {
209	global $wpdb;
210
211	wp_cache_set( $this->incrementer_name, microtime( true ) );
212
213	// @codingStandardsIgnoreStart
214	$wpdb->query(
215	$wpdb->prepare(
216	"DELETE FROM $this->table_name WHERE session_expiry < %d",
217	time()
218	)
219	);
220	// @codingStandardsIgnoreEnd
221	}
222
223	/**
224	* Replace table data
225	* Note: only for internal use
226	*
227	* @since 4.9.0 rename function - PHP 8 compatibility
228	* @since 2.2.0
229	* @access public
230	*
231	* @param string $table_name Table name.
232	* @param array $data Data.
233	* @param array $format Array for data format of each key:value in data.
234	*/
235	public function replace( $table_name, $data, $format = null ) {
236	global $wpdb;
237
238	wp_cache_set( $data['session_key'], $data['session_value'], $this->cache_group, $data['session_expiry'] - time() );
239
240	// @codingStandardsIgnoreStart
241	$wpdb->replace(
242	$table_name,
243	$data,
244	$format
245	);
246	// @codingStandardsIgnoreEnd
247	}
248	}
249