api/v3/utils.php

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