Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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) { | |
142 | $params['start'] = array('title' => 'Start Date'); | |
143 | $params['end'] = array('title' => 'End Date'); | |
79f1148d DL |
144 | $params['geocoding'] = array('title' => 'Geocode address?'); |
145 | $params['parse'] = array('title' => 'Parse street address?'); | |
b2ed8e73 CW |
146 | $params['throttle'] = array( |
147 | 'title' => 'Throttle?', | |
148 | 'description' => 'if enabled, geo-codes at a slow rate', | |
149 | ); | |
6a488035 TO |
150 | } |
151 | ||
152 | /** | |
c1a920f1 | 153 | * Send the scheduled reminders for all contacts (either for activities or events). |
6a488035 | 154 | * |
cf470720 TO |
155 | * @param array $params |
156 | * (reference ) input parameters. | |
6a488035 TO |
157 | * now - the time to use, in YmdHis format |
158 | * - makes testing a bit simpler since we can simulate past/future time | |
159 | * | |
c23f45d3 | 160 | * @return array |
6a488035 TO |
161 | */ |
162 | function civicrm_api3_job_send_reminder($params) { | |
e27a3472 EM |
163 | //note that $params['rowCount' can be overridden by one of the preferred syntaxes ($options['limit'] = x |
164 | //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 | 165 | // in that case (ie. makes it non-configurable via the UI). Another approach would be to set a default of 0 |
e27a3472 EM |
166 | // in the _spec function - but since that is a deprecated value it seems more contentious than this approach |
167 | $params['rowCount'] = 0; | |
39fefc30 KJ |
168 | $lock = new CRM_Core_Lock('civimail.job.EmailProcessor'); |
169 | if (!$lock->isAcquired()) { | |
170 | return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running'); | |
171 | } | |
172 | ||
73f3e293 | 173 | $result = CRM_Core_BAO_ActionSchedule::processQueue(CRM_Utils_Array::value('now', $params), $params); |
39fefc30 | 174 | $lock->release(); |
6a488035 TO |
175 | |
176 | if ($result['is_error'] == 0) { | |
177 | return civicrm_api3_create_success(); | |
178 | } | |
179 | else { | |
180 | return civicrm_api3_create_error($result['messages']); | |
181 | } | |
182 | } | |
73f3e293 | 183 | /** |
c1a920f1 EM |
184 | * Adjust metadata for "send_reminder" action. |
185 | * | |
186 | * The metadata is used for setting defaults, documentation & validation. | |
73f3e293 | 187 | * |
cf470720 | 188 | * @param array $params |
b081365f | 189 | * Array of parameters determined by getfields. |
73f3e293 E |
190 | */ |
191 | function _civicrm_api3_job_send_reminder(&$params) { | |
192 | //@todo this function will now take all fields in action_schedule as params | |
193 | // as it is calling the api fn to set the filters - update getfields to reflect | |
194 | $params['id'] = array( | |
195 | 'type' => CRM_Utils_Type::T_INT, | |
21dfd5f5 | 196 | 'title' => 'Action Schedule ID', |
73f3e293 E |
197 | ); |
198 | } | |
6a488035 | 199 | /** |
c1a920f1 | 200 | * Execute a specific report instance and send the output via email. |
6a488035 | 201 | * |
cf470720 TO |
202 | * @param array $params |
203 | * (reference ) input parameters. | |
6a488035 TO |
204 | * sendmail - Boolean - should email be sent?, required |
205 | * instanceId - Integer - the report instance ID | |
206 | * resetVal - Integer - should we reset form state (always true)? | |
207 | * | |
c23f45d3 | 208 | * @return array |
6a488035 TO |
209 | */ |
210 | function civicrm_api3_job_mail_report($params) { | |
6a488035 TO |
211 | $result = CRM_Report_Utils_Report::processReport($params); |
212 | ||
213 | if ($result['is_error'] == 0) { | |
214 | // this should be handling by throwing exceptions but can't remove until we can test that. | |
215 | return civicrm_api3_create_success(); | |
216 | } | |
217 | else { | |
218 | return civicrm_api3_create_error($result['messages']); | |
219 | } | |
220 | } | |
221 | ||
222 | /** | |
6a488035 | 223 | * This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type. |
211e2fca | 224 | * |
6a488035 TO |
225 | * IMPORTANT: You must first create valid option value before using via admin interface. |
226 | * Check option lists for Email Greetings, Postal Greetings and Addressee | |
227 | * | |
211e2fca | 228 | * @todo - is this here by mistake or should it be added to _spec function :id - Integer - greetings option group. |
6a488035 | 229 | * |
9657ccf2 | 230 | * @param array $params |
77b97be7 | 231 | * |
3f83a242 | 232 | * @return array |
6a488035 TO |
233 | */ |
234 | function civicrm_api3_job_update_greeting($params) { | |
6a488035 | 235 | if (isset($params['ct']) && isset($params['gt'])) { |
6a488035 TO |
236 | $ct = explode(',', $params['ct']); |
237 | $gt = explode(',', $params['gt']); | |
238 | foreach ($ct as $ctKey => $ctValue) { | |
239 | foreach ($gt as $gtKey => $gtValue) { | |
240 | $params['ct'] = trim($ctValue); | |
241 | $params['gt'] = trim($gtValue); | |
3f83a242 | 242 | CRM_Contact_BAO_Contact_Utils::updateGreeting($params); |
6a488035 TO |
243 | } |
244 | } | |
245 | } | |
246 | else { | |
3f83a242 | 247 | CRM_Contact_BAO_Contact_Utils::updateGreeting($params); |
6a488035 | 248 | } |
3f83a242 | 249 | return civicrm_api3_create_success(); |
6a488035 TO |
250 | } |
251 | ||
252 | /** | |
211e2fca | 253 | * Adjust Metadata for Get action. |
72b3a70c | 254 | * |
c1a920f1 EM |
255 | * The metadata is used for setting defaults, documentation & validation. |
256 | * | |
72b3a70c | 257 | * @param array $params |
b081365f | 258 | * Array of parameters determined by getfields. |
72b3a70c | 259 | */ |
6a488035 TO |
260 | function _civicrm_api3_job_update_greeting_spec(&$params) { |
261 | $params['ct'] = array( | |
262 | 'api.required' => 1, | |
263 | 'title' => 'Contact Type', | |
264 | 'type' => CRM_Utils_Type::T_STRING, | |
265 | ); | |
266 | $params['gt'] = array( | |
971d41b1 CW |
267 | 'api.required' => 1, |
268 | 'title' => 'Greeting Type', | |
269 | 'type' => CRM_Utils_Type::T_STRING, | |
6a488035 TO |
270 | ); |
271 | } | |
272 | ||
273 | /** | |
c1a920f1 | 274 | * Mass update pledge statuses. |
6a488035 | 275 | * |
cf470720 | 276 | * @param array $params |
c1a920f1 | 277 | * |
c23f45d3 | 278 | * @return array |
6a488035 TO |
279 | */ |
280 | function civicrm_api3_job_process_pledge($params) { | |
281 | // *** Uncomment the next line if you want automated reminders to be sent | |
282 | // $params['send_reminders'] = true; | |
283 | $result = CRM_Pledge_BAO_Pledge::updatePledgeStatus($params); | |
284 | ||
285 | if ($result['is_error'] == 0) { | |
286 | // experiment: detailed execution log is a result here | |
287 | return civicrm_api3_create_success($result['messages']); | |
288 | } | |
289 | else { | |
290 | return civicrm_api3_create_error($result['error_message']); | |
291 | } | |
292 | } | |
293 | ||
294 | /** | |
c1a920f1 | 295 | * Process mail queue. |
6a488035 TO |
296 | * |
297 | * @param array $params | |
298 | * | |
299 | * @return array | |
300 | */ | |
301 | function civicrm_api3_job_process_mailing($params) { | |
302 | ||
303 | if (!CRM_Mailing_BAO_Mailing::processQueue()) { | |
304 | return civicrm_api3_create_error('Process Queue failed'); | |
305 | } | |
306 | else { | |
307 | $values = array(); | |
244bbdd8 | 308 | return civicrm_api3_create_success($values, $params, 'Job', 'process_mailing'); |
6a488035 TO |
309 | } |
310 | } | |
311 | ||
312 | /** | |
cd5823ae | 313 | * Process sms queue. |
6a488035 TO |
314 | * |
315 | * @param array $params | |
316 | * | |
317 | * @return array | |
318 | */ | |
319 | function civicrm_api3_job_process_sms($params) { | |
6a488035 TO |
320 | if (!CRM_Mailing_BAO_Mailing::processQueue('sms')) { |
321 | return civicrm_api3_create_error('Process Queue failed'); | |
322 | } | |
323 | else { | |
324 | $values = array(); | |
244bbdd8 | 325 | return civicrm_api3_create_success($values, $params, 'Job', 'process_sms'); |
6a488035 TO |
326 | } |
327 | } | |
39fefc30 | 328 | |
6a488035 | 329 | /** |
c1a920f1 | 330 | * Job to get mail responses from civiMailing. |
9657ccf2 EM |
331 | * |
332 | * @param array $params | |
333 | * | |
334 | * @return array | |
6a488035 TO |
335 | */ |
336 | function civicrm_api3_job_fetch_bounces($params) { | |
39fefc30 | 337 | $lock = new CRM_Core_Lock('civimail.job.EmailProcessor'); |
6a488035 TO |
338 | if (!$lock->isAcquired()) { |
339 | return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running'); | |
340 | } | |
341 | if (!CRM_Utils_Mail_EmailProcessor::processBounces()) { | |
39fefc30 | 342 | $lock->release(); |
6a488035 TO |
343 | return civicrm_api3_create_error('Process Bounces failed'); |
344 | } | |
6a488035 | 345 | $lock->release(); |
39fefc30 KJ |
346 | |
347 | // FIXME: processBounces doesn't return true/false on success/failure | |
348 | $values = array(); | |
244bbdd8 | 349 | return civicrm_api3_create_success($values, $params, 'Job', 'fetch_bounces'); |
6a488035 TO |
350 | } |
351 | ||
352 | /** | |
35823763 | 353 | * Job to get mail and create activities. |
9657ccf2 EM |
354 | * |
355 | * @param array $params | |
356 | * | |
357 | * @return array | |
6a488035 TO |
358 | */ |
359 | function civicrm_api3_job_fetch_activities($params) { | |
39fefc30 | 360 | $lock = new CRM_Core_Lock('civimail.job.EmailProcessor'); |
6a488035 TO |
361 | if (!$lock->isAcquired()) { |
362 | return civicrm_api3_create_error('Could not acquire lock, another EmailProcessor process is running'); | |
363 | } | |
39fefc30 KJ |
364 | |
365 | try { | |
366 | CRM_Utils_Mail_EmailProcessor::processActivities(); | |
481a74f4 | 367 | $values = array(); |
6a488035 | 368 | $lock->release(); |
244bbdd8 | 369 | return civicrm_api3_create_success($values, $params, 'Job', 'fetch_activities'); |
0db6c3e1 TO |
370 | } |
371 | catch (Exception $e) { | |
6a488035 TO |
372 | $lock->release(); |
373 | return civicrm_api3_create_error('Process Activities failed'); | |
374 | } | |
375 | } | |
376 | ||
377 | /** | |
35823763 | 378 | * Process participant statuses. |
6a488035 | 379 | * |
cf470720 | 380 | * @param array $params |
35823763 | 381 | * Input parameters. |
6a488035 | 382 | * |
a6c01b45 | 383 | * @return array |
72b3a70c | 384 | * array of properties, if error an array with an error id and error message |
6a488035 TO |
385 | */ |
386 | function civicrm_api3_job_process_participant($params) { | |
6a488035 TO |
387 | $result = CRM_Event_BAO_ParticipantStatusType::process($params); |
388 | ||
389 | if (!$result['is_error']) { | |
390 | return civicrm_api3_create_success(implode("\r\r", $result['messages'])); | |
391 | } | |
392 | else { | |
393 | return civicrm_api3_create_error('Error while processing participant statuses'); | |
394 | } | |
395 | } | |
396 | ||
397 | ||
398 | /** | |
61fe4988 EM |
399 | * This api checks and updates the status of all membership records for a given domain. |
400 | * | |
401 | * The function uses the calc_membership_status and update_contact_membership APIs. | |
6a488035 TO |
402 | * |
403 | * IMPORTANT: | |
404 | * Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3. | |
405 | * | |
cf470720 TO |
406 | * @param array $params |
407 | * Input parameters NOT USED. | |
6a488035 | 408 | * |
971d41b1 | 409 | * @return bool |
72b3a70c | 410 | * true if success, else false |
6a488035 | 411 | */ |
608e6658 | 412 | function civicrm_api3_job_process_membership($params) { |
39fefc30 KJ |
413 | $lock = new CRM_Core_Lock('civimail.job.updateMembership'); |
414 | if (!$lock->isAcquired()) { | |
017877e1 | 415 | return civicrm_api3_create_error('Could not acquire lock, another Membership Processing process is running'); |
39fefc30 KJ |
416 | } |
417 | ||
6a488035 | 418 | $result = CRM_Member_BAO_Membership::updateAllMembershipStatus(); |
39fefc30 | 419 | $lock->release(); |
6a488035 TO |
420 | |
421 | if ($result['is_error'] == 0) { | |
244bbdd8 | 422 | return civicrm_api3_create_success($result['messages'], $params, 'Job', 'process_membership'); |
6a488035 TO |
423 | } |
424 | else { | |
425 | return civicrm_api3_create_error($result['messages']); | |
426 | } | |
427 | } | |
428 | ||
429 | /** | |
3f83a242 | 430 | * This api checks and updates the status of all survey respondents. |
6a488035 | 431 | * |
cf470720 TO |
432 | * @param array $params |
433 | * (reference ) input parameters. | |
6a488035 | 434 | * |
971d41b1 | 435 | * @return bool |
72b3a70c | 436 | * true if success, else false |
6a488035 TO |
437 | */ |
438 | function civicrm_api3_job_process_respondent($params) { | |
6a488035 TO |
439 | $result = CRM_Campaign_BAO_Survey::releaseRespondent($params); |
440 | ||
441 | if ($result['is_error'] == 0) { | |
442 | return civicrm_api3_create_success(); | |
443 | } | |
444 | else { | |
445 | return civicrm_api3_create_error($result['messages']); | |
446 | } | |
447 | } | |
448 | ||
449 | /** | |
450 | * Merges given pair of duplicate contacts. | |
451 | * | |
cf470720 TO |
452 | * @param array $params |
453 | * Input parameters. | |
6a488035 | 454 | * |
a6c01b45 | 455 | * @return array |
72b3a70c | 456 | * API Result Array |
6a488035 TO |
457 | */ |
458 | function civicrm_api3_job_process_batch_merge($params) { | |
459 | $rgid = CRM_Utils_Array::value('rgid', $params); | |
460 | $gid = CRM_Utils_Array::value('gid', $params); | |
461 | ||
462 | $mode = CRM_Utils_Array::value('mode', $params, 'safe'); | |
463 | $autoFlip = CRM_Utils_Array::value('auto_flip', $params, TRUE); | |
464 | ||
6a488035 TO |
465 | $result = CRM_Dedupe_Merger::batchMerge($rgid, $gid, $mode, $autoFlip); |
466 | ||
467 | if ($result['is_error'] == 0) { | |
468 | return civicrm_api3_create_success(); | |
469 | } | |
470 | else { | |
471 | return civicrm_api3_create_error($result['messages']); | |
472 | } | |
473 | } | |
474 | ||
3f83a242 | 475 | /** |
61fe4988 EM |
476 | * Metadata for batch merge function. |
477 | * | |
3f83a242 EM |
478 | * @param $params |
479 | */ | |
480 | function _civicrm_api3_job_process_batch_merge_spec(&$params) { | |
481 | $params['rgid'] = array( | |
482 | 'title' => 'rule group id', | |
483 | 'type' => CRM_Utils_Type::T_INT, | |
484 | ); | |
485 | $params['gid'] = array( | |
486 | 'title' => 'group id', | |
487 | 'type' => CRM_Utils_Type::T_INT, | |
488 | ); | |
489 | $params['mode'] = array( | |
490 | 'title' => 'Mode', | |
608e6658 | 491 | '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 |
492 | 'type' => CRM_Utils_Type::T_STRING, |
493 | ); | |
494 | $params['auto_flip'] = array( | |
495 | 'title' => 'Auto Flip', | |
496 | 'description' => 'let the api decide which contact to retain and which to delete?', | |
497 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
498 | ); | |
499 | } | |
500 | ||
6a488035 | 501 | /** |
61fe4988 | 502 | * Runs handlePaymentCron method in the specified payment processor. |
6a488035 | 503 | * |
cf470720 TO |
504 | * @param array $params |
505 | * Input parameters. | |
6a488035 | 506 | * |
61fe4988 EM |
507 | * Expected @params array keys are: INCORRECTLY DOCUMENTED AND SHOULD BE IN THE _spec function |
508 | * for retrieval via getfields. | |
6a488035 | 509 | * {string 'processor_name' - the name of the payment processor, eg: Sagepay} |
6a488035 TO |
510 | */ |
511 | function civicrm_api3_job_run_payment_cron($params) { | |
512 | ||
6a488035 TO |
513 | // live mode |
514 | CRM_Core_Payment::handlePaymentMethod( | |
515 | 'PaymentCron', | |
516 | array_merge( | |
517 | $params, | |
518 | array( | |
519 | 'caller' => 'api', | |
520 | ) | |
521 | ) | |
522 | ); | |
523 | ||
524 | // test mode | |
525 | CRM_Core_Payment::handlePaymentMethod( | |
526 | 'PaymentCron', | |
527 | array_merge( | |
528 | $params, | |
529 | array( | |
530 | 'mode' => 'test', | |
531 | ) | |
532 | ) | |
533 | ); | |
534 | } | |
535 | ||
536 | /** | |
61fe4988 EM |
537 | * This api cleans up all the old session entries and temp tables. |
538 | * | |
539 | * We recommend that sites run this on an hourly basis. | |
6a488035 | 540 | * |
cf470720 | 541 | * @param array $params |
971d41b1 | 542 | * Sends in various config parameters to decide what needs to be cleaned. |
6a488035 | 543 | */ |
481a74f4 | 544 | function civicrm_api3_job_cleanup($params) { |
971d41b1 CW |
545 | $session = CRM_Utils_Array::value('session', $params, TRUE); |
546 | $tempTable = CRM_Utils_Array::value('tempTables', $params, TRUE); | |
547 | $jobLog = CRM_Utils_Array::value('jobLog', $params, TRUE); | |
548 | $prevNext = CRM_Utils_Array::value('prevNext', $params, TRUE); | |
549 | $dbCache = CRM_Utils_Array::value('dbCache', $params, FALSE); | |
550 | $memCache = CRM_Utils_Array::value('memCache', $params, FALSE); | |
6a488035 | 551 | |
481a74f4 TO |
552 | if ($session || $tempTable || $prevNext) { |
553 | CRM_Core_BAO_Cache::cleanup($session, $tempTable, $prevNext); | |
6a488035 TO |
554 | } |
555 | ||
481a74f4 TO |
556 | if ($jobLog) { |
557 | CRM_Core_BAO_Job::cleanup(); | |
6a488035 TO |
558 | } |
559 | ||
481a74f4 TO |
560 | if ($dbCache) { |
561 | CRM_Core_Config::clearDBCache(); | |
6a488035 TO |
562 | } |
563 | ||
481a74f4 TO |
564 | if ($memCache) { |
565 | CRM_Utils_System::flushCache(); | |
6a488035 TO |
566 | } |
567 | } | |
568 | ||
569 | /** | |
570 | * Set expired relationships to disabled. | |
61fe4988 EM |
571 | * |
572 | * @param array $params | |
573 | * | |
9657ccf2 | 574 | * @return array |
3f83a242 | 575 | * @throws \API_Exception |
6a488035 | 576 | */ |
608e6658 | 577 | function civicrm_api3_job_disable_expired_relationships($params) { |
6a488035 | 578 | $result = CRM_Contact_BAO_Relationship::disableExpiredRelationships(); |
3f83a242 EM |
579 | if (!$result) { |
580 | throw new API_Exception('Failed to disable all expired relationships.'); | |
6a488035 | 581 | } |
244bbdd8 | 582 | return civicrm_api3_create_success(1, $params, 'Job', 'disable_expired_relationships'); |
6a488035 TO |
583 | } |
584 | ||
585 | /** | |
61fe4988 EM |
586 | * This api reloads all the smart groups. |
587 | * | |
588 | * If the org has a large number of smart groups it is recommended that they use the limit clause | |
589 | * to limit the number of smart groups evaluated on a per job basis. | |
590 | * | |
591 | * Might also help to increase the smartGroupCacheTimeout and use the cache. | |
9657ccf2 EM |
592 | * |
593 | * @param array $params | |
61fe4988 | 594 | * |
9657ccf2 | 595 | * @return array |
3f83a242 | 596 | * @throws \API_Exception |
6a488035 | 597 | */ |
9657ccf2 | 598 | function civicrm_api3_job_group_rebuild($params) { |
39fefc30 KJ |
599 | $lock = new CRM_Core_Lock('civimail.job.groupRebuild'); |
600 | if (!$lock->isAcquired()) { | |
3f83a242 | 601 | throw new API_Exception('Could not acquire lock, another EmailProcessor process is running'); |
39fefc30 KJ |
602 | } |
603 | ||
481a74f4 | 604 | $limit = CRM_Utils_Array::value('limit', $params, 0); |
6a488035 | 605 | |
971d41b1 | 606 | CRM_Contact_BAO_GroupContactCache::loadAll(NULL, $limit); |
39fefc30 KJ |
607 | $lock->release(); |
608 | ||
f9e16e9a | 609 | return civicrm_api3_create_success(); |
6a488035 | 610 | } |