AyeCode / invoicing

includes/libraries/action-scheduler/classes/ActionScheduler_ListTable.php

Indentation +602 added lines, -602 removed lines

@@ -6,606 +6,606 @@
  */
 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', 'action-scheduler' );
-
-		$this->bulk_actions = array(
-			'delete' => __( 'Delete', 'action-scheduler' ),
-		);
-
-		$this->columns = array(
-			'hook'        => __( 'Hook', 'action-scheduler' ),
-			'status'      => __( 'Status', 'action-scheduler' ),
-			'args'        => __( 'Arguments', 'action-scheduler' ),
-			'group'       => __( 'Group', 'action-scheduler' ),
-			'recurrence'  => __( 'Recurrence', 'action-scheduler' ),
-			'schedule'    => __( 'Scheduled Date', 'action-scheduler' ),
-			'log_entries' => __( 'Log', 'action-scheduler' ),
-		);
-
-		$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', 'action-scheduler' ) );
-			$this->sort_by[] = 'claim_id';
-		}
-
-		$this->row_actions = array(
-			'hook' => array(
-				'run' => array(
-					'name'  => __( 'Run', 'action-scheduler' ),
-					'desc'  => __( 'Process the action now as if it were run as part of a queue', 'action-scheduler' ),
-				),
-				'cancel' => array(
-					'name'  => __( 'Cancel', 'action-scheduler' ),
-					'desc'  => __( 'Cancel the action now to avoid it being run in future', 'action-scheduler' ),
-					'class' => 'cancel trash',
-				),
-			),
-		);
-
-		self::$time_periods = array(
-			array(
-				'seconds' => YEAR_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s year', '%s years', 'action-scheduler' ),
-			),
-			array(
-				'seconds' => MONTH_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s month', '%s months', 'action-scheduler' ),
-			),
-			array(
-				'seconds' => WEEK_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s week', '%s weeks', 'action-scheduler' ),
-			),
-			array(
-				'seconds' => DAY_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s day', '%s days', 'action-scheduler' ),
-			),
-			array(
-				'seconds' => HOUR_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s hour', '%s hours', 'action-scheduler' ),
-			),
-			array(
-				'seconds' => MINUTE_IN_SECONDS,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s minute', '%s minutes', 'action-scheduler' ),
-			),
-			array(
-				'seconds' => 1,
-				/* translators: %s: amount of time */
-				'names'   => _n_noop( '%s second', '%s seconds', 'action-scheduler' ),
-			),
-		);
-
-		parent::__construct( array(
-			'singular' => 'action-scheduler',
-			'plural'   => 'action-scheduler',
-			'ajax'     => false,
-		) );
-	}
-
-	/**
-	 * 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!', 'action-scheduler' );
-		}
-
-		$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, 'action-scheduler' ), $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', 'action-scheduler' ), self::human_interval( $recurrence ) );
-			} else {
-				return $recurrence;
-			}
-		}
-
-		return __( 'Non-repeating', 'action-scheduler' );
-	}
-
-	/**
-	 * 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'] ) ) {
-			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).' , 'action-scheduler' ),
-					);
-					$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,
-						'action-scheduler'
-					),
-					$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>', 'action-scheduler' ), esc_url( $in_progress_url ) );
-			} else {
-				/* translators: %d: seconds */
-				$async_request_message = sprintf( __( 'The next queue will begin processing in approximately %d seconds.', 'action-scheduler' ), $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', 'action-scheduler' ), $action_hook_html );
-						break;
-					case 'cancel' :
-						/* translators: %s: action HTML */
-						$action_message_html = sprintf( __( 'Successfully canceled action: %s', 'action-scheduler' ), $action_hook_html );
-						break;
-					default :
-						/* translators: %s: action HTML */
-						$action_message_html = sprintf( __( 'Successfully processed change for action: %s', 'action-scheduler' ), $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', 'action-scheduler' ), $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)', 'action-scheduler' ), self::human_interval( gmdate( 'U' ) - $next_timestamp ) );
-		} else {
-			/* translators: %s: date interval */
-			$schedule_display_string .= sprintf( __( ' (%s)', 'action-scheduler' ), 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->package . '_items_per_page', $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'      => $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', 'action-scheduler' );
-	}
+    /**
+     * 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', 'action-scheduler' );
+
+        $this->bulk_actions = array(
+            'delete' => __( 'Delete', 'action-scheduler' ),
+        );
+
+        $this->columns = array(
+            'hook'        => __( 'Hook', 'action-scheduler' ),
+            'status'      => __( 'Status', 'action-scheduler' ),
+            'args'        => __( 'Arguments', 'action-scheduler' ),
+            'group'       => __( 'Group', 'action-scheduler' ),
+            'recurrence'  => __( 'Recurrence', 'action-scheduler' ),
+            'schedule'    => __( 'Scheduled Date', 'action-scheduler' ),
+            'log_entries' => __( 'Log', 'action-scheduler' ),
+        );
+
+        $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', 'action-scheduler' ) );
+            $this->sort_by[] = 'claim_id';
+        }
+
+        $this->row_actions = array(
+            'hook' => array(
+                'run' => array(
+                    'name'  => __( 'Run', 'action-scheduler' ),
+                    'desc'  => __( 'Process the action now as if it were run as part of a queue', 'action-scheduler' ),
+                ),
+                'cancel' => array(
+                    'name'  => __( 'Cancel', 'action-scheduler' ),
+                    'desc'  => __( 'Cancel the action now to avoid it being run in future', 'action-scheduler' ),
+                    'class' => 'cancel trash',
+                ),
+            ),
+        );
+
+        self::$time_periods = array(
+            array(
+                'seconds' => YEAR_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s year', '%s years', 'action-scheduler' ),
+            ),
+            array(
+                'seconds' => MONTH_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s month', '%s months', 'action-scheduler' ),
+            ),
+            array(
+                'seconds' => WEEK_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s week', '%s weeks', 'action-scheduler' ),
+            ),
+            array(
+                'seconds' => DAY_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s day', '%s days', 'action-scheduler' ),
+            ),
+            array(
+                'seconds' => HOUR_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s hour', '%s hours', 'action-scheduler' ),
+            ),
+            array(
+                'seconds' => MINUTE_IN_SECONDS,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s minute', '%s minutes', 'action-scheduler' ),
+            ),
+            array(
+                'seconds' => 1,
+                /* translators: %s: amount of time */
+                'names'   => _n_noop( '%s second', '%s seconds', 'action-scheduler' ),
+            ),
+        );
+
+        parent::__construct( array(
+            'singular' => 'action-scheduler',
+            'plural'   => 'action-scheduler',
+            'ajax'     => false,
+        ) );
+    }
+
+    /**
+     * 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!', 'action-scheduler' );
+        }
+
+        $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, 'action-scheduler' ), $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', 'action-scheduler' ), self::human_interval( $recurrence ) );
+            } else {
+                return $recurrence;
+            }
+        }
+
+        return __( 'Non-repeating', 'action-scheduler' );
+    }
+
+    /**
+     * 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'] ) ) {
+            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).' , 'action-scheduler' ),
+                    );
+                    $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,
+                        'action-scheduler'
+                    ),
+                    $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>', 'action-scheduler' ), esc_url( $in_progress_url ) );
+            } else {
+                /* translators: %d: seconds */
+                $async_request_message = sprintf( __( 'The next queue will begin processing in approximately %d seconds.', 'action-scheduler' ), $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', 'action-scheduler' ), $action_hook_html );
+                        break;
+                    case 'cancel' :
+                        /* translators: %s: action HTML */
+                        $action_message_html = sprintf( __( 'Successfully canceled action: %s', 'action-scheduler' ), $action_hook_html );
+                        break;
+                    default :
+                        /* translators: %s: action HTML */
+                        $action_message_html = sprintf( __( 'Successfully processed change for action: %s', 'action-scheduler' ), $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', 'action-scheduler' ), $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)', 'action-scheduler' ), self::human_interval( gmdate( 'U' ) - $next_timestamp ) );
+        } else {
+            /* translators: %s: date interval */
+            $schedule_display_string .= sprintf( __( ' (%s)', 'action-scheduler' ), 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->package . '_items_per_page', $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'      => $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', 'action-scheduler' );
+    }
 }

includes/libraries/action-scheduler/classes/WP_CLI/ProgressBar.php

Indentation +99 added lines, -99 removed lines

@@ -17,103 +17,103 @@
  */
 class ProgressBar {
 
-	/** @var integer */
-	protected $total_ticks;
-
-	/** @var integer */
-	protected $count;
-
-	/** @var integer */
-	protected $interval;
-
-	/** @var string */
-	protected $message;
-
-	/** @var \cli\progress\Bar */
-	protected $progress_bar;
-
-	/**
-	 * ProgressBar constructor.
-	 *
-	 * @param string  $message    Text to display before the progress bar.
-	 * @param integer $count      Total number of ticks to be performed.
-	 * @param integer $interval   Optional. The interval in milliseconds between updates. Default 100.
- 	 *
-	 * @throws Exception When this is not run within WP CLI
-	 */
-	public function __construct( $message, $count, $interval = 100 ) {
-		if ( ! ( defined( 'WP_CLI' ) && WP_CLI ) ) {
-			/* translators: %s php class name */
-			throw new \Exception( sprintf( __( 'The %s class can only be run within WP CLI.', 'action-scheduler' ), __CLASS__ ) );
-		}
-
-		$this->total_ticks = 0;
-		$this->message     = $message;
-		$this->count       = $count;
-		$this->interval    = $interval;
-	}
-
-	/**
-	 * Increment the progress bar ticks.
-	 */
-	public function tick() {
-		if ( null === $this->progress_bar ) {
-			$this->setup_progress_bar();
-		}
-
-		$this->progress_bar->tick();
-		$this->total_ticks++;
-
-		do_action( 'action_scheduler/progress_tick', $this->total_ticks );
-	}
-
-	/**
-	 * Get the progress bar tick count.
-	 *
-	 * @return int
-	 */
-	public function current() {
-		return $this->progress_bar ? $this->progress_bar->current() : 0;
-	}
-
-	/**
-	 * Finish the current progress bar.
-	 */
-	public function finish() {
-		if ( null !== $this->progress_bar ) {
-			$this->progress_bar->finish();
-		}
-
-		$this->progress_bar = null;
-	}
-
-	/**
-	 * Set the message used when creating the progress bar.
-	 *
-	 * @param string $message The message to be used when the next progress bar is created.
-	 */
-	public function set_message( $message ) {
-		$this->message = $message;
-	}
-
-	/**
-	 * Set the count for a new progress bar.
-	 *
-	 * @param integer $count The total number of ticks expected to complete.
-	 */
-	public function set_count( $count ) {
-		$this->count = $count;
-		$this->finish();
-	}
-
-	/**
-	 * Set up the progress bar.
-	 */
-	protected function setup_progress_bar() {
-		$this->progress_bar = \WP_CLI\Utils\make_progress_bar(
-			$this->message,
-			$this->count,
-			$this->interval
-		);
-	}
+    /** @var integer */
+    protected $total_ticks;
+
+    /** @var integer */
+    protected $count;
+
+    /** @var integer */
+    protected $interval;
+
+    /** @var string */
+    protected $message;
+
+    /** @var \cli\progress\Bar */
+    protected $progress_bar;
+
+    /**
+     * ProgressBar constructor.
+     *
+     * @param string  $message    Text to display before the progress bar.
+     * @param integer $count      Total number of ticks to be performed.
+     * @param integer $interval   Optional. The interval in milliseconds between updates. Default 100.
+     *
+     * @throws Exception When this is not run within WP CLI
+     */
+    public function __construct( $message, $count, $interval = 100 ) {
+        if ( ! ( defined( 'WP_CLI' ) && WP_CLI ) ) {
+            /* translators: %s php class name */
+            throw new \Exception( sprintf( __( 'The %s class can only be run within WP CLI.', 'action-scheduler' ), __CLASS__ ) );
+        }
+
+        $this->total_ticks = 0;
+        $this->message     = $message;
+        $this->count       = $count;
+        $this->interval    = $interval;
+    }
+
+    /**
+     * Increment the progress bar ticks.
+     */
+    public function tick() {
+        if ( null === $this->progress_bar ) {
+            $this->setup_progress_bar();
+        }
+
+        $this->progress_bar->tick();
+        $this->total_ticks++;
+
+        do_action( 'action_scheduler/progress_tick', $this->total_ticks );
+    }
+
+    /**
+     * Get the progress bar tick count.
+     *
+     * @return int
+     */
+    public function current() {
+        return $this->progress_bar ? $this->progress_bar->current() : 0;
+    }
+
+    /**
+     * Finish the current progress bar.
+     */
+    public function finish() {
+        if ( null !== $this->progress_bar ) {
+            $this->progress_bar->finish();
+        }
+
+        $this->progress_bar = null;
+    }
+
+    /**
+     * Set the message used when creating the progress bar.
+     *
+     * @param string $message The message to be used when the next progress bar is created.
+     */
+    public function set_message( $message ) {
+        $this->message = $message;
+    }
+
+    /**
+     * Set the count for a new progress bar.
+     *
+     * @param integer $count The total number of ticks expected to complete.
+     */
+    public function set_count( $count ) {
+        $this->count = $count;
+        $this->finish();
+    }
+
+    /**
+     * Set up the progress bar.
+     */
+    protected function setup_progress_bar() {
+        $this->progress_bar = \WP_CLI\Utils\make_progress_bar(
+            $this->message,
+            $this->count,
+            $this->interval
+        );
+    }
 }

includes/libraries/action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php

Indentation +185 added lines, -185 removed lines

@@ -9,189 +9,189 @@
  */
 class ActionScheduler_WPCLI_QueueRunner extends ActionScheduler_Abstract_QueueRunner {
 
-	/** @var array */
-	protected $actions;
-
-	/** @var  ActionScheduler_ActionClaim */
-	protected $claim;
-
-	/** @var \cli\progress\Bar */
-	protected $progress_bar;
-
-	/**
-	 * ActionScheduler_WPCLI_QueueRunner constructor.
-	 *
-	 * @param ActionScheduler_Store             $store
-	 * @param ActionScheduler_FatalErrorMonitor $monitor
-	 * @param ActionScheduler_QueueCleaner      $cleaner
-	 *
-	 * @throws Exception When this is not run within WP CLI
-	 */
-	public function __construct( ActionScheduler_Store $store = null, ActionScheduler_FatalErrorMonitor $monitor = null, ActionScheduler_QueueCleaner $cleaner = null ) {
-		if ( ! ( defined( 'WP_CLI' ) && WP_CLI ) ) {
-			/* translators: %s php class name */
-			throw new Exception( sprintf( __( 'The %s class can only be run within WP CLI.', 'action-scheduler' ), __CLASS__ ) );
-		}
-
-		parent::__construct( $store, $monitor, $cleaner );
-	}
-
-	/**
-	 * Set up the Queue before processing.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param int    $batch_size The batch size to process.
-	 * @param array  $hooks      The hooks being used to filter the actions claimed in this batch.
-	 * @param string $group      The group of actions to claim with this batch.
-	 * @param bool   $force      Whether to force running even with too many concurrent processes.
-	 *
-	 * @return int The number of actions that will be run.
-	 * @throws \WP_CLI\ExitException When there are too many concurrent batches.
-	 */
-	public function setup( $batch_size, $hooks = array(), $group = '', $force = false ) {
-		$this->run_cleanup();
-		$this->add_hooks();
-
-		// Check to make sure there aren't too many concurrent processes running.
-		if ( $this->has_maximum_concurrent_batches() ) {
-			if ( $force ) {
-				WP_CLI::warning( __( 'There are too many concurrent batches, but the run is forced to continue.', 'action-scheduler' ) );
-			} else {
-				WP_CLI::error( __( 'There are too many concurrent batches.', 'action-scheduler' ) );
-			}
-		}
-
-		// Stake a claim and store it.
-		$this->claim = $this->store->stake_claim( $batch_size, null, $hooks, $group );
-		$this->monitor->attach( $this->claim );
-		$this->actions = $this->claim->get_actions();
-
-		return count( $this->actions );
-	}
-
-	/**
-	 * Add our hooks to the appropriate actions.
-	 *
-	 * @author Jeremy Pry
-	 */
-	protected function add_hooks() {
-		add_action( 'action_scheduler_before_execute', array( $this, 'before_execute' ) );
-		add_action( 'action_scheduler_after_execute', array( $this, 'after_execute' ), 10, 2 );
-		add_action( 'action_scheduler_failed_execution', array( $this, 'action_failed' ), 10, 2 );
-	}
-
-	/**
-	 * Set up the WP CLI progress bar.
-	 *
-	 * @author Jeremy Pry
-	 */
-	protected function setup_progress_bar() {
-		$count              = count( $this->actions );
-		$this->progress_bar = new ProgressBar(
-			/* translators: %d: amount of actions */
-			sprintf( _n( 'Running %d action', 'Running %d actions', $count, 'action-scheduler' ), number_format_i18n( $count ) ),
-			$count
-		);
-	}
-
-	/**
-	 * Process actions in the queue.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param string $context Optional runner context. Default 'WP CLI'.
-	 *
-	 * @return int The number of actions processed.
-	 */
-	public function run( $context = 'WP CLI' ) {
-		do_action( 'action_scheduler_before_process_queue' );
-		$this->setup_progress_bar();
-		foreach ( $this->actions as $action_id ) {
-			// Error if we lost the claim.
-			if ( ! in_array( $action_id, $this->store->find_actions_by_claim_id( $this->claim->get_id() ) ) ) {
-				WP_CLI::warning( __( 'The claim has been lost. Aborting current batch.', 'action-scheduler' ) );
-				break;
-			}
-
-			$this->process_action( $action_id, $context );
-			$this->progress_bar->tick();
-		}
-
-		$completed = $this->progress_bar->current();
-		$this->progress_bar->finish();
-		$this->store->release_claim( $this->claim );
-		do_action( 'action_scheduler_after_process_queue' );
-
-		return $completed;
-	}
-
-	/**
-	 * Handle WP CLI message when the action is starting.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param $action_id
-	 */
-	public function before_execute( $action_id ) {
-		/* translators: %s refers to the action ID */
-		WP_CLI::log( sprintf( __( 'Started processing action %s', 'action-scheduler' ), $action_id ) );
-	}
-
-	/**
-	 * Handle WP CLI message when the action has completed.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param int $action_id
-	 * @param null|ActionScheduler_Action $action The instance of the action. Default to null for backward compatibility.
-	 */
-	public function after_execute( $action_id, $action = null ) {
-		// backward compatibility
-		if ( null === $action ) {
-			$action = $this->store->fetch_action( $action_id );
-		}
-		/* translators: 1: action ID 2: hook name */
-		WP_CLI::log( sprintf( __( 'Completed processing action %1$s with hook: %2$s', 'action-scheduler' ), $action_id, $action->get_hook() ) );
-	}
-
-	/**
-	 * Handle WP CLI message when the action has failed.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param int       $action_id
-	 * @param Exception $exception
-	 * @throws \WP_CLI\ExitException With failure message.
-	 */
-	public function action_failed( $action_id, $exception ) {
-		WP_CLI::error(
-			/* translators: 1: action ID 2: exception message */
-			sprintf( __( 'Error processing action %1$s: %2$s', 'action-scheduler' ), $action_id, $exception->getMessage() ),
-			false
-		);
-	}
-
-	/**
-	 * Sleep and help avoid hitting memory limit
-	 *
-	 * @param int $sleep_time Amount of seconds to sleep
-	 * @deprecated 3.0.0
-	 */
-	protected function stop_the_insanity( $sleep_time = 0 ) {
-		_deprecated_function( 'ActionScheduler_WPCLI_QueueRunner::stop_the_insanity', '3.0.0', 'ActionScheduler_DataController::free_memory' );
-
-		ActionScheduler_DataController::free_memory();
-	}
-
-	/**
-	 * Maybe trigger the stop_the_insanity() method to free up memory.
-	 */
-	protected function maybe_stop_the_insanity() {
-		// The value returned by progress_bar->current() might be padded. Remove padding, and convert to int.
-		$current_iteration = intval( trim( $this->progress_bar->current() ) );
-		if ( 0 === $current_iteration % 50 ) {
-			$this->stop_the_insanity();
-		}
-	}
+    /** @var array */
+    protected $actions;
+
+    /** @var  ActionScheduler_ActionClaim */
+    protected $claim;
+
+    /** @var \cli\progress\Bar */
+    protected $progress_bar;
+
+    /**
+     * ActionScheduler_WPCLI_QueueRunner constructor.
+     *
+     * @param ActionScheduler_Store             $store
+     * @param ActionScheduler_FatalErrorMonitor $monitor
+     * @param ActionScheduler_QueueCleaner      $cleaner
+     *
+     * @throws Exception When this is not run within WP CLI
+     */
+    public function __construct( ActionScheduler_Store $store = null, ActionScheduler_FatalErrorMonitor $monitor = null, ActionScheduler_QueueCleaner $cleaner = null ) {
+        if ( ! ( defined( 'WP_CLI' ) && WP_CLI ) ) {
+            /* translators: %s php class name */
+            throw new Exception( sprintf( __( 'The %s class can only be run within WP CLI.', 'action-scheduler' ), __CLASS__ ) );
+        }
+
+        parent::__construct( $store, $monitor, $cleaner );
+    }
+
+    /**
+     * Set up the Queue before processing.
+     *
+     * @author Jeremy Pry
+     *
+     * @param int    $batch_size The batch size to process.
+     * @param array  $hooks      The hooks being used to filter the actions claimed in this batch.
+     * @param string $group      The group of actions to claim with this batch.
+     * @param bool   $force      Whether to force running even with too many concurrent processes.
+     *
+     * @return int The number of actions that will be run.
+     * @throws \WP_CLI\ExitException When there are too many concurrent batches.
+     */
+    public function setup( $batch_size, $hooks = array(), $group = '', $force = false ) {
+        $this->run_cleanup();
+        $this->add_hooks();
+
+        // Check to make sure there aren't too many concurrent processes running.
+        if ( $this->has_maximum_concurrent_batches() ) {
+            if ( $force ) {
+                WP_CLI::warning( __( 'There are too many concurrent batches, but the run is forced to continue.', 'action-scheduler' ) );
+            } else {
+                WP_CLI::error( __( 'There are too many concurrent batches.', 'action-scheduler' ) );
+            }
+        }
+
+        // Stake a claim and store it.
+        $this->claim = $this->store->stake_claim( $batch_size, null, $hooks, $group );
+        $this->monitor->attach( $this->claim );
+        $this->actions = $this->claim->get_actions();
+
+        return count( $this->actions );
+    }
+
+    /**
+     * Add our hooks to the appropriate actions.
+     *
+     * @author Jeremy Pry
+     */
+    protected function add_hooks() {
+        add_action( 'action_scheduler_before_execute', array( $this, 'before_execute' ) );
+        add_action( 'action_scheduler_after_execute', array( $this, 'after_execute' ), 10, 2 );
+        add_action( 'action_scheduler_failed_execution', array( $this, 'action_failed' ), 10, 2 );
+    }
+
+    /**
+     * Set up the WP CLI progress bar.
+     *
+     * @author Jeremy Pry
+     */
+    protected function setup_progress_bar() {
+        $count              = count( $this->actions );
+        $this->progress_bar = new ProgressBar(
+            /* translators: %d: amount of actions */
+            sprintf( _n( 'Running %d action', 'Running %d actions', $count, 'action-scheduler' ), number_format_i18n( $count ) ),
+            $count
+        );
+    }
+
+    /**
+     * Process actions in the queue.
+     *
+     * @author Jeremy Pry
+     *
+     * @param string $context Optional runner context. Default 'WP CLI'.
+     *
+     * @return int The number of actions processed.
+     */
+    public function run( $context = 'WP CLI' ) {
+        do_action( 'action_scheduler_before_process_queue' );
+        $this->setup_progress_bar();
+        foreach ( $this->actions as $action_id ) {
+            // Error if we lost the claim.
+            if ( ! in_array( $action_id, $this->store->find_actions_by_claim_id( $this->claim->get_id() ) ) ) {
+                WP_CLI::warning( __( 'The claim has been lost. Aborting current batch.', 'action-scheduler' ) );
+                break;
+            }
+
+            $this->process_action( $action_id, $context );
+            $this->progress_bar->tick();
+        }
+
+        $completed = $this->progress_bar->current();
+        $this->progress_bar->finish();
+        $this->store->release_claim( $this->claim );
+        do_action( 'action_scheduler_after_process_queue' );
+
+        return $completed;
+    }
+
+    /**
+     * Handle WP CLI message when the action is starting.
+     *
+     * @author Jeremy Pry
+     *
+     * @param $action_id
+     */
+    public function before_execute( $action_id ) {
+        /* translators: %s refers to the action ID */
+        WP_CLI::log( sprintf( __( 'Started processing action %s', 'action-scheduler' ), $action_id ) );
+    }
+
+    /**
+     * Handle WP CLI message when the action has completed.
+     *
+     * @author Jeremy Pry
+     *
+     * @param int $action_id
+     * @param null|ActionScheduler_Action $action The instance of the action. Default to null for backward compatibility.
+     */
+    public function after_execute( $action_id, $action = null ) {
+        // backward compatibility
+        if ( null === $action ) {
+            $action = $this->store->fetch_action( $action_id );
+        }
+        /* translators: 1: action ID 2: hook name */
+        WP_CLI::log( sprintf( __( 'Completed processing action %1$s with hook: %2$s', 'action-scheduler' ), $action_id, $action->get_hook() ) );
+    }
+
+    /**
+     * Handle WP CLI message when the action has failed.
+     *
+     * @author Jeremy Pry
+     *
+     * @param int       $action_id
+     * @param Exception $exception
+     * @throws \WP_CLI\ExitException With failure message.
+     */
+    public function action_failed( $action_id, $exception ) {
+        WP_CLI::error(
+            /* translators: 1: action ID 2: exception message */
+            sprintf( __( 'Error processing action %1$s: %2$s', 'action-scheduler' ), $action_id, $exception->getMessage() ),
+            false
+        );
+    }
+
+    /**
+     * Sleep and help avoid hitting memory limit
+     *
+     * @param int $sleep_time Amount of seconds to sleep
+     * @deprecated 3.0.0
+     */
+    protected function stop_the_insanity( $sleep_time = 0 ) {
+        _deprecated_function( 'ActionScheduler_WPCLI_QueueRunner::stop_the_insanity', '3.0.0', 'ActionScheduler_DataController::free_memory' );
+
+        ActionScheduler_DataController::free_memory();
+    }
+
+    /**
+     * Maybe trigger the stop_the_insanity() method to free up memory.
+     */
+    protected function maybe_stop_the_insanity() {
+        // The value returned by progress_bar->current() might be padded. Remove padding, and convert to int.
+        $current_iteration = intval( trim( $this->progress_bar->current() ) );
+        if ( 0 === $current_iteration % 50 ) {
+            $this->stop_the_insanity();
+        }
+    }
 }

includes/libraries/action-scheduler/classes/WP_CLI/Migration_Command.php

Indentation +124 added lines, -124 removed lines

@@ -21,128 +21,128 @@
  */
 class Migration_Command extends WP_CLI_Command {
 
-	/** @var int */
-	private $total_processed = 0;
-
-	/**
-	 * Register the command with WP-CLI
-	 */
-	public function register() {
-		if ( ! defined( 'WP_CLI' ) || ! WP_CLI ) {
-			return;
-		}
-
-		WP_CLI::add_command( 'action-scheduler migrate', [ $this, 'migrate' ], [
-			'shortdesc' => 'Migrates actions to the DB tables store',
-			'synopsis'  => [
-				[
-					'type'        => 'assoc',
-					'name'        => 'batch-size',
-					'optional'    => true,
-					'default'     => 100,
-					'description' => 'The number of actions to process in each batch',
-				],
-				[
-					'type'        => 'assoc',
-					'name'        => 'free-memory-on',
-					'optional'    => true,
-					'default'     => 50,
-					'description' => 'The number of actions to process between freeing memory. 0 disables freeing memory',
-				],
-				[
-					'type'        => 'assoc',
-					'name'        => 'pause',
-					'optional'    => true,
-					'default'     => 0,
-					'description' => 'The number of seconds to pause when freeing memory',
-				],
-				[
-					'type'        => 'flag',
-					'name'        => 'dry-run',
-					'optional'    => true,
-					'description' => 'Reports on the actions that would have been migrated, but does not change any data',
-				],
-			],
-		] );
-	}
-
-	/**
-	 * Process the data migration.
-	 *
-	 * @param array $positional_args Required for WP CLI. Not used in migration.
-	 * @param array $assoc_args Optional arguments.
-	 *
-	 * @return void
-	 */
-	public function migrate( $positional_args, $assoc_args ) {
-		$this->init_logging();
-
-		$config = $this->get_migration_config( $assoc_args );
-		$runner = new Runner( $config );
-		$runner->init_destination();
-
-		$batch_size = isset( $assoc_args[ 'batch-size' ] ) ? (int) $assoc_args[ 'batch-size' ] : 100;
-		$free_on    = isset( $assoc_args[ 'free-memory-on' ] ) ? (int) $assoc_args[ 'free-memory-on' ] : 50;
-		$sleep      = isset( $assoc_args[ 'pause' ] ) ? (int) $assoc_args[ 'pause' ] : 0;
-		\ActionScheduler_DataController::set_free_ticks( $free_on );
-		\ActionScheduler_DataController::set_sleep_time( $sleep );
-
-		do {
-			$actions_processed     = $runner->run( $batch_size );
-			$this->total_processed += $actions_processed;
-		} while ( $actions_processed > 0 );
-
-		if ( ! $config->get_dry_run() ) {
-			// let the scheduler know that there's nothing left to do
-			$scheduler = new Scheduler();
-			$scheduler->mark_complete();
-		}
-
-		WP_CLI::success( sprintf( '%s complete. %d actions processed.', $config->get_dry_run() ? 'Dry run' : 'Migration', $this->total_processed ) );
-	}
-
-	/**
-	 * Build the config object used to create the Runner
-	 *
-	 * @param array $args Optional arguments.
-	 *
-	 * @return ActionScheduler\Migration\Config
-	 */
-	private function get_migration_config( $args ) {
-		$args = wp_parse_args( $args, [
-			'dry-run' => false,
-		] );
-
-		$config = Controller::instance()->get_migration_config_object();
-		$config->set_dry_run( ! empty( $args[ 'dry-run' ] ) );
-
-		return $config;
-	}
-
-	/**
-	 * Hook command line logging into migration actions.
-	 */
-	private function init_logging() {
-		add_action( 'action_scheduler/migrate_action_dry_run', function ( $action_id ) {
-			WP_CLI::debug( sprintf( 'Dry-run: migrated action %d', $action_id ) );
-		}, 10, 1 );
-		add_action( 'action_scheduler/no_action_to_migrate', function ( $action_id ) {
-			WP_CLI::debug( sprintf( 'No action found to migrate for ID %d', $action_id ) );
-		}, 10, 1 );
-		add_action( 'action_scheduler/migrate_action_failed', function ( $action_id ) {
-			WP_CLI::warning( sprintf( 'Failed migrating action with ID %d', $action_id ) );
-		}, 10, 1 );
-		add_action( 'action_scheduler/migrate_action_incomplete', function ( $source_id, $destination_id ) {
-			WP_CLI::warning( sprintf( 'Unable to remove source action with ID %d after migrating to new ID %d', $source_id, $destination_id ) );
-		}, 10, 2 );
-		add_action( 'action_scheduler/migrated_action', function ( $source_id, $destination_id ) {
-			WP_CLI::debug( sprintf( 'Migrated source action with ID %d to new store with ID %d', $source_id, $destination_id ) );
-		}, 10, 2 );
-		add_action( 'action_scheduler/migration_batch_starting', function ( $batch ) {
-			WP_CLI::debug( 'Beginning migration of batch: ' . print_r( $batch, true ) );
-		}, 10, 1 );
-		add_action( 'action_scheduler/migration_batch_complete', function ( $batch ) {
-			WP_CLI::log( sprintf( 'Completed migration of %d actions', count( $batch ) ) );
-		}, 10, 1 );
-	}
+    /** @var int */
+    private $total_processed = 0;
+
+    /**
+     * Register the command with WP-CLI
+     */
+    public function register() {
+        if ( ! defined( 'WP_CLI' ) || ! WP_CLI ) {
+            return;
+        }
+
+        WP_CLI::add_command( 'action-scheduler migrate', [ $this, 'migrate' ], [
+            'shortdesc' => 'Migrates actions to the DB tables store',
+            'synopsis'  => [
+                [
+                    'type'        => 'assoc',
+                    'name'        => 'batch-size',
+                    'optional'    => true,
+                    'default'     => 100,
+                    'description' => 'The number of actions to process in each batch',
+                ],
+                [
+                    'type'        => 'assoc',
+                    'name'        => 'free-memory-on',
+                    'optional'    => true,
+                    'default'     => 50,
+                    'description' => 'The number of actions to process between freeing memory. 0 disables freeing memory',
+                ],
+                [
+                    'type'        => 'assoc',
+                    'name'        => 'pause',
+                    'optional'    => true,
+                    'default'     => 0,
+                    'description' => 'The number of seconds to pause when freeing memory',
+                ],
+                [
+                    'type'        => 'flag',
+                    'name'        => 'dry-run',
+                    'optional'    => true,
+                    'description' => 'Reports on the actions that would have been migrated, but does not change any data',
+                ],
+            ],
+        ] );
+    }
+
+    /**
+     * Process the data migration.
+     *
+     * @param array $positional_args Required for WP CLI. Not used in migration.
+     * @param array $assoc_args Optional arguments.
+     *
+     * @return void
+     */
+    public function migrate( $positional_args, $assoc_args ) {
+        $this->init_logging();
+
+        $config = $this->get_migration_config( $assoc_args );
+        $runner = new Runner( $config );
+        $runner->init_destination();
+
+        $batch_size = isset( $assoc_args[ 'batch-size' ] ) ? (int) $assoc_args[ 'batch-size' ] : 100;
+        $free_on    = isset( $assoc_args[ 'free-memory-on' ] ) ? (int) $assoc_args[ 'free-memory-on' ] : 50;
+        $sleep      = isset( $assoc_args[ 'pause' ] ) ? (int) $assoc_args[ 'pause' ] : 0;
+        \ActionScheduler_DataController::set_free_ticks( $free_on );
+        \ActionScheduler_DataController::set_sleep_time( $sleep );
+
+        do {
+            $actions_processed     = $runner->run( $batch_size );
+            $this->total_processed += $actions_processed;
+        } while ( $actions_processed > 0 );
+
+        if ( ! $config->get_dry_run() ) {
+            // let the scheduler know that there's nothing left to do
+            $scheduler = new Scheduler();
+            $scheduler->mark_complete();
+        }
+
+        WP_CLI::success( sprintf( '%s complete. %d actions processed.', $config->get_dry_run() ? 'Dry run' : 'Migration', $this->total_processed ) );
+    }
+
+    /**
+     * Build the config object used to create the Runner
+     *
+     * @param array $args Optional arguments.
+     *
+     * @return ActionScheduler\Migration\Config
+     */
+    private function get_migration_config( $args ) {
+        $args = wp_parse_args( $args, [
+            'dry-run' => false,
+        ] );
+
+        $config = Controller::instance()->get_migration_config_object();
+        $config->set_dry_run( ! empty( $args[ 'dry-run' ] ) );
+
+        return $config;
+    }
+
+    /**
+     * Hook command line logging into migration actions.
+     */
+    private function init_logging() {
+        add_action( 'action_scheduler/migrate_action_dry_run', function ( $action_id ) {
+            WP_CLI::debug( sprintf( 'Dry-run: migrated action %d', $action_id ) );
+        }, 10, 1 );
+        add_action( 'action_scheduler/no_action_to_migrate', function ( $action_id ) {
+            WP_CLI::debug( sprintf( 'No action found to migrate for ID %d', $action_id ) );
+        }, 10, 1 );
+        add_action( 'action_scheduler/migrate_action_failed', function ( $action_id ) {
+            WP_CLI::warning( sprintf( 'Failed migrating action with ID %d', $action_id ) );
+        }, 10, 1 );
+        add_action( 'action_scheduler/migrate_action_incomplete', function ( $source_id, $destination_id ) {
+            WP_CLI::warning( sprintf( 'Unable to remove source action with ID %d after migrating to new ID %d', $source_id, $destination_id ) );
+        }, 10, 2 );
+        add_action( 'action_scheduler/migrated_action', function ( $source_id, $destination_id ) {
+            WP_CLI::debug( sprintf( 'Migrated source action with ID %d to new store with ID %d', $source_id, $destination_id ) );
+        }, 10, 2 );
+        add_action( 'action_scheduler/migration_batch_starting', function ( $batch ) {
+            WP_CLI::debug( 'Beginning migration of batch: ' . print_r( $batch, true ) );
+        }, 10, 1 );
+        add_action( 'action_scheduler/migration_batch_complete', function ( $batch ) {
+            WP_CLI::log( sprintf( 'Completed migration of %d actions', count( $batch ) ) );
+        }, 10, 1 );
+    }
 }

includes/libraries/action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php

Indentation +138 added lines, -138 removed lines

@@ -5,154 +5,154 @@
  */
 class ActionScheduler_WPCLI_Scheduler_command extends WP_CLI_Command {
 
-	/**
-	 * Run the Action Scheduler
-	 *
-	 * ## OPTIONS
-	 *
-	 * [--batch-size=<size>]
-	 * : The maximum number of actions to run. Defaults to 100.
-	 *
-	 * [--batches=<size>]
-	 * : Limit execution to a number of batches. Defaults to 0, meaning batches will continue being executed until all actions are complete.
-	 *
-	 * [--cleanup-batch-size=<size>]
-	 * : The maximum number of actions to clean up. Defaults to the value of --batch-size.
-	 *
-	 * [--hooks=<hooks>]
-	 * : Only run actions with the specified hook. Omitting this option runs actions with any hook. Define multiple hooks as a comma separated string (without spaces), e.g. `--hooks=hook_one,hook_two,hook_three`
-	 *
-	 * [--group=<group>]
-	 * : Only run actions from the specified group. Omitting this option runs actions from all groups.
-	 *
-	 * [--free-memory-on=<count>]
-	 * : The number of actions to process between freeing memory. 0 disables freeing memory. Default 50.
-	 *
-	 * [--pause=<seconds>]
-	 * : The number of seconds to pause when freeing memory. Default no pause.
-	 *
-	 * [--force]
-	 * : Whether to force execution despite the maximum number of concurrent processes being exceeded.
-	 *
-	 * @param array $args Positional arguments.
-	 * @param array $assoc_args Keyed arguments.
-	 * @throws \WP_CLI\ExitException When an error occurs.
-	 *
-	 * @subcommand run
-	 */
-	public function run( $args, $assoc_args ) {
-		// Handle passed arguments.
-		$batch   = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'batch-size', 100 ) );
-		$batches = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'batches', 0 ) );
-		$clean   = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'cleanup-batch-size', $batch ) );
-		$hooks   = explode( ',', WP_CLI\Utils\get_flag_value( $assoc_args, 'hooks', '' ) );
-		$hooks   = array_filter( array_map( 'trim', $hooks ) );
-		$group   = \WP_CLI\Utils\get_flag_value( $assoc_args, 'group', '' );
-		$free_on = \WP_CLI\Utils\get_flag_value( $assoc_args, 'free-memory-on', '' );
-		$sleep   = \WP_CLI\Utils\get_flag_value( $assoc_args, 'pause', '' );
-		$force   = \WP_CLI\Utils\get_flag_value( $assoc_args, 'force', false );
+    /**
+     * Run the Action Scheduler
+     *
+     * ## OPTIONS
+     *
+     * [--batch-size=<size>]
+     * : The maximum number of actions to run. Defaults to 100.
+     *
+     * [--batches=<size>]
+     * : Limit execution to a number of batches. Defaults to 0, meaning batches will continue being executed until all actions are complete.
+     *
+     * [--cleanup-batch-size=<size>]
+     * : The maximum number of actions to clean up. Defaults to the value of --batch-size.
+     *
+     * [--hooks=<hooks>]
+     * : Only run actions with the specified hook. Omitting this option runs actions with any hook. Define multiple hooks as a comma separated string (without spaces), e.g. `--hooks=hook_one,hook_two,hook_three`
+     *
+     * [--group=<group>]
+     * : Only run actions from the specified group. Omitting this option runs actions from all groups.
+     *
+     * [--free-memory-on=<count>]
+     * : The number of actions to process between freeing memory. 0 disables freeing memory. Default 50.
+     *
+     * [--pause=<seconds>]
+     * : The number of seconds to pause when freeing memory. Default no pause.
+     *
+     * [--force]
+     * : Whether to force execution despite the maximum number of concurrent processes being exceeded.
+     *
+     * @param array $args Positional arguments.
+     * @param array $assoc_args Keyed arguments.
+     * @throws \WP_CLI\ExitException When an error occurs.
+     *
+     * @subcommand run
+     */
+    public function run( $args, $assoc_args ) {
+        // Handle passed arguments.
+        $batch   = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'batch-size', 100 ) );
+        $batches = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'batches', 0 ) );
+        $clean   = absint( \WP_CLI\Utils\get_flag_value( $assoc_args, 'cleanup-batch-size', $batch ) );
+        $hooks   = explode( ',', WP_CLI\Utils\get_flag_value( $assoc_args, 'hooks', '' ) );
+        $hooks   = array_filter( array_map( 'trim', $hooks ) );
+        $group   = \WP_CLI\Utils\get_flag_value( $assoc_args, 'group', '' );
+        $free_on = \WP_CLI\Utils\get_flag_value( $assoc_args, 'free-memory-on', '' );
+        $sleep   = \WP_CLI\Utils\get_flag_value( $assoc_args, 'pause', '' );
+        $force   = \WP_CLI\Utils\get_flag_value( $assoc_args, 'force', false );
 
-		ActionScheduler_DataController::set_free_ticks( $free_on );
-		ActionScheduler_DataController::set_sleep_time( $sleep );
+        ActionScheduler_DataController::set_free_ticks( $free_on );
+        ActionScheduler_DataController::set_sleep_time( $sleep );
 
-		$batches_completed = 0;
-		$actions_completed = 0;
-		$unlimited         = $batches === 0;
+        $batches_completed = 0;
+        $actions_completed = 0;
+        $unlimited         = $batches === 0;
 
-		try {
-			// Custom queue cleaner instance.
-			$cleaner = new ActionScheduler_QueueCleaner( null, $clean );
+        try {
+            // Custom queue cleaner instance.
+            $cleaner = new ActionScheduler_QueueCleaner( null, $clean );
 
-			// Get the queue runner instance
-			$runner = new ActionScheduler_WPCLI_QueueRunner( null, null, $cleaner );
+            // Get the queue runner instance
+            $runner = new ActionScheduler_WPCLI_QueueRunner( null, null, $cleaner );
 
-			// Determine how many tasks will be run in the first batch.
-			$total = $runner->setup( $batch, $hooks, $group, $force );
+            // Determine how many tasks will be run in the first batch.
+            $total = $runner->setup( $batch, $hooks, $group, $force );
 
-			// Run actions for as long as possible.
-			while ( $total > 0 ) {
-				$this->print_total_actions( $total );
-				$actions_completed += $runner->run();
-				$batches_completed++;
+            // Run actions for as long as possible.
+            while ( $total > 0 ) {
+                $this->print_total_actions( $total );
+                $actions_completed += $runner->run();
+                $batches_completed++;
 
-				// Maybe set up tasks for the next batch.
-				$total = ( $unlimited || $batches_completed < $batches ) ? $runner->setup( $batch, $hooks, $group, $force ) : 0;
-			}
-		} catch ( Exception $e ) {
-			$this->print_error( $e );
-		}
+                // Maybe set up tasks for the next batch.
+                $total = ( $unlimited || $batches_completed < $batches ) ? $runner->setup( $batch, $hooks, $group, $force ) : 0;
+            }
+        } catch ( Exception $e ) {
+            $this->print_error( $e );
+        }
 
-		$this->print_total_batches( $batches_completed );
-		$this->print_success( $actions_completed );
-	}
+        $this->print_total_batches( $batches_completed );
+        $this->print_success( $actions_completed );
+    }
 
-	/**
-	 * Print WP CLI message about how many actions are about to be processed.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param int $total
-	 */
-	protected function print_total_actions( $total ) {
-		WP_CLI::log(
-			sprintf(
-				/* translators: %d refers to how many scheduled taks were found to run */
-				_n( 'Found %d scheduled task', 'Found %d scheduled tasks', $total, 'action-scheduler' ),
-				number_format_i18n( $total )
-			)
-		);
-	}
+    /**
+     * Print WP CLI message about how many actions are about to be processed.
+     *
+     * @author Jeremy Pry
+     *
+     * @param int $total
+     */
+    protected function print_total_actions( $total ) {
+        WP_CLI::log(
+            sprintf(
+                /* translators: %d refers to how many scheduled taks were found to run */
+                _n( 'Found %d scheduled task', 'Found %d scheduled tasks', $total, 'action-scheduler' ),
+                number_format_i18n( $total )
+            )
+        );
+    }
 
-	/**
-	 * Print WP CLI message about how many batches of actions were processed.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param int $batches_completed
-	 */
-	protected function print_total_batches( $batches_completed ) {
-		WP_CLI::log(
-			sprintf(
-				/* translators: %d refers to the total number of batches executed */
-				_n( '%d batch executed.', '%d batches executed.', $batches_completed, 'action-scheduler' ),
-				number_format_i18n( $batches_completed )
-			)
-		);
-	}
+    /**
+     * Print WP CLI message about how many batches of actions were processed.
+     *
+     * @author Jeremy Pry
+     *
+     * @param int $batches_completed
+     */
+    protected function print_total_batches( $batches_completed ) {
+        WP_CLI::log(
+            sprintf(
+                /* translators: %d refers to the total number of batches executed */
+                _n( '%d batch executed.', '%d batches executed.', $batches_completed, 'action-scheduler' ),
+                number_format_i18n( $batches_completed )
+            )
+        );
+    }
 
-	/**
-	 * Convert an exception into a WP CLI error.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param Exception $e The error object.
-	 *
-	 * @throws \WP_CLI\ExitException
-	 */
-	protected function print_error( Exception $e ) {
-		WP_CLI::error(
-			sprintf(
-				/* translators: %s refers to the exception error message */
-				__( 'There was an error running the action scheduler: %s', 'action-scheduler' ),
-				$e->getMessage()
-			)
-		);
-	}
+    /**
+     * Convert an exception into a WP CLI error.
+     *
+     * @author Jeremy Pry
+     *
+     * @param Exception $e The error object.
+     *
+     * @throws \WP_CLI\ExitException
+     */
+    protected function print_error( Exception $e ) {
+        WP_CLI::error(
+            sprintf(
+                /* translators: %s refers to the exception error message */
+                __( 'There was an error running the action scheduler: %s', 'action-scheduler' ),
+                $e->getMessage()
+            )
+        );
+    }
 
-	/**
-	 * Print a success message with the number of completed actions.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param int $actions_completed
-	 */
-	protected function print_success( $actions_completed ) {
-		WP_CLI::success(
-			sprintf(
-				/* translators: %d refers to the total number of taskes completed */
-				_n( '%d scheduled task completed.', '%d scheduled tasks completed.', $actions_completed, 'action-scheduler' ),
-				number_format_i18n( $actions_completed )
-			)
-		);
-	}
+    /**
+     * Print a success message with the number of completed actions.
+     *
+     * @author Jeremy Pry
+     *
+     * @param int $actions_completed
+     */
+    protected function print_success( $actions_completed ) {
+        WP_CLI::success(
+            sprintf(
+                /* translators: %d refers to the total number of taskes completed */
+                _n( '%d scheduled task completed.', '%d scheduled tasks completed.', $actions_completed, 'action-scheduler' ),
+                number_format_i18n( $actions_completed )
+            )
+        );
+    }
 }

includes/libraries/action-scheduler/classes/ActionScheduler_DateTime.php

Indentation +60 added lines, -60 removed lines

@@ -7,70 +7,70 @@
  */
 class ActionScheduler_DateTime extends DateTime {
 
-	/**
-	 * UTC offset.
-	 *
-	 * Only used when a timezone is not set. When a timezone string is
-	 * used, this will be set to 0.
-	 *
-	 * @var int
-	 */
-	protected $utcOffset = 0;
+    /**
+     * UTC offset.
+     *
+     * Only used when a timezone is not set. When a timezone string is
+     * used, this will be set to 0.
+     *
+     * @var int
+     */
+    protected $utcOffset = 0;
 
-	/**
-	 * Get the unix timestamp of the current object.
-	 *
-	 * Missing in PHP 5.2 so just here so it can be supported consistently.
-	 *
-	 * @return int
-	 */
-	public function getTimestamp() {
-		return method_exists( 'DateTime', 'getTimestamp' ) ? parent::getTimestamp() : $this->format( 'U' );
-	}
+    /**
+     * Get the unix timestamp of the current object.
+     *
+     * Missing in PHP 5.2 so just here so it can be supported consistently.
+     *
+     * @return int
+     */
+    public function getTimestamp() {
+        return method_exists( 'DateTime', 'getTimestamp' ) ? parent::getTimestamp() : $this->format( 'U' );
+    }
 
-	/**
-	 * Set the UTC offset.
-	 *
-	 * This represents a fixed offset instead of a timezone setting.
-	 *
-	 * @param $offset
-	 */
-	public function setUtcOffset( $offset ) {
-		$this->utcOffset = intval( $offset );
-	}
+    /**
+     * Set the UTC offset.
+     *
+     * This represents a fixed offset instead of a timezone setting.
+     *
+     * @param $offset
+     */
+    public function setUtcOffset( $offset ) {
+        $this->utcOffset = intval( $offset );
+    }
 
-	/**
-	 * Returns the timezone offset.
-	 *
-	 * @return int
-	 * @link http://php.net/manual/en/datetime.getoffset.php
-	 */
-	public function getOffset() {
-		return $this->utcOffset ? $this->utcOffset : parent::getOffset();
-	}
+    /**
+     * Returns the timezone offset.
+     *
+     * @return int
+     * @link http://php.net/manual/en/datetime.getoffset.php
+     */
+    public function getOffset() {
+        return $this->utcOffset ? $this->utcOffset : parent::getOffset();
+    }
 
-	/**
-	 * Set the TimeZone associated with the DateTime
-	 *
-	 * @param DateTimeZone $timezone
-	 *
-	 * @return static
-	 * @link http://php.net/manual/en/datetime.settimezone.php
-	 */
-	public function setTimezone( $timezone ) {
-		$this->utcOffset = 0;
-		parent::setTimezone( $timezone );
+    /**
+     * Set the TimeZone associated with the DateTime
+     *
+     * @param DateTimeZone $timezone
+     *
+     * @return static
+     * @link http://php.net/manual/en/datetime.settimezone.php
+     */
+    public function setTimezone( $timezone ) {
+        $this->utcOffset = 0;
+        parent::setTimezone( $timezone );
 
-		return $this;
-	}
+        return $this;
+    }
 
-	/**
-	 * Get the timestamp with the WordPress timezone offset added or subtracted.
-	 *
-	 * @since  3.0.0
-	 * @return int
-	 */
-	public function getOffsetTimestamp() {
-		return $this->getTimestamp() + $this->getOffset();
-	}
+    /**
+     * Get the timestamp with the WordPress timezone offset added or subtracted.
+     *
+     * @since  3.0.0
+     * @return int
+     */
+    public function getOffsetTimestamp() {
+        return $this->getTimestamp() + $this->getOffset();
+    }
 }

includes/libraries/action-scheduler/classes/ActionScheduler_LogEntry.php

Indentation +44 added lines, -44 removed lines

@@ -5,63 +5,63 @@
  */
 class ActionScheduler_LogEntry {
 
-	/**
-	 * @var int $action_id
-	 */
-	protected $action_id =  '';
+    /**
+     * @var int $action_id
+     */
+    protected $action_id =  '';
 
-	/**
-	 * @var string $message
-	 */
-	protected $message =  '';
+    /**
+     * @var string $message
+     */
+    protected $message =  '';
 
-	/**
-	 * @var Datetime $date
-	 */
-	protected $date;
+    /**
+     * @var Datetime $date
+     */
+    protected $date;
 
-	/**
-	 * Constructor
-	 *
-	 * @param mixed  $action_id Action ID
-	 * @param string $message   Message
-	 * @param Datetime $date    Datetime object with the time when this log entry was created. If this parameter is
-	 *                          not provided a new Datetime object (with current time) will be created.
-	 */
-	public function __construct( $action_id, $message, $date = null ) {
+    /**
+     * Constructor
+     *
+     * @param mixed  $action_id Action ID
+     * @param string $message   Message
+     * @param Datetime $date    Datetime object with the time when this log entry was created. If this parameter is
+     *                          not provided a new Datetime object (with current time) will be created.
+     */
+    public function __construct( $action_id, $message, $date = null ) {
 
-		/*
+        /*
 		 * ActionScheduler_wpCommentLogger::get_entry() previously passed a 3rd param of $comment->comment_type
 		 * to ActionScheduler_LogEntry::__construct(), goodness knows why, and the Follow-up Emails plugin
 		 * hard-codes loading its own version of ActionScheduler_wpCommentLogger with that out-dated method,
 		 * goodness knows why, so we need to guard against that here instead of using a DateTime type declaration
 		 * for the constructor's 3rd param of $date and causing a fatal error with older versions of FUE.
 		 */
-		if ( null !== $date && ! is_a( $date, 'DateTime' ) ) {
-			_doing_it_wrong( __METHOD__, 'The third parameter must be a valid DateTime instance, or null.', '2.0.0' );
-			$date = null;
-		}
+        if ( null !== $date && ! is_a( $date, 'DateTime' ) ) {
+            _doing_it_wrong( __METHOD__, 'The third parameter must be a valid DateTime instance, or null.', '2.0.0' );
+            $date = null;
+        }
 
-		$this->action_id = $action_id;
-		$this->message   = $message;
-		$this->date      = $date ? $date : new Datetime;
-	}
+        $this->action_id = $action_id;
+        $this->message   = $message;
+        $this->date      = $date ? $date : new Datetime;
+    }
 
-	/**
-	 * Returns the date when this log entry was created
-	 *
-	 * @return Datetime
-	 */
-	public function get_date() {
-		return $this->date;
-	}
+    /**
+     * Returns the date when this log entry was created
+     *
+     * @return Datetime
+     */
+    public function get_date() {
+        return $this->date;
+    }
 
-	public function get_action_id() {
-		return $this->action_id;
-	}
+    public function get_action_id() {
+        return $this->action_id;
+    }
 
-	public function get_message() {
-		return $this->message;
-	}
+    public function get_message() {
+        return $this->message;
+    }
 }
 

includes/libraries/action-scheduler/classes/ActionScheduler_DataController.php

Indentation +170 added lines, -170 removed lines

@@ -14,174 +14,174 @@
  * @since 3.0.0
  */
 class ActionScheduler_DataController {
-	/** Action data store class name. */
-	const DATASTORE_CLASS = 'ActionScheduler_DBStore';
-
-	/** Logger data store class name. */
-	const LOGGER_CLASS    = 'ActionScheduler_DBLogger';
-
-	/** Migration status option name. */
-	const STATUS_FLAG     = 'action_scheduler_migration_status';
-
-	/** Migration status option value. */
-	const STATUS_COMPLETE = 'complete';
-
-	/** Migration minimum required PHP version. */
-	const MIN_PHP_VERSION = '5.5';
-
-	/** @var ActionScheduler_DataController */
-	private static $instance;
-
-	/** @var int */
-	private static $sleep_time = 0;
-
-	/** @var int */
-	private static $free_ticks = 50;
-
-	/**
-	 * Get a flag indicating whether the migration environment dependencies are met.
-	 *
-	 * @return bool
-	 */
-	public static function dependencies_met() {
-		$php_support = version_compare( PHP_VERSION, self::MIN_PHP_VERSION, '>=' );
-		return $php_support && apply_filters( 'action_scheduler_migration_dependencies_met', true );
-	}
-
-	/**
-	 * Get a flag indicating whether the migration is complete.
-	 *
-	 * @return bool Whether the flag has been set marking the migration as complete
-	 */
-	public static function is_migration_complete() {
-		return get_option( self::STATUS_FLAG ) === self::STATUS_COMPLETE;
-	}
-
-	/**
-	 * Mark the migration as complete.
-	 */
-	public static function mark_migration_complete() {
-		update_option( self::STATUS_FLAG, self::STATUS_COMPLETE );
-	}
-
-	/**
-	 * Unmark migration when a plugin is de-activated. Will not work in case of silent activation, for example in an update.
-	 * We do this to mitigate the bug of lost actions which happens if there was an AS 2.x to AS 3.x migration in the past, but that plugin is now
-	 * deactivated and the site was running on AS 2.x again.
-	 */
-	public static function mark_migration_incomplete() {
-		delete_option( self::STATUS_FLAG );
-	}
-
-	/**
-	 * Set the action store class name.
-	 *
-	 * @param string $class Classname of the store class.
-	 *
-	 * @return string
-	 */
-	public static function set_store_class( $class ) {
-		return self::DATASTORE_CLASS;
-	}
-
-	/**
-	 * Set the action logger class name.
-	 *
-	 * @param string $class Classname of the logger class.
-	 *
-	 * @return string
-	 */
-	public static function set_logger_class( $class ) {
-		return self::LOGGER_CLASS;
-	}
-
-	/**
-	 * Set the sleep time in seconds.
-	 *
-	 * @param integer $sleep_time The number of seconds to pause before resuming operation.
-	 */
-	public static function set_sleep_time( $sleep_time ) {
-		self::$sleep_time = $sleep_time;
-	}
-
-	/**
-	 * Set the tick count required for freeing memory.
-	 *
-	 * @param integer $free_ticks The number of ticks to free memory on.
-	 */
-	public static function set_free_ticks( $free_ticks ) {
-		self::$free_ticks = $free_ticks;
-	}
-
-	/**
-	 * Free memory if conditions are met.
-	 *
-	 * @param int $ticks Current tick count.
-	 */
-	public static function maybe_free_memory( $ticks ) {
-		if ( self::$free_ticks && 0 === $ticks % self::$free_ticks ) {
-			self::free_memory();
-		}
-	}
-
-	/**
-	 * Reduce memory footprint by clearing the database query and object caches.
-	 */
-	public static function free_memory() {
-		if ( 0 < self::$sleep_time ) {
-			/* translators: %d: amount of time */
-			\WP_CLI::warning( sprintf( _n( 'Stopped the insanity for %d second', 'Stopped the insanity for %d seconds', self::$sleep_time, 'action-scheduler' ), self::$sleep_time ) );
-			sleep( self::$sleep_time );
-		}
-
-		\WP_CLI::warning( __( 'Attempting to reduce used memory...', 'action-scheduler' ) );
-
-		/**
-		 * @var $wpdb            \wpdb
-		 * @var $wp_object_cache \WP_Object_Cache
-		 */
-		global $wpdb, $wp_object_cache;
-
-		$wpdb->queries = array();
-
-		if ( ! is_a( $wp_object_cache, 'WP_Object_Cache' ) ) {
-			return;
-		}
-
-		$wp_object_cache->group_ops      = array();
-		$wp_object_cache->stats          = array();
-		$wp_object_cache->memcache_debug = array();
-		$wp_object_cache->cache          = array();
-
-		if ( is_callable( array( $wp_object_cache, '__remoteset' ) ) ) {
-			call_user_func( array( $wp_object_cache, '__remoteset' ) ); // important
-		}
-	}
-
-	/**
-	 * Connect to table datastores if migration is complete.
-	 * Otherwise, proceed with the migration if the dependencies have been met.
-	 */
-	public static function init() {
-		if ( self::is_migration_complete() ) {
-			add_filter( 'action_scheduler_store_class', array( 'ActionScheduler_DataController', 'set_store_class' ), 100 );
-			add_filter( 'action_scheduler_logger_class', array( 'ActionScheduler_DataController', 'set_logger_class' ), 100 );
-			add_action( 'deactivate_plugin', array( 'ActionScheduler_DataController', 'mark_migration_incomplete' ) );
-		} elseif ( self::dependencies_met() ) {
-			Controller::init();
-		}
-
-		add_action( 'action_scheduler/progress_tick', array( 'ActionScheduler_DataController', 'maybe_free_memory' ) );
-	}
-
-	/**
-	 * Singleton factory.
-	 */
-	public static function instance() {
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new static();
-		}
-
-		return self::$instance;
-	}
+    /** Action data store class name. */
+    const DATASTORE_CLASS = 'ActionScheduler_DBStore';
+
+    /** Logger data store class name. */
+    const LOGGER_CLASS    = 'ActionScheduler_DBLogger';
+
+    /** Migration status option name. */
+    const STATUS_FLAG     = 'action_scheduler_migration_status';
+
+    /** Migration status option value. */
+    const STATUS_COMPLETE = 'complete';
+
+    /** Migration minimum required PHP version. */
+    const MIN_PHP_VERSION = '5.5';
+
+    /** @var ActionScheduler_DataController */
+    private static $instance;
+
+    /** @var int */
+    private static $sleep_time = 0;
+
+    /** @var int */
+    private static $free_ticks = 50;
+
+    /**
+     * Get a flag indicating whether the migration environment dependencies are met.
+     *
+     * @return bool
+     */
+    public static function dependencies_met() {
+        $php_support = version_compare( PHP_VERSION, self::MIN_PHP_VERSION, '>=' );
+        return $php_support && apply_filters( 'action_scheduler_migration_dependencies_met', true );
+    }
+
+    /**
+     * Get a flag indicating whether the migration is complete.
+     *
+     * @return bool Whether the flag has been set marking the migration as complete
+     */
+    public static function is_migration_complete() {
+        return get_option( self::STATUS_FLAG ) === self::STATUS_COMPLETE;
+    }
+
+    /**
+     * Mark the migration as complete.
+     */
+    public static function mark_migration_complete() {
+        update_option( self::STATUS_FLAG, self::STATUS_COMPLETE );
+    }
+
+    /**
+     * Unmark migration when a plugin is de-activated. Will not work in case of silent activation, for example in an update.
+     * We do this to mitigate the bug of lost actions which happens if there was an AS 2.x to AS 3.x migration in the past, but that plugin is now
+     * deactivated and the site was running on AS 2.x again.
+     */
+    public static function mark_migration_incomplete() {
+        delete_option( self::STATUS_FLAG );
+    }
+
+    /**
+     * Set the action store class name.
+     *
+     * @param string $class Classname of the store class.
+     *
+     * @return string
+     */
+    public static function set_store_class( $class ) {
+        return self::DATASTORE_CLASS;
+    }
+
+    /**
+     * Set the action logger class name.
+     *
+     * @param string $class Classname of the logger class.
+     *
+     * @return string
+     */
+    public static function set_logger_class( $class ) {
+        return self::LOGGER_CLASS;
+    }
+
+    /**
+     * Set the sleep time in seconds.
+     *
+     * @param integer $sleep_time The number of seconds to pause before resuming operation.
+     */
+    public static function set_sleep_time( $sleep_time ) {
+        self::$sleep_time = $sleep_time;
+    }
+
+    /**
+     * Set the tick count required for freeing memory.
+     *
+     * @param integer $free_ticks The number of ticks to free memory on.
+     */
+    public static function set_free_ticks( $free_ticks ) {
+        self::$free_ticks = $free_ticks;
+    }
+
+    /**
+     * Free memory if conditions are met.
+     *
+     * @param int $ticks Current tick count.
+     */
+    public static function maybe_free_memory( $ticks ) {
+        if ( self::$free_ticks && 0 === $ticks % self::$free_ticks ) {
+            self::free_memory();
+        }
+    }
+
+    /**
+     * Reduce memory footprint by clearing the database query and object caches.
+     */
+    public static function free_memory() {
+        if ( 0 < self::$sleep_time ) {
+            /* translators: %d: amount of time */
+            \WP_CLI::warning( sprintf( _n( 'Stopped the insanity for %d second', 'Stopped the insanity for %d seconds', self::$sleep_time, 'action-scheduler' ), self::$sleep_time ) );
+            sleep( self::$sleep_time );
+        }
+
+        \WP_CLI::warning( __( 'Attempting to reduce used memory...', 'action-scheduler' ) );
+
+        /**
+         * @var $wpdb            \wpdb
+         * @var $wp_object_cache \WP_Object_Cache
+         */
+        global $wpdb, $wp_object_cache;
+
+        $wpdb->queries = array();
+
+        if ( ! is_a( $wp_object_cache, 'WP_Object_Cache' ) ) {
+            return;
+        }
+
+        $wp_object_cache->group_ops      = array();
+        $wp_object_cache->stats          = array();
+        $wp_object_cache->memcache_debug = array();
+        $wp_object_cache->cache          = array();
+
+        if ( is_callable( array( $wp_object_cache, '__remoteset' ) ) ) {
+            call_user_func( array( $wp_object_cache, '__remoteset' ) ); // important
+        }
+    }
+
+    /**
+     * Connect to table datastores if migration is complete.
+     * Otherwise, proceed with the migration if the dependencies have been met.
+     */
+    public static function init() {
+        if ( self::is_migration_complete() ) {
+            add_filter( 'action_scheduler_store_class', array( 'ActionScheduler_DataController', 'set_store_class' ), 100 );
+            add_filter( 'action_scheduler_logger_class', array( 'ActionScheduler_DataController', 'set_logger_class' ), 100 );
+            add_action( 'deactivate_plugin', array( 'ActionScheduler_DataController', 'mark_migration_incomplete' ) );
+        } elseif ( self::dependencies_met() ) {
+            Controller::init();
+        }
+
+        add_action( 'action_scheduler/progress_tick', array( 'ActionScheduler_DataController', 'maybe_free_memory' ) );
+    }
+
+    /**
+     * Singleton factory.
+     */
+    public static function instance() {
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new static();
+        }
+
+        return self::$instance;
+    }
 }

includes/libraries/action-scheduler/classes/ActionScheduler_InvalidActionException.php

Indentation +32 added lines, -32 removed lines

@@ -9,39 +9,39 @@
  */
 class ActionScheduler_InvalidActionException extends \InvalidArgumentException implements ActionScheduler_Exception {
 
-	/**
-	 * Create a new exception when the action's schedule cannot be fetched.
-	 *
-	 * @param string $action_id The action ID with bad args.
-	 * @return static
-	 */
-	public static function from_schedule( $action_id, $schedule ) {
-		$message = sprintf(
-			/* translators: 1: action ID 2: schedule */
-			__( 'Action [%1$s] has an invalid schedule: %2$s', 'action-scheduler' ),
-			$action_id,
-			var_export( $schedule, true )
-		);
+    /**
+     * Create a new exception when the action's schedule cannot be fetched.
+     *
+     * @param string $action_id The action ID with bad args.
+     * @return static
+     */
+    public static function from_schedule( $action_id, $schedule ) {
+        $message = sprintf(
+            /* translators: 1: action ID 2: schedule */
+            __( 'Action [%1$s] has an invalid schedule: %2$s', 'action-scheduler' ),
+            $action_id,
+            var_export( $schedule, true )
+        );
 
-		return new static( $message );
-	}
+        return new static( $message );
+    }
 
-	/**
-	 * Create a new exception when the action's args cannot be decoded to an array.
-	 *
-	 * @author Jeremy Pry
-	 *
-	 * @param string $action_id The action ID with bad args.
-	 * @return static
-	 */
-	public static function from_decoding_args( $action_id, $args = array() ) {
-		$message = sprintf(
-			/* translators: 1: action ID 2: arguments */
-			__( 'Action [%1$s] has invalid arguments. It cannot be JSON decoded to an array. $args = %2$s', 'action-scheduler' ),
-			$action_id,
-			var_export( $args, true )
-		);
+    /**
+     * Create a new exception when the action's args cannot be decoded to an array.
+     *
+     * @author Jeremy Pry
+     *
+     * @param string $action_id The action ID with bad args.
+     * @return static
+     */
+    public static function from_decoding_args( $action_id, $args = array() ) {
+        $message = sprintf(
+            /* translators: 1: action ID 2: arguments */
+            __( 'Action [%1$s] has invalid arguments. It cannot be JSON decoded to an array. $args = %2$s', 'action-scheduler' ),
+            $action_id,
+            var_export( $args, true )
+        );
 
-		return new static( $message );
-	}
+        return new static( $message );
+    }
 }