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