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/Config.php';
  46   $config = CRM_Core_Config::singleton();
  47   }
  48
  49 /**
  50  * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking
  51  *
  52  * @param array $params array of fields to check
  53  * @param array $daoName string DAO to check for required fields (create functions only)
  54  * @param array $keys list of required fields options. One of the options is required
  55  * @return null or throws error if there the required fields not present
  56
  57  * @
  58  *
  59  */
  60 function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array(
  61   )) {
  62   $keys = array(array());
  63   foreach ($keyoptions as $key) {
  64     $keys[0][] = $key;
  65   }
  66   civicrm_api3_verify_mandatory($params, $daoName, $keys);
  67 }
  68
  69 /**
  70  * Function to check mandatory fields are included
  71  *
  72  * @param array $params array of fields to check
  73  * @param array $daoName string DAO to check for required fields (create functions only)
  74  * @param array $keys list of required fields. A value can be an array denoting that either this or that is required.
  75  * @param bool $verifyDAO
  76  *
  77  * @return null or throws error if there the required fields not present
  78  *
  79  * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param
  80  */
  81 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(
  82   ), $verifyDAO = TRUE) {
  83
  84   $unmatched = array();
  85   if ($daoName != NULL && $verifyDAO && empty($params['id'])) {
  86     $unmatched = _civicrm_api3_check_required_fields($params, $daoName, TRUE);
  87     if (!is_array($unmatched)) {
  88       $unmatched = array();
  89     }
  90   }
  91
  92   if (!empty($params['id'])) {
  93     $keys = array('version');
  94   }
  95   else {
  96     if (!in_array('version', $keys)) {
  97       // required from v3 onwards
  98       $keys[] = 'version';
  99     }
 100   }
 101   foreach ($keys as $key) {
 102     if (is_array($key)) {
 103       $match = 0;
 104       $optionset = array();
 105       foreach ($key as $subkey) {
 106         if (!array_key_exists($subkey, $params) || empty($params[$subkey])) {
 107           $optionset[] = $subkey;
 108         }
 109         else {
 110           // as long as there is one match then we don't need to rtn anything
 111           $match = 1;
 112         }
 113       }
 114       if (empty($match) && !empty($optionset)) {
 115         $unmatched[] = "one of (" . implode(", ", $optionset) . ")";
 116       }
 117     }
 118     else {
 119       if (!array_key_exists($key, $params) || empty($params[$key])) {
 120         $unmatched[] = $key;
 121       }
 122     }
 123   }
 124   if (!empty($unmatched)) {
 125     throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched));
 126   }
 127 }
 128
 129 /**
 130  *
 131  * @param <type> $msg
 132  * @param <type> $data
 133  * @param object $dao DAO / BAO object to be freed here
 134  *
 135  * @return <type>
 136  */
 137 function civicrm_api3_create_error($msg, $data = array(
 138   ), &$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     }
 187   }
 188   //if ( array_key_exists ('debug',$params) && is_object ($dao)) {
 189   if (is_array($params) && array_key_exists('debug', $params)) {
 190     if (!is_object($dao)) {
 191       $d = _civicrm_api3_get_DAO(CRM_Utils_Array::value('entity', $params));
 192       if (!empty($d)) {
 193         $file = str_replace('_', '/', $d) . ".php";
 194         require_once ($file);
 195         $dao = new $d();
 196       }
 197     }
 198     if (is_string($action) && $action != 'getfields') {
 199       $apiFields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action) + $params);
 200     }
 201     elseif ($action != 'getfields') {
 202       $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) + $params);
 203     }
 204     else {
 205       $apiFields = FALSE;
 206     }
 207
 208     $allFields = array();
 209     if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array::value('values', $apiFields))) {
 210       $allFields = array_keys($apiFields['values']);
 211     }
 212     $paramFields = array_keys($params);
 213     $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'));
 214     if ($undefined) {
 215       $result['undefined_fields'] = array_merge($undefined);
 216     }
 217   }
 218   if (is_object($dao)) {
 219     $dao->free();
 220   }
 221
 222   $result['version'] = 3;
 223   if (is_array($values)) {
 224     $result['count'] = count($values);
 225
 226     // Convert value-separated strings to array
 227     _civicrm_api3_separate_values($values);
 228
 229     if ($result['count'] == 1) {
 230       list($result['id']) = array_keys($values);
 231     }
 232     elseif (!empty($values['id']) && is_int($values['id'])) {
 233       $result['id'] = $values['id'];
 234     }
 235   }
 236   else {
 237     $result['count'] = !empty($values) ? 1 : 0;
 238   }
 239
 240   if (is_array($values) && isset($params['sequential']) &&
 241     $params['sequential'] == 1
 242   ) {
 243     $result['values'] = array_values($values);
 244   }
 245   else {
 246     $result['values'] = $values;
 247   }
 248
 249   return array_merge($result, $extraReturnValues);
 250 }
 251
 252 /**
 253  * Load the DAO of the entity
 254  */
 255 function _civicrm_api3_load_DAO($entity) {
 256   $dao = _civicrm_api3_get_DAO($entity);
 257   if (empty($dao)) {
 258     return FALSE;
 259   }
 260   $file = str_replace('_', '/', $dao) . ".php";
 261   require_once ($file);
 262   $d = new $dao();
 263   return $d;
 264 }
 265
 266 /**
 267  * Function to return the DAO of the function or Entity
 268  * @param  $name is either a function of the api (civicrm_{entity}_create or the entity name
 269  * return the DAO name to manipulate this function
 270  * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
 271  */
 272 function _civicrm_api3_get_DAO($name) {
 273   static $dao = NULL;
 274   if (!$dao) {
 275     require ('CRM/Core/DAO/listAll.php');
 276   }
 277
 278   if (strpos($name, 'civicrm_api3') !== FALSE) {
 279     $last = strrpos($name, '_');
 280     // len ('civicrm_api3_') == 13
 281     $name = substr($name, 13, $last - 13);
 282   }
 283
 284   if (strtolower($name) == 'individual' || strtolower($name) == 'household' || strtolower($name) == 'organization') {
 285     $name = 'Contact';
 286   }
 287
 288   //hack to deal with incorrectly named BAO/DAO - see CRM-10859 - remove after rename
 289   if($name == 'price_set'){
 290     return 'CRM_Price_DAO_Set';
 291   }
 292   if($name == 'price_field'){
 293     return 'CRM_Price_DAO_Field';
 294   }
 295   if($name == 'price_field_value'){
 296     return 'CRM_Price_DAO_FieldValue';
 297   }
 298   // these aren't listed on ticket CRM-10859 - but same problem - lack of standardisation
 299   if($name == 'mailing_job' || $name == 'MailingJob'){
 300     return 'CRM_Mailing_BAO_Job';
 301   }
 302   if($name == 'mailing_recipients' || $name == 'MailingRecipients'){
 303     return 'CRM_Mailing_BAO_Recipients';
 304   }
 305   if(strtolower($name) == 'im'){
 306     return 'CRM_Core_BAO_IM';
 307   }
 308
 309
 310   return CRM_Utils_Array::value(_civicrm_api_get_camel_name($name, 3), $dao);
 311 }
 312
 313 /**
 314  * Function to return the DAO of the function or Entity
 315  * @param  $name is either a function of the api (civicrm_{entity}_create or the entity name
 316  * return the DAO name to manipulate this function
 317  * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
 318  */
 319 function _civicrm_api3_get_BAO($name) {
 320   $dao = _civicrm_api3_get_DAO($name);
 321   $dao = str_replace("DAO", "BAO", $dao);
 322   return $dao;
 323 }
 324
 325 /**
 326  *  Recursive function to explode value-separated strings into arrays
 327  *
 328  */
 329 function _civicrm_api3_separate_values(&$values) {
 330   $sp = CRM_Core_DAO::VALUE_SEPARATOR;
 331   foreach ($values as $key => & $value) {
 332     if (is_array($value)) {
 333       _civicrm_api3_separate_values($value);
 334     }
 335     elseif (is_string($value)) {
 336       if($key == 'case_type_id'){// this is to honor the way case API was originally written
 337         $value = trim(str_replace($sp, ',', $value), ',');
 338       }
 339       elseif (strpos($value, $sp) !== FALSE) {
 340         $value = explode($sp, trim($value, $sp));
 341       }
 342     }
 343   }
 344 }
 345
 346 /**
 347  * This is a wrapper for api_store_values which will check the suitable fields using getfields
 348  * rather than DAO->fields
 349  *
 350  * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
 351  *
 352  * Note this is used by BAO type create functions - eg. contribution
 353  * @param string $entity
 354  * @param array $params
 355  * @param array $values
 356  */
 357 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
 358   $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
 359   $fields = $fields['values'];
 360   _civicrm_api3_store_values($fields, $params, $values);
 361 }
 362 /**
 363  *
 364  * @param array $fields
 365  * @param array $params
 366  * @param array $values
 367  *
 368  * @return Bool $valueFound
 369  */
 370 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
 371   $valueFound = FALSE;
 372
 373   $keys = array_intersect_key($params, $fields);
 374   foreach ($keys as $name => $value) {
 375     if ($name !== 'id') {
 376       $values[$name] = $value;
 377       $valueFound = TRUE;
 378     }
 379   }
 380   return $valueFound;
 381 }
 382 /**
 383  * The API supports 2 types of get requestion. The more complex uses the BAO query object.
 384  *  This is a generic function for those functions that call it
 385  *
 386  *  At the moment only called by contact we should extend to contribution &
 387  *  others that use the query object. Note that this function passes permission information in.
 388  *  The others don't
 389  *
 390  * @param array $params as passed into api get or getcount function
 391  * @param array $options array of options (so we can modify the filter)
 392  * @param bool $getCount are we just after the count
 393  */
 394 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = null){
 395
 396   // Convert id to e.g. contact_id
 397   if (empty($params[$entity . '_id']) && isset($params['id'])) {
 398     $params[$entity . '_id'] = $params['id'];
 399   }
 400   unset($params['id']);
 401
 402   $options = _civicrm_api3_get_options_from_params($params, TRUE);
 403
 404   $inputParams = array_merge(
 405     CRM_Utils_Array::value('input_params', $options, array()),
 406     CRM_Utils_Array::value('input_params', $additional_options, array())
 407   );
 408   $returnProperties = array_merge(
 409     CRM_Utils_Array::value('return', $options, array()),
 410     CRM_Utils_Array::value('return', $additional_options, array())
 411   );
 412   if(empty($returnProperties)){
 413     $returnProperties = null;
 414   }
 415   if(!empty($params['check_permissions'])){
 416     // we will filter query object against getfields
 417     $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
 418     // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
 419     $fields['values'][$entity . '_id'] = array();
 420     $varsToFilter = array('returnProperties', 'inputParams');
 421     foreach ($varsToFilter as $varToFilter){
 422       if(!is_array($$varToFilter)){
 423         continue;
 424       }
 425       //I was going to throw an exception rather than silently filter out - but
 426       //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
 427       //so we are silently ignoring parts of their request
 428       //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
 429       $$varToFilter = array_intersect_key($$varToFilter, $fields['values']);
 430     }
 431   }
 432   $options = array_merge($options,$additional_options);
 433   $sort             = CRM_Utils_Array::value('sort', $options, NULL);
 434   $offset             = CRM_Utils_Array::value('offset', $options, NULL);
 435   $limit             = CRM_Utils_Array::value('limit', $options, NULL);
 436   $smartGroupCache  = CRM_Utils_Array::value('smartGroupCache', $params);
 437
 438   if($getCount){
 439     $limit = NULL;
 440     $returnProperties = NULL;
 441   }
 442
 443   $newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams);
 444   $skipPermissions = CRM_Utils_Array::value('check_permissions', $params)? 0 :1;
 445   list($entities, $options) = CRM_Contact_BAO_Query::apiQuery(
 446     $newParams,
 447     $returnProperties,
 448     NULL,
 449     $sort,
 450     $offset ,
 451     $limit,
 452     $smartGroupCache,
 453     $getCount,
 454     $skipPermissions
 455   );
 456   if ($getCount) { // only return the count of contacts
 457     return $entities;
 458   }
 459
 460   return $entities;
 461 }
 462
 463 /**
 464  * Function transfers the filters being passed into the DAO onto the params object
 465  */
 466 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
 467   $entity = substr($dao->__table, 8);
 468
 469   $allfields = _civicrm_api3_build_fields_array($dao, $unique);
 470
 471   $fields = array_intersect(array_keys($allfields), array_keys($params));
 472   if (isset($params[$entity . "_id"])) {
 473     //if entity_id is set then treat it as ID (will be overridden by id if set)
 474     $dao->id = $params[$entity . "_id"];
 475   }
 476   //apply options like sort
 477   _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
 478
 479   //accept filters like filter.activity_date_time_high
 480   // std is now 'filters' => ..
 481   if (strstr(implode(',', array_keys($params)), 'filter')) {
 482     if (isset($params['filters']) && is_array($params['filters'])) {
 483       foreach ($params['filters'] as $paramkey => $paramvalue) {
 484         _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
 485       }
 486     }
 487     else {
 488       foreach ($params as $paramkey => $paramvalue) {
 489         if (strstr($paramkey, 'filter')) {
 490           _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
 491         }
 492       }
 493     }
 494   }
 495   // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
 496   // support for other syntaxes is discussed in ticket but being put off for now
 497   $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
 498   if (!$fields) {
 499     $fields = array();
 500   }
 501
 502   foreach ($fields as $field) {
 503     if (is_array($params[$field])) {
 504       //get the actual fieldname from db
 505       $fieldName = $allfields[$field]['name'];
 506       //array is the syntax for SQL clause
 507       foreach ($params[$field] as $operator => $criteria) {
 508         if (in_array($operator, $acceptedSQLOperators)) {
 509           switch ($operator) {
 510             // unary operators
 511
 512             case 'IS NULL':
 513             case 'IS NOT NULL':
 514               $dao->whereAdd(sprintf('%s %s', $fieldName, $operator));
 515               break;
 516
 517             // ternary operators
 518
 519             case 'BETWEEN':
 520             case 'NOT BETWEEN':
 521               if (empty($criteria[0]) || empty($criteria[1])) {
 522                 throw new exception("invalid criteria for $operator");
 523               }
 524               $dao->whereAdd(sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO::escapeString($criteria[0]), CRM_Core_DAO::escapeString($criteria[1])));
 525               break;
 526
 527             // n-ary operators
 528
 529             case 'IN':
 530             case 'NOT IN':
 531               if (empty($criteria)) {
 532                 throw new exception("invalid criteria for $operator");
 533               }
 534               $escapedCriteria = array_map(array('CRM_Core_DAO', 'escapeString'), $criteria);
 535               $dao->whereAdd(sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
 536               break;
 537
 538             // binary operators
 539
 540             default:
 541
 542               $dao->whereAdd(sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO::escapeString($criteria)));
 543           }
 544         }
 545       }
 546     }
 547     else {
 548       if ($unique) {
 549         $dao->$allfields[$field]['name'] = $params[$field];
 550       }
 551       else {
 552         $dao->$field = $params[$field];
 553       }
 554     }
 555   }
 556   if (!empty($params['return']) && is_array($params['return'])) {
 557     $dao->selectAdd();
 558     $allfields =  _civicrm_api3_get_unique_name_array($dao);
 559     $returnMatched = array_intersect($params['return'], $allfields);
 560     $returnUniqueMatched = array_intersect(
 561       array_diff(// not already matched on the field names
 562         $params['return'],
 563         $returnMatched),
 564         array_flip($allfields)// but a match for the field keys
 565     );
 566
 567     foreach ($returnMatched as $returnValue) {
 568         $dao->selectAdd($returnValue);
 569     }
 570     foreach ($returnUniqueMatched as $uniqueVal){
 571       $dao->selectAdd($allfields[$uniqueVal]);
 572
 573     }
 574     $dao->selectAdd('id');
 575   }
 576 }
 577
 578 /**
 579  * Apply filters (e.g. high, low) to DAO object (prior to find)
 580  * @param string $filterField field name of filter
 581  * @param string $filterValue field value of filter
 582  * @param object $dao DAO object
 583  */
 584 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
 585   if (strstr($filterField, 'high')) {
 586     $fieldName = substr($filterField, 0, -5);
 587     $dao->whereAdd("($fieldName <= $filterValue )");
 588   }
 589   if (strstr($filterField, 'low')) {
 590     $fieldName = substr($filterField, 0, -4);
 591     $dao->whereAdd("($fieldName >= $filterValue )");
 592   }
 593   if($filterField == 'is_current' && $filterValue == 1){
 594     $todayStart = date('Ymd000000', strtotime('now'));
 595     $todayEnd = date('Ymd235959', strtotime('now'));
 596     $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
 597     if(property_exists($dao, 'is_active')){
 598       $dao->whereAdd('is_active = 1');
 599     }
 600   }
 601 }
 602
 603 /**
 604  * Get sort, limit etc options from the params - supporting old & new formats.
 605  * get returnproperties for legacy
 606  * @param array $params params array as passed into civicrm_api
 607  * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
 608  * for legacy report & return a unique fields array
 609  * @return array $options options extracted from params
 610  */
 611 function _civicrm_api3_get_options_from_params(&$params, $queryObject = false, $entity = '', $action = '') {
 612   $sort = CRM_Utils_Array::value('sort', $params, 0);
 613   $sort = CRM_Utils_Array::value('option.sort', $params, $sort);
 614   $sort = CRM_Utils_Array::value('option_sort', $params, $sort);
 615
 616   $offset = CRM_Utils_Array::value('offset', $params, 0);
 617   $offset = CRM_Utils_Array::value('option.offset', $params, $offset);
 618   // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
 619   $offset = CRM_Utils_Array::value('option_offset', $params, $offset);
 620
 621   $limit = CRM_Utils_Array::value('rowCount', $params, 25);
 622   $limit = CRM_Utils_Array::value('option.limit', $params, $limit);
 623   $limit = CRM_Utils_Array::value('option_limit', $params, $limit);
 624
 625   if (is_array(CRM_Utils_Array::value('options', $params))) {
 626     $offset = CRM_Utils_Array::value('offset', $params['options'], $offset);
 627     $limit  = CRM_Utils_Array::value('limit', $params['options'], $limit);
 628     $sort   = CRM_Utils_Array::value('sort', $params['options'], $sort);
 629   }
 630
 631   $returnProperties = array();
 632   // handle the format return =sort_name,display_name...
 633   if (array_key_exists('return', $params)) {
 634     if (is_array($params['return'])) {
 635       $returnProperties = array_fill_keys($params['return'], 1);
 636     }
 637     else {
 638       $returnProperties = explode(',', str_replace(' ', '', $params['return']));
 639       $returnProperties = array_fill_keys($returnProperties, 1);
 640     }
 641   }
 642   if($entity && $action =='get' ){
 643     if(CRM_Utils_Array::value('id',$returnProperties)){
 644       $returnProperties[$entity . '_id'] = 1;
 645       unset($returnProperties['id']);
 646     }
 647     switch (trim(strtolower($sort))){
 648     case 'id':
 649     case 'id desc':
 650     case 'id asc':
 651       $sort = str_replace('id', $entity . '_id',$sort);
 652     }
 653   }
 654
 655
 656   $options = array(
 657     'offset' => $offset,
 658     'sort' => $sort,
 659     'limit' => $limit,
 660     'return' => !empty($returnProperties) ? $returnProperties : NULL,
 661   );
 662   if (!$queryObject) {
 663     return $options;
 664   }
 665   //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
 666   // if the queryobject is being used this should be used
 667   $inputParams = array();
 668   $legacyreturnProperties = array();
 669   $otherVars = array(
 670     'sort', 'offset', 'rowCount', 'options','return',
 671   );
 672   foreach ($params as $n => $v) {
 673     if (substr($n, 0, 7) == 'return.') {
 674       $legacyreturnProperties[substr($n, 7)] = $v;
 675     }
 676     elseif($n == 'id'){
 677       $inputParams[$entity. '_id'] = $v;
 678     }
 679     elseif (in_array($n, $otherVars)) {}
 680     else{
 681       $inputParams[$n] = $v;
 682     }
 683   }
 684   $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
 685   $options['input_params'] = $inputParams;
 686   return $options;
 687 }
 688
 689 /**
 690  * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
 691  * @param array $params params array as passed into civicrm_api
 692  * @param object $dao DAO object
 693  */
 694 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
 695
 696   $options = _civicrm_api3_get_options_from_params($params,false,$entity);
 697   $dao->limit((int)$options['offset'], (int)$options['limit']);
 698   if (!empty($options['sort'])) {
 699     $dao->orderBy($options['sort']);
 700   }
 701 }
 702
 703 /**
 704  * build fields array. This is the array of fields as it relates to the given DAO
 705  * returns unique fields as keys by default but if set but can return by DB fields
 706  */
 707 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
 708   $fields = $bao->fields();
 709   if ($unique) {
 710     if(!CRM_Utils_Array::value('id', $fields)){
 711      $entity = _civicrm_api_get_entity_name_from_dao($bao);
 712      $fields['id'] = $fields[$entity . '_id'];
 713      unset($fields[$entity . '_id']);
 714     }
 715     return $fields;
 716   }
 717
 718   foreach ($fields as $field) {
 719     $dbFields[$field['name']] = $field;
 720   }
 721   return $dbFields;
 722 }
 723
 724 /**
 725  * build fields array. This is the array of fields as it relates to the given DAO
 726  * returns unique fields as keys by default but if set but can return by DB fields
 727  */
 728 function _civicrm_api3_get_unique_name_array(&$bao) {
 729   $fields = $bao->fields();
 730   foreach ($fields as $field => $values) {
 731     $uniqueFields[$field] = CRM_Utils_Array::value('name',$values, $field);
 732   }
 733   return $uniqueFields;
 734 }
 735
 736 /**
 737  * Converts an DAO object to an array
 738  *
 739  * @param  object   $dao           (reference )object to convert
 740  * @params array of arrays (key = id) of array of fields
 741  * @static void
 742  * @access public
 743  */
 744 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
 745   $result = array();
 746   if (empty($dao) || !$dao->find()) {
 747     return array();
 748   }
 749
 750   //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
 751   if (!empty($entity) && CRM_Utils_Array::value('return', $params) && is_array($params['return'])) {
 752     foreach ($params['return'] as $return) {
 753       if (substr($return, 0, 6) == 'custom') {
 754         $custom = TRUE;
 755       }
 756     }
 757   }
 758
 759
 760   $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
 761
 762   while ($dao->fetch()) {
 763     $tmp = array();
 764     foreach ($fields as $key) {
 765       if (array_key_exists($key, $dao)) {
 766         // not sure on that one
 767         if ($dao->$key !== NULL) {
 768           $tmp[$key] = $dao->$key;
 769         }
 770       }
 771     }
 772     $result[$dao->id] = $tmp;
 773     if (!empty($custom)) {
 774       _civicrm_api3_custom_data_get($result[$dao->id], $entity, $dao->id);
 775     }
 776   }
 777
 778
 779   return $result;
 780 }
 781
 782 /**
 783  * Converts an object to an array
 784  *
 785  * @param  object   $dao           (reference) object to convert
 786  * @param  array    $values        (reference) array
 787  * @param  array    $uniqueFields
 788  *
 789  * @return array
 790  * @static void
 791  * @access public
 792  */
 793 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
 794
 795   $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
 796   foreach ($fields as $key => $value) {
 797     if (array_key_exists($key, $dao)) {
 798       $values[$key] = $dao->$key;
 799     }
 800   }
 801 }
 802
 803 /**
 804  * Wrapper for _civicrm_object_to_array when api supports unique fields
 805  */
 806 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
 807   return _civicrm_api3_object_to_array($dao, $values, TRUE);
 808 }
 809
 810 /**
 811  *
 812  * @param array $params
 813  * @param array $values
 814  * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
 815  * @param string $entityId ID of entity per $extends
 816  */
 817 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
 818   $values['custom'] = array();
 819   foreach ($params as $key => $value) {
 820     list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField::getKeyID($key, TRUE);
 821     if ($customFieldID) {
 822       CRM_Core_BAO_CustomField::formatCustomField($customFieldID, $values['custom'],
 823         $value, $extends, $customValueID, $entityId, FALSE, FALSE
 824       );
 825     }
 826   }
 827 }
 828
 829 /**
 830  * @deprecated
 831  * This function ensures that we have the right input parameters
 832  *
 833  * This function is only called when $dao is passed into verify_mandatory.
 834  * The practice of passing $dao into verify_mandatory turned out to be
 835  * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
 836  * api level. Hence the intention is to remove this function
 837  * & the associated param from viery_mandatory
 838  *
 839  * @param array  $params       Associative array of property name/value
 840  *                             pairs to insert in new history.
 841  * @daoName string DAO to check params agains
 842  *
 843  * @return bool should the missing fields be returned as an array (core error created as default)
 844  *
 845  * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
 846  * @access public
 847  */
 848 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
 849   //@deprecated - see notes
 850   if (isset($params['extends'])) {
 851     if (($params['extends'] == 'Activity' ||
 852         $params['extends'] == 'Phonecall' ||
 853         $params['extends'] == 'Meeting' ||
 854         $params['extends'] == 'Group' ||
 855         $params['extends'] == 'Contribution'
 856       ) &&
 857       ($params['style'] == 'Tab')
 858     ) {
 859       return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
 860     }
 861   }
 862
 863   $dao = new $daoName();
 864   $fields = $dao->fields();
 865
 866   $missing = array();
 867   foreach ($fields as $k => $v) {
 868     if ($v['name'] == 'id') {
 869       continue;
 870     }
 871
 872     if (CRM_Utils_Array::value('required', $v)) {
 873       // 0 is a valid input for numbers, CRM-8122
 874       if (!isset($params[$k]) || (empty($params[$k]) && !($params[$k] === 0))) {
 875         $missing[] = $k;
 876       }
 877     }
 878   }
 879
 880   if (!empty($missing)) {
 881     if (!empty($return)) {
 882       return $missing;
 883     }
 884     else {
 885       return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
 886     }
 887   }
 888
 889   return TRUE;
 890 }
 891
 892 /**
 893  * Check permissions for a given API call.
 894  *
 895  * @param $entity string API entity being accessed
 896  * @param $action string API action being performed
 897  * @param $params array  params of the API call
 898  * @param $throw bool    whether to throw exception instead of returning false
 899  *
 900  * @return bool whether the current API user has the permission to make the call
 901  */
 902 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
 903   // return early unless we’re told explicitly to do the permission check
 904   if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
 905     return TRUE;
 906   }
 907
 908   require_once 'CRM/Core/Permission.php';
 909
 910   require_once 'CRM/Core/DAO/permissions.php';
 911   $permissions = _civicrm_api3_permissions($entity, $action, $params);
 912
 913   // $params might’ve been reset by the alterAPIPermissions() hook
 914   if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
 915     return TRUE;
 916   }
 917
 918   foreach ($permissions as $perm) {
 919     if (!CRM_Core_Permission::check($perm)) {
 920       if ($throw) {
 921         throw new Exception("API permission check failed for $entity/$action call; missing permission: $perm.");
 922       }
 923       else {
 924         return FALSE;
 925       }
 926     }
 927   }
 928   return TRUE;
 929 }
 930
 931 /**
 932  * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
 933  *
 934  * @param string $bao_name name of BAO
 935  * @param array $params params from api
 936  * @param bool $returnAsSuccess return in api success format
 937  */
 938 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
 939   $bao = new $bao_name();
 940   _civicrm_api3_dao_set_filter($bao, $params, TRUE,$entity);
 941   if ($returnAsSuccess) {
 942     return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity);
 943   }
 944   else {
 945     return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
 946   }
 947 }
 948
 949 /**
 950  * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
 951  * @param string $bao_name Name of BAO Class
 952  * @param array $params parameters passed into the api call
 953  * @param string $entity Entity - pass in if entity is non-standard & required $ids array
 954  */
 955 function _civicrm_api3_basic_create($bao_name, &$params, $entity = null) {
 956
 957   $args = array(&$params);
 958   if(!empty($entity)){
 959     $ids = array($entity => CRM_Utils_Array::value('id', $params));
 960     $args[] = &$ids;
 961   }
 962   if (method_exists($bao_name, 'create')) {
 963     $fct = 'create';
 964   }
 965   elseif (method_exists($bao_name, 'add')) {
 966     $fct = 'add';
 967   }
 968   if (!isset($fct)) {
 969     return civicrm_api3_create_error('Entity not created, missing create or add method for ' . $bao_name);
 970   }
 971   $bao = call_user_func_array(array($bao_name, $fct), $args);
 972   if (is_null($bao)) {
 973     return civicrm_api3_create_error('Entity not created ' . $bao_name . '::' . $fct);
 974   }
 975   else {
 976     $values = array();
 977     _civicrm_api3_object_to_array($bao, $values[$bao->id]);
 978     return civicrm_api3_create_success($values, $params, null, 'create', $bao);
 979   }
 980 }
 981
 982 /**
 983  * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
 984  * if api::del doesn't exist it will try DAO delete method
 985  */
 986 function _civicrm_api3_basic_delete($bao_name, &$params) {
 987
 988   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 989   $args = array(&$params['id']);
 990   if (method_exists($bao_name, 'del')) {
 991     $bao = call_user_func_array(array($bao_name, 'del'), $args);
 992     return civicrm_api3_create_success(TRUE);
 993   }
 994   elseif (method_exists($bao_name, 'delete')) {
 995     $dao = new $bao_name();
 996     $dao->id = $params['id'];
 997     if ($dao->find()) {
 998       while ($dao->fetch()) {
 999         $dao->delete();
1000         return civicrm_api3_create_success();
1001       }
1002     }
1003     else {
1004       return civicrm_api3_create_error('Could not delete entity id ' . $params['id']);
1005     }
1006   }
1007
1008   return civicrm_api3_create_error('no delete method found');
1009 }
1010
1011 /**
1012  * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1013  * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1014  *
1015  * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1016  * @param string $entity  e.g membership, event
1017  * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1018  * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1019  * @param string $subName - Subtype of entity
1020  *
1021  */
1022 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1023   require_once 'CRM/Core/BAO/CustomGroup.php';
1024   require_once 'CRM/Core/BAO/CustomField.php';
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   $file = str_replace('_', '/', $fieldInfo['FKClassName']) . ".php";
1157   require_once ($file);
1158   $dao = new $fieldInfo['FKClassName'];
1159   $dao->id = $params[$fieldname];
1160   $dao->selectAdd();
1161   $dao->selectAdd('id');
1162   if (!$dao->find()) {
1163     throw new Exception("$fieldname is not valid : " . $params[$fieldname]);
1164   }
1165 }
1166
1167 /**
1168  * Validate foreign constraint fields being passed into API.
1169  *
1170  * @param array $params params from civicrm_api
1171  * @param string $fieldname uniquename of field being checked
1172  * @param array $fieldinfo array of fields from getfields function
1173  */
1174 function _civicrm_api3_validate_uniquekey(&$params, &$fieldname, &$fieldInfo) {
1175   $existing = civicrm_api($params['entity'], 'get', array(
1176       'version' => $params['version'],
1177       $fieldname => $params[$fieldname],
1178     ));
1179   // an entry already exists for this unique field
1180   if ($existing['count'] == 1) {
1181     // question - could this ever be a security issue?
1182     throw new Exception("Field: `$fieldname` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1183   }
1184 }
1185
1186 /**
1187  * Generic implementation of the "replace" action.
1188  *
1189  * Replace the old set of entities (matching some given keys) with a new set of
1190  * entities (matching the same keys).
1191  *
1192  * Note: This will verify that 'values' is present, but it does not directly verify
1193  * any other parameters.
1194  *
1195  * @param string $entity entity name
1196  * @param array $params params from civicrm_api, including:
1197  *   - 'values': an array of records to save
1198  *   - all other items: keys which identify new/pre-existing records
1199  */
1200 function _civicrm_api3_generic_replace($entity, $params) {
1201
1202   require_once 'CRM/Core/Transaction.php';
1203   $transaction = new CRM_Core_Transaction();
1204   try {
1205     if (!is_array($params['values'])) {
1206       throw new Exception("Mandatory key(s) missing from params array: values");
1207     }
1208
1209     // Extract the keys -- somewhat scary, don't think too hard about it
1210     $baseParams = $params;
1211     unset($baseParams['values']);
1212     unset($baseParams['sequential']);
1213
1214     // Lookup pre-existing records
1215     $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1216     if (civicrm_error($preexisting)) {
1217       $transaction->rollback();
1218       return $preexisting;
1219     }
1220
1221     // Save the new/updated records
1222     $creates = array();
1223     foreach ($params['values'] as $replacement) {
1224       // Sugar: Don't force clients to duplicate the 'key' data
1225       $replacement = array_merge($baseParams, $replacement);
1226       $action      = (isset($replacement['id']) || isset($replacement[$entity . '_id'])) ? 'update' : 'create';
1227       $create      = civicrm_api($entity, $action, $replacement);
1228       if (civicrm_error($create)) {
1229         $transaction->rollback();
1230         return $create;
1231       }
1232       foreach ($create['values'] as $entity_id => $entity_value) {
1233         $creates[$entity_id] = $entity_value;
1234       }
1235     }
1236
1237     // Remove stale records
1238     $staleIDs = array_diff(
1239       array_keys($preexisting['values']),
1240       array_keys($creates)
1241     );
1242     foreach ($staleIDs as $staleID) {
1243       $delete = civicrm_api($entity, 'delete', array(
1244           'version' => $params['version'],
1245           'id' => $staleID,
1246         ));
1247       if (civicrm_error($delete)) {
1248         $transaction->rollback();
1249         return $delete;
1250       }
1251     }
1252
1253     return civicrm_api3_create_success($creates, $params);
1254   }
1255   catch(PEAR_Exception $e) {
1256     $transaction->rollback();
1257     return civicrm_api3_create_error($e->getMessage());
1258   }
1259   catch(Exception $e) {
1260     $transaction->rollback();
1261     return civicrm_api3_create_error($e->getMessage());
1262   }
1263 }
1264
1265 /**
1266  * returns fields allowable by api
1267  * @param $entity string Entity to query
1268  * @param bool $unique index by unique fields?
1269  */
1270 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1271   )) {
1272   $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1273   $dao = _civicrm_api3_get_DAO($entity);
1274   if (empty($dao)) {
1275     return array();
1276   }
1277   $file = str_replace('_', '/', $dao) . ".php";
1278   require_once ($file);
1279   $d = new $dao();
1280   $fields = $d->fields();
1281   // replace uniqueNames by the normal names as the key
1282   if (empty($unique)) {
1283     foreach ($fields as $name => & $field) {
1284       //getting rid of unused attributes
1285       foreach ($unsetIfEmpty as $attr) {
1286         if (empty($field[$attr])) {
1287           unset($field[$attr]);
1288         }
1289       }
1290       if ($name == $field['name']) {
1291         continue;
1292       }
1293       if (array_key_exists($field['name'], $fields)) {
1294         $field['error'] = 'name conflict';
1295         // it should never happen, but better safe than sorry
1296         continue;
1297       }
1298       $fields[$field['name']] = $field;
1299       $fields[$field['name']]['uniqueName'] = $name;
1300       unset($fields[$name]);
1301     }
1302   }
1303   $fields += _civicrm_api_get_custom_fields($entity, $params);
1304   return $fields;
1305 }
1306
1307 /**
1308  * Return an array of fields for a given entity - this is the same as the BAO function but
1309  * fields are prefixed with 'custom_' to represent api params
1310  */
1311 function _civicrm_api_get_custom_fields($entity, &$params) {
1312   require_once 'CRM/Core/BAO/CustomField.php';
1313   $customfields = array();
1314   $entity = _civicrm_api_get_camel_name($entity);
1315   if (strtolower($entity) == 'contact') {
1316     $entity = CRM_Utils_Array::value('contact_type', $params);
1317   }
1318   $retrieveOnlyParent = FALSE;
1319   // we could / should probably test for other subtypes here - e.g. activity_type_id
1320   if($entity == 'Contact'){
1321     empty($params['contact_sub_type']);
1322   }
1323   $customfields = CRM_Core_BAO_CustomField::getFields($entity,
1324     FALSE,
1325     FALSE,
1326     CRM_Utils_Array::value('contact_sub_type', $params, FALSE),
1327     NULL,
1328     $retrieveOnlyParent,
1329     FALSE,
1330     FALSE
1331   );
1332   // find out if we have any requests to resolve options
1333   $getoptions = CRM_Utils_Array::value('get_options', CRM_Utils_Array::value('options',$params));
1334   if(!is_array($getoptions)){
1335       $getoptions = array($getoptions);
1336   }
1337
1338   foreach ($customfields as $key => $value) {
1339     $customfields['custom_' . $key] = $value;
1340    if(in_array('custom_' . $key, $getoptions)){
1341      $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption::valuesByID($key);
1342    }
1343     unset($customfields[$key]);
1344   }
1345   return $customfields;
1346 }
1347
1348 /**
1349  * Return array of defaults for the given API (function is a wrapper on getfields)
1350  */
1351 function _civicrm_api3_getdefaults($apiRequest) {
1352   $defaults = array();
1353
1354   $result = civicrm_api($apiRequest['entity'],
1355     'getfields',
1356     array(
1357       'version' => 3,
1358       'action' => $apiRequest['action'],
1359     )
1360   );
1361
1362   foreach ($result['values'] as $field => $values) {
1363     if (isset($values['api.default'])) {
1364       $defaults[$field] = $values['api.default'];
1365     }
1366   }
1367   return $defaults;
1368 }
1369
1370 /**
1371  * Return array of defaults for the given API (function is a wrapper on getfields)
1372  */
1373 function _civicrm_api3_getrequired($apiRequest) {
1374   $required = array('version');
1375
1376   $result = civicrm_api($apiRequest['entity'],
1377     'getfields',
1378     array(
1379       'version' => 3,
1380       'action' => $apiRequest['action'],
1381     )
1382   );
1383   foreach ($result['values'] as $field => $values) {
1384     if (CRM_Utils_Array::value('api.required', $values)) {
1385       $required[] = $field;
1386     }
1387   }
1388   return $required;
1389 }
1390
1391 /**
1392  * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1393  * If multiple aliases the last takes precedence
1394  *
1395  * Function also swaps unique fields for non-unique fields & vice versa.
1396  */
1397 function _civicrm_api3_swap_out_aliases(&$apiRequest) {
1398   if (strtolower($apiRequest['action'] == 'getfields')) {
1399     if (CRM_Utils_Array::value('api_action', $apiRequest['params'])) {
1400       $apiRequest['params']['action'] = $apiRequest['params']['api_action'];
1401       unset($apiRequest['params']['api_action']);
1402     }
1403     return;
1404   }
1405   $result = civicrm_api($apiRequest['entity'],
1406     'getfields',
1407     array(
1408       'version' => 3,
1409       'action' => $apiRequest['action'],
1410     )
1411   );
1412
1413   foreach ($result['values'] as $field => $values) {
1414     $uniqueName = CRM_Utils_Array::value('uniqueName', $values);
1415     if (CRM_Utils_Array::value('api.aliases', $values)) {
1416       // if aliased field is not set we try to use field alias
1417       if (!isset($apiRequest['params'][$field])) {
1418         foreach ($values['api.aliases'] as $alias) {
1419           if (isset($apiRequest['params'][$alias])) {
1420             $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1421           }
1422           //unset original field  nb - need to be careful with this as it may bring inconsistencies
1423           // out of the woodwork but will be implementing only as _spec function extended
1424           unset($apiRequest['params'][$alias]);
1425         }
1426       }
1427     }
1428     if (!isset($apiRequest['params'][$field])
1429       && CRM_Utils_Array::value('name', $values)
1430       && $field != $values['name']
1431       && isset($apiRequest['params'][$values['name']])
1432     ) {
1433       $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1434       // note that it would make sense to unset the original field here but tests need to be in place first
1435     }
1436     if (!isset($apiRequest['params'][$field])
1437       && $uniqueName
1438       && $field != $uniqueName
1439       && array_key_exists($uniqueName, $apiRequest['params'])
1440       )
1441     {
1442       $apiRequest['params'][$field] = CRM_Utils_Array::value($values['uniqueName'], $apiRequest['params']);
1443       // note that it would make sense to unset the original field here but tests need to be in place first
1444     }
1445   }
1446
1447 }
1448
1449 /**
1450  * Validate integer fields being passed into API.
1451  * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1452  *
1453  * @param array $params params from civicrm_api
1454  * @param string $fieldname uniquename of field being checked
1455  * @param array $fieldinfo array of fields from getfields function
1456  */
1457 function _civicrm_api3_validate_integer(&$params, &$fieldname, &$fieldInfo, $entity) {
1458   //if fieldname exists in params
1459   if (CRM_Utils_Array::value($fieldname, $params)) {
1460     //if value = 'user_contact_id' replace value with logged in user id
1461     if ($params[$fieldname] == "user_contact_id") {
1462       $session = &CRM_Core_Session::singleton();
1463       $params[$fieldname] = $session->get('userID');
1464     }
1465     if (CRM_Utils_Array::value('pseudoconstant', $fieldInfo) ) {
1466       $constant = CRM_Utils_Array::value('options', $fieldInfo);
1467       if (is_numeric($params[$fieldname]) && !CRM_Utils_Array::value('FKClassName',$fieldInfo) && !array_key_exists($params[$fieldname], $fieldInfo['options'])) {
1468         throw new API_Exception("$fieldname is not valid", 2001, array('error_field' => $fieldname,"type"=>"integer"));
1469       }
1470     }
1471     // we are looking for strings that should be swapped out e.g swap 'Donation' to financial_type_id 1
1472     if (!is_numeric($params[$fieldname]) && !is_array($params[$fieldname])) {
1473       if(CRM_Utils_Array::value('FKClassName', $fieldInfo)){
1474         // we'll get the options for this now since we are doing a swap out
1475         $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldname));
1476         if(empty($options['is_error'])){
1477           $fieldInfo['options'] = $options['values'];
1478         }
1479       }
1480       if(!empty($fieldInfo['options'])){
1481         $numericvalue = array_search($params[$fieldname], $fieldInfo['options']);
1482         if (empty($numericvalue)) {
1483           throw new Exception("$fieldname " . $params[$fieldname] . " is not valid");
1484         }
1485         else {
1486           $params[$fieldname] = $numericvalue;
1487         }
1488       }
1489     }
1490
1491     // once we have done any swaps check our field length
1492     if(is_string($params[$fieldname]) &&
1493       CRM_Utils_Array::value('maxlength',$fieldInfo)
1494       && strlen($params[$fieldname]) > $fieldInfo['maxlength']
1495       ){
1496       throw new API_Exception( $params[$fieldname] . " is " . strlen($params[$fieldname]) . " characters  - longer than $fieldname length" . $fieldInfo['maxlength'] . ' characters',
1497         2100, array('field' => $fieldname, "max_length"=>$fieldInfo['maxlength'])
1498       );
1499     }
1500   }
1501 }
1502
1503 function _civicrm_api3_validate_html(&$params, &$fieldname, &$fieldInfo) {
1504   if ($value = CRM_Utils_Array::value($fieldname, $params)) {
1505     if (!CRM_Utils_Rule::xssString($value)) {
1506       throw new API_Exception('Illegal characters in input (potential scripting attack)',array("field"=>$fieldname,"error_code"=>"xss"));
1507     }
1508   }
1509 }
1510
1511 /**
1512  * Validate string fields being passed into API.
1513  * @param array $params params from civicrm_api
1514  * @param string $fieldname uniquename of field being checked
1515  * @param array $fieldinfo array of fields from getfields function
1516  */
1517 function _civicrm_api3_validate_string(&$params, &$fieldname, &$fieldInfo) {
1518   // If fieldname exists in params
1519   $value = (string) CRM_Utils_Array::value($fieldname, $params,'');
1520   if ($value ) {
1521     if (!CRM_Utils_Rule::xssString($value)) {
1522       throw new Exception('Illegal characters in input (potential scripting attack)');
1523     }
1524     if ($fieldname == 'currency') {
1525       if (!CRM_Utils_Rule::currencyCode($value)) {
1526         throw new Exception("Currency not a valid code: $value");
1527       }
1528     }
1529     if (!empty ($fieldInfo['options'])) {
1530       // Validate & swap out any pseudoconstants / options
1531       $options = $fieldInfo['options'];
1532       $lowerCaseOptions = array_map("strtolower", $options);
1533       // If value passed is not a key, it may be a label
1534       // Try to lookup key from label - if it can't be found throw error
1535       if (!isset($options[strtolower($value)]) && !isset($options[$value]) ) {
1536         if (!in_array(strtolower($value), $lowerCaseOptions)) {
1537           throw new Exception("$fieldname `$value` is not valid.");
1538         }
1539       }
1540     }
1541     // Check our field length
1542     elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1543       throw new API_Exception("Value for $fieldname is " . strlen($value) . " characters  - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1544         2100, array('field' => $fieldname)
1545       );
1546     }
1547   }
1548 }