147 lines
3.8 KiB
PHP
147 lines
3.8 KiB
PHP
<?php
|
|
/**
|
|
* Piwik - free/libre analytics platform
|
|
*
|
|
* @link http://piwik.org
|
|
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
|
*
|
|
*/
|
|
|
|
namespace Piwik\Scheduler;
|
|
|
|
use Piwik\Common;
|
|
use Piwik\Option;
|
|
use Piwik\Date;
|
|
|
|
/**
|
|
* This data structure holds the scheduled times for each active scheduled task.
|
|
*/
|
|
class Timetable
|
|
{
|
|
const TIMETABLE_OPTION_STRING = "TaskScheduler.timetable";
|
|
|
|
private $timetable;
|
|
|
|
public function __construct()
|
|
{
|
|
$optionData = Option::get(self::TIMETABLE_OPTION_STRING);
|
|
$unserializedTimetable = Common::safe_unserialize($optionData);
|
|
|
|
$this->timetable = $unserializedTimetable === false ? array() : $unserializedTimetable;
|
|
}
|
|
|
|
public function getTimetable()
|
|
{
|
|
return $this->timetable;
|
|
}
|
|
|
|
public function setTimetable($timetable)
|
|
{
|
|
$this->timetable = $timetable;
|
|
}
|
|
|
|
/**
|
|
* @param Task[] $activeTasks
|
|
*/
|
|
public function removeInactiveTasks($activeTasks)
|
|
{
|
|
$activeTaskNames = array();
|
|
foreach ($activeTasks as $task) {
|
|
$activeTaskNames[] = $task->getName();
|
|
}
|
|
foreach (array_keys($this->timetable) as $taskName) {
|
|
if (!in_array($taskName, $activeTaskNames)) {
|
|
unset($this->timetable[$taskName]);
|
|
}
|
|
}
|
|
$this->save();
|
|
}
|
|
|
|
public function getScheduledTaskNames()
|
|
{
|
|
return array_keys($this->timetable);
|
|
}
|
|
|
|
public function getScheduledTaskTime($taskName)
|
|
{
|
|
return isset($this->timetable[$taskName]) ? Date::factory($this->timetable[$taskName]) : false;
|
|
}
|
|
|
|
/**
|
|
* Checks if the task should be executed
|
|
*
|
|
* Task has to be executed if :
|
|
* - the task has already been scheduled once and the current system time is greater than the scheduled time.
|
|
* - execution is forced, see $forceTaskExecution
|
|
*
|
|
* @param string $taskName
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function shouldExecuteTask($taskName)
|
|
{
|
|
$forceTaskExecution = (defined('DEBUG_FORCE_SCHEDULED_TASKS') && DEBUG_FORCE_SCHEDULED_TASKS);
|
|
|
|
if ($forceTaskExecution) {
|
|
return true;
|
|
}
|
|
|
|
return $this->taskHasBeenScheduledOnce($taskName) && time() >= $this->timetable[$taskName];
|
|
}
|
|
|
|
/**
|
|
* Checks if a task should be rescheduled
|
|
*
|
|
* Task has to be rescheduled if :
|
|
* - the task has to be executed
|
|
* - the task has never been scheduled before
|
|
*
|
|
* @param string $taskName
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function taskShouldBeRescheduled($taskName)
|
|
{
|
|
return !$this->taskHasBeenScheduledOnce($taskName) || $this->shouldExecuteTask($taskName);
|
|
}
|
|
|
|
public function rescheduleTask(Task $task)
|
|
{
|
|
$rescheduledTime = $task->getRescheduledTime();
|
|
|
|
// update the scheduled time
|
|
$this->timetable[$task->getName()] = $rescheduledTime;
|
|
$this->save();
|
|
|
|
return Date::factory($rescheduledTime);
|
|
}
|
|
|
|
public function rescheduleTaskAndRunTomorrow(Task $task)
|
|
{
|
|
$tomorrow = Date::factory('tomorrow');
|
|
|
|
// update the scheduled time
|
|
$this->timetable[$task->getName()] = $tomorrow->getTimestamp();
|
|
$this->save();
|
|
|
|
return $tomorrow;
|
|
}
|
|
|
|
public function save()
|
|
{
|
|
Option::set(self::TIMETABLE_OPTION_STRING, serialize($this->timetable));
|
|
}
|
|
|
|
public function getScheduledTimeForMethod($className, $methodName, $methodParameter = null)
|
|
{
|
|
$taskName = Task::getTaskName($className, $methodName, $methodParameter);
|
|
|
|
return $this->taskHasBeenScheduledOnce($taskName) ? $this->timetable[$taskName] : false;
|
|
}
|
|
|
|
public function taskHasBeenScheduledOnce($taskName)
|
|
{
|
|
return isset($this->timetable[$taskName]);
|
|
}
|
|
}
|