CronRule.class.php in Ultimate Cron 7.2
Same filename and directory in other branches
This class parses cron rules and determines last execution time using least case integer comparison.
File
CronRule.class.phpView source
<?php
/**
* @file
* This class parses cron rules and determines last
* execution time using least case integer comparison.
*/
class CronRule {
public $rule = NULL;
public $time = NULL;
public $skew = 0;
public $allow_shorthand = FALSE;
private static $ranges = array(
'minutes' => array(
0,
59,
),
'hours' => array(
0,
23,
),
'days' => array(
1,
31,
),
'months' => array(
1,
12,
),
'weekdays' => array(
0,
6,
),
);
private $type = NULL;
private static $cache = array();
private static $instances = array();
private $last_run;
private $next_run;
/**
* Factory method for CronRule instance.
*
* @param string $rule
* The crontab rule to use.
* @param int $time
* The time to test against.
* @param int $skew
* Skew for @ flag.
*
* @return CronRule
* CronRule object.
*/
public static function factory($rule, $time = NULL, $skew = 0) {
if (strpos($rule, '@') === FALSE) {
$skew = 0;
}
$time = isset($time) ? (int) $time : time();
$key = "{$rule}:{$time}:{$skew}";
if (isset(self::$instances[$key])) {
return self::$instances[$key];
}
self::$instances[$key] = new CronRule($rule, $time, $skew);
return self::$instances[$key];
}
/**
* Constructor.
*
* @param string $rule
* The crontab rule to use.
* @param int $time
* The time to test against.
* @param int $skew
* Skew for @ flag.
*/
public function __construct($rule, $time, $skew) {
// Trim the rule to avoid infinite loops in later processing.
$this->rule = trim($rule);
$this->time = $time;
$this->skew = $skew;
}
/**
* Expand interval from cronrule part.
*
* @param array $matches
* (e.g. 4-43/5+2).
* array of matches:
* [1] = lower
* [2] = upper
* [5] = step
* [7] = offset
*
* @return string
* Comma-separated list of values.
*/
public function expandInterval($matches) {
$result = array();
$lower = $matches[1];
$upper = isset($matches[2]) && $matches[2] != '' ? $matches[2] : $lower;
$step = isset($matches[5]) && $matches[5] != '' ? $matches[5] : 1;
$offset = isset($matches[7]) && $matches[7] != '' ? $matches[7] : 0;
if ($step <= 0) {
return '';
}
$step = $step > 0 ? $step : 1;
for ($i = $lower; $i <= $upper; $i += $step) {
$result[] = ($i + $offset) % (self::$ranges[$this->type][1] + 1);
}
return implode(',', $result);
}
/**
* Prepare part.
*
* @param string $part
* The part.
* @param string $type
* Type of part.
*
* @return string
* The prepared part.
*/
public function preparePart($part, $type) {
$max = implode('-', self::$ranges[$type]);
$part = str_replace("*", $max, $part);
$part = str_replace("@", $this->skew % (self::$ranges[$type][1] + 1), $part);
return $part;
}
/**
* Expand range from cronrule part.
*
* @param string $part
* Cronrule part, e.g.: 1,2,3,4-43/5.
* @param string $type
* Type of range (minutes, hours, etc.)
*
* @return array
* Valid values for this range.
*/
public function expandRange($part, $type) {
$this->type = $type;
$part = preg_replace_callback('!(\\d+)(?:-(\\d+))?((/(\\d+))?(\\+(\\d+))?)?!', array(
$this,
'expandInterval',
), $part);
if (!preg_match('/([^0-9\\,])/', $part)) {
$part = explode(',', $part);
rsort($part);
}
else {
$part = array();
}
return $part;
}
/**
* Pre process rule.
*
* @param array &$parts
* Parts of rules to pre process.
*/
public function preProcessRule(&$parts) {
// Allow JAN-DEC.
$months = array(
1 => 'jan',
'feb',
'mar',
'apr',
'may',
'jun',
'jul',
'aug',
'sep',
'oct',
'nov',
'dec',
);
$parts[3] = strtr(strtolower($parts[3]), array_flip($months));
// Allow SUN-SUN.
$days = array(
'sun',
'mon',
'tue',
'wed',
'thu',
'fri',
'sat',
);
$parts[4] = strtr(strtolower($parts[4]), array_flip($days));
$parts[4] = str_replace('7', '0', $parts[4]);
$i = 0;
foreach (self::$ranges as $type => $range) {
$part =& $parts[$i++];
$max = implode('-', $range);
$part = str_replace("*", $max, $part);
$part = str_replace("@", $this->skew % ($range[1] + 1), $part);
}
}
/**
* Post process rule.
*
* @param array &$intervals
* Intervals to post process.
*/
public function postProcessRule(&$intervals) {
}
/**
* Generate regex rules.
*
* @return array
* Date and time regular expression for mathing rule.
*/
public function getIntervals() {
if (isset(self::$cache['intervals'][$this->rule][$this->skew])) {
return self::$cache['intervals'][$this->rule][$this->skew];
}
$parts = preg_split('/\\s+/', $this->rule);
if ($this->allow_shorthand) {
// Allow short rules by appending wildcards?
$parts += array(
'*',
'*',
'*',
'*',
'*',
);
$parts = array_slice($parts, 0, 5);
}
if (count($parts) != 5) {
return self::$cache['intervals'][$this->rule][$this->skew] = FALSE;
}
$this
->preProcessRule($parts);
$intervals = array();
$intervals['parts'] = $parts;
$intervals['minutes'] = $this
->expandRange($parts[0], 'minutes');
if (empty($intervals['minutes'])) {
return self::$cache['intervals'][$this->rule][$this->skew] = FALSE;
}
$intervals['hours'] = $this
->expandRange($parts[1], 'hours');
if (empty($intervals['hours'])) {
return self::$cache['intervals'][$this->rule][$this->skew] = FALSE;
}
$intervals['days'] = $this
->expandRange($parts[2], 'days');
if (empty($intervals['days'])) {
return self::$cache['intervals'][$this->rule][$this->skew] = FALSE;
}
$intervals['months'] = $this
->expandRange($parts[3], 'months');
if (empty($intervals['months'])) {
return self::$cache['intervals'][$this->rule][$this->skew] = FALSE;
}
$intervals['weekdays'] = $this
->expandRange($parts[4], 'weekdays');
if (empty($intervals['weekdays'])) {
return self::$cache['intervals'][$this->rule][$this->skew] = FALSE;
}
$intervals['weekdays'] = array_flip($intervals['weekdays']);
$this
->postProcessRule($intervals);
return self::$cache['intervals'][$this->rule][$this->skew] = $intervals;
}
/**
* Convert intervals back into crontab rule format.
*
* @param array $intervals
* Intervals to convert.
*
* @return string
* Crontab rule.
*/
public function rebuildRule($intervals) {
if (!is_array($intervals['parts'])) {
return FALSE;
}
return implode(' ', $intervals['parts']);
}
/**
* Parse rule.
*
* Run through parser expanding expression, and recombine into crontab syntax.
*/
public function parseRule() {
if (isset($this->parsed)) {
return $this->parsed;
}
$this->parsed = $this
->rebuildRule($this
->getIntervals());
return $this->parsed;
}
/**
* Get last schedule time of rule in UNIX timestamp format.
*
* @return int
* UNIX timestamp of last schedule time.
*/
public function getLastSchedule() {
if (isset($this->last_run)) {
return $this->last_run;
}
// Current time round to last minute.
$time = floor($this->time / 60) * 60;
// Generate regular expressions from rule.
$intervals = $this
->getIntervals();
if ($intervals === FALSE) {
return FALSE;
}
// Get starting points.
$start_year = date('Y', $time);
// Go back max 28 years (leapyear * weekdays).
$end_year = $start_year - 28;
$start_month = date('n', $time);
$start_day = date('j', $time);
$start_hour = date('G', $time);
$start_minute = (int) date('i', $time);
// If both weekday and days are restricted, then use either or
// otherwise, use and ... when using or, we have to try out all the days
// in the month and not just to the ones restricted.
$check_weekday = count($intervals['weekdays']) != 7;
$check_both = $check_weekday && count($intervals['days']) != 31;
$days = $check_both ? range(31, 1) : $intervals['days'];
// Find last date and time this rule was run.
for ($year = $start_year; $year > $end_year; $year--) {
foreach ($intervals['months'] as $month) {
if ($month < 1 || $month > 12) {
continue;
}
if ($year >= $start_year && $month > $start_month) {
continue;
}
foreach ($days as $day) {
if ($day < 1 || $day > 31) {
continue;
}
if ($year >= $start_year && $month >= $start_month && $day > $start_day) {
continue;
}
if (!checkdate($month, $day, $year)) {
continue;
}
// Check days and weekdays using and/or logic.
if ($check_weekday) {
$date_array = getdate(mktime(0, 0, 0, $month, $day, $year));
if ($check_both) {
if (!in_array($day, $intervals['days']) && !isset($intervals['weekdays'][$date_array['wday']])) {
continue;
}
}
else {
if (!isset($intervals['weekdays'][$date_array['wday']])) {
continue;
}
}
}
if ($day != $start_day || $month != $start_month || $year != $start_year) {
$start_hour = 23;
$start_minute = 59;
}
foreach ($intervals['hours'] as $hour) {
if ($hour < 0 || $hour > 23) {
continue;
}
if ($hour > $start_hour) {
continue;
}
if ($hour < $start_hour) {
$start_minute = 59;
}
foreach ($intervals['minutes'] as $minute) {
if ($minute < 0 || $minute > 59) {
continue;
}
if ($minute > $start_minute) {
continue;
}
break 5;
}
}
}
}
}
if (!isset($hour) || !isset($minute) || !isset($month) || !isset($day) || !isset($year)) {
return FALSE;
}
// Create UNIX timestamp from derived date+time.
$this->last_run = mktime($hour, $minute, 0, $month, $day, $year);
return $this->last_run;
}
/**
* Get next schedule time of rule in UNIX timestamp format.
*
* @return int
* UNIX timestamp of next schedule time.
*/
public function getNextSchedule() {
$time = $this->time;
$last_schedule = $this
->getLastSchedule();
$next_schedule = NULL;
// If the rule can't be parsed we don't proceed as this could lead to an
// infinite loop.
if (!$this
->parseRule()) {
return $next_schedule;
}
// Do a binary search for the next schedule.
$interval = 86400 * 30;
$offset = $interval;
do {
$test = new CronRule($this->rule, $time + (int) $offset, $this->skew);
$schedule = $test
->getLastSchedule();
$interval /= 2;
if ($schedule > $last_schedule) {
$next_schedule = $schedule;
$offset -= $interval;
}
elseif ($next_schedule) {
$offset += $interval;
}
else {
// Increase interval by doubling up.
// (we've already halved it, so now we quadrouple it).
$offset = $interval *= 4;
}
} while ($interval > 30);
return $next_schedule;
}
/**
* Check if a rule is valid.
*/
public function isValid() {
return $this
->getLastSchedule() === FALSE ? FALSE : TRUE;
}
}