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