3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for CiviCRM APIv3 utilitity functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_utils
34 * @copyright CiviCRM LLC (c) 2004-2013
35 * @version $Id: utils.php 30879 2010-11-22 15:45:55Z shot $
40 * Initialize CiviCRM - should be run at the start of each API function
42 function _civicrm_api3_initialize() {
43 require_once 'CRM/Core/ClassLoader.php';
44 CRM_Core_ClassLoader
::singleton()->register();
45 CRM_Core_Config
::singleton();
49 * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking
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
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
59 function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array(
61 $keys = array(array());
62 foreach ($keyoptions as $key) {
65 civicrm_api3_verify_mandatory($params, $daoName, $keys);
69 * Function to check mandatory fields are included
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
76 * @throws API_Exception
77 * @return null or throws error if there the required fields not present
79 * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param
81 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(
82 ), $verifyDAO = TRUE) {
85 if ($daoName != NULL && $verifyDAO && empty($params['id'])) {
86 $unmatched = _civicrm_api3_check_required_fields($params, $daoName, TRUE);
87 if (!is_array($unmatched)) {
92 if (!empty($params['id'])) {
93 $keys = array('version');
96 if (!in_array('version', $keys)) {
97 // required from v3 onwards
101 foreach ($keys as $key) {
102 if (is_array($key)) {
104 $optionset = array();
105 foreach ($key as $subkey) {
106 if (!array_key_exists($subkey, $params) ||
empty($params[$subkey])) {
107 $optionset[] = $subkey;
110 // as long as there is one match then we don't need to rtn anything
114 if (empty($match) && !empty($optionset)) {
115 $unmatched[] = "one of (" . implode(", ", $optionset) . ")";
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')) {
126 if (!empty($unmatched)) {
127 throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched));
133 * @param <type> $data
135 * @param object $dao DAO / BAO object to be freed here
137 * @throws API_Exception
138 * @return array <type>
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)) {
146 if (is_array($dao)) {
147 if ($msg == 'DB Error: constraint violation' ||
substr($msg, 0,9) == 'DB Error:' ||
$msg == 'DB Error: already exists') {
149 $fields = _civicrm_api3_api_getfields($dao);
150 _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], $fields, TRUE);
152 catch(Exception
$e) {
153 $msg = $e->getMessage();
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'];
164 if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && !empty($dao['params']['api.has_parent'])) {
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);
172 * Format array in result output styple
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
182 * @return array $result
184 function civicrm_api3_create_success($values = 1, $params = array(
185 ), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = 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"];
194 if(!empty($item['financial_type_id'])){
195 //4.3 legacy handling
196 $values[$key]['contribution_type_id'] = $item['financial_type_id'];
198 if(!empty($item['next_sched_contribution_date'])){
199 // 4.4 legacy handling
200 $values[$key]['next_sched_contribution'] = $item['next_sched_contribution_date'];
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);
209 elseif ($action != 'getfields') {
210 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) +
$params);
216 $allFields = array();
217 if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array
::value('values', $apiFields))) {
218 $allFields = array_keys($apiFields['values']);
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'));
223 $result['undefined_fields'] = array_merge($undefined);
226 if (is_object($dao)) {
230 $result['version'] = 3;
231 if (is_array($values)) {
232 $result['count'] = (int) count($values);
234 // Convert value-separated strings to array
235 _civicrm_api3_separate_values($values);
237 if ($result['count'] == 1) {
238 list($result['id']) = array_keys($values);
240 elseif (!empty($values['id']) && is_int($values['id'])) {
241 $result['id'] = $values['id'];
245 $result['count'] = !empty($values) ?
1 : 0;
248 if (is_array($values) && isset($params['sequential']) &&
249 $params['sequential'] == 1
251 $result['values'] = array_values($values);
254 $result['values'] = $values;
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'];
263 return array_merge($result, $extraReturnValues);
267 * Load the DAO of the entity
269 function _civicrm_api3_load_DAO($entity) {
270 $dao = _civicrm_api3_get_DAO($entity);
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
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);
292 $name = _civicrm_api_get_camel_name($name, 3);
294 if ($name == 'Individual' ||
$name == 'Household' ||
$name == 'Organization') {
298 // hack to deal with incorrectly named BAO/DAO - see CRM-10859
300 // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingRecipients
301 // but am not confident mailing_recipients is tested so have not tackled.
302 if ($name == 'MailingRecipients') {
303 return 'CRM_Mailing_DAO_Recipients';
305 // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingComponent
306 if ($name == 'MailingComponent') {
307 return 'CRM_Mailing_DAO_Component';
309 // FIXME: DAO should be renamed CRM_ACL_DAO_AclRole
310 if ($name == 'AclRole') {
311 return 'CRM_ACL_DAO_EntityRole';
313 // FIXME: DAO should be renamed CRM_SMS_DAO_SmsProvider
314 // But this would impact SMS extensions so need to coordinate
315 // Probably best approach is to migrate them to use the api and decouple them from core BAOs
316 if ($name == 'SmsProvider') {
317 return 'CRM_SMS_DAO_Provider';
319 // FIXME: DAO names should follow CamelCase convention
320 if ($name == 'Im' ||
$name == 'Acl') {
321 $name = strtoupper($name);
323 return CRM_Core_DAO_AllCoreTables
::getFullName($name);
327 * Function to return the DAO of the function or Entity
328 * @param String $name is either a function of the api (civicrm_{entity}_create or the entity name
329 * return the DAO name to manipulate this function
330 * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
333 function _civicrm_api3_get_BAO($name) {
334 // FIXME: DAO should be renamed CRM_Badge_DAO_BadgeLayout
335 if ($name == 'PrintLabel') {
336 return 'CRM_Badge_BAO_Layout';
338 $dao = _civicrm_api3_get_DAO($name);
342 $bao = str_replace("DAO", "BAO", $dao);
343 $file = strtr($bao, '_', '/') . '.php';
344 // Check if this entity actually has a BAO. Fall back on the DAO if not.
345 return stream_resolve_include_path($file) ?
$bao : $dao;
349 * Recursive function to explode value-separated strings into arrays
352 function _civicrm_api3_separate_values(&$values) {
353 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
354 foreach ($values as $key => & $value) {
355 if (is_array($value)) {
356 _civicrm_api3_separate_values($value);
358 elseif (is_string($value)) {
359 if($key == 'case_type_id'){// this is to honor the way case API was originally written
360 $value = trim(str_replace($sp, ',', $value), ',');
362 elseif (strpos($value, $sp) !== FALSE) {
363 $value = explode($sp, trim($value, $sp));
370 * This is a legacy wrapper for api_store_values which will check the suitable fields using getfields
371 * rather than DAO->fields
373 * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
375 * Note this is used by BAO type create functions - eg. contribution
376 * @param string $entity
377 * @param array $params
378 * @param array $values
380 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
381 $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
382 $fields = $fields['values'];
383 _civicrm_api3_store_values($fields, $params, $values);
387 * @param array $fields
388 * @param array $params
389 * @param array $values
391 * @return Bool $valueFound
393 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
396 $keys = array_intersect_key($params, $fields);
397 foreach ($keys as $name => $value) {
398 if ($name !== 'id') {
399 $values[$name] = $value;
407 * The API supports 2 types of get requestion. The more complex uses the BAO query object.
408 * This is a generic function for those functions that call it
410 * At the moment only called by contact we should extend to contribution &
411 * others that use the query object. Note that this function passes permission information in.
415 * @param array $params as passed into api get or getcount function
416 * @param array $additional_options
417 * @param bool $getCount are we just after the count
420 * @internal param array $options array of options (so we can modify the filter)
422 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){
424 // Convert id to e.g. contact_id
425 if (empty($params[$entity . '_id']) && isset($params['id'])) {
426 $params[$entity . '_id'] = $params['id'];
428 unset($params['id']);
430 $options = _civicrm_api3_get_options_from_params($params, TRUE);
432 $inputParams = array_merge(
433 CRM_Utils_Array
::value('input_params', $options, array()),
434 CRM_Utils_Array
::value('input_params', $additional_options, array())
436 $returnProperties = array_merge(
437 CRM_Utils_Array
::value('return', $options, array()),
438 CRM_Utils_Array
::value('return', $additional_options, array())
440 if(empty($returnProperties)){
441 $returnProperties = NULL;
443 if(!empty($params['check_permissions'])){
444 // we will filter query object against getfields
445 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
446 // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
447 $fields['values'][$entity . '_id'] = array();
448 $varsToFilter = array('returnProperties', 'inputParams');
449 foreach ($varsToFilter as $varToFilter){
450 if(!is_array($
$varToFilter)){
453 //I was going to throw an exception rather than silently filter out - but
454 //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
455 //so we are silently ignoring parts of their request
456 //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
457 $
$varToFilter = array_intersect_key($
$varToFilter, $fields['values']);
460 $options = array_merge($options,$additional_options);
461 $sort = CRM_Utils_Array
::value('sort', $options, NULL);
462 $offset = CRM_Utils_Array
::value('offset', $options, NULL);
463 $limit = CRM_Utils_Array
::value('limit', $options, NULL);
464 $smartGroupCache = CRM_Utils_Array
::value('smartGroupCache', $params);
468 $returnProperties = NULL;
471 $newParams = CRM_Contact_BAO_Query
::convertFormValues($inputParams);
472 foreach ($newParams as &$newParam) {
473 if($newParam[1] == '=' && is_array($newParam[2])) {
474 // we may be looking at an attempt to use the 'IN' style syntax
475 // @todo at time of writing only 'IN' & 'NOT IN' are supported for the array style syntax
476 $sqlFilter = CRM_Core_DAO
::createSqlFilter($newParam[0], $params[$newParam[0]], 'String', NULL, TRUE);
478 $newParam[1] = key($newParam[2]);
479 $newParam[2] = $sqlFilter;
484 $skipPermissions = !empty($params['check_permissions']) ?
0 :1;
486 list($entities, $options) = CRM_Contact_BAO_Query
::apiQuery(
497 if ($getCount) { // only return the count of contacts
505 * Function transfers the filters being passed into the DAO onto the params object
507 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
508 $entity = substr($dao->__table
, 8);
510 $allfields = _civicrm_api3_build_fields_array($dao, $unique);
512 $fields = array_intersect(array_keys($allfields), array_keys($params));
513 if (isset($params[$entity . "_id"])) {
514 //if entity_id is set then treat it as ID (will be overridden by id if set)
515 $dao->id
= $params[$entity . "_id"];
518 $options = _civicrm_api3_get_options_from_params($params);
519 //apply options like sort
520 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
522 //accept filters like filter.activity_date_time_high
523 // std is now 'filters' => ..
524 if (strstr(implode(',', array_keys($params)), 'filter')) {
525 if (isset($params['filters']) && is_array($params['filters'])) {
526 foreach ($params['filters'] as $paramkey => $paramvalue) {
527 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
531 foreach ($params as $paramkey => $paramvalue) {
532 if (strstr($paramkey, 'filter')) {
533 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
538 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
539 // support for other syntaxes is discussed in ticket but being put off for now
540 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
545 foreach ($fields as $field) {
546 if (is_array($params[$field])) {
547 //get the actual fieldname from db
548 $fieldName = $allfields[$field]['name'];
549 $where = CRM_Core_DAO
::createSqlFilter($fieldName, $params[$field], 'String');
551 $dao->whereAdd($where);
556 $daoFieldName = $allfields[$field]['name'];
557 if (empty($daoFieldName)) {
558 throw new API_Exception("Failed to determine field name for \"$field\"");
560 $dao->{$daoFieldName} = $params[$field];
563 $dao->$field = $params[$field];
567 if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) {
569 $options['return']['id'] = TRUE;// ensure 'id' is included
570 $allfields = _civicrm_api3_get_unique_name_array($dao);
571 $returnMatched = array_intersect(array_keys($options['return']), $allfields);
572 foreach ($returnMatched as $returnValue) {
573 $dao->selectAdd($returnValue);
576 $unmatchedFields = array_diff(// not already matched on the field names
577 array_keys($options['return']),
581 $returnUniqueMatched = array_intersect(
583 array_flip($allfields)// but a match for the field keys
585 foreach ($returnUniqueMatched as $uniqueVal){
586 $dao->selectAdd($allfields[$uniqueVal]);
589 $dao->setApiFilter($params);
593 * Apply filters (e.g. high, low) to DAO object (prior to find)
594 * @param string $filterField field name of filter
595 * @param string $filterValue field value of filter
596 * @param object $dao DAO object
598 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
599 if (strstr($filterField, 'high')) {
600 $fieldName = substr($filterField, 0, -5);
601 $dao->whereAdd("($fieldName <= $filterValue )");
603 if (strstr($filterField, 'low')) {
604 $fieldName = substr($filterField, 0, -4);
605 $dao->whereAdd("($fieldName >= $filterValue )");
607 if($filterField == 'is_current' && $filterValue == 1){
608 $todayStart = date('Ymd000000', strtotime('now'));
609 $todayEnd = date('Ymd235959', strtotime('now'));
610 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
611 if(property_exists($dao, 'is_active')){
612 $dao->whereAdd('is_active = 1');
618 * Get sort, limit etc options from the params - supporting old & new formats.
619 * get returnproperties for legacy
621 * @param array $params params array as passed into civicrm_api
622 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
623 * for legacy report & return a unique fields array
625 * @param string $entity
626 * @param string $action
628 * @return array $options options extracted from params
630 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
632 $sort = CRM_Utils_Array
::value('sort', $params, 0);
633 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
634 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
636 $offset = CRM_Utils_Array
::value('offset', $params, 0);
637 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
638 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
639 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
641 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
642 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
643 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
645 if (is_array(CRM_Utils_Array
::value('options', $params))) {
646 // is count is set by generic getcount not user
647 $is_count = CRM_Utils_Array
::value('is_count', $params['options']);
648 $offset = CRM_Utils_Array
::value('offset', $params['options'], $offset);
649 $limit = CRM_Utils_Array
::value('limit', $params['options'], $limit);
650 $sort = CRM_Utils_Array
::value('sort', $params['options'], $sort);
653 $returnProperties = array();
654 // handle the format return =sort_name,display_name...
655 if (array_key_exists('return', $params)) {
656 if (is_array($params['return'])) {
657 $returnProperties = array_fill_keys($params['return'], 1);
660 $returnProperties = explode(',', str_replace(' ', '', $params['return']));
661 $returnProperties = array_fill_keys($returnProperties, 1);
664 if ($entity && $action =='get') {
665 if (!empty($returnProperties['id'])) {
666 $returnProperties[$entity . '_id'] = 1;
667 unset($returnProperties['id']);
669 switch (trim(strtolower($sort))){
673 $sort = str_replace('id', $entity . '_id',$sort);
678 'offset' => CRM_Utils_Rule
::integer($offset) ?
$offset : NULL,
679 'sort' => CRM_Utils_Rule
::string($sort) ?
$sort : NULL,
680 'limit' => CRM_Utils_Rule
::integer($limit) ?
$limit : NULL,
681 'is_count' => $is_count,
682 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
685 if ($options['sort'] && stristr($options['sort'], 'SELECT')) {
686 throw new API_Exception('invalid string in sort options');
692 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
693 // if the queryobject is being used this should be used
694 $inputParams = array();
695 $legacyreturnProperties = array();
697 'sort', 'offset', 'rowCount', 'options','return',
699 foreach ($params as $n => $v) {
700 if (substr($n, 0, 7) == 'return.') {
701 $legacyreturnProperties[substr($n, 7)] = $v;
703 elseif ($n == 'id') {
704 $inputParams[$entity. '_id'] = $v;
706 elseif (in_array($n, $otherVars)) {}
708 $inputParams[$n] = $v;
709 if ($v && !is_array($v) && stristr($v, 'SELECT')) {
710 throw new API_Exception('invalid string');
714 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
715 $options['input_params'] = $inputParams;
720 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
722 * @param array $params params array as passed into civicrm_api
723 * @param object $dao DAO object
726 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
728 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
729 if(!$options['is_count']) {
730 $dao->limit((int)$options['offset'], (int)$options['limit']);
731 if (!empty($options['sort'])) {
732 $dao->orderBy($options['sort']);
738 * build fields array. This is the array of fields as it relates to the given DAO
739 * returns unique fields as keys by default but if set but can return by DB fields
741 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
742 $fields = $bao->fields();
744 if (empty($fields['id'])){
745 $entity = _civicrm_api_get_entity_name_from_dao($bao);
746 $fields['id'] = $fields[$entity . '_id'];
747 unset($fields[$entity . '_id']);
752 foreach ($fields as $field) {
753 $dbFields[$field['name']] = $field;
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
762 function _civicrm_api3_get_unique_name_array(&$bao) {
763 $fields = $bao->fields();
764 foreach ($fields as $field => $values) {
765 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
767 return $uniqueFields;
771 * Converts an DAO object to an array
773 * @param object $dao (reference )object to convert
774 * @param null $params
775 * @param bool $uniqueFields
776 * @param string $entity
780 * @params array of arrays (key = id) of array of fields
785 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
787 if(isset($params['options']) && !empty($params['options']['is_count'])) {
788 return $dao->count();
790 if (empty($dao) ||
!$dao->find()) {
794 if(isset($dao->count
)) {
797 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
798 if (!empty($entity) && !empty($params['return']) && is_array($params['return'])) {
799 foreach ($params['return'] as $return) {
800 if (substr($return, 0, 6) == 'custom') {
807 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
809 while ($dao->fetch()) {
811 foreach ($fields as $key) {
812 if (array_key_exists($key, $dao)) {
813 // not sure on that one
814 if ($dao->$key !== NULL) {
815 $tmp[$key] = $dao->$key;
819 $result[$dao->id
] = $tmp;
820 if (!empty($custom)) {
821 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
830 * Converts an object to an array
832 * @param object $dao (reference) object to convert
833 * @param array $values (reference) array
834 * @param array|bool $uniqueFields
840 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
842 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
843 foreach ($fields as $key => $value) {
844 if (array_key_exists($key, $dao)) {
845 $values[$key] = $dao->$key;
851 * Wrapper for _civicrm_object_to_array when api supports unique fields
853 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
854 return _civicrm_api3_object_to_array($dao, $values, TRUE);
859 * @param array $params
860 * @param array $values
861 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
862 * @param string $entityId ID of entity per $extends
864 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
865 $values['custom'] = array();
866 foreach ($params as $key => $value) {
867 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
868 if ($customFieldID && (!IS_NULL($value))) {
869 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
870 $value, $extends, $customValueID, $entityId, FALSE, FALSE
878 * This function ensures that we have the right input parameters
880 * This function is only called when $dao is passed into verify_mandatory.
881 * The practice of passing $dao into verify_mandatory turned out to be
882 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
883 * api level. Hence the intention is to remove this function
884 * & the associated param from viery_mandatory
886 * @param array $params Associative array of property name/value
887 * pairs to insert in new history.
889 * @param bool $return
891 * @daoName string DAO to check params agains
893 * @return bool should the missing fields be returned as an array (core error created as default)
895 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
898 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
899 //@deprecated - see notes
900 if (isset($params['extends'])) {
901 if (($params['extends'] == 'Activity' ||
902 $params['extends'] == 'Phonecall' ||
903 $params['extends'] == 'Meeting' ||
904 $params['extends'] == 'Group' ||
905 $params['extends'] == 'Contribution'
907 ($params['style'] == 'Tab')
909 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
913 $dao = new $daoName();
914 $fields = $dao->fields();
917 foreach ($fields as $k => $v) {
918 if ($v['name'] == 'id') {
922 if (!empty($v['required'])) {
923 // 0 is a valid input for numbers, CRM-8122
924 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
930 if (!empty($missing)) {
931 if (!empty($return)) {
935 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
943 * Check permissions for a given API call.
945 * @param $entity string API entity being accessed
946 * @param $action string API action being performed
947 * @param $params array params of the API call
948 * @param $throw deprecated bool whether to throw exception instead of returning false
951 * @return bool whether the current API user has the permission to make the call
953 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
954 // return early unless we’re told explicitly to do the permission check
955 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
959 require_once 'CRM/Core/DAO/permissions.php';
960 $permissions = _civicrm_api3_permissions($entity, $action, $params);
962 // $params might’ve been reset by the alterAPIPermissions() hook
963 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
967 if (!CRM_Core_Permission
::check($permissions)) {
969 if(is_array($permissions)) {
970 $permissions = implode(' and ', $permissions);
972 throw new Exception("API permission check failed for $entity/$action call; insufficient permission: require $permissions");
975 //@todo remove this - this is an internal api function called with $throw set to TRUE. It is only called with false
976 // in tests & that should be tidied up
985 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
987 * @param string $bao_name name of BAO
988 * @param array $params params from api
989 * @param bool $returnAsSuccess return in api success format
990 * @param string $entity
994 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
995 $bao = new $bao_name();
996 _civicrm_api3_dao_set_filter($bao, $params, TRUE, $entity);
997 if ($returnAsSuccess) {
998 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity, 'get');
1001 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
1006 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
1007 * @param string $bao_name Name of BAO Class
1008 * @param array $params parameters passed into the api call
1009 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
1012 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
1014 $args = array(&$params);
1015 if (!empty($entity)) {
1016 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
1020 if (method_exists($bao_name, 'create')) {
1022 $fct_name = $bao_name . '::' . $fct;
1023 $bao = call_user_func_array(array($bao_name, $fct), $args);
1025 elseif (method_exists($bao_name, 'add')) {
1027 $fct_name = $bao_name . '::' . $fct;
1028 $bao = call_user_func_array(array($bao_name, $fct), $args);
1031 $fct_name = '_civicrm_api3_basic_create_fallback';
1032 $bao = _civicrm_api3_basic_create_fallback($bao_name, $params);
1035 if (is_null($bao)) {
1036 return civicrm_api3_create_error('Entity not created (' . $fct_name . ')');
1038 elseif (is_a($bao, 'CRM_Core_Error')) {
1039 //some wierd circular thing means the error takes itself as an argument
1040 $msg = $bao->getMessages($bao);
1041 // the api deals with entities on a one-by-one basis. However, the contribution bao pushes entities
1042 // onto the error object - presumably because the contribution import is not handling multiple errors correctly
1043 // so we need to reset the error object here to avoid getting concatenated errors
1044 //@todo - the mulitple error handling should be moved out of the contribution object to the import / multiple entity processes
1045 CRM_Core_Error
::singleton()->reset();
1046 throw new API_Exception($msg);
1050 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
1051 return civicrm_api3_create_success($values, $params, $entity, 'create', $bao);
1056 * For BAO's which don't have a create() or add() functions, use this fallback implementation.
1058 * @fixme There's an intuitive sense that this behavior should be defined somehow in the BAO/DAO class
1059 * structure. In practice, that requires a fair amount of refactoring and/or kludgery.
1061 * @param string $bao_name
1062 * @param array $params
1064 * @throws API_Exception
1065 * @return CRM_Core_DAO|NULL an instance of the BAO
1067 function _civicrm_api3_basic_create_fallback($bao_name, &$params) {
1068 $dao_name = get_parent_class($bao_name);
1069 if ($dao_name === 'CRM_Core_DAO' ||
!$dao_name) {
1070 $dao_name = $bao_name;
1072 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName($dao_name);
1073 if (empty($entityName)) {
1074 throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array(
1075 'class_name' => $bao_name,
1078 $hook = empty($params['id']) ?
'create' : 'edit';
1080 CRM_Utils_Hook
::pre($hook, $entityName, CRM_Utils_Array
::value('id', $params), $params);
1081 $instance = new $dao_name();
1082 $instance->copyValues($params);
1084 CRM_Utils_Hook
::post($hook, $entityName, $instance->id
, $instance);
1090 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
1091 * if api::del doesn't exist it will try DAO delete method
1093 function _civicrm_api3_basic_delete($bao_name, &$params) {
1095 civicrm_api3_verify_mandatory($params, NULL, array('id'));
1096 $args = array(&$params['id']);
1097 if (method_exists($bao_name, 'del')) {
1098 $bao = call_user_func_array(array($bao_name, 'del'), $args);
1099 if ($bao !== FALSE) {
1100 return civicrm_api3_create_success(TRUE);
1102 throw new API_Exception('Could not delete entity id ' . $params['id']);
1104 elseif (method_exists($bao_name, 'delete')) {
1105 $dao = new $bao_name();
1106 $dao->id
= $params['id'];
1108 while ($dao->fetch()) {
1110 return civicrm_api3_create_success();
1114 throw new API_Exception('Could not delete entity id ' . $params['id']);
1118 throw new API_Exception('no delete method found');
1122 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1123 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1125 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1126 * @param string $entity e.g membership, event
1128 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1129 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1130 * @param string $subName - Subtype of entity
1132 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1133 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1134 CRM_Core_DAO
::$_nullObject,
1140 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1141 $customValues = array();
1142 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1143 if (!empty($customValues)) {
1144 foreach ($customValues as $key => $val) {
1145 if (strstr($key, '_id')) {
1146 $idkey = substr($key, 0, -3);
1147 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1148 $returnArray[$key] = $val;
1151 // per standard - return custom_fieldID
1152 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1154 //not standard - but some api did this so guess we should keep - cheap as chips
1155 $returnArray[$key] = $val;
1162 * Validate fields being passed into API. This function relies on the getFields function working accurately
1163 * for the given API. If error mode is set to TRUE then it will also check
1166 * As of writing only date was implemented.
1167 * @param string $entity
1168 * @param string $action
1169 * @param array $params -
1170 * @param array $fields response from getfields all variables are the same as per civicrm_api
1171 * @param bool $errorMode errorMode do intensive post fail checks?
1174 function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $errorMode = False) {
1175 $fields = array_intersect_key($fields, $params);
1176 foreach ($fields as $fieldName => $fieldInfo) {
1177 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1178 case CRM_Utils_Type
::T_INT
:
1179 //field is of type integer
1180 _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1185 //field is of type date or datetime
1186 _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1190 _civicrm_api3_validate_html($params, $fieldName, $fieldInfo);
1193 case CRM_Utils_Type
::T_STRING
:
1194 _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1197 case CRM_Utils_Type
::T_MONEY
:
1198 if (!CRM_Utils_Rule
::money($params[$fieldName]) && !empty($params[$fieldName])) {
1199 throw new Exception($fieldName . " is not a valid amount: " . $params[$fieldName]);
1203 // intensive checks - usually only called after DB level fail
1204 if (!empty($errorMode) && strtolower($action) == 'create') {
1205 if (!empty($fieldInfo['FKClassName'])) {
1206 if (!empty($params[$fieldName])) {
1207 _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo);
1209 elseif (!empty($fieldInfo['required'])) {
1210 throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report");
1213 if (!empty($fieldInfo['api.unique'])) {
1214 $params['entity'] = $entity;
1215 _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo);
1222 * Validate date fields being passed into API.
1223 * It currently converts both unique fields and DB field names to a mysql date.
1224 * @todo - probably the unique field handling & the if exists handling is now done before this
1225 * function is reached in the wrapper - can reduce this code down to assume we
1226 * are only checking the passed in field
1228 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1229 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1231 * @param array $params params from civicrm_api
1232 * @param string $fieldName uniquename of field being checked
1235 * @internal param array $fieldinfo array of fields from getfields function
1237 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1238 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1239 if (!empty($params[$fieldInfo['name']])) {
1240 //accept 'whatever strtotime accepts
1241 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1242 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1244 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']]);
1246 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldName) && !empty($params[$fieldName])) {
1247 //If the unique field name differs from the db name & is set handle it here
1248 if (strtotime($params[$fieldName]) === FALSE) {
1249 throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]);
1251 $params[$fieldName] = CRM_Utils_Date
::processDate($params[$fieldName]);
1256 * Validate foreign constraint fields being passed into API.
1258 * @param array $params params from civicrm_api
1259 * @param string $fieldName uniquename of field being checked
1262 * @internal param array $fieldinfo array of fields from getfields function
1264 function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) {
1265 $dao = new $fieldInfo['FKClassName'];
1266 $dao->id
= $params[$fieldName];
1268 $dao->selectAdd('id');
1269 if (!$dao->find()) {
1270 throw new Exception("$fieldName is not valid : " . $params[$fieldName]);
1275 * Validate foreign constraint fields being passed into API.
1277 * @param array $params params from civicrm_api
1278 * @param string $fieldName uniquename of field being checked
1281 * @internal param array $fieldinfo array of fields from getfields function
1283 function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) {
1284 $existing = civicrm_api($params['entity'], 'get', array(
1285 'version' => $params['version'],
1286 $fieldName => $params[$fieldName],
1288 // an entry already exists for this unique field
1289 if ($existing['count'] == 1) {
1290 // question - could this ever be a security issue?
1291 throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1296 * Generic implementation of the "replace" action.
1298 * Replace the old set of entities (matching some given keys) with a new set of
1299 * entities (matching the same keys).
1301 * Note: This will verify that 'values' is present, but it does not directly verify
1302 * any other parameters.
1304 * @param string $entity entity name
1305 * @param array $params params from civicrm_api, including:
1306 * - 'values': an array of records to save
1307 * - all other items: keys which identify new/pre-existing records
1310 function _civicrm_api3_generic_replace($entity, $params) {
1312 $transaction = new CRM_Core_Transaction();
1314 if (!is_array($params['values'])) {
1315 throw new Exception("Mandatory key(s) missing from params array: values");
1318 // Extract the keys -- somewhat scary, don't think too hard about it
1319 $baseParams = _civicrm_api3_generic_replace_base_params($params);
1321 // Lookup pre-existing records
1322 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1323 if (civicrm_error($preexisting)) {
1324 $transaction->rollback();
1325 return $preexisting;
1328 // Save the new/updated records
1330 foreach ($params['values'] as $replacement) {
1331 // Sugar: Don't force clients to duplicate the 'key' data
1332 $replacement = array_merge($baseParams, $replacement);
1333 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1334 $create = civicrm_api($entity, $action, $replacement);
1335 if (civicrm_error($create)) {
1336 $transaction->rollback();
1339 foreach ($create['values'] as $entity_id => $entity_value) {
1340 $creates[$entity_id] = $entity_value;
1344 // Remove stale records
1345 $staleIDs = array_diff(
1346 array_keys($preexisting['values']),
1347 array_keys($creates)
1349 foreach ($staleIDs as $staleID) {
1350 $delete = civicrm_api($entity, 'delete', array(
1351 'version' => $params['version'],
1354 if (civicrm_error($delete)) {
1355 $transaction->rollback();
1360 return civicrm_api3_create_success($creates, $params);
1362 catch(PEAR_Exception
$e) {
1363 $transaction->rollback();
1364 return civicrm_api3_create_error($e->getMessage());
1366 catch(Exception
$e) {
1367 $transaction->rollback();
1368 return civicrm_api3_create_error($e->getMessage());
1377 function _civicrm_api3_generic_replace_base_params($params) {
1378 $baseParams = $params;
1379 unset($baseParams['values']);
1380 unset($baseParams['sequential']);
1381 unset($baseParams['options']);
1386 * returns fields allowable by api
1388 * @param $entity string Entity to query
1389 * @param bool $unique index by unique fields?
1390 * @param array $params
1394 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1396 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1397 $dao = _civicrm_api3_get_DAO($entity);
1402 $fields = $d->fields();
1403 // replace uniqueNames by the normal names as the key
1404 if (empty($unique)) {
1405 foreach ($fields as $name => & $field) {
1406 //getting rid of unused attributes
1407 foreach ($unsetIfEmpty as $attr) {
1408 if (empty($field[$attr])) {
1409 unset($field[$attr]);
1412 if ($name == $field['name']) {
1415 if (array_key_exists($field['name'], $fields)) {
1416 $field['error'] = 'name conflict';
1417 // it should never happen, but better safe than sorry
1420 $fields[$field['name']] = $field;
1421 $fields[$field['name']]['uniqueName'] = $name;
1422 unset($fields[$name]);
1425 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1430 * Return an array of fields for a given entity - this is the same as the BAO function but
1431 * fields are prefixed with 'custom_' to represent api params
1433 function _civicrm_api_get_custom_fields($entity, &$params) {
1434 $customfields = array();
1435 $entity = _civicrm_api_get_camel_name($entity);
1436 if (strtolower($entity) == 'contact') {
1437 // Use sub-type if available, otherwise stick with 'Contact'
1438 $entity = CRM_Utils_Array
::value('contact_type', $params);
1440 $retrieveOnlyParent = FALSE;
1441 // we could / should probably test for other subtypes here - e.g. activity_type_id
1442 if($entity == 'Contact'){
1443 empty($params['contact_sub_type']);
1445 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1448 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1450 $retrieveOnlyParent,
1454 // find out if we have any requests to resolve options
1455 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1456 if(!is_array($getoptions)){
1457 $getoptions = array($getoptions);
1460 foreach ($customfields as $key => $value) {
1461 // Regular fields have a 'name' property
1462 $value['name'] = 'custom_' . $key;
1463 $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']);
1464 $customfields['custom_' . $key] = $value;
1465 if (in_array('custom_' . $key, $getoptions)) {
1466 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1468 unset($customfields[$key]);
1470 return $customfields;
1473 * Translate the custom field data_type attribute into a std 'type'
1475 function _getStandardTypeFromCustomDataType($dataType) {
1477 'String' => CRM_Utils_Type
::T_STRING
,
1478 'Int' => CRM_Utils_Type
::T_INT
,
1479 'Money' => CRM_Utils_Type
::T_MONEY
,
1480 'Memo' => CRM_Utils_Type
::T_LONGTEXT
,
1481 'Float' => CRM_Utils_Type
::T_FLOAT
,
1482 'Date' => CRM_Utils_Type
::T_DATE
,
1483 'Boolean' => CRM_Utils_Type
::T_BOOLEAN
,
1484 'StateProvince' => CRM_Utils_Type
::T_INT
,
1485 'File' => CRM_Utils_Type
::T_STRING
,
1486 'Link' => CRM_Utils_Type
::T_STRING
,
1487 'ContactReference' => CRM_Utils_Type
::T_INT
,
1488 'Country' => CRM_Utils_Type
::T_INT
,
1490 return $mapping[$dataType];
1493 * Return array of defaults for the given API (function is a wrapper on getfields)
1495 function _civicrm_api3_getdefaults($apiRequest, $fields) {
1496 $defaults = array();
1498 foreach ($fields as $field => $values) {
1499 if (isset($values['api.default'])) {
1500 $defaults[$field] = $values['api.default'];
1507 * Return array of defaults for the given API (function is a wrapper on getfields)
1509 function _civicrm_api3_getrequired($apiRequest, $fields) {
1510 $required = array('version');
1512 foreach ($fields as $field => $values) {
1513 if (!empty($values['api.required'])) {
1514 $required[] = $field;
1521 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1522 * If multiple aliases the last takes precedence
1524 * Function also swaps unique fields for non-unique fields & vice versa.
1526 function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) {
1527 foreach ($fields as $field => $values) {
1528 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1529 if (!empty($values['api.aliases'])) {
1530 // if aliased field is not set we try to use field alias
1531 if (!isset($apiRequest['params'][$field])) {
1532 foreach ($values['api.aliases'] as $alias) {
1533 if (isset($apiRequest['params'][$alias])) {
1534 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1536 //unset original field nb - need to be careful with this as it may bring inconsistencies
1537 // out of the woodwork but will be implementing only as _spec function extended
1538 unset($apiRequest['params'][$alias]);
1542 if (!isset($apiRequest['params'][$field]) && !empty($values['name']) && $field != $values['name']
1543 && isset($apiRequest['params'][$values['name']])
1545 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1546 // note that it would make sense to unset the original field here but tests need to be in place first
1548 if (!isset($apiRequest['params'][$field])
1550 && $field != $uniqueName
1551 && array_key_exists($uniqueName, $apiRequest['params'])
1554 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1555 // note that it would make sense to unset the original field here but tests need to be in place first
1562 * Validate integer fields being passed into API.
1563 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1565 * @param array $params params from civicrm_api
1566 * @param string $fieldName uniquename of field being checked
1569 * @throws API_Exception
1570 * @internal param array $fieldinfo array of fields from getfields function
1572 function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) {
1573 //if fieldname exists in params
1574 if (!empty($params[$fieldName])) {
1575 // if value = 'user_contact_id' (or similar), replace value with contact id
1576 if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) {
1577 $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]);
1578 if ('unknown-user' === $realContactId) {
1579 throw new API_Exception("\"$fieldName\" \"{$params[$fieldName]}\" cannot be resolved to a contact ID", 2002, array('error_field' => $fieldName,"type"=>"integer"));
1580 } elseif (is_numeric($realContactId)) {
1581 $params[$fieldName] = $realContactId;
1584 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1585 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1588 // After swapping options, ensure we have an integer(s)
1589 foreach ((array) ($params[$fieldName]) as $value) {
1590 if ($value && !is_numeric($value) && $value !== 'null' && !is_array($value)) {
1591 throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer"));
1595 // Check our field length
1596 if(is_string($params[$fieldName]) && !empty($fieldInfo['maxlength']) && strlen($params[$fieldName]) > $fieldInfo['maxlength']
1598 throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
1599 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength'])
1606 * Determine a contact ID using a string expression
1608 * @param string $contactIdExpr e.g. "user_contact_id" or "@user:username"
1609 * @return int|NULL|'unknown-user'
1611 function _civicrm_api3_resolve_contactID($contactIdExpr) {
1612 //if value = 'user_contact_id' replace value with logged in user id
1613 if ($contactIdExpr == "user_contact_id") {
1614 $session = &CRM_Core_Session
::singleton();
1615 if (!is_numeric($session->get('userID'))) {
1618 return $session->get('userID');
1619 } elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) {
1620 $config = CRM_Core_Config
::singleton();
1622 $ufID = $config->userSystem
->getUfId($matches[1]);
1624 return 'unknown-user';
1627 $contactID = CRM_Core_BAO_UFMatch
::getContactId($ufID);
1629 return 'unknown-user';
1638 * Validate html (check for scripting attack)
1643 * @throws API_Exception
1645 function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) {
1646 if ($value = CRM_Utils_Array
::value($fieldName, $params)) {
1647 if (!CRM_Utils_Rule
::xssString($value)) {
1648 throw new API_Exception('Illegal characters in input (potential scripting attack)', array("field"=>$fieldName,"error_code"=>"xss"));
1654 * Validate string fields being passed into API.
1655 * @param array $params params from civicrm_api
1656 * @param string $fieldName uniquename of field being checked
1659 * @throws API_Exception
1661 * @internal param array $fieldinfo array of fields from getfields function
1663 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
1664 // If fieldname exists in params
1665 $value = CRM_Utils_Array
::value($fieldName, $params, '');
1666 if(!is_array($value)){
1667 $value = (string) $value;
1670 //@todo what do we do about passed in arrays. For many of these fields
1671 // the missing piece of functionality is separating them to a separated string
1672 // & many save incorrectly. But can we change them wholesale?
1675 if (!CRM_Utils_Rule
::xssString($value)) {
1676 throw new Exception('Illegal characters in input (potential scripting attack)');
1678 if ($fieldName == 'currency') {
1679 if (!CRM_Utils_Rule
::currencyCode($value)) {
1680 throw new Exception("Currency not a valid code: $value");
1683 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options']) ||
!empty($fieldInfo['enumValues'])) {
1684 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1686 // Check our field length
1687 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1688 throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1689 2100, array('field' => $fieldName)
1696 * Validate & swap out any pseudoconstants / options
1698 * @param $params: api parameters
1699 * @param $entity: api entity name
1700 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1701 * @param $fieldInfo: getfields meta-data
1703 function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) {
1704 $options = CRM_Utils_Array
::value('options', $fieldInfo);
1706 if(strtolower($entity) == 'profile' && !empty($fieldInfo['entity'])) {
1707 // we need to get the options from the entity the field relates to
1708 $entity = $fieldInfo['entity'];
1710 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name'], 'context' => 'validate'));
1711 $options = CRM_Utils_Array
::value('values', $options, array());
1714 // If passed a value-separated string, explode to an array, then re-implode after matching values
1716 if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
1717 $params[$fieldName] = CRM_Utils_Array
::explodePadded($params[$fieldName]);
1720 // If passed multiple options, validate each
1721 if (is_array($params[$fieldName])) {
1722 foreach ($params[$fieldName] as &$value) {
1723 if (!is_array($value)) {
1724 _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName);
1727 // TODO: unwrap the call to implodePadded from the conditional and do it always
1728 // need to verify that this is safe and doesn't break anything though.
1729 // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
1731 CRM_Utils_Array
::implodePadded($params[$fieldName]);
1735 _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName);
1740 * Validate & swap a single option value for a field
1742 * @param $value: field value
1743 * @param $options: array of options for this field
1744 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1745 * @throws API_Exception
1747 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) {
1748 // If option is a key, no need to translate
1749 if (array_key_exists($value, $options)) {
1753 // Translate value into key
1754 $newValue = array_search($value, $options);
1755 if ($newValue !== FALSE) {
1759 // Case-insensitive matching
1760 $newValue = strtolower($value);
1761 $options = array_map("strtolower", $options);
1762 $newValue = array_search($newValue, $options);
1763 if ($newValue === FALSE) {
1764 throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName));
1770 * Returns the canonical name of a field
1771 * @param $entity: api entity name (string should already be standardized - no camelCase)
1772 * @param $fieldName: any variation of a field's name (name, unique_name, api.alias)
1774 * @return (string|bool) fieldName or FALSE if the field does not exist
1776 function _civicrm_api3_api_resolve_alias($entity, $fieldName) {
1777 if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
1780 if ($fieldName == "{$entity}_id") {
1783 $result = civicrm_api($entity, 'getfields', array(
1785 'action' => 'create',
1787 $meta = $result['values'];
1788 if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) {
1789 $fieldName = $fieldName . '_id';
1791 if (isset($meta[$fieldName])) {
1792 return $meta[$fieldName]['name'];
1794 foreach ($meta as $info) {
1795 if ($fieldName == CRM_Utils_Array
::value('uniqueName', $info)) {
1796 return $info['name'];
1798 if (array_search($fieldName, CRM_Utils_Array
::value('api.aliases', $info, array())) !== FALSE) {
1799 return $info['name'];