5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.6 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2014 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * new version of civicrm apis. See blog post at
32 * http://civicrm.org/node/131
35 * @package CiviCRM_APIv3
37 * @copyright CiviCRM LLC (c) 2004-2014
38 * $Id: Contact.php 30879 2010-11-22 15:45:55Z shot $
43 * Adjust metadata for "Create" action
45 * The metadata is used for setting defaults, documentation & validation
46 * @param array $params
47 * Array or parameters determined by getfields.
49 function _civicrm_api3_job_create_spec(&$params) {
50 $params['run_frequency']['api.required'] = 1;
51 $params['name']['api.required'] = 1;
52 $params['api_entity']['api.required'] = 1;
53 $params['api_action']['api.required'] = 1;
55 $params['domain_id']['api.default'] = CRM_Core_Config
::domainID();
56 $params['is_active']['api.default'] = 1;
60 * create scheduled job
62 * @param array $params
63 * Associative array of property name/value pairs to insert in new job.
65 * @return success or error
66 * {@getfields Job_create}
68 * {@schema Core/Job.xml}
70 function civicrm_api3_job_create($params) {
71 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
75 * Retrieve one or more job
76 * @param array input parameters
77 * @return array api result array
78 * {@getfields email_get}
81 function civicrm_api3_job_get($params) {
82 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
88 * @param array $params
90 * @return array API Result Array
91 * {@getfields Job_delete}
95 function civicrm_api3_job_delete($params) {
96 _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
100 * Dumb wrapper to execute scheduled jobs. Always creates success - errors
101 * and results are handled in the job log.
103 * @param array $params
104 * (reference ) input parameters.
106 * @return array API Result Array
112 function civicrm_api3_job_execute($params) {
113 $facility = new CRM_Core_JobManager();
114 $facility->execute(FALSE);
116 // always creates success - results are handled elsewhere
117 return civicrm_api3_create_success();
121 * Adjust Metadata for Execute action
123 * @param array $params
124 * Array or parameters determined by getfields.
126 function _civicrm_api3_job_execute_spec(&$params) {
130 * Geocode group of contacts based on given params
132 * @param array $params
133 * (reference ) input parameters.
135 * @return array API Result Array
136 * {@getfields contact_geocode}
143 function civicrm_api3_job_geocode($params) {
144 $gc = new CRM_Utils_Address_BatchUpdate($params);
147 $result = $gc->run();
149 if ($result['is_error'] == 0) {
150 return civicrm_api3_create_success($result['messages']);
153 return civicrm_api3_create_error($result['messages']);
158 * First check on Code documentation
160 * @param array $params
162 function _civicrm_api3_job_geocode_spec(&$params) {
163 $params['start'] = array('title' => 'Start Date');
164 $params['end'] = array('title' => 'End Date');
165 $params['geocoding'] = array('title' => 'Geocode address?');
166 $params['parse'] = array('title' => 'Parse street address?');
167 $params['throttle'] = array('title' => 'Throttle? if enabled, geocodes at a slow rate');
171 * Send the scheduled reminders for all contacts (either for activities or events)
173 * @param array $params
174 * (reference ) input parameters.
175 * now - the time to use, in YmdHis format
176 * - makes testing a bit simpler since we can simulate past/future time
178 * @return boolean true if success, else false
183 function civicrm_api3_job_send_reminder($params) {
184 //note that $params['rowCount' can be overridden by one of the preferred syntaxes ($options['limit'] = x
185 //It's not clear whether than syntax can be passed in via the UI config - but this keeps the pre 4.4.4 behaviour
186 // in that case (ie. makes it unconfigurable via the UI). Another approach would be to set a default of 0
187 // in the _spec function - but since that is a deprecated value it seems more contentious than this approach
188 $params['rowCount'] = 0;
189 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
190 if (!$lock->isAcquired()) {
191 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
194 $result = CRM_Core_BAO_ActionSchedule
::processQueue(CRM_Utils_Array
::value('now', $params), $params);
197 if ($result['is_error'] == 0) {
198 return civicrm_api3_create_success();
201 return civicrm_api3_create_error($result['messages']);
205 * Adjust metadata for "send_reminder" action
207 * The metadata is used for setting defaults, documentation & validation
208 * @param array $params
209 * Array or parameters determined by getfields.
211 function _civicrm_api3_job_send_reminder(&$params) {
212 //@todo this function will now take all fields in action_schedule as params
213 // as it is calling the api fn to set the filters - update getfields to reflect
214 $params['id'] = array(
215 'type' => CRM_Utils_Type
::T_INT
,
216 'title' => 'Action Schedule ID',
220 * Execute a specific report instance and send the output via email
222 * @param array $params
223 * (reference ) input parameters.
224 * sendmail - Boolean - should email be sent?, required
225 * instanceId - Integer - the report instance ID
226 * resetVal - Integer - should we reset form state (always true)?
228 * @return boolean true if success, else false
233 function civicrm_api3_job_mail_report($params) {
234 $result = CRM_Report_Utils_Report
::processReport($params);
236 if ($result['is_error'] == 0) {
237 // this should be handling by throwing exceptions but can't remove until we can test that.
238 return civicrm_api3_create_success();
241 return civicrm_api3_create_error($result['messages']);
247 * This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.
248 * IMPORTANT: You must first create valid option value before using via admin interface.
249 * Check option lists for Email Greetings, Postal Greetings and Addressee
251 * id - Integer - greetings option group
253 * @param array $params
255 * @return boolean true if success, else false
259 function civicrm_api3_job_update_greeting($params) {
261 if (isset($params['ct']) && isset($params['gt'])) {
263 $ct = explode(',', $params['ct']);
264 $gt = explode(',', $params['gt']);
265 foreach ($ct as $ctKey => $ctValue) {
266 foreach ($gt as $gtKey => $gtValue) {
267 $params['ct'] = trim($ctValue);
268 $params['gt'] = trim($gtValue);
269 $result[] = CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
274 $result = CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
277 foreach ($result as $resultKey => $resultValue) {
278 if ($resultValue['is_error'] == 0) {
279 //really we should rely on the exception mechanism here - but we need to test that before removing this line
280 return civicrm_api3_create_success();
283 return civicrm_api3_create_error($resultValue['messages']);
289 * Adjust Metadata for Get action
291 * The metadata is used for setting defaults, documentation & validation
292 * @param array $params
293 * Array or parameters determined by getfields.
295 function _civicrm_api3_job_update_greeting_spec(&$params) {
296 $params['ct'] = array(
298 'title' => 'Contact Type',
299 'type' => CRM_Utils_Type
::T_STRING
,
301 $params['gt'] = array(
303 'title' => 'Greeting Type',
304 'type' => CRM_Utils_Type
::T_STRING
,
309 * Mass update pledge statuses
311 * @param array $params
312 * (reference ) input parameters.
314 * @return boolean true if success, else false
319 function civicrm_api3_job_process_pledge($params) {
320 // *** Uncomment the next line if you want automated reminders to be sent
321 // $params['send_reminders'] = true;
322 $result = CRM_Pledge_BAO_Pledge
::updatePledgeStatus($params);
324 if ($result['is_error'] == 0) {
325 // experiment: detailed execution log is a result here
326 return civicrm_api3_create_success($result['messages']);
329 return civicrm_api3_create_error($result['error_message']);
336 * @param array $params
340 function civicrm_api3_job_process_mailing($params) {
342 if (!CRM_Mailing_BAO_Mailing
::processQueue()) {
343 return civicrm_api3_create_error('Process Queue failed');
347 return civicrm_api3_create_success($values, $params, 'mailing', 'process');
354 * @param array $params
358 function civicrm_api3_job_process_sms($params) {
359 if (!CRM_Mailing_BAO_Mailing
::processQueue('sms')) {
360 return civicrm_api3_create_error('Process Queue failed');
364 return civicrm_api3_create_success($values, $params, 'mailing', 'process');
369 * Job to get mail responses from civimailing
371 * @param array $params
375 function civicrm_api3_job_fetch_bounces($params) {
376 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
377 if (!$lock->isAcquired()) {
378 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
380 if (!CRM_Utils_Mail_EmailProcessor
::processBounces()) {
382 return civicrm_api3_create_error('Process Bounces failed');
386 // FIXME: processBounces doesn't return true/false on success/failure
388 return civicrm_api3_create_success($values, $params, 'mailing', 'bounces');
392 * Job to get mail and create activities
394 * @param array $params
398 function civicrm_api3_job_fetch_activities($params) {
399 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
400 if (!$lock->isAcquired()) {
401 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
405 CRM_Utils_Mail_EmailProcessor
::processActivities();
408 return civicrm_api3_create_success($values, $params,'mailing','activities');
410 catch (Exception
$e) {
412 return civicrm_api3_create_error('Process Activities failed');
417 * Process participant statuses
419 * @param array $params
420 * (reference ) input parameters.
422 * @return array (reference ) array of properties, if error an array with an error id and error message
425 function civicrm_api3_job_process_participant($params) {
426 $result = CRM_Event_BAO_ParticipantStatusType
::process($params);
428 if (!$result['is_error']) {
429 return civicrm_api3_create_success(implode("\r\r", $result['messages']));
432 return civicrm_api3_create_error('Error while processing participant statuses');
438 * This api checks and updates the status of all membership records for a given domain using the calc_membership_status and
439 * update_contact_membership APIs.
442 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
444 * @param array $params
445 * Input parameters NOT USED.
447 * @return boolean true if success, else false
451 function civicrm_api3_job_process_membership($params) {
452 $lock = new CRM_Core_Lock('civimail.job.updateMembership');
453 if (!$lock->isAcquired()) {
454 return civicrm_api3_create_error('Could not acquire lock, another Membership Processing process is running');
457 $result = CRM_Member_BAO_Membership
::updateAllMembershipStatus();
460 if ($result['is_error'] == 0) {
461 return civicrm_api3_create_success($result['messages']);
464 return civicrm_api3_create_error($result['messages']);
469 * This api checks and updates the status of all survey respondants.
471 * @param array $params
472 * (reference ) input parameters.
474 * @return boolean true if success, else false
478 function civicrm_api3_job_process_respondent($params) {
479 $result = CRM_Campaign_BAO_Survey
::releaseRespondent($params);
481 if ($result['is_error'] == 0) {
482 return civicrm_api3_create_success();
485 return civicrm_api3_create_error($result['messages']);
490 * Merges given pair of duplicate contacts.
492 * @param array $params
495 * Allowed @params array keys are:
496 * {int $rgid rule group id}
497 * {int $gid group id}
498 * {string mode helps decide how to behave when there are conflicts.
499 * A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.}
500 * {boolean auto_flip wether to let api decide which contact to retain and which to delete.}
502 * @return array API Result Array
507 function civicrm_api3_job_process_batch_merge($params) {
508 $rgid = CRM_Utils_Array
::value('rgid', $params);
509 $gid = CRM_Utils_Array
::value('gid', $params);
511 $mode = CRM_Utils_Array
::value('mode', $params, 'safe');
512 $autoFlip = CRM_Utils_Array
::value('auto_flip', $params, TRUE);
514 $result = CRM_Dedupe_Merger
::batchMerge($rgid, $gid, $mode, $autoFlip);
516 if ($result['is_error'] == 0) {
517 return civicrm_api3_create_success();
520 return civicrm_api3_create_error($result['messages']);
525 * Runs handlePaymentCron method in the specified payment processor
527 * @param array $params
530 * Expected @params array keys are:
531 * {string 'processor_name' - the name of the payment processor, eg: Sagepay}
535 function civicrm_api3_job_run_payment_cron($params) {
538 CRM_Core_Payment
::handlePaymentMethod(
549 CRM_Core_Payment
::handlePaymentMethod(
561 * This api cleans up all the old session entries and temp tables. We recommend that sites run this on an hourly basis
563 * @param array $params
564 * (reference ) - sends in various config parameters to decide what needs to be cleaned.
566 * @return boolean true if success, else false
570 function civicrm_api3_job_cleanup($params) {
571 $session = CRM_Utils_Array
::value('session', $params, true );
572 $tempTable = CRM_Utils_Array
::value('tempTables', $params, true );
573 $jobLog = CRM_Utils_Array
::value('jobLog', $params, true );
574 $prevNext = CRM_Utils_Array
::value('prevNext', $params, true );
575 $dbCache = CRM_Utils_Array
::value('dbCache', $params, false);
576 $memCache = CRM_Utils_Array
::value('memCache', $params, false);
578 if ($session ||
$tempTable ||
$prevNext) {
579 CRM_Core_BAO_Cache
::cleanup($session, $tempTable, $prevNext);
583 CRM_Core_BAO_Job
::cleanup();
587 CRM_Core_Config
::clearDBCache();
591 CRM_Utils_System
::flushCache();
596 * Set expired relationships to disabled.
598 * @param array $params
602 function civicrm_api3_job_disable_expired_relationships($params) {
603 $result = CRM_Contact_BAO_Relationship
::disableExpiredRelationships();
605 return civicrm_api3_create_success();
608 return civicrm_api3_create_error('Failed to disable all expired relationships.');
613 * This api reloads all the smart groups. If the org has a large number of smart groups
614 * it is recommended that they use the limit clause to limit the number of smart groups
615 * evaluated on a per job basis. Might also help to increase the smartGroupCacheTimeout
618 * @param array $params
622 function civicrm_api3_job_group_rebuild($params) {
623 $lock = new CRM_Core_Lock('civimail.job.groupRebuild');
624 if (!$lock->isAcquired()) {
625 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
628 $limit = CRM_Utils_Array
::value('limit', $params, 0);
630 CRM_Contact_BAO_GroupContactCache
::loadAll(null, $limit);
633 return civicrm_api3_create_success();