File "class-module.php"
Full path: /home/webcknlt/admissiontell.com/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-sync/src/modules/class-module.php
File
size: 25.41 B (25.41 KB bytes)
MIME-type: text/x-php
Charset: utf-8
Download Open Edit Advanced Editor &nnbsp; Back
<?php
/**
* A base abstraction of a sync module.
*
* @package automattic/jetpack-sync
*/
namespace Automattic\Jetpack\Sync\Modules;
use Automattic\Jetpack\Sync\Defaults;
use Automattic\Jetpack\Sync\Functions;
use Automattic\Jetpack\Sync\Listener;
use Automattic\Jetpack\Sync\Replicastore;
use Automattic\Jetpack\Sync\Sender;
use Automattic\Jetpack\Sync\Settings;
/**
* Basic methods implemented by Jetpack Sync extensions.
*
* @abstract
*/
abstract class Module {
/**
* Number of items per chunk when grouping objects for performance reasons.
*
* @access public
*
* @var int
*/
const ARRAY_CHUNK_SIZE = 10;
/**
* Max query length for DB queries.
*
* @access public
*
* @var int
*/
const MAX_DB_QUERY_LENGTH = 15 * 1024;
/**
* Max bytes allowed for full sync upload for the module.
* Default Setting : 7MB.
*
* @access public
*
* @var int
*/
const MAX_SIZE_FULL_SYNC = 7000000;
/**
* Max bytes allowed for post meta_value => length.
* Default Setting : 2MB.
*
* @access public
*
* @var int
*/
const MAX_META_LENGTH = 2000000;
/**
* Sync module name.
*
* @access public
*
* @return string
*/
abstract public function name();
/**
* The id field in the database.
*
* @access public
*
* @return string
*/
public function id_field() {
return 'ID';
}
/**
* The table name.
*
* @access public
*
* @return string|bool
* @deprecated since 3.11.0 Use table() instead.
*/
public function table_name() {
_deprecated_function( __METHOD__, '3.11.0', 'Automattic\\Jetpack\\Sync\\Module->table' );
return false;
}
/**
* The table in the database with the prefix.
*
* @access public
*
* @return string|bool
*/
public function table() {
return false;
}
/**
* The full sync action name for this module.
*
* @access public
*
* @return string
*/
public function full_sync_action_name() {
return 'jetpack_full_sync_' . $this->name();
}
// phpcs:disable VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
/**
* Retrieve a sync object by its ID.
*
* @access public
*
* @param string $object_type Type of the sync object.
* @param int $id ID of the sync object.
* @return mixed Object, or false if the object is invalid.
*/
public function get_object_by_id( $object_type, $id ) {
return false;
}
/**
* Initialize callables action listeners.
* Override these to set up listeners and set/reset data/defaults.
*
* @access public
*
* @param callable $callable Action handler callable.
*/
public function init_listeners( $callable ) {
}
/**
* Initialize module action listeners for full sync.
*
* @access public
*
* @param callable $callable Action handler callable.
*/
public function init_full_sync_listeners( $callable ) {
}
/**
* Initialize the module in the sender.
*
* @access public
*/
public function init_before_send() {
}
/**
* Set module defaults.
*
* @access public
*/
public function set_defaults() {
}
/**
* Perform module cleanup.
* Usually triggered when uninstalling the plugin.
*
* @access public
*/
public function reset_data() {
}
/**
* Enqueue the module actions for full sync.
*
* @access public
*
* @param array $config Full sync configuration for this sync module.
* @param int $max_items_to_enqueue Maximum number of items to enqueue.
* @param boolean $state True if full sync has finished enqueueing this module, false otherwise.
* @return array Number of actions enqueued, and next module state.
*/
public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) {
// In subclasses, return the number of actions enqueued, and next module state (true == done).
return array( null, true );
}
/**
* Retrieve an estimated number of actions that will be enqueued.
*
* @access public
*
* @param array $config Full sync configuration for this sync module.
* @return array Number of items yet to be enqueued.
*/
public function estimate_full_sync_actions( $config ) {
// In subclasses, return the number of items yet to be enqueued.
return null;
}
// phpcs:enable VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
/**
* Retrieve the actions that will be sent for this module during a full sync.
*
* @access public
*
* @return array Full sync actions of this module.
*/
public function get_full_sync_actions() {
return array();
}
/**
* Get the number of actions that we care about.
*
* @access protected
*
* @param array $action_names Action names we're interested in.
* @param array $actions_to_count Unfiltered list of actions we want to count.
* @return array Number of actions that we're interested in.
*/
protected function count_actions( $action_names, $actions_to_count ) {
return count( array_intersect( $action_names, $actions_to_count ) );
}
/**
* Calculate the checksum of one or more values.
*
* @access protected
*
* @param mixed $values Values to calculate checksum for.
* @param bool $sort If $values should have ksort called on it.
* @return int The checksum.
*/
protected function get_check_sum( $values, $sort = true ) {
// Associative array order changes the generated checksum value.
if ( $sort && is_array( $values ) ) {
$this->recursive_ksort( $values );
}
return crc32( wp_json_encode( Functions::json_wrap( $values ) ) );
}
/**
* Recursively call ksort on an Array
*
* @param array $values Array.
*/
private function recursive_ksort( &$values ) {
ksort( $values );
foreach ( $values as &$value ) {
if ( is_array( $value ) ) {
$this->recursive_ksort( $value );
}
}
}
/**
* Whether a particular checksum in a set of checksums is valid.
*
* @access protected
*
* @param array $sums_to_check Array of checksums.
* @param string $name Name of the checksum.
* @param int $new_sum Checksum to compare against.
* @return boolean Whether the checksum is valid.
*/
protected function still_valid_checksum( $sums_to_check, $name, $new_sum ) {
if ( isset( $sums_to_check[ $name ] ) && $sums_to_check[ $name ] === $new_sum ) {
return true;
}
return false;
}
/**
* Enqueue all items of a sync type as an action.
*
* @access protected
*
* @param string $action_name Name of the action.
* @param string $table_name Name of the database table.
* @param string $id_field Name of the ID field in the database.
* @param string $where_sql The SQL WHERE clause to filter to the desired items.
* @param int $max_items_to_enqueue Maximum number of items to enqueue in the same time.
* @param boolean $state Whether enqueueing has finished.
* @return array Array, containing the number of chunks and TRUE, indicating enqueueing has finished.
*/
protected function enqueue_all_ids_as_action( $action_name, $table_name, $id_field, $where_sql, $max_items_to_enqueue, $state ) {
global $wpdb;
if ( ! $where_sql ) {
$where_sql = '1 = 1';
}
$items_per_page = 1000;
$page = 1;
$chunk_count = 0;
$previous_interval_end = $state ? $state : '~0';
$listener = Listener::get_instance();
// Count down from max_id to min_id so we get newest posts/comments/etc first.
// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
while ( $ids = $wpdb->get_col( "SELECT {$id_field} FROM {$table_name} WHERE {$where_sql} AND {$id_field} < {$previous_interval_end} ORDER BY {$id_field} DESC LIMIT {$items_per_page}" ) ) {
// Request posts in groups of N for efficiency.
$chunked_ids = array_chunk( $ids, self::ARRAY_CHUNK_SIZE );
// If we hit our row limit, process and return.
if ( $chunk_count + count( $chunked_ids ) >= $max_items_to_enqueue ) {
$remaining_items_count = $max_items_to_enqueue - $chunk_count;
$remaining_items = array_slice( $chunked_ids, 0, $remaining_items_count );
$remaining_items_with_previous_interval_end = $this->get_chunks_with_preceding_end( $remaining_items, $previous_interval_end );
$listener->bulk_enqueue_full_sync_actions( $action_name, $remaining_items_with_previous_interval_end );
$last_chunk = end( $remaining_items );
return array( $remaining_items_count + $chunk_count, end( $last_chunk ) );
}
$chunked_ids_with_previous_end = $this->get_chunks_with_preceding_end( $chunked_ids, $previous_interval_end );
$listener->bulk_enqueue_full_sync_actions( $action_name, $chunked_ids_with_previous_end );
$chunk_count += count( $chunked_ids );
++$page;
// The $ids are ordered in descending order.
$previous_interval_end = end( $ids );
}
if ( $wpdb->last_error ) {
// return the values that were passed in so all these chunks get retried.
return array( $max_items_to_enqueue, $state );
}
return array( $chunk_count, true );
}
/**
* Given the Module Full Sync Configuration and Status return the next chunk of items to send.
*
* @param array $config This module Full Sync configuration.
* @param array $status This module Full Sync status.
* @param int $chunk_size Chunk size.
*
* @return array|object|null
*/
public function get_next_chunk( $config, $status, $chunk_size ) {
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery
global $wpdb;
return $wpdb->get_col(
"
SELECT {$this->id_field()}
FROM {$this->table()}
WHERE {$this->get_where_sql( $config )}
AND {$this->id_field()} < {$status['last_sent']}
ORDER BY {$this->id_field()}
DESC LIMIT {$chunk_size}
"
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery
}
/**
* Return last_item to send for Module Full Sync Configuration.
*
* @param array $config This module Full Sync configuration.
*
* @return array|object|null
*/
public function get_last_item( $config ) {
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.DirectDatabaseQuery.DirectQuery
return $wpdb->get_var(
"
SELECT {$this->id_field()}
FROM {$this->table()}
WHERE {$this->get_where_sql( $config )}
ORDER BY {$this->id_field()}
LIMIT 1
"
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.DirectDatabaseQuery.DirectQuery
}
/**
* Return the initial last sent object.
*
* @return string|array initial status.
*/
public function get_initial_last_sent() {
return '~0';
}
/**
* Immediately send all items of a sync type as an action.
*
* @access protected
*
* @param string $config Full sync configuration for this module.
* @param array $status the current module full sync status.
* @param float $send_until timestamp until we want this request to send full sync events.
* @param int $started The timestamp when the full sync started.
*
* @return array Status, the module full sync status updated.
*/
public function send_full_sync_actions( $config, $status, $send_until, $started ) {
global $wpdb;
if ( empty( $status['last_sent'] ) ) {
$status['last_sent'] = $this->get_initial_last_sent();
}
$limits = Settings::get_setting( 'full_sync_limits' )[ $this->name() ] ??
Defaults::get_default_setting( 'full_sync_limits' )[ $this->name() ] ??
array(
'max_chunks' => 10,
'chunk_size' => 100,
);
$limits['chunk_size'] = $this->adjust_chunk_size_if_stuck( $status['last_sent'], $limits['chunk_size'], $started );
$chunks_sent = 0;
$last_item = $this->get_last_item( $config );
while ( $chunks_sent < $limits['max_chunks'] && microtime( true ) < $send_until ) {
$objects = $this->get_next_chunk( $config, $status, $limits['chunk_size'] );
if ( $wpdb->last_error ) {
$status['error'] = true;
return $status;
}
if ( empty( $objects ) ) {
$status['finished'] = true;
return $status;
}
// If we have objects as a key it means get_next_chunk is being overridden, we need to check for it being an empty array.
// In case it is an empty array, we should not send the action or increase the chunks_sent, we just need to update the status.
if ( ! isset( $objects['objects'] ) || array() !== $objects['objects'] ) {
$key = $this->full_sync_action_name() . '_' . crc32( wp_json_encode( $status['last_sent'] ) );
$result = $this->send_action( $this->full_sync_action_name(), array( $objects, $status['last_sent'] ), $key );
if ( is_wp_error( $result ) || $wpdb->last_error ) {
$status['error'] = true;
return $status;
}
++$chunks_sent;
}
// Updated the sent and last_sent status.
$status = $this->set_send_full_sync_actions_status( $status, $objects );
if ( $last_item === $status['last_sent'] ) {
$status['finished'] = true;
return $status;
}
}
return $status;
}
/**
* Adjust chunk size using adaptive logic and update transient for tracking stuck state.
*
* @param string $last_sent The current last_sent marker.
* @param int $default_chunk_size The default chunk size.
* @param int $started The timestamp when the full sync started.
* @return int Adjusted chunk size.
*/
private function adjust_chunk_size_if_stuck( $last_sent, $default_chunk_size, $started ) {
$transient_key = 'jetpack_sync_last_sent_' . $this->name() . '_' . $started;
$stuck_data = get_transient( $transient_key );
$stuck_count = 0;
$adjusted_chunk_size = $default_chunk_size;
$is_stuck = isset( $stuck_data['last_sent'] ) && $stuck_data['last_sent'] === $last_sent;
if ( $is_stuck && $stuck_data['adjusted_chunk_size'] === 1 ) {
return 1; // If we are already at the minimum chunk size, do not adjust further.
}
// We will adjust if it is stuck after 10 minutes.
if (
$is_stuck &&
( time() - $stuck_data['timestamp'] ) >= 10 * MINUTE_IN_SECONDS
) {
$stuck_count = ++$stuck_data['stuck_count'];
$adjusted_chunk_size = max( 1, (int) ( $default_chunk_size / ( 2 ** $stuck_count ) ) ); // Halve the chunk size for each stuck iteration.
// If we are stuck, we will send an action to notify about the adjustment.
$this->send_action(
'jetpack_full_sync_stuck_adjustment',
array(
'module' => $this->name(),
'last_sent' => $last_sent,
'stuck_count' => $stuck_count,
'adjusted_chunk_size' => $adjusted_chunk_size,
)
);
}
// Set or update the transient with the new last_sent, timestamp, and stuck_count.
// If we are not stuck, reset the timestamp and stuck_count.
set_transient(
$transient_key,
array(
'last_sent' => $last_sent,
'timestamp' => $is_stuck ? $stuck_data['timestamp'] : time(),
'stuck_count' => $stuck_count,
'adjusted_chunk_size' => $adjusted_chunk_size,
),
HOUR_IN_SECONDS
);
return $adjusted_chunk_size;
}
/**
* Set the status of the full sync action based on the objects that were sent.
* Used to update the status of the module after sending a chunk of objects.
* Since Full Sync logic chunking relies on order of items being processed in descending order, we need to sort
* due to some modules (e.g. WooCommerce) changing the order while getting the objects.
*
* @access protected
*
* @param array $status This module Full Sync status.
* @param array $objects This module Full Sync objects.
*
* @return array The updated status.
*/
protected function set_send_full_sync_actions_status( $status, $objects ) {
$object_ids = $objects['object_ids'] ?? $objects;
$status['last_sent'] = end( $object_ids );
$status['sent'] += count( $object_ids );
return $status;
}
/**
* Immediately sends a single item without firing or enqueuing it
*
* @param string $action_name The action.
* @param array $data The data associated with the action.
* @param string $key The key to use for the action.
*/
public function send_action( $action_name, $data = null, $key = null ) {
$sender = Sender::get_instance();
return $sender->send_action( $action_name, $data, $key );
}
/**
* Retrieve chunk IDs with previous interval end.
*
* @access protected
*
* @param array $chunks All remaining items.
* @param int $previous_interval_end The last item from the previous interval.
* @return array Chunk IDs with the previous interval end.
*/
protected function get_chunks_with_preceding_end( $chunks, $previous_interval_end ) {
$chunks_with_ends = array();
foreach ( $chunks as $chunk ) {
$chunks_with_ends[] = array(
'ids' => $chunk,
'previous_end' => $previous_interval_end,
);
// Chunks are ordered in descending order.
$previous_interval_end = end( $chunk );
}
return $chunks_with_ends;
}
/**
* Get metadata of a particular object type within the designated meta key whitelist.
*
* @access protected
*
* @todo Refactor to use $wpdb->prepare() on the SQL query.
*
* @param array $ids Object IDs.
* @param string $meta_type Meta type.
* @param array $meta_key_whitelist Meta key whitelist.
* @return array Unserialized meta values.
*/
protected function get_metadata( $ids, $meta_type, $meta_key_whitelist ) {
global $wpdb;
$table = _get_meta_table( $meta_type );
$id = $meta_type . '_id';
if ( ! $table ) {
return array();
}
$private_meta_whitelist_sql = "'" . implode( "','", array_map( 'esc_sql', $meta_key_whitelist ) ) . "'";
return array_map(
array( $this, 'unserialize_meta' ),
$wpdb->get_results(
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared
"SELECT $id, meta_key, meta_value, meta_id FROM $table WHERE $id IN ( " . implode( ',', wp_parse_id_list( $ids ) ) . ' )' .
" AND meta_key IN ( $private_meta_whitelist_sql ) ",
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared
OBJECT
)
);
}
/**
* Initialize listeners for the particular meta type.
*
* @access public
*
* @param string $meta_type Meta type.
* @param callable $callable Action handler callable.
*/
public function init_listeners_for_meta_type( $meta_type, $callable ) {
add_action( "added_{$meta_type}_meta", $callable, 10, 4 );
add_action( "updated_{$meta_type}_meta", $callable, 10, 4 );
add_action( "deleted_{$meta_type}_meta", $callable, 10, 4 );
}
/**
* Initialize meta whitelist handler for the particular meta type.
*
* @access public
*
* @param string $meta_type Meta type.
* @param callable $whitelist_handler Action handler callable.
*/
public function init_meta_whitelist_handler( $meta_type, $whitelist_handler ) {
add_filter( "jetpack_sync_before_enqueue_added_{$meta_type}_meta", $whitelist_handler );
add_filter( "jetpack_sync_before_enqueue_updated_{$meta_type}_meta", $whitelist_handler );
add_filter( "jetpack_sync_before_enqueue_deleted_{$meta_type}_meta", $whitelist_handler );
}
/**
* Retrieve the term relationships for the specified object IDs.
*
* @access protected
*
* @todo This feels too specific to be in the abstract sync Module class. Move it?
*
* @param array $ids Object IDs.
* @return array Term relationships - object ID and term taxonomy ID pairs.
*/
protected function get_term_relationships( $ids ) {
global $wpdb;
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
return $wpdb->get_results( "SELECT object_id, term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id IN ( " . implode( ',', wp_parse_id_list( $ids ) ) . ' )', OBJECT );
}
/**
* Unserialize the value of a meta object, if necessary.
*
* @access public
*
* @param object $meta Meta object.
* @return object Meta object with possibly unserialized value.
*/
public function unserialize_meta( $meta ) {
$meta->meta_value = maybe_unserialize( $meta->meta_value );
return $meta;
}
/**
* Retrieve a set of objects by their IDs.
*
* @access public
*
* @param string $object_type Object type.
* @param array $ids Object IDs.
* @return array Array of objects.
*/
public function get_objects_by_id( $object_type, $ids ) {
if ( empty( $ids ) || empty( $object_type ) ) {
return array();
}
$objects = array();
foreach ( (array) $ids as $id ) {
$object = $this->get_object_by_id( $object_type, $id );
// Only add object if we have the object.
if ( $object ) {
$objects[ $id ] = $object;
}
}
return $objects;
}
/**
* Gets a list of minimum and maximum object ids for each batch based on the given batch size.
*
* @access public
*
* @param int $batch_size The batch size for objects.
* @param string|bool $where_sql The sql where clause minus 'WHERE', or false if no where clause is needed.
*
* @return array|bool An array of min and max ids for each batch. FALSE if no table can be found.
*/
public function get_min_max_object_ids_for_batches( $batch_size, $where_sql = false ) {
if ( ! $this->table() ) {
return false;
}
$results = array();
$table = $this->table();
$current_max = 0;
$current_min = 1;
$id_field = $this->id_field();
$replicastore = new Replicastore();
$total = $replicastore->get_min_max_object_id(
$id_field,
$table,
$where_sql,
false
);
while ( $total->max > $current_max ) {
$where = $where_sql ?
$where_sql . " AND $id_field > $current_max" :
"$id_field > $current_max";
$result = $replicastore->get_min_max_object_id(
$id_field,
$table,
$where,
$batch_size
);
if ( empty( $result->min ) && empty( $result->max ) ) {
// Our query produced no min and max. We can assume the min from the previous query,
// and the total max we found in the initial query.
$current_max = (int) $total->max;
$result = (object) array(
'min' => $current_min,
'max' => $current_max,
);
} else {
$current_min = (int) $result->min;
$current_max = (int) $result->max;
}
$results[] = $result;
}
return $results;
}
/**
* Return Total number of objects.
*
* @param array $config Full Sync config.
*
* @return int total
*/
public function total( $config ) {
global $wpdb;
$table = $this->table();
$where = $this->get_where_sql( $config );
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
return (int) $wpdb->get_var( "SELECT COUNT(*) FROM $table WHERE $where" );
}
/**
* Retrieve the WHERE SQL clause based on the module config.
*
* @access public
*
* @param array $config Full sync configuration for this sync module.
* @return string WHERE SQL clause, or `null` if no comments are specified in the module config.
*/
public function get_where_sql( $config ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
return '1=1';
}
/**
* Filters objects and metadata based on maximum size constraints.
* It always allows the first object with its metadata, even if they exceed the limit.
*
* @access public
*
* @param string $type The type of objects to filter (e.g., 'post' or 'comment').
* @param array $objects The array of objects to filter (e.g., posts or comments).
* @param array $metadata The array of metadata to filter.
* @param int $max_meta_size Maximum size for individual objects.
* @param int $max_total_size Maximum combined size for objects and metadata.
* @return array An array containing the filtered object IDs, filtered objects, and filtered metadata.
*/
public function filter_objects_and_metadata_by_size( $type, $objects, $metadata, $max_meta_size, $max_total_size ) {
$filtered_objects = array();
$filtered_metadata = array();
$filtered_object_ids = array();
$current_size = 0;
foreach ( $objects as $object ) {
$object_size = strlen( (string) maybe_serialize( $object ) );
$current_metadata = array();
$metadata_size = 0;
$id_field = $this->id_field();
$object_id = (int) ( is_object( $object ) ? $object->{$id_field} : $object[ $id_field ] );
foreach ( $metadata as $key => $metadata_item ) {
if ( (int) $metadata_item->{$type . '_id'} === $object_id ) {
$metadata_item_size = strlen( (string) maybe_serialize( $metadata_item ) );
if ( $metadata_item_size >= $max_meta_size ) {
$metadata_item->meta_value = ''; // Trim metadata if too large.
$metadata_item_size = strlen( (string) maybe_serialize( $metadata_item ) );
}
$current_metadata[] = $metadata_item;
$metadata_size += $metadata_item_size;
if ( ! empty( $filtered_object_ids ) && ( $current_size + $object_size + $metadata_size ) > $max_total_size ) {
break 2; // Exit both loops.
}
unset( $metadata[ $key ] );
}
}
// Always allow the first object with metadata.
if ( empty( $filtered_object_ids ) || ( $current_size + $object_size + $metadata_size ) <= $max_total_size ) {
$filtered_object_ids[] = strval( is_object( $object ) ? $object->{$id_field} : $object[ $id_field ] );
$filtered_objects[] = $object;
$filtered_metadata = array_merge( $filtered_metadata, $current_metadata );
$current_size += $object_size + $metadata_size;
} else {
break;
}
}
return array(
$filtered_object_ids,
$filtered_objects,
$filtered_metadata,
);
}
}