File Manager

📁 Media Files

📁 .. (Parent Directory) 🔧 class-attachments.php 🔧 class-callables.php 🔧 class-comments.php 🔧 class-constants.php 🔧 class-full-sync-immediately.php 🔧 class-full-sync.php 🔧 class-import.php 🔧 class-menus.php 🔧 class-meta.php 🔧 class-module.php 🔧 class-network-options.php 🔧 class-options.php 🔧 class-plugins.php 🔧 class-posts.php 🔧 class-protect.php 🔧 class-search.php 🔧 class-stats.php 🔧 class-term-relationships.php 🔧 class-terms.php 🔧 class-themes.php 🔧 class-updates.php 🔧 class-users.php 🔧 class-woocommerce-hpos-orders.php 🔧 class-woocommerce-products.php 🔧 class-woocommerce.php 🔧 class-wp-super-cache.php

⬆️ Upload Files

📁 Create Folder

📄 Create File

💻 Terminal

📦 Extract Archive

🔧 Edit: class-full-sync-immediately.php

PHP

Size: 15.75 KB | Modified: 2026-01-19 14:00:20

<?php
/**
 * Full sync module.
 *
 * @package automattic/jetpack-sync
 */

namespace Automattic\Jetpack\Sync\Modules;

use Automattic\Jetpack\Sync\Actions;
use Automattic\Jetpack\Sync\Defaults;
use Automattic\Jetpack\Sync\Lock;
use Automattic\Jetpack\Sync\Modules;
use Automattic\Jetpack\Sync\Settings;

if ( ! defined( 'ABSPATH' ) ) {
	exit( 0 );
}

/**
 * This class does a full resync of the database by
 * sending an outbound action for every single object
 * that we care about.
 */
class Full_Sync_Immediately extends Module {
	/**
	 * Prefix of the full sync status option name.
	 *
	 * @var string
	 */
	const STATUS_OPTION = 'jetpack_sync_full_status';

/**
	 * Sync Lock name.
	 *
	 * @var string
	 */
	const LOCK_NAME = 'full_sync';

/**
	 * Sync module name.
	 *
	 * @access public
	 *
	 * @return string
	 */
	public function name() {
		return 'full-sync';
	}

/**
	 * Initialize action listeners for full sync.
	 *
	 * @access public
	 *
	 * @param callable $callable Action handler callable.
	 */
	public function init_full_sync_listeners( $callable ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
	}

/**
	 * Start a full sync.
	 *
	 * @access public
	 *
	 * @param array $full_sync_config Full sync configuration.
	 * @param mixed $context The context where the full sync was initiated from.
	 *
	 * @return bool Always returns true at success.
	 */
	public function start( $full_sync_config = null, $context = null ) {
		// Check if there was a full sync in progress already before resetting the data.
		$should_process_cancelled_action = $this->get_status()['start_action_processed'] && ! $this->is_finished() ? true : false;
		// Remove all evidence of previous full sync items and status.
		$this->reset_data();

// Update status to indicate that a new full sync is starting and need to cancel previous one.
		if ( $should_process_cancelled_action ) {
			$this->update_status(
				array(
					'cancelled_action_processed' => false,
				)
			);
		}

if ( ! is_array( $full_sync_config ) ) {
			/*
			 * Filter default sync config to allow injecting custom configuration.
			 *
			 * @param array $full_sync_config Sync configuration for all sync modules.
			 *
			 * @since 3.10.0
			 */
			$full_sync_config = apply_filters( 'jetpack_full_sync_config', Defaults::$default_full_sync_config );
			if ( is_multisite() ) {
				$full_sync_config['network_options'] = 1;
			}
		}

if ( isset( $full_sync_config['users'] ) && 'initial' === $full_sync_config['users'] ) {
			$users_module = Modules::get_module( 'users' );
			'@phan-var Users $users_module';
			$full_sync_config['users'] = $users_module->get_initial_sync_user_config();
		}

$this->update_status(
			array(
				'started' => time(),
				'config'  => $full_sync_config,
				'context' => $context,
			)
		);

return true;
	}

/**
	 * Whether full sync has started.
	 *
	 * @access public
	 *
	 * @return boolean
	 */
	public function is_started() {
		return (bool) $this->get_status()['started'];
	}

/**
	 * Retrieve the status of the current full sync.
	 *
	 * @access public
	 *
	 * @return array Full sync status.
	 */
	public function get_status() {
		$default = array(
			'start_action_processed'     => false,
			'cancelled_action_processed' => true, // true by default to avoid sending the action when there is no need,
			'started'                    => false,
			'finished'                   => false,
			'progress'                   => array(),
			'config'                     => array(),
			'context'                    => null,
		);

return wp_parse_args( \Jetpack_Options::get_raw_option( self::STATUS_OPTION ), $default );
	}

/**
	 * Returns the progress percentage of a full sync.
	 *
	 * @access public
	 *
	 * @return int|null
	 */
	public function get_sync_progress_percentage() {
		if ( ! $this->is_started() || $this->is_finished() ) {
			return null;
		}
		$status = $this->get_status();
		if ( empty( $status['progress'] ) ) {
			return null;
		}
		$total_items = array_reduce(
			array_values( $status['progress'] ),
			function ( $sum, $sync_item ) {
				return isset( $sync_item['total'] ) ? ( $sum + (int) $sync_item['total'] ) : $sum;
			},
			0
		);
		$total_sent  = array_reduce(
			array_values( $status['progress'] ),
			function ( $sum, $sync_item ) {
				return isset( $sync_item['sent'] ) ? ( $sum + (int) $sync_item['sent'] ) : $sum;
			},
			0
		);
		return floor( ( $total_sent / $total_items ) * 100 );
	}

/**
	 * Whether full sync has finished.
	 *
	 * @access public
	 *
	 * @return boolean
	 */
	public function is_finished() {
		return (bool) $this->get_status()['finished'];
	}

/**
	 * Clear all the full sync data.
	 *
	 * @access public
	 */
	public function reset_data() {
		$this->clear_status();
		( new Lock() )->remove( self::LOCK_NAME, true );
	}

/**
	 * Clear all the full sync status options.
	 *
	 * @access public
	 */
	public function clear_status() {
		\Jetpack_Options::delete_raw_option( self::STATUS_OPTION );
	}

/**
	 * Updates the status of the current full sync.
	 *
	 * @access public
	 *
	 * @param array $values New values to set.
	 *
	 * @return bool True if success.
	 */
	public function update_status( $values ) {
		return $this->set_status( wp_parse_args( $values, $this->get_status() ) );
	}

/**
	 * Retrieve the status of the current full sync.
	 *
	 * @param array $values New values to set.
	 *
	 * @access public
	 *
	 * @return boolean Full sync status.
	 */
	public function set_status( $values ) {
		return \Jetpack_Options::update_raw_option( self::STATUS_OPTION, $values );
	}

/**
	 * Given an initial Full Sync configuration get the initial status.
	 *
	 * @param array $full_sync_config Full sync configuration.
	 * @param array $range Range of the sync items, containing min, max and count IDs for some item types.
	 *
	 * @return array Initial Sent status.
	 */
	public function get_initial_progress( $full_sync_config, $range = null ) {
		// Set default configuration, calculate totals, and save configuration if totals > 0.
		$status = array();
		foreach ( $full_sync_config as $name => $config ) {
			$module = Modules::get_module( $name );
			if ( ! $module ) {
				continue;
			}
			$status[ $name ] = array(
				// If we have a range for the module, use the count from the range to avoid querying the database again.
				'total'    => $range[ $name ]->count ?? $module->total( $config ),
				'sent'     => 0,
				'finished' => false,
			);
		}

return $status;
	}

/**
	 * Get the range for content (posts and comments) to sync.
	 *
	 * @access private
	 *
	 * @param array $full_sync_config Full sync configuration.
	 *
	 * @return array Array of range (min ID, max ID, total items) for all content types.
	 */
	private function get_content_range( $full_sync_config ) {
		$range = array();
		foreach ( $full_sync_config as $module_name => $config ) {
			// Calculate ranges only for modules that get chunked.
			if ( in_array( $module_name, array( 'constants', 'functions', 'network_options', 'options', 'themes', 'updates' ), true ) ) {
				continue;
			}
			$module = Modules::get_module( $module_name );
			if ( ! $module ) {
				continue;
			}
			if ( true === isset( $config ) && $config ) {
				$range[ $module_name ] = $this->get_range( $module_name );
			}
		}

return $range;
	}

/**
	 * Get the range (min ID, max ID and total items) of items to sync.
	 *
	 * @access public
	 *
	 * @param string $type Type of sync item to get the range for.
	 *
	 * @return array Array of min ID, max ID and total items in the range.
	 */
	public function get_range( $type ) {
		global $wpdb;
		$module = Modules::get_module( $type );
		if ( ! $module ) {
			return array();
		}

$table = $module->table();
		$id    = $module->id_field();
		if ( 'terms' === $module ) { // Terms module relies on the term_taxonomy and term_taxonomy_id for the where sql, let's use term_id instead.
			$id = 'term_id';
		}
		$where_sql = $module->get_where_sql( array() );

// TODO: Call $wpdb->prepare on the following query.
		// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
		$results = $wpdb->get_results( "SELECT MAX({$id}) as max, MIN({$id}) as min, COUNT({$id}) as count FROM {$table} WHERE {$where_sql}" );
		if ( isset( $results[0] ) ) {
			return $results[0];
		}

return array();
	}

/**
	 * Continue sending instead of enqueueing.
	 *
	 * @access public
	 */
	public function continue_enqueuing() {
		$this->continue_sending();
	}

/**
	 * Continue sending.
	 *
	 * @access public
	 */
	public function continue_sending() {
		// Return early if Full Sync is not running.
		if ( ! $this->is_started() || $this->get_status()['finished'] ) {
			return;
		}

// Return early if we've gotten a retry-after header response.
		$retry_time = get_option( Actions::RETRY_AFTER_PREFIX . 'immediate-send' );
		if ( $retry_time ) {
			// If expired delete but don't send. Send will occurr in new request to avoid race conditions.
			if ( microtime( true ) > $retry_time ) {
				update_option( Actions::RETRY_AFTER_PREFIX . 'immediate-send', false, false );
			}
			return false;
		}

// Obtain send Lock.
		$lock            = new Lock();
		$lock_expiration = $lock->attempt( self::LOCK_NAME );

// Return if unable to obtain lock.
		if ( false === $lock_expiration ) {
			return;
		}

// Send Full Sync actions.
		$success = $this->send();

// Remove lock.
		if ( $success ) {
			$lock->remove( self::LOCK_NAME, $lock_expiration );
		}
	}

/**
	 * Immediately send the next items to full sync.
	 *
	 * @access public
	 */
	public function send() {

if ( ! $this->maybe_send_cancelled_action() ) {
			return false;
		}

if ( ! $this->maybe_send_full_sync_start() ) {
			return false;
		}
		$config = $this->get_status()['config'];

$max_duration = Settings::get_setting( 'full_sync_send_duration' );
		$send_until   = microtime( true ) + $max_duration;

$progress = $this->get_status()['progress'];

$started = $this->get_status()['started'];

$remaining_modules = $this->get_remaining_modules_to_send();

foreach ( $remaining_modules as $module ) {
			$module_name = $module->name();
			if ( array_key_exists( $module_name, $progress ) && array_key_exists( $module_name, $config ) ) {
				$progress[ $module_name ] = $module->send_full_sync_actions( $config[ $module_name ], $progress[ $module_name ], $send_until, $started );
				if ( isset( $progress[ $module_name ]['error'] ) ) {
					unset( $progress[ $module_name ]['error'] );
					$this->update_status( array( 'progress' => $progress ) );
					return false;
				} elseif ( ! $progress[ $module_name ]['finished'] ) {
					$this->update_status( array( 'progress' => $progress ) );
					return true;
				}
			}

if ( $this->get_status()['started'] !== $started ) {
				// Full sync was restarted, stop sending.
				return false;
			}
		}

// Check that all remaining modules in progress are actually finished.
		// If a module was skipped in the main loop (due to being unfinished), but still exists in progress, we shouldn't mark the sync as complete.
		foreach ( $remaining_modules as $module ) {
			$name = $module->name();
			if ( array_key_exists( $name, $progress ) && empty( $progress[ $name ]['finished'] ) ) {
				$this->update_status( array( 'progress' => $progress ) );
				return true;
			}
		}

$this->send_full_sync_end();
		$this->update_status( array( 'progress' => $progress ) );
		return true;
	}

/**
	 * Get Modules that are configured to Full Sync and haven't finished sending
	 *
	 * @return array
	 */
	public function get_remaining_modules_to_send() {
		$status            = $this->get_status();
		$remaining_modules = array();
		foreach ( array_keys( $status['config'] ) as $module_name ) {
			$module = Modules::get_module( $module_name );
			if ( ! $module ) {
				continue;
			}
			if ( isset( $status['progress'][ $module_name ]['finished'] ) &&
				true === $status['progress'][ $module_name ]['finished'] ) {
					continue;
			}
			// Ensure that 'constants', 'options', and 'callables' are sent first.
			if ( in_array( $module_name, array( 'network_options', 'options', 'functions', 'constants' ), true ) ) {
				array_unshift( $remaining_modules, $module );
			} else {
				$remaining_modules[] = $module;
			}
		}
		return $remaining_modules;
	}

/**
	 * Sends the `jetpack_full_sync_start` action if it hasn't been processed yet.
	 *
	 * Prepares the full sync start action, sends it to WordPress.com, fires the local action,
	 * and updates the sync status to reflect that the start action has been processed.
	 *
	 * @return bool True if the action was successfully sent or already processed, false on failure.
	 */
	private function maybe_send_full_sync_start() {
		$status = $this->get_status();

// If already processed, nothing to do.
		if ( true === $status['start_action_processed'] ) {
			return true;
		}

$config  = $status['config'];
		$context = $status['context'];
		$range   = $this->get_content_range( $config );

$result = $this->send_action( 'jetpack_full_sync_start', array( $config, $range, $context ) );

// If the action failed on WordPress.com, return false.
		if ( is_wp_error( $result ) ) {
			return false;
		}

/**
		 * Fires when a full sync begins. This action is serialized
		 * and sent to the server so that it knows a full sync is coming.
		 *
		 * @param array $config Sync configuration for all sync modules.
		 * @param array $range Range of the sync items, containing min and max IDs for some item types.
		 * @param mixed $context The context where the full sync was initiated from.
		 *
		 * @since 1.6.3
		 * @since-jetpack 4.2.0
		 * @since-jetpack 7.3.0 Added $range arg.
		 * @since 4.4.0 Added $context arg.
		 */
		do_action( 'jetpack_full_sync_start', $config, $range );

$this->update_status(
			array(
				'start_action_processed' => true,
				'progress'               => $this->get_initial_progress( $config, $range ),
			)
		);

return true;
	}

/**
	 * Sends the `jetpack_full_sync_cancelled` action if it hasn't been processed yet.
	 *
	 * @return bool True if the action was successfully sent or already processed, false on failure.
	 */
	private function maybe_send_cancelled_action() {
		$status = $this->get_status();

if ( true === $status['cancelled_action_processed'] ) {
			return true;
		}

$result = $this->send_action( 'jetpack_full_sync_cancelled' );

if ( is_wp_error( $result ) ) {
			return false;
		}

/**
		 * Fires when a full sync is cancelled.
		 *
		 * @since 1.6.3
		 * @since-jetpack 4.2.0
		 */
		do_action( 'jetpack_full_sync_cancelled' );
		$this->update_status( array( 'cancelled_action_processed' => true ) );
		return true;
	}

/**
	 *  Sends the `jetpack_full_sync_end` action and updates the status when the full sync end action is processed.
	 *
	 * @access public
	 */
	public function send_full_sync_end() {
		$status  = $this->get_status();
		$range   = $this->get_content_range( $status['config'] );
		$context = $status['context'];

$result = $this->send_action( 'jetpack_full_sync_end', array( '', $range, $context ) );

if ( is_wp_error( $result ) ) { // Do not set finished status if we get an error.
			return;
		}
		/**
		 * Fires when a full sync ends. This action is serialized
		 * and sent to the server.
		 *
		 * @param string $checksum Deprecated since 7.3.0 - @see https://github.com/Automattic/jetpack/pull/11945/
		 * @param array $range Range of the sync items, containing min and max IDs for some item types.
		 *
		 * @since 1.6.3
		 * @since-jetpack 4.2.0
		 * @since-jetpack 7.3.0 Added $range arg.
		 */
		do_action( 'jetpack_full_sync_end', '', $range );

// Setting autoload to true means that it's faster to check whether we should continue enqueuing.
		$this->update_status( array( 'finished' => time() ) );
	}

/**
	 * Empty Function as we don't close buffers on Immediate Full Sync.
	 *
	 * @param array $actions an array of actions, ignored for queueless sync.
	 */
	public function update_sent_progress_action( $actions ) { } // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
}

Supports: PHP, ASPX, HTML, JavaScript, CSS and other text-based files

📥 Download

File manager