3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 api is used for working with scheduled "cron" jobs.
31 * @package CiviCRM_APIv3
35 * Adjust metadata for "Create" action.
37 * The metadata is used for setting defaults, documentation & validation.
39 * @param array $params
40 * Array of parameters determined by getfields.
42 function _civicrm_api3_job_create_spec(&$params) {
43 $params['run_frequency']['api.required'] = 1;
44 $params['name']['api.required'] = 1;
45 $params['api_entity']['api.required'] = 1;
46 $params['api_action']['api.required'] = 1;
48 $params['domain_id']['api.default'] = CRM_Core_Config
::domainID();
49 $params['is_active']['api.default'] = 1;
53 * Create scheduled job.
55 * @param array $params
56 * Associative array of property name/value pairs to insert in new job.
60 function civicrm_api3_job_create($params) {
61 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
65 * Retrieve one or more job.
67 * @param array $params
72 function civicrm_api3_job_get($params) {
73 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
79 * @param array $params
81 function civicrm_api3_job_delete($params) {
82 _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
86 * Dumb wrapper to execute scheduled jobs.
88 * Always creates success - errors and results are handled in the job log.
90 * @param array $params
91 * input parameters (unused).
96 function civicrm_api3_job_execute($params) {
98 $facility = new CRM_Core_JobManager();
99 $facility->execute(FALSE);
101 // Always creates success - results are handled elsewhere.
102 return civicrm_api3_create_success(1, $params, 'Job');
106 * Adjust Metadata for Execute action.
108 * @param array $params
109 * Array of parameters determined by getfields.
111 function _civicrm_api3_job_execute_spec(&$params) {
115 * Geocode group of contacts based on given params.
117 * @param array $params
123 function civicrm_api3_job_geocode($params) {
124 $gc = new CRM_Utils_Address_BatchUpdate($params);
126 $result = $gc->run();
128 if ($result['is_error'] == 0) {
129 return civicrm_api3_create_success($result['messages']);
132 return civicrm_api3_create_error($result['messages']);
137 * First check on Code documentation.
139 * @param array $params
141 function _civicrm_api3_job_geocode_spec(&$params) {
142 $params['start'] = array(
143 'title' => 'Starting Contact ID',
144 'type' => CRM_Utils_Type
::T_INT
,
146 $params['end'] = array(
147 'title' => 'Ending Contact ID',
148 'type' => CRM_Utils_Type
::T_INT
,
150 $params['geocoding'] = array(
151 'title' => 'Geocode address?',
152 'type' => CRM_Utils_Type
::T_BOOLEAN
,
154 $params['parse'] = array(
155 'title' => 'Parse street address?',
156 'type' => CRM_Utils_Type
::T_BOOLEAN
,
158 $params['throttle'] = array(
159 'title' => 'Throttle?',
160 'description' => 'If enabled, geo-codes at a slow rate',
161 'type' => CRM_Utils_Type
::T_BOOLEAN
,
166 * Send the scheduled reminders for all contacts (either for activities or events).
168 * @param array $params
169 * (reference ) input parameters.
170 * now - the time to use, in YmdHis format
171 * - makes testing a bit simpler since we can simulate past/future time
175 function civicrm_api3_job_send_reminder($params) {
176 //note that $params['rowCount' can be overridden by one of the preferred syntaxes ($options['limit'] = x
177 //It's not clear whether than syntax can be passed in via the UI config - but this keeps the pre 4.4.4 behaviour
178 // in that case (ie. makes it non-configurable via the UI). Another approach would be to set a default of 0
179 // in the _spec function - but since that is a deprecated value it seems more contentious than this approach
180 $params['rowCount'] = 0;
181 $lock = Civi
::lockManager()->acquire('worker.core.ActionSchedule');
182 if (!$lock->isAcquired()) {
183 return civicrm_api3_create_error('Could not acquire lock, another ActionSchedule process is running');
186 $result = CRM_Core_BAO_ActionSchedule
::processQueue(CRM_Utils_Array
::value('now', $params), $params);
189 if ($result['is_error'] == 0) {
190 return civicrm_api3_create_success();
193 return civicrm_api3_create_error($result['messages']);
197 * Adjust metadata for "send_reminder" action.
199 * The metadata is used for setting defaults, documentation & validation.
201 * @param array $params
202 * Array of parameters determined by getfields.
204 function _civicrm_api3_job_send_reminder(&$params) {
205 //@todo this function will now take all fields in action_schedule as params
206 // as it is calling the api fn to set the filters - update getfields to reflect
207 $params['id'] = array(
208 'type' => CRM_Utils_Type
::T_INT
,
209 'title' => 'Action Schedule ID',
213 * Execute a specific report instance and send the output via email.
215 * @param array $params
216 * (reference ) input parameters.
217 * sendmail - Boolean - should email be sent?, required
218 * instanceId - Integer - the report instance ID
219 * resetVal - Integer - should we reset form state (always true)?
223 function civicrm_api3_job_mail_report($params) {
224 $result = CRM_Report_Utils_Report
::processReport($params);
226 if ($result['is_error'] == 0) {
227 // this should be handling by throwing exceptions but can't remove until we can test that.
228 return civicrm_api3_create_success();
231 return civicrm_api3_create_error($result['messages']);
236 * This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.
238 * IMPORTANT: You must first create valid option value before using via admin interface.
239 * Check option lists for Email Greetings, Postal Greetings and Addressee
241 * @todo - is this here by mistake or should it be added to _spec function :id - Integer - greetings option group.
243 * @param array $params
247 function civicrm_api3_job_update_greeting($params) {
248 if (isset($params['ct']) && isset($params['gt'])) {
249 $ct = explode(',', $params['ct']);
250 $gt = explode(',', $params['gt']);
251 foreach ($ct as $ctKey => $ctValue) {
252 foreach ($gt as $gtKey => $gtValue) {
253 $params['ct'] = trim($ctValue);
254 $params['gt'] = trim($gtValue);
255 CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
260 CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
262 return civicrm_api3_create_success();
266 * Adjust Metadata for Get action.
268 * The metadata is used for setting defaults, documentation & validation.
270 * @param array $params
271 * Array of parameters determined by getfields.
273 function _civicrm_api3_job_update_greeting_spec(&$params) {
274 $params['ct'] = array(
276 'title' => 'Contact Type',
277 'type' => CRM_Utils_Type
::T_STRING
,
279 $params['gt'] = array(
281 'title' => 'Greeting Type',
282 'type' => CRM_Utils_Type
::T_STRING
,
287 * Mass update pledge statuses.
289 * @param array $params
293 function civicrm_api3_job_process_pledge($params) {
294 // *** Uncomment the next line if you want automated reminders to be sent
295 // $params['send_reminders'] = true;
296 $result = CRM_Pledge_BAO_Pledge
::updatePledgeStatus($params);
298 if ($result['is_error'] == 0) {
299 // experiment: detailed execution log is a result here
300 return civicrm_api3_create_success($result['messages']);
303 return civicrm_api3_create_error($result['error_message']);
308 * Process mail queue.
310 * @param array $params
314 function civicrm_api3_job_process_mailing($params) {
315 $mailsProcessedOrig = CRM_Mailing_BAO_MailingJob
::$mailsProcessed;
317 if (!CRM_Mailing_BAO_Mailing
::processQueue()) {
318 return civicrm_api3_create_error('Process Queue failed');
322 'processed' => CRM_Mailing_BAO_MailingJob
::$mailsProcessed - $mailsProcessedOrig,
324 return civicrm_api3_create_success($values, $params, 'Job', 'process_mailing');
331 * @param array $params
335 function civicrm_api3_job_process_sms($params) {
336 $mailsProcessedOrig = CRM_Mailing_BAO_MailingJob
::$mailsProcessed;
338 if (!CRM_Mailing_BAO_Mailing
::processQueue('sms')) {
339 return civicrm_api3_create_error('Process Queue failed');
343 'processed' => CRM_Mailing_BAO_MailingJob
::$mailsProcessed - $mailsProcessedOrig,
345 return civicrm_api3_create_success($values, $params, 'Job', 'process_sms');
350 * Job to get mail responses from civiMailing.
352 * @param array $params
356 function civicrm_api3_job_fetch_bounces($params) {
357 $lock = Civi
::lockManager()->acquire('worker.mailing.EmailProcessor');
358 if (!$lock->isAcquired()) {
359 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
361 CRM_Utils_Mail_EmailProcessor
::processBounces($params['is_create_activities']);
364 return civicrm_api3_create_success(1, $params, 'Job', 'fetch_bounces');
368 * Metadata for bounce function.
370 * @param array $params
372 function _civicrm_api3_job_fetch_bounces_spec(&$params) {
373 $params['is_create_activities'] = array(
375 'type' => CRM_Utils_Type
::T_BOOLEAN
,
376 'title' => ts('Create activities for replies?'),
381 * Job to get mail and create activities.
383 * @param array $params
387 function civicrm_api3_job_fetch_activities($params) {
388 $lock = Civi
::lockManager()->acquire('worker.mailing.EmailProcessor');
389 if (!$lock->isAcquired()) {
390 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
394 CRM_Utils_Mail_EmailProcessor
::processActivities();
397 return civicrm_api3_create_success($values, $params, 'Job', 'fetch_activities');
399 catch (Exception
$e) {
401 return civicrm_api3_create_error($e->getMessage());
406 * Process participant statuses.
408 * @param array $params
412 * array of properties, if error an array with an error id and error message
414 function civicrm_api3_job_process_participant($params) {
415 $result = CRM_Event_BAO_ParticipantStatusType
::process($params);
417 if (!$result['is_error']) {
418 return civicrm_api3_create_success(implode("\r\r", $result['messages']));
421 return civicrm_api3_create_error('Error while processing participant statuses');
427 * This api checks and updates the status of all membership records for a given domain.
429 * The function uses the calc_membership_status and update_contact_membership APIs.
432 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
434 * @param array $params
435 * Input parameters NOT USED.
438 * true if success, else false
440 function civicrm_api3_job_process_membership($params) {
441 $lock = Civi
::lockManager()->acquire('worker.member.UpdateMembership');
442 if (!$lock->isAcquired()) {
443 return civicrm_api3_create_error('Could not acquire lock, another Membership Processing process is running');
446 $result = CRM_Member_BAO_Membership
::updateAllMembershipStatus();
449 if ($result['is_error'] == 0) {
450 return civicrm_api3_create_success($result['messages'], $params, 'Job', 'process_membership');
453 return civicrm_api3_create_error($result['messages']);
458 * This api checks and updates the status of all survey respondents.
460 * @param array $params
461 * (reference ) input parameters.
464 * true if success, else false
466 function civicrm_api3_job_process_respondent($params) {
467 $result = CRM_Campaign_BAO_Survey
::releaseRespondent($params);
469 if ($result['is_error'] == 0) {
470 return civicrm_api3_create_success();
473 return civicrm_api3_create_error($result['messages']);
478 * Merges given pair of duplicate contacts.
480 * @param array $params
485 * @throws \CiviCRM_API3_Exception
487 function civicrm_api3_job_process_batch_merge($params) {
488 $rule_group_id = CRM_Utils_Array
::value('rule_group_id', $params);
489 if (!$rule_group_id) {
490 $rule_group_id = civicrm_api3('RuleGroup', 'getvalue', array(
491 'contact_type' => 'Individual',
492 'used' => 'Unsupervised',
494 'options' => array('limit' => 1),
497 $gid = CRM_Utils_Array
::value('gid', $params);
498 $mode = CRM_Utils_Array
::value('mode', $params, 'safe');
500 $result = CRM_Dedupe_Merger
::batchMerge($rule_group_id, $gid, $mode, 1, 2, CRM_Utils_Array
::value('criteria', $params, array()), CRM_Utils_Array
::value('check_permissions', $params));
502 return civicrm_api3_create_success($result, $params);
506 * Metadata for batch merge function.
510 function _civicrm_api3_job_process_batch_merge_spec(&$params) {
511 $params['rule_group_id'] = array(
512 'title' => 'Dedupe rule group id, defaults to Contact Unsupervised rule',
513 'type' => CRM_Utils_Type
::T_INT
,
514 'api.aliases' => array('rgid'),
516 $params['gid'] = array(
517 'title' => 'group id',
518 'type' => CRM_Utils_Type
::T_INT
,
520 $params['mode'] = array(
522 '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.',
523 'type' => CRM_Utils_Type
::T_STRING
,
525 $params['auto_flip'] = array(
526 'title' => 'Auto Flip',
527 'description' => 'let the api decide which contact to retain and which to delete?',
528 'type' => CRM_Utils_Type
::T_BOOLEAN
,
533 * Runs handlePaymentCron method in the specified payment processor.
535 * @param array $params
538 * Expected @params array keys are: INCORRECTLY DOCUMENTED AND SHOULD BE IN THE _spec function
539 * for retrieval via getfields.
540 * {string 'processor_name' - the name of the payment processor, eg: Sagepay}
542 function civicrm_api3_job_run_payment_cron($params) {
545 CRM_Core_Payment
::handlePaymentMethod(
556 CRM_Core_Payment
::handlePaymentMethod(
568 * This api cleans up all the old session entries and temp tables.
570 * We recommend that sites run this on an hourly basis.
572 * @param array $params
573 * Sends in various config parameters to decide what needs to be cleaned.
575 function civicrm_api3_job_cleanup($params) {
576 $session = CRM_Utils_Array
::value('session', $params, TRUE);
577 $tempTable = CRM_Utils_Array
::value('tempTables', $params, TRUE);
578 $jobLog = CRM_Utils_Array
::value('jobLog', $params, TRUE);
579 $prevNext = CRM_Utils_Array
::value('prevNext', $params, TRUE);
580 $dbCache = CRM_Utils_Array
::value('dbCache', $params, FALSE);
581 $memCache = CRM_Utils_Array
::value('memCache', $params, FALSE);
582 $tplCache = CRM_Utils_Array
::value('tplCache', $params, FALSE);
583 $wordRplc = CRM_Utils_Array
::value('wordRplc', $params, FALSE);
585 if ($session ||
$tempTable ||
$prevNext) {
586 CRM_Core_BAO_Cache
::cleanup($session, $tempTable, $prevNext);
590 CRM_Core_BAO_Job
::cleanup();
594 $config = CRM_Core_Config
::singleton();
595 $config->cleanup(1, FALSE);
599 CRM_Core_Config
::clearDBCache();
603 CRM_Utils_System
::flushCache();
607 CRM_Core_BAO_WordReplacement
::rebuild();
612 * Set expired relationships to disabled.
614 * @param array $params
617 * @throws \API_Exception
619 function civicrm_api3_job_disable_expired_relationships($params) {
620 $result = CRM_Contact_BAO_Relationship
::disableExpiredRelationships();
622 throw new API_Exception('Failed to disable all expired relationships.');
624 return civicrm_api3_create_success(1, $params, 'Job', 'disable_expired_relationships');
628 * This api reloads all the smart groups.
630 * If the org has a large number of smart groups it is recommended that they use the limit clause
631 * to limit the number of smart groups evaluated on a per job basis.
633 * Might also help to increase the smartGroupCacheTimeout and use the cache.
635 * @param array $params
638 * @throws \API_Exception
640 function civicrm_api3_job_group_rebuild($params) {
641 $lock = Civi
::lockManager()->acquire('worker.core.GroupRebuild');
642 if (!$lock->isAcquired()) {
643 throw new API_Exception('Could not acquire lock, another GroupRebuild process is running');
646 $limit = CRM_Utils_Array
::value('limit', $params, 0);
648 CRM_Contact_BAO_GroupContactCache
::loadAll(NULL, $limit);
651 return civicrm_api3_create_success();
655 * Flush smart groups caches.
657 * This job purges aged smart group cache data (based on the timeout value). Sites can decide whether they want this
658 * job and / or the group cache rebuild job to run. In some cases performance is better when old caches are cleared out
659 * prior to any attempt to rebuild them. Also, many sites are very happy to have caches built on demand, provided the
660 * user is not having to wait for deadlocks to clear when invalidating them.
662 * @param array $params
665 * @throws \API_Exception
667 function civicrm_api3_job_group_cache_flush($params) {
668 CRM_Contact_BAO_GroupContactCache
::deterministicCacheFlush();
669 return civicrm_api3_create_success();
673 * Check for CiviCRM software updates.
675 * Anonymous site statistics are sent back to civicrm.org during this check.
677 function civicrm_api3_job_version_check() {
678 $vc = new CRM_Utils_VersionCheck();
680 return civicrm_api3_create_success();