api/v3/utils.php

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