Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | class CRM_Core_I18n { | |
18 | ||
07844ccf SV |
19 | /** |
20 | * Constants for communication preferences. | |
21 | * | |
22 | * @var int | |
23 | */ | |
24 | const NONE = 'none', AUTO = 'auto'; | |
25 | ||
2c4bba53 | 26 | /** |
e97c66ff | 27 | * @var callable|null |
2c4bba53 TO |
28 | * A callback function which handles SQL string encoding. |
29 | * Set NULL to use the default, CRM_Core_DAO::escapeString(). | |
30 | * This is used by `ts(..., [escape=>sql])`. | |
31 | * | |
32 | * This option is not intended for general consumption. It is only intended | |
33 | * for certain pre-boot/pre-install contexts. | |
34 | * | |
35 | * You might ask, "Why on Earth does string-translation have an opinion on | |
36 | * SQL escaping?" Good question! | |
37 | */ | |
38 | public static $SQL_ESCAPER = NULL; | |
39 | ||
40 | /** | |
33c6d76d | 41 | * Escape a string if a mode is specified, otherwise return string unmodified. |
2c4bba53 TO |
42 | * |
43 | * @param string $text | |
33c6d76d | 44 | * @param string $mode |
2c4bba53 TO |
45 | * @return string |
46 | */ | |
33c6d76d CW |
47 | protected static function escape($text, $mode) { |
48 | switch ($mode) { | |
49 | case 'sql': | |
50 | if (self::$SQL_ESCAPER == NULL) { | |
51 | return CRM_Core_DAO::escapeString($text); | |
52 | } | |
53 | else { | |
54 | return call_user_func(self::$SQL_ESCAPER, $text); | |
55 | } | |
56 | ||
57 | case 'js': | |
58 | return substr(json_encode($text, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT), 1, -1); | |
2c4bba53 | 59 | } |
33c6d76d | 60 | return $text; |
2c4bba53 | 61 | } |
07844ccf | 62 | |
6a488035 | 63 | /** |
2ba175b6 DL |
64 | * A PHP-gettext instance for string translation; |
65 | * should stay null if the strings are not to be translated (en_US). | |
518fa0ee | 66 | * @var object |
6a488035 TO |
67 | */ |
68 | private $_phpgettext = NULL; | |
69 | ||
70 | /** | |
71 | * Whether we are using native gettext or not. | |
518fa0ee | 72 | * @var bool |
6a488035 TO |
73 | */ |
74 | private $_nativegettext = FALSE; | |
75 | ||
74eb462f ML |
76 | /** |
77 | * Gettext cache for extension domains/streamers, depending on if native or phpgettext. | |
78 | * - native gettext: we cache the value for textdomain() | |
79 | * - phpgettext: we cache the file streamer. | |
518fa0ee | 80 | * @var array |
74eb462f | 81 | */ |
be2fb01f | 82 | private $_extensioncache = []; |
74eb462f | 83 | |
0d096477 TO |
84 | /** |
85 | * @var string | |
86 | */ | |
87 | private $locale; | |
88 | ||
6a488035 TO |
89 | /** |
90 | * A locale-based constructor that shouldn't be called from outside of this class (use singleton() instead). | |
91 | * | |
5a4f6742 CW |
92 | * @param string $locale |
93 | * the base of this certain object's existence. | |
6a488035 | 94 | * |
77b97be7 | 95 | * @return \CRM_Core_I18n |
6a488035 | 96 | */ |
00be9182 | 97 | public function __construct($locale) { |
0d096477 | 98 | $this->locale = $locale; |
6a488035 | 99 | if ($locale != '' and $locale != 'en_US') { |
6a488035 TO |
100 | if (defined('CIVICRM_GETTEXT_NATIVE') && CIVICRM_GETTEXT_NATIVE && function_exists('gettext')) { |
101 | // Note: the file hierarchy for .po must be, for example: l10n/fr_FR/LC_MESSAGES/civicrm.mo | |
102 | ||
103 | $this->_nativegettext = TRUE; | |
c86241f4 | 104 | $this->setNativeGettextLocale($locale); |
6a488035 TO |
105 | return; |
106 | } | |
107 | ||
108 | // Otherwise, use PHP-gettext | |
c86241f4 | 109 | $this->setPhpGettextLocale($locale); |
6a488035 TO |
110 | } |
111 | } | |
112 | ||
113 | /** | |
114 | * Returns whether gettext is running natively or using PHP-Gettext. | |
115 | * | |
a6c01b45 CW |
116 | * @return bool |
117 | * True if gettext is native | |
6a488035 | 118 | */ |
00be9182 | 119 | public function isNative() { |
6a488035 TO |
120 | return $this->_nativegettext; |
121 | } | |
122 | ||
f2ac86d1 | 123 | /** |
124 | * Set native locale for getText. | |
125 | * | |
126 | * @param string $locale | |
127 | */ | |
c86241f4 SV |
128 | protected function setNativeGettextLocale($locale) { |
129 | ||
130 | $locale .= '.utf8'; | |
131 | putenv("LANG=$locale"); | |
132 | ||
133 | // CRM-11833 Avoid LC_ALL because of LC_NUMERIC and potential DB error. | |
134 | setlocale(LC_TIME, $locale); | |
135 | setlocale(LC_MESSAGES, $locale); | |
136 | setlocale(LC_CTYPE, $locale); | |
137 | ||
138 | bindtextdomain('civicrm', CRM_Core_I18n::getResourceDir()); | |
139 | bind_textdomain_codeset('civicrm', 'UTF-8'); | |
140 | textdomain('civicrm'); | |
141 | ||
142 | $this->_phpgettext = new CRM_Core_I18n_NativeGettext(); | |
143 | $this->_extensioncache['civicrm'] = 'civicrm'; | |
144 | ||
145 | } | |
146 | ||
f2ac86d1 | 147 | /** |
148 | * Set getText locale. | |
149 | * | |
150 | * @param string $locale | |
151 | */ | |
c86241f4 SV |
152 | protected function setPhpGettextLocale($locale) { |
153 | ||
154 | // we support both the old file hierarchy format and the new: | |
155 | // pre-4.5: civicrm/l10n/xx_XX/civicrm.mo | |
156 | // post-4.5: civicrm/l10n/xx_XX/LC_MESSAGES/civicrm.mo | |
157 | require_once 'PHPgettext/streams.php'; | |
158 | require_once 'PHPgettext/gettext.php'; | |
159 | ||
160 | $mo_file = CRM_Core_I18n::getResourceDir() . $locale . DIRECTORY_SEPARATOR . 'LC_MESSAGES' . DIRECTORY_SEPARATOR . 'civicrm.mo'; | |
161 | ||
162 | if (!file_exists($mo_file)) { | |
163 | // fallback to pre-4.5 mode | |
164 | $mo_file = CRM_Core_I18n::getResourceDir() . $locale . DIRECTORY_SEPARATOR . 'civicrm.mo'; | |
165 | } | |
166 | ||
167 | $streamer = new FileReader($mo_file); | |
168 | $this->_phpgettext = new gettext_reader($streamer); | |
169 | $this->_extensioncache['civicrm'] = $this->_phpgettext; | |
170 | ||
171 | } | |
172 | ||
6a488035 TO |
173 | /** |
174 | * Return languages available in this instance of CiviCRM. | |
175 | * | |
5a4f6742 CW |
176 | * @param bool $justEnabled |
177 | * whether to return all languages or just the enabled ones. | |
6a488035 | 178 | * |
a6c01b45 | 179 | * @return array |
16b10e64 | 180 | * Array of code/language name mappings |
6a488035 | 181 | */ |
00be9182 | 182 | public static function languages($justEnabled = FALSE) { |
6a488035 TO |
183 | static $all = NULL; |
184 | static $enabled = NULL; | |
185 | ||
186 | if (!$all) { | |
c0c9cd82 | 187 | $all = CRM_Contact_BAO_Contact::buildOptions('preferred_language'); |
6a488035 | 188 | |
ece6501c | 189 | // get labels |
be2fb01f CW |
190 | $rows = []; |
191 | $labels = []; | |
192 | CRM_Core_OptionValue::getValues(['name' => 'languages'], $rows); | |
ece6501c ML |
193 | foreach ($rows as $id => $row) { |
194 | $labels[$row['name']] = $row['label']; | |
195 | } | |
196 | ||
6a488035 | 197 | // check which ones are available; add them to $all if not there already |
be2fb01f | 198 | $codes = []; |
4d8ce7f0 | 199 | if (is_dir(CRM_Core_I18n::getResourceDir()) && $dir = opendir(CRM_Core_I18n::getResourceDir())) { |
6a488035 TO |
200 | while ($filename = readdir($dir)) { |
201 | if (preg_match('/^[a-z][a-z]_[A-Z][A-Z]$/', $filename)) { | |
202 | $codes[] = $filename; | |
203 | if (!isset($all[$filename])) { | |
8a0dba7b | 204 | $all[$filename] = $labels[$filename] ?? "($filename)"; |
6a488035 TO |
205 | } |
206 | } | |
207 | } | |
208 | closedir($dir); | |
209 | } | |
210 | ||
211 | // drop the unavailable languages (except en_US) | |
212 | foreach (array_keys($all) as $code) { | |
213 | if ($code == 'en_US') { | |
214 | continue; | |
215 | } | |
408b79bf | 216 | if (!in_array($code, $codes)) { |
217 | unset($all[$code]); | |
218 | } | |
6a488035 | 219 | } |
ece6501c | 220 | |
921ed8ae | 221 | asort($all); |
6a488035 TO |
222 | } |
223 | ||
224 | if ($enabled === NULL) { | |
cc493f5e | 225 | $languageLimit = Civi::settings()->get('languageLimit'); |
be2fb01f | 226 | $enabled = []; |
cc493f5e | 227 | if ($languageLimit) { |
6a488035 | 228 | foreach ($all as $code => $name) { |
cc493f5e | 229 | if (array_key_exists($code, $languageLimit)) { |
6a488035 TO |
230 | $enabled[$code] = $name; |
231 | } | |
232 | } | |
233 | } | |
234 | } | |
235 | ||
236 | return $justEnabled ? $enabled : $all; | |
237 | } | |
238 | ||
921ed8ae AS |
239 | /** |
240 | * Return the available UI languages | |
518fa0ee SL |
241 | * @return array|string |
242 | * array(string languageCode => string languageName) if !$justCodes | |
921ed8ae AS |
243 | */ |
244 | public static function uiLanguages($justCodes = FALSE) { | |
245 | // In multilang we only allow the languages that are configured in db | |
246 | // Otherwise, the languages configured in uiLanguages | |
247 | $settings = Civi::settings(); | |
248 | if (CRM_Core_I18n::isMultiLingual()) { | |
249 | $codes = array_keys((array) $settings->get('languageLimit')); | |
250 | } | |
251 | else { | |
252 | $codes = $settings->get('uiLanguages'); | |
253 | if (!$codes) { | |
254 | $codes = [$settings->get('lcMessages')]; | |
255 | } | |
256 | } | |
257 | return $justCodes ? $codes | |
258 | : CRM_Utils_Array::subset(CRM_Core_I18n::languages(), $codes); | |
259 | } | |
260 | ||
6a488035 TO |
261 | /** |
262 | * Replace arguments in a string with their values. Arguments are represented by % followed by their number. | |
263 | * | |
5a4f6742 CW |
264 | * @param string $str |
265 | * source string. | |
6a488035 | 266 | * |
a6c01b45 CW |
267 | * @return string |
268 | * modified string | |
6a488035 | 269 | */ |
00be9182 | 270 | public function strarg($str) { |
be2fb01f | 271 | $tr = []; |
6a488035 TO |
272 | $p = 0; |
273 | for ($i = 1; $i < func_num_args(); $i++) { | |
274 | $arg = func_get_arg($i); | |
275 | if (is_array($arg)) { | |
276 | foreach ($arg as $aarg) { | |
277 | $tr['%' . ++$p] = $aarg; | |
278 | } | |
279 | } | |
280 | else { | |
281 | $tr['%' . ++$p] = $arg; | |
282 | } | |
283 | } | |
284 | return strtr($str, $tr); | |
285 | } | |
286 | ||
f2ac86d1 | 287 | /** |
288 | * Get the directory for l10n resources. | |
289 | * | |
290 | * @return string | |
291 | */ | |
4d8ce7f0 | 292 | public static function getResourceDir() { |
f64df9e7 | 293 | return CRM_Utils_File::addTrailingSlash(\Civi::paths()->getPath('[civicrm.l10n]/.')); |
4d8ce7f0 TO |
294 | } |
295 | ||
6a488035 TO |
296 | /** |
297 | * Smarty block function, provides gettext support for smarty. | |
298 | * | |
299 | * The block content is the text that should be translated. | |
300 | * | |
301 | * Any parameter that is sent to the function will be represented as %n in the translation text, | |
302 | * where n is 1 for the first parameter. The following parameters are reserved: | |
303 | * - escape - sets escape mode: | |
304 | * - 'html' for HTML escaping, this is the default. | |
305 | * - 'js' for javascript escaping. | |
306 | * - 'no'/'off'/0 - turns off escaping | |
307 | * - plural - The plural version of the text (2nd parameter of ngettext()) | |
308 | * - count - The item count for plural mode (3rd parameter of ngettext()) | |
309 | * - context - gettext context of that string (for homonym handling) | |
310 | * | |
5a4f6742 CW |
311 | * @param string $text |
312 | * the original string. | |
313 | * @param array $params | |
3f3bba82 TO |
314 | * The params of the translation (if any). |
315 | * - domain: string|array a list of translation domains to search (in order) | |
316 | * - context: string | |
69e812be | 317 | * - skip_translation: flag (do only escape/replacement, skip the actual translation) |
e3b7fc11 | 318 | * |
a6c01b45 CW |
319 | * @return string |
320 | * the translated string | |
6a488035 | 321 | */ |
be2fb01f | 322 | public function crm_translate($text, $params = []) { |
33c6d76d CW |
323 | $escape = $params['escape'] ?? NULL; |
324 | unset($params['escape']); | |
6a488035 TO |
325 | |
326 | // sometimes we need to {ts}-tag a string, but don’t want to | |
327 | // translate it in the template (like civicrm_navigation.tpl), | |
328 | // because we handle the translation in a different way (CRM-6998) | |
329 | // in such cases we return early, only doing SQL/JS escaping | |
330 | if (isset($params['skip']) and $params['skip']) { | |
33c6d76d | 331 | return self::escape($text, $escape); |
6a488035 TO |
332 | } |
333 | ||
3f3bba82 | 334 | $plural = $count = NULL; |
6a488035 TO |
335 | if (isset($params['plural'])) { |
336 | $plural = $params['plural']; | |
337 | unset($params['plural']); | |
338 | if (isset($params['count'])) { | |
339 | $count = $params['count']; | |
340 | } | |
341 | } | |
342 | ||
343 | if (isset($params['context'])) { | |
344 | $context = $params['context']; | |
345 | unset($params['context']); | |
346 | } | |
347 | else { | |
348 | $context = NULL; | |
349 | } | |
350 | ||
3f3bba82 TO |
351 | if (isset($params['domain'])) { |
352 | $domain = $params['domain']; | |
353 | unset($params['domain']); | |
354 | } | |
355 | else { | |
356 | $domain = NULL; | |
357 | } | |
358 | ||
1b4710da TO |
359 | $raw = !empty($params['raw']); |
360 | unset($params['raw']); | |
361 | ||
69e812be | 362 | if (!isset($params['skip_translation'])) { |
2f98cf00 E |
363 | if (!empty($domain)) { |
364 | // It might be prettier to cast to an array, but this is high-traffic stuff. | |
365 | if (is_array($domain)) { | |
366 | foreach ($domain as $d) { | |
367 | $candidate = $this->crm_translate_raw($text, $d, $count, $plural, $context); | |
368 | if ($candidate != $text) { | |
369 | $text = $candidate; | |
370 | break; | |
371 | } | |
3f3bba82 TO |
372 | } |
373 | } | |
2f98cf00 E |
374 | else { |
375 | $text = $this->crm_translate_raw($text, $domain, $count, $plural, $context); | |
376 | } | |
3f3bba82 TO |
377 | } |
378 | else { | |
2f98cf00 | 379 | $text = $this->crm_translate_raw($text, NULL, $count, $plural, $context); |
3f3bba82 TO |
380 | } |
381 | } | |
3f3bba82 TO |
382 | |
383 | // replace the numbered %1, %2, etc. params if present | |
1b4710da | 384 | if (count($params) && !$raw) { |
3f3bba82 TO |
385 | $text = $this->strarg($text, $params); |
386 | } | |
387 | ||
33c6d76d | 388 | return self::escape($text, $escape); |
3f3bba82 TO |
389 | } |
390 | ||
391 | /** | |
392 | * Lookup the raw translation of a string (without any extra escaping or interpolation). | |
393 | * | |
394 | * @param string $text | |
e97c66ff | 395 | * @param string|null $domain |
396 | * @param int|null $count | |
3f3bba82 TO |
397 | * @param string $plural |
398 | * @param string $context | |
e3b7fc11 | 399 | * |
400 | * @return string | |
3f3bba82 TO |
401 | */ |
402 | protected function crm_translate_raw($text, $domain, $count, $plural, $context) { | |
1a3cba0e ML |
403 | // gettext domain for extensions |
404 | $domain_changed = FALSE; | |
3f3bba82 TO |
405 | if (!empty($domain) && $this->_phpgettext) { |
406 | if ($this->setGettextDomain($domain)) { | |
1a3cba0e ML |
407 | $domain_changed = TRUE; |
408 | } | |
409 | } | |
410 | ||
6a488035 | 411 | // do all wildcard translations first |
a565a9b6 | 412 | |
9d114ab6 | 413 | $stringTable = $this->getWordReplacements(); |
6a488035 TO |
414 | |
415 | $exactMatch = FALSE; | |
416 | if (isset($stringTable['enabled']['exactMatch'])) { | |
417 | foreach ($stringTable['enabled']['exactMatch'] as $search => $replace) { | |
418 | if ($search === $text) { | |
419 | $exactMatch = TRUE; | |
420 | $text = $replace; | |
421 | break; | |
422 | } | |
423 | } | |
424 | } | |
425 | ||
6cf5bb6f DL |
426 | if ( |
427 | !$exactMatch && | |
6a488035 TO |
428 | isset($stringTable['enabled']['wildcardMatch']) |
429 | ) { | |
353ffa53 | 430 | $search = array_keys($stringTable['enabled']['wildcardMatch']); |
6a488035 | 431 | $replace = array_values($stringTable['enabled']['wildcardMatch']); |
353ffa53 | 432 | $text = str_replace($search, $replace, $text); |
6a488035 TO |
433 | } |
434 | ||
435 | // dont translate if we've done exactMatch already | |
436 | if (!$exactMatch) { | |
437 | // use plural if required parameters are set | |
438 | if (isset($count) && isset($plural)) { | |
439 | ||
440 | if ($this->_phpgettext) { | |
26ff2e24 | 441 | $text = $this->_phpgettext->ngettext($text, $plural, (int) $count); |
6a488035 TO |
442 | } |
443 | else { | |
444 | // if the locale's not set, we do ngettext work by hand | |
445 | // if $count == 1 then $text = $text, else $text = $plural | |
446 | if ($count != 1) { | |
447 | $text = $plural; | |
448 | } | |
449 | } | |
450 | ||
451 | // expand %count in translated string to $count | |
be2fb01f | 452 | $text = strtr($text, ['%count' => $count]); |
6a488035 TO |
453 | |
454 | // if not plural, but the locale's set, translate | |
455 | } | |
456 | elseif ($this->_phpgettext) { | |
457 | if ($context) { | |
458 | $text = $this->_phpgettext->pgettext($context, $text); | |
459 | } | |
460 | else { | |
461 | $text = $this->_phpgettext->translate($text); | |
462 | } | |
463 | } | |
464 | } | |
465 | ||
1a3cba0e ML |
466 | if ($domain_changed) { |
467 | $this->setGettextDomain('civicrm'); | |
468 | } | |
469 | ||
6a488035 TO |
470 | return $text; |
471 | } | |
472 | ||
473 | /** | |
474 | * Translate a string to the current locale. | |
475 | * | |
5a4f6742 CW |
476 | * @param string $string |
477 | * this string should be translated. | |
6a488035 | 478 | * |
a6c01b45 CW |
479 | * @return string |
480 | * the translated string | |
6a488035 | 481 | */ |
00be9182 | 482 | public function translate($string) { |
6a488035 TO |
483 | return ($this->_phpgettext) ? $this->_phpgettext->translate($string) : $string; |
484 | } | |
485 | ||
486 | /** | |
487 | * Localize (destructively) array values. | |
488 | * | |
5a4f6742 CW |
489 | * @param array $array |
490 | * the array for localization (in place). | |
491 | * @param array $params | |
492 | * an array of additional parameters. | |
6a488035 | 493 | */ |
408b79bf | 494 | public function localizeArray( |
6a488035 | 495 | &$array, |
be2fb01f | 496 | $params = [] |
6a488035 | 497 | ) { |
98466ff9 | 498 | $tsLocale = CRM_Core_I18n::getLocale(); |
6a488035 TO |
499 | |
500 | if ($tsLocale == 'en_US') { | |
501 | return; | |
502 | } | |
503 | ||
504 | foreach ($array as & $value) { | |
505 | if ($value) { | |
506 | $value = ts($value, $params); | |
507 | } | |
508 | } | |
509 | } | |
510 | ||
511 | /** | |
512 | * Localize (destructively) array elements with keys of 'title'. | |
513 | * | |
5a4f6742 CW |
514 | * @param array $array |
515 | * the array for localization (in place). | |
6a488035 | 516 | */ |
00be9182 | 517 | public function localizeTitles(&$array) { |
6a488035 TO |
518 | foreach ($array as $key => $value) { |
519 | if (is_array($value)) { | |
520 | $this->localizeTitles($value); | |
521 | $array[$key] = $value; | |
522 | } | |
523 | elseif ((string ) $key == 'title') { | |
be2fb01f | 524 | $array[$key] = ts($value, ['context' => 'menu']); |
6a488035 TO |
525 | } |
526 | } | |
527 | } | |
528 | ||
1a3cba0e ML |
529 | /** |
530 | * Binds a gettext domain, wrapper over bindtextdomain(). | |
531 | * | |
6a0b768e TO |
532 | * @param $key |
533 | * Key of the extension (can be 'civicrm', or 'org.example.foo'). | |
1a3cba0e | 534 | * |
408b79bf | 535 | * @return Bool |
a6c01b45 | 536 | * True if the domain was changed for an extension. |
1a3cba0e | 537 | */ |
00be9182 | 538 | public function setGettextDomain($key) { |
82bcff63 | 539 | /* No domain changes for en_US */ |
353ffa53 | 540 | if (!$this->_phpgettext) { |
82bcff63 ML |
541 | return FALSE; |
542 | } | |
1a3cba0e | 543 | |
74eb462f | 544 | // It's only necessary to find/bind once |
353ffa53 | 545 | if (!isset($this->_extensioncache[$key])) { |
1a3cba0e ML |
546 | try { |
547 | $mapper = CRM_Extension_System::singleton()->getMapper(); | |
548 | $path = $mapper->keyToBasePath($key); | |
549 | $info = $mapper->keyToInfo($key); | |
550 | $domain = $info->file; | |
551 | ||
74eb462f ML |
552 | if ($this->_nativegettext) { |
553 | bindtextdomain($domain, $path . DIRECTORY_SEPARATOR . 'l10n'); | |
554 | bind_textdomain_codeset($domain, 'UTF-8'); | |
555 | $this->_extensioncache[$key] = $domain; | |
556 | } | |
557 | else { | |
558 | // phpgettext | |
b52647df | 559 | $mo_file = $path . DIRECTORY_SEPARATOR . 'l10n' . DIRECTORY_SEPARATOR . $this->locale . DIRECTORY_SEPARATOR . 'LC_MESSAGES' . DIRECTORY_SEPARATOR . $domain . '.mo'; |
74eb462f ML |
560 | $streamer = new FileReader($mo_file); |
561 | $this->_extensioncache[$key] = new gettext_reader($streamer); | |
562 | } | |
1a3cba0e ML |
563 | } |
564 | catch (CRM_Extension_Exception $e) { | |
b44e3f84 | 565 | // Intentionally not translating this string to avoid possible infinite loops |
74eb462f ML |
566 | // Only developers should see this string, if they made a mistake in their ts() usage. |
567 | CRM_Core_Session::setStatus('Unknown extension key in a translation string: ' . $key, '', 'error'); | |
568 | $this->_extensioncache[$key] = FALSE; | |
1a3cba0e ML |
569 | } |
570 | } | |
571 | ||
74eb462f ML |
572 | if (isset($this->_extensioncache[$key]) && $this->_extensioncache[$key]) { |
573 | if ($this->_nativegettext) { | |
574 | textdomain($this->_extensioncache[$key]); | |
575 | } | |
576 | else { | |
577 | $this->_phpgettext = $this->_extensioncache[$key]; | |
578 | } | |
579 | ||
580 | return TRUE; | |
1a3cba0e | 581 | } |
74eb462f ML |
582 | |
583 | return FALSE; | |
1a3cba0e ML |
584 | } |
585 | ||
07844ccf | 586 | /** |
864c22c3 | 587 | * Is the current CiviCRM domain in multilingual mode. |
07844ccf | 588 | * |
394d18d3 | 589 | * @return bool |
07844ccf SV |
590 | * True if CiviCRM is in multilingual mode. |
591 | */ | |
592 | public static function isMultilingual() { | |
d357f225 CW |
593 | $domain = CRM_Core_BAO_Domain::getDomain(); |
594 | return (bool) $domain->locales; | |
394d18d3 CW |
595 | } |
596 | ||
597 | /** | |
598 | * Returns languages if domain is in multilingual mode. | |
599 | * | |
600 | * @return array|bool | |
601 | */ | |
602 | public static function getMultilingual() { | |
d357f225 CW |
603 | $domain = CRM_Core_BAO_Domain::getDomain(); |
604 | return $domain->locales ? CRM_Core_DAO::unSerializeField($domain->locales, CRM_Core_DAO::SERIALIZE_SEPARATOR_TRIMMED) : FALSE; | |
07844ccf SV |
605 | } |
606 | ||
3a55aa6b ML |
607 | /** |
608 | * Is the language written "right-to-left"? | |
609 | * | |
610 | * @param $language | |
611 | * Language (for example 'en_US', or 'fr_CA'). | |
612 | * | |
394d18d3 | 613 | * @return bool |
3a55aa6b ML |
614 | * True if it is an RTL language. |
615 | */ | |
616 | public static function isLanguageRTL($language) { | |
617 | $rtl = CRM_Core_I18n_PseudoConstant::getRTLlanguages(); | |
618 | $short = CRM_Core_I18n_PseudoConstant::shortForLong($language); | |
619 | ||
620 | return (in_array($short, $rtl)); | |
621 | } | |
07844ccf | 622 | |
8731b5ab TO |
623 | /** |
624 | * If you switch back/forth between locales/drivers, it may be necessary | |
625 | * to reset some options. | |
626 | */ | |
627 | protected function reactivate() { | |
628 | if ($this->_nativegettext) { | |
629 | $this->setNativeGettextLocale($this->locale); | |
630 | } | |
631 | ||
632 | } | |
633 | ||
07844ccf SV |
634 | /** |
635 | * Change the processing language without changing the current user language | |
636 | * | |
c86241f4 SV |
637 | * @param $locale |
638 | * Locale (for example 'en_US', or 'fr_CA'). | |
07844ccf SV |
639 | * True if the domain was changed for an extension. |
640 | */ | |
c86241f4 | 641 | public function setLocale($locale) { |
fd1f3a26 SV |
642 | |
643 | // Change the language of the CMS as well, for URLs. | |
c86241f4 | 644 | CRM_Utils_System::setUFLocale($locale); |
fd1f3a26 | 645 | |
6b084142 | 646 | // For sql queries, if running in DB multi-lingual mode. |
53d46849 | 647 | global $dbLocale; |
6b084142 ML |
648 | |
649 | if ($dbLocale) { | |
650 | $dbLocale = "_{$locale}"; | |
651 | } | |
07844ccf | 652 | |
96cb9196 ML |
653 | // For self::getLocale() |
654 | global $tsLocale; | |
655 | $tsLocale = $locale; | |
8731b5ab TO |
656 | |
657 | CRM_Core_I18n::singleton()->reactivate(); | |
07844ccf SV |
658 | } |
659 | ||
6a488035 TO |
660 | /** |
661 | * Static instance provider - return the instance for the current locale. | |
c4c311c1 CW |
662 | * |
663 | * @return CRM_Core_I18n | |
6a488035 | 664 | */ |
00be9182 | 665 | public static function &singleton() { |
9d65201d | 666 | if (!isset(Civi::$statics[__CLASS__]['singleton'])) { |
be2fb01f | 667 | Civi::$statics[__CLASS__]['singleton'] = []; |
9d65201d | 668 | } |
98466ff9 | 669 | $tsLocale = CRM_Core_I18n::getLocale(); |
9d65201d SL |
670 | if (!isset(Civi::$statics[__CLASS__]['singleton'][$tsLocale])) { |
671 | Civi::$statics[__CLASS__]['singleton'][$tsLocale] = new CRM_Core_I18n($tsLocale); | |
6a488035 TO |
672 | } |
673 | ||
9d65201d | 674 | return Civi::$statics[__CLASS__]['singleton'][$tsLocale]; |
6a488035 TO |
675 | } |
676 | ||
677 | /** | |
678 | * Set the LC_TIME locale if it's not set already (for a given language choice). | |
679 | * | |
a6c01b45 CW |
680 | * @return string |
681 | * the final LC_TIME that got set | |
6a488035 | 682 | */ |
00be9182 | 683 | public static function setLcTime() { |
be2fb01f | 684 | static $locales = []; |
6a488035 | 685 | |
98466ff9 | 686 | $tsLocale = CRM_Core_I18n::getLocale(); |
6a488035 TO |
687 | if (!isset($locales[$tsLocale])) { |
688 | // with the config being set to pl_PL: try pl_PL.UTF-8, | |
689 | // then pl_PL, if neither present fall back to C | |
690 | $locales[$tsLocale] = setlocale(LC_TIME, $tsLocale . '.UTF-8', $tsLocale, 'C'); | |
691 | } | |
692 | ||
693 | return $locales[$tsLocale]; | |
694 | } | |
96025800 | 695 | |
9747df8a | 696 | /** |
697 | * Get the default language for contacts where no language is provided. | |
698 | * | |
699 | * Note that NULL is a valid option so be careful with checking for empty etc. | |
700 | * | |
701 | * NULL would mean 'we don't know & we don't want to hazard a guess'. | |
702 | * | |
703 | * @return string | |
704 | */ | |
705 | public static function getContactDefaultLanguage() { | |
aaffa79f | 706 | $language = Civi::settings()->get('contact_default_language'); |
9747df8a | 707 | if ($language == 'undefined') { |
708 | return NULL; | |
709 | } | |
710 | if (empty($language) || $language === '*default*') { | |
be2fb01f | 711 | $language = civicrm_api3('setting', 'getvalue', [ |
9747df8a | 712 | 'name' => 'lcMessages', |
713 | 'group' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME, | |
be2fb01f | 714 | ]); |
9747df8a | 715 | } |
716 | elseif ($language == 'current_site_language') { | |
98466ff9 | 717 | return CRM_Core_I18n::getLocale(); |
9747df8a | 718 | } |
719 | ||
720 | return $language; | |
721 | } | |
722 | ||
186e53b3 | 723 | /** |
724 | * Get the current locale | |
725 | * | |
726 | * @return string | |
727 | */ | |
728 | public static function getLocale() { | |
729 | global $tsLocale; | |
338ff411 | 730 | return $tsLocale ? $tsLocale : 'en_US'; |
186e53b3 | 731 | } |
732 | ||
9d114ab6 TO |
733 | /** |
734 | * @return array | |
735 | * Ex: $stringTable['enabled']['wildcardMatch']['foo'] = 'bar'; | |
736 | */ | |
737 | private function getWordReplacements() { | |
738 | if (isset(Civi::$statics['testPreInstall'])) { | |
739 | return []; | |
740 | } | |
741 | ||
742 | // FIXME: Is there a constant we can reference instead of hardcoding en_US? | |
743 | $replacementsLocale = $this->locale ? $this->locale : 'en_US'; | |
744 | if ((!isset(Civi::$statics[__CLASS__]) || !array_key_exists($replacementsLocale, Civi::$statics[__CLASS__]))) { | |
745 | if (defined('CIVICRM_DSN') && !CRM_Core_Config::isUpgradeMode()) { | |
746 | Civi::$statics[__CLASS__][$replacementsLocale] = CRM_Core_BAO_WordReplacement::getLocaleCustomStrings($replacementsLocale); | |
747 | } | |
748 | else { | |
749 | Civi::$statics[__CLASS__][$replacementsLocale] = []; | |
750 | } | |
751 | } | |
752 | return Civi::$statics[__CLASS__][$replacementsLocale]; | |
753 | } | |
754 | ||
6a488035 TO |
755 | } |
756 | ||
757 | /** | |
758 | * Short-named function for string translation, defined in global scope so it's available everywhere. | |
759 | * | |
e3b7fc11 | 760 | * @param string $text |
6a0b768e | 761 | * String string for translating. |
16b10e64 | 762 | * @param array $params |
6a0b768e | 763 | * Array an array of additional parameters. |
6a488035 | 764 | * |
a6c01b45 | 765 | * @return string |
353ffa53 | 766 | * the translated string |
6a488035 | 767 | */ |
be2fb01f | 768 | function ts($text, $params = []) { |
852de6cf | 769 | static $bootstrapReady = FALSE; |
4954910a | 770 | static $lastLocale = NULL; |
6a488035 TO |
771 | static $i18n = NULL; |
772 | static $function = NULL; | |
773 | ||
774 | if ($text == '') { | |
775 | return ''; | |
776 | } | |
777 | ||
4954910a | 778 | // When the settings become available, lookup customTranslateFunction. |
852de6cf E |
779 | if (!$bootstrapReady) { |
780 | $bootstrapReady = (bool) \Civi\Core\Container::isContainerBooted(); | |
781 | if ($bootstrapReady) { | |
782 | // just got ready: determine whether there is a working custom translation function | |
4954910a TO |
783 | $config = CRM_Core_Config::singleton(); |
784 | if (isset($config->customTranslateFunction) and function_exists($config->customTranslateFunction)) { | |
785 | $function = $config->customTranslateFunction; | |
786 | } | |
787 | } | |
6a488035 TO |
788 | } |
789 | ||
4954910a TO |
790 | $activeLocale = CRM_Core_I18n::getLocale(); |
791 | if (!$i18n or $lastLocale != $activeLocale) { | |
6a488035 | 792 | $i18n = CRM_Core_I18n::singleton(); |
4954910a | 793 | $lastLocale = $activeLocale; |
6a488035 TO |
794 | } |
795 | ||
796 | if ($function) { | |
797 | return $function($text, $params); | |
798 | } | |
799 | else { | |
800 | return $i18n->crm_translate($text, $params); | |
801 | } | |
802 | } |