AyeCode / invoicing

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

Indentation +4 added lines, -4 removed lines

@@ -4,8 +4,8 @@
  * Class ActionScheduler_NullLogEntry
  */
 class ActionScheduler_NullLogEntry extends ActionScheduler_LogEntry {
-	public function __construct( $action_id = '', $message = '' ) {
-		// nothing to see here
-	}
+    public function __construct( $action_id = '', $message = '' ) {
+        // nothing to see here
+    }
 }
- 
\ No newline at end of file
+    
\ No newline at end of file

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

Indentation +147 added lines, -147 removed lines

@@ -5,151 +5,151 @@
  */
 class ActionScheduler_QueueCleaner {
 
-	/** @var int */
-	protected $batch_size;
-
-	/** @var ActionScheduler_Store */
-	private $store = null;
-
-	/**
-	 * 31 days in seconds.
-	 *
-	 * @var int
-	 */
-	private $month_in_seconds = 2678400;
-
-	/**
-	 * ActionScheduler_QueueCleaner constructor.
-	 *
-	 * @param ActionScheduler_Store $store      The store instance.
-	 * @param int                   $batch_size The batch size.
-	 */
-	public function __construct( ActionScheduler_Store $store = null, $batch_size = 20 ) {
-		$this->store = $store ? $store : ActionScheduler_Store::instance();
-		$this->batch_size = $batch_size;
-	}
-
-	public function delete_old_actions() {
-		$lifespan = apply_filters( 'action_scheduler_retention_period', $this->month_in_seconds );
-		$cutoff = as_get_datetime_object($lifespan.' seconds ago');
-
-		$statuses_to_purge = array(
-			ActionScheduler_Store::STATUS_COMPLETE,
-			ActionScheduler_Store::STATUS_CANCELED,
-		);
-
-		foreach ( $statuses_to_purge as $status ) {
-			$actions_to_delete = $this->store->query_actions( array(
-				'status'           => $status,
-				'modified'         => $cutoff,
-				'modified_compare' => '<=',
-				'per_page'         => $this->get_batch_size(),
-			) );
-
-			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 ) );
-				}
-			}
-		}
-	}
-
-	/**
-	 * Unclaim pending actions that have not been run within a given time limit.
-	 *
-	 * When called by ActionScheduler_Abstract_QueueRunner::run_cleanup(), the time limit passed
-	 * as a parameter is 10x the time limit used for queue processing.
-	 *
-	 * @param int $time_limit The number of seconds to allow a queue to run before unclaiming its pending actions. Default 300 (5 minutes).
-	 */
-	public function reset_timeouts( $time_limit = 300 ) {
-		$timeout = apply_filters( 'action_scheduler_timeout_period', $time_limit );
-		if ( $timeout < 0 ) {
-			return;
-		}
-		$cutoff = as_get_datetime_object($timeout.' seconds ago');
-		$actions_to_reset = $this->store->query_actions( array(
-			'status'           => ActionScheduler_Store::STATUS_PENDING,
-			'modified'         => $cutoff,
-			'modified_compare' => '<=',
-			'claimed'          => true,
-			'per_page'         => $this->get_batch_size(),
-		) );
-
-		foreach ( $actions_to_reset as $action_id ) {
-			$this->store->unclaim_action( $action_id );
-			do_action( 'action_scheduler_reset_action', $action_id );
-		}
-	}
-
-	/**
-	 * Mark actions that have been running for more than a given time limit as failed, based on
-	 * 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.
-	 *
-	 * @param int $time_limit The number of seconds to allow an action to run before it is considered to have failed. Default 300 (5 minutes).
-	 */
-	public function mark_failures( $time_limit = 300 ) {
-		$timeout = apply_filters( 'action_scheduler_failure_period', $time_limit );
-		if ( $timeout < 0 ) {
-			return;
-		}
-		$cutoff = as_get_datetime_object($timeout.' seconds ago');
-		$actions_to_reset = $this->store->query_actions( array(
-			'status'           => ActionScheduler_Store::STATUS_RUNNING,
-			'modified'         => $cutoff,
-			'modified_compare' => '<=',
-			'per_page'         => $this->get_batch_size(),
-		) );
-
-		foreach ( $actions_to_reset as $action_id ) {
-			$this->store->mark_failure( $action_id );
-			do_action( 'action_scheduler_failed_action', $action_id, $timeout );
-		}
-	}
-
-	/**
-	 * Do all of the cleaning actions.
-	 *
-	 * @param int $time_limit The number of seconds to use as the timeout and failure period. Default 300 (5 minutes).
-	 * @author Jeremy Pry
-	 */
-	public function clean( $time_limit = 300 ) {
-		$this->delete_old_actions();
-		$this->reset_timeouts( $time_limit );
-		$this->mark_failures( $time_limit );
-	}
-
-	/**
-	 * Get the batch size for cleaning the queue.
-	 *
-	 * @author Jeremy Pry
-	 * @return int
-	 */
-	protected function get_batch_size() {
-		/**
-		 * Filter the batch size when cleaning the queue.
-		 *
-		 * @param int $batch_size The number of actions to clean in one batch.
-		 */
-		return absint( apply_filters( 'action_scheduler_cleanup_batch_size', $this->batch_size ) );
-	}
+    /** @var int */
+    protected $batch_size;
+
+    /** @var ActionScheduler_Store */
+    private $store = null;
+
+    /**
+     * 31 days in seconds.
+     *
+     * @var int
+     */
+    private $month_in_seconds = 2678400;
+
+    /**
+     * ActionScheduler_QueueCleaner constructor.
+     *
+     * @param ActionScheduler_Store $store      The store instance.
+     * @param int                   $batch_size The batch size.
+     */
+    public function __construct( ActionScheduler_Store $store = null, $batch_size = 20 ) {
+        $this->store = $store ? $store : ActionScheduler_Store::instance();
+        $this->batch_size = $batch_size;
+    }
+
+    public function delete_old_actions() {
+        $lifespan = apply_filters( 'action_scheduler_retention_period', $this->month_in_seconds );
+        $cutoff = as_get_datetime_object($lifespan.' seconds ago');
+
+        $statuses_to_purge = array(
+            ActionScheduler_Store::STATUS_COMPLETE,
+            ActionScheduler_Store::STATUS_CANCELED,
+        );
+
+        foreach ( $statuses_to_purge as $status ) {
+            $actions_to_delete = $this->store->query_actions( array(
+                'status'           => $status,
+                'modified'         => $cutoff,
+                'modified_compare' => '<=',
+                'per_page'         => $this->get_batch_size(),
+            ) );
+
+            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 ) );
+                }
+            }
+        }
+    }
+
+    /**
+     * Unclaim pending actions that have not been run within a given time limit.
+     *
+     * When called by ActionScheduler_Abstract_QueueRunner::run_cleanup(), the time limit passed
+     * as a parameter is 10x the time limit used for queue processing.
+     *
+     * @param int $time_limit The number of seconds to allow a queue to run before unclaiming its pending actions. Default 300 (5 minutes).
+     */
+    public function reset_timeouts( $time_limit = 300 ) {
+        $timeout = apply_filters( 'action_scheduler_timeout_period', $time_limit );
+        if ( $timeout < 0 ) {
+            return;
+        }
+        $cutoff = as_get_datetime_object($timeout.' seconds ago');
+        $actions_to_reset = $this->store->query_actions( array(
+            'status'           => ActionScheduler_Store::STATUS_PENDING,
+            'modified'         => $cutoff,
+            'modified_compare' => '<=',
+            'claimed'          => true,
+            'per_page'         => $this->get_batch_size(),
+        ) );
+
+        foreach ( $actions_to_reset as $action_id ) {
+            $this->store->unclaim_action( $action_id );
+            do_action( 'action_scheduler_reset_action', $action_id );
+        }
+    }
+
+    /**
+     * Mark actions that have been running for more than a given time limit as failed, based on
+     * 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.
+     *
+     * @param int $time_limit The number of seconds to allow an action to run before it is considered to have failed. Default 300 (5 minutes).
+     */
+    public function mark_failures( $time_limit = 300 ) {
+        $timeout = apply_filters( 'action_scheduler_failure_period', $time_limit );
+        if ( $timeout < 0 ) {
+            return;
+        }
+        $cutoff = as_get_datetime_object($timeout.' seconds ago');
+        $actions_to_reset = $this->store->query_actions( array(
+            'status'           => ActionScheduler_Store::STATUS_RUNNING,
+            'modified'         => $cutoff,
+            'modified_compare' => '<=',
+            'per_page'         => $this->get_batch_size(),
+        ) );
+
+        foreach ( $actions_to_reset as $action_id ) {
+            $this->store->mark_failure( $action_id );
+            do_action( 'action_scheduler_failed_action', $action_id, $timeout );
+        }
+    }
+
+    /**
+     * Do all of the cleaning actions.
+     *
+     * @param int $time_limit The number of seconds to use as the timeout and failure period. Default 300 (5 minutes).
+     * @author Jeremy Pry
+     */
+    public function clean( $time_limit = 300 ) {
+        $this->delete_old_actions();
+        $this->reset_timeouts( $time_limit );
+        $this->mark_failures( $time_limit );
+    }
+
+    /**
+     * Get the batch size for cleaning the queue.
+     *
+     * @author Jeremy Pry
+     * @return int
+     */
+    protected function get_batch_size() {
+        /**
+         * Filter the batch size when cleaning the queue.
+         *
+         * @param int $batch_size The number of actions to clean in one batch.
+         */
+        return absint( apply_filters( 'action_scheduler_cleanup_batch_size', $this->batch_size ) );
+    }
 }

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

Indentation +35 added lines, -35 removed lines

@@ -9,41 +9,41 @@
  */
 class ActionScheduler_OptionLock extends ActionScheduler_Lock {
 
-	/**
-	 * Set a lock using options for a given amount of time (60 seconds by default).
-	 *
-	 * Using an autoloaded option avoids running database queries or other resource intensive tasks
-	 * on frequently triggered hooks, like 'init' or 'shutdown'.
-	 *
-	 * For example, ActionScheduler_QueueRunner->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 ) );
-	}
+    /**
+     * Set a lock using options for a given amount of time (60 seconds by default).
+     *
+     * Using an autoloaded option avoids running database queries or other resource intensive tasks
+     * on frequently triggered hooks, like 'init' or 'shutdown'.
+     *
+     * For example, ActionScheduler_QueueRunner->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 ) );
-	}
+    /**
+     * 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 );
-	}
+    /**
+     * 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 );
+    }
 }

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

Indentation +13 added lines, -13 removed lines

@@ -4,20 +4,20 @@
  * Class ActionScheduler_ActionClaim
  */
 class ActionScheduler_ActionClaim {
-	private $id = '';
-	private $action_ids = array();
+    private $id = '';
+    private $action_ids = array();
 
-	public function __construct( $id, array $action_ids ) {
-		$this->id = $id;
-		$this->action_ids = $action_ids;
-	}
+    public function __construct( $id, array $action_ids ) {
+        $this->id = $id;
+        $this->action_ids = $action_ids;
+    }
 
-	public function get_id() {
-		return $this->id;
-	}
+    public function get_id() {
+        return $this->id;
+    }
 
-	public function get_actions() {
-		return $this->action_ids;
-	}
+    public function get_actions() {
+        return $this->action_ids;
+    }
 }
- 
\ No newline at end of file
+    
\ No newline at end of file

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

Indentation +191 added lines, -191 removed lines

@@ -4,195 +4,195 @@
  * Class ActionScheduler_QueueRunner
  */
 class ActionScheduler_QueueRunner extends ActionScheduler_Abstract_QueueRunner {
-	const WP_CRON_HOOK = 'action_scheduler_run_queue';
-
-	const WP_CRON_SCHEDULE = 'every_minute';
-
-	/** @var ActionScheduler_AsyncRequest_QueueRunner */
-	protected $async_request;
-
-	/** @var ActionScheduler_QueueRunner  */
-	private static $runner = null;
-
-	/**
-	 * @return ActionScheduler_QueueRunner
-	 * @codeCoverageIgnore
-	 */
-	public static function instance() {
-		if ( empty(self::$runner) ) {
-			$class = apply_filters('action_scheduler_queue_runner_class', 'ActionScheduler_QueueRunner');
-			self::$runner = new $class();
-		}
-		return self::$runner;
-	}
-
-	/**
-	 * ActionScheduler_QueueRunner constructor.
-	 *
-	 * @param ActionScheduler_Store             $store
-	 * @param ActionScheduler_FatalErrorMonitor $monitor
-	 * @param ActionScheduler_QueueCleaner      $cleaner
-	 */
-	public function __construct( ActionScheduler_Store $store = null, ActionScheduler_FatalErrorMonitor $monitor = null, ActionScheduler_QueueCleaner $cleaner = null, ActionScheduler_AsyncRequest_QueueRunner $async_request = null ) {
-		parent::__construct( $store, $monitor, $cleaner );
-
-		if ( is_null( $async_request ) ) {
-			$async_request = new ActionScheduler_AsyncRequest_QueueRunner( $this->store );
-		}
-
-		$this->async_request = $async_request;
-	}
-
-	/**
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-
-		add_filter( 'cron_schedules', array( self::instance(), 'add_wp_cron_schedule' ) );
-
-		$cron_context = array( 'WP Cron' );
-
-		if ( ! wp_next_scheduled( self::WP_CRON_HOOK, $cron_context ) ) {
-
-			// Check for and remove any WP Cron hook scheduled by Action Scheduler < 3.0.0, which didn't include the $context param
-			$next_timestamp = wp_next_scheduled( self::WP_CRON_HOOK );
-			if ( $next_timestamp ) {
-				wp_unschedule_event( $next_timestamp, self::WP_CRON_HOOK );
-			}
-
-			$schedule = apply_filters( 'action_scheduler_run_schedule', self::WP_CRON_SCHEDULE );
-			wp_schedule_event( time(), $schedule, self::WP_CRON_HOOK, $cron_context );
-		}
-
-		add_action( self::WP_CRON_HOOK, array( self::instance(), 'run' ) );
-		$this->hook_dispatch_async_request();
-	}
-
-	/**
-	 * Hook check for dispatching an async request.
-	 */
-	public function hook_dispatch_async_request() {
-		add_action( 'shutdown', array( $this, 'maybe_dispatch_async_request' ) );
-	}
-
-	/**
-	 * Unhook check for dispatching an async request.
-	 */
-	public function unhook_dispatch_async_request() {
-		remove_action( 'shutdown', array( $this, 'maybe_dispatch_async_request' ) );
-	}
-
-	/**
-	 * Check if we should dispatch an async request to process actions.
-	 *
-	 * This method is attached to 'shutdown', so is called frequently. To avoid slowing down
-	 * the site, it mitigates the work performed in each request by:
-	 * 1. checking if it's in the admin context and then
-	 * 2. haven't run on the 'shutdown' hook within the lock time (60 seconds by default)
-	 * 3. haven't exceeded the number of allowed batches.
-	 *
-	 * The order of these checks is important, because they run from a check on a value:
-	 * 1. in memory - is_admin() maps to $GLOBALS or the WP_ADMIN constant
-	 * 2. in memory - transients use autoloaded options by default
-	 * 3. from a database query - has_maximum_concurrent_batches() run the query
-	 *    $this->store->get_claim_count() to find the current number of claims in the DB.
-	 *
-	 * If all of these conditions are met, then we request an async runner check whether it
-	 * should dispatch a request to process pending actions.
-	 */
-	public function maybe_dispatch_async_request() {
-		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();
-		}
-	}
-
-	/**
-	 * Process actions in the queue. Attached to self::WP_CRON_HOOK i.e. 'action_scheduler_run_queue'
-	 *
-	 * The $context param of this method defaults to 'WP Cron', because prior to Action Scheduler 3.0.0
-	 * that was the only context in which this method was run, and the self::WP_CRON_HOOK hook had no context
-	 * passed along with it. New code calling this method directly, or by triggering the self::WP_CRON_HOOK,
-	 * 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 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.
-	 */
-	public function run( $context = 'WP Cron' ) {
-		ActionScheduler_Compatibility::raise_memory_limit();
-		ActionScheduler_Compatibility::raise_time_limit( $this->get_time_limit() );
-		do_action( 'action_scheduler_before_process_queue' );
-		$this->run_cleanup();
-		$processed_actions = 0;
-		if ( false === $this->has_maximum_concurrent_batches() ) {
-			$batch_size = apply_filters( 'action_scheduler_queue_runner_batch_size', 25 );
-			do {
-				$processed_actions_in_batch = $this->do_batch( $batch_size, $context );
-				$processed_actions         += $processed_actions_in_batch;
-			} while ( $processed_actions_in_batch > 0 && ! $this->batch_limits_exceeded( $processed_actions ) ); // keep going until we run out of actions, time, or memory
-		}
-
-		do_action( 'action_scheduler_after_process_queue' );
-		return $processed_actions;
-	}
-
-	/**
-	 * Process a batch of actions pending in the queue.
-	 *
-	 * Actions are processed by claiming a set of pending actions then processing each one until either the batch
-	 * 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 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.
-	 */
-	protected function do_batch( $size = 100, $context = '' ) {
-		$claim = $this->store->stake_claim($size);
-		$this->monitor->attach($claim);
-		$processed_actions = 0;
-
-		foreach ( $claim->get_actions() as $action_id ) {
-			// bail if we lost the claim
-			if ( ! in_array( $action_id, $this->store->find_actions_by_claim_id( $claim->get_id() ) ) ) {
-				break;
-			}
-			$this->process_action( $action_id, $context );
-			$processed_actions++;
-
-			if ( $this->batch_limits_exceeded( $processed_actions ) ) {
-				break;
-			}
-		}
-		$this->store->release_claim($claim);
-		$this->monitor->detach();
-		$this->clear_caches();
-		return $processed_actions;
-	}
-
-	/**
-	 * Running large batches can eat up memory, as WP adds data to its object cache.
-	 *
-	 * If using a persistent object store, this has the side effect of flushing that
-	 * as well, so this is disabled by default. To enable:
-	 *
-	 * add_filter( 'action_scheduler_queue_runner_flush_cache', '__return_true' );
-	 */
-	protected function clear_caches() {
-		if ( ! wp_using_ext_object_cache() || apply_filters( 'action_scheduler_queue_runner_flush_cache', false ) ) {
-			wp_cache_flush();
-		}
-	}
-
-	public function add_wp_cron_schedule( $schedules ) {
-		$schedules['every_minute'] = array(
-			'interval' => 60, // in seconds
-			'display'  => __( 'Every minute', 'action-scheduler' ),
-		);
-
-		return $schedules;
-	}
+    const WP_CRON_HOOK = 'action_scheduler_run_queue';
+
+    const WP_CRON_SCHEDULE = 'every_minute';
+
+    /** @var ActionScheduler_AsyncRequest_QueueRunner */
+    protected $async_request;
+
+    /** @var ActionScheduler_QueueRunner  */
+    private static $runner = null;
+
+    /**
+     * @return ActionScheduler_QueueRunner
+     * @codeCoverageIgnore
+     */
+    public static function instance() {
+        if ( empty(self::$runner) ) {
+            $class = apply_filters('action_scheduler_queue_runner_class', 'ActionScheduler_QueueRunner');
+            self::$runner = new $class();
+        }
+        return self::$runner;
+    }
+
+    /**
+     * ActionScheduler_QueueRunner constructor.
+     *
+     * @param ActionScheduler_Store             $store
+     * @param ActionScheduler_FatalErrorMonitor $monitor
+     * @param ActionScheduler_QueueCleaner      $cleaner
+     */
+    public function __construct( ActionScheduler_Store $store = null, ActionScheduler_FatalErrorMonitor $monitor = null, ActionScheduler_QueueCleaner $cleaner = null, ActionScheduler_AsyncRequest_QueueRunner $async_request = null ) {
+        parent::__construct( $store, $monitor, $cleaner );
+
+        if ( is_null( $async_request ) ) {
+            $async_request = new ActionScheduler_AsyncRequest_QueueRunner( $this->store );
+        }
+
+        $this->async_request = $async_request;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function init() {
+
+        add_filter( 'cron_schedules', array( self::instance(), 'add_wp_cron_schedule' ) );
+
+        $cron_context = array( 'WP Cron' );
+
+        if ( ! wp_next_scheduled( self::WP_CRON_HOOK, $cron_context ) ) {
+
+            // Check for and remove any WP Cron hook scheduled by Action Scheduler < 3.0.0, which didn't include the $context param
+            $next_timestamp = wp_next_scheduled( self::WP_CRON_HOOK );
+            if ( $next_timestamp ) {
+                wp_unschedule_event( $next_timestamp, self::WP_CRON_HOOK );
+            }
+
+            $schedule = apply_filters( 'action_scheduler_run_schedule', self::WP_CRON_SCHEDULE );
+            wp_schedule_event( time(), $schedule, self::WP_CRON_HOOK, $cron_context );
+        }
+
+        add_action( self::WP_CRON_HOOK, array( self::instance(), 'run' ) );
+        $this->hook_dispatch_async_request();
+    }
+
+    /**
+     * Hook check for dispatching an async request.
+     */
+    public function hook_dispatch_async_request() {
+        add_action( 'shutdown', array( $this, 'maybe_dispatch_async_request' ) );
+    }
+
+    /**
+     * Unhook check for dispatching an async request.
+     */
+    public function unhook_dispatch_async_request() {
+        remove_action( 'shutdown', array( $this, 'maybe_dispatch_async_request' ) );
+    }
+
+    /**
+     * Check if we should dispatch an async request to process actions.
+     *
+     * This method is attached to 'shutdown', so is called frequently. To avoid slowing down
+     * the site, it mitigates the work performed in each request by:
+     * 1. checking if it's in the admin context and then
+     * 2. haven't run on the 'shutdown' hook within the lock time (60 seconds by default)
+     * 3. haven't exceeded the number of allowed batches.
+     *
+     * The order of these checks is important, because they run from a check on a value:
+     * 1. in memory - is_admin() maps to $GLOBALS or the WP_ADMIN constant
+     * 2. in memory - transients use autoloaded options by default
+     * 3. from a database query - has_maximum_concurrent_batches() run the query
+     *    $this->store->get_claim_count() to find the current number of claims in the DB.
+     *
+     * If all of these conditions are met, then we request an async runner check whether it
+     * should dispatch a request to process pending actions.
+     */
+    public function maybe_dispatch_async_request() {
+        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();
+        }
+    }
+
+    /**
+     * Process actions in the queue. Attached to self::WP_CRON_HOOK i.e. 'action_scheduler_run_queue'
+     *
+     * The $context param of this method defaults to 'WP Cron', because prior to Action Scheduler 3.0.0
+     * that was the only context in which this method was run, and the self::WP_CRON_HOOK hook had no context
+     * passed along with it. New code calling this method directly, or by triggering the self::WP_CRON_HOOK,
+     * 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 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.
+     */
+    public function run( $context = 'WP Cron' ) {
+        ActionScheduler_Compatibility::raise_memory_limit();
+        ActionScheduler_Compatibility::raise_time_limit( $this->get_time_limit() );
+        do_action( 'action_scheduler_before_process_queue' );
+        $this->run_cleanup();
+        $processed_actions = 0;
+        if ( false === $this->has_maximum_concurrent_batches() ) {
+            $batch_size = apply_filters( 'action_scheduler_queue_runner_batch_size', 25 );
+            do {
+                $processed_actions_in_batch = $this->do_batch( $batch_size, $context );
+                $processed_actions         += $processed_actions_in_batch;
+            } while ( $processed_actions_in_batch > 0 && ! $this->batch_limits_exceeded( $processed_actions ) ); // keep going until we run out of actions, time, or memory
+        }
+
+        do_action( 'action_scheduler_after_process_queue' );
+        return $processed_actions;
+    }
+
+    /**
+     * Process a batch of actions pending in the queue.
+     *
+     * Actions are processed by claiming a set of pending actions then processing each one until either the batch
+     * 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 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.
+     */
+    protected function do_batch( $size = 100, $context = '' ) {
+        $claim = $this->store->stake_claim($size);
+        $this->monitor->attach($claim);
+        $processed_actions = 0;
+
+        foreach ( $claim->get_actions() as $action_id ) {
+            // bail if we lost the claim
+            if ( ! in_array( $action_id, $this->store->find_actions_by_claim_id( $claim->get_id() ) ) ) {
+                break;
+            }
+            $this->process_action( $action_id, $context );
+            $processed_actions++;
+
+            if ( $this->batch_limits_exceeded( $processed_actions ) ) {
+                break;
+            }
+        }
+        $this->store->release_claim($claim);
+        $this->monitor->detach();
+        $this->clear_caches();
+        return $processed_actions;
+    }
+
+    /**
+     * Running large batches can eat up memory, as WP adds data to its object cache.
+     *
+     * If using a persistent object store, this has the side effect of flushing that
+     * as well, so this is disabled by default. To enable:
+     *
+     * add_filter( 'action_scheduler_queue_runner_flush_cache', '__return_true' );
+     */
+    protected function clear_caches() {
+        if ( ! wp_using_ext_object_cache() || apply_filters( 'action_scheduler_queue_runner_flush_cache', false ) ) {
+            wp_cache_flush();
+        }
+    }
+
+    public function add_wp_cron_schedule( $schedules ) {
+        $schedules['every_minute'] = array(
+            'interval' => 60, // in seconds
+            'display'  => __( 'Every minute', 'action-scheduler' ),
+        );
+
+        return $schedules;
+    }
 }

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

Indentation +84 added lines, -84 removed lines

@@ -10,88 +10,88 @@
  */
 class ActionScheduler_AsyncRequest_QueueRunner extends WP_Async_Request {
 
-	/**
-	 * Data store for querying actions
-	 *
-	 * @var ActionScheduler_Store
-	 * @access protected
-	 */
-	protected $store;
-
-	/**
-	 * Prefix for ajax hooks
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $prefix = 'as';
-
-	/**
-	 * Action for ajax hooks
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $action = 'async_request_queue_runner';
-
-	/**
-	 * Initiate new async request
-	 */
-	public function __construct( ActionScheduler_Store $store ) {
-		parent::__construct();
-		$this->store = $store;
-	}
-
-	/**
-	 * Handle async requests
-	 *
-	 * Run a queue, and maybe dispatch another async request to run another queue
-	 * if there are still pending actions after completing a queue in this request.
-	 */
-	protected function handle() {
-		do_action( 'action_scheduler_run_queue', 'Async Request' ); // run a queue in the same way as WP Cron, but declare the Async Request context
-
-		$sleep_seconds = $this->get_sleep_seconds();
-
-		if ( $sleep_seconds ) {
-			sleep( $sleep_seconds );
-		}
-
-		$this->maybe_dispatch();
-	}
-
-	/**
-	 * If the async request runner is needed and allowed to run, dispatch a request.
-	 */
-	public function maybe_dispatch() {
-		if ( ! $this->allow() ) {
-			return;
-		}
-
-		$this->dispatch();
-		ActionScheduler_QueueRunner::instance()->unhook_dispatch_async_request();
-	}
-
-	/**
-	 * Only allow async requests when needed.
-	 *
-	 * Also allow 3rd party code to disable running actions via async requests.
-	 */
-	protected function allow() {
-
-		if ( ! has_action( 'action_scheduler_run_queue' ) || ActionScheduler::runner()->has_maximum_concurrent_batches() || ! $this->store->has_pending_actions_due() ) {
-			$allow = false;
-		} else {
-			$allow = true;
-		}
-
-		return apply_filters( 'action_scheduler_allow_async_request_runner', $allow );
-	}
-
-	/**
-	 * Chaining async requests can crash MySQL. A brief sleep call in PHP prevents that.
-	 */
-	protected function get_sleep_seconds() {
-		return apply_filters( 'action_scheduler_async_request_sleep_seconds', 5, $this );
-	}
+    /**
+     * Data store for querying actions
+     *
+     * @var ActionScheduler_Store
+     * @access protected
+     */
+    protected $store;
+
+    /**
+     * Prefix for ajax hooks
+     *
+     * @var string
+     * @access protected
+     */
+    protected $prefix = 'as';
+
+    /**
+     * Action for ajax hooks
+     *
+     * @var string
+     * @access protected
+     */
+    protected $action = 'async_request_queue_runner';
+
+    /**
+     * Initiate new async request
+     */
+    public function __construct( ActionScheduler_Store $store ) {
+        parent::__construct();
+        $this->store = $store;
+    }
+
+    /**
+     * Handle async requests
+     *
+     * Run a queue, and maybe dispatch another async request to run another queue
+     * if there are still pending actions after completing a queue in this request.
+     */
+    protected function handle() {
+        do_action( 'action_scheduler_run_queue', 'Async Request' ); // run a queue in the same way as WP Cron, but declare the Async Request context
+
+        $sleep_seconds = $this->get_sleep_seconds();
+
+        if ( $sleep_seconds ) {
+            sleep( $sleep_seconds );
+        }
+
+        $this->maybe_dispatch();
+    }
+
+    /**
+     * If the async request runner is needed and allowed to run, dispatch a request.
+     */
+    public function maybe_dispatch() {
+        if ( ! $this->allow() ) {
+            return;
+        }
+
+        $this->dispatch();
+        ActionScheduler_QueueRunner::instance()->unhook_dispatch_async_request();
+    }
+
+    /**
+     * Only allow async requests when needed.
+     *
+     * Also allow 3rd party code to disable running actions via async requests.
+     */
+    protected function allow() {
+
+        if ( ! has_action( 'action_scheduler_run_queue' ) || ActionScheduler::runner()->has_maximum_concurrent_batches() || ! $this->store->has_pending_actions_due() ) {
+            $allow = false;
+        } else {
+            $allow = true;
+        }
+
+        return apply_filters( 'action_scheduler_allow_async_request_runner', $allow );
+    }
+
+    /**
+     * Chaining async requests can crash MySQL. A brief sleep call in PHP prevents that.
+     */
+    protected function get_sleep_seconds() {
+        return apply_filters( 'action_scheduler_async_request_sleep_seconds', 5, $this );
+    }
 }

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

Indentation +104 added lines, -104 removed lines

@@ -7,109 +7,109 @@
  */
 class ActionScheduler_WPCommentCleaner {
 
-	/**
-	 * Post migration hook used to cleanup the WP comment table.
-	 *
-	 * @var string
-	 */
-	protected static $cleanup_hook = 'action_scheduler/cleanup_wp_comment_logs';
-
-	/**
-	 * An instance of the ActionScheduler_wpCommentLogger class to interact with the comments table.
-	 *
-	 * This instance should only be used as an interface. It should not be initialized.
-	 *
-	 * @var ActionScheduler_wpCommentLogger
-	 */
-	protected static $wp_comment_logger = null;
-
-	/**
-	 * The key used to store the cached value of whether there are logs in the WP comment table.
-	 *
-	 * @var string
-	 */
-	protected static $has_logs_option_key = 'as_has_wp_comment_logs';
-
-	/**
-	 * Initialize the class and attach callbacks.
-	 */
-	public static function init() {
-		if ( empty( self::$wp_comment_logger ) ) {
-			self::$wp_comment_logger = new ActionScheduler_wpCommentLogger();
-		}
-
-		add_action( self::$cleanup_hook, array( __CLASS__, 'delete_all_action_comments' ) );
-
-		// While there are orphaned logs left in the comments table, we need to attach the callbacks which filter comment counts.
-		add_action( 'pre_get_comments', array( self::$wp_comment_logger, 'filter_comment_queries' ), 10, 1 );
-		add_action( 'wp_count_comments', array( self::$wp_comment_logger, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
-		add_action( 'comment_feed_where', array( self::$wp_comment_logger, 'filter_comment_feed' ), 10, 2 );
-
-		// Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen
-		add_action( 'load-tools_page_action-scheduler', array( __CLASS__, 'register_admin_notice' ) );
-		add_action( 'load-woocommerce_page_wc-status', array( __CLASS__, 'register_admin_notice' ) );
-	}
-
-	/**
-	 * Determines if there are log entries in the wp comments table.
-	 *
-	 * Uses the flag set on migration completion set by @see self::maybe_schedule_cleanup().
-	 *
-	 * @return boolean Whether there are scheduled action comments in the comments table.
-	 */
-	public static function has_logs() {
-		return 'yes' === get_option( self::$has_logs_option_key );
-	}
-
-	/**
-	 * Schedules the WP Post comment table cleanup to run in 6 months if it's not already scheduled.
-	 * Attached to the migration complete hook 'action_scheduler/migration_complete'.
-	 */
-	public static function maybe_schedule_cleanup() {
-		if ( (bool) get_comments( array( 'type' => ActionScheduler_wpCommentLogger::TYPE, 'number' => 1, 'fields' => 'ids' ) ) ) {
-			update_option( self::$has_logs_option_key, 'yes' );
-
-			if ( ! as_next_scheduled_action( self::$cleanup_hook ) ) {
-				as_schedule_single_action( gmdate( 'U' ) + ( 6 * MONTH_IN_SECONDS ), self::$cleanup_hook );
-			}
-		}
-	}
-
-	/**
-	 * Delete all action comments from the WP Comments table.
-	 */
-	public static function delete_all_action_comments() {
-		global $wpdb;
-		$wpdb->delete( $wpdb->comments, array( 'comment_type' => ActionScheduler_wpCommentLogger::TYPE, 'comment_agent' => ActionScheduler_wpCommentLogger::AGENT ) );
-		delete_option( self::$has_logs_option_key );
-	}
-
-	/**
-	 * Registers admin notices about the orphaned action logs.
-	 */
-	public static function register_admin_notice() {
-		add_action( 'admin_notices', array( __CLASS__, 'print_admin_notice' ) );
-	}
+    /**
+     * Post migration hook used to cleanup the WP comment table.
+     *
+     * @var string
+     */
+    protected static $cleanup_hook = 'action_scheduler/cleanup_wp_comment_logs';
+
+    /**
+     * An instance of the ActionScheduler_wpCommentLogger class to interact with the comments table.
+     *
+     * This instance should only be used as an interface. It should not be initialized.
+     *
+     * @var ActionScheduler_wpCommentLogger
+     */
+    protected static $wp_comment_logger = null;
+
+    /**
+     * The key used to store the cached value of whether there are logs in the WP comment table.
+     *
+     * @var string
+     */
+    protected static $has_logs_option_key = 'as_has_wp_comment_logs';
+
+    /**
+     * Initialize the class and attach callbacks.
+     */
+    public static function init() {
+        if ( empty( self::$wp_comment_logger ) ) {
+            self::$wp_comment_logger = new ActionScheduler_wpCommentLogger();
+        }
+
+        add_action( self::$cleanup_hook, array( __CLASS__, 'delete_all_action_comments' ) );
+
+        // While there are orphaned logs left in the comments table, we need to attach the callbacks which filter comment counts.
+        add_action( 'pre_get_comments', array( self::$wp_comment_logger, 'filter_comment_queries' ), 10, 1 );
+        add_action( 'wp_count_comments', array( self::$wp_comment_logger, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
+        add_action( 'comment_feed_where', array( self::$wp_comment_logger, 'filter_comment_feed' ), 10, 2 );
+
+        // Action Scheduler may be displayed as a Tools screen or WooCommerce > Status administration screen
+        add_action( 'load-tools_page_action-scheduler', array( __CLASS__, 'register_admin_notice' ) );
+        add_action( 'load-woocommerce_page_wc-status', array( __CLASS__, 'register_admin_notice' ) );
+    }
+
+    /**
+     * Determines if there are log entries in the wp comments table.
+     *
+     * Uses the flag set on migration completion set by @see self::maybe_schedule_cleanup().
+     *
+     * @return boolean Whether there are scheduled action comments in the comments table.
+     */
+    public static function has_logs() {
+        return 'yes' === get_option( self::$has_logs_option_key );
+    }
+
+    /**
+     * Schedules the WP Post comment table cleanup to run in 6 months if it's not already scheduled.
+     * Attached to the migration complete hook 'action_scheduler/migration_complete'.
+     */
+    public static function maybe_schedule_cleanup() {
+        if ( (bool) get_comments( array( 'type' => ActionScheduler_wpCommentLogger::TYPE, 'number' => 1, 'fields' => 'ids' ) ) ) {
+            update_option( self::$has_logs_option_key, 'yes' );
+
+            if ( ! as_next_scheduled_action( self::$cleanup_hook ) ) {
+                as_schedule_single_action( gmdate( 'U' ) + ( 6 * MONTH_IN_SECONDS ), self::$cleanup_hook );
+            }
+        }
+    }
+
+    /**
+     * Delete all action comments from the WP Comments table.
+     */
+    public static function delete_all_action_comments() {
+        global $wpdb;
+        $wpdb->delete( $wpdb->comments, array( 'comment_type' => ActionScheduler_wpCommentLogger::TYPE, 'comment_agent' => ActionScheduler_wpCommentLogger::AGENT ) );
+        delete_option( self::$has_logs_option_key );
+    }
+
+    /**
+     * Registers admin notices about the orphaned action logs.
+     */
+    public static function register_admin_notice() {
+        add_action( 'admin_notices', array( __CLASS__, 'print_admin_notice' ) );
+    }
 	
-	/**
-	 * Prints details about the orphaned action logs and includes information on where to learn more.
-	 */
-	public static function print_admin_notice() {
-		$next_cleanup_message        = '';
-		$next_scheduled_cleanup_hook = as_next_scheduled_action( self::$cleanup_hook );
-
-		if ( $next_scheduled_cleanup_hook ) {
-			/* translators: %s: date interval */
-			$next_cleanup_message = sprintf( __( 'This data will be deleted in %s.', 'action-scheduler' ), human_time_diff( gmdate( 'U' ), $next_scheduled_cleanup_hook ) );
-		}
-
-		$notice = sprintf(
-			/* translators: 1: next cleanup message 2: github issue URL */
-			__( 'Action Scheduler has migrated data to custom tables; however, orphaned log entries exist in the WordPress Comments table. %1$s <a href="%2$s">Learn more &raquo;</a>', 'action-scheduler' ),
-			$next_cleanup_message,
-			'https://github.com/woocommerce/action-scheduler/issues/368'
-		);
-
-		echo '<div class="notice notice-warning"><p>' . wp_kses_post( $notice ) . '</p></div>';
-	}
+    /**
+     * Prints details about the orphaned action logs and includes information on where to learn more.
+     */
+    public static function print_admin_notice() {
+        $next_cleanup_message        = '';
+        $next_scheduled_cleanup_hook = as_next_scheduled_action( self::$cleanup_hook );
+
+        if ( $next_scheduled_cleanup_hook ) {
+            /* translators: %s: date interval */
+            $next_cleanup_message = sprintf( __( 'This data will be deleted in %s.', 'action-scheduler' ), human_time_diff( gmdate( 'U' ), $next_scheduled_cleanup_hook ) );
+        }
+
+        $notice = sprintf(
+            /* translators: 1: next cleanup message 2: github issue URL */
+            __( 'Action Scheduler has migrated data to custom tables; however, orphaned log entries exist in the WordPress Comments table. %1$s <a href="%2$s">Learn more &raquo;</a>', 'action-scheduler' ),
+            $next_cleanup_message,
+            'https://github.com/woocommerce/action-scheduler/issues/368'
+        );
+
+        echo '<div class="notice notice-warning"><p>' . wp_kses_post( $notice ) . '</p></div>';
+    }
 }

includes/libraries/action-scheduler/classes/actions/ActionScheduler_FinishedAction.php

Indentation +7 added lines, -7 removed lines

@@ -5,12 +5,12 @@
  */
 class ActionScheduler_FinishedAction extends ActionScheduler_Action {
 
-	public function execute() {
-		// don't execute
-	}
+    public function execute() {
+        // don't execute
+    }
 
-	public function is_finished() {
-		return TRUE;
-	}
+    public function is_finished() {
+        return TRUE;
+    }
 }
- 
\ No newline at end of file
+    
\ No newline at end of file

includes/libraries/action-scheduler/classes/actions/ActionScheduler_CanceledAction.php

Indentation +12 added lines, -12 removed lines

@@ -8,16 +8,16 @@
  */
 class ActionScheduler_CanceledAction extends ActionScheduler_FinishedAction {
 
-	/**
-	 * @param string $hook
-	 * @param array $args
-	 * @param ActionScheduler_Schedule $schedule
-	 * @param string $group
-	 */
-	public function __construct( $hook, array $args = array(), ActionScheduler_Schedule $schedule = null, $group = '' ) {
-		parent::__construct( $hook, $args, $schedule, $group );
-		if ( is_null( $schedule ) ) {
-			$this->set_schedule( new ActionScheduler_NullSchedule() );
-		}
-	}
+    /**
+     * @param string $hook
+     * @param array $args
+     * @param ActionScheduler_Schedule $schedule
+     * @param string $group
+     */
+    public function __construct( $hook, array $args = array(), ActionScheduler_Schedule $schedule = null, $group = '' ) {
+        parent::__construct( $hook, $args, $schedule, $group );
+        if ( is_null( $schedule ) ) {
+            $this->set_schedule( new ActionScheduler_NullSchedule() );
+        }
+    }
 }