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