ScheduledTask.inc.php

<?php
 
import('lib.pkp.classes.scheduledTask.ScheduledTaskHelper');
 
abstract class ScheduledTask {
 
   private $_args;
 
   private $_processId = null;
 
   private $_executionLogFile;
 
   private $_helper;
 
 
   function __construct($args = array()) {
      $this->_args = $args;
      $this->_processId = uniqid();
 
      // Ensure common locale keys are available
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_ADMIN, LOCALE_COMPONENT_APP_ADMIN, LOCALE_COMPONENT_PKP_COMMON);
      
      // Check the scheduled task execution log folder.
      import('lib.pkp.classes.file.PrivateFileManager');
      $fileMgr = new PrivateFileManager();
 
      $scheduledTaskFilesPath = realpath($fileMgr->getBasePath()) . DIRECTORY_SEPARATOR . SCHEDULED_TASK_EXECUTION_LOG_DIR;
      $this->_executionLogFile = $scheduledTaskFilesPath . DIRECTORY_SEPARATOR . str_replace(' ', '', $this->getName()) . 
         '-' . $this->getProcessId() . '-' . date('Ymd') . '.log';
      if (!$fileMgr->fileExists($scheduledTaskFilesPath, 'dir')) {
         $success = $fileMgr->mkdirtree($scheduledTaskFilesPath);
         if (!$success) {
            // files directory wrong configuration?
            assert(false);
            $this->_executionLogFile = null;
         }
      }
   }
 
 
   //
   // Protected methods.
   //
   function getProcessId() {
      return $this->_processId;
   }
 
   function getHelper() {
      if (!$this->_helper) $this->_helper = new ScheduledTaskHelper();
      return $this->_helper;
   }
 
   function getName() {
      return __('admin.scheduledTask');
   }
 
   function addExecutionLogEntry($message, $type = null) {
      $logFile = $this->_executionLogFile;
 
      if (!$message) return;
      $date = '[' . Core::getCurrentDate() . '] ';
 
      if ($type) {
         $log = $date . '[' . __($type) . '] ' . $message;
      } else {
         $log = $date . $message;
      }
 
      $fp = fopen($logFile, 'ab');
      if (flock($fp, LOCK_EX)) {
         fwrite($fp, $log . PHP_EOL);
         flock($fp, LOCK_UN);
      } else {
         fatalError("Couldn't lock the file.");
      }
      fclose($fp);   
   }
 
 
   //
   // Protected abstract methods.
   //
   abstract protected function executeActions();
 
 
   //
   // Public methods.
   //
   function execute() {
      $this->addExecutionLogEntry(Config::getVar('general', 'base_url'));
      $this->addExecutionLogEntry(__('admin.scheduledTask.startTime'), SCHEDULED_TASK_MESSAGE_TYPE_NOTICE);
 
      $result = $this->executeActions();
 
      $this->addExecutionLogEntry(__('admin.scheduledTask.stopTime'), SCHEDULED_TASK_MESSAGE_TYPE_NOTICE);
 
      $helper = $this->getHelper();
      $helper->notifyExecutionResult($this->_processId, $this->getName(), $result, $this->_executionLogFile);
 
      return $result;
   }
}