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 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('title' => 'Start Date');
143 $params['end'] = array('title' => 'End Date');
144 $params['geocoding'] = array('title' => 'Geocode address?');
145 $params['parse'] = array('title' => 'Parse street address?');
146 $params['throttle'] = array('title' => 'Throttle? if enabled, geo-codes at a slow rate');
150 * Send the scheduled reminders for all contacts (either for activities or events).
152 * @param array $params
153 * (reference ) input parameters.
154 * now - the time to use, in YmdHis format
155 * - makes testing a bit simpler since we can simulate past/future time
159 function civicrm_api3_job_send_reminder($params) {
160 //note that $params['rowCount' can be overridden by one of the preferred syntaxes ($options['limit'] = x
161 //It's not clear whether than syntax can be passed in via the UI config - but this keeps the pre 4.4.4 behaviour
162 // in that case (ie. makes it non-configurable via the UI). Another approach would be to set a default of 0
163 // in the _spec function - but since that is a deprecated value it seems more contentious than this approach
164 $params['rowCount'] = 0;
165 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
166 if (!$lock->isAcquired()) {
167 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
170 $result = CRM_Core_BAO_ActionSchedule
::processQueue(CRM_Utils_Array
::value('now', $params), $params);
173 if ($result['is_error'] == 0) {
174 return civicrm_api3_create_success();
177 return civicrm_api3_create_error($result['messages']);
181 * Adjust metadata for "send_reminder" action.
183 * The metadata is used for setting defaults, documentation & validation.
185 * @param array $params
186 * Array of parameters determined by getfields.
188 function _civicrm_api3_job_send_reminder(&$params) {
189 //@todo this function will now take all fields in action_schedule as params
190 // as it is calling the api fn to set the filters - update getfields to reflect
191 $params['id'] = array(
192 'type' => CRM_Utils_Type
::T_INT
,
193 'title' => 'Action Schedule ID',
197 * Execute a specific report instance and send the output via email.
199 * @param array $params
200 * (reference ) input parameters.
201 * sendmail - Boolean - should email be sent?, required
202 * instanceId - Integer - the report instance ID
203 * resetVal - Integer - should we reset form state (always true)?
207 function civicrm_api3_job_mail_report($params) {
208 $result = CRM_Report_Utils_Report
::processReport($params);
210 if ($result['is_error'] == 0) {
211 // this should be handling by throwing exceptions but can't remove until we can test that.
212 return civicrm_api3_create_success();
215 return civicrm_api3_create_error($result['messages']);
220 * This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.
222 * IMPORTANT: You must first create valid option value before using via admin interface.
223 * Check option lists for Email Greetings, Postal Greetings and Addressee
225 * @todo - is this here by mistake or should it be added to _spec function :id - Integer - greetings option group.
227 * @param array $params
231 function civicrm_api3_job_update_greeting($params) {
232 if (isset($params['ct']) && isset($params['gt'])) {
233 $ct = explode(',', $params['ct']);
234 $gt = explode(',', $params['gt']);
235 foreach ($ct as $ctKey => $ctValue) {
236 foreach ($gt as $gtKey => $gtValue) {
237 $params['ct'] = trim($ctValue);
238 $params['gt'] = trim($gtValue);
239 CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
244 CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
246 return civicrm_api3_create_success();
250 * Adjust Metadata for Get action.
252 * The metadata is used for setting defaults, documentation & validation.
254 * @param array $params
255 * Array of parameters determined by getfields.
257 function _civicrm_api3_job_update_greeting_spec(&$params) {
258 $params['ct'] = array(
260 'title' => 'Contact Type',
261 'type' => CRM_Utils_Type
::T_STRING
,
263 $params['gt'] = array(
265 'title' => 'Greeting Type',
266 'type' => CRM_Utils_Type
::T_STRING
,
271 * Mass update pledge statuses.
273 * @param array $params
277 function civicrm_api3_job_process_pledge($params) {
278 // *** Uncomment the next line if you want automated reminders to be sent
279 // $params['send_reminders'] = true;
280 $result = CRM_Pledge_BAO_Pledge
::updatePledgeStatus($params);
282 if ($result['is_error'] == 0) {
283 // experiment: detailed execution log is a result here
284 return civicrm_api3_create_success($result['messages']);
287 return civicrm_api3_create_error($result['error_message']);
292 * Process mail queue.
294 * @param array $params
298 function civicrm_api3_job_process_mailing($params) {
300 if (!CRM_Mailing_BAO_Mailing
::processQueue()) {
301 return civicrm_api3_create_error('Process Queue failed');
305 return civicrm_api3_create_success($values, $params, 'Job', 'process_mailing');
312 * @param array $params
316 function civicrm_api3_job_process_sms($params) {
317 if (!CRM_Mailing_BAO_Mailing
::processQueue('sms')) {
318 return civicrm_api3_create_error('Process Queue failed');
322 return civicrm_api3_create_success($values, $params, 'Job', 'process_sms');
327 * Job to get mail responses from civiMailing.
329 * @param array $params
333 function civicrm_api3_job_fetch_bounces($params) {
334 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
335 if (!$lock->isAcquired()) {
336 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
338 if (!CRM_Utils_Mail_EmailProcessor
::processBounces()) {
340 return civicrm_api3_create_error('Process Bounces failed');
344 // FIXME: processBounces doesn't return true/false on success/failure
346 return civicrm_api3_create_success($values, $params, 'Job', 'fetch_bounces');
350 * Job to get mail and create activities.
352 * @param array $params
356 function civicrm_api3_job_fetch_activities($params) {
357 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
358 if (!$lock->isAcquired()) {
359 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
363 CRM_Utils_Mail_EmailProcessor
::processActivities();
366 return civicrm_api3_create_success($values, $params, 'Job', 'fetch_activities');
368 catch (Exception
$e) {
370 return civicrm_api3_create_error('Process Activities failed');
375 * Process participant statuses.
377 * @param array $params
381 * array of properties, if error an array with an error id and error message
383 function civicrm_api3_job_process_participant($params) {
384 $result = CRM_Event_BAO_ParticipantStatusType
::process($params);
386 if (!$result['is_error']) {
387 return civicrm_api3_create_success(implode("\r\r", $result['messages']));
390 return civicrm_api3_create_error('Error while processing participant statuses');
396 * This api checks and updates the status of all membership records for a given domain.
398 * The function uses the calc_membership_status and update_contact_membership APIs.
401 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
403 * @param array $params
404 * Input parameters NOT USED.
407 * true if success, else false
409 function civicrm_api3_job_process_membership($params) {
410 $lock = new CRM_Core_Lock('civimail.job.updateMembership');
411 if (!$lock->isAcquired()) {
412 return civicrm_api3_create_error('Could not acquire lock, another Membership Processing process is running');
415 $result = CRM_Member_BAO_Membership
::updateAllMembershipStatus();
418 if ($result['is_error'] == 0) {
419 return civicrm_api3_create_success($result['messages'], $params, 'Job', 'process_membership');
422 return civicrm_api3_create_error($result['messages']);
427 * This api checks and updates the status of all survey respondents.
429 * @param array $params
430 * (reference ) input parameters.
433 * true if success, else false
435 function civicrm_api3_job_process_respondent($params) {
436 $result = CRM_Campaign_BAO_Survey
::releaseRespondent($params);
438 if ($result['is_error'] == 0) {
439 return civicrm_api3_create_success();
442 return civicrm_api3_create_error($result['messages']);
447 * Merges given pair of duplicate contacts.
449 * @param array $params
455 function civicrm_api3_job_process_batch_merge($params) {
456 $rgid = CRM_Utils_Array
::value('rgid', $params);
457 $gid = CRM_Utils_Array
::value('gid', $params);
459 $mode = CRM_Utils_Array
::value('mode', $params, 'safe');
460 $autoFlip = CRM_Utils_Array
::value('auto_flip', $params, TRUE);
462 $result = CRM_Dedupe_Merger
::batchMerge($rgid, $gid, $mode, $autoFlip);
464 if ($result['is_error'] == 0) {
465 return civicrm_api3_create_success();
468 return civicrm_api3_create_error($result['messages']);
473 * Metadata for batch merge function.
477 function _civicrm_api3_job_process_batch_merge_spec(&$params) {
478 $params['rgid'] = array(
479 'title' => 'rule group id',
480 'type' => CRM_Utils_Type
::T_INT
,
482 $params['gid'] = array(
483 'title' => 'group id',
484 'type' => CRM_Utils_Type
::T_INT
,
486 $params['mode'] = array(
488 '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.',
489 'type' => CRM_Utils_Type
::T_STRING
,
491 $params['auto_flip'] = array(
492 'title' => 'Auto Flip',
493 'description' => 'let the api decide which contact to retain and which to delete?',
494 'type' => CRM_Utils_Type
::T_BOOLEAN
,
499 * Runs handlePaymentCron method in the specified payment processor.
501 * @param array $params
504 * Expected @params array keys are: INCORRECTLY DOCUMENTED AND SHOULD BE IN THE _spec function
505 * for retrieval via getfields.
506 * {string 'processor_name' - the name of the payment processor, eg: Sagepay}
508 function civicrm_api3_job_run_payment_cron($params) {
511 CRM_Core_Payment
::handlePaymentMethod(
522 CRM_Core_Payment
::handlePaymentMethod(
534 * This api cleans up all the old session entries and temp tables.
536 * We recommend that sites run this on an hourly basis.
538 * @param array $params
539 * Sends in various config parameters to decide what needs to be cleaned.
541 function civicrm_api3_job_cleanup($params) {
542 $session = CRM_Utils_Array
::value('session', $params, TRUE);
543 $tempTable = CRM_Utils_Array
::value('tempTables', $params, TRUE);
544 $jobLog = CRM_Utils_Array
::value('jobLog', $params, TRUE);
545 $prevNext = CRM_Utils_Array
::value('prevNext', $params, TRUE);
546 $dbCache = CRM_Utils_Array
::value('dbCache', $params, FALSE);
547 $memCache = CRM_Utils_Array
::value('memCache', $params, FALSE);
549 if ($session ||
$tempTable ||
$prevNext) {
550 CRM_Core_BAO_Cache
::cleanup($session, $tempTable, $prevNext);
554 CRM_Core_BAO_Job
::cleanup();
558 CRM_Core_Config
::clearDBCache();
562 CRM_Utils_System
::flushCache();
567 * Set expired relationships to disabled.
569 * @param array $params
572 * @throws \API_Exception
574 function civicrm_api3_job_disable_expired_relationships($params) {
575 $result = CRM_Contact_BAO_Relationship
::disableExpiredRelationships();
577 throw new API_Exception('Failed to disable all expired relationships.');
579 return civicrm_api3_create_success(1, $params, 'Job', 'disable_expired_relationships');
583 * This api reloads all the smart groups.
585 * If the org has a large number of smart groups it is recommended that they use the limit clause
586 * to limit the number of smart groups evaluated on a per job basis.
588 * Might also help to increase the smartGroupCacheTimeout and use the cache.
590 * @param array $params
593 * @throws \API_Exception
595 function civicrm_api3_job_group_rebuild($params) {
596 $lock = new CRM_Core_Lock('civimail.job.groupRebuild');
597 if (!$lock->isAcquired()) {
598 throw new API_Exception('Could not acquire lock, another EmailProcessor process is running');
601 $limit = CRM_Utils_Array
::value('limit', $params, 0);
603 CRM_Contact_BAO_GroupContactCache
::loadAll(NULL, $limit);
606 return civicrm_api3_create_success();