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