4 * File for the CiviCRM APIv3 API wrapper
6 * @package CiviCRM_APIv3
9 * @copyright CiviCRM LLC (c) 2004-2013
10 * @version $Id: api.php 30486 2010-11-02 16:12:09Z shot $
14 * @param string $entity
15 * type of entities to deal with
16 * @param string $action
17 * create, get, delete or some special action name.
18 * @param array $params
19 * array to be passed to function
21 function civicrm_api($entity, $action, $params, $extra = NULL) {
22 $apiWrappers = array(CRM_Core_HTMLInputCoder
::singleton());
24 require_once ('api/v3/utils.php');
25 require_once 'api/Exception.php';
26 if (!is_array($params)) {
27 throw new API_Exception('Input variable `params` is not an array', 2000);
29 _civicrm_api3_initialize();
30 $errorScope = CRM_Core_TemporaryErrorScope
::useException();
31 $apiRequest = array();
32 $apiRequest['entity'] = CRM_Utils_String
::munge($entity);
33 $apiRequest['action'] = CRM_Utils_String
::munge($action);
34 $apiRequest['version'] = civicrm_get_api_version($params);
35 $apiRequest['params'] = $params;
36 $apiRequest['extra'] = $extra;
37 // look up function, file, is_generic
38 $apiRequest +
= _civicrm_api_resolve($apiRequest);
39 if (strtolower($action) == 'create' ||
strtolower($action) == 'delete') {
40 $apiRequest['is_transactional'] = 1;
41 $transaction = new CRM_Core_Transaction();
44 // support multi-lingual requests
45 if ($language = CRM_Utils_Array
::value('option.language', $params)) {
46 _civicrm_api_set_locale($language);
49 _civicrm_api3_api_check_permission($apiRequest['entity'], $apiRequest['action'], $apiRequest['params']);
51 // we do this before we
52 _civicrm_api3_swap_out_aliases($apiRequest);
53 if (strtolower($action) != 'getfields') {
54 if (!CRM_Utils_Array
::value('id', $apiRequest['params'])) {
55 $apiRequest['params'] = array_merge(_civicrm_api3_getdefaults($apiRequest), $apiRequest['params']);
57 //if 'id' is set then only 'version' will be checked but should still be checked for consistency
58 civicrm_api3_verify_mandatory($apiRequest['params'], NULL, _civicrm_api3_getrequired($apiRequest));
61 foreach ($apiWrappers as $apiWrapper) {
62 $apiRequest = $apiWrapper->fromApiInput($apiRequest);
65 $function = $apiRequest['function'];
66 if ($apiRequest['function'] && $apiRequest['is_generic']) {
67 // Unlike normal API implementations, generic implementations require explicit
68 // knowledge of the entity and action (as well as $params). Bundle up these bits
69 // into a convenient data structure.
70 $result = $function($apiRequest);
72 elseif ($apiRequest['function'] && !$apiRequest['is_generic']) {
73 _civicrm_api3_validate_fields($apiRequest['entity'], $apiRequest['action'], $apiRequest['params']);
75 $result = isset($extra) ?
$function($apiRequest['params'], $extra) : $function($apiRequest['params']);
78 return civicrm_api3_create_error("API (" . $apiRequest['entity'] . "," . $apiRequest['action'] . ") does not exist (join the API team and implement it!)");
81 foreach ($apiWrappers as $apiWrapper) {
82 $result = $apiWrapper->toApiOutput($apiRequest, $result);
85 if (CRM_Utils_Array
::value('format.is_success', $apiRequest['params']) == 1) {
86 if ($result['is_error'] === 0) {
93 if (CRM_Utils_Array
::value('format.only_id', $apiRequest['params']) && isset($result['id'])) {
96 if (CRM_Utils_Array
::value('is_error', $result, 0) == 0) {
97 _civicrm_api_call_nested_api($apiRequest['params'], $result, $apiRequest['action'], $apiRequest['entity'], $apiRequest['version']);
99 if (function_exists('xdebug_time_index')
100 && CRM_Utils_Array
::value('debug', $apiRequest['params'])
101 // result would not be an array for getvalue
104 $result['xdebug']['peakMemory'] = xdebug_peak_memory_usage();
105 $result['xdebug']['memory'] = xdebug_memory_usage();
106 $result['xdebug']['timeIndex'] = xdebug_time_index();
111 catch(PEAR_Exception
$e) {
112 if (CRM_Utils_Array
::value('format.is_success', $apiRequest['params']) == 1) {
115 $error = $e->getCause();
116 if ($error instanceof DB_Error
) {
117 $data["error_code"] = DB
::errorMessage($error->getCode());
118 $data["sql"] = $error->getDebugInfo();
120 if (CRM_Utils_Array
::value('debug', $apiRequest['params'])) {
121 $data['debug_info'] = $error->getUserInfo();
122 $data['trace'] = $e->getTraceAsString();
125 $data['tip'] = "add debug=1 to your API call to have more info about the error";
127 $err = civicrm_api3_create_error($e->getMessage(), $data, $apiRequest);
128 if (CRM_Utils_Array
::value('is_transactional', $apiRequest)) {
129 $transaction->rollback();
133 catch (API_Exception
$e){
134 if(!isset($apiRequest)){
135 $apiRequest = array();
137 if (CRM_Utils_Array
::value('format.is_success', CRM_Utils_Array
::value('params',$apiRequest)) == 1) {
140 $data = $e->getExtraParams();
141 $data['entity'] = CRM_Utils_Array
::value('entity', $apiRequest);
142 $data['action'] = CRM_Utils_Array
::value('action', $apiRequest);
143 $err = civicrm_api3_create_error($e->getMessage(), $data, $apiRequest, $e->getCode());
144 if (CRM_Utils_Array
::value('debug', CRM_Utils_Array
::value('params',$apiRequest))
145 && empty($data['trace']) // prevent recursion
147 $err['trace'] = $e->getTraceAsString();
149 if (CRM_Utils_Array
::value('is_transactional', $apiRequest)) {
150 $transaction->rollback();
154 catch(Exception
$e) {
155 if (CRM_Utils_Array
::value('format.is_success', $apiRequest['params']) == 1) {
159 $err = civicrm_api3_create_error($e->getMessage(), $data, $apiRequest, $e->getCode());
160 if (CRM_Utils_Array
::value('debug', $apiRequest['params'])) {
161 $err['trace'] = $e->getTraceAsString();
163 if (CRM_Utils_Array
::value('is_transactional', $apiRequest)) {
164 $transaction->rollback();
171 * Look up the implementation for a given API request
173 * @param $apiRequest array with keys:
174 * - entity: string, required
175 * - action: string, required
177 * - version: scalar, required
179 * @return array with keys
180 * - function: callback (mixed)
181 * - is_generic: boolean
183 function _civicrm_api_resolve($apiRequest) {
185 $cachekey = strtolower($apiRequest['entity']) . ':' . strtolower($apiRequest['action']) . ':' . $apiRequest['version'];
186 if (isset($cache[$cachekey])) {
187 return $cache[$cachekey];
190 $camelName = _civicrm_api_get_camel_name($apiRequest['entity'], $apiRequest['version']);
191 $actionCamelName = _civicrm_api_get_camel_name($apiRequest['action']);
193 // Determine if there is an entity-specific implementation of the action
194 $stdFunction = civicrm_api_get_function_name($apiRequest['entity'], $apiRequest['action'], $apiRequest['version']);
195 if (function_exists($stdFunction)) {
196 // someone already loaded the appropriate file
197 // FIXME: This has the affect of masking bugs in load order; this is included to provide bug-compatibility
198 $cache[$cachekey] = array('function' => $stdFunction, 'is_generic' => FALSE);
199 return $cache[$cachekey];
203 // By convention, the $camelName.php is more likely to contain the function, so test it first
204 'api/v' . $apiRequest['version'] . '/' . $camelName . '.php',
205 'api/v' . $apiRequest['version'] . '/' . $camelName . '/' . $actionCamelName . '.php',
207 foreach ($stdFiles as $stdFile) {
208 if (CRM_Utils_File
::isIncludable($stdFile)) {
209 require_once $stdFile;
210 if (function_exists($stdFunction)) {
211 $cache[$cachekey] = array('function' => $stdFunction, 'is_generic' => FALSE);
212 return $cache[$cachekey];
217 // Determine if there is a generic implementation of the action
218 require_once 'api/v3/Generic.php';
219 # $genericFunction = 'civicrm_api3_generic_' . $apiRequest['action'];
220 $genericFunction = civicrm_api_get_function_name('generic', $apiRequest['action'], $apiRequest['version']);
221 $genericFiles = array(
222 // By convention, the Generic.php is more likely to contain the function, so test it first
223 'api/v' . $apiRequest['version'] . '/Generic.php',
224 'api/v' . $apiRequest['version'] . '/Generic/' . $actionCamelName . '.php',
226 foreach ($genericFiles as $genericFile) {
227 if (CRM_Utils_File
::isIncludable($genericFile)) {
228 require_once $genericFile;
229 if (function_exists($genericFunction)) {
230 $cache[$cachekey] = array('function' => $genericFunction, 'is_generic' => TRUE);
231 return $cache[$cachekey];
236 $cache[$cachekey] = array('function' => FALSE, 'is_generic' => FALSE);
237 return $cache[$cachekey];
240 * Version 3 wrapper for civicrm_api. Throws exception
241 * @param string $entity type of entities to deal with
242 * @param string $action create, get, delete or some special action name.
243 * @param array $params array to be passed to function
248 function civicrm_api3($entity, $action, $params){
249 $params['version'] = 3;
250 $result = civicrm_api($entity, $action, $params);
251 if($result['is_error']){
252 throw new CiviCRM_API3_Exception($result['error_message'], CRM_Utils_Array
::value('error_code', $result, 'undefined'), $result);
257 * Load/require all files related to an entity.
259 * This should not normally be called because it's does a file-system scan; it's
260 * only appropriate when introspection is really required (eg for "getActions").
262 * @param string $entity
265 function _civicrm_api_loadEntity($entity, $version = 3) {
267 $apiRequest = array();
268 $apiRequest['entity'] = $entity;
269 $apiRequest['action'] = 'pretty sure it will never exist. Trick to [try to] force resolve to scan everywhere';
270 $apiRequest['version'] = $version;
271 // look up function, file, is_generic
272 $apiRequest = _civicrm_api_resolve($apiRequest);
275 $camelName = _civicrm_api_get_camel_name($entity, $version);
277 // Check for master entity file; to match _civicrm_api_resolve(), only load the first one
278 $stdFile = 'api/v' . $version . '/' . $camelName . '.php';
279 if (CRM_Utils_File
::isIncludable($stdFile)) {
280 require_once $stdFile;
283 // Check for standalone action files; to match _civicrm_api_resolve(), only load the first one
284 $loaded_files = array(); // array($relativeFilePath => TRUE)
285 $include_dirs = array_unique(explode(PATH_SEPARATOR
, get_include_path()));
286 foreach ($include_dirs as $include_dir) {
287 $action_dir = implode(DIRECTORY_SEPARATOR
, array($include_dir, 'api', "v${version}", $camelName));
288 if (! is_dir($action_dir)) {
292 $iterator = new DirectoryIterator($action_dir);
293 foreach ($iterator as $fileinfo) {
294 $file = $fileinfo->getFilename();
295 if (array_key_exists($file, $loaded_files)) {
296 continue; // action provided by an earlier item on include_path
299 $parts = explode(".", $file);
300 if (end($parts) == "php" && !preg_match('/Tests?\.php$/', $file) ) {
301 require_once $action_dir . DIRECTORY_SEPARATOR
. $file;
302 $loaded_files[$file] = TRUE;
312 function civicrm_api_get_function_name($entity, $action, $version = NULL) {
314 if (empty($version)) {
315 $version = civicrm_get_api_version();
318 $entity = _civicrm_api_get_entity_name_from_camel($entity);
319 return 'civicrm_api3' . '_' . $entity . '_' . $action;
323 * We must be sure that every request uses only one version of the API.
325 * @param $desired_version : array or integer
326 * One chance to set the version number.
327 * After that, this version number will be used for the remaining request.
328 * This can either be a number, or an array(.., 'version' => $version, ..).
329 * This allows to directly pass the $params array.
331 function civicrm_get_api_version($desired_version = NULL) {
333 if (is_array($desired_version)) {
334 // someone gave the full $params array.
335 $params = $desired_version;
336 $desired_version = empty($params['version']) ?
NULL : (int) $params['version'];
338 if (isset($desired_version) && is_integer($desired_version)) {
339 $_version = $desired_version;
342 // we will set the default to version 3 as soon as we find that it works.
349 * Check if the result is an error. Note that this function has been retained from
350 * api v2 for convenience but the result is more standardised in v3 and param
351 * 'format.is_success' => 1
352 * will result in a boolean success /fail being returned if that is what you need.
354 * @param array $params (reference ) input parameters
356 * @return boolean true if error, false otherwise
360 function civicrm_error($result) {
361 if (is_array($result)) {
362 return (array_key_exists('is_error', $result) &&
369 function _civicrm_api_get_camel_name($entity, $version = NULL) {
370 if (empty($version)) {
371 $version = civicrm_get_api_version();
374 $fragments = explode('_', $entity);
375 foreach ($fragments as & $fragment) {
376 $fragment = ucfirst($fragment);
378 // Special case: UFGroup, UFJoin, UFMatch, UFField
379 if ($fragments[0] === 'Uf') {
380 $fragments[0] = 'UF';
382 return implode('', $fragments);
386 * Call any nested api calls
388 function _civicrm_api_call_nested_api(&$params, &$result, $action, $entity, $version) {
389 $entity = _civicrm_api_get_entity_name_from_camel($entity);
390 if(strtolower($action) == 'getsingle'){
391 // I don't understand the protocol here, but we don't want
392 // $result to be a recursive array
393 // $result['values'][0] = $result;
394 $oldResult = $result;
395 $result = array('values' => array(0 => $oldResult));
397 foreach ($params as $field => $newparams) {
398 if ((is_array($newparams) ||
$newparams === 1) && $field <> 'api.has_parent' && substr($field, 0, 3) == 'api') {
400 // 'api.participant.delete' => 1 is a valid options - handle 1 instead of an array
401 if ($newparams === 1) {
402 $newparams = array('version' => $version);
404 // can be api_ or api.
405 $separator = $field[3];
406 if (!($separator == '.' ||
$separator == '_')) {
409 $subAPI = explode($separator, $field);
411 $subaction = empty($subAPI[2]) ?
$action : $subAPI[2];
413 'debug' => CRM_Utils_Array
::value('debug', $params),
415 $subEntity = $subAPI[1];
417 foreach ($result['values'] as $idIndex => $parentAPIValues) {
419 if (strtolower($subEntity) != 'contact') {
420 //contact spits the dummy at activity_id so what else won't it like?
421 //set entity_id & entity table based on the parent's id & entity. e.g for something like
422 //note if the parent call is contact 'entity_table' will be set to 'contact' & 'id' to the contact id from
424 //in this case 'contact_id' will also be set to the parent's id
425 $subParams["entity_id"] = $parentAPIValues['id'];
426 $subParams['entity_table'] = 'civicrm_' . _civicrm_api_get_entity_name_from_camel($entity);
427 $subParams[strtolower($entity) . "_id"] = $parentAPIValues['id'];
429 if (strtolower($entity) != 'contact' && CRM_Utils_Array
::value(strtolower($subEntity . "_id"), $parentAPIValues)) {
430 //e.g. if event_id is in the values returned & subentity is event then pass in event_id as 'id'
431 //don't do this for contact as it does some wierd things like returning primary email &
432 //thus limiting the ability to chain email
433 //TODO - this might need the camel treatment
434 $subParams['id'] = $parentAPIValues[$subEntity . "_id"];
437 if (CRM_Utils_Array
::value('entity_table', $result['values'][$idIndex]) == $subEntity) {
438 $subParams['id'] = $result['values'][$idIndex]['entity_id'];
440 // if we are dealing with the same entity pass 'id' through (useful for get + delete for example)
441 if (strtolower($entity) == strtolower($subEntity)) {
442 $subParams['id'] = $result['values'][$idIndex]['id'];
446 $subParams['version'] = $version;
447 if(!empty($params['check_permissions'])){
448 $subParams['check_permissions'] = $params['check_permissions'];
450 $subParams['sequential'] = 1;
451 $subParams['api.has_parent'] = 1;
452 if (array_key_exists(0, $newparams)) {
453 // it is a numerically indexed array - ie. multiple creates
454 foreach ($newparams as $entity => $entityparams) {
455 $subParams = array_merge($subParams, $entityparams);
456 _civicrm_api_replace_variables($subAPI[1], $subaction, $subParams, $result['values'][$idIndex], $separator);
457 $result['values'][$result['id']][$field][] = civicrm_api($subEntity, $subaction, $subParams);
458 if ($result['is_error'] === 1) {
459 throw new Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
465 $subParams = array_merge($subParams, $newparams);
466 _civicrm_api_replace_variables($subAPI[1], $subaction, $subParams, $result['values'][$idIndex], $separator);
467 $result['values'][$idIndex][$field] = civicrm_api($subEntity, $subaction, $subParams);
468 if (!empty($result['is_error'])) {
469 throw new Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
475 if(strtolower($action) == 'getsingle'){
476 $result = $result['values'][0];
481 * Swap out any $values vars - ie. the value after $value is swapped for the parent $result
482 * 'activity_type_id' => '$value.testfield',
483 'tag_id' => '$value.api.tag.create.id',
484 'tag1_id' => '$value.api.entity.create.0.id'
486 function _civicrm_api_replace_variables($entity, $action, &$params, &$parentResult, $separator = '.') {
489 foreach ($params as $field => $value) {
491 if (is_string($value) && substr($value, 0, 6) == '$value') {
492 $valuesubstitute = substr($value, 7);
494 if (!empty($parentResult[$valuesubstitute])) {
495 $params[$field] = $parentResult[$valuesubstitute];
499 $stringParts = explode($separator, $value);
500 unset($stringParts[0]);
502 $fieldname = array_shift($stringParts);
504 //when our string is an array we will treat it as an array from that . onwards
505 $count = count($stringParts);
507 $fieldname .= "." . array_shift($stringParts);
508 if (array_key_exists($fieldname, $parentResult) && is_array($parentResult[$fieldname])) {
509 $arrayLocation = $parentResult[$fieldname];
510 foreach ($stringParts as $key => $value) {
511 $arrayLocation = CRM_Utils_Array
::value($value, $arrayLocation);
513 $params[$field] = $arrayLocation;
515 $count = count($stringParts);
523 * Convert possibly camel name to underscore separated entity name
525 * @param string $entity entity name in various formats e.g. Contribution, contribution, OptionValue, option_value, UFJoin, uf_join
526 * @return string $entity entity name in underscore separated format
528 * FIXME: Why isn't this called first thing in civicrm_api wrapper?
530 function _civicrm_api_get_entity_name_from_camel($entity) {
531 if ($entity == strtolower($entity)) {
535 $entity = ltrim(strtolower(str_replace('U_F',
537 // That's CamelCase, beside an odd UFCamel that is expected as uf_camel
538 preg_replace('/(?=[A-Z])/', '_$0', $entity)
545 * Having a DAO object find the entity name
546 * @param object $bao DAO being passed in
548 function _civicrm_api_get_entity_name_from_dao($bao){
549 $daoName = str_replace("BAO", "DAO", get_class($bao));
550 return _civicrm_api_get_entity_name_from_camel(CRM_Core_DAO_AllCoreTables
::getBriefName($daoName));
554 * Sets the tsLocale and dbLocale for multi-lingual sites.
555 * Some code duplication from CRM/Core/BAO/ConfigSetting.php retrieve()
556 * to avoid regressions from refactoring.
558 function _civicrm_api_set_locale($lcMessagesRequest) {
559 // We must validate whether the locale is valid, otherwise setting a bad
560 // dbLocale could probably lead to sql-injection.
561 $domain = new CRM_Core_DAO_Domain();
562 $domain->id
= CRM_Core_Config
::domainID();
565 if ($domain->config_backend
) {
566 $defaults = unserialize($domain->config_backend
);
568 // are we in a multi-language setup?
569 $multiLang = $domain->locales ?
TRUE : FALSE;
572 // on multi-lang sites based on request and civicrm_uf_match
574 $languageLimit = array();
575 if (array_key_exists('languageLimit', $defaults) && is_array($defaults['languageLimit'])) {
576 $languageLimit = $defaults['languageLimit'];
579 if (in_array($lcMessagesRequest, array_keys($languageLimit))) {
580 $lcMessages = $lcMessagesRequest;
583 throw new API_Exception(ts('Language not enabled: %1', array(1 => $lcMessagesRequest)));
589 // set suffix for table names - use views if more than one language
591 $dbLocale = $multiLang && $lcMessages ?
"_{$lcMessages}" : '';
593 // FIXME: an ugly hack to fix CRM-4041
595 $tsLocale = $lcMessages;