Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
244bbdd8 | 29 | * This api is used for working with scheduled "cron" jobs. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
c1a920f1 EM |
35 | * Adjust metadata for "Create" action. |
36 | * | |
37 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 38 | * |
cf470720 | 39 | * @param array $params |
b081365f | 40 | * Array of parameters determined by getfields. |
6a488035 TO |
41 | */ |
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; | |
47 | ||
48 | $params['domain_id']['api.default'] = CRM_Core_Config::domainID(); | |
49 | $params['is_active']['api.default'] = 1; | |
50 | } | |
51 | ||
52 | /** | |
c1a920f1 | 53 | * Create scheduled job. |
6a488035 | 54 | * |
cf470720 TO |
55 | * @param array $params |
56 | * Associative array of property name/value pairs to insert in new job. | |
6a488035 | 57 | * |
72b3a70c | 58 | * @return array |
6a488035 TO |
59 | */ |
60 | function civicrm_api3_job_create($params) { | |
a25b46e9 | 61 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Job'); |
6a488035 TO |
62 | } |
63 | ||
7a6059c2 MW |
64 | /** |
65 | * Adjust metadata for clone spec action. | |
66 | * | |
67 | * @param array $spec | |
68 | */ | |
69 | function _civicrm_api3_job_clone_spec(&$spec) { | |
70 | $spec['id']['title'] = 'Job ID to clone'; | |
71 | $spec['id']['type'] = CRM_Utils_Type::T_INT; | |
72 | $spec['id']['api.required'] = 1; | |
73 | $spec['is_active']['title'] = 'Job is Active?'; | |
74 | $spec['is_active']['type'] = CRM_Utils_Type::T_BOOLEAN; | |
75 | $spec['is_active']['api.required'] = 0; | |
76 | } | |
77 | ||
78 | /** | |
79 | * Clone Job. | |
80 | * | |
81 | * @param array $params | |
82 | * | |
83 | * @return array | |
84 | * @throws \API_Exception | |
85 | * @throws \CiviCRM_API3_Exception | |
86 | */ | |
87 | function civicrm_api3_job_clone($params) { | |
88 | if (empty($params['id'])) { | |
89 | throw new API_Exception("Mandatory key(s) missing from params array: id field is required"); | |
90 | } | |
91 | $id = $params['id']; | |
92 | unset($params['id']); | |
93 | $params['last_run'] = 'null'; | |
94 | $params['scheduled_run_date'] = 'null'; | |
95 | $newJobDAO = CRM_Core_BAO_Job::copy($id, $params); | |
96 | return civicrm_api3('Job', 'get', array('id' => $newJobDAO->id)); | |
97 | } | |
98 | ||
6a488035 | 99 | /** |
211e2fca | 100 | * Retrieve one or more job. |
971d41b1 CW |
101 | * |
102 | * @param array $params | |
103 | * input parameters | |
971d41b1 | 104 | * |
211e2fca | 105 | * @return array |
6a488035 TO |
106 | */ |
107 | function civicrm_api3_job_get($params) { | |
108 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
109 | } | |
110 | ||
111 | /** | |
211e2fca | 112 | * Delete a job. |
6a488035 | 113 | * |
9657ccf2 | 114 | * @param array $params |
6a488035 TO |
115 | */ |
116 | function civicrm_api3_job_delete($params) { | |
61ef23bd | 117 | _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 TO |
118 | } |
119 | ||
120 | /** | |
211e2fca EM |
121 | * Dumb wrapper to execute scheduled jobs. |
122 | * | |
123 | * Always creates success - errors and results are handled in the job log. | |
6a488035 | 124 | * |
cf470720 | 125 | * @param array $params |
971d41b1 | 126 | * input parameters (unused). |
6a488035 | 127 | * |
a6c01b45 | 128 | * @return array |
72b3a70c | 129 | * API Result Array |
6a488035 | 130 | */ |
608e6658 | 131 | function civicrm_api3_job_execute($params) { |
608e6658 | 132 | |
6a488035 TO |
133 | $facility = new CRM_Core_JobManager(); |
134 | $facility->execute(FALSE); | |
135 | ||
61fe4988 | 136 | // Always creates success - results are handled elsewhere. |
244bbdd8 | 137 | return civicrm_api3_create_success(1, $params, 'Job'); |
6a488035 TO |
138 | } |
139 | ||
140 | /** | |
211e2fca | 141 | * Adjust Metadata for Execute action. |
6a488035 | 142 | * |
cf470720 | 143 | * @param array $params |
b081365f | 144 | * Array of parameters determined by getfields. |
6a488035 TO |
145 | */ |
146 | function _civicrm_api3_job_execute_spec(&$params) { | |
147 | } | |
148 | ||
149 | /** | |
211e2fca | 150 | * Geocode group of contacts based on given params. |
6a488035 | 151 | * |
cf470720 | 152 | * @param array $params |
971d41b1 | 153 | * input parameters. |
6a488035 | 154 | * |
a6c01b45 | 155 | * @return array |
72b3a70c | 156 | * API Result Array |
6a488035 TO |
157 | */ |
158 | function civicrm_api3_job_geocode($params) { | |
6a488035 TO |
159 | $gc = new CRM_Utils_Address_BatchUpdate($params); |
160 | ||
6a488035 TO |
161 | $result = $gc->run(); |
162 | ||
163 | if ($result['is_error'] == 0) { | |
164 | return civicrm_api3_create_success($result['messages']); | |
165 | } | |
166 | else { | |
167 | return civicrm_api3_create_error($result['messages']); | |
168 | } | |
169 | } | |
9657ccf2 | 170 | |
6a488035 | 171 | /** |
c1a920f1 | 172 | * First check on Code documentation. |
9657ccf2 EM |
173 | * |
174 | * @param array $params | |
6a488035 TO |
175 | */ |
176 | function _civicrm_api3_job_geocode_spec(&$params) { | |
d142432b | 177 | $params['start'] = array( |
8ebf8a02 DG |
178 | 'title' => 'Starting Contact ID', |
179 | 'type' => CRM_Utils_Type::T_INT, | |
d142432b EM |
180 | ); |
181 | $params['end'] = array( | |
8ebf8a02 DG |
182 | 'title' => 'Ending Contact ID', |
183 | 'type' => CRM_Utils_Type::T_INT, | |
d142432b EM |
184 | ); |
185 | $params['geocoding'] = array( | |
186 | 'title' => 'Geocode address?', | |
187 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
188 | ); | |
189 | $params['parse'] = array( | |
190 | 'title' => 'Parse street address?', | |
191 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
192 | ); | |
b2ed8e73 CW |
193 | $params['throttle'] = array( |
194 | 'title' => 'Throttle?', | |
d142432b EM |
195 | 'description' => 'If enabled, geo-codes at a slow rate', |
196 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
b2ed8e73 | 197 | ); |
6a488035 TO |
198 | } |
199 | ||
200 | /** | |
c1a920f1 | 201 | * Send the scheduled reminders for all contacts (either for activities or events). |
6a488035 | 202 | * |
cf470720 TO |
203 | * @param array $params |
204 | * (reference ) input parameters. | |
6a488035 TO |
205 | * now - the time to use, in YmdHis format |
206 | * - makes testing a bit simpler since we can simulate past/future time | |
207 | * | |
c23f45d3 | 208 | * @return array |
6a488035 TO |
209 | */ |
210 | function civicrm_api3_job_send_reminder($params) { | |
e27a3472 EM |
211 | //note that $params['rowCount' can be overridden by one of the preferred syntaxes ($options['limit'] = x |
212 | //It's not clear whether than syntax can be passed in via the UI config - but this keeps the pre 4.4.4 behaviour | |
c23f45d3 | 213 | // in that case (ie. makes it non-configurable via the UI). Another approach would be to set a default of 0 |
e27a3472 EM |
214 | // in the _spec function - but since that is a deprecated value it seems more contentious than this approach |
215 | $params['rowCount'] = 0; | |
83617886 | 216 | $lock = Civi::lockManager()->acquire('worker.core.ActionSchedule'); |
39fefc30 | 217 | if (!$lock->isAcquired()) { |
33c5988b | 218 | return civicrm_api3_create_error('Could not acquire lock, another ActionSchedule process is running'); |
39fefc30 KJ |
219 | } |
220 | ||
73f3e293 | 221 | $result = CRM_Core_BAO_ActionSchedule::processQueue(CRM_Utils_Array::value('now', $params), $params); |
39fefc30 | 222 | $lock->release(); |
6a488035 TO |
223 | |
224 | if ($result['is_error'] == 0) { | |
225 | return civicrm_api3_create_success(); | |
226 | } | |
227 | else { | |
228 | return civicrm_api3_create_error($result['messages']); | |
229 | } | |
230 | } | |
73f3e293 | 231 | /** |
c1a920f1 EM |
232 | * Adjust metadata for "send_reminder" action. |
233 | * | |
234 | * The metadata is used for setting defaults, documentation & validation. | |
73f3e293 | 235 | * |
cf470720 | 236 | * @param array $params |
b081365f | 237 | * Array of parameters determined by getfields. |
73f3e293 E |
238 | */ |
239 | function _civicrm_api3_job_send_reminder(&$params) { | |
240 | //@todo this function will now take all fields in action_schedule as params | |
241 | // as it is calling the api fn to set the filters - update getfields to reflect | |
242 | $params['id'] = array( | |
243 | 'type' => CRM_Utils_Type::T_INT, | |
21dfd5f5 | 244 | 'title' => 'Action Schedule ID', |
73f3e293 E |
245 | ); |
246 | } | |
6a488035 | 247 | /** |
c1a920f1 | 248 | * Execute a specific report instance and send the output via email. |
6a488035 | 249 | * |
cf470720 TO |
250 | * @param array $params |
251 | * (reference ) input parameters. | |
6a488035 TO |
252 | * sendmail - Boolean - should email be sent?, required |
253 | * instanceId - Integer - the report instance ID | |
254 | * resetVal - Integer - should we reset form state (always true)? | |
255 | * | |
c23f45d3 | 256 | * @return array |
6a488035 TO |
257 | */ |
258 | function civicrm_api3_job_mail_report($params) { | |
6a488035 TO |
259 | $result = CRM_Report_Utils_Report::processReport($params); |
260 | ||
261 | if ($result['is_error'] == 0) { | |
262 | // this should be handling by throwing exceptions but can't remove until we can test that. | |
263 | return civicrm_api3_create_success(); | |
264 | } | |
265 | else { | |
266 | return civicrm_api3_create_error($result['messages']); | |
267 | } | |
268 | } | |
269 | ||
270 | /** | |
6a488035 | 271 | * This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type. |
211e2fca | 272 | * |
6a488035 TO |
273 | * IMPORTANT: You must first create valid option value before using via admin interface. |
274 | * Check option lists for Email Greetings, Postal Greetings and Addressee | |
275 | * | |
211e2fca | 276 | * @todo - is this here by mistake or should it be added to _spec function :id - Integer - greetings option group. |
6a488035 | 277 | * |
9657ccf2 | 278 | * @param array $params |
77b97be7 | 279 | * |
3f83a242 | 280 | * @return array |
6a488035 TO |
281 | */ |
282 | function civicrm_api3_job_update_greeting($params) { | |
6a488035 | 283 | if (isset($params['ct']) && isset($params['gt'])) { |
6a488035 TO |
284 | $ct = explode(',', $params['ct']); |
285 | $gt = explode(',', $params['gt']); | |
286 | foreach ($ct as $ctKey => $ctValue) { | |
287 | foreach ($gt as $gtKey => $gtValue) { | |
288 | $params['ct'] = trim($ctValue); | |
289 | $params['gt'] = trim($gtValue); | |
3f83a242 | 290 | CRM_Contact_BAO_Contact_Utils::updateGreeting($params); |
6a488035 TO |
291 | } |
292 | } | |
293 | } | |
294 | else { | |
3f83a242 | 295 | CRM_Contact_BAO_Contact_Utils::updateGreeting($params); |
6a488035 | 296 | } |
3f83a242 | 297 | return civicrm_api3_create_success(); |
6a488035 TO |
298 | } |
299 | ||
300 | /** | |
211e2fca | 301 | * Adjust Metadata for Get action. |
72b3a70c | 302 | * |
c1a920f1 EM |
303 | * The metadata is used for setting defaults, documentation & validation. |
304 | * | |
72b3a70c | 305 | * @param array $params |
b081365f | 306 | * Array of parameters determined by getfields. |
72b3a70c | 307 | */ |
6a488035 TO |
308 | function _civicrm_api3_job_update_greeting_spec(&$params) { |
309 | $params['ct'] = array( | |
310 | 'api.required' => 1, | |
311 | 'title' => 'Contact Type', | |
312 | 'type' => CRM_Utils_Type::T_STRING, | |
313 | ); | |
314 | $params['gt'] = array( | |
971d41b1 CW |
315 | 'api.required' => 1, |
316 | 'title' => 'Greeting Type', | |
317 | 'type' => CRM_Utils_Type::T_STRING, | |
6a488035 TO |
318 | ); |
319 | } | |
320 | ||
321 | /** | |
c1a920f1 | 322 | * Mass update pledge statuses. |
6a488035 | 323 | * |
cf470720 | 324 | * @param array $params |
c1a920f1 | 325 | * |
c23f45d3 | 326 | * @return array |
6a488035 TO |
327 | */ |
328 | function civicrm_api3_job_process_pledge($params) { | |
329 | // *** Uncomment the next line if you want automated reminders to be sent | |
330 | // $params['send_reminders'] = true; | |
331 | $result = CRM_Pledge_BAO_Pledge::updatePledgeStatus($params); | |
332 | ||
333 | if ($result['is_error'] == 0) { | |
334 | // experiment: detailed execution log is a result here | |
335 | return civicrm_api3_create_success($result['messages']); | |
336 | } | |
337 | else { | |
338 | return civicrm_api3_create_error($result['error_message']); | |
339 | } | |
340 | } | |
341 | ||
342 | /** | |
c1a920f1 | 343 | * Process mail queue. |
6a488035 TO |
344 | * |
345 | * @param array $params | |
346 | * | |
347 | * @return array | |
348 | */ | |
349 | function civicrm_api3_job_process_mailing($params) { | |
ec782609 | 350 | $mailsProcessedOrig = CRM_Mailing_BAO_MailingJob::$mailsProcessed; |
6a488035 | 351 | |
03c5ceba | 352 | try { |
353 | CRM_Core_BAO_Setting::isAPIJobAllowedToRun($params); | |
354 | } | |
355 | catch (Exception $e) { | |
356 | return civicrm_api3_create_error($e->getMessage()); | |
357 | } | |
358 | ||
6a488035 TO |
359 | if (!CRM_Mailing_BAO_Mailing::processQueue()) { |
360 | return civicrm_api3_create_error('Process Queue failed'); | |
361 | } | |
362 | else { | |
ec782609 TO |
363 | $values = array( |
364 | 'processed' => CRM_Mailing_BAO_MailingJob::$mailsProcessed - $mailsProcessedOrig, | |
365 | ); | |
244bbdd8 | 366 | return civicrm_api3_create_success($values, $params, 'Job', 'process_mailing'); |
6a488035 TO |
367 | } |
368 | } | |
369 | ||
370 | /** | |
cd5823ae | 371 | * Process sms queue. |
6a488035 TO |
372 | * |
373 | * @param array $params | |
374 | * | |
375 | * @return array | |
376 | */ | |
377 | function civicrm_api3_job_process_sms($params) { | |
ec782609 TO |
378 | $mailsProcessedOrig = CRM_Mailing_BAO_MailingJob::$mailsProcessed; |
379 | ||
6a488035 TO |
380 | if (!CRM_Mailing_BAO_Mailing::processQueue('sms')) { |
381 | return civicrm_api3_create_error('Process Queue failed'); | |
382 | } | |
383 | else { | |
ec782609 TO |
384 | $values = array( |
385 | 'processed' => CRM_Mailing_BAO_MailingJob::$mailsProcessed - $mailsProcessedOrig, | |
386 | ); | |
244bbdd8 | 387 | return civicrm_api3_create_success($values, $params, 'Job', 'process_sms'); |
6a488035 TO |
388 | } |
389 | } | |
39fefc30 | 390 | |
6a488035 | 391 | /** |
c1a920f1 | 392 | * Job to get mail responses from civiMailing. |
9657ccf2 EM |
393 | * |
394 | * @param array $params | |
395 | * | |
396 | * @return array | |
6a488035 TO |
397 | */ |
398 | function civicrm_api3_job_fetch_bounces($params) { | |
83617886 | 399 | $lock = Civi::lockManager()->acquire('worker.mailing.EmailProcessor'); |
6a488035 TO |
400 | if (!$lock->isAcquired()) { |
401 | return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running'); | |
402 | } | |
3ff238ae | 403 | CRM_Utils_Mail_EmailProcessor::processBounces($params['is_create_activities']); |
6a488035 | 404 | $lock->release(); |
39fefc30 | 405 | |
3ff238ae | 406 | return civicrm_api3_create_success(1, $params, 'Job', 'fetch_bounces'); |
407 | } | |
408 | ||
409 | /** | |
410 | * Metadata for bounce function. | |
411 | * | |
412 | * @param array $params | |
413 | */ | |
414 | function _civicrm_api3_job_fetch_bounces_spec(&$params) { | |
415 | $params['is_create_activities'] = array( | |
416 | 'api.default' => 0, | |
417 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
418 | 'title' => ts('Create activities for replies?'), | |
419 | ); | |
6a488035 TO |
420 | } |
421 | ||
422 | /** | |
35823763 | 423 | * Job to get mail and create activities. |
9657ccf2 EM |
424 | * |
425 | * @param array $params | |
426 | * | |
427 | * @return array | |
6a488035 TO |
428 | */ |
429 | function civicrm_api3_job_fetch_activities($params) { | |
83617886 | 430 | $lock = Civi::lockManager()->acquire('worker.mailing.EmailProcessor'); |
6a488035 TO |
431 | if (!$lock->isAcquired()) { |
432 | return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running'); | |
433 | } | |
39fefc30 KJ |
434 | |
435 | try { | |
436 | CRM_Utils_Mail_EmailProcessor::processActivities(); | |
481a74f4 | 437 | $values = array(); |
6a488035 | 438 | $lock->release(); |
244bbdd8 | 439 | return civicrm_api3_create_success($values, $params, 'Job', 'fetch_activities'); |
0db6c3e1 TO |
440 | } |
441 | catch (Exception $e) { | |
6a488035 | 442 | $lock->release(); |
e7b952ac | 443 | return civicrm_api3_create_error($e->getMessage()); |
6a488035 TO |
444 | } |
445 | } | |
446 | ||
447 | /** | |
35823763 | 448 | * Process participant statuses. |
6a488035 | 449 | * |
cf470720 | 450 | * @param array $params |
35823763 | 451 | * Input parameters. |
6a488035 | 452 | * |
a6c01b45 | 453 | * @return array |
72b3a70c | 454 | * array of properties, if error an array with an error id and error message |
6a488035 TO |
455 | */ |
456 | function civicrm_api3_job_process_participant($params) { | |
6a488035 TO |
457 | $result = CRM_Event_BAO_ParticipantStatusType::process($params); |
458 | ||
459 | if (!$result['is_error']) { | |
460 | return civicrm_api3_create_success(implode("\r\r", $result['messages'])); | |
461 | } | |
462 | else { | |
463 | return civicrm_api3_create_error('Error while processing participant statuses'); | |
464 | } | |
465 | } | |
466 | ||
467 | ||
468 | /** | |
61fe4988 EM |
469 | * This api checks and updates the status of all membership records for a given domain. |
470 | * | |
471 | * The function uses the calc_membership_status and update_contact_membership APIs. | |
6a488035 TO |
472 | * |
473 | * IMPORTANT: | |
474 | * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3. | |
475 | * | |
cf470720 TO |
476 | * @param array $params |
477 | * Input parameters NOT USED. | |
6a488035 | 478 | * |
971d41b1 | 479 | * @return bool |
72b3a70c | 480 | * true if success, else false |
6a488035 | 481 | */ |
608e6658 | 482 | function civicrm_api3_job_process_membership($params) { |
83617886 | 483 | $lock = Civi::lockManager()->acquire('worker.member.UpdateMembership'); |
39fefc30 | 484 | if (!$lock->isAcquired()) { |
017877e1 | 485 | return civicrm_api3_create_error('Could not acquire lock, another Membership Processing process is running'); |
39fefc30 KJ |
486 | } |
487 | ||
6a488035 | 488 | $result = CRM_Member_BAO_Membership::updateAllMembershipStatus(); |
39fefc30 | 489 | $lock->release(); |
6a488035 TO |
490 | |
491 | if ($result['is_error'] == 0) { | |
244bbdd8 | 492 | return civicrm_api3_create_success($result['messages'], $params, 'Job', 'process_membership'); |
6a488035 TO |
493 | } |
494 | else { | |
495 | return civicrm_api3_create_error($result['messages']); | |
496 | } | |
497 | } | |
498 | ||
499 | /** | |
3f83a242 | 500 | * This api checks and updates the status of all survey respondents. |
6a488035 | 501 | * |
cf470720 TO |
502 | * @param array $params |
503 | * (reference ) input parameters. | |
6a488035 | 504 | * |
971d41b1 | 505 | * @return bool |
72b3a70c | 506 | * true if success, else false |
6a488035 TO |
507 | */ |
508 | function civicrm_api3_job_process_respondent($params) { | |
6a488035 TO |
509 | $result = CRM_Campaign_BAO_Survey::releaseRespondent($params); |
510 | ||
511 | if ($result['is_error'] == 0) { | |
512 | return civicrm_api3_create_success(); | |
513 | } | |
514 | else { | |
515 | return civicrm_api3_create_error($result['messages']); | |
516 | } | |
517 | } | |
518 | ||
519 | /** | |
520 | * Merges given pair of duplicate contacts. | |
521 | * | |
cf470720 TO |
522 | * @param array $params |
523 | * Input parameters. | |
6a488035 | 524 | * |
a6c01b45 | 525 | * @return array |
72b3a70c | 526 | * API Result Array |
76ddbc8e | 527 | * @throws \CiviCRM_API3_Exception |
6a488035 TO |
528 | */ |
529 | function civicrm_api3_job_process_batch_merge($params) { | |
6c866f0c | 530 | $rule_group_id = CRM_Utils_Array::value('rule_group_id', $params); |
76ddbc8e | 531 | if (!$rule_group_id) { |
532 | $rule_group_id = civicrm_api3('RuleGroup', 'getvalue', array( | |
533 | 'contact_type' => 'Individual', | |
534 | 'used' => 'Unsupervised', | |
535 | 'return' => 'id', | |
6c866f0c | 536 | 'options' => array('limit' => 1), |
76ddbc8e | 537 | )); |
538 | } | |
f008885c | 539 | $rgid = CRM_Utils_Array::value('rgid', $params); |
6a488035 | 540 | $gid = CRM_Utils_Array::value('gid', $params); |
6a488035 | 541 | $mode = CRM_Utils_Array::value('mode', $params, 'safe'); |
6a488035 | 542 | |
d13a105a | 543 | $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)); |
6a488035 | 544 | |
76ddbc8e | 545 | return civicrm_api3_create_success($result, $params); |
6a488035 TO |
546 | } |
547 | ||
3f83a242 | 548 | /** |
61fe4988 EM |
549 | * Metadata for batch merge function. |
550 | * | |
3f83a242 EM |
551 | * @param $params |
552 | */ | |
553 | function _civicrm_api3_job_process_batch_merge_spec(&$params) { | |
6c866f0c | 554 | $params['rule_group_id'] = array( |
76ddbc8e | 555 | 'title' => 'Dedupe rule group id, defaults to Contact Unsupervised rule', |
3f83a242 | 556 | 'type' => CRM_Utils_Type::T_INT, |
6c866f0c | 557 | 'api.aliases' => array('rgid'), |
3f83a242 EM |
558 | ); |
559 | $params['gid'] = array( | |
560 | 'title' => 'group id', | |
561 | 'type' => CRM_Utils_Type::T_INT, | |
562 | ); | |
563 | $params['mode'] = array( | |
564 | 'title' => 'Mode', | |
608e6658 | 565 | '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.', |
3f83a242 EM |
566 | 'type' => CRM_Utils_Type::T_STRING, |
567 | ); | |
568 | $params['auto_flip'] = array( | |
569 | 'title' => 'Auto Flip', | |
570 | 'description' => 'let the api decide which contact to retain and which to delete?', | |
571 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
572 | ); | |
573 | } | |
574 | ||
6a488035 | 575 | /** |
61fe4988 | 576 | * Runs handlePaymentCron method in the specified payment processor. |
6a488035 | 577 | * |
cf470720 TO |
578 | * @param array $params |
579 | * Input parameters. | |
6a488035 | 580 | * |
61fe4988 EM |
581 | * Expected @params array keys are: INCORRECTLY DOCUMENTED AND SHOULD BE IN THE _spec function |
582 | * for retrieval via getfields. | |
6a488035 | 583 | * {string 'processor_name' - the name of the payment processor, eg: Sagepay} |
6a488035 TO |
584 | */ |
585 | function civicrm_api3_job_run_payment_cron($params) { | |
586 | ||
6a488035 TO |
587 | // live mode |
588 | CRM_Core_Payment::handlePaymentMethod( | |
589 | 'PaymentCron', | |
590 | array_merge( | |
591 | $params, | |
592 | array( | |
593 | 'caller' => 'api', | |
594 | ) | |
595 | ) | |
596 | ); | |
597 | ||
598 | // test mode | |
599 | CRM_Core_Payment::handlePaymentMethod( | |
600 | 'PaymentCron', | |
601 | array_merge( | |
602 | $params, | |
603 | array( | |
604 | 'mode' => 'test', | |
605 | ) | |
606 | ) | |
607 | ); | |
608 | } | |
609 | ||
610 | /** | |
61fe4988 EM |
611 | * This api cleans up all the old session entries and temp tables. |
612 | * | |
613 | * We recommend that sites run this on an hourly basis. | |
6a488035 | 614 | * |
cf470720 | 615 | * @param array $params |
971d41b1 | 616 | * Sends in various config parameters to decide what needs to be cleaned. |
6a488035 | 617 | */ |
481a74f4 | 618 | function civicrm_api3_job_cleanup($params) { |
971d41b1 CW |
619 | $session = CRM_Utils_Array::value('session', $params, TRUE); |
620 | $tempTable = CRM_Utils_Array::value('tempTables', $params, TRUE); | |
621 | $jobLog = CRM_Utils_Array::value('jobLog', $params, TRUE); | |
fd33fead | 622 | $expired = CRM_Utils_Array::value('expiredDbCache', $params, TRUE); |
971d41b1 CW |
623 | $prevNext = CRM_Utils_Array::value('prevNext', $params, TRUE); |
624 | $dbCache = CRM_Utils_Array::value('dbCache', $params, FALSE); | |
625 | $memCache = CRM_Utils_Array::value('memCache', $params, FALSE); | |
9db8dfb7 | 626 | $tplCache = CRM_Utils_Array::value('tplCache', $params, FALSE); |
627 | $wordRplc = CRM_Utils_Array::value('wordRplc', $params, FALSE); | |
6a488035 | 628 | |
fd33fead TO |
629 | if ($session || $tempTable || $prevNext || $expired) { |
630 | CRM_Core_BAO_Cache::cleanup($session, $tempTable, $prevNext, $expired); | |
6a488035 TO |
631 | } |
632 | ||
481a74f4 TO |
633 | if ($jobLog) { |
634 | CRM_Core_BAO_Job::cleanup(); | |
6a488035 TO |
635 | } |
636 | ||
9db8dfb7 | 637 | if ($tplCache) { |
4dd6dceb | 638 | $config = CRM_Core_Config::singleton(); |
639 | $config->cleanup(1, FALSE); | |
640 | } | |
641 | ||
481a74f4 TO |
642 | if ($dbCache) { |
643 | CRM_Core_Config::clearDBCache(); | |
6a488035 TO |
644 | } |
645 | ||
481a74f4 TO |
646 | if ($memCache) { |
647 | CRM_Utils_System::flushCache(); | |
6a488035 | 648 | } |
4dd6dceb | 649 | |
9db8dfb7 | 650 | if ($wordRplc) { |
4dd6dceb | 651 | CRM_Core_BAO_WordReplacement::rebuild(); |
652 | } | |
6a488035 TO |
653 | } |
654 | ||
655 | /** | |
656 | * Set expired relationships to disabled. | |
61fe4988 EM |
657 | * |
658 | * @param array $params | |
659 | * | |
9657ccf2 | 660 | * @return array |
3f83a242 | 661 | * @throws \API_Exception |
6a488035 | 662 | */ |
608e6658 | 663 | function civicrm_api3_job_disable_expired_relationships($params) { |
6a488035 | 664 | $result = CRM_Contact_BAO_Relationship::disableExpiredRelationships(); |
3f83a242 EM |
665 | if (!$result) { |
666 | throw new API_Exception('Failed to disable all expired relationships.'); | |
6a488035 | 667 | } |
244bbdd8 | 668 | return civicrm_api3_create_success(1, $params, 'Job', 'disable_expired_relationships'); |
6a488035 TO |
669 | } |
670 | ||
671 | /** | |
61fe4988 EM |
672 | * This api reloads all the smart groups. |
673 | * | |
674 | * If the org has a large number of smart groups it is recommended that they use the limit clause | |
675 | * to limit the number of smart groups evaluated on a per job basis. | |
676 | * | |
677 | * Might also help to increase the smartGroupCacheTimeout and use the cache. | |
9657ccf2 EM |
678 | * |
679 | * @param array $params | |
61fe4988 | 680 | * |
9657ccf2 | 681 | * @return array |
3f83a242 | 682 | * @throws \API_Exception |
6a488035 | 683 | */ |
9657ccf2 | 684 | function civicrm_api3_job_group_rebuild($params) { |
83617886 | 685 | $lock = Civi::lockManager()->acquire('worker.core.GroupRebuild'); |
39fefc30 | 686 | if (!$lock->isAcquired()) { |
0feefbc7 | 687 | throw new API_Exception('Could not acquire lock, another GroupRebuild process is running'); |
39fefc30 KJ |
688 | } |
689 | ||
481a74f4 | 690 | $limit = CRM_Utils_Array::value('limit', $params, 0); |
6a488035 | 691 | |
971d41b1 | 692 | CRM_Contact_BAO_GroupContactCache::loadAll(NULL, $limit); |
39fefc30 KJ |
693 | $lock->release(); |
694 | ||
f9e16e9a | 695 | return civicrm_api3_create_success(); |
6a488035 | 696 | } |
999128a9 | 697 | |
a357281f | 698 | /** |
699 | * Flush smart groups caches. | |
700 | * | |
701 | * This job purges aged smart group cache data (based on the timeout value). Sites can decide whether they want this | |
702 | * job and / or the group cache rebuild job to run. In some cases performance is better when old caches are cleared out | |
703 | * prior to any attempt to rebuild them. Also, many sites are very happy to have caches built on demand, provided the | |
704 | * user is not having to wait for deadlocks to clear when invalidating them. | |
705 | * | |
706 | * @param array $params | |
707 | * | |
708 | * @return array | |
709 | * @throws \API_Exception | |
710 | */ | |
711 | function civicrm_api3_job_group_cache_flush($params) { | |
2b68a50c | 712 | CRM_Contact_BAO_GroupContactCache::deterministicCacheFlush(); |
a357281f | 713 | return civicrm_api3_create_success(); |
714 | } | |
715 | ||
999128a9 CW |
716 | /** |
717 | * Check for CiviCRM software updates. | |
718 | * | |
719 | * Anonymous site statistics are sent back to civicrm.org during this check. | |
720 | */ | |
721 | function civicrm_api3_job_version_check() { | |
722 | $vc = new CRM_Utils_VersionCheck(); | |
723 | $vc->fetch(); | |
e9e60a8c | 724 | return civicrm_api3_create_success(); |
999128a9 | 725 | } |