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 | * | |
e144ca30 | 22 | * @var string |
07844ccf SV |
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) { | |
8cab7b3d | 187 | // Use `getValues`, not `buildOptions` to bypass hook_civicrm_fieldOptions. See core#1132. |
188 | CRM_Core_OptionValue::getValues(['name' => 'languages'], $optionValues, 'weight', TRUE); | |
189 | $all = array_column($optionValues, 'label', 'name'); | |
6a488035 | 190 | |
8cab7b3d | 191 | // FIXME: How is this not duplicative of the lines above? |
ece6501c | 192 | // get labels |
be2fb01f CW |
193 | $rows = []; |
194 | $labels = []; | |
195 | CRM_Core_OptionValue::getValues(['name' => 'languages'], $rows); | |
ece6501c ML |
196 | foreach ($rows as $id => $row) { |
197 | $labels[$row['name']] = $row['label']; | |
198 | } | |
199 | ||
6a488035 | 200 | // check which ones are available; add them to $all if not there already |
be2fb01f | 201 | $codes = []; |
4d8ce7f0 | 202 | if (is_dir(CRM_Core_I18n::getResourceDir()) && $dir = opendir(CRM_Core_I18n::getResourceDir())) { |
6a488035 TO |
203 | while ($filename = readdir($dir)) { |
204 | if (preg_match('/^[a-z][a-z]_[A-Z][A-Z]$/', $filename)) { | |
205 | $codes[] = $filename; | |
206 | if (!isset($all[$filename])) { | |
8a0dba7b | 207 | $all[$filename] = $labels[$filename] ?? "($filename)"; |
6a488035 TO |
208 | } |
209 | } | |
210 | } | |
211 | closedir($dir); | |
212 | } | |
213 | ||
214 | // drop the unavailable languages (except en_US) | |
215 | foreach (array_keys($all) as $code) { | |
216 | if ($code == 'en_US') { | |
217 | continue; | |
218 | } | |
408b79bf | 219 | if (!in_array($code, $codes)) { |
220 | unset($all[$code]); | |
221 | } | |
6a488035 | 222 | } |
ece6501c | 223 | |
921ed8ae | 224 | asort($all); |
6a488035 TO |
225 | } |
226 | ||
227 | if ($enabled === NULL) { | |
cc493f5e | 228 | $languageLimit = Civi::settings()->get('languageLimit'); |
be2fb01f | 229 | $enabled = []; |
cc493f5e | 230 | if ($languageLimit) { |
6a488035 | 231 | foreach ($all as $code => $name) { |
cc493f5e | 232 | if (array_key_exists($code, $languageLimit)) { |
6a488035 TO |
233 | $enabled[$code] = $name; |
234 | } | |
235 | } | |
236 | } | |
237 | } | |
238 | ||
239 | return $justEnabled ? $enabled : $all; | |
240 | } | |
241 | ||
57eda25d EM |
242 | /** |
243 | * Get the options available for format locale. | |
244 | * | |
245 | * Note the pseudoconstant can't be used as the key is the name not the value. | |
246 | * | |
247 | * @return array | |
248 | */ | |
9d14b6f7 | 249 | public static function getFormatLocales(): array { |
57eda25d | 250 | $values = CRM_Core_OptionValue::getValues(['name' => 'languages'], $optionValues, 'label', TRUE); |
afd5a927 | 251 | $return = []; |
9d14b6f7 | 252 | $return[NULL] = ts('Inherit from language'); |
57eda25d EM |
253 | foreach ($values as $value) { |
254 | $return[$value['name']] = $value['label']; | |
255 | } | |
afd5a927 EM |
256 | // Sorry not sorry. |
257 | // Hacking in for now since the is probably the most important use-case for | |
258 | // money formatting in an English speaking non-US locale based on any reasonable | |
259 | // metric. | |
79f4e0bd | 260 | $return['en_NZ'] = ts('English (New Zealand)'); |
57eda25d EM |
261 | return $return; |
262 | } | |
263 | ||
921ed8ae AS |
264 | /** |
265 | * Return the available UI languages | |
518fa0ee SL |
266 | * @return array|string |
267 | * array(string languageCode => string languageName) if !$justCodes | |
921ed8ae AS |
268 | */ |
269 | public static function uiLanguages($justCodes = FALSE) { | |
270 | // In multilang we only allow the languages that are configured in db | |
271 | // Otherwise, the languages configured in uiLanguages | |
272 | $settings = Civi::settings(); | |
273 | if (CRM_Core_I18n::isMultiLingual()) { | |
274 | $codes = array_keys((array) $settings->get('languageLimit')); | |
275 | } | |
276 | else { | |
277 | $codes = $settings->get('uiLanguages'); | |
278 | if (!$codes) { | |
279 | $codes = [$settings->get('lcMessages')]; | |
280 | } | |
281 | } | |
282 | return $justCodes ? $codes | |
283 | : CRM_Utils_Array::subset(CRM_Core_I18n::languages(), $codes); | |
284 | } | |
285 | ||
6a488035 TO |
286 | /** |
287 | * Replace arguments in a string with their values. Arguments are represented by % followed by their number. | |
288 | * | |
5a4f6742 CW |
289 | * @param string $str |
290 | * source string. | |
6a488035 | 291 | * |
a6c01b45 CW |
292 | * @return string |
293 | * modified string | |
6a488035 | 294 | */ |
00be9182 | 295 | public function strarg($str) { |
be2fb01f | 296 | $tr = []; |
6a488035 TO |
297 | $p = 0; |
298 | for ($i = 1; $i < func_num_args(); $i++) { | |
299 | $arg = func_get_arg($i); | |
300 | if (is_array($arg)) { | |
301 | foreach ($arg as $aarg) { | |
302 | $tr['%' . ++$p] = $aarg; | |
303 | } | |
304 | } | |
305 | else { | |
306 | $tr['%' . ++$p] = $arg; | |
307 | } | |
308 | } | |
309 | return strtr($str, $tr); | |
310 | } | |
311 | ||
f2ac86d1 | 312 | /** |
313 | * Get the directory for l10n resources. | |
314 | * | |
315 | * @return string | |
316 | */ | |
4d8ce7f0 | 317 | public static function getResourceDir() { |
f64df9e7 | 318 | return CRM_Utils_File::addTrailingSlash(\Civi::paths()->getPath('[civicrm.l10n]/.')); |
4d8ce7f0 TO |
319 | } |
320 | ||
6a488035 TO |
321 | /** |
322 | * Smarty block function, provides gettext support for smarty. | |
323 | * | |
324 | * The block content is the text that should be translated. | |
325 | * | |
326 | * Any parameter that is sent to the function will be represented as %n in the translation text, | |
327 | * where n is 1 for the first parameter. The following parameters are reserved: | |
328 | * - escape - sets escape mode: | |
329 | * - 'html' for HTML escaping, this is the default. | |
330 | * - 'js' for javascript escaping. | |
331 | * - 'no'/'off'/0 - turns off escaping | |
332 | * - plural - The plural version of the text (2nd parameter of ngettext()) | |
333 | * - count - The item count for plural mode (3rd parameter of ngettext()) | |
334 | * - context - gettext context of that string (for homonym handling) | |
335 | * | |
5a4f6742 CW |
336 | * @param string $text |
337 | * the original string. | |
338 | * @param array $params | |
3f3bba82 TO |
339 | * The params of the translation (if any). |
340 | * - domain: string|array a list of translation domains to search (in order) | |
341 | * - context: string | |
69e812be | 342 | * - skip_translation: flag (do only escape/replacement, skip the actual translation) |
e3b7fc11 | 343 | * |
a6c01b45 CW |
344 | * @return string |
345 | * the translated string | |
6a488035 | 346 | */ |
be2fb01f | 347 | public function crm_translate($text, $params = []) { |
33c6d76d CW |
348 | $escape = $params['escape'] ?? NULL; |
349 | unset($params['escape']); | |
6a488035 TO |
350 | |
351 | // sometimes we need to {ts}-tag a string, but don’t want to | |
352 | // translate it in the template (like civicrm_navigation.tpl), | |
353 | // because we handle the translation in a different way (CRM-6998) | |
354 | // in such cases we return early, only doing SQL/JS escaping | |
355 | if (isset($params['skip']) and $params['skip']) { | |
33c6d76d | 356 | return self::escape($text, $escape); |
6a488035 TO |
357 | } |
358 | ||
3f3bba82 | 359 | $plural = $count = NULL; |
6a488035 TO |
360 | if (isset($params['plural'])) { |
361 | $plural = $params['plural']; | |
362 | unset($params['plural']); | |
363 | if (isset($params['count'])) { | |
364 | $count = $params['count']; | |
365 | } | |
366 | } | |
367 | ||
368 | if (isset($params['context'])) { | |
369 | $context = $params['context']; | |
370 | unset($params['context']); | |
371 | } | |
372 | else { | |
373 | $context = NULL; | |
374 | } | |
375 | ||
3f3bba82 TO |
376 | if (isset($params['domain'])) { |
377 | $domain = $params['domain']; | |
378 | unset($params['domain']); | |
379 | } | |
380 | else { | |
381 | $domain = NULL; | |
382 | } | |
383 | ||
1b4710da TO |
384 | $raw = !empty($params['raw']); |
385 | unset($params['raw']); | |
386 | ||
69e812be | 387 | if (!isset($params['skip_translation'])) { |
2f98cf00 E |
388 | if (!empty($domain)) { |
389 | // It might be prettier to cast to an array, but this is high-traffic stuff. | |
390 | if (is_array($domain)) { | |
391 | foreach ($domain as $d) { | |
392 | $candidate = $this->crm_translate_raw($text, $d, $count, $plural, $context); | |
393 | if ($candidate != $text) { | |
394 | $text = $candidate; | |
395 | break; | |
396 | } | |
3f3bba82 TO |
397 | } |
398 | } | |
2f98cf00 E |
399 | else { |
400 | $text = $this->crm_translate_raw($text, $domain, $count, $plural, $context); | |
401 | } | |
3f3bba82 TO |
402 | } |
403 | else { | |
2f98cf00 | 404 | $text = $this->crm_translate_raw($text, NULL, $count, $plural, $context); |
3f3bba82 TO |
405 | } |
406 | } | |
3f3bba82 TO |
407 | |
408 | // replace the numbered %1, %2, etc. params if present | |
1b4710da | 409 | if (count($params) && !$raw) { |
3f3bba82 TO |
410 | $text = $this->strarg($text, $params); |
411 | } | |
412 | ||
33c6d76d | 413 | return self::escape($text, $escape); |
3f3bba82 TO |
414 | } |
415 | ||
416 | /** | |
417 | * Lookup the raw translation of a string (without any extra escaping or interpolation). | |
418 | * | |
419 | * @param string $text | |
e97c66ff | 420 | * @param string|null $domain |
421 | * @param int|null $count | |
3f3bba82 TO |
422 | * @param string $plural |
423 | * @param string $context | |
e3b7fc11 | 424 | * |
425 | * @return string | |
3f3bba82 TO |
426 | */ |
427 | protected function crm_translate_raw($text, $domain, $count, $plural, $context) { | |
1a3cba0e ML |
428 | // gettext domain for extensions |
429 | $domain_changed = FALSE; | |
3f3bba82 TO |
430 | if (!empty($domain) && $this->_phpgettext) { |
431 | if ($this->setGettextDomain($domain)) { | |
1a3cba0e ML |
432 | $domain_changed = TRUE; |
433 | } | |
434 | } | |
435 | ||
6a488035 | 436 | // do all wildcard translations first |
a565a9b6 | 437 | |
9d114ab6 | 438 | $stringTable = $this->getWordReplacements(); |
6a488035 TO |
439 | |
440 | $exactMatch = FALSE; | |
441 | if (isset($stringTable['enabled']['exactMatch'])) { | |
442 | foreach ($stringTable['enabled']['exactMatch'] as $search => $replace) { | |
443 | if ($search === $text) { | |
444 | $exactMatch = TRUE; | |
445 | $text = $replace; | |
446 | break; | |
447 | } | |
448 | } | |
449 | } | |
450 | ||
6cf5bb6f DL |
451 | if ( |
452 | !$exactMatch && | |
6a488035 TO |
453 | isset($stringTable['enabled']['wildcardMatch']) |
454 | ) { | |
353ffa53 | 455 | $search = array_keys($stringTable['enabled']['wildcardMatch']); |
6a488035 | 456 | $replace = array_values($stringTable['enabled']['wildcardMatch']); |
353ffa53 | 457 | $text = str_replace($search, $replace, $text); |
6a488035 TO |
458 | } |
459 | ||
460 | // dont translate if we've done exactMatch already | |
461 | if (!$exactMatch) { | |
462 | // use plural if required parameters are set | |
463 | if (isset($count) && isset($plural)) { | |
464 | ||
465 | if ($this->_phpgettext) { | |
26ff2e24 | 466 | $text = $this->_phpgettext->ngettext($text, $plural, (int) $count); |
6a488035 TO |
467 | } |
468 | else { | |
469 | // if the locale's not set, we do ngettext work by hand | |
470 | // if $count == 1 then $text = $text, else $text = $plural | |
471 | if ($count != 1) { | |
472 | $text = $plural; | |
473 | } | |
474 | } | |
475 | ||
476 | // expand %count in translated string to $count | |
be2fb01f | 477 | $text = strtr($text, ['%count' => $count]); |
6a488035 TO |
478 | |
479 | // if not plural, but the locale's set, translate | |
480 | } | |
481 | elseif ($this->_phpgettext) { | |
482 | if ($context) { | |
483 | $text = $this->_phpgettext->pgettext($context, $text); | |
484 | } | |
485 | else { | |
486 | $text = $this->_phpgettext->translate($text); | |
487 | } | |
488 | } | |
489 | } | |
490 | ||
1a3cba0e ML |
491 | if ($domain_changed) { |
492 | $this->setGettextDomain('civicrm'); | |
493 | } | |
494 | ||
6a488035 TO |
495 | return $text; |
496 | } | |
497 | ||
498 | /** | |
499 | * Translate a string to the current locale. | |
500 | * | |
5a4f6742 CW |
501 | * @param string $string |
502 | * this string should be translated. | |
6a488035 | 503 | * |
a6c01b45 CW |
504 | * @return string |
505 | * the translated string | |
6a488035 | 506 | */ |
00be9182 | 507 | public function translate($string) { |
6a488035 TO |
508 | return ($this->_phpgettext) ? $this->_phpgettext->translate($string) : $string; |
509 | } | |
510 | ||
511 | /** | |
512 | * Localize (destructively) array values. | |
513 | * | |
5a4f6742 CW |
514 | * @param array $array |
515 | * the array for localization (in place). | |
516 | * @param array $params | |
517 | * an array of additional parameters. | |
6a488035 | 518 | */ |
408b79bf | 519 | public function localizeArray( |
6a488035 | 520 | &$array, |
be2fb01f | 521 | $params = [] |
6a488035 | 522 | ) { |
98466ff9 | 523 | $tsLocale = CRM_Core_I18n::getLocale(); |
6a488035 TO |
524 | |
525 | if ($tsLocale == 'en_US') { | |
526 | return; | |
527 | } | |
528 | ||
529 | foreach ($array as & $value) { | |
530 | if ($value) { | |
531 | $value = ts($value, $params); | |
532 | } | |
533 | } | |
534 | } | |
535 | ||
536 | /** | |
537 | * Localize (destructively) array elements with keys of 'title'. | |
538 | * | |
5a4f6742 CW |
539 | * @param array $array |
540 | * the array for localization (in place). | |
6a488035 | 541 | */ |
00be9182 | 542 | public function localizeTitles(&$array) { |
6a488035 TO |
543 | foreach ($array as $key => $value) { |
544 | if (is_array($value)) { | |
545 | $this->localizeTitles($value); | |
546 | $array[$key] = $value; | |
547 | } | |
548 | elseif ((string ) $key == 'title') { | |
be2fb01f | 549 | $array[$key] = ts($value, ['context' => 'menu']); |
6a488035 TO |
550 | } |
551 | } | |
552 | } | |
553 | ||
1a3cba0e ML |
554 | /** |
555 | * Binds a gettext domain, wrapper over bindtextdomain(). | |
556 | * | |
3fd42bb5 | 557 | * @param string $key |
6a0b768e | 558 | * Key of the extension (can be 'civicrm', or 'org.example.foo'). |
1a3cba0e | 559 | * |
408b79bf | 560 | * @return Bool |
a6c01b45 | 561 | * True if the domain was changed for an extension. |
1a3cba0e | 562 | */ |
00be9182 | 563 | public function setGettextDomain($key) { |
82bcff63 | 564 | /* No domain changes for en_US */ |
353ffa53 | 565 | if (!$this->_phpgettext) { |
82bcff63 ML |
566 | return FALSE; |
567 | } | |
1a3cba0e | 568 | |
74eb462f | 569 | // It's only necessary to find/bind once |
353ffa53 | 570 | if (!isset($this->_extensioncache[$key])) { |
1a3cba0e ML |
571 | try { |
572 | $mapper = CRM_Extension_System::singleton()->getMapper(); | |
573 | $path = $mapper->keyToBasePath($key); | |
574 | $info = $mapper->keyToInfo($key); | |
575 | $domain = $info->file; | |
576 | ||
74eb462f ML |
577 | if ($this->_nativegettext) { |
578 | bindtextdomain($domain, $path . DIRECTORY_SEPARATOR . 'l10n'); | |
579 | bind_textdomain_codeset($domain, 'UTF-8'); | |
580 | $this->_extensioncache[$key] = $domain; | |
581 | } | |
582 | else { | |
583 | // phpgettext | |
b52647df | 584 | $mo_file = $path . DIRECTORY_SEPARATOR . 'l10n' . DIRECTORY_SEPARATOR . $this->locale . DIRECTORY_SEPARATOR . 'LC_MESSAGES' . DIRECTORY_SEPARATOR . $domain . '.mo'; |
74eb462f | 585 | $streamer = new FileReader($mo_file); |
c282ea69 | 586 | $this->_extensioncache[$key] = $streamer->length() ? new gettext_reader($streamer) : NULL; |
74eb462f | 587 | } |
1a3cba0e ML |
588 | } |
589 | catch (CRM_Extension_Exception $e) { | |
b44e3f84 | 590 | // Intentionally not translating this string to avoid possible infinite loops |
74eb462f ML |
591 | // Only developers should see this string, if they made a mistake in their ts() usage. |
592 | CRM_Core_Session::setStatus('Unknown extension key in a translation string: ' . $key, '', 'error'); | |
593 | $this->_extensioncache[$key] = FALSE; | |
1a3cba0e ML |
594 | } |
595 | } | |
596 | ||
74eb462f ML |
597 | if (isset($this->_extensioncache[$key]) && $this->_extensioncache[$key]) { |
598 | if ($this->_nativegettext) { | |
599 | textdomain($this->_extensioncache[$key]); | |
600 | } | |
601 | else { | |
602 | $this->_phpgettext = $this->_extensioncache[$key]; | |
603 | } | |
604 | ||
605 | return TRUE; | |
1a3cba0e | 606 | } |
74eb462f ML |
607 | |
608 | return FALSE; | |
1a3cba0e ML |
609 | } |
610 | ||
07844ccf | 611 | /** |
864c22c3 | 612 | * Is the current CiviCRM domain in multilingual mode. |
07844ccf | 613 | * |
394d18d3 | 614 | * @return bool |
07844ccf SV |
615 | * True if CiviCRM is in multilingual mode. |
616 | */ | |
617 | public static function isMultilingual() { | |
d357f225 CW |
618 | $domain = CRM_Core_BAO_Domain::getDomain(); |
619 | return (bool) $domain->locales; | |
394d18d3 CW |
620 | } |
621 | ||
622 | /** | |
623 | * Returns languages if domain is in multilingual mode. | |
624 | * | |
625 | * @return array|bool | |
626 | */ | |
627 | public static function getMultilingual() { | |
d357f225 CW |
628 | $domain = CRM_Core_BAO_Domain::getDomain(); |
629 | return $domain->locales ? CRM_Core_DAO::unSerializeField($domain->locales, CRM_Core_DAO::SERIALIZE_SEPARATOR_TRIMMED) : FALSE; | |
07844ccf SV |
630 | } |
631 | ||
3a55aa6b ML |
632 | /** |
633 | * Is the language written "right-to-left"? | |
634 | * | |
3fd42bb5 | 635 | * @param string $language |
3a55aa6b ML |
636 | * Language (for example 'en_US', or 'fr_CA'). |
637 | * | |
394d18d3 | 638 | * @return bool |
3a55aa6b ML |
639 | * True if it is an RTL language. |
640 | */ | |
641 | public static function isLanguageRTL($language) { | |
642 | $rtl = CRM_Core_I18n_PseudoConstant::getRTLlanguages(); | |
643 | $short = CRM_Core_I18n_PseudoConstant::shortForLong($language); | |
644 | ||
645 | return (in_array($short, $rtl)); | |
646 | } | |
07844ccf | 647 | |
8731b5ab TO |
648 | /** |
649 | * If you switch back/forth between locales/drivers, it may be necessary | |
650 | * to reset some options. | |
651 | */ | |
652 | protected function reactivate() { | |
653 | if ($this->_nativegettext) { | |
654 | $this->setNativeGettextLocale($this->locale); | |
655 | } | |
656 | ||
657 | } | |
658 | ||
07844ccf SV |
659 | /** |
660 | * Change the processing language without changing the current user language | |
661 | * | |
3fd42bb5 | 662 | * @param string $locale |
c86241f4 | 663 | * Locale (for example 'en_US', or 'fr_CA'). |
07844ccf SV |
664 | * True if the domain was changed for an extension. |
665 | */ | |
c86241f4 | 666 | public function setLocale($locale) { |
fd1f3a26 SV |
667 | |
668 | // Change the language of the CMS as well, for URLs. | |
c86241f4 | 669 | CRM_Utils_System::setUFLocale($locale); |
fd1f3a26 | 670 | |
6b084142 | 671 | // For sql queries, if running in DB multi-lingual mode. |
53d46849 | 672 | global $dbLocale; |
6b084142 ML |
673 | |
674 | if ($dbLocale) { | |
675 | $dbLocale = "_{$locale}"; | |
676 | } | |
07844ccf | 677 | |
96cb9196 ML |
678 | // For self::getLocale() |
679 | global $tsLocale; | |
680 | $tsLocale = $locale; | |
8731b5ab TO |
681 | |
682 | CRM_Core_I18n::singleton()->reactivate(); | |
07844ccf SV |
683 | } |
684 | ||
6a488035 TO |
685 | /** |
686 | * Static instance provider - return the instance for the current locale. | |
c4c311c1 CW |
687 | * |
688 | * @return CRM_Core_I18n | |
6a488035 | 689 | */ |
00be9182 | 690 | public static function &singleton() { |
9d65201d | 691 | if (!isset(Civi::$statics[__CLASS__]['singleton'])) { |
be2fb01f | 692 | Civi::$statics[__CLASS__]['singleton'] = []; |
9d65201d | 693 | } |
98466ff9 | 694 | $tsLocale = CRM_Core_I18n::getLocale(); |
9d65201d SL |
695 | if (!isset(Civi::$statics[__CLASS__]['singleton'][$tsLocale])) { |
696 | Civi::$statics[__CLASS__]['singleton'][$tsLocale] = new CRM_Core_I18n($tsLocale); | |
6a488035 TO |
697 | } |
698 | ||
9d65201d | 699 | return Civi::$statics[__CLASS__]['singleton'][$tsLocale]; |
6a488035 TO |
700 | } |
701 | ||
702 | /** | |
703 | * Set the LC_TIME locale if it's not set already (for a given language choice). | |
704 | * | |
a6c01b45 CW |
705 | * @return string |
706 | * the final LC_TIME that got set | |
6a488035 | 707 | */ |
00be9182 | 708 | public static function setLcTime() { |
be2fb01f | 709 | static $locales = []; |
6a488035 | 710 | |
98466ff9 | 711 | $tsLocale = CRM_Core_I18n::getLocale(); |
6a488035 TO |
712 | if (!isset($locales[$tsLocale])) { |
713 | // with the config being set to pl_PL: try pl_PL.UTF-8, | |
714 | // then pl_PL, if neither present fall back to C | |
715 | $locales[$tsLocale] = setlocale(LC_TIME, $tsLocale . '.UTF-8', $tsLocale, 'C'); | |
716 | } | |
717 | ||
718 | return $locales[$tsLocale]; | |
719 | } | |
96025800 | 720 | |
9747df8a | 721 | /** |
722 | * Get the default language for contacts where no language is provided. | |
723 | * | |
724 | * Note that NULL is a valid option so be careful with checking for empty etc. | |
725 | * | |
726 | * NULL would mean 'we don't know & we don't want to hazard a guess'. | |
727 | * | |
728 | * @return string | |
729 | */ | |
730 | public static function getContactDefaultLanguage() { | |
aaffa79f | 731 | $language = Civi::settings()->get('contact_default_language'); |
9747df8a | 732 | if ($language == 'undefined') { |
733 | return NULL; | |
734 | } | |
735 | if (empty($language) || $language === '*default*') { | |
be2fb01f | 736 | $language = civicrm_api3('setting', 'getvalue', [ |
9747df8a | 737 | 'name' => 'lcMessages', |
738 | 'group' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME, | |
be2fb01f | 739 | ]); |
9747df8a | 740 | } |
741 | elseif ($language == 'current_site_language') { | |
98466ff9 | 742 | return CRM_Core_I18n::getLocale(); |
9747df8a | 743 | } |
744 | ||
745 | return $language; | |
746 | } | |
747 | ||
186e53b3 | 748 | /** |
749 | * Get the current locale | |
750 | * | |
751 | * @return string | |
752 | */ | |
753 | public static function getLocale() { | |
754 | global $tsLocale; | |
338ff411 | 755 | return $tsLocale ? $tsLocale : 'en_US'; |
186e53b3 | 756 | } |
757 | ||
9d114ab6 TO |
758 | /** |
759 | * @return array | |
760 | * Ex: $stringTable['enabled']['wildcardMatch']['foo'] = 'bar'; | |
761 | */ | |
762 | private function getWordReplacements() { | |
763 | if (isset(Civi::$statics['testPreInstall'])) { | |
764 | return []; | |
765 | } | |
766 | ||
767 | // FIXME: Is there a constant we can reference instead of hardcoding en_US? | |
768 | $replacementsLocale = $this->locale ? $this->locale : 'en_US'; | |
769 | if ((!isset(Civi::$statics[__CLASS__]) || !array_key_exists($replacementsLocale, Civi::$statics[__CLASS__]))) { | |
770 | if (defined('CIVICRM_DSN') && !CRM_Core_Config::isUpgradeMode()) { | |
771 | Civi::$statics[__CLASS__][$replacementsLocale] = CRM_Core_BAO_WordReplacement::getLocaleCustomStrings($replacementsLocale); | |
772 | } | |
773 | else { | |
774 | Civi::$statics[__CLASS__][$replacementsLocale] = []; | |
775 | } | |
776 | } | |
777 | return Civi::$statics[__CLASS__][$replacementsLocale]; | |
778 | } | |
779 | ||
6a488035 TO |
780 | } |
781 | ||
782 | /** | |
783 | * Short-named function for string translation, defined in global scope so it's available everywhere. | |
784 | * | |
e3b7fc11 | 785 | * @param string $text |
6a0b768e | 786 | * String string for translating. |
16b10e64 | 787 | * @param array $params |
6a0b768e | 788 | * Array an array of additional parameters. |
6a488035 | 789 | * |
a6c01b45 | 790 | * @return string |
353ffa53 | 791 | * the translated string |
6a488035 | 792 | */ |
be2fb01f | 793 | function ts($text, $params = []) { |
852de6cf | 794 | static $bootstrapReady = FALSE; |
4954910a | 795 | static $lastLocale = NULL; |
6a488035 TO |
796 | static $i18n = NULL; |
797 | static $function = NULL; | |
798 | ||
799 | if ($text == '') { | |
800 | return ''; | |
801 | } | |
802 | ||
4954910a | 803 | // When the settings become available, lookup customTranslateFunction. |
852de6cf E |
804 | if (!$bootstrapReady) { |
805 | $bootstrapReady = (bool) \Civi\Core\Container::isContainerBooted(); | |
806 | if ($bootstrapReady) { | |
807 | // just got ready: determine whether there is a working custom translation function | |
4954910a TO |
808 | $config = CRM_Core_Config::singleton(); |
809 | if (isset($config->customTranslateFunction) and function_exists($config->customTranslateFunction)) { | |
810 | $function = $config->customTranslateFunction; | |
811 | } | |
812 | } | |
6a488035 TO |
813 | } |
814 | ||
4954910a TO |
815 | $activeLocale = CRM_Core_I18n::getLocale(); |
816 | if (!$i18n or $lastLocale != $activeLocale) { | |
6a488035 | 817 | $i18n = CRM_Core_I18n::singleton(); |
4954910a | 818 | $lastLocale = $activeLocale; |
6a488035 TO |
819 | } |
820 | ||
821 | if ($function) { | |
822 | return $function($text, $params); | |
823 | } | |
824 | else { | |
825 | return $i18n->crm_translate($text, $params); | |
826 | } | |
827 | } |