forked from Automattic/jetpack
-
Notifications
You must be signed in to change notification settings - Fork 0
/
functions.global.php
518 lines (464 loc) · 14.4 KB
/
functions.global.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
<?php
/**
* This file is meant to be the home for any generic & reusable functions
* that can be accessed anywhere within Jetpack.
*
* This file is loaded whether or not Jetpack is active.
*
* Please namespace with jetpack_
*
* @package Jetpack
*/
use Automattic\Jetpack\Connection\Client;
use Automattic\Jetpack\Device_Detection;
use Automattic\Jetpack\Redirect;
/**
* Disable direct access.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Hook into Core's _deprecated_function
* Add more details about when a deprecated function will be removed.
*
* @since 8.8.0
*
* @param string $function The function that was called.
* @param string $replacement Optional. The function that should have been called. Default null.
* @param string $version The version of Jetpack that deprecated the function.
*/
function jetpack_deprecated_function( $function, $replacement, $version ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
// Bail early for non-Jetpack deprecations.
if ( 0 !== strpos( $version, 'jetpack-' ) ) {
return;
}
// Look for when a function will be removed based on when it was deprecated.
$removed_version = jetpack_get_future_removed_version( $version );
// If we could find a version, let's log a message about when removal will happen.
if (
! empty( $removed_version )
&& ( defined( 'WP_DEBUG' ) && WP_DEBUG )
/** This filter is documented in core/src/wp-includes/functions.php */
&& apply_filters( 'deprecated_function_trigger_error', true )
) {
error_log( // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
sprintf(
/* Translators: 1. Function name. 2. Jetpack version number. */
__( 'The %1$s function will be removed from the Jetpack plugin in version %2$s.', 'jetpack' ),
$function,
$removed_version
)
);
}
}
add_action( 'deprecated_function_run', 'jetpack_deprecated_function', 10, 3 );
/**
* Hook into Core's _deprecated_file
* Add more details about when a deprecated file will be removed.
*
* @since 8.8.0
*
* @param string $file The file that was called.
* @param string $replacement The file that should have been included based on ABSPATH.
* @param string $version The version of WordPress that deprecated the file.
* @param string $message A message regarding the change.
*/
function jetpack_deprecated_file( $file, $replacement, $version, $message ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
// Bail early for non-Jetpack deprecations.
if ( 0 !== strpos( $version, 'jetpack-' ) ) {
return;
}
// Look for when a file will be removed based on when it was deprecated.
$removed_version = jetpack_get_future_removed_version( $version );
// If we could find a version, let's log a message about when removal will happen.
if (
! empty( $removed_version )
&& ( defined( 'WP_DEBUG' ) && WP_DEBUG )
/** This filter is documented in core/src/wp-includes/functions.php */
&& apply_filters( 'deprecated_file_trigger_error', true )
) {
error_log( // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
sprintf(
/* Translators: 1. File name. 2. Jetpack version number. */
__( 'The %1$s file will be removed from the Jetpack plugin in version %2$s.', 'jetpack' ),
$file,
$removed_version
)
);
}
}
add_action( 'deprecated_file_included', 'jetpack_deprecated_file', 10, 4 );
/**
* Get the major version number of Jetpack 6 months after provided version.
* Useful to indicate when a deprecated function will be removed from Jetpack.
*
* @since 8.8.0
*
* @param string $version The version of WordPress that deprecated the function.
*
* @return bool|float Return a Jetpack Major version number, or false.
*/
function jetpack_get_future_removed_version( $version ) {
/*
* Extract the version number from a deprecation notice.
* (let's only keep the first decimal, e.g. 8.8 and not 8.8.0)
*/
preg_match( '#(([0-9]+\.([0-9]+))(?:\.[0-9]+)*)#', $version, $matches );
if ( isset( $matches[2], $matches[3] ) ) {
$deprecated_version = (float) $matches[2];
$deprecated_minor = (float) $matches[3];
/*
* If the detected minor version number
* (e.g. "7" in "8.7")
* is higher than 9, we know the version number is malformed.
* Jetpack does not use semver yet.
* Bail.
*/
if ( 10 <= $deprecated_minor ) {
return false;
}
// We'll remove the function from the code 6 months later, thus 6 major versions later.
$removed_version = $deprecated_version + 0.6;
return (float) $removed_version;
}
return false;
}
/**
* Set the admin language, based on user language.
*
* @since 4.5.0
* @deprecated 6.6.0 Use Core function instead.
*
* @return string
*/
function jetpack_get_user_locale() {
_deprecated_function( __FUNCTION__, 'jetpack-6.6.0', 'get_user_locale' );
return get_user_locale();
}
/**
* Determine if this site is an Atomic site or not looking first at the 'at_options' option.
* As a fallback, check for presence of wpcomsh plugin to determine if a current site has undergone AT.
*
* @since 4.8.1
*
* @return bool
*/
function jetpack_is_atomic_site() {
$at_options = get_option( 'at_options', array() );
return ! empty( $at_options ) || defined( 'WPCOMSH__PLUGIN_FILE' );
}
/**
* Register post type for migration.
*
* @since 5.2
*/
function jetpack_register_migration_post_type() {
register_post_type(
'jetpack_migration',
array(
'supports' => array(),
'taxonomies' => array(),
'hierarchical' => false,
'public' => false,
'has_archive' => false,
'can_export' => true,
)
);
}
/**
* Stores migration data in the database.
*
* @since 5.2
*
* @param string $option_name Option name.
* @param bool $option_value Option value.
*
* @return int|WP_Error
*/
function jetpack_store_migration_data( $option_name, $option_value ) {
jetpack_register_migration_post_type();
$insert = array(
'post_title' => $option_name,
'post_content_filtered' => $option_value,
'post_type' => 'jetpack_migration',
'post_date' => gmdate( 'Y-m-d H:i:s', time() ),
);
$post = get_page_by_title( $option_name, 'OBJECT', 'jetpack_migration' );
if ( null !== $post ) {
$insert['ID'] = $post->ID;
}
return wp_insert_post( $insert, true );
}
/**
* Retrieves legacy image widget data.
*
* @since 5.2
*
* @param string $option_name Option name.
*
* @return mixed|null
*/
function jetpack_get_migration_data( $option_name ) {
$post = get_page_by_title( $option_name, 'OBJECT', 'jetpack_migration' );
return null !== $post ? maybe_unserialize( $post->post_content_filtered ) : null;
}
/**
* Prints a TOS blurb used throughout the connection prompts.
*
* @since 5.3
*
* @echo string
*/
function jetpack_render_tos_blurb() {
printf(
wp_kses(
/* Translators: placeholders are links. */
__( 'By clicking the <strong>Set up Jetpack</strong> button, you agree to our <a href="%1$s" target="_blank" rel="noopener noreferrer">Terms of Service</a> and to <a href="%2$s" target="_blank" rel="noopener noreferrer">share details</a> with WordPress.com.', 'jetpack' ),
array(
'a' => array(
'href' => array(),
'target' => array(),
'rel' => array(),
),
'strong' => true,
)
),
esc_url( Redirect::get_url( 'wpcom-tos' ) ),
esc_url( Redirect::get_url( 'jetpack-support-what-data-does-jetpack-sync' ) )
);
}
/**
* Intervene upgrade process so Jetpack themes are downloaded with credentials.
*
* @since 5.3
*
* @param bool $preempt Whether to preempt an HTTP request's return value. Default false.
* @param array $r HTTP request arguments.
* @param string $url The request URL.
*
* @return array|bool|WP_Error
*/
function jetpack_theme_update( $preempt, $r, $url ) {
if ( 0 === stripos( $url, JETPACK__WPCOM_JSON_API_BASE . '/rest/v1/themes/download' ) ) {
$file = $r['filename'];
if ( ! $file ) {
return new WP_Error( 'problem_creating_theme_file', esc_html__( 'Problem creating file for theme download', 'jetpack' ) );
}
$theme = pathinfo( wp_parse_url( $url, PHP_URL_PATH ), PATHINFO_FILENAME );
// Remove filter to avoid endless loop since wpcom_json_api_request_as_blog uses this too.
remove_filter( 'pre_http_request', 'jetpack_theme_update' );
$result = Client::wpcom_json_api_request_as_blog(
"themes/download/$theme.zip",
'1.1',
array(
'stream' => true,
'filename' => $file,
)
);
if ( 200 !== wp_remote_retrieve_response_code( $result ) ) {
return new WP_Error( 'problem_fetching_theme', esc_html__( 'Problem downloading theme', 'jetpack' ) );
}
return $result;
}
return $preempt;
}
/**
* Add the filter when a upgrade is going to be downloaded.
*
* @since 5.3
*
* @param bool $reply Whether to bail without returning the package. Default false.
*
* @return bool
*/
function jetpack_upgrader_pre_download( $reply ) {
add_filter( 'pre_http_request', 'jetpack_theme_update', 10, 3 );
return $reply;
}
add_filter( 'upgrader_pre_download', 'jetpack_upgrader_pre_download' );
/**
* Wraps data in a way so that we can distinguish between objects and array and also prevent object recursion.
*
* @since 6.1.0
*
* @param array|obj $any Source data to be cleaned up.
* @param array $seen_nodes Built array of nodes.
*
* @return array
*/
function jetpack_json_wrap( &$any, $seen_nodes = array() ) {
if ( is_object( $any ) ) {
$input = get_object_vars( $any );
$input['__o'] = 1;
} else {
$input = &$any;
}
if ( is_array( $input ) ) {
$seen_nodes[] = &$any;
$return = array();
foreach ( $input as $k => &$v ) {
if ( ( is_array( $v ) || is_object( $v ) ) ) {
if ( in_array( $v, $seen_nodes, true ) ) {
continue;
}
$return[ $k ] = jetpack_json_wrap( $v, $seen_nodes );
} else {
$return[ $k ] = $v;
}
}
return $return;
}
return $any;
}
/**
* Checks if the mime_content_type function is available and return it if so.
*
* The function mime_content_type is enabled by default in PHP, but can be disabled. We attempt to
* enforce this via composer.json, but that won't be checked in majority of cases where
* this would be happening.
*
* @since 7.8.0
*
* @param string $file File location.
*
* @return string|false MIME type or false if functionality is not available.
*/
function jetpack_mime_content_type( $file ) {
if ( function_exists( 'mime_content_type' ) ) {
return mime_content_type( $file );
}
return false;
}
/**
* Checks that the mime type of the specified file is among those in a filterable list of mime types.
*
* @since 7.8.0
*
* @param string $file Path to file to get its mime type.
*
* @return bool
*/
function jetpack_is_file_supported_for_sideloading( $file ) {
$type = jetpack_mime_content_type( $file );
if ( ! $type ) {
return false;
}
/**
* Filter the list of supported mime types for media sideloading.
*
* @since 4.0.0
*
* @module json-api
*
* @param array $supported_mime_types Array of the supported mime types for media sideloading.
*/
$supported_mime_types = apply_filters(
'jetpack_supported_media_sideload_types',
array(
'image/png',
'image/jpeg',
'image/gif',
'image/bmp',
'video/quicktime',
'video/mp4',
'video/mpeg',
'video/ogg',
'video/3gpp',
'video/3gpp2',
'video/h261',
'video/h262',
'video/h264',
'video/x-msvideo',
'video/x-ms-wmv',
'video/x-ms-asf',
)
);
// If the type returned was not an array as expected, then we know we don't have a match.
if ( ! is_array( $supported_mime_types ) ) {
return false;
}
return in_array( $type, $supported_mime_types, true );
}
/**
* Determine if the current User Agent matches the passed $kind
*
* @param string $kind Category of mobile device to check for.
* Either: any, dumb, smart.
* @param bool $return_matched_agent Boolean indicating if the UA should be returned.
*
* @return bool|string Boolean indicating if current UA matches $kind. If
* $return_matched_agent is true, returns the UA string
*/
function jetpack_is_mobile( $kind = 'any', $return_matched_agent = false ) {
/**
* Filter the value of jetpack_is_mobile before it is calculated.
*
* Passing a truthy value to the filter will short-circuit determining the
* mobile type, returning the passed value instead.
*
* @since 4.2.0
*
* @param bool|string $matches Boolean if current UA matches $kind or not. If
* $return_matched_agent is true, should return the UA string
* @param string $kind Category of mobile device being checked
* @param bool $return_matched_agent Boolean indicating if the UA should be returned
*/
$pre = apply_filters( 'pre_jetpack_is_mobile', null, $kind, $return_matched_agent );
if ( $pre ) {
return $pre;
}
$return = false;
$device_info = Device_Detection::get_info();
if ( 'any' === $kind ) {
$return = $device_info['is_phone'];
} elseif ( 'smart' === $kind ) {
$return = $device_info['is_smartphone'];
} elseif ( 'dumb' === $kind ) {
$return = $device_info['is_phone'] && ! $device_info['is_smartphone'];
}
if ( $return_matched_agent && true === $return ) {
$return = $device_info['is_phone_matched_ua'];
}
/**
* Filter the value of jetpack_is_mobile
*
* @since 4.2.0
*
* @param bool|string $matches Boolean if current UA matches $kind or not. If
* $return_matched_agent is true, should return the UA string
* @param string $kind Category of mobile device being checked
* @param bool $return_matched_agent Boolean indicating if the UA should be returned
*/
return apply_filters( 'jetpack_is_mobile', $return, $kind, $return_matched_agent );
}
/**
* Determine whether the current request is for accessing the frontend.
*
* @return bool True if it's a frontend request, false otherwise.
*/
function jetpack_is_frontend() {
$is_frontend = true;
if (
is_admin() ||
wp_doing_ajax() ||
wp_doing_cron() ||
wp_is_json_request() ||
wp_is_jsonp_request() ||
wp_is_xml_request() ||
is_feed() ||
( defined( 'REST_REQUEST' ) && REST_REQUEST ) ||
( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST ) ||
( defined( 'WP_CLI' ) && WP_CLI )
) {
$is_frontend = false;
}
/**
* Filter whether the current request is for accessing the frontend.
*
* @since 9.0.0
*
* @param bool $is_frontend Whether the current request is for accessing the frontend.
*/
return (bool) apply_filters( 'jetpack_is_frontend', $is_frontend );
}