* @param float $now The current time in microtime.
*
* @return float
*/
public function lag( $now = null ) {
return (float) $this->queue_storage->get_lag( $now );
}
/**
* Resets the queue.
*/
public function reset() {
$this->delete_checkout_id();
$this->queue_storage->clear_queue();
}
/**
* Return the size of the queue.
*
* @return int
*/
public function size() {
return $this->queue_storage->get_item_count();
}
/**
* Lets you know if there is any items in the queue.
*
* We use this peculiar implementation because it's much faster than count(*).
*
* @return bool
*/
public function has_any_items() {
return $this->size() > 0;
}
/**
* Used to checkout the queue.
*
* @param int $buffer_size Size of the buffer to checkout.
*
* @return \Automattic\Jetpack\Sync\Queue_Buffer|bool|int|\WP_Error
*/
public function checkout( $buffer_size ) {
if ( $this->get_checkout_id() ) {
return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
}
// TODO check if adding a prefix is going to be a problem
$buffer_id = uniqid( '', true );
$result = $this->set_checkout_id( $buffer_id );
if ( ! $result || is_wp_error( $result ) ) {
return $result;
}
$items = $this->fetch_items( $buffer_size );
if ( ! is_countable( $items ) ) {
return false;
}
if ( count( $items ) === 0 ) {
return false;
}
return new Queue_Buffer( $buffer_id, array_slice( $items, 0, $buffer_size ) );
}
/**
* Given a list of items return the items ids.
*
* @param array $items List of item objects.
*
* @return array Ids of the items.
*/
public function get_ids( $items ) {
return array_map(
function ( $item ) {
return $item->id;
},
$items
);
}
/**
* Pop elements from the queue.
*
* @param int $limit Number of items to pop from the queue.
*
* @return array|object|null
*/
public function pop( $limit ) {
$items = $this->fetch_items( $limit );
$ids = $this->get_ids( $items );
$this->delete( $ids );
return $items;
}
/**
* Get the items from the queue with a memory limit.
*
* This checks out rows until it either empties the queue or hits a certain memory limit
* it loads the sizes from the DB first so that it doesn't accidentally
* load more data into memory than it needs to.
* The only way it will load more items than $max_size is if a single queue item
* exceeds the memory limit, but in that case it will send that item by itself.
*
* @param int $max_memory (bytes) Maximum memory threshold.
* @param int $max_buffer_size Maximum buffer size (number of items).
*
* @return \Automattic\Jetpack\Sync\Queue_Buffer|bool|int|\WP_Error
*/
public function checkout_with_memory_limit( $max_memory, $max_buffer_size = 500 ) {
if ( $this->get_checkout_id() ) {
return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
}
$buffer_id = uniqid( '', true );
$result = $this->set_checkout_id( $buffer_id );
if ( ! $result || is_wp_error( $result ) ) {
return $result;
}
// How much memory is currently being used by the items.
$total_memory = 0;
// Store the items to return
$items = array();
$current_items_ids = $this->queue_storage->get_items_ids_with_size( $max_buffer_size - count( $items ) );
// If no valid items are returned or no items are returned, continue.
if ( ! is_countable( $current_items_ids ) || count( $current_items_ids ) === 0 ) {
return false;
}
$item_ids_to_fetch = array();
foreach ( $current_items_ids as $id => $item_with_size ) {
$total_memory += $item_with_size->value_size;
// If this is the first item and it exceeds memory, allow loop to continue
// we will exit on the next iteration instead.
if ( $total_memory > $max_memory && $id > 0 ) {
break;
}
$item_ids_to_fetch[] = $item_with_size->id;
}
$current_items = $this->queue_storage->fetch_items_by_ids( $item_ids_to_fetch );
$items_count = is_countable( $current_items ) ? count( $current_items ) : 0;
if ( $items_count > 0 ) {
/**
* Save some memory by moving things one by one to the array of items being returned, instead of
* unserializing all and then merging them with other items.
*
* PHPCS ignore is because this is the expected behavior - we're assigning a variable in the condition part of the loop.
*/
// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
while ( ( $current_item = array_shift( $current_items ) ) !== null ) {
// @codingStandardsIgnoreStart
$current_item->value = unserialize( $current_item->value );
// @codingStandardsIgnoreEnd
$items[] = $current_item;
}
}
if ( count( $items ) === 0 ) {
$this->delete_checkout_id();
return false;
}
return new Queue_Buffer( $buffer_id, $items );
}
/**
* Check in the queue.
*
* @param \Automattic\Jetpack\Sync\Queue_Buffer $buffer Queue_Buffer object.
*
* @return bool|\WP_Error
*/
public function checkin( $buffer ) {
$is_valid = $this->validate_checkout( $buffer );
if ( is_wp_error( $is_valid ) ) {
return $is_valid;
}
$this->delete_checkout_id();
return true;
}
/**
* Close the buffer.
*
* @param \Automattic\Jetpack\Sync\Queue_Buffer $buffer Queue_Buffer object.
* @param null|array $ids_to_remove Ids to remove from the queue.
*
* @return bool|\WP_Error
*/
public function close( $buffer, $ids_to_remove = null ) {
$is_valid = $this->validate_checkout( $buffer );
if ( is_wp_error( $is_valid ) ) {
// Always delete ids_to_remove even when buffer is no longer checked-out.
// They were processed by WP.com so safe to remove from queue.
if ( $ids_to_remove !== null ) {
$this->delete( $ids_to_remove );
}
return $is_valid;
}
$this->delete_checkout_id();
// By default clear all items in the buffer.
if ( $ids_to_remove === null ) {
$ids_to_remove = $buffer->get_item_ids();
}
$this->delete( $ids_to_remove );
return true;
}
/**
* Delete elements from the queue.
*
* @param array $ids Ids to delete.
*
* @return bool|int
*/
private function delete( $ids ) {
if ( array() === $ids ) {
return 0;
}
$this->queue_storage->delete_items_by_ids( $ids );
return true;
}
/**
* Flushes all items from the queue.
*
* @return array
*/
public function flush_all() {
$items = Utils::get_item_values( $this->fetch_items() );
$this->reset();
return $items;
}
/**
* Get all the items from the queue.
*
* @return array|object|null
*/
public function get_all() {
return $this->fetch_items();
}
/**
* Forces Checkin of the queue.
* Use with caution, this could allow multiple processes to delete
* and send from the queue at the same time
*/
public function force_checkin() {
$this->delete_checkout_id();
}
/**
* Checks if the queue is locked.
*
* @return bool
*/
public function is_locked() {
return (bool) $this->get_checkout_id();
}
/**
* Locks checkouts from the queue
* tries to wait up to $timeout seconds for the queue to be empty.
*
* @param int $timeout The wait time in seconds for the queue to be empty.
*
* @return bool|int|\WP_Error
*/
public function lock( $timeout = 30 ) {
$tries = 0;
while ( $this->has_any_items() && $tries < $timeout ) {
sleep( 1 );
++$tries;
}
if ( 30 === $tries ) {
return new WP_Error( 'lock_timeout', 'Timeout waiting for sync queue to empty' );
}
if ( $this->get_checkout_id() ) {
return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
}
// Hopefully this means we can acquire a checkout?
$result = $this->set_checkout_id( 'lock' );
if ( ! $result || is_wp_error( $result ) ) {
return $result;
}
return true;
}
/**
* Unlocks the queue.
*
* @return bool|int
*/
public function unlock() {
return $this->delete_checkout_id();
}
/**
* This option is specifically chosen to, as much as possible, preserve time order
* and minimise the possibility of collisions between multiple processes working
* at the same time.
*
* @return string
*/
protected function generate_option_name_timestamp() {
return sprintf( '%.6f', microtime( true ) );
}
/**
* Gets the checkout ID.
*
* @return bool|string
*/
private function get_checkout_id() {
global $wpdb;
$checkout_value = $wpdb->get_var(
$wpdb->prepare(
"SELECT option_value FROM $wpdb->options WHERE option_name = %s",
$this->get_lock_option_name()
)
);
if ( $checkout_value ) {
list( $checkout_id, $timestamp ) = explode( ':', $checkout_value );
if ( (int) $timestamp > time() ) {
return $checkout_id;
}
}
return false;
}
/**
* Sets the checkout id.
*
* @param string $checkout_id The ID of the checkout.
*
* @return bool|int
*/
private function set_checkout_id( $checkout_id ) {
global $wpdb;
$expires = time() + Defaults::$default_sync_queue_lock_timeout;
$updated_num = $wpdb->query(
$wpdb->prepare(
"UPDATE $wpdb->options SET option_value = %s WHERE option_name = %s",
"$checkout_id:$expires",
$this->get_lock_option_name()
)
);
if ( ! $updated_num ) {
$updated_num = $wpdb->query(
$wpdb->prepare(
"INSERT INTO $wpdb->options ( option_name, option_value, autoload ) VALUES ( %s, %s, 'no' )",
$this->get_lock_option_name(),
"$checkout_id:$expires"
)
);
}
return $updated_num;
}
/**
* Deletes the checkout ID.
*
* @return bool|int
*/
private function delete_checkout_id() {
global $wpdb;
// Rather than delete, which causes fragmentation, we update in place.
return $wpdb->query(
$wpdb->prepare(
"UPDATE $wpdb->options SET option_value = %s WHERE option_name = %s",
'0:0',
$this->get_lock_option_name()
)
);
}
/**
* Return the lock option name.
*
* @return string
*/
private function get_lock_option_name() {
return "jpsq_{$this->id}_checkout";
}
/**
* Return the next data row option name.
*
* @return string
*/
private function get_next_data_row_option_name() {
$timestamp = $this->generate_option_name_timestamp();
// Row iterator is used to avoid collisions where we're writing data waaay fast in a single process.
if ( PHP_INT_MAX === $this->row_iterator ) {
$this->row_iterator = 0;
} else {
$this->row_iterator += 1;
}
return 'jpsq_' . $this->id . '-' . $timestamp . '-' . $this->random_int . '-' . $this->row_iterator;
}
/**
* Return the items in the queue.
*
* @param null|int $limit Limit to the number of items we fetch at once.
*
* @return array|object|null
*/
private function fetch_items( $limit = null ) {
$items = $this->queue_storage->fetch_items( $limit );
return $this->unserialize_values( $items );
}
/**
* Return items with specific ids.
*
* @param array $items_ids Array of event ids.
*
* @return array|object|null
*/
private function fetch_items_by_id( $items_ids ) {
return $this->unserialize_values( $this->queue_storage->fetch_items_by_ids( $items_ids ) );
}
/**
* Unserialize item values.
*
* @param array $items Events from the Queue to be unserialized.
*
* @return mixed
*/
private function unserialize_values( $items ) {
array_walk(
$items,
function ( $item ) {
// @codingStandardsIgnoreStart
$item->value = @unserialize( $item->value );
// @codingStandardsIgnoreEnd
}
);
return $items;
}
/**
* Return true if the buffer is still valid or an Error other wise.
*
* @param \Automattic\Jetpack\Sync\Queue_Buffer $buffer The Queue_Buffer.
*
* @return bool|WP_Error
*/
private function validate_checkout( $buffer ) {
if ( ! $buffer instanceof Queue_Buffer ) {
return new WP_Error( 'not_a_buffer', 'You must checkin an instance of Automattic\\Jetpack\\Sync\\Queue_Buffer' );
}
$checkout_id = $this->get_checkout_id();
if ( ! $checkout_id ) {
return new WP_Error( 'buffer_not_checked_out', 'There are no checked out buffers' );
}
// TODO: change to strict comparison.
if ( $checkout_id != $buffer->id ) { // phpcs:ignore Universal.Operators.StrictComparisons.LooseNotEqual
return new WP_Error( 'buffer_mismatch', 'The buffer you checked in was not checked out' );
}
return true;
}
}
Fatal error: Uncaught Error: Class "Automattic\Jetpack\Sync\Queue" not found in /htdocs/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-sync/src/class-listener.php:467
Stack trace:
#0 /htdocs/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-sync/src/class-listener.php(75): Automattic\Jetpack\Sync\Listener->set_defaults()
#1 /htdocs/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-sync/src/class-listener.php(63): Automattic\Jetpack\Sync\Listener->__construct()
#2 /htdocs/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-sync/src/class-actions.php(759): Automattic\Jetpack\Sync\Listener::get_instance()
#3 /htdocs/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-sync/src/class-actions.php(146): Automattic\Jetpack\Sync\Actions::initialize_listener()
#4 /htdocs/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-sync/src/class-main.php(111): Automattic\Jetpack\Sync\Actions::init()
#5 /htdocs/wp-includes/class-wp-hook.php(324): Automattic\Jetpack\Sync\Main::on_plugins_loaded_late('')
#6 /htdocs/wp-includes/class-wp-hook.php(348): WP_Hook->apply_filters(NULL, Array)
#7 /htdocs/wp-includes/plugin.php(517): WP_Hook->do_action(Array)
#8 /htdocs/wp-settings.php(559): do_action('plugins_loaded')
#9 /htdocs/wp-config.php(85): require_once('/htdocs/wp-sett...')
#10 /htdocs/wp-load.php(50): require_once('/htdocs/wp-conf...')
#11 /htdocs/wp-blog-header.php(13): require_once('/htdocs/wp-load...')
#12 /htdocs/index.php(17): require('/htdocs/wp-blog...')
#13 {main}
thrown in /htdocs/wp-content/plugins/jetpack/jetpack_vendor/automattic/jetpack-sync/src/class-listener.php on line 467