api/v3/Job.php

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