Jetpack_Sync_Actions::async_sender() - Code Metrics - Inspection of "use `async_sender` Sync Setting" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/sync-async-sender ( bb6c2b...f64c35 )

unknown

created 2019-03-22 21:13 UTC

Jetpack_Sync_Actions::async_sender() A

↳ Parent: Jetpack_Sync_Actions

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	11
rs	9.9
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();
		} else if ( 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',
			(
				( isset( $_SERVER['REQUEST_METHOD'] ) && 'POST' === $_SERVER['REQUEST_METHOD'] )
				||
				current_user_can( 'manage_options' )
				||
				is_admin()
				||
				defined( 'PHPUNIT_JETPACK_TESTSUITE' )
			)
		) ) {
			if ( Jetpack_Sync_Settings::get_setting( 'async_sender' ) ) {
				if ( ! isset( $_GET['jetpack_sync_async_sender'] ) ) {
					self::async_sender();
					return;
				}
			}

			if ( isset( $_GET['jetpack_sync_async_sender'] ) ) {
				ignore_user_abort(true );
			}

			self::initialize_sender();
			add_action( 'shutdown', array( self::$sender, 'do_sync' ) );
			add_action( 'shutdown', array( self::$sender, 'do_full_sync' ) );
		}
	}

	static function sync_allowed() {
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
		return ( ! Jetpack_Sync_Settings::get_setting( 'disable' )
		         && ( doing_action( 'jetpack_user_authorized' ) || Jetpack::is_active() )
		         && ! ( Jetpack::is_development_mode() || Jetpack::is_staging_site() ) )
		       || defined( 'PHPUNIT_JETPACK_TESTSUITE' );
	}

	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 );
		} else if ( $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 ) ),
			)
		);
	}

	static function async_sender() {
		$url = add_query_arg( 'jetpack_sync_async_sender', true, site_url() );
		$args = array(
			'timeout'   => 0.01,
			'blocking'  => false,
			/** This filter is documented in wp-includes/class-wp-http-streams.php */
			'sslverify' => apply_filters( 'https_local_ssl_verify', false )
		);

		wp_remote_post( $url, $args );
	}
}

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

Automattic / jetpack

Push — update/sync-async-sender ( bb6c2b...f64c35 )

Jetpack_Sync_Actions::async_sender() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like