3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * This interface defines methods that need to be implemented
14 * by every scheduled job (cron task) in CiviCRM.
17 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 class CRM_Core_JobManager
{
24 * Format is ($id => CRM_Core_ScheduledJob).
31 * @var CRM_Core_ScheduledJob
33 public $currentJob = NULL;
35 public $singleRunParams = [];
37 public $_source = NULL;
42 public function __construct() {
43 $config = CRM_Core_Config
::singleton();
44 $config->fatalErrorHandler
= 'CRM_Core_JobManager_scheduledJobFatalErrorHandler';
46 $this->jobs
= $this->_getJobs();
52 public function execute($auth = TRUE) {
54 $this->logEntry('Starting scheduled jobs execution');
56 if ($auth && !CRM_Utils_System
::authenticateKey(TRUE)) {
57 $this->logEntry('Could not authenticate the site key.');
59 require_once 'api/api.php';
61 // it's not asynchronous at this stage
62 CRM_Utils_Hook
::cron($this);
63 foreach ($this->jobs
as $job) {
64 if ($job->is_active
) {
65 if ($job->needsRunning()) {
66 $this->executeJob($job);
70 $this->logEntry('Finishing scheduled jobs execution.');
72 // Set last cron date for the status check
74 'name' => 'checkLastCron',
75 'check_info' => gmdate('U'),
77 CRM_Core_BAO_StatusPreference
::create($statusPref);
83 public function __destruct() {
90 public function executeJobByAction($entity, $action) {
91 $job = $this->_getJob(NULL, $entity, $action);
92 $this->executeJob($job);
98 public function executeJobById($id) {
99 $job = $this->_getJob($id);
100 $this->executeJob($job);
104 * @param CRM_Core_ScheduledJob $job
106 public function executeJob($job) {
107 $this->currentJob
= $job;
109 // CRM-18231 check if non-production environment.
111 CRM_Core_BAO_Setting
::isAPIJobAllowedToRun($job->apiParams
);
113 catch (Exception
$e) {
114 $this->logEntry('Error while executing ' . $job->name
. ': ' . $e->getMessage());
115 $this->currentJob
= FALSE;
119 $this->logEntry('Starting execution of ' . $job->name
);
122 $singleRunParamsKey = strtolower($job->api_entity
. '_' . $job->api_action
);
124 if (array_key_exists($singleRunParamsKey, $this->singleRunParams
)) {
125 $params = $this->singleRunParams
[$singleRunParamsKey];
128 $params = $job->apiParams
;
131 CRM_Utils_Hook
::preJob($job, $params);
133 $result = civicrm_api($job->api_entity
, $job->api_action
, $params);
135 catch (Exception
$e) {
136 $this->logEntry('Error while executing ' . $job->name
. ': ' . $e->getMessage());
139 CRM_Utils_Hook
::postJob($job, $params, $result);
140 $this->logEntry('Finished execution of ' . $job->name
. ' with result: ' . $this->_apiResultToMessage($result));
141 $this->currentJob
= FALSE;
143 //Disable outBound option after executing the job.
144 $environment = CRM_Core_Config
::environment(NULL, TRUE);
145 if ($environment != 'Production' && !empty($job->apiParams
['runInNonProductionEnvironment'])) {
146 Civi
::settings()->set('mailing_backend', ['outBound_option' => CRM_Mailing_Config
::OUTBOUND_OPTION_DISABLED
]);
151 * Retrieves the list of jobs from the database,
152 * populates class param.
155 * ($id => CRM_Core_ScheduledJob)
157 private function _getJobs() {
159 $dao = new CRM_Core_DAO_Job();
160 $dao->orderBy('name');
161 $dao->domain_id
= CRM_Core_Config
::domainID();
163 while ($dao->fetch()) {
165 CRM_Core_DAO
::storeValues($dao, $temp);
166 $jobs[$dao->id
] = new CRM_Core_ScheduledJob($temp);
172 * Retrieves specific job from the database by id.
173 * and creates ScheduledJob object.
176 * @param null $entity
177 * @param null $action
179 * @return CRM_Core_ScheduledJob
182 private function _getJob($id = NULL, $entity = NULL, $action = NULL) {
183 if (is_null($id) && is_null($action)) {
184 CRM_Core_Error
::fatal('You need to provide either id or name to use this method');
186 $dao = new CRM_Core_DAO_Job();
188 $dao->api_entity
= $entity;
189 $dao->api_action
= $action;
191 while ($dao->fetch()) {
192 CRM_Core_DAO
::storeValues($dao, $temp);
193 $job = new CRM_Core_ScheduledJob($temp);
201 * @param array $params
202 * @param null $source
204 public function setSingleRunParams($entity, $job, $params, $source = NULL) {
205 $this->_source
= $source;
206 $key = strtolower($entity . '_' . $job);
207 $this->singleRunParams
[$key] = $params;
208 $this->singleRunParams
[$key]['version'] = 3;
212 * @param string $message
214 public function logEntry($message) {
215 $domainID = CRM_Core_Config
::domainID();
216 $dao = new CRM_Core_DAO_JobLog();
218 $dao->domain_id
= $domainID;
221 * The description is a summary of the message.
222 * HTML tags are stripped from the message.
223 * The description is limited to 240 characters
224 * and has an ellipsis added if it is truncated.
226 $maxDescription = 240;
227 $ellipsis = " (...)";
228 $description = strip_tags($message);
229 if (strlen($description) > $maxDescription) {
230 $description = substr($description, 0, $maxDescription - strlen($ellipsis)) . $ellipsis;
232 $dao->description
= $description;
234 if ($this->currentJob
) {
235 $dao->job_id
= $this->currentJob
->id
;
236 $dao->name
= $this->currentJob
->name
;
237 $dao->command
= ts("Entity:") . " " . $this->currentJob
->api_entity
. " " . ts("Action:") . " " . $this->currentJob
->api_action
;
239 if (!empty($this->currentJob
->parameters
)) {
240 $data .= "\n\nParameters raw (from db settings): \n" . $this->currentJob
->parameters
;
242 $singleRunParamsKey = strtolower($this->currentJob
->api_entity
. '_' . $this->currentJob
->api_action
);
243 if (array_key_exists($singleRunParamsKey, $this->singleRunParams
)) {
244 $data .= "\n\nParameters raw (" . $this->_source
. "): \n" . serialize($this->singleRunParams
[$singleRunParamsKey]);
245 $data .= "\n\nParameters parsed (and passed to API method): \n" . serialize($this->singleRunParams
[$singleRunParamsKey]);
248 $data .= "\n\nParameters parsed (and passed to API method): \n" . serialize($this->currentJob
->apiParams
);
251 $data .= "\n\nFull message: \n" . $message;
263 private function _apiResultToMessage($apiResult) {
264 $status = $apiResult['is_error'] ?
ts('Failure') : ts('Success');
265 $msg = CRM_Utils_Array
::value('error_message', $apiResult, 'empty error_message!');
266 $vals = CRM_Utils_Array
::value('values', $apiResult, 'empty values!');
267 if (is_array($msg)) {
268 $msg = serialize($msg);
270 if (is_array($vals)) {
271 $vals = serialize($vals);
273 $message = $apiResult['is_error'] ?
', Error message: ' . $msg : " (" . $vals . ")";
274 return $status . $message;
284 function CRM_Core_JobManager_scheduledJobFatalErrorHandler($message) {
285 throw new Exception("{$message['message']}: {$message['code']}");