api/v3/utils.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * CiviCRM APIv3 utility functions.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Initialize CiviCRM - should be run at the start of each API function.
  20  */
  21 function _civicrm_api3_initialize() {
  22   require_once 'CRM/Core/ClassLoader.php';
  23   CRM_Core_ClassLoader::singleton()->register();
  24   CRM_Core_Config::singleton();
  25 }
  26
  27 /**
  28  * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking.
  29  *
  30  * @param array $params
  31  *   Array of fields to check.
  32  * @param array $daoName
  33  *   String DAO to check for required fields (create functions only).
  34  * @param array $keyoptions
  35  *   List of required fields options. One of the options is required.
  36  *
  37  * @throws \API_Exception
  38  */
  39 function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = []) {
  40   $keys = [[]];
  41   foreach ($keyoptions as $key) {
  42     $keys[0][] = $key;
  43   }
  44   civicrm_api3_verify_mandatory($params, $daoName, $keys);
  45 }
  46
  47 /**
  48  * Check mandatory fields are included.
  49  *
  50  * @param array $params
  51  *   Array of fields to check.
  52  * @param array $daoName
  53  *   String DAO to check for required fields (create functions only).
  54  * @param array $keys
  55  *   List of required fields. A value can be an array denoting that either this or that is required.
  56  * @param bool $verifyDAO
  57  *
  58  * @throws \API_Exception
  59  */
  60 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = [], $verifyDAO = TRUE) {
  61   $unmatched = [];
  62
  63   if (!empty($params['id'])) {
  64     $keys = ['version'];
  65   }
  66   else {
  67     if (!in_array('version', $keys)) {
  68       // required from v3 onwards
  69       $keys[] = 'version';
  70     }
  71   }
  72   foreach ($keys as $key) {
  73     if (is_array($key)) {
  74       $match = 0;
  75       $optionset = [];
  76       foreach ($key as $subkey) {
  77         if (!array_key_exists($subkey, $params) || empty($params[$subkey])) {
  78           $optionset[] = $subkey;
  79         }
  80         else {
  81           // As long as there is one match we don't need to return anything.
  82           $match = 1;
  83         }
  84       }
  85       if (empty($match) && !empty($optionset)) {
  86         $unmatched[] = "one of (" . implode(", ", $optionset) . ")";
  87       }
  88     }
  89     else {
  90       // Disallow empty values except for the number zero.
  91       // TODO: create a utility for this since it's needed in many places.
  92       if (!array_key_exists($key, $params) || (empty($params[$key]) && $params[$key] !== 0.0 && $params[$key] !== 0 && $params[$key] !== '0')) {
  93         $unmatched[] = $key;
  94       }
  95     }
  96   }
  97   if (!empty($unmatched)) {
  98     throw new API_Exception('Mandatory key(s) missing from params array: ' . implode(", ", $unmatched), 'mandatory_missing', ["fields" => $unmatched]);
  99   }
 100 }
 101
 102 /**
 103  * Create error array.
 104  *
 105  * @param string $msg
 106  * @param array $data
 107  *
 108  * @return array
 109  */
 110 function civicrm_api3_create_error($msg, $data = []) {
 111   $data['is_error'] = 1;
 112   $data['error_message'] = $msg;
 113
 114   // we will show sql to privileged user only (not sure of a specific
 115   // security hole here but seems sensible - perhaps should apply to the trace as well?)
 116   if (isset($data['sql'])) {
 117     if (CRM_Core_Permission::check('Administer CiviCRM') || CIVICRM_UF === 'UnitTests') {
 118       // Isn't this redundant?
 119       $data['debug_information'] = $data['sql'];
 120     }
 121     else {
 122       unset($data['sql']);
 123     }
 124   }
 125   return $data;
 126 }
 127
 128 /**
 129  * Format array in result output style.
 130  *
 131  * @param array|int $values values generated by API operation (the result)
 132  * @param array $params
 133  *   Parameters passed into API call.
 134  * @param string $entity
 135  *   The entity being acted on.
 136  * @param string $action
 137  *   The action passed to the API.
 138  * @param object $dao
 139  *   DAO object to be freed here.
 140  * @param array $extraReturnValues
 141  *   Additional values to be added to top level of result array(.
 142  *   - this param is currently used for legacy behaviour support
 143  *
 144  * @return array
 145  * @throws \CiviCRM_API3_Exception
 146  */
 147 function civicrm_api3_create_success($values = 1, $params = [], $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = []) {
 148   $result = [];
 149   $lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity);
 150   // TODO: This shouldn't be necessary but this fn sometimes gets called with lowercase entity
 151   $entity = _civicrm_api_get_camel_name($entity);
 152   $result['is_error'] = 0;
 153   //lets set the ['id'] field if it's not set & we know what the entity is
 154   if (is_array($values) && $entity && $action !== 'getfields') {
 155     foreach ($values as $key => $item) {
 156       if (empty($item['id']) && !empty($item[$lowercase_entity . '_id'])) {
 157         $values[$key]['id'] = $item[$lowercase_entity . '_id'];
 158       }
 159       if (!empty($item['financial_type_id'])) {
 160         // 4.3 legacy handling.
 161         $values[$key]['contribution_type_id'] = $item['financial_type_id'];
 162       }
 163       if (!empty($item['contribution_cancel_date'])) {
 164         // 5.16 legacy handling.
 165         $values[$key]['cancel_date'] = $item['contribution_cancel_date'];
 166       }
 167       if (!empty($item['next_sched_contribution_date'])) {
 168         // 4.4 legacy handling
 169         $values[$key]['next_sched_contribution'] = $item['next_sched_contribution_date'];
 170       }
 171     }
 172   }
 173
 174   if (is_array($params) && $entity && !empty($params['debug'])) {
 175     if (is_string($action) && $action !== 'getfields') {
 176       $apiFields = civicrm_api($entity, 'getfields', ['version' => 3, 'action' => $action] + $params);
 177     }
 178     elseif ($action !== 'getfields') {
 179       $apiFields = civicrm_api($entity, 'getfields', ['version' => 3] + $params);
 180     }
 181     else {
 182       $apiFields = FALSE;
 183     }
 184
 185     $allFields = [];
 186     if ($action !== 'getfields' && isset($apiFields['values']) && is_array($apiFields['values'])) {
 187       $allFields = array_keys($apiFields['values']);
 188     }
 189     $paramFields = array_keys($params);
 190     $undefined = array_diff($paramFields, $allFields, array_keys($_COOKIE), [
 191       'action',
 192       'entity',
 193       'debug',
 194       'version',
 195       'check_permissions',
 196       'IDS_request_uri',
 197       'IDS_user_agent',
 198       'return',
 199       'sequential',
 200       'rowCount',
 201       'option_offset',
 202       'option_limit',
 203       'custom',
 204       'option_sort',
 205       'options',
 206       'prettyprint',
 207     ]);
 208     if ($undefined) {
 209       $result['undefined_fields'] = array_merge($undefined);
 210     }
 211   }
 212
 213   $result['version'] = 3;
 214   if (is_array($values)) {
 215     $result['count'] = (int) count($values);
 216
 217     // Convert value-separated strings to array
 218     if ($action !== 'getfields') {
 219       _civicrm_api3_separate_values($values);
 220     }
 221
 222     if ($result['count'] == 1) {
 223       list($result['id']) = array_keys($values);
 224     }
 225     elseif (!empty($values['id']) && is_int($values['id'])) {
 226       $result['id'] = $values['id'];
 227     }
 228   }
 229   else {
 230     $result['count'] = !empty($values) ? 1 : 0;
 231   }
 232
 233   if (is_array($values) && isset($params['sequential']) &&
 234     $params['sequential'] == 1
 235   ) {
 236     $result['values'] = array_values($values);
 237   }
 238   else {
 239     $result['values'] = $values;
 240   }
 241   if (!empty($params['options']['metadata'])) {
 242     // We've made metadata an array but only supporting 'fields' atm.
 243     if (in_array('fields', (array) $params['options']['metadata']) && $action !== 'getfields') {
 244       $fields = civicrm_api3($entity, 'getfields', [
 245         'action' => substr($action, 0, 3) == 'get' ? 'get' : 'create',
 246       ]);
 247       $result['metadata']['fields'] = $fields['values'];
 248     }
 249   }
 250   // Report deprecations.
 251   $deprecated = _civicrm_api3_deprecation_check($entity, $result);
 252   // Always report "setvalue" action as deprecated.
 253   if (!is_string($deprecated) && ($action === 'getactions' || $action === 'setvalue')) {
 254     $deprecated = ((array) $deprecated) + ['setvalue' => 'The "setvalue" action is deprecated. Use "create" with an id instead.'];
 255   }
 256   // Always report "update" action as deprecated.
 257   if (!is_string($deprecated) && ($action === 'getactions' || $action === 'update')) {
 258     $deprecated = ((array) $deprecated) + ['update' => 'The "update" action is deprecated. Use "create" with an id instead.'];
 259   }
 260   if ($deprecated) {
 261     // Metadata-level deprecations or wholesale entity deprecations.
 262     if ($entity === 'Entity' || $action === 'getactions' || is_string($deprecated)) {
 263       $result['deprecated'] = $deprecated;
 264     }
 265     // Action-specific deprecations
 266     elseif (!empty($deprecated[$action])) {
 267       $result['deprecated'] = $deprecated[$action];
 268     }
 269   }
 270   return array_merge($result, $extraReturnValues);
 271 }
 272
 273 /**
 274  * Load the DAO of the entity.
 275  *
 276  * @param $entity
 277  *
 278  * @return bool
 279  */
 280 function _civicrm_api3_load_DAO($entity) {
 281   $dao = _civicrm_api3_get_DAO($entity);
 282   if (empty($dao)) {
 283     return FALSE;
 284   }
 285   $d = new $dao();
 286   return $d;
 287 }
 288
 289 /**
 290  * Return the DAO of the function or Entity.
 291  *
 292  * @param string $name
 293  *   Either a function of the api (civicrm_{entity}_create or the entity name.
 294  *   return the DAO name to manipulate this function
 295  *   eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
 296  *
 297  * @return CRM_Core_DAO|string
 298  */
 299 function _civicrm_api3_get_DAO($name) {
 300   if (strpos($name, 'civicrm_api3') !== FALSE) {
 301     $last = strrpos($name, '_');
 302     // len ('civicrm_api3_') == 13
 303     $name = substr($name, 13, $last - 13);
 304   }
 305
 306   $name = _civicrm_api_get_camel_name($name);
 307
 308   if ($name === 'Individual' || $name === 'Household' || $name === 'Organization') {
 309     $name = 'Contact';
 310   }
 311
 312   // hack to deal with incorrectly named BAO/DAO - see CRM-10859
 313
 314   // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingEventQueue
 315   if ($name === 'MailingEventQueue') {
 316     return 'CRM_Mailing_Event_DAO_Queue';
 317   }
 318   // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingRecipients
 319   // but am not confident mailing_recipients is tested so have not tackled.
 320   if ($name === 'MailingRecipients') {
 321     return 'CRM_Mailing_DAO_Recipients';
 322   }
 323   if ($name === 'AclRole') {
 324     return 'CRM_ACL_DAO_ACLEntityRole';
 325   }
 326   // FIXME: DAO should be renamed CRM_SMS_DAO_SmsProvider
 327   // But this would impact SMS extensions so need to coordinate
 328   // Probably best approach is to migrate them to use the api and decouple them from core BAOs
 329   if ($name === 'SmsProvider') {
 330     return 'CRM_SMS_DAO_Provider';
 331   }
 332   // Entity was renamed to CRM_Dedupe_DAO_DedupeRule for APIv4
 333   if ($name === 'Rule') {
 334     return 'CRM_Dedupe_DAO_DedupeRule';
 335   }
 336   // Entity was renamed to CRM_Dedupe_DAO_DedupeRuleGroup for APIv4
 337   if ($name === 'RuleGroup') {
 338     return 'CRM_Dedupe_DAO_DedupeRuleGroup';
 339   }
 340   // Entity was renamed to CRM_Dedupe_DAO_DedupeException for APIv4
 341   if ($name === 'Exception') {
 342     return 'CRM_Dedupe_DAO_DedupeException';
 343   }
 344   // FIXME: DAO names should follow CamelCase convention
 345   if ($name === 'Im' || $name === 'Acl' || $name === 'Pcp') {
 346     $name = strtoupper($name);
 347   }
 348
 349   $dao = CRM_Core_DAO_AllCoreTables::getFullName($name);
 350   if ($dao || !$name) {
 351     return $dao;
 352   }
 353
 354   // Really weird apis can declare their own DAO name. Not sure if this is a good idea...
 355   if (file_exists("api/v3/$name.php")) {
 356     include_once "api/v3/$name.php";
 357   }
 358
 359   $daoFn = '_civicrm_api3_' . _civicrm_api_get_entity_name_from_camel($name) . '_DAO';
 360   if (function_exists($daoFn)) {
 361     return $daoFn();
 362   }
 363
 364   return NULL;
 365 }
 366
 367 /**
 368  * Return the BAO name of the function or Entity.
 369  *
 370  * @param string $name
 371  *   Is either a function of the api (civicrm_{entity}_create or the entity name.
 372  *   return the DAO name to manipulate this function
 373  *   eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
 374  *
 375  * @return string|null
 376  */
 377 function _civicrm_api3_get_BAO($name) {
 378   // FIXME: DAO should be renamed CRM_Badge_DAO_BadgeLayout
 379   if ($name === 'PrintLabel') {
 380     return 'CRM_Badge_BAO_Layout';
 381   }
 382   if ($name === 'Order') {
 383     // Order basically maps to contribution at the top level but
 384     // has enhanced access to other entities.
 385     $name = 'Contribution';
 386   }
 387   if ($name === 'Dedupe') {
 388     // Dedupe is a pseudoentity for PrevNextCache - but accessing dedupe related info
 389     // not the other cache info like search results (which could in fact be in Redis or another cache engine)
 390     $name = 'PrevNextCache';
 391   }
 392   if ($name === 'Payment') {
 393     $name = 'FinancialTrxn';
 394   }
 395   $dao = _civicrm_api3_get_DAO($name);
 396   if (!$dao) {
 397     return NULL;
 398   }
 399   $bao = str_replace("DAO", "BAO", $dao);
 400   $file = strtr($bao, '_', '/') . '.php';
 401   // Check if this entity actually has a BAO. Fall back on the DAO if not.
 402   return stream_resolve_include_path($file) ? $bao : $dao;
 403 }
 404
 405 /**
 406  * Recursive function to explode value-separated strings into arrays.
 407  *
 408  * @param $values
 409  */
 410 function _civicrm_api3_separate_values(&$values) {
 411   $sp = CRM_Core_DAO::VALUE_SEPARATOR;
 412   foreach ($values as $key => & $value) {
 413     if (is_array($value)) {
 414       _civicrm_api3_separate_values($value);
 415     }
 416     elseif (is_string($value)) {
 417       // This is to honor the way case API was originally written.
 418       if ($key === 'case_type_id') {
 419         $value = trim(str_replace($sp, ',', $value), ',');
 420       }
 421       elseif (strpos($value, $sp) !== FALSE) {
 422         $value = explode($sp, trim($value, $sp));
 423       }
 424     }
 425   }
 426 }
 427
 428 /**
 429  * This is a legacy wrapper for api_store_values.
 430  *
 431  * It checks suitable fields using getfields rather than DAO->fields.
 432  *
 433  * Getfields has handling for how to deal with unique names which dao->fields doesn't
 434  *
 435  * Note this is used by BAO type create functions - eg. contribution
 436  *
 437  * @param string $entity
 438  * @param array $params
 439  * @param array $values
 440  */
 441 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values) {
 442   $fields = civicrm_api($entity, 'getfields', ['version' => 3, 'action' => 'create']);
 443   $fields = $fields['values'];
 444   _civicrm_api3_store_values($fields, $params, $values);
 445 }
 446
 447 /**
 448  * Store values.
 449  *
 450  * @param array $fields
 451  * @param array $params
 452  * @param array $values
 453  *
 454  * @return Bool
 455  */
 456 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
 457   $valueFound = FALSE;
 458
 459   $keys = array_intersect_key($params, $fields);
 460   foreach ($keys as $name => $value) {
 461     if ($name !== 'id') {
 462       $values[$name] = $value;
 463       $valueFound = TRUE;
 464     }
 465   }
 466   return $valueFound;
 467 }
 468
 469 /**
 470  * Returns field names of the given entity fields.
 471  *
 472  * @deprecated
 473  * @param array $fields
 474  *   Fields array to retrieve the field names for.
 475  * @return array
 476  */
 477 function _civicrm_api3_field_names($fields) {
 478   CRM_Core_Error::deprecatedFunctionWarning('array_column');
 479   $result = [];
 480   foreach ($fields as $key => $value) {
 481     if (!empty($value['name'])) {
 482       $result[] = $value['name'];
 483     }
 484   }
 485   return $result;
 486 }
 487
 488 /**
 489  * Get function for query object api.
 490  *
 491  * The API supports 2 types of get request. The more complex uses the BAO query object.
 492  *  This is a generic function for those functions that call it
 493  *
 494  *  At the moment only called by contact we should extend to contribution &
 495  *  others that use the query object. Note that this function passes permission information in.
 496  *  The others don't
 497  *
 498  * Ideally this would be merged with _civicrm_get_query_object but we need to resolve differences in what the
 499  * 2 variants call
 500  *
 501  * @param $entity
 502  * @param array $params
 503  *   As passed into api get or getcount function.
 504  * @param array $additional_options
 505  *   Array of options (so we can modify the filter).
 506  * @param bool $getCount
 507  *   Are we just after the count.
 508  * @param int $mode
 509  *   This basically correlates to the component.
 510  * @param null|array $defaultReturnProperties
 511  *   Default return properties for the entity
 512  *  (used if return not set - but don't do that - set return!).
 513  *
 514  * @return array
 515  * @throws API_Exception
 516  */
 517 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = [], $getCount = NULL, $mode = 1, $defaultReturnProperties = NULL) {
 518   $lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity);
 519   // Convert id to e.g. contact_id
 520   if (empty($params[$lowercase_entity . '_id']) && isset($params['id'])) {
 521     $params[$lowercase_entity . '_id'] = $params['id'];
 522   }
 523   unset($params['id']);
 524
 525   $options = _civicrm_api3_get_options_from_params($params, TRUE);
 526
 527   $inputParams = array_merge(
 528     CRM_Utils_Array::value('input_params', $options, []),
 529     CRM_Utils_Array::value('input_params', $additional_options, [])
 530   );
 531   $returnProperties = array_merge(
 532     CRM_Utils_Array::value('return', $options, []),
 533     CRM_Utils_Array::value('return', $additional_options, [])
 534   );
 535   if (empty($returnProperties)) {
 536     $returnProperties = $defaultReturnProperties;
 537   }
 538   if (!empty($params['check_permissions'])) {
 539     // we will filter query object against getfields
 540     $fields = civicrm_api($entity, 'getfields', ['version' => 3, 'action' => 'get']);
 541     // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
 542     $fields['values'][$lowercase_entity . '_id'] = [];
 543     $varsToFilter = ['returnProperties', 'inputParams'];
 544     foreach ($varsToFilter as $varToFilter) {
 545       if (!is_array($$varToFilter)) {
 546         continue;
 547       }
 548       //I was going to throw an exception rather than silently filter out - but
 549       //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
 550       //so we are silently ignoring parts of their request
 551       //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
 552       $$varToFilter = array_intersect_key($$varToFilter, $fields['values']);
 553     }
 554   }
 555   $options = array_merge($options, $additional_options);
 556   $sort             = $options['sort'] ?? NULL;
 557   $offset             = $options['offset'] ?? NULL;
 558   $limit             = $options['limit'] ?? NULL;
 559   $smartGroupCache  = $params['smartGroupCache'] ?? NULL;
 560
 561   if ($getCount) {
 562     $limit = NULL;
 563     $returnProperties = NULL;
 564   }
 565
 566   if (substr($sort, 0, 2) == 'id') {
 567     $sort = $lowercase_entity . "_" . $sort;
 568   }
 569
 570   $newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams);
 571
 572   $skipPermissions = !empty($params['check_permissions']) ? 0 : 1;
 573
 574   list($entities) = CRM_Contact_BAO_Query::apiQuery(
 575     $newParams,
 576     $returnProperties,
 577     NULL,
 578     $sort,
 579     $offset,
 580     $limit,
 581     $smartGroupCache,
 582     $getCount,
 583     $skipPermissions,
 584     $mode,
 585     $entity,
 586     TRUE
 587   );
 588
 589   return $entities;
 590 }
 591
 592 /**
 593  * Get dao query object based on input params.
 594  *
 595  * Ideally this would be merged with _civicrm_get_using_query_object but we need to resolve differences in what the
 596  * 2 variants call
 597  *
 598  * @param array $params
 599  * @param string $mode
 600  * @param string $entity
 601  *
 602  * @return array
 603  *   [CRM_Core_DAO|CRM_Contact_BAO_Query]
 604  */
 605 function _civicrm_api3_get_query_object($params, $mode, $entity) {
 606   $options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get');
 607   $sort = $options['sort'] ?? NULL;
 608   $offset = $options['offset'] ?? NULL;
 609   $rowCount = $options['limit'] ?? NULL;
 610   $inputParams = CRM_Utils_Array::value('input_params', $options, []);
 611   $returnProperties = $options['return'] ?? NULL;
 612   if (empty($returnProperties)) {
 613     $returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties($mode);
 614   }
 615
 616   $newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams, 0, FALSE, $entity);
 617   $query = new CRM_Contact_BAO_Query($newParams, $returnProperties, NULL,
 618     FALSE, FALSE, $mode,
 619     empty($params['check_permissions']),
 620     TRUE, TRUE, NULL, 'AND', 'NULL', TRUE
 621   );
 622   list($select, $from, $where, $having) = $query->query();
 623
 624   $sql = "$select $from $where $having";
 625
 626   if (!empty($sort)) {
 627     $sort = CRM_Utils_Type::escape($sort, 'MysqlOrderBy');
 628     $sql .= " ORDER BY $sort ";
 629   }
 630   if (!empty($rowCount)) {
 631     $sql .= " LIMIT $offset, $rowCount ";
 632   }
 633   $dao = CRM_Core_DAO::executeQuery($sql);
 634   return [$dao, $query];
 635 }
 636
 637 /**
 638  * Function transfers the filters being passed into the DAO onto the params object.
 639  *
 640  * @deprecated DAO based retrieval is being phased out.
 641  *
 642  * @param CRM_Core_DAO $dao
 643  * @param array $params
 644  * @param bool $unique
 645  * @param array $extraSql
 646  *   API specific queries eg for event isCurrent would be converted to
 647  *   $extraSql['where'] = array('civicrm_event' => array('(start_date >= CURDATE() || end_date >= CURDATE())'));
 648  *
 649  * @throws API_Exception
 650  * @throws Exception
 651  */
 652 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $extraSql = []) {
 653   $entity = _civicrm_api_get_entity_name_from_dao($dao);
 654   $lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity);
 655   if (!empty($params[$lowercase_entity . "_id"]) && empty($params['id'])) {
 656     //if entity_id is set then treat it as ID (will be overridden by id if set)
 657     $params['id'] = $params[$lowercase_entity . "_id"];
 658   }
 659   $allfields = _civicrm_api3_build_fields_array($dao, $unique);
 660   $fields = array_intersect(array_keys($allfields), array_keys($params));
 661
 662   $options = _civicrm_api3_get_options_from_params($params);
 663   //apply options like sort
 664   _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
 665
 666   //accept filters like filter.activity_date_time_high
 667   // std is now 'filters' => ..
 668   if (strstr(implode(',', array_keys($params)), 'filter')) {
 669     if (isset($params['filters']) && is_array($params['filters'])) {
 670       foreach ($params['filters'] as $paramkey => $paramvalue) {
 671         _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
 672       }
 673     }
 674     else {
 675       foreach ($params as $paramkey => $paramvalue) {
 676         if (strstr($paramkey, 'filter')) {
 677           _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
 678         }
 679       }
 680     }
 681   }
 682   if (!$fields) {
 683     $fields = [];
 684   }
 685
 686   foreach ($fields as $field) {
 687     if (is_array($params[$field])) {
 688       //get the actual fieldname from db
 689       $fieldName = $allfields[$field]['name'];
 690       $where = CRM_Core_DAO::createSqlFilter($fieldName, $params[$field], 'String');
 691       if (!empty($where)) {
 692         $dao->whereAdd($where);
 693       }
 694     }
 695     else {
 696       if ($unique) {
 697         $daoFieldName = $allfields[$field]['name'];
 698         if (empty($daoFieldName)) {
 699           throw new API_Exception("Failed to determine field name for \"$field\"");
 700         }
 701         $dao->{$daoFieldName} = $params[$field];
 702       }
 703       else {
 704         $dao->$field = $params[$field];
 705       }
 706     }
 707   }
 708   if (!empty($extraSql['where'])) {
 709     foreach ($extraSql['where'] as $table => $sqlWhere) {
 710       foreach ($sqlWhere as $where) {
 711         $dao->whereAdd($where);
 712       }
 713     }
 714   }
 715   if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) {
 716     $dao->selectAdd();
 717     // Ensure 'id' is included.
 718     $options['return']['id'] = TRUE;
 719     $allfields = _civicrm_api3_get_unique_name_array($dao);
 720     $returnMatched = array_intersect(array_keys($options['return']), $allfields);
 721     foreach ($returnMatched as $returnValue) {
 722       $dao->selectAdd($returnValue);
 723     }
 724
 725     // Not already matched on the field names.
 726     $unmatchedFields = array_diff(
 727       array_keys($options['return']),
 728       $returnMatched
 729     );
 730
 731     $returnUniqueMatched = array_intersect(
 732       $unmatchedFields,
 733       // But a match for the field keys.
 734       array_flip($allfields)
 735     );
 736     foreach ($returnUniqueMatched as $uniqueVal) {
 737       $dao->selectAdd($allfields[$uniqueVal]);
 738     }
 739   }
 740   $dao->setApiFilter($params);
 741 }
 742
 743 /**
 744  * Apply filters (e.g. high, low) to DAO object (prior to find).
 745  *
 746  * @param string $filterField
 747  *   Field name of filter.
 748  * @param string $filterValue
 749  *   Field value of filter.
 750  * @param object $dao
 751  *   DAO object.
 752  */
 753 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
 754   if (strstr($filterField, 'high')) {
 755     $fieldName = substr($filterField, 0, -5);
 756     $dao->whereAdd("($fieldName <= $filterValue )");
 757   }
 758   if (strstr($filterField, 'low')) {
 759     $fieldName = substr($filterField, 0, -4);
 760     $dao->whereAdd("($fieldName >= $filterValue )");
 761   }
 762   if ($filterField == 'is_current' && $filterValue == 1) {
 763     $todayStart = date('Ymd000000', strtotime('now'));
 764     $todayEnd = date('Ymd235959', strtotime('now'));
 765     $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
 766     if (property_exists($dao, 'is_active')) {
 767       $dao->whereAdd('is_active = 1');
 768     }
 769   }
 770 }
 771
 772 /**
 773  * Get sort, limit etc options from the params - supporting old & new formats.
 774  *
 775  * Get returnProperties for legacy
 776  *
 777  * @param array $params
 778  *   Params array as passed into civicrm_api.
 779  * @param bool $queryObject
 780  *   Is this supporting a queryObject api (e.g contact) - if so we support more options.
 781  *   for legacy report & return a unique fields array
 782  *
 783  * @param string $entity
 784  * @param string $action
 785  *
 786  * @throws API_Exception
 787  * @return array
 788  *   options extracted from params
 789  */
 790 function _civicrm_api3_get_options_from_params($params, $queryObject = FALSE, $entity = '', $action = '') {
 791   $lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity);
 792   $is_count = FALSE;
 793
 794   // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
 795   $sort = $params['option_sort'] ?? $params['option.sort'] ?? $params['sort'] ?? 0;
 796   $offset = $params['option_offset'] ?? $params['option.offset'] ?? $params['offset'] ?? 0;
 797
 798   $limit = CRM_Utils_Array::value('rowCount', $params, 25);
 799   $limit = CRM_Utils_Array::value('option.limit', $params, $limit);
 800   $limit = CRM_Utils_Array::value('option_limit', $params, $limit);
 801
 802   if (isset($params['options']) && is_array($params['options'])) {
 803     // is count is set by generic getcount not user
 804     $is_count = $params['options']['is_count'] ?? FALSE;
 805     $offset = $params['options']['offset'] ?? $offset;
 806     $limit = CRM_Utils_Array::value('limit', $params['options'], $limit);
 807     $sort = $params['options']['sort'] ?? $sort;
 808   }
 809
 810   $returnProperties = [];
 811   // handle the format return =sort_name,display_name...
 812   if (array_key_exists('return', $params)) {
 813     if (is_array($params['return'])) {
 814       $returnProperties = array_fill_keys($params['return'], 1);
 815     }
 816     else {
 817       $returnProperties = explode(',', str_replace(' ', '', $params['return']));
 818       $returnProperties = array_fill_keys($returnProperties, 1);
 819     }
 820   }
 821   if ($entity && $action == 'get') {
 822     if (!empty($returnProperties['id'])) {
 823       $returnProperties[$lowercase_entity . '_id'] = 1;
 824       unset($returnProperties['id']);
 825     }
 826   }
 827
 828   $options = [
 829     'offset' => CRM_Utils_Rule::integer($offset) ? $offset : NULL,
 830     'limit' => (!$is_count && CRM_Utils_Rule::integer($limit)) ? $limit : NULL,
 831     'is_count' => $is_count,
 832     'return' => !empty($returnProperties) ? $returnProperties : [],
 833   ];
 834
 835   $finalSort = [];
 836   $options['sort'] = NULL;
 837   if (!empty($sort)) {
 838     if (!is_array($sort)) {
 839       $sort = array_map('trim', explode(',', $sort));
 840     }
 841     foreach ($sort as $s) {
 842       if ($s === '(1)' || CRM_Utils_Rule::mysqlOrderBy($s)) {
 843         if ($entity && $action === 'get') {
 844           switch (trim(strtolower($s))) {
 845             case 'id':
 846             case 'id desc':
 847             case 'id asc':
 848               $s = str_replace('id', $lowercase_entity . '_id', $s);
 849           }
 850         }
 851         $finalSort[] = $s;
 852       }
 853       else {
 854         throw new API_Exception("Unknown field specified for sort. Cannot order by '$s'");
 855       }
 856     }
 857     $options['sort'] = implode(', ', $finalSort);
 858   }
 859
 860   if ($options['sort'] && stristr($options['sort'], 'SELECT')) {
 861     throw new API_Exception('invalid string in sort options');
 862   }
 863
 864   if (!$queryObject) {
 865     return $options;
 866   }
 867   //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
 868   // if the query object is being used this should be used
 869   $inputParams = [];
 870   $legacyreturnProperties = [];
 871   $otherVars = [
 872     'sort', 'offset', 'rowCount', 'options', 'return',
 873     'version', 'prettyprint', 'check_permissions', 'sequential',
 874   ];
 875   foreach ($params as $n => $v) {
 876     if (substr($n, 0, 7) === 'return.') {
 877       $legacyreturnProperties[substr($n, 7)] = $v;
 878     }
 879     elseif ($n === 'id') {
 880       $inputParams[$lowercase_entity . '_id'] = $v;
 881     }
 882     elseif (!in_array($n, $otherVars)) {
 883       $inputParams[$n] = $v;
 884       if ($v && !is_array($v) && stristr($v, 'SELECT')) {
 885         throw new API_Exception('invalid string');
 886       }
 887     }
 888   }
 889   $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
 890   $options['input_params'] = $inputParams;
 891   return $options;
 892 }
 893
 894 /**
 895  * Apply options (e.g. sort, limit, order by) to DAO object (prior to find).
 896  *
 897  * @param array $params
 898  *   Params array as passed into civicrm_api.
 899  * @param object $dao
 900  *   DAO object.
 901  * @param $entity
 902  *
 903  * @throws \API_Exception
 904  * @throws \CRM_Core_Exception
 905  */
 906 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
 907
 908   $options = _civicrm_api3_get_options_from_params($params, FALSE, $entity);
 909   if (!$options['is_count']) {
 910     if (!empty($options['limit'])) {
 911       $dao->limit((int) $options['offset'], (int) $options['limit']);
 912     }
 913     if (!empty($options['sort'])) {
 914       $options['sort'] = CRM_Utils_Type::escape($options['sort'], 'MysqlOrderBy');
 915       $dao->orderBy($options['sort']);
 916     }
 917   }
 918 }
 919
 920 /**
 921  * Build fields array.
 922  *
 923  * This is the array of fields as it relates to the given DAO
 924  * returns unique fields as keys by default but if set but can return by DB fields
 925  *
 926  * @param CRM_Core_DAO $bao
 927  * @param bool $unique
 928  *
 929  * @return array
 930  */
 931 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
 932   $fields = $bao->fields();
 933   if ($unique) {
 934     if (empty($fields['id'])) {
 935       $lowercase_entity = _civicrm_api_get_entity_name_from_camel(_civicrm_api_get_entity_name_from_dao($bao));
 936       if (isset($fields[$lowercase_entity . '_id'])) {
 937         $fields['id'] = $fields[$lowercase_entity . '_id'];
 938         unset($fields[$lowercase_entity . '_id']);
 939       }
 940     }
 941     return $fields;
 942   }
 943
 944   foreach ($fields as $field) {
 945     $dbFields[$field['name']] = $field;
 946   }
 947   return $dbFields;
 948 }
 949
 950 /**
 951  * Build fields array.
 952  *
 953  * This is the array of fields as it relates to the given DAO
 954  * returns unique fields as keys by default but if set but can return by DB fields
 955  *
 956  * @param CRM_Core_DAO $bao
 957  *
 958  * @return array
 959  */
 960 function _civicrm_api3_get_unique_name_array(&$bao) {
 961   $fields = $bao->fields();
 962   foreach ($fields as $field => $values) {
 963     $uniqueFields[$field] = CRM_Utils_Array::value('name', $values, $field);
 964   }
 965   return $uniqueFields;
 966 }
 967
 968 /**
 969  * Converts an DAO object to an array.
 970  *
 971  * @param CRM_Core_DAO $dao
 972  *   Object to convert.
 973  * @param array $params
 974  * @param bool $uniqueFields
 975  * @param string $entity
 976  * @param bool $autoFind
 977  *
 978  * @return array
 979  *
 980  * @throws \API_Exception
 981  *
 982  * @deprecated - DAO based retrieval is being phased out.
 983  *
 984  */
 985 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) {
 986   $result = [];
 987   if (isset($params['options']) && !empty($params['options']['is_count'])) {
 988     return $dao->count();
 989   }
 990   if (empty($dao)) {
 991     return [];
 992   }
 993   if ($autoFind && !$dao->find()) {
 994     return [];
 995   }
 996
 997   if (isset($dao->count)) {
 998     return $dao->count;
 999   }
1000
1001   $fields = array_keys(_civicrm_api3_build_fields_array($dao, FALSE));
1002   while ($dao->fetch()) {
1003     $tmp = [];
1004     foreach ($fields as $key) {
1005       if (property_exists($dao, $key)) {
1006         // not sure on that one
1007         if ($dao->$key !== NULL) {
1008           $tmp[$key] = $dao->$key;
1009         }
1010       }
1011     }
1012     $result[$dao->id] = $tmp;
1013
1014     if (_civicrm_api3_custom_fields_are_required($entity, $params)) {
1015       _civicrm_api3_custom_data_get($result[$dao->id], $params['check_permissions'], $entity, $dao->id);
1016     }
1017   }
1018
1019   return $result;
1020 }
1021
1022 /**
1023  * Determine if custom fields need to be retrieved.
1024  *
1025  * We currently retrieve all custom fields or none at this level so if we know the entity
1026  * && it can take custom fields & there is the string 'custom' in their return request we get them all, they are filtered on the way out
1027  *
1028  * @param string $entity
1029  *   Entity name in CamelCase.
1030  * @param array $params
1031  *
1032  * @return bool
1033  * @throws \API_Exception
1034  *
1035  * @todo filter so only required fields are queried
1036  */
1037 function _civicrm_api3_custom_fields_are_required($entity, $params) {
1038   if (!array_key_exists($entity, CRM_Core_BAO_CustomQuery::$extendsMap)) {
1039     return FALSE;
1040   }
1041   $options = _civicrm_api3_get_options_from_params($params);
1042   // We check for possibility of 'custom' => 1 as well as specific custom fields.
1043   $returnString = implode('', $options['return']) . implode('', array_keys($options['return']));
1044   if (stristr($returnString, 'custom')) {
1045     return TRUE;
1046   }
1047 }
1048
1049 /**
1050  * Converts an object to an array.
1051  *
1052  * @param object $dao
1053  *   (reference) object to convert.
1054  * @param array $values
1055  *   (reference) array.
1056  * @param array|bool $uniqueFields
1057  */
1058 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
1059
1060   $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
1061   foreach ($fields as $key => $value) {
1062     if (property_exists($dao, $key)) {
1063       $values[$key] = $dao->$key ?? NULL;
1064     }
1065   }
1066 }
1067
1068 /**
1069  * Wrapper for _civicrm_object_to_array when api supports unique fields.
1070  *
1071  * @param $dao
1072  * @param $values
1073  *
1074  * @return array
1075  */
1076 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
1077   return _civicrm_api3_object_to_array($dao, $values, TRUE);
1078 }
1079
1080 /**
1081  * Format custom parameters.
1082  *
1083  * @param array $params
1084  * @param array $values
1085  * @param string $extends
1086  *   Entity that this custom field extends (e.g. contribution, event, contact).
1087  * @param string $entityId
1088  *   ID of entity per $extends.
1089  */
1090 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
1091   if (!empty($params['custom']) && empty($params['check_permissions'])) {
1092     // The Import class does the formatting first - ideally it wouldn't but this early return
1093     // provides transitional support.
1094     return;
1095   }
1096   $values['custom'] = [];
1097   $checkCheckBoxField = FALSE;
1098   $entity = $extends;
1099   if (in_array($extends, ['Household', 'Individual', 'Organization'])) {
1100     $entity = 'Contact';
1101   }
1102
1103   $fields = civicrm_api($entity, 'getfields', ['version' => 3, 'action' => 'create']);
1104   if (!$fields['is_error']) {
1105     // not sure if fields could be error - maybe change to using civicrm_api3 wrapper later - this is conservative
1106     $fields = $fields['values'];
1107     $checkCheckBoxField = TRUE;
1108   }
1109
1110   foreach ($params as $key => $value) {
1111     list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField::getKeyID($key, TRUE);
1112     if ($customFieldID && (!is_null($value))) {
1113       if ($checkCheckBoxField && !empty($fields['custom_' . $customFieldID]) && $fields['custom_' . $customFieldID]['html_type'] == 'CheckBox') {
1114         formatCheckBoxField($value, 'custom_' . $customFieldID, $entity);
1115       }
1116
1117       CRM_Core_BAO_CustomField::formatCustomField($customFieldID, $values['custom'],
1118         $value, $extends, $customValueID, $entityId, FALSE, !empty($params['check_permissions']), TRUE
1119       );
1120     }
1121   }
1122 }
1123
1124 /**
1125  * Format parameters for create action.
1126  *
1127  * @param array $params
1128  * @param $entity
1129  */
1130 function _civicrm_api3_format_params_for_create(&$params, $entity) {
1131   $nonGenericEntities = ['Contact', 'Individual', 'Household', 'Organization'];
1132
1133   $customFieldEntities = array_diff_key(CRM_Core_SelectValues::customGroupExtends(), array_fill_keys($nonGenericEntities, 1));
1134   if (!array_key_exists($entity, $customFieldEntities)) {
1135     return;
1136   }
1137   $values = [];
1138   _civicrm_api3_custom_format_params($params, $values, $entity);
1139   $params = array_merge($params, $values);
1140 }
1141
1142 /**
1143  * We can't rely on downstream to add separators to checkboxes so we'll check here.
1144  *
1145  * We should look at pushing to BAO function
1146  * and / or validate function but this is a safe place for now as it has massive test coverage & we can keep the change very specific
1147  * note that this is specifically tested in the GRANT api test case so later refactoring should use that as a checking point
1148  *
1149  * We will only alter the value if we are sure that changing it will make it correct - if it appears wrong but does not appear to have a clear fix we
1150  * don't touch - lots of very cautious code in here
1151  *
1152  * The resulting array should look like
1153  * array(
1154  *  'key' => 1,
1155  *  'key1' => 1,
1156  * );
1157  *
1158  * OR one or more keys wrapped in a CRM_Core_DAO::VALUE_SEPARATOR - either it accepted by the receiving function
1159  *
1160  * @todo - we are probably skipping handling disabled options as presumably getoptions is not giving us them. This should be non-regressive but might
1161  * be fixed in future
1162  *
1163  * @param mixed $checkboxFieldValue
1164  * @param string $customFieldLabel
1165  * @param string $entity
1166  */
1167 function formatCheckBoxField(&$checkboxFieldValue, $customFieldLabel, $entity) {
1168
1169   if (is_string($checkboxFieldValue) && stristr($checkboxFieldValue, CRM_Core_DAO::VALUE_SEPARATOR)) {
1170     // We can assume it's pre-formatted.
1171     return;
1172   }
1173   $options = civicrm_api($entity, 'getoptions', ['field' => $customFieldLabel, 'version' => 3]);
1174   if (!empty($options['is_error'])) {
1175     // The check is precautionary - can probably be removed later.
1176     return;
1177   }
1178
1179   $options = $options['values'];
1180   $validValue = TRUE;
1181   if (is_array($checkboxFieldValue)) {
1182     foreach ($checkboxFieldValue as $key => $value) {
1183       if (!array_key_exists($key, $options)) {
1184         $validValue = FALSE;
1185       }
1186     }
1187     if ($validValue) {
1188       // we have been passed an array that is already in the 'odd' custom field format
1189       return;
1190     }
1191   }
1192
1193   // so we either have an array that is not keyed by the value or we have a string that doesn't hold separators
1194   // if the array only has one item we'll treat it like any other string
1195   if (is_array($checkboxFieldValue) && count($checkboxFieldValue) == 1) {
1196     $possibleValue = reset($checkboxFieldValue);
1197   }
1198   if (is_string($checkboxFieldValue)) {
1199     $possibleValue = $checkboxFieldValue;
1200   }
1201   if (isset($possibleValue) && array_key_exists($possibleValue, $options)) {
1202     $checkboxFieldValue = CRM_Core_DAO::VALUE_SEPARATOR . $possibleValue . CRM_Core_DAO::VALUE_SEPARATOR;
1203     return;
1204   }
1205   elseif (is_array($checkboxFieldValue)) {
1206     // so this time around we are considering the values in the array
1207     $possibleValues = $checkboxFieldValue;
1208     $formatValue = TRUE;
1209   }
1210   elseif (stristr($checkboxFieldValue, ',')) {
1211     $formatValue = TRUE;
1212     //lets see if we should separate it - we do this near the end so we
1213     // ensure we have already checked that the comma is not part of a legitimate match
1214     // and of course, we don't make any changes if we don't now have matches
1215     $possibleValues = explode(',', $checkboxFieldValue);
1216   }
1217   else {
1218     // run out of ideas as to what the format might be - if it's a string it doesn't match with or without the ','
1219     return;
1220   }
1221
1222   foreach ($possibleValues as $index => $possibleValue) {
1223     if (array_key_exists($possibleValue, $options)) {
1224       // do nothing - we will leave formatValue set to true unless another value is not found (which would cause us to ignore the whole value set)
1225     }
1226     elseif (array_key_exists(trim($possibleValue), $options)) {
1227       $possibleValues[$index] = trim($possibleValue);
1228     }
1229     else {
1230       $formatValue = FALSE;
1231     }
1232   }
1233   if ($formatValue) {
1234     $checkboxFieldValue = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $possibleValues) . CRM_Core_DAO::VALUE_SEPARATOR;
1235   }
1236 }
1237
1238 /**
1239  * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this.
1240  *
1241  * @param string|CRM_Core_DAO $bao_name
1242  *   Name of BAO.
1243  * @param array $params
1244  *   Params from api.
1245  * @param bool $returnAsSuccess
1246  *   Return in api success format.
1247  * @param string $entity
1248  * @param CRM_Utils_SQL_Select|NULL $sql
1249  *   Extra SQL bits to add to the query. For filtering current events, this might be:
1250  *   CRM_Utils_SQL_Select::fragment()->where('(start_date >= CURDATE() || end_date >= CURDATE())');
1251  * @param bool $uniqueFields
1252  *   Should unique field names be returned (for backward compatibility)
1253  *
1254  * @return array
1255  */
1256 function _civicrm_api3_basic_get($bao_name, $params, $returnAsSuccess = TRUE, $entity = "", $sql = NULL, $uniqueFields = FALSE) {
1257   $entity = $entity ?: CRM_Core_DAO_AllCoreTables::getBriefName($bao_name);
1258   $options = _civicrm_api3_get_options_from_params($params);
1259
1260   // Skip query if table doesn't exist yet due to pending upgrade
1261   if (!$bao_name::tableHasBeenAdded()) {
1262     \Civi::log()->warning("Could not read from {$entity} before table has been added. Upgrade required.", ['civi.tag' => 'upgrade_needed']);
1263     $result = [];
1264   }
1265   else {
1266     $query = new \Civi\API\Api3SelectQuery($entity, $params['check_permissions'] ?? FALSE);
1267     $query->where = $params;
1268     if ($options['is_count']) {
1269       $query->select = ['count_rows'];
1270     }
1271     else {
1272       $query->select = array_keys(array_filter($options['return']));
1273       $query->orderBy = $options['sort'];
1274       $query->isFillUniqueFields = $uniqueFields;
1275     }
1276     $query->limit = $options['limit'];
1277     $query->offset = $options['offset'];
1278     $query->merge($sql);
1279     $result = $query->run();
1280   }
1281
1282   if ($returnAsSuccess) {
1283     return civicrm_api3_create_success($result, $params, $entity, 'get');
1284   }
1285   return $result;
1286 }
1287
1288 /**
1289  * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this.
1290  *
1291  * @param string $bao_name
1292  *   Name of BAO Class.
1293  * @param array $params
1294  *   Parameters passed into the api call.
1295  * @param string $entity
1296  *   Entity - pass in if entity is non-standard & required $ids array.
1297  *
1298  * @throws API_Exception
1299  * @throws \Civi\API\Exception\UnauthorizedException
1300  * @return array
1301  */
1302 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
1303   _civicrm_api3_check_edit_permissions($bao_name, $params);
1304   _civicrm_api3_format_params_for_create($params, $entity);
1305   $args = array(&$params);
1306   if ($entity) {
1307     $ids = [$entity => CRM_Utils_Array::value('id', $params)];
1308     $args[] = &$ids;
1309   }
1310
1311   if (method_exists($bao_name, 'create')) {
1312     $fct = 'create';
1313     $fct_name = $bao_name . '::' . $fct;
1314     $bao = call_user_func_array([$bao_name, $fct], $args);
1315   }
1316   elseif (method_exists($bao_name, 'add')) {
1317     $fct = 'add';
1318     $fct_name = $bao_name . '::' . $fct;
1319     $bao = call_user_func_array([$bao_name, $fct], $args);
1320   }
1321   else {
1322     $fct_name = '_civicrm_api3_basic_create_fallback';
1323     $bao = _civicrm_api3_basic_create_fallback($bao_name, $params);
1324   }
1325
1326   if (is_null($bao)) {
1327     return civicrm_api3_create_error('Entity not created (' . $fct_name . ')');
1328   }
1329   elseif (is_a($bao, 'CRM_Core_Error')) {
1330     //some weird circular thing means the error takes itself as an argument
1331     $msg = $bao->getMessages($bao);
1332     // the api deals with entities on a one-by-one basis. However, the contribution bao pushes entities
1333     // onto the error object - presumably because the contribution import is not handling multiple errors correctly
1334     // so we need to reset the error object here to avoid getting concatenated errors
1335     //@todo - the mulitple error handling should be moved out of the contribution object to the import / multiple entity processes
1336     CRM_Core_Error::singleton()->reset();
1337     throw new API_Exception($msg);
1338   }
1339   else {
1340     // If we have custom fields the BAO may have taken care of it or we may have to.
1341     // $extendsMap provides a pretty good hard-coded list of BAOs that take care of the custom data.
1342     if (isset($params['custom']) && empty(CRM_Core_BAO_CustomQuery::$extendsMap[$entity])) {
1343       CRM_Core_BAO_CustomValueTable::store($params['custom'], CRM_Core_DAO_AllCoreTables::getTableForClass(CRM_Core_DAO_AllCoreTables::getFullName($entity)), $bao->id);
1344     }
1345     $values = [];
1346     _civicrm_api3_object_to_array($bao, $values[$bao->id]);
1347     return civicrm_api3_create_success($values, $params, $entity, 'create', $bao);
1348   }
1349 }
1350
1351 /**
1352  * For BAO's which don't have a create() or add() functions, use this fallback implementation.
1353  *
1354  * @param string|CRM_Core_DAO $bao_name
1355  * @param array $params
1356  *
1357  * @throws API_Exception
1358  *
1359  * @return CRM_Core_DAO|NULL
1360  *   An instance of the BAO
1361  */
1362 function _civicrm_api3_basic_create_fallback($bao_name, $params) {
1363   return $bao_name::writeRecord($params);
1364 }
1365
1366 /**
1367  * Function to do a 'standard' api del.
1368  *
1369  * When the api is only doing a $bao::del then use this if api::del doesn't exist it will try DAO delete method.
1370  *
1371  * @param string|CRM_Core_DAO $bao_name
1372  * @param array $params
1373  *
1374  * @return array
1375  *   API result array
1376  *
1377  * @throws API_Exception
1378  * @throws \Civi\API\Exception\UnauthorizedException
1379  * @throws \CiviCRM_API3_Exception
1380  */
1381 function _civicrm_api3_basic_delete($bao_name, &$params) {
1382   civicrm_api3_verify_mandatory($params, NULL, ['id']);
1383   _civicrm_api3_check_edit_permissions($bao_name, ['id' => $params['id']]);
1384   if (method_exists($bao_name, 'del')) {
1385     $args = [&$params['id']];
1386     $dao = new $bao_name();
1387     $dao->id = $params['id'];
1388     if ($dao->find()) {
1389       $bao = call_user_func_array([$bao_name, 'del'], $args);
1390       if ($bao !== FALSE) {
1391         return civicrm_api3_create_success();
1392       }
1393       throw new API_Exception('Could not delete entity id ' . $params['id']);
1394     }
1395     throw new API_Exception('Could not delete entity id ' . $params['id']);
1396   }
1397   else {
1398     $bao_name::deleteRecord($params);
1399     return civicrm_api3_create_success();
1400   }
1401 }
1402
1403 /**
1404  * Get custom data for the given entity & Add it to the returnArray.
1405  *
1406  * This looks like 'custom_123' = 'custom string' AND
1407  * 'custom_123_1' = 'custom string'
1408  * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1409  *
1410  * @param array $returnArray
1411  *   Array to append custom data too - generally $result[4] where 4 is the entity id.
1412  * @param $checkPermission
1413  * @param string $entity
1414  *   E.g membership, event.
1415  * @param int $entity_id
1416  * @param int $groupID
1417  *   Per CRM_Core_BAO_CustomGroup::getTree.
1418  * @param int $subType
1419  *   E.g. membership_type_id where custom data doesn't apply to all membership types.
1420  * @param string $subName
1421  *   Subtype of entity.
1422  *
1423  * @throws \CRM_Core_Exception
1424  */
1425 function _civicrm_api3_custom_data_get(&$returnArray, $checkPermission, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1426   $groupTree = CRM_Core_BAO_CustomGroup::getTree($entity,
1427     NULL,
1428     $entity_id,
1429     $groupID,
1430     NULL,
1431     $subName,
1432     TRUE,
1433     NULL,
1434     TRUE,
1435     $checkPermission ? CRM_Core_Permission::VIEW : FALSE
1436   );
1437   $groupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1);
1438   $customValues = [];
1439   CRM_Core_BAO_CustomGroup::setDefaults($groupTree, $customValues);
1440   $fieldInfo = [];
1441   foreach ($groupTree as $set) {
1442     $fieldInfo += $set['fields'];
1443   }
1444   if (!empty($customValues)) {
1445     foreach ($customValues as $key => $val) {
1446       // per standard - return custom_fieldID
1447       $id = CRM_Core_BAO_CustomField::getKeyID($key);
1448       $returnArray['custom_' . $id] = $val;
1449
1450       //not standard - but some api did this so guess we should keep - cheap as chips
1451       $returnArray[$key] = $val;
1452
1453       // Shim to restore legacy behavior of ContactReference custom fields
1454       if (!empty($fieldInfo[$id]) && $fieldInfo[$id]['data_type'] === 'ContactReference') {
1455         $returnArray['custom_' . $id . '_id'] = $returnArray[$key . '_id'] = $val;
1456         $returnArray['custom_' . $id] = $returnArray[$key] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $val, 'sort_name');
1457       }
1458     }
1459   }
1460 }
1461
1462 /**
1463  * Used by the Validate API.
1464  *
1465  * @param string $entity
1466  * @param string $action
1467  * @param array $params
1468  *
1469  * @return array $errors
1470  * @throws \CiviCRM_API3_Exception
1471  */
1472 function _civicrm_api3_validate($entity, $action, $params) {
1473   $errors = [];
1474   $fields = civicrm_api3($entity, 'getfields', ['sequential' => 1, 'api_action' => $action]);
1475   $fields = $fields['values'];
1476
1477   // Check for required fields.
1478   foreach ($fields as $values) {
1479     if (!empty($values['api.required']) && empty($params[$values['name']])) {
1480       $errors[$values['name']] = [
1481         'message' => 'Mandatory key(s) missing from params array: ' . $values['name'],
1482         'code' => 'mandatory_missing',
1483       ];
1484     }
1485   }
1486
1487   // Select only the fields which have been input as a param.
1488   $finalfields = [];
1489   foreach ($fields as $values) {
1490     if (array_key_exists($values['name'], $params)) {
1491       $finalfields[] = $values;
1492     }
1493   }
1494
1495   // This derives heavily from the function "_civicrm_api3_validate_fields".
1496   // However, the difference is that try-catch blocks are nested in the loop, making it
1497   // possible for us to get all errors in one go.
1498   foreach ($finalfields as $fieldInfo) {
1499     $fieldName = $fieldInfo['name'];
1500     try {
1501       _civicrm_api3_validate_switch_cases($fieldName, $fieldInfo, $entity, $params);
1502     }
1503     catch (Exception $e) {
1504       $errors[$fieldName] = [
1505         'message' => $e->getMessage(),
1506         'code' => 'incorrect_value',
1507       ];
1508     }
1509   }
1510
1511   return [$errors];
1512 }
1513
1514 /**
1515  * Used by the Validate API.
1516  * @param $fieldName
1517  * @param array $fieldInfo
1518  * @param string $entity
1519  * @param array $params
1520  *
1521  * @throws API_Exception
1522  * @throws Exception
1523  */
1524 function _civicrm_api3_validate_switch_cases($fieldName, $fieldInfo, $entity, $params) {
1525   switch (CRM_Utils_Array::value('type', $fieldInfo)) {
1526     case CRM_Utils_Type::T_INT:
1527       _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1528       break;
1529
1530     case CRM_Utils_Type::T_DATE:
1531     case CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME:
1532     case CRM_Utils_Type::T_TIMESTAMP:
1533       //field is of type date or datetime
1534       _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1535       break;
1536
1537     case CRM_Utils_Type::T_TEXT:
1538     case CRM_Utils_Type::T_STRING:
1539       _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1540       break;
1541
1542     case CRM_Utils_Type::T_MONEY:
1543       list($fieldValue, $op) = _civicrm_api3_field_value_check($params, $fieldName);
1544
1545       foreach ((array) $fieldValue as $fieldvalue) {
1546         if (!CRM_Utils_Rule::money($fieldvalue) && !empty($fieldvalue)) {
1547           throw new Exception($fieldName . ' is  not a valid amount: ' . $params[$fieldName]);
1548         }
1549       }
1550       break;
1551   }
1552 }
1553
1554 /**
1555  * Validate fields being passed into API.
1556  *
1557  * This function relies on the getFields function working accurately
1558  * for the given API.
1559  *
1560  * As of writing only date was implemented.
1561  *
1562  * @param string $entity
1563  * @param string $action
1564  * @param array $params
1565  *   -.
1566  * @param array $fields
1567  *   Response from getfields all variables are the same as per civicrm_api.
1568  *
1569  * @throws Exception
1570  */
1571 function _civicrm_api3_validate_fields($entity, $action, &$params, $fields) {
1572   //CRM-15792 handle datetime for custom fields below code handles chain api call
1573   $chainApikeys = array_flip(preg_grep("/^api./", array_keys($params)));
1574   if (!empty($chainApikeys) && is_array($chainApikeys)) {
1575     foreach ($chainApikeys as $key => $value) {
1576       if (is_array($params[$key])) {
1577         $chainApiParams = array_intersect_key($fields, $params[$key]);
1578         $customFields = array_fill_keys(array_keys($params[$key]), $key);
1579       }
1580     }
1581   }
1582   $fields = array_intersect_key($fields, $params);
1583   if (!empty($chainApiParams)) {
1584     $fields = array_merge($fields, $chainApiParams);
1585   }
1586   foreach ($fields as $fieldName => $fieldInfo) {
1587     switch (CRM_Utils_Array::value('type', $fieldInfo)) {
1588       case CRM_Utils_Type::T_INT:
1589         //field is of type integer
1590         _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1591         break;
1592
1593       case CRM_Utils_Type::T_DATE:
1594       case CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME:
1595       case CRM_Utils_Type::T_TIMESTAMP:
1596         //field is of type date or datetime
1597         if (!empty($customFields) && array_key_exists($fieldName, $customFields)) {
1598           $dateParams = &$params[$customFields[$fieldName]];
1599         }
1600         else {
1601           $dateParams = &$params;
1602         }
1603         _civicrm_api3_validate_date($dateParams, $fieldName, $fieldInfo);
1604         break;
1605
1606       case CRM_Utils_Type::T_TEXT:
1607       case CRM_Utils_Type::T_STRING:
1608         _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1609         break;
1610
1611       case CRM_Utils_Type::T_MONEY:
1612         list($fieldValue, $op) = _civicrm_api3_field_value_check($params, $fieldName);
1613         if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
1614           break;
1615         }
1616         foreach ((array) $fieldValue as $fieldvalue) {
1617           if (!CRM_Utils_Rule::money($fieldvalue) && !empty($fieldvalue)) {
1618             throw new Exception($fieldName . " is  not a valid amount: " . $params[$fieldName]);
1619           }
1620         }
1621         break;
1622     }
1623   }
1624 }
1625
1626 /**
1627  * Validate foreign key values of fields being passed into API.
1628  *
1629  * This function relies on the getFields function working accurately
1630  * for the given API.
1631  *
1632  * @param string $entity
1633  * @param string $action
1634  * @param array $params
1635  *
1636  * @param array $fields
1637  *   Response from getfields all variables are the same as per civicrm_api.
1638  *
1639  * @throws Exception
1640  */
1641 function _civicrm_api3_validate_foreign_keys($entity, $action, &$params, $fields) {
1642   // intensive checks - usually only called after DB level fail
1643   foreach ($fields as $fieldName => $fieldInfo) {
1644     if (!empty($fieldInfo['FKClassName'])) {
1645       if (!empty($params[$fieldName])) {
1646         foreach ((array) $params[$fieldName] as $fieldValue) {
1647           _civicrm_api3_validate_constraint($fieldValue, $fieldName, $fieldInfo, $entity);
1648         }
1649       }
1650       elseif (!empty($fieldInfo['required'])) {
1651         throw new Exception("DB Constraint Violation - $fieldName should possibly be marked as mandatory for $entity,$action API. If so, please raise a bug report.");
1652       }
1653     }
1654     if (!empty($fieldInfo['api.unique'])) {
1655       $params['entity'] = $entity;
1656       _civicrm_api3_validate_unique_key($params, $fieldName);
1657     }
1658   }
1659 }
1660
1661 /**
1662  * Validate date fields being passed into API.
1663  *
1664  * It currently converts both unique fields and DB field names to a mysql date.
1665  * @todo - probably the unique field handling & the if exists handling is now done before this
1666  * function is reached in the wrapper - can reduce this code down to assume we
1667  * are only checking the passed in field
1668  *
1669  * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1670  * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1671  *
1672  * @param array $params
1673  *   Params from civicrm_api.
1674  * @param string $fieldName
1675  *   Uniquename of field being checked.
1676  * @param array $fieldInfo
1677  *   Array of fields from getfields function.
1678  *
1679  * @throws Exception
1680  */
1681 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1682   list($fieldValue, $op) = _civicrm_api3_field_value_check($params, $fieldName);
1683   if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
1684     return;
1685   }
1686
1687   if ($fieldValue === 'null' && empty($fieldInfo['api.required'])) {
1688     // This is the wierd & wonderful way PEAR sets null.
1689     return;
1690   }
1691
1692   //should we check first to prevent it from being copied if they have passed in sql friendly format?
1693   if (!empty($params[$fieldInfo['name']])) {
1694     $fieldValue = _civicrm_api3_getValidDate($fieldValue, $fieldInfo['name'], $fieldInfo['type']);
1695   }
1696   if ((CRM_Utils_Array::value('name', $fieldInfo) != $fieldName) && !empty($fieldValue)) {
1697     $fieldValue = _civicrm_api3_getValidDate($fieldValue, $fieldName, $fieldInfo['type']);
1698   }
1699
1700   if (!empty($op)) {
1701     $params[$fieldName][$op] = $fieldValue;
1702   }
1703   else {
1704     $params[$fieldName] = $fieldValue;
1705   }
1706 }
1707
1708 /**
1709  * Convert date into BAO friendly date.
1710  *
1711  * We accept 'whatever strtotime accepts'
1712  *
1713  * @param string $dateValue
1714  * @param string $fieldName
1715  * @param $fieldType
1716  *
1717  * @throws Exception
1718  * @return mixed
1719  */
1720 function _civicrm_api3_getValidDate($dateValue, $fieldName, $fieldType) {
1721   if (is_array($dateValue)) {
1722     foreach ($dateValue as $key => $value) {
1723       $dateValue[$key] = _civicrm_api3_getValidDate($value, $fieldName, $fieldType);
1724     }
1725     return $dateValue;
1726   }
1727   if (strtotime($dateValue) === FALSE) {
1728     throw new Exception($fieldName . " is not a valid date: " . $dateValue);
1729   }
1730   $format = ($fieldType == CRM_Utils_Type::T_DATE) ? 'Ymd000000' : 'YmdHis';
1731   return CRM_Utils_Date::processDate($dateValue, NULL, FALSE, $format);
1732 }
1733
1734 /**
1735  * Validate foreign constraint fields being passed into API.
1736  *
1737  * @param mixed $fieldValue
1738  * @param string $fieldName
1739  *   Unique name of field being checked.
1740  * @param array $fieldInfo
1741  *   Array of fields from getfields function.
1742  * @param string $entity
1743  *
1744  * @throws \API_Exception
1745  */
1746 function _civicrm_api3_validate_constraint($fieldValue, $fieldName, $fieldInfo, $entity) {
1747   $daoName = $fieldInfo['FKClassName'];
1748   $fieldInfo = [$fieldName => $fieldInfo];
1749   $params = [$fieldName => $fieldValue];
1750   _civicrm_api3_validate_fields($entity, NULL, $params, $fieldInfo);
1751   /* @var CRM_Core_DAO $dao*/
1752   $dao = new $daoName();
1753   $dao->id = $params[$fieldName];
1754   $dao->selectAdd();
1755   $dao->selectAdd('id');
1756   if (!$dao->find()) {
1757     throw new API_Exception("$fieldName is not valid : " . $fieldValue);
1758   }
1759 }
1760
1761 /**
1762  * Validate foreign constraint fields being passed into API.
1763  *
1764  * @param array $params
1765  *   Params from civicrm_api.
1766  * @param string $fieldName
1767  *   Uniquename of field being checked.
1768  *
1769  * @throws Exception
1770  */
1771 function _civicrm_api3_validate_unique_key(&$params, &$fieldName) {
1772   list($fieldValue, $op) = _civicrm_api3_field_value_check($params, $fieldName);
1773   if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
1774     return;
1775   }
1776   $existing = civicrm_api($params['entity'], 'get', [
1777     'version' => $params['version'],
1778     $fieldName => $fieldValue,
1779   ]);
1780   // an entry already exists for this unique field
1781   if ($existing['count'] == 1) {
1782     // question - could this ever be a security issue?
1783     throw new API_Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1784   }
1785 }
1786
1787 /**
1788  * Generic implementation of the "replace" action.
1789  *
1790  * Replace the old set of entities (matching some given keys) with a new set of
1791  * entities (matching the same keys).
1792  *
1793  * @note This will verify that 'values' is present, but it does not directly verify
1794  * any other parameters.
1795  *
1796  * @param string $entity
1797  *   Entity name.
1798  * @param array $params
1799  *   Params from civicrm_api, including:.
1800  *   - 'values': an array of records to save
1801  *   - all other items: keys which identify new/pre-existing records.
1802  *
1803  * @return array|int
1804  */
1805 function _civicrm_api3_generic_replace($entity, $params) {
1806
1807   $transaction = new CRM_Core_Transaction();
1808   try {
1809     if (!is_array($params['values'])) {
1810       throw new Exception("Mandatory key(s) missing from params array: values");
1811     }
1812
1813     // Extract the keys -- somewhat scary, don't think too hard about it
1814     $baseParams = _civicrm_api3_generic_replace_base_params($params);
1815
1816     // Lookup pre-existing records
1817     $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1818     if (civicrm_error($preexisting)) {
1819       $transaction->rollback();
1820       return $preexisting;
1821     }
1822
1823     // Save the new/updated records
1824     $creates = [];
1825     foreach ($params['values'] as $replacement) {
1826       // Sugar: Don't force clients to duplicate the 'key' data
1827       $replacement = array_merge($baseParams, $replacement);
1828       $action      = (isset($replacement['id']) || isset($replacement[$entity . '_id'])) ? 'update' : 'create';
1829       $create      = civicrm_api($entity, $action, $replacement);
1830       if (civicrm_error($create)) {
1831         $transaction->rollback();
1832         return $create;
1833       }
1834       foreach ($create['values'] as $entity_id => $entity_value) {
1835         $creates[$entity_id] = $entity_value;
1836       }
1837     }
1838
1839     // Remove stale records
1840     $staleIDs = array_diff(
1841       array_keys($preexisting['values']),
1842       array_keys($creates)
1843     );
1844     foreach ($staleIDs as $staleID) {
1845       $delete = civicrm_api($entity, 'delete', [
1846         'version' => $params['version'],
1847         'id' => $staleID,
1848       ]);
1849       if (civicrm_error($delete)) {
1850         $transaction->rollback();
1851         return $delete;
1852       }
1853     }
1854
1855     return civicrm_api3_create_success($creates, $params);
1856   }
1857   catch (PEAR_Exception $e) {
1858     $transaction->rollback();
1859     return civicrm_api3_create_error($e->getMessage());
1860   }
1861   catch (Exception $e) {
1862     $transaction->rollback();
1863     return civicrm_api3_create_error($e->getMessage());
1864   }
1865 }
1866
1867 /**
1868  * Replace base parameters.
1869  *
1870  * @param array $params
1871  *
1872  * @return array
1873  */
1874 function _civicrm_api3_generic_replace_base_params($params) {
1875   $baseParams = $params;
1876   unset($baseParams['values']);
1877   unset($baseParams['sequential']);
1878   unset($baseParams['options']);
1879   return $baseParams;
1880 }
1881
1882 /**
1883  * Returns fields allowable by api.
1884  *
1885  * @param $entity
1886  *   String Entity to query.
1887  * @param bool $unique
1888  *   Index by unique fields?.
1889  * @param array $params
1890  *
1891  * @return array
1892  */
1893 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = []) {
1894   $unsetIfEmpty = [
1895     'dataPattern',
1896     'headerPattern',
1897     'default',
1898     'export',
1899     'import',
1900   ];
1901   $dao = _civicrm_api3_get_DAO($entity);
1902   if (empty($dao)) {
1903     return [];
1904   }
1905   $fields = $dao::fields();
1906   $supportedFields = $dao::getSupportedFields();
1907
1908   foreach ($fields as $name => $field) {
1909     // Denote as core field
1910     $fields[$name]['is_core_field'] = TRUE;
1911     // Set html attributes for text fields
1912     if (isset($field['html'])) {
1913       $fields[$name]['html'] += (array) $dao::makeAttribute($field);
1914     }
1915     // Delete field if not supported by current db schema (prevents errors when there are pending db updates)
1916     if (!isset($supportedFields[$field['name']])) {
1917       unset($fields[$name]);
1918     }
1919   }
1920
1921   // replace uniqueNames by the normal names as the key
1922   if (empty($unique)) {
1923     foreach ($fields as $name => &$field) {
1924       //getting rid of unused attributes
1925       foreach ($unsetIfEmpty as $attr) {
1926         if (empty($field[$attr])) {
1927           unset($field[$attr]);
1928         }
1929       }
1930       if ($name == $field['name']) {
1931         continue;
1932       }
1933       if (array_key_exists($field['name'], $fields)) {
1934         $field['error'] = 'name conflict';
1935         // it should never happen, but better safe than sorry
1936         continue;
1937       }
1938       $fields[$field['name']] = $field;
1939       $fields[$field['name']]['uniqueName'] = $name;
1940       unset($fields[$name]);
1941     }
1942   }
1943   // Translate FKClassName to the corresponding api
1944   foreach ($fields as $name => &$field) {
1945     if (!empty($field['FKClassName'])) {
1946       $FKApi = CRM_Core_DAO_AllCoreTables::getBriefName($field['FKClassName']);
1947       if ($FKApi) {
1948         $field['FKApiName'] = $FKApi;
1949       }
1950     }
1951   }
1952   $fields += _civicrm_api_get_custom_fields($entity, $params);
1953   return $fields;
1954 }
1955
1956 /**
1957  * Return an array of fields for a given entity.
1958  *
1959  * This is the same as the BAO function but fields are prefixed with 'custom_' to represent api params.
1960  *
1961  * @param $entity
1962  * @param array $params
1963  *
1964  * @return array
1965  */
1966 function _civicrm_api_get_custom_fields($entity, &$params) {
1967   $entity = _civicrm_api_get_camel_name($entity);
1968   if ($entity == 'Contact') {
1969     // Use sub-type if available, otherwise "NULL" to fetch from all contact types
1970     $entity = $params['contact_type'] ?? NULL;
1971   }
1972   $customfields = CRM_Core_BAO_CustomField::getFields($entity,
1973     FALSE,
1974     FALSE,
1975     // we could / should probably test for other subtypes here - e.g. activity_type_id
1976     CRM_Utils_Array::value('contact_sub_type', $params),
1977     NULL,
1978     FALSE,
1979     FALSE,
1980     FALSE
1981   );
1982
1983   $ret = [];
1984
1985   foreach ($customfields as $key => $value) {
1986     // Regular fields have a 'name' property
1987     $value['name'] = 'custom_' . $key;
1988     $value['title'] = $value['label'];
1989     if ($value['data_type'] == 'Date' && CRM_Utils_Array::value('time_format', $value, 0) > 0) {
1990       $value['data_type'] = 'DateTime';
1991     }
1992     $value['type'] = CRM_Utils_Array::value($value['data_type'], CRM_Core_BAO_CustomField::dataToType());
1993     $ret['custom_' . $key] = $value;
1994   }
1995   return $ret;
1996 }
1997
1998 /**
1999  * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't.
2000  *
2001  * If multiple aliases the last takes precedence
2002  *
2003  * Function also swaps unique fields for non-unique fields & vice versa.
2004  *
2005  * @param $apiRequest
2006  * @param $fields
2007  */
2008 function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) {
2009   foreach ($fields as $field => $values) {
2010     $uniqueName = $values['uniqueName'] ?? NULL;
2011     if (!empty($values['api.aliases'])) {
2012       // if aliased field is not set we try to use field alias
2013       if (!isset($apiRequest['params'][$field])) {
2014         foreach ($values['api.aliases'] as $alias) {
2015           if (isset($apiRequest['params'][$alias])) {
2016             $apiRequest['params'][$field] = $apiRequest['params'][$alias];
2017           }
2018           //unset original field  nb - need to be careful with this as it may bring inconsistencies
2019           // out of the woodwork but will be implementing only as _spec function extended
2020           unset($apiRequest['params'][$alias]);
2021         }
2022       }
2023     }
2024     if (!isset($apiRequest['params'][$field]) && !empty($values['name']) && $field != $values['name']
2025       && isset($apiRequest['params'][$values['name']])
2026     ) {
2027       $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
2028       // note that it would make sense to unset the original field here but tests need to be in place first
2029       if ($field != 'domain_version') {
2030         unset($apiRequest['params'][$values['name']]);
2031       }
2032     }
2033     if (!isset($apiRequest['params'][$field])
2034       && $uniqueName
2035       && $field != $uniqueName
2036       && array_key_exists($uniqueName, $apiRequest['params'])
2037     ) {
2038       $apiRequest['params'][$field] = $apiRequest['params'][$values['uniqueName']] ?? NULL;
2039       // note that it would make sense to unset the original field here but tests need to be in place first
2040     }
2041   }
2042
2043 }
2044
2045 /**
2046  * Validate integer fields being passed into API.
2047  *
2048  * It currently converts the incoming value 'user_contact_id' into the id of the currently logged in user.
2049  *
2050  * @param array $params
2051  *   Params from civicrm_api.
2052  * @param string $fieldName
2053  *   Uniquename of field being checked.
2054  * @param array $fieldInfo
2055  *   Array of fields from getfields function.
2056  * @param string $entity
2057  *
2058  * @throws API_Exception
2059  */
2060 function _civicrm_api3_validate_integer(&$params, $fieldName, &$fieldInfo, $entity) {
2061   list($fieldValue, $op) = _civicrm_api3_field_value_check($params, $fieldName);
2062   if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE) {
2063     return;
2064   }
2065
2066   if (!empty($fieldValue) || $fieldValue === '0' || $fieldValue === 0) {
2067     // if value = 'user_contact_id' (or similar), replace value with contact id
2068     if (!is_numeric($fieldValue) && is_scalar($fieldValue)) {
2069       $realContactId = _civicrm_api3_resolve_contactID($fieldValue);
2070       if ('unknown-user' === $realContactId) {
2071         throw new API_Exception("\"$fieldName\" \"{$fieldValue}\" cannot be resolved to a contact ID", 2002, ['error_field' => $fieldName, "type" => "integer"]);
2072       }
2073       elseif (is_numeric($realContactId)) {
2074         $fieldValue = $realContactId;
2075       }
2076       elseif (is_null($realContactId) && empty($fieldInfo['api.required']) && $fieldValue === 'user_contact_id') {
2077         // If not mandatory this will be OK. If mandatory it should fail.
2078         $fieldValue = NULL;
2079       }
2080     }
2081     if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options']) || $fieldName === 'campaign_id') {
2082       $additional_lookup_params = [];
2083       if (strtolower($entity) == 'address' && $fieldName == 'state_province_id') {
2084         $country_id = _civicrm_api3_resolve_country_id($params);
2085         if (!empty($country_id)) {
2086           $additional_lookup_params = ['country_id' => $country_id];
2087         }
2088       }
2089       _civicrm_api3_api_match_pseudoconstant($fieldValue, $entity, $fieldName, $fieldInfo, $op, $additional_lookup_params);
2090     }
2091
2092     // After swapping options, ensure we have an integer(s)
2093     foreach ((array) ($fieldValue) as $value) {
2094       if ($value && !is_numeric($value) && $value !== 'null' && $value !== NULL && !is_array($value)) {
2095         throw new API_Exception("$fieldName is not a valid integer", 2001, ['error_field' => $fieldName, "type" => "integer"]);
2096       }
2097     }
2098
2099     // Check our field length
2100     if (is_string($fieldValue) && !empty($fieldInfo['maxlength']) && strlen($fieldValue) > $fieldInfo['maxlength']
2101       ) {
2102       throw new API_Exception($fieldValue . " is " . strlen($fieldValue) . " characters  - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
2103         2100, ['field' => $fieldName, "max_length" => $fieldInfo['maxlength']]
2104       );
2105     }
2106   }
2107
2108   if (!empty($op)) {
2109     $params[$fieldName][$op] = $fieldValue;
2110   }
2111   else {
2112     $params[$fieldName] = $fieldValue;
2113   }
2114 }
2115
2116 /**
2117  * Helper function to determine country_id given the myriad of values for country_id or country that are supported
2118  * @param $params
2119  *
2120  * @return int|null
2121  */
2122 function _civicrm_api3_resolve_country_id($params) {
2123   if (!empty($params['country_id'])) {
2124     if (is_numeric($params['country_id'])) {
2125       $country_id = $params['country_id'];
2126     }
2127     else {
2128       $country = new CRM_Core_DAO_Country();
2129       $country->name = $params['country_id'];
2130       if (!$country->find(TRUE)) {
2131         $country->name = NULL;
2132         $country->iso_code = $params['country_id'];
2133         $country->find(TRUE);
2134       }
2135       if (!empty($country->id)) {
2136         $country_id = $country->id;
2137       }
2138     }
2139   }
2140   elseif (!empty($params['country'])) {
2141     if (is_numeric($params['country'])) {
2142       $country_id = $params['country'];
2143     }
2144     else {
2145       $country = new CRM_Core_DAO_Country();
2146       $country->name = $params['country'];
2147       if (!$country->find(TRUE)) {
2148         $country->name = NULL;
2149         $country->iso_code = $params['country'];
2150         $country->find(TRUE);
2151       }
2152       if (!empty($country->id)) {
2153         $country_id = $country->id;
2154       }
2155     }
2156   }
2157   return !empty($country_id) ? $country_id : NULL;
2158 }
2159
2160 /**
2161  * Determine a contact ID using a string expression.
2162  *
2163  * @param string $contactIdExpr
2164  *   E.g. "user_contact_id" or "@user:username".
2165  *
2166  * @return int|null|'unknown-user'
2167  * @throws \CRM_Core_Exception
2168  */
2169 function _civicrm_api3_resolve_contactID($contactIdExpr) {
2170   // If value = 'user_contact_id' replace value with logged in user id.
2171   if ($contactIdExpr == "user_contact_id") {
2172     return CRM_Core_Session::getLoggedInContactID();
2173   }
2174   elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) {
2175     $config = CRM_Core_Config::singleton();
2176
2177     $ufID = $config->userSystem->getUfId($matches[1]);
2178     if (!$ufID) {
2179       return 'unknown-user';
2180     }
2181
2182     $contactID = CRM_Core_BAO_UFMatch::getContactId($ufID);
2183     if (!$contactID) {
2184       return 'unknown-user';
2185     }
2186
2187     return $contactID;
2188   }
2189   return NULL;
2190 }
2191
2192 /**
2193  * Validate html (check for scripting attack).
2194  *
2195  * @param array $params
2196  * @param string $fieldName
2197  * @param array $fieldInfo
2198  *
2199  * @throws API_Exception
2200  */
2201 function _civicrm_api3_validate_html(&$params, &$fieldName, $fieldInfo) {
2202   list($fieldValue, $op) = _civicrm_api3_field_value_check($params, $fieldName);
2203   if (strpos($op, 'NULL') || strpos($op, 'EMPTY')) {
2204     return;
2205   }
2206 }
2207
2208 /**
2209  * Validate string fields being passed into API.
2210  *
2211  * @param array $params
2212  *   Params from civicrm_api.
2213  * @param string $fieldName
2214  *   Uniquename of field being checked.
2215  * @param array $fieldInfo
2216  *   Array of fields from getfields function.
2217  * @param string $entity
2218  *
2219  * @throws API_Exception
2220  * @throws Exception
2221  */
2222 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
2223   list($fieldValue, $op) = _civicrm_api3_field_value_check($params, $fieldName, 'String');
2224   if (strpos($op, 'NULL') !== FALSE || strpos($op, 'EMPTY') !== FALSE || CRM_Utils_System::isNull($fieldValue)) {
2225     return;
2226   }
2227
2228   if (!is_array($fieldValue)) {
2229     $fieldValue = (string) $fieldValue;
2230   }
2231
2232   if ($fieldValue) {
2233     foreach ((array) $fieldValue as $key => $value) {
2234       if ($fieldName == 'currency') {
2235         //When using IN operator $fieldValue is a array of currency codes
2236         if (!CRM_Utils_Rule::currencyCode($value)) {
2237           throw new Exception("Currency not a valid code: $currency");
2238         }
2239       }
2240     }
2241   }
2242   if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options'])) {
2243     _civicrm_api3_api_match_pseudoconstant($fieldValue, $entity, $fieldName, $fieldInfo, $op);
2244   }
2245   // Check our field length
2246   elseif (is_string($fieldValue) && !empty($fieldInfo['maxlength']) && strlen(utf8_decode($fieldValue)) > $fieldInfo['maxlength']) {
2247     throw new API_Exception("Value for $fieldName is " . strlen(utf8_decode($value)) . " characters  - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
2248       2100, ['field' => $fieldName]
2249     );
2250   }
2251
2252   if (!empty($op)) {
2253     $params[$fieldName][$op] = $fieldValue;
2254   }
2255   else {
2256     $params[$fieldName] = $fieldValue;
2257   }
2258 }
2259
2260 /**
2261  * Validate & swap out any pseudoconstants / options.
2262  *
2263  * @param mixed $fieldValue
2264  * @param string $entity : api entity name
2265  * @param string $fieldName : field name used in api call (not necessarily the canonical name)
2266  * @param array $fieldInfo : getfields meta-data
2267  * @param string $op
2268  * @param array $additional_lookup_params
2269  *
2270  * @throws \API_Exception
2271  */
2272 function _civicrm_api3_api_match_pseudoconstant(&$fieldValue, $entity, $fieldName, $fieldInfo, $op = '=', $additional_lookup_params = []) {
2273   if (in_array($op, ['>', '<', '>=', '<=', 'LIKE', 'NOT LIKE'])) {
2274     return;
2275   }
2276
2277   $options = $fieldInfo['options'] ?? NULL;
2278
2279   if (!$options) {
2280     if (strtolower($entity) == 'profile' && !empty($fieldInfo['entity'])) {
2281       // We need to get the options from the entity the field relates to.
2282       $entity = $fieldInfo['entity'];
2283     }
2284     $options_lookup_params = [
2285       'version' => 3,
2286       'field' => $fieldInfo['name'],
2287       'context' => 'validate',
2288     ];
2289     if (!empty($additional_lookup_params)) {
2290       $options_lookup_params = array_merge($additional_lookup_params, $options_lookup_params);
2291     }
2292     $options = civicrm_api($entity, 'getoptions', $options_lookup_params);
2293
2294     $options = CRM_Utils_Array::value('values', $options, []);
2295   }
2296
2297   // If passed a value-separated string, explode to an array, then re-implode after matching values.
2298   $implode = FALSE;
2299   if (is_string($fieldValue) && strpos($fieldValue, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
2300     $fieldValue = CRM_Utils_Array::explodePadded($fieldValue);
2301     $implode = TRUE;
2302   }
2303   // If passed multiple options, validate each.
2304   if (is_array($fieldValue)) {
2305     foreach ($fieldValue as &$value) {
2306       if (!is_array($value)) {
2307         _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName, CRM_Utils_Array::value('api.required', $fieldInfo));
2308       }
2309     }
2310     // TODO: unwrap the call to implodePadded from the conditional and do it always
2311     // need to verify that this is safe and doesn't break anything though.
2312     // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
2313     if ($implode) {
2314       CRM_Utils_Array::implodePadded($fieldValue);
2315     }
2316   }
2317   else {
2318     _civicrm_api3_api_match_pseudoconstant_value($fieldValue, $options, $fieldName, CRM_Utils_Array::value('api.required', $fieldInfo));
2319   }
2320 }
2321
2322 /**
2323  * Validate & swap a single option value for a field.
2324  *
2325  * @param string $value field value
2326  * @param array $options array of options for this field
2327  * @param string $fieldName field name used in api call (not necessarily the canonical name)
2328  * @param bool $isRequired
2329  *   Is this a required field or is 'null' an acceptable option. We allow 'null' last
2330  *   in case we have the weird situation of it being a valid option in which case our
2331  *   brains will probably explode.
2332  *
2333  * @throws API_Exception
2334  */
2335 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName, $isRequired) {
2336   // If option is a key, no need to translate
2337   // or if no options are avaiable for pseudoconstant 'table' property
2338   if (array_key_exists($value, $options) || !$options) {
2339     return;
2340   }
2341
2342   // Hack for Profile formatting fields
2343   if ($fieldName === 'field_name' && (strpos($value, 'formatting') === 0)) {
2344     return;
2345   }
2346
2347   // Legacy handling of tag used_for values, see https://github.com/civicrm/civicrm-core/pull/20573
2348   if ($fieldName === 'used_for') {
2349     $legacyTagUsedFor = [
2350       'Activities' => 'Activity',
2351       'Contacts' => 'Contact',
2352       'Cases' => 'Case',
2353       // Attachements [sic] was the original spelling
2354       'Attachements' => 'File',
2355     ];
2356     $value = $legacyTagUsedFor[$value] ?? $value;
2357   }
2358
2359   // Translate value into key
2360   // Cast $value to string to avoid a bug in array_search
2361   $newValue = array_search((string) $value, $options);
2362   if ($newValue !== FALSE) {
2363     $value = $newValue;
2364     return;
2365   }
2366   // Case-insensitive matching
2367   $newValue = strtolower($value);
2368   $options = array_map("strtolower", $options);
2369   $newValue = array_search($newValue, $options);
2370   if ($newValue === FALSE) {
2371     if ($value === 'null' && !$isRequired) {
2372       // CiviMagic syntax for Nulling out the field - let it through.
2373       return;
2374     }
2375     // Legacy support for custom fields: If matching failed by name, fallback to label
2376     // @see https://lab.civicrm.org/dev/core/-/issues/1816
2377     if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($fieldName)) {
2378       $field = new CRM_Core_BAO_CustomField();
2379       $field->id = $customFieldId;
2380       $options = array_map("strtolower", $field->getOptions());
2381       $newValue = array_search(strtolower($value), $options);
2382     }
2383   }
2384   if ($newValue === FALSE) {
2385     throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, ['error_field' => $fieldName]);
2386   }
2387   $value = $newValue;
2388 }
2389
2390 /**
2391  * Returns the canonical name of a field.
2392  *
2393  * @param $entity
2394  *   api entity name (string should already be standardized - no camelCase).
2395  * @param $fieldName
2396  *   any variation of a field's name (name, unique_name, api.alias).
2397  *
2398  * @param string $action
2399  *
2400  * @return bool|string
2401  *   FieldName or FALSE if the field does not exist
2402  */
2403 function _civicrm_api3_api_resolve_alias($entity, $fieldName, $action = 'create') {
2404   if (!$fieldName) {
2405     return FALSE;
2406   }
2407   if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
2408     return $fieldName;
2409   }
2410   if ($fieldName === (CRM_Core_DAO_AllCoreTables::convertEntityNameToLower($entity) . '_id')) {
2411     return 'id';
2412   }
2413   $result = civicrm_api($entity, 'getfields', [
2414     'version' => 3,
2415     'action' => $action,
2416   ]);
2417   $meta = $result['values'];
2418   if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) {
2419     $fieldName = $fieldName . '_id';
2420   }
2421   if (isset($meta[$fieldName])) {
2422     return $meta[$fieldName]['name'];
2423   }
2424   foreach ($meta as $info) {
2425     if ($fieldName == $info['name'] || $fieldName == CRM_Utils_Array::value('uniqueName', $info)) {
2426       return $info['name'];
2427     }
2428     if (array_search($fieldName, CRM_Utils_Array::value('api.aliases', $info, [])) !== FALSE) {
2429       return $info['name'];
2430     }
2431   }
2432   // Create didn't work, try with get
2433   if ($action == 'create') {
2434     return _civicrm_api3_api_resolve_alias($entity, $fieldName, 'get');
2435   }
2436   return FALSE;
2437 }
2438
2439 /**
2440  * Check if the function is deprecated.
2441  *
2442  * @param string $entity
2443  * @param array $result
2444  *
2445  * @return string|array|null
2446  */
2447 function _civicrm_api3_deprecation_check($entity, $result = []) {
2448   if ($entity) {
2449     $lowercase_entity = _civicrm_api_get_entity_name_from_camel($entity);
2450     $fnName = "_civicrm_api3_{$lowercase_entity}_deprecation";
2451     if (function_exists($fnName)) {
2452       return $fnName($result);
2453     }
2454   }
2455 }
2456
2457 /**
2458  * Get the actual field value.
2459  *
2460  * In some case $params[$fieldName] holds Array value in this format Array([operator] => [value])
2461  * So this function returns the actual field value.
2462  *
2463  * @param array $params
2464  * @param string $fieldName
2465  * @param string $type
2466  *
2467  * @return mixed
2468  */
2469 function _civicrm_api3_field_value_check(&$params, $fieldName, $type = NULL) {
2470   $fieldValue = $params[$fieldName] ?? NULL;
2471   $op = NULL;
2472
2473   if (!empty($fieldValue) && is_array($fieldValue) &&
2474     (array_search(key($fieldValue), CRM_Core_DAO::acceptedSQLOperators()) ||
2475       $type == 'String' && strstr(key($fieldValue), 'EMPTY'))
2476   ) {
2477     $op = key($fieldValue);
2478     $fieldValue = $fieldValue[$op] ?? NULL;
2479   }
2480   return [$fieldValue, $op];
2481 }
2482
2483 /**
2484  * A generic "get" API based on simple array data. This is comparable to
2485  * _civicrm_api3_basic_get but does not use DAO/BAO. This is useful for
2486  * small/mid-size data loaded from external JSON or XML documents.
2487  *
2488  * @param $entity
2489  * @param array $params
2490  *   API parameters.
2491  * @param array $records
2492  *   List of all records.
2493  * @param string $idCol
2494  *   The property which defines the ID of a record
2495  * @param array $filterableFields
2496  *   List of filterable fields.
2497  *
2498  * @return array
2499  * @throws \API_Exception
2500  */
2501 function _civicrm_api3_basic_array_get($entity, $params, $records, $idCol, $filterableFields) {
2502   $options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get');
2503   $offset = $options['offset'] ?? NULL;
2504   $limit = $options['limit'] ?? NULL;
2505
2506   $sort = !empty($options['sort']) ? explode(', ', $options['sort']) : NULL;
2507   if ($sort) {
2508     usort($records, function($a, $b) use ($sort) {
2509       foreach ($sort as $field) {
2510         [$field, $dir] = array_pad(explode(' ', $field), 2, 'asc');
2511         $modifier = strtolower($dir) == 'asc' ? 1 : -1;
2512         if (isset($a[$field]) && isset($b[$field])) {
2513           if ($a[$field] == $b[$field]) {
2514             continue;
2515           }
2516           return (strnatcasecmp($a[$field], $b[$field]) * $modifier);
2517         }
2518         elseif (isset($a[$field]) || isset($b[$field])) {
2519           return ((isset($a[$field]) ? 1 : -1) * $modifier);
2520         }
2521       }
2522       return 0;
2523     });
2524   }
2525
2526   $matches = [];
2527
2528   $isMatch = function($recordVal, $searchVal) {
2529     $operator = '=';
2530     if (is_array($searchVal) && count($searchVal) === 1 && in_array(array_keys($searchVal)[0], CRM_Core_DAO::acceptedSQLOperators())) {
2531       $operator = array_keys($searchVal)[0];
2532       $searchVal = array_values($searchVal)[0];
2533     }
2534     switch ($operator) {
2535       case '=':
2536       case '!=':
2537       case '<>':
2538         return ($recordVal == $searchVal) == ($operator == '=');
2539
2540       case 'IS NULL':
2541       case 'IS NOT NULL':
2542         return is_null($recordVal) == ($operator == 'IS NULL');
2543
2544       case '>':
2545         return $recordVal > $searchVal;
2546
2547       case '>=':
2548         return $recordVal >= $searchVal;
2549
2550       case '<':
2551         return $recordVal < $searchVal;
2552
2553       case '<=':
2554         return $recordVal <= $searchVal;
2555
2556       case 'BETWEEN':
2557       case 'NOT BETWEEN':
2558         $between = ($recordVal >= $searchVal[0] && $recordVal <= $searchVal[1]);
2559         return $between == ($operator == 'BETWEEN');
2560
2561       case 'LIKE':
2562       case 'NOT LIKE':
2563         $pattern = '/^' . str_replace('%', '.*', preg_quote($searchVal, '/')) . '$/i';
2564         return !preg_match($pattern, $recordVal) == ($operator != 'LIKE');
2565
2566       case 'IN':
2567       case 'NOT IN':
2568         return in_array($recordVal, $searchVal) == ($operator == 'IN');
2569
2570       default:
2571         throw new API_Exception("Unsupported operator: '$operator' cannot be used with array data");
2572     }
2573   };
2574
2575   $currentOffset = 0;
2576   foreach ($records as $record) {
2577     if ($idCol != 'id') {
2578       $record['id'] = $record[$idCol];
2579     }
2580     $match = TRUE;
2581     foreach ($params as $k => $v) {
2582       if ($k == 'id') {
2583         $k = $idCol;
2584       }
2585       if (in_array($k, $filterableFields) && !$isMatch($record[$k] ?? NULL, $v)) {
2586         $match = FALSE;
2587         break;
2588       }
2589     }
2590     if ($match) {
2591       if ($currentOffset >= $offset) {
2592         $matches[$record[$idCol]] = $record;
2593       }
2594       if ($limit && count($matches) >= $limit) {
2595         break;
2596       }
2597       $currentOffset++;
2598     }
2599   }
2600
2601   $return = CRM_Utils_Array::value('return', $options, []);
2602   if (!empty($return)) {
2603     $return['id'] = 1;
2604     $matches = CRM_Utils_Array::filterColumns($matches, array_keys($return));
2605   }
2606
2607   return civicrm_api3_create_success($matches, $params);
2608 }
2609
2610 /**
2611  * @param string $bao_name
2612  * @param array $params
2613  * @throws \Civi\API\Exception\UnauthorizedException
2614  */
2615 function _civicrm_api3_check_edit_permissions($bao_name, $params) {
2616   // For lack of something more clever, here's a whitelist of entities whos permissions
2617   // are inherited from a contact record.
2618   // Note, when adding here, also remember to modify _civicrm_api3_permissions()
2619   $contactEntities = [
2620     'CRM_Core_BAO_Email',
2621     'CRM_Core_BAO_Phone',
2622     'CRM_Core_BAO_Address',
2623     'CRM_Core_BAO_IM',
2624     'CRM_Core_BAO_Website',
2625     'CRM_Core_BAO_OpenID',
2626   ];
2627   if (!empty($params['check_permissions']) && in_array($bao_name, $contactEntities)) {
2628     $cid = !empty($params['contact_id']) ? $params['contact_id'] : CRM_Core_DAO::getFieldValue($bao_name, $params['id'], 'contact_id');
2629     if (!CRM_Contact_BAO_Contact_Permission::allow($cid, CRM_Core_Permission::EDIT)) {
2630       throw new \Civi\API\Exception\UnauthorizedException('Permission denied to modify contact record');
2631     }
2632   }
2633 }
2634
2635 /**
2636  * Check if an entity has been modified since the last known modified_date
2637  *
2638  * @param string $modifiedDate Last knowm modified_date
2639  * @param int $id Id of record to check
2640  * @param string $entity API Entity
2641  *
2642  * @return bool
2643  * @throws \CiviCRM_API3_Exception
2644  */
2645 function _civicrm_api3_compare_timestamps($modifiedDate, $id, $entity) {
2646   $currentDbInfo = civicrm_api3($entity, 'getsingle', ['id' => $id]);
2647   if (strtotime($currentDbInfo['modified_date']) <= strtotime($modifiedDate)) {
2648     return TRUE;
2649   }
2650   return FALSE;
2651 }