Completed
Push — add/changelog-432 ( 125982...8161c6 )
by
unknown
70:53 queued 60:29
created

Jetpack_Sync_Actions::maybe_schedule_sync_cron()   A

Complexity

Conditions 4
Paths 4

Size

Total Lines 15
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
eloc 9
nc 4
nop 2
dl 0
loc 15
rs 9.2
c 0
b 0
f 0
1
<?php
2
require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
3
4
/**
5
 * The role of this class is to hook the Sync subsystem into WordPress - when to listen for actions,
6
 * when to send, when to perform a full sync, etc.
7
 *
8
 * It also binds the action to send data to WPCOM to Jetpack's XMLRPC client object.
9
 */
10
class Jetpack_Sync_Actions {
11
	static $sender = null;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $sender.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
12
	static $listener = null;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $listener.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
13
	const INITIAL_SYNC_MULTISITE_INTERVAL = 10;
14
	const DEFAULT_SYNC_CRON_INTERVAL = '1min';
15
16
	static function init() {
17
18
		// Add a custom "every minute" cron schedule
19
		add_filter( 'cron_schedules', array( __CLASS__, 'minute_cron_schedule' ) );
20
21
		// On jetpack authorization, schedule a full sync
22
		add_action( 'jetpack_client_authorized', array( __CLASS__, 'schedule_full_sync' ), 10, 0 );
23
24
		// When importing via cron, do not sync
25
		add_action( 'wp_cron_importer_hook', array( __CLASS__, 'set_is_importing_true' ), 1 );
26
27
		// Sync connected user role changes to .com
28
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-users.php';
29
30
		// everything below this point should only happen if we're a valid sync site
31
		if ( ! self::sync_allowed() ) {
32
			return;
33
		}
34
35
		// publicize filter to prevent publicizing blacklisted post types
36
		add_filter( 'publicize_should_publicize_published_post', array( __CLASS__, 'prevent_publicize_blacklisted_posts' ), 10, 2 );
37
38
		// cron hooks
39
		add_action( 'jetpack_sync_full', array( __CLASS__, 'do_full_sync' ), 10, 1 );
40
		add_action( 'jetpack_sync_cron', array( __CLASS__, 'do_cron_sync' ) );
41
		add_action( 'jetpack_sync_full_cron', array( __CLASS__, 'do_cron_full_sync' ) );
42
43
		self::init_sync_cron_jobs();
44
45
		/**
46
		 * Fires on every request before default loading sync listener code.
47
		 * Return false to not load sync listener code that monitors common
48
		 * WP actions to be serialized.
49
		 *
50
		 * By default this returns true for cron jobs, non-GET-requests, or requests where the
51
		 * user is logged-in.
52
		 *
53
		 * @since 4.2.0
54
		 *
55
		 * @param bool should we load sync listener code for this request
56
		 */
57
		if ( apply_filters( 'jetpack_sync_listener_should_load',
58
			(
59
				( isset( $_SERVER["REQUEST_METHOD"] ) && 'GET' !== $_SERVER['REQUEST_METHOD'] )
60
				||
61
				is_user_logged_in()
62
				||
63
				defined( 'PHPUNIT_JETPACK_TESTSUITE' )
64
				||
65
				defined( 'DOING_CRON' ) && DOING_CRON
66
			)
67
		) ) {
68
			self::initialize_listener();
69
		}
70
71
		/**
72
		 * Fires on every request before default loading sync sender code.
73
		 * Return false to not load sync sender code that serializes pending
74
		 * data and sends it to WPCOM for processing.
75
		 *
76
		 * By default this returns true for cron jobs, POST requests, admin requests, or requests
77
		 * by users who can manage_options.
78
		 *
79
		 * @since 4.2.0
80
		 *
81
		 * @param bool should we load sync sender code for this request
82
		 */
83
		if ( apply_filters( 'jetpack_sync_sender_should_load',
84
			(
85
				( isset( $_SERVER["REQUEST_METHOD"] ) && 'POST' === $_SERVER['REQUEST_METHOD'] )
86
				||
87
				current_user_can( 'manage_options' )
88
				||
89
				is_admin()
90
				||
91
				defined( 'PHPUNIT_JETPACK_TESTSUITE' )
92
				||
93
				defined( 'DOING_CRON' ) && DOING_CRON
94
			)
95
		) ) {
96
			self::initialize_sender();
97
			add_action( 'shutdown', array( self::$sender, 'do_sync' ) );
98
		}
99
100
	}
101
102
	static function sync_allowed() {
103
		return ( ! Jetpack_Sync_Settings::get_setting( 'disable' ) && Jetpack::is_active() && ! ( Jetpack::is_development_mode() || Jetpack::is_staging_site() ) )
104
			   || defined( 'PHPUNIT_JETPACK_TESTSUITE' );
105
	}
106
107
	static function prevent_publicize_blacklisted_posts( $should_publicize, $post ) {
108
		if ( in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) ) ) {
109
			return false;
110
		}
111
112
		return $should_publicize;
113
	}
114
115
	static function set_is_importing_true() {
116
		Jetpack_Sync_Settings::set_importing( true );
117
	}
118
119
	static function send_data( $data, $codec_name, $sent_timestamp, $queue_id ) {
120
		Jetpack::load_xml_rpc_client();
121
122
		$query_args = array(
123
			'sync'      => '1',             // add an extra parameter to the URL so we can tell it's a sync action
124
			'codec'     => $codec_name,     // send the name of the codec used to encode the data
125
			'timestamp' => $sent_timestamp, // send current server time so we can compensate for clock differences
126
			'queue'     => $queue_id,       // sync or full_sync
127
		);
128
129
		if ( Jetpack::sync_idc_optin() ) {
130
			$query_args['home']    = get_home_url(); // Send home url option to check for Identity Crisis server-side
131
			$query_args['siteurl'] = get_site_url(); // Send home url option to check for Identity Crisis server-side
132
		}
133
134
		$url = add_query_arg( $query_args, Jetpack::xmlrpc_api_url() );
135
136
		$rpc = new Jetpack_IXR_Client( array(
137
			'url'     => $url,
138
			'user_id' => JETPACK_MASTER_USER,
139
			'timeout' => 30,
140
		) );
141
142
		$result = $rpc->query( 'jetpack.syncActions', $data );
143
144
		if ( ! $result ) {
145
			return $rpc->get_jetpack_error();
146
		}
147
148
		return $rpc->getResponse();
149
	}
150
151
	static function schedule_initial_sync( $new_version = null, $old_version = null ) {
152
		$initial_sync_config = array(
153
			'options' => true,
154
			'network_options' => true,
155
			'functions' => true,
156
			'constants' => true,
157
		);
158
159
		if ( $old_version && ( version_compare( $old_version, '4.2', '<' ) ) ) {
160
			$initial_sync_config['users'] = 'initial';
161
		}
162
163
		// we need this function call here because we have to run this function
164
		// reeeeally early in init, before WP_CRON_LOCK_TIMEOUT is defined.
165
		wp_functionality_constants();
166
167
		if ( is_multisite() ) {
168
			// stagger initial syncs for multisite blogs so they don't all pile on top of each other
169
			$time_offset = ( rand() / getrandmax() ) * self::INITIAL_SYNC_MULTISITE_INTERVAL * get_blog_count();
170
		} else {
171
			$time_offset = 1;
172
		}
173
174
		self::schedule_full_sync(
175
			$initial_sync_config,
176
			$time_offset
177
		);
178
	}
179
180
	static function schedule_full_sync( $modules = null, $time_offset = 1 ) {
181
		if ( ! self::sync_allowed() ) {
182
			return false;
183
		}
184
185
		if ( Jetpack_Sync_Settings::get_setting( 'avoid_wp_cron' ) ) {
186
			// run queuing inline
187
			set_time_limit( 0 );
188
			self::do_full_sync( $modules );
189
			return false;
190
		}
191
192
		if ( self::is_scheduled_full_sync() ) {
193
			self::unschedule_all_full_syncs();
194
		}
195
196
		if ( $modules ) {
197
			wp_schedule_single_event( time() + $time_offset, 'jetpack_sync_full', array( $modules ) );
198
		} else {
199
			wp_schedule_single_event( time() + $time_offset, 'jetpack_sync_full' );
200
		}
201
202
		if ( $time_offset === 1 ) {
203
			spawn_cron();
204
		}
205
206
		return true;
207
	}
208
209
	static function unschedule_all_full_syncs() {
210
		foreach ( _get_cron_array() as $timestamp => $cron ) {
211
			if ( ! empty( $cron['jetpack_sync_full'] ) ) {
212
				foreach( $cron['jetpack_sync_full'] as $key => $config ) {
213
					wp_unschedule_event( $timestamp, 'jetpack_sync_full', $config['args'] );
214
				}
215
			}
216
		}
217
	}
218
219
	static function is_scheduled_full_sync( $modules = null ) {
220
		if ( is_null( $modules ) ) {
221
			$crons = _get_cron_array();
222
223
			foreach ( $crons as $timestamp => $cron ) {
224
				if ( ! empty( $cron['jetpack_sync_full'] ) ) {
225
					return true;
226
				}
227
			}
228
			return false;
229
		}
230
231
		return !! wp_next_scheduled( 'jetpack_sync_full', array( $modules ) );
232
	}
233
234
	static function do_full_sync( $modules = null ) {
235
		if ( ! self::sync_allowed() ) {
236
			return;
237
		}
238
239
		self::initialize_listener();
240
		Jetpack_Sync_Modules::get_module( 'full-sync' )->start( $modules );
241
		self::do_cron_full_sync(); // immediately run a cron full sync, which sends pending data
242
	}
243
244
	static function minute_cron_schedule( $schedules ) {
245
		if( ! isset( $schedules["1min"] ) ) {
246
			$schedules["1min"] = array(
247
				'interval' => 60,
248
				'display' => __( 'Every minute' )
249
			);
250
		}
251
		return $schedules;
252
	}
253
254
	// try to send actions until we run out of things to send,
255
	// or have to wait more than 15s before sending again,
256
	// or we hit a lock or some other sending issue
257 View Code Duplication
	static function do_cron_sync() {
258
		if ( ! self::sync_allowed() ) {
259
			return;
260
		}
261
262
		self::initialize_sender();
263
264
		// remove shutdown hook - no need to sync twice
265
		if ( has_action( 'shutdown', array( self::$sender, 'do_sync' ) ) ) {
266
			remove_action( 'shutdown', array( self::$sender, 'do_sync' ) );
267
		}
268
269
		do {
270
			$next_sync_time = self::$sender->get_next_sync_time( 'sync' );
271
272
			if ( $next_sync_time ) {
273
				$delay = $next_sync_time - time() + 1;
274
				if ( $delay > 15 ) {
275
					break;
276
				} elseif ( $delay > 0 ) {
277
					sleep( $delay );
278
				}
279
			}
280
281
			$result = self::$sender->do_sync();
282
		} while ( $result );
283
	}
284
285 View Code Duplication
	static function do_cron_full_sync() {
286
		if ( ! self::sync_allowed() ) {
287
			return;
288
		}
289
290
		self::initialize_sender();
291
292
		// remove shutdown hook - no need to sync twice
293
		if ( has_action( 'shutdown', array( self::$sender, 'do_sync' ) ) ) {
294
			remove_action( 'shutdown', array( self::$sender, 'do_sync' ) );
295
		}
296
297
		do {
298
			$next_sync_time = self::$sender->get_next_sync_time( 'full_sync' );
299
300
			if ( $next_sync_time ) {
301
				$delay = $next_sync_time - time() + 1;
302
				if ( $delay > 15 ) {
303
					break;
304
				} elseif ( $delay > 0 ) {
305
					sleep( $delay );
306
				}
307
			}
308
309
			$result = self::$sender->do_full_sync();
310
		} while ( $result );
311
	}
312
313
	static function initialize_listener() {
314
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
315
		self::$listener = Jetpack_Sync_Listener::get_instance();
316
	}
317
318
	static function initialize_sender() {
319
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-sender.php';
320
		self::$sender = Jetpack_Sync_Sender::get_instance();
321
322
		// bind the sending process
323
		add_filter( 'jetpack_sync_send_data', array( __CLASS__, 'send_data' ), 10, 4 );
324
	}
325
326
	static function sanitize_filtered_sync_cron_schedule( $schedule ) {
327
		$schedule = sanitize_key( $schedule );
328
		$schedules = wp_get_schedules();
329
330
		// Make sure that the schedule has actually been registered using the `cron_intervals` filter.
331
		if ( isset( $schedules[ $schedule ] ) ) {
332
			return $schedule;
333
		}
334
335
		return self::DEFAULT_SYNC_CRON_INTERVAL;
336
	}
337
338
	static function maybe_schedule_sync_cron( $schedule, $hook ) {
339
		if ( ! $hook ) {
340
			return;
341
		}
342
		$schedule = self::sanitize_filtered_sync_cron_schedule( $schedule );
343
344
		if ( ! wp_next_scheduled( $hook ) ) {
345
			// Schedule a job to send pending queue items once a minute
346
			wp_schedule_event( time(), $schedule, $hook );
347
		} else if ( $schedule != wp_get_schedule( $hook ) ) {
348
			// If the schedule has changed, update the schedule
349
			wp_clear_scheduled_hook( $hook );
350
			wp_schedule_event( time(), $schedule, $hook );
351
		}
352
	}
353
354
	static function init_sync_cron_jobs() {
355
		/**
356
		 * Allows overriding of the default incremental sync cron schedule which defaults to once per minute.
357
		 *
358
		 * @since 4.3.2
359
		 *
360
		 * @param string self::DEFAULT_SYNC_CRON_INTERVAL
361
		 */
362
		$incremental_sync_cron_schedule = apply_filters( 'jetpack_sync_incremental_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL );
363
		self::maybe_schedule_sync_cron( $incremental_sync_cron_schedule, 'jetpack_sync_cron' );
364
365
		/**
366
		 * Allows overriding of the full sync cron schedule which defaults to once per minute.
367
		 *
368
		 * @since 4.3.2
369
		 *
370
		 * @param string self::DEFAULT_SYNC_CRON_INTERVAL
371
		 */
372
		$full_sync_cron_schedule = apply_filters( 'jetpack_sync_full_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL );
373
		self::maybe_schedule_sync_cron( $full_sync_cron_schedule, 'jetpack_sync_full_cron' );
374
	}
375
}
376
377
/**
378
 * If the site is using alternate cron, we need to init the listener and sender before cron
379
 * runs. So, we init at a priority of 9.
380
 * 
381
 * If the site is using a regular cron job, we init at a priority of 90 which gives plugins a chance
382
 * to add filters before we initialize.
383
 */
384
if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) {
385
	add_action( 'init', array( 'Jetpack_Sync_Actions', 'init' ), 9 );
386
} else {
387
	add_action( 'init', array( 'Jetpack_Sync_Actions', 'init' ), 90 );
388
}
389
390
// We need to define this here so that it's hooked before `updating_jetpack_version` is called
391
add_action( 'updating_jetpack_version', array( 'Jetpack_Sync_Actions', 'schedule_initial_sync' ), 10, 2 );
392