diff options
Diffstat (limited to 'plugins/jetpack/sync/class.jetpack-sync-listener.php')
| -rw-r--r-- | plugins/jetpack/sync/class.jetpack-sync-listener.php | 329 |
1 files changed, 329 insertions, 0 deletions
diff --git a/plugins/jetpack/sync/class.jetpack-sync-listener.php b/plugins/jetpack/sync/class.jetpack-sync-listener.php new file mode 100644 index 00000000..62abc0d2 --- /dev/null +++ b/plugins/jetpack/sync/class.jetpack-sync-listener.php @@ -0,0 +1,329 @@ +<?php + +require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php'; +require_once dirname( __FILE__ ) . '/class.jetpack-sync-queue.php'; +require_once dirname( __FILE__ ) . '/class.jetpack-sync-modules.php'; +require_once dirname( __FILE__ ) . '/class.jetpack-sync-actions.php'; + +/** + * This class monitors actions and logs them to the queue to be sent + */ +class Jetpack_Sync_Listener { + const QUEUE_STATE_CHECK_TRANSIENT = 'jetpack_sync_last_checked_queue_state'; + const QUEUE_STATE_CHECK_TIMEOUT = 300; // 5 minutes + + private $sync_queue; + private $full_sync_queue; + private $sync_queue_size_limit; + private $sync_queue_lag_limit; + + // singleton functions + private static $instance; + + public static function get_instance() { + if ( null === self::$instance ) { + self::$instance = new self(); + } + + return self::$instance; + } + + // this is necessary because you can't use "new" when you declare instance properties >:( + protected function __construct() { + $this->set_defaults(); + $this->init(); + } + + private function init() { + $handler = array( $this, 'action_handler' ); + $full_sync_handler = array( $this, 'full_sync_action_handler' ); + + foreach ( Jetpack_Sync_Modules::get_modules() as $module ) { + $module->init_listeners( $handler ); + $module->init_full_sync_listeners( $full_sync_handler ); + } + + // Module Activation + add_action( 'jetpack_activate_module', $handler ); + add_action( 'jetpack_deactivate_module', $handler ); + + // Jetpack Upgrade + add_action( 'updating_jetpack_version', $handler, 10, 2 ); + + // Send periodic checksum + add_action( 'jetpack_sync_checksum', $handler ); + } + + function get_sync_queue() { + return $this->sync_queue; + } + + function get_full_sync_queue() { + return $this->full_sync_queue; + } + + function set_queue_size_limit( $limit ) { + $this->sync_queue_size_limit = $limit; + } + + function get_queue_size_limit() { + return $this->sync_queue_size_limit; + } + + function set_queue_lag_limit( $age ) { + $this->sync_queue_lag_limit = $age; + } + + function get_queue_lag_limit() { + return $this->sync_queue_lag_limit; + } + + function force_recheck_queue_limit() { + delete_transient( self::QUEUE_STATE_CHECK_TRANSIENT . '_' . $this->sync_queue->id ); + delete_transient( self::QUEUE_STATE_CHECK_TRANSIENT . '_' . $this->full_sync_queue->id ); + } + + // prevent adding items to the queue if it hasn't sent an item for 15 mins + // AND the queue is over 1000 items long (by default) + function can_add_to_queue( $queue ) { + if ( ! Jetpack_Sync_Settings::is_sync_enabled() ) { + return false; + } + + $state_transient_name = self::QUEUE_STATE_CHECK_TRANSIENT . '_' . $queue->id; + + $queue_state = get_transient( $state_transient_name ); + + if ( false === $queue_state ) { + $queue_state = array( $queue->size(), $queue->lag() ); + set_transient( $state_transient_name, $queue_state, self::QUEUE_STATE_CHECK_TIMEOUT ); + } + + list( $queue_size, $queue_age ) = $queue_state; + + return ( $queue_age < $this->sync_queue_lag_limit ) + || + ( ( $queue_size + 1 ) < $this->sync_queue_size_limit ); + } + + function full_sync_action_handler() { + $args = func_get_args(); + $this->enqueue_action( current_filter(), $args, $this->full_sync_queue ); + } + + function action_handler() { + $args = func_get_args(); + $this->enqueue_action( current_filter(), $args, $this->sync_queue ); + } + + // add many actions to the queue directly, without invoking them + + /** + * Bulk add action to the queue. + * + * @param $action_name String the name the full sync action. + * @param $args_array Array of chunked arguments + */ + function bulk_enqueue_full_sync_actions( $action_name, $args_array ) { + $queue = $this->get_full_sync_queue(); + + // periodically check the size of the queue, and disable adding to it if + // it exceeds some limit AND the oldest item exceeds the age limit (i.e. sending has stopped) + if ( ! $this->can_add_to_queue( $queue ) ) { + return; + } + + // if we add any items to the queue, we should try to ensure that our script + // can't be killed before they are sent + if ( function_exists( 'ignore_user_abort' ) ) { + ignore_user_abort( true ); + } + + $data_to_enqueue = array(); + $user_id = get_current_user_id(); + $currtime = microtime( true ); + $is_importing = Jetpack_Sync_Settings::is_importing(); + + foreach ( $args_array as $args ) { + $previous_end = isset( $args['previous_end'] ) ? $args['previous_end'] : null; + $args = isset( $args['ids'] ) ? $args['ids'] : $args; + + + /** + * Modify or reject the data within an action before it is enqueued locally. + * + * @since 4.2.0 + * + * @module sync + * + * @param array The action parameters + */ + $args = apply_filters( "jetpack_sync_before_enqueue_$action_name", $args ); + $action_data = array( $args ); + if ( ! is_null( $previous_end ) ) { + $action_data[] = $previous_end; + } + // allow listeners to abort + if ( $args === false ) { + continue; + } + + $data_to_enqueue[] = array( + $action_name, + $action_data, + $user_id, + $currtime, + $is_importing, + ); + } + + $queue->add_all( $data_to_enqueue ); + } + + function enqueue_action( $current_filter, $args, $queue ) { + // don't enqueue an action during the outbound http request - this prevents recursion + if ( Jetpack_Sync_Settings::is_sending() ) { + return; + } + + /** + * Add an action hook to execute when anything on the whitelist gets sent to the queue to sync. + * + * @module sync + * + * @since 5.9.0 + */ + do_action( 'jetpack_sync_action_before_enqueue' ); + + /** + * Modify or reject the data within an action before it is enqueued locally. + * + * @since 4.2.0 + * + * @param array The action parameters + */ + $args = apply_filters( "jetpack_sync_before_enqueue_$current_filter", $args ); + + // allow listeners to abort + if ( $args === false ) { + return; + } + + // periodically check the size of the queue, and disable adding to it if + // it exceeds some limit AND the oldest item exceeds the age limit (i.e. sending has stopped) + if ( ! $this->can_add_to_queue( $queue ) ) { + return; + } + + // if we add any items to the queue, we should try to ensure that our script + // can't be killed before they are sent + if ( function_exists( 'ignore_user_abort' ) ) { + ignore_user_abort( true ); + } + + if ( + 'sync' === $queue->id || + in_array( + $current_filter, + array( + 'jetpack_full_sync_start', + 'jetpack_full_sync_end', + 'jetpack_full_sync_cancel', + ) + ) + ) { + $queue->add( + array( + $current_filter, + $args, + get_current_user_id(), + microtime( true ), + Jetpack_Sync_Settings::is_importing(), + $this->get_actor( $current_filter, $args ), + ) + ); + } else { + $queue->add( + array( + $current_filter, + $args, + get_current_user_id(), + microtime( true ), + Jetpack_Sync_Settings::is_importing(), + ) + ); + } + + // since we've added some items, let's try to load the sender so we can send them as quickly as possible + if ( ! Jetpack_Sync_Actions::$sender ) { + add_filter( 'jetpack_sync_sender_should_load', '__return_true' ); + if ( did_action( 'init' ) ) { + Jetpack_Sync_Actions::add_sender_shutdown(); + } + } + } + + function get_actor( $current_filter, $args ) { + if ( 'wp_login' === $current_filter ) { + $user = get_user_by( 'ID', $args[1]->data->ID ); + } else { + $user = wp_get_current_user(); + } + + $translated_role = Jetpack::translate_user_to_role( $user ); + + $actor = array( + 'wpcom_user_id' => null, + 'external_user_id' => isset( $user->ID ) ? $user->ID : null, + 'display_name' => isset( $user->display_name ) ? $user->display_name : null, + 'user_email' => isset( $user->user_email ) ? $user->user_email : null, + 'user_roles' => isset( $user->roles ) ? $user->roles : null, + 'translated_role' => $translated_role ? $translated_role : null, + 'is_cron' => defined( 'DOING_CRON' ) ? DOING_CRON : false, + 'is_rest' => defined( 'REST_API_REQUEST' ) ? REST_API_REQUEST : false, + 'is_xmlrpc' => defined( 'XMLRPC_REQUEST' ) ? XMLRPC_REQUEST : false, + 'is_wp_rest' => defined( 'REST_REQUEST' ) ? REST_REQUEST : false, + 'is_ajax' => defined( 'DOING_AJAX' ) ? DOING_AJAX : false, + 'is_wp_admin' => is_admin(), + 'is_cli' => defined( 'WP_CLI' ) ? WP_CLI : false, + 'from_url' => $this->get_request_url(), + ); + + if ( $this->should_send_user_data_with_actor( $current_filter ) ) { + require_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php'; + $actor['ip'] = jetpack_protect_get_ip(); + $actor['user_agent'] = isset( $_SERVER['HTTP_USER_AGENT'] ) ? $_SERVER['HTTP_USER_AGENT'] : 'unknown'; + } + + return $actor; + } + + function should_send_user_data_with_actor( $current_filter ) { + $should_send = in_array( $current_filter, array( 'jetpack_wp_login', 'wp_logout', 'jetpack_valid_failed_login_attempt' ) ); + /** + * Allow or deny sending actor's user data ( IP and UA ) during a sync event + * + * @since 5.8.0 + * + * @module sync + * + * @param bool True if we should send user data + * @param string The current filter that is performing the sync action + */ + return apply_filters( 'jetpack_sync_actor_user_data', $should_send, $current_filter ); + } + + function set_defaults() { + $this->sync_queue = new Jetpack_Sync_Queue( 'sync' ); + $this->full_sync_queue = new Jetpack_Sync_Queue( 'full_sync' ); + $this->set_queue_size_limit( Jetpack_Sync_Settings::get_setting( 'max_queue_size' ) ); + $this->set_queue_lag_limit( Jetpack_Sync_Settings::get_setting( 'max_queue_lag' ) ); + } + + function get_request_url() { + if ( isset( $_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'] ) ) { + return 'http' . ( isset( $_SERVER['HTTPS'] ) ? 's' : '' ) . '://' . "{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}"; + } + return is_admin() ? get_admin_url( get_current_blog_id() ) : home_url(); + } +} |