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