Jetpack_Sync_Actions::schedule_initial_sync() - Code Metrics - Inspection of "Add descriptive sections about i18n, data approach..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/admin-page-readme-more-... ( 8f2301...4565b6 )

unknown

created 2016-09-09 15:52 UTC

Jetpack_Sync_Actions::schedule_initial_sync() B

↳ Parent: Jetpack_Sync_Actions

Complexity

Conditions	4
Paths	4

Size

Total Lines	28
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	16
c	0
b	0
f	0
nc	4
nop	2
dl	0
loc	28
rs	8.5806

<?php
require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';

/**
 * The role of this class is to hook the Sync subsystem into WordPress - when to listen for actions,
 * when to send, when to perform a full sync, etc.
 *
 * It also binds the action to send data to WPCOM to Jetpack's XMLRPC client object.
 */
class Jetpack_Sync_Actions {
	static $sender = null;
class A {
    var $property;
}
	static $listener = null;
class A {
    var $property;
}
	const INITIAL_SYNC_MULTISITE_INTERVAL = 10;

	static function init() {

		// Add a custom "every minute" cron schedule
		add_filter( 'cron_schedules', array( __CLASS__, 'minute_cron_schedule' ) );

		// On jetpack authorization, schedule a full sync
		add_action( 'jetpack_client_authorized', array( __CLASS__, 'schedule_full_sync' ), 10, 0 );

		// When importing via cron, do not sync
		add_action( 'wp_cron_importer_hook', array( __CLASS__, 'set_is_importing_true' ), 1 );

		// Sync connected user role changes to .com
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-users.php';

		// everything below this point should only happen if we're a valid sync site
		if ( ! self::sync_allowed() ) {
			return;
		}

		// publicize filter to prevent publicizing blacklisted post types
		add_filter( 'publicize_should_publicize_published_post', array( __CLASS__, 'prevent_publicize_blacklisted_posts' ), 10, 2 );

		// cron hooks
		add_action( 'jetpack_sync_full', array( __CLASS__, 'do_full_sync' ), 10, 1 );
		add_action( 'jetpack_sync_cron', array( __CLASS__, 'do_cron_sync' ) );

		if ( ! wp_next_scheduled( 'jetpack_sync_cron' ) ) {
			// Schedule a job to send pending queue items once a minute
			wp_schedule_event( time(), '1min', 'jetpack_sync_cron' );
		}

		/**
		 * Fires on every request before default loading sync listener code.
		 * Return false to not load sync listener code that monitors common
		 * WP actions to be serialized.
		 *
		 * By default this returns true for cron jobs, non-GET-requests, or requests where the
		 * user is logged-in.
		 *
		 * @since 4.2.0
		 *
		 * @param bool should we load sync listener code for this request
		 */
		if ( apply_filters( 'jetpack_sync_listener_should_load',
			(
				( isset( $_SERVER["REQUEST_METHOD"] ) && 'GET' !== $_SERVER['REQUEST_METHOD'] )
				||
				is_user_logged_in()
				||
				defined( 'PHPUNIT_JETPACK_TESTSUITE' )
				||
				defined( 'DOING_CRON' ) && DOING_CRON
			)
		) ) {
			self::initialize_listener();
		}

		/**
		 * Fires on every request before default loading sync sender code.
		 * Return false to not load sync sender code that serializes pending
		 * data and sends it to WPCOM for processing.
		 *
		 * By default this returns true for cron jobs, POST requests, admin requests, or requests
		 * by users who can manage_options.
		 *
		 * @since 4.2.0
		 *
		 * @param bool should we load sync sender code for this request
		 */
		if ( apply_filters( 'jetpack_sync_sender_should_load',
			(
				( isset( $_SERVER["REQUEST_METHOD"] ) && 'POST' === $_SERVER['REQUEST_METHOD'] )
				||
				current_user_can( 'manage_options' )
				||
				is_admin()
				||
				defined( 'PHPUNIT_JETPACK_TESTSUITE' )
				||
				defined( 'DOING_CRON' ) && DOING_CRON
			)
		) ) {
			self::initialize_sender();
			add_action( 'shutdown', array( self::$sender, 'do_sync' ) );
		}

	}

	static function sync_allowed() {
		return ( ! Jetpack_Sync_Settings::get_setting( 'disable' ) && Jetpack::is_active() && ! ( Jetpack::is_development_mode() || Jetpack::is_staging_site() ) )
			   || defined( 'PHPUNIT_JETPACK_TESTSUITE' );
	}

	static function prevent_publicize_blacklisted_posts( $should_publicize, $post ) {
		if ( in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) ) ) {
			return false;
		}

		return $should_publicize;
	}

	static function set_is_importing_true() {
		Jetpack_Sync_Settings::set_importing( true );
	}

	static function send_data( $data, $codec_name, $sent_timestamp, $queue_id ) {
		Jetpack::load_xml_rpc_client();

		$url = add_query_arg( array(
			'sync'      => '1', // add an extra parameter to the URL so we can tell it's a sync action
			'codec'     => $codec_name, // send the name of the codec used to encode the data
			'timestamp' => $sent_timestamp, // send current server time so we can compensate for clock differences
			'queue'     => $queue_id, // sync or full_sync
		), Jetpack::xmlrpc_api_url() );

		$rpc = new Jetpack_IXR_Client( array(
			'url'     => $url,
			'user_id' => JETPACK_MASTER_USER,
			'timeout' => 30,
		) );

		$result = $rpc->query( 'jetpack.syncActions', $data );

		if ( ! $result ) {
			return $rpc->get_jetpack_error();
		}

		return $rpc->getResponse();
	}

	static function schedule_initial_sync( $new_version = null, $old_version = null ) {
		$initial_sync_config = array(
			'options' => true,
			'network_options' => true,
			'functions' => true,
			'constants' => true,
		);

		if ( $old_version && ( version_compare( $old_version, '4.2', '<' ) ) ) {
			$initial_sync_config['users'] = 'initial';
		}

		// we need this function call here because we have to run this function
		// reeeeally early in init, before WP_CRON_LOCK_TIMEOUT is defined.
		wp_functionality_constants();

		if ( is_multisite() ) {
			// stagger initial syncs for multisite blogs so they don't all pile on top of each other
			$time_offset = ( rand() / getrandmax() ) * self::INITIAL_SYNC_MULTISITE_INTERVAL * get_blog_count();
		} else {
			$time_offset = 1;
		}

		self::schedule_full_sync(
			$initial_sync_config,
			$time_offset
		);
	}

	static function schedule_full_sync( $modules = null, $time_offset = 1 ) {
		if ( ! self::sync_allowed() ) {
			return false;
		}

		if ( self::is_scheduled_full_sync() ) {
			self::unschedule_all_full_syncs();
		}

		if ( $modules ) {
			wp_schedule_single_event( time() + $time_offset, 'jetpack_sync_full', array( $modules ) );
		} else {
			wp_schedule_single_event( time() + $time_offset, 'jetpack_sync_full' );
		}

		if ( $time_offset === 1 ) {
			spawn_cron();
		}

		return true;
	}

	static function unschedule_all_full_syncs() {
		foreach ( _get_cron_array() as $timestamp => $cron ) {
			if ( ! empty( $cron['jetpack_sync_full'] ) ) {
				foreach( $cron['jetpack_sync_full'] as $key => $config ) {
					wp_unschedule_event( $timestamp, 'jetpack_sync_full', $config['args'] );
				}
			}
		}
	}

	static function is_scheduled_full_sync( $modules = null ) {
		if ( is_null( $modules ) ) {
			$crons = _get_cron_array();

			foreach ( $crons as $timestamp => $cron ) {
				if ( ! empty( $cron['jetpack_sync_full'] ) ) {
					return true;
				}
			}
			return false;
		}

		return !! wp_next_scheduled( 'jetpack_sync_full', array( $modules ) );
	}

	static function do_full_sync( $modules = null ) {
		if ( ! self::sync_allowed() ) {
			return;
		}

		self::initialize_listener();
		Jetpack_Sync_Modules::get_module( 'full-sync' )->start( $modules );
		self::do_cron_sync(); // immediately run a cron sync, which sends pending data
	}

	static function minute_cron_schedule( $schedules ) {
		if( ! isset( $schedules["1min"] ) ) {
			$schedules["1min"] = array(
				'interval' => 60,
				'display' => __( 'Every minute' )
			);
		}
		return $schedules;
	}

	// try to send actions until we run out of things to send,
	// or have to wait more than 15s before sending again,
	// or we hit a lock or some other sending issue
	static function do_cron_sync() {
		if ( ! self::sync_allowed() ) {
			return;
		}

		self::initialize_sender();

		// remove shutdown hook - no need to sync twice
		if ( has_action( 'shutdown', array( self::$sender, 'do_sync' ) ) ) {
			remove_action( 'shutdown', array( self::$sender, 'do_sync' ) );
		}

		do {
			$next_sync_time = self::$sender->get_next_sync_time();

			if ( $next_sync_time ) {
				$delay = $next_sync_time - time() + 1;
				if ( $delay > 15 ) {
					break;
				} elseif ( $delay > 0 ) {
					sleep( $delay );
				}
			}

			$result = self::$sender->do_sync();
		} while ( $result );
	}

	static function initialize_listener() {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
		self::$listener = Jetpack_Sync_Listener::get_instance();
	}

	static function initialize_sender() {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-sender.php';
		self::$sender = Jetpack_Sync_Sender::get_instance();

		// bind the sending process
		add_filter( 'jetpack_sync_send_data', array( __CLASS__, 'send_data' ), 10, 4 );
	}
}

// Allow other plugins to add filters before we initialize the actions.
// Load the listeners if before modules get loaded so that we can capture version changes etc.
add_action( 'init', array( 'Jetpack_Sync_Actions', 'init' ), 90 );

// We need to define this here so that it's hooked before `updating_jetpack_version` is called
add_action( 'updating_jetpack_version', array( 'Jetpack_Sync_Actions', 'schedule_initial_sync' ), 10, 2 );


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 2016-06-29 22:35 UTC by Report Bug Copy Issue Report 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 2016-06-30 03:18 UTC by Report Bug Copy Issue Report 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
15			static function init() {
16
17			// Add a custom "every minute" cron schedule
18			add_filter( 'cron_schedules', array( __CLASS__, 'minute_cron_schedule' ) );
19
20			// On jetpack authorization, schedule a full sync
21			add_action( 'jetpack_client_authorized', array( __CLASS__, 'schedule_full_sync' ), 10, 0 );
22
23			// When importing via cron, do not sync
24			add_action( 'wp_cron_importer_hook', array( __CLASS__, 'set_is_importing_true' ), 1 );
25
26			// Sync connected user role changes to .com
27			require_once dirname( __FILE__ ) . '/class.jetpack-sync-users.php';
28
29			// everything below this point should only happen if we're a valid sync site
30			if ( ! self::sync_allowed() ) {
31			return;
32			}
33
34			// publicize filter to prevent publicizing blacklisted post types
35			add_filter( 'publicize_should_publicize_published_post', array( __CLASS__, 'prevent_publicize_blacklisted_posts' ), 10, 2 );
36
37			// cron hooks
38			add_action( 'jetpack_sync_full', array( __CLASS__, 'do_full_sync' ), 10, 1 );
39			add_action( 'jetpack_sync_cron', array( __CLASS__, 'do_cron_sync' ) );
40
41			if ( ! wp_next_scheduled( 'jetpack_sync_cron' ) ) {
42			// Schedule a job to send pending queue items once a minute
43			wp_schedule_event( time(), '1min', 'jetpack_sync_cron' );
44			}
45
46			/**
47			* Fires on every request before default loading sync listener code.
48			* Return false to not load sync listener code that monitors common
49			* WP actions to be serialized.
50			*
51			* By default this returns true for cron jobs, non-GET-requests, or requests where the
52			* user is logged-in.
53			*
54			* @since 4.2.0
55			*
56			* @param bool should we load sync listener code for this request
57			*/
58			if ( apply_filters( 'jetpack_sync_listener_should_load',
59			(
60			( isset( $_SERVER["REQUEST_METHOD"] ) && 'GET' !== $_SERVER['REQUEST_METHOD'] )
61			\|\|
62			is_user_logged_in()
63			\|\|
64			defined( 'PHPUNIT_JETPACK_TESTSUITE' )
65			\|\|
66			defined( 'DOING_CRON' ) && DOING_CRON
67			)
68			) ) {
69			self::initialize_listener();
70			}
71
72			/**
73			* Fires on every request before default loading sync sender code.
74			* Return false to not load sync sender code that serializes pending
75			* data and sends it to WPCOM for processing.
76			*
77			* By default this returns true for cron jobs, POST requests, admin requests, or requests
78			* by users who can manage_options.
79			*
80			* @since 4.2.0
81			*
82			* @param bool should we load sync sender code for this request
83			*/
84			if ( apply_filters( 'jetpack_sync_sender_should_load',
85			(
86			( isset( $_SERVER["REQUEST_METHOD"] ) && 'POST' === $_SERVER['REQUEST_METHOD'] )
87			\|\|
88			current_user_can( 'manage_options' )
89			\|\|
90			is_admin()
91			\|\|
92			defined( 'PHPUNIT_JETPACK_TESTSUITE' )
93			\|\|
94			defined( 'DOING_CRON' ) && DOING_CRON
95			)
96			) ) {
97			self::initialize_sender();
98			add_action( 'shutdown', array( self::$sender, 'do_sync' ) );
99			}
100
101			}
102
103			static function sync_allowed() {
104			return ( ! Jetpack_Sync_Settings::get_setting( 'disable' ) && Jetpack::is_active() && ! ( Jetpack::is_development_mode() \|\| Jetpack::is_staging_site() ) )
105			\|\| defined( 'PHPUNIT_JETPACK_TESTSUITE' );
106			}
107
108			static function prevent_publicize_blacklisted_posts( $should_publicize, $post ) {
109			if ( in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) ) ) {
110			return false;
111			}
112
113			return $should_publicize;
114			}
115
116			static function set_is_importing_true() {
117			Jetpack_Sync_Settings::set_importing( true );
118			}
119
120			static function send_data( $data, $codec_name, $sent_timestamp, $queue_id ) {
121			Jetpack::load_xml_rpc_client();
122
123			$url = add_query_arg( array(
124			'sync' => '1', // add an extra parameter to the URL so we can tell it's a sync action
125			'codec' => $codec_name, // send the name of the codec used to encode the data
126			'timestamp' => $sent_timestamp, // send current server time so we can compensate for clock differences
127			'queue' => $queue_id, // sync or full_sync
128			), Jetpack::xmlrpc_api_url() );
129
130			$rpc = new Jetpack_IXR_Client( array(
131			'url' => $url,
132			'user_id' => JETPACK_MASTER_USER,
133			'timeout' => 30,
134			) );
135
136			$result = $rpc->query( 'jetpack.syncActions', $data );
137
138			if ( ! $result ) {
139			return $rpc->get_jetpack_error();
140			}
141
142			return $rpc->getResponse();
143			}
144
145			static function schedule_initial_sync( $new_version = null, $old_version = null ) {
146			$initial_sync_config = array(
147			'options' => true,
148			'network_options' => true,
149			'functions' => true,
150			'constants' => true,
151			);
152
153			if ( $old_version && ( version_compare( $old_version, '4.2', '<' ) ) ) {
154			$initial_sync_config['users'] = 'initial';
155			}
156
157			// we need this function call here because we have to run this function
158			// reeeeally early in init, before WP_CRON_LOCK_TIMEOUT is defined.
159			wp_functionality_constants();
160
161			if ( is_multisite() ) {
162			// stagger initial syncs for multisite blogs so they don't all pile on top of each other
163			$time_offset = ( rand() / getrandmax() ) * self::INITIAL_SYNC_MULTISITE_INTERVAL * get_blog_count();
164			} else {
165			$time_offset = 1;
166			}
167
168			self::schedule_full_sync(
169			$initial_sync_config,
170			$time_offset
171			);
172			}
173
174			static function schedule_full_sync( $modules = null, $time_offset = 1 ) {
175			if ( ! self::sync_allowed() ) {
176			return false;
177			}
178
179			if ( self::is_scheduled_full_sync() ) {
180			self::unschedule_all_full_syncs();
181			}
182
183			if ( $modules ) {
184			wp_schedule_single_event( time() + $time_offset, 'jetpack_sync_full', array( $modules ) );
185			} else {
186			wp_schedule_single_event( time() + $time_offset, 'jetpack_sync_full' );
187			}
188
189			if ( $time_offset === 1 ) {
190			spawn_cron();
191			}
192
193			return true;
194			}
195
196			static function unschedule_all_full_syncs() {
197			foreach ( _get_cron_array() as $timestamp => $cron ) {
198			if ( ! empty( $cron['jetpack_sync_full'] ) ) {
199			foreach( $cron['jetpack_sync_full'] as $key => $config ) {
200			wp_unschedule_event( $timestamp, 'jetpack_sync_full', $config['args'] );
201			}
202			}
203			}
204			}
205
206			static function is_scheduled_full_sync( $modules = null ) {
207			if ( is_null( $modules ) ) {
208			$crons = _get_cron_array();
209
210			foreach ( $crons as $timestamp => $cron ) {
211			if ( ! empty( $cron['jetpack_sync_full'] ) ) {
212			return true;
213			}
214			}
215			return false;
216			}
217
218			return !! wp_next_scheduled( 'jetpack_sync_full', array( $modules ) );
219			}
220
221			static function do_full_sync( $modules = null ) {
222			if ( ! self::sync_allowed() ) {
223			return;
224			}
225
226			self::initialize_listener();
227			Jetpack_Sync_Modules::get_module( 'full-sync' )->start( $modules );
228			self::do_cron_sync(); // immediately run a cron sync, which sends pending data
229			}
230
231			static function minute_cron_schedule( $schedules ) {
232			if( ! isset( $schedules["1min"] ) ) {
233			$schedules["1min"] = array(
234			'interval' => 60,
235			'display' => __( 'Every minute' )
236			);
237			}
238			return $schedules;
239			}
240
241			// try to send actions until we run out of things to send,
242			// or have to wait more than 15s before sending again,
243			// or we hit a lock or some other sending issue
244			static function do_cron_sync() {
245			if ( ! self::sync_allowed() ) {
246			return;
247			}
248
249			self::initialize_sender();
250
251			// remove shutdown hook - no need to sync twice
252			if ( has_action( 'shutdown', array( self::$sender, 'do_sync' ) ) ) {
253			remove_action( 'shutdown', array( self::$sender, 'do_sync' ) );
254			}
255
256			do {
257			$next_sync_time = self::$sender->get_next_sync_time();
258
259			if ( $next_sync_time ) {
260			$delay = $next_sync_time - time() + 1;
261			if ( $delay > 15 ) {
262			break;
263			} elseif ( $delay > 0 ) {
264			sleep( $delay );
265			}
266			}
267
268			$result = self::$sender->do_sync();
269			} while ( $result );
270			}
271
272			static function initialize_listener() {
273			require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
274			self::$listener = Jetpack_Sync_Listener::get_instance();
275			}
276
277			static function initialize_sender() {
278			require_once dirname( __FILE__ ) . '/class.jetpack-sync-sender.php';
279			self::$sender = Jetpack_Sync_Sender::get_instance();
280
281			// bind the sending process
282			add_filter( 'jetpack_sync_send_data', array( __CLASS__, 'send_data' ), 10, 4 );
283			}
284			}
285
286			// Allow other plugins to add filters before we initialize the actions.
287			// Load the listeners if before modules get loaded so that we can capture version changes etc.
288			add_action( 'init', array( 'Jetpack_Sync_Actions', 'init' ), 90 );
289
290			// We need to define this here so that it's hooked before `updating_jetpack_version` is called
291			add_action( 'updating_jetpack_version', array( 'Jetpack_Sync_Actions', 'schedule_initial_sync' ), 10, 2 );
292

Automattic / jetpack

Push — update/admin-page-readme-more-... ( 8f2301...4565b6 )

Jetpack_Sync_Actions::schedule_initial_sync() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like