iqltechnologies / brighty

plugins/woocommerce/packages/action-scheduler/classes/migration/ActionScheduler_DBStoreMigrator.php

Indentation +31 added lines, -31 removed lines

@@ -9,39 +9,39 @@
  */
 class ActionScheduler_DBStoreMigrator extends ActionScheduler_DBStore {
 
-	/**
-	 * Save an action with optional last attempt date.
-	 *
-	 * Normally, saving an action sets its attempted date to 0000-00-00 00:00:00 because when an action is first saved,
-	 * it can't have been attempted yet, but migrated completed actions will have an attempted date, so we need to save
-	 * that when first saving the action.
-	 *
-	 * @param ActionScheduler_Action $action
-	 * @param \DateTime $scheduled_date Optional date of the first instance to store.
-	 * @param \DateTime $last_attempt_date Optional date the action was last attempted.
-	 *
-	 * @return string The action ID
-	 * @throws \RuntimeException When the action is not saved.
-	 */
-	public function save_action( ActionScheduler_Action $action, \DateTime $scheduled_date = null, \DateTime $last_attempt_date = null ){
-		try {
-			/** @var \wpdb $wpdb */
-			global $wpdb;
+    /**
+     * Save an action with optional last attempt date.
+     *
+     * Normally, saving an action sets its attempted date to 0000-00-00 00:00:00 because when an action is first saved,
+     * it can't have been attempted yet, but migrated completed actions will have an attempted date, so we need to save
+     * that when first saving the action.
+     *
+     * @param ActionScheduler_Action $action
+     * @param \DateTime $scheduled_date Optional date of the first instance to store.
+     * @param \DateTime $last_attempt_date Optional date the action was last attempted.
+     *
+     * @return string The action ID
+     * @throws \RuntimeException When the action is not saved.
+     */
+    public function save_action( ActionScheduler_Action $action, \DateTime $scheduled_date = null, \DateTime $last_attempt_date = null ){
+        try {
+            /** @var \wpdb $wpdb */
+            global $wpdb;
 
-			$action_id = parent::save_action( $action, $scheduled_date );
+            $action_id = parent::save_action( $action, $scheduled_date );
 
-			if ( null !== $last_attempt_date ) {
-				$data = [
-					'last_attempt_gmt'   => $this->get_scheduled_date_string( $action, $last_attempt_date ),
-					'last_attempt_local' => $this->get_scheduled_date_string_local( $action, $last_attempt_date ),
-				];
+            if ( null !== $last_attempt_date ) {
+                $data = [
+                    'last_attempt_gmt'   => $this->get_scheduled_date_string( $action, $last_attempt_date ),
+                    'last_attempt_local' => $this->get_scheduled_date_string_local( $action, $last_attempt_date ),
+                ];
 
-				$wpdb->update( $wpdb->actionscheduler_actions, $data, array( 'action_id' => $action_id ), array( '%s', '%s' ), array( '%d' ) );
-			}
+                $wpdb->update( $wpdb->actionscheduler_actions, $data, array( 'action_id' => $action_id ), array( '%s', '%s' ), array( '%d' ) );
+            }
 
-			return $action_id;
-		} catch ( \Exception $e ) {
-			throw new \RuntimeException( sprintf( __( 'Error saving action: %s', 'woocommerce' ), $e->getMessage() ), 0 );
-		}
-	}
+            return $action_id;
+        } catch ( \Exception $e ) {
+            throw new \RuntimeException( sprintf( __( 'Error saving action: %s', 'woocommerce' ), $e->getMessage() ), 0 );
+        }
+    }
 }

plugins/woocommerce/packages/action-scheduler/classes/migration/DryRun_LogMigrator.php

Indentation +9 added lines, -9 removed lines

@@ -11,13 +11,13 @@
  * @codeCoverageIgnore
  */
 class DryRun_LogMigrator extends LogMigrator {
-	/**
-	 * Simulate migrating an action log.
-	 *
-	 * @param int $source_action_id Source logger object.
-	 * @param int $destination_action_id Destination logger object.
-	 */
-	public function migrate( $source_action_id, $destination_action_id ) {
-		// no-op
-	}
+    /**
+     * Simulate migrating an action log.
+     *
+     * @param int $source_action_id Source logger object.
+     * @param int $destination_action_id Destination logger object.
+     */
+    public function migrate( $source_action_id, $destination_action_id ) {
+        // no-op
+    }
 }
\ No newline at end of file

plugins/woocommerce/packages/action-scheduler/classes/ActionScheduler_ListTable.php

Indentation +634 added lines, -634 removed lines

@@ -6,638 +6,638 @@
  */
 class ActionScheduler_ListTable extends ActionScheduler_Abstract_ListTable {
 
-	/**
-	 * The package name.
-	 *
-	 * @var string
-	 */
-	protected $package = 'action-scheduler';
-
-	/**
-	 * Columns to show (name => label).
-	 *
-	 * @var array
-	 */
-	protected $columns = array();
-
-	/**
-	 * Actions (name => label).
-	 *
-	 * @var array
-	 */
-	protected $row_actions = array();
-
-	/**
-	 * The active data stores
-	 *
-	 * @var ActionScheduler_Store
-	 */
-	protected $store;
-
-	/**
-	 * A logger to use for getting action logs to display
-	 *
-	 * @var ActionScheduler_Logger
-	 */
-	protected $logger;
-
-	/**
-	 * A ActionScheduler_QueueRunner runner instance (or child class)
-	 *
-	 * @var ActionScheduler_QueueRunner
-	 */
-	protected $runner;
-
-	/**
-	 * Bulk actions. The key of the array is the method name of the implementation:
-	 *
-	 *     bulk_<key>(array $ids, string $sql_in).
-	 *
-	 * See the comments in the parent class for further details
-	 *
-	 * @var array
-	 */
-	protected $bulk_actions = array();
-
-	/**
-	 * Flag variable to render our notifications, if any, once.
-	 *
-	 * @var bool
-	 */
-	protected static $did_notification = false;
-
-	/**
-	 * Array of seconds for common time periods, like week or month, alongside an internationalised string representation, i.e. "Day" or "Days"
-	 *
-	 * @var array
-	 */
-	private static $time_periods;
-
-	/**
-	 * Sets the current data store object into `store->action` and initialises the object.
-	 *
-	 * @param ActionScheduler_Store $store
-	 * @param ActionScheduler_Logger $logger
-	 * @param ActionScheduler_QueueRunner $runner
-	 */
-	public function __construct( ActionScheduler_Store $store, ActionScheduler_Logger $logger, ActionScheduler_QueueRunner $runner ) {
-
-		$this->store  = $store;
-		$this->logger = $logger;
-		$this->runner = $runner;
-
-		$this->table_header = __( 'Scheduled Actions', 'woocommerce' );
-
-		$this->bulk_actions = array(
-			'delete' => __( 'Delete', 'woocommerce' ),
-		);
-
-		$this->columns = array(
-			'hook'        => __( 'Hook', 'woocommerce' ),
-			'status'      => __( 'Status', 'woocommerce' ),
-			'args'        => __( 'Arguments', 'woocommerce' ),
-			'group'       => __( 'Group', 'woocommerce' ),
-			'recurrence'  => __( 'Recurrence', 'woocommerce' ),
-			'schedule'    => __( 'Scheduled Date', 'woocommerce' ),
-			'log_entries' => __( 'Log', 'woocommerce' ),
-		);
-
-		$this->sort_by = array(
-			'schedule',
-			'hook',
-			'group',
-		);
-
-		$this->search_by = array(
-			'hook',
-			'args',
-			'claim_id',
-		);
-
-		$request_status = $this->get_request_status();
-
-		if ( empty( $request_status ) ) {
-			$this->sort_by[] = 'status';
-		} elseif ( in_array( $request_status, array( 'in-progress', 'failed' ) ) ) {
-			$this->columns  += array( 'claim_id' => __( 'Claim ID', 'woocommerce' ) );
-			$this->sort_by[] = 'claim_id';
-		}
-
-		$this->row_actions = array(
-			'hook' => array(
-				'run' => array(
-					'name'  => __( 'Run', 'woocommerce' ),
-					'desc'  => __( 'Process the action now as if it were run as part of a queue', 'woocommerce' ),
-				),
-				'cancel' => array(
-					'name'  => __( 'Cancel', 'woocommerce' ),
-					'desc'  => __( 'Cancel the action now to avoid it being run in future', 'woocommerce' ),
-					'class' => 'cancel trash',
-				),
-			),
-		);
-
-		self::$time_periods = array(
-			array(
-				'seconds' => YEAR_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s year', '%s years', 'woocommerce' ),
-			),
-			array(
-				'seconds' => MONTH_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s month', '%s months', 'woocommerce' ),
-			),
-			array(
-				'seconds' => WEEK_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s week', '%s weeks', 'woocommerce' ),
-			),
-			array(
-				'seconds' => DAY_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s day', '%s days', 'woocommerce' ),
-			),
-			array(
-				'seconds' => HOUR_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s hour', '%s hours', 'woocommerce' ),
-			),
-			array(
-				'seconds' => MINUTE_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s minute', '%s minutes', 'woocommerce' ),
-			),
-			array(
-				'seconds' => 1,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s second', '%s seconds', 'woocommerce' ),
-			),
-		);
-
-		parent::__construct(
-			array(
-				'singular' => 'action-scheduler',
-				'plural'   => 'action-scheduler',
-				'ajax'     => false,
-			)
-		);
-
-		add_screen_option(
-			'per_page',
-			array(
-				'default' => $this->items_per_page,
-			)
-		);
-
-		add_filter( 'set_screen_option_' . $this->get_per_page_option_name(), array( $this, 'set_items_per_page_option' ), 10, 3 );
-		set_screen_options();
-	}
-
-	/**
-	 * Handles setting the items_per_page option for this screen.
-	 *
-	 * @param mixed  $status Default false (to skip saving the current option).
-	 * @param string $option Screen option name.
-	 * @param int    $value  Screen option value.
-	 * @return int
-	 */
-	public function set_items_per_page_option( $status, $option, $value ) {
-		return $value;
-	}
-	/**
-	 * Convert an interval of seconds into a two part human friendly string.
-	 *
-	 * The WordPress human_time_diff() function only calculates the time difference to one degree, meaning
-	 * even if an action is 1 day and 11 hours away, it will display "1 day". This function goes one step
-	 * further to display two degrees of accuracy.
-	 *
-	 * Inspired by the Crontrol::interval() function by Edward Dale: https://wordpress.org/plugins/wp-crontrol/
-	 *
-	 * @param int $interval A interval in seconds.
-	 * @param int $periods_to_include Depth of time periods to include, e.g. for an interval of 70, and $periods_to_include of 2, both minutes and seconds would be included. With a value of 1, only minutes would be included.
-	 * @return string A human friendly string representation of the interval.
-	 */
-	private static function human_interval( $interval, $periods_to_include = 2 ) {
-
-		if ( $interval <= 0 ) {
-			return __( 'Now!', 'woocommerce' );
-		}
-
-		$output = '';
-
-		for ( $time_period_index = 0, $periods_included = 0, $seconds_remaining = $interval; $time_period_index < count( self::$time_periods ) && $seconds_remaining > 0 && $periods_included < $periods_to_include; $time_period_index++ ) {
-
-			$periods_in_interval = floor( $seconds_remaining / self::$time_periods[ $time_period_index ]['seconds'] );
-
-			if ( $periods_in_interval > 0 ) {
-				if ( ! empty( $output ) ) {
-					$output .= ' ';
-				}
-				$output .= sprintf( _n( self::$time_periods[ $time_period_index ]['names'][0], self::$time_periods[ $time_period_index ]['names'][1], $periods_in_interval, 'woocommerce' ), $periods_in_interval );
-				$seconds_remaining -= $periods_in_interval * self::$time_periods[ $time_period_index ]['seconds'];
-				$periods_included++;
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * Returns the recurrence of an action or 'Non-repeating'. The output is human readable.
-	 *
-	 * @param ActionScheduler_Action $action
-	 *
-	 * @return string
-	 */
-	protected function get_recurrence( $action ) {
-		$schedule = $action->get_schedule();
-		if ( $schedule->is_recurring() ) {
-			$recurrence = $schedule->get_recurrence();
-
-			if ( is_numeric( $recurrence ) ) {
-				/* translators: %s: time interval */
-				return sprintf( __( 'Every %s', 'woocommerce' ), self::human_interval( $recurrence ) );
-			} else {
-				return $recurrence;
-			}
-		}
-
-		return __( 'Non-repeating', 'woocommerce' );
-	}
-
-	/**
-	 * Serializes the argument of an action to render it in a human friendly format.
-	 *
-	 * @param array $row The array representation of the current row of the table
-	 *
-	 * @return string
-	 */
-	public function column_args( array $row ) {
-		if ( empty( $row['args'] ) ) {
-			return apply_filters( 'action_scheduler_list_table_column_args', '', $row );
-		}
-
-		$row_html = '<ul>';
-		foreach ( $row['args'] as $key => $value ) {
-			$row_html .= sprintf( '<li><code>%s => %s</code></li>', esc_html( var_export( $key, true ) ), esc_html( var_export( $value, true ) ) );
-		}
-		$row_html .= '</ul>';
-
-		return apply_filters( 'action_scheduler_list_table_column_args', $row_html, $row );
-	}
-
-	/**
-	 * Prints the logs entries inline. We do so to avoid loading Javascript and other hacks to show it in a modal.
-	 *
-	 * @param array $row Action array.
-	 * @return string
-	 */
-	public function column_log_entries( array $row ) {
-
-		$log_entries_html = '<ol>';
-
-		$timezone = new DateTimezone( 'UTC' );
-
-		foreach ( $row['log_entries'] as $log_entry ) {
-			$log_entries_html .= $this->get_log_entry_html( $log_entry, $timezone );
-		}
-
-		$log_entries_html .= '</ol>';
-
-		return $log_entries_html;
-	}
-
-	/**
-	 * Prints the logs entries inline. We do so to avoid loading Javascript and other hacks to show it in a modal.
-	 *
-	 * @param ActionScheduler_LogEntry $log_entry
-	 * @param DateTimezone $timezone
-	 * @return string
-	 */
-	protected function get_log_entry_html( ActionScheduler_LogEntry $log_entry, DateTimezone $timezone ) {
-		$date = $log_entry->get_date();
-		$date->setTimezone( $timezone );
-		return sprintf( '<li><strong>%s</strong><br/>%s</li>', esc_html( $date->format( 'Y-m-d H:i:s O' ) ), esc_html( $log_entry->get_message() ) );
-	}
-
-	/**
-	 * Only display row actions for pending actions.
-	 *
-	 * @param array  $row         Row to render
-	 * @param string $column_name Current row
-	 *
-	 * @return string
-	 */
-	protected function maybe_render_actions( $row, $column_name ) {
-		if ( 'pending' === strtolower( $row[ 'status_name' ] ) ) {
-			return parent::maybe_render_actions( $row, $column_name );
-		}
-
-		return '';
-	}
-
-	/**
-	 * Renders admin notifications
-	 *
-	 * Notifications:
-	 *  1. When the maximum number of tasks are being executed simultaneously.
-	 *  2. Notifications when a task is manually executed.
-	 *  3. Tables are missing.
-	 */
-	public function display_admin_notices() {
-		global $wpdb;
-
-		if ( ( is_a( $this->store, 'ActionScheduler_HybridStore' ) || is_a( $this->store, 'ActionScheduler_DBStore' ) ) && apply_filters( 'action_scheduler_enable_recreate_data_store', true ) ) {
-			$table_list = array(
-				'actionscheduler_actions',
-				'actionscheduler_logs',
-				'actionscheduler_groups',
-				'actionscheduler_claims',
-			);
-
-			$found_tables = $wpdb->get_col( "SHOW TABLES LIKE '{$wpdb->prefix}actionscheduler%'" ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-			foreach ( $table_list as $table_name ) {
-				if ( ! in_array( $wpdb->prefix . $table_name, $found_tables ) ) {
-					$this->admin_notices[] = array(
-						'class'   => 'error',
-						'message' => __( 'It appears one or more database tables were missing. Attempting to re-create the missing table(s).' , 'woocommerce' ),
-					);
-					$this->recreate_tables();
-					parent::display_admin_notices();
-
-					return;
-				}
-			}
-		}
-
-		if ( $this->runner->has_maximum_concurrent_batches() ) {
-			$claim_count           = $this->store->get_claim_count();
-			$this->admin_notices[] = array(
-				'class'   => 'updated',
-				'message' => sprintf(
-					/* translators: %s: amount of claims */
-					_n(
-						'Maximum simultaneous queues already in progress (%s queue). No additional queues will begin processing until the current queues are complete.',
-						'Maximum simultaneous queues already in progress (%s queues). No additional queues will begin processing until the current queues are complete.',
-						$claim_count,
-						'woocommerce'
-					),
-					$claim_count
-				),
-			);
-		} elseif ( $this->store->has_pending_actions_due() ) {
-
-			$async_request_lock_expiration = ActionScheduler::lock()->get_expiration( 'async-request-runner' );
-
-			// No lock set or lock expired
-			if ( false === $async_request_lock_expiration || $async_request_lock_expiration < time() ) {
-				$in_progress_url       = add_query_arg( 'status', 'in-progress', remove_query_arg( 'status' ) );
-				/* translators: %s: process URL */
-				$async_request_message = sprintf( __( 'A new queue has begun processing. <a href="%s">View actions in-progress &raquo;</a>', 'woocommerce' ), esc_url( $in_progress_url ) );
-			} else {
-				/* translators: %d: seconds */
-				$async_request_message = sprintf( __( 'The next queue will begin processing in approximately %d seconds.', 'woocommerce' ), $async_request_lock_expiration - time() );
-			}
-
-			$this->admin_notices[] = array(
-				'class'   => 'notice notice-info',
-				'message' => $async_request_message,
-			);
-		}
-
-		$notification = get_transient( 'action_scheduler_admin_notice' );
-
-		if ( is_array( $notification ) ) {
-			delete_transient( 'action_scheduler_admin_notice' );
-
-			$action = $this->store->fetch_action( $notification['action_id'] );
-			$action_hook_html = '<strong><code>' . $action->get_hook() . '</code></strong>';
-			if ( 1 == $notification['success'] ) {
-				$class = 'updated';
-				switch ( $notification['row_action_type'] ) {
-					case 'run' :
-						/* translators: %s: action HTML */
-						$action_message_html = sprintf( __( 'Successfully executed action: %s', 'woocommerce' ), $action_hook_html );
-						break;
-					case 'cancel' :
-						/* translators: %s: action HTML */
-						$action_message_html = sprintf( __( 'Successfully canceled action: %s', 'woocommerce' ), $action_hook_html );
-						break;
-					default :
-						/* translators: %s: action HTML */
-						$action_message_html = sprintf( __( 'Successfully processed change for action: %s', 'woocommerce' ), $action_hook_html );
-						break;
-				}
-			} else {
-				$class = 'error';
-				/* translators: 1: action HTML 2: action ID 3: error message */
-				$action_message_html = sprintf( __( 'Could not process change for action: "%1$s" (ID: %2$d). Error: %3$s', 'woocommerce' ), $action_hook_html, esc_html( $notification['action_id'] ), esc_html( $notification['error_message'] ) );
-			}
-
-			$action_message_html = apply_filters( 'action_scheduler_admin_notice_html', $action_message_html, $action, $notification );
-
-			$this->admin_notices[] = array(
-				'class'   => $class,
-				'message' => $action_message_html,
-			);
-		}
-
-		parent::display_admin_notices();
-	}
-
-	/**
-	 * Prints the scheduled date in a human friendly format.
-	 *
-	 * @param array $row The array representation of the current row of the table
-	 *
-	 * @return string
-	 */
-	public function column_schedule( $row ) {
-		return $this->get_schedule_display_string( $row['schedule'] );
-	}
-
-	/**
-	 * Get the scheduled date in a human friendly format.
-	 *
-	 * @param ActionScheduler_Schedule $schedule
-	 * @return string
-	 */
-	protected function get_schedule_display_string( ActionScheduler_Schedule $schedule ) {
-
-		$schedule_display_string = '';
-
-		if ( ! $schedule->get_date() ) {
-			return '0000-00-00 00:00:00';
-		}
-
-		$next_timestamp = $schedule->get_date()->getTimestamp();
-
-		$schedule_display_string .= $schedule->get_date()->format( 'Y-m-d H:i:s O' );
-		$schedule_display_string .= '<br/>';
-
-		if ( gmdate( 'U' ) > $next_timestamp ) {
-			/* translators: %s: date interval */
-			$schedule_display_string .= sprintf( __( ' (%s ago)', 'woocommerce' ), self::human_interval( gmdate( 'U' ) - $next_timestamp ) );
-		} else {
-			/* translators: %s: date interval */
-			$schedule_display_string .= sprintf( __( ' (%s)', 'woocommerce' ), self::human_interval( $next_timestamp - gmdate( 'U' ) ) );
-		}
-
-		return $schedule_display_string;
-	}
-
-	/**
-	 * Bulk delete
-	 *
-	 * Deletes actions based on their ID. This is the handler for the bulk delete. It assumes the data
-	 * properly validated by the callee and it will delete the actions without any extra validation.
-	 *
-	 * @param array $ids
-	 * @param string $ids_sql Inherited and unused
-	 */
-	protected function bulk_delete( array $ids, $ids_sql ) {
-		foreach ( $ids as $id ) {
-			$this->store->delete_action( $id );
-		}
-	}
-
-	/**
-	 * Implements the logic behind running an action. ActionScheduler_Abstract_ListTable validates the request and their
-	 * parameters are valid.
-	 *
-	 * @param int $action_id
-	 */
-	protected function row_action_cancel( $action_id ) {
-		$this->process_row_action( $action_id, 'cancel' );
-	}
-
-	/**
-	 * Implements the logic behind running an action. ActionScheduler_Abstract_ListTable validates the request and their
-	 * parameters are valid.
-	 *
-	 * @param int $action_id
-	 */
-	protected function row_action_run( $action_id ) {
-		$this->process_row_action( $action_id, 'run' );
-	}
-
-	/**
-	 * Force the data store schema updates.
-	 */
-	protected function recreate_tables() {
-		if ( is_a( $this->store, 'ActionScheduler_HybridStore' ) ) {
-			$store = $this->store;
-		} else {
-			$store = new ActionScheduler_HybridStore();
-		}
-		add_action( 'action_scheduler/created_table', array( $store, 'set_autoincrement' ), 10, 2 );
-
-		$store_schema  = new ActionScheduler_StoreSchema();
-		$logger_schema = new ActionScheduler_LoggerSchema();
-		$store_schema->register_tables( true );
-		$logger_schema->register_tables( true );
-
-		remove_action( 'action_scheduler/created_table', array( $store, 'set_autoincrement' ), 10 );
-	}
-	/**
-	 * Implements the logic behind processing an action once an action link is clicked on the list table.
-	 *
-	 * @param int $action_id
-	 * @param string $row_action_type The type of action to perform on the action.
-	 */
-	protected function process_row_action( $action_id, $row_action_type ) {
-		try {
-			switch ( $row_action_type ) {
-				case 'run' :
-					$this->runner->process_action( $action_id, 'Admin List Table' );
-					break;
-				case 'cancel' :
-					$this->store->cancel_action( $action_id );
-					break;
-			}
-			$success = 1;
-			$error_message = '';
-		} catch ( Exception $e ) {
-			$success = 0;
-			$error_message = $e->getMessage();
-		}
-
-		set_transient( 'action_scheduler_admin_notice', compact( 'action_id', 'success', 'error_message', 'row_action_type' ), 30 );
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	public function prepare_items() {
-		$this->prepare_column_headers();
-
-		$per_page = $this->get_items_per_page( $this->get_per_page_option_name(), $this->items_per_page );
-
-		$query = array(
-			'per_page' => $per_page,
-			'offset'   => $this->get_items_offset(),
-			'status'   => $this->get_request_status(),
-			'orderby'  => $this->get_request_orderby(),
-			'order'    => $this->get_request_order(),
-			'search'   => $this->get_request_search_query(),
-		);
-
-		$this->items = array();
-
-		$total_items = $this->store->query_actions( $query, 'count' );
-
-		$status_labels = $this->store->get_status_labels();
-
-		foreach ( $this->store->query_actions( $query ) as $action_id ) {
-			try {
-				$action = $this->store->fetch_action( $action_id );
-			} catch ( Exception $e ) {
-				continue;
-			}
-			if ( is_a( $action, 'ActionScheduler_NullAction' ) ) {
-				continue;
-			}
-			$this->items[ $action_id ] = array(
-				'ID'          => $action_id,
-				'hook'        => $action->get_hook(),
-				'status_name' => $this->store->get_status( $action_id ),
-				'status'      => $status_labels[ $this->store->get_status( $action_id ) ],
-				'args'        => $action->get_args(),
-				'group'       => $action->get_group(),
-				'log_entries' => $this->logger->get_logs( $action_id ),
-				'claim_id'    => $this->store->get_claim_id( $action_id ),
-				'recurrence'  => $this->get_recurrence( $action ),
-				'schedule'    => $action->get_schedule(),
-			);
-		}
-
-		$this->set_pagination_args( array(
-			'total_items' => $total_items,
-			'per_page'    => $per_page,
-			'total_pages' => ceil( $total_items / $per_page ),
-		) );
-	}
-
-	/**
-	 * Prints the available statuses so the user can click to filter.
-	 */
-	protected function display_filter_by_status() {
-		$this->status_counts = $this->store->action_counts();
-		parent::display_filter_by_status();
-	}
-
-	/**
-	 * Get the text to display in the search box on the list table.
-	 */
-	protected function get_search_box_button_text() {
-		return __( 'Search hook, args and claim ID', 'woocommerce' );
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	protected function get_per_page_option_name() {
-		return str_replace( '-', '_', $this->screen->id ) . '_per_page';
-	}
+    /**
+     * The package name.
+     *
+     * @var string
+     */
+    protected $package = 'action-scheduler';
+
+    /**
+     * Columns to show (name => label).
+     *
+     * @var array
+     */
+    protected $columns = array();
+
+    /**
+     * Actions (name => label).
+     *
+     * @var array
+     */
+    protected $row_actions = array();
+
+    /**
+     * The active data stores
+     *
+     * @var ActionScheduler_Store
+     */
+    protected $store;
+
+    /**
+     * A logger to use for getting action logs to display
+     *
+     * @var ActionScheduler_Logger
+     */
+    protected $logger;
+
+    /**
+     * A ActionScheduler_QueueRunner runner instance (or child class)
+     *
+     * @var ActionScheduler_QueueRunner
+     */
+    protected $runner;
+
+    /**
+     * Bulk actions. The key of the array is the method name of the implementation:
+     *
+     *     bulk_<key>(array $ids, string $sql_in).
+     *
+     * See the comments in the parent class for further details
+     *
+     * @var array
+     */
+    protected $bulk_actions = array();
+
+    /**
+     * Flag variable to render our notifications, if any, once.
+     *
+     * @var bool
+     */
+    protected static $did_notification = false;
+
+    /**
+     * Array of seconds for common time periods, like week or month, alongside an internationalised string representation, i.e. "Day" or "Days"
+     *
+     * @var array
+     */
+    private static $time_periods;
+
+    /**
+     * Sets the current data store object into `store->action` and initialises the object.
+     *
+     * @param ActionScheduler_Store $store
+     * @param ActionScheduler_Logger $logger
+     * @param ActionScheduler_QueueRunner $runner
+     */
+    public function __construct( ActionScheduler_Store $store, ActionScheduler_Logger $logger, ActionScheduler_QueueRunner $runner ) {
+
+        $this->store  = $store;
+        $this->logger = $logger;
+        $this->runner = $runner;
+
+        $this->table_header = __( 'Scheduled Actions', 'woocommerce' );
+
+        $this->bulk_actions = array(
+            'delete' => __( 'Delete', 'woocommerce' ),
+        );
+
+        $this->columns = array(
+            'hook'        => __( 'Hook', 'woocommerce' ),
+            'status'      => __( 'Status', 'woocommerce' ),
+            'args'        => __( 'Arguments', 'woocommerce' ),
+            'group'       => __( 'Group', 'woocommerce' ),
+            'recurrence'  => __( 'Recurrence', 'woocommerce' ),
+            'schedule'    => __( 'Scheduled Date', 'woocommerce' ),
+            'log_entries' => __( 'Log', 'woocommerce' ),
+        );
+
+        $this->sort_by = array(
+            'schedule',
+            'hook',
+            'group',
+        );
+
+        $this->search_by = array(
+            'hook',
+            'args',
+            'claim_id',
+        );
+
+        $request_status = $this->get_request_status();
+
+        if ( empty( $request_status ) ) {
+            $this->sort_by[] = 'status';
+        } elseif ( in_array( $request_status, array( 'in-progress', 'failed' ) ) ) {
+            $this->columns  += array( 'claim_id' => __( 'Claim ID', 'woocommerce' ) );
+            $this->sort_by[] = 'claim_id';
+        }
+
+        $this->row_actions = array(
+            'hook' => array(
+                'run' => array(
+                    'name'  => __( 'Run', 'woocommerce' ),
+                    'desc'  => __( 'Process the action now as if it were run as part of a queue', 'woocommerce' ),
+                ),
+                'cancel' => array(
+                    'name'  => __( 'Cancel', 'woocommerce' ),
+                    'desc'  => __( 'Cancel the action now to avoid it being run in future', 'woocommerce' ),
+                    'class' => 'cancel trash',
+                ),
+            ),
+        );
+
+        self::$time_periods = array(
+            array(
+                'seconds' => YEAR_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s year', '%s years', 'woocommerce' ),
+            ),
+            array(
+                'seconds' => MONTH_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s month', '%s months', 'woocommerce' ),
+            ),
+            array(
+                'seconds' => WEEK_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s week', '%s weeks', 'woocommerce' ),
+            ),
+            array(
+                'seconds' => DAY_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s day', '%s days', 'woocommerce' ),
+            ),
+            array(
+                'seconds' => HOUR_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s hour', '%s hours', 'woocommerce' ),
+            ),
+            array(
+                'seconds' => MINUTE_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s minute', '%s minutes', 'woocommerce' ),
+            ),
+            array(
+                'seconds' => 1,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s second', '%s seconds', 'woocommerce' ),
+            ),
+        );
+
+        parent::__construct(
+            array(
+                'singular' => 'action-scheduler',
+                'plural'   => 'action-scheduler',
+                'ajax'     => false,
+            )
+        );
+
+        add_screen_option(
+            'per_page',
+            array(
+                'default' => $this->items_per_page,
+            )
+        );
+
+        add_filter( 'set_screen_option_' . $this->get_per_page_option_name(), array( $this, 'set_items_per_page_option' ), 10, 3 );
+        set_screen_options();
+    }
+
+    /**
+     * Handles setting the items_per_page option for this screen.
+     *
+     * @param mixed  $status Default false (to skip saving the current option).
+     * @param string $option Screen option name.
+     * @param int    $value  Screen option value.
+     * @return int
+     */
+    public function set_items_per_page_option( $status, $option, $value ) {
+        return $value;
+    }
+    /**
+     * Convert an interval of seconds into a two part human friendly string.
+     *
+     * The WordPress human_time_diff() function only calculates the time difference to one degree, meaning
+     * even if an action is 1 day and 11 hours away, it will display "1 day". This function goes one step
+     * further to display two degrees of accuracy.
+     *
+     * Inspired by the Crontrol::interval() function by Edward Dale: https://wordpress.org/plugins/wp-crontrol/
+     *
+     * @param int $interval A interval in seconds.
+     * @param int $periods_to_include Depth of time periods to include, e.g. for an interval of 70, and $periods_to_include of 2, both minutes and seconds would be included. With a value of 1, only minutes would be included.
+     * @return string A human friendly string representation of the interval.
+     */
+    private static function human_interval( $interval, $periods_to_include = 2 ) {
+
+        if ( $interval <= 0 ) {
+            return __( 'Now!', 'woocommerce' );
+        }
+
+        $output = '';
+
+        for ( $time_period_index = 0, $periods_included = 0, $seconds_remaining = $interval; $time_period_index < count( self::$time_periods ) && $seconds_remaining > 0 && $periods_included < $periods_to_include; $time_period_index++ ) {
+
+            $periods_in_interval = floor( $seconds_remaining / self::$time_periods[ $time_period_index ]['seconds'] );
+
+            if ( $periods_in_interval > 0 ) {
+                if ( ! empty( $output ) ) {
+                    $output .= ' ';
+                }
+                $output .= sprintf( _n( self::$time_periods[ $time_period_index ]['names'][0], self::$time_periods[ $time_period_index ]['names'][1], $periods_in_interval, 'woocommerce' ), $periods_in_interval );
+                $seconds_remaining -= $periods_in_interval * self::$time_periods[ $time_period_index ]['seconds'];
+                $periods_included++;
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Returns the recurrence of an action or 'Non-repeating'. The output is human readable.
+     *
+     * @param ActionScheduler_Action $action
+     *
+     * @return string
+     */
+    protected function get_recurrence( $action ) {
+        $schedule = $action->get_schedule();
+        if ( $schedule->is_recurring() ) {
+            $recurrence = $schedule->get_recurrence();
+
+            if ( is_numeric( $recurrence ) ) {
+                /* translators: %s: time interval */
+                return sprintf( __( 'Every %s', 'woocommerce' ), self::human_interval( $recurrence ) );
+            } else {
+                return $recurrence;
+            }
+        }
+
+        return __( 'Non-repeating', 'woocommerce' );
+    }
+
+    /**
+     * Serializes the argument of an action to render it in a human friendly format.
+     *
+     * @param array $row The array representation of the current row of the table
+     *
+     * @return string
+     */
+    public function column_args( array $row ) {
+        if ( empty( $row['args'] ) ) {
+            return apply_filters( 'action_scheduler_list_table_column_args', '', $row );
+        }
+
+        $row_html = '<ul>';
+        foreach ( $row['args'] as $key => $value ) {
+            $row_html .= sprintf( '<li><code>%s => %s</code></li>', esc_html( var_export( $key, true ) ), esc_html( var_export( $value, true ) ) );
+        }
+        $row_html .= '</ul>';
+
+        return apply_filters( 'action_scheduler_list_table_column_args', $row_html, $row );
+    }
+
+    /**
+     * Prints the logs entries inline. We do so to avoid loading Javascript and other hacks to show it in a modal.
+     *
+     * @param array $row Action array.
+     * @return string
+     */
+    public function column_log_entries( array $row ) {
+
+        $log_entries_html = '<ol>';
+
+        $timezone = new DateTimezone( 'UTC' );
+
+        foreach ( $row['log_entries'] as $log_entry ) {
+            $log_entries_html .= $this->get_log_entry_html( $log_entry, $timezone );
+        }
+
+        $log_entries_html .= '</ol>';
+
+        return $log_entries_html;
+    }
+
+    /**
+     * Prints the logs entries inline. We do so to avoid loading Javascript and other hacks to show it in a modal.
+     *
+     * @param ActionScheduler_LogEntry $log_entry
+     * @param DateTimezone $timezone
+     * @return string
+     */
+    protected function get_log_entry_html( ActionScheduler_LogEntry $log_entry, DateTimezone $timezone ) {
+        $date = $log_entry->get_date();
+        $date->setTimezone( $timezone );
+        return sprintf( '<li><strong>%s</strong><br/>%s</li>', esc_html( $date->format( 'Y-m-d H:i:s O' ) ), esc_html( $log_entry->get_message() ) );
+    }
+
+    /**
+     * Only display row actions for pending actions.
+     *
+     * @param array  $row         Row to render
+     * @param string $column_name Current row
+     *
+     * @return string
+     */
+    protected function maybe_render_actions( $row, $column_name ) {
+        if ( 'pending' === strtolower( $row[ 'status_name' ] ) ) {
+            return parent::maybe_render_actions( $row, $column_name );
+        }
+
+        return '';
+    }
+
+    /**
+     * Renders admin notifications
+     *
+     * Notifications:
+     *  1. When the maximum number of tasks are being executed simultaneously.
+     *  2. Notifications when a task is manually executed.
+     *  3. Tables are missing.
+     */
+    public function display_admin_notices() {
+        global $wpdb;
+
+        if ( ( is_a( $this->store, 'ActionScheduler_HybridStore' ) || is_a( $this->store, 'ActionScheduler_DBStore' ) ) && apply_filters( 'action_scheduler_enable_recreate_data_store', true ) ) {
+            $table_list = array(
+                'actionscheduler_actions',
+                'actionscheduler_logs',
+                'actionscheduler_groups',
+                'actionscheduler_claims',
+            );
+
+            $found_tables = $wpdb->get_col( "SHOW TABLES LIKE '{$wpdb->prefix}actionscheduler%'" ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+            foreach ( $table_list as $table_name ) {
+                if ( ! in_array( $wpdb->prefix . $table_name, $found_tables ) ) {
+                    $this->admin_notices[] = array(
+                        'class'   => 'error',
+                        'message' => __( 'It appears one or more database tables were missing. Attempting to re-create the missing table(s).' , 'woocommerce' ),
+                    );
+                    $this->recreate_tables();
+                    parent::display_admin_notices();
+
+                    return;
+                }
+            }
+        }
+
+        if ( $this->runner->has_maximum_concurrent_batches() ) {
+            $claim_count           = $this->store->get_claim_count();
+            $this->admin_notices[] = array(
+                'class'   => 'updated',
+                'message' => sprintf(
+                    /* translators: %s: amount of claims */
+                    _n(
+                        'Maximum simultaneous queues already in progress (%s queue). No additional queues will begin processing until the current queues are complete.',
+                        'Maximum simultaneous queues already in progress (%s queues). No additional queues will begin processing until the current queues are complete.',
+                        $claim_count,
+                        'woocommerce'
+                    ),
+                    $claim_count
+                ),
+            );
+        } elseif ( $this->store->has_pending_actions_due() ) {
+
+            $async_request_lock_expiration = ActionScheduler::lock()->get_expiration( 'async-request-runner' );
+
+            // No lock set or lock expired
+            if ( false === $async_request_lock_expiration || $async_request_lock_expiration < time() ) {
+                $in_progress_url       = add_query_arg( 'status', 'in-progress', remove_query_arg( 'status' ) );
+                /* translators: %s: process URL */
+                $async_request_message = sprintf( __( 'A new queue has begun processing. <a href="%s">View actions in-progress &raquo;</a>', 'woocommerce' ), esc_url( $in_progress_url ) );
+            } else {
+                /* translators: %d: seconds */
+                $async_request_message = sprintf( __( 'The next queue will begin processing in approximately %d seconds.', 'woocommerce' ), $async_request_lock_expiration - time() );
+            }
+
+            $this->admin_notices[] = array(
+                'class'   => 'notice notice-info',
+                'message' => $async_request_message,
+            );
+        }
+
+        $notification = get_transient( 'action_scheduler_admin_notice' );
+
+        if ( is_array( $notification ) ) {
+            delete_transient( 'action_scheduler_admin_notice' );
+
+            $action = $this->store->fetch_action( $notification['action_id'] );
+            $action_hook_html = '<strong><code>' . $action->get_hook() . '</code></strong>';
+            if ( 1 == $notification['success'] ) {
+                $class = 'updated';
+                switch ( $notification['row_action_type'] ) {
+                    case 'run' :
+                        /* translators: %s: action HTML */
+                        $action_message_html = sprintf( __( 'Successfully executed action: %s', 'woocommerce' ), $action_hook_html );
+                        break;
+                    case 'cancel' :
+                        /* translators: %s: action HTML */
+                        $action_message_html = sprintf( __( 'Successfully canceled action: %s', 'woocommerce' ), $action_hook_html );
+                        break;
+                    default :
+                        /* translators: %s: action HTML */
+                        $action_message_html = sprintf( __( 'Successfully processed change for action: %s', 'woocommerce' ), $action_hook_html );
+                        break;
+                }
+            } else {
+                $class = 'error';
+                /* translators: 1: action HTML 2: action ID 3: error message */
+                $action_message_html = sprintf( __( 'Could not process change for action: "%1$s" (ID: %2$d). Error: %3$s', 'woocommerce' ), $action_hook_html, esc_html( $notification['action_id'] ), esc_html( $notification['error_message'] ) );
+            }
+
+            $action_message_html = apply_filters( 'action_scheduler_admin_notice_html', $action_message_html, $action, $notification );
+
+            $this->admin_notices[] = array(
+                'class'   => $class,
+                'message' => $action_message_html,
+            );
+        }
+
+        parent::display_admin_notices();
+    }
+
+    /**
+     * Prints the scheduled date in a human friendly format.
+     *
+     * @param array $row The array representation of the current row of the table
+     *
+     * @return string
+     */
+    public function column_schedule( $row ) {
+        return $this->get_schedule_display_string( $row['schedule'] );
+    }
+
+    /**
+     * Get the scheduled date in a human friendly format.
+     *
+     * @param ActionScheduler_Schedule $schedule
+     * @return string
+     */
+    protected function get_schedule_display_string( ActionScheduler_Schedule $schedule ) {
+
+        $schedule_display_string = '';
+
+        if ( ! $schedule->get_date() ) {
+            return '0000-00-00 00:00:00';
+        }
+
+        $next_timestamp = $schedule->get_date()->getTimestamp();
+
+        $schedule_display_string .= $schedule->get_date()->format( 'Y-m-d H:i:s O' );
+        $schedule_display_string .= '<br/>';
+
+        if ( gmdate( 'U' ) > $next_timestamp ) {
+            /* translators: %s: date interval */
+            $schedule_display_string .= sprintf( __( ' (%s ago)', 'woocommerce' ), self::human_interval( gmdate( 'U' ) - $next_timestamp ) );
+        } else {
+            /* translators: %s: date interval */
+            $schedule_display_string .= sprintf( __( ' (%s)', 'woocommerce' ), self::human_interval( $next_timestamp - gmdate( 'U' ) ) );
+        }
+
+        return $schedule_display_string;
+    }
+
+    /**
+     * Bulk delete
+     *
+     * Deletes actions based on their ID. This is the handler for the bulk delete. It assumes the data
+     * properly validated by the callee and it will delete the actions without any extra validation.
+     *
+     * @param array $ids
+     * @param string $ids_sql Inherited and unused
+     */
+    protected function bulk_delete( array $ids, $ids_sql ) {
+        foreach ( $ids as $id ) {
+            $this->store->delete_action( $id );
+        }
+    }
+
+    /**
+     * Implements the logic behind running an action. ActionScheduler_Abstract_ListTable validates the request and their
+     * parameters are valid.
+     *
+     * @param int $action_id
+     */
+    protected function row_action_cancel( $action_id ) {
+        $this->process_row_action( $action_id, 'cancel' );
+    }
+
+    /**
+     * Implements the logic behind running an action. ActionScheduler_Abstract_ListTable validates the request and their
+     * parameters are valid.
+     *
+     * @param int $action_id
+     */
+    protected function row_action_run( $action_id ) {
+        $this->process_row_action( $action_id, 'run' );
+    }
+
+    /**
+     * Force the data store schema updates.
+     */
+    protected function recreate_tables() {
+        if ( is_a( $this->store, 'ActionScheduler_HybridStore' ) ) {
+            $store = $this->store;
+        } else {
+            $store = new ActionScheduler_HybridStore();
+        }
+        add_action( 'action_scheduler/created_table', array( $store, 'set_autoincrement' ), 10, 2 );
+
+        $store_schema  = new ActionScheduler_StoreSchema();
+        $logger_schema = new ActionScheduler_LoggerSchema();
+        $store_schema->register_tables( true );
+        $logger_schema->register_tables( true );
+
+        remove_action( 'action_scheduler/created_table', array( $store, 'set_autoincrement' ), 10 );
+    }
+    /**
+     * Implements the logic behind processing an action once an action link is clicked on the list table.
+     *
+     * @param int $action_id
+     * @param string $row_action_type The type of action to perform on the action.
+     */
+    protected function process_row_action( $action_id, $row_action_type ) {
+        try {
+            switch ( $row_action_type ) {
+                case 'run' :
+                    $this->runner->process_action( $action_id, 'Admin List Table' );
+                    break;
+                case 'cancel' :
+                    $this->store->cancel_action( $action_id );
+                    break;
+            }
+            $success = 1;
+            $error_message = '';
+        } catch ( Exception $e ) {
+            $success = 0;
+            $error_message = $e->getMessage();
+        }
+
+        set_transient( 'action_scheduler_admin_notice', compact( 'action_id', 'success', 'error_message', 'row_action_type' ), 30 );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function prepare_items() {
+        $this->prepare_column_headers();
+
+        $per_page = $this->get_items_per_page( $this->get_per_page_option_name(), $this->items_per_page );
+
+        $query = array(
+            'per_page' => $per_page,
+            'offset'   => $this->get_items_offset(),
+            'status'   => $this->get_request_status(),
+            'orderby'  => $this->get_request_orderby(),
+            'order'    => $this->get_request_order(),
+            'search'   => $this->get_request_search_query(),
+        );
+
+        $this->items = array();
+
+        $total_items = $this->store->query_actions( $query, 'count' );
+
+        $status_labels = $this->store->get_status_labels();
+
+        foreach ( $this->store->query_actions( $query ) as $action_id ) {
+            try {
+                $action = $this->store->fetch_action( $action_id );
+            } catch ( Exception $e ) {
+                continue;
+            }
+            if ( is_a( $action, 'ActionScheduler_NullAction' ) ) {
+                continue;
+            }
+            $this->items[ $action_id ] = array(
+                'ID'          => $action_id,
+                'hook'        => $action->get_hook(),
+                'status_name' => $this->store->get_status( $action_id ),
+                'status'      => $status_labels[ $this->store->get_status( $action_id ) ],
+                'args'        => $action->get_args(),
+                'group'       => $action->get_group(),
+                'log_entries' => $this->logger->get_logs( $action_id ),
+                'claim_id'    => $this->store->get_claim_id( $action_id ),
+                'recurrence'  => $this->get_recurrence( $action ),
+                'schedule'    => $action->get_schedule(),
+            );
+        }
+
+        $this->set_pagination_args( array(
+            'total_items' => $total_items,
+            'per_page'    => $per_page,
+            'total_pages' => ceil( $total_items / $per_page ),
+        ) );
+    }
+
+    /**
+     * Prints the available statuses so the user can click to filter.
+     */
+    protected function display_filter_by_status() {
+        $this->status_counts = $this->store->action_counts();
+        parent::display_filter_by_status();
+    }
+
+    /**
+     * Get the text to display in the search box on the list table.
+     */
+    protected function get_search_box_button_text() {
+        return __( 'Search hook, args and claim ID', 'woocommerce' );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function get_per_page_option_name() {
+        return str_replace( '-', '_', $this->screen->id ) . '_per_page';
+    }
 }

plugins/woocommerce/packages/action-scheduler/classes/data-stores/ActionScheduler_wpPostStore_PostStatusRegistrar.php

Indentation +44 added lines, -44 removed lines

@@ -5,54 +5,54 @@
  * @codeCoverageIgnore
  */
 class ActionScheduler_wpPostStore_PostStatusRegistrar {
-	public function register() {
-		register_post_status( ActionScheduler_Store::STATUS_RUNNING, array_merge( $this->post_status_args(), $this->post_status_running_labels() ) );
-		register_post_status( ActionScheduler_Store::STATUS_FAILED, array_merge( $this->post_status_args(), $this->post_status_failed_labels() ) );
-	}
+    public function register() {
+        register_post_status( ActionScheduler_Store::STATUS_RUNNING, array_merge( $this->post_status_args(), $this->post_status_running_labels() ) );
+        register_post_status( ActionScheduler_Store::STATUS_FAILED, array_merge( $this->post_status_args(), $this->post_status_failed_labels() ) );
+    }
 
-	/**
-	 * Build the args array for the post type definition
-	 *
-	 * @return array
-	 */
-	protected function post_status_args() {
-		$args = array(
-			'public'                    => false,
-			'exclude_from_search'       => false,
-			'show_in_admin_all_list'    => true,
-			'show_in_admin_status_list' => true,
-		);
+    /**
+     * Build the args array for the post type definition
+     *
+     * @return array
+     */
+    protected function post_status_args() {
+        $args = array(
+            'public'                    => false,
+            'exclude_from_search'       => false,
+            'show_in_admin_all_list'    => true,
+            'show_in_admin_status_list' => true,
+        );
 
-		return apply_filters( 'action_scheduler_post_status_args', $args );
-	}
+        return apply_filters( 'action_scheduler_post_status_args', $args );
+    }
 
-	/**
-	 * Build the args array for the post type definition
-	 *
-	 * @return array
-	 */
-	protected function post_status_failed_labels() {
-		$labels = array(
-			'label'       => _x( 'Failed', 'post', 'woocommerce' ),
-			/* translators: %s: count */
-			'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'woocommerce' ),
-		);
+    /**
+     * Build the args array for the post type definition
+     *
+     * @return array
+     */
+    protected function post_status_failed_labels() {
+        $labels = array(
+            'label'       => _x( 'Failed', 'post', 'woocommerce' ),
+            /* translators: %s: count */
+            'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'woocommerce' ),
+        );
 
-		return apply_filters( 'action_scheduler_post_status_failed_labels', $labels );
-	}
+        return apply_filters( 'action_scheduler_post_status_failed_labels', $labels );
+    }
 
-	/**
-	 * Build the args array for the post type definition
-	 *
-	 * @return array
-	 */
-	protected function post_status_running_labels() {
-		$labels = array(
-			'label'       => _x( 'In-Progress', 'post', 'woocommerce' ),
-			/* translators: %s: count */
-			'label_count' => _n_noop( 'In-Progress <span class="count">(%s)</span>', 'In-Progress <span class="count">(%s)</span>', 'woocommerce' ),
-		);
+    /**
+     * Build the args array for the post type definition
+     *
+     * @return array
+     */
+    protected function post_status_running_labels() {
+        $labels = array(
+            'label'       => _x( 'In-Progress', 'post', 'woocommerce' ),
+            /* translators: %s: count */
+            'label_count' => _n_noop( 'In-Progress <span class="count">(%s)</span>', 'In-Progress <span class="count">(%s)</span>', 'woocommerce' ),
+        );
 
-		return apply_filters( 'action_scheduler_post_status_running_labels', $labels );
-	}
+        return apply_filters( 'action_scheduler_post_status_running_labels', $labels );
+    }
 }

plugins/woocommerce/packages/action-scheduler/classes/data-stores/ActionScheduler_HybridStore.php

Indentation +406 added lines, -406 removed lines

@@ -13,414 +13,414 @@
  * @since 3.0.0
  */
 class ActionScheduler_HybridStore extends Store {
-	const DEMARKATION_OPTION = 'action_scheduler_hybrid_store_demarkation';
-
-	private $primary_store;
-	private $secondary_store;
-	private $migration_runner;
-
-	/**
-	 * @var int The dividing line between IDs of actions created
-	 *          by the primary and secondary stores.
-	 *
-	 * Methods that accept an action ID will compare the ID against
-	 * this to determine which store will contain that ID. In almost
-	 * all cases, the ID should come from the primary store, but if
-	 * client code is bypassing the API functions and fetching IDs
-	 * from elsewhere, then there is a chance that an unmigrated ID
-	 * might be requested.
-	 */
-	private $demarkation_id = 0;
-
-	/**
-	 * ActionScheduler_HybridStore constructor.
-	 *
-	 * @param Config $config Migration config object.
-	 */
-	public function __construct( Config $config = null ) {
-		$this->demarkation_id = (int) get_option( self::DEMARKATION_OPTION, 0 );
-		if ( empty( $config ) ) {
-			$config = Controller::instance()->get_migration_config_object();
-		}
-		$this->primary_store    = $config->get_destination_store();
-		$this->secondary_store  = $config->get_source_store();
-		$this->migration_runner = new Runner( $config );
-	}
-
-	/**
-	 * Initialize the table data store tables.
-	 *
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-		add_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10, 2 );
-		$this->primary_store->init();
-		$this->secondary_store->init();
-		remove_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10 );
-	}
-
-	/**
-	 * When the actions table is created, set its autoincrement
-	 * value to be one higher than the posts table to ensure that
-	 * there are no ID collisions.
-	 *
-	 * @param string $table_name
-	 * @param string $table_suffix
-	 *
-	 * @return void
-	 * @codeCoverageIgnore
-	 */
-	public function set_autoincrement( $table_name, $table_suffix ) {
-		if ( ActionScheduler_StoreSchema::ACTIONS_TABLE === $table_suffix ) {
-			if ( empty( $this->demarkation_id ) ) {
-				$this->demarkation_id = $this->set_demarkation_id();
-			}
-			/** @var \wpdb $wpdb */
-			global $wpdb;
-			/**
-			 * A default date of '0000-00-00 00:00:00' is invalid in MySQL 5.7 when configured with 
-			 * sql_mode including both STRICT_TRANS_TABLES and NO_ZERO_DATE.
-			 */
-			$default_date = new DateTime( 'tomorrow' );
-			$null_action  = new ActionScheduler_NullAction();
-			$date_gmt     = $this->get_scheduled_date_string( $null_action, $default_date );
-			$date_local   = $this->get_scheduled_date_string_local( $null_action, $default_date );
-
-			$row_count = $wpdb->insert(
-				$wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
-				[
-					'action_id'            => $this->demarkation_id,
-					'hook'                 => '',
-					'status'               => '',
-					'scheduled_date_gmt'   => $date_gmt,
-					'scheduled_date_local' => $date_local,
-					'last_attempt_gmt'     => $date_gmt,
-					'last_attempt_local'   => $date_local,
-				]
-			);
-			if ( $row_count > 0 ) {
-				$wpdb->delete(
-					$wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
-					[ 'action_id' => $this->demarkation_id ]
-				);
-			}
-		}
-	}
-
-	/**
-	 * Store the demarkation id in WP options.
-	 *
-	 * @param int $id The ID to set as the demarkation point between the two stores
-	 *                Leave null to use the next ID from the WP posts table.
-	 *
-	 * @return int The new ID.
-	 *
-	 * @codeCoverageIgnore
-	 */
-	private function set_demarkation_id( $id = null ) {
-		if ( empty( $id ) ) {
-			/** @var \wpdb $wpdb */
-			global $wpdb;
-			$id = (int) $wpdb->get_var( "SELECT MAX(ID) FROM $wpdb->posts" );
-			$id ++;
-		}
-		update_option( self::DEMARKATION_OPTION, $id );
-
-		return $id;
-	}
-
-	/**
-	 * Find the first matching action from the secondary store.
-	 * If it exists, migrate it to the primary store immediately.
-	 * After it migrates, the secondary store will logically contain
-	 * the next matching action, so return the result thence.
-	 *
-	 * @param string $hook
-	 * @param array  $params
-	 *
-	 * @return string
-	 */
-	public function find_action( $hook, $params = [] ) {
-		$found_unmigrated_action = $this->secondary_store->find_action( $hook, $params );
-		if ( ! empty( $found_unmigrated_action ) ) {
-			$this->migrate( [ $found_unmigrated_action ] );
-		}
-
-		return $this->primary_store->find_action( $hook, $params );
-	}
-
-	/**
-	 * Find actions matching the query in the secondary source first.
-	 * If any are found, migrate them immediately. Then the secondary
-	 * store will contain the canonical results.
-	 *
-	 * @param array $query
-	 * @param string $query_type Whether to select or count the results. Default, select.
-	 *
-	 * @return int[]
-	 */
-	public function query_actions( $query = [], $query_type = 'select' ) {
-		$found_unmigrated_actions = $this->secondary_store->query_actions( $query, 'select' );
-		if ( ! empty( $found_unmigrated_actions ) ) {
-			$this->migrate( $found_unmigrated_actions );
-		}
-
-		return $this->primary_store->query_actions( $query, $query_type );
-	}
-
-	/**
-	 * Get a count of all actions in the store, grouped by status
-	 *
-	 * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status.
-	 */
-	public function action_counts() {
-		$unmigrated_actions_count = $this->secondary_store->action_counts();
-		$migrated_actions_count   = $this->primary_store->action_counts();
-		$actions_count_by_status  = array();
-
-		foreach ( $this->get_status_labels() as $status_key => $status_label ) {
-
-			$count = 0;
-
-			if ( isset( $unmigrated_actions_count[ $status_key ] ) ) {
-				$count += $unmigrated_actions_count[ $status_key ];
-			}
-
-			if ( isset( $migrated_actions_count[ $status_key ] ) ) {
-				$count += $migrated_actions_count[ $status_key ];
-			}
-
-			$actions_count_by_status[ $status_key ] = $count;
-		}
-
-		$actions_count_by_status = array_filter( $actions_count_by_status );
-
-		return $actions_count_by_status;
-	}
-
-	/**
-	 * If any actions would have been claimed by the secondary store,
-	 * migrate them immediately, then ask the primary store for the
-	 * canonical claim.
-	 *
-	 * @param int           $max_actions
-	 * @param DateTime|null $before_date
-	 *
-	 * @return ActionScheduler_ActionClaim
-	 */
-	public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' ) {
-		$claim = $this->secondary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
-
-		$claimed_actions = $claim->get_actions();
-		if ( ! empty( $claimed_actions ) ) {
-			$this->migrate( $claimed_actions );
-		}
-
-		$this->secondary_store->release_claim( $claim );
-
-		return $this->primary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
-	}
-
-	/**
-	 * Migrate a list of actions to the table data store.
-	 *
-	 * @param array $action_ids List of action IDs.
-	 */
-	private function migrate( $action_ids ) {
-		$this->migration_runner->migrate_actions( $action_ids );
-	}
-
-	/**
-	 * Save an action to the primary store.
-	 *
-	 * @param ActionScheduler_Action $action Action object to be saved.
-	 * @param DateTime               $date Optional. Schedule date. Default null.
-	 *
-	 * @return int The action ID
-	 */
-	public function save_action( ActionScheduler_Action $action, DateTime $date = null ) {
-		return $this->primary_store->save_action( $action, $date );
-	}
-
-	/**
-	 * Retrieve an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function fetch_action( $action_id ) {
-		$store = $this->get_store_from_action_id( $action_id, true );
-		if ( $store ) {
-			return $store->fetch_action( $action_id );
-		} else {
-			return new ActionScheduler_NullAction();
-		}
-	}
-
-	/**
-	 * Cancel an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function cancel_action( $action_id ) {
-		$store = $this->get_store_from_action_id( $action_id );
-		if ( $store ) {
-			$store->cancel_action( $action_id );
-		}
-	}
-
-	/**
-	 * Delete an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function delete_action( $action_id ) {
-		$store = $this->get_store_from_action_id( $action_id );
-		if ( $store ) {
-			$store->delete_action( $action_id );
-		}
-	}
-
-	/**
-	 * Get the schedule date an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function get_date( $action_id ) {
-		$store = $this->get_store_from_action_id( $action_id );
-		if ( $store ) {
-			return $store->get_date( $action_id );
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Mark an existing action as failed whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function mark_failure( $action_id ) {
-		$store = $this->get_store_from_action_id( $action_id );
-		if ( $store ) {
-			$store->mark_failure( $action_id );
-		}
-	}
-
-	/**
-	 * Log the execution of an existing action whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function log_execution( $action_id ) {
-		$store = $this->get_store_from_action_id( $action_id );
-		if ( $store ) {
-			$store->log_execution( $action_id );
-		}
-	}
-
-	/**
-	 * Mark an existing action complete whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function mark_complete( $action_id ) {
-		$store = $this->get_store_from_action_id( $action_id );
-		if ( $store ) {
-			$store->mark_complete( $action_id );
-		}
-	}
-
-	/**
-	 * Get an existing action status whether migrated or not.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function get_status( $action_id ) {
-		$store = $this->get_store_from_action_id( $action_id );
-		if ( $store ) {
-			return $store->get_status( $action_id );
-		}
-		return null;
-	}
-
-	/**
-	 * Return which store an action is stored in.
-	 *
-	 * @param int  $action_id ID of the action.
-	 * @param bool $primary_first Optional flag indicating search the primary store first.
-	 * @return ActionScheduler_Store
-	 */
-	protected function get_store_from_action_id( $action_id, $primary_first = false ) {
-		if ( $primary_first ) {
-			$stores = [
-				$this->primary_store,
-				$this->secondary_store,
-			];
-		} elseif ( $action_id < $this->demarkation_id ) {
-			$stores = [
-				$this->secondary_store,
-				$this->primary_store,
-			];
-		} else {
-			$stores = [
-				$this->primary_store,
-			];
-		}
-
-		foreach ( $stores as $store ) {
-			$action = $store->fetch_action( $action_id );
-			if ( ! is_a( $action, 'ActionScheduler_NullAction' ) ) {
-				return $store;
-			}
-		}
-		return null;
-	}
-
-	/* * * * * * * * * * * * * * * * * * * * * * * * * * *
+    const DEMARKATION_OPTION = 'action_scheduler_hybrid_store_demarkation';
+
+    private $primary_store;
+    private $secondary_store;
+    private $migration_runner;
+
+    /**
+     * @var int The dividing line between IDs of actions created
+     *          by the primary and secondary stores.
+     *
+     * Methods that accept an action ID will compare the ID against
+     * this to determine which store will contain that ID. In almost
+     * all cases, the ID should come from the primary store, but if
+     * client code is bypassing the API functions and fetching IDs
+     * from elsewhere, then there is a chance that an unmigrated ID
+     * might be requested.
+     */
+    private $demarkation_id = 0;
+
+    /**
+     * ActionScheduler_HybridStore constructor.
+     *
+     * @param Config $config Migration config object.
+     */
+    public function __construct( Config $config = null ) {
+        $this->demarkation_id = (int) get_option( self::DEMARKATION_OPTION, 0 );
+        if ( empty( $config ) ) {
+            $config = Controller::instance()->get_migration_config_object();
+        }
+        $this->primary_store    = $config->get_destination_store();
+        $this->secondary_store  = $config->get_source_store();
+        $this->migration_runner = new Runner( $config );
+    }
+
+    /**
+     * Initialize the table data store tables.
+     *
+     * @codeCoverageIgnore
+     */
+    public function init() {
+        add_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10, 2 );
+        $this->primary_store->init();
+        $this->secondary_store->init();
+        remove_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10 );
+    }
+
+    /**
+     * When the actions table is created, set its autoincrement
+     * value to be one higher than the posts table to ensure that
+     * there are no ID collisions.
+     *
+     * @param string $table_name
+     * @param string $table_suffix
+     *
+     * @return void
+     * @codeCoverageIgnore
+     */
+    public function set_autoincrement( $table_name, $table_suffix ) {
+        if ( ActionScheduler_StoreSchema::ACTIONS_TABLE === $table_suffix ) {
+            if ( empty( $this->demarkation_id ) ) {
+                $this->demarkation_id = $this->set_demarkation_id();
+            }
+            /** @var \wpdb $wpdb */
+            global $wpdb;
+            /**
+             * A default date of '0000-00-00 00:00:00' is invalid in MySQL 5.7 when configured with 
+             * sql_mode including both STRICT_TRANS_TABLES and NO_ZERO_DATE.
+             */
+            $default_date = new DateTime( 'tomorrow' );
+            $null_action  = new ActionScheduler_NullAction();
+            $date_gmt     = $this->get_scheduled_date_string( $null_action, $default_date );
+            $date_local   = $this->get_scheduled_date_string_local( $null_action, $default_date );
+
+            $row_count = $wpdb->insert(
+                $wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
+                [
+                    'action_id'            => $this->demarkation_id,
+                    'hook'                 => '',
+                    'status'               => '',
+                    'scheduled_date_gmt'   => $date_gmt,
+                    'scheduled_date_local' => $date_local,
+                    'last_attempt_gmt'     => $date_gmt,
+                    'last_attempt_local'   => $date_local,
+                ]
+            );
+            if ( $row_count > 0 ) {
+                $wpdb->delete(
+                    $wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
+                    [ 'action_id' => $this->demarkation_id ]
+                );
+            }
+        }
+    }
+
+    /**
+     * Store the demarkation id in WP options.
+     *
+     * @param int $id The ID to set as the demarkation point between the two stores
+     *                Leave null to use the next ID from the WP posts table.
+     *
+     * @return int The new ID.
+     *
+     * @codeCoverageIgnore
+     */
+    private function set_demarkation_id( $id = null ) {
+        if ( empty( $id ) ) {
+            /** @var \wpdb $wpdb */
+            global $wpdb;
+            $id = (int) $wpdb->get_var( "SELECT MAX(ID) FROM $wpdb->posts" );
+            $id ++;
+        }
+        update_option( self::DEMARKATION_OPTION, $id );
+
+        return $id;
+    }
+
+    /**
+     * Find the first matching action from the secondary store.
+     * If it exists, migrate it to the primary store immediately.
+     * After it migrates, the secondary store will logically contain
+     * the next matching action, so return the result thence.
+     *
+     * @param string $hook
+     * @param array  $params
+     *
+     * @return string
+     */
+    public function find_action( $hook, $params = [] ) {
+        $found_unmigrated_action = $this->secondary_store->find_action( $hook, $params );
+        if ( ! empty( $found_unmigrated_action ) ) {
+            $this->migrate( [ $found_unmigrated_action ] );
+        }
+
+        return $this->primary_store->find_action( $hook, $params );
+    }
+
+    /**
+     * Find actions matching the query in the secondary source first.
+     * If any are found, migrate them immediately. Then the secondary
+     * store will contain the canonical results.
+     *
+     * @param array $query
+     * @param string $query_type Whether to select or count the results. Default, select.
+     *
+     * @return int[]
+     */
+    public function query_actions( $query = [], $query_type = 'select' ) {
+        $found_unmigrated_actions = $this->secondary_store->query_actions( $query, 'select' );
+        if ( ! empty( $found_unmigrated_actions ) ) {
+            $this->migrate( $found_unmigrated_actions );
+        }
+
+        return $this->primary_store->query_actions( $query, $query_type );
+    }
+
+    /**
+     * Get a count of all actions in the store, grouped by status
+     *
+     * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status.
+     */
+    public function action_counts() {
+        $unmigrated_actions_count = $this->secondary_store->action_counts();
+        $migrated_actions_count   = $this->primary_store->action_counts();
+        $actions_count_by_status  = array();
+
+        foreach ( $this->get_status_labels() as $status_key => $status_label ) {
+
+            $count = 0;
+
+            if ( isset( $unmigrated_actions_count[ $status_key ] ) ) {
+                $count += $unmigrated_actions_count[ $status_key ];
+            }
+
+            if ( isset( $migrated_actions_count[ $status_key ] ) ) {
+                $count += $migrated_actions_count[ $status_key ];
+            }
+
+            $actions_count_by_status[ $status_key ] = $count;
+        }
+
+        $actions_count_by_status = array_filter( $actions_count_by_status );
+
+        return $actions_count_by_status;
+    }
+
+    /**
+     * If any actions would have been claimed by the secondary store,
+     * migrate them immediately, then ask the primary store for the
+     * canonical claim.
+     *
+     * @param int           $max_actions
+     * @param DateTime|null $before_date
+     *
+     * @return ActionScheduler_ActionClaim
+     */
+    public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' ) {
+        $claim = $this->secondary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
+
+        $claimed_actions = $claim->get_actions();
+        if ( ! empty( $claimed_actions ) ) {
+            $this->migrate( $claimed_actions );
+        }
+
+        $this->secondary_store->release_claim( $claim );
+
+        return $this->primary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
+    }
+
+    /**
+     * Migrate a list of actions to the table data store.
+     *
+     * @param array $action_ids List of action IDs.
+     */
+    private function migrate( $action_ids ) {
+        $this->migration_runner->migrate_actions( $action_ids );
+    }
+
+    /**
+     * Save an action to the primary store.
+     *
+     * @param ActionScheduler_Action $action Action object to be saved.
+     * @param DateTime               $date Optional. Schedule date. Default null.
+     *
+     * @return int The action ID
+     */
+    public function save_action( ActionScheduler_Action $action, DateTime $date = null ) {
+        return $this->primary_store->save_action( $action, $date );
+    }
+
+    /**
+     * Retrieve an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function fetch_action( $action_id ) {
+        $store = $this->get_store_from_action_id( $action_id, true );
+        if ( $store ) {
+            return $store->fetch_action( $action_id );
+        } else {
+            return new ActionScheduler_NullAction();
+        }
+    }
+
+    /**
+     * Cancel an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function cancel_action( $action_id ) {
+        $store = $this->get_store_from_action_id( $action_id );
+        if ( $store ) {
+            $store->cancel_action( $action_id );
+        }
+    }
+
+    /**
+     * Delete an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function delete_action( $action_id ) {
+        $store = $this->get_store_from_action_id( $action_id );
+        if ( $store ) {
+            $store->delete_action( $action_id );
+        }
+    }
+
+    /**
+     * Get the schedule date an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function get_date( $action_id ) {
+        $store = $this->get_store_from_action_id( $action_id );
+        if ( $store ) {
+            return $store->get_date( $action_id );
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Mark an existing action as failed whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function mark_failure( $action_id ) {
+        $store = $this->get_store_from_action_id( $action_id );
+        if ( $store ) {
+            $store->mark_failure( $action_id );
+        }
+    }
+
+    /**
+     * Log the execution of an existing action whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function log_execution( $action_id ) {
+        $store = $this->get_store_from_action_id( $action_id );
+        if ( $store ) {
+            $store->log_execution( $action_id );
+        }
+    }
+
+    /**
+     * Mark an existing action complete whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function mark_complete( $action_id ) {
+        $store = $this->get_store_from_action_id( $action_id );
+        if ( $store ) {
+            $store->mark_complete( $action_id );
+        }
+    }
+
+    /**
+     * Get an existing action status whether migrated or not.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function get_status( $action_id ) {
+        $store = $this->get_store_from_action_id( $action_id );
+        if ( $store ) {
+            return $store->get_status( $action_id );
+        }
+        return null;
+    }
+
+    /**
+     * Return which store an action is stored in.
+     *
+     * @param int  $action_id ID of the action.
+     * @param bool $primary_first Optional flag indicating search the primary store first.
+     * @return ActionScheduler_Store
+     */
+    protected function get_store_from_action_id( $action_id, $primary_first = false ) {
+        if ( $primary_first ) {
+            $stores = [
+                $this->primary_store,
+                $this->secondary_store,
+            ];
+        } elseif ( $action_id < $this->demarkation_id ) {
+            $stores = [
+                $this->secondary_store,
+                $this->primary_store,
+            ];
+        } else {
+            $stores = [
+                $this->primary_store,
+            ];
+        }
+
+        foreach ( $stores as $store ) {
+            $action = $store->fetch_action( $action_id );
+            if ( ! is_a( $action, 'ActionScheduler_NullAction' ) ) {
+                return $store;
+            }
+        }
+        return null;
+    }
+
+    /* * * * * * * * * * * * * * * * * * * * * * * * * * *
 	 * All claim-related functions should operate solely
 	 * on the primary store.
 	 * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
-	/**
-	 * Get the claim count from the table data store.
-	 */
-	public function get_claim_count() {
-		return $this->primary_store->get_claim_count();
-	}
-
-	/**
-	 * Retrieve the claim ID for an action from the table data store.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function get_claim_id( $action_id ) {
-		return $this->primary_store->get_claim_id( $action_id );
-	}
-
-	/**
-	 * Release a claim in the table data store.
-	 *
-	 * @param ActionScheduler_ActionClaim $claim Claim object.
-	 */
-	public function release_claim( ActionScheduler_ActionClaim $claim ) {
-		$this->primary_store->release_claim( $claim );
-	}
-
-	/**
-	 * Release claims on an action in the table data store.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function unclaim_action( $action_id ) {
-		$this->primary_store->unclaim_action( $action_id );
-	}
-
-	/**
-	 * Retrieve a list of action IDs by claim.
-	 *
-	 * @param int $claim_id Claim ID.
-	 */
-	public function find_actions_by_claim_id( $claim_id ) {
-		return $this->primary_store->find_actions_by_claim_id( $claim_id );
-	}
+    /**
+     * Get the claim count from the table data store.
+     */
+    public function get_claim_count() {
+        return $this->primary_store->get_claim_count();
+    }
+
+    /**
+     * Retrieve the claim ID for an action from the table data store.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function get_claim_id( $action_id ) {
+        return $this->primary_store->get_claim_id( $action_id );
+    }
+
+    /**
+     * Release a claim in the table data store.
+     *
+     * @param ActionScheduler_ActionClaim $claim Claim object.
+     */
+    public function release_claim( ActionScheduler_ActionClaim $claim ) {
+        $this->primary_store->release_claim( $claim );
+    }
+
+    /**
+     * Release claims on an action in the table data store.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function unclaim_action( $action_id ) {
+        $this->primary_store->unclaim_action( $action_id );
+    }
+
+    /**
+     * Retrieve a list of action IDs by claim.
+     *
+     * @param int $claim_id Claim ID.
+     */
+    public function find_actions_by_claim_id( $claim_id ) {
+        return $this->primary_store->find_actions_by_claim_id( $claim_id );
+    }
 }

plugins/woocommerce/packages/action-scheduler/classes/data-stores/ActionScheduler_wpCommentLogger.php

Indentation +232 added lines, -232 removed lines

@@ -4,237 +4,237 @@
  * Class ActionScheduler_wpCommentLogger
  */
 class ActionScheduler_wpCommentLogger extends ActionScheduler_Logger {
-	const AGENT = 'ActionScheduler';
-	const TYPE = 'action_log';
-
-	/**
-	 * @param string $action_id
-	 * @param string $message
-	 * @param DateTime $date
-	 *
-	 * @return string The log entry ID
-	 */
-	public function log( $action_id, $message, DateTime $date = NULL ) {
-		if ( empty($date) ) {
-			$date = as_get_datetime_object();
-		} else {
-			$date = as_get_datetime_object( clone $date );
-		}
-		$comment_id = $this->create_wp_comment( $action_id, $message, $date );
-		return $comment_id;
-	}
-
-	protected function create_wp_comment( $action_id, $message, DateTime $date ) {
-
-		$comment_date_gmt = $date->format('Y-m-d H:i:s');
-		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
-		$comment_data = array(
-			'comment_post_ID' => $action_id,
-			'comment_date' => $date->format('Y-m-d H:i:s'),
-			'comment_date_gmt' => $comment_date_gmt,
-			'comment_author' => self::AGENT,
-			'comment_content' => $message,
-			'comment_agent' => self::AGENT,
-			'comment_type' => self::TYPE,
-		);
-		return wp_insert_comment($comment_data);
-	}
-
-	/**
-	 * @param string $entry_id
-	 *
-	 * @return ActionScheduler_LogEntry
-	 */
-	public function get_entry( $entry_id ) {
-		$comment = $this->get_comment( $entry_id );
-		if ( empty($comment) || $comment->comment_type != self::TYPE ) {
-			return new ActionScheduler_NullLogEntry();
-		}
-
-		$date = as_get_datetime_object( $comment->comment_date_gmt );
-		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
-		return new ActionScheduler_LogEntry( $comment->comment_post_ID, $comment->comment_content, $date );
-	}
-
-	/**
-	 * @param string $action_id
-	 *
-	 * @return ActionScheduler_LogEntry[]
-	 */
-	public function get_logs( $action_id ) {
-		$status = 'all';
-		if ( get_post_status($action_id) == 'trash' ) {
-			$status = 'post-trashed';
-		}
-		$comments = get_comments(array(
-			'post_id' => $action_id,
-			'orderby' => 'comment_date_gmt',
-			'order' => 'ASC',
-			'type' => self::TYPE,
-			'status' => $status,
-		));
-		$logs = array();
-		foreach ( $comments as $c ) {
-			$entry = $this->get_entry( $c );
-			if ( !empty($entry) ) {
-				$logs[] = $entry;
-			}
-		}
-		return $logs;
-	}
-
-	protected function get_comment( $comment_id ) {
-		return get_comment( $comment_id );
-	}
-
-
-
-	/**
-	 * @param WP_Comment_Query $query
-	 */
-	public function filter_comment_queries( $query ) {
-		foreach ( array('ID', 'parent', 'post_author', 'post_name', 'post_parent', 'type', 'post_type', 'post_id', 'post_ID') as $key ) {
-			if ( !empty($query->query_vars[$key]) ) {
-				return; // don't slow down queries that wouldn't include action_log comments anyway
-			}
-		}
-		$query->query_vars['action_log_filter'] = TRUE;
-		add_filter( 'comments_clauses', array( $this, 'filter_comment_query_clauses' ), 10, 2 );
-	}
-
-	/**
-	 * @param array $clauses
-	 * @param WP_Comment_Query $query
-	 *
-	 * @return array
-	 */
-	public function filter_comment_query_clauses( $clauses, $query ) {
-		if ( !empty($query->query_vars['action_log_filter']) ) {
-			$clauses['where'] .= $this->get_where_clause();
-		}
-		return $clauses;
-	}
-
-	/**
-	 * Make sure Action Scheduler logs are excluded from comment feeds, which use WP_Query, not
-	 * the WP_Comment_Query class handled by @see self::filter_comment_queries().
-	 *
-	 * @param string $where
-	 * @param WP_Query $query
-	 *
-	 * @return string
-	 */
-	public function filter_comment_feed( $where, $query ) {
-		if ( is_comment_feed() ) {
-			$where .= $this->get_where_clause();
-		}
-		return $where;
-	}
-
-	/**
-	 * Return a SQL clause to exclude Action Scheduler comments.
-	 *
-	 * @return string
-	 */
-	protected function get_where_clause() {
-		global $wpdb;
-		return sprintf( " AND {$wpdb->comments}.comment_type != '%s'", self::TYPE );
-	}
-
-	/**
-	 * Remove action log entries from wp_count_comments()
-	 *
-	 * @param array $stats
-	 * @param int $post_id
-	 *
-	 * @return object
-	 */
-	public function filter_comment_count( $stats, $post_id ) {
-		global $wpdb;
-
-		if ( 0 === $post_id ) {
-			$stats = $this->get_comment_count();
-		}
-
-		return $stats;
-	}
-
-	/**
-	 * Retrieve the comment counts from our cache, or the database if the cached version isn't set.
-	 *
-	 * @return object
-	 */
-	protected function get_comment_count() {
-		global $wpdb;
-
-		$stats = get_transient( 'as_comment_count' );
-
-		if ( ! $stats ) {
-			$stats = array();
-
-			$count = $wpdb->get_results( "SELECT comment_approved, COUNT( * ) AS num_comments FROM {$wpdb->comments} WHERE comment_type NOT IN('order_note','action_log') GROUP BY comment_approved", ARRAY_A );
-
-			$total = 0;
-			$stats = array();
-			$approved = array( '0' => 'moderated', '1' => 'approved', 'spam' => 'spam', 'trash' => 'trash', 'post-trashed' => 'post-trashed' );
-
-			foreach ( (array) $count as $row ) {
-				// Don't count post-trashed toward totals
-				if ( 'post-trashed' != $row['comment_approved'] && 'trash' != $row['comment_approved'] ) {
-					$total += $row['num_comments'];
-				}
-				if ( isset( $approved[ $row['comment_approved'] ] ) ) {
-					$stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
-				}
-			}
-
-			$stats['total_comments'] = $total;
-			$stats['all']            = $total;
-
-			foreach ( $approved as $key ) {
-				if ( empty( $stats[ $key ] ) ) {
-					$stats[ $key ] = 0;
-				}
-			}
-
-			$stats = (object) $stats;
-			set_transient( 'as_comment_count', $stats );
-		}
-
-		return $stats;
-	}
-
-	/**
-	 * Delete comment count cache whenever there is new comment or the status of a comment changes. Cache
-	 * will be regenerated next time ActionScheduler_wpCommentLogger::filter_comment_count() is called.
-	 */
-	public function delete_comment_count_cache() {
-		delete_transient( 'as_comment_count' );
-	}
-
-	/**
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-		add_action( 'action_scheduler_before_process_queue', array( $this, 'disable_comment_counting' ), 10, 0 );
-		add_action( 'action_scheduler_after_process_queue', array( $this, 'enable_comment_counting' ), 10, 0 );
-
-		parent::init();
-
-		add_action( 'pre_get_comments', array( $this, 'filter_comment_queries' ), 10, 1 );
-		add_action( 'wp_count_comments', array( $this, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
-		add_action( 'comment_feed_where', array( $this, 'filter_comment_feed' ), 10, 2 );
-
-		// Delete comments count cache whenever there is a new comment or a comment status changes
-		add_action( 'wp_insert_comment', array( $this, 'delete_comment_count_cache' ) );
-		add_action( 'wp_set_comment_status', array( $this, 'delete_comment_count_cache' ) );
-	}
-
-	public function disable_comment_counting() {
-		wp_defer_comment_counting(true);
-	}
-	public function enable_comment_counting() {
-		wp_defer_comment_counting(false);
-	}
+    const AGENT = 'ActionScheduler';
+    const TYPE = 'action_log';
+
+    /**
+     * @param string $action_id
+     * @param string $message
+     * @param DateTime $date
+     *
+     * @return string The log entry ID
+     */
+    public function log( $action_id, $message, DateTime $date = NULL ) {
+        if ( empty($date) ) {
+            $date = as_get_datetime_object();
+        } else {
+            $date = as_get_datetime_object( clone $date );
+        }
+        $comment_id = $this->create_wp_comment( $action_id, $message, $date );
+        return $comment_id;
+    }
+
+    protected function create_wp_comment( $action_id, $message, DateTime $date ) {
+
+        $comment_date_gmt = $date->format('Y-m-d H:i:s');
+        ActionScheduler_TimezoneHelper::set_local_timezone( $date );
+        $comment_data = array(
+            'comment_post_ID' => $action_id,
+            'comment_date' => $date->format('Y-m-d H:i:s'),
+            'comment_date_gmt' => $comment_date_gmt,
+            'comment_author' => self::AGENT,
+            'comment_content' => $message,
+            'comment_agent' => self::AGENT,
+            'comment_type' => self::TYPE,
+        );
+        return wp_insert_comment($comment_data);
+    }
+
+    /**
+     * @param string $entry_id
+     *
+     * @return ActionScheduler_LogEntry
+     */
+    public function get_entry( $entry_id ) {
+        $comment = $this->get_comment( $entry_id );
+        if ( empty($comment) || $comment->comment_type != self::TYPE ) {
+            return new ActionScheduler_NullLogEntry();
+        }
+
+        $date = as_get_datetime_object( $comment->comment_date_gmt );
+        ActionScheduler_TimezoneHelper::set_local_timezone( $date );
+        return new ActionScheduler_LogEntry( $comment->comment_post_ID, $comment->comment_content, $date );
+    }
+
+    /**
+     * @param string $action_id
+     *
+     * @return ActionScheduler_LogEntry[]
+     */
+    public function get_logs( $action_id ) {
+        $status = 'all';
+        if ( get_post_status($action_id) == 'trash' ) {
+            $status = 'post-trashed';
+        }
+        $comments = get_comments(array(
+            'post_id' => $action_id,
+            'orderby' => 'comment_date_gmt',
+            'order' => 'ASC',
+            'type' => self::TYPE,
+            'status' => $status,
+        ));
+        $logs = array();
+        foreach ( $comments as $c ) {
+            $entry = $this->get_entry( $c );
+            if ( !empty($entry) ) {
+                $logs[] = $entry;
+            }
+        }
+        return $logs;
+    }
+
+    protected function get_comment( $comment_id ) {
+        return get_comment( $comment_id );
+    }
+
+
+
+    /**
+     * @param WP_Comment_Query $query
+     */
+    public function filter_comment_queries( $query ) {
+        foreach ( array('ID', 'parent', 'post_author', 'post_name', 'post_parent', 'type', 'post_type', 'post_id', 'post_ID') as $key ) {
+            if ( !empty($query->query_vars[$key]) ) {
+                return; // don't slow down queries that wouldn't include action_log comments anyway
+            }
+        }
+        $query->query_vars['action_log_filter'] = TRUE;
+        add_filter( 'comments_clauses', array( $this, 'filter_comment_query_clauses' ), 10, 2 );
+    }
+
+    /**
+     * @param array $clauses
+     * @param WP_Comment_Query $query
+     *
+     * @return array
+     */
+    public function filter_comment_query_clauses( $clauses, $query ) {
+        if ( !empty($query->query_vars['action_log_filter']) ) {
+            $clauses['where'] .= $this->get_where_clause();
+        }
+        return $clauses;
+    }
+
+    /**
+     * Make sure Action Scheduler logs are excluded from comment feeds, which use WP_Query, not
+     * the WP_Comment_Query class handled by @see self::filter_comment_queries().
+     *
+     * @param string $where
+     * @param WP_Query $query
+     *
+     * @return string
+     */
+    public function filter_comment_feed( $where, $query ) {
+        if ( is_comment_feed() ) {
+            $where .= $this->get_where_clause();
+        }
+        return $where;
+    }
+
+    /**
+     * Return a SQL clause to exclude Action Scheduler comments.
+     *
+     * @return string
+     */
+    protected function get_where_clause() {
+        global $wpdb;
+        return sprintf( " AND {$wpdb->comments}.comment_type != '%s'", self::TYPE );
+    }
+
+    /**
+     * Remove action log entries from wp_count_comments()
+     *
+     * @param array $stats
+     * @param int $post_id
+     *
+     * @return object
+     */
+    public function filter_comment_count( $stats, $post_id ) {
+        global $wpdb;
+
+        if ( 0 === $post_id ) {
+            $stats = $this->get_comment_count();
+        }
+
+        return $stats;
+    }
+
+    /**
+     * Retrieve the comment counts from our cache, or the database if the cached version isn't set.
+     *
+     * @return object
+     */
+    protected function get_comment_count() {
+        global $wpdb;
+
+        $stats = get_transient( 'as_comment_count' );
+
+        if ( ! $stats ) {
+            $stats = array();
+
+            $count = $wpdb->get_results( "SELECT comment_approved, COUNT( * ) AS num_comments FROM {$wpdb->comments} WHERE comment_type NOT IN('order_note','action_log') GROUP BY comment_approved", ARRAY_A );
+
+            $total = 0;
+            $stats = array();
+            $approved = array( '0' => 'moderated', '1' => 'approved', 'spam' => 'spam', 'trash' => 'trash', 'post-trashed' => 'post-trashed' );
+
+            foreach ( (array) $count as $row ) {
+                // Don't count post-trashed toward totals
+                if ( 'post-trashed' != $row['comment_approved'] && 'trash' != $row['comment_approved'] ) {
+                    $total += $row['num_comments'];
+                }
+                if ( isset( $approved[ $row['comment_approved'] ] ) ) {
+                    $stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
+                }
+            }
+
+            $stats['total_comments'] = $total;
+            $stats['all']            = $total;
+
+            foreach ( $approved as $key ) {
+                if ( empty( $stats[ $key ] ) ) {
+                    $stats[ $key ] = 0;
+                }
+            }
+
+            $stats = (object) $stats;
+            set_transient( 'as_comment_count', $stats );
+        }
+
+        return $stats;
+    }
+
+    /**
+     * Delete comment count cache whenever there is new comment or the status of a comment changes. Cache
+     * will be regenerated next time ActionScheduler_wpCommentLogger::filter_comment_count() is called.
+     */
+    public function delete_comment_count_cache() {
+        delete_transient( 'as_comment_count' );
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function init() {
+        add_action( 'action_scheduler_before_process_queue', array( $this, 'disable_comment_counting' ), 10, 0 );
+        add_action( 'action_scheduler_after_process_queue', array( $this, 'enable_comment_counting' ), 10, 0 );
+
+        parent::init();
+
+        add_action( 'pre_get_comments', array( $this, 'filter_comment_queries' ), 10, 1 );
+        add_action( 'wp_count_comments', array( $this, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
+        add_action( 'comment_feed_where', array( $this, 'filter_comment_feed' ), 10, 2 );
+
+        // Delete comments count cache whenever there is a new comment or a comment status changes
+        add_action( 'wp_insert_comment', array( $this, 'delete_comment_count_cache' ) );
+        add_action( 'wp_set_comment_status', array( $this, 'delete_comment_count_cache' ) );
+    }
+
+    public function disable_comment_counting() {
+        wp_defer_comment_counting(true);
+    }
+    public function enable_comment_counting() {
+        wp_defer_comment_counting(false);
+    }
 
 }

plugins/woocommerce/packages/action-scheduler/classes/data-stores/ActionScheduler_DBStore.php

Indentation +865 added lines, -865 removed lines

@@ -9,869 +9,869 @@
  */
 class ActionScheduler_DBStore extends ActionScheduler_Store {
 
-	/**
-	 * Used to share information about the before_date property of claims internally.
-	 *
-	 * This is used in preference to passing the same information as a method param
-	 * for backwards-compatibility reasons.
-	 *
-	 * @var DateTime|null
-	 */
-	private $claim_before_date = null;
-
-	/** @var int */
-	protected static $max_args_length = 8000;
-
-	/** @var int */
-	protected static $max_index_length = 191;
-
-	/**
-	 * Initialize the data store
-	 *
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-		$table_maker = new ActionScheduler_StoreSchema();
-		$table_maker->init();
-		$table_maker->register_tables();
-	}
-
-	/**
-	 * Save an action.
-	 *
-	 * @param ActionScheduler_Action $action Action object.
-	 * @param DateTime              $date Optional schedule date. Default null.
-	 *
-	 * @return int Action ID.
-	 * @throws RuntimeException     Throws exception when saving the action fails.
-	 */
-	public function save_action( ActionScheduler_Action $action, \DateTime $date = null ) {
-		try {
-
-			$this->validate_action( $action );
-
-			/** @var \wpdb $wpdb */
-			global $wpdb;
-			$data = array(
-				'hook'                 => $action->get_hook(),
-				'status'               => ( $action->is_finished() ? self::STATUS_COMPLETE : self::STATUS_PENDING ),
-				'scheduled_date_gmt'   => $this->get_scheduled_date_string( $action, $date ),
-				'scheduled_date_local' => $this->get_scheduled_date_string_local( $action, $date ),
-				'schedule'             => serialize( $action->get_schedule() ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
-				'group_id'             => $this->get_group_id( $action->get_group() ),
-			);
-			$args = wp_json_encode( $action->get_args() );
-			if ( strlen( $args ) <= static::$max_index_length ) {
-				$data['args'] = $args;
-			} else {
-				$data['args']          = $this->hash_args( $args );
-				$data['extended_args'] = $args;
-			}
-
-			$table_name = ! empty( $wpdb->actionscheduler_actions ) ? $wpdb->actionscheduler_actions : $wpdb->prefix . 'actionscheduler_actions';
-			$wpdb->insert( $table_name, $data );
-			$action_id = $wpdb->insert_id;
-
-			if ( is_wp_error( $action_id ) ) {
-				throw new \RuntimeException( $action_id->get_error_message() );
-			} elseif ( empty( $action_id ) ) {
-				throw new \RuntimeException( $wpdb->last_error ? $wpdb->last_error : __( 'Database error.', 'woocommerce' ) );
-			}
-
-			do_action( 'action_scheduler_stored_action', $action_id );
-
-			return $action_id;
-		} catch ( \Exception $e ) {
-			/* translators: %s: error message */
-			throw new \RuntimeException( sprintf( __( 'Error saving action: %s', 'woocommerce' ), $e->getMessage() ), 0 );
-		}
-	}
-
-	/**
-	 * Generate a hash from json_encoded $args using MD5 as this isn't for security.
-	 *
-	 * @param string $args JSON encoded action args.
-	 * @return string
-	 */
-	protected function hash_args( $args ) {
-		return md5( $args );
-	}
-
-	/**
-	 * Get action args query param value from action args.
-	 *
-	 * @param array $args Action args.
-	 * @return string
-	 */
-	protected function get_args_for_query( $args ) {
-		$encoded = wp_json_encode( $args );
-		if ( strlen( $encoded ) <= static::$max_index_length ) {
-			return $encoded;
-		}
-		return $this->hash_args( $encoded );
-	}
-	/**
-	 * Get a group's ID based on its name/slug.
-	 *
-	 * @param string $slug The string name of a group.
-	 * @param bool   $create_if_not_exists Whether to create the group if it does not already exist. Default, true - create the group.
-	 *
-	 * @return int The group's ID, if it exists or is created, or 0 if it does not exist and is not created.
-	 */
-	protected function get_group_id( $slug, $create_if_not_exists = true ) {
-		if ( empty( $slug ) ) {
-			return 0;
-		}
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$group_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT group_id FROM {$wpdb->actionscheduler_groups} WHERE slug=%s", $slug ) );
-		if ( empty( $group_id ) && $create_if_not_exists ) {
-			$group_id = $this->create_group( $slug );
-		}
-
-		return $group_id;
-	}
-
-	/**
-	 * Create an action group.
-	 *
-	 * @param string $slug Group slug.
-	 *
-	 * @return int Group ID.
-	 */
-	protected function create_group( $slug ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$wpdb->insert( $wpdb->actionscheduler_groups, array( 'slug' => $slug ) );
-
-		return (int) $wpdb->insert_id;
-	}
-
-	/**
-	 * Retrieve an action.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @return ActionScheduler_Action
-	 */
-	public function fetch_action( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$data = $wpdb->get_row(
-			$wpdb->prepare(
-				"SELECT a.*, g.slug AS `group` FROM {$wpdb->actionscheduler_actions} a LEFT JOIN {$wpdb->actionscheduler_groups} g ON a.group_id=g.group_id WHERE a.action_id=%d",
-				$action_id
-			)
-		);
-
-		if ( empty( $data ) ) {
-			return $this->get_null_action();
-		}
-
-		if ( ! empty( $data->extended_args ) ) {
-			$data->args = $data->extended_args;
-			unset( $data->extended_args );
-		}
-
-		// Convert NULL dates to zero dates.
-		$date_fields = array(
-			'scheduled_date_gmt',
-			'scheduled_date_local',
-			'last_attempt_gmt',
-			'last_attempt_gmt',
-		);
-		foreach ( $date_fields as $date_field ) {
-			if ( is_null( $data->$date_field ) ) {
-				$data->$date_field = ActionScheduler_StoreSchema::DEFAULT_DATE;
-			}
-		}
-
-		try {
-			$action = $this->make_action_from_db_record( $data );
-		} catch ( ActionScheduler_InvalidActionException $exception ) {
-			do_action( 'action_scheduler_failed_fetch_action', $action_id, $exception );
-			return $this->get_null_action();
-		}
-
-		return $action;
-	}
-
-	/**
-	 * Create a null action.
-	 *
-	 * @return ActionScheduler_NullAction
-	 */
-	protected function get_null_action() {
-		return new ActionScheduler_NullAction();
-	}
-
-	/**
-	 * Create an action from a database record.
-	 *
-	 * @param object $data Action database record.
-	 *
-	 * @return ActionScheduler_Action|ActionScheduler_CanceledAction|ActionScheduler_FinishedAction
-	 */
-	protected function make_action_from_db_record( $data ) {
-
-		$hook     = $data->hook;
-		$args     = json_decode( $data->args, true );
-		$schedule = unserialize( $data->schedule ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
-
-		$this->validate_args( $args, $data->action_id );
-		$this->validate_schedule( $schedule, $data->action_id );
-
-		if ( empty( $schedule ) ) {
-			$schedule = new ActionScheduler_NullSchedule();
-		}
-		$group = $data->group ? $data->group : '';
-
-		return ActionScheduler::factory()->get_stored_action( $data->status, $data->hook, $args, $schedule, $group );
-	}
-
-	/**
-	 * Returns the SQL statement to query (or count) actions.
-	 *
-	 * @since x.x.x $query['status'] accepts array of statuses instead of a single status.
-	 *
-	 * @param array  $query Filtering options.
-	 * @param string $select_or_count  Whether the SQL should select and return the IDs or just the row count.
-	 *
-	 * @return string SQL statement already properly escaped.
-	 * @throws InvalidArgumentException If the query is invalid.
-	 */
-	protected function get_query_actions_sql( array $query, $select_or_count = 'select' ) {
-
-		if ( ! in_array( $select_or_count, array( 'select', 'count' ), true ) ) {
-			throw new InvalidArgumentException( __( 'Invalid value for select or count parameter. Cannot query actions.', 'woocommerce' ) );
-		}
-
-		$query = wp_parse_args(
-			$query,
-			array(
-				'hook'             => '',
-				'args'             => null,
-				'date'             => null,
-				'date_compare'     => '<=',
-				'modified'         => null,
-				'modified_compare' => '<=',
-				'group'            => '',
-				'status'           => '',
-				'claimed'          => null,
-				'per_page'         => 5,
-				'offset'           => 0,
-				'orderby'          => 'date',
-				'order'            => 'ASC',
-			)
-		);
-
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$sql        = ( 'count' === $select_or_count ) ? 'SELECT count(a.action_id)' : 'SELECT a.action_id';
-		$sql       .= " FROM {$wpdb->actionscheduler_actions} a";
-		$sql_params = array();
-
-		if ( ! empty( $query['group'] ) || 'group' === $query['orderby'] ) {
-			$sql .= " LEFT JOIN {$wpdb->actionscheduler_groups} g ON g.group_id=a.group_id";
-		}
-
-		$sql .= ' WHERE 1=1';
-
-		if ( ! empty( $query['group'] ) ) {
-			$sql         .= ' AND g.slug=%s';
-			$sql_params[] = $query['group'];
-		}
-
-		if ( $query['hook'] ) {
-			$sql         .= ' AND a.hook=%s';
-			$sql_params[] = $query['hook'];
-		}
-		if ( ! is_null( $query['args'] ) ) {
-			$sql         .= ' AND a.args=%s';
-			$sql_params[] = $this->get_args_for_query( $query['args'] );
-		}
-
-		if ( $query['status'] ) {
-			$statuses     = (array) $query['status'];
-			$placeholders = array_fill( 0, count( $statuses ), '%s' );
-			$sql         .= ' AND a.status IN (' . join( ', ', $placeholders ) . ')';
-			$sql_params   = array_merge( $sql_params, array_values( $statuses ) );
-		}
-
-		if ( $query['date'] instanceof \DateTime ) {
-			$date = clone $query['date'];
-			$date->setTimezone( new \DateTimeZone( 'UTC' ) );
-			$date_string  = $date->format( 'Y-m-d H:i:s' );
-			$comparator   = $this->validate_sql_comparator( $query['date_compare'] );
-			$sql         .= " AND a.scheduled_date_gmt $comparator %s";
-			$sql_params[] = $date_string;
-		}
-
-		if ( $query['modified'] instanceof \DateTime ) {
-			$modified = clone $query['modified'];
-			$modified->setTimezone( new \DateTimeZone( 'UTC' ) );
-			$date_string  = $modified->format( 'Y-m-d H:i:s' );
-			$comparator   = $this->validate_sql_comparator( $query['modified_compare'] );
-			$sql         .= " AND a.last_attempt_gmt $comparator %s";
-			$sql_params[] = $date_string;
-		}
-
-		if ( true === $query['claimed'] ) {
-			$sql .= ' AND a.claim_id != 0';
-		} elseif ( false === $query['claimed'] ) {
-			$sql .= ' AND a.claim_id = 0';
-		} elseif ( ! is_null( $query['claimed'] ) ) {
-			$sql         .= ' AND a.claim_id = %d';
-			$sql_params[] = $query['claimed'];
-		}
-
-		if ( ! empty( $query['search'] ) ) {
-			$sql .= ' AND (a.hook LIKE %s OR (a.extended_args IS NULL AND a.args LIKE %s) OR a.extended_args LIKE %s';
-			for ( $i = 0; $i < 3; $i++ ) {
-				$sql_params[] = sprintf( '%%%s%%', $query['search'] );
-			}
-
-			$search_claim_id = (int) $query['search'];
-			if ( $search_claim_id ) {
-				$sql         .= ' OR a.claim_id = %d';
-				$sql_params[] = $search_claim_id;
-			}
-
-			$sql .= ')';
-		}
-
-		if ( 'select' === $select_or_count ) {
-			if ( 'ASC' === strtoupper( $query['order'] ) ) {
-				$order = 'ASC';
-			} else {
-				$order = 'DESC';
-			}
-			switch ( $query['orderby'] ) {
-				case 'hook':
-					$sql .= " ORDER BY a.hook $order";
-					break;
-				case 'group':
-					$sql .= " ORDER BY g.slug $order";
-					break;
-				case 'modified':
-					$sql .= " ORDER BY a.last_attempt_gmt $order";
-					break;
-				case 'none':
-					break;
-				case 'action_id':
-					$sql .= " ORDER BY a.action_id $order";
-					break;
-				case 'date':
-				default:
-					$sql .= " ORDER BY a.scheduled_date_gmt $order";
-					break;
-			}
-
-			if ( $query['per_page'] > 0 ) {
-				$sql         .= ' LIMIT %d, %d';
-				$sql_params[] = $query['offset'];
-				$sql_params[] = $query['per_page'];
-			}
-		}
-
-		if ( ! empty( $sql_params ) ) {
-			$sql = $wpdb->prepare( $sql, $sql_params ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-		}
-
-		return $sql;
-	}
-
-	/**
-	 * Query for action count or list of action IDs.
-	 *
-	 * @since x.x.x $query['status'] accepts array of statuses instead of a single status.
-	 *
-	 * @see ActionScheduler_Store::query_actions for $query arg usage.
-	 *
-	 * @param array  $query      Query filtering options.
-	 * @param string $query_type Whether to select or count the results. Defaults to select.
-	 *
-	 * @return string|array|null The IDs of actions matching the query. Null on failure.
-	 */
-	public function query_actions( $query = array(), $query_type = 'select' ) {
-		/** @var wpdb $wpdb */
-		global $wpdb;
-
-		$sql = $this->get_query_actions_sql( $query, $query_type );
-
-		return ( 'count' === $query_type ) ? $wpdb->get_var( $sql ) : $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.NoSql, WordPress.DB.DirectDatabaseQuery.NoCaching
-	}
-
-	/**
-	 * Get a count of all actions in the store, grouped by status.
-	 *
-	 * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status.
-	 */
-	public function action_counts() {
-		global $wpdb;
-
-		$sql  = "SELECT a.status, count(a.status) as 'count'";
-		$sql .= " FROM {$wpdb->actionscheduler_actions} a";
-		$sql .= ' GROUP BY a.status';
-
-		$actions_count_by_status = array();
-		$action_stati_and_labels = $this->get_status_labels();
-
-		foreach ( $wpdb->get_results( $sql ) as $action_data ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			// Ignore any actions with invalid status.
-			if ( array_key_exists( $action_data->status, $action_stati_and_labels ) ) {
-				$actions_count_by_status[ $action_data->status ] = $action_data->count;
-			}
-		}
-
-		return $actions_count_by_status;
-	}
-
-	/**
-	 * Cancel an action.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @return void
-	 * @throws \InvalidArgumentException If the action update failed.
-	 */
-	public function cancel_action( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-
-		$updated = $wpdb->update(
-			$wpdb->actionscheduler_actions,
-			array( 'status' => self::STATUS_CANCELED ),
-			array( 'action_id' => $action_id ),
-			array( '%s' ),
-			array( '%d' )
-		);
-		if ( false === $updated ) {
-			/* translators: %s: action ID */
-			throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) );
-		}
-		do_action( 'action_scheduler_canceled_action', $action_id );
-	}
-
-	/**
-	 * Cancel pending actions by hook.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $hook Hook name.
-	 *
-	 * @return void
-	 */
-	public function cancel_actions_by_hook( $hook ) {
-		$this->bulk_cancel_actions( array( 'hook' => $hook ) );
-	}
-
-	/**
-	 * Cancel pending actions by group.
-	 *
-	 * @param string $group Group slug.
-	 *
-	 * @return void
-	 */
-	public function cancel_actions_by_group( $group ) {
-		$this->bulk_cancel_actions( array( 'group' => $group ) );
-	}
-
-	/**
-	 * Bulk cancel actions.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param array $query_args Query parameters.
-	 */
-	protected function bulk_cancel_actions( $query_args ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-
-		if ( ! is_array( $query_args ) ) {
-			return;
-		}
-
-		// Don't cancel actions that are already canceled.
-		if ( isset( $query_args['status'] ) && self::STATUS_CANCELED === $query_args['status'] ) {
-			return;
-		}
-
-		$action_ids = true;
-		$query_args = wp_parse_args(
-			$query_args,
-			array(
-				'per_page' => 1000,
-				'status'   => self::STATUS_PENDING,
-				'orderby'  => 'action_id',
-			)
-		);
-
-		while ( $action_ids ) {
-			$action_ids = $this->query_actions( $query_args );
-			if ( empty( $action_ids ) ) {
-				break;
-			}
-
-			$format     = array_fill( 0, count( $action_ids ), '%d' );
-			$query_in   = '(' . implode( ',', $format ) . ')';
-			$parameters = $action_ids;
-			array_unshift( $parameters, self::STATUS_CANCELED );
-
-			$wpdb->query(
-				$wpdb->prepare(
-					"UPDATE {$wpdb->actionscheduler_actions} SET status = %s WHERE action_id IN {$query_in}", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
-					$parameters
-				)
-			);
-
-			do_action( 'action_scheduler_bulk_cancel_actions', $action_ids );
-		}
-	}
-
-	/**
-	 * Delete an action.
-	 *
-	 * @param int $action_id Action ID.
-	 * @throws \InvalidArgumentException If the action deletion failed.
-	 */
-	public function delete_action( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$deleted = $wpdb->delete( $wpdb->actionscheduler_actions, array( 'action_id' => $action_id ), array( '%d' ) );
-		if ( empty( $deleted ) ) {
-			throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) ); //phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment
-		}
-		do_action( 'action_scheduler_deleted_action', $action_id );
-	}
-
-	/**
-	 * Get the schedule date for an action.
-	 *
-	 * @param string $action_id Action ID.
-	 *
-	 * @return \DateTime The local date the action is scheduled to run, or the date that it ran.
-	 */
-	public function get_date( $action_id ) {
-		$date = $this->get_date_gmt( $action_id );
-		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
-		return $date;
-	}
-
-	/**
-	 * Get the GMT schedule date for an action.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @throws \InvalidArgumentException If action cannot be identified.
-	 * @return \DateTime The GMT date the action is scheduled to run, or the date that it ran.
-	 */
-	protected function get_date_gmt( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$record = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d", $action_id ) );
-		if ( empty( $record ) ) {
-			throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) ); //phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment
-		}
-		if ( self::STATUS_PENDING === $record->status ) {
-			return as_get_datetime_object( $record->scheduled_date_gmt );
-		} else {
-			return as_get_datetime_object( $record->last_attempt_gmt );
-		}
-	}
-
-	/**
-	 * Stake a claim on actions.
-	 *
-	 * @param int       $max_actions Maximum number of action to include in claim.
-	 * @param \DateTime $before_date Jobs must be schedule before this date. Defaults to now.
-	 * @param array     $hooks Hooks to filter for.
-	 * @param string    $group Group to filter for.
-	 *
-	 * @return ActionScheduler_ActionClaim
-	 */
-	public function stake_claim( $max_actions = 10, \DateTime $before_date = null, $hooks = array(), $group = '' ) {
-		$claim_id = $this->generate_claim_id();
-
-		$this->claim_before_date = $before_date;
-		$this->claim_actions( $claim_id, $max_actions, $before_date, $hooks, $group );
-		$action_ids              = $this->find_actions_by_claim_id( $claim_id );
-		$this->claim_before_date = null;
-
-		return new ActionScheduler_ActionClaim( $claim_id, $action_ids );
-	}
-
-	/**
-	 * Generate a new action claim.
-	 *
-	 * @return int Claim ID.
-	 */
-	protected function generate_claim_id() {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$now = as_get_datetime_object();
-		$wpdb->insert( $wpdb->actionscheduler_claims, array( 'date_created_gmt' => $now->format( 'Y-m-d H:i:s' ) ) );
-
-		return $wpdb->insert_id;
-	}
-
-	/**
-	 * Mark actions claimed.
-	 *
-	 * @param string    $claim_id Claim Id.
-	 * @param int       $limit Number of action to include in claim.
-	 * @param \DateTime $before_date Should use UTC timezone.
-	 * @param array     $hooks Hooks to filter for.
-	 * @param string    $group Group to filter for.
-	 *
-	 * @return int The number of actions that were claimed.
-	 * @throws \InvalidArgumentException Throws InvalidArgumentException if group doesn't exist.
-	 * @throws \RuntimeException Throws RuntimeException if unable to claim action.
-	 */
-	protected function claim_actions( $claim_id, $limit, \DateTime $before_date = null, $hooks = array(), $group = '' ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-
-		$now  = as_get_datetime_object();
-		$date = is_null( $before_date ) ? $now : clone $before_date;
-
-		// can't use $wpdb->update() because of the <= condition.
-		$update = "UPDATE {$wpdb->actionscheduler_actions} SET claim_id=%d, last_attempt_gmt=%s, last_attempt_local=%s";
-		$params = array(
-			$claim_id,
-			$now->format( 'Y-m-d H:i:s' ),
-			current_time( 'mysql' ),
-		);
-
-		$where    = 'WHERE claim_id = 0 AND scheduled_date_gmt <= %s AND status=%s';
-		$params[] = $date->format( 'Y-m-d H:i:s' );
-		$params[] = self::STATUS_PENDING;
-
-		if ( ! empty( $hooks ) ) {
-			$placeholders = array_fill( 0, count( $hooks ), '%s' );
-			$where       .= ' AND hook IN (' . join( ', ', $placeholders ) . ')';
-			$params       = array_merge( $params, array_values( $hooks ) );
-		}
-
-		if ( ! empty( $group ) ) {
-
-			$group_id = $this->get_group_id( $group, false );
-
-			// throw exception if no matching group found, this matches ActionScheduler_wpPostStore's behaviour.
-			if ( empty( $group_id ) ) {
-				/* translators: %s: group name */
-				throw new InvalidArgumentException( sprintf( __( 'The group "%s" does not exist.', 'woocommerce' ), $group ) );
-			}
-
-			$where   .= ' AND group_id = %d';
-			$params[] = $group_id;
-		}
-
-		/**
-		 * Sets the order-by clause used in the action claim query.
-		 *
-		 * @since x.x.x
-		 *
-		 * @param string $order_by_sql
-		 */
-		$order    = apply_filters( 'action_scheduler_claim_actions_order_by', 'ORDER BY attempts ASC, scheduled_date_gmt ASC, action_id ASC' );
-		$params[] = $limit;
-
-		$sql           = $wpdb->prepare( "{$update} {$where} {$order} LIMIT %d", $params ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders
-		$rows_affected = $wpdb->query( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
-		if ( false === $rows_affected ) {
-			throw new \RuntimeException( __( 'Unable to claim actions. Database error.', 'woocommerce' ) );
-		}
-
-		return (int) $rows_affected;
-	}
-
-	/**
-	 * Get the number of active claims.
-	 *
-	 * @return int
-	 */
-	public function get_claim_count() {
-		global $wpdb;
-
-		$sql = "SELECT COUNT(DISTINCT claim_id) FROM {$wpdb->actionscheduler_actions} WHERE claim_id != 0 AND status IN ( %s, %s)";
-		$sql = $wpdb->prepare( $sql, array( self::STATUS_PENDING, self::STATUS_RUNNING ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-
-		return (int) $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	}
-
-	/**
-	 * Return an action's claim ID, as stored in the claim_id column.
-	 *
-	 * @param string $action_id Action ID.
-	 * @return mixed
-	 */
-	public function get_claim_id( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-
-		$sql = "SELECT claim_id FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d";
-		$sql = $wpdb->prepare( $sql, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-
-		return (int) $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	}
-
-	/**
-	 * Retrieve the action IDs of action in a claim.
-	 *
-	 * @param  int $claim_id Claim ID.
-	 * @return int[]
-	 */
-	public function find_actions_by_claim_id( $claim_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-
-		$action_ids  = array();
-		$before_date = isset( $this->claim_before_date ) ? $this->claim_before_date : as_get_datetime_object();
-		$cut_off     = $before_date->format( 'Y-m-d H:i:s' );
-
-		$sql = $wpdb->prepare(
-			"SELECT action_id, scheduled_date_gmt FROM {$wpdb->actionscheduler_actions} WHERE claim_id = %d",
-			$claim_id
-		);
-
-		// Verify that the scheduled date for each action is within the expected bounds (in some unusual
-		// cases, we cannot depend on MySQL to honor all of the WHERE conditions we specify).
-		foreach ( $wpdb->get_results( $sql ) as $claimed_action ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-			if ( $claimed_action->scheduled_date_gmt <= $cut_off ) {
-				$action_ids[] = absint( $claimed_action->action_id );
-			}
-		}
-
-		return $action_ids;
-	}
-
-	/**
-	 * Release actions from a claim and delete the claim.
-	 *
-	 * @param ActionScheduler_ActionClaim $claim Claim object.
-	 */
-	public function release_claim( ActionScheduler_ActionClaim $claim ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$wpdb->update( $wpdb->actionscheduler_actions, array( 'claim_id' => 0 ), array( 'claim_id' => $claim->get_id() ), array( '%d' ), array( '%d' ) );
-		$wpdb->delete( $wpdb->actionscheduler_claims, array( 'claim_id' => $claim->get_id() ), array( '%d' ) );
-	}
-
-	/**
-	 * Remove the claim from an action.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @return void
-	 */
-	public function unclaim_action( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$wpdb->update(
-			$wpdb->actionscheduler_actions,
-			array( 'claim_id' => 0 ),
-			array( 'action_id' => $action_id ),
-			array( '%s' ),
-			array( '%d' )
-		);
-	}
-
-	/**
-	 * Mark an action as failed.
-	 *
-	 * @param int $action_id Action ID.
-	 * @throws \InvalidArgumentException Throw an exception if action was not updated.
-	 */
-	public function mark_failure( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$updated = $wpdb->update(
-			$wpdb->actionscheduler_actions,
-			array( 'status' => self::STATUS_FAILED ),
-			array( 'action_id' => $action_id ),
-			array( '%s' ),
-			array( '%d' )
-		);
-		if ( empty( $updated ) ) {
-			throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) ); //phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment
-		}
-	}
-
-	/**
-	 * Add execution message to action log.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @return void
-	 */
-	public function log_execution( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-
-		$sql = "UPDATE {$wpdb->actionscheduler_actions} SET attempts = attempts+1, status=%s, last_attempt_gmt = %s, last_attempt_local = %s WHERE action_id = %d";
-		$sql = $wpdb->prepare( $sql, self::STATUS_RUNNING, current_time( 'mysql', true ), current_time( 'mysql' ), $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-		$wpdb->query( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	}
-
-	/**
-	 * Mark an action as complete.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @return void
-	 * @throws \InvalidArgumentException Throw an exception if action was not updated.
-	 */
-	public function mark_complete( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$updated = $wpdb->update(
-			$wpdb->actionscheduler_actions,
-			array(
-				'status'             => self::STATUS_COMPLETE,
-				'last_attempt_gmt'   => current_time( 'mysql', true ),
-				'last_attempt_local' => current_time( 'mysql' ),
-			),
-			array( 'action_id' => $action_id ),
-			array( '%s' ),
-			array( '%d' )
-		);
-		if ( empty( $updated ) ) {
-			throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) ); //phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment
-		}
-
-		/**
-		 * Fires after a scheduled action has been completed.
-		 *
-		 * @since 3.4.2
-		 *
-		 * @param int $action_id Action ID.
-		 */
-		do_action( 'action_scheduler_completed_action', $action_id );
-	}
-
-	/**
-	 * Get an action's status.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @return string
-	 * @throws \InvalidArgumentException Throw an exception if not status was found for action_id.
-	 * @throws \RuntimeException Throw an exception if action status could not be retrieved.
-	 */
-	public function get_status( $action_id ) {
-		/** @var \wpdb $wpdb */
-		global $wpdb;
-		$sql    = "SELECT status FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d";
-		$sql    = $wpdb->prepare( $sql, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-		$status = $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-
-		if ( null === $status ) {
-			throw new \InvalidArgumentException( __( 'Invalid action ID. No status found.', 'woocommerce' ) );
-		} elseif ( empty( $status ) ) {
-			throw new \RuntimeException( __( 'Unknown status found for action.', 'woocommerce' ) );
-		} else {
-			return $status;
-		}
-	}
+    /**
+     * Used to share information about the before_date property of claims internally.
+     *
+     * This is used in preference to passing the same information as a method param
+     * for backwards-compatibility reasons.
+     *
+     * @var DateTime|null
+     */
+    private $claim_before_date = null;
+
+    /** @var int */
+    protected static $max_args_length = 8000;
+
+    /** @var int */
+    protected static $max_index_length = 191;
+
+    /**
+     * Initialize the data store
+     *
+     * @codeCoverageIgnore
+     */
+    public function init() {
+        $table_maker = new ActionScheduler_StoreSchema();
+        $table_maker->init();
+        $table_maker->register_tables();
+    }
+
+    /**
+     * Save an action.
+     *
+     * @param ActionScheduler_Action $action Action object.
+     * @param DateTime              $date Optional schedule date. Default null.
+     *
+     * @return int Action ID.
+     * @throws RuntimeException     Throws exception when saving the action fails.
+     */
+    public function save_action( ActionScheduler_Action $action, \DateTime $date = null ) {
+        try {
+
+            $this->validate_action( $action );
+
+            /** @var \wpdb $wpdb */
+            global $wpdb;
+            $data = array(
+                'hook'                 => $action->get_hook(),
+                'status'               => ( $action->is_finished() ? self::STATUS_COMPLETE : self::STATUS_PENDING ),
+                'scheduled_date_gmt'   => $this->get_scheduled_date_string( $action, $date ),
+                'scheduled_date_local' => $this->get_scheduled_date_string_local( $action, $date ),
+                'schedule'             => serialize( $action->get_schedule() ), // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
+                'group_id'             => $this->get_group_id( $action->get_group() ),
+            );
+            $args = wp_json_encode( $action->get_args() );
+            if ( strlen( $args ) <= static::$max_index_length ) {
+                $data['args'] = $args;
+            } else {
+                $data['args']          = $this->hash_args( $args );
+                $data['extended_args'] = $args;
+            }
+
+            $table_name = ! empty( $wpdb->actionscheduler_actions ) ? $wpdb->actionscheduler_actions : $wpdb->prefix . 'actionscheduler_actions';
+            $wpdb->insert( $table_name, $data );
+            $action_id = $wpdb->insert_id;
+
+            if ( is_wp_error( $action_id ) ) {
+                throw new \RuntimeException( $action_id->get_error_message() );
+            } elseif ( empty( $action_id ) ) {
+                throw new \RuntimeException( $wpdb->last_error ? $wpdb->last_error : __( 'Database error.', 'woocommerce' ) );
+            }
+
+            do_action( 'action_scheduler_stored_action', $action_id );
+
+            return $action_id;
+        } catch ( \Exception $e ) {
+            /* translators: %s: error message */
+            throw new \RuntimeException( sprintf( __( 'Error saving action: %s', 'woocommerce' ), $e->getMessage() ), 0 );
+        }
+    }
+
+    /**
+     * Generate a hash from json_encoded $args using MD5 as this isn't for security.
+     *
+     * @param string $args JSON encoded action args.
+     * @return string
+     */
+    protected function hash_args( $args ) {
+        return md5( $args );
+    }
+
+    /**
+     * Get action args query param value from action args.
+     *
+     * @param array $args Action args.
+     * @return string
+     */
+    protected function get_args_for_query( $args ) {
+        $encoded = wp_json_encode( $args );
+        if ( strlen( $encoded ) <= static::$max_index_length ) {
+            return $encoded;
+        }
+        return $this->hash_args( $encoded );
+    }
+    /**
+     * Get a group's ID based on its name/slug.
+     *
+     * @param string $slug The string name of a group.
+     * @param bool   $create_if_not_exists Whether to create the group if it does not already exist. Default, true - create the group.
+     *
+     * @return int The group's ID, if it exists or is created, or 0 if it does not exist and is not created.
+     */
+    protected function get_group_id( $slug, $create_if_not_exists = true ) {
+        if ( empty( $slug ) ) {
+            return 0;
+        }
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $group_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT group_id FROM {$wpdb->actionscheduler_groups} WHERE slug=%s", $slug ) );
+        if ( empty( $group_id ) && $create_if_not_exists ) {
+            $group_id = $this->create_group( $slug );
+        }
+
+        return $group_id;
+    }
+
+    /**
+     * Create an action group.
+     *
+     * @param string $slug Group slug.
+     *
+     * @return int Group ID.
+     */
+    protected function create_group( $slug ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $wpdb->insert( $wpdb->actionscheduler_groups, array( 'slug' => $slug ) );
+
+        return (int) $wpdb->insert_id;
+    }
+
+    /**
+     * Retrieve an action.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @return ActionScheduler_Action
+     */
+    public function fetch_action( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $data = $wpdb->get_row(
+            $wpdb->prepare(
+                "SELECT a.*, g.slug AS `group` FROM {$wpdb->actionscheduler_actions} a LEFT JOIN {$wpdb->actionscheduler_groups} g ON a.group_id=g.group_id WHERE a.action_id=%d",
+                $action_id
+            )
+        );
+
+        if ( empty( $data ) ) {
+            return $this->get_null_action();
+        }
+
+        if ( ! empty( $data->extended_args ) ) {
+            $data->args = $data->extended_args;
+            unset( $data->extended_args );
+        }
+
+        // Convert NULL dates to zero dates.
+        $date_fields = array(
+            'scheduled_date_gmt',
+            'scheduled_date_local',
+            'last_attempt_gmt',
+            'last_attempt_gmt',
+        );
+        foreach ( $date_fields as $date_field ) {
+            if ( is_null( $data->$date_field ) ) {
+                $data->$date_field = ActionScheduler_StoreSchema::DEFAULT_DATE;
+            }
+        }
+
+        try {
+            $action = $this->make_action_from_db_record( $data );
+        } catch ( ActionScheduler_InvalidActionException $exception ) {
+            do_action( 'action_scheduler_failed_fetch_action', $action_id, $exception );
+            return $this->get_null_action();
+        }
+
+        return $action;
+    }
+
+    /**
+     * Create a null action.
+     *
+     * @return ActionScheduler_NullAction
+     */
+    protected function get_null_action() {
+        return new ActionScheduler_NullAction();
+    }
+
+    /**
+     * Create an action from a database record.
+     *
+     * @param object $data Action database record.
+     *
+     * @return ActionScheduler_Action|ActionScheduler_CanceledAction|ActionScheduler_FinishedAction
+     */
+    protected function make_action_from_db_record( $data ) {
+
+        $hook     = $data->hook;
+        $args     = json_decode( $data->args, true );
+        $schedule = unserialize( $data->schedule ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
+
+        $this->validate_args( $args, $data->action_id );
+        $this->validate_schedule( $schedule, $data->action_id );
+
+        if ( empty( $schedule ) ) {
+            $schedule = new ActionScheduler_NullSchedule();
+        }
+        $group = $data->group ? $data->group : '';
+
+        return ActionScheduler::factory()->get_stored_action( $data->status, $data->hook, $args, $schedule, $group );
+    }
+
+    /**
+     * Returns the SQL statement to query (or count) actions.
+     *
+     * @since x.x.x $query['status'] accepts array of statuses instead of a single status.
+     *
+     * @param array  $query Filtering options.
+     * @param string $select_or_count  Whether the SQL should select and return the IDs or just the row count.
+     *
+     * @return string SQL statement already properly escaped.
+     * @throws InvalidArgumentException If the query is invalid.
+     */
+    protected function get_query_actions_sql( array $query, $select_or_count = 'select' ) {
+
+        if ( ! in_array( $select_or_count, array( 'select', 'count' ), true ) ) {
+            throw new InvalidArgumentException( __( 'Invalid value for select or count parameter. Cannot query actions.', 'woocommerce' ) );
+        }
+
+        $query = wp_parse_args(
+            $query,
+            array(
+                'hook'             => '',
+                'args'             => null,
+                'date'             => null,
+                'date_compare'     => '<=',
+                'modified'         => null,
+                'modified_compare' => '<=',
+                'group'            => '',
+                'status'           => '',
+                'claimed'          => null,
+                'per_page'         => 5,
+                'offset'           => 0,
+                'orderby'          => 'date',
+                'order'            => 'ASC',
+            )
+        );
+
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $sql        = ( 'count' === $select_or_count ) ? 'SELECT count(a.action_id)' : 'SELECT a.action_id';
+        $sql       .= " FROM {$wpdb->actionscheduler_actions} a";
+        $sql_params = array();
+
+        if ( ! empty( $query['group'] ) || 'group' === $query['orderby'] ) {
+            $sql .= " LEFT JOIN {$wpdb->actionscheduler_groups} g ON g.group_id=a.group_id";
+        }
+
+        $sql .= ' WHERE 1=1';
+
+        if ( ! empty( $query['group'] ) ) {
+            $sql         .= ' AND g.slug=%s';
+            $sql_params[] = $query['group'];
+        }
+
+        if ( $query['hook'] ) {
+            $sql         .= ' AND a.hook=%s';
+            $sql_params[] = $query['hook'];
+        }
+        if ( ! is_null( $query['args'] ) ) {
+            $sql         .= ' AND a.args=%s';
+            $sql_params[] = $this->get_args_for_query( $query['args'] );
+        }
+
+        if ( $query['status'] ) {
+            $statuses     = (array) $query['status'];
+            $placeholders = array_fill( 0, count( $statuses ), '%s' );
+            $sql         .= ' AND a.status IN (' . join( ', ', $placeholders ) . ')';
+            $sql_params   = array_merge( $sql_params, array_values( $statuses ) );
+        }
+
+        if ( $query['date'] instanceof \DateTime ) {
+            $date = clone $query['date'];
+            $date->setTimezone( new \DateTimeZone( 'UTC' ) );
+            $date_string  = $date->format( 'Y-m-d H:i:s' );
+            $comparator   = $this->validate_sql_comparator( $query['date_compare'] );
+            $sql         .= " AND a.scheduled_date_gmt $comparator %s";
+            $sql_params[] = $date_string;
+        }
+
+        if ( $query['modified'] instanceof \DateTime ) {
+            $modified = clone $query['modified'];
+            $modified->setTimezone( new \DateTimeZone( 'UTC' ) );
+            $date_string  = $modified->format( 'Y-m-d H:i:s' );
+            $comparator   = $this->validate_sql_comparator( $query['modified_compare'] );
+            $sql         .= " AND a.last_attempt_gmt $comparator %s";
+            $sql_params[] = $date_string;
+        }
+
+        if ( true === $query['claimed'] ) {
+            $sql .= ' AND a.claim_id != 0';
+        } elseif ( false === $query['claimed'] ) {
+            $sql .= ' AND a.claim_id = 0';
+        } elseif ( ! is_null( $query['claimed'] ) ) {
+            $sql         .= ' AND a.claim_id = %d';
+            $sql_params[] = $query['claimed'];
+        }
+
+        if ( ! empty( $query['search'] ) ) {
+            $sql .= ' AND (a.hook LIKE %s OR (a.extended_args IS NULL AND a.args LIKE %s) OR a.extended_args LIKE %s';
+            for ( $i = 0; $i < 3; $i++ ) {
+                $sql_params[] = sprintf( '%%%s%%', $query['search'] );
+            }
+
+            $search_claim_id = (int) $query['search'];
+            if ( $search_claim_id ) {
+                $sql         .= ' OR a.claim_id = %d';
+                $sql_params[] = $search_claim_id;
+            }
+
+            $sql .= ')';
+        }
+
+        if ( 'select' === $select_or_count ) {
+            if ( 'ASC' === strtoupper( $query['order'] ) ) {
+                $order = 'ASC';
+            } else {
+                $order = 'DESC';
+            }
+            switch ( $query['orderby'] ) {
+                case 'hook':
+                    $sql .= " ORDER BY a.hook $order";
+                    break;
+                case 'group':
+                    $sql .= " ORDER BY g.slug $order";
+                    break;
+                case 'modified':
+                    $sql .= " ORDER BY a.last_attempt_gmt $order";
+                    break;
+                case 'none':
+                    break;
+                case 'action_id':
+                    $sql .= " ORDER BY a.action_id $order";
+                    break;
+                case 'date':
+                default:
+                    $sql .= " ORDER BY a.scheduled_date_gmt $order";
+                    break;
+            }
+
+            if ( $query['per_page'] > 0 ) {
+                $sql         .= ' LIMIT %d, %d';
+                $sql_params[] = $query['offset'];
+                $sql_params[] = $query['per_page'];
+            }
+        }
+
+        if ( ! empty( $sql_params ) ) {
+            $sql = $wpdb->prepare( $sql, $sql_params ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+        }
+
+        return $sql;
+    }
+
+    /**
+     * Query for action count or list of action IDs.
+     *
+     * @since x.x.x $query['status'] accepts array of statuses instead of a single status.
+     *
+     * @see ActionScheduler_Store::query_actions for $query arg usage.
+     *
+     * @param array  $query      Query filtering options.
+     * @param string $query_type Whether to select or count the results. Defaults to select.
+     *
+     * @return string|array|null The IDs of actions matching the query. Null on failure.
+     */
+    public function query_actions( $query = array(), $query_type = 'select' ) {
+        /** @var wpdb $wpdb */
+        global $wpdb;
+
+        $sql = $this->get_query_actions_sql( $query, $query_type );
+
+        return ( 'count' === $query_type ) ? $wpdb->get_var( $sql ) : $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.NoSql, WordPress.DB.DirectDatabaseQuery.NoCaching
+    }
+
+    /**
+     * Get a count of all actions in the store, grouped by status.
+     *
+     * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status.
+     */
+    public function action_counts() {
+        global $wpdb;
+
+        $sql  = "SELECT a.status, count(a.status) as 'count'";
+        $sql .= " FROM {$wpdb->actionscheduler_actions} a";
+        $sql .= ' GROUP BY a.status';
+
+        $actions_count_by_status = array();
+        $action_stati_and_labels = $this->get_status_labels();
+
+        foreach ( $wpdb->get_results( $sql ) as $action_data ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            // Ignore any actions with invalid status.
+            if ( array_key_exists( $action_data->status, $action_stati_and_labels ) ) {
+                $actions_count_by_status[ $action_data->status ] = $action_data->count;
+            }
+        }
+
+        return $actions_count_by_status;
+    }
+
+    /**
+     * Cancel an action.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @return void
+     * @throws \InvalidArgumentException If the action update failed.
+     */
+    public function cancel_action( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+
+        $updated = $wpdb->update(
+            $wpdb->actionscheduler_actions,
+            array( 'status' => self::STATUS_CANCELED ),
+            array( 'action_id' => $action_id ),
+            array( '%s' ),
+            array( '%d' )
+        );
+        if ( false === $updated ) {
+            /* translators: %s: action ID */
+            throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) );
+        }
+        do_action( 'action_scheduler_canceled_action', $action_id );
+    }
+
+    /**
+     * Cancel pending actions by hook.
+     *
+     * @since 3.0.0
+     *
+     * @param string $hook Hook name.
+     *
+     * @return void
+     */
+    public function cancel_actions_by_hook( $hook ) {
+        $this->bulk_cancel_actions( array( 'hook' => $hook ) );
+    }
+
+    /**
+     * Cancel pending actions by group.
+     *
+     * @param string $group Group slug.
+     *
+     * @return void
+     */
+    public function cancel_actions_by_group( $group ) {
+        $this->bulk_cancel_actions( array( 'group' => $group ) );
+    }
+
+    /**
+     * Bulk cancel actions.
+     *
+     * @since 3.0.0
+     *
+     * @param array $query_args Query parameters.
+     */
+    protected function bulk_cancel_actions( $query_args ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+
+        if ( ! is_array( $query_args ) ) {
+            return;
+        }
+
+        // Don't cancel actions that are already canceled.
+        if ( isset( $query_args['status'] ) && self::STATUS_CANCELED === $query_args['status'] ) {
+            return;
+        }
+
+        $action_ids = true;
+        $query_args = wp_parse_args(
+            $query_args,
+            array(
+                'per_page' => 1000,
+                'status'   => self::STATUS_PENDING,
+                'orderby'  => 'action_id',
+            )
+        );
+
+        while ( $action_ids ) {
+            $action_ids = $this->query_actions( $query_args );
+            if ( empty( $action_ids ) ) {
+                break;
+            }
+
+            $format     = array_fill( 0, count( $action_ids ), '%d' );
+            $query_in   = '(' . implode( ',', $format ) . ')';
+            $parameters = $action_ids;
+            array_unshift( $parameters, self::STATUS_CANCELED );
+
+            $wpdb->query(
+                $wpdb->prepare(
+                    "UPDATE {$wpdb->actionscheduler_actions} SET status = %s WHERE action_id IN {$query_in}", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+                    $parameters
+                )
+            );
+
+            do_action( 'action_scheduler_bulk_cancel_actions', $action_ids );
+        }
+    }
+
+    /**
+     * Delete an action.
+     *
+     * @param int $action_id Action ID.
+     * @throws \InvalidArgumentException If the action deletion failed.
+     */
+    public function delete_action( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $deleted = $wpdb->delete( $wpdb->actionscheduler_actions, array( 'action_id' => $action_id ), array( '%d' ) );
+        if ( empty( $deleted ) ) {
+            throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) ); //phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment
+        }
+        do_action( 'action_scheduler_deleted_action', $action_id );
+    }
+
+    /**
+     * Get the schedule date for an action.
+     *
+     * @param string $action_id Action ID.
+     *
+     * @return \DateTime The local date the action is scheduled to run, or the date that it ran.
+     */
+    public function get_date( $action_id ) {
+        $date = $this->get_date_gmt( $action_id );
+        ActionScheduler_TimezoneHelper::set_local_timezone( $date );
+        return $date;
+    }
+
+    /**
+     * Get the GMT schedule date for an action.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @throws \InvalidArgumentException If action cannot be identified.
+     * @return \DateTime The GMT date the action is scheduled to run, or the date that it ran.
+     */
+    protected function get_date_gmt( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $record = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d", $action_id ) );
+        if ( empty( $record ) ) {
+            throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) ); //phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment
+        }
+        if ( self::STATUS_PENDING === $record->status ) {
+            return as_get_datetime_object( $record->scheduled_date_gmt );
+        } else {
+            return as_get_datetime_object( $record->last_attempt_gmt );
+        }
+    }
+
+    /**
+     * Stake a claim on actions.
+     *
+     * @param int       $max_actions Maximum number of action to include in claim.
+     * @param \DateTime $before_date Jobs must be schedule before this date. Defaults to now.
+     * @param array     $hooks Hooks to filter for.
+     * @param string    $group Group to filter for.
+     *
+     * @return ActionScheduler_ActionClaim
+     */
+    public function stake_claim( $max_actions = 10, \DateTime $before_date = null, $hooks = array(), $group = '' ) {
+        $claim_id = $this->generate_claim_id();
+
+        $this->claim_before_date = $before_date;
+        $this->claim_actions( $claim_id, $max_actions, $before_date, $hooks, $group );
+        $action_ids              = $this->find_actions_by_claim_id( $claim_id );
+        $this->claim_before_date = null;
+
+        return new ActionScheduler_ActionClaim( $claim_id, $action_ids );
+    }
+
+    /**
+     * Generate a new action claim.
+     *
+     * @return int Claim ID.
+     */
+    protected function generate_claim_id() {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $now = as_get_datetime_object();
+        $wpdb->insert( $wpdb->actionscheduler_claims, array( 'date_created_gmt' => $now->format( 'Y-m-d H:i:s' ) ) );
+
+        return $wpdb->insert_id;
+    }
+
+    /**
+     * Mark actions claimed.
+     *
+     * @param string    $claim_id Claim Id.
+     * @param int       $limit Number of action to include in claim.
+     * @param \DateTime $before_date Should use UTC timezone.
+     * @param array     $hooks Hooks to filter for.
+     * @param string    $group Group to filter for.
+     *
+     * @return int The number of actions that were claimed.
+     * @throws \InvalidArgumentException Throws InvalidArgumentException if group doesn't exist.
+     * @throws \RuntimeException Throws RuntimeException if unable to claim action.
+     */
+    protected function claim_actions( $claim_id, $limit, \DateTime $before_date = null, $hooks = array(), $group = '' ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+
+        $now  = as_get_datetime_object();
+        $date = is_null( $before_date ) ? $now : clone $before_date;
+
+        // can't use $wpdb->update() because of the <= condition.
+        $update = "UPDATE {$wpdb->actionscheduler_actions} SET claim_id=%d, last_attempt_gmt=%s, last_attempt_local=%s";
+        $params = array(
+            $claim_id,
+            $now->format( 'Y-m-d H:i:s' ),
+            current_time( 'mysql' ),
+        );
+
+        $where    = 'WHERE claim_id = 0 AND scheduled_date_gmt <= %s AND status=%s';
+        $params[] = $date->format( 'Y-m-d H:i:s' );
+        $params[] = self::STATUS_PENDING;
+
+        if ( ! empty( $hooks ) ) {
+            $placeholders = array_fill( 0, count( $hooks ), '%s' );
+            $where       .= ' AND hook IN (' . join( ', ', $placeholders ) . ')';
+            $params       = array_merge( $params, array_values( $hooks ) );
+        }
+
+        if ( ! empty( $group ) ) {
+
+            $group_id = $this->get_group_id( $group, false );
+
+            // throw exception if no matching group found, this matches ActionScheduler_wpPostStore's behaviour.
+            if ( empty( $group_id ) ) {
+                /* translators: %s: group name */
+                throw new InvalidArgumentException( sprintf( __( 'The group "%s" does not exist.', 'woocommerce' ), $group ) );
+            }
+
+            $where   .= ' AND group_id = %d';
+            $params[] = $group_id;
+        }
+
+        /**
+         * Sets the order-by clause used in the action claim query.
+         *
+         * @since x.x.x
+         *
+         * @param string $order_by_sql
+         */
+        $order    = apply_filters( 'action_scheduler_claim_actions_order_by', 'ORDER BY attempts ASC, scheduled_date_gmt ASC, action_id ASC' );
+        $params[] = $limit;
+
+        $sql           = $wpdb->prepare( "{$update} {$where} {$order} LIMIT %d", $params ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders
+        $rows_affected = $wpdb->query( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
+        if ( false === $rows_affected ) {
+            throw new \RuntimeException( __( 'Unable to claim actions. Database error.', 'woocommerce' ) );
+        }
+
+        return (int) $rows_affected;
+    }
+
+    /**
+     * Get the number of active claims.
+     *
+     * @return int
+     */
+    public function get_claim_count() {
+        global $wpdb;
+
+        $sql = "SELECT COUNT(DISTINCT claim_id) FROM {$wpdb->actionscheduler_actions} WHERE claim_id != 0 AND status IN ( %s, %s)";
+        $sql = $wpdb->prepare( $sql, array( self::STATUS_PENDING, self::STATUS_RUNNING ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+
+        return (int) $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    }
+
+    /**
+     * Return an action's claim ID, as stored in the claim_id column.
+     *
+     * @param string $action_id Action ID.
+     * @return mixed
+     */
+    public function get_claim_id( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+
+        $sql = "SELECT claim_id FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d";
+        $sql = $wpdb->prepare( $sql, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+
+        return (int) $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    }
+
+    /**
+     * Retrieve the action IDs of action in a claim.
+     *
+     * @param  int $claim_id Claim ID.
+     * @return int[]
+     */
+    public function find_actions_by_claim_id( $claim_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+
+        $action_ids  = array();
+        $before_date = isset( $this->claim_before_date ) ? $this->claim_before_date : as_get_datetime_object();
+        $cut_off     = $before_date->format( 'Y-m-d H:i:s' );
+
+        $sql = $wpdb->prepare(
+            "SELECT action_id, scheduled_date_gmt FROM {$wpdb->actionscheduler_actions} WHERE claim_id = %d",
+            $claim_id
+        );
+
+        // Verify that the scheduled date for each action is within the expected bounds (in some unusual
+        // cases, we cannot depend on MySQL to honor all of the WHERE conditions we specify).
+        foreach ( $wpdb->get_results( $sql ) as $claimed_action ) { // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+            if ( $claimed_action->scheduled_date_gmt <= $cut_off ) {
+                $action_ids[] = absint( $claimed_action->action_id );
+            }
+        }
+
+        return $action_ids;
+    }
+
+    /**
+     * Release actions from a claim and delete the claim.
+     *
+     * @param ActionScheduler_ActionClaim $claim Claim object.
+     */
+    public function release_claim( ActionScheduler_ActionClaim $claim ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $wpdb->update( $wpdb->actionscheduler_actions, array( 'claim_id' => 0 ), array( 'claim_id' => $claim->get_id() ), array( '%d' ), array( '%d' ) );
+        $wpdb->delete( $wpdb->actionscheduler_claims, array( 'claim_id' => $claim->get_id() ), array( '%d' ) );
+    }
+
+    /**
+     * Remove the claim from an action.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @return void
+     */
+    public function unclaim_action( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $wpdb->update(
+            $wpdb->actionscheduler_actions,
+            array( 'claim_id' => 0 ),
+            array( 'action_id' => $action_id ),
+            array( '%s' ),
+            array( '%d' )
+        );
+    }
+
+    /**
+     * Mark an action as failed.
+     *
+     * @param int $action_id Action ID.
+     * @throws \InvalidArgumentException Throw an exception if action was not updated.
+     */
+    public function mark_failure( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $updated = $wpdb->update(
+            $wpdb->actionscheduler_actions,
+            array( 'status' => self::STATUS_FAILED ),
+            array( 'action_id' => $action_id ),
+            array( '%s' ),
+            array( '%d' )
+        );
+        if ( empty( $updated ) ) {
+            throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) ); //phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment
+        }
+    }
+
+    /**
+     * Add execution message to action log.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @return void
+     */
+    public function log_execution( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+
+        $sql = "UPDATE {$wpdb->actionscheduler_actions} SET attempts = attempts+1, status=%s, last_attempt_gmt = %s, last_attempt_local = %s WHERE action_id = %d";
+        $sql = $wpdb->prepare( $sql, self::STATUS_RUNNING, current_time( 'mysql', true ), current_time( 'mysql' ), $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+        $wpdb->query( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    }
+
+    /**
+     * Mark an action as complete.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @return void
+     * @throws \InvalidArgumentException Throw an exception if action was not updated.
+     */
+    public function mark_complete( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $updated = $wpdb->update(
+            $wpdb->actionscheduler_actions,
+            array(
+                'status'             => self::STATUS_COMPLETE,
+                'last_attempt_gmt'   => current_time( 'mysql', true ),
+                'last_attempt_local' => current_time( 'mysql' ),
+            ),
+            array( 'action_id' => $action_id ),
+            array( '%s' ),
+            array( '%d' )
+        );
+        if ( empty( $updated ) ) {
+            throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'woocommerce' ), $action_id ) ); //phpcs:ignore WordPress.WP.I18n.MissingTranslatorsComment
+        }
+
+        /**
+         * Fires after a scheduled action has been completed.
+         *
+         * @since 3.4.2
+         *
+         * @param int $action_id Action ID.
+         */
+        do_action( 'action_scheduler_completed_action', $action_id );
+    }
+
+    /**
+     * Get an action's status.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @return string
+     * @throws \InvalidArgumentException Throw an exception if not status was found for action_id.
+     * @throws \RuntimeException Throw an exception if action status could not be retrieved.
+     */
+    public function get_status( $action_id ) {
+        /** @var \wpdb $wpdb */
+        global $wpdb;
+        $sql    = "SELECT status FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d";
+        $sql    = $wpdb->prepare( $sql, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+        $status = $wpdb->get_var( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+
+        if ( null === $status ) {
+            throw new \InvalidArgumentException( __( 'Invalid action ID. No status found.', 'woocommerce' ) );
+        } elseif ( empty( $status ) ) {
+            throw new \RuntimeException( __( 'Unknown status found for action.', 'woocommerce' ) );
+        } else {
+            return $status;
+        }
+    }
 }

plugins/woocommerce/packages/action-scheduler/classes/data-stores/ActionScheduler_DBLogger.php

Indentation +142 added lines, -142 removed lines

@@ -9,146 +9,146 @@
  */
 class ActionScheduler_DBLogger extends ActionScheduler_Logger {
 
-	/**
-	 * Add a record to an action log.
-	 *
-	 * @param int      $action_id Action ID.
-	 * @param string   $message Message to be saved in the log entry.
-	 * @param DateTime $date Timestamp of the log entry.
-	 *
-	 * @return int     The log entry ID.
-	 */
-	public function log( $action_id, $message, DateTime $date = null ) {
-		if ( empty( $date ) ) {
-			$date = as_get_datetime_object();
-		} else {
-			$date = clone $date;
-		}
-
-		$date_gmt = $date->format( 'Y-m-d H:i:s' );
-		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
-		$date_local = $date->format( 'Y-m-d H:i:s' );
-
-		/** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
-		global $wpdb;
-		$wpdb->insert(
-			$wpdb->actionscheduler_logs,
-			array(
-				'action_id'      => $action_id,
-				'message'        => $message,
-				'log_date_gmt'   => $date_gmt,
-				'log_date_local' => $date_local,
-			),
-			array( '%d', '%s', '%s', '%s' )
-		);
-
-		return $wpdb->insert_id;
-	}
-
-	/**
-	 * Retrieve an action log entry.
-	 *
-	 * @param int $entry_id Log entry ID.
-	 *
-	 * @return ActionScheduler_LogEntry
-	 */
-	public function get_entry( $entry_id ) {
-		/** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
-		global $wpdb;
-		$entry = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE log_id=%d", $entry_id ) );
-
-		return $this->create_entry_from_db_record( $entry );
-	}
-
-	/**
-	 * Create an action log entry from a database record.
-	 *
-	 * @param object $record Log entry database record object.
-	 *
-	 * @return ActionScheduler_LogEntry
-	 */
-	private function create_entry_from_db_record( $record ) {
-		if ( empty( $record ) ) {
-			return new ActionScheduler_NullLogEntry();
-		}
-
-		if ( is_null( $record->log_date_gmt ) ) {
-			$date = as_get_datetime_object( ActionScheduler_StoreSchema::DEFAULT_DATE );
-		} else {
-			$date = as_get_datetime_object( $record->log_date_gmt );
-		}
-
-		return new ActionScheduler_LogEntry( $record->action_id, $record->message, $date );
-	}
-
-	/**
-	 * Retrieve the an action's log entries from the database.
-	 *
-	 * @param int $action_id Action ID.
-	 *
-	 * @return ActionScheduler_LogEntry[]
-	 */
-	public function get_logs( $action_id ) {
-		/** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
-		global $wpdb;
-
-		$records = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE action_id=%d", $action_id ) );
-
-		return array_map( array( $this, 'create_entry_from_db_record' ), $records );
-	}
-
-	/**
-	 * Initialize the data store.
-	 *
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-		$table_maker = new ActionScheduler_LoggerSchema();
-		$table_maker->init();
-		$table_maker->register_tables();
-
-		parent::init();
-
-		add_action( 'action_scheduler_deleted_action', array( $this, 'clear_deleted_action_logs' ), 10, 1 );
-	}
-
-	/**
-	 * Delete the action logs for an action.
-	 *
-	 * @param int $action_id Action ID.
-	 */
-	public function clear_deleted_action_logs( $action_id ) {
-		/** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
-		global $wpdb;
-		$wpdb->delete( $wpdb->actionscheduler_logs, array( 'action_id' => $action_id ), array( '%d' ) );
-	}
-
-	/**
-	 * Bulk add cancel action log entries.
-	 *
-	 * @param array $action_ids List of action ID.
-	 */
-	public function bulk_log_cancel_actions( $action_ids ) {
-		if ( empty( $action_ids ) ) {
-			return;
-		}
-
-		/** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
-		global $wpdb;
-		$date     = as_get_datetime_object();
-		$date_gmt = $date->format( 'Y-m-d H:i:s' );
-		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
-		$date_local = $date->format( 'Y-m-d H:i:s' );
-		$message    = __( 'action canceled', 'woocommerce' );
-		$format     = '(%d, ' . $wpdb->prepare( '%s, %s, %s', $message, $date_gmt, $date_local ) . ')';
-		$sql_query  = "INSERT {$wpdb->actionscheduler_logs} (action_id, message, log_date_gmt, log_date_local) VALUES ";
-		$value_rows = array();
-
-		foreach ( $action_ids as $action_id ) {
-			$value_rows[] = $wpdb->prepare( $format, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-		}
-		$sql_query .= implode( ',', $value_rows );
-
-		$wpdb->query( $sql_query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-	}
+    /**
+     * Add a record to an action log.
+     *
+     * @param int      $action_id Action ID.
+     * @param string   $message Message to be saved in the log entry.
+     * @param DateTime $date Timestamp of the log entry.
+     *
+     * @return int     The log entry ID.
+     */
+    public function log( $action_id, $message, DateTime $date = null ) {
+        if ( empty( $date ) ) {
+            $date = as_get_datetime_object();
+        } else {
+            $date = clone $date;
+        }
+
+        $date_gmt = $date->format( 'Y-m-d H:i:s' );
+        ActionScheduler_TimezoneHelper::set_local_timezone( $date );
+        $date_local = $date->format( 'Y-m-d H:i:s' );
+
+        /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
+        global $wpdb;
+        $wpdb->insert(
+            $wpdb->actionscheduler_logs,
+            array(
+                'action_id'      => $action_id,
+                'message'        => $message,
+                'log_date_gmt'   => $date_gmt,
+                'log_date_local' => $date_local,
+            ),
+            array( '%d', '%s', '%s', '%s' )
+        );
+
+        return $wpdb->insert_id;
+    }
+
+    /**
+     * Retrieve an action log entry.
+     *
+     * @param int $entry_id Log entry ID.
+     *
+     * @return ActionScheduler_LogEntry
+     */
+    public function get_entry( $entry_id ) {
+        /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
+        global $wpdb;
+        $entry = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE log_id=%d", $entry_id ) );
+
+        return $this->create_entry_from_db_record( $entry );
+    }
+
+    /**
+     * Create an action log entry from a database record.
+     *
+     * @param object $record Log entry database record object.
+     *
+     * @return ActionScheduler_LogEntry
+     */
+    private function create_entry_from_db_record( $record ) {
+        if ( empty( $record ) ) {
+            return new ActionScheduler_NullLogEntry();
+        }
+
+        if ( is_null( $record->log_date_gmt ) ) {
+            $date = as_get_datetime_object( ActionScheduler_StoreSchema::DEFAULT_DATE );
+        } else {
+            $date = as_get_datetime_object( $record->log_date_gmt );
+        }
+
+        return new ActionScheduler_LogEntry( $record->action_id, $record->message, $date );
+    }
+
+    /**
+     * Retrieve the an action's log entries from the database.
+     *
+     * @param int $action_id Action ID.
+     *
+     * @return ActionScheduler_LogEntry[]
+     */
+    public function get_logs( $action_id ) {
+        /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
+        global $wpdb;
+
+        $records = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE action_id=%d", $action_id ) );
+
+        return array_map( array( $this, 'create_entry_from_db_record' ), $records );
+    }
+
+    /**
+     * Initialize the data store.
+     *
+     * @codeCoverageIgnore
+     */
+    public function init() {
+        $table_maker = new ActionScheduler_LoggerSchema();
+        $table_maker->init();
+        $table_maker->register_tables();
+
+        parent::init();
+
+        add_action( 'action_scheduler_deleted_action', array( $this, 'clear_deleted_action_logs' ), 10, 1 );
+    }
+
+    /**
+     * Delete the action logs for an action.
+     *
+     * @param int $action_id Action ID.
+     */
+    public function clear_deleted_action_logs( $action_id ) {
+        /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
+        global $wpdb;
+        $wpdb->delete( $wpdb->actionscheduler_logs, array( 'action_id' => $action_id ), array( '%d' ) );
+    }
+
+    /**
+     * Bulk add cancel action log entries.
+     *
+     * @param array $action_ids List of action ID.
+     */
+    public function bulk_log_cancel_actions( $action_ids ) {
+        if ( empty( $action_ids ) ) {
+            return;
+        }
+
+        /** @var \wpdb $wpdb */ //phpcs:ignore Generic.Commenting.DocComment.MissingShort
+        global $wpdb;
+        $date     = as_get_datetime_object();
+        $date_gmt = $date->format( 'Y-m-d H:i:s' );
+        ActionScheduler_TimezoneHelper::set_local_timezone( $date );
+        $date_local = $date->format( 'Y-m-d H:i:s' );
+        $message    = __( 'action canceled', 'woocommerce' );
+        $format     = '(%d, ' . $wpdb->prepare( '%s, %s, %s', $message, $date_gmt, $date_local ) . ')';
+        $sql_query  = "INSERT {$wpdb->actionscheduler_logs} (action_id, message, log_date_gmt, log_date_local) VALUES ";
+        $value_rows = array();
+
+        foreach ( $action_ids as $action_id ) {
+            $value_rows[] = $wpdb->prepare( $format, $action_id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+        }
+        $sql_query .= implode( ',', $value_rows );
+
+        $wpdb->query( $sql_query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+    }
 }

plugins/woocommerce/packages/action-scheduler/classes/data-stores/ActionScheduler_wpPostStore_TaxonomyRegistrar.php

Indentation +16 added lines, -16 removed lines

@@ -5,22 +5,22 @@
  * @codeCoverageIgnore
  */
 class ActionScheduler_wpPostStore_TaxonomyRegistrar {
-	public function register() {
-		register_taxonomy( ActionScheduler_wpPostStore::GROUP_TAXONOMY, ActionScheduler_wpPostStore::POST_TYPE, $this->taxonomy_args() );
-	}
+    public function register() {
+        register_taxonomy( ActionScheduler_wpPostStore::GROUP_TAXONOMY, ActionScheduler_wpPostStore::POST_TYPE, $this->taxonomy_args() );
+    }
 
-	protected function taxonomy_args() {
-		$args = array(
-			'label' => __( 'Action Group', 'woocommerce' ),
-			'public' => false,
-			'hierarchical' => false,
-			'show_admin_column' => true,
-			'query_var' => false,
-			'rewrite' => false,
-		);
+    protected function taxonomy_args() {
+        $args = array(
+            'label' => __( 'Action Group', 'woocommerce' ),
+            'public' => false,
+            'hierarchical' => false,
+            'show_admin_column' => true,
+            'query_var' => false,
+            'rewrite' => false,
+        );
 
-		$args = apply_filters( 'action_scheduler_taxonomy_args', $args );
-		return $args;
-	}
+        $args = apply_filters( 'action_scheduler_taxonomy_args', $args );
+        return $args;
+    }
 }
- 
\ No newline at end of file
+    
\ No newline at end of file