Jetpack_Sync_Actions::__construct() - Code Metrics - Inspection of "Removed initialization calls on some Sync objects,..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/sync-package-migrate-is... ( 322353...de5291 )

unknown

created 2019-06-12 22:50 UTC

Jetpack_Sync_Actions::__construct() A

↳ Parent: Jetpack_Sync_Actions

Complexity

Conditions	5
Paths	7

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	7
nop	1
dl	0
loc	38
rs	9.0008
c	0
b	0
f	0

<?php

use Automattic\Jetpack\Connection\Manager as Connection_Manager;
use Automattic\Jetpack\Constants;

/**
 * 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;
	static $listener                       = null;
	const DEFAULT_SYNC_CRON_INTERVAL_NAME  = 'jetpack_sync_interval';
	const DEFAULT_SYNC_CRON_INTERVAL_VALUE = 300; // 5 * MINUTE_IN_SECONDS;

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

		if ( self::sync_via_cron_allowed() ) {
			self::init_sync_cron_jobs();
		} elseif ( wp_next_scheduled( 'jetpack_sync_cron' ) ) {
			self::clear_sync_cron_jobs();
		}
		// 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
		new Jetpack_Sync_Users( $connection );

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

		/**
		 * 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', true ) ) {
			self::initialize_listener();
		}

		add_action( 'init', array( __CLASS__, 'add_sender_shutdown' ), 90 );
	}

	static function add_sender_shutdown() {
		/**
		 * 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',
			self::should_initialize_sender()
		) ) {
			self::initialize_sender();
			add_action( 'shutdown', array( self::$sender, 'do_sync' ) );
			add_action( 'shutdown', array( self::$sender, 'do_full_sync' ) );
		}
	}

	static function should_initialize_sender() {
		if ( Constants::is_true( 'DOING_CRON' ) ) {
			return self::sync_via_cron_allowed();
		}

		if ( isset( $_SERVER['REQUEST_METHOD'] ) && 'POST' === $_SERVER['REQUEST_METHOD'] ) {
			return true;
		}

		if ( current_user_can( 'manage_options' ) ) {
			return true;
		}

		if ( is_admin() ) {
			return true;
		}

		if ( defined( 'PHPUNIT_JETPACK_TESTSUITE' ) ) {
			return true;
		}

		return false;
	}

	static function sync_allowed() {
		if ( defined( 'PHPUNIT_JETPACK_TESTSUITE' ) ) {
			return true;
		}
		if ( ! Jetpack_Sync_Settings::is_sync_enabled() ) {
			return false;
		}
		if ( Jetpack::is_development_mode() ) {
			return false;
		}
		if ( Jetpack::is_staging_site() ) {
			return false;
		}

		$connection_manager = Jetpack_Sync_Main::init()->get_connection_manager();

		if ( ! $connection_manager->is_active() ) {
			if ( ! doing_action( 'jetpack_user_authorized' ) ) {
				return false;
			}
		}

		return true;
	}

	static function sync_via_cron_allowed() {
		return ( Jetpack_Sync_Settings::get_setting( 'sync_via_cron' ) );
	}

	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, $checkout_duration, $preprocess_duration ) {
		Jetpack::load_xml_rpc_client();

		$query_args = 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
			'home'      => Jetpack_Sync_Functions::home_url(),  // Send home url option to check for Identity Crisis server-side
			'siteurl'   => Jetpack_Sync_Functions::site_url(),  // Send siteurl option to check for Identity Crisis server-side
			'cd'        => sprintf( '%.4f', $checkout_duration ),   // Time spent retrieving queue items from the DB
			'pd'        => sprintf( '%.4f', $preprocess_duration ), // Time spent converting queue items into data to send
		);

		// Has the site opted in to IDC mitigation?
		if ( Jetpack::sync_idc_optin() ) {
			$query_args['idc'] = true;
		}

		if ( Jetpack_Options::get_option( 'migrate_for_idc', false ) ) {
			$query_args['migrate_for_idc'] = true;
		}

		$query_args['timeout'] = Jetpack_Sync_Settings::is_doing_cron() ? 30 : 15;

		/**
		 * Filters query parameters appended to the Sync request URL sent to WordPress.com.
		 *
		 * @since 4.7.0
		 *
		 * @param array $query_args associative array of query parameters.
		 */
		$query_args = apply_filters( 'jetpack_sync_send_data_query_args', $query_args );

		$url = add_query_arg( $query_args, Jetpack::xmlrpc_api_url() );

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

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

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

		$response = $rpc->getResponse();

		// Check if WordPress.com IDC mitigation blocked the sync request
		if ( is_array( $response ) && isset( $response['error_code'] ) ) {
			$error_code              = $response['error_code'];
			$allowed_idc_error_codes = array(
				'jetpack_url_mismatch',
				'jetpack_home_url_mismatch',
				'jetpack_site_url_mismatch',
			);

			if ( in_array( $error_code, $allowed_idc_error_codes ) ) {
				Jetpack_Options::update_option(
					'sync_error_idc',
					Jetpack::get_sync_error_idc_option( $response )
				);
			}

			return new WP_Error(
				'sync_error_idc',
				esc_html__( 'Sync has been blocked from WordPress.com because it would cause an identity crisis', 'jetpack' )
			);
		}

		return $response;
	}

	static function do_initial_sync() {
		// Lets not sync if we are not suppose to.
		if ( ! self::sync_allowed() ) {
			return false;
		}

		$initial_sync_config = array(
			'options'   => true,
			'functions' => true,
			'constants' => true,
			'users'     => array( get_current_user_id() ),
		);

		if ( is_multisite() ) {
			$initial_sync_config['network_options'] = true;
		}

		self::do_full_sync( $initial_sync_config );
	}

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

		$full_sync_module = Jetpack_Sync_Modules::get_module( 'full-sync' );

		if ( ! $full_sync_module ) {
			return false;
		}

		self::initialize_listener();

		$full_sync_module->start( $modules );

		return true;
	}

	static function jetpack_cron_schedule( $schedules ) {
		if ( ! isset( $schedules[ self::DEFAULT_SYNC_CRON_INTERVAL_NAME ] ) ) {
			$schedules[ self::DEFAULT_SYNC_CRON_INTERVAL_NAME ] = array(
				'interval' => self::DEFAULT_SYNC_CRON_INTERVAL_VALUE,
				'display'  => sprintf(
					esc_html( _n( 'Every minute', 'Every %d minutes', intval( self::DEFAULT_SYNC_CRON_INTERVAL_VALUE / 60 ), 'jetpack' ) ),
					intval( self::DEFAULT_SYNC_CRON_INTERVAL_VALUE / 60 )
				),
			);
		}
		return $schedules;
	}

	static function do_cron_sync() {
		self::do_cron_sync_by_type( 'sync' );
	}

	static function do_cron_full_sync() {
		self::do_cron_sync_by_type( 'full_sync' );
	}

	/**
	 * 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
	 *
	 * @param string $type Sync type. Can be `sync` or `full_sync`.
	 */
	static function do_cron_sync_by_type( $type ) {
		if ( ! self::sync_allowed() || ( 'sync' !== $type && 'full_sync' !== $type ) ) {
			return;
		}

		self::initialize_sender();

		$time_limit = Jetpack_Sync_Settings::get_setting( 'cron_sync_time_limit' );
		$start_time = time();

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

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

			$result = 'full_sync' === $type ? self::$sender->do_full_sync() : self::$sender->do_sync();
		} while ( $result && ! is_wp_error( $result ) && ( $start_time + $time_limit ) > time() );
	}

	static function initialize_listener() {
		self::$listener = Jetpack_Sync_Listener::get_instance();
	}

	static function initialize_sender() {
		self::$sender = Jetpack_Sync_Sender::get_instance();

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

	static function initialize_woocommerce() {
		if ( false === class_exists( 'WooCommerce' ) ) {
			return;
		}
		add_filter( 'jetpack_sync_modules', array( 'Jetpack_Sync_Actions', 'add_woocommerce_sync_module' ) );
	}

	static function add_woocommerce_sync_module( $sync_modules ) {
		$sync_modules[] = 'Jetpack_Sync_Module_WooCommerce';
		return $sync_modules;
	}

	static function initialize_wp_super_cache() {
		if ( false === function_exists( 'wp_cache_is_enabled' ) ) {
			return;
		}
		add_filter( 'jetpack_sync_modules', array( 'Jetpack_Sync_Actions', 'add_wp_super_cache_sync_module' ) );
	}

	static function add_wp_super_cache_sync_module( $sync_modules ) {
		$sync_modules[] = 'Jetpack_Sync_Module_WP_Super_Cache';
		return $sync_modules;
	}

	static function sanitize_filtered_sync_cron_schedule( $schedule ) {
		$schedule  = sanitize_key( $schedule );
		$schedules = wp_get_schedules();

		// Make sure that the schedule has actually been registered using the `cron_intervals` filter.
		if ( isset( $schedules[ $schedule ] ) ) {
			return $schedule;
		}

		return self::DEFAULT_SYNC_CRON_INTERVAL_NAME;
	}

	static function get_start_time_offset( $schedule = '', $hook = '' ) {
		$start_time_offset = is_multisite()
			? mt_rand( 0, ( 2 * self::DEFAULT_SYNC_CRON_INTERVAL_VALUE ) )
			: 0;

		/**
		 * Allows overriding the offset that the sync cron jobs will first run. This can be useful when scheduling
		 * cron jobs across multiple sites in a network.
		 *
		 * @since 4.5.0
		 *
		 * @param int    $start_time_offset
		 * @param string $hook
		 * @param string $schedule
		 */
		return intval(
			apply_filters(
				'jetpack_sync_cron_start_time_offset',
				$start_time_offset,
				$hook,
				$schedule
			)
		);
	}

	static function maybe_schedule_sync_cron( $schedule, $hook ) {
		if ( ! $hook ) {
			return;
		}
		$schedule = self::sanitize_filtered_sync_cron_schedule( $schedule );

		$start_time = time() + self::get_start_time_offset( $schedule, $hook );
		if ( ! wp_next_scheduled( $hook ) ) {
			// Schedule a job to send pending queue items once a minute
			wp_schedule_event( $start_time, $schedule, $hook );
		} elseif ( $schedule != wp_get_schedule( $hook ) ) {
			// If the schedule has changed, update the schedule
			wp_clear_scheduled_hook( $hook );
			wp_schedule_event( $start_time, $schedule, $hook );
		}
	}

	static function clear_sync_cron_jobs() {
		wp_clear_scheduled_hook( 'jetpack_sync_cron' );
		wp_clear_scheduled_hook( 'jetpack_sync_full_cron' );
	}

	static function init_sync_cron_jobs() {
		add_filter( 'cron_schedules', array( __CLASS__, 'jetpack_cron_schedule' ) );

		add_action( 'jetpack_sync_cron', array( __CLASS__, 'do_cron_sync' ) );
		add_action( 'jetpack_sync_full_cron', array( __CLASS__, 'do_cron_full_sync' ) );

		/**
		 * Allows overriding of the default incremental sync cron schedule which defaults to once every 5 minutes.
		 *
		 * @since 4.3.2
		 *
		 * @param string self::DEFAULT_SYNC_CRON_INTERVAL_NAME
		 */
		$incremental_sync_cron_schedule = apply_filters( 'jetpack_sync_incremental_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL_NAME );
		self::maybe_schedule_sync_cron( $incremental_sync_cron_schedule, 'jetpack_sync_cron' );

		/**
		 * Allows overriding of the full sync cron schedule which defaults to once every 5 minutes.
		 *
		 * @since 4.3.2
		 *
		 * @param string self::DEFAULT_SYNC_CRON_INTERVAL_NAME
		 */
		$full_sync_cron_schedule = apply_filters( 'jetpack_sync_full_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL_NAME );
		self::maybe_schedule_sync_cron( $full_sync_cron_schedule, 'jetpack_sync_full_cron' );
	}

	static function cleanup_on_upgrade( $new_version = null, $old_version = null ) {
		if ( wp_next_scheduled( 'jetpack_sync_send_db_checksum' ) ) {
			wp_clear_scheduled_hook( 'jetpack_sync_send_db_checksum' );
		}

		$is_new_sync_upgrade = version_compare( $old_version, '4.2', '>=' );
		if ( ! empty( $old_version ) && $is_new_sync_upgrade && version_compare( $old_version, '4.5', '<' ) ) {
			self::clear_sync_cron_jobs();
			Jetpack_Sync_Settings::update_settings(
				array(
					'render_filtered_content' => Jetpack_Sync_Defaults::$default_render_filtered_content,

				)
			);
		}
	}

	/**
	 * Get the sync status
	 *
	 * @param string|null $fields A comma-separated string of the fields to include in the array from the JSON response.
	 * @return array
	 */
	static function get_sync_status( $fields = null ) {
		self::initialize_sender();

		$sync_module     = Jetpack_Sync_Modules::get_module( 'full-sync' );
		$queue           = self::$sender->get_sync_queue();
		$full_queue      = self::$sender->get_full_sync_queue();
		$cron_timestamps = array_keys( _get_cron_array() );
		$next_cron       = $cron_timestamps[0] - time();

		$checksums = array();

		if ( ! empty( $fields ) ) {
			$store         = new Jetpack_Sync_WP_Replicastore();
			$fields_params = array_map( 'trim', explode( ',', $fields ) );

			if ( in_array( 'posts_checksum', $fields_params, true ) ) {
				$checksums['posts_checksum'] = $store->posts_checksum();
			}
			if ( in_array( 'comments_checksum', $fields_params, true ) ) {
				$checksums['comments_checksum'] = $store->comments_checksum();
			}
			if ( in_array( 'post_meta_checksum', $fields_params, true ) ) {
				$checksums['post_meta_checksum'] = $store->post_meta_checksum();
			}
			if ( in_array( 'comment_meta_checksum', $fields_params, true ) ) {
				$checksums['comment_meta_checksum'] = $store->comment_meta_checksum();
			}
		}

		$full_sync_status = ( $sync_module ) ? $sync_module->get_status() : array();

		return array_merge(
			$full_sync_status,
			$checksums,
			array(
				'cron_size'            => count( $cron_timestamps ),
				'next_cron'            => $next_cron,
				'queue_size'           => $queue->size(),
				'queue_lag'            => $queue->lag(),
				'queue_next_sync'      => ( self::$sender->get_next_sync_time( 'sync' ) - microtime( true ) ),
				'full_queue_size'      => $full_queue->size(),
				'full_queue_lag'       => $full_queue->lag(),
				'full_queue_next_sync' => ( self::$sender->get_next_sync_time( 'full_sync' ) - microtime( true ) ),
			)
		);
	}
}


1			<?php
2
3			use Automattic\Jetpack\Connection\Manager as Connection_Manager;
4			use Automattic\Jetpack\Constants;
5
6			/**
7			* The role of this class is to hook the Sync subsystem into WordPress - when to listen for actions,
8			* when to send, when to perform a full sync, etc.
9			*
10			* It also binds the action to send data to WPCOM to Jetpack's XMLRPC client object.
11			*/
12			class Jetpack_Sync_Actions {
13			static $sender = null;
14			static $listener = null;
15			const DEFAULT_SYNC_CRON_INTERVAL_NAME = 'jetpack_sync_interval';
16			const DEFAULT_SYNC_CRON_INTERVAL_VALUE = 300; // 5 * MINUTE_IN_SECONDS;
17
18			public function __construct( Connection_Manager $connection ) {
19			// everything below this point should only happen if we're a valid sync site
20			if ( ! self::sync_allowed() ) {
21			return;
22			}
23
24			if ( self::sync_via_cron_allowed() ) {
25			self::init_sync_cron_jobs();
26			} elseif ( wp_next_scheduled( 'jetpack_sync_cron' ) ) {
27			self::clear_sync_cron_jobs();
28			}
29			// When importing via cron, do not sync
30			add_action( 'wp_cron_importer_hook', array( __CLASS__, 'set_is_importing_true' ), 1 );
31
32			// Sync connected user role changes to .com
33			new Jetpack_Sync_Users( $connection );
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			/**
39			* Fires on every request before default loading sync listener code.
40			* Return false to not load sync listener code that monitors common
41			* WP actions to be serialized.
42			*
43			* By default this returns true for cron jobs, non-GET-requests, or requests where the
44			* user is logged-in.
45			*
46			* @since 4.2.0
47			*
48			* @param bool should we load sync listener code for this request
49			*/
50			if ( apply_filters( 'jetpack_sync_listener_should_load', true ) ) {
51			self::initialize_listener();
52			}
53
54			add_action( 'init', array( __CLASS__, 'add_sender_shutdown' ), 90 );
55			}
56
57			static function add_sender_shutdown() {
58			/**
59			* Fires on every request before default loading sync sender code.
60			* Return false to not load sync sender code that serializes pending
61			* data and sends it to WPCOM for processing.
62			*
63			* By default this returns true for cron jobs, POST requests, admin requests, or requests
64			* by users who can manage_options.
65			*
66			* @since 4.2.0
67			*
68			* @param bool should we load sync sender code for this request
69			*/
70			if ( apply_filters(
71			'jetpack_sync_sender_should_load',
72			self::should_initialize_sender()
73			) ) {
74			self::initialize_sender();
75			add_action( 'shutdown', array( self::$sender, 'do_sync' ) );
76			add_action( 'shutdown', array( self::$sender, 'do_full_sync' ) );
77			}
78			}
79
80			static function should_initialize_sender() {
81			if ( Constants::is_true( 'DOING_CRON' ) ) {
82			return self::sync_via_cron_allowed();
83			}
84
85			if ( isset( $_SERVER['REQUEST_METHOD'] ) && 'POST' === $_SERVER['REQUEST_METHOD'] ) {
86			return true;
87			}
88
89			if ( current_user_can( 'manage_options' ) ) {
90			return true;
91			}
92
93			if ( is_admin() ) {
94			return true;
95			}
96
97			if ( defined( 'PHPUNIT_JETPACK_TESTSUITE' ) ) {
98			return true;
99			}
100
101			return false;
102			}
103
104			static function sync_allowed() {
105			if ( defined( 'PHPUNIT_JETPACK_TESTSUITE' ) ) {
106			return true;
107			}
108			if ( ! Jetpack_Sync_Settings::is_sync_enabled() ) {
109			return false;
110			}
111			if ( Jetpack::is_development_mode() ) {
112			return false;
113			}
114			if ( Jetpack::is_staging_site() ) {
115			return false;
116			}
117
118			$connection_manager = Jetpack_Sync_Main::init()->get_connection_manager();
			0 ignored issues – show Bug introduced 2019-06-13 04:50 UTC by Report Bug Copy Issue Report The method `init()` does not seem to exist on `object<Jetpack_Sync_Main>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
119			if ( ! $connection_manager->is_active() ) {
120			if ( ! doing_action( 'jetpack_user_authorized' ) ) {
121			return false;
122			}
123			}
124
125			return true;
126			}
127
128			static function sync_via_cron_allowed() {
129			return ( Jetpack_Sync_Settings::get_setting( 'sync_via_cron' ) );
130			}
131
132			static function prevent_publicize_blacklisted_posts( $should_publicize, $post ) {
133			if ( in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) ) ) {
134			return false;
135			}
136
137			return $should_publicize;
138			}
139
140			static function set_is_importing_true() {
141			Jetpack_Sync_Settings::set_importing( true );
142			}
143
144			static function send_data( $data, $codec_name, $sent_timestamp, $queue_id, $checkout_duration, $preprocess_duration ) {
145			Jetpack::load_xml_rpc_client();
146
147			$query_args = array(
148			'sync' => '1', // add an extra parameter to the URL so we can tell it's a sync action
149			'codec' => $codec_name, // send the name of the codec used to encode the data
150			'timestamp' => $sent_timestamp, // send current server time so we can compensate for clock differences
151			'queue' => $queue_id, // sync or full_sync
152			'home' => Jetpack_Sync_Functions::home_url(), // Send home url option to check for Identity Crisis server-side
153			'siteurl' => Jetpack_Sync_Functions::site_url(), // Send siteurl option to check for Identity Crisis server-side
154			'cd' => sprintf( '%.4f', $checkout_duration ), // Time spent retrieving queue items from the DB
155			'pd' => sprintf( '%.4f', $preprocess_duration ), // Time spent converting queue items into data to send
156			);
157
158			// Has the site opted in to IDC mitigation?
159			if ( Jetpack::sync_idc_optin() ) {
160			$query_args['idc'] = true;
161			}
162
163			if ( Jetpack_Options::get_option( 'migrate_for_idc', false ) ) {
164			$query_args['migrate_for_idc'] = true;
165			}
166
167			$query_args['timeout'] = Jetpack_Sync_Settings::is_doing_cron() ? 30 : 15;
168
169			/**
170			* Filters query parameters appended to the Sync request URL sent to WordPress.com.
171			*
172			* @since 4.7.0
173			*
174			* @param array $query_args associative array of query parameters.
175			*/
176			$query_args = apply_filters( 'jetpack_sync_send_data_query_args', $query_args );
177
178			$url = add_query_arg( $query_args, Jetpack::xmlrpc_api_url() );
179
180			$rpc = new Jetpack_IXR_Client(
181			array(
182			'url' => $url,
183			'user_id' => JETPACK_MASTER_USER,
184			'timeout' => $query_args['timeout'],
185			)
186			);
187
188			$result = $rpc->query( 'jetpack.syncActions', $data );
189
190			if ( ! $result ) {
191			return $rpc->get_jetpack_error();
192			}
193
194			$response = $rpc->getResponse();
195
196			// Check if WordPress.com IDC mitigation blocked the sync request
197			if ( is_array( $response ) && isset( $response['error_code'] ) ) {
198			$error_code = $response['error_code'];
199			$allowed_idc_error_codes = array(
200			'jetpack_url_mismatch',
201			'jetpack_home_url_mismatch',
202			'jetpack_site_url_mismatch',
203			);
204
205			if ( in_array( $error_code, $allowed_idc_error_codes ) ) {
206			Jetpack_Options::update_option(
207			'sync_error_idc',
208			Jetpack::get_sync_error_idc_option( $response )
209			);
210			}
211
212			return new WP_Error(
213			'sync_error_idc',
214			esc_html__( 'Sync has been blocked from WordPress.com because it would cause an identity crisis', 'jetpack' )
215			);
216			}
217
218			return $response;
219			}
220
221			static function do_initial_sync() {
222			// Lets not sync if we are not suppose to.
223			if ( ! self::sync_allowed() ) {
224			return false;
225			}
226
227			$initial_sync_config = array(
228			'options' => true,
229			'functions' => true,
230			'constants' => true,
231			'users' => array( get_current_user_id() ),
232			);
233
234			if ( is_multisite() ) {
235			$initial_sync_config['network_options'] = true;
236			}
237
238			self::do_full_sync( $initial_sync_config );
239			}
240
241			static function do_full_sync( $modules = null ) {
242			if ( ! self::sync_allowed() ) {
243			return false;
244			}
245
246			$full_sync_module = Jetpack_Sync_Modules::get_module( 'full-sync' );
247
248			if ( ! $full_sync_module ) {
249			return false;
250			}
251
252			self::initialize_listener();
253
254			$full_sync_module->start( $modules );
255
256			return true;
257			}
258
259			static function jetpack_cron_schedule( $schedules ) {
260			if ( ! isset( $schedules[ self::DEFAULT_SYNC_CRON_INTERVAL_NAME ] ) ) {
261			$schedules[ self::DEFAULT_SYNC_CRON_INTERVAL_NAME ] = array(
262			'interval' => self::DEFAULT_SYNC_CRON_INTERVAL_VALUE,
263			'display' => sprintf(
264			esc_html( _n( 'Every minute', 'Every %d minutes', intval( self::DEFAULT_SYNC_CRON_INTERVAL_VALUE / 60 ), 'jetpack' ) ),
265			intval( self::DEFAULT_SYNC_CRON_INTERVAL_VALUE / 60 )
266			),
267			);
268			}
269			return $schedules;
270			}
271
272			static function do_cron_sync() {
273			self::do_cron_sync_by_type( 'sync' );
274			}
275
276			static function do_cron_full_sync() {
277			self::do_cron_sync_by_type( 'full_sync' );
278			}
279
280			/**
281			* Try to send actions until we run out of things to send,
282			* or have to wait more than 15s before sending again,
283			* or we hit a lock or some other sending issue
284			*
285			* @param string $type Sync type. Can be `sync` or `full_sync`.
286			*/
287			static function do_cron_sync_by_type( $type ) {
288			if ( ! self::sync_allowed() \|\| ( 'sync' !== $type && 'full_sync' !== $type ) ) {
289			return;
290			}
291
292			self::initialize_sender();
293
294			$time_limit = Jetpack_Sync_Settings::get_setting( 'cron_sync_time_limit' );
295			$start_time = time();
296
297			do {
298			$next_sync_time = self::$sender->get_next_sync_time( $type );
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 = 'full_sync' === $type ? self::$sender->do_full_sync() : self::$sender->do_sync();
310			} while ( $result && ! is_wp_error( $result ) && ( $start_time + $time_limit ) > time() );
311			}
312
313			static function initialize_listener() {
314			self::$listener = Jetpack_Sync_Listener::get_instance();
315			}
316
317			static function initialize_sender() {
318			self::$sender = Jetpack_Sync_Sender::get_instance();
319
320			// bind the sending process
321			add_filter( 'jetpack_sync_send_data', array( __CLASS__, 'send_data' ), 10, 6 );
322			}
323
324			static function initialize_woocommerce() {
325			if ( false === class_exists( 'WooCommerce' ) ) {
326			return;
327			}
328			add_filter( 'jetpack_sync_modules', array( 'Jetpack_Sync_Actions', 'add_woocommerce_sync_module' ) );
329			}
330
331			static function add_woocommerce_sync_module( $sync_modules ) {
332			$sync_modules[] = 'Jetpack_Sync_Module_WooCommerce';
333			return $sync_modules;
334			}
335
336			static function initialize_wp_super_cache() {
337			if ( false === function_exists( 'wp_cache_is_enabled' ) ) {
338			return;
339			}
340			add_filter( 'jetpack_sync_modules', array( 'Jetpack_Sync_Actions', 'add_wp_super_cache_sync_module' ) );
341			}
342
343			static function add_wp_super_cache_sync_module( $sync_modules ) {
344			$sync_modules[] = 'Jetpack_Sync_Module_WP_Super_Cache';
345			return $sync_modules;
346			}
347
348			static function sanitize_filtered_sync_cron_schedule( $schedule ) {
349			$schedule = sanitize_key( $schedule );
350			$schedules = wp_get_schedules();
351
352			// Make sure that the schedule has actually been registered using the `cron_intervals` filter.
353			if ( isset( $schedules[ $schedule ] ) ) {
354			return $schedule;
355			}
356
357			return self::DEFAULT_SYNC_CRON_INTERVAL_NAME;
358			}
359
360			static function get_start_time_offset( $schedule = '', $hook = '' ) {
361			$start_time_offset = is_multisite()
362			? mt_rand( 0, ( 2 * self::DEFAULT_SYNC_CRON_INTERVAL_VALUE ) )
363			: 0;
364
365			/**
366			* Allows overriding the offset that the sync cron jobs will first run. This can be useful when scheduling
367			* cron jobs across multiple sites in a network.
368			*
369			* @since 4.5.0
370			*
371			* @param int $start_time_offset
372			* @param string $hook
373			* @param string $schedule
374			*/
375			return intval(
376			apply_filters(
377			'jetpack_sync_cron_start_time_offset',
378			$start_time_offset,
379			$hook,
380			$schedule
381			)
382			);
383			}
384
385			static function maybe_schedule_sync_cron( $schedule, $hook ) {
386			if ( ! $hook ) {
387			return;
388			}
389			$schedule = self::sanitize_filtered_sync_cron_schedule( $schedule );
390
391			$start_time = time() + self::get_start_time_offset( $schedule, $hook );
392			if ( ! wp_next_scheduled( $hook ) ) {
393			// Schedule a job to send pending queue items once a minute
394			wp_schedule_event( $start_time, $schedule, $hook );
395			} elseif ( $schedule != wp_get_schedule( $hook ) ) {
396			// If the schedule has changed, update the schedule
397			wp_clear_scheduled_hook( $hook );
398			wp_schedule_event( $start_time, $schedule, $hook );
399			}
400			}
401
402			static function clear_sync_cron_jobs() {
403			wp_clear_scheduled_hook( 'jetpack_sync_cron' );
404			wp_clear_scheduled_hook( 'jetpack_sync_full_cron' );
405			}
406
407			static function init_sync_cron_jobs() {
408			add_filter( 'cron_schedules', array( __CLASS__, 'jetpack_cron_schedule' ) );
409
410			add_action( 'jetpack_sync_cron', array( __CLASS__, 'do_cron_sync' ) );
411			add_action( 'jetpack_sync_full_cron', array( __CLASS__, 'do_cron_full_sync' ) );
412
413			/**
414			* Allows overriding of the default incremental sync cron schedule which defaults to once every 5 minutes.
415			*
416			* @since 4.3.2
417			*
418			* @param string self::DEFAULT_SYNC_CRON_INTERVAL_NAME
419			*/
420			$incremental_sync_cron_schedule = apply_filters( 'jetpack_sync_incremental_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL_NAME );
421			self::maybe_schedule_sync_cron( $incremental_sync_cron_schedule, 'jetpack_sync_cron' );
422
423			/**
424			* Allows overriding of the full sync cron schedule which defaults to once every 5 minutes.
425			*
426			* @since 4.3.2
427			*
428			* @param string self::DEFAULT_SYNC_CRON_INTERVAL_NAME
429			*/
430			$full_sync_cron_schedule = apply_filters( 'jetpack_sync_full_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL_NAME );
431			self::maybe_schedule_sync_cron( $full_sync_cron_schedule, 'jetpack_sync_full_cron' );
432			}
433
434			static function cleanup_on_upgrade( $new_version = null, $old_version = null ) {
435			if ( wp_next_scheduled( 'jetpack_sync_send_db_checksum' ) ) {
436			wp_clear_scheduled_hook( 'jetpack_sync_send_db_checksum' );
437			}
438
439			$is_new_sync_upgrade = version_compare( $old_version, '4.2', '>=' );
440			if ( ! empty( $old_version ) && $is_new_sync_upgrade && version_compare( $old_version, '4.5', '<' ) ) {
441			self::clear_sync_cron_jobs();
442			Jetpack_Sync_Settings::update_settings(
443			array(
444			'render_filtered_content' => Jetpack_Sync_Defaults::$default_render_filtered_content,
			0 ignored issues – show Bug introduced 2017-01-13 19:50 UTC by Report Bug Copy Issue Report The property `default_render_filtered_content` cannot be accessed from this context as it is declared `private` in class `Jetpack_Sync_Defaults`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
445			)
446			);
447			}
448			}
449
450			/**
451			* Get the sync status
452			*
453			* @param string\|null $fields A comma-separated string of the fields to include in the array from the JSON response.
454			* @return array
455			*/
456			static function get_sync_status( $fields = null ) {
457			self::initialize_sender();
458
459			$sync_module = Jetpack_Sync_Modules::get_module( 'full-sync' );
460			$queue = self::$sender->get_sync_queue();
461			$full_queue = self::$sender->get_full_sync_queue();
462			$cron_timestamps = array_keys( _get_cron_array() );
463			$next_cron = $cron_timestamps[0] - time();
464
465			$checksums = array();
466
467			if ( ! empty( $fields ) ) {
468			$store = new Jetpack_Sync_WP_Replicastore();
469			$fields_params = array_map( 'trim', explode( ',', $fields ) );
470
471			if ( in_array( 'posts_checksum', $fields_params, true ) ) {
472			$checksums['posts_checksum'] = $store->posts_checksum();
473			}
474			if ( in_array( 'comments_checksum', $fields_params, true ) ) {
475			$checksums['comments_checksum'] = $store->comments_checksum();
476			}
477			if ( in_array( 'post_meta_checksum', $fields_params, true ) ) {
478			$checksums['post_meta_checksum'] = $store->post_meta_checksum();
479			}
480			if ( in_array( 'comment_meta_checksum', $fields_params, true ) ) {
481			$checksums['comment_meta_checksum'] = $store->comment_meta_checksum();
482			}
483			}
484
485			$full_sync_status = ( $sync_module ) ? $sync_module->get_status() : array();
486
487			return array_merge(
488			$full_sync_status,
489			$checksums,
490			array(
491			'cron_size' => count( $cron_timestamps ),
492			'next_cron' => $next_cron,
493			'queue_size' => $queue->size(),
494			'queue_lag' => $queue->lag(),
495			'queue_next_sync' => ( self::$sender->get_next_sync_time( 'sync' ) - microtime( true ) ),
496			'full_queue_size' => $full_queue->size(),
497			'full_queue_lag' => $full_queue->lag(),
498			'full_queue_next_sync' => ( self::$sender->get_next_sync_time( 'full_sync' ) - microtime( true ) ),
499			)
500			);
501			}
502			}
503

Automattic / jetpack

Push — update/sync-package-migrate-is... ( 322353...de5291 )

Jetpack_Sync_Actions::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like