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