api/api.php

   1 <?php
   2
   3 /**
   4  * File for the CiviCRM APIv3 API wrapper
   5  *
   6  * @package CiviCRM_APIv3
   7  * @subpackage API
   8  *
   9  * @copyright CiviCRM LLC (c) 2004-2013
  10  * @version $Id: api.php 30486 2010-11-02 16:12:09Z shot $
  11  */
  12
  13 /**
  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
  20  */
  21 function civicrm_api($entity, $action, $params, $extra = NULL) {
  22   $apiWrappers = array(CRM_Core_HTMLInputCoder::singleton());
  23   try {
  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);
  28     }
  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();
  42     }
  43
  44     // support multi-lingual requests
  45     if ($language = CRM_Utils_Array::value('option.language', $params)) {
  46       _civicrm_api_set_locale($language);
  47     }
  48
  49     _civicrm_api3_api_check_permission($apiRequest['entity'], $apiRequest['action'], $apiRequest['params']);
  50
  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']);
  56       }
  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));
  59     }
  60
  61     foreach ($apiWrappers as $apiWrapper) {
  62       $apiRequest = $apiWrapper->fromApiInput($apiRequest);
  63     }
  64
  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);
  71     }
  72     elseif ($apiRequest['function'] && !$apiRequest['is_generic']) {
  73       _civicrm_api3_validate_fields($apiRequest['entity'], $apiRequest['action'], $apiRequest['params']);
  74
  75       $result = isset($extra) ? $function($apiRequest['params'], $extra) : $function($apiRequest['params']);
  76     }
  77     else {
  78       return civicrm_api3_create_error("API (" . $apiRequest['entity'] . "," . $apiRequest['action'] . ") does not exist (join the API team and implement it!)");
  79     }
  80
  81     foreach ($apiWrappers as $apiWrapper) {
  82       $result = $apiWrapper->toApiOutput($apiRequest, $result);
  83     }
  84
  85     if (CRM_Utils_Array::value('format.is_success', $apiRequest['params']) == 1) {
  86       if ($result['is_error'] === 0) {
  87         return 1;
  88       }
  89       else {
  90         return 0;
  91       }
  92     }
  93     if (CRM_Utils_Array::value('format.only_id', $apiRequest['params']) && isset($result['id'])) {
  94       return $result['id'];
  95     }
  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']);
  98     }
  99     if (function_exists('xdebug_time_index')
 100       && CRM_Utils_Array::value('debug', $apiRequest['params'])
 101       // result would not be an array for getvalue
 102       && is_array($result)
 103     ) {
 104       $result['xdebug']['peakMemory'] = xdebug_peak_memory_usage();
 105       $result['xdebug']['memory'] = xdebug_memory_usage();
 106       $result['xdebug']['timeIndex'] = xdebug_time_index();
 107     }
 108
 109     return $result;
 110   }
 111   catch(PEAR_Exception $e) {
 112     if (CRM_Utils_Array::value('format.is_success', $apiRequest['params']) == 1) {
 113       return 0;
 114     }
 115     $error = $e->getCause();
 116     if ($error instanceof DB_Error) {
 117       $data["error_code"] = DB::errorMessage($error->getCode());
 118       $data["sql"] = $error->getDebugInfo();
 119     }
 120     if (CRM_Utils_Array::value('debug', $apiRequest['params'])) {
 121       $data['debug_info'] = $error->getUserInfo();
 122       $data['trace'] = $e->getTraceAsString();
 123     }
 124     else{
 125       $data['tip'] = "add debug=1 to your API call to have more info about the error";
 126     }
 127     $err = civicrm_api3_create_error($e->getMessage(), $data, $apiRequest);
 128     if (CRM_Utils_Array::value('is_transactional', $apiRequest)) {
 129       $transaction->rollback();
 130     }
 131     return $err;
 132   }
 133   catch (API_Exception $e){
 134     if(!isset($apiRequest)){
 135       $apiRequest = array();
 136     }
 137     if (CRM_Utils_Array::value('format.is_success', CRM_Utils_Array::value('params',$apiRequest)) == 1) {
 138       return 0;
 139     }
 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
 146     ) {
 147       $err['trace'] = $e->getTraceAsString();
 148     }
 149     if (CRM_Utils_Array::value('is_transactional', $apiRequest)) {
 150       $transaction->rollback();
 151     }
 152     return $err;
 153   }
 154   catch(Exception $e) {
 155     if (CRM_Utils_Array::value('format.is_success', $apiRequest['params']) == 1) {
 156       return 0;
 157     }
 158     $data = array();
 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();
 162     }
 163     if (CRM_Utils_Array::value('is_transactional', $apiRequest)) {
 164       $transaction->rollback();
 165     }
 166     return $err;
 167   }
 168 }
 169
 170 /**
 171  * Look up the implementation for a given API request
 172  *
 173  * @param $apiRequest array with keys:
 174  *  - entity: string, required
 175  *  - action: string, required
 176  *  - params: array
 177  *  - version: scalar, required
 178  *
 179  * @return array with keys
 180  *  - function: callback (mixed)
 181  *  - is_generic: boolean
 182  */
 183 function _civicrm_api_resolve($apiRequest) {
 184   static $cache;
 185   $cachekey = strtolower($apiRequest['entity']) . ':' . strtolower($apiRequest['action']) . ':' . $apiRequest['version'];
 186   if (isset($cache[$cachekey])) {
 187     return $cache[$cachekey];
 188   }
 189
 190   $camelName = _civicrm_api_get_camel_name($apiRequest['entity'], $apiRequest['version']);
 191   $actionCamelName = _civicrm_api_get_camel_name($apiRequest['action']);
 192
 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];
 200   }
 201
 202   $stdFiles = array(
 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',
 206   );
 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];
 213       }
 214     }
 215   }
 216
 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',
 225   );
 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];
 232       }
 233     }
 234   }
 235
 236   $cache[$cachekey] = array('function' => FALSE, 'is_generic' => FALSE);
 237   return $cache[$cachekey];
 238 }
 239
 240 /**
 241  * Load/require all files related to an entity.
 242  *
 243  * This should not normally be called because it's does a file-system scan; it's
 244  * only appropriate when introspection is really required (eg for "getActions").
 245  *
 246  * @param string $entity
 247  * @return void
 248  */
 249 function _civicrm_api_loadEntity($entity, $version = 3) {
 250   /*
 251   $apiRequest = array();
 252   $apiRequest['entity'] = $entity;
 253   $apiRequest['action'] = 'pretty sure it will never exist. Trick to [try to] force resolve to scan everywhere';
 254   $apiRequest['version'] = $version;
 255   // look up function, file, is_generic
 256   $apiRequest = _civicrm_api_resolve($apiRequest);
 257   */
 258
 259   $camelName = _civicrm_api_get_camel_name($entity, $version);
 260
 261   // Check for master entity file; to match _civicrm_api_resolve(), only load the first one
 262   $stdFile = 'api/v' . $version . '/' . $camelName . '.php';
 263   if (CRM_Utils_File::isIncludable($stdFile)) {
 264     require_once $stdFile;
 265   }
 266
 267   // Check for standalone action files; to match _civicrm_api_resolve(), only load the first one
 268   $loaded_files = array(); // array($relativeFilePath => TRUE)
 269   $include_dirs = array_unique(explode(PATH_SEPARATOR, get_include_path()));
 270   foreach ($include_dirs as $include_dir) {
 271     $action_dir = implode(DIRECTORY_SEPARATOR, array($include_dir, 'api', "v${version}", $camelName));
 272     if (! is_dir($action_dir)) {
 273       continue;
 274     }
 275
 276     $iterator = new DirectoryIterator($action_dir);
 277     foreach ($iterator as $fileinfo) {
 278       $file = $fileinfo->getFilename();
 279       if (array_key_exists($file, $loaded_files)) {
 280         continue; // action provided by an earlier item on include_path
 281       }
 282
 283       $parts = explode(".", $file);
 284       if (end($parts) == "php" && !preg_match('/Tests?\.php$/', $file) ) {
 285         require_once $action_dir . DIRECTORY_SEPARATOR . $file;
 286         $loaded_files[$file] = TRUE;
 287       }
 288     }
 289   }
 290 }
 291
 292 /**
 293  *
 294  * @deprecated
 295  */
 296 function civicrm_api_get_function_name($entity, $action, $version = NULL) {
 297
 298   if (empty($version)) {
 299     $version = civicrm_get_api_version();
 300   }
 301
 302   $entity = _civicrm_api_get_entity_name_from_camel($entity);
 303   return 'civicrm_api3' . '_' . $entity . '_' . $action;
 304 }
 305
 306 /**
 307  * We must be sure that every request uses only one version of the API.
 308  *
 309  * @param $desired_version : array or integer
 310  *   One chance to set the version number.
 311  *   After that, this version number will be used for the remaining request.
 312  *   This can either be a number, or an array(.., 'version' => $version, ..).
 313  *   This allows to directly pass the $params array.
 314  */
 315 function civicrm_get_api_version($desired_version = NULL) {
 316
 317   if (is_array($desired_version)) {
 318     // someone gave the full $params array.
 319     $params = $desired_version;
 320     $desired_version = empty($params['version']) ? NULL : (int) $params['version'];
 321   }
 322   if (isset($desired_version) && is_integer($desired_version)) {
 323     $_version = $desired_version;
 324   }
 325   else {
 326     // we will set the default to version 3 as soon as we find that it works.
 327     $_version = 3;
 328   }
 329   return $_version;
 330 }
 331
 332 /**
 333  * Check if the result is an error. Note that this function has been retained from
 334  * api v2 for convenience but the result is more standardised in v3 and param
 335  * 'format.is_success' => 1
 336  * will result in a boolean success /fail being returned if that is what you need.
 337  *
 338  * @param  array   $params           (reference ) input parameters
 339  *
 340  * @return boolean true if error, false otherwise
 341  * @static void
 342  * @access public
 343  */
 344 function civicrm_error($result) {
 345   if (is_array($result)) {
 346     return (array_key_exists('is_error', $result) &&
 347       $result['is_error']
 348     ) ? TRUE : FALSE;
 349   }
 350   return FALSE;
 351 }
 352
 353 function _civicrm_api_get_camel_name($entity, $version = NULL) {
 354   if (empty($version)) {
 355     $version = civicrm_get_api_version();
 356   }
 357
 358   $fragments = explode('_', $entity);
 359   foreach ($fragments as & $fragment) {
 360     $fragment = ucfirst($fragment);
 361   }
 362   // Special case: UFGroup, UFJoin, UFMatch, UFField
 363   if ($fragments[0] === 'Uf') {
 364     $fragments[0] = 'UF';
 365   }
 366   return implode('', $fragments);
 367 }
 368
 369 /**
 370  * Call any nested api calls
 371  */
 372 function _civicrm_api_call_nested_api(&$params, &$result, $action, $entity, $version) {
 373   $entity = _civicrm_api_get_entity_name_from_camel($entity);
 374   if(strtolower($action) == 'getsingle'){
 375     // I don't understand the protocol here, but we don't want
 376     // $result to be a recursive array
 377     // $result['values'][0] = $result;
 378     $oldResult = $result;
 379     $result = array('values' => array(0 => $oldResult));
 380   }
 381   foreach ($params as $field => $newparams) {
 382     if ((is_array($newparams) || $newparams === 1) && $field <> 'api.has_parent' && substr($field, 0, 3) == 'api') {
 383
 384       // 'api.participant.delete' => 1 is a valid options - handle 1 instead of an array
 385       if ($newparams === 1) {
 386         $newparams = array('version' => $version);
 387       }
 388       // can be api_ or api.
 389       $separator = $field[3];
 390       if (!($separator == '.' || $separator == '_')) {
 391         continue;
 392       }
 393       $subAPI = explode($separator, $field);
 394
 395       $subaction = empty($subAPI[2]) ? $action : $subAPI[2];
 396       $subParams = array(
 397         'debug' => CRM_Utils_Array::value('debug', $params),
 398       );
 399       $subEntity = $subAPI[1];
 400
 401       foreach ($result['values'] as $idIndex => $parentAPIValues) {
 402
 403         if (strtolower($subEntity) != 'contact') {
 404           //contact spits the dummy at activity_id so what else won't it like?
 405           //set entity_id & entity table based on the parent's id & entity. e.g for something like
 406           //note if the parent call is contact 'entity_table' will be set to 'contact' & 'id' to the contact id from
 407           //the parent call.
 408           //in this case 'contact_id' will also be set to the parent's id
 409           $subParams["entity_id"] = $parentAPIValues['id'];
 410           $subParams['entity_table'] = 'civicrm_' . _civicrm_api_get_entity_name_from_camel($entity);
 411           $subParams[strtolower($entity) . "_id"] = $parentAPIValues['id'];
 412         }
 413         if (strtolower($entity) != 'contact' && CRM_Utils_Array::value(strtolower($subEntity . "_id"), $parentAPIValues)) {
 414           //e.g. if event_id is in the values returned & subentity is event then pass in event_id as 'id'
 415           //don't do this for contact as it does some wierd things like returning primary email &
 416           //thus limiting the ability to chain email
 417           //TODO - this might need the camel treatment
 418           $subParams['id'] = $parentAPIValues[$subEntity . "_id"];
 419         }
 420
 421         if (CRM_Utils_Array::value('entity_table', $result['values'][$idIndex]) == $subEntity) {
 422           $subParams['id'] = $result['values'][$idIndex]['entity_id'];
 423         }
 424         // if we are dealing with the same entity pass 'id' through (useful for get + delete for example)
 425         if (strtolower($entity) == strtolower($subEntity)) {
 426           $subParams['id'] = $result['values'][$idIndex]['id'];
 427         }
 428
 429
 430         $subParams['version'] = $version;
 431         if(!empty($params['check_permissions'])){
 432           $subParams['check_permissions'] = $params['check_permissions'];
 433         }
 434         $subParams['sequential'] = 1;
 435         $subParams['api.has_parent'] = 1;
 436         if (array_key_exists(0, $newparams)) {
 437           // it is a numerically indexed array - ie. multiple creates
 438           foreach ($newparams as $entity => $entityparams) {
 439             $subParams = array_merge($subParams, $entityparams);
 440             _civicrm_api_replace_variables($subAPI[1], $subaction, $subParams, $result['values'][$idIndex], $separator);
 441             $result['values'][$result['id']][$field][] = civicrm_api($subEntity, $subaction, $subParams);
 442             if ($result['is_error'] === 1) {
 443               throw new Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
 444             }
 445           }
 446         }
 447         else {
 448
 449           $subParams = array_merge($subParams, $newparams);
 450           _civicrm_api_replace_variables($subAPI[1], $subaction, $subParams, $result['values'][$idIndex], $separator);
 451           $result['values'][$idIndex][$field] = civicrm_api($subEntity, $subaction, $subParams);
 452           if (!empty($result['is_error'])) {
 453             throw new Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
 454           }
 455         }
 456       }
 457     }
 458   }
 459   if(strtolower($action) == 'getsingle'){
 460     $result = $result['values'][0];
 461   }
 462 }
 463
 464 /**
 465  * Swap out any $values vars - ie. the value after $value is swapped for the parent $result
 466  * 'activity_type_id' => '$value.testfield',
 467    'tag_id'  => '$value.api.tag.create.id',
 468     'tag1_id' => '$value.api.entity.create.0.id'
 469  */
 470 function _civicrm_api_replace_variables($entity, $action, &$params, &$parentResult, $separator = '.') {
 471
 472
 473   foreach ($params as $field => $value) {
 474
 475     if (is_string($value) && substr($value, 0, 6) == '$value') {
 476       $valuesubstitute = substr($value, 7);
 477
 478       if (!empty($parentResult[$valuesubstitute])) {
 479         $params[$field] = $parentResult[$valuesubstitute];
 480       }
 481       else {
 482
 483         $stringParts = explode($separator, $value);
 484         unset($stringParts[0]);
 485
 486         $fieldname = array_shift($stringParts);
 487
 488         //when our string is an array we will treat it as an array from that . onwards
 489         $count = count($stringParts);
 490         while ($count > 0) {
 491           $fieldname .= "." . array_shift($stringParts);
 492           if (array_key_exists($fieldname, $parentResult) && is_array($parentResult[$fieldname])) {
 493             $arrayLocation = $parentResult[$fieldname];
 494             foreach ($stringParts as $key => $value) {
 495               $arrayLocation = CRM_Utils_Array::value($value, $arrayLocation);
 496             }
 497             $params[$field] = $arrayLocation;
 498           }
 499           $count = count($stringParts);
 500         }
 501       }
 502     }
 503   }
 504 }
 505
 506 /**
 507  * Convert possibly camel name to underscore separated entity name
 508  *
 509  * @param string $entity entity name in various formats e.g. Contribution, contribution, OptionValue, option_value, UFJoin, uf_join
 510  * @return string $entity entity name in underscore separated format
 511  *
 512  * FIXME: Why isn't this called first thing in civicrm_api wrapper?
 513  */
 514 function _civicrm_api_get_entity_name_from_camel($entity) {
 515   if ($entity == strtolower($entity)) {
 516     return $entity;
 517   }
 518   else {
 519     $entity = ltrim(strtolower(str_replace('U_F',
 520           'uf',
 521           // That's CamelCase, beside an odd UFCamel that is expected as uf_camel
 522           preg_replace('/(?=[A-Z])/', '_$0', $entity)
 523         )), '_');
 524   }
 525   return $entity;
 526 }
 527
 528 /**
 529  * Having a DAO object find the entity name
 530  * @param object $bao DAO being passed in
 531  */
 532 function _civicrm_api_get_entity_name_from_dao($bao){
 533   $daoName = str_replace("BAO", "DAO", get_class($bao));
 534   return _civicrm_api_get_entity_name_from_camel(CRM_Core_DAO_AllCoreTables::getBriefName($daoName));
 535 }
 536
 537 /**
 538  * Sets the tsLocale and dbLocale for multi-lingual sites.
 539  * Some code duplication from CRM/Core/BAO/ConfigSetting.php retrieve()
 540  * to avoid regressions from refactoring.
 541  */
 542 function _civicrm_api_set_locale($lcMessagesRequest) {
 543   // We must validate whether the locale is valid, otherwise setting a bad
 544   // dbLocale could probably lead to sql-injection.
 545   $domain = new CRM_Core_DAO_Domain();
 546   $domain->id = CRM_Core_Config::domainID();
 547   $domain->find(TRUE);
 548
 549   if ($domain->config_backend) {
 550     $defaults = unserialize($domain->config_backend);
 551
 552     // are we in a multi-language setup?
 553     $multiLang = $domain->locales ? TRUE : FALSE;
 554     $lcMessages = NULL;
 555
 556     // on multi-lang sites based on request and civicrm_uf_match
 557     if ($multiLang) {
 558       $languageLimit = array();
 559       if (array_key_exists('languageLimit', $defaults) && is_array($defaults['languageLimit'])) {
 560         $languageLimit = $defaults['languageLimit'];
 561       }
 562
 563       if (in_array($lcMessagesRequest, array_keys($languageLimit))) {
 564         $lcMessages = $lcMessagesRequest;
 565       }
 566       else {
 567         throw new API_Exception(ts('Language not enabled: %1', array(1 => $lcMessagesRequest)));
 568       }
 569     }
 570
 571     global $dbLocale;
 572
 573     // set suffix for table names - use views if more than one language
 574     if ($lcMessages) {
 575       $dbLocale = $multiLang && $lcMessages ? "_{$lcMessages}" : '';
 576
 577       // FIXME: an ugly hack to fix CRM-4041
 578       global $tsLocale;
 579       $tsLocale = $lcMessages;
 580     }
 581   }
 582 }