api/v3/utils.php

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