X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2Futils.php;h=3fb9699444568f795502c324bd11f4cb4696ecae;hb=85bb0909cffd925f4cd5c0022a68a1ff74d3ad8e;hp=c1ab74a494740787e86d57f1686201ed9ead13be;hpb=5e436708bbab6d893a35d74f6d5916494463de87;p=civicrm-core.git diff --git a/api/v3/utils.php b/api/v3/utils.php index c1ab74a494..3fb9699444 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -1,9 +1,9 @@ $data * @param array $data - * @param object $dao DAO / BAO object to be freed here * * @throws API_Exception * @return array */ -function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) { - //fix me - $dao should be param 4 & 3 should be $apiRequest - if (is_object($dao)) { - $dao->free(); - } - - if (is_array($dao)) { - if ($msg == 'DB Error: constraint violation' || substr($msg, 0,9) == 'DB Error:' || $msg == 'DB Error: already exists') { - try { - $fields = _civicrm_api3_api_getfields($dao); - _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], $fields, TRUE); - } - catch(Exception $e) { - $msg = $e->getMessage(); - } - } - } +function civicrm_api3_create_error($msg, $data = array()) { $data['is_error'] = 1; $data['error_message'] = $msg; - // we will show sql to privelledged user only (not sure of a specific - // security hole here but seems sensible - perhaps should apply to the trace as well? + // we will show sql to privileged user only (not sure of a specific + // security hole here but seems sensible - perhaps should apply to the trace as well?) if(isset($data['sql']) && CRM_Core_Permission::check('Administer CiviCRM')) { - $data['debug_information'] = $data['sql']; - } - if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && CRM_Utils_Array::value('api.has_parent', $dao['params'])) { - $errorCode = empty($data['error_code']) ? 'chained_api_failed' : $data['error_code']; - throw new API_Exception('Error in call to ' . $dao['entity'] . '_' . $dao['action'] . ' : ' . $msg, $errorCode, $data); + $data['debug_information'] = $data['sql']; // Isn't this redundant? + } else { + unset($data['sql']); } return $data; } @@ -170,7 +150,7 @@ function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) { /** * Format array in result output styple * - * @param array $values values generated by API operation (the result) + * @param array|int $values values generated by API operation (the result) * @param array $params parameters passed into API call * @param string $entity the entity being acted on * @param string $action the action passed to the API @@ -180,8 +160,7 @@ function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) { * * @return array $result */ -function civicrm_api3_create_success($values = 1, $params = array( - ), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) { +function civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) { $result = array(); $result['is_error'] = 0; //lets set the ['id'] field if it's not set & we know what the entity is @@ -217,7 +196,7 @@ function civicrm_api3_create_success($values = 1, $params = array( $allFields = array_keys($apiFields['values']); } $paramFields = array_keys($params); - $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')); + $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', 'prettyprint')); if ($undefined) { $result['undefined_fields'] = array_merge($undefined); } @@ -254,8 +233,8 @@ function civicrm_api3_create_success($values = 1, $params = array( } if(!empty($params['options']['metadata'])) { // we've made metadata an array but only supporting 'fields' atm - if(in_array('fields', $params['options']['metadata'])) { - $fields = civicrm_api3($entity, 'getfields', array('action' => $action)); + if(in_array('fields', (array) $params['options']['metadata'])) { + $fields = civicrm_api3($entity, 'getfields', array('action' => substr($action, 0, 3) == 'get' ? 'get' : 'create')); $result['metadata']['fields'] = $fields['values']; } } @@ -288,21 +267,53 @@ function _civicrm_api3_get_DAO($name) { $name = substr($name, 13, $last - 13); } - if (strtolower($name) == 'individual' || strtolower($name) == 'household' || strtolower($name) == 'organization') { + $name = _civicrm_api_get_camel_name($name, 3); + + if ($name == 'Individual' || $name == 'Household' || $name == 'Organization') { $name = 'Contact'; } - //hack to deal with incorrectly named BAO/DAO - see CRM-10859 - - // several of these have been removed but am not confident mailing_recipients is - // tests so have not tackled. - // correct approach for im is unclear - if($name == 'mailing_recipients' || $name == 'MailingRecipients'){ - return 'CRM_Mailing_BAO_Recipients'; + // hack to deal with incorrectly named BAO/DAO - see CRM-10859 + + // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingRecipients + // but am not confident mailing_recipients is tested so have not tackled. + if ($name == 'MailingRecipients') { + return 'CRM_Mailing_DAO_Recipients'; + } + // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingComponent + if ($name == 'MailingComponent') { + return 'CRM_Mailing_DAO_Component'; + } + // FIXME: DAO should be renamed CRM_ACL_DAO_AclRole + if ($name == 'AclRole') { + return 'CRM_ACL_DAO_EntityRole'; + } + // FIXME: DAO should be renamed CRM_SMS_DAO_SmsProvider + // But this would impact SMS extensions so need to coordinate + // Probably best approach is to migrate them to use the api and decouple them from core BAOs + if ($name == 'SmsProvider') { + return 'CRM_SMS_DAO_Provider'; + } + // FIXME: DAO names should follow CamelCase convention + if ($name == 'Im' || $name == 'Acl') { + $name = strtoupper($name); + } + $dao = CRM_Core_DAO_AllCoreTables::getFullName($name); + if ($dao || !$name) { + return $dao; + } + + // Really weird apis can declare their own DAO name. Not sure if this is a good idea... + if(file_exists("api/v3/$name.php")) { + include_once "api/v3/$name.php"; } - if(strtolower($name) == 'im'){ - return 'CRM_Core_BAO_IM'; + + $daoFn = "_civicrm_api3_" . _civicrm_api_get_entity_name_from_camel($name) . "_DAO"; + if (function_exists($daoFn)) { + return $daoFn(); } - return CRM_Core_DAO_AllCoreTables::getFullName(_civicrm_api_get_camel_name($name, 3)); + + return NULL; } /** @@ -313,6 +324,10 @@ function _civicrm_api3_get_DAO($name) { * @return mixed */ function _civicrm_api3_get_BAO($name) { + // FIXME: DAO should be renamed CRM_Badge_DAO_BadgeLayout + if ($name == 'PrintLabel') { + return 'CRM_Badge_BAO_Layout'; + } $dao = _civicrm_api3_get_DAO($name); if (!$dao) { return NULL; @@ -460,7 +475,9 @@ function _civicrm_api3_get_using_query_object($entity, $params, $additional_opti } } - $skipPermissions = CRM_Utils_Array::value('check_permissions', $params)? 0 :1; + + $skipPermissions = !empty($params['check_permissions']) ? 0 :1; + list($entities, $options) = CRM_Contact_BAO_Query::apiQuery( $newParams, $returnProperties, @@ -520,6 +537,13 @@ function _civicrm_api3_get_query_object($params, $mode, $entity) { /** * Function transfers the filters being passed into the DAO onto the params object + * @param CRM_Core_DAO $dao + * @param array $params + * @param bool $unique + * @param string $entity + * + * @throws API_Exception + * @throws Exception */ function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) { $entity = substr($dao->__table, 8); @@ -552,9 +576,6 @@ function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) { } } } - // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now - // support for other syntaxes is discussed in ticket but being put off for now - $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'); if (!$fields) { $fields = array(); } @@ -642,6 +663,7 @@ function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) { * @param string $entity * @param string $action * + * @throws API_Exception * @return array $options options extracted from params */ function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') { @@ -679,7 +701,7 @@ function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $ } } if ($entity && $action =='get') { - if (CRM_Utils_Array::value('id',$returnProperties)) { + if (!empty($returnProperties['id'])) { $returnProperties[$entity . '_id'] = 1; unset($returnProperties['id']); } @@ -696,7 +718,7 @@ function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $ 'sort' => CRM_Utils_Rule::string($sort) ? $sort : NULL, 'limit' => CRM_Utils_Rule::integer($limit) ? $limit : NULL, 'is_count' => $is_count, - 'return' => !empty($returnProperties) ? $returnProperties : NULL, + 'return' => !empty($returnProperties) ? $returnProperties : array(), ); if ($options['sort'] && stristr($options['sort'], 'SELECT')) { @@ -760,7 +782,7 @@ function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) { function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) { $fields = $bao->fields(); if ($unique) { - if(!CRM_Utils_Array::value('id', $fields)){ + if (empty($fields['id'])){ $entity = _civicrm_api_get_entity_name_from_dao($bao); $fields['id'] = $fields[$entity . '_id']; unset($fields[$entity . '_id']); @@ -777,6 +799,9 @@ function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) { /** * build fields array. This is the array of fields as it relates to the given DAO * returns unique fields as keys by default but if set but can return by DB fields + * @param CRM_Core_BAO $bao + * + * @return mixed */ function _civicrm_api3_get_unique_name_array(&$bao) { $fields = $bao->fields(); @@ -789,11 +814,13 @@ function _civicrm_api3_get_unique_name_array(&$bao) { /** * Converts an DAO object to an array * - * @param object $dao (reference )object to convert + * @param object $dao (reference )object to convert * @param null $params * @param bool $uniqueFields * @param string $entity * + * @param bool $autoFind + * * @return array * * @params array of arrays (key = id) of array of fields @@ -803,7 +830,7 @@ function _civicrm_api3_get_unique_name_array(&$bao) { */ function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) { $result = array(); - if(isset($params['options']) && CRM_Utils_Array::value('is_count', $params['options'])) { + if(isset($params['options']) && !empty($params['options']['is_count'])) { return $dao->count(); } if (empty($dao)) { @@ -816,15 +843,6 @@ function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, if(isset($dao->count)) { return $dao->count; } - //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired - if (!empty($entity) && CRM_Utils_Array::value('return', $params) && is_array($params['return'])) { - foreach ($params['return'] as $return) { - if (substr($return, 0, 6) == 'custom') { - $custom = TRUE; - } - } - } - $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields)); @@ -839,7 +857,8 @@ function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, } } $result[$dao->id] = $tmp; - if (!empty($custom)) { + + if(_civicrm_api3_custom_fields_are_required($entity, $params)) { _civicrm_api3_custom_data_get($result[$dao->id], $entity, $dao->id); } } @@ -848,6 +867,27 @@ function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, return $result; } +/** + * We currently retrieve all custom fields or none at this level so if we know the entity + * && it can take custom fields & there is the string 'custom' in their return request we get them all, they are filtered on the way out + * @todo filter so only required fields are queried + * + * @param $params + * @param string $entity - entity name in CamelCase + * + * @return bool + */ +function _civicrm_api3_custom_fields_are_required($entity, $params) { + if (!array_key_exists($entity, CRM_Core_BAO_CustomQuery::$extendsMap)) { + return FALSE; + } + $options = _civicrm_api3_get_options_from_params($params); + //we check for possibility of 'custom' => 1 as well as specific custom fields + $returnString = implode('', $options['return']) . implode('', array_keys($options['return'])); + if(stristr($returnString, 'custom')) { + return TRUE; + } +} /** * Converts an object to an array * @@ -911,6 +951,22 @@ function _civicrm_api3_custom_format_params($params, &$values, $extends, $entity } } +/** + * @param $params + * @param $entity + */ +function _civicrm_api3_format_params_for_create(&$params, $entity) { + $nonGenericEntities = array('Contact', 'Individual', 'Household', 'Organization'); + + $customFieldEntities = array_diff_key(CRM_Core_BAO_CustomQuery::$extendsMap, array_fill_keys($nonGenericEntities, 1)); + if(!array_key_exists($entity, $customFieldEntities)) { + return; + } + $values = array(); + _civicrm_api3_custom_format_params($params, $values, $entity); + $params = array_merge($params, $values); +} + /** * we can't rely on downstream to add separators to checkboxes so we'll check here. We should look at pushing to BAO function * and / or validate function but this is a safe place for now as it has massive test coverage & we can keep the change very specific @@ -1052,7 +1108,7 @@ function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) continue; } - if (CRM_Utils_Array::value('required', $v)) { + if (!empty($v['required'])) { // 0 is a valid input for numbers, CRM-8122 if (!isset($params[$k]) || (empty($params[$k]) && !($params[$k] === 0))) { $missing[] = $k; @@ -1072,48 +1128,6 @@ function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) return TRUE; } -/** - * Check permissions for a given API call. - * - * @param $entity string API entity being accessed - * @param $action string API action being performed - * @param $params array params of the API call - * @param $throw deprecated bool whether to throw exception instead of returning false - * - * @throws Exception - * @return bool whether the current API user has the permission to make the call - */ -function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) { - // return early unless we’re told explicitly to do the permission check - if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) { - return TRUE; - } - - require_once 'CRM/Core/DAO/permissions.php'; - $permissions = _civicrm_api3_permissions($entity, $action, $params); - - // $params might’ve been reset by the alterAPIPermissions() hook - if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) { - return TRUE; - } - - if (!CRM_Core_Permission::check($permissions)) { - if ($throw) { - if(is_array($permissions)) { - $permissions = implode(' and ', $permissions); - } - throw new Exception("API permission check failed for $entity/$action call; insufficient permission: require $permissions"); - } - else { - //@todo remove this - this is an internal api function called with $throw set to TRUE. It is only called with false - // in tests & that should be tidied up - return FALSE; - } - } - - return TRUE; -} - /** * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this * @@ -1131,19 +1145,22 @@ function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $ return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity, 'get'); } else { - return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity); + return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity, 'get'); } } /** * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this + * * @param string $bao_name Name of BAO Class * @param array $params parameters passed into the api call * @param string $entity Entity - pass in if entity is non-standard & required $ids array + * + * @throws API_Exception * @return array */ function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) { - + _civicrm_api3_format_params_for_create($params, $entity); $args = array(&$params); if (!empty($entity)) { $ids = array($entity => CRM_Utils_Array::value('id', $params)); @@ -1198,7 +1215,11 @@ function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) { * @return CRM_Core_DAO|NULL an instance of the BAO */ function _civicrm_api3_basic_create_fallback($bao_name, &$params) { - $entityName = CRM_Core_DAO_AllCoreTables::getBriefName(get_parent_class($bao_name)); + $dao_name = get_parent_class($bao_name); + if ($dao_name === 'CRM_Core_DAO' || !$dao_name) { + $dao_name = $bao_name; + } + $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($dao_name); if (empty($entityName)) { throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array( 'class_name' => $bao_name, @@ -1207,7 +1228,7 @@ function _civicrm_api3_basic_create_fallback($bao_name, &$params) { $hook = empty($params['id']) ? 'create' : 'edit'; CRM_Utils_Hook::pre($hook, $entityName, CRM_Utils_Array::value('id', $params), $params); - $instance = new $bao_name(); + $instance = new $dao_name(); $instance->copyValues($params); $instance->save(); CRM_Utils_Hook::post($hook, $entityName, $instance->id, $instance); @@ -1218,6 +1239,12 @@ function _civicrm_api3_basic_create_fallback($bao_name, &$params) { /** * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this * if api::del doesn't exist it will try DAO delete method + * + * @param $bao_name + * @param $params + * + * @return array API result array + * @throws API_Exception */ function _civicrm_api3_basic_delete($bao_name, &$params) { @@ -1259,7 +1286,7 @@ function _civicrm_api3_basic_delete($bao_name, &$params) { * @param string $subName - Subtype of entity */ function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) { - $groupTree = &CRM_Core_BAO_CustomGroup::getTree($entity, + $groupTree = CRM_Core_BAO_CustomGroup::getTree($entity, CRM_Core_DAO::$_nullObject, $entity_id, $groupID, @@ -1269,19 +1296,23 @@ function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $grou $groupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1, CRM_Core_DAO::$_nullObject); $customValues = array(); CRM_Core_BAO_CustomGroup::setDefaults($groupTree, $customValues); + $fieldInfo = array(); + foreach ($groupTree as $set) { + $fieldInfo += $set['fields']; + } if (!empty($customValues)) { foreach ($customValues as $key => $val) { - if (strstr($key, '_id')) { - $idkey = substr($key, 0, -3); - $returnArray['custom_' . (CRM_Core_BAO_CustomField::getKeyID($idkey) . "_id")] = $val; - $returnArray[$key] = $val; - } - else { - // per standard - return custom_fieldID - $returnArray['custom_' . (CRM_Core_BAO_CustomField::getKeyID($key))] = $val; + // per standard - return custom_fieldID + $id = CRM_Core_BAO_CustomField::getKeyID($key); + $returnArray['custom_' . $id] = $val; - //not standard - but some api did this so guess we should keep - cheap as chips - $returnArray[$key] = $val; + //not standard - but some api did this so guess we should keep - cheap as chips + $returnArray[$key] = $val; + + // Shim to restore legacy behavior of ContactReference custom fields + if (!empty($fieldInfo[$id]) && $fieldInfo[$id]['data_type'] == 'ContactReference') { + $returnArray['custom_' . $id . '_id'] = $returnArray[$key . '_id'] = $val; + $returnArray['custom_' . $id] = $returnArray[$key] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $val, 'sort_name'); } } } @@ -1311,6 +1342,7 @@ function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $err case 4: case 12: + case CRM_Utils_Type::T_TIMESTAMP: //field is of type date or datetime _civicrm_api3_validate_date($params, $fieldName, $fieldInfo); break; @@ -1331,15 +1363,15 @@ function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $err // intensive checks - usually only called after DB level fail if (!empty($errorMode) && strtolower($action) == 'create') { - if (CRM_Utils_Array::value('FKClassName', $fieldInfo)) { - if (CRM_Utils_Array::value($fieldName, $params)) { + if (!empty($fieldInfo['FKClassName'])) { + if (!empty($params[$fieldName])) { _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo); } - elseif (CRM_Utils_Array::value('required', $fieldInfo)) { + elseif (!empty($fieldInfo['required'])) { throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report"); } } - if (CRM_Utils_Array::value('api.unique', $fieldInfo)) { + if (!empty($fieldInfo['api.unique'])) { $params['entity'] = $entity; _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo); } @@ -1364,21 +1396,40 @@ function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $err */ function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) { //should we check first to prevent it from being copied if they have passed in sql friendly format? - if (CRM_Utils_Array::value($fieldInfo['name'], $params)) { - //accept 'whatever strtotime accepts - if (strtotime($params[$fieldInfo['name']]) === FALSE) { - throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]); - } - $format = ($fieldInfo['type'] == CRM_Utils_Type::T_DATE) ? 'Ymd000000' : 'YmdHis'; - $params[$fieldInfo['name']] = CRM_Utils_Date::processDate($params[$fieldInfo['name']], NULL, FALSE, $format); + if (!empty($params[$fieldInfo['name']])) { + $params[$fieldInfo['name']] = _civicrm_api3_getValidDate($params[$fieldInfo['name']], $fieldInfo['name'], $fieldInfo['type']); + } + if ((CRM_Utils_Array::value('name', $fieldInfo) != $fieldName) && !empty($params[$fieldName])) { + $params[$fieldName] = _civicrm_api3_getValidDate($params[$fieldName], $fieldName, $fieldInfo['type']); } - if ((CRM_Utils_Array::value('name', $fieldInfo) != $fieldName) && CRM_Utils_Array::value($fieldName, $params)) { - //If the unique field name differs from the db name & is set handle it here - if (strtotime($params[$fieldName]) === FALSE) { - throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]); +} + +/** + * convert date into BAO friendly date + * we accept 'whatever strtotime accepts' + * + * @param string $dateValue + * @param $fieldName + * @param $fieldType + * + * @throws Exception + * @internal param $fieldInfo + * + * @internal param $params + * @return mixed + */ +function _civicrm_api3_getValidDate($dateValue, $fieldName, $fieldType) { + if (is_array($dateValue)) { + foreach ($dateValue as $key => $value) { + $dateValue[$key] = _civicrm_api3_getValidDate($value, $fieldName, $fieldType); } - $params[$fieldName] = CRM_Utils_Date::processDate($params[$fieldName]); + return $dateValue; + } + if (strtotime($dateValue) === FALSE) { + throw new Exception($fieldName . " is not a valid date: " . $dateValue); } + $format = ($fieldType == CRM_Utils_Type::T_DATE) ? 'Ymd000000' : 'YmdHis'; + return CRM_Utils_Date::processDate($dateValue, NULL, FALSE, $format); } /** @@ -1415,7 +1466,7 @@ function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) { // an entry already exists for this unique field if ($existing['count'] == 1) { // question - could this ever be a security issue? - throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']); + throw new API_Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']); } } @@ -1518,8 +1569,7 @@ function _civicrm_api3_generic_replace_base_params($params) { * * @return array */ -function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array( - )) { +function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array()) { $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import'); $dao = _civicrm_api3_get_DAO($entity); if (empty($dao)) { @@ -1578,23 +1628,17 @@ function _civicrm_api_get_custom_fields($entity, &$params) { FALSE, FALSE ); - // find out if we have any requests to resolve options - $getoptions = CRM_Utils_Array::value('get_options', CRM_Utils_Array::value('options',$params)); - if(!is_array($getoptions)){ - $getoptions = array($getoptions); - } + + $ret = array(); foreach ($customfields as $key => $value) { // Regular fields have a 'name' property $value['name'] = 'custom_' . $key; + $value['title'] = $value['label']; $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']); - $customfields['custom_' . $key] = $value; - if (in_array('custom_' . $key, $getoptions)) { - $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption::valuesByID($key); - } - unset($customfields[$key]); + $ret['custom_' . $key] = $value; } - return $customfields; + return $ret; } /** * Translate the custom field data_type attribute into a std 'type' @@ -1616,33 +1660,7 @@ function _getStandardTypeFromCustomDataType($dataType) { ); return $mapping[$dataType]; } -/** - * Return array of defaults for the given API (function is a wrapper on getfields) - */ -function _civicrm_api3_getdefaults($apiRequest, $fields) { - $defaults = array(); - foreach ($fields as $field => $values) { - if (isset($values['api.default'])) { - $defaults[$field] = $values['api.default']; - } - } - return $defaults; -} - -/** - * Return array of defaults for the given API (function is a wrapper on getfields) - */ -function _civicrm_api3_getrequired($apiRequest, $fields) { - $required = array('version'); - - foreach ($fields as $field => $values) { - if (CRM_Utils_Array::value('api.required', $values)) { - $required[] = $field; - } - } - return $required; -} /** * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't @@ -1653,7 +1671,7 @@ function _civicrm_api3_getrequired($apiRequest, $fields) { function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) { foreach ($fields as $field => $values) { $uniqueName = CRM_Utils_Array::value('uniqueName', $values); - if (CRM_Utils_Array::value('api.aliases', $values)) { + if (!empty($values['api.aliases'])) { // if aliased field is not set we try to use field alias if (!isset($apiRequest['params'][$field])) { foreach ($values['api.aliases'] as $alias) { @@ -1666,9 +1684,7 @@ function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) { } } } - if (!isset($apiRequest['params'][$field]) - && CRM_Utils_Array::value('name', $values) - && $field != $values['name'] + if (!isset($apiRequest['params'][$field]) && !empty($values['name']) && $field != $values['name'] && isset($apiRequest['params'][$values['name']]) ) { $apiRequest['params'][$field] = $apiRequest['params'][$values['name']]; @@ -1698,8 +1714,7 @@ function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) { * @throws API_Exception */ function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) { - //if fieldname exists in params - if (CRM_Utils_Array::value($fieldName, $params)) { + if (!empty($params[$fieldName])) { // if value = 'user_contact_id' (or similar), replace value with contact id if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) { $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]); @@ -1721,9 +1736,7 @@ function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $ent } // Check our field length - if(is_string($params[$fieldName]) && - CRM_Utils_Array::value('maxlength',$fieldInfo) - && strlen($params[$fieldName]) > $fieldInfo['maxlength'] + if(is_string($params[$fieldName]) && !empty($fieldInfo['maxlength']) && strlen($params[$fieldName]) > $fieldInfo['maxlength'] ){ throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters', 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength']) @@ -1806,7 +1819,7 @@ function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $enti throw new Exception("Currency not a valid code: $value"); } } - if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options']) || !empty($fieldInfo['enumValues'])) { + if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options'])) { _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo); } // Check our field length @@ -1894,10 +1907,11 @@ function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldN /** * Returns the canonical name of a field - * @param $entity: api entity name (string should already be standardized - no camelCase) - * @param $fieldName: any variation of a field's name (name, unique_name, api.alias) * - * @return (string|bool) fieldName or FALSE if the field does not exist + * @param $entity : api entity name (string should already be standardized - no camelCase) + * @param $fieldName : any variation of a field's name (name, unique_name, api.alias) + * + * @return bool|string (string|bool) fieldName or FALSE if the field does not exist */ function _civicrm_api3_api_resolve_alias($entity, $fieldName) { if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {