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