3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
38 * A PHP-gettext instance for string translation;
39 * should stay null if the strings are not to be translated (en_US).
41 private $_phpgettext = NULL;
44 * Whether we are using native gettext or not.
46 private $_nativegettext = FALSE;
49 * Gettext cache for extension domains/streamers, depending on if native or phpgettext.
50 * - native gettext: we cache the value for textdomain()
51 * - phpgettext: we cache the file streamer.
53 private $_extensioncache = array();
56 * A locale-based constructor that shouldn't be called from outside of this class (use singleton() instead).
58 * @param string $locale
59 * the base of this certain object's existence.
61 * @return \CRM_Core_I18n
63 public function __construct($locale) {
64 if ($locale != '' and $locale != 'en_US') {
65 $config = CRM_Core_Config
::singleton();
67 if (defined('CIVICRM_GETTEXT_NATIVE') && CIVICRM_GETTEXT_NATIVE
&& function_exists('gettext')) {
68 // Note: the file hierarchy for .po must be, for example: l10n/fr_FR/LC_MESSAGES/civicrm.mo
70 $this->_nativegettext
= TRUE;
73 putenv("LANG=$locale");
75 // CRM-11833 Avoid LC_ALL because of LC_NUMERIC and potential DB error.
76 setlocale(LC_TIME
, $locale);
77 setlocale(LC_MESSAGES
, $locale);
78 setlocale(LC_CTYPE
, $locale);
80 bindtextdomain('civicrm', $config->gettextResourceDir
);
81 bind_textdomain_codeset('civicrm', 'UTF-8');
82 textdomain('civicrm');
84 $this->_phpgettext
= new CRM_Core_I18n_NativeGettext();
85 $this->_extensioncache
['civicrm'] = 'civicrm';
89 // Otherwise, use PHP-gettext
90 // we support both the old file hierarchy format and the new:
91 // pre-4.5: civicrm/l10n/xx_XX/civicrm.mo
92 // post-4.5: civicrm/l10n/xx_XX/LC_MESSAGES/civicrm.mo
93 require_once 'PHPgettext/streams.php';
94 require_once 'PHPgettext/gettext.php';
96 $mo_file = $config->gettextResourceDir
. $locale . DIRECTORY_SEPARATOR
. 'LC_MESSAGES' . DIRECTORY_SEPARATOR
. 'civicrm.mo';
98 if (!file_exists($mo_file)) {
99 // fallback to pre-4.5 mode
100 $mo_file = $config->gettextResourceDir
. $locale . DIRECTORY_SEPARATOR
. 'civicrm.mo';
103 $streamer = new FileReader($mo_file);
104 $this->_phpgettext
= new gettext_reader($streamer);
105 $this->_extensioncache
['civicrm'] = $this->_phpgettext
;
110 * Returns whether gettext is running natively or using PHP-Gettext.
113 * True if gettext is native
115 public function isNative() {
116 return $this->_nativegettext
;
120 * Return languages available in this instance of CiviCRM.
122 * @param bool $justEnabled
123 * whether to return all languages or just the enabled ones.
126 * Array of code/language name mappings
128 public static function languages($justEnabled = FALSE) {
130 static $enabled = NULL;
133 $all = CRM_Contact_BAO_Contact
::buildOptions('preferred_language');
135 // check which ones are available; add them to $all if not there already
136 $config = CRM_Core_Config
::singleton();
138 if (is_dir($config->gettextResourceDir
) && $dir = opendir($config->gettextResourceDir
)) {
139 while ($filename = readdir($dir)) {
140 if (preg_match('/^[a-z][a-z]_[A-Z][A-Z]$/', $filename)) {
141 $codes[] = $filename;
142 if (!isset($all[$filename])) {
143 $all[$filename] = $filename;
150 // drop the unavailable languages (except en_US)
151 foreach (array_keys($all) as $code) {
152 if ($code == 'en_US') {
155 if (!in_array($code, $codes)) {
161 if ($enabled === NULL) {
162 $config = CRM_Core_Config
::singleton();
164 if (isset($config->languageLimit
) and $config->languageLimit
) {
165 foreach ($all as $code => $name) {
166 if (in_array($code, array_keys($config->languageLimit
))) {
167 $enabled[$code] = $name;
173 return $justEnabled ?
$enabled : $all;
177 * Replace arguments in a string with their values. Arguments are represented by % followed by their number.
185 public function strarg($str) {
188 for ($i = 1; $i < func_num_args(); $i++
) {
189 $arg = func_get_arg($i);
190 if (is_array($arg)) {
191 foreach ($arg as $aarg) {
192 $tr['%' . ++
$p] = $aarg;
196 $tr['%' . ++
$p] = $arg;
199 return strtr($str, $tr);
203 * Smarty block function, provides gettext support for smarty.
205 * The block content is the text that should be translated.
207 * Any parameter that is sent to the function will be represented as %n in the translation text,
208 * where n is 1 for the first parameter. The following parameters are reserved:
209 * - escape - sets escape mode:
210 * - 'html' for HTML escaping, this is the default.
211 * - 'js' for javascript escaping.
212 * - 'no'/'off'/0 - turns off escaping
213 * - plural - The plural version of the text (2nd parameter of ngettext())
214 * - count - The item count for plural mode (3rd parameter of ngettext())
215 * - context - gettext context of that string (for homonym handling)
217 * @param string $text
218 * the original string.
219 * @param array $params
220 * The params of the translation (if any).
221 * - domain: string|array a list of translation domains to search (in order)
224 * the translated string
226 public function crm_translate($text, $params = array()) {
227 if (isset($params['escape'])) {
228 $escape = $params['escape'];
229 unset($params['escape']);
232 // sometimes we need to {ts}-tag a string, but don’t want to
233 // translate it in the template (like civicrm_navigation.tpl),
234 // because we handle the translation in a different way (CRM-6998)
235 // in such cases we return early, only doing SQL/JS escaping
236 if (isset($params['skip']) and $params['skip']) {
237 if (isset($escape) and ($escape == 'sql')) {
238 $text = CRM_Core_DAO
::escapeString($text);
240 if (isset($escape) and ($escape == 'js')) {
241 $text = addcslashes($text, "'");
246 $plural = $count = NULL;
247 if (isset($params['plural'])) {
248 $plural = $params['plural'];
249 unset($params['plural']);
250 if (isset($params['count'])) {
251 $count = $params['count'];
255 if (isset($params['context'])) {
256 $context = $params['context'];
257 unset($params['context']);
263 if (isset($params['domain'])) {
264 $domain = $params['domain'];
265 unset($params['domain']);
271 $raw = !empty($params['raw']);
272 unset($params['raw']);
274 if (!empty($domain)) {
275 // It might be prettier to cast to an array, but this is high-traffic stuff.
276 if (is_array($domain)) {
277 foreach ($domain as $d) {
278 $candidate = $this->crm_translate_raw($text, $d, $count, $plural, $context);
279 if ($candidate != $text) {
286 $text = $this->crm_translate_raw($text, $domain, $count, $plural, $context);
290 $text = $this->crm_translate_raw($text, NULL, $count, $plural, $context);
293 // replace the numbered %1, %2, etc. params if present
294 if (count($params) && !$raw) {
295 $text = $this->strarg($text, $params);
298 // escape SQL if we were asked for it
299 if (isset($escape) and ($escape == 'sql')) {
300 $text = CRM_Core_DAO
::escapeString($text);
303 // escape for JavaScript (if requested)
304 if (isset($escape) and ($escape == 'js')) {
305 $text = addcslashes($text, "'");
312 * Lookup the raw translation of a string (without any extra escaping or interpolation).
314 * @param string $text
315 * @param string|NULL $domain
316 * @param int|NULL $count
317 * @param string $plural
318 * @param string $context
319 * @return mixed|string|translated
321 protected function crm_translate_raw($text, $domain, $count, $plural, $context) {
322 // gettext domain for extensions
323 $domain_changed = FALSE;
324 if (!empty($domain) && $this->_phpgettext
) {
325 if ($this->setGettextDomain($domain)) {
326 $domain_changed = TRUE;
330 // do all wildcard translations first
331 $config = CRM_Core_Config
::singleton();
332 $stringTable = CRM_Utils_Array
::value(
334 $config->localeCustomStrings
338 if (isset($stringTable['enabled']['exactMatch'])) {
339 foreach ($stringTable['enabled']['exactMatch'] as $search => $replace) {
340 if ($search === $text) {
350 isset($stringTable['enabled']['wildcardMatch'])
352 $search = array_keys($stringTable['enabled']['wildcardMatch']);
353 $replace = array_values($stringTable['enabled']['wildcardMatch']);
354 $text = str_replace($search, $replace, $text);
357 // dont translate if we've done exactMatch already
359 // use plural if required parameters are set
360 if (isset($count) && isset($plural)) {
362 if ($this->_phpgettext
) {
363 $text = $this->_phpgettext
->ngettext($text, $plural, $count);
366 // if the locale's not set, we do ngettext work by hand
367 // if $count == 1 then $text = $text, else $text = $plural
373 // expand %count in translated string to $count
374 $text = strtr($text, array('%count' => $count));
376 // if not plural, but the locale's set, translate
378 elseif ($this->_phpgettext
) {
380 $text = $this->_phpgettext
->pgettext($context, $text);
383 $text = $this->_phpgettext
->translate($text);
388 if ($domain_changed) {
389 $this->setGettextDomain('civicrm');
396 * Translate a string to the current locale.
398 * @param string $string
399 * this string should be translated.
402 * the translated string
404 public function translate($string) {
405 return ($this->_phpgettext
) ?
$this->_phpgettext
->translate($string) : $string;
409 * Localize (destructively) array values.
411 * @param array $array
412 * the array for localization (in place).
413 * @param array $params
414 * an array of additional parameters.
418 public function localizeArray(
424 if ($tsLocale == 'en_US') {
428 foreach ($array as & $value) {
430 $value = ts($value, $params);
436 * Localize (destructively) array elements with keys of 'title'.
438 * @param array $array
439 * the array for localization (in place).
443 public function localizeTitles(&$array) {
444 foreach ($array as $key => $value) {
445 if (is_array($value)) {
446 $this->localizeTitles($value);
447 $array[$key] = $value;
449 elseif ((string ) $key == 'title') {
450 $array[$key] = ts($value, array('context' => 'menu'));
456 * Binds a gettext domain, wrapper over bindtextdomain().
459 * Key of the extension (can be 'civicrm', or 'org.example.foo').
462 * True if the domain was changed for an extension.
464 public function setGettextDomain($key) {
465 /* No domain changes for en_US */
466 if (!$this->_phpgettext
) {
470 // It's only necessary to find/bind once
471 if (!isset($this->_extensioncache
[$key])) {
472 $config = CRM_Core_Config
::singleton();
475 $mapper = CRM_Extension_System
::singleton()->getMapper();
476 $path = $mapper->keyToBasePath($key);
477 $info = $mapper->keyToInfo($key);
478 $domain = $info->file
;
480 if ($this->_nativegettext
) {
481 bindtextdomain($domain, $path . DIRECTORY_SEPARATOR
. 'l10n');
482 bind_textdomain_codeset($domain, 'UTF-8');
483 $this->_extensioncache
[$key] = $domain;
487 $mo_file = $path . DIRECTORY_SEPARATOR
. 'l10n' . DIRECTORY_SEPARATOR
. $config->lcMessages
. DIRECTORY_SEPARATOR
. 'LC_MESSAGES' . DIRECTORY_SEPARATOR
. $domain . '.mo';
488 $streamer = new FileReader($mo_file);
489 $this->_extensioncache
[$key] = new gettext_reader($streamer);
492 catch (CRM_Extension_Exception
$e) {
493 // Intentionally not translating this string to avoid possible infinite loops
494 // Only developers should see this string, if they made a mistake in their ts() usage.
495 CRM_Core_Session
::setStatus('Unknown extension key in a translation string: ' . $key, '', 'error');
496 $this->_extensioncache
[$key] = FALSE;
500 if (isset($this->_extensioncache
[$key]) && $this->_extensioncache
[$key]) {
501 if ($this->_nativegettext
) {
502 textdomain($this->_extensioncache
[$key]);
505 $this->_phpgettext
= $this->_extensioncache
[$key];
515 * Static instance provider - return the instance for the current locale.
517 * @return CRM_Core_I18n
519 public static function &singleton() {
520 static $singleton = array();
523 if (!isset($singleton[$tsLocale])) {
524 $singleton[$tsLocale] = new CRM_Core_I18n($tsLocale);
527 return $singleton[$tsLocale];
531 * Set the LC_TIME locale if it's not set already (for a given language choice).
534 * the final LC_TIME that got set
536 public static function setLcTime() {
537 static $locales = array();
540 if (!isset($locales[$tsLocale])) {
541 // with the config being set to pl_PL: try pl_PL.UTF-8,
542 // then pl_PL, if neither present fall back to C
543 $locales[$tsLocale] = setlocale(LC_TIME
, $tsLocale . '.UTF-8', $tsLocale, 'C');
546 return $locales[$tsLocale];
552 * Short-named function for string translation, defined in global scope so it's available everywhere.
555 * String string for translating.
556 * @param array $params
557 * Array an array of additional parameters.
560 * the translated string
562 function ts($text, $params = array()) {
563 static $config = NULL;
564 static $locale = NULL;
566 static $function = NULL;
573 $config = CRM_Core_Config
::singleton();
577 if (!$i18n or $locale != $tsLocale) {
578 $i18n = CRM_Core_I18n
::singleton();
580 if (isset($config->customTranslateFunction
) and function_exists($config->customTranslateFunction
)) {
581 $function = $config->customTranslateFunction
;
586 return $function($text, $params);
589 return $i18n->crm_translate($text, $params);