api/v3/utils.php

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