Completed
Push — fix/save-full-sync-status-duri... ( 6117f3...bc1926 )
by
unknown
09:30
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__, 'do_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
			$error = $rpc->get_jetpack_error();
146
			if ( 'jetpack_url_mismatch' === $error->get_error_code() ) {
147
				Jetpack_Options::update_option( 'sync_error_idc', get_home_url() );
148
			}
149
			
150
			return $error;
151
		}
152
153
		return $rpc->getResponse();
154
	}
155
156
	static function schedule_initial_sync( $new_version = null, $old_version = null ) {
157
		$initial_sync_config = array(
158
			'options' => true,
159
			'network_options' => true,
160
			'functions' => true,
161
			'constants' => true,
162
		);
163
164
		if ( $old_version && ( version_compare( $old_version, '4.2', '<' ) ) ) {
165
			$initial_sync_config['users'] = 'initial';
166
		}
167
168
		// we need this function call here because we have to run this function
169
		// reeeeally early in init, before WP_CRON_LOCK_TIMEOUT is defined.
170
		wp_functionality_constants();
171
172
		if ( is_multisite() ) {
173
			// stagger initial syncs for multisite blogs so they don't all pile on top of each other
174
			$time_offset = ( rand() / getrandmax() ) * self::INITIAL_SYNC_MULTISITE_INTERVAL * get_blog_count();
0 ignored issues
show
Unused Code introduced by
$time_offset is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
175
		} else {
176
			$time_offset = 1;
0 ignored issues
show
Unused Code introduced by
$time_offset is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
177
		}
178
179
		self::do_full_sync( $initial_sync_config );
180
	}
181
182
	static function do_full_sync( $modules = null ) {
183
		if ( ! self::sync_allowed() ) {
184
			return false;
185
		}
186
187
		self::initialize_listener();
188
		Jetpack_Sync_Modules::get_module( 'full-sync' )->start( $modules );
189
		self::do_cron_full_sync(); // immediately run a cron full sync, which sends pending data
190
191
		return true;
192
	}
193
194
	static function minute_cron_schedule( $schedules ) {
195
		if( ! isset( $schedules["1min"] ) ) {
196
			$schedules["1min"] = array(
197
				'interval' => 60,
198
				'display' => __( 'Every minute' )
199
			);
200
		}
201
		return $schedules;
202
	}
203
204
	// try to send actions until we run out of things to send,
205
	// or have to wait more than 15s before sending again,
206
	// or we hit a lock or some other sending issue
207 View Code Duplication
	static function do_cron_sync() {
208
		if ( ! self::sync_allowed() ) {
209
			return;
210
		}
211
212
		self::initialize_sender();
213
214
		// remove shutdown hook - no need to sync twice
215
		if ( has_action( 'shutdown', array( self::$sender, 'do_sync' ) ) ) {
216
			remove_action( 'shutdown', array( self::$sender, 'do_sync' ) );
217
		}
218
219
		do {
220
			$next_sync_time = self::$sender->get_next_sync_time( 'sync' );
221
222
			if ( $next_sync_time ) {
223
				$delay = $next_sync_time - time() + 1;
224
				if ( $delay > 15 ) {
225
					break;
226
				} elseif ( $delay > 0 ) {
227
					sleep( $delay );
228
				}
229
			}
230
231
			$result = self::$sender->do_sync();
232
		} while ( $result );
233
	}
234
235 View Code Duplication
	static function do_cron_full_sync() {
236
		if ( ! self::sync_allowed() ) {
237
			return;
238
		}
239
240
		self::initialize_sender();
241
242
		// remove shutdown hook - no need to sync twice
243
		if ( has_action( 'shutdown', array( self::$sender, 'do_sync' ) ) ) {
244
			remove_action( 'shutdown', array( self::$sender, 'do_sync' ) );
245
		}
246
247
		do {
248
			$next_sync_time = self::$sender->get_next_sync_time( 'full_sync' );
249
250
			if ( $next_sync_time ) {
251
				$delay = $next_sync_time - time() + 1;
252
				if ( $delay > 15 ) {
253
					break;
254
				} elseif ( $delay > 0 ) {
255
					sleep( $delay );
256
				}
257
			}
258
259
			$result = self::$sender->do_full_sync();
260
		} while ( $result );
261
	}
262
263
	static function initialize_listener() {
264
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
265
		self::$listener = Jetpack_Sync_Listener::get_instance();
266
	}
267
268
	static function initialize_sender() {
269
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-sender.php';
270
		self::$sender = Jetpack_Sync_Sender::get_instance();
271
272
		// bind the sending process
273
		add_filter( 'jetpack_sync_send_data', array( __CLASS__, 'send_data' ), 10, 4 );
274
	}
275
276
	static function sanitize_filtered_sync_cron_schedule( $schedule ) {
277
		$schedule = sanitize_key( $schedule );
278
		$schedules = wp_get_schedules();
279
280
		// Make sure that the schedule has actually been registered using the `cron_intervals` filter.
281
		if ( isset( $schedules[ $schedule ] ) ) {
282
			return $schedule;
283
		}
284
285
		return self::DEFAULT_SYNC_CRON_INTERVAL;
286
	}
287
288
	static function maybe_schedule_sync_cron( $schedule, $hook ) {
289
		if ( ! $hook ) {
290
			return;
291
		}
292
		$schedule = self::sanitize_filtered_sync_cron_schedule( $schedule );
293
294
		if ( ! wp_next_scheduled( $hook ) ) {
295
			// Schedule a job to send pending queue items once a minute
296
			wp_schedule_event( time(), $schedule, $hook );
297
		} else if ( $schedule != wp_get_schedule( $hook ) ) {
298
			// If the schedule has changed, update the schedule
299
			wp_clear_scheduled_hook( $hook );
300
			wp_schedule_event( time(), $schedule, $hook );
301
		}
302
	}
303
304
	static function init_sync_cron_jobs() {
305
		/**
306
		 * Allows overriding of the default incremental sync cron schedule which defaults to once per minute.
307
		 *
308
		 * @since 4.3.2
309
		 *
310
		 * @param string self::DEFAULT_SYNC_CRON_INTERVAL
311
		 */
312
		$incremental_sync_cron_schedule = apply_filters( 'jetpack_sync_incremental_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL );
313
		self::maybe_schedule_sync_cron( $incremental_sync_cron_schedule, 'jetpack_sync_cron' );
314
315
		/**
316
		 * Allows overriding of the full sync cron schedule which defaults to once per minute.
317
		 *
318
		 * @since 4.3.2
319
		 *
320
		 * @param string self::DEFAULT_SYNC_CRON_INTERVAL
321
		 */
322
		$full_sync_cron_schedule = apply_filters( 'jetpack_sync_full_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL );
323
		self::maybe_schedule_sync_cron( $full_sync_cron_schedule, 'jetpack_sync_full_cron' );
324
	}
325
}
326
327
/**
328
 * If the site is using alternate cron, we need to init the listener and sender before cron
329
 * runs. So, we init at a priority of 9.
330
 * 
331
 * If the site is using a regular cron job, we init at a priority of 90 which gives plugins a chance
332
 * to add filters before we initialize.
333
 */
334
if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) {
335
	add_action( 'init', array( 'Jetpack_Sync_Actions', 'init' ), 9 );
336
} else {
337
	add_action( 'init', array( 'Jetpack_Sync_Actions', 'init' ), 90 );
338
}
339
340
// We need to define this here so that it's hooked before `updating_jetpack_version` is called
341
add_action( 'updating_jetpack_version', array( 'Jetpack_Sync_Actions', 'schedule_initial_sync' ), 10, 2 );
342