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