There is a new version of e107 available.
Please visit ".$data['infourl']." for further details.
".print_r(error_get_last(), true).""; $message .= "
".print_r(headers_list(),true).""; // $message .= "
| ".$k." | ".print_a($v,true)." |
";
// $cron->getLastRan() returns last due time in an array
print_r($cron->getLastRan());
echo "Debug:
" . nl2br($cron->getDebug());
$cron_str1 = "3 12 * * *";
if ($cron->calcLastRan($cron_str1))
{
echo "
Cron '$cron_str1' last due at: " . date('r', $cron->getLastRanUnix()) . "
";
print_r($cron->getLastRan());
}
else
{
echo "Error parsing";
}
echo "Debug:
" . nl2br($cron->getDebug());
*#######################################################################################################
*/
class CronParser
{
var $bits = Array(); //exploded String like 0 1 * * *
var $now = Array(); //Array of cron-style entries for time()
var $lastRan; //Timestamp of last ran time.
private $lastDue;
var $taken;
var $debug;
var $year;
var $month;
var $day;
var $hour;
var $minute;
var $minutes_arr = array(); //minutes array based on cron string
var $hours_arr = array(); //hours array based on cron string
var $months_arr = array(); //months array based on cron string
/**
* @return string[]
*/
function getLastRan()
{
return explode(",", eShims::strftime("%M,%H,%d,%m,%w,%Y", $this->lastRan)); //Get the values for now in a format we can use
}
public function getLastDue()
{
return $this->lastDue;
}
public function getNow()
{
return $this->now;
}
/**
* @return mixed
*/
function getLastRanUnix()
{
return $this->lastRan;
}
/**
* @return mixed
*/
function getDebug()
{
return $this->debug;
}
function setDebug($bool)
{
$this->debug = (bool) $bool;
}
/**
* @param $str
* @return void
*/
function debug($str)
{
if(!$this->debug)
{
return;
}
$text = (is_array($str) ? print_r($str,true) : $str);
error_log('e107: Cron '.$text);
echo $text."\n";
}
/**
* Assumes that value is not *, and creates an array of valid numbers that
* the string represents. Returns an array.
*/
function expand_ranges($str)
{
$ret = [];
if (strpos($str, ",") !== false)
{
$arParts = explode(',', $str);
foreach ($arParts AS $part)
{
if (strpos($part, '-') !== false)
{
$arRange = explode('-', $part);
for ($i = $arRange[0]; $i <= $arRange[1]; $i++)
{
$ret[] = $i;
}
}
else
{
$ret[] = $part;
}
}
}
elseif (strpos($str, '-') !== false)
{
$arRange = explode('-', $str);
for ($i = $arRange[0]; $i <= $arRange[1]; $i++)
{
$ret[] = $i;
}
}
else
{
$ret[] = $str;
}
$ret = array_unique($ret);
sort($ret);
return $ret;
}
/**
* @param $month
* @param $year
* @return string
*/
function daysinmonth($month, $year)
{
return date('t', mktime(0, 0, 0, $month, 1, $year));
}
/**
* Calculate the last due time before this moment
*/
function calcLastRan($string)
{
$this->debug(__METHOD__.' ('.__LINE__.'): '.date_default_timezone_get());
$tstart = microtime(true);
$this->lastRan = 0;
$this->year = NULL;
$this->month = NULL;
$this->day = NULL;
$this->hour = NULL;
$this->minute = NULL;
$this->hours_arr = array();
$this->minutes_arr = array();
$this->months_arr = array();
$string = preg_replace('/\s{2,}/', ' ', $string);
if (preg_match('/[^-,* \\d]/', $string) !== 0)
{
$this->debug("e107: Cron string contains invalid character: ".$string);
return false;
}
$this->debug("\n----- Working on cron schedule: $string ----");
$this->bits = @explode(" ", $string);
if (count($this->bits) != 5)
{
$this->debug("e107: Cron string is invalid. Too many or too little sections after explode.".print_r($this->bits,true));
return false;
}
//put the current time into an array
$t = eShims::strftime("%M,%H,%d,%m,%w,%Y", time());
$this->now = explode(",", $t);
$this->year = $this->now[5];
$arMonths = $this->_getMonthsArray();
do
{
$this->month = array_pop($arMonths);
}
while ($this->month > $this->now[3]);
if ($this->month === NULL)
{
$this->year = $this->year - 1;
$this->debug("Not due within this year. So checking the previous year " . $this->year);
$arMonths = $this->_getMonthsArray();
$this->_prevMonth($arMonths);
}
elseif ($this->month == $this->now[3]) //now Sep, month = array(7,9,12)
{
$this->debug("Cron is due this month, getting days array.");
$arDays = $this->_getDaysArray($this->month, $this->year);
do
{
$this->day = array_pop($arDays);
}
while ($this->day > $this->now[2]);
if ($this->day === NULL)
{
$this->debug("Smallest day is even greater than today");
$this->_prevMonth($arMonths);
}
elseif ($this->day == $this->now[2])
{
$this->debug("Due to run today");
$arHours = $this->_getHoursArray();
do
{
$this->hour = array_pop($arHours);
}
while ($this->hour > $this->now[1]);
if ($this->hour === NULL) // now =2, arHours = array(3,5,7)
{
$this->debug("Not due this hour and some earlier hours, so go for previous day");
$this->_prevDay($arDays, $arMonths);
}
elseif ($this->hour < $this->now[1]) //now =2, arHours = array(1,3,5)
{
$this->minute = $this->_getLastMinute();
}
else // now =2, arHours = array(1,2,5)
{
$this->debug("Due this hour");
$arMinutes = $this->_getMinutesArray();
do
{
$this->minute = array_pop($arMinutes);
}
while ($this->minute > $this->now[0]);
if ($this->minute === NULL)
{
$this->debug("Not due this minute, so go for previous hour.");
$this->_prevHour($arHours, $arDays, $arMonths);
}
else
{
$this->debug("Due this very minute or some earlier minutes before this moment within this hour.");
}
}
}
else
{
$this->debug("Cron was due on " . $this->day . " of this month");
$this->hour = $this->_getLastHour();
$this->minute = $this->_getLastMinute();
}
}
else //now Sep, arrMonths=array(7, 10)
{
$this->debug("Cron was due before this month. Previous month is: " . $this->year . '-' . $this->month);
$this->day = $this->_getLastDay($this->month, $this->year);
if ($this->day === NULL)
{
//No scheduled date within this month. So we will try the previous month in the month array
$this->_prevMonth($arMonths);
}
else
{
$this->hour = $this->_getLastHour();
$this->minute = $this->_getLastMinute();
}
}
$tend = microtime(true);
$this->taken = $tend - $tstart;
$this->debug("Parsing $string taken " . $this->taken . " seconds");
//if the last due is beyond 1970
if ($this->minute === NULL)
{
$this->debug("Error calculating last due time");
return false;
}
else
{
$lastDue = $this->year.'-'.(strlen($this->month) === 1 ? '0'.$this->month : $this->month).'-'.(strlen($this->day) === 1 ? '0'.$this->day : $this->day).'T'.(strlen($this->hour) === 1 ? '0'.$this->hour : $this->hour) . ":" . (strlen($this->minute) === 1 ? '0'.$this->minute : $this->minute);
$this->debug(__METHOD__.' ('.__LINE__.'): '.date_default_timezone_get());
$this->debug(__METHOD__.' ('.__LINE__.'): Setting lastDue to ' . $lastDue);
$this->lastDue = $lastDue;
$this->lastRan = mktime($this->hour, $this->minute, 0, $this->month, $this->day, $this->year);
$this->debug(__METHOD__.' ('.__LINE__.'): Setting lastRan to '.date('c', $this->lastRan));
return true;
}
}
//get the due time before current month
/**
* @param $arMonths
* @return void
*/
function _prevMonth($arMonths)
{
$this->month = array_pop($arMonths);
if ($this->month === NULL)
{
$this->year = $this->year -1;
if ($this->year <= 1970)
{
$this->debug("Can not calculate last due time. At least not before 1970..");
}
else
{
$this->debug("Have to go for previous year " . $this->year);
$arMonths = $this->_getMonthsArray();
$this->_prevMonth($arMonths);
}
}
else
{
$this->debug("Getting the last day for previous month: " . $this->year . '-' . $this->month);
$this->day = $this->_getLastDay($this->month, $this->year);
if ($this->day === NULL)
{
//no available date schedule in this month
$this->_prevMonth($arMonths);
}
else
{
$this->hour = $this->_getLastHour();
$this->minute = $this->_getLastMinute();
}
}
}
//get the due time before current day
/**
* @param $arDays
* @param $arMonths
* @return void
*/
function _prevDay($arDays, $arMonths)
{
$this->debug("Go for the previous day");
$this->day = array_pop($arDays);
if ($this->day === NULL)
{
$this->debug("Have to go for previous month");
$this->_prevMonth($arMonths);
}
else
{
$this->hour = $this->_getLastHour();
$this->minute = $this->_getLastMinute();
}
}
//get the due time before current hour
/**
* @param $arHours
* @param $arDays
* @param $arMonths
* @return void
*/
function _prevHour($arHours, $arDays, $arMonths)
{
$this->debug("Going for previous hour");
$this->hour = array_pop($arHours);
if ($this->hour === NULL)
{
$this->debug("Have to go for previous day");
$this->_prevDay($arDays, $arMonths);
}
else
{
$this->minute = $this->_getLastMinute();
}
}
//not used at the moment
/**
* @return mixed|null
*/
function _getLastMonth()
{
$months = $this->_getMonthsArray();
return array_pop($months);
}
/**
* @param $month
* @param $year
* @return mixed|null
*/
function _getLastDay($month, $year)
{
//put the available days for that month into an array
$days = $this->_getDaysArray($month, $year);
return array_pop($days);
}
/**
* @return mixed|null
*/
function _getLastHour()
{
$hours = $this->_getHoursArray();
return array_pop($hours);
}
/**
* @return mixed|null
*/
function _getLastMinute()
{
$minutes = $this->_getMinutesArray();
return array_pop($minutes);
}
//remove the out of range array elements. $arr should be sorted already and does not contain duplicates
/**
* @param $arr
* @param $low
* @param $high
* @return mixed
*/
function _sanitize ($arr, $low, $high)
{
$count = count($arr);
for ($i = 0; $i <= ($count - 1); $i++)
{
if ($arr[$i] < $low)
{
$this->debug("Remove out of range element. $arr[$i] is outside $low - $high");
unset($arr[$i]);
}
else
{
break;
}
}
for ($i = ($count - 1); $i >= 0; $i--)
{
if ($arr[$i] > $high)
{
$this->debug("Remove out of range element. $arr[$i] is outside $low - $high");
unset ($arr[$i]);
}
else
{
break;
}
}
//re-assign keys
sort($arr);
return $arr;
}
//given a month/year, list all the days within that month fell into the week days list.
/**
* @param $month
* @param $year
* @return array
*/
function _getDaysArray($month, $year = 0)
{
if ($year == 0)
{
$year = $this->year;
}
$days = array();
//return everyday of the month if both bit[2] and bit[4] are '*'
if ($this->bits[2] == '*' AND $this->bits[4] == '*')
{
$days = $this->getDays($month, $year);
}
else
{
//create an array for the weekdays
if ($this->bits[4] == '*')
{
for ($i = 0; $i <= 6; $i++)
{
$arWeekdays[] = $i;
}
}
else
{
$arWeekdays = $this->expand_ranges($this->bits[4]);
$arWeekdays = $this->_sanitize($arWeekdays, 0, 7);
//map 7 to 0, both represents Sunday. Array is sorted already!
if (in_array(7, $arWeekdays))
{
if (in_array(0, $arWeekdays))
{
array_pop($arWeekdays);
}
else
{
$tmp[] = 0;
array_pop($arWeekdays);
$arWeekdays = array_merge($tmp, $arWeekdays);
}
}
}
$this->debug("Array for the weekdays");
$this->debug($arWeekdays);
if ($this->bits[2] == '*')
{
$daysmonth = $this->getDays($month, $year);
}
else
{
$daysmonth = $this->expand_ranges($this->bits[2]);
// so that we do not end up with 31 of Feb
$daysinmonth = $this->daysinmonth($month, $year);
$daysmonth = $this->_sanitize($daysmonth, 1, $daysinmonth);
}
//Now match these days with weekdays
foreach ($daysmonth AS $day)
{
$wkday = date('w', mktime(0, 0, 0, $month, $day, $year));
if (in_array($wkday, $arWeekdays))
{
$days[] = $day;
}
}
}
$this->debug("Days array matching weekdays for $year-$month");
//$this->debug($days);
return $days;
}
//given a month/year, return an array containing all the days in that month
/**
* @param $month
* @param $year
* @return array
*/
function getDays($month, $year)
{
$daysinmonth = $this->daysinmonth($month, $year);
$this->debug("Number of days in $year-$month : $daysinmonth");
$days = array();
for ($i = 1; $i <= $daysinmonth; $i++)
{
$days[] = $i;
}
return $days;
}
/**
* @return array|mixed
*/
function _getHoursArray()
{
if (empty($this->hours_arr))
{
$hours = array();
if ($this->bits[1] == '*')
{
for ($i = 0; $i <= 23; $i++)
{
$hours[] = $i;
}
}
else
{
$hours = $this->expand_ranges($this->bits[1]);
$hours = $this->_sanitize($hours, 0, 23);
}
// $this->debug("Hour array");
// $this->debug($hours);
$this->hours_arr = $hours;
}
return $this->hours_arr;
}
/**
* @return array|mixed
*/
function _getMinutesArray()
{
if (empty($this->minutes_arr))
{
$minutes = array();
if ($this->bits[0] == '*')
{
for ($i = 0; $i <= 60; $i++)
{
$minutes[] = $i;
}
}
else
{
$minutes = $this->expand_ranges($this->bits[0]);
$minutes = $this->_sanitize($minutes, 0, 59);
}
// $this->debug("Minutes array");
// $this->debug($minutes);
$this->minutes_arr = $minutes;
}
return $this->minutes_arr;
}
/**
* @return array|mixed
*/
function _getMonthsArray()
{
if (empty($this->months_arr))
{
$months = array();
if ($this->bits[3] == '*')
{
for ($i = 1; $i <= 12; $i++)
{
$months[] = $i;
}
}
else
{
$months = $this->expand_ranges($this->bits[3]);
$months = $this->_sanitize($months, 1, 12);
}
// $this->debug("Months array");
// $this->debug($months);
$this->months_arr = $months;
}
return $this->months_arr;
}
}
/**
* Class cronScheduler.
*
* @see cron.php
*
* TODO:
* - Log error in admin log.
* - Pref for sending email to Administrator.
* - LANs
*/
class cronScheduler
{
/**
* Cron parser class.
*
* @var \CronParser.
*/
private $cron;
/**
* Debug mode.
*
* @var bool
*/
private $debug;
/**
* System preferences.
*
* @var array|mixed
*/
private $pref;
/**
* Constructor.
*/
public function __construct()
{
global $_E107;
$this->cron = new CronParser();
$this->debug = $_E107['debug'];
$this->cron->setDebug($_E107['debug']);
$this->pref = e107::getPref();
}
/**
* Runs all cron jobs.
*
* @return bool
*/
public function run()
{
$valid = $this->validateToken();
if(!$valid)
{
if($this->debug)
{
$this->cron->debug('e107: Invalid token used for cron class');
}
return false;
}
if(!@file_put_contents(e_CACHE . 'cronLastLoad.php', time()))
{
$this->cron->debug('e107: Unable to write to: '.e_CACHE . 'cronLastLoad.php. Permissions issue?');
}
// Get active cron jobs.
$cron_jobs = $this->getCronJobs(true);
if($this->debug)
{
$this->cron->debug('e107: Cron Jobs Found: '.print_r($cron_jobs,true));
}
foreach($cron_jobs as $job)
{
$this->runJob($job);
}
return null;
}
/**
* Runs a cron job.
*
* @param array $job
* Contains the current cron job. Each element is an array with following
* properties:
* - 'path' string '_system' or plugin name.
* - 'active' int 1 if active, 0 if inactive
* - 'tab' string cron tab
* - 'function' string function name
* - 'class' string class name
*
* @return bool $status
*/
public function runJob($job)
{
$status = false;
$this->cron->debug(__METHOD__.' ('.__LINE__.'): '.date_default_timezone_get());
$this->cron->debug(__METHOD__.' ('.__LINE__.'): Current time: '.date('c'));
if(empty($job['active']))
{
if($this->debug)
{
error_log('e107: Cron job not active: '.print_r($job,true), E_NOTICE);
}
return false;
}
// Calculate the last due time before this moment.
$this->cron->calcLastRan($job['tab']);
$due = $this->cron->getLastRanUnix();
$this->cron->debug(__METHOD__.' ('.__LINE__.'): '.date_default_timezone_get());
$triggerTime = (time() - 45);
$this->cron->debug(__METHOD__.' ('.__LINE__.'): Current Time (-45): '.date('c',$triggerTime));
if($due <= $triggerTime)
{
if($this->debug)
{
$job['_lastRun'] = date('c',$due);
$job['_triggerTime'] = date('c',$triggerTime);
$this->cron->debug(__METHOD__.' ('.__LINE__.'): NOT running cron method because: _lastRun < _triggerTime ');
$this->cron->debug($job);
}
return false;
}
if($job['path'] != '_system' && !is_readable(e_PLUGIN . $job['path'] . "/e_cron.php"))
{
$this->cron->debug('e107: Cron file not readable: '.e_PLUGIN . $job['path'] . "/e_cron.php", E_ERROR);
return false;
}
if($this->debug)
{
$this->cron->debug('e107: Cron is running: '.print_r($job,true), E_NOTICE);
}
// This is correct.
if($job['path'] != '_system')
{
include_once(e_PLUGIN . $job['path'] . "/e_cron.php");
}
$class = $job['class'] . "_cron";
if(!class_exists($class, false))
{
if($this->debug)
{
$this->cron->debug('e107: Cron could not find class: '.$class, E_ERROR);
}
return $status;
}
$obj = new $class;
if(!method_exists($obj, $job['function']))
{
if($this->debug)
{
$this->cron->debug('Cron could not find method: '.$job['function'], E_ERROR);
}
return $status;
}
// Exception handling.
$method = $job['function'];
try
{
$status = $obj->$method();
}
catch(Exception $e)
{
$msg = $e->getFile() . ' ' . $e->getLine();
$msg .= "\n\n" . $e->getCode() . ' ' . $e->getMessage();
$msg .= "\n\n" . implode("\n", $e->getTrace());
$mail = array(
'to_mail' => $this->pref['siteadminemail'],
'to_name' => $this->pref['siteadmin'],
'from_mail' => $this->pref['siteadminemail'],
'from_name' => $this->pref['siteadmin'],
'message' => $msg,
'subject' => 'e107 - Cron Schedule Exception',
);
error_log('e107: Cron Exception occurred: '.$msg, E_ERROR);
$this->sendMail($mail);
}
// If task returns value which is not boolean (BC), it will be used as a
// message (send email, logs).
if($status && true !== $status)
{
$msg = 'Method returned message: [{' . $class . '}::' . $job['function'] . '] ' . $status;
error_log('e107: Cron Method returned message: '.$msg, E_NOTICE);
$mail = array(
'to_mail' => $this->pref['siteadminemail'],
'to_name' => $this->pref['siteadmin'],
'from_mail' => $this->pref['siteadminemail'],
'from_name' => $this->pref['siteadmin'],
'message' => $msg,
'subject' => 'e107 - Cron Schedule Task Report',
);
$this->sendMail($mail);
}
$update = [
'cron_lastrun' => time(),
'WHERE' => 'cron_id = '.$job['id']
];
e107::getDb()->update('cron',$update);
return $status;
}
/**
* Validate Cron Token.
*
* @return bool
*/
public function validateToken()
{
$pwd = '';
if($this->debug && !empty($_SERVER['QUERY_STRING']))
{
$pwd = $_SERVER['QUERY_STRING'];
}
elseif(!empty($_SERVER['argv'][1]))
{
$pwd = trim($_SERVER['argv'][1]);
}
if(!empty($_GET['token']))
{
$pwd = e107::getParser()->filter($_GET['token']);
}
else
{
$pwd = str_replace('token=', '', $pwd);
}
if($this->debug)
{
error_log("Cron Token: ".$pwd, E_NOTICE);
}
if(empty($this->pref['e_cron_pwd']) || (varset($this->pref['e_cron_pwd']) != $pwd))
{
if(!empty($pwd))
{
$msg = "Your Cron Schedule is not configured correctly. Your passwords do not match.";
$msg .= "
";
$msg .= "Sent from cron: " . $pwd;
$msg .= "
";
$msg .= "Stored in e107: " . varset($this->pref['e_cron_pwd'], "(none set)");
$msg .= "
";
$msg .= "You should regenerate the cron command in admin and enter it again in your server configuration.";
$msg .= "