AyeCode / invoicing

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

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

Indentation +168 added lines, -168 removed lines

@@ -5,172 +5,172 @@
  * @codeCoverageIgnore
  */
 abstract class ActionScheduler_Logger {
-	private static $logger = NULL;
-
-	/**
-	 * @return ActionScheduler_Logger
-	 */
-	public static function instance() {
-		if ( empty(self::$logger) ) {
-			$class = apply_filters('action_scheduler_logger_class', 'ActionScheduler_wpCommentLogger');
-			self::$logger = new $class();
-		}
-		return self::$logger;
-	}
-
-	/**
-	 * @param string $action_id
-	 * @param string $message
-	 * @param DateTime $date
-	 *
-	 * @return string The log entry ID
-	 */
-	abstract public function log( $action_id, $message, DateTime $date = NULL );
-
-	/**
-	 * @param string $entry_id
-	 *
-	 * @return ActionScheduler_LogEntry
-	 */
-	abstract public function get_entry( $entry_id );
-
-	/**
-	 * @param string $action_id
-	 *
-	 * @return ActionScheduler_LogEntry[]
-	 */
-	abstract public function get_logs( $action_id );
-
-
-	/**
-	 * @codeCoverageIgnore
-	 */
-	public function init() {
-		$this->hook_stored_action();
-		add_action( 'action_scheduler_canceled_action', array( $this, 'log_canceled_action' ), 10, 1 );
-		add_action( 'action_scheduler_begin_execute', array( $this, 'log_started_action' ), 10, 2 );
-		add_action( 'action_scheduler_after_execute', array( $this, 'log_completed_action' ), 10, 3 );
-		add_action( 'action_scheduler_failed_execution', array( $this, 'log_failed_action' ), 10, 3 );
-		add_action( 'action_scheduler_failed_action', array( $this, 'log_timed_out_action' ), 10, 2 );
-		add_action( 'action_scheduler_unexpected_shutdown', array( $this, 'log_unexpected_shutdown' ), 10, 2 );
-		add_action( 'action_scheduler_reset_action', array( $this, 'log_reset_action' ), 10, 1 );
-		add_action( 'action_scheduler_execution_ignored', array( $this, 'log_ignored_action' ), 10, 2 );
-		add_action( 'action_scheduler_failed_fetch_action', array( $this, 'log_failed_fetch_action' ), 10, 2 );
-		add_action( 'action_scheduler_failed_to_schedule_next_instance', array( $this, 'log_failed_schedule_next_instance' ), 10, 2 );
-		add_action( 'action_scheduler_bulk_cancel_actions', array( $this, 'bulk_log_cancel_actions' ), 10, 1 );
-	}
-
-	public function hook_stored_action() {
-		add_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
-	}
-
-	public function unhook_stored_action() {
-		remove_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
-	}
-
-	public function log_stored_action( $action_id ) {
-		$this->log( $action_id, __( 'action created', 'action-scheduler' ) );
-	}
-
-	public function log_canceled_action( $action_id ) {
-		$this->log( $action_id, __( 'action canceled', 'action-scheduler' ) );
-	}
-
-	public function log_started_action( $action_id, $context = '' ) {
-		if ( ! empty( $context ) ) {
-			/* translators: %s: context */
-			$message = sprintf( __( 'action started via %s', 'action-scheduler' ), $context );
-		} else {
-			$message = __( 'action started', 'action-scheduler' );
-		}
-		$this->log( $action_id, $message );
-	}
-
-	public function log_completed_action( $action_id, $action = NULL, $context = '' ) {
-		if ( ! empty( $context ) ) {
-			/* translators: %s: context */
-			$message = sprintf( __( 'action complete via %s', 'action-scheduler' ), $context );
-		} else {
-			$message = __( 'action complete', 'action-scheduler' );
-		}
-		$this->log( $action_id, $message );
-	}
-
-	public function log_failed_action( $action_id, Exception $exception, $context = '' ) {
-		if ( ! empty( $context ) ) {
-			/* translators: 1: context 2: exception message */
-			$message = sprintf( __( 'action failed via %1$s: %2$s', 'action-scheduler' ), $context, $exception->getMessage() );
-		} else {
-			/* translators: %s: exception message */
-			$message = sprintf( __( 'action failed: %s', 'action-scheduler' ), $exception->getMessage() );
-		}
-		$this->log( $action_id, $message );
-	}
-
-	public function log_timed_out_action( $action_id, $timeout ) {
-		/* translators: %s: amount of time */
-		$this->log( $action_id, sprintf( __( 'action timed out after %s seconds', 'action-scheduler' ), $timeout ) );
-	}
-
-	public function log_unexpected_shutdown( $action_id, $error ) {
-		if ( ! empty( $error ) ) {
-			/* translators: 1: error message 2: filename 3: line */
-			$this->log( $action_id, sprintf( __( 'unexpected shutdown: PHP Fatal error %1$s in %2$s on line %3$s', 'action-scheduler' ), $error['message'], $error['file'], $error['line'] ) );
-		}
-	}
-
-	public function log_reset_action( $action_id ) {
-		$this->log( $action_id, __( 'action reset', 'action-scheduler' ) );
-	}
-
-	public function log_ignored_action( $action_id, $context = '' ) {
-		if ( ! empty( $context ) ) {
-			/* translators: %s: context */
-			$message = sprintf( __( 'action ignored via %s', 'action-scheduler' ), $context );
-		} else {
-			$message = __( 'action ignored', 'action-scheduler' );
-		}
-		$this->log( $action_id, $message );
-	}
-
-	/**
-	 * @param string $action_id
-	 * @param Exception|NULL $exception The exception which occured when fetching the action. NULL by default for backward compatibility.
-	 *
-	 * @return ActionScheduler_LogEntry[]
-	 */
-	public function log_failed_fetch_action( $action_id, Exception $exception = NULL ) {
-
-		if ( ! is_null( $exception ) ) {
-			/* translators: %s: exception message */
-			$log_message = sprintf( __( 'There was a failure fetching this action: %s', 'action-scheduler' ), $exception->getMessage() );
-		} else {
-			$log_message = __( 'There was a failure fetching this action', 'action-scheduler' );
-		}
-
-		$this->log( $action_id, $log_message );
-	}
-
-	public function log_failed_schedule_next_instance( $action_id, Exception $exception ) {
-		/* translators: %s: exception message */
-		$this->log( $action_id, sprintf( __( 'There was a failure scheduling the next instance of this action: %s', 'action-scheduler' ), $exception->getMessage() ) );
-	}
-
-	/**
-	 * Bulk add cancel action log entries.
-	 *
-	 * Implemented here for backward compatibility. Should be implemented in parent loggers
-	 * for more performant bulk logging.
-	 *
-	 * @param array $action_ids List of action ID.
-	 */
-	public function bulk_log_cancel_actions( $action_ids ) {
-		if ( empty( $action_ids ) ) {
-			return;
-		}
-
-		foreach ( $action_ids as $action_id ) {
-			$this->log_canceled_action( $action_id );
-		}
-	}
+    private static $logger = NULL;
+
+    /**
+     * @return ActionScheduler_Logger
+     */
+    public static function instance() {
+        if ( empty(self::$logger) ) {
+            $class = apply_filters('action_scheduler_logger_class', 'ActionScheduler_wpCommentLogger');
+            self::$logger = new $class();
+        }
+        return self::$logger;
+    }
+
+    /**
+     * @param string $action_id
+     * @param string $message
+     * @param DateTime $date
+     *
+     * @return string The log entry ID
+     */
+    abstract public function log( $action_id, $message, DateTime $date = NULL );
+
+    /**
+     * @param string $entry_id
+     *
+     * @return ActionScheduler_LogEntry
+     */
+    abstract public function get_entry( $entry_id );
+
+    /**
+     * @param string $action_id
+     *
+     * @return ActionScheduler_LogEntry[]
+     */
+    abstract public function get_logs( $action_id );
+
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function init() {
+        $this->hook_stored_action();
+        add_action( 'action_scheduler_canceled_action', array( $this, 'log_canceled_action' ), 10, 1 );
+        add_action( 'action_scheduler_begin_execute', array( $this, 'log_started_action' ), 10, 2 );
+        add_action( 'action_scheduler_after_execute', array( $this, 'log_completed_action' ), 10, 3 );
+        add_action( 'action_scheduler_failed_execution', array( $this, 'log_failed_action' ), 10, 3 );
+        add_action( 'action_scheduler_failed_action', array( $this, 'log_timed_out_action' ), 10, 2 );
+        add_action( 'action_scheduler_unexpected_shutdown', array( $this, 'log_unexpected_shutdown' ), 10, 2 );
+        add_action( 'action_scheduler_reset_action', array( $this, 'log_reset_action' ), 10, 1 );
+        add_action( 'action_scheduler_execution_ignored', array( $this, 'log_ignored_action' ), 10, 2 );
+        add_action( 'action_scheduler_failed_fetch_action', array( $this, 'log_failed_fetch_action' ), 10, 2 );
+        add_action( 'action_scheduler_failed_to_schedule_next_instance', array( $this, 'log_failed_schedule_next_instance' ), 10, 2 );
+        add_action( 'action_scheduler_bulk_cancel_actions', array( $this, 'bulk_log_cancel_actions' ), 10, 1 );
+    }
+
+    public function hook_stored_action() {
+        add_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
+    }
+
+    public function unhook_stored_action() {
+        remove_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
+    }
+
+    public function log_stored_action( $action_id ) {
+        $this->log( $action_id, __( 'action created', 'action-scheduler' ) );
+    }
+
+    public function log_canceled_action( $action_id ) {
+        $this->log( $action_id, __( 'action canceled', 'action-scheduler' ) );
+    }
+
+    public function log_started_action( $action_id, $context = '' ) {
+        if ( ! empty( $context ) ) {
+            /* translators: %s: context */
+            $message = sprintf( __( 'action started via %s', 'action-scheduler' ), $context );
+        } else {
+            $message = __( 'action started', 'action-scheduler' );
+        }
+        $this->log( $action_id, $message );
+    }
+
+    public function log_completed_action( $action_id, $action = NULL, $context = '' ) {
+        if ( ! empty( $context ) ) {
+            /* translators: %s: context */
+            $message = sprintf( __( 'action complete via %s', 'action-scheduler' ), $context );
+        } else {
+            $message = __( 'action complete', 'action-scheduler' );
+        }
+        $this->log( $action_id, $message );
+    }
+
+    public function log_failed_action( $action_id, Exception $exception, $context = '' ) {
+        if ( ! empty( $context ) ) {
+            /* translators: 1: context 2: exception message */
+            $message = sprintf( __( 'action failed via %1$s: %2$s', 'action-scheduler' ), $context, $exception->getMessage() );
+        } else {
+            /* translators: %s: exception message */
+            $message = sprintf( __( 'action failed: %s', 'action-scheduler' ), $exception->getMessage() );
+        }
+        $this->log( $action_id, $message );
+    }
+
+    public function log_timed_out_action( $action_id, $timeout ) {
+        /* translators: %s: amount of time */
+        $this->log( $action_id, sprintf( __( 'action timed out after %s seconds', 'action-scheduler' ), $timeout ) );
+    }
+
+    public function log_unexpected_shutdown( $action_id, $error ) {
+        if ( ! empty( $error ) ) {
+            /* translators: 1: error message 2: filename 3: line */
+            $this->log( $action_id, sprintf( __( 'unexpected shutdown: PHP Fatal error %1$s in %2$s on line %3$s', 'action-scheduler' ), $error['message'], $error['file'], $error['line'] ) );
+        }
+    }
+
+    public function log_reset_action( $action_id ) {
+        $this->log( $action_id, __( 'action reset', 'action-scheduler' ) );
+    }
+
+    public function log_ignored_action( $action_id, $context = '' ) {
+        if ( ! empty( $context ) ) {
+            /* translators: %s: context */
+            $message = sprintf( __( 'action ignored via %s', 'action-scheduler' ), $context );
+        } else {
+            $message = __( 'action ignored', 'action-scheduler' );
+        }
+        $this->log( $action_id, $message );
+    }
+
+    /**
+     * @param string $action_id
+     * @param Exception|NULL $exception The exception which occured when fetching the action. NULL by default for backward compatibility.
+     *
+     * @return ActionScheduler_LogEntry[]
+     */
+    public function log_failed_fetch_action( $action_id, Exception $exception = NULL ) {
+
+        if ( ! is_null( $exception ) ) {
+            /* translators: %s: exception message */
+            $log_message = sprintf( __( 'There was a failure fetching this action: %s', 'action-scheduler' ), $exception->getMessage() );
+        } else {
+            $log_message = __( 'There was a failure fetching this action', 'action-scheduler' );
+        }
+
+        $this->log( $action_id, $log_message );
+    }
+
+    public function log_failed_schedule_next_instance( $action_id, Exception $exception ) {
+        /* translators: %s: exception message */
+        $this->log( $action_id, sprintf( __( 'There was a failure scheduling the next instance of this action: %s', 'action-scheduler' ), $exception->getMessage() ) );
+    }
+
+    /**
+     * Bulk add cancel action log entries.
+     *
+     * Implemented here for backward compatibility. Should be implemented in parent loggers
+     * for more performant bulk logging.
+     *
+     * @param array $action_ids List of action ID.
+     */
+    public function bulk_log_cancel_actions( $action_ids ) {
+        if ( empty( $action_ids ) ) {
+            return;
+        }
+
+        foreach ( $action_ids as $action_id ) {
+            $this->log_canceled_action( $action_id );
+        }
+    }
 }

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

Indentation +52 added lines, -52 removed lines

@@ -7,56 +7,56 @@
  */
 abstract class ActionScheduler_Lock {
 
-	/** @var ActionScheduler_Lock */
-	private static $locker = NULL;
-
-	/** @var int */
-	protected static $lock_duration = MINUTE_IN_SECONDS;
-
-	/**
-	 * Check if a lock is set for a given lock type.
-	 *
-	 * @param string $lock_type A string to identify different lock types.
-	 * @return bool
-	 */
-	public function is_locked( $lock_type ) {
-		return ( $this->get_expiration( $lock_type ) >= time() );
-	}
-
-	/**
-	 * Set a lock.
-	 *
-	 * @param string $lock_type A string to identify different lock types.
-	 * @return bool
-	 */
-	abstract public function set( $lock_type );
-
-	/**
-	 * If a lock is set, return the timestamp it was set to expiry.
-	 *
-	 * @param string $lock_type A string to identify different lock types.
-	 * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire.
-	 */
-	abstract public function get_expiration( $lock_type );
-
-	/**
-	 * Get the amount of time to set for a given lock. 60 seconds by default.
-	 *
-	 * @param string $lock_type A string to identify different lock types.
-	 * @return int
-	 */
-	protected function get_duration( $lock_type ) {
-		return apply_filters( 'action_scheduler_lock_duration', self::$lock_duration, $lock_type );
-	}
-
-	/**
-	 * @return ActionScheduler_Lock
-	 */
-	public static function instance() {
-		if ( empty( self::$locker ) ) {
-			$class = apply_filters( 'action_scheduler_lock_class', 'ActionScheduler_OptionLock' );
-			self::$locker = new $class();
-		}
-		return self::$locker;
-	}
+    /** @var ActionScheduler_Lock */
+    private static $locker = NULL;
+
+    /** @var int */
+    protected static $lock_duration = MINUTE_IN_SECONDS;
+
+    /**
+     * Check if a lock is set for a given lock type.
+     *
+     * @param string $lock_type A string to identify different lock types.
+     * @return bool
+     */
+    public function is_locked( $lock_type ) {
+        return ( $this->get_expiration( $lock_type ) >= time() );
+    }
+
+    /**
+     * Set a lock.
+     *
+     * @param string $lock_type A string to identify different lock types.
+     * @return bool
+     */
+    abstract public function set( $lock_type );
+
+    /**
+     * If a lock is set, return the timestamp it was set to expiry.
+     *
+     * @param string $lock_type A string to identify different lock types.
+     * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire.
+     */
+    abstract public function get_expiration( $lock_type );
+
+    /**
+     * Get the amount of time to set for a given lock. 60 seconds by default.
+     *
+     * @param string $lock_type A string to identify different lock types.
+     * @return int
+     */
+    protected function get_duration( $lock_type ) {
+        return apply_filters( 'action_scheduler_lock_duration', self::$lock_duration, $lock_type );
+    }
+
+    /**
+     * @return ActionScheduler_Lock
+     */
+    public static function instance() {
+        if ( empty( self::$locker ) ) {
+            $class = apply_filters( 'action_scheduler_lock_class', 'ActionScheduler_OptionLock' );
+            self::$locker = new $class();
+        }
+        return self::$locker;
+    }
 }

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

Indentation +264 added lines, -264 removed lines

@@ -8,268 +8,268 @@
  * @codeCoverageIgnore
  */
 abstract class ActionScheduler {
-	private static $plugin_file = '';
-	/** @var ActionScheduler_ActionFactory */
-	private static $factory = NULL;
-
-	public static function factory() {
-		if ( !isset(self::$factory) ) {
-			self::$factory = new ActionScheduler_ActionFactory();
-		}
-		return self::$factory;
-	}
-
-	public static function store() {
-		return ActionScheduler_Store::instance();
-	}
-
-	public static function lock() {
-		return ActionScheduler_Lock::instance();
-	}
-
-	public static function logger() {
-		return ActionScheduler_Logger::instance();
-	}
-
-	public static function runner() {
-		return ActionScheduler_QueueRunner::instance();
-	}
-
-	public static function admin_view() {
-		return ActionScheduler_AdminView::instance();
-	}
-
-	/**
-	 * Get the absolute system path to the plugin directory, or a file therein
-	 * @static
-	 * @param string $path
-	 * @return string
-	 */
-	public static function plugin_path( $path ) {
-		$base = dirname(self::$plugin_file);
-		if ( $path ) {
-			return trailingslashit($base).$path;
-		} else {
-			return untrailingslashit($base);
-		}
-	}
-
-	/**
-	 * Get the absolute URL to the plugin directory, or a file therein
-	 * @static
-	 * @param string $path
-	 * @return string
-	 */
-	public static function plugin_url( $path ) {
-		return plugins_url($path, self::$plugin_file);
-	}
-
-	public static function autoload( $class ) {
-		$d           = DIRECTORY_SEPARATOR;
-		$classes_dir = self::plugin_path( 'classes' . $d );
-		$separator   = strrpos( $class, '\\' );
-		if ( false !== $separator ) {
-			if ( 0 !== strpos( $class, 'Action_Scheduler' ) ) {
-				return;
-			}
-			$class = substr( $class, $separator + 1 );
-		}
-
-		if ( 'Deprecated' === substr( $class, -10 ) ) {
-			$dir = self::plugin_path( 'deprecated' . $d );
-		} elseif ( self::is_class_abstract( $class ) ) {
-			$dir = $classes_dir . 'abstracts' . $d;
-		} elseif ( self::is_class_migration( $class ) ) {
-			$dir = $classes_dir . 'migration' . $d;
-		} elseif ( 'Schedule' === substr( $class, -8 ) ) {
-			$dir = $classes_dir . 'schedules' . $d;
-		} elseif ( 'Action' === substr( $class, -6 ) ) {
-			$dir = $classes_dir . 'actions' . $d;
-		} elseif ( 'Schema' === substr( $class, -6 ) ) {
-			$dir = $classes_dir . 'schema' . $d;
-		} elseif ( strpos( $class, 'ActionScheduler' ) === 0 ) {
-			$segments = explode( '_', $class );
-			$type = isset( $segments[ 1 ] ) ? $segments[ 1 ] : '';
-
-			switch ( $type ) {
-				case 'WPCLI':
-					$dir = $classes_dir . 'WP_CLI' . $d;
-					break;
-				case 'DBLogger':
-				case 'DBStore':
-				case 'HybridStore':
-				case 'wpPostStore':
-				case 'wpCommentLogger':
-					$dir = $classes_dir . 'data-stores' . $d;
-					break;
-				default:
-					$dir = $classes_dir;
-					break;
-			}
-		} elseif ( self::is_class_cli( $class ) ) {
-			$dir = $classes_dir . 'WP_CLI' . $d;
-		} elseif ( strpos( $class, 'CronExpression' ) === 0 ) {
-			$dir = self::plugin_path( 'lib' . $d . 'cron-expression' . $d );
-		} elseif ( strpos( $class, 'WP_Async_Request' ) === 0 ) {
-			$dir = self::plugin_path( 'lib' . $d );
-		} else {
-			return;
-		}
-
-		if ( file_exists( "{$dir}{$class}.php" ) ) {
-			include( "{$dir}{$class}.php" );
-			return;
-		}
-	}
-
-	/**
-	 * Initialize the plugin
-	 *
-	 * @static
-	 * @param string $plugin_file
-	 */
-	public static function init( $plugin_file ) {
-		self::$plugin_file = $plugin_file;
-		spl_autoload_register( array( __CLASS__, 'autoload' ) );
-
-		/**
-		 * Fires in the early stages of Action Scheduler init hook.
-		 */
-		do_action( 'action_scheduler_pre_init' );
-
-		require_once( self::plugin_path( 'functions.php' ) );
-		ActionScheduler_DataController::init();
-
-		$store      = self::store();
-		$logger     = self::logger();
-		$runner     = self::runner();
-		$admin_view = self::admin_view();
-
-		// Ensure initialization on plugin activation.
-		if ( ! did_action( 'init' ) ) {
-			add_action( 'init', array( $admin_view, 'init' ), 0, 0 ); // run before $store::init()
-			add_action( 'init', array( $store, 'init' ), 1, 0 );
-			add_action( 'init', array( $logger, 'init' ), 1, 0 );
-			add_action( 'init', array( $runner, 'init' ), 1, 0 );
-		} else {
-			$admin_view->init();
-			$store->init();
-			$logger->init();
-			$runner->init();
-		}
-
-		if ( apply_filters( 'action_scheduler_load_deprecated_functions', true ) ) {
-			require_once( self::plugin_path( 'deprecated/functions.php' ) );
-		}
-
-		if ( defined( 'WP_CLI' ) && WP_CLI ) {
-			WP_CLI::add_command( 'action-scheduler', 'ActionScheduler_WPCLI_Scheduler_command' );
-			if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration() ) {
-				$command = new Migration_Command();
-				$command->register();
-			}
-		}
-
-		/**
-		 * Handle WP comment cleanup after migration.
-		 */
-		if ( is_a( $logger, 'ActionScheduler_DBLogger' ) && ActionScheduler_DataController::is_migration_complete() && ActionScheduler_WPCommentCleaner::has_logs() ) {
-			ActionScheduler_WPCommentCleaner::init();
-		}
-
-		add_action( 'action_scheduler/migration_complete', 'ActionScheduler_WPCommentCleaner::maybe_schedule_cleanup' );
-	}
-
-	/**
-	 * Determine if the class is one of our abstract classes.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $class The class name.
-	 *
-	 * @return bool
-	 */
-	protected static function is_class_abstract( $class ) {
-		static $abstracts = array(
-			'ActionScheduler'                            => true,
-			'ActionScheduler_Abstract_ListTable'         => true,
-			'ActionScheduler_Abstract_QueueRunner'       => true,
-			'ActionScheduler_Abstract_Schedule'          => true,
-			'ActionScheduler_Abstract_RecurringSchedule' => true,
-			'ActionScheduler_Lock'                       => true,
-			'ActionScheduler_Logger'                     => true,
-			'ActionScheduler_Abstract_Schema'            => true,
-			'ActionScheduler_Store'                      => true,
-			'ActionScheduler_TimezoneHelper'             => true,
-		);
-
-		return isset( $abstracts[ $class ] ) && $abstracts[ $class ];
-	}
-
-	/**
-	 * Determine if the class is one of our migration classes.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $class The class name.
-	 *
-	 * @return bool
-	 */
-	protected static function is_class_migration( $class ) {
-		static $migration_segments = array(
-			'ActionMigrator'  => true,
-			'BatchFetcher'    => true,
-			'DBStoreMigrator' => true,
-			'DryRun'          => true,
-			'LogMigrator'     => true,
-			'Config'          => true,
-			'Controller'      => true,
-			'Runner'          => true,
-			'Scheduler'       => true,
-		);
-
-		$segments = explode( '_', $class );
-		$segment = isset( $segments[ 1 ] ) ? $segments[ 1 ] : $class;
-
-		return isset( $migration_segments[ $segment ] ) && $migration_segments[ $segment ];
-	}
-
-	/**
-	 * Determine if the class is one of our WP CLI classes.
-	 *
-	 * @since 3.0.0
-	 *
-	 * @param string $class The class name.
-	 *
-	 * @return bool
-	 */
-	protected static function is_class_cli( $class ) {
-		static $cli_segments = array(
-			'QueueRunner' => true,
-			'Command'     => true,
-			'ProgressBar' => true,
-		);
-
-		$segments = explode( '_', $class );
-		$segment = isset( $segments[ 1 ] ) ? $segments[ 1 ] : $class;
-
-		return isset( $cli_segments[ $segment ] ) && $cli_segments[ $segment ];
-	}
-
-	final public function __clone() {
-		trigger_error("Singleton. No cloning allowed!", E_USER_ERROR);
-	}
-
-	final public function __wakeup() {
-		trigger_error("Singleton. No serialization allowed!", E_USER_ERROR);
-	}
-
-	final private function __construct() {}
-
-	/** Deprecated **/
-
-	public static function get_datetime_object( $when = null, $timezone = 'UTC' ) {
-		_deprecated_function( __METHOD__, '2.0', 'wcs_add_months()' );
-		return as_get_datetime_object( $when, $timezone );
-	}
+    private static $plugin_file = '';
+    /** @var ActionScheduler_ActionFactory */
+    private static $factory = NULL;
+
+    public static function factory() {
+        if ( !isset(self::$factory) ) {
+            self::$factory = new ActionScheduler_ActionFactory();
+        }
+        return self::$factory;
+    }
+
+    public static function store() {
+        return ActionScheduler_Store::instance();
+    }
+
+    public static function lock() {
+        return ActionScheduler_Lock::instance();
+    }
+
+    public static function logger() {
+        return ActionScheduler_Logger::instance();
+    }
+
+    public static function runner() {
+        return ActionScheduler_QueueRunner::instance();
+    }
+
+    public static function admin_view() {
+        return ActionScheduler_AdminView::instance();
+    }
+
+    /**
+     * Get the absolute system path to the plugin directory, or a file therein
+     * @static
+     * @param string $path
+     * @return string
+     */
+    public static function plugin_path( $path ) {
+        $base = dirname(self::$plugin_file);
+        if ( $path ) {
+            return trailingslashit($base).$path;
+        } else {
+            return untrailingslashit($base);
+        }
+    }
+
+    /**
+     * Get the absolute URL to the plugin directory, or a file therein
+     * @static
+     * @param string $path
+     * @return string
+     */
+    public static function plugin_url( $path ) {
+        return plugins_url($path, self::$plugin_file);
+    }
+
+    public static function autoload( $class ) {
+        $d           = DIRECTORY_SEPARATOR;
+        $classes_dir = self::plugin_path( 'classes' . $d );
+        $separator   = strrpos( $class, '\\' );
+        if ( false !== $separator ) {
+            if ( 0 !== strpos( $class, 'Action_Scheduler' ) ) {
+                return;
+            }
+            $class = substr( $class, $separator + 1 );
+        }
+
+        if ( 'Deprecated' === substr( $class, -10 ) ) {
+            $dir = self::plugin_path( 'deprecated' . $d );
+        } elseif ( self::is_class_abstract( $class ) ) {
+            $dir = $classes_dir . 'abstracts' . $d;
+        } elseif ( self::is_class_migration( $class ) ) {
+            $dir = $classes_dir . 'migration' . $d;
+        } elseif ( 'Schedule' === substr( $class, -8 ) ) {
+            $dir = $classes_dir . 'schedules' . $d;
+        } elseif ( 'Action' === substr( $class, -6 ) ) {
+            $dir = $classes_dir . 'actions' . $d;
+        } elseif ( 'Schema' === substr( $class, -6 ) ) {
+            $dir = $classes_dir . 'schema' . $d;
+        } elseif ( strpos( $class, 'ActionScheduler' ) === 0 ) {
+            $segments = explode( '_', $class );
+            $type = isset( $segments[ 1 ] ) ? $segments[ 1 ] : '';
+
+            switch ( $type ) {
+                case 'WPCLI':
+                    $dir = $classes_dir . 'WP_CLI' . $d;
+                    break;
+                case 'DBLogger':
+                case 'DBStore':
+                case 'HybridStore':
+                case 'wpPostStore':
+                case 'wpCommentLogger':
+                    $dir = $classes_dir . 'data-stores' . $d;
+                    break;
+                default:
+                    $dir = $classes_dir;
+                    break;
+            }
+        } elseif ( self::is_class_cli( $class ) ) {
+            $dir = $classes_dir . 'WP_CLI' . $d;
+        } elseif ( strpos( $class, 'CronExpression' ) === 0 ) {
+            $dir = self::plugin_path( 'lib' . $d . 'cron-expression' . $d );
+        } elseif ( strpos( $class, 'WP_Async_Request' ) === 0 ) {
+            $dir = self::plugin_path( 'lib' . $d );
+        } else {
+            return;
+        }
+
+        if ( file_exists( "{$dir}{$class}.php" ) ) {
+            include( "{$dir}{$class}.php" );
+            return;
+        }
+    }
+
+    /**
+     * Initialize the plugin
+     *
+     * @static
+     * @param string $plugin_file
+     */
+    public static function init( $plugin_file ) {
+        self::$plugin_file = $plugin_file;
+        spl_autoload_register( array( __CLASS__, 'autoload' ) );
+
+        /**
+         * Fires in the early stages of Action Scheduler init hook.
+         */
+        do_action( 'action_scheduler_pre_init' );
+
+        require_once( self::plugin_path( 'functions.php' ) );
+        ActionScheduler_DataController::init();
+
+        $store      = self::store();
+        $logger     = self::logger();
+        $runner     = self::runner();
+        $admin_view = self::admin_view();
+
+        // Ensure initialization on plugin activation.
+        if ( ! did_action( 'init' ) ) {
+            add_action( 'init', array( $admin_view, 'init' ), 0, 0 ); // run before $store::init()
+            add_action( 'init', array( $store, 'init' ), 1, 0 );
+            add_action( 'init', array( $logger, 'init' ), 1, 0 );
+            add_action( 'init', array( $runner, 'init' ), 1, 0 );
+        } else {
+            $admin_view->init();
+            $store->init();
+            $logger->init();
+            $runner->init();
+        }
+
+        if ( apply_filters( 'action_scheduler_load_deprecated_functions', true ) ) {
+            require_once( self::plugin_path( 'deprecated/functions.php' ) );
+        }
+
+        if ( defined( 'WP_CLI' ) && WP_CLI ) {
+            WP_CLI::add_command( 'action-scheduler', 'ActionScheduler_WPCLI_Scheduler_command' );
+            if ( ! ActionScheduler_DataController::is_migration_complete() && Controller::instance()->allow_migration() ) {
+                $command = new Migration_Command();
+                $command->register();
+            }
+        }
+
+        /**
+         * Handle WP comment cleanup after migration.
+         */
+        if ( is_a( $logger, 'ActionScheduler_DBLogger' ) && ActionScheduler_DataController::is_migration_complete() && ActionScheduler_WPCommentCleaner::has_logs() ) {
+            ActionScheduler_WPCommentCleaner::init();
+        }
+
+        add_action( 'action_scheduler/migration_complete', 'ActionScheduler_WPCommentCleaner::maybe_schedule_cleanup' );
+    }
+
+    /**
+     * Determine if the class is one of our abstract classes.
+     *
+     * @since 3.0.0
+     *
+     * @param string $class The class name.
+     *
+     * @return bool
+     */
+    protected static function is_class_abstract( $class ) {
+        static $abstracts = array(
+            'ActionScheduler'                            => true,
+            'ActionScheduler_Abstract_ListTable'         => true,
+            'ActionScheduler_Abstract_QueueRunner'       => true,
+            'ActionScheduler_Abstract_Schedule'          => true,
+            'ActionScheduler_Abstract_RecurringSchedule' => true,
+            'ActionScheduler_Lock'                       => true,
+            'ActionScheduler_Logger'                     => true,
+            'ActionScheduler_Abstract_Schema'            => true,
+            'ActionScheduler_Store'                      => true,
+            'ActionScheduler_TimezoneHelper'             => true,
+        );
+
+        return isset( $abstracts[ $class ] ) && $abstracts[ $class ];
+    }
+
+    /**
+     * Determine if the class is one of our migration classes.
+     *
+     * @since 3.0.0
+     *
+     * @param string $class The class name.
+     *
+     * @return bool
+     */
+    protected static function is_class_migration( $class ) {
+        static $migration_segments = array(
+            'ActionMigrator'  => true,
+            'BatchFetcher'    => true,
+            'DBStoreMigrator' => true,
+            'DryRun'          => true,
+            'LogMigrator'     => true,
+            'Config'          => true,
+            'Controller'      => true,
+            'Runner'          => true,
+            'Scheduler'       => true,
+        );
+
+        $segments = explode( '_', $class );
+        $segment = isset( $segments[ 1 ] ) ? $segments[ 1 ] : $class;
+
+        return isset( $migration_segments[ $segment ] ) && $migration_segments[ $segment ];
+    }
+
+    /**
+     * Determine if the class is one of our WP CLI classes.
+     *
+     * @since 3.0.0
+     *
+     * @param string $class The class name.
+     *
+     * @return bool
+     */
+    protected static function is_class_cli( $class ) {
+        static $cli_segments = array(
+            'QueueRunner' => true,
+            'Command'     => true,
+            'ProgressBar' => true,
+        );
+
+        $segments = explode( '_', $class );
+        $segment = isset( $segments[ 1 ] ) ? $segments[ 1 ] : $class;
+
+        return isset( $cli_segments[ $segment ] ) && $cli_segments[ $segment ];
+    }
+
+    final public function __clone() {
+        trigger_error("Singleton. No cloning allowed!", E_USER_ERROR);
+    }
+
+    final public function __wakeup() {
+        trigger_error("Singleton. No serialization allowed!", E_USER_ERROR);
+    }
+
+    final private function __construct() {}
+
+    /** Deprecated **/
+
+    public static function get_datetime_object( $when = null, $timezone = 'UTC' ) {
+        _deprecated_function( __METHOD__, '2.0', 'wcs_add_months()' );
+        return as_get_datetime_object( $when, $timezone );
+    }
 }

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

Indentation +120 added lines, -120 removed lines

@@ -12,124 +12,124 @@
  */
 abstract class ActionScheduler_Abstract_Schema {
 
-	/**
-	 * @var int Increment this value in derived class to trigger a schema update.
-	 */
-	protected $schema_version = 1;
-
-	/**
-	 * @var array Names of tables that will be registered by this class.
-	 */
-	protected $tables = [];
-
-	/**
-	 * Register tables with WordPress, and create them if needed.
-	 *
-	 * @param bool $force_update Optional. Default false. Use true to always run the schema update.
-	 *
-	 * @return void
-	 */
-	public function register_tables( $force_update = false ) {
-		global $wpdb;
-
-		// make WP aware of our tables
-		foreach ( $this->tables as $table ) {
-			$wpdb->tables[] = $table;
-			$name           = $this->get_full_table_name( $table );
-			$wpdb->$table   = $name;
-		}
-
-		// create the tables
-		if ( $this->schema_update_required() || $force_update ) {
-			foreach ( $this->tables as $table ) {
-				$this->update_table( $table );
-			}
-			$this->mark_schema_update_complete();
-		}
-	}
-
-	/**
-	 * @param string $table The name of the table
-	 *
-	 * @return string The CREATE TABLE statement, suitable for passing to dbDelta
-	 */
-	abstract protected function get_table_definition( $table );
-
-	/**
-	 * Determine if the database schema is out of date
-	 * by comparing the integer found in $this->schema_version
-	 * with the option set in the WordPress options table
-	 *
-	 * @return bool
-	 */
-	private function schema_update_required() {
-		$option_name         = 'schema-' . static::class;
-		$version_found_in_db = get_option( $option_name, 0 );
-
-		// Check for schema option stored by the Action Scheduler Custom Tables plugin in case site has migrated from that plugin with an older schema
-		if ( 0 === $version_found_in_db ) {
-
-			$plugin_option_name = 'schema-';
-
-			switch ( static::class ) {
-				case 'ActionScheduler_StoreSchema' :
-					$plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Store_Table_Maker';
-					break;
-				case 'ActionScheduler_LoggerSchema' :
-					$plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Logger_Table_Maker';
-					break;
-			}
-
-			$version_found_in_db = get_option( $plugin_option_name, 0 );
-
-			delete_option( $plugin_option_name );
-		}
-
-		return version_compare( $version_found_in_db, $this->schema_version, '<' );
-	}
-
-	/**
-	 * Update the option in WordPress to indicate that
-	 * our schema is now up to date
-	 *
-	 * @return void
-	 */
-	private function mark_schema_update_complete() {
-		$option_name = 'schema-' . static::class;
-
-		// work around race conditions and ensure that our option updates
-		$value_to_save = (string) $this->schema_version . '.0.' . time();
-
-		update_option( $option_name, $value_to_save );
-	}
-
-	/**
-	 * Update the schema for the given table
-	 *
-	 * @param string $table The name of the table to update
-	 *
-	 * @return void
-	 */
-	private function update_table( $table ) {
-		require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
-		$definition = $this->get_table_definition( $table );
-		if ( $definition ) {
-			$updated = dbDelta( $definition );
-			foreach ( $updated as $updated_table => $update_description ) {
-				if ( strpos( $update_description, 'Created table' ) === 0 ) {
-					do_action( 'action_scheduler/created_table', $updated_table, $table );
-				}
-			}
-		}
-	}
-
-	/**
-	 * @param string $table
-	 *
-	 * @return string The full name of the table, including the
-	 *                table prefix for the current blog
-	 */
-	protected function get_full_table_name( $table ) {
-		return $GLOBALS[ 'wpdb' ]->prefix . $table;
-	}
+    /**
+     * @var int Increment this value in derived class to trigger a schema update.
+     */
+    protected $schema_version = 1;
+
+    /**
+     * @var array Names of tables that will be registered by this class.
+     */
+    protected $tables = [];
+
+    /**
+     * Register tables with WordPress, and create them if needed.
+     *
+     * @param bool $force_update Optional. Default false. Use true to always run the schema update.
+     *
+     * @return void
+     */
+    public function register_tables( $force_update = false ) {
+        global $wpdb;
+
+        // make WP aware of our tables
+        foreach ( $this->tables as $table ) {
+            $wpdb->tables[] = $table;
+            $name           = $this->get_full_table_name( $table );
+            $wpdb->$table   = $name;
+        }
+
+        // create the tables
+        if ( $this->schema_update_required() || $force_update ) {
+            foreach ( $this->tables as $table ) {
+                $this->update_table( $table );
+            }
+            $this->mark_schema_update_complete();
+        }
+    }
+
+    /**
+     * @param string $table The name of the table
+     *
+     * @return string The CREATE TABLE statement, suitable for passing to dbDelta
+     */
+    abstract protected function get_table_definition( $table );
+
+    /**
+     * Determine if the database schema is out of date
+     * by comparing the integer found in $this->schema_version
+     * with the option set in the WordPress options table
+     *
+     * @return bool
+     */
+    private function schema_update_required() {
+        $option_name         = 'schema-' . static::class;
+        $version_found_in_db = get_option( $option_name, 0 );
+
+        // Check for schema option stored by the Action Scheduler Custom Tables plugin in case site has migrated from that plugin with an older schema
+        if ( 0 === $version_found_in_db ) {
+
+            $plugin_option_name = 'schema-';
+
+            switch ( static::class ) {
+                case 'ActionScheduler_StoreSchema' :
+                    $plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Store_Table_Maker';
+                    break;
+                case 'ActionScheduler_LoggerSchema' :
+                    $plugin_option_name .= 'Action_Scheduler\Custom_Tables\DB_Logger_Table_Maker';
+                    break;
+            }
+
+            $version_found_in_db = get_option( $plugin_option_name, 0 );
+
+            delete_option( $plugin_option_name );
+        }
+
+        return version_compare( $version_found_in_db, $this->schema_version, '<' );
+    }
+
+    /**
+     * Update the option in WordPress to indicate that
+     * our schema is now up to date
+     *
+     * @return void
+     */
+    private function mark_schema_update_complete() {
+        $option_name = 'schema-' . static::class;
+
+        // work around race conditions and ensure that our option updates
+        $value_to_save = (string) $this->schema_version . '.0.' . time();
+
+        update_option( $option_name, $value_to_save );
+    }
+
+    /**
+     * Update the schema for the given table
+     *
+     * @param string $table The name of the table to update
+     *
+     * @return void
+     */
+    private function update_table( $table ) {
+        require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
+        $definition = $this->get_table_definition( $table );
+        if ( $definition ) {
+            $updated = dbDelta( $definition );
+            foreach ( $updated as $updated_table => $update_description ) {
+                if ( strpos( $update_description, 'Created table' ) === 0 ) {
+                    do_action( 'action_scheduler/created_table', $updated_table, $table );
+                }
+            }
+        }
+    }
+
+    /**
+     * @param string $table
+     *
+     * @return string The full name of the table, including the
+     *                table prefix for the current blog
+     */
+    protected function get_full_table_name( $table ) {
+        return $GLOBALS[ 'wpdb' ]->prefix . $table;
+    }
 }
\ No newline at end of file

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

Indentation +81 added lines, -81 removed lines

@@ -5,95 +5,95 @@
  */
 class ActionScheduler_Compatibility {
 
-	/**
-	 * Converts a shorthand byte value to an integer byte value.
-	 *
-	 * Wrapper for wp_convert_hr_to_bytes(), moved to load.php in WordPress 4.6 from media.php
-	 *
-	 * @link https://secure.php.net/manual/en/function.ini-get.php
-	 * @link https://secure.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
-	 *
-	 * @param string $value A (PHP ini) byte value, either shorthand or ordinary.
-	 * @return int An integer byte value.
-	 */
-	public static function convert_hr_to_bytes( $value ) {
-		if ( function_exists( 'wp_convert_hr_to_bytes' ) ) {
-			return wp_convert_hr_to_bytes( $value );
-		}
+    /**
+     * Converts a shorthand byte value to an integer byte value.
+     *
+     * Wrapper for wp_convert_hr_to_bytes(), moved to load.php in WordPress 4.6 from media.php
+     *
+     * @link https://secure.php.net/manual/en/function.ini-get.php
+     * @link https://secure.php.net/manual/en/faq.using.php#faq.using.shorthandbytes
+     *
+     * @param string $value A (PHP ini) byte value, either shorthand or ordinary.
+     * @return int An integer byte value.
+     */
+    public static function convert_hr_to_bytes( $value ) {
+        if ( function_exists( 'wp_convert_hr_to_bytes' ) ) {
+            return wp_convert_hr_to_bytes( $value );
+        }
 
-		$value = strtolower( trim( $value ) );
-		$bytes = (int) $value;
+        $value = strtolower( trim( $value ) );
+        $bytes = (int) $value;
 
-		if ( false !== strpos( $value, 'g' ) ) {
-			$bytes *= GB_IN_BYTES;
-		} elseif ( false !== strpos( $value, 'm' ) ) {
-			$bytes *= MB_IN_BYTES;
-		} elseif ( false !== strpos( $value, 'k' ) ) {
-			$bytes *= KB_IN_BYTES;
-		}
+        if ( false !== strpos( $value, 'g' ) ) {
+            $bytes *= GB_IN_BYTES;
+        } elseif ( false !== strpos( $value, 'm' ) ) {
+            $bytes *= MB_IN_BYTES;
+        } elseif ( false !== strpos( $value, 'k' ) ) {
+            $bytes *= KB_IN_BYTES;
+        }
 
-		// Deal with large (float) values which run into the maximum integer size.
-		return min( $bytes, PHP_INT_MAX );
-	}
+        // Deal with large (float) values which run into the maximum integer size.
+        return min( $bytes, PHP_INT_MAX );
+    }
 
-	/**
-	 * Attempts to raise the PHP memory limit for memory intensive processes.
-	 *
-	 * Only allows raising the existing limit and prevents lowering it.
-	 *
-	 * Wrapper for wp_raise_memory_limit(), added in WordPress v4.6.0
-	 *
-	 * @return bool|int|string The limit that was set or false on failure.
-	 */
-	public static function raise_memory_limit() {
-		if ( function_exists( 'wp_raise_memory_limit' ) ) {
-			return wp_raise_memory_limit( 'admin' );
-		}
+    /**
+     * Attempts to raise the PHP memory limit for memory intensive processes.
+     *
+     * Only allows raising the existing limit and prevents lowering it.
+     *
+     * Wrapper for wp_raise_memory_limit(), added in WordPress v4.6.0
+     *
+     * @return bool|int|string The limit that was set or false on failure.
+     */
+    public static function raise_memory_limit() {
+        if ( function_exists( 'wp_raise_memory_limit' ) ) {
+            return wp_raise_memory_limit( 'admin' );
+        }
 
-		$current_limit     = @ini_get( 'memory_limit' );
-		$current_limit_int = self::convert_hr_to_bytes( $current_limit );
+        $current_limit     = @ini_get( 'memory_limit' );
+        $current_limit_int = self::convert_hr_to_bytes( $current_limit );
 
-		if ( -1 === $current_limit_int ) {
-			return false;
-		}
+        if ( -1 === $current_limit_int ) {
+            return false;
+        }
 
-		$wp_max_limit       = WP_MAX_MEMORY_LIMIT;
-		$wp_max_limit_int   = self::convert_hr_to_bytes( $wp_max_limit );
-		$filtered_limit     = apply_filters( 'admin_memory_limit', $wp_max_limit );
-		$filtered_limit_int = self::convert_hr_to_bytes( $filtered_limit );
+        $wp_max_limit       = WP_MAX_MEMORY_LIMIT;
+        $wp_max_limit_int   = self::convert_hr_to_bytes( $wp_max_limit );
+        $filtered_limit     = apply_filters( 'admin_memory_limit', $wp_max_limit );
+        $filtered_limit_int = self::convert_hr_to_bytes( $filtered_limit );
 
-		if ( -1 === $filtered_limit_int || ( $filtered_limit_int > $wp_max_limit_int && $filtered_limit_int > $current_limit_int ) ) {
-			if ( false !== @ini_set( 'memory_limit', $filtered_limit ) ) {
-				return $filtered_limit;
-			} else {
-				return false;
-			}
-		} elseif ( -1 === $wp_max_limit_int || $wp_max_limit_int > $current_limit_int ) {
-			if ( false !== @ini_set( 'memory_limit', $wp_max_limit ) ) {
-				return $wp_max_limit;
-			} else {
-				return false;
-			}
-		}
-		return false;
-	}
+        if ( -1 === $filtered_limit_int || ( $filtered_limit_int > $wp_max_limit_int && $filtered_limit_int > $current_limit_int ) ) {
+            if ( false !== @ini_set( 'memory_limit', $filtered_limit ) ) {
+                return $filtered_limit;
+            } else {
+                return false;
+            }
+        } elseif ( -1 === $wp_max_limit_int || $wp_max_limit_int > $current_limit_int ) {
+            if ( false !== @ini_set( 'memory_limit', $wp_max_limit ) ) {
+                return $wp_max_limit;
+            } else {
+                return false;
+            }
+        }
+        return false;
+    }
 
-	/**
-	 * Attempts to raise the PHP timeout for time intensive processes.
-	 *
-	 * Only allows raising the existing limit and prevents lowering it. Wrapper for wc_set_time_limit(), when available.
-	 *
-	 * @param int The time limit in seconds.
-	 */
-	public static function raise_time_limit( $limit = 0 ) {
-		if ( $limit < ini_get( 'max_execution_time' ) ) {
-			return;
-		}
+    /**
+     * Attempts to raise the PHP timeout for time intensive processes.
+     *
+     * Only allows raising the existing limit and prevents lowering it. Wrapper for wc_set_time_limit(), when available.
+     *
+     * @param int The time limit in seconds.
+     */
+    public static function raise_time_limit( $limit = 0 ) {
+        if ( $limit < ini_get( 'max_execution_time' ) ) {
+            return;
+        }
 
-		if ( function_exists( 'wc_set_time_limit' ) ) {
-			wc_set_time_limit( $limit );
-		} elseif ( function_exists( 'set_time_limit' ) && false === strpos( ini_get( 'disable_functions' ), 'set_time_limit' ) && ! ini_get( 'safe_mode' ) ) {
-			@set_time_limit( $limit );
-		}
-	}
+        if ( function_exists( 'wc_set_time_limit' ) ) {
+            wc_set_time_limit( $limit );
+        } elseif ( function_exists( 'set_time_limit' ) && false === strpos( ini_get( 'disable_functions' ), 'set_time_limit' ) && ! ini_get( 'safe_mode' ) ) {
+            @set_time_limit( $limit );
+        }
+    }
 }