'; printf( - // translators: 1) is the number of affected actions, 2) is a link to an admin screen. _n( + // translators: 1) is the number of affected actions, 2) is a link to an admin screen. 'Action Scheduler: %1$d past-due action found; something may be wrong. Read documentation »', 'Action Scheduler: %1$d past-due actions found; something may be wrong. Read documentation »', $num_pastdue_actions, @@ -224,7 +224,6 @@ public function add_help_tabs() { 'id' => 'action_scheduler_about', 'title' => __( 'About', 'action-scheduler' ), 'content' => - // translators: %s is the Action Scheduler version. '
' .
__( 'Action Scheduler is a scalable, traceable job queue for background processing large sets of actions. Action Scheduler works by triggering an action hook to run at some time in the future. Scheduled actions can also be scheduled to run on a recurring schedule.', 'action-scheduler' ) .
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_AsyncRequest_QueueRunner.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_AsyncRequest_QueueRunner.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_AsyncRequest_QueueRunner.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_AsyncRequest_QueueRunner.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_Compatibility.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_Compatibility.php
similarity index 87%
rename from dependencies/ActionScheduler/classes/ActionScheduler_Compatibility.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_Compatibility.php
index bb28023bc9..85e0ed9da3 100644
--- a/dependencies/ActionScheduler/classes/ActionScheduler_Compatibility.php
+++ b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_Compatibility.php
@@ -4,6 +4,7 @@
* Class ActionScheduler_Compatibility
*/
class ActionScheduler_Compatibility {
+
/**
* Converts a shorthand byte value to an integer byte value.
*
@@ -88,18 +89,21 @@ public static function raise_time_limit( $limit = 0 ) {
$limit = (int) $limit;
$max_execution_time = (int) ini_get( 'max_execution_time' );
- // If the max execution time is already set to zero (unlimited), there is no reason to make a further change.
- if ( 0 === $max_execution_time ) {
+ /*
+ * If the max execution time is already unlimited (zero), or if it exceeds or is equal to the proposed
+ * limit, there is no reason for us to make further changes (we never want to lower it).
+ */
+ if (
+ 0 === $max_execution_time
+ || ( $max_execution_time >= $limit && $limit !== 0 )
+ ) {
return;
}
- // Whichever of $max_execution_time or $limit is higher is the amount by which we raise the time limit.
- $raise_by = 0 === $limit || $limit > $max_execution_time ? $limit : $max_execution_time;
-
if ( function_exists( 'wc_set_time_limit' ) ) {
- wc_set_time_limit( $raise_by );
+ wc_set_time_limit( $limit );
} elseif ( function_exists( 'set_time_limit' ) && false === strpos( ini_get( 'disable_functions' ), 'set_time_limit' ) && ! ini_get( 'safe_mode' ) ) { // phpcs:ignore PHPCompatibility.IniDirectives.RemovedIniDirectives.safe_modeDeprecatedRemoved
- @set_time_limit( $raise_by ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+ @set_time_limit( $limit ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
}
}
}
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_DataController.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_DataController.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_DataController.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_DataController.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_DateTime.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_DateTime.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_DateTime.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_DateTime.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_Exception.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_Exception.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_Exception.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_Exception.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_FatalErrorMonitor.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_FatalErrorMonitor.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_FatalErrorMonitor.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_FatalErrorMonitor.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_InvalidActionException.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_InvalidActionException.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_InvalidActionException.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_InvalidActionException.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_ListTable.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_ListTable.php
similarity index 96%
rename from dependencies/ActionScheduler/classes/ActionScheduler_ListTable.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_ListTable.php
index abf767ce65..9e631f7543 100644
--- a/dependencies/ActionScheduler/classes/ActionScheduler_ListTable.php
+++ b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_ListTable.php
@@ -234,7 +234,7 @@ private static function human_interval( $interval, $periods_to_include = 2 ) {
if ( ! empty( $output ) ) {
$output .= ' ';
}
- $output .= sprintf( translate_nooped_plural( self::$time_periods[ $time_period_index ]['names'], $periods_in_interval, 'action-scheduler' ), $periods_in_interval );
+ $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++;
}
@@ -252,7 +252,7 @@ private static function human_interval( $interval, $periods_to_include = 2 ) {
*/
protected function get_recurrence( $action ) {
$schedule = $action->get_schedule();
- if ( $schedule->is_recurring() && method_exists( $schedule, 'get_recurrence' ) ) {
+ if ( $schedule->is_recurring() ) {
$recurrence = $schedule->get_recurrence();
if ( is_numeric( $recurrence ) ) {
@@ -471,7 +471,7 @@ protected function get_schedule_display_string( ActionScheduler_Schedule $schedu
return __( 'async', 'action-scheduler' );
}
- if ( ! method_exists( $schedule, 'get_date' ) || ! $schedule->get_date() ) {
+ if ( ! $schedule->get_date() ) {
return '0000-00-00 00:00:00';
}
@@ -502,20 +502,7 @@ protected function get_schedule_display_string( ActionScheduler_Schedule $schedu
*/
protected function bulk_delete( array $ids, $ids_sql ) {
foreach ( $ids as $id ) {
- try {
- $this->store->delete_action( $id );
- } catch ( Exception $e ) {
- // A possible reason for an exception would include a scenario where the same action is deleted by a
- // concurrent request.
- error_log(
- sprintf(
- /* translators: 1: action ID 2: exception message. */
- __( 'Action Scheduler was unable to delete action %1$d. Reason: %2$s', 'action-scheduler' ),
- $id,
- $e->getMessage()
- )
- );
- }
+ $this->store->delete_action( $id );
}
}
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_LogEntry.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_LogEntry.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_LogEntry.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_LogEntry.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_NullLogEntry.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_NullLogEntry.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_NullLogEntry.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_NullLogEntry.php
diff --git a/inc/Dependencies/ActionScheduler/classes/ActionScheduler_OptionLock.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_OptionLock.php
new file mode 100644
index 0000000000..4bc9a3fc26
--- /dev/null
+++ b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_OptionLock.php
@@ -0,0 +1,49 @@
+maybe_dispatch_async_request() uses a lock to avoid
+ * calling ActionScheduler_QueueRunner->has_maximum_concurrent_batches() every time the 'shutdown',
+ * hook is triggered, because that method calls ActionScheduler_QueueRunner->store->get_claim_count()
+ * to find the current number of claims in the database.
+ *
+ * @param string $lock_type A string to identify different lock types.
+ * @bool True if lock value has changed, false if not or if set failed.
+ */
+ public function set( $lock_type ) {
+ return update_option( $this->get_key( $lock_type ), time() + $this->get_duration( $lock_type ) );
+ }
+
+ /**
+ * If a lock is set, return the timestamp it was set to expiry.
+ *
+ * @param string $lock_type A string to identify different lock types.
+ * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire.
+ */
+ public function get_expiration( $lock_type ) {
+ return get_option( $this->get_key( $lock_type ) );
+ }
+
+ /**
+ * Get the key to use for storing the lock in the transient
+ *
+ * @param string $lock_type A string to identify different lock types.
+ * @return string
+ */
+ protected function get_key( $lock_type ) {
+ return sprintf( 'action_scheduler_lock_%s', $lock_type );
+ }
+}
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_QueueCleaner.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_QueueCleaner.php
similarity index 50%
rename from dependencies/ActionScheduler/classes/ActionScheduler_QueueCleaner.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_QueueCleaner.php
index 6b066dca02..49cd44bb2a 100644
--- a/dependencies/ActionScheduler/classes/ActionScheduler_QueueCleaner.php
+++ b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_QueueCleaner.php
@@ -18,14 +18,6 @@ class ActionScheduler_QueueCleaner {
*/
private $month_in_seconds = 2678400;
- /**
- * @var string[] Default list of statuses purged by the cleaner process.
- */
- private $default_statuses_to_purge = [
- ActionScheduler_Store::STATUS_COMPLETE,
- ActionScheduler_Store::STATUS_CANCELED,
- ];
-
/**
* ActionScheduler_QueueCleaner constructor.
*
@@ -37,113 +29,46 @@ public function __construct( ActionScheduler_Store $store = null, $batch_size =
$this->batch_size = $batch_size;
}
- /**
- * Default queue cleaner process used by queue runner.
- *
- * @return array
- */
public function delete_old_actions() {
- /**
- * Filter the minimum scheduled date age for action deletion.
- *
- * @param int $retention_period Minimum scheduled age in seconds of the actions to be deleted.
- */
$lifespan = apply_filters( 'action_scheduler_retention_period', $this->month_in_seconds );
+ $cutoff = as_get_datetime_object($lifespan.' seconds ago');
- try {
- $cutoff = as_get_datetime_object( $lifespan . ' seconds ago' );
- } catch ( Exception $e ) {
- _doing_it_wrong(
- __METHOD__,
- sprintf(
- /* Translators: %s is the exception message. */
- esc_html__( 'It was not possible to determine a valid cut-off time: %s.', 'action-scheduler' ),
- esc_html( $e->getMessage() )
- ),
- '3.5.5'
- );
-
- return array();
- }
-
-
- /**
- * Filter the statuses when cleaning the queue.
- *
- * @param string[] $default_statuses_to_purge Action statuses to clean.
- */
- $statuses_to_purge = (array) apply_filters( 'action_scheduler_default_cleaner_statuses', $this->default_statuses_to_purge );
-
- return $this->clean_actions( $statuses_to_purge, $cutoff, $this->get_batch_size() );
- }
-
- /**
- * Delete selected actions limited by status and date.
- *
- * @param string[] $statuses_to_purge List of action statuses to purge. Defaults to canceled, complete.
- * @param DateTime $cutoff_date Date limit for selecting actions. Defaults to 31 days ago.
- * @param int|null $batch_size Maximum number of actions per status to delete. Defaults to 20.
- * @param string $context Calling process context. Defaults to `old`.
- * @return array Actions deleted.
- */
- public function clean_actions( array $statuses_to_purge, DateTime $cutoff_date, $batch_size = null, $context = 'old' ) {
- $batch_size = $batch_size !== null ? $batch_size : $this->batch_size;
- $cutoff = $cutoff_date !== null ? $cutoff_date : as_get_datetime_object( $this->month_in_seconds . ' seconds ago' );
- $lifespan = time() - $cutoff->getTimestamp();
- if ( empty( $statuses_to_purge ) ) {
- $statuses_to_purge = $this->default_statuses_to_purge;
- }
+ $statuses_to_purge = array(
+ ActionScheduler_Store::STATUS_COMPLETE,
+ ActionScheduler_Store::STATUS_CANCELED,
+ );
- $deleted_actions = [];
foreach ( $statuses_to_purge as $status ) {
$actions_to_delete = $this->store->query_actions( array(
'status' => $status,
'modified' => $cutoff,
'modified_compare' => '<=',
- 'per_page' => $batch_size,
+ 'per_page' => $this->get_batch_size(),
'orderby' => 'none',
) );
- $deleted_actions = array_merge( $deleted_actions, $this->delete_actions( $actions_to_delete, $lifespan, $context ) );
- }
-
- return $deleted_actions;
- }
-
- /**
- * @param int[] $actions_to_delete List of action IDs to delete.
- * @param int $lifespan Minimum scheduled age in seconds of the actions being deleted.
- * @param string $context Context of the delete request.
- * @return array Deleted action IDs.
- */
- private function delete_actions( array $actions_to_delete, $lifespan = null, $context = 'old' ) {
- $deleted_actions = [];
- if ( $lifespan === null ) {
- $lifespan = $this->month_in_seconds;
- }
-
- foreach ( $actions_to_delete as $action_id ) {
- try {
- $this->store->delete_action( $action_id );
- $deleted_actions[] = $action_id;
- } catch ( Exception $e ) {
- /**
- * Notify 3rd party code of exceptions when deleting a completed action older than the retention period
- *
- * This hook provides a way for 3rd party code to log or otherwise handle exceptions relating to their
- * actions.
- *
- * @param int $action_id The scheduled actions ID in the data store
- * @param Exception $e The exception thrown when attempting to delete the action from the data store
- * @param int $lifespan The retention period, in seconds, for old actions
- * @param int $count_of_actions_to_delete The number of old actions being deleted in this batch
- * @since 2.0.0
- *
- */
- do_action( "action_scheduler_failed_{$context}_action_deletion", $action_id, $e, $lifespan, count( $actions_to_delete ) );
+ foreach ( $actions_to_delete as $action_id ) {
+ try {
+ $this->store->delete_action( $action_id );
+ } catch ( Exception $e ) {
+
+ /**
+ * Notify 3rd party code of exceptions when deleting a completed action older than the retention period
+ *
+ * This hook provides a way for 3rd party code to log or otherwise handle exceptions relating to their
+ * actions.
+ *
+ * @since 2.0.0
+ *
+ * @param int $action_id The scheduled actions ID in the data store
+ * @param Exception $e The exception thrown when attempting to delete the action from the data store
+ * @param int $lifespan The retention period, in seconds, for old actions
+ * @param int $count_of_actions_to_delete The number of old actions being deleted in this batch
+ */
+ do_action( 'action_scheduler_failed_old_action_deletion', $action_id, $e, $lifespan, count( $actions_to_delete ) );
+ }
}
}
- return $deleted_actions;
}
/**
@@ -177,7 +102,7 @@ public function reset_timeouts( $time_limit = 300 ) {
/**
* Mark actions that have been running for more than a given time limit as failed, based on
- * the assumption some uncatchable and unloggable fatal error occurred during processing.
+ * the assumption some uncatachable and unloggable fatal error occurred during processing.
*
* When called by ActionScheduler_Abstract_QueueRunner::run_cleanup(), the time limit passed
* as a parameter is 10x the time limit used for queue processing.
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_QueueRunner.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_QueueRunner.php
similarity index 86%
rename from dependencies/ActionScheduler/classes/ActionScheduler_QueueRunner.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_QueueRunner.php
index 90e64fc46e..b890dca137 100644
--- a/dependencies/ActionScheduler/classes/ActionScheduler_QueueRunner.php
+++ b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_QueueRunner.php
@@ -103,12 +103,9 @@ public function unhook_dispatch_async_request() {
* should dispatch a request to process pending actions.
*/
public function maybe_dispatch_async_request() {
- // Only start an async queue at most once every 60 seconds.
- if (
- is_admin()
- && ! ActionScheduler::lock()->is_locked( 'async-request-runner' )
- && ActionScheduler::lock()->set( 'async-request-runner' )
- ) {
+ if ( is_admin() && ! ActionScheduler::lock()->is_locked( 'async-request-runner' ) ) {
+ // Only start an async queue at most once every 60 seconds
+ ActionScheduler::lock()->set( 'async-request-runner' );
$this->async_request->maybe_dispatch();
}
}
@@ -122,7 +119,7 @@ public function maybe_dispatch_async_request() {
* should set a context as the first parameter. For an example of this, refer to the code seen in
* @see ActionScheduler_AsyncRequest_QueueRunner::handle()
*
- * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
+ * @param string $context Optional identifer for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
* Generally, this should be capitalised and not localised as it's a proper noun.
* @return int The number of actions processed.
*/
@@ -152,7 +149,7 @@ public function run( $context = 'WP Cron' ) {
* size is completed, or memory or time limits are reached, defined by @see $this->batch_limits_exceeded().
*
* @param int $size The maximum number of actions to process in the batch.
- * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
+ * @param string $context Optional identifer for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron'
* Generally, this should be capitalised and not localised as it's a proper noun.
* @return int The number of actions processed.
*/
@@ -188,15 +185,9 @@ protected function do_batch( $size = 100, $context = '' ) {
protected function clear_caches() {
/*
* Calling wp_cache_flush_runtime() lets us clear the runtime cache without invalidating the external object
- * cache, so we will always prefer this method (as compared to calling wp_cache_flush()) when it is available.
- *
- * However, this function was only introduced in WordPress 6.0. Additionally, the preferred way of detecting if
- * it is supported changed in WordPress 6.1 so we use two different methods to decide if we should utilize it.
+ * cache, so we will always prefer this when it is available (but it was only introduced in WordPress 6.0).
*/
- $flushing_runtime_cache_explicitly_supported = function_exists( 'wp_cache_supports' ) && wp_cache_supports( 'flush_runtime' );
- $flushing_runtime_cache_implicitly_supported = ! function_exists( 'wp_cache_supports' ) && function_exists( 'wp_cache_flush_runtime' );
-
- if ( $flushing_runtime_cache_explicitly_supported || $flushing_runtime_cache_implicitly_supported ) {
+ if ( function_exists( 'wp_cache_flush_runtime' ) ) {
wp_cache_flush_runtime();
} elseif (
! wp_using_ext_object_cache()
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_Versions.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_Versions.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_Versions.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_Versions.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_WPCommentCleaner.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_WPCommentCleaner.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_WPCommentCleaner.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_WPCommentCleaner.php
diff --git a/dependencies/ActionScheduler/classes/ActionScheduler_wcSystemStatus.php b/inc/Dependencies/ActionScheduler/classes/ActionScheduler_wcSystemStatus.php
similarity index 100%
rename from dependencies/ActionScheduler/classes/ActionScheduler_wcSystemStatus.php
rename to inc/Dependencies/ActionScheduler/classes/ActionScheduler_wcSystemStatus.php
diff --git a/dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php b/inc/Dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php
similarity index 99%
rename from dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php
rename to inc/Dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php
index 4681daa492..c33de68672 100644
--- a/dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php
+++ b/inc/Dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php
@@ -90,7 +90,7 @@ 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' ), $count ),
+ sprintf( _n( 'Running %d action', 'Running %d actions', $count, 'action-scheduler' ), number_format_i18n( $count ) ),
$count
);
}
diff --git a/dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php b/inc/Dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php
similarity index 72%
rename from dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php
rename to inc/Dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php
index 2c68a3860d..70b052e58d 100644
--- a/dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php
+++ b/inc/Dependencies/ActionScheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php
@@ -55,9 +55,6 @@ public function fix_schema( $args, $assoc_args ) {
* [--group=