api/v3/utils.php

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