class-give-db-meta.php — GiveWP – Donation Plugin and Fundraising Platform 2.4.5

give / includes / class-give-db-meta.php

give / includes Last commit date

class-give-db-meta.php

546 lines

1	<?php
2	/**
3	* Give DB Meta
4	*
5	* @package Give
6	* @subpackage Classes/Give_DB_Meta
7	* @copyright Copyright (c) 2017, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 2.0
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17	class Give_DB_Meta extends Give_DB {
18	/**
19	* Post type
20	*
21	* @since 2.0
22	* @access protected
23	* @var bool
24	*/
25	protected $post_type = '';
26
27	/**
28	* Meta type
29	*
30	* @since 2.0
31	* @access protected
32	* @var bool
33	*/
34	protected $meta_type = '';
35
36	/**
37	* Flag to handle result type
38	*
39	* @since 2.0
40	* @access protected
41	*/
42	protected $raw_result = false;
43
44	/**
45	* Flag for short circuit of meta function
46	*
47	* @since 2.0
48	* @access protected
49	*/
50	protected $check = false;
51
52
53	/**
54	* Meta supports.
55	*
56	* @since 2.0
57	* @access protected
58	* @var array
59	*/
60	protected $supports = array(
61	'add_post_metadata',
62	'get_post_metadata',
63	'update_post_metadata',
64	'delete_post_metadata',
65	'posts_where',
66	'posts_join',
67	'posts_groupby',
68	'posts_orderby'
69	);
70
71	/**
72	* Give_DB_Meta constructor.
73	*
74	* @since 2.0
75	*/
76	function __construct() {
77	parent::__construct();
78
79	// Bailout.
80	if ( empty( $this->supports ) \|\| ! $this->is_custom_meta_table_active() ) {
81	return;
82	}
83
84	if ( in_array( 'add_post_metadata', $this->supports ) ) {
85	add_filter( 'add_post_metadata', array( $this, '__add_meta' ), 0, 5 );
86	}
87
88	if ( in_array( 'get_post_metadata', $this->supports ) ) {
89	add_filter( 'get_post_metadata', array( $this, '__get_meta' ), 10, 4 );
90	}
91
92	if ( in_array( 'update_post_metadata', $this->supports ) ) {
93	add_filter( 'update_post_metadata', array( $this, '__update_meta' ), 0, 5 );
94	}
95
96	if ( in_array( 'delete_post_metadata', $this->supports ) ) {
97	add_filter( 'delete_post_metadata', array( $this, '__delete_meta' ), 0, 5 );
98	}
99
100	if ( in_array( 'posts_where', $this->supports ) ) {
101	add_filter( 'posts_where', array( $this, '__rename_meta_table_name_in_query' ), 99999, 2 );
102	}
103
104	if ( in_array( 'posts_join', $this->supports ) ) {
105	add_filter( 'posts_join', array( $this, '__rename_meta_table_name_in_query' ), 99999, 2 );
106	}
107
108	if ( in_array( 'posts_groupby', $this->supports ) ) {
109	add_filter( 'posts_groupby', array( $this, '__rename_meta_table_name_in_query' ), 99999, 2 );
110	}
111
112	if ( in_array( 'posts_orderby', $this->supports ) ) {
113	add_filter( 'posts_orderby', array( $this, '__rename_meta_table_name_in_query' ), 99999, 2 );
114	}
115	}
116
117
118	/**
119	* Retrieve payment meta field for a payment.
120	*
121	* @access public
122	* @since 2.0
123	*
124	* @param int $id Pst Type ID.
125	* @param string $meta_key The meta key to retrieve.
126	* @param bool $single Whether to return a single value.
127	*
128	* @return mixed Will be an array if $single is false. Will be value of meta data field if $single
129	* is true.
130	*/
131	public function get_meta( $id = 0, $meta_key = '', $single = false ) {
132	$id = $this->sanitize_id( $id );
133
134	// Bailout.
135	if ( ! $this->is_valid_post_type( $id ) ) {
136	return $this->check;
137	}
138
139	if ( $this->raw_result ) {
140	if ( ! ( $value = get_metadata( $this->meta_type, $id, $meta_key, false ) ) ) {
141	$value = '';
142	}
143
144	// Reset flag.
145	$this->raw_result = false;
146
147	} else {
148	$value = get_metadata( $this->meta_type, $id, $meta_key, $single );
149	}
150
151	return $value;
152	}
153
154
155	/**
156	* Add meta data field to a payment.
157	*
158	* For internal use only. Use Give_Payment->add_meta() for public usage.
159	*
160	* @access private
161	* @since 2.0
162	*
163	* @param int $id Post Type ID.
164	* @param string $meta_key Metadata name.
165	* @param mixed $meta_value Metadata value.
166	* @param bool $unique Optional, default is false. Whether the same key should not be added.
167	*
168	* @return int\|bool False for failure. True for success.
169	*/
170	public function add_meta( $id = 0, $meta_key = '', $meta_value, $unique = false ) {
171	$id = $this->sanitize_id( $id );
172
173	// Bailout.
174	if ( ! $this->is_valid_post_type( $id ) ) {
175	return $this->check;
176	}
177
178	$meta_id = add_metadata( $this->meta_type, $id, $meta_key, $meta_value, $unique );
179
180	if ( $meta_id ) {
181	$this->delete_cache( $id );
182	}
183
184	return $meta_id;
185	}
186
187	/**
188	* Update payment meta field based on Post Type ID.
189	*
190	* For internal use only. Use Give_Payment->update_meta() for public usage.
191	*
192	* Use the $prev_value parameter to differentiate between meta fields with the
193	* same key and Post Type ID.
194	*
195	* If the meta field for the payment does not exist, it will be added.
196	*
197	* @access public
198	* @since 2.0
199	*
200	* @param int $id Post Type ID.
201	* @param string $meta_key Metadata key.
202	* @param mixed $meta_value Metadata value.
203	* @param mixed $prev_value Optional. Previous value to check before removing.
204	*
205	* @return int\|bool False on failure, true if success.
206	*/
207	public function update_meta( $id = 0, $meta_key = '', $meta_value, $prev_value = '' ) {
208	$id = $this->sanitize_id( $id );
209
210	// Bailout.
211	if ( ! $this->is_valid_post_type( $id ) ) {
212	return $this->check;
213	}
214
215	$meta_id = update_metadata( $this->meta_type, $id, $meta_key, $meta_value, $prev_value );
216
217	if ( $meta_id ) {
218	$this->delete_cache( $id );
219	}
220
221	return $meta_id;
222	}
223
224	/**
225	* Remove metadata matching criteria from a payment.
226	*
227	* You can match based on the key, or key and value. Removing based on key and
228	* value, will keep from removing duplicate metadata with the same key. It also
229	* allows removing all metadata matching key, if needed.
230	*
231	* @access public
232	* @since 2.0
233	*
234	* @param int $id Post Type ID.
235	* @param string $meta_key Metadata name.
236	* @param mixed $meta_value Optional. Metadata value.
237	* @param mixed $delete_all Optional.
238	*
239	* @return bool False for failure. True for success.
240	*/
241	public function delete_meta( $id = 0, $meta_key = '', $meta_value = '', $delete_all = '' ) {
242	$id = $this->sanitize_id( $id );
243
244	// Bailout.
245	if ( ! $this->is_valid_post_type( $id ) ) {
246	return $this->check;
247	}
248
249	$is_meta_deleted = delete_metadata( $this->meta_type, $id, $meta_key, $meta_value, $delete_all );
250
251	if ( $is_meta_deleted ) {
252	$this->delete_cache( $id );
253	}
254
255	return $is_meta_deleted;
256	}
257
258	/**
259	* Rename query clauses of every query for new meta table
260	*
261	* @since 2.0
262	* @access public
263	*
264	* @param string $clause
265	* @param WP_Query $wp_query
266	*
267	* @return string
268	*/
269	public function __rename_meta_table_name_in_query( $clause, $wp_query ) {
270	// Add new table to sql query.
271	if ( $this->is_post_type_query( $wp_query ) && ! empty( $wp_query->meta_query->queries ) ) {
272	$clause = $this->__rename_meta_table_name( $clause, current_filter() );
273	}
274
275	return $clause;
276	}
277
278
279	/**
280	* Rename query clauses for new meta table
281	*
282	* @param $clause
283	* @param $filter
284	*
285	* @return mixed
286	*/
287	public function __rename_meta_table_name( $clause, $filter ) {
288	global $wpdb;
289
290	$clause = str_replace( "{$wpdb->postmeta}.post_id", "{$this->table_name}.{$this->meta_type}_id", $clause );
291	$clause = str_replace( $wpdb->postmeta, $this->table_name, $clause );
292
293	switch ( $filter ) {
294	case 'posts_join':
295	$joins = array( 'INNER JOIN', 'LEFT JOIN' );
296
297	foreach ( $joins as $join ) {
298	if ( false !== strpos( $clause, $join ) ) {
299	$clause = explode( $join, $clause );
300
301	foreach ( $clause as $key => $clause_part ) {
302	if ( empty( $clause_part ) ) {
303	continue;
304	}
305
306	preg_match( '/' . $wpdb->prefix . 'give_' . $this->meta_type . 'meta AS (.*) ON/', $clause_part, $alias_table_name );
307
308	if ( isset( $alias_table_name[1] ) ) {
309	$clause[ $key ] = str_replace( "{$alias_table_name[1]}.post_id", "{$alias_table_name[1]}.{$this->meta_type}_id", $clause_part );
310	}
311	}
312
313	$clause = implode( "{$join} ", $clause );
314	}
315	}
316	break;
317
318	case 'posts_where':
319	$clause = str_replace( array( 'mt2.post_id', 'mt1.post_id' ), array(
320	"mt2.{$this->meta_type}_id",
321	"mt1.{$this->meta_type}_id"
322	), $clause );
323	break;
324	}
325
326	return $clause;
327	}
328
329
330	/**
331	* Check if current query for post type or not.
332	*
333	* @since 2.0
334	* @access protected
335	*
336	* @param WP_Query $wp_query
337	*
338	* @return bool
339	*/
340	protected function is_post_type_query( $wp_query ) {
341	$status = false;
342
343	// Check if it is payment query.
344	if ( ! empty( $wp_query->query['post_type'] ) ) {
345	if (
346	is_string( $wp_query->query['post_type'] ) &&
347	$this->post_type === $wp_query->query['post_type']
348	) {
349	$status = true;
350	} elseif (
351	is_array( $wp_query->query['post_type'] ) &&
352	1 === count( $wp_query->query['post_type'] ) &&
353	in_array( $this->post_type, $wp_query->query['post_type'] )
354	) {
355	$status = true;
356	}
357	}
358
359	return $status;
360	}
361
362	/**
363	* Check if current id of post type or not
364	*
365	* @since 2.0
366	* @access protected
367	*
368	* @param $ID
369	*
370	* @return bool
371	*/
372	protected function is_valid_post_type( $ID ) {
373	return $ID && ( $this->post_type === get_post_type( $ID ) );
374	}
375
376	/**
377	* check if custom meta table enabled or not.
378	*
379	* @since 2.0
380	* @access protected
381	* @return bool
382	*/
383	protected function is_custom_meta_table_active() {
384	return false;
385	}
386
387
388	/**
389	* Update last_changed key
390	*
391	* @since 2.0
392	* @access private
393	*
394	* @param int $id
395	* @param string $meta_type
396	*
397	* @return void
398	*/
399	private function delete_cache( $id, $meta_type = '' ) {
400	$meta_type = empty( $meta_type ) ? $this->meta_type : $meta_type;
401
402	$group = array(
403	'payment' => 'give-donations', // Backward compatibility
404	'donation' => 'give-donations',
405	'donor' => 'give-donors',
406	'customer' => 'give-donors', // Backward compatibility for pre upgrade in 2.0
407	);
408
409	if ( array_key_exists( $meta_type, $group ) ) {
410	Give_Cache::delete_group( $id, $group[ $meta_type ] );
411	}
412	}
413
414	/**
415	* Add support for hidden functions.
416	*
417	* @since 2.0
418	* @access public
419	*
420	* @param $name
421	* @param $arguments
422	*
423	* @return mixed
424	*/
425	public function __call( $name, $arguments ) {
426	switch ( $name ) {
427	case '__add_meta':
428	$this->check = $arguments[0];
429	$id = $arguments[1];
430	$meta_key = $arguments[2];
431	$meta_value = $arguments[3];
432	$unique = $arguments[4];
433
434	// Bailout.
435	if ( ! $this->is_valid_post_type( $id ) ) {
436	return $this->check;
437	}
438
439	return $this->add_meta( $id, $meta_key, $meta_value, $unique );
440
441	case '__get_meta':
442	$this->check = $arguments[0];
443	$id = $arguments[1];
444	$meta_key = $arguments[2];
445	$single = $arguments[3];
446
447	// Bailout.
448	if ( ! $this->is_valid_post_type( $id ) ) {
449	return $this->check;
450	}
451
452	$this->raw_result = true;
453
454	return $this->get_meta( $id, $meta_key, $single );
455
456	case '__update_meta':
457	$this->check = $arguments[0];
458	$id = $arguments[1];
459	$meta_key = $arguments[2];
460	$meta_value = $arguments[3];
461
462	// Bailout.
463	if ( ! $this->is_valid_post_type( $id ) ) {
464	return $this->check;
465	}
466
467	return $this->update_meta( $id, $meta_key, $meta_value );
468
469	case '__delete_meta':
470	$this->check = $arguments[0];
471	$id = $arguments[1];
472	$meta_key = $arguments[2];
473	$meta_value = $arguments[3];
474	$delete_all = $arguments[3];
475
476	// Bailout.
477	if ( ! $this->is_valid_post_type( $id ) ) {
478	return $this->check;
479	}
480
481	return $this->delete_meta( $id, $meta_key, $meta_value, $delete_all );
482	}
483	}
484
485	/**
486	* Create Meta Tables.
487	*
488	* @since 2.0.1
489	* @access public
490	*/
491	public function create_table() {
492	global $wpdb;
493
494	$charset_collate = $wpdb->get_charset_collate();
495
496	$sql = "CREATE TABLE {$this->table_name} (
497	meta_id bigint(20) NOT NULL AUTO_INCREMENT,
498	{$this->meta_type}_id bigint(20) NOT NULL,
499	meta_key varchar(255) DEFAULT NULL,
500	meta_value longtext,
501	PRIMARY KEY (meta_id),
502	KEY {$this->meta_type}_id ({$this->meta_type}_id),
503	KEY meta_key (meta_key({$this->min_index_length}))
504	) {$charset_collate};";
505
506	require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
507	dbDelta( $sql );
508
509	update_option( $this->table_name . '_db_version', $this->version, false );
510	}
511
512
513	/**
514	* Get meta type
515	*
516	* @since 2.0.4
517	* @access public
518	*
519	* @return string
520	*/
521	public function get_meta_type() {
522	return $this->meta_type;
523	}
524
525	/**
526	* Remove all meta data matching criteria from a meta table.
527	*
528	* @since 2.1.3
529	* @access public
530	*
531	* @param int $id ID.
532	*
533	* @return bool False for failure. True for success.
534	*/
535	public function delete_all_meta( $id = 0 ) {
536	global $wpdb;
537	$status = $wpdb->delete( $this->table_name, array( "{$this->meta_type}_id" => $id ), array( '%d' ) );
538
539	if ( $status ) {
540	$this->delete_cache( $id, $this->meta_type );
541	}
542
543	return $status;
544	}
545	}
546