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 api is used for working with scheduled "cron" jobs.
15 * @package CiviCRM_APIv3
19 * Adjust metadata for "Create" action.
21 * The metadata is used for setting defaults, documentation & validation.
23 * @param array $params
24 * Array of parameters determined by getfields.
26 function _civicrm_api3_job_create_spec(&$params) {
27 $params['run_frequency']['api.required'] = 1;
28 $params['name']['api.required'] = 1;
29 $params['api_entity']['api.required'] = 1;
30 $params['api_action']['api.required'] = 1;
32 $params['domain_id']['api.default'] = CRM_Core_Config
::domainID();
33 $params['is_active']['api.default'] = 1;
37 * Create scheduled job.
39 * @param array $params
40 * Associative array of property name/value pairs to insert in new job.
44 function civicrm_api3_job_create($params) {
45 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Job');
49 * Adjust metadata for clone spec action.
53 function _civicrm_api3_job_clone_spec(&$spec) {
54 $spec['id']['title'] = 'Job ID to clone';
55 $spec['id']['type'] = CRM_Utils_Type
::T_INT
;
56 $spec['id']['api.required'] = 1;
57 $spec['is_active']['title'] = 'Job is Active?';
58 $spec['is_active']['type'] = CRM_Utils_Type
::T_BOOLEAN
;
59 $spec['is_active']['api.required'] = 0;
65 * @param array $params
68 * @throws \API_Exception
69 * @throws \CiviCRM_API3_Exception
71 function civicrm_api3_job_clone($params) {
72 if (empty($params['id'])) {
73 throw new API_Exception("Mandatory key(s) missing from params array: id field is required");
77 $params['last_run'] = 'null';
78 $params['scheduled_run_date'] = 'null';
79 $newJobDAO = CRM_Core_BAO_Job
::copy($id, $params);
80 return civicrm_api3('Job', 'get', ['id' => $newJobDAO->id
]);
84 * Retrieve one or more job.
86 * @param array $params
91 function civicrm_api3_job_get($params) {
92 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
98 * @param array $params
100 function civicrm_api3_job_delete($params) {
101 _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
105 * Dumb wrapper to execute scheduled jobs.
107 * Always creates success - errors and results are handled in the job log.
109 * @param array $params
110 * input parameters (unused).
115 function civicrm_api3_job_execute($params) {
117 $facility = new CRM_Core_JobManager();
118 $facility->execute(FALSE);
120 // Always creates success - results are handled elsewhere.
121 return civicrm_api3_create_success(1, $params, 'Job');
125 * Adjust Metadata for Execute action.
127 * @param array $params
128 * Array of parameters determined by getfields.
130 function _civicrm_api3_job_execute_spec(&$params) {
134 * Geocode group of contacts based on given params.
136 * @param array $params
142 function civicrm_api3_job_geocode($params) {
143 $gc = new CRM_Utils_Address_BatchUpdate($params);
145 $result = $gc->run();
147 if ($result['is_error'] == 0) {
148 return civicrm_api3_create_success($result['messages']);
151 return civicrm_api3_create_error($result['messages']);
156 * First check on Code documentation.
158 * @param array $params
160 function _civicrm_api3_job_geocode_spec(&$params) {
162 'title' => 'Starting Contact ID',
163 'type' => CRM_Utils_Type
::T_INT
,
166 'title' => 'Ending Contact ID',
167 'type' => CRM_Utils_Type
::T_INT
,
169 $params['geocoding'] = [
170 'title' => 'Geocode address?',
171 'type' => CRM_Utils_Type
::T_BOOLEAN
,
174 'title' => 'Parse street address?',
175 'type' => CRM_Utils_Type
::T_BOOLEAN
,
177 $params['throttle'] = [
178 'title' => 'Throttle?',
179 'description' => 'If enabled, geo-codes at a slow rate',
180 'type' => CRM_Utils_Type
::T_BOOLEAN
,
185 * Send the scheduled reminders as configured.
187 * @param array $params
188 * - now - the time to use, in YmdHis format
189 * - makes testing a bit simpler since we can simulate past/future time
192 * @throws \API_Exception
193 * @throws \CRM_Core_Exception
194 * @throws \CiviCRM_API3_Exception
196 function civicrm_api3_job_send_reminder($params) {
197 //note that $params['rowCount' can be overridden by one of the preferred syntaxes ($options['limit'] = x
198 //It's not clear whether than syntax can be passed in via the UI config - but this keeps the pre 4.4.4 behaviour
199 // in that case (ie. makes it non-configurable via the UI). Another approach would be to set a default of 0
200 // in the _spec function - but since that is a deprecated value it seems more contentious than this approach
201 $params['rowCount'] = 0;
202 $lock = Civi
::lockManager()->acquire('worker.core.ActionSchedule');
203 if (!$lock->isAcquired()) {
204 throw new API_Exception('Could not acquire lock, another ActionSchedule process is running');
207 CRM_Core_BAO_ActionSchedule
::processQueue($params['now'] ??
NULL, $params);
209 return civicrm_api3_create_success(1, $params, 'ActionSchedule', 'send_reminder');
213 * Adjust metadata for "send_reminder" action.
215 * The metadata is used for setting defaults, documentation & validation.
217 * @param array $params
218 * Array of parameters determined by getfields.
220 function _civicrm_api3_job_send_reminder(&$params) {
221 //@todo this function will now take all fields in action_schedule as params
222 // as it is calling the api fn to set the filters - update getfields to reflect
224 'type' => CRM_Utils_Type
::T_INT
,
225 'title' => 'Action Schedule ID',
230 * Execute a specific report instance and send the output via email.
232 * @param array $params
233 * (reference ) input parameters.
234 * sendmail - Boolean - should email be sent?, required
235 * instanceId - Integer - the report instance ID
236 * resetVal - Integer - should we reset form state (always true)?
240 function civicrm_api3_job_mail_report($params) {
241 $result = CRM_Report_Utils_Report
::processReport($params);
243 if ($result['is_error'] == 0) {
244 // this should be handling by throwing exceptions but can't remove until we can test that.
245 return civicrm_api3_create_success();
248 return civicrm_api3_create_error($result['messages']);
253 * This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.
255 * IMPORTANT: You must first create valid option value before using via admin interface.
256 * Check option lists for Email Greetings, Postal Greetings and Addressee
258 * @todo - is this here by mistake or should it be added to _spec function :id - Integer - greetings option group.
260 * @param array $params
264 function civicrm_api3_job_update_greeting($params) {
265 if (isset($params['ct']) && isset($params['gt'])) {
266 $ct = explode(',', $params['ct']);
267 $gt = explode(',', $params['gt']);
268 foreach ($ct as $ctKey => $ctValue) {
269 foreach ($gt as $gtKey => $gtValue) {
270 $params['ct'] = trim($ctValue);
271 $params['gt'] = trim($gtValue);
272 CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
277 CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
279 return civicrm_api3_create_success();
283 * Adjust Metadata for Get action.
285 * The metadata is used for setting defaults, documentation & validation.
287 * @param array $params
288 * Array of parameters determined by getfields.
290 function _civicrm_api3_job_update_greeting_spec(&$params) {
293 'title' => 'Contact Type',
294 'type' => CRM_Utils_Type
::T_STRING
,
298 'title' => 'Greeting Type',
299 'type' => CRM_Utils_Type
::T_STRING
,
304 * Mass update pledge statuses.
306 * @param array $params
310 function civicrm_api3_job_process_pledge($params) {
311 // *** Uncomment the next line if you want automated reminders to be sent
312 // $params['send_reminders'] = true;
313 $result = CRM_Pledge_BAO_Pledge
::updatePledgeStatus($params);
315 if ($result['is_error'] == 0) {
316 // experiment: detailed execution log is a result here
317 return civicrm_api3_create_success($result['messages']);
320 return civicrm_api3_create_error($result['error_message']);
325 * Process mail queue.
327 * @param array $params
331 function civicrm_api3_job_process_mailing($params) {
332 $mailsProcessedOrig = CRM_Mailing_BAO_MailingJob
::$mailsProcessed;
335 CRM_Core_BAO_Setting
::isAPIJobAllowedToRun($params);
337 catch (Exception
$e) {
338 return civicrm_api3_create_error($e->getMessage());
341 if (!CRM_Mailing_BAO_Mailing
::processQueue()) {
342 return civicrm_api3_create_error('Process Queue failed');
346 'processed' => CRM_Mailing_BAO_MailingJob
::$mailsProcessed - $mailsProcessedOrig,
348 return civicrm_api3_create_success($values, $params, 'Job', 'process_mailing');
355 * @param array $params
359 function civicrm_api3_job_process_sms($params) {
360 $mailsProcessedOrig = CRM_Mailing_BAO_MailingJob
::$mailsProcessed;
362 if (!CRM_Mailing_BAO_Mailing
::processQueue('sms')) {
363 return civicrm_api3_create_error('Process Queue failed');
367 'processed' => CRM_Mailing_BAO_MailingJob
::$mailsProcessed - $mailsProcessedOrig,
369 return civicrm_api3_create_success($values, $params, 'Job', 'process_sms');
374 * Job to get mail responses from civiMailing.
376 * @param array $params
380 function civicrm_api3_job_fetch_bounces($params) {
381 $lock = Civi
::lockManager()->acquire('worker.mailing.EmailProcessor');
382 if (!$lock->isAcquired()) {
383 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
385 CRM_Utils_Mail_EmailProcessor
::processBounces($params['is_create_activities']);
388 return civicrm_api3_create_success(1, $params, 'Job', 'fetch_bounces');
392 * Metadata for bounce function.
394 * @param array $params
396 function _civicrm_api3_job_fetch_bounces_spec(&$params) {
397 $params['is_create_activities'] = [
399 'type' => CRM_Utils_Type
::T_BOOLEAN
,
400 'title' => ts('Create activities for replies?'),
405 * Job to get mail and create activities.
407 * @param array $params
411 function civicrm_api3_job_fetch_activities($params) {
412 $lock = Civi
::lockManager()->acquire('worker.mailing.EmailProcessor');
413 if (!$lock->isAcquired()) {
414 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
418 CRM_Utils_Mail_EmailProcessor
::processActivities();
421 return civicrm_api3_create_success($values, $params, 'Job', 'fetch_activities');
423 catch (Exception
$e) {
425 return civicrm_api3_create_error($e->getMessage());
430 * Process participant statuses.
432 * @param array $params
436 * array of properties, if error an array with an error id and error message
438 function civicrm_api3_job_process_participant($params) {
439 $result = CRM_Event_BAO_ParticipantStatusType
::process($params);
441 if (!$result['is_error']) {
442 return civicrm_api3_create_success(implode("\r\r", $result['messages']));
445 return civicrm_api3_create_error('Error while processing participant statuses');
450 * This api checks and updates the status of all membership records for a given domain.
452 * The function uses the calc_membership_status and update_contact_membership APIs.
455 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
457 * @param array $params
458 * Input parameters NOT USED.
461 * true if success, else false
463 function civicrm_api3_job_process_membership($params) {
464 $lock = Civi
::lockManager()->acquire('worker.member.UpdateMembership');
465 if (!$lock->isAcquired()) {
466 return civicrm_api3_create_error('Could not acquire lock, another Membership Processing process is running');
469 $result = CRM_Member_BAO_Membership
::updateAllMembershipStatus();
472 if ($result['is_error'] == 0) {
473 return civicrm_api3_create_success($result['messages'], $params, 'Job', 'process_membership');
476 return civicrm_api3_create_error($result['messages']);
481 * This api checks and updates the status of all survey respondents.
483 * @param array $params
484 * (reference ) input parameters.
487 * true if success, else false
489 function civicrm_api3_job_process_respondent($params) {
490 $result = CRM_Campaign_BAO_Survey
::releaseRespondent($params);
492 if ($result['is_error'] == 0) {
493 return civicrm_api3_create_success();
496 return civicrm_api3_create_error($result['messages']);
501 * Merges given pair of duplicate contacts.
503 * @param array $params
508 * @throws \CiviCRM_API3_Exception
510 function civicrm_api3_job_process_batch_merge($params) {
511 $rule_group_id = $params['rule_group_id'] ??
NULL;
512 if (!$rule_group_id) {
513 $rule_group_id = civicrm_api3('RuleGroup', 'getvalue', [
514 'contact_type' => 'Individual',
515 'used' => 'Unsupervised',
517 'options' => ['limit' => 1],
520 $rgid = $params['rgid'] ??
NULL;
521 $gid = $params['gid'] ??
NULL;
522 $mode = CRM_Utils_Array
::value('mode', $params, 'safe');
524 $result = CRM_Dedupe_Merger
::batchMerge($rule_group_id, $gid, $mode, 1, 2, CRM_Utils_Array
::value('criteria', $params, []), CRM_Utils_Array
::value('check_permissions', $params), NULL, $params['search_limit']);
526 return civicrm_api3_create_success($result, $params);
530 * Metadata for batch merge function.
534 function _civicrm_api3_job_process_batch_merge_spec(&$params) {
535 $params['rule_group_id'] = [
536 'title' => 'Dedupe rule group id, defaults to Contact Unsupervised rule',
537 'type' => CRM_Utils_Type
::T_INT
,
538 'api.aliases' => ['rgid'],
541 'title' => 'group id',
542 'type' => CRM_Utils_Type
::T_INT
,
546 'description' => 'helps decide how to behave when there are conflicts. A \'safe\' value skips the merge if there are no conflicts. Does a force merge otherwise.',
547 'type' => CRM_Utils_Type
::T_STRING
,
549 $params['auto_flip'] = [
550 'title' => 'Auto Flip',
551 'description' => 'let the api decide which contact to retain and which to delete?',
552 'type' => CRM_Utils_Type
::T_BOOLEAN
,
554 $params['search_limit'] = [
555 'title' => ts('Number of contacts to look for matches for.'),
556 'type' => CRM_Utils_Type
::T_INT
,
557 'api.default' => (int) Civi
::settings()->get('dedupe_default_limit'),
563 * Runs handlePaymentCron method in the specified payment processor.
565 * @param array $params
568 * Expected @params array keys are: INCORRECTLY DOCUMENTED AND SHOULD BE IN THE _spec function
569 * for retrieval via getfields.
570 * {string 'processor_name' - the name of the payment processor, eg: Sagepay}
572 function civicrm_api3_job_run_payment_cron($params) {
575 CRM_Core_Payment
::handlePaymentMethod(
586 CRM_Core_Payment
::handlePaymentMethod(
598 * This api cleans up all the old session entries and temp tables.
600 * We recommend that sites run this on an hourly basis.
602 * @param array $params
603 * Sends in various config parameters to decide what needs to be cleaned.
605 function civicrm_api3_job_cleanup($params) {
606 $session = CRM_Utils_Array
::value('session', $params, TRUE);
607 $tempTable = CRM_Utils_Array
::value('tempTables', $params, TRUE);
608 $jobLog = CRM_Utils_Array
::value('jobLog', $params, TRUE);
609 $expired = CRM_Utils_Array
::value('expiredDbCache', $params, TRUE);
610 $prevNext = CRM_Utils_Array
::value('prevNext', $params, TRUE);
611 $dbCache = CRM_Utils_Array
::value('dbCache', $params, FALSE);
612 $memCache = CRM_Utils_Array
::value('memCache', $params, FALSE);
613 $tplCache = CRM_Utils_Array
::value('tplCache', $params, FALSE);
614 $wordRplc = CRM_Utils_Array
::value('wordRplc', $params, FALSE);
616 if ($session ||
$tempTable ||
$prevNext ||
$expired) {
617 CRM_Core_BAO_Cache
::cleanup($session, $tempTable, $prevNext, $expired);
621 CRM_Core_BAO_Job
::cleanup();
625 $config = CRM_Core_Config
::singleton();
626 $config->cleanup(1, FALSE);
630 CRM_Core_Config
::clearDBCache();
634 CRM_Utils_System
::flushCache();
638 CRM_Core_BAO_WordReplacement
::rebuild();
643 * Set expired relationships to disabled.
645 * @param array $params
648 * @throws \API_Exception
650 function civicrm_api3_job_disable_expired_relationships($params) {
651 $result = CRM_Contact_BAO_Relationship
::disableExpiredRelationships();
653 throw new API_Exception('Failed to disable all expired relationships.');
655 return civicrm_api3_create_success(1, $params, 'Job', 'disable_expired_relationships');
659 * This api reloads all the smart groups.
661 * If the org has a large number of smart groups it is recommended that they use the limit clause
662 * to limit the number of smart groups evaluated on a per job basis.
664 * Might also help to increase the smartGroupCacheTimeout and use the cache.
666 * @param array $params
669 * @throws \API_Exception
671 function civicrm_api3_job_group_rebuild($params) {
672 $lock = Civi
::lockManager()->acquire('worker.core.GroupRebuild');
673 if (!$lock->isAcquired()) {
674 throw new API_Exception('Could not acquire lock, another GroupRebuild process is running');
677 $limit = $params['limit'] ??
0;
679 CRM_Contact_BAO_GroupContactCache
::loadAll(NULL, $limit);
682 return civicrm_api3_create_success();
686 * Flush smart groups caches.
688 * This job purges aged smart group cache data (based on the timeout value). Sites can decide whether they want this
689 * job and / or the group cache rebuild job to run. In some cases performance is better when old caches are cleared out
690 * prior to any attempt to rebuild them. Also, many sites are very happy to have caches built on demand, provided the
691 * user is not having to wait for deadlocks to clear when invalidating them.
693 * @param array $params
696 * @throws \API_Exception
698 function civicrm_api3_job_group_cache_flush($params) {
699 CRM_Contact_BAO_GroupContactCache
::deterministicCacheFlush();
700 return civicrm_api3_create_success();
704 * Check for CiviCRM software updates.
706 * Anonymous site statistics are sent back to civicrm.org during this check.
708 function civicrm_api3_job_version_check() {
709 $vc = new CRM_Utils_VersionCheck();
711 return civicrm_api3_create_success();