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