scheduled_task_manager.inc

Go to the documentation of this file.

<?php
Fakoli::using("email");
 
class ScheduledTaskManager
{
     static $workers = array();
     
     function __construct()
     {
          ComponentManager::fireEvent("RegisterScheduledTaskWorkers");
     }
 
     static function registerScheduledTaskWorkers()
     {
          ScheduledTaskManager::registerWorker("scheduled_task", "Validate Configuration", array(ScheduledTaskManager, testTask));
     }
     
     static function setDefaults()
     {
          Settings::setDefaultValue('scheduled_task', 'test_email', '', 'String', 'Comma-separated list of recipients for the test task');
     }
 
     static function registerWorker($component, $task_name, $handler, $hourly = false)
     {
          ScheduledTaskManager::$workers[$component.":".$task_name] = $handler;
          
          try
          {
               $task = ScheduledTask::getInstance($component, $task_name);
          }
          catch(DataNotFoundException $e)
          {
               $task = new ScheduledTask();
               $task->component = $component;
               $task->task_name = $task_name;
               $task->active = false;
               $task->run_every_hour = $hourly;
               $task->save();
          }
     }
 
     static function getTabs($key)
     {
          $tabs = array("Task Schedule" =>   "/admin/scheduled_task_form",
                           "Execution Logs"  =>   "/admin/scheduled_task_logs");
     
          $qs = ($key) ? "task_id=$key" : "";
          return new TabBar("tabs", $tabs, $qs);
     }
     
     function getTasks()
     {
          return Query::create(ScheduledTask, "ORDER BY component, task_name")->execute();
     }
     
     function executeTask($component, $task_name)
     {
          trace("-- Executing Task '{$component}: $task_name'", 3);
          
          $task = ScheduledTask::getInstance($component, $task_name);
          
          if (!$task)
          {
               // Report an error
          }
 
          $timestamp = now();
          
          $worker = ScheduledTaskManager::$workers[$component.':'.$task_name];
          ob_start();
          $result = call_user_func($worker);
          $output = ob_get_contents();
          ob_end_clean();
          
          $log = new ScheduledTaskLogEntry();
          $log->task_id = $task->task_id;
          $log->log_date = $timestamp;
          $log->log = $output;
          $log->status = $result;
          $log->save();
     }
     
     function runTasks()
     {
          global $config;
          
          Fakoli::scheduledTaskTraceLevel();
          
          $currentPeriod = TaskScheduleHelper::calculatePeriod();
          trace("** Running tasks for period $currentPeriod", 3);
          
          $tasks = $this->getTasks();
          $count = 0;
          
          foreach($tasks as $task)
          {
               if (!$task->active) continue;
               if ($task->run_every_hour || strpos($task->schedule, $currentPeriod) !== false)
               {
                    $this->executeTask($task->component, $task->task_name);
                    ++$count;
               }
          }
          
          trace("$count ".pluralize("task", $count)." executed", 3);
 
          Fakoli::coreTraceLevel();
     }
     
     static function testTask()
     {
          global $config;
          
          trace("Running Validation Configuration task", 3);
          
          $email = Settings::getValue('scheduled_task', 'test_email');
          if (!$email) 
          {
               $email = Settings::getValue("settings", "system_notification_email");
          }
          
          $site_email_from =  Settings::getValue('email', 'email_from');
          $site_email_name =  Settings::getValue('email', 'email_name');
          
          if (!$email) return;
          
          trace("Sending confirmation email to {$email}", 3);
          
          $mail = new EmailHandler($email, "Scheduled Task Notification from {$config['site_name']}", 
                                        "This message confirms that the Validate Configuration schedule task worker was triggered at ".now(), 
                                        $site_email_from, 
                                        $site_email_name);
          $mail->send();
               
          echo "Confirmation email sent";
          
          return "Success";
     }
          
     static function upgradeComponent($version)
     {
          $mgr = new ScheduledTaskUpgradeManager();
          $mgr->upgrade($version);
     }
}
?>