api/v3/utils.php

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