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     require_once 'CRM/Utils/File.php';
 209     if (CRM_Utils_File::isIncludable($stdFile)) {
 210       require_once $stdFile;
 211       if (function_exists($stdFunction)) {
 212         $cache[$cachekey] = array('function' => $stdFunction, 'is_generic' => FALSE);
 213         return $cache[$cachekey];
 214       }
 215     }
 216   }
 217
 218   // Determine if there is a generic implementation of the action
 219   require_once 'api/v3/Generic.php';
 220   # $genericFunction = 'civicrm_api3_generic_' . $apiRequest['action'];
 221   $genericFunction = civicrm_api_get_function_name('generic', $apiRequest['action'], $apiRequest['version']);
 222   $genericFiles = array(
 223     // By convention, the Generic.php is more likely to contain the function, so test it first
 224     'api/v' . $apiRequest['version'] . '/Generic.php',
 225     'api/v' . $apiRequest['version'] . '/Generic/' . $actionCamelName . '.php',
 226   );
 227   foreach ($genericFiles as $genericFile) {
 228     require_once 'CRM/Utils/File.php';
 229     if (CRM_Utils_File::isIncludable($genericFile)) {
 230       require_once $genericFile;
 231       if (function_exists($genericFunction)) {
 232         $cache[$cachekey] = array('function' => $genericFunction, 'is_generic' => TRUE);
 233         return $cache[$cachekey];
 234       }
 235     }
 236   }
 237
 238   $cache[$cachekey] = array('function' => FALSE, 'is_generic' => FALSE);
 239   return $cache[$cachekey];
 240 }
 241 /**
 242  * Version 3 wrapper for civicrm_api. Throws exception
 243  * @param string $entity type of entities to deal with
 244  * @param string $action create, get, delete or some special action name.
 245  * @param array $params array to be passed to function
 246  *
 247  * @return array
 248  *
 249  */
 250 function civicrm_api3($entity, $action, $params) {
 251   $params['version'] = 3;
 252   $result = civicrm_api($entity, $action, $params);
 253   if(is_array($result) && !empty($result['is_error'])){
 254     throw new CiviCRM_API3_Exception($result['error_message'], CRM_Utils_Array::value('error_code', $result, 'undefined'), $result);
 255   }
 256   return $result;
 257 }
 258
 259 /**
 260  * Load/require all files related to an entity.
 261  *
 262  * This should not normally be called because it's does a file-system scan; it's
 263  * only appropriate when introspection is really required (eg for "getActions").
 264  *
 265  * @param string $entity
 266  * @return void
 267  */
 268 function _civicrm_api_loadEntity($entity, $version = 3) {
 269   /*
 270   $apiRequest = array();
 271   $apiRequest['entity'] = $entity;
 272   $apiRequest['action'] = 'pretty sure it will never exist. Trick to [try to] force resolve to scan everywhere';
 273   $apiRequest['version'] = $version;
 274   // look up function, file, is_generic
 275   $apiRequest = _civicrm_api_resolve($apiRequest);
 276   */
 277
 278   $camelName = _civicrm_api_get_camel_name($entity, $version);
 279
 280   // Check for master entity file; to match _civicrm_api_resolve(), only load the first one
 281   require_once 'CRM/Utils/File.php';
 282   $stdFile = 'api/v' . $version . '/' . $camelName . '.php';
 283   if (CRM_Utils_File::isIncludable($stdFile)) {
 284     require_once $stdFile;
 285   }
 286
 287   // Check for standalone action files; to match _civicrm_api_resolve(), only load the first one
 288   $loaded_files = array(); // array($relativeFilePath => TRUE)
 289   $include_dirs = array_unique(explode(PATH_SEPARATOR, get_include_path()));
 290   foreach ($include_dirs as $include_dir) {
 291     $action_dir = implode(DIRECTORY_SEPARATOR, array($include_dir, 'api', "v${version}", $camelName));
 292     if (! is_dir($action_dir)) {
 293       continue;
 294     }
 295
 296     $iterator = new DirectoryIterator($action_dir);
 297     foreach ($iterator as $fileinfo) {
 298       $file = $fileinfo->getFilename();
 299       if (array_key_exists($file, $loaded_files)) {
 300         continue; // action provided by an earlier item on include_path
 301       }
 302
 303       $parts = explode(".", $file);
 304       if (end($parts) == "php" && !preg_match('/Tests?\.php$/', $file) ) {
 305         require_once $action_dir . DIRECTORY_SEPARATOR . $file;
 306         $loaded_files[$file] = TRUE;
 307       }
 308     }
 309   }
 310 }
 311
 312 /**
 313  *
 314  * @deprecated
 315  */
 316 function civicrm_api_get_function_name($entity, $action, $version = NULL) {
 317
 318   if (empty($version)) {
 319     $version = civicrm_get_api_version();
 320   }
 321
 322   $entity = _civicrm_api_get_entity_name_from_camel($entity);
 323   return 'civicrm_api3' . '_' . $entity . '_' . $action;
 324 }
 325
 326 /**
 327  * We must be sure that every request uses only one version of the API.
 328  *
 329  * @param $desired_version : array or integer
 330  *   One chance to set the version number.
 331  *   After that, this version number will be used for the remaining request.
 332  *   This can either be a number, or an array(.., 'version' => $version, ..).
 333  *   This allows to directly pass the $params array.
 334  */
 335 function civicrm_get_api_version($desired_version = NULL) {
 336
 337   if (is_array($desired_version)) {
 338     // someone gave the full $params array.
 339     $params = $desired_version;
 340     $desired_version = empty($params['version']) ? NULL : (int) $params['version'];
 341   }
 342   if (isset($desired_version) && is_integer($desired_version)) {
 343     $_version = $desired_version;
 344   }
 345   else {
 346     // we will set the default to version 3 as soon as we find that it works.
 347     $_version = 3;
 348   }
 349   return $_version;
 350 }
 351
 352 /**
 353  * Check if the result is an error. Note that this function has been retained from
 354  * api v2 for convenience but the result is more standardised in v3 and param
 355  * 'format.is_success' => 1
 356  * will result in a boolean success /fail being returned if that is what you need.
 357  *
 358  * @param  array   $params           (reference ) input parameters
 359  *
 360  * @return boolean true if error, false otherwise
 361  * @static void
 362  * @access public
 363  */
 364 function civicrm_error($result) {
 365   if (is_array($result)) {
 366     return (array_key_exists('is_error', $result) &&
 367       $result['is_error']
 368     ) ? TRUE : FALSE;
 369   }
 370   return FALSE;
 371 }
 372
 373 function _civicrm_api_get_camel_name($entity, $version = NULL) {
 374   static $_map = NULL;
 375
 376   if (empty($version)) {
 377     $version = civicrm_get_api_version();
 378   }
 379
 380   if (isset($_map[$version][strtolower($entity)])) {
 381     return $_map[$version][strtolower($entity)];
 382   }
 383
 384   $fragments = explode('_', $entity);
 385   foreach ($fragments as & $fragment) {
 386     $fragment = ucfirst($fragment);
 387   }
 388   // Special case: UFGroup, UFJoin, UFMatch, UFField
 389   if ($fragments[0] === 'Uf') {
 390     $fragments[0] = 'UF';
 391   }
 392   return implode('', $fragments);
 393 }
 394
 395 /**
 396  * Call any nested api calls
 397  */
 398 function _civicrm_api_call_nested_api(&$params, &$result, $action, $entity, $version) {
 399   $entity = _civicrm_api_get_entity_name_from_camel($entity);
 400   if(strtolower($action) == 'getsingle'){
 401     // I don't understand the protocol here, but we don't want
 402     // $result to be a recursive array
 403     // $result['values'][0] = $result;
 404     $oldResult = $result;
 405     $result = array('values' => array(0 => $oldResult));
 406   }
 407   foreach ($params as $field => $newparams) {
 408     if ((is_array($newparams) || $newparams === 1) && $field <> 'api.has_parent' && substr($field, 0, 3) == 'api') {
 409
 410       // 'api.participant.delete' => 1 is a valid options - handle 1 instead of an array
 411       if ($newparams === 1) {
 412         $newparams = array('version' => $version);
 413       }
 414       // can be api_ or api.
 415       $separator = $field[3];
 416       if (!($separator == '.' || $separator == '_')) {
 417         continue;
 418       }
 419       $subAPI = explode($separator, $field);
 420
 421       $subaction = empty($subAPI[2]) ? $action : $subAPI[2];
 422       $subParams = array(
 423         'debug' => CRM_Utils_Array::value('debug', $params),
 424       );
 425       $subEntity = $subAPI[1];
 426
 427       foreach ($result['values'] as $idIndex => $parentAPIValues) {
 428
 429         if (strtolower($subEntity) != 'contact') {
 430           //contact spits the dummy at activity_id so what else won't it like?
 431           //set entity_id & entity table based on the parent's id & entity. e.g for something like
 432           //note if the parent call is contact 'entity_table' will be set to 'contact' & 'id' to the contact id from
 433           //the parent call.
 434           //in this case 'contact_id' will also be set to the parent's id
 435           $subParams["entity_id"] = $parentAPIValues['id'];
 436           $subParams['entity_table'] = 'civicrm_' . _civicrm_api_get_entity_name_from_camel($entity);
 437           $subParams[strtolower($entity) . "_id"] = $parentAPIValues['id'];
 438         }
 439         if (strtolower($entity) != 'contact' && CRM_Utils_Array::value(strtolower($subEntity . "_id"), $parentAPIValues)) {
 440           //e.g. if event_id is in the values returned & subentity is event then pass in event_id as 'id'
 441           //don't do this for contact as it does some wierd things like returning primary email &
 442           //thus limiting the ability to chain email
 443           //TODO - this might need the camel treatment
 444           $subParams['id'] = $parentAPIValues[$subEntity . "_id"];
 445         }
 446
 447         if (CRM_Utils_Array::value('entity_table', $result['values'][$idIndex]) == $subEntity) {
 448           $subParams['id'] = $result['values'][$idIndex]['entity_id'];
 449         }
 450         // if we are dealing with the same entity pass 'id' through (useful for get + delete for example)
 451         if (strtolower($entity) == strtolower($subEntity)) {
 452           $subParams['id'] = $result['values'][$idIndex]['id'];
 453         }
 454
 455
 456         $subParams['version'] = $version;
 457         if(!empty($params['check_permissions'])){
 458           $subParams['check_permissions'] = $params['check_permissions'];
 459         }
 460         $subParams['sequential'] = 1;
 461         $subParams['api.has_parent'] = 1;
 462         if (array_key_exists(0, $newparams)) {
 463           // it is a numerically indexed array - ie. multiple creates
 464           foreach ($newparams as $entity => $entityparams) {
 465             $subParams = array_merge($subParams, $entityparams);
 466             _civicrm_api_replace_variables($subAPI[1], $subaction, $subParams, $result['values'][$idIndex], $separator);
 467             $result['values'][$result['id']][$field][] = civicrm_api($subEntity, $subaction, $subParams);
 468             if ($result['is_error'] === 1) {
 469               throw new Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
 470             }
 471           }
 472         }
 473         else {
 474
 475           $subParams = array_merge($subParams, $newparams);
 476           _civicrm_api_replace_variables($subAPI[1], $subaction, $subParams, $result['values'][$idIndex], $separator);
 477           $result['values'][$idIndex][$field] = civicrm_api($subEntity, $subaction, $subParams);
 478           if (!empty($result['is_error'])) {
 479             throw new Exception($subEntity . ' ' . $subaction . 'call failed with' . $result['error_message']);
 480           }
 481         }
 482       }
 483     }
 484   }
 485   if(strtolower($action) == 'getsingle'){
 486     $result = $result['values'][0];
 487   }
 488 }
 489
 490 /**
 491  * Swap out any $values vars - ie. the value after $value is swapped for the parent $result
 492  * 'activity_type_id' => '$value.testfield',
 493    'tag_id'  => '$value.api.tag.create.id',
 494     'tag1_id' => '$value.api.entity.create.0.id'
 495  */
 496 function _civicrm_api_replace_variables($entity, $action, &$params, &$parentResult, $separator = '.') {
 497
 498
 499   foreach ($params as $field => $value) {
 500
 501     if (is_string($value) && substr($value, 0, 6) == '$value') {
 502       $valuesubstitute = substr($value, 7);
 503
 504       if (!empty($parentResult[$valuesubstitute])) {
 505         $params[$field] = $parentResult[$valuesubstitute];
 506       }
 507       else {
 508
 509         $stringParts = explode($separator, $value);
 510         unset($stringParts[0]);
 511
 512         $fieldname = array_shift($stringParts);
 513
 514         //when our string is an array we will treat it as an array from that . onwards
 515         $count = count($stringParts);
 516         while ($count > 0) {
 517           $fieldname .= "." . array_shift($stringParts);
 518           if (array_key_exists($fieldname, $parentResult) && is_array($parentResult[$fieldname])) {
 519             $arrayLocation = $parentResult[$fieldname];
 520             foreach ($stringParts as $key => $value) {
 521               $arrayLocation = CRM_Utils_Array::value($value, $arrayLocation);
 522             }
 523             $params[$field] = $arrayLocation;
 524           }
 525           $count = count($stringParts);
 526         }
 527       }
 528     }
 529   }
 530 }
 531
 532 /**
 533  * Convert possibly camel name to underscore separated entity name
 534  *
 535  * @param string $entity entity name in various formats e.g. Contribution, contribution, OptionValue, option_value, UFJoin, uf_join
 536  * @return string $entity entity name in underscore separated format
 537  *
 538  * FIXME: Why isn't this called first thing in civicrm_api wrapper?
 539  */
 540 function _civicrm_api_get_entity_name_from_camel($entity) {
 541   if ($entity == strtolower($entity)) {
 542     return $entity;
 543   }
 544   else {
 545     $entity = ltrim(strtolower(str_replace('U_F',
 546           'uf',
 547           // That's CamelCase, beside an odd UFCamel that is expected as uf_camel
 548           preg_replace('/(?=[A-Z])/', '_$0', $entity)
 549         )), '_');
 550   }
 551   return $entity;
 552 }
 553
 554 /**
 555  * Having a DAO object find the entity name
 556  * @param object $bao DAO being passed in
 557  */
 558 function _civicrm_api_get_entity_name_from_dao($bao){
 559   $daoName = str_replace("BAO", "DAO", get_class($bao));
 560   $dao = array();
 561   require ('CRM/Core/DAO/listAll.php');
 562   $daos = array_flip($dao);
 563   return _civicrm_api_get_entity_name_from_camel($daos[$daoName]);
 564
 565 }
 566
 567
 568 /**
 569  * Sets the tsLocale and dbLocale for multi-lingual sites.
 570  * Some code duplication from CRM/Core/BAO/ConfigSetting.php retrieve()
 571  * to avoid regressions from refactoring.
 572  */
 573 function _civicrm_api_set_locale($lcMessagesRequest) {
 574   // We must validate whether the locale is valid, otherwise setting a bad
 575   // dbLocale could probably lead to sql-injection.
 576   $domain = new CRM_Core_DAO_Domain();
 577   $domain->id = CRM_Core_Config::domainID();
 578   $domain->find(TRUE);
 579
 580   if ($domain->config_backend) {
 581     $defaults = unserialize($domain->config_backend);
 582
 583     // are we in a multi-language setup?
 584     $multiLang = $domain->locales ? TRUE : FALSE;
 585     $lcMessages = NULL;
 586
 587     // on multi-lang sites based on request and civicrm_uf_match
 588     if ($multiLang) {
 589       $languageLimit = array();
 590       if (array_key_exists('languageLimit', $defaults) && is_array($defaults['languageLimit'])) {
 591         $languageLimit = $defaults['languageLimit'];
 592       }
 593
 594       if (in_array($lcMessagesRequest, array_keys($languageLimit))) {
 595         $lcMessages = $lcMessagesRequest;
 596       }
 597       else {
 598         throw new API_Exception(ts('Language not enabled: %1', array(1 => $lcMessagesRequest)));
 599       }
 600     }
 601
 602     global $dbLocale;
 603
 604     // set suffix for table names - use views if more than one language
 605     if ($lcMessages) {
 606       $dbLocale = $multiLang && $lcMessages ? "_{$lcMessages}" : '';
 607
 608       // FIXME: an ugly hack to fix CRM-4041
 609       global $tsLocale;
 610       $tsLocale = $lcMessages;
 611     }
 612   }
 613 }