3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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).
223 * the translated string
225 public function crm_translate($text, $params = array()) {
226 if (isset($params['escape'])) {
227 $escape = $params['escape'];
228 unset($params['escape']);
231 // sometimes we need to {ts}-tag a string, but don’t want to
232 // translate it in the template (like civicrm_navigation.tpl),
233 // because we handle the translation in a different way (CRM-6998)
234 // in such cases we return early, only doing SQL/JS escaping
235 if (isset($params['skip']) and $params['skip']) {
236 if (isset($escape) and ($escape == 'sql')) {
237 $text = CRM_Core_DAO
::escapeString($text);
239 if (isset($escape) and ($escape == 'js')) {
240 $text = addcslashes($text, "'");
245 if (isset($params['plural'])) {
246 $plural = $params['plural'];
247 unset($params['plural']);
248 if (isset($params['count'])) {
249 $count = $params['count'];
253 if (isset($params['context'])) {
254 $context = $params['context'];
255 unset($params['context']);
261 // gettext domain for extensions
262 $domain_changed = FALSE;
263 if (!empty($params['domain']) && $this->_phpgettext
) {
264 if ($this->setGettextDomain($params['domain'])) {
265 $domain_changed = TRUE;
269 // do all wildcard translations first
270 $config = CRM_Core_Config
::singleton();
271 $stringTable = CRM_Utils_Array
::value(
273 $config->localeCustomStrings
277 if (isset($stringTable['enabled']['exactMatch'])) {
278 foreach ($stringTable['enabled']['exactMatch'] as $search => $replace) {
279 if ($search === $text) {
289 isset($stringTable['enabled']['wildcardMatch'])
291 $search = array_keys($stringTable['enabled']['wildcardMatch']);
292 $replace = array_values($stringTable['enabled']['wildcardMatch']);
293 $text = str_replace($search, $replace, $text);
296 // dont translate if we've done exactMatch already
298 // use plural if required parameters are set
299 if (isset($count) && isset($plural)) {
301 if ($this->_phpgettext
) {
302 $text = $this->_phpgettext
->ngettext($text, $plural, $count);
305 // if the locale's not set, we do ngettext work by hand
306 // if $count == 1 then $text = $text, else $text = $plural
312 // expand %count in translated string to $count
313 $text = strtr($text, array('%count' => $count));
315 // if not plural, but the locale's set, translate
317 elseif ($this->_phpgettext
) {
319 $text = $this->_phpgettext
->pgettext($context, $text);
322 $text = $this->_phpgettext
->translate($text);
327 // replace the numbered %1, %2, etc. params if present
328 if (count($params)) {
329 $text = $this->strarg($text, $params);
332 // escape SQL if we were asked for it
333 if (isset($escape) and ($escape == 'sql')) {
334 $text = CRM_Core_DAO
::escapeString($text);
337 // escape for JavaScript (if requested)
338 if (isset($escape) and ($escape == 'js')) {
339 $text = addcslashes($text, "'");
342 if ($domain_changed) {
343 $this->setGettextDomain('civicrm');
350 * Translate a string to the current locale.
352 * @param string $string
353 * this string should be translated.
356 * the translated string
358 public function translate($string) {
359 return ($this->_phpgettext
) ?
$this->_phpgettext
->translate($string) : $string;
363 * Localize (destructively) array values.
365 * @param array $array
366 * the array for localization (in place).
367 * @param array $params
368 * an array of additional parameters.
372 public function localizeArray(
378 if ($tsLocale == 'en_US') {
382 foreach ($array as & $value) {
384 $value = ts($value, $params);
390 * Localize (destructively) array elements with keys of 'title'.
392 * @param array $array
393 * the array for localization (in place).
397 public function localizeTitles(&$array) {
398 foreach ($array as $key => $value) {
399 if (is_array($value)) {
400 $this->localizeTitles($value);
401 $array[$key] = $value;
403 elseif ((string ) $key == 'title') {
404 $array[$key] = ts($value, array('context' => 'menu'));
410 * Binds a gettext domain, wrapper over bindtextdomain().
413 * Key of the extension (can be 'civicrm', or 'org.example.foo').
416 * True if the domain was changed for an extension.
418 public function setGettextDomain($key) {
419 /* No domain changes for en_US */
420 if (!$this->_phpgettext
) {
424 // It's only necessary to find/bind once
425 if (!isset($this->_extensioncache
[$key])) {
426 $config = CRM_Core_Config
::singleton();
429 $mapper = CRM_Extension_System
::singleton()->getMapper();
430 $path = $mapper->keyToBasePath($key);
431 $info = $mapper->keyToInfo($key);
432 $domain = $info->file
;
434 if ($this->_nativegettext
) {
435 bindtextdomain($domain, $path . DIRECTORY_SEPARATOR
. 'l10n');
436 bind_textdomain_codeset($domain, 'UTF-8');
437 $this->_extensioncache
[$key] = $domain;
441 $mo_file = $path . DIRECTORY_SEPARATOR
. 'l10n' . DIRECTORY_SEPARATOR
. $config->lcMessages
. DIRECTORY_SEPARATOR
. 'LC_MESSAGES' . DIRECTORY_SEPARATOR
. $domain . '.mo';
442 $streamer = new FileReader($mo_file);
443 $this->_extensioncache
[$key] = new gettext_reader($streamer);
446 catch (CRM_Extension_Exception
$e) {
447 // Intentionally not translating this string to avoid possible infinit loops
448 // Only developers should see this string, if they made a mistake in their ts() usage.
449 CRM_Core_Session
::setStatus('Unknown extension key in a translation string: ' . $key, '', 'error');
450 $this->_extensioncache
[$key] = FALSE;
454 if (isset($this->_extensioncache
[$key]) && $this->_extensioncache
[$key]) {
455 if ($this->_nativegettext
) {
456 textdomain($this->_extensioncache
[$key]);
459 $this->_phpgettext
= $this->_extensioncache
[$key];
469 * Static instance provider - return the instance for the current locale.
471 public static function &singleton() {
472 static $singleton = array();
475 if (!isset($singleton[$tsLocale])) {
476 $singleton[$tsLocale] = new CRM_Core_I18n($tsLocale);
479 return $singleton[$tsLocale];
483 * Set the LC_TIME locale if it's not set already (for a given language choice).
486 * the final LC_TIME that got set
488 public static function setLcTime() {
489 static $locales = array();
492 if (!isset($locales[$tsLocale])) {
493 // with the config being set to pl_PL: try pl_PL.UTF-8,
494 // then pl_PL, if neither present fall back to C
495 $locales[$tsLocale] = setlocale(LC_TIME
, $tsLocale . '.UTF-8', $tsLocale, 'C');
498 return $locales[$tsLocale];
503 * Short-named function for string translation, defined in global scope so it's available everywhere.
506 * String string for translating.
507 * @param array $params
508 * Array an array of additional parameters.
511 * the translated string
513 function ts($text, $params = array()) {
514 static $config = NULL;
515 static $locale = NULL;
517 static $function = NULL;
524 $config = CRM_Core_Config
::singleton();
528 if (!$i18n or $locale != $tsLocale) {
529 $i18n = CRM_Core_I18n
::singleton();
531 if (isset($config->customTranslateFunction
) and function_exists($config->customTranslateFunction
)) {
532 $function = $config->customTranslateFunction
;
537 return $function($text, $params);
540 return $i18n->crm_translate($text, $params);