api/v3/utils.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.4                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  * File for CiviCRM APIv3 utilitity functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_utils
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2013
  35  * @version $Id: utils.php 30879 2010-11-22 15:45:55Z shot $
  36  *
  37  */
  38
  39 /**
  40  * Initialize CiviCRM - should be run at the start of each API function
  41  */
  42 function _civicrm_api3_initialize() {
  43   require_once 'CRM/Core/ClassLoader.php';
  44   CRM_Core_ClassLoader::singleton()->register();
  45   CRM_Core_Config::singleton();
  46 }
  47
  48 /**
  49  * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking
  50  *
  51  * @param array $params array of fields to check
  52  * @param array $daoName string DAO to check for required fields (create functions only)
  53  * @param array $keyoptions
  54  *
  55  * @internal param array $keys list of required fields options. One of the options is required
  56  * @return null or throws error if there the required fields not present
  57  * @
  58  */
  59 function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array(
  60   )) {
  61   $keys = array(array());
  62   foreach ($keyoptions as $key) {
  63     $keys[0][] = $key;
  64   }
  65   civicrm_api3_verify_mandatory($params, $daoName, $keys);
  66 }
  67
  68 /**
  69  * Function to check mandatory fields are included
  70  *
  71  * @param array $params array of fields to check
  72  * @param array $daoName string DAO to check for required fields (create functions only)
  73  * @param array $keys list of required fields. A value can be an array denoting that either this or that is required.
  74  * @param bool $verifyDAO
  75  *
  76  * @throws API_Exception
  77  * @return null or throws error if there the required fields not present
  78  *
  79  * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param
  80  */
  81 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(
  82   ), $verifyDAO = TRUE) {
  83
  84   $unmatched = array();
  85   if ($daoName != NULL && $verifyDAO && empty($params['id'])) {
  86     $unmatched = _civicrm_api3_check_required_fields($params, $daoName, TRUE);
  87     if (!is_array($unmatched)) {
  88       $unmatched = array();
  89     }
  90   }
  91
  92   if (!empty($params['id'])) {
  93     $keys = array('version');
  94   }
  95   else {
  96     if (!in_array('version', $keys)) {
  97       // required from v3 onwards
  98       $keys[] = 'version';
  99     }
 100   }
 101   foreach ($keys as $key) {
 102     if (is_array($key)) {
 103       $match = 0;
 104       $optionset = array();
 105       foreach ($key as $subkey) {
 106         if (!array_key_exists($subkey, $params) || empty($params[$subkey])) {
 107           $optionset[] = $subkey;
 108         }
 109         else {
 110           // as long as there is one match then we don't need to rtn anything
 111           $match = 1;
 112         }
 113       }
 114       if (empty($match) && !empty($optionset)) {
 115         $unmatched[] = "one of (" . implode(", ", $optionset) . ")";
 116       }
 117     }
 118     else {
 119       if (!array_key_exists($key, $params) || empty($params[$key])) {
 120         $unmatched[] = $key;
 121       }
 122     }
 123   }
 124   if (!empty($unmatched)) {
 125     throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched));
 126   }
 127 }
 128
 129 /**
 130  *
 131  * @param <type> $data
 132  * @param array $data
 133  * @param object $dao DAO / BAO object to be freed here
 134  *
 135  * @throws API_Exception
 136  * @return array <type>
 137  */
 138 function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) {
 139   //fix me - $dao should be param 4 & 3 should be $apiRequest
 140   if (is_object($dao)) {
 141     $dao->free();
 142   }
 143
 144   if (is_array($dao)) {
 145     if ($msg == 'DB Error: constraint violation' || substr($msg, 0,9)  == 'DB Error:' || $msg == 'DB Error: already exists') {
 146       try {
 147         $fields = _civicrm_api3_api_getfields($dao);
 148         _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], $fields, TRUE);
 149       }
 150       catch(Exception $e) {
 151         $msg = $e->getMessage();
 152       }
 153     }
 154   }
 155   $data['is_error'] = 1;
 156   $data['error_message'] = $msg;
 157   // we will show sql to privelledged user only (not sure of a specific
 158   // security hole here but seems sensible - perhaps should apply to the trace as well?
 159   if(isset($data['sql']) && CRM_Core_Permission::check('Administer CiviCRM')) {
 160     $data['debug_information'] = $data['sql'];
 161   }
 162   if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && CRM_Utils_Array::value('api.has_parent', $dao['params'])) {
 163     $errorCode = empty($data['error_code']) ? 'chained_api_failed' : $data['error_code'];
 164     throw new API_Exception('Error in call to ' . $dao['entity'] . '_' . $dao['action'] . ' : ' . $msg, $errorCode, $data);
 165   }
 166   return $data;
 167 }
 168
 169 /**
 170  * Format array in result output styple
 171  *
 172  * @param array $values values generated by API operation (the result)
 173  * @param array $params parameters passed into API call
 174  * @param string $entity the entity being acted on
 175  * @param string $action the action passed to the API
 176  * @param object $dao DAO object to be freed here
 177  * @param array $extraReturnValues additional values to be added to top level of result array(
 178  *   - this param is currently used for legacy behaviour support
 179  *
 180  * @return array $result
 181  */
 182 function civicrm_api3_create_success($values = 1, $params = array(
 183   ), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) {
 184   $result = array();
 185   $result['is_error'] = 0;
 186   //lets set the ['id'] field if it's not set & we know what the entity is
 187   if (is_array($values) && !empty($entity)) {
 188     foreach ($values as $key => $item) {
 189       if (empty($item['id']) && !empty($item[$entity . "_id"])) {
 190         $values[$key]['id'] = $item[$entity . "_id"];
 191       }
 192       if(!empty($item['financial_type_id'])){
 193         //4.3 legacy handling
 194         $values[$key]['contribution_type_id'] = $item['financial_type_id'];
 195       }
 196       if(!empty($item['next_sched_contribution_date'])){
 197         // 4.4 legacy handling
 198         $values[$key]['next_sched_contribution'] = $item['next_sched_contribution_date'];
 199       }
 200     }
 201   }
 202
 203   if (is_array($params) && !empty($params['debug'])) {
 204     if (is_string($action) && $action != 'getfields') {
 205       $apiFields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action) + $params);
 206     }
 207     elseif ($action != 'getfields') {
 208       $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) + $params);
 209     }
 210     else {
 211       $apiFields = FALSE;
 212     }
 213
 214     $allFields = array();
 215     if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array::value('values', $apiFields))) {
 216       $allFields = array_keys($apiFields['values']);
 217     }
 218     $paramFields = array_keys($params);
 219     $undefined = array_diff($paramFields, $allFields, array_keys($_COOKIE), array('action', 'entity', 'debug', 'version', 'check_permissions', 'IDS_request_uri', 'IDS_user_agent', 'return', 'sequential', 'rowCount', 'option_offset', 'option_limit', 'custom', 'option_sort', 'options'));
 220     if ($undefined) {
 221       $result['undefined_fields'] = array_merge($undefined);
 222     }
 223   }
 224   if (is_object($dao)) {
 225     $dao->free();
 226   }
 227
 228   $result['version'] = 3;
 229   if (is_array($values)) {
 230     $result['count'] = (int) count($values);
 231
 232     // Convert value-separated strings to array
 233     _civicrm_api3_separate_values($values);
 234
 235     if ($result['count'] == 1) {
 236       list($result['id']) = array_keys($values);
 237     }
 238     elseif (!empty($values['id']) && is_int($values['id'])) {
 239       $result['id'] = $values['id'];
 240     }
 241   }
 242   else {
 243     $result['count'] = !empty($values) ? 1 : 0;
 244   }
 245
 246   if (is_array($values) && isset($params['sequential']) &&
 247     $params['sequential'] == 1
 248   ) {
 249     $result['values'] = array_values($values);
 250   }
 251   else {
 252     $result['values'] = $values;
 253   }
 254
 255   return array_merge($result, $extraReturnValues);
 256 }
 257
 258 /**
 259  * Load the DAO of the entity
 260  */
 261 function _civicrm_api3_load_DAO($entity) {
 262   $dao = _civicrm_api3_get_DAO($entity);
 263   if (empty($dao)) {
 264     return FALSE;
 265   }
 266   $d = new $dao();
 267   return $d;
 268 }
 269
 270 /**
 271  * Function to return the DAO of the function or Entity
 272  * @param String $name  either a function of the api (civicrm_{entity}_create or the entity name
 273  * return the DAO name to manipulate this function
 274  * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
 275  * @return mixed|string
 276  */
 277 function _civicrm_api3_get_DAO($name) {
 278   if (strpos($name, 'civicrm_api3') !== FALSE) {
 279     $last = strrpos($name, '_');
 280     // len ('civicrm_api3_') == 13
 281     $name = substr($name, 13, $last - 13);
 282   }
 283
 284   if (strtolower($name) == 'individual' || strtolower($name) == 'household' || strtolower($name) == 'organization') {
 285     $name = 'Contact';
 286   }
 287
 288   //hack to deal with incorrectly named BAO/DAO - see CRM-10859 -
 289   // several of these have been removed but am not confident mailing_recipients is
 290   // tests so have not tackled.
 291   if($name == 'mailing_recipients' || $name == 'MailingRecipients'){
 292     return 'CRM_Mailing_BAO_Recipients';
 293   }
 294   // correct approach for im & acl is unclear
 295   if (strtolower($name) == 'im' || strtolower($name) == 'acl') {
 296     $name = strtoupper($name);
 297   }
 298   return CRM_Core_DAO_AllCoreTables::getFullName(_civicrm_api_get_camel_name($name, 3));
 299 }
 300
 301 /**
 302  * Function to return the DAO of the function or Entity
 303  * @param String $name is either a function of the api (civicrm_{entity}_create or the entity name
 304  * return the DAO name to manipulate this function
 305  * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
 306  * @return mixed
 307  */
 308 function _civicrm_api3_get_BAO($name) {
 309   $dao = _civicrm_api3_get_DAO($name);
 310   if (!$dao) {
 311     return NULL;
 312   }
 313   $bao = str_replace("DAO", "BAO", $dao);
 314   $file = strtr($bao, '_', '/') . '.php';
 315   // Check if this entity actually has a BAO. Fall back on the DAO if not.
 316   return stream_resolve_include_path($file) ? $bao : $dao;
 317 }
 318
 319 /**
 320  *  Recursive function to explode value-separated strings into arrays
 321  *
 322  */
 323 function _civicrm_api3_separate_values(&$values) {
 324   $sp = CRM_Core_DAO::VALUE_SEPARATOR;
 325   foreach ($values as $key => & $value) {
 326     if (is_array($value)) {
 327       _civicrm_api3_separate_values($value);
 328     }
 329     elseif (is_string($value)) {
 330       if($key == 'case_type_id'){// this is to honor the way case API was originally written
 331         $value = trim(str_replace($sp, ',', $value), ',');
 332       }
 333       elseif (strpos($value, $sp) !== FALSE) {
 334         $value = explode($sp, trim($value, $sp));
 335       }
 336     }
 337   }
 338 }
 339
 340 /**
 341  * This is a legacy wrapper for api_store_values which will check the suitable fields using getfields
 342  * rather than DAO->fields
 343  *
 344  * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
 345  *
 346  * Note this is used by BAO type create functions - eg. contribution
 347  * @param string $entity
 348  * @param array $params
 349  * @param array $values
 350  */
 351 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
 352   $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
 353   $fields = $fields['values'];
 354   _civicrm_api3_store_values($fields, $params, $values);
 355 }
 356 /**
 357  *
 358  * @param array $fields
 359  * @param array $params
 360  * @param array $values
 361  *
 362  * @return Bool $valueFound
 363  */
 364 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
 365   $valueFound = FALSE;
 366
 367   $keys = array_intersect_key($params, $fields);
 368   foreach ($keys as $name => $value) {
 369     if ($name !== 'id') {
 370       $values[$name] = $value;
 371       $valueFound = TRUE;
 372     }
 373   }
 374   return $valueFound;
 375 }
 376
 377 /**
 378  * The API supports 2 types of get requestion. The more complex uses the BAO query object.
 379  *  This is a generic function for those functions that call it
 380  *
 381  *  At the moment only called by contact we should extend to contribution &
 382  *  others that use the query object. Note that this function passes permission information in.
 383  *  The others don't
 384  *
 385  * @param $entity
 386  * @param array $params as passed into api get or getcount function
 387  * @param array $additional_options
 388  * @param bool $getCount are we just after the count
 389  *
 390  * @return
 391  * @internal param array $options array of options (so we can modify the filter)
 392  */
 393 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){
 394
 395   // Convert id to e.g. contact_id
 396   if (empty($params[$entity . '_id']) && isset($params['id'])) {
 397     $params[$entity . '_id'] = $params['id'];
 398   }
 399   unset($params['id']);
 400
 401   $options = _civicrm_api3_get_options_from_params($params, TRUE);
 402
 403   $inputParams = array_merge(
 404     CRM_Utils_Array::value('input_params', $options, array()),
 405     CRM_Utils_Array::value('input_params', $additional_options, array())
 406   );
 407   $returnProperties = array_merge(
 408     CRM_Utils_Array::value('return', $options, array()),
 409     CRM_Utils_Array::value('return', $additional_options, array())
 410   );
 411   if(empty($returnProperties)){
 412     $returnProperties = NULL;
 413   }
 414   if(!empty($params['check_permissions'])){
 415     // we will filter query object against getfields
 416     $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
 417     // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
 418     $fields['values'][$entity . '_id'] = array();
 419     $varsToFilter = array('returnProperties', 'inputParams');
 420     foreach ($varsToFilter as $varToFilter){
 421       if(!is_array($$varToFilter)){
 422         continue;
 423       }
 424       //I was going to throw an exception rather than silently filter out - but
 425       //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
 426       //so we are silently ignoring parts of their request
 427       //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
 428       $$varToFilter = array_intersect_key($$varToFilter, $fields['values']);
 429     }
 430   }
 431   $options = array_merge($options,$additional_options);
 432   $sort             = CRM_Utils_Array::value('sort', $options, NULL);
 433   $offset             = CRM_Utils_Array::value('offset', $options, NULL);
 434   $limit             = CRM_Utils_Array::value('limit', $options, NULL);
 435   $smartGroupCache  = CRM_Utils_Array::value('smartGroupCache', $params);
 436
 437   if($getCount){
 438     $limit = NULL;
 439     $returnProperties = NULL;
 440   }
 441
 442   $newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams);
 443   foreach ($newParams as &$newParam) {
 444     if($newParam[1] == '='  && is_array($newParam[2])) {
 445       // we may be looking at an attempt to use the 'IN' style syntax
 446       // @todo at time of writing only 'IN' & 'NOT IN' are  supported for the array style syntax
 447       $sqlFilter = CRM_Core_DAO::createSqlFilter($newParam[0], $params[$newParam[0]], 'String', NULL, TRUE);
 448       if($sqlFilter) {
 449         $newParam[1] = key($newParam[2]);
 450         $newParam[2] = $sqlFilter;
 451       }
 452     }
 453
 454   }
 455   $skipPermissions = CRM_Utils_Array::value('check_permissions', $params)? 0 :1;
 456
 457   list($entities, $options) = CRM_Contact_BAO_Query::apiQuery(
 458     $newParams,
 459     $returnProperties,
 460     NULL,
 461     $sort,
 462     $offset ,
 463     $limit,
 464     $smartGroupCache,
 465     $getCount,
 466     $skipPermissions
 467   );
 468   if ($getCount) { // only return the count of contacts
 469     return $entities;
 470   }
 471
 472   return $entities;
 473 }
 474
 475 /**
 476  * Function transfers the filters being passed into the DAO onto the params object
 477  */
 478 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
 479   $entity = substr($dao->__table, 8);
 480
 481   $allfields = _civicrm_api3_build_fields_array($dao, $unique);
 482
 483   $fields = array_intersect(array_keys($allfields), array_keys($params));
 484   if (isset($params[$entity . "_id"])) {
 485     //if entity_id is set then treat it as ID (will be overridden by id if set)
 486     $dao->id = $params[$entity . "_id"];
 487   }
 488
 489   $options = _civicrm_api3_get_options_from_params($params);
 490   //apply options like sort
 491   _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
 492
 493   //accept filters like filter.activity_date_time_high
 494   // std is now 'filters' => ..
 495   if (strstr(implode(',', array_keys($params)), 'filter')) {
 496     if (isset($params['filters']) && is_array($params['filters'])) {
 497       foreach ($params['filters'] as $paramkey => $paramvalue) {
 498         _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
 499       }
 500     }
 501     else {
 502       foreach ($params as $paramkey => $paramvalue) {
 503         if (strstr($paramkey, 'filter')) {
 504           _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
 505         }
 506       }
 507     }
 508   }
 509   // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
 510   // support for other syntaxes is discussed in ticket but being put off for now
 511   $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
 512   if (!$fields) {
 513     $fields = array();
 514   }
 515
 516   foreach ($fields as $field) {
 517     if (is_array($params[$field])) {
 518       //get the actual fieldname from db
 519       $fieldName = $allfields[$field]['name'];
 520       $where = CRM_Core_DAO::createSqlFilter($fieldName, $params[$field], 'String');
 521       if(!empty($where)) {
 522         $dao->whereAdd($where);
 523       }
 524     }
 525     else {
 526       if ($unique) {
 527         $daoFieldName = $allfields[$field]['name'];
 528         if (empty($daoFieldName)) {
 529           throw new API_Exception("Failed to determine field name for \"$field\"");
 530         }
 531         $dao->{$daoFieldName} = $params[$field];
 532       }
 533       else {
 534         $dao->$field = $params[$field];
 535       }
 536     }
 537   }
 538   if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) {
 539     $dao->selectAdd();
 540     $options['return']['id'] = TRUE;// ensure 'id' is included
 541     $allfields =  _civicrm_api3_get_unique_name_array($dao);
 542     $returnMatched = array_intersect(array_keys($options['return']), $allfields);
 543     foreach ($returnMatched as $returnValue) {
 544       $dao->selectAdd($returnValue);
 545     }
 546
 547     $unmatchedFields = array_diff(// not already matched on the field names
 548       array_keys($options['return']),
 549       $returnMatched
 550     );
 551
 552     $returnUniqueMatched = array_intersect(
 553       $unmatchedFields,
 554       array_flip($allfields)// but a match for the field keys
 555     );
 556     foreach ($returnUniqueMatched as $uniqueVal){
 557       $dao->selectAdd($allfields[$uniqueVal]);
 558     }
 559   }
 560 }
 561
 562 /**
 563  * Apply filters (e.g. high, low) to DAO object (prior to find)
 564  * @param string $filterField field name of filter
 565  * @param string $filterValue field value of filter
 566  * @param object $dao DAO object
 567  */
 568 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
 569   if (strstr($filterField, 'high')) {
 570     $fieldName = substr($filterField, 0, -5);
 571     $dao->whereAdd("($fieldName <= $filterValue )");
 572   }
 573   if (strstr($filterField, 'low')) {
 574     $fieldName = substr($filterField, 0, -4);
 575     $dao->whereAdd("($fieldName >= $filterValue )");
 576   }
 577   if($filterField == 'is_current' && $filterValue == 1){
 578     $todayStart = date('Ymd000000', strtotime('now'));
 579     $todayEnd = date('Ymd235959', strtotime('now'));
 580     $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
 581     if(property_exists($dao, 'is_active')){
 582       $dao->whereAdd('is_active = 1');
 583     }
 584   }
 585 }
 586
 587 /**
 588  * Get sort, limit etc options from the params - supporting old & new formats.
 589  * get returnproperties for legacy
 590  *
 591  * @param array $params params array as passed into civicrm_api
 592  * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
 593  * for legacy report & return a unique fields array
 594  *
 595  * @param string $entity
 596  * @param string $action
 597  *
 598  * @return array $options options extracted from params
 599  */
 600 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
 601   $is_count = FALSE;
 602   $sort = CRM_Utils_Array::value('sort', $params, 0);
 603   $sort = CRM_Utils_Array::value('option.sort', $params, $sort);
 604   $sort = CRM_Utils_Array::value('option_sort', $params, $sort);
 605
 606   $offset = CRM_Utils_Array::value('offset', $params, 0);
 607   $offset = CRM_Utils_Array::value('option.offset', $params, $offset);
 608   // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
 609   $offset = CRM_Utils_Array::value('option_offset', $params, $offset);
 610
 611   $limit = CRM_Utils_Array::value('rowCount', $params, 25);
 612   $limit = CRM_Utils_Array::value('option.limit', $params, $limit);
 613   $limit = CRM_Utils_Array::value('option_limit', $params, $limit);
 614
 615   if (is_array(CRM_Utils_Array::value('options', $params))) {
 616     // is count is set by generic getcount not user
 617     $is_count = CRM_Utils_Array::value('is_count', $params['options']);
 618     $offset = CRM_Utils_Array::value('offset', $params['options'], $offset);
 619     $limit  = CRM_Utils_Array::value('limit', $params['options'], $limit);
 620     $sort   = CRM_Utils_Array::value('sort', $params['options'], $sort);
 621   }
 622
 623   $returnProperties = array();
 624   // handle the format return =sort_name,display_name...
 625   if (array_key_exists('return', $params)) {
 626     if (is_array($params['return'])) {
 627       $returnProperties = array_fill_keys($params['return'], 1);
 628     }
 629     else {
 630       $returnProperties = explode(',', str_replace(' ', '', $params['return']));
 631       $returnProperties = array_fill_keys($returnProperties, 1);
 632     }
 633   }
 634   if ($entity && $action =='get') {
 635     if (CRM_Utils_Array::value('id',$returnProperties)) {
 636       $returnProperties[$entity . '_id'] = 1;
 637       unset($returnProperties['id']);
 638     }
 639     switch (trim(strtolower($sort))){
 640     case 'id':
 641     case 'id desc':
 642     case 'id asc':
 643       $sort = str_replace('id', $entity . '_id',$sort);
 644     }
 645   }
 646
 647   $options = array(
 648     'offset' => CRM_Utils_Rule::integer($offset) ? $offset : NULL,
 649     'sort' => CRM_Utils_Rule::string($sort) ? $sort : NULL,
 650     'limit' => CRM_Utils_Rule::integer($limit) ? $limit : NULL,
 651     'is_count' => $is_count,
 652     'return' => !empty($returnProperties) ? $returnProperties : NULL,
 653   );
 654
 655   if ($options['sort'] && stristr($options['sort'], 'SELECT')) {
 656     throw new API_Exception('invalid string in sort options');
 657   }
 658
 659   if (!$queryObject) {
 660     return $options;
 661   }
 662   //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
 663   // if the queryobject is being used this should be used
 664   $inputParams = array();
 665   $legacyreturnProperties = array();
 666   $otherVars = array(
 667     'sort', 'offset', 'rowCount', 'options','return',
 668   );
 669   foreach ($params as $n => $v) {
 670     if (substr($n, 0, 7) == 'return.') {
 671       $legacyreturnProperties[substr($n, 7)] = $v;
 672     }
 673     elseif ($n == 'id') {
 674       $inputParams[$entity. '_id'] = $v;
 675     }
 676     elseif (in_array($n, $otherVars)) {}
 677     else {
 678       $inputParams[$n] = $v;
 679       if ($v && !is_array($v) && stristr($v, 'SELECT')) {
 680         throw new API_Exception('invalid string');
 681       }
 682     }
 683   }
 684   $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
 685   $options['input_params'] = $inputParams;
 686   return $options;
 687 }
 688
 689 /**
 690  * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
 691  *
 692  * @param array $params params array as passed into civicrm_api
 693  * @param object $dao DAO object
 694  * @param $entity
 695  */
 696 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
 697
 698   $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
 699   if(!$options['is_count']) {
 700     $dao->limit((int)$options['offset'], (int)$options['limit']);
 701     if (!empty($options['sort'])) {
 702       $dao->orderBy($options['sort']);
 703     }
 704   }
 705 }
 706
 707 /**
 708  * build fields array. This is the array of fields as it relates to the given DAO
 709  * returns unique fields as keys by default but if set but can return by DB fields
 710  */
 711 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
 712   $fields = $bao->fields();
 713   if ($unique) {
 714     if(!CRM_Utils_Array::value('id', $fields)){
 715      $entity = _civicrm_api_get_entity_name_from_dao($bao);
 716      $fields['id'] = $fields[$entity . '_id'];
 717      unset($fields[$entity . '_id']);
 718     }
 719     return $fields;
 720   }
 721
 722   foreach ($fields as $field) {
 723     $dbFields[$field['name']] = $field;
 724   }
 725   return $dbFields;
 726 }
 727
 728 /**
 729  * build fields array. This is the array of fields as it relates to the given DAO
 730  * returns unique fields as keys by default but if set but can return by DB fields
 731  */
 732 function _civicrm_api3_get_unique_name_array(&$bao) {
 733   $fields = $bao->fields();
 734   foreach ($fields as $field => $values) {
 735     $uniqueFields[$field] = CRM_Utils_Array::value('name',$values, $field);
 736   }
 737   return $uniqueFields;
 738 }
 739
 740 /**
 741  * Converts an DAO object to an array
 742  *
 743  * @param  object $dao           (reference )object to convert
 744  * @param null $params
 745  * @param bool $uniqueFields
 746  * @param string $entity
 747  *
 748  * @return array
 749  *
 750  * @params array of arrays (key = id) of array of fields
 751  *
 752  * @static void
 753  * @access public
 754  */
 755 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
 756   $result = array();
 757   if(isset($params['options']) && CRM_Utils_Array::value('is_count', $params['options'])) {
 758     return $dao->count();
 759   }
 760   if (empty($dao) || !$dao->find()) {
 761     return array();
 762   }
 763
 764   if(isset($dao->count)) {
 765     return $dao->count;
 766   }
 767   //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
 768   if (!empty($entity) && CRM_Utils_Array::value('return', $params) && is_array($params['return'])) {
 769     foreach ($params['return'] as $return) {
 770       if (substr($return, 0, 6) == 'custom') {
 771         $custom = TRUE;
 772       }
 773     }
 774   }
 775
 776
 777   $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
 778
 779   while ($dao->fetch()) {
 780     $tmp = array();
 781     foreach ($fields as $key) {
 782       if (array_key_exists($key, $dao)) {
 783         // not sure on that one
 784         if ($dao->$key !== NULL) {
 785           $tmp[$key] = $dao->$key;
 786         }
 787       }
 788     }
 789     $result[$dao->id] = $tmp;
 790     if (!empty($custom)) {
 791       _civicrm_api3_custom_data_get($result[$dao->id], $entity, $dao->id);
 792     }
 793   }
 794
 795
 796   return $result;
 797 }
 798
 799 /**
 800  * Converts an object to an array
 801  *
 802  * @param  object $dao           (reference) object to convert
 803  * @param  array $values        (reference) array
 804  * @param array|bool $uniqueFields
 805  *
 806  * @return array
 807  * @static void
 808  * @access public
 809  */
 810 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
 811
 812   $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
 813   foreach ($fields as $key => $value) {
 814     if (array_key_exists($key, $dao)) {
 815       $values[$key] = $dao->$key;
 816     }
 817   }
 818 }
 819
 820 /**
 821  * Wrapper for _civicrm_object_to_array when api supports unique fields
 822  */
 823 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
 824   return _civicrm_api3_object_to_array($dao, $values, TRUE);
 825 }
 826
 827 /**
 828  *
 829  * @param array $params
 830  * @param array $values
 831  * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
 832  * @param string $entityId ID of entity per $extends
 833  */
 834 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
 835   $values['custom'] = array();
 836   foreach ($params as $key => $value) {
 837     list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField::getKeyID($key, TRUE);
 838     if ($customFieldID && (!IS_NULL($value))) {
 839       CRM_Core_BAO_CustomField::formatCustomField($customFieldID, $values['custom'],
 840         $value, $extends, $customValueID, $entityId, FALSE, FALSE
 841       );
 842     }
 843   }
 844 }
 845
 846 /**
 847  * @deprecated
 848  * This function ensures that we have the right input parameters
 849  *
 850  * This function is only called when $dao is passed into verify_mandatory.
 851  * The practice of passing $dao into verify_mandatory turned out to be
 852  * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
 853  * api level. Hence the intention is to remove this function
 854  * & the associated param from viery_mandatory
 855  *
 856  * @param array $params       Associative array of property name/value
 857  *                             pairs to insert in new history.
 858  * @param $daoName
 859  * @param bool $return
 860  *
 861  * @daoName string DAO to check params agains
 862  *
 863  * @return bool should the missing fields be returned as an array (core error created as default)
 864  *
 865  * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
 866  * @access public
 867  */
 868 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
 869   //@deprecated - see notes
 870   if (isset($params['extends'])) {
 871     if (($params['extends'] == 'Activity' ||
 872         $params['extends'] == 'Phonecall' ||
 873         $params['extends'] == 'Meeting' ||
 874         $params['extends'] == 'Group' ||
 875         $params['extends'] == 'Contribution'
 876       ) &&
 877       ($params['style'] == 'Tab')
 878     ) {
 879       return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
 880     }
 881   }
 882
 883   $dao = new $daoName();
 884   $fields = $dao->fields();
 885
 886   $missing = array();
 887   foreach ($fields as $k => $v) {
 888     if ($v['name'] == 'id') {
 889       continue;
 890     }
 891
 892     if (CRM_Utils_Array::value('required', $v)) {
 893       // 0 is a valid input for numbers, CRM-8122
 894       if (!isset($params[$k]) || (empty($params[$k]) && !($params[$k] === 0))) {
 895         $missing[] = $k;
 896       }
 897     }
 898   }
 899
 900   if (!empty($missing)) {
 901     if (!empty($return)) {
 902       return $missing;
 903     }
 904     else {
 905       return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
 906     }
 907   }
 908
 909   return TRUE;
 910 }
 911
 912 /**
 913  * Check permissions for a given API call.
 914  *
 915  * @param $entity string API entity being accessed
 916  * @param $action string API action being performed
 917  * @param $params array  params of the API call
 918  * @param $throw deprecated bool    whether to throw exception instead of returning false
 919  *
 920  * @throws Exception
 921  * @return bool whether the current API user has the permission to make the call
 922  */
 923 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
 924   // return early unless we’re told explicitly to do the permission check
 925   if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
 926     return TRUE;
 927   }
 928
 929   require_once 'CRM/Core/DAO/permissions.php';
 930   $permissions = _civicrm_api3_permissions($entity, $action, $params);
 931
 932   // $params might’ve been reset by the alterAPIPermissions() hook
 933   if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
 934     return TRUE;
 935   }
 936
 937   if (!CRM_Core_Permission::check($permissions)) {
 938     if ($throw) {
 939       if(is_array($permissions)) {
 940         $permissions = implode(' and ', $permissions);
 941       }
 942       throw new Exception("API permission check failed for $entity/$action call; insufficient permission: require $permissions");
 943     }
 944     else {
 945       //@todo remove this - this is an internal api function called with $throw set to TRUE. It is only called with false
 946       // in tests & that should be tidied up
 947       return FALSE;
 948     }
 949   }
 950
 951   return TRUE;
 952 }
 953
 954 /**
 955  * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
 956  *
 957  * @param string $bao_name name of BAO
 958  * @param array $params params from api
 959  * @param bool $returnAsSuccess return in api success format
 960  * @param string $entity
 961  *
 962  * @return array
 963  */
 964 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
 965   $bao = new $bao_name();
 966   _civicrm_api3_dao_set_filter($bao, $params, TRUE,$entity);
 967   if ($returnAsSuccess) {
 968       return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity);
 969   }
 970   else {
 971     return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
 972   }
 973 }
 974
 975 /**
 976  * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
 977  * @param string $bao_name Name of BAO Class
 978  * @param array $params parameters passed into the api call
 979  * @param string $entity Entity - pass in if entity is non-standard & required $ids array
 980  * @return array
 981  */
 982 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
 983
 984   $args = array(&$params);
 985   if (!empty($entity)) {
 986     $ids = array($entity => CRM_Utils_Array::value('id', $params));
 987     $args[] = &$ids;
 988   }
 989
 990   if (method_exists($bao_name, 'create')) {
 991     $fct = 'create';
 992     $fct_name = $bao_name . '::' . $fct;
 993     $bao = call_user_func_array(array($bao_name, $fct), $args);
 994   }
 995   elseif (method_exists($bao_name, 'add')) {
 996     $fct = 'add';
 997     $fct_name = $bao_name . '::' . $fct;
 998     $bao = call_user_func_array(array($bao_name, $fct), $args);
 999   }
1000   else {
1001     $fct_name = '_civicrm_api3_basic_create_fallback';
1002     $bao = _civicrm_api3_basic_create_fallback($bao_name, $params);
1003   }
1004
1005   if (is_null($bao)) {
1006     return civicrm_api3_create_error('Entity not created (' . $fct_name . ')');
1007   }
1008   elseif (is_a($bao, 'CRM_Core_Error')) {
1009     //some wierd circular thing means the error takes itself as an argument
1010     $msg = $bao->getMessages($bao);
1011     // the api deals with entities on a one-by-one basis. However, the contribution bao pushes entities
1012     // onto the error object - presumably because the contribution import is not handling multiple errors correctly
1013     // so we need to reset the error object here to avoid getting concatenated errors
1014     //@todo - the mulitple error handling should be moved out of the contribution object to the import / multiple entity processes
1015     CRM_Core_Error::singleton()->reset();
1016     throw new API_Exception($msg);
1017   }
1018   else {
1019     $values = array();
1020     _civicrm_api3_object_to_array($bao, $values[$bao->id]);
1021     return civicrm_api3_create_success($values, $params, $entity, 'create', $bao);
1022   }
1023 }
1024
1025 /**
1026  * For BAO's which don't have a create() or add() functions, use this fallback implementation.
1027  *
1028  * @fixme There's an intuitive sense that this behavior should be defined somehow in the BAO/DAO class
1029  * structure. In practice, that requires a fair amount of refactoring and/or kludgery.
1030  *
1031  * @param string $bao_name
1032  * @param array $params
1033  *
1034  * @throws API_Exception
1035  * @return CRM_Core_DAO|NULL an instance of the BAO
1036  */
1037 function _civicrm_api3_basic_create_fallback($bao_name, &$params) {
1038   $entityName = CRM_Core_DAO_AllCoreTables::getBriefName(get_parent_class($bao_name));
1039   if (empty($entityName)) {
1040     throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array(
1041       'class_name' => $bao_name,
1042     ));
1043   }
1044   $hook = empty($params['id']) ? 'create' : 'edit';
1045
1046   CRM_Utils_Hook::pre($hook, $entityName, CRM_Utils_Array::value('id', $params), $params);
1047   $instance = new $bao_name();
1048   $instance->copyValues($params);
1049   $instance->save();
1050   CRM_Utils_Hook::post($hook, $entityName, $instance->id, $instance);
1051
1052   return $instance;
1053 }
1054
1055 /**
1056  * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
1057  * if api::del doesn't exist it will try DAO delete method
1058  */
1059 function _civicrm_api3_basic_delete($bao_name, &$params) {
1060
1061   civicrm_api3_verify_mandatory($params, NULL, array('id'));
1062   $args = array(&$params['id']);
1063   if (method_exists($bao_name, 'del')) {
1064     $bao = call_user_func_array(array($bao_name, 'del'), $args);
1065     if ($bao !== FALSE) {
1066       return civicrm_api3_create_success(TRUE);
1067     }
1068     throw new API_Exception('Could not delete entity id ' . $params['id']);
1069   }
1070   elseif (method_exists($bao_name, 'delete')) {
1071     $dao = new $bao_name();
1072     $dao->id = $params['id'];
1073     if ($dao->find()) {
1074       while ($dao->fetch()) {
1075         $dao->delete();
1076         return civicrm_api3_create_success();
1077       }
1078     }
1079     else {
1080       throw new API_Exception('Could not delete entity id ' . $params['id']);
1081     }
1082   }
1083
1084   throw new API_Exception('no delete method found');
1085 }
1086
1087 /**
1088  * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1089  * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1090  *
1091  * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1092  * @param string $entity  e.g membership, event
1093  * @param $entity_id
1094  * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1095  * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1096  * @param string $subName - Subtype of entity
1097  */
1098 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1099   $groupTree = &CRM_Core_BAO_CustomGroup::getTree($entity,
1100     CRM_Core_DAO::$_nullObject,
1101     $entity_id,
1102     $groupID,
1103     $subType,
1104     $subName
1105   );
1106   $groupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1, CRM_Core_DAO::$_nullObject);
1107   $customValues = array();
1108   CRM_Core_BAO_CustomGroup::setDefaults($groupTree, $customValues);
1109   if (!empty($customValues)) {
1110     foreach ($customValues as $key => $val) {
1111       if (strstr($key, '_id')) {
1112         $idkey = substr($key, 0, -3);
1113         $returnArray['custom_' . (CRM_Core_BAO_CustomField::getKeyID($idkey) . "_id")] = $val;
1114         $returnArray[$key] = $val;
1115       }
1116       else {
1117         // per standard - return custom_fieldID
1118         $returnArray['custom_' . (CRM_Core_BAO_CustomField::getKeyID($key))] = $val;
1119
1120         //not standard - but some api did this so guess we should keep - cheap as chips
1121         $returnArray[$key] = $val;
1122       }
1123     }
1124   }
1125 }
1126
1127 /**
1128  * Validate fields being passed into API. This function relies on the getFields function working accurately
1129  * for the given API. If error mode is set to TRUE then it will also check
1130  * foreign keys
1131  *
1132  * As of writing only date was implemented.
1133  * @param string $entity
1134  * @param string $action
1135  * @param array $params -
1136  * @param array $fields response from getfields all variables are the same as per civicrm_api
1137  * @param bool $errorMode errorMode do intensive post fail checks?
1138  * @throws Exception
1139  */
1140 function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $errorMode = False) {
1141   $fields = array_intersect_key($fields, $params);
1142   foreach ($fields as $fieldName => $fieldInfo) {
1143     switch (CRM_Utils_Array::value('type', $fieldInfo)) {
1144       case CRM_Utils_Type::T_INT:
1145         //field is of type integer
1146         _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1147         break;
1148
1149       case 4:
1150       case 12:
1151         //field is of type date or datetime
1152         _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1153         break;
1154
1155     case 32://blob
1156         _civicrm_api3_validate_html($params, $fieldName, $fieldInfo);
1157         break;
1158
1159       case CRM_Utils_Type::T_STRING:
1160         _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1161         break;
1162
1163       case CRM_Utils_Type::T_MONEY:
1164         if (!CRM_Utils_Rule::money($params[$fieldName]) && !empty($params[$fieldName])) {
1165           throw new Exception($fieldName . " is  not a valid amount: " . $params[$fieldName]);
1166         }
1167     }
1168
1169     // intensive checks - usually only called after DB level fail
1170     if (!empty($errorMode) && strtolower($action) == 'create') {
1171       if (CRM_Utils_Array::value('FKClassName', $fieldInfo)) {
1172         if (CRM_Utils_Array::value($fieldName, $params)) {
1173           _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo);
1174         }
1175         elseif (CRM_Utils_Array::value('required', $fieldInfo)) {
1176           throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report");
1177         }
1178       }
1179       if (CRM_Utils_Array::value('api.unique', $fieldInfo)) {
1180         $params['entity'] = $entity;
1181         _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo);
1182       }
1183     }
1184   }
1185 }
1186
1187 /**
1188  * Validate date fields being passed into API.
1189  * It currently converts both unique fields and DB field names to a mysql date.
1190  * @todo - probably the unique field handling & the if exists handling is now done before this
1191  * function is reached in the wrapper - can reduce this code down to assume we
1192  * are only checking the passed in field
1193  *
1194  * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1195  * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1196  *
1197  * @param array $params params from civicrm_api
1198  * @param string $fieldName uniquename of field being checked
1199  * @param $fieldInfo
1200  * @throws Exception
1201  * @internal param array $fieldinfo array of fields from getfields function
1202  */
1203 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1204   //should we check first to prevent it from being copied if they have passed in sql friendly format?
1205   if (CRM_Utils_Array::value($fieldInfo['name'], $params)) {
1206     //accept 'whatever strtotime accepts
1207     if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1208       throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1209     }
1210     $params[$fieldInfo['name']] = CRM_Utils_Date::processDate($params[$fieldInfo['name']]);
1211   }
1212   if ((CRM_Utils_Array::value('name', $fieldInfo) != $fieldName) && CRM_Utils_Array::value($fieldName, $params)) {
1213     //If the unique field name differs from the db name & is set handle it here
1214     if (strtotime($params[$fieldName]) === FALSE) {
1215       throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]);
1216     }
1217     $params[$fieldName] = CRM_Utils_Date::processDate($params[$fieldName]);
1218   }
1219 }
1220
1221 /**
1222  * Validate foreign constraint fields being passed into API.
1223  *
1224  * @param array $params params from civicrm_api
1225  * @param string $fieldName uniquename of field being checked
1226  * @param $fieldInfo
1227  * @throws Exception
1228  * @internal param array $fieldinfo array of fields from getfields function
1229  */
1230 function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) {
1231   $dao = new $fieldInfo['FKClassName'];
1232   $dao->id = $params[$fieldName];
1233   $dao->selectAdd();
1234   $dao->selectAdd('id');
1235   if (!$dao->find()) {
1236     throw new Exception("$fieldName is not valid : " . $params[$fieldName]);
1237   }
1238 }
1239
1240 /**
1241  * Validate foreign constraint fields being passed into API.
1242  *
1243  * @param array $params params from civicrm_api
1244  * @param string $fieldName uniquename of field being checked
1245  * @param $fieldInfo
1246  * @throws Exception
1247  * @internal param array $fieldinfo array of fields from getfields function
1248  */
1249 function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) {
1250   $existing = civicrm_api($params['entity'], 'get', array(
1251       'version' => $params['version'],
1252       $fieldName => $params[$fieldName],
1253     ));
1254   // an entry already exists for this unique field
1255   if ($existing['count'] == 1) {
1256     // question - could this ever be a security issue?
1257     throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1258   }
1259 }
1260
1261 /**
1262  * Generic implementation of the "replace" action.
1263  *
1264  * Replace the old set of entities (matching some given keys) with a new set of
1265  * entities (matching the same keys).
1266  *
1267  * Note: This will verify that 'values' is present, but it does not directly verify
1268  * any other parameters.
1269  *
1270  * @param string $entity entity name
1271  * @param array $params params from civicrm_api, including:
1272  *   - 'values': an array of records to save
1273  *   - all other items: keys which identify new/pre-existing records
1274  * @return array|int
1275  */
1276 function _civicrm_api3_generic_replace($entity, $params) {
1277
1278   $transaction = new CRM_Core_Transaction();
1279   try {
1280     if (!is_array($params['values'])) {
1281       throw new Exception("Mandatory key(s) missing from params array: values");
1282     }
1283
1284     // Extract the keys -- somewhat scary, don't think too hard about it
1285     $baseParams = _civicrm_api3_generic_replace_base_params($params);
1286
1287     // Lookup pre-existing records
1288     $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1289     if (civicrm_error($preexisting)) {
1290       $transaction->rollback();
1291       return $preexisting;
1292     }
1293
1294     // Save the new/updated records
1295     $creates = array();
1296     foreach ($params['values'] as $replacement) {
1297       // Sugar: Don't force clients to duplicate the 'key' data
1298       $replacement = array_merge($baseParams, $replacement);
1299       $action      = (isset($replacement['id']) || isset($replacement[$entity . '_id'])) ? 'update' : 'create';
1300       $create      = civicrm_api($entity, $action, $replacement);
1301       if (civicrm_error($create)) {
1302         $transaction->rollback();
1303         return $create;
1304       }
1305       foreach ($create['values'] as $entity_id => $entity_value) {
1306         $creates[$entity_id] = $entity_value;
1307       }
1308     }
1309
1310     // Remove stale records
1311     $staleIDs = array_diff(
1312       array_keys($preexisting['values']),
1313       array_keys($creates)
1314     );
1315     foreach ($staleIDs as $staleID) {
1316       $delete = civicrm_api($entity, 'delete', array(
1317           'version' => $params['version'],
1318           'id' => $staleID,
1319         ));
1320       if (civicrm_error($delete)) {
1321         $transaction->rollback();
1322         return $delete;
1323       }
1324     }
1325
1326     return civicrm_api3_create_success($creates, $params);
1327   }
1328   catch(PEAR_Exception $e) {
1329     $transaction->rollback();
1330     return civicrm_api3_create_error($e->getMessage());
1331   }
1332   catch(Exception $e) {
1333     $transaction->rollback();
1334     return civicrm_api3_create_error($e->getMessage());
1335   }
1336 }
1337
1338 /**
1339  * @param $params
1340  *
1341  * @return mixed
1342  */
1343 function _civicrm_api3_generic_replace_base_params($params) {
1344   $baseParams = $params;
1345   unset($baseParams['values']);
1346   unset($baseParams['sequential']);
1347   unset($baseParams['options']);
1348   return $baseParams;
1349 }
1350
1351 /**
1352  * returns fields allowable by api
1353  *
1354  * @param $entity string Entity to query
1355  * @param bool $unique index by unique fields?
1356  * @param array $params
1357  *
1358  * @return array
1359  */
1360 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1361   )) {
1362   $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1363   $dao = _civicrm_api3_get_DAO($entity);
1364   if (empty($dao)) {
1365     return array();
1366   }
1367   $d = new $dao();
1368   $fields = $d->fields();
1369   // replace uniqueNames by the normal names as the key
1370   if (empty($unique)) {
1371     foreach ($fields as $name => & $field) {
1372       //getting rid of unused attributes
1373       foreach ($unsetIfEmpty as $attr) {
1374         if (empty($field[$attr])) {
1375           unset($field[$attr]);
1376         }
1377       }
1378       if ($name == $field['name']) {
1379         continue;
1380       }
1381       if (array_key_exists($field['name'], $fields)) {
1382         $field['error'] = 'name conflict';
1383         // it should never happen, but better safe than sorry
1384         continue;
1385       }
1386       $fields[$field['name']] = $field;
1387       $fields[$field['name']]['uniqueName'] = $name;
1388       unset($fields[$name]);
1389     }
1390   }
1391   $fields += _civicrm_api_get_custom_fields($entity, $params);
1392   return $fields;
1393 }
1394
1395 /**
1396  * Return an array of fields for a given entity - this is the same as the BAO function but
1397  * fields are prefixed with 'custom_' to represent api params
1398  */
1399 function _civicrm_api_get_custom_fields($entity, &$params) {
1400   $customfields = array();
1401   $entity = _civicrm_api_get_camel_name($entity);
1402   if (strtolower($entity) == 'contact') {
1403     // Use sub-type if available, otherwise stick with 'Contact'
1404     $entity = CRM_Utils_Array::value('contact_type', $params);
1405   }
1406   $retrieveOnlyParent = FALSE;
1407   // we could / should probably test for other subtypes here - e.g. activity_type_id
1408   if($entity == 'Contact'){
1409     empty($params['contact_sub_type']);
1410   }
1411   $customfields = CRM_Core_BAO_CustomField::getFields($entity,
1412     FALSE,
1413     FALSE,
1414     CRM_Utils_Array::value('contact_sub_type', $params, FALSE),
1415     NULL,
1416     $retrieveOnlyParent,
1417     FALSE,
1418     FALSE
1419   );
1420   // find out if we have any requests to resolve options
1421   $getoptions = CRM_Utils_Array::value('get_options', CRM_Utils_Array::value('options',$params));
1422   if(!is_array($getoptions)){
1423       $getoptions = array($getoptions);
1424   }
1425
1426   foreach ($customfields as $key => $value) {
1427     // Regular fields have a 'name' property
1428     $value['name'] = 'custom_' . $key;
1429     $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']);
1430     $customfields['custom_' . $key] = $value;
1431     if (in_array('custom_' . $key, $getoptions)) {
1432       $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption::valuesByID($key);
1433     }
1434     unset($customfields[$key]);
1435   }
1436   return $customfields;
1437 }
1438 /**
1439  * Translate the custom field data_type attribute into a std 'type'
1440  */
1441 function _getStandardTypeFromCustomDataType($dataType) {
1442   $mapping = array(
1443     'String' => CRM_Utils_Type::T_STRING,
1444     'Int' => CRM_Utils_Type::T_INT,
1445     'Money' => CRM_Utils_Type::T_MONEY,
1446     'Memo' => CRM_Utils_Type::T_LONGTEXT,
1447     'Float' => CRM_Utils_Type::T_FLOAT,
1448     'Date' => CRM_Utils_Type::T_DATE,
1449     'Boolean' => CRM_Utils_Type::T_BOOLEAN,
1450     'StateProvince' => CRM_Utils_Type::T_INT,
1451     'File' => CRM_Utils_Type::T_STRING,
1452     'Link' => CRM_Utils_Type::T_STRING,
1453     'ContactReference' => CRM_Utils_Type::T_INT,
1454     'Country' => CRM_Utils_Type::T_INT,
1455   );
1456   return $mapping[$dataType];
1457 }
1458 /**
1459  * Return array of defaults for the given API (function is a wrapper on getfields)
1460  */
1461 function _civicrm_api3_getdefaults($apiRequest, $fields) {
1462   $defaults = array();
1463
1464   foreach ($fields as $field => $values) {
1465     if (isset($values['api.default'])) {
1466       $defaults[$field] = $values['api.default'];
1467     }
1468   }
1469   return $defaults;
1470 }
1471
1472 /**
1473  * Return array of defaults for the given API (function is a wrapper on getfields)
1474  */
1475 function _civicrm_api3_getrequired($apiRequest, $fields) {
1476   $required = array('version');
1477
1478   foreach ($fields as $field => $values) {
1479     if (CRM_Utils_Array::value('api.required', $values)) {
1480       $required[] = $field;
1481     }
1482   }
1483   return $required;
1484 }
1485
1486 /**
1487  * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1488  * If multiple aliases the last takes precedence
1489  *
1490  * Function also swaps unique fields for non-unique fields & vice versa.
1491  */
1492 function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) {
1493   foreach ($fields as $field => $values) {
1494     $uniqueName = CRM_Utils_Array::value('uniqueName', $values);
1495     if (CRM_Utils_Array::value('api.aliases', $values)) {
1496       // if aliased field is not set we try to use field alias
1497       if (!isset($apiRequest['params'][$field])) {
1498         foreach ($values['api.aliases'] as $alias) {
1499           if (isset($apiRequest['params'][$alias])) {
1500             $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1501           }
1502           //unset original field  nb - need to be careful with this as it may bring inconsistencies
1503           // out of the woodwork but will be implementing only as _spec function extended
1504           unset($apiRequest['params'][$alias]);
1505         }
1506       }
1507     }
1508     if (!isset($apiRequest['params'][$field])
1509       && CRM_Utils_Array::value('name', $values)
1510       && $field != $values['name']
1511       && isset($apiRequest['params'][$values['name']])
1512     ) {
1513       $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1514       // note that it would make sense to unset the original field here but tests need to be in place first
1515     }
1516     if (!isset($apiRequest['params'][$field])
1517       && $uniqueName
1518       && $field != $uniqueName
1519       && array_key_exists($uniqueName, $apiRequest['params'])
1520       )
1521     {
1522       $apiRequest['params'][$field] = CRM_Utils_Array::value($values['uniqueName'], $apiRequest['params']);
1523       // note that it would make sense to unset the original field here but tests need to be in place first
1524     }
1525   }
1526
1527 }
1528
1529 /**
1530  * Validate integer fields being passed into API.
1531  * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1532  *
1533  * @param array $params params from civicrm_api
1534  * @param string $fieldName uniquename of field being checked
1535  * @param $fieldInfo
1536  * @param $entity
1537  * @throws API_Exception
1538  * @internal param array $fieldinfo array of fields from getfields function
1539  */
1540 function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) {
1541   //if fieldname exists in params
1542   if (CRM_Utils_Array::value($fieldName, $params)) {
1543     // if value = 'user_contact_id' (or similar), replace value with contact id
1544     if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) {
1545       $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]);
1546       if ('unknown-user' === $realContactId) {
1547         throw new API_Exception("\"$fieldName\" \"{$params[$fieldName]}\" cannot be resolved to a contact ID", 2002, array('error_field' => $fieldName,"type"=>"integer"));
1548       } elseif (is_numeric($realContactId)) {
1549         $params[$fieldName] = $realContactId;
1550       }
1551     }
1552     if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options'])) {
1553       _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1554     }
1555
1556     // After swapping options, ensure we have an integer(s)
1557     foreach ((array) ($params[$fieldName]) as $value) {
1558       if ($value && !is_numeric($value) && $value !== 'null' && !is_array($value)) {
1559         throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer"));
1560       }
1561     }
1562
1563     // Check our field length
1564     if(is_string($params[$fieldName]) &&
1565       CRM_Utils_Array::value('maxlength',$fieldInfo)
1566       && strlen($params[$fieldName]) > $fieldInfo['maxlength']
1567       ){
1568       throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters  - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
1569         2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength'])
1570       );
1571     }
1572   }
1573 }
1574
1575 /**
1576  * Determine a contact ID using a string expression
1577  *
1578  * @param string $contactIdExpr e.g. "user_contact_id" or "@user:username"
1579  * @return int|NULL|'unknown-user'
1580  */
1581 function  _civicrm_api3_resolve_contactID($contactIdExpr) {
1582   //if value = 'user_contact_id' replace value with logged in user id
1583   if ($contactIdExpr == "user_contact_id") {
1584     $session = &CRM_Core_Session::singleton();
1585     if (!is_numeric($session->get('userID'))) {
1586       return NULL;
1587     }
1588     return $session->get('userID');
1589   } elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) {
1590     $config = CRM_Core_Config::singleton();
1591
1592     $ufID = $config->userSystem->getUfId($matches[1]);
1593     if (!$ufID) {
1594       return 'unknown-user';
1595     }
1596
1597     $contactID = CRM_Core_BAO_UFMatch::getContactId($ufID);
1598     if (!$contactID) {
1599       return 'unknown-user';
1600     }
1601
1602     return $contactID;
1603   }
1604   return NULL;
1605 }
1606
1607 /**
1608  * Validate html (check for scripting attack)
1609  * @param $params
1610  * @param $fieldName
1611  * @param $fieldInfo
1612  *
1613  * @throws API_Exception
1614  */
1615 function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) {
1616   if ($value = CRM_Utils_Array::value($fieldName, $params)) {
1617     if (!CRM_Utils_Rule::xssString($value)) {
1618       throw new API_Exception('Illegal characters in input (potential scripting attack)', array("field"=>$fieldName,"error_code"=>"xss"));
1619     }
1620   }
1621 }
1622
1623 /**
1624  * Validate string fields being passed into API.
1625  * @param array $params params from civicrm_api
1626  * @param string $fieldName uniquename of field being checked
1627  * @param $fieldInfo
1628  * @param $entity
1629  * @throws API_Exception
1630  * @throws Exception
1631  * @internal param array $fieldinfo array of fields from getfields function
1632  */
1633 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
1634   // If fieldname exists in params
1635   $value = CRM_Utils_Array::value($fieldName, $params, '');
1636   if(!is_array($value)){
1637     $value = (string) $value;
1638   }
1639   else{
1640     //@todo what do we do about passed in arrays. For many of these fields
1641     // the missing piece of functionality is separating them to a separated string
1642     // & many save incorrectly. But can we change them wholesale?
1643   }
1644   if ($value ) {
1645     if (!CRM_Utils_Rule::xssString($value)) {
1646       throw new Exception('Illegal characters in input (potential scripting attack)');
1647     }
1648     if ($fieldName == 'currency') {
1649       if (!CRM_Utils_Rule::currencyCode($value)) {
1650         throw new Exception("Currency not a valid code: $value");
1651       }
1652     }
1653     if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options']) || !empty($fieldInfo['enumValues'])) {
1654       _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1655     }
1656     // Check our field length
1657     elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1658       throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters  - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1659         2100, array('field' => $fieldName)
1660       );
1661     }
1662   }
1663 }
1664
1665 /**
1666  * Validate & swap out any pseudoconstants / options
1667  *
1668  * @param $params: api parameters
1669  * @param $entity: api entity name
1670  * @param $fieldName: field name used in api call (not necessarily the canonical name)
1671  * @param $fieldInfo: getfields meta-data
1672  */
1673 function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) {
1674   $options = CRM_Utils_Array::value('options', $fieldInfo);
1675   if (!$options) {
1676     if(strtolower($entity) == 'profile' && !empty($fieldInfo['entity'])) {
1677       // we need to get the options from the entity the field relates to
1678       $entity = $fieldInfo['entity'];
1679     }
1680     $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name'], 'context' => 'validate'));
1681     $options = CRM_Utils_Array::value('values', $options, array());
1682   }
1683
1684   // If passed a value-separated string, explode to an array, then re-implode after matching values
1685   $implode = FALSE;
1686   if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
1687     $params[$fieldName] = CRM_Utils_Array::explodePadded($params[$fieldName]);
1688     $implode = TRUE;
1689   }
1690   // If passed multiple options, validate each
1691   if (is_array($params[$fieldName])) {
1692     foreach ($params[$fieldName] as &$value) {
1693       if (!is_array($value)) {
1694         _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName);
1695       }
1696     }
1697     // TODO: unwrap the call to implodePadded from the conditional and do it always
1698     // need to verify that this is safe and doesn't break anything though.
1699     // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
1700     if ($implode) {
1701       CRM_Utils_Array::implodePadded($params[$fieldName]);
1702     }
1703   }
1704   else {
1705     _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName);
1706   }
1707 }
1708
1709 /**
1710  * Validate & swap a single option value for a field
1711  *
1712  * @param $value: field value
1713  * @param $options: array of options for this field
1714  * @param $fieldName: field name used in api call (not necessarily the canonical name)
1715  * @throws API_Exception
1716  */
1717 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) {
1718   // If option is a key, no need to translate
1719   if (array_key_exists($value, $options)) {
1720     return;
1721   }
1722
1723   // Translate value into key
1724   $newValue = array_search($value, $options);
1725   if ($newValue !== FALSE) {
1726     $value = $newValue;
1727     return;
1728   }
1729   // Case-insensitive matching
1730   $newValue = strtolower($value);
1731   $options = array_map("strtolower", $options);
1732   $newValue = array_search($newValue, $options);
1733   if ($newValue === FALSE) {
1734     throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName));
1735   }
1736   $value = $newValue;
1737 }
1738
1739 /**
1740  * Returns the canonical name of a field
1741  * @param $entity: api entity name (string should already be standardized - no camelCase)
1742  * @param $fieldName: any variation of a field's name (name, unique_name, api.alias)
1743  *
1744  * @return (string|bool) fieldName or FALSE if the field does not exist
1745  */
1746 function _civicrm_api3_api_resolve_alias($entity, $fieldName) {
1747   if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
1748     return $fieldName;
1749   }
1750   if ($fieldName == "{$entity}_id") {
1751     return 'id';
1752   }
1753   $result = civicrm_api($entity, 'getfields', array(
1754     'version' => 3,
1755     'action' => 'create',
1756   ));
1757   $meta = $result['values'];
1758   if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) {
1759     $fieldName = $fieldName . '_id';
1760   }
1761   if (isset($meta[$fieldName])) {
1762     return $meta[$fieldName]['name'];
1763   }
1764   foreach ($meta as $info) {
1765     if ($fieldName == CRM_Utils_Array::value('uniqueName', $info)) {
1766       return $info['name'];
1767     }
1768     if (array_search($fieldName, CRM_Utils_Array::value('api.aliases', $info, array())) !== FALSE) {
1769       return $info['name'];
1770     }
1771   }
1772   return FALSE;
1773 }