Jetpack_Sync_Actions::should_initialize_sender() - Code Metrics - Inspection of "Refactor conditions under which sync sender loads,..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/disable-any-sending-when-c... ( 9edfff...6db7aa )

unknown

created 2019-05-08 18:04 UTC

Jetpack_Sync_Actions::should_initialize_sender() B

↳ Parent: Jetpack_Sync_Actions

Complexity

Conditions	7
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
nc	6
nop	0
dl	0
loc	23
rs	8.6186
c	0
b	0
f	0

<?php

require_once dirname( __FILE__ ) . '/class.jetpack-sync-modules.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;
	static $listener                       = null;
	const DEFAULT_SYNC_CRON_INTERVAL_NAME  = 'jetpack_sync_interval';
	const DEFAULT_SYNC_CRON_INTERVAL_VALUE = 300; // 5 * MINUTE_IN_SECONDS;

	static function init() {

		// 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
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-users.php';

		// 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 ( Jetpack_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;
		}
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
		if ( ! Jetpack_Sync_Settings::is_sync_enabled() ) {
			return false;
		}
		if ( Jetpack::is_development_mode() ) {
			return false;
		}
		if ( Jetpack::is_staging_site() ) {
			return false;
		}
		if ( ! Jetpack::is_active() ) {
			if ( ! doing_action( 'jetpack_user_authorized' ) ) {
				return false;
			}
		}

		return true;
	}

	static function sync_via_cron_allowed() {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
		return ( Jetpack_Sync_Settings::get_setting( 'sync_via_cron' ) );
	}

	static function prevent_publicize_blacklisted_posts( $should_publicize, $post ) {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
		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() {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
		Jetpack_Sync_Settings::set_importing( true );
	}

	static function send_data( $data, $codec_name, $sent_timestamp, $queue_id, $checkout_duration, $preprocess_duration ) {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-functions.php';
		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() {
		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, 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 ) {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-module-woocommerce.php';
		$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 ) {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-module-wp-super-cache.php';
		$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', '<' ) ) {
			require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
			self::clear_sync_cron_jobs();
			Jetpack_Sync_Settings::update_settings(
				array(
					'render_filtered_content' => Jetpack_Sync_Defaults::$default_render_filtered_content,

				)
			);
		}
	}

	static function get_sync_status() {
		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();

		$full_sync_status = ( $sync_module ) ? $sync_module->get_status() : array();
		return array_merge(
			$full_sync_status,
			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 ) ),
			)
		);
	}
}

// Check for WooCommerce support
add_action( 'plugins_loaded', array( 'Jetpack_Sync_Actions', 'initialize_woocommerce' ), 5 );

// Check for WP Super Cache
add_action( 'plugins_loaded', array( 'Jetpack_Sync_Actions', 'initialize_wp_super_cache' ), 5 );

/*
 * Init after plugins loaded and before the `init` action. This helps with issues where plugins init
 * with a high priority or sites that use alternate cron.
 */
add_action( 'plugins_loaded', 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', 'cleanup_on_upgrade' ), 10, 2 );
add_action( 'jetpack_user_authorized', array( 'Jetpack_Sync_Actions', 'do_initial_sync' ), 10, 0 );



1			<?php
2
3			require_once dirname( __FILE__ ) . '/class.jetpack-sync-modules.php';
4
5			/**
6			* The role of this class is to hook the Sync subsystem into WordPress - when to listen for actions,
7			* when to send, when to perform a full sync, etc.
8			*
9			* It also binds the action to send data to WPCOM to Jetpack's XMLRPC client object.
10			*/
11			class Jetpack_Sync_Actions {
12			static $sender = null;
13			static $listener = null;
14			const DEFAULT_SYNC_CRON_INTERVAL_NAME = 'jetpack_sync_interval';
15			const DEFAULT_SYNC_CRON_INTERVAL_VALUE = 300; // 5 * MINUTE_IN_SECONDS;
16
17			static function init() {
18
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			require_once dirname( __FILE__ ) . '/class.jetpack-sync-users.php';
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 ( Jetpack_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			require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
109			if ( ! Jetpack_Sync_Settings::is_sync_enabled() ) {
110			return false;
111			}
112			if ( Jetpack::is_development_mode() ) {
113			return false;
114			}
115			if ( Jetpack::is_staging_site() ) {
116			return false;
117			}
118			if ( ! Jetpack::is_active() ) {
119			if ( ! doing_action( 'jetpack_user_authorized' ) ) {
120			return false;
121			}
122			}
123
124			return true;
125			}
126
127			static function sync_via_cron_allowed() {
128			require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
129			return ( Jetpack_Sync_Settings::get_setting( 'sync_via_cron' ) );
130			}
131
132			static function prevent_publicize_blacklisted_posts( $should_publicize, $post ) {
133			require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
134			if ( in_array( $post->post_type, Jetpack_Sync_Settings::get_setting( 'post_types_blacklist' ) ) ) {
135			return false;
136			}
137
138			return $should_publicize;
139			}
140
141			static function set_is_importing_true() {
142			require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
143			Jetpack_Sync_Settings::set_importing( true );
144			}
145
146			static function send_data( $data, $codec_name, $sent_timestamp, $queue_id, $checkout_duration, $preprocess_duration ) {
147			require_once dirname( __FILE__ ) . '/class.jetpack-sync-functions.php';
148			Jetpack::load_xml_rpc_client();
149
150			$query_args = array(
151			'sync' => '1', // add an extra parameter to the URL so we can tell it's a sync action
152			'codec' => $codec_name, // send the name of the codec used to encode the data
153			'timestamp' => $sent_timestamp, // send current server time so we can compensate for clock differences
154			'queue' => $queue_id, // sync or full_sync
155			'home' => Jetpack_Sync_Functions::home_url(), // Send home url option to check for Identity Crisis server-side
156			'siteurl' => Jetpack_Sync_Functions::site_url(), // Send siteurl option to check for Identity Crisis server-side
157			'cd' => sprintf( '%.4f', $checkout_duration ), // Time spent retrieving queue items from the DB
158			'pd' => sprintf( '%.4f', $preprocess_duration ), // Time spent converting queue items into data to send
159			);
160
161			// Has the site opted in to IDC mitigation?
162			if ( Jetpack::sync_idc_optin() ) {
163			$query_args['idc'] = true;
164			}
165
166			if ( Jetpack_Options::get_option( 'migrate_for_idc', false ) ) {
167			$query_args['migrate_for_idc'] = true;
168			}
169
170			$query_args['timeout'] = Jetpack_Sync_Settings::is_doing_cron() ? 30 : 15;
171
172			/**
173			* Filters query parameters appended to the Sync request URL sent to WordPress.com.
174			*
175			* @since 4.7.0
176			*
177			* @param array $query_args associative array of query parameters.
178			*/
179			$query_args = apply_filters( 'jetpack_sync_send_data_query_args', $query_args );
180
181			$url = add_query_arg( $query_args, Jetpack::xmlrpc_api_url() );
182
183			$rpc = new Jetpack_IXR_Client(
184			array(
185			'url' => $url,
186			'user_id' => JETPACK_MASTER_USER,
187			'timeout' => $query_args['timeout'],
188			)
189			);
190
191			$result = $rpc->query( 'jetpack.syncActions', $data );
192
193			if ( ! $result ) {
194			return $rpc->get_jetpack_error();
195			}
196
197			$response = $rpc->getResponse();
198
199			// Check if WordPress.com IDC mitigation blocked the sync request
200			if ( is_array( $response ) && isset( $response['error_code'] ) ) {
201			$error_code = $response['error_code'];
202			$allowed_idc_error_codes = array(
203			'jetpack_url_mismatch',
204			'jetpack_home_url_mismatch',
205			'jetpack_site_url_mismatch',
206			);
207
208			if ( in_array( $error_code, $allowed_idc_error_codes ) ) {
209			Jetpack_Options::update_option(
210			'sync_error_idc',
211			Jetpack::get_sync_error_idc_option( $response )
212			);
213			}
214
215			return new WP_Error(
216			'sync_error_idc',
217			esc_html__( 'Sync has been blocked from WordPress.com because it would cause an identity crisis', 'jetpack' )
218			);
219			}
220
221			return $response;
222			}
223
224			static function do_initial_sync() {
225			// Lets not sync if we are not suppose to.
226			if ( ! self::sync_allowed() ) {
227			return false;
228			}
229
230			$initial_sync_config = array(
231			'options' => true,
232			'functions' => true,
233			'constants' => true,
234			'users' => array( get_current_user_id() ),
235			);
236
237			if ( is_multisite() ) {
238			$initial_sync_config['network_options'] = true;
239			}
240
241			self::do_full_sync( $initial_sync_config );
242			}
243
244			static function do_full_sync( $modules = null ) {
245			if ( ! self::sync_allowed() ) {
246			return false;
247			}
248
249			$full_sync_module = Jetpack_Sync_Modules::get_module( 'full-sync' );
250
251			if ( ! $full_sync_module ) {
252			return false;
253			}
254
255			self::initialize_listener();
256
257			$full_sync_module->start( $modules );
258
259			return true;
260			}
261
262			static function jetpack_cron_schedule( $schedules ) {
263			if ( ! isset( $schedules[ self::DEFAULT_SYNC_CRON_INTERVAL_NAME ] ) ) {
264			$schedules[ self::DEFAULT_SYNC_CRON_INTERVAL_NAME ] = array(
265			'interval' => self::DEFAULT_SYNC_CRON_INTERVAL_VALUE,
266			'display' => sprintf(
267			esc_html( _n( 'Every minute', 'Every %d minutes', intval( self::DEFAULT_SYNC_CRON_INTERVAL_VALUE / 60 ), 'jetpack' ) ),
268			intval( self::DEFAULT_SYNC_CRON_INTERVAL_VALUE / 60 )
269			),
270			);
271			}
272			return $schedules;
273			}
274
275			static function do_cron_sync() {
276			self::do_cron_sync_by_type( 'sync' );
277			}
278
279			static function do_cron_full_sync() {
280			self::do_cron_sync_by_type( 'full_sync' );
281			}
282
283			/**
284			* Try to send actions until we run out of things to send,
285			* or have to wait more than 15s before sending again,
286			* or we hit a lock or some other sending issue
287			*
288			* @param string $type Sync type. Can be `sync` or `full_sync`.
289			*/
290			static function do_cron_sync_by_type( $type ) {
291			if ( ! self::sync_allowed() \|\| ( 'sync' !== $type && 'full_sync' !== $type ) ) {
292			return;
293			}
294
295			self::initialize_sender();
296
297			$time_limit = Jetpack_Sync_Settings::get_setting( 'cron_sync_time_limit' );
298			$start_time = time();
299
300			do {
301			$next_sync_time = self::$sender->get_next_sync_time( $type );
302
303			if ( $next_sync_time ) {
304			$delay = $next_sync_time - time() + 1;
305			if ( $delay > 15 ) {
306			break;
307			} elseif ( $delay > 0 ) {
308			sleep( $delay );
309			}
310			}
311
312			$result = 'full_sync' === $type ? self::$sender->do_full_sync() : self::$sender->do_sync();
313			} while ( $result && ! is_wp_error( $result ) && ( $start_time + $time_limit ) > time() );
314			}
315
316			static function initialize_listener() {
317			require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
318			self::$listener = Jetpack_Sync_Listener::get_instance();
319			}
320
321			static function initialize_sender() {
322			require_once dirname( __FILE__ ) . '/class.jetpack-sync-sender.php';
323			self::$sender = Jetpack_Sync_Sender::get_instance();
324
325			// bind the sending process
326			add_filter( 'jetpack_sync_send_data', array( __CLASS__, 'send_data' ), 10, 6 );
327			}
328
329			static function initialize_woocommerce() {
330			if ( false === class_exists( 'WooCommerce' ) ) {
331			return;
332			}
333			add_filter( 'jetpack_sync_modules', array( 'Jetpack_Sync_Actions', 'add_woocommerce_sync_module' ) );
334			}
335
336			static function add_woocommerce_sync_module( $sync_modules ) {
337			require_once dirname( __FILE__ ) . '/class.jetpack-sync-module-woocommerce.php';
338			$sync_modules[] = 'Jetpack_Sync_Module_WooCommerce';
339			return $sync_modules;
340			}
341
342			static function initialize_wp_super_cache() {
343			if ( false === function_exists( 'wp_cache_is_enabled' ) ) {
344			return;
345			}
346			add_filter( 'jetpack_sync_modules', array( 'Jetpack_Sync_Actions', 'add_wp_super_cache_sync_module' ) );
347			}
348
349			static function add_wp_super_cache_sync_module( $sync_modules ) {
350			require_once dirname( __FILE__ ) . '/class.jetpack-sync-module-wp-super-cache.php';
351			$sync_modules[] = 'Jetpack_Sync_Module_WP_Super_Cache';
352			return $sync_modules;
353			}
354
355			static function sanitize_filtered_sync_cron_schedule( $schedule ) {
356			$schedule = sanitize_key( $schedule );
357			$schedules = wp_get_schedules();
358
359			// Make sure that the schedule has actually been registered using the `cron_intervals` filter.
360			if ( isset( $schedules[ $schedule ] ) ) {
361			return $schedule;
362			}
363
364			return self::DEFAULT_SYNC_CRON_INTERVAL_NAME;
365			}
366
367			static function get_start_time_offset( $schedule = '', $hook = '' ) {
368			$start_time_offset = is_multisite()
369			? mt_rand( 0, ( 2 * self::DEFAULT_SYNC_CRON_INTERVAL_VALUE ) )
370			: 0;
371
372			/**
373			* Allows overriding the offset that the sync cron jobs will first run. This can be useful when scheduling
374			* cron jobs across multiple sites in a network.
375			*
376			* @since 4.5.0
377			*
378			* @param int $start_time_offset
379			* @param string $hook
380			* @param string $schedule
381			*/
382			return intval(
383			apply_filters(
384			'jetpack_sync_cron_start_time_offset',
385			$start_time_offset,
386			$hook,
387			$schedule
388			)
389			);
390			}
391
392			static function maybe_schedule_sync_cron( $schedule, $hook ) {
393			if ( ! $hook ) {
394			return;
395			}
396			$schedule = self::sanitize_filtered_sync_cron_schedule( $schedule );
397
398			$start_time = time() + self::get_start_time_offset( $schedule, $hook );
399			if ( ! wp_next_scheduled( $hook ) ) {
400			// Schedule a job to send pending queue items once a minute
401			wp_schedule_event( $start_time, $schedule, $hook );
402			} elseif ( $schedule != wp_get_schedule( $hook ) ) {
403			// If the schedule has changed, update the schedule
404			wp_clear_scheduled_hook( $hook );
405			wp_schedule_event( $start_time, $schedule, $hook );
406			}
407			}
408
409			static function clear_sync_cron_jobs() {
410			wp_clear_scheduled_hook( 'jetpack_sync_cron' );
411			wp_clear_scheduled_hook( 'jetpack_sync_full_cron' );
412			}
413
414			static function init_sync_cron_jobs() {
415			add_filter( 'cron_schedules', array( __CLASS__, 'jetpack_cron_schedule' ) );
416
417			add_action( 'jetpack_sync_cron', array( __CLASS__, 'do_cron_sync' ) );
418			add_action( 'jetpack_sync_full_cron', array( __CLASS__, 'do_cron_full_sync' ) );
419
420			/**
421			* Allows overriding of the default incremental sync cron schedule which defaults to once every 5 minutes.
422			*
423			* @since 4.3.2
424			*
425			* @param string self::DEFAULT_SYNC_CRON_INTERVAL_NAME
426			*/
427			$incremental_sync_cron_schedule = apply_filters( 'jetpack_sync_incremental_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL_NAME );
428			self::maybe_schedule_sync_cron( $incremental_sync_cron_schedule, 'jetpack_sync_cron' );
429
430			/**
431			* Allows overriding of the full sync cron schedule which defaults to once every 5 minutes.
432			*
433			* @since 4.3.2
434			*
435			* @param string self::DEFAULT_SYNC_CRON_INTERVAL_NAME
436			*/
437			$full_sync_cron_schedule = apply_filters( 'jetpack_sync_full_sync_interval', self::DEFAULT_SYNC_CRON_INTERVAL_NAME );
438			self::maybe_schedule_sync_cron( $full_sync_cron_schedule, 'jetpack_sync_full_cron' );
439			}
440
441			static function cleanup_on_upgrade( $new_version = null, $old_version = null ) {
442			if ( wp_next_scheduled( 'jetpack_sync_send_db_checksum' ) ) {
443			wp_clear_scheduled_hook( 'jetpack_sync_send_db_checksum' );
444			}
445
446			$is_new_sync_upgrade = version_compare( $old_version, '4.2', '>=' );
447			if ( ! empty( $old_version ) && $is_new_sync_upgrade && version_compare( $old_version, '4.5', '<' ) ) {
448			require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
449			self::clear_sync_cron_jobs();
450			Jetpack_Sync_Settings::update_settings(
451			array(
452			'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...
453			)
454			);
455			}
456			}
457
458			static function get_sync_status() {
459			self::initialize_sender();
460
461			$sync_module = Jetpack_Sync_Modules::get_module( 'full-sync' );
462			$queue = self::$sender->get_sync_queue();
463			$full_queue = self::$sender->get_full_sync_queue();
464			$cron_timestamps = array_keys( _get_cron_array() );
465			$next_cron = $cron_timestamps[0] - time();
466
467			$full_sync_status = ( $sync_module ) ? $sync_module->get_status() : array();
468			return array_merge(
469			$full_sync_status,
470			array(
471			'cron_size' => count( $cron_timestamps ),
472			'next_cron' => $next_cron,
473			'queue_size' => $queue->size(),
474			'queue_lag' => $queue->lag(),
475			'queue_next_sync' => ( self::$sender->get_next_sync_time( 'sync' ) - microtime( true ) ),
476			'full_queue_size' => $full_queue->size(),
477			'full_queue_lag' => $full_queue->lag(),
478			'full_queue_next_sync' => ( self::$sender->get_next_sync_time( 'full_sync' ) - microtime( true ) ),
479			)
480			);
481			}
482			}
483
484			// Check for WooCommerce support
485			add_action( 'plugins_loaded', array( 'Jetpack_Sync_Actions', 'initialize_woocommerce' ), 5 );
486
487			// Check for WP Super Cache
488			add_action( 'plugins_loaded', array( 'Jetpack_Sync_Actions', 'initialize_wp_super_cache' ), 5 );
489
490			/*
491			* Init after plugins loaded and before the `init` action. This helps with issues where plugins init
492			* with a high priority or sites that use alternate cron.
493			*/
494			add_action( 'plugins_loaded', array( 'Jetpack_Sync_Actions', 'init' ), 90 );
495
496
497
498			// We need to define this here so that it's hooked before `updating_jetpack_version` is called
499			add_action( 'updating_jetpack_version', array( 'Jetpack_Sync_Actions', 'cleanup_on_upgrade' ), 10, 2 );
500			add_action( 'jetpack_user_authorized', array( 'Jetpack_Sync_Actions', 'do_initial_sync' ), 10, 0 );
501
502

Automattic / jetpack

Push — add/disable-any-sending-when-c... ( 9edfff...6db7aa )

Jetpack_Sync_Actions::should_initialize_sender() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like