AyeCode / invoicing

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 );
+    }
 }

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

Indentation +55 added lines, -55 removed lines

@@ -4,59 +4,59 @@
  * Class ActionScheduler_Versions
  */
 class ActionScheduler_Versions {
-	/**
-	 * @var ActionScheduler_Versions
-	 */
-	private static $instance = NULL;
-
-	private $versions = array();
-
-	public function register( $version_string, $initialization_callback ) {
-		if ( isset($this->versions[$version_string]) ) {
-			return FALSE;
-		}
-		$this->versions[$version_string] = $initialization_callback;
-		return TRUE;
-	}
-
-	public function get_versions() {
-		return $this->versions;
-	}
-
-	public function latest_version() {
-		$keys = array_keys($this->versions);
-		if ( empty($keys) ) {
-			return false;
-		}
-		uasort( $keys, 'version_compare' );
-		return end($keys);
-	}
-
-	public function latest_version_callback() {
-		$latest = $this->latest_version();
-		if ( empty($latest) || !isset($this->versions[$latest]) ) {
-			return '__return_null';
-		}
-		return $this->versions[$latest];
-	}
-
-	/**
-	 * @return ActionScheduler_Versions
-	 * @codeCoverageIgnore
-	 */
-	public static function instance() {
-		if ( empty(self::$instance) ) {
-			self::$instance = new self();
-		}
-		return self::$instance;
-	}
-
-	/**
-	 * @codeCoverageIgnore
-	 */
-	public static function initialize_latest_version() {
-		$self = self::instance();
-		call_user_func($self->latest_version_callback());
-	}
+    /**
+     * @var ActionScheduler_Versions
+     */
+    private static $instance = NULL;
+
+    private $versions = array();
+
+    public function register( $version_string, $initialization_callback ) {
+        if ( isset($this->versions[$version_string]) ) {
+            return FALSE;
+        }
+        $this->versions[$version_string] = $initialization_callback;
+        return TRUE;
+    }
+
+    public function get_versions() {
+        return $this->versions;
+    }
+
+    public function latest_version() {
+        $keys = array_keys($this->versions);
+        if ( empty($keys) ) {
+            return false;
+        }
+        uasort( $keys, 'version_compare' );
+        return end($keys);
+    }
+
+    public function latest_version_callback() {
+        $latest = $this->latest_version();
+        if ( empty($latest) || !isset($this->versions[$latest]) ) {
+            return '__return_null';
+        }
+        return $this->versions[$latest];
+    }
+
+    /**
+     * @return ActionScheduler_Versions
+     * @codeCoverageIgnore
+     */
+    public static function instance() {
+        if ( empty(self::$instance) ) {
+            self::$instance = new self();
+        }
+        return self::$instance;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public static function initialize_latest_version() {
+        $self = self::instance();
+        call_user_func($self->latest_version_callback());
+    }
 }
- 
\ No newline at end of file
+    
\ No newline at end of file

includes/libraries/action-scheduler/classes/abstracts/ActionScheduler_Abstract_QueueRunner.php

Indentation +232 added lines, -232 removed lines

@@ -5,236 +5,236 @@
  */
 abstract class ActionScheduler_Abstract_QueueRunner extends ActionScheduler_Abstract_QueueRunner_Deprecated {
 
-	/** @var ActionScheduler_QueueCleaner */
-	protected $cleaner;
-
-	/** @var ActionScheduler_FatalErrorMonitor */
-	protected $monitor;
-
-	/** @var ActionScheduler_Store */
-	protected $store;
-
-	/**
-	 * The created time.
-	 *
-	 * Represents when the queue runner was constructed and used when calculating how long a PHP request has been running.
-	 * For this reason it should be as close as possible to the PHP request start time.
-	 *
-	 * @var int
-	 */
-	private $created_time;
-
-	/**
-	 * ActionScheduler_Abstract_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 ) {
-
-		$this->created_time = microtime( true );
-
-		$this->store   = $store ? $store : ActionScheduler_Store::instance();
-		$this->monitor = $monitor ? $monitor : new ActionScheduler_FatalErrorMonitor( $this->store );
-		$this->cleaner = $cleaner ? $cleaner : new ActionScheduler_QueueCleaner( $this->store );
-	}
-
-	/**
-	 * Process an individual action.
-	 *
-	 * @param int $action_id The action ID to process.
-	 * @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.
-	 */
-	public function process_action( $action_id, $context = '' ) {
-		try {
-			$valid_action = false;
-			do_action( 'action_scheduler_before_execute', $action_id, $context );
-
-			if ( ActionScheduler_Store::STATUS_PENDING !== $this->store->get_status( $action_id ) ) {
-				do_action( 'action_scheduler_execution_ignored', $action_id, $context );
-				return;
-			}
-
-			$valid_action = true;
-			do_action( 'action_scheduler_begin_execute', $action_id, $context );
-
-			$action = $this->store->fetch_action( $action_id );
-			$this->store->log_execution( $action_id );
-			$action->execute();
-			do_action( 'action_scheduler_after_execute', $action_id, $action, $context );
-			$this->store->mark_complete( $action_id );
-		} catch ( Exception $e ) {
-			if ( $valid_action ) {
-				$this->store->mark_failure( $action_id );
-				do_action( 'action_scheduler_failed_execution', $action_id, $e, $context );
-			} else {
-				do_action( 'action_scheduler_failed_validation', $action_id, $e, $context );
-			}
-		}
-
-		if ( isset( $action ) && is_a( $action, 'ActionScheduler_Action' ) && $action->get_schedule()->is_recurring() ) {
-			$this->schedule_next_instance( $action, $action_id );
-		}
-	}
-
-	/**
-	 * Schedule the next instance of the action if necessary.
-	 *
-	 * @param ActionScheduler_Action $action
-	 * @param int $action_id
-	 */
-	protected function schedule_next_instance( ActionScheduler_Action $action, $action_id ) {
-		try {
-			ActionScheduler::factory()->repeat( $action );
-		} catch ( Exception $e ) {
-			do_action( 'action_scheduler_failed_to_schedule_next_instance', $action_id, $e, $action );
-		}
-	}
-
-	/**
-	 * Run the queue cleaner.
-	 *
-	 * @author Jeremy Pry
-	 */
-	protected function run_cleanup() {
-		$this->cleaner->clean( 10 * $this->get_time_limit() );
-	}
-
-	/**
-	 * Get the number of concurrent batches a runner allows.
-	 *
-	 * @return int
-	 */
-	public function get_allowed_concurrent_batches() {
-		return apply_filters( 'action_scheduler_queue_runner_concurrent_batches', 1 );
-	}
-
-	/**
-	 * Check if the number of allowed concurrent batches is met or exceeded.
-	 *
-	 * @return bool
-	 */
-	public function has_maximum_concurrent_batches() {
-		return $this->store->get_claim_count() >= $this->get_allowed_concurrent_batches();
-	}
-
-	/**
-	 * Get the maximum number of seconds a batch can run for.
-	 *
-	 * @return int The number of seconds.
-	 */
-	protected function get_time_limit() {
-
-		$time_limit = 30;
-
-		// Apply deprecated filter from deprecated get_maximum_execution_time() method
-		if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) {
-			_deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' );
-			$time_limit = apply_filters( 'action_scheduler_maximum_execution_time', $time_limit );
-		}
-
-		return absint( apply_filters( 'action_scheduler_queue_runner_time_limit', $time_limit ) );
-	}
-
-	/**
-	 * Get the number of seconds the process has been running.
-	 *
-	 * @return int The number of seconds.
-	 */
-	protected function get_execution_time() {
-		$execution_time = microtime( true ) - $this->created_time;
-
-		// Get the CPU time if the hosting environment uses it rather than wall-clock time to calculate a process's execution time.
-		if ( function_exists( 'getrusage' ) && apply_filters( 'action_scheduler_use_cpu_execution_time', defined( 'PANTHEON_ENVIRONMENT' ) ) ) {
-			$resource_usages = getrusage();
-
-			if ( isset( $resource_usages['ru_stime.tv_usec'], $resource_usages['ru_stime.tv_usec'] ) ) {
-				$execution_time = $resource_usages['ru_stime.tv_sec'] + ( $resource_usages['ru_stime.tv_usec'] / 1000000 );
-			}
-		}
-
-		return $execution_time;
-	}
-
-	/**
-	 * Check if the host's max execution time is (likely) to be exceeded if processing more actions.
-	 *
-	 * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
-	 * @return bool
-	 */
-	protected function time_likely_to_be_exceeded( $processed_actions ) {
-
-		$execution_time        = $this->get_execution_time();
-		$max_execution_time    = $this->get_time_limit();
-		$time_per_action       = $execution_time / $processed_actions;
-		$estimated_time        = $execution_time + ( $time_per_action * 3 );
-		$likely_to_be_exceeded = $estimated_time > $max_execution_time;
-
-		return apply_filters( 'action_scheduler_maximum_execution_time_likely_to_be_exceeded', $likely_to_be_exceeded, $this, $processed_actions, $execution_time, $max_execution_time );
-	}
-
-	/**
-	 * Get memory limit
-	 *
-	 * Based on WP_Background_Process::get_memory_limit()
-	 *
-	 * @return int
-	 */
-	protected function get_memory_limit() {
-		if ( function_exists( 'ini_get' ) ) {
-			$memory_limit = ini_get( 'memory_limit' );
-		} else {
-			$memory_limit = '128M'; // Sensible default, and minimum required by WooCommerce
-		}
-
-		if ( ! $memory_limit || -1 === $memory_limit || '-1' === $memory_limit ) {
-			// Unlimited, set to 32GB.
-			$memory_limit = '32G';
-		}
-
-		return ActionScheduler_Compatibility::convert_hr_to_bytes( $memory_limit );
-	}
-
-	/**
-	 * Memory exceeded
-	 *
-	 * Ensures the batch process never exceeds 90% of the maximum WordPress memory.
-	 *
-	 * Based on WP_Background_Process::memory_exceeded()
-	 *
-	 * @return bool
-	 */
-	protected function memory_exceeded() {
-
-		$memory_limit    = $this->get_memory_limit() * 0.90;
-		$current_memory  = memory_get_usage( true );
-		$memory_exceeded = $current_memory >= $memory_limit;
-
-		return apply_filters( 'action_scheduler_memory_exceeded', $memory_exceeded, $this );
-	}
-
-	/**
-	 * See if the batch limits have been exceeded, which is when memory usage is almost at
-	 * the maximum limit, or the time to process more actions will exceed the max time limit.
-	 *
-	 * Based on WC_Background_Process::batch_limits_exceeded()
-	 *
-	 * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
-	 * @return bool
-	 */
-	protected function batch_limits_exceeded( $processed_actions ) {
-		return $this->memory_exceeded() || $this->time_likely_to_be_exceeded( $processed_actions );
-	}
-
-	/**
-	 * Process actions in the queue.
-	 *
-	 * @author Jeremy Pry
-	 * @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.
-	 */
-	abstract public function run( $context = '' );
+    /** @var ActionScheduler_QueueCleaner */
+    protected $cleaner;
+
+    /** @var ActionScheduler_FatalErrorMonitor */
+    protected $monitor;
+
+    /** @var ActionScheduler_Store */
+    protected $store;
+
+    /**
+     * The created time.
+     *
+     * Represents when the queue runner was constructed and used when calculating how long a PHP request has been running.
+     * For this reason it should be as close as possible to the PHP request start time.
+     *
+     * @var int
+     */
+    private $created_time;
+
+    /**
+     * ActionScheduler_Abstract_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 ) {
+
+        $this->created_time = microtime( true );
+
+        $this->store   = $store ? $store : ActionScheduler_Store::instance();
+        $this->monitor = $monitor ? $monitor : new ActionScheduler_FatalErrorMonitor( $this->store );
+        $this->cleaner = $cleaner ? $cleaner : new ActionScheduler_QueueCleaner( $this->store );
+    }
+
+    /**
+     * Process an individual action.
+     *
+     * @param int $action_id The action ID to process.
+     * @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.
+     */
+    public function process_action( $action_id, $context = '' ) {
+        try {
+            $valid_action = false;
+            do_action( 'action_scheduler_before_execute', $action_id, $context );
+
+            if ( ActionScheduler_Store::STATUS_PENDING !== $this->store->get_status( $action_id ) ) {
+                do_action( 'action_scheduler_execution_ignored', $action_id, $context );
+                return;
+            }
+
+            $valid_action = true;
+            do_action( 'action_scheduler_begin_execute', $action_id, $context );
+
+            $action = $this->store->fetch_action( $action_id );
+            $this->store->log_execution( $action_id );
+            $action->execute();
+            do_action( 'action_scheduler_after_execute', $action_id, $action, $context );
+            $this->store->mark_complete( $action_id );
+        } catch ( Exception $e ) {
+            if ( $valid_action ) {
+                $this->store->mark_failure( $action_id );
+                do_action( 'action_scheduler_failed_execution', $action_id, $e, $context );
+            } else {
+                do_action( 'action_scheduler_failed_validation', $action_id, $e, $context );
+            }
+        }
+
+        if ( isset( $action ) && is_a( $action, 'ActionScheduler_Action' ) && $action->get_schedule()->is_recurring() ) {
+            $this->schedule_next_instance( $action, $action_id );
+        }
+    }
+
+    /**
+     * Schedule the next instance of the action if necessary.
+     *
+     * @param ActionScheduler_Action $action
+     * @param int $action_id
+     */
+    protected function schedule_next_instance( ActionScheduler_Action $action, $action_id ) {
+        try {
+            ActionScheduler::factory()->repeat( $action );
+        } catch ( Exception $e ) {
+            do_action( 'action_scheduler_failed_to_schedule_next_instance', $action_id, $e, $action );
+        }
+    }
+
+    /**
+     * Run the queue cleaner.
+     *
+     * @author Jeremy Pry
+     */
+    protected function run_cleanup() {
+        $this->cleaner->clean( 10 * $this->get_time_limit() );
+    }
+
+    /**
+     * Get the number of concurrent batches a runner allows.
+     *
+     * @return int
+     */
+    public function get_allowed_concurrent_batches() {
+        return apply_filters( 'action_scheduler_queue_runner_concurrent_batches', 1 );
+    }
+
+    /**
+     * Check if the number of allowed concurrent batches is met or exceeded.
+     *
+     * @return bool
+     */
+    public function has_maximum_concurrent_batches() {
+        return $this->store->get_claim_count() >= $this->get_allowed_concurrent_batches();
+    }
+
+    /**
+     * Get the maximum number of seconds a batch can run for.
+     *
+     * @return int The number of seconds.
+     */
+    protected function get_time_limit() {
+
+        $time_limit = 30;
+
+        // Apply deprecated filter from deprecated get_maximum_execution_time() method
+        if ( has_filter( 'action_scheduler_maximum_execution_time' ) ) {
+            _deprecated_function( 'action_scheduler_maximum_execution_time', '2.1.1', 'action_scheduler_queue_runner_time_limit' );
+            $time_limit = apply_filters( 'action_scheduler_maximum_execution_time', $time_limit );
+        }
+
+        return absint( apply_filters( 'action_scheduler_queue_runner_time_limit', $time_limit ) );
+    }
+
+    /**
+     * Get the number of seconds the process has been running.
+     *
+     * @return int The number of seconds.
+     */
+    protected function get_execution_time() {
+        $execution_time = microtime( true ) - $this->created_time;
+
+        // Get the CPU time if the hosting environment uses it rather than wall-clock time to calculate a process's execution time.
+        if ( function_exists( 'getrusage' ) && apply_filters( 'action_scheduler_use_cpu_execution_time', defined( 'PANTHEON_ENVIRONMENT' ) ) ) {
+            $resource_usages = getrusage();
+
+            if ( isset( $resource_usages['ru_stime.tv_usec'], $resource_usages['ru_stime.tv_usec'] ) ) {
+                $execution_time = $resource_usages['ru_stime.tv_sec'] + ( $resource_usages['ru_stime.tv_usec'] / 1000000 );
+            }
+        }
+
+        return $execution_time;
+    }
+
+    /**
+     * Check if the host's max execution time is (likely) to be exceeded if processing more actions.
+     *
+     * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
+     * @return bool
+     */
+    protected function time_likely_to_be_exceeded( $processed_actions ) {
+
+        $execution_time        = $this->get_execution_time();
+        $max_execution_time    = $this->get_time_limit();
+        $time_per_action       = $execution_time / $processed_actions;
+        $estimated_time        = $execution_time + ( $time_per_action * 3 );
+        $likely_to_be_exceeded = $estimated_time > $max_execution_time;
+
+        return apply_filters( 'action_scheduler_maximum_execution_time_likely_to_be_exceeded', $likely_to_be_exceeded, $this, $processed_actions, $execution_time, $max_execution_time );
+    }
+
+    /**
+     * Get memory limit
+     *
+     * Based on WP_Background_Process::get_memory_limit()
+     *
+     * @return int
+     */
+    protected function get_memory_limit() {
+        if ( function_exists( 'ini_get' ) ) {
+            $memory_limit = ini_get( 'memory_limit' );
+        } else {
+            $memory_limit = '128M'; // Sensible default, and minimum required by WooCommerce
+        }
+
+        if ( ! $memory_limit || -1 === $memory_limit || '-1' === $memory_limit ) {
+            // Unlimited, set to 32GB.
+            $memory_limit = '32G';
+        }
+
+        return ActionScheduler_Compatibility::convert_hr_to_bytes( $memory_limit );
+    }
+
+    /**
+     * Memory exceeded
+     *
+     * Ensures the batch process never exceeds 90% of the maximum WordPress memory.
+     *
+     * Based on WP_Background_Process::memory_exceeded()
+     *
+     * @return bool
+     */
+    protected function memory_exceeded() {
+
+        $memory_limit    = $this->get_memory_limit() * 0.90;
+        $current_memory  = memory_get_usage( true );
+        $memory_exceeded = $current_memory >= $memory_limit;
+
+        return apply_filters( 'action_scheduler_memory_exceeded', $memory_exceeded, $this );
+    }
+
+    /**
+     * See if the batch limits have been exceeded, which is when memory usage is almost at
+     * the maximum limit, or the time to process more actions will exceed the max time limit.
+     *
+     * Based on WC_Background_Process::batch_limits_exceeded()
+     *
+     * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action
+     * @return bool
+     */
+    protected function batch_limits_exceeded( $processed_actions ) {
+        return $this->memory_exceeded() || $this->time_likely_to_be_exceeded( $processed_actions );
+    }
+
+    /**
+     * Process actions in the queue.
+     *
+     * @author Jeremy Pry
+     * @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.
+     */
+    abstract public function run( $context = '' );
 }

includes/libraries/action-scheduler/classes/abstracts/ActionScheduler_Abstract_ListTable.php

Indentation +649 added lines, -649 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! class_exists( 'WP_List_Table' ) ) {
-	require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
+    require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
 }
 
 /**
@@ -23,652 +23,652 @@ 
  */
 abstract class ActionScheduler_Abstract_ListTable extends WP_List_Table {
 
-	/**
-	 * The table name
-	 */
-	protected $table_name;
-
-	/**
-	 * Package name, used to get options from WP_List_Table::get_items_per_page.
-	 */
-	protected $package;
-
-	/**
-	 * How many items do we render per page?
-	 */
-	protected $items_per_page = 10;
-
-	/**
-	 * Enables search in this table listing. If this array
-	 * is empty it means the listing is not searchable.
-	 */
-	protected $search_by = array();
-
-	/**
-	 * Columns to show in the table listing. It is a key => value pair. The
-	 * key must much the table column name and the value is the label, which is
-	 * automatically translated.
-	 */
-	protected $columns = array();
-
-	/**
-	 * Defines the row-actions. It expects an array where the key
-	 * is the column name and the value is an array of actions.
-	 *
-	 * The array of actions are key => value, where key is the method name
-	 * (with the prefix row_action_<key>) and the value is the label
-	 * and title.
-	 */
-	protected $row_actions = array();
-
-	/**
-	 * The Primary key of our table
-	 */
-	protected $ID = 'ID';
-
-	/**
-	 * Enables sorting, it expects an array
-	 * of columns (the column names are the values)
-	 */
-	protected $sort_by = array();
-
-	protected $filter_by = array();
-
-	/**
-	 * @var array The status name => count combinations for this table's items. Used to display status filters.
-	 */
-	protected $status_counts = array();
-
-	/**
-	 * @var array Notices to display when loading the table. Array of arrays of form array( 'class' => {updated|error}, 'message' => 'This is the notice text display.' ).
-	 */
-	protected $admin_notices = array();
-
-	/**
-	 * @var string Localised string displayed in the <h1> element above the able.
-	 */
-	protected $table_header;
-
-	/**
-	 * Enables bulk actions. It must be an array where the key is the action name
-	 * and the value is the label (which is translated automatically). It is important
-	 * to notice that it will check that the method exists (`bulk_$name`) and will throw
-	 * an exception if it does not exists.
-	 *
-	 * This class will automatically check if the current request has a bulk action, will do the
-	 * validations and afterwards will execute the bulk method, with two arguments. The first argument
-	 * is the array with primary keys, the second argument is a string with a list of the primary keys,
-	 * escaped and ready to use (with `IN`).
-	 */
-	protected $bulk_actions = array();
-
-	/**
-	 * Makes translation easier, it basically just wraps
-	 * `_x` with some default (the package name).
-	 * 
-	 * @deprecated 3.0.0
-	 */
-	protected function translate( $text, $context = '' ) {
-		return $text;
-	}
-
-	/**
-	 * Reads `$this->bulk_actions` and returns an array that WP_List_Table understands. It
-	 * also validates that the bulk method handler exists. It throws an exception because
-	 * this is a library meant for developers and missing a bulk method is a development-time error.
-	 */
-	protected function get_bulk_actions() {
-		$actions = array();
-
-		foreach ( $this->bulk_actions as $action => $label ) {
-			if ( ! is_callable( array( $this, 'bulk_' . $action ) ) ) {
-				throw new RuntimeException( "The bulk action $action does not have a callback method" );
-			}
-
-			$actions[ $action ] = $label;
-		}
-
-		return $actions;
-	}
-
-	/**
-	 * Checks if the current request has a bulk action. If that is the case it will validate and will
-	 * execute the bulk method handler. Regardless if the action is valid or not it will redirect to
-	 * the previous page removing the current arguments that makes this request a bulk action.
-	 */
-	protected function process_bulk_action() {
-		global $wpdb;
-		// Detect when a bulk action is being triggered.
-		$action = $this->current_action();
-		if ( ! $action ) {
-			return;
-		}
-
-		check_admin_referer( 'bulk-' . $this->_args['plural'] );
-
-		$method   = 'bulk_' . $action;
-		if ( array_key_exists( $action, $this->bulk_actions ) && is_callable( array( $this, $method ) ) && ! empty( $_GET['ID'] ) && is_array( $_GET['ID'] ) ) {
-			$ids_sql = '(' . implode( ',', array_fill( 0, count( $_GET['ID'] ), '%s' ) ) . ')';
-			$this->$method( $_GET['ID'], $wpdb->prepare( $ids_sql, $_GET['ID'] ) );
-		}
-
-		wp_redirect( remove_query_arg(
-			array( '_wp_http_referer', '_wpnonce', 'ID', 'action', 'action2' ),
-			wp_unslash( $_SERVER['REQUEST_URI'] )
-		) );
-		exit;
-	}
-
-	/**
-	 * Default code for deleting entries.
-	 * validated already by process_bulk_action()
-	 */
-	protected function bulk_delete( array $ids, $ids_sql ) {
-		$store = ActionScheduler::store();
-		foreach ( $ids as $action_id ) {
-			$store->delete( $action_id );
-		}
-	}
-
-	/**
-	 * Prepares the _column_headers property which is used by WP_Table_List at rendering.
-	 * It merges the columns and the sortable columns.
-	 */
-	protected function prepare_column_headers() {
-		$this->_column_headers = array(
-			$this->get_columns(),
-			array(),
-			$this->get_sortable_columns(),
-		);
-	}
-
-	/**
-	 * Reads $this->sort_by and returns the columns name in a format that WP_Table_List
-	 * expects
-	 */
-	public function get_sortable_columns() {
-		$sort_by = array();
-		foreach ( $this->sort_by as $column ) {
-			$sort_by[ $column ] = array( $column, true );
-		}
-		return $sort_by;
-	}
-
-	/**
-	 * Returns the columns names for rendering. It adds a checkbox for selecting everything
-	 * as the first column
-	 */
-	public function get_columns() {
-		$columns = array_merge(
-			array( 'cb' => '<input type="checkbox" />' ),
-			$this->columns
-		);
-
-		return $columns;
-	}
-
-	/**
-	 * Get prepared LIMIT clause for items query
-	 *
-	 * @global wpdb $wpdb
-	 *
-	 * @return string Prepared LIMIT clause for items query.
-	 */
-	protected function get_items_query_limit() {
-		global $wpdb;
-
-		$per_page = $this->get_items_per_page( $this->package . '_items_per_page', $this->items_per_page );
-		return $wpdb->prepare( 'LIMIT %d', $per_page );
-	}
-
-	/**
-	 * Returns the number of items to offset/skip for this current view.
-	 *
-	 * @return int
-	 */
-	protected function get_items_offset() {
-		$per_page = $this->get_items_per_page( $this->package . '_items_per_page', $this->items_per_page );
-		$current_page = $this->get_pagenum();
-		if ( 1 < $current_page ) {
-			$offset = $per_page * ( $current_page - 1 );
-		} else {
-			$offset = 0;
-		}
-
-		return $offset;
-	}
-
-	/**
-	 * Get prepared OFFSET clause for items query
-	 *
-	 * @global wpdb $wpdb
-	 *
-	 * @return string Prepared OFFSET clause for items query.
-	 */
-	protected function get_items_query_offset() {
-		global $wpdb;
-
-		return $wpdb->prepare( 'OFFSET %d', $this->get_items_offset() );
-	}
-
-	/**
-	 * Prepares the ORDER BY sql statement. It uses `$this->sort_by` to know which
-	 * columns are sortable. This requests validates the orderby $_GET parameter is a valid
-	 * column and sortable. It will also use order (ASC|DESC) using DESC by default.
-	 */
-	protected function get_items_query_order() {
-		if ( empty( $this->sort_by ) ) {
-			return '';
-		}
-
-		$orderby = esc_sql( $this->get_request_orderby() );
-		$order   = esc_sql( $this->get_request_order() );
-
-		return "ORDER BY {$orderby} {$order}";
-	}
-
-	/**
-	 * Return the sortable column specified for this request to order the results by, if any.
-	 *
-	 * @return string
-	 */
-	protected function get_request_orderby() {
-
-		$valid_sortable_columns = array_values( $this->sort_by );
-
-		if ( ! empty( $_GET['orderby'] ) && in_array( $_GET['orderby'], $valid_sortable_columns ) ) {
-			$orderby = sanitize_text_field( $_GET['orderby'] );
-		} else {
-			$orderby = $valid_sortable_columns[0];
-		}
-
-		return $orderby;
-	}
-
-	/**
-	 * Return the sortable column order specified for this request.
-	 *
-	 * @return string
-	 */
-	protected function get_request_order() {
-
-		if ( ! empty( $_GET['order'] ) && 'desc' === strtolower( $_GET['order'] ) ) {
-			$order = 'DESC';
-		} else {
-			$order = 'ASC';
-		}
-
-		return $order;
-	}
-
-	/**
-	 * Return the status filter for this request, if any.
-	 *
-	 * @return string
-	 */
-	protected function get_request_status() {
-		$status = ( ! empty( $_GET['status'] ) ) ? $_GET['status'] : '';
-		return $status;
-	}
-
-	/**
-	 * Return the search filter for this request, if any.
-	 *
-	 * @return string
-	 */
-	protected function get_request_search_query() {
-		$search_query = ( ! empty( $_GET['s'] ) ) ? $_GET['s'] : '';
-		return $search_query;
-	}
-
-	/**
-	 * Process and return the columns name. This is meant for using with SQL, this means it
-	 * always includes the primary key.
-	 *
-	 * @return array
-	 */
-	protected function get_table_columns() {
-		$columns = array_keys( $this->columns );
-		if ( ! in_array( $this->ID, $columns ) ) {
-			$columns[] = $this->ID;
-		}
-
-		return $columns;
-	}
-
-	/**
-	 * Check if the current request is doing a "full text" search. If that is the case
-	 * prepares the SQL to search texts using LIKE.
-	 *
-	 * If the current request does not have any search or if this list table does not support
-	 * that feature it will return an empty string.
-	 *
-	 * TODO:
-	 *   - Improve search doing LIKE by word rather than by phrases.
-	 *
-	 * @return string
-	 */
-	protected function get_items_query_search() {
-		global $wpdb;
-
-		if ( empty( $_GET['s'] ) || empty( $this->search_by ) ) {
-			return '';
-		}
-
-		$filter  = array();
-		foreach ( $this->search_by as $column ) {
-			$filter[] = $wpdb->prepare('`' . $column . '` like "%%s%"', $wpdb->esc_like( $_GET['s'] ));
-		}
-		return implode( ' OR ', $filter );
-	}
-
-	/**
-	 * Prepares the SQL to filter rows by the options defined at `$this->filter_by`. Before trusting
-	 * any data sent by the user it validates that it is a valid option.
-	 */
-	protected function get_items_query_filters() {
-		global $wpdb;
-
-		if ( ! $this->filter_by || empty( $_GET['filter_by'] ) || ! is_array( $_GET['filter_by'] ) ) {
-			return '';
-		}
-
-		$filter = array();
-
-		foreach ( $this->filter_by as $column => $options ) {
-			if ( empty( $_GET['filter_by'][ $column ] ) || empty( $options[ $_GET['filter_by'][ $column ] ] ) ) {
-				continue;
-			}
-
-			$filter[] = $wpdb->prepare( "`$column` = %s", $_GET['filter_by'][ $column ] );
-		}
-
-		return implode( ' AND ', $filter );
-
-	}
-
-	/**
-	 * Prepares the data to feed WP_Table_List.
-	 *
-	 * This has the core for selecting, sorting and filting data. To keep the code simple
-	 * its logic is split among many methods (get_items_query_*).
-	 *
-	 * Beside populating the items this function will also count all the records that matches
-	 * the filtering criteria and will do fill the pagination variables.
-	 */
-	public function prepare_items() {
-		global $wpdb;
-
-		$this->process_bulk_action();
-
-		$this->process_row_actions();
-
-		if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
-			// _wp_http_referer is used only on bulk actions, we remove it to keep the $_GET shorter
-			wp_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), wp_unslash( $_SERVER['REQUEST_URI'] ) ) );
-			exit;
-		}
-
-		$this->prepare_column_headers();
-
-		$limit   = $this->get_items_query_limit();
-		$offset  = $this->get_items_query_offset();
-		$order   = $this->get_items_query_order();
-		$where   = array_filter(array(
-			$this->get_items_query_search(),
-			$this->get_items_query_filters(),
-		));
-		$columns = '`' . implode( '`, `', $this->get_table_columns() ) . '`';
-
-		if ( ! empty( $where ) ) {
-			$where = 'WHERE ('. implode( ') AND (', $where ) . ')';
-		} else {
-			$where = '';
-		}
-
-		$sql = "SELECT $columns FROM {$this->table_name} {$where} {$order} {$limit} {$offset}";
-
-		$this->set_items( $wpdb->get_results( $sql, ARRAY_A ) );
-
-		$query_count = "SELECT COUNT({$this->ID}) FROM {$this->table_name} {$where}";
-		$total_items = $wpdb->get_var( $query_count );
-		$per_page    = $this->get_items_per_page( $this->package . '_items_per_page', $this->items_per_page );
-		$this->set_pagination_args( array(
-			'total_items' => $total_items,
-			'per_page'    => $per_page,
-			'total_pages' => ceil( $total_items / $per_page ),
-		) );
-	}
-
-	public function extra_tablenav( $which ) {
-		if ( ! $this->filter_by || 'top' !== $which ) {
-			return;
-		}
-
-		echo '<div class="alignleft actions">';
-
-		foreach ( $this->filter_by as $id => $options ) {
-			$default = ! empty( $_GET['filter_by'][ $id ] ) ? $_GET['filter_by'][ $id ] : '';
-			if ( empty( $options[ $default ] ) ) {
-				$default = '';
-			}
-
-			echo '<select name="filter_by[' . esc_attr( $id ) . ']" class="first" id="filter-by-' . esc_attr( $id ) . '">';
-
-			foreach ( $options as $value => $label ) {
-				echo '<option value="' . esc_attr( $value ) . '" ' . esc_html( $value == $default ? 'selected' : '' )  .'>'
-					. esc_html( $label )
-				. '</option>';
-			}
-
-			echo '</select>';
-		}
-
-		submit_button( esc_html__( 'Filter', 'action-scheduler' ), '', 'filter_action', false, array( 'id' => 'post-query-submit' ) );
-		echo '</div>';
-	}
-
-	/**
-	 * Set the data for displaying. It will attempt to unserialize (There is a chance that some columns
-	 * are serialized). This can be override in child classes for futher data transformation.
-	 */
-	protected function set_items( array $items ) {
-		$this->items = array();
-		foreach ( $items as $item ) {
-			$this->items[ $item[ $this->ID ] ] = array_map( 'maybe_unserialize', $item );
-		}
-	}
-
-	/**
-	 * Renders the checkbox for each row, this is the first column and it is named ID regardless
-	 * of how the primary key is named (to keep the code simpler). The bulk actions will do the proper
-	 * name transformation though using `$this->ID`.
-	 */
-	public function column_cb( $row ) {
-		return '<input name="ID[]" type="checkbox" value="' . esc_attr( $row[ $this->ID ] ) .'" />';
-	}
-
-	/**
-	 * Renders the row-actions.
-	 *
-	 * This method renders the action menu, it reads the definition from the $row_actions property,
-	 * and it checks that the row action method exists before rendering it.
-	 *
-	 * @param array $row     Row to render
-	 * @param $column_name   Current row
-	 * @return
-	 */
-	protected function maybe_render_actions( $row, $column_name ) {
-		if ( empty( $this->row_actions[ $column_name ] ) ) {
-			return;
-		}
-
-		$row_id = $row[ $this->ID ];
-
-		$actions = '<div class="row-actions">';
-		$action_count = 0;
-		foreach ( $this->row_actions[ $column_name ] as $action_key => $action ) {
-
-			$action_count++;
-
-			if ( ! method_exists( $this, 'row_action_' . $action_key ) ) {
-				continue;
-			}
-
-			$action_link = ! empty( $action['link'] ) ? $action['link'] : add_query_arg( array( 'row_action' => $action_key, 'row_id' => $row_id, 'nonce'  => wp_create_nonce( $action_key . '::' . $row_id ) ) );
-			$span_class  = ! empty( $action['class'] ) ? $action['class'] : $action_key;
-			$separator   = ( $action_count < count( $this->row_actions[ $column_name ] ) ) ? ' | ' : '';
-
-			$actions .= sprintf( '<span class="%s">', esc_attr( $span_class ) );
-			$actions .= sprintf( '<a href="%1$s" title="%2$s">%3$s</a>', esc_url( $action_link ), esc_attr( $action['desc'] ), esc_html( $action['name'] ) );
-			$actions .= sprintf( '%s</span>', $separator );
-		}
-		$actions .= '</div>';
-		return $actions;
-	}
-
-	protected function process_row_actions() {
-		$parameters = array( 'row_action', 'row_id', 'nonce' );
-		foreach ( $parameters as $parameter ) {
-			if ( empty( $_REQUEST[ $parameter ] ) ) {
-				return;
-			}
-		}
-
-		$method = 'row_action_' . $_REQUEST['row_action'];
-
-		if ( $_REQUEST['nonce'] === wp_create_nonce( $_REQUEST[ 'row_action' ] . '::' . $_REQUEST[ 'row_id' ] ) && method_exists( $this, $method ) ) {
-			$this->$method( $_REQUEST['row_id'] );
-		}
-
-		wp_redirect( remove_query_arg(
-			array( 'row_id', 'row_action', 'nonce' ),
-			wp_unslash( $_SERVER['REQUEST_URI'] )
-		) );
-		exit;
-	}
-
-	/**
-	 * Default column formatting, it will escape everythig for security.
-	 */
-	public function column_default( $item, $column_name ) {
-		$column_html = esc_html( $item[ $column_name ] );
-		$column_html .= $this->maybe_render_actions( $item, $column_name );
-		return $column_html;
-	}
-
-	/**
-	 * Display the table heading and search query, if any
-	 */
-	protected function display_header() {
-		echo '<h1 class="wp-heading-inline">' . esc_attr( $this->table_header ) . '</h1>';
-		if ( $this->get_request_search_query() ) {
-			/* translators: %s: search query */
-			echo '<span class="subtitle">' . esc_attr( sprintf( __( 'Search results for "%s"', 'action-scheduler' ), $this->get_request_search_query() ) ) . '</span>';
-		}
-		echo '<hr class="wp-header-end">';
-	}
-
-	/**
-	 * Display the table heading and search query, if any
-	 */
-	protected function display_admin_notices() {
-		foreach ( $this->admin_notices as $notice ) {
-			echo '<div id="message" class="' . $notice['class'] . '">';
-			echo '	<p>' . wp_kses_post( $notice['message'] ) . '</p>';
-			echo '</div>';
-		}
-	}
-
-	/**
-	 * Prints the available statuses so the user can click to filter.
-	 */
-	protected function display_filter_by_status() {
-
-		$status_list_items = array();
-		$request_status    = $this->get_request_status();
-
-		// Helper to set 'all' filter when not set on status counts passed in
-		if ( ! isset( $this->status_counts['all'] ) ) {
-			$this->status_counts = array( 'all' => array_sum( $this->status_counts ) ) + $this->status_counts;
-		}
-
-		foreach ( $this->status_counts as $status_name => $count ) {
-
-			if ( 0 === $count ) {
-				continue;
-			}
-
-			if ( $status_name === $request_status || ( empty( $request_status ) && 'all' === $status_name ) ) {
-				$status_list_item = '<li class="%1$s"><strong>%3$s</strong> (%4$d)</li>';
-			} else {
-				$status_list_item = '<li class="%1$s"><a href="%2$s">%3$s</a> (%4$d)</li>';
-			}
-
-			$status_filter_url   = ( 'all' === $status_name ) ? remove_query_arg( 'status' ) : add_query_arg( 'status', $status_name );
-			$status_filter_url   = remove_query_arg( array( 'paged', 's' ), $status_filter_url );
-			$status_list_items[] = sprintf( $status_list_item, esc_attr( $status_name ), esc_url( $status_filter_url ), esc_html( ucfirst( $status_name ) ), absint( $count ) );
-		}
-
-		if ( $status_list_items ) {
-			echo '<ul class="subsubsub">';
-			echo implode( " | \n", $status_list_items );
-			echo '</ul>';
-		}
-	}
-
-	/**
-	 * Renders the table list, we override the original class to render the table inside a form
-	 * and to render any needed HTML (like the search box). By doing so the callee of a function can simple
-	 * forget about any extra HTML.
-	 */
-	protected function display_table() {
-		echo '<form id="' . esc_attr( $this->_args['plural'] ) . '-filter" method="get">';
-		foreach ( $_GET as $key => $value ) {
-			if ( '_' === $key[0] || 'paged' === $key ) {
-				continue;
-			}
-			echo '<input type="hidden" name="' . esc_attr( $key ) . '" value="' . esc_attr( $value ) . '" />';
-		}
-		if ( ! empty( $this->search_by ) ) {
-			echo $this->search_box( $this->get_search_box_button_text(), 'plugin' ); // WPCS: XSS OK
-		}
-		parent::display();
-		echo '</form>';
-	}
-
-	/**
-	 * Process any pending actions.
-	 */
-	public function process_actions() {
-		$this->process_bulk_action();
-		$this->process_row_actions();
-
-		if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
-			// _wp_http_referer is used only on bulk actions, we remove it to keep the $_GET shorter
-			wp_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), wp_unslash( $_SERVER['REQUEST_URI'] ) ) );
-			exit;
-		}
-	}
-
-	/**
-	 * Render the list table page, including header, notices, status filters and table.
-	 */
-	public function display_page() {
-		$this->prepare_items();
-
-		echo '<div class="wrap">';
-		$this->display_header();
-		$this->display_admin_notices();
-		$this->display_filter_by_status();
-		$this->display_table();
-		echo '</div>';
-	}
-
-	/**
-	 * Get the text to display in the search box on the list table.
-	 */
-	protected function get_search_box_placeholder() {
-		return esc_html__( 'Search', 'action-scheduler' );
-	}
+    /**
+     * The table name
+     */
+    protected $table_name;
+
+    /**
+     * Package name, used to get options from WP_List_Table::get_items_per_page.
+     */
+    protected $package;
+
+    /**
+     * How many items do we render per page?
+     */
+    protected $items_per_page = 10;
+
+    /**
+     * Enables search in this table listing. If this array
+     * is empty it means the listing is not searchable.
+     */
+    protected $search_by = array();
+
+    /**
+     * Columns to show in the table listing. It is a key => value pair. The
+     * key must much the table column name and the value is the label, which is
+     * automatically translated.
+     */
+    protected $columns = array();
+
+    /**
+     * Defines the row-actions. It expects an array where the key
+     * is the column name and the value is an array of actions.
+     *
+     * The array of actions are key => value, where key is the method name
+     * (with the prefix row_action_<key>) and the value is the label
+     * and title.
+     */
+    protected $row_actions = array();
+
+    /**
+     * The Primary key of our table
+     */
+    protected $ID = 'ID';
+
+    /**
+     * Enables sorting, it expects an array
+     * of columns (the column names are the values)
+     */
+    protected $sort_by = array();
+
+    protected $filter_by = array();
+
+    /**
+     * @var array The status name => count combinations for this table's items. Used to display status filters.
+     */
+    protected $status_counts = array();
+
+    /**
+     * @var array Notices to display when loading the table. Array of arrays of form array( 'class' => {updated|error}, 'message' => 'This is the notice text display.' ).
+     */
+    protected $admin_notices = array();
+
+    /**
+     * @var string Localised string displayed in the <h1> element above the able.
+     */
+    protected $table_header;
+
+    /**
+     * Enables bulk actions. It must be an array where the key is the action name
+     * and the value is the label (which is translated automatically). It is important
+     * to notice that it will check that the method exists (`bulk_$name`) and will throw
+     * an exception if it does not exists.
+     *
+     * This class will automatically check if the current request has a bulk action, will do the
+     * validations and afterwards will execute the bulk method, with two arguments. The first argument
+     * is the array with primary keys, the second argument is a string with a list of the primary keys,
+     * escaped and ready to use (with `IN`).
+     */
+    protected $bulk_actions = array();
+
+    /**
+     * Makes translation easier, it basically just wraps
+     * `_x` with some default (the package name).
+     * 
+     * @deprecated 3.0.0
+     */
+    protected function translate( $text, $context = '' ) {
+        return $text;
+    }
+
+    /**
+     * Reads `$this->bulk_actions` and returns an array that WP_List_Table understands. It
+     * also validates that the bulk method handler exists. It throws an exception because
+     * this is a library meant for developers and missing a bulk method is a development-time error.
+     */
+    protected function get_bulk_actions() {
+        $actions = array();
+
+        foreach ( $this->bulk_actions as $action => $label ) {
+            if ( ! is_callable( array( $this, 'bulk_' . $action ) ) ) {
+                throw new RuntimeException( "The bulk action $action does not have a callback method" );
+            }
+
+            $actions[ $action ] = $label;
+        }
+
+        return $actions;
+    }
+
+    /**
+     * Checks if the current request has a bulk action. If that is the case it will validate and will
+     * execute the bulk method handler. Regardless if the action is valid or not it will redirect to
+     * the previous page removing the current arguments that makes this request a bulk action.
+     */
+    protected function process_bulk_action() {
+        global $wpdb;
+        // Detect when a bulk action is being triggered.
+        $action = $this->current_action();
+        if ( ! $action ) {
+            return;
+        }
+
+        check_admin_referer( 'bulk-' . $this->_args['plural'] );
+
+        $method   = 'bulk_' . $action;
+        if ( array_key_exists( $action, $this->bulk_actions ) && is_callable( array( $this, $method ) ) && ! empty( $_GET['ID'] ) && is_array( $_GET['ID'] ) ) {
+            $ids_sql = '(' . implode( ',', array_fill( 0, count( $_GET['ID'] ), '%s' ) ) . ')';
+            $this->$method( $_GET['ID'], $wpdb->prepare( $ids_sql, $_GET['ID'] ) );
+        }
+
+        wp_redirect( remove_query_arg(
+            array( '_wp_http_referer', '_wpnonce', 'ID', 'action', 'action2' ),
+            wp_unslash( $_SERVER['REQUEST_URI'] )
+        ) );
+        exit;
+    }
+
+    /**
+     * Default code for deleting entries.
+     * validated already by process_bulk_action()
+     */
+    protected function bulk_delete( array $ids, $ids_sql ) {
+        $store = ActionScheduler::store();
+        foreach ( $ids as $action_id ) {
+            $store->delete( $action_id );
+        }
+    }
+
+    /**
+     * Prepares the _column_headers property which is used by WP_Table_List at rendering.
+     * It merges the columns and the sortable columns.
+     */
+    protected function prepare_column_headers() {
+        $this->_column_headers = array(
+            $this->get_columns(),
+            array(),
+            $this->get_sortable_columns(),
+        );
+    }
+
+    /**
+     * Reads $this->sort_by and returns the columns name in a format that WP_Table_List
+     * expects
+     */
+    public function get_sortable_columns() {
+        $sort_by = array();
+        foreach ( $this->sort_by as $column ) {
+            $sort_by[ $column ] = array( $column, true );
+        }
+        return $sort_by;
+    }
+
+    /**
+     * Returns the columns names for rendering. It adds a checkbox for selecting everything
+     * as the first column
+     */
+    public function get_columns() {
+        $columns = array_merge(
+            array( 'cb' => '<input type="checkbox" />' ),
+            $this->columns
+        );
+
+        return $columns;
+    }
+
+    /**
+     * Get prepared LIMIT clause for items query
+     *
+     * @global wpdb $wpdb
+     *
+     * @return string Prepared LIMIT clause for items query.
+     */
+    protected function get_items_query_limit() {
+        global $wpdb;
+
+        $per_page = $this->get_items_per_page( $this->package . '_items_per_page', $this->items_per_page );
+        return $wpdb->prepare( 'LIMIT %d', $per_page );
+    }
+
+    /**
+     * Returns the number of items to offset/skip for this current view.
+     *
+     * @return int
+     */
+    protected function get_items_offset() {
+        $per_page = $this->get_items_per_page( $this->package . '_items_per_page', $this->items_per_page );
+        $current_page = $this->get_pagenum();
+        if ( 1 < $current_page ) {
+            $offset = $per_page * ( $current_page - 1 );
+        } else {
+            $offset = 0;
+        }
+
+        return $offset;
+    }
+
+    /**
+     * Get prepared OFFSET clause for items query
+     *
+     * @global wpdb $wpdb
+     *
+     * @return string Prepared OFFSET clause for items query.
+     */
+    protected function get_items_query_offset() {
+        global $wpdb;
+
+        return $wpdb->prepare( 'OFFSET %d', $this->get_items_offset() );
+    }
+
+    /**
+     * Prepares the ORDER BY sql statement. It uses `$this->sort_by` to know which
+     * columns are sortable. This requests validates the orderby $_GET parameter is a valid
+     * column and sortable. It will also use order (ASC|DESC) using DESC by default.
+     */
+    protected function get_items_query_order() {
+        if ( empty( $this->sort_by ) ) {
+            return '';
+        }
+
+        $orderby = esc_sql( $this->get_request_orderby() );
+        $order   = esc_sql( $this->get_request_order() );
+
+        return "ORDER BY {$orderby} {$order}";
+    }
+
+    /**
+     * Return the sortable column specified for this request to order the results by, if any.
+     *
+     * @return string
+     */
+    protected function get_request_orderby() {
+
+        $valid_sortable_columns = array_values( $this->sort_by );
+
+        if ( ! empty( $_GET['orderby'] ) && in_array( $_GET['orderby'], $valid_sortable_columns ) ) {
+            $orderby = sanitize_text_field( $_GET['orderby'] );
+        } else {
+            $orderby = $valid_sortable_columns[0];
+        }
+
+        return $orderby;
+    }
+
+    /**
+     * Return the sortable column order specified for this request.
+     *
+     * @return string
+     */
+    protected function get_request_order() {
+
+        if ( ! empty( $_GET['order'] ) && 'desc' === strtolower( $_GET['order'] ) ) {
+            $order = 'DESC';
+        } else {
+            $order = 'ASC';
+        }
+
+        return $order;
+    }
+
+    /**
+     * Return the status filter for this request, if any.
+     *
+     * @return string
+     */
+    protected function get_request_status() {
+        $status = ( ! empty( $_GET['status'] ) ) ? $_GET['status'] : '';
+        return $status;
+    }
+
+    /**
+     * Return the search filter for this request, if any.
+     *
+     * @return string
+     */
+    protected function get_request_search_query() {
+        $search_query = ( ! empty( $_GET['s'] ) ) ? $_GET['s'] : '';
+        return $search_query;
+    }
+
+    /**
+     * Process and return the columns name. This is meant for using with SQL, this means it
+     * always includes the primary key.
+     *
+     * @return array
+     */
+    protected function get_table_columns() {
+        $columns = array_keys( $this->columns );
+        if ( ! in_array( $this->ID, $columns ) ) {
+            $columns[] = $this->ID;
+        }
+
+        return $columns;
+    }
+
+    /**
+     * Check if the current request is doing a "full text" search. If that is the case
+     * prepares the SQL to search texts using LIKE.
+     *
+     * If the current request does not have any search or if this list table does not support
+     * that feature it will return an empty string.
+     *
+     * TODO:
+     *   - Improve search doing LIKE by word rather than by phrases.
+     *
+     * @return string
+     */
+    protected function get_items_query_search() {
+        global $wpdb;
+
+        if ( empty( $_GET['s'] ) || empty( $this->search_by ) ) {
+            return '';
+        }
+
+        $filter  = array();
+        foreach ( $this->search_by as $column ) {
+            $filter[] = $wpdb->prepare('`' . $column . '` like "%%s%"', $wpdb->esc_like( $_GET['s'] ));
+        }
+        return implode( ' OR ', $filter );
+    }
+
+    /**
+     * Prepares the SQL to filter rows by the options defined at `$this->filter_by`. Before trusting
+     * any data sent by the user it validates that it is a valid option.
+     */
+    protected function get_items_query_filters() {
+        global $wpdb;
+
+        if ( ! $this->filter_by || empty( $_GET['filter_by'] ) || ! is_array( $_GET['filter_by'] ) ) {
+            return '';
+        }
+
+        $filter = array();
+
+        foreach ( $this->filter_by as $column => $options ) {
+            if ( empty( $_GET['filter_by'][ $column ] ) || empty( $options[ $_GET['filter_by'][ $column ] ] ) ) {
+                continue;
+            }
+
+            $filter[] = $wpdb->prepare( "`$column` = %s", $_GET['filter_by'][ $column ] );
+        }
+
+        return implode( ' AND ', $filter );
+
+    }
+
+    /**
+     * Prepares the data to feed WP_Table_List.
+     *
+     * This has the core for selecting, sorting and filting data. To keep the code simple
+     * its logic is split among many methods (get_items_query_*).
+     *
+     * Beside populating the items this function will also count all the records that matches
+     * the filtering criteria and will do fill the pagination variables.
+     */
+    public function prepare_items() {
+        global $wpdb;
+
+        $this->process_bulk_action();
+
+        $this->process_row_actions();
+
+        if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
+            // _wp_http_referer is used only on bulk actions, we remove it to keep the $_GET shorter
+            wp_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), wp_unslash( $_SERVER['REQUEST_URI'] ) ) );
+            exit;
+        }
+
+        $this->prepare_column_headers();
+
+        $limit   = $this->get_items_query_limit();
+        $offset  = $this->get_items_query_offset();
+        $order   = $this->get_items_query_order();
+        $where   = array_filter(array(
+            $this->get_items_query_search(),
+            $this->get_items_query_filters(),
+        ));
+        $columns = '`' . implode( '`, `', $this->get_table_columns() ) . '`';
+
+        if ( ! empty( $where ) ) {
+            $where = 'WHERE ('. implode( ') AND (', $where ) . ')';
+        } else {
+            $where = '';
+        }
+
+        $sql = "SELECT $columns FROM {$this->table_name} {$where} {$order} {$limit} {$offset}";
+
+        $this->set_items( $wpdb->get_results( $sql, ARRAY_A ) );
+
+        $query_count = "SELECT COUNT({$this->ID}) FROM {$this->table_name} {$where}";
+        $total_items = $wpdb->get_var( $query_count );
+        $per_page    = $this->get_items_per_page( $this->package . '_items_per_page', $this->items_per_page );
+        $this->set_pagination_args( array(
+            'total_items' => $total_items,
+            'per_page'    => $per_page,
+            'total_pages' => ceil( $total_items / $per_page ),
+        ) );
+    }
+
+    public function extra_tablenav( $which ) {
+        if ( ! $this->filter_by || 'top' !== $which ) {
+            return;
+        }
+
+        echo '<div class="alignleft actions">';
+
+        foreach ( $this->filter_by as $id => $options ) {
+            $default = ! empty( $_GET['filter_by'][ $id ] ) ? $_GET['filter_by'][ $id ] : '';
+            if ( empty( $options[ $default ] ) ) {
+                $default = '';
+            }
+
+            echo '<select name="filter_by[' . esc_attr( $id ) . ']" class="first" id="filter-by-' . esc_attr( $id ) . '">';
+
+            foreach ( $options as $value => $label ) {
+                echo '<option value="' . esc_attr( $value ) . '" ' . esc_html( $value == $default ? 'selected' : '' )  .'>'
+                    . esc_html( $label )
+                . '</option>';
+            }
+
+            echo '</select>';
+        }
+
+        submit_button( esc_html__( 'Filter', 'action-scheduler' ), '', 'filter_action', false, array( 'id' => 'post-query-submit' ) );
+        echo '</div>';
+    }
+
+    /**
+     * Set the data for displaying. It will attempt to unserialize (There is a chance that some columns
+     * are serialized). This can be override in child classes for futher data transformation.
+     */
+    protected function set_items( array $items ) {
+        $this->items = array();
+        foreach ( $items as $item ) {
+            $this->items[ $item[ $this->ID ] ] = array_map( 'maybe_unserialize', $item );
+        }
+    }
+
+    /**
+     * Renders the checkbox for each row, this is the first column and it is named ID regardless
+     * of how the primary key is named (to keep the code simpler). The bulk actions will do the proper
+     * name transformation though using `$this->ID`.
+     */
+    public function column_cb( $row ) {
+        return '<input name="ID[]" type="checkbox" value="' . esc_attr( $row[ $this->ID ] ) .'" />';
+    }
+
+    /**
+     * Renders the row-actions.
+     *
+     * This method renders the action menu, it reads the definition from the $row_actions property,
+     * and it checks that the row action method exists before rendering it.
+     *
+     * @param array $row     Row to render
+     * @param $column_name   Current row
+     * @return
+     */
+    protected function maybe_render_actions( $row, $column_name ) {
+        if ( empty( $this->row_actions[ $column_name ] ) ) {
+            return;
+        }
+
+        $row_id = $row[ $this->ID ];
+
+        $actions = '<div class="row-actions">';
+        $action_count = 0;
+        foreach ( $this->row_actions[ $column_name ] as $action_key => $action ) {
+
+            $action_count++;
+
+            if ( ! method_exists( $this, 'row_action_' . $action_key ) ) {
+                continue;
+            }
+
+            $action_link = ! empty( $action['link'] ) ? $action['link'] : add_query_arg( array( 'row_action' => $action_key, 'row_id' => $row_id, 'nonce'  => wp_create_nonce( $action_key . '::' . $row_id ) ) );
+            $span_class  = ! empty( $action['class'] ) ? $action['class'] : $action_key;
+            $separator   = ( $action_count < count( $this->row_actions[ $column_name ] ) ) ? ' | ' : '';
+
+            $actions .= sprintf( '<span class="%s">', esc_attr( $span_class ) );
+            $actions .= sprintf( '<a href="%1$s" title="%2$s">%3$s</a>', esc_url( $action_link ), esc_attr( $action['desc'] ), esc_html( $action['name'] ) );
+            $actions .= sprintf( '%s</span>', $separator );
+        }
+        $actions .= '</div>';
+        return $actions;
+    }
+
+    protected function process_row_actions() {
+        $parameters = array( 'row_action', 'row_id', 'nonce' );
+        foreach ( $parameters as $parameter ) {
+            if ( empty( $_REQUEST[ $parameter ] ) ) {
+                return;
+            }
+        }
+
+        $method = 'row_action_' . $_REQUEST['row_action'];
+
+        if ( $_REQUEST['nonce'] === wp_create_nonce( $_REQUEST[ 'row_action' ] . '::' . $_REQUEST[ 'row_id' ] ) && method_exists( $this, $method ) ) {
+            $this->$method( $_REQUEST['row_id'] );
+        }
+
+        wp_redirect( remove_query_arg(
+            array( 'row_id', 'row_action', 'nonce' ),
+            wp_unslash( $_SERVER['REQUEST_URI'] )
+        ) );
+        exit;
+    }
+
+    /**
+     * Default column formatting, it will escape everythig for security.
+     */
+    public function column_default( $item, $column_name ) {
+        $column_html = esc_html( $item[ $column_name ] );
+        $column_html .= $this->maybe_render_actions( $item, $column_name );
+        return $column_html;
+    }
+
+    /**
+     * Display the table heading and search query, if any
+     */
+    protected function display_header() {
+        echo '<h1 class="wp-heading-inline">' . esc_attr( $this->table_header ) . '</h1>';
+        if ( $this->get_request_search_query() ) {
+            /* translators: %s: search query */
+            echo '<span class="subtitle">' . esc_attr( sprintf( __( 'Search results for "%s"', 'action-scheduler' ), $this->get_request_search_query() ) ) . '</span>';
+        }
+        echo '<hr class="wp-header-end">';
+    }
+
+    /**
+     * Display the table heading and search query, if any
+     */
+    protected function display_admin_notices() {
+        foreach ( $this->admin_notices as $notice ) {
+            echo '<div id="message" class="' . $notice['class'] . '">';
+            echo '	<p>' . wp_kses_post( $notice['message'] ) . '</p>';
+            echo '</div>';
+        }
+    }
+
+    /**
+     * Prints the available statuses so the user can click to filter.
+     */
+    protected function display_filter_by_status() {
+
+        $status_list_items = array();
+        $request_status    = $this->get_request_status();
+
+        // Helper to set 'all' filter when not set on status counts passed in
+        if ( ! isset( $this->status_counts['all'] ) ) {
+            $this->status_counts = array( 'all' => array_sum( $this->status_counts ) ) + $this->status_counts;
+        }
+
+        foreach ( $this->status_counts as $status_name => $count ) {
+
+            if ( 0 === $count ) {
+                continue;
+            }
+
+            if ( $status_name === $request_status || ( empty( $request_status ) && 'all' === $status_name ) ) {
+                $status_list_item = '<li class="%1$s"><strong>%3$s</strong> (%4$d)</li>';
+            } else {
+                $status_list_item = '<li class="%1$s"><a href="%2$s">%3$s</a> (%4$d)</li>';
+            }
+
+            $status_filter_url   = ( 'all' === $status_name ) ? remove_query_arg( 'status' ) : add_query_arg( 'status', $status_name );
+            $status_filter_url   = remove_query_arg( array( 'paged', 's' ), $status_filter_url );
+            $status_list_items[] = sprintf( $status_list_item, esc_attr( $status_name ), esc_url( $status_filter_url ), esc_html( ucfirst( $status_name ) ), absint( $count ) );
+        }
+
+        if ( $status_list_items ) {
+            echo '<ul class="subsubsub">';
+            echo implode( " | \n", $status_list_items );
+            echo '</ul>';
+        }
+    }
+
+    /**
+     * Renders the table list, we override the original class to render the table inside a form
+     * and to render any needed HTML (like the search box). By doing so the callee of a function can simple
+     * forget about any extra HTML.
+     */
+    protected function display_table() {
+        echo '<form id="' . esc_attr( $this->_args['plural'] ) . '-filter" method="get">';
+        foreach ( $_GET as $key => $value ) {
+            if ( '_' === $key[0] || 'paged' === $key ) {
+                continue;
+            }
+            echo '<input type="hidden" name="' . esc_attr( $key ) . '" value="' . esc_attr( $value ) . '" />';
+        }
+        if ( ! empty( $this->search_by ) ) {
+            echo $this->search_box( $this->get_search_box_button_text(), 'plugin' ); // WPCS: XSS OK
+        }
+        parent::display();
+        echo '</form>';
+    }
+
+    /**
+     * Process any pending actions.
+     */
+    public function process_actions() {
+        $this->process_bulk_action();
+        $this->process_row_actions();
+
+        if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
+            // _wp_http_referer is used only on bulk actions, we remove it to keep the $_GET shorter
+            wp_redirect( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), wp_unslash( $_SERVER['REQUEST_URI'] ) ) );
+            exit;
+        }
+    }
+
+    /**
+     * Render the list table page, including header, notices, status filters and table.
+     */
+    public function display_page() {
+        $this->prepare_items();
+
+        echo '<div class="wrap">';
+        $this->display_header();
+        $this->display_admin_notices();
+        $this->display_filter_by_status();
+        $this->display_table();
+        echo '</div>';
+    }
+
+    /**
+     * Get the text to display in the search box on the list table.
+     */
+    protected function get_search_box_placeholder() {
+        return esc_html__( 'Search', 'action-scheduler' );
+    }
 }

includes/libraries/action-scheduler/classes/abstracts/ActionScheduler_Abstract_RecurringSchedule.php

Indentation +86 added lines, -86 removed lines

@@ -5,98 +5,98 @@
  */
 abstract class ActionScheduler_Abstract_RecurringSchedule extends ActionScheduler_Abstract_Schedule {
 
-	/**
-	 * The date & time the first instance of this schedule was setup to run (which may not be this instance).
-	 *
-	 * Schedule objects are attached to an action object. Each schedule stores the run date for that
-	 * object as the start date - @see $this->start - and logic to calculate the next run date after
-	 * that - @see $this->calculate_next(). The $first_date property also keeps a record of when the very
-	 * first instance of this chain of schedules ran.
-	 *
-	 * @var DateTime
-	 */
-	private $first_date = NULL;
+    /**
+     * The date & time the first instance of this schedule was setup to run (which may not be this instance).
+     *
+     * Schedule objects are attached to an action object. Each schedule stores the run date for that
+     * object as the start date - @see $this->start - and logic to calculate the next run date after
+     * that - @see $this->calculate_next(). The $first_date property also keeps a record of when the very
+     * first instance of this chain of schedules ran.
+     *
+     * @var DateTime
+     */
+    private $first_date = NULL;
 
-	/**
-	 * Timestamp equivalent of @see $this->first_date
-	 *
-	 * @var int
-	 */
-	protected $first_timestamp = NULL;
+    /**
+     * Timestamp equivalent of @see $this->first_date
+     *
+     * @var int
+     */
+    protected $first_timestamp = NULL;
 
-	/**
-	 * The recurrance between each time an action is run using this schedule.
-	 * Used to calculate the start date & time. Can be a number of seconds, in the
-	 * case of ActionScheduler_IntervalSchedule, or a cron expression, as in the
-	 * case of ActionScheduler_CronSchedule. Or something else.
-	 *
-	 * @var mixed
-	 */
-	protected $recurrence;
+    /**
+     * The recurrance between each time an action is run using this schedule.
+     * Used to calculate the start date & time. Can be a number of seconds, in the
+     * case of ActionScheduler_IntervalSchedule, or a cron expression, as in the
+     * case of ActionScheduler_CronSchedule. Or something else.
+     *
+     * @var mixed
+     */
+    protected $recurrence;
 
-	/**
-	 * @param DateTime $date The date & time to run the action.
-	 * @param mixed $recurrence The data used to determine the schedule's recurrance.
-	 * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance.
-	 */
-	public function __construct( DateTime $date, $recurrence, DateTime $first = null ) {
-		parent::__construct( $date );
-		$this->first_date = empty( $first ) ? $date : $first;
-		$this->recurrence = $recurrence;
-	}
+    /**
+     * @param DateTime $date The date & time to run the action.
+     * @param mixed $recurrence The data used to determine the schedule's recurrance.
+     * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance.
+     */
+    public function __construct( DateTime $date, $recurrence, DateTime $first = null ) {
+        parent::__construct( $date );
+        $this->first_date = empty( $first ) ? $date : $first;
+        $this->recurrence = $recurrence;
+    }
 
-	/**
-	 * @return bool
-	 */
-	public function is_recurring() {
-		return true;
-	}
+    /**
+     * @return bool
+     */
+    public function is_recurring() {
+        return true;
+    }
 
-	/**
-	 * Get the date & time of the first schedule in this recurring series.
-	 *
-	 * @return DateTime|null
-	 */
-	public function get_first_date() {
-		return clone $this->first_date;
-	}
+    /**
+     * Get the date & time of the first schedule in this recurring series.
+     *
+     * @return DateTime|null
+     */
+    public function get_first_date() {
+        return clone $this->first_date;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function get_recurrence() {
-		return $this->recurrence;
-	}
+    /**
+     * @return string
+     */
+    public function get_recurrence() {
+        return $this->recurrence;
+    }
 
-	/**
-	 * For PHP 5.2 compat, since DateTime objects can't be serialized
-	 * @return array
-	 */
-	public function __sleep() {
-		$sleep_params = parent::__sleep();
-		$this->first_timestamp = $this->first_date->getTimestamp();
-		return array_merge( $sleep_params, array(
-			'first_timestamp',
-			'recurrence'
-		) );
-	}
+    /**
+     * For PHP 5.2 compat, since DateTime objects can't be serialized
+     * @return array
+     */
+    public function __sleep() {
+        $sleep_params = parent::__sleep();
+        $this->first_timestamp = $this->first_date->getTimestamp();
+        return array_merge( $sleep_params, array(
+            'first_timestamp',
+            'recurrence'
+        ) );
+    }
 
-	/**
-	 * Unserialize recurring schedules serialized/stored prior to AS 3.0.0
-	 *
-	 * Prior to Action Scheduler 3.0.0, schedules used different property names to refer
-	 * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp
-	 * was the same as ActionScheduler_SimpleSchedule::timestamp. This was addressed in
-	 * Action Scheduler 3.0.0, where properties and property names were aligned for better
-	 * inheritance. To maintain backward compatibility with scheduled serialized and stored
-	 * prior to 3.0, we need to correctly map the old property names.
-	 */
-	public function __wakeup() {
-		parent::__wakeup();
-		if ( $this->first_timestamp > 0 ) {
-			$this->first_date = as_get_datetime_object( $this->first_timestamp );
-		} else {
-			$this->first_date = $this->get_date();
-		}
-	}
+    /**
+     * Unserialize recurring schedules serialized/stored prior to AS 3.0.0
+     *
+     * Prior to Action Scheduler 3.0.0, schedules used different property names to refer
+     * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp
+     * was the same as ActionScheduler_SimpleSchedule::timestamp. This was addressed in
+     * Action Scheduler 3.0.0, where properties and property names were aligned for better
+     * inheritance. To maintain backward compatibility with scheduled serialized and stored
+     * prior to 3.0, we need to correctly map the old property names.
+     */
+    public function __wakeup() {
+        parent::__wakeup();
+        if ( $this->first_timestamp > 0 ) {
+            $this->first_date = as_get_datetime_object( $this->first_timestamp );
+        } else {
+            $this->first_date = $this->get_date();
+        }
+    }
 }

includes/libraries/action-scheduler/classes/abstracts/ActionScheduler_TimezoneHelper.php

Indentation +145 added lines, -145 removed lines

@@ -4,149 +4,149 @@
  * Class ActionScheduler_TimezoneHelper
  */
 abstract class ActionScheduler_TimezoneHelper {
-	private static $local_timezone = NULL;
-
-	/**
-	 * Set a DateTime's timezone to the WordPress site's timezone, or a UTC offset
-	 * if no timezone string is available.
-	 *
-	 * @since  2.1.0
-	 *
-	 * @param DateTime $date
-	 * @return ActionScheduler_DateTime
-	 */
-	public static function set_local_timezone( DateTime $date ) {
-
-		// Accept a DateTime for easier backward compatibility, even though we require methods on ActionScheduler_DateTime
-		if ( ! is_a( $date, 'ActionScheduler_DateTime' ) ) {
-			$date = as_get_datetime_object( $date->format( 'U' ) );
-		}
-
-		if ( get_option( 'timezone_string' ) ) {
-			$date->setTimezone( new DateTimeZone( self::get_local_timezone_string() ) );
-		} else {
-			$date->setUtcOffset( self::get_local_timezone_offset() );
-		}
-
-		return $date;
-	}
-
-	/**
-	 * Helper to retrieve the timezone string for a site until a WP core method exists
-	 * (see https://core.trac.wordpress.org/ticket/24730).
-	 *
-	 * Adapted from wc_timezone_string() and https://secure.php.net/manual/en/function.timezone-name-from-abbr.php#89155.
-	 *
-	 * If no timezone string is set, and its not possible to match the UTC offset set for the site to a timezone
-	 * string, then an empty string will be returned, and the UTC offset should be used to set a DateTime's
-	 * timezone.
-	 *
-	 * @since 2.1.0
-	 * @return string PHP timezone string for the site or empty if no timezone string is available.
-	 */
-	protected static function get_local_timezone_string( $reset = false ) {
-		// If site timezone string exists, return it.
-		$timezone = get_option( 'timezone_string' );
-		if ( $timezone ) {
-			return $timezone;
-		}
-
-		// Get UTC offset, if it isn't set then return UTC.
-		$utc_offset = intval( get_option( 'gmt_offset', 0 ) );
-		if ( 0 === $utc_offset ) {
-			return 'UTC';
-		}
-
-		// Adjust UTC offset from hours to seconds.
-		$utc_offset *= 3600;
-
-		// Attempt to guess the timezone string from the UTC offset.
-		$timezone = timezone_name_from_abbr( '', $utc_offset );
-		if ( $timezone ) {
-			return $timezone;
-		}
-
-		// Last try, guess timezone string manually.
-		foreach ( timezone_abbreviations_list() as $abbr ) {
-			foreach ( $abbr as $city ) {
-				if ( (bool) date( 'I' ) === (bool) $city['dst'] && $city['timezone_id'] && intval( $city['offset'] ) === $utc_offset ) {
-					return $city['timezone_id'];
-				}
-			}
-		}
-
-		// No timezone string
-		return '';
-	}
-
-	/**
-	 * Get timezone offset in seconds.
-	 *
-	 * @since  2.1.0
-	 * @return float
-	 */
-	protected static function get_local_timezone_offset() {
-		$timezone = get_option( 'timezone_string' );
-
-		if ( $timezone ) {
-			$timezone_object = new DateTimeZone( $timezone );
-			return $timezone_object->getOffset( new DateTime( 'now' ) );
-		} else {
-			return floatval( get_option( 'gmt_offset', 0 ) ) * HOUR_IN_SECONDS;
-		}
-	}
-
-	/**
-	 * @deprecated 2.1.0
-	 */
-	public static function get_local_timezone( $reset = FALSE ) {
-		_deprecated_function( __FUNCTION__, '2.1.0', 'ActionScheduler_TimezoneHelper::set_local_timezone()' );
-		if ( $reset ) {
-			self::$local_timezone = NULL;
-		}
-		if ( !isset(self::$local_timezone) ) {
-			$tzstring = get_option('timezone_string');
-
-			if ( empty($tzstring) ) {
-				$gmt_offset = get_option('gmt_offset');
-				if ( $gmt_offset == 0 ) {
-					$tzstring = 'UTC';
-				} else {
-					$gmt_offset *= HOUR_IN_SECONDS;
-					$tzstring   = timezone_name_from_abbr( '', $gmt_offset, 1 );
-
-					// If there's no timezone string, try again with no DST.
-					if ( false === $tzstring ) {
-						$tzstring = timezone_name_from_abbr( '', $gmt_offset, 0 );
-					}
-
-					// Try mapping to the first abbreviation we can find.
-					if ( false === $tzstring ) {
-						$is_dst = date( 'I' );
-						foreach ( timezone_abbreviations_list() as $abbr ) {
-							foreach ( $abbr as $city ) {
-								if ( $city['dst'] == $is_dst && $city['offset'] == $gmt_offset ) {
-									// If there's no valid timezone ID, keep looking.
-									if ( null === $city['timezone_id'] ) {
-										continue;
-									}
-
-									$tzstring = $city['timezone_id'];
-									break 2;
-								}
-							}
-						}
-					}
-
-					// If we still have no valid string, then fall back to UTC.
-					if ( false === $tzstring ) {
-						$tzstring = 'UTC';
-					}
-				}
-			}
-
-			self::$local_timezone = new DateTimeZone($tzstring);
-		}
-		return self::$local_timezone;
-	}
+    private static $local_timezone = NULL;
+
+    /**
+     * Set a DateTime's timezone to the WordPress site's timezone, or a UTC offset
+     * if no timezone string is available.
+     *
+     * @since  2.1.0
+     *
+     * @param DateTime $date
+     * @return ActionScheduler_DateTime
+     */
+    public static function set_local_timezone( DateTime $date ) {
+
+        // Accept a DateTime for easier backward compatibility, even though we require methods on ActionScheduler_DateTime
+        if ( ! is_a( $date, 'ActionScheduler_DateTime' ) ) {
+            $date = as_get_datetime_object( $date->format( 'U' ) );
+        }
+
+        if ( get_option( 'timezone_string' ) ) {
+            $date->setTimezone( new DateTimeZone( self::get_local_timezone_string() ) );
+        } else {
+            $date->setUtcOffset( self::get_local_timezone_offset() );
+        }
+
+        return $date;
+    }
+
+    /**
+     * Helper to retrieve the timezone string for a site until a WP core method exists
+     * (see https://core.trac.wordpress.org/ticket/24730).
+     *
+     * Adapted from wc_timezone_string() and https://secure.php.net/manual/en/function.timezone-name-from-abbr.php#89155.
+     *
+     * If no timezone string is set, and its not possible to match the UTC offset set for the site to a timezone
+     * string, then an empty string will be returned, and the UTC offset should be used to set a DateTime's
+     * timezone.
+     *
+     * @since 2.1.0
+     * @return string PHP timezone string for the site or empty if no timezone string is available.
+     */
+    protected static function get_local_timezone_string( $reset = false ) {
+        // If site timezone string exists, return it.
+        $timezone = get_option( 'timezone_string' );
+        if ( $timezone ) {
+            return $timezone;
+        }
+
+        // Get UTC offset, if it isn't set then return UTC.
+        $utc_offset = intval( get_option( 'gmt_offset', 0 ) );
+        if ( 0 === $utc_offset ) {
+            return 'UTC';
+        }
+
+        // Adjust UTC offset from hours to seconds.
+        $utc_offset *= 3600;
+
+        // Attempt to guess the timezone string from the UTC offset.
+        $timezone = timezone_name_from_abbr( '', $utc_offset );
+        if ( $timezone ) {
+            return $timezone;
+        }
+
+        // Last try, guess timezone string manually.
+        foreach ( timezone_abbreviations_list() as $abbr ) {
+            foreach ( $abbr as $city ) {
+                if ( (bool) date( 'I' ) === (bool) $city['dst'] && $city['timezone_id'] && intval( $city['offset'] ) === $utc_offset ) {
+                    return $city['timezone_id'];
+                }
+            }
+        }
+
+        // No timezone string
+        return '';
+    }
+
+    /**
+     * Get timezone offset in seconds.
+     *
+     * @since  2.1.0
+     * @return float
+     */
+    protected static function get_local_timezone_offset() {
+        $timezone = get_option( 'timezone_string' );
+
+        if ( $timezone ) {
+            $timezone_object = new DateTimeZone( $timezone );
+            return $timezone_object->getOffset( new DateTime( 'now' ) );
+        } else {
+            return floatval( get_option( 'gmt_offset', 0 ) ) * HOUR_IN_SECONDS;
+        }
+    }
+
+    /**
+     * @deprecated 2.1.0
+     */
+    public static function get_local_timezone( $reset = FALSE ) {
+        _deprecated_function( __FUNCTION__, '2.1.0', 'ActionScheduler_TimezoneHelper::set_local_timezone()' );
+        if ( $reset ) {
+            self::$local_timezone = NULL;
+        }
+        if ( !isset(self::$local_timezone) ) {
+            $tzstring = get_option('timezone_string');
+
+            if ( empty($tzstring) ) {
+                $gmt_offset = get_option('gmt_offset');
+                if ( $gmt_offset == 0 ) {
+                    $tzstring = 'UTC';
+                } else {
+                    $gmt_offset *= HOUR_IN_SECONDS;
+                    $tzstring   = timezone_name_from_abbr( '', $gmt_offset, 1 );
+
+                    // If there's no timezone string, try again with no DST.
+                    if ( false === $tzstring ) {
+                        $tzstring = timezone_name_from_abbr( '', $gmt_offset, 0 );
+                    }
+
+                    // Try mapping to the first abbreviation we can find.
+                    if ( false === $tzstring ) {
+                        $is_dst = date( 'I' );
+                        foreach ( timezone_abbreviations_list() as $abbr ) {
+                            foreach ( $abbr as $city ) {
+                                if ( $city['dst'] == $is_dst && $city['offset'] == $gmt_offset ) {
+                                    // If there's no valid timezone ID, keep looking.
+                                    if ( null === $city['timezone_id'] ) {
+                                        continue;
+                                    }
+
+                                    $tzstring = $city['timezone_id'];
+                                    break 2;
+                                }
+                            }
+                        }
+                    }
+
+                    // If we still have no valid string, then fall back to UTC.
+                    if ( false === $tzstring ) {
+                        $tzstring = 'UTC';
+                    }
+                }
+            }
+
+            self::$local_timezone = new DateTimeZone($tzstring);
+        }
+        return self::$local_timezone;
+    }
 }

includes/libraries/action-scheduler/classes/abstracts/ActionScheduler_Store.php

Indentation +337 added lines, -337 removed lines

@@ -5,341 +5,341 @@
  * @codeCoverageIgnore
  */
 abstract class ActionScheduler_Store extends ActionScheduler_Store_Deprecated {
-	const STATUS_COMPLETE = 'complete';
-	const STATUS_PENDING  = 'pending';
-	const STATUS_RUNNING  = 'in-progress';
-	const STATUS_FAILED   = 'failed';
-	const STATUS_CANCELED = 'canceled';
-	const DEFAULT_CLASS   = 'ActionScheduler_wpPostStore';
-
-	/** @var ActionScheduler_Store */
-	private static $store = NULL;
-
-	/** @var int */
-	protected static $max_args_length = 191;
-
-	/**
-	 * @param ActionScheduler_Action $action
-	 * @param DateTime $scheduled_date Optional Date of the first instance
-	 *        to store. Otherwise uses the first date of the action's
-	 *        schedule.
-	 *
-	 * @return string The action ID
-	 */
-	abstract public function save_action( ActionScheduler_Action $action, DateTime $scheduled_date = NULL );
-
-	/**
-	 * @param string $action_id
-	 *
-	 * @return ActionScheduler_Action
-	 */
-	abstract public function fetch_action( $action_id );
-
-	/**
-	 * @param string $hook Hook name/slug.
-	 * @param array  $params Hook arguments.
-	 * @return string ID of the next action matching the criteria.
-	 */
-	abstract public function find_action( $hook, $params = array() );
-
-	/**
-	 * @param array  $query Query parameters.
-	 * @param string $query_type Whether to select or count the results. Default, select.
-	 *
-	 * @return array|int The IDs of or count of actions matching the query.
-	 */
-	abstract public function query_actions( $query = array(), $query_type = 'select' );
-
-	/**
-	 * Get a count of all actions in the store, grouped by status
-	 *
-	 * @return array
-	 */
-	abstract public function action_counts();
-
-	/**
-	 * @param string $action_id
-	 */
-	abstract public function cancel_action( $action_id );
-
-	/**
-	 * @param string $action_id
-	 */
-	abstract public function delete_action( $action_id );
-
-	/**
-	 * @param string $action_id
-	 *
-	 * @return DateTime The date the action is schedule to run, or the date that it ran.
-	 */
-	abstract public function get_date( $action_id );
-
-
-	/**
-	 * @param int      $max_actions
-	 * @param DateTime $before_date Claim only actions schedule before the given date. Defaults to now.
-	 * @param array    $hooks       Claim only actions with a hook or hooks.
-	 * @param string   $group       Claim only actions in the given group.
-	 *
-	 * @return ActionScheduler_ActionClaim
-	 */
-	abstract public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' );
-
-	/**
-	 * @return int
-	 */
-	abstract public function get_claim_count();
-
-	/**
-	 * @param ActionScheduler_ActionClaim $claim
-	 */
-	abstract public function release_claim( ActionScheduler_ActionClaim $claim );
-
-	/**
-	 * @param string $action_id
-	 */
-	abstract public function unclaim_action( $action_id );
-
-	/**
-	 * @param string $action_id
-	 */
-	abstract public function mark_failure( $action_id );
-
-	/**
-	 * @param string $action_id
-	 */
-	abstract public function log_execution( $action_id );
-
-	/**
-	 * @param string $action_id
-	 */
-	abstract public function mark_complete( $action_id );
-
-	/**
-	 * @param string $action_id
-	 *
-	 * @return string
-	 */
-	abstract public function get_status( $action_id );
-
-	/**
-	 * @param string $action_id
-	 * @return mixed
-	 */
-	abstract public function get_claim_id( $action_id );
-
-	/**
-	 * @param string $claim_id
-	 * @return array
-	 */
-	abstract public function find_actions_by_claim_id( $claim_id );
-
-	/**
-	 * @param string $comparison_operator
-	 * @return string
-	 */
-	protected function validate_sql_comparator( $comparison_operator ) {
-		if ( in_array( $comparison_operator, array('!=', '>', '>=', '<', '<=', '=') ) ) {
-			return $comparison_operator;
-		}
-		return '=';
-	}
-
-	/**
-	 * Get the time MySQL formated date/time string for an action's (next) scheduled date.
-	 *
-	 * @param ActionScheduler_Action $action
-	 * @param DateTime $scheduled_date (optional)
-	 * @return string
-	 */
-	protected function get_scheduled_date_string( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ) {
-		$next = null === $scheduled_date ? $action->get_schedule()->get_date() : $scheduled_date;
-		if ( ! $next ) {
-			return '0000-00-00 00:00:00';
-		}
-		$next->setTimezone( new DateTimeZone( 'UTC' ) );
-
-		return $next->format( 'Y-m-d H:i:s' );
-	}
-
-	/**
-	 * Get the time MySQL formated date/time string for an action's (next) scheduled date.
-	 *
-	 * @param ActionScheduler_Action $action
-	 * @param DateTime $scheduled_date (optional)
-	 * @return string
-	 */
-	protected function get_scheduled_date_string_local( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ) {
-		$next = null === $scheduled_date ? $action->get_schedule()->get_date() : $scheduled_date;
-		if ( ! $next ) {
-			return '0000-00-00 00:00:00';
-		}
-
-		ActionScheduler_TimezoneHelper::set_local_timezone( $next );
-		return $next->format( 'Y-m-d H:i:s' );
-	}
-
-	/**
-	 * Validate that we could decode action arguments.
-	 *
-	 * @param mixed $args      The decoded arguments.
-	 * @param int   $action_id The action ID.
-	 *
-	 * @throws ActionScheduler_InvalidActionException When the decoded arguments are invalid.
-	 */
-	protected function validate_args( $args, $action_id ) {
-		// Ensure we have an array of args.
-		if ( ! is_array( $args ) ) {
-			throw ActionScheduler_InvalidActionException::from_decoding_args( $action_id );
-		}
-
-		// Validate JSON decoding if possible.
-		if ( function_exists( 'json_last_error' ) && JSON_ERROR_NONE !== json_last_error() ) {
-			throw ActionScheduler_InvalidActionException::from_decoding_args( $action_id, $args );
-		}
-	}
-
-	/**
-	 * Validate a ActionScheduler_Schedule object.
-	 *
-	 * @param mixed $schedule  The unserialized ActionScheduler_Schedule object.
-	 * @param int   $action_id The action ID.
-	 *
-	 * @throws ActionScheduler_InvalidActionException When the schedule is invalid.
-	 */
-	protected function validate_schedule( $schedule, $action_id ) {
-		if ( empty( $schedule ) || ! is_a( $schedule, 'ActionScheduler_Schedule' ) ) {
-			throw ActionScheduler_InvalidActionException::from_schedule( $action_id, $schedule );
-		}
-	}
-
-	/**
-	 * InnoDB indexes have a maximum size of 767 bytes by default, which is only 191 characters with utf8mb4.
-	 *
-	 * Previously, AS wasn't concerned about args length, as we used the (unindex) post_content column. However,
-	 * with custom tables, we use an indexed VARCHAR column instead.
-	 *
-	 * @param  ActionScheduler_Action $action Action to be validated.
-	 * @throws InvalidArgumentException When json encoded args is too long.
-	 */
-	protected function validate_action( ActionScheduler_Action $action ) {
-		if ( strlen( json_encode( $action->get_args() ) ) > static::$max_args_length ) {
-			throw new InvalidArgumentException( sprintf( __( 'ActionScheduler_Action::$args too long. To ensure the args column can be indexed, action args should not be more than %d characters when encoded as JSON.', 'action-scheduler' ), static::$max_args_length ) );
-		}
-	}
-
-	/**
-	 * Cancel pending actions by hook.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $hook Hook name.
-	 *
-	 * @return void
-	 */
-	public function cancel_actions_by_hook( $hook ) {
-		$action_ids = true;
-		while ( ! empty( $action_ids ) ) {
-			$action_ids = $this->query_actions(
-				array(
-					'hook' => $hook,
-					'status' => self::STATUS_PENDING,
-					'per_page' => 1000,
-				)
-			);
-
-			$this->bulk_cancel_actions( $action_ids );
-		}
-	}
-
-	/**
-	 * Cancel pending actions by group.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $group Group slug.
-	 *
-	 * @return void
-	 */
-	public function cancel_actions_by_group( $group ) {
-		$action_ids = true;
-		while ( ! empty( $action_ids ) ) {
-			$action_ids = $this->query_actions(
-				array(
-					'group' => $group,
-					'status' => self::STATUS_PENDING,
-					'per_page' => 1000,
-				)
-			);
-
-			$this->bulk_cancel_actions( $action_ids );
-		}
-	}
-
-	/**
-	 * Cancel a set of action IDs.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param array $action_ids List of action IDs.
-	 *
-	 * @return void
-	 */
-	private function bulk_cancel_actions( $action_ids ) {
-		foreach ( $action_ids as $action_id ) {
-			$this->cancel_action( $action_id );
-		}
-
-		do_action( 'action_scheduler_bulk_cancel_actions', $action_ids );
-	}
-
-	/**
-	 * @return array
-	 */
-	public function get_status_labels() {
-		return array(
-			self::STATUS_COMPLETE => __( 'Complete', 'action-scheduler' ),
-			self::STATUS_PENDING  => __( 'Pending', 'action-scheduler' ),
-			self::STATUS_RUNNING  => __( 'In-progress', 'action-scheduler' ),
-			self::STATUS_FAILED   => __( 'Failed', 'action-scheduler' ),
-			self::STATUS_CANCELED => __( 'Canceled', 'action-scheduler' ),
-		);
-	}
-
-	/**
-	 * Check if there are any pending scheduled actions due to run.
-	 *
-	 * @param ActionScheduler_Action $action
-	 * @param DateTime $scheduled_date (optional)
-	 * @return string
-	 */
-	public function has_pending_actions_due() {
-		$pending_actions = $this->query_actions( array(
-			'date'   => as_get_datetime_object(),
-			'status' => ActionScheduler_Store::STATUS_PENDING,
-		) );
-
-		return ! empty( $pending_actions );
-	}
-
-	/**
-	 * Callable initialization function optionally overridden in derived classes.
-	 */
-	public function init() {}
-
-	/**
-	 * Callable function to mark an action as migrated optionally overridden in derived classes.
-	 */
-	public function mark_migrated( $action_id ) {}
-
-	/**
-	 * @return ActionScheduler_Store
-	 */
-	public static function instance() {
-		if ( empty( self::$store ) ) {
-			$class = apply_filters( 'action_scheduler_store_class', self::DEFAULT_CLASS );
-			self::$store = new $class();
-		}
-		return self::$store;
-	}
+    const STATUS_COMPLETE = 'complete';
+    const STATUS_PENDING  = 'pending';
+    const STATUS_RUNNING  = 'in-progress';
+    const STATUS_FAILED   = 'failed';
+    const STATUS_CANCELED = 'canceled';
+    const DEFAULT_CLASS   = 'ActionScheduler_wpPostStore';
+
+    /** @var ActionScheduler_Store */
+    private static $store = NULL;
+
+    /** @var int */
+    protected static $max_args_length = 191;
+
+    /**
+     * @param ActionScheduler_Action $action
+     * @param DateTime $scheduled_date Optional Date of the first instance
+     *        to store. Otherwise uses the first date of the action's
+     *        schedule.
+     *
+     * @return string The action ID
+     */
+    abstract public function save_action( ActionScheduler_Action $action, DateTime $scheduled_date = NULL );
+
+    /**
+     * @param string $action_id
+     *
+     * @return ActionScheduler_Action
+     */
+    abstract public function fetch_action( $action_id );
+
+    /**
+     * @param string $hook Hook name/slug.
+     * @param array  $params Hook arguments.
+     * @return string ID of the next action matching the criteria.
+     */
+    abstract public function find_action( $hook, $params = array() );
+
+    /**
+     * @param array  $query Query parameters.
+     * @param string $query_type Whether to select or count the results. Default, select.
+     *
+     * @return array|int The IDs of or count of actions matching the query.
+     */
+    abstract public function query_actions( $query = array(), $query_type = 'select' );
+
+    /**
+     * Get a count of all actions in the store, grouped by status
+     *
+     * @return array
+     */
+    abstract public function action_counts();
+
+    /**
+     * @param string $action_id
+     */
+    abstract public function cancel_action( $action_id );
+
+    /**
+     * @param string $action_id
+     */
+    abstract public function delete_action( $action_id );
+
+    /**
+     * @param string $action_id
+     *
+     * @return DateTime The date the action is schedule to run, or the date that it ran.
+     */
+    abstract public function get_date( $action_id );
+
+
+    /**
+     * @param int      $max_actions
+     * @param DateTime $before_date Claim only actions schedule before the given date. Defaults to now.
+     * @param array    $hooks       Claim only actions with a hook or hooks.
+     * @param string   $group       Claim only actions in the given group.
+     *
+     * @return ActionScheduler_ActionClaim
+     */
+    abstract public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' );
+
+    /**
+     * @return int
+     */
+    abstract public function get_claim_count();
+
+    /**
+     * @param ActionScheduler_ActionClaim $claim
+     */
+    abstract public function release_claim( ActionScheduler_ActionClaim $claim );
+
+    /**
+     * @param string $action_id
+     */
+    abstract public function unclaim_action( $action_id );
+
+    /**
+     * @param string $action_id
+     */
+    abstract public function mark_failure( $action_id );
+
+    /**
+     * @param string $action_id
+     */
+    abstract public function log_execution( $action_id );
+
+    /**
+     * @param string $action_id
+     */
+    abstract public function mark_complete( $action_id );
+
+    /**
+     * @param string $action_id
+     *
+     * @return string
+     */
+    abstract public function get_status( $action_id );
+
+    /**
+     * @param string $action_id
+     * @return mixed
+     */
+    abstract public function get_claim_id( $action_id );
+
+    /**
+     * @param string $claim_id
+     * @return array
+     */
+    abstract public function find_actions_by_claim_id( $claim_id );
+
+    /**
+     * @param string $comparison_operator
+     * @return string
+     */
+    protected function validate_sql_comparator( $comparison_operator ) {
+        if ( in_array( $comparison_operator, array('!=', '>', '>=', '<', '<=', '=') ) ) {
+            return $comparison_operator;
+        }
+        return '=';
+    }
+
+    /**
+     * Get the time MySQL formated date/time string for an action's (next) scheduled date.
+     *
+     * @param ActionScheduler_Action $action
+     * @param DateTime $scheduled_date (optional)
+     * @return string
+     */
+    protected function get_scheduled_date_string( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ) {
+        $next = null === $scheduled_date ? $action->get_schedule()->get_date() : $scheduled_date;
+        if ( ! $next ) {
+            return '0000-00-00 00:00:00';
+        }
+        $next->setTimezone( new DateTimeZone( 'UTC' ) );
+
+        return $next->format( 'Y-m-d H:i:s' );
+    }
+
+    /**
+     * Get the time MySQL formated date/time string for an action's (next) scheduled date.
+     *
+     * @param ActionScheduler_Action $action
+     * @param DateTime $scheduled_date (optional)
+     * @return string
+     */
+    protected function get_scheduled_date_string_local( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ) {
+        $next = null === $scheduled_date ? $action->get_schedule()->get_date() : $scheduled_date;
+        if ( ! $next ) {
+            return '0000-00-00 00:00:00';
+        }
+
+        ActionScheduler_TimezoneHelper::set_local_timezone( $next );
+        return $next->format( 'Y-m-d H:i:s' );
+    }
+
+    /**
+     * Validate that we could decode action arguments.
+     *
+     * @param mixed $args      The decoded arguments.
+     * @param int   $action_id The action ID.
+     *
+     * @throws ActionScheduler_InvalidActionException When the decoded arguments are invalid.
+     */
+    protected function validate_args( $args, $action_id ) {
+        // Ensure we have an array of args.
+        if ( ! is_array( $args ) ) {
+            throw ActionScheduler_InvalidActionException::from_decoding_args( $action_id );
+        }
+
+        // Validate JSON decoding if possible.
+        if ( function_exists( 'json_last_error' ) && JSON_ERROR_NONE !== json_last_error() ) {
+            throw ActionScheduler_InvalidActionException::from_decoding_args( $action_id, $args );
+        }
+    }
+
+    /**
+     * Validate a ActionScheduler_Schedule object.
+     *
+     * @param mixed $schedule  The unserialized ActionScheduler_Schedule object.
+     * @param int   $action_id The action ID.
+     *
+     * @throws ActionScheduler_InvalidActionException When the schedule is invalid.
+     */
+    protected function validate_schedule( $schedule, $action_id ) {
+        if ( empty( $schedule ) || ! is_a( $schedule, 'ActionScheduler_Schedule' ) ) {
+            throw ActionScheduler_InvalidActionException::from_schedule( $action_id, $schedule );
+        }
+    }
+
+    /**
+     * InnoDB indexes have a maximum size of 767 bytes by default, which is only 191 characters with utf8mb4.
+     *
+     * Previously, AS wasn't concerned about args length, as we used the (unindex) post_content column. However,
+     * with custom tables, we use an indexed VARCHAR column instead.
+     *
+     * @param  ActionScheduler_Action $action Action to be validated.
+     * @throws InvalidArgumentException When json encoded args is too long.
+     */
+    protected function validate_action( ActionScheduler_Action $action ) {
+        if ( strlen( json_encode( $action->get_args() ) ) > static::$max_args_length ) {
+            throw new InvalidArgumentException( sprintf( __( 'ActionScheduler_Action::$args too long. To ensure the args column can be indexed, action args should not be more than %d characters when encoded as JSON.', 'action-scheduler' ), static::$max_args_length ) );
+        }
+    }
+
+    /**
+     * Cancel pending actions by hook.
+     *
+     * @since 3.0.0
+     *
+     * @param string $hook Hook name.
+     *
+     * @return void
+     */
+    public function cancel_actions_by_hook( $hook ) {
+        $action_ids = true;
+        while ( ! empty( $action_ids ) ) {
+            $action_ids = $this->query_actions(
+                array(
+                    'hook' => $hook,
+                    'status' => self::STATUS_PENDING,
+                    'per_page' => 1000,
+                )
+            );
+
+            $this->bulk_cancel_actions( $action_ids );
+        }
+    }
+
+    /**
+     * Cancel pending actions by group.
+     *
+     * @since 3.0.0
+     *
+     * @param string $group Group slug.
+     *
+     * @return void
+     */
+    public function cancel_actions_by_group( $group ) {
+        $action_ids = true;
+        while ( ! empty( $action_ids ) ) {
+            $action_ids = $this->query_actions(
+                array(
+                    'group' => $group,
+                    'status' => self::STATUS_PENDING,
+                    'per_page' => 1000,
+                )
+            );
+
+            $this->bulk_cancel_actions( $action_ids );
+        }
+    }
+
+    /**
+     * Cancel a set of action IDs.
+     *
+     * @since 3.0.0
+     *
+     * @param array $action_ids List of action IDs.
+     *
+     * @return void
+     */
+    private function bulk_cancel_actions( $action_ids ) {
+        foreach ( $action_ids as $action_id ) {
+            $this->cancel_action( $action_id );
+        }
+
+        do_action( 'action_scheduler_bulk_cancel_actions', $action_ids );
+    }
+
+    /**
+     * @return array
+     */
+    public function get_status_labels() {
+        return array(
+            self::STATUS_COMPLETE => __( 'Complete', 'action-scheduler' ),
+            self::STATUS_PENDING  => __( 'Pending', 'action-scheduler' ),
+            self::STATUS_RUNNING  => __( 'In-progress', 'action-scheduler' ),
+            self::STATUS_FAILED   => __( 'Failed', 'action-scheduler' ),
+            self::STATUS_CANCELED => __( 'Canceled', 'action-scheduler' ),
+        );
+    }
+
+    /**
+     * Check if there are any pending scheduled actions due to run.
+     *
+     * @param ActionScheduler_Action $action
+     * @param DateTime $scheduled_date (optional)
+     * @return string
+     */
+    public function has_pending_actions_due() {
+        $pending_actions = $this->query_actions( array(
+            'date'   => as_get_datetime_object(),
+            'status' => ActionScheduler_Store::STATUS_PENDING,
+        ) );
+
+        return ! empty( $pending_actions );
+    }
+
+    /**
+     * Callable initialization function optionally overridden in derived classes.
+     */
+    public function init() {}
+
+    /**
+     * Callable function to mark an action as migrated optionally overridden in derived classes.
+     */
+    public function mark_migrated( $action_id ) {}
+
+    /**
+     * @return ActionScheduler_Store
+     */
+    public static function instance() {
+        if ( empty( self::$store ) ) {
+            $class = apply_filters( 'action_scheduler_store_class', self::DEFAULT_CLASS );
+            self::$store = new $class();
+        }
+        return self::$store;
+    }
 }

includes/libraries/action-scheduler/classes/abstracts/ActionScheduler_Abstract_Schedule.php

Indentation +67 added lines, -67 removed lines

@@ -5,79 +5,79 @@
  */
 abstract class ActionScheduler_Abstract_Schedule extends ActionScheduler_Schedule_Deprecated {
 
-	/**
-	 * The date & time the schedule is set to run.
-	 *
-	 * @var DateTime
-	 */
-	private $scheduled_date = NULL;
+    /**
+     * The date & time the schedule is set to run.
+     *
+     * @var DateTime
+     */
+    private $scheduled_date = NULL;
 
-	/**
-	 * Timestamp equivalent of @see $this->scheduled_date
-	 *
-	 * @var int
-	 */
-	protected $scheduled_timestamp = NULL;
+    /**
+     * Timestamp equivalent of @see $this->scheduled_date
+     *
+     * @var int
+     */
+    protected $scheduled_timestamp = NULL;
 
-	/**
-	 * @param DateTime $date The date & time to run the action.
-	 */
-	public function __construct( DateTime $date ) {
-		$this->scheduled_date = $date;
-	}
+    /**
+     * @param DateTime $date The date & time to run the action.
+     */
+    public function __construct( DateTime $date ) {
+        $this->scheduled_date = $date;
+    }
 
-	/**
-	 * Check if a schedule should recur.
-	 *
-	 * @return bool
-	 */
-	abstract public function is_recurring();
+    /**
+     * Check if a schedule should recur.
+     *
+     * @return bool
+     */
+    abstract public function is_recurring();
 
-	/**
-	 * Calculate when the next instance of this schedule would run based on a given date & time.
-	 *
-	 * @param DateTime $after
-	 * @return DateTime
-	 */
-	abstract protected function calculate_next( DateTime $after );
+    /**
+     * Calculate when the next instance of this schedule would run based on a given date & time.
+     *
+     * @param DateTime $after
+     * @return DateTime
+     */
+    abstract protected function calculate_next( DateTime $after );
 
-	/**
-	 * Get the next date & time when this schedule should run after a given date & time.
-	 *
-	 * @param DateTime $after
-	 * @return DateTime|null
-	 */
-	public function get_next( DateTime $after ) {
-		$after = clone $after;
-		if ( $after > $this->scheduled_date ) {
-			$after = $this->calculate_next( $after );
-			return $after;
-		}
-		return clone $this->scheduled_date;
-	}
+    /**
+     * Get the next date & time when this schedule should run after a given date & time.
+     *
+     * @param DateTime $after
+     * @return DateTime|null
+     */
+    public function get_next( DateTime $after ) {
+        $after = clone $after;
+        if ( $after > $this->scheduled_date ) {
+            $after = $this->calculate_next( $after );
+            return $after;
+        }
+        return clone $this->scheduled_date;
+    }
 
-	/**
-	 * Get the date & time the schedule is set to run.
-	 *
-	 * @return DateTime|null
-	 */
-	public function get_date() {
-		return $this->scheduled_date;
-	}
+    /**
+     * Get the date & time the schedule is set to run.
+     *
+     * @return DateTime|null
+     */
+    public function get_date() {
+        return $this->scheduled_date;
+    }
 
-	/**
-	 * For PHP 5.2 compat, since DateTime objects can't be serialized
-	 * @return array
-	 */
-	public function __sleep() {
-		$this->scheduled_timestamp = $this->scheduled_date->getTimestamp();
-		return array(
-			'scheduled_timestamp',
-		);
-	}
+    /**
+     * For PHP 5.2 compat, since DateTime objects can't be serialized
+     * @return array
+     */
+    public function __sleep() {
+        $this->scheduled_timestamp = $this->scheduled_date->getTimestamp();
+        return array(
+            'scheduled_timestamp',
+        );
+    }
 
-	public function __wakeup() {
-		$this->scheduled_date = as_get_datetime_object( $this->scheduled_timestamp );
-		unset( $this->scheduled_timestamp );
-	}
+    public function __wakeup() {
+        $this->scheduled_date = as_get_datetime_object( $this->scheduled_timestamp );
+        unset( $this->scheduled_timestamp );
+    }
 }