5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.5 |
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 * Include common API util functions
45 require_once 'api/v3/utils.php';
48 * Adjust metadata for "Create" action
50 * The metadata is used for setting defaults, documentation & validation
51 * @param array $params array or parameters determined by getfields
53 function _civicrm_api3_job_create_spec(&$params) {
54 $params['run_frequency']['api.required'] = 1;
55 $params['name']['api.required'] = 1;
56 $params['api_entity']['api.required'] = 1;
57 $params['api_action']['api.required'] = 1;
59 $params['domain_id']['api.default'] = CRM_Core_Config
::domainID();
60 $params['is_active']['api.default'] = 1;
64 * Function to create scheduled job
66 * @param array $params Associative array of property name/value pairs to insert in new job.
68 * @return success or error
69 * {@getfields Job_create}
71 * {@schema Core/Job.xml}
73 function civicrm_api3_job_create($params) {
74 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
78 * Retrieve one or more job
79 * @param array input parameters
80 * @return array api result array
81 * {@getfields email_get}
84 function civicrm_api3_job_get($params) {
85 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
93 * @return array API Result Array
94 * {@getfields Job_delete}
98 function civicrm_api3_job_delete($params) {
99 if ($params['id'] != NULL && !CRM_Utils_Rule
::integer($params['id'])) {
100 return civicrm_api3_create_error('Invalid value for job ID');
103 $result = CRM_Core_BAO_Job
::del($params['id']);
105 return civicrm_api3_create_error('Could not delete job');
107 return civicrm_api3_create_success($result, $params, 'job', 'delete');
111 * Dumb wrapper to execute scheduled jobs. Always creates success - errors
112 * and results are handled in the job log.
114 * @param array $params (reference ) input parameters
116 * @return array API Result Array
122 function civicrm_api3_job_execute($params) {
123 $facility = new CRM_Core_JobManager();
124 $facility->execute(FALSE);
126 // always creates success - results are handled elsewhere
127 return civicrm_api3_create_success();
131 * Adjust Metadata for Execute action
133 * @param array $params array or parameters determined by getfields
135 function _civicrm_api3_job_execute_spec(&$params) {
139 * Geocode group of contacts based on given params
141 * @param array $params (reference ) input parameters
143 * @return array API Result Array
144 * {@getfields contact_geocode}
151 function civicrm_api3_job_geocode($params) {
152 $gc = new CRM_Utils_Address_BatchUpdate($params);
155 $result = $gc->run();
157 if ($result['is_error'] == 0) {
158 return civicrm_api3_create_success($result['messages']);
161 return civicrm_api3_create_error($result['messages']);
165 * First check on Code documentation
167 function _civicrm_api3_job_geocode_spec(&$params) {
168 $params['start'] = array('title' => 'Start Date');
169 $params['end'] = array('title' => 'End Date');
170 $params['geocoding'] = array('title' => 'Geocode address?');
171 $params['parse'] = array('title' => 'Parse street address?');
172 $params['throttle'] = array('title' => 'Throttle? if enabled, geocodes at a slow rate');
176 * Send the scheduled reminders for all contacts (either for activities or events)
178 * @param array $params (reference ) input parameters
179 * now - the time to use, in YmdHis format
180 * - makes testing a bit simpler since we can simulate past/future time
182 * @return boolean true if success, else false
187 function civicrm_api3_job_send_reminder($params) {
188 //note that $params['rowCount' can be overridden by one of the preferred syntaxes ($options['limit'] = x
189 //It's not clear whether than syntax can be passed in via the UI config - but this keeps the pre 4.4.4 behaviour
190 // in that case (ie. makes it unconfigurable via the UI). Another approach would be to set a default of 0
191 // in the _spec function - but since that is a deprecated value it seems more contentious than this approach
192 $params['rowCount'] = 0;
193 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
194 if (!$lock->isAcquired()) {
195 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
198 $result = CRM_Core_BAO_ActionSchedule
::processQueue(CRM_Utils_Array
::value('now', $params), $params);
201 if ($result['is_error'] == 0) {
202 return civicrm_api3_create_success();
205 return civicrm_api3_create_error($result['messages']);
209 * Adjust metadata for "send_reminder" action
211 * The metadata is used for setting defaults, documentation & validation
212 * @param array $params array or parameters determined by getfields
214 function _civicrm_api3_job_send_reminder(&$params) {
215 //@todo this function will now take all fields in action_schedule as params
216 // as it is calling the api fn to set the filters - update getfields to reflect
217 $params['id'] = array(
218 'type' => CRM_Utils_Type
::T_INT
,
219 'title' => 'Action Schedule ID'
223 * Execute a specific report instance and send the output via email
225 * @param array $params (reference ) input parameters
226 * sendmail - Boolean - should email be sent?, required
227 * instanceId - Integer - the report instance ID
228 * resetVal - Integer - should we reset form state (always true)?
230 * @return boolean true if success, else false
235 function civicrm_api3_job_mail_report($params) {
236 $result = CRM_Report_Utils_Report
::processReport($params);
238 if ($result['is_error'] == 0) {
239 // this should be handling by throwing exceptions but can't remove until we can test that.
240 return civicrm_api3_create_success();
243 return civicrm_api3_create_error($result['messages']);
249 * This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.
250 * IMPORTANT: You must first create valid option value before using via admin interface.
251 * Check option lists for Email Greetings, Postal Greetings and Addressee
253 * id - Integer - greetings option group
255 * @return boolean true if success, else false
260 function civicrm_api3_job_update_greeting($params) {
262 if (isset($params['ct']) && isset($params['gt'])) {
264 $ct = explode(',', $params['ct']);
265 $gt = explode(',', $params['gt']);
266 foreach ($ct as $ctKey => $ctValue) {
267 foreach ($gt as $gtKey => $gtValue) {
268 $params['ct'] = trim($ctValue);
269 $params['gt'] = trim($gtValue);
270 $result[] = CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
275 $result = CRM_Contact_BAO_Contact_Utils
::updateGreeting($params);
278 foreach ($result as $resultKey => $resultValue) {
279 if ($resultValue['is_error'] == 0) {
280 //really we should rely on the exception mechanism here - but we need to test that before removing this line
281 return civicrm_api3_create_success();
284 return civicrm_api3_create_error($resultValue['messages']);
290 * Adjust Metadata for Get action
292 * The metadata is used for setting defaults, documentation & validation
293 * @param array $params 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 (reference ) input parameters
313 * @return boolean true if success, else false
318 function civicrm_api3_job_process_pledge($params) {
319 // *** Uncomment the next line if you want automated reminders to be sent
320 // $params['send_reminders'] = true;
321 $result = CRM_Pledge_BAO_Pledge
::updatePledgeStatus($params);
323 if ($result['is_error'] == 0) {
324 // experiment: detailed execution log is a result here
325 return civicrm_api3_create_success($result['messages']);
328 return civicrm_api3_create_error($result['error_message']);
335 * @param array $params
339 function civicrm_api3_job_process_mailing($params) {
341 if (!CRM_Mailing_BAO_Mailing
::processQueue()) {
342 return civicrm_api3_create_error('Process Queue failed');
346 return civicrm_api3_create_success($values, $params, 'mailing', 'process');
353 * @param array $params
357 function civicrm_api3_job_process_sms($params) {
358 if (!CRM_Mailing_BAO_Mailing
::processQueue('sms')) {
359 return civicrm_api3_create_error('Process Queue failed');
363 return civicrm_api3_create_success($values, $params, 'mailing', 'process');
368 * Job to get mail responses from civimailing
370 function civicrm_api3_job_fetch_bounces($params) {
371 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
372 if (!$lock->isAcquired()) {
373 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
375 if (!CRM_Utils_Mail_EmailProcessor
::processBounces()) {
377 return civicrm_api3_create_error('Process Bounces failed');
381 // FIXME: processBounces doesn't return true/false on success/failure
383 return civicrm_api3_create_success($values, $params, 'mailing', 'bounces');
387 * Job to get mail and create activities
389 function civicrm_api3_job_fetch_activities($params) {
390 $lock = new CRM_Core_Lock('civimail.job.EmailProcessor');
391 if (!$lock->isAcquired()) {
392 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
396 CRM_Utils_Mail_EmailProcessor
::processActivities();
399 return civicrm_api3_create_success($values, $params,'mailing','activities');
400 } catch (Exception
$e) {
402 return civicrm_api3_create_error('Process Activities failed');
407 * Process participant statuses
409 * @param array $params (reference ) input parameters
411 * @return array (reference ) 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 using the calc_membership_status and
428 * update_contact_membership APIs.
431 * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
433 * @param array $params input parameters NOT USED
435 * @return boolean true if success, else false
439 function civicrm_api3_job_process_membership($params) {
440 $lock = new CRM_Core_Lock('civimail.job.updateMembership');
441 if (!$lock->isAcquired()) {
442 return civicrm_api3_create_error('Could not acquire lock, another Membership Processing process is running');
445 $result = CRM_Member_BAO_Membership
::updateAllMembershipStatus();
448 if ($result['is_error'] == 0) {
449 return civicrm_api3_create_success($result['messages']);
452 return civicrm_api3_create_error($result['messages']);
457 * This api checks and updates the status of all survey respondants.
459 * @param array $params (reference ) input parameters
461 * @return boolean true if success, else false
465 function civicrm_api3_job_process_respondent($params) {
466 $result = CRM_Campaign_BAO_Survey
::releaseRespondent($params);
468 if ($result['is_error'] == 0) {
469 return civicrm_api3_create_success();
472 return civicrm_api3_create_error($result['messages']);
477 * Merges given pair of duplicate contacts.
479 * @param array $params input parameters
481 * Allowed @params array keys are:
482 * {int $rgid rule group id}
483 * {int $gid group id}
484 * {string mode helps decide how to behave when there are conflicts.
485 * A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.}
486 * {boolean auto_flip wether to let api decide which contact to retain and which to delete.}
488 * @return array API Result Array
493 function civicrm_api3_job_process_batch_merge($params) {
494 $rgid = CRM_Utils_Array
::value('rgid', $params);
495 $gid = CRM_Utils_Array
::value('gid', $params);
497 $mode = CRM_Utils_Array
::value('mode', $params, 'safe');
498 $autoFlip = CRM_Utils_Array
::value('auto_flip', $params, TRUE);
500 $result = CRM_Dedupe_Merger
::batchMerge($rgid, $gid, $mode, $autoFlip);
502 if ($result['is_error'] == 0) {
503 return civicrm_api3_create_success();
506 return civicrm_api3_create_error($result['messages']);
511 * Runs handlePaymentCron method in the specified payment processor
513 * @param array $params input parameters
515 * Expected @params array keys are:
516 * {string 'processor_name' - the name of the payment processor, eg: Sagepay}
520 function civicrm_api3_job_run_payment_cron($params) {
523 CRM_Core_Payment
::handlePaymentMethod(
534 CRM_Core_Payment
::handlePaymentMethod(
546 * This api cleans up all the old session entries and temp tables. We recommend that sites run this on an hourly basis
548 * @param array $params (reference ) - sends in various config parameters to decide what needs to be cleaned
550 * @return boolean true if success, else false
554 function civicrm_api3_job_cleanup( $params ) {
555 $session = CRM_Utils_Array
::value( 'session' , $params, true );
556 $tempTable = CRM_Utils_Array
::value( 'tempTables', $params, true );
557 $jobLog = CRM_Utils_Array
::value( 'jobLog' , $params, true );
558 $prevNext = CRM_Utils_Array
::value( 'prevNext' , $params, true );
559 $dbCache = CRM_Utils_Array
::value( 'dbCache' , $params, false );
560 $memCache = CRM_Utils_Array
::value( 'memCache' , $params, false );
562 if ( $session ||
$tempTable ||
$prevNext ) {
563 CRM_Core_BAO_Cache
::cleanup( $session, $tempTable, $prevNext );
567 CRM_Core_BAO_Job
::cleanup( );
571 CRM_Core_Config
::clearDBCache( );
575 CRM_Utils_System
::flushCache( );
580 * Set expired relationships to disabled.
583 function civicrm_api3_job_disable_expired_relationships($params) {
584 $result = CRM_Contact_BAO_Relationship
::disableExpiredRelationships();
586 return civicrm_api3_create_success();
589 return civicrm_api3_create_error('Failed to disable all expired relationships.');
594 * This api reloads all the smart groups. If the org has a large number of smart groups
595 * it is recommended that they use the limit clause to limit the number of smart groups
596 * evaluated on a per job basis. Might also help to increase the smartGroupCacheTimeout
599 function civicrm_api3_job_group_rebuild( $params ) {
600 $lock = new CRM_Core_Lock('civimail.job.groupRebuild');
601 if (!$lock->isAcquired()) {
602 return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running');
605 $limit = CRM_Utils_Array
::value( 'limit', $params, 0 );
607 CRM_Contact_BAO_GroupContactCache
::loadAll(null, $limit);
610 return civicrm_api3_create_success();