Completed
Push — add/15653-imgcmp-amp ( 14b0d6...199648 )
by
unknown
74:44 queued 68:27
created

Actions::should_initialize_sender_enqueue()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 0
dl 0
loc 7
rs 10
c 0
b 0
f 0
1
<?php
2
/**
3
 * A class that defines syncable actions for Jetpack.
4
 *
5
 * @package automattic/jetpack-sync
6
 */
7
8
namespace Automattic\Jetpack\Sync;
9
10
use Automattic\Jetpack\Connection\Manager as Jetpack_Connection;
11
use Automattic\Jetpack\Constants;
12
use Automattic\Jetpack\Status;
13
use Automattic\Jetpack\Sync\Health;
14
use Automattic\Jetpack\Sync\Modules;
15
16
/**
17
 * The role of this class is to hook the Sync subsystem into WordPress - when to listen for actions,
18
 * when to send, when to perform a full sync, etc.
19
 *
20
 * It also binds the action to send data to WPCOM to Jetpack's XMLRPC client object.
21
 */
22
class Actions {
23
	/**
24
	 * A variable to hold a sync sender object.
25
	 *
26
	 * @access public
27
	 * @static
28
	 *
29
	 * @var Automattic\Jetpack\Sync\Sender
30
	 */
31
	public static $sender = null;
32
33
	/**
34
	 * A variable to hold a sync listener object.
35
	 *
36
	 * @access public
37
	 * @static
38
	 *
39
	 * @var Automattic\Jetpack\Sync\Listener
40
	 */
41
	public static $listener = null;
42
43
	/**
44
	 * Name of the sync cron schedule.
45
	 *
46
	 * @access public
47
	 *
48
	 * @var string
49
	 */
50
	const DEFAULT_SYNC_CRON_INTERVAL_NAME = 'jetpack_sync_interval';
51
52
	/**
53
	 * Interval between the last and the next sync cron action.
54
	 *
55
	 * @access public
56
	 *
57
	 * @var int
58
	 */
59
	const DEFAULT_SYNC_CRON_INTERVAL_VALUE = 300; // 5 * MINUTE_IN_SECONDS;
60
61
	/**
62
	 * Initialize Sync for cron jobs, set up listeners for WordPress Actions,
63
	 * and set up a shut-down action for sending actions to WordPress.com
64
	 *
65
	 * @access public
66
	 * @static
67
	 */
68
	public static function init() {
69
		// Everything below this point should only happen if we're a valid sync site.
70
		if ( ! self::sync_allowed() ) {
71
			return;
72
		}
73
74
		if ( self::sync_via_cron_allowed() ) {
75
			self::init_sync_cron_jobs();
76
		} elseif ( wp_next_scheduled( 'jetpack_sync_cron' ) ) {
77
			self::clear_sync_cron_jobs();
78
		}
79
		// When importing via cron, do not sync.
80
		add_action( 'wp_cron_importer_hook', array( __CLASS__, 'set_is_importing_true' ), 1 );
81
82
		// Sync connected user role changes to WordPress.com.
83
		Users::init();
84
85
		// Publicize filter to prevent publicizing blacklisted post types.
86
		add_filter( 'publicize_should_publicize_published_post', array( __CLASS__, 'prevent_publicize_blacklisted_posts' ), 10, 2 );
87
88
		/**
89
		 * Fires on every request before default loading sync listener code.
90
		 * Return false to not load sync listener code that monitors common
91
		 * WP actions to be serialized.
92
		 *
93
		 * By default this returns true for cron jobs, non-GET-requests, or requests where the
94
		 * user is logged-in.
95
		 *
96
		 * @since 4.2.0
97
		 *
98
		 * @param bool should we load sync listener code for this request
99
		 */
100
		if ( apply_filters( 'jetpack_sync_listener_should_load', true ) ) {
101
			self::initialize_listener();
102
		}
103
104
		add_action( 'init', array( __CLASS__, 'add_sender_shutdown' ), 90 );
105
	}
106
107
	/**
108
	 * Prepares sync to send actions on shutdown for the current request.
109
	 *
110
	 * @access public
111
	 * @static
112
	 */
113
	public static function add_sender_shutdown() {
114
		/**
115
		 * Fires on every request before default loading sync sender code.
116
		 * Return false to not load sync sender code that serializes pending
117
		 * data and sends it to WPCOM for processing.
118
		 *
119
		 * By default this returns true for cron jobs, POST requests, admin requests, or requests
120
		 * by users who can manage_options.
121
		 *
122
		 * @since 4.2.0
123
		 *
124
		 * @param bool should we load sync sender code for this request
125
		 */
126
		if ( apply_filters(
127
			'jetpack_sync_sender_should_load',
128
			self::should_initialize_sender()
129
		) ) {
130
			self::initialize_sender();
131
			add_action( 'shutdown', array( self::$sender, 'do_sync' ) );
132
			add_action( 'shutdown', array( self::$sender, 'do_full_sync' ), 9999 );
133
		}
134
	}
135
136
	/**
137
	 * Decides if the sender should run on shutdown for this request.
138
	 *
139
	 * @access public
140
	 * @static
141
	 *
142
	 * @return bool
143
	 */
144
	public static function should_initialize_sender() {
145
		if ( Constants::is_true( 'DOING_CRON' ) ) {
146
			return self::sync_via_cron_allowed();
147
		}
148
149
		if ( isset( $_SERVER['REQUEST_METHOD'] ) && 'POST' === $_SERVER['REQUEST_METHOD'] ) {
150
			return true;
151
		}
152
153
		if ( current_user_can( 'manage_options' ) ) {
154
			return true;
155
		}
156
157
		if ( is_admin() ) {
158
			return true;
159
		}
160
161
		if ( defined( 'PHPUNIT_JETPACK_TESTSUITE' ) ) {
162
			return true;
163
		}
164
165
		if ( Constants::get_constant( 'WP_CLI' ) ) {
166
			return true;
167
		}
168
169
		return false;
170
	}
171
172
	/**
173
	 * Decides if the sender should run on shutdown when actions are queued.
174
	 *
175
	 * @access public
176
	 * @static
177
	 *
178
	 * @return bool
179
	 */
180
	public static function should_initialize_sender_enqueue() {
181
		if ( Constants::is_true( 'DOING_CRON' ) ) {
182
			return self::sync_via_cron_allowed();
183
		}
184
185
		return true;
186
	}
187
188
	/**
189
	 * Decides if sync should run at all during this request.
190
	 *
191
	 * @access public
192
	 * @static
193
	 *
194
	 * @return bool
195
	 */
196
	public static function sync_allowed() {
197
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
198
			return false;
199
		}
200
201
		if ( defined( 'PHPUNIT_JETPACK_TESTSUITE' ) ) {
202
			return true;
203
		}
204
205
		if ( ! Settings::is_sync_enabled() ) {
206
			return false;
207
		}
208
209
		if ( ( new Status() )->is_development_mode() ) {
210
			return false;
211
		}
212
213
		if ( ( new Status() )->is_staging_site() ) {
214
			return false;
215
		}
216
217
		$connection = new Jetpack_Connection();
218
		if ( ! $connection->is_active() ) {
219
			if ( ! doing_action( 'jetpack_user_authorized' ) ) {
220
				return false;
221
			}
222
		}
223
224
		return true;
225
	}
226
227
	/**
228
	 * Determines if syncing during a cron job is allowed.
229
	 *
230
	 * @access public
231
	 * @static
232
	 *
233
	 * @return bool|int
234
	 */
235
	public static function sync_via_cron_allowed() {
236
		return ( Settings::get_setting( 'sync_via_cron' ) );
237
	}
238
239
	/**
240
	 * Decides if the given post should be Publicized based on its type.
241
	 *
242
	 * @access public
243
	 * @static
244
	 *
245
	 * @param bool     $should_publicize  Publicize status prior to this filter running.
246
	 * @param \WP_Post $post              The post to test for Publicizability.
247
	 * @return bool
248
	 */
249
	public static function prevent_publicize_blacklisted_posts( $should_publicize, $post ) {
250
		if ( in_array( $post->post_type, Settings::get_setting( 'post_types_blacklist' ), true ) ) {
251
			return false;
252
		}
253
254
		return $should_publicize;
255
	}
256
257
	/**
258
	 * Set an importing flag to `true` in sync settings.
259
	 *
260
	 * @access public
261
	 * @static
262
	 */
263
	public static function set_is_importing_true() {
264
		Settings::set_importing( true );
265
	}
266
267
	/**
268
	 * Sends data to WordPress.com via an XMLRPC request.
269
	 *
270
	 * @access public
271
	 * @static
272
	 *
273
	 * @param object $data                   Data relating to a sync action.
274
	 * @param string $codec_name             The name of the codec that encodes the data.
275
	 * @param float  $sent_timestamp         Current server time so we can compensate for clock differences.
276
	 * @param string $queue_id               The queue the action belongs to, sync or full_sync.
277
	 * @param float  $checkout_duration      Time spent retrieving queue items from the DB.
278
	 * @param float  $preprocess_duration    Time spent converting queue items into data to send.
279
	 * @param int    $queue_size             The size of the sync queue at the time of processing.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $queue_size not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
280
	 * @return Jetpack_Error|mixed|WP_Error  The result of the sending request.
281
	 */
282
	public static function send_data( $data, $codec_name, $sent_timestamp, $queue_id, $checkout_duration, $preprocess_duration, $queue_size = null ) {
283
		$query_args = array(
284
			'sync'       => '1',             // Add an extra parameter to the URL so we can tell it's a sync action.
285
			'codec'      => $codec_name,
286
			'timestamp'  => $sent_timestamp,
287
			'queue'      => $queue_id,
288
			'home'       => Functions::home_url(),  // Send home url option to check for Identity Crisis server-side.
289
			'siteurl'    => Functions::site_url(),  // Send siteurl option to check for Identity Crisis server-side.
290
			'cd'         => sprintf( '%.4f', $checkout_duration ),
291
			'pd'         => sprintf( '%.4f', $preprocess_duration ),
292
			'queue_size' => $queue_size,
293
		);
294
295
		// Has the site opted in to IDC mitigation?
296
		if ( \Jetpack::sync_idc_optin() ) {
297
			$query_args['idc'] = true;
298
		}
299
300
		if ( \Jetpack_Options::get_option( 'migrate_for_idc', false ) ) {
301
			$query_args['migrate_for_idc'] = true;
302
		}
303
304
		$query_args['timeout'] = Settings::is_doing_cron() ? 30 : 15;
305
306
		/**
307
		 * Filters query parameters appended to the Sync request URL sent to WordPress.com.
308
		 *
309
		 * @since 4.7.0
310
		 *
311
		 * @param array $query_args associative array of query parameters.
312
		 */
313
		$query_args = apply_filters( 'jetpack_sync_send_data_query_args', $query_args );
314
315
		$connection = new Jetpack_Connection();
316
		$url        = add_query_arg( $query_args, $connection->xmlrpc_api_url() );
317
318
		// If we're currently updating to Jetpack 7.7, the IXR client may be missing briefly
319
		// because since 7.7 it's being autoloaded with Composer.
320
		if ( ! class_exists( '\\Jetpack_IXR_Client' ) ) {
321
			return new \WP_Error(
322
				'ixr_client_missing',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'ixr_client_missing'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
323
				esc_html__( 'Sync has been aborted because the IXR client is missing.', 'jetpack' )
324
			);
325
		}
326
327
		$rpc = new \Jetpack_IXR_Client(
328
			array(
329
				'url'     => $url,
330
				'user_id' => JETPACK_MASTER_USER,
331
				'timeout' => $query_args['timeout'],
332
			)
333
		);
334
335
		$result = $rpc->query( 'jetpack.syncActions', $data );
336
337
		if ( ! $result ) {
338
			return $rpc->get_jetpack_error();
339
		}
340
341
		$response = $rpc->getResponse();
342
343
		// Check if WordPress.com IDC mitigation blocked the sync request.
344
		if ( is_array( $response ) && isset( $response['error_code'] ) ) {
345
			$error_code              = $response['error_code'];
346
			$allowed_idc_error_codes = array(
347
				'jetpack_url_mismatch',
348
				'jetpack_home_url_mismatch',
349
				'jetpack_site_url_mismatch',
350
			);
351
352
			if ( in_array( $error_code, $allowed_idc_error_codes, true ) ) {
353
				\Jetpack_Options::update_option(
354
					'sync_error_idc',
355
					\Jetpack::get_sync_error_idc_option( $response )
356
				);
357
			}
358
359
			return new \WP_Error(
360
				'sync_error_idc',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'sync_error_idc'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
361
				esc_html__( 'Sync has been blocked from WordPress.com because it would cause an identity crisis', 'jetpack' )
362
			);
363
		}
364
365
		return $response;
366
	}
367
368
	/**
369
	 * Kicks off the initial sync.
370
	 *
371
	 * @access public
372
	 * @static
373
	 *
374
	 * @return bool|null False if sync is not allowed.
375
	 */
376
	public static function do_initial_sync() {
377
		// Lets not sync if we are not suppose to.
378
		if ( ! self::sync_allowed() ) {
379
			return false;
380
		}
381
382
		// Don't start new sync if a full sync is in process.
383
		$full_sync_module = Modules::get_module( 'full-sync' );
384
		if ( $full_sync_module && $full_sync_module->is_started() && ! $full_sync_module->is_finished() ) {
385
			return false;
386
		}
387
388
		$initial_sync_config = array(
389
			'options'   => true,
390
			'functions' => true,
391
			'constants' => true,
392
			'users'     => array( get_current_user_id() ),
393
		);
394
395
		if ( is_multisite() ) {
396
			$initial_sync_config['network_options'] = true;
397
		}
398
399
		self::do_full_sync( $initial_sync_config );
400
	}
401
402
	/**
403
	 * Kicks off a full sync.
404
	 *
405
	 * @access public
406
	 * @static
407
	 *
408
	 * @param array $modules  The sync modules should be included in this full sync. All will be included if null.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $modules not be array|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
409
	 * @return bool           True if full sync was successfully started.
410
	 */
411
	public static function do_full_sync( $modules = null ) {
412
		if ( ! self::sync_allowed() ) {
413
			return false;
414
		}
415
416
		$full_sync_module = Modules::get_module( 'full-sync' );
417
418
		if ( ! $full_sync_module ) {
419
			return false;
420
		}
421
422
		self::initialize_listener();
423
424
		$full_sync_module->start( $modules );
425
426
		return true;
427
	}
428
429
	/**
430
	 * Adds a cron schedule for regular syncing via cron, unless the schedule already exists.
431
	 *
432
	 * @access public
433
	 * @static
434
	 *
435
	 * @param array $schedules  The list of WordPress cron schedules prior to this filter.
436
	 * @return array            A list of WordPress cron schedules with the Jetpack sync interval added.
437
	 */
438
	public static function jetpack_cron_schedule( $schedules ) {
439
		if ( ! isset( $schedules[ self::DEFAULT_SYNC_CRON_INTERVAL_NAME ] ) ) {
440
			$minutes = intval( self::DEFAULT_SYNC_CRON_INTERVAL_VALUE / 60 );
441
			$display = ( 1 === $minutes ) ?
442
				__( 'Every minute', 'jetpack' ) :
443
				/* translators: %d is an integer indicating the number of minutes. */
444
				sprintf( __( 'Every %d minutes', 'jetpack' ), $minutes );
445
			$schedules[ self::DEFAULT_SYNC_CRON_INTERVAL_NAME ] = array(
446
				'interval' => self::DEFAULT_SYNC_CRON_INTERVAL_VALUE,
447
				'display'  => $display,
448
			);
449
		}
450
		return $schedules;
451
	}
452
453
	/**
454
	 * Starts an incremental sync via cron.
455
	 *
456
	 * @access public
457
	 * @static
458
	 */
459
	public static function do_cron_sync() {
460
		self::do_cron_sync_by_type( 'sync' );
461
	}
462
463
	/**
464
	 * Starts a full sync via cron.
465
	 *
466
	 * @access public
467
	 * @static
468
	 */
469
	public static function do_cron_full_sync() {
470
		self::do_cron_sync_by_type( 'full_sync' );
471
	}
472
473
	/**
474
	 * Try to send actions until we run out of things to send,
475
	 * or have to wait more than 15s before sending again,
476
	 * or we hit a lock or some other sending issue
477
	 *
478
	 * @access public
479
	 * @static
480
	 *
481
	 * @param string $type Sync type. Can be `sync` or `full_sync`.
482
	 */
483
	public static function do_cron_sync_by_type( $type ) {
484
		if ( ! self::sync_allowed() || ( 'sync' !== $type && 'full_sync' !== $type ) ) {
485
			return;
486
		}
487
488
		self::initialize_sender();
489
490
		$time_limit = Settings::get_setting( 'cron_sync_time_limit' );
491
		$start_time = time();
492
493
		do {
494
			$next_sync_time = self::$sender->get_next_sync_time( $type );
495
496
			if ( $next_sync_time ) {
497
				$delay = $next_sync_time - time() + 1;
498
				if ( $delay > 15 ) {
499
					break;
500
				} elseif ( $delay > 0 ) {
501
					sleep( $delay );
502
				}
503
			}
504
505
			$result = 'full_sync' === $type ? self::$sender->do_full_sync() : self::$sender->do_sync();
506
		} while ( $result && ! is_wp_error( $result ) && ( $start_time + $time_limit ) > time() );
507
	}
508
509
	/**
510
	 * Initialize the sync listener.
511
	 *
512
	 * @access public
513
	 * @static
514
	 */
515
	public static function initialize_listener() {
516
		self::$listener = Listener::get_instance();
0 ignored issues
show
Documentation Bug introduced by
It seems like \Automattic\Jetpack\Sync\Listener::get_instance() of type object<Automattic\Jetpack\Sync\Listener> is incompatible with the declared type object<Automattic\Jetpac...\Jetpack\Sync\Listener> of property $listener.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
517
	}
518
519
	/**
520
	 * Initializes the sync sender.
521
	 *
522
	 * @access public
523
	 * @static
524
	 */
525
	public static function initialize_sender() {
526
		self::$sender = Sender::get_instance();
0 ignored issues
show
Documentation Bug introduced by
It seems like \Automattic\Jetpack\Sync\Sender::get_instance() of type object<Automattic\Jetpack\Sync\Sender> is incompatible with the declared type object<Automattic\Jetpac...ic\Jetpack\Sync\Sender> of property $sender.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
527
		add_filter( 'jetpack_sync_send_data', array( __CLASS__, 'send_data' ), 10, 7 );
528
	}
529
530
	/**
531
	 * Initializes sync for WooCommerce.
532
	 *
533
	 * @access public
534
	 * @static
535
	 */
536
	public static function initialize_woocommerce() {
537
		if ( false === class_exists( 'WooCommerce' ) ) {
538
			return;
539
		}
540
		add_filter( 'jetpack_sync_modules', array( __CLASS__, 'add_woocommerce_sync_module' ) );
541
	}
542
543
	/**
544
	 * Adds Woo's sync modules to existing modules for sending.
545
	 *
546
	 * @access public
547
	 * @static
548
	 *
549
	 * @param array $sync_modules The list of sync modules declared prior to this filter.
550
	 * @return array A list of sync modules that now includes Woo's modules.
551
	 */
552
	public static function add_woocommerce_sync_module( $sync_modules ) {
553
		$sync_modules[] = 'Automattic\\Jetpack\\Sync\\Modules\\WooCommerce';
554
		return $sync_modules;
555
	}
556
557
	/**
558
	 * Initializes sync for WP Super Cache.
559
	 *
560
	 * @access public
561
	 * @static
562
	 */
563
	public static function initialize_wp_super_cache() {
564
		if ( false === function_exists( 'wp_cache_is_enabled' ) ) {
565
			return;
566
		}
567
		add_filter( 'jetpack_sync_modules', array( __CLASS__, 'add_wp_super_cache_sync_module' ) );
568
	}
569
570
	/**
571
	 * Adds WP Super Cache's sync modules to existing modules for sending.
572
	 *
573
	 * @access public
574
	 * @static
575
	 *
576
	 * @param array $sync_modules The list of sync modules declared prior to this filer.
577
	 * @return array A list of sync modules that now includes WP Super Cache's modules.
578
	 */
579
	public static function add_wp_super_cache_sync_module( $sync_modules ) {
580
		$sync_modules[] = 'Automattic\\Jetpack\\Sync\\Modules\\WP_Super_Cache';
581
		return $sync_modules;
582
	}
583
584
	/**
585
	 * Sanitizes the name of sync's cron schedule.
586
	 *
587
	 * @access public
588
	 * @static
589
	 *
590
	 * @param string $schedule The name of a WordPress cron schedule.
591
	 * @return string The sanitized name of sync's cron schedule.
592
	 */
593
	public static function sanitize_filtered_sync_cron_schedule( $schedule ) {
594
		$schedule  = sanitize_key( $schedule );
595
		$schedules = wp_get_schedules();
596
597
		// Make sure that the schedule has actually been registered using the `cron_intervals` filter.
598
		if ( isset( $schedules[ $schedule ] ) ) {
599
			return $schedule;
600
		}
601
602
		return self::DEFAULT_SYNC_CRON_INTERVAL_NAME;
603
	}
604
605
	/**
606
	 * Allows offsetting of start times for sync cron jobs.
607
	 *
608
	 * @access public
609
	 * @static
610
	 *
611
	 * @param string $schedule The name of a cron schedule.
612
	 * @param string $hook     The hook that this method is responding to.
613
	 * @return int The offset for the sync cron schedule.
614
	 */
615
	public static function get_start_time_offset( $schedule = '', $hook = '' ) {
616
		$start_time_offset = is_multisite()
617
			? wp_rand( 0, ( 2 * self::DEFAULT_SYNC_CRON_INTERVAL_VALUE ) )
618
			: 0;
619
620
		/**
621
		 * Allows overriding the offset that the sync cron jobs will first run. This can be useful when scheduling
622
		 * cron jobs across multiple sites in a network.
623
		 *
624
		 * @since 4.5.0
625
		 *
626
		 * @param int    $start_time_offset
627
		 * @param string $hook
628
		 * @param string $schedule
629
		 */
630
		return intval(
631
			apply_filters(
632
				'jetpack_sync_cron_start_time_offset',
633
				$start_time_offset,
634
				$hook,
635
				$schedule
636
			)
637
		);
638
	}
639
640
	/**
641
	 * Decides if a sync cron should be scheduled.
642
	 *
643
	 * @access public
644
	 * @static
645
	 *
646
	 * @param string $schedule The name of a cron schedule.
647
	 * @param string $hook     The hook that this method is responding to.
648
	 */
649
	public static function maybe_schedule_sync_cron( $schedule, $hook ) {
650
		if ( ! $hook ) {
651
			return;
652
		}
653
		$schedule = self::sanitize_filtered_sync_cron_schedule( $schedule );
654
655
		$start_time = time() + self::get_start_time_offset( $schedule, $hook );
656
		if ( ! wp_next_scheduled( $hook ) ) {
657
			// Schedule a job to send pending queue items once a minute.
658
			wp_schedule_event( $start_time, $schedule, $hook );
659
		} elseif ( wp_get_schedule( $hook ) !== $schedule ) {
660
			// If the schedule has changed, update the schedule.
661
			wp_clear_scheduled_hook( $hook );
662
			wp_schedule_event( $start_time, $schedule, $hook );
663
		}
664
	}
665
666
	/**
667
	 * Clears Jetpack sync cron jobs.
668
	 *
669
	 * @access public
670
	 * @static
671
	 */
672
	public static function clear_sync_cron_jobs() {
673
		wp_clear_scheduled_hook( 'jetpack_sync_cron' );
674
		wp_clear_scheduled_hook( 'jetpack_sync_full_cron' );
675
	}
676
677
	/**
678
	 * Initializes Jetpack sync cron jobs.
679
	 *
680
	 * @access public
681
	 * @static
682
	 */
683
	public static function init_sync_cron_jobs() {
684
		add_filter( 'cron_schedules', array( __CLASS__, 'jetpack_cron_schedule' ) ); // phpcs:ignore WordPress.WP.CronInterval.ChangeDetected
685
686
		add_action( 'jetpack_sync_cron', array( __CLASS__, 'do_cron_sync' ) );
687
		add_action( 'jetpack_sync_full_cron', array( __CLASS__, 'do_cron_full_sync' ) );
688
689
		/**
690
		 * Allows overriding of the default incremental sync cron schedule which defaults to once every 5 minutes.
691
		 *
692
		 * @since 4.3.2
693
		 *
694
		 * @param string self::DEFAULT_SYNC_CRON_INTERVAL_NAME
695
		 */
696
		$incremental_sync_cron_schedule = apply_filters( 'jetpack_sync_incremental_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL_NAME );
697
		self::maybe_schedule_sync_cron( $incremental_sync_cron_schedule, 'jetpack_sync_cron' );
698
699
		/**
700
		 * Allows overriding of the full sync cron schedule which defaults to once every 5 minutes.
701
		 *
702
		 * @since 4.3.2
703
		 *
704
		 * @param string self::DEFAULT_SYNC_CRON_INTERVAL_NAME
705
		 */
706
		$full_sync_cron_schedule = apply_filters( 'jetpack_sync_full_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL_NAME );
707
		self::maybe_schedule_sync_cron( $full_sync_cron_schedule, 'jetpack_sync_full_cron' );
708
	}
709
710
	/**
711
	 * Perform maintenance when a plugin upgrade occurs.
712
	 *
713
	 * @access public
714
	 * @static
715
	 *
716
	 * @param string $new_version New version of the plugin.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $new_version not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
717
	 * @param string $old_version Old version of the plugin.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_version not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
718
	 */
719
	public static function cleanup_on_upgrade( $new_version = null, $old_version = null ) {
720
		if ( wp_next_scheduled( 'jetpack_sync_send_db_checksum' ) ) {
721
			wp_clear_scheduled_hook( 'jetpack_sync_send_db_checksum' );
722
		}
723
724
		$is_new_sync_upgrade = version_compare( $old_version, '4.2', '>=' );
725
		if ( ! empty( $old_version ) && $is_new_sync_upgrade && version_compare( $old_version, '4.5', '<' ) ) {
726
			self::clear_sync_cron_jobs();
727
			Settings::update_settings(
728
				array(
729
					'render_filtered_content' => Defaults::$default_render_filtered_content,
730
				)
731
			);
732
		}
733
734
		Health::on_jetpack_upgraded();
735
	}
736
737
	/**
738
	 * Get syncing status for the given fields.
739
	 *
740
	 * @access public
741
	 * @static
742
	 *
743
	 * @param string|null $fields A comma-separated string of the fields to include in the array from the JSON response.
744
	 * @return array An associative array with the status report.
745
	 */
746
	public static function get_sync_status( $fields = null ) {
747
		self::initialize_sender();
748
749
		$sync_module = Modules::get_module( 'full-sync' );
750
		$queue       = self::$sender->get_sync_queue();
751
752
		// _get_cron_array can be false
753
		$cron_timestamps = ( _get_cron_array() ) ? array_keys( _get_cron_array() ) : array();
754
		$next_cron       = ( ! empty( $cron_timestamps ) ) ? $cron_timestamps[0] - time() : '';
755
756
		$checksums = array();
757
758
		if ( ! empty( $fields ) ) {
759
			$store         = new Replicastore();
760
			$fields_params = array_map( 'trim', explode( ',', $fields ) );
761
762
			if ( in_array( 'posts_checksum', $fields_params, true ) ) {
763
				$checksums['posts_checksum'] = $store->posts_checksum();
764
			}
765
			if ( in_array( 'comments_checksum', $fields_params, true ) ) {
766
				$checksums['comments_checksum'] = $store->comments_checksum();
767
			}
768
			if ( in_array( 'post_meta_checksum', $fields_params, true ) ) {
769
				$checksums['post_meta_checksum'] = $store->post_meta_checksum();
770
			}
771
			if ( in_array( 'comment_meta_checksum', $fields_params, true ) ) {
772
				$checksums['comment_meta_checksum'] = $store->comment_meta_checksum();
773
			}
774
		}
775
776
		$full_sync_status = ( $sync_module ) ? $sync_module->get_status() : array();
777
778
		$full_queue = self::$sender->get_full_sync_queue();
779
780
		$result = array_merge(
781
			$full_sync_status,
782
			$checksums,
783
			array(
784
				'cron_size'            => count( $cron_timestamps ),
785
				'next_cron'            => $next_cron,
786
				'queue_size'           => $queue->size(),
787
				'queue_lag'            => $queue->lag(),
788
				'queue_next_sync'      => ( self::$sender->get_next_sync_time( 'sync' ) - microtime( true ) ),
789
				'full_queue_next_sync' => ( self::$sender->get_next_sync_time( 'full_sync' ) - microtime( true ) ),
790
			)
791
		);
792
793
		// Verify $sync_module is not false.
794
		if ( ( $sync_module ) && false === strpos( get_class( $sync_module ), 'Full_Sync_Immediately' ) ) {
795
			$result['full_queue_size'] = $full_queue->size();
796
			$result['full_queue_lag']  = $full_queue->lag();
797
		}
798
		return $result;
799
	}
800
}
801