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