3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This interface defines methods that need to be implemented
30 * by every scheduled job (cron task) in CiviCRM.
33 * @copyright CiviCRM LLC (c) 2004-2014
37 class CRM_Core_JobManager
{
40 * @var array ($id => CRM_Core_ScheduledJob)
45 * @var CRM_Core_ScheduledJob
47 var $currentJob = NULL;
49 var $singleRunParams = array();
63 public function __construct() {
64 $config = CRM_Core_Config
::singleton();
65 $config->fatalErrorHandler
= 'CRM_Core_JobManager_scheduledJobFatalErrorHandler';
67 $this->jobs
= $this->_getJobs();
78 public function execute($auth = TRUE) {
80 $this->logEntry('Starting scheduled jobs execution');
82 if ($auth && !CRM_Utils_System
::authenticateKey(TRUE)) {
83 $this->logEntry('Could not authenticate the site key.');
85 require_once 'api/api.php';
87 // it's not asynchronous at this stage
88 CRM_Utils_Hook
::cron($this);
89 foreach ($this->jobs
as $job) {
90 if ($job->is_active
) {
91 if ($job->needsRunning()) {
92 $this->executeJob($job);
96 $this->logEntry('Finishing scheduled jobs execution.');
105 public function __destruct() {}
111 public function executeJobByAction($entity, $action) {
112 $job = $this->_getJob(NULL, $entity, $action);
113 $this->executeJob($job);
119 public function executeJobById($id) {
120 $job = $this->_getJob($id);
121 $this->executeJob($job);
125 * @param CRM_Core_ScheduledJob $job
127 public function executeJob($job) {
128 $this->currentJob
= $job;
129 $this->logEntry('Starting execution of ' . $job->name
);
132 $singleRunParamsKey = strtolower($job->api_entity
. '_' . $job->api_action
);
134 if (array_key_exists($singleRunParamsKey, $this->singleRunParams
)) {
135 $params = $this->singleRunParams
[$singleRunParamsKey];
138 $params = $job->apiParams
;
142 $result = civicrm_api($job->api_entity
, $job->api_action
, $params);
145 $this->logEntry('Error while executing ' . $job->name
. ': ' . $e->getMessage());
147 $this->logEntry('Finished execution of ' . $job->name
. ' with result: ' . $this->_apiResultToMessage($result));
148 $this->currentJob
= FALSE;
152 * Retrieves the list of jobs from the database,
153 * populates class param.
156 * @return array ($id => CRM_Core_ScheduledJob)
162 private function _getJobs() {
164 $dao = new CRM_Core_DAO_Job();
165 $dao->orderBy('name');
166 $dao->domain_id
= CRM_Core_Config
::domainID();
168 while ($dao->fetch()) {
170 CRM_Core_DAO
::storeValues($dao, $temp);
171 $jobs[$dao->id
] = new CRM_Core_ScheduledJob($temp);
177 * Retrieves specific job from the database by id
178 * and creates ScheduledJob object.
185 * @param null $entity
186 * @param null $action
188 * @return CRM_Core_ScheduledJob
191 private function _getJob($id = NULL, $entity = NULL, $action = NULL) {
192 if (is_null($id) && is_null($action)) {
193 CRM_Core_Error
::fatal('You need to provide either id or name to use this method');
195 $dao = new CRM_Core_DAO_Job();
197 $dao->api_entity
= $entity;
198 $dao->api_action
= $action;
200 while ($dao->fetch()) {
201 CRM_Core_DAO
::storeValues($dao, $temp);
202 $job = new CRM_Core_ScheduledJob($temp);
210 * @param array $params
211 * @param null $source
213 public function setSingleRunParams($entity, $job, $params, $source = NULL) {
214 $this->_source
= $source;
215 $key = strtolower($entity . '_' . $job);
216 $this->singleRunParams
[$key] = $params;
217 $this->singleRunParams
[$key]['version'] = 3;
222 * @return array|null collection of permissions, null if none
228 public function logEntry($message) {
229 $domainID = CRM_Core_Config
::domainID();
230 $dao = new CRM_Core_DAO_JobLog();
232 $dao->domain_id
= $domainID;
233 $dao->description
= substr($message, 0, 235);
234 if (strlen($message) > 235) {
235 $dao->description
.= " (...)";
237 if ($this->currentJob
) {
238 $dao->job_id
= $this->currentJob
->id
;
239 $dao->name
= $this->currentJob
->name
;
240 $dao->command
= ts("Entity:") . " " . $this->currentJob
->api_entity
. " " . ts("Action:") . " " . $this->currentJob
->api_action
;
242 if (!empty($this->currentJob
->parameters
)) {
243 $data .= "\n\nParameters raw (from db settings): \n" . $this->currentJob
->parameters
;
245 $singleRunParamsKey = strtolower($this->currentJob
->api_entity
. '_' . $this->currentJob
->api_action
);
246 if (array_key_exists($singleRunParamsKey, $this->singleRunParams
)) {
247 $data .= "\n\nParameters raw (" . $this->_source
. "): \n" . serialize($this->singleRunParams
[$singleRunParamsKey]);
248 $data .= "\n\nParameters parsed (and passed to API method): \n" . serialize($this->singleRunParams
[$singleRunParamsKey]);
251 $data .= "\n\nParameters parsed (and passed to API method): \n" . serialize($this->currentJob
->apiParams
);
254 $data .= "\n\nFull message: \n" . $message;
266 private function _apiResultToMessage($apiResult) {
267 $status = $apiResult['is_error'] ?
ts('Failure') : ts('Success');
268 $msg = CRM_Utils_Array
::value('error_message', $apiResult, 'empty error_message!');
269 $vals = CRM_Utils_Array
::value('values', $apiResult, 'empty values!');
270 if (is_array($msg)) {
271 $msg = serialize($msg);
273 if (is_array($vals)) {
274 $vals = serialize($vals);
276 $message = $apiResult['is_error'] ?
', Error message: ' . $msg : " (" . $vals . ")";
277 return $status . $message;
286 function CRM_Core_JobManager_scheduledJobFatalErrorHandler($message) {
287 throw new Exception("{$message['message']}: {$message['code']}");