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