CRM/Core/JobManager.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This interface defines methods that need to be implemented
  30  * by every scheduled job (cron task) in CiviCRM.
  31  *
  32  * @package CRM
  33  * @copyright CiviCRM LLC (c) 2004-2015
  34  * $Id$
  35  *
  36  */
  37 class CRM_Core_JobManager {
  38
  39   /**
  40    * @var array ($id => CRM_Core_ScheduledJob)
  41    */
  42   var $jobs = NULL;
  43
  44   /**
  45    * @var CRM_Core_ScheduledJob
  46    */
  47   var $currentJob = NULL;
  48
  49   var $singleRunParams = array();
  50
  51   var $_source = NULL;
  52
  53
  54   /**
  55    * Class constructor.
  56    *
  57    * @return void
  58    */
  59   public function __construct() {
  60     $config = CRM_Core_Config::singleton();
  61     $config->fatalErrorHandler = 'CRM_Core_JobManager_scheduledJobFatalErrorHandler';
  62
  63     $this->jobs = $this->_getJobs();
  64   }
  65
  66   /**
  67    * @param bool $auth
  68    */
  69   public function execute($auth = TRUE) {
  70
  71     $this->logEntry('Starting scheduled jobs execution');
  72
  73     if ($auth && !CRM_Utils_System::authenticateKey(TRUE)) {
  74       $this->logEntry('Could not authenticate the site key.');
  75     }
  76     require_once 'api/api.php';
  77
  78     // it's not asynchronous at this stage
  79     CRM_Utils_Hook::cron($this);
  80     foreach ($this->jobs as $job) {
  81       if ($job->is_active) {
  82         if ($job->needsRunning()) {
  83           $this->executeJob($job);
  84         }
  85       }
  86     }
  87     $this->logEntry('Finishing scheduled jobs execution.');
  88
  89     // Set last cron date for the status check
  90     $statusPref = array(
  91       'name' => 'checkLastCron',
  92       'check_info' => gmdate('U'),
  93     );
  94     CRM_Core_BAO_StatusPreference::create($statusPref);
  95   }
  96
  97   /**
  98    * Class destructor.
  99    */
 100   public function __destruct() {
 101   }
 102
 103   /**
 104    * @param $entity
 105    * @param $action
 106    */
 107   public function executeJobByAction($entity, $action) {
 108     $job = $this->_getJob(NULL, $entity, $action);
 109     $this->executeJob($job);
 110   }
 111
 112   /**
 113    * @param int $id
 114    */
 115   public function executeJobById($id) {
 116     $job = $this->_getJob($id);
 117     $this->executeJob($job);
 118   }
 119
 120   /**
 121    * @param CRM_Core_ScheduledJob $job
 122    */
 123   public function executeJob($job) {
 124     $this->currentJob = $job;
 125     $this->logEntry('Starting execution of ' . $job->name);
 126     $job->saveLastRun();
 127
 128     $singleRunParamsKey = strtolower($job->api_entity . '_' . $job->api_action);
 129
 130     if (array_key_exists($singleRunParamsKey, $this->singleRunParams)) {
 131       $params = $this->singleRunParams[$singleRunParamsKey];
 132     }
 133     else {
 134       $params = $job->apiParams;
 135     }
 136
 137     try {
 138       $result = civicrm_api($job->api_entity, $job->api_action, $params);
 139     }
 140     catch (Exception$e) {
 141       $this->logEntry('Error while executing ' . $job->name . ': ' . $e->getMessage());
 142     }
 143     $this->logEntry('Finished execution of ' . $job->name . ' with result: ' . $this->_apiResultToMessage($result));
 144     $this->currentJob = FALSE;
 145   }
 146
 147   /**
 148    * Retrieves the list of jobs from the database,
 149    * populates class param.
 150    *
 151    * @return array
 152    *   ($id => CRM_Core_ScheduledJob)
 153    */
 154   private function _getJobs() {
 155     $jobs = array();
 156     $dao = new CRM_Core_DAO_Job();
 157     $dao->orderBy('name');
 158     $dao->domain_id = CRM_Core_Config::domainID();
 159     $dao->find();
 160     while ($dao->fetch()) {
 161       $temp = array();
 162       CRM_Core_DAO::storeValues($dao, $temp);
 163       $jobs[$dao->id] = new CRM_Core_ScheduledJob($temp);
 164     }
 165     return $jobs;
 166   }
 167
 168   /**
 169    * Retrieves specific job from the database by id.
 170    * and creates ScheduledJob object.
 171    *
 172    * @param int $id
 173    * @param null $entity
 174    * @param null $action
 175    *
 176    * @return CRM_Core_ScheduledJob
 177    * @throws Exception
 178    */
 179   private function _getJob($id = NULL, $entity = NULL, $action = NULL) {
 180     if (is_null($id) && is_null($action)) {
 181       CRM_Core_Error::fatal('You need to provide either id or name to use this method');
 182     }
 183     $dao = new CRM_Core_DAO_Job();
 184     $dao->id = $id;
 185     $dao->api_entity = $entity;
 186     $dao->api_action = $action;
 187     $dao->find();
 188     while ($dao->fetch()) {
 189       CRM_Core_DAO::storeValues($dao, $temp);
 190       $job = new CRM_Core_ScheduledJob($temp);
 191     }
 192     return $job;
 193   }
 194
 195   /**
 196    * @param $entity
 197    * @param $job
 198    * @param array $params
 199    * @param null $source
 200    */
 201   public function setSingleRunParams($entity, $job, $params, $source = NULL) {
 202     $this->_source = $source;
 203     $key = strtolower($entity . '_' . $job);
 204     $this->singleRunParams[$key] = $params;
 205     $this->singleRunParams[$key]['version'] = 3;
 206   }
 207
 208   /**
 209    * @param string $message
 210    *
 211    * @return void
 212    *   collection of permissions, null if none
 213    */
 214   public function logEntry($message) {
 215     $domainID = CRM_Core_Config::domainID();
 216     $dao = new CRM_Core_DAO_JobLog();
 217
 218     $dao->domain_id = $domainID;
 219     $dao->description = substr($message, 0, 235);
 220     if (strlen($message) > 235) {
 221       $dao->description .= " (...)";
 222     }
 223     if ($this->currentJob) {
 224       $dao->job_id = $this->currentJob->id;
 225       $dao->name = $this->currentJob->name;
 226       $dao->command = ts("Entity:") . " " . $this->currentJob->api_entity . " " . ts("Action:") . " " . $this->currentJob->api_action;
 227       $data = "";
 228       if (!empty($this->currentJob->parameters)) {
 229         $data .= "\n\nParameters raw (from db settings): \n" . $this->currentJob->parameters;
 230       }
 231       $singleRunParamsKey = strtolower($this->currentJob->api_entity . '_' . $this->currentJob->api_action);
 232       if (array_key_exists($singleRunParamsKey, $this->singleRunParams)) {
 233         $data .= "\n\nParameters raw (" . $this->_source . "): \n" . serialize($this->singleRunParams[$singleRunParamsKey]);
 234         $data .= "\n\nParameters parsed (and passed to API method): \n" . serialize($this->singleRunParams[$singleRunParamsKey]);
 235       }
 236       else {
 237         $data .= "\n\nParameters parsed (and passed to API method): \n" . serialize($this->currentJob->apiParams);
 238       }
 239
 240       $data .= "\n\nFull message: \n" . $message;
 241
 242       $dao->data = $data;
 243     }
 244     $dao->save();
 245   }
 246
 247   /**
 248    * @param $apiResult
 249    *
 250    * @return string
 251    */
 252   private function _apiResultToMessage($apiResult) {
 253     $status = $apiResult['is_error'] ? ts('Failure') : ts('Success');
 254     $msg = CRM_Utils_Array::value('error_message', $apiResult, 'empty error_message!');
 255     $vals = CRM_Utils_Array::value('values', $apiResult, 'empty values!');
 256     if (is_array($msg)) {
 257       $msg = serialize($msg);
 258     }
 259     if (is_array($vals)) {
 260       $vals = serialize($vals);
 261     }
 262     $message = $apiResult['is_error'] ? ', Error message: ' . $msg : " (" . $vals . ")";
 263     return $status . $message;
 264   }
 265
 266 }
 267
 268 /**
 269  * @param $message
 270  *
 271  * @throws Exception
 272  */
 273 function CRM_Core_JobManager_scheduledJobFatalErrorHandler($message) {
 274   throw new Exception("{$message['message']}: {$message['code']}");
 275 }