wpgetapi / lib / cmb2 / includes / CMB2_Ajax.php

CMB2_Ajax.php in WPGet API – Connect to any external REST API 1.4.6, at lib/cmb2/includes/CMB2_Ajax.php

324 lines 9.0 KB

Raw Download Zip

1	<?php
2
3	/**
4	* CMB2 ajax methods
5	* (i.e. a lot of work to get oEmbeds to work with non-post objects)
6	*
7	* @since 0.9.5
8	*
9	* @category WordPress_Plugin
10	* @package CMB2
11	* @author CMB2 team
12	* @license GPL-2.0+
13	*/
14	class CMB2_Ajax {
15
16	// Whether to hijack the oembed cache system.
17	protected $hijack = false;
18	protected $object_id = 0;
19	protected $embed_args = array();
20	protected $object_type = 'post';
21	protected $ajax_update = false;
22
23	/**
24	* Instance of this class.
25	*
26	* @since 2.2.2
27	* @var object
28	*/
29	protected static $instance;
30
31	/**
32	* Get the singleton instance of this class.
33	*
34	* @since 2.2.2
35	* @return CMB2_Ajax
36	*/
37	public static function get_instance() {
38	if ( ! ( self::$instance instanceof self ) ) {
39	self::$instance = new self();
40	}
41
42	return self::$instance;
43	}
44
45	/**
46	* Constructor
47	*
48	* @since 2.2.0
49	*/
50	protected function __construct() {
51	add_action( 'wp_ajax_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
52	add_action( 'wp_ajax_nopriv_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
53	// Need to occasionally clean stale oembed cache data from the option value.
54	add_action( 'cmb2_save_options-page_fields', array( __CLASS__, 'clean_stale_options_page_oembeds' ) );
55	}
56
57	/**
58	* Handles our oEmbed ajax request
59	*
60	* @since 0.9.5
61	* @return mixed oEmbed embed code \| fallback \| error message
62	*/
63	public function oembed_handler() {
64
65	// Verify our nonce.
66	if ( ! ( isset( $_REQUEST['cmb2_ajax_nonce'], $_REQUEST['oembed_url'] ) && wp_verify_nonce( $_REQUEST['cmb2_ajax_nonce'], 'ajax_nonce' ) ) ) {
67	die();
68	}
69
70	// Sanitize our search string.
71	$oembed_string = sanitize_text_field( $_REQUEST['oembed_url'] );
72
73	// Send back error if empty.
74	if ( empty( $oembed_string ) ) {
75	wp_send_json_error( '<p class="ui-state-error-text">' . esc_html__( 'Please Try Again', 'cmb2' ) . '</p>' );
76	}
77
78	// Set width of embed.
79	$embed_width = isset( $_REQUEST['oembed_width'] ) && intval( $_REQUEST['oembed_width'] ) < 640 ? intval( $_REQUEST['oembed_width'] ) : '640';
80
81	// Set url.
82	$oembed_url = esc_url( $oembed_string );
83
84	// Set args.
85	$embed_args = array(
86	'width' => $embed_width,
87	);
88
89	$this->ajax_update = true;
90
91	// Get embed code (or fallback link).
92	$html = $this->get_oembed( array(
93	'url' => $oembed_url,
94	'object_id' => $_REQUEST['object_id'],
95	'object_type' => isset( $_REQUEST['object_type'] ) ? $_REQUEST['object_type'] : 'post',
96	'oembed_args' => $embed_args,
97	'field_id' => $_REQUEST['field_id'],
98	) );
99
100	wp_send_json_success( $html );
101	}
102
103	/**
104	* Retrieves oEmbed from url/object ID
105	*
106	* @since 0.9.5
107	* @param array $args Arguments for method.
108	* @return mixed HTML markup with embed or fallback.
109	*/
110	public function get_oembed_no_edit( $args ) {
111	global $wp_embed;
112
113	$oembed_url = esc_url( $args['url'] );
114
115	// Sanitize object_id.
116	$this->object_id = is_numeric( $args['object_id'] ) ? absint( $args['object_id'] ) : sanitize_text_field( $args['object_id'] );
117
118	$args = wp_parse_args( $args, array(
119	'object_type' => 'post',
120	'oembed_args' => array(),
121	'field_id' => false,
122	'wp_error' => false,
123	) );
124
125	$this->embed_args =& $args;
126
127	/*
128	* Set the post_ID so oEmbed won't fail
129	* wp-includes/class-wp-embed.php, WP_Embed::shortcode()
130	*/
131	$wp_embed->post_ID = $this->object_id;
132
133	// Special scenario if NOT a post object.
134	if ( isset( $args['object_type'] ) && 'post' != $args['object_type'] ) {
135
136	if ( 'options-page' == $args['object_type'] ) {
137
138	// Bogus id to pass some numeric checks. Issue with a VERY large WP install?
139	$wp_embed->post_ID = 1987645321;
140	}
141
142	// Ok, we need to hijack the oembed cache system.
143	$this->hijack = true;
144	$this->object_type = $args['object_type'];
145
146	// Gets ombed cache from our object's meta (vs postmeta).
147	add_filter( 'get_post_metadata', array( $this, 'hijack_oembed_cache_get' ), 10, 3 );
148
149	// Sets ombed cache in our object's meta (vs postmeta).
150	add_filter( 'update_post_metadata', array( $this, 'hijack_oembed_cache_set' ), 10, 4 );
151
152	}
153
154	$embed_args = '';
155
156	foreach ( $args['oembed_args'] as $key => $val ) {
157	$embed_args .= " $key=\"$val\"";
158	}
159
160	// Ping WordPress for an embed.
161	$embed = $wp_embed->run_shortcode( '[embed' . $embed_args . ']' . $oembed_url . '[/embed]' );
162
163	// Fallback that WordPress creates when no oEmbed was found.
164	$fallback = $wp_embed->maybe_make_link( $oembed_url );
165
166	return compact( 'embed', 'fallback', 'args' );
167	}
168
169	/**
170	* Retrieves oEmbed from url/object ID
171	*
172	* @since 0.9.5
173	* @param array $args Arguments for method.
174	* @return string HTML markup with embed or fallback.
175	*/
176	public function get_oembed( $args ) {
177	$oembed = $this->get_oembed_no_edit( $args );
178
179	// Send back our embed.
180	if ( $oembed['embed'] && $oembed['embed'] != $oembed['fallback'] ) {
181	return '<div class="cmb2-oembed embed-status">' . $oembed['embed'] . '<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button" rel="' . $oembed['args']['field_id'] . '">' . esc_html__( 'Remove Embed', 'cmb2' ) . '</a></p></div>';
182	}
183
184	// Otherwise, send back error info that no oEmbeds were found.
185	return sprintf(
186	'<p class="ui-state-error-text">%s</p>',
187	sprintf(
188	/* translators: 1: results for. 2: link to codex.wordpress.org/Embeds */
189	esc_html__( 'No oEmbed Results Found for %1$s. View more info at %2$s.', 'cmb2' ),
190	$oembed['fallback'],
191	'<a href="https://wordpress.org/support/article/embeds/" target="_blank">codex.wordpress.org/Embeds</a>'
192	)
193	);
194	}
195
196	/**
197	* Hijacks retrieving of cached oEmbed.
198	* Returns cached data from relevant object metadata (vs postmeta)
199	*
200	* @since 0.9.5
201	* @param boolean $check Whether to retrieve postmeta or override.
202	* @param int $object_id Object ID.
203	* @param string $meta_key Object metakey.
204	* @return mixed Object's oEmbed cached data.
205	*/
206	public function hijack_oembed_cache_get( $check, $object_id, $meta_key ) {
207	if ( ! $this->hijack \|\| ( $this->object_id != $object_id && 1987645321 !== $object_id ) ) {
208	return $check;
209	}
210
211	if ( $this->ajax_update ) {
212	return false;
213	}
214
215	return $this->cache_action( $meta_key );
216	}
217
218	/**
219	* Hijacks saving of cached oEmbed.
220	* Saves cached data to relevant object metadata (vs postmeta)
221	*
222	* @since 0.9.5
223	* @param boolean $check Whether to continue setting postmeta.
224	* @param int $object_id Object ID to get postmeta from.
225	* @param string $meta_key Postmeta's key.
226	* @param mixed $meta_value Value of the postmeta to be saved.
227	* @return boolean Whether to continue setting.
228	*/
229	public function hijack_oembed_cache_set( $check, $object_id, $meta_key, $meta_value ) {
230
231	if (
232	! $this->hijack
233	\|\| ( $this->object_id != $object_id && 1987645321 !== $object_id )
234	// Only want to hijack oembed meta values.
235	\|\| 0 !== strpos( $meta_key, '_oembed_' )
236	) {
237	return $check;
238	}
239
240	$this->cache_action( $meta_key, $meta_value );
241
242	// Anything other than `null` to cancel saving to postmeta.
243	return true;
244	}
245
246	/**
247	* Gets/updates the cached oEmbed value from/to relevant object metadata (vs postmeta).
248	*
249	* @since 1.3.0
250	*
251	* @param string $meta_key Postmeta's key.
252	* @return mixed
253	*/
254	protected function cache_action( $meta_key ) {
255	$func_args = func_get_args();
256	$action = isset( $func_args[1] ) ? 'update' : 'get';
257
258	if ( 'options-page' === $this->object_type ) {
259
260	$args = array( $meta_key );
261
262	if ( 'update' === $action ) {
263	$args[] = $func_args[1];
264	$args[] = true;
265	}
266
267	// Cache the result to our options.
268	$status = call_user_func_array( array( cmb2_options( $this->object_id ), $action ), $args );
269	} else {
270
271	$args = array( $this->object_type, $this->object_id, $meta_key );
272	$args[] = 'update' === $action ? $func_args[1] : true;
273
274	// Cache the result to our metadata.
275	$status = call_user_func_array( $action . '_metadata', $args );
276	}
277
278	return $status;
279	}
280
281	/**
282	* Hooks in when options-page data is saved to clean stale
283	* oembed cache data from the option value.
284	*
285	* @since 2.2.0
286	* @param string $option_key The options-page option key.
287	* @return void
288	*/
289	public static function clean_stale_options_page_oembeds( $option_key ) {
290	$options = cmb2_options( $option_key )->get_options();
291	$modified = false;
292	if ( is_array( $options ) ) {
293
294	$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, '', array(), 0 );
295	$now = time();
296
297	foreach ( $options as $key => $value ) {
298	// Check for cached oembed data.
299	if ( 0 === strpos( $key, '_oembed_time_' ) ) {
300	$cached_recently = ( $now - $value ) < $ttl;
301
302	if ( ! $cached_recently ) {
303	$modified = true;
304	// Remove the the cached ttl expiration, and the cached oembed value.
305	unset( $options[ $key ] );
306	unset( $options[ str_replace( '_oembed_time_', '_oembed_', $key ) ] );
307	}
308	} // End if.
309	// Remove the cached unknown values.
310	elseif ( '{{unknown}}' === $value ) {
311	$modified = true;
312	unset( $options[ $key ] );
313	}
314	}
315	}
316
317	// Update the option and remove stale cache data.
318	if ( $modified ) {
319	$updated = cmb2_options( $option_key )->set( $options );
320	}
321	}
322
323	}
324