Blame view
sources/lib/private/l10n.php
14.6 KB
|
03e52840d
|
1 2 3 4 |
<?php /** * ownCloud * |
|
31b7f2792
|
5 |
* @author Frank Karlitschek |
|
03e52840d
|
6 7 |
* @author Jakob Sack * @copyright 2012 Frank Karlitschek frank@owncloud.org |
|
31b7f2792
|
8 |
* @copyright 2013 Jakob Sack |
|
03e52840d
|
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
* * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE * License as published by the Free Software Foundation; either * version 3 of the License, or any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU AFFERO GENERAL PUBLIC LICENSE for more details. * * You should have received a copy of the GNU Affero General Public * License along with this library. If not, see <http://www.gnu.org/licenses/>. * */ /** * This class is for i18n and l10n */ |
|
31b7f2792
|
28 |
class OC_L10N implements \OCP\IL10N {
|
|
03e52840d
|
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
/** * cache */ protected static $cache = array(); /** * The best language */ protected static $language = ''; /** * App of this object */ protected $app; /** * Language of this object */ protected $lang; /** * Translations */ private $translations = array(); /** |
|
31b7f2792
|
55 56 57 58 59 60 61 62 63 64 |
* Plural forms (string) */ private $plural_form_string = 'nplurals=2; plural=(n != 1);'; /** * Plural forms (function) */ private $plural_form_function = null; /** |
|
03e52840d
|
65 66 67 68 69 70 71 72 73 74 75 |
* Localization */ private $localizations = array( 'jsdate' => 'dd.mm.yy', 'date' => '%d.%m.%Y', 'datetime' => '%d.%m.%Y %H:%M:%S', 'time' => '%H:%M:%S', 'firstday' => 0); /** * get an L10N instance |
|
6d9380f96
|
76 77 78 |
* @param string $app * @param string|null $lang * @return \OC_L10N |
|
03e52840d
|
79 80 |
*/
public static function get($app, $lang=null) {
|
|
31b7f2792
|
81 82 83 84 |
if (is_null($lang)) {
return OC::$server->getL10N($app);
} else {
return new \OC_L10N($app, $lang);
|
|
03e52840d
|
85 86 87 88 |
} } /** |
|
6d9380f96
|
89 90 91 |
* The constructor * @param string $app app requesting l10n * @param string $lang default: null Language |
|
03e52840d
|
92 93 94 95 96 97 98 99 |
*
* If language is not set, the constructor tries to find the right
* language.
*/
public function __construct($app, $lang = null) {
$this->app = $app;
$this->lang = $lang;
}
|
|
6d9380f96
|
100 101 102 |
/** * @param string $transFile */ |
|
31b7f2792
|
103 104 105 106 107 108 109 110 111 112 |
public function load($transFile) {
$this->app = true;
include $transFile;
if(isset($TRANSLATIONS) && is_array($TRANSLATIONS)) {
$this->translations = $TRANSLATIONS;
}
if(isset($PLURAL_FORMS)) {
$this->plural_form_string = $PLURAL_FORMS;
}
}
|
|
03e52840d
|
113 114 115 116 117 |
protected function init() {
if ($this->app === true) {
return;
}
$app = OC_App::cleanAppId($this->app);
|
|
6d9380f96
|
118 |
$lang = str_replace(array('\0', '/', '\\', '..'), '', $this->lang);
|
|
03e52840d
|
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
$this->app = true;
// Find the right language
if(is_null($lang) || $lang == '') {
$lang = self::findLanguage($app);
}
// Use cache if possible
if(array_key_exists($app.'::'.$lang, self::$cache)) {
$this->translations = self::$cache[$app.'::'.$lang]['t'];
$this->localizations = self::$cache[$app.'::'.$lang]['l'];
}
else{
$i18ndir = self::findI18nDir($app);
// Localization is in /l10n, Texts are in $i18ndir
// (Just no need to define date/time format etc. twice)
|
|
6d9380f96
|
135 136 137 138 |
if((OC_Helper::isSubDirectory($i18ndir.$lang.'.php', OC::$SERVERROOT.'/core/l10n/') || OC_Helper::isSubDirectory($i18ndir.$lang.'.php', OC::$SERVERROOT.'/lib/l10n/') || OC_Helper::isSubDirectory($i18ndir.$lang.'.php', OC::$SERVERROOT.'/settings') || OC_Helper::isSubDirectory($i18ndir.$lang.'.php', OC_App::getAppPath($app).'/l10n/') |
|
03e52840d
|
139 140 141 |
)
&& file_exists($i18ndir.$lang.'.php')) {
// Include the file, save the data from $CONFIG
|
|
31b7f2792
|
142 143 |
$transFile = strip_tags($i18ndir).strip_tags($lang).'.php'; include $transFile; |
|
03e52840d
|
144 145 |
if(isset($TRANSLATIONS) && is_array($TRANSLATIONS)) {
$this->translations = $TRANSLATIONS;
|
|
31b7f2792
|
146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
//merge with translations from theme
$theme = OC_Config::getValue( "theme" );
if (!is_null($theme)) {
$transFile = OC::$SERVERROOT.'/themes/'.$theme.substr($transFile, strlen(OC::$SERVERROOT));
if (file_exists($transFile)) {
include $transFile;
if (isset($TRANSLATIONS) && is_array($TRANSLATIONS)) {
$this->translations = array_merge($this->translations, $TRANSLATIONS);
}
}
}
}
if(isset($PLURAL_FORMS)) {
$this->plural_form_string = $PLURAL_FORMS;
|
|
03e52840d
|
160 161 |
} } |
|
6d9380f96
|
162 |
if(file_exists(OC::$SERVERROOT.'/core/l10n/l10n-'.$lang.'.php') && OC_Helper::isSubDirectory(OC::$SERVERROOT.'/core/l10n/l10n-'.$lang.'.php', OC::$SERVERROOT.'/core/l10n/')) {
|
|
03e52840d
|
163 164 165 166 167 168 169 170 171 172 173 174 175 |
// Include the file, save the data from $CONFIG
include OC::$SERVERROOT.'/core/l10n/l10n-'.$lang.'.php';
if(isset($LOCALIZATIONS) && is_array($LOCALIZATIONS)) {
$this->localizations = array_merge($this->localizations, $LOCALIZATIONS);
}
}
self::$cache[$app.'::'.$lang]['t'] = $this->translations;
self::$cache[$app.'::'.$lang]['l'] = $this->localizations;
}
}
/**
|
|
6d9380f96
|
176 |
* Creates a function that The constructor |
|
31b7f2792
|
177 178 179 180 181 182 |
* * If language is not set, the constructor tries to find the right * language. * * Parts of the code is copied from Habari: * https://github.com/habari/system/blob/master/classes/locale.php |
|
6d9380f96
|
183 |
* @param string $string |
|
31b7f2792
|
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
* @return string
*/
protected function createPluralFormFunction($string){
if(preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) {
// sanitize
$nplurals = preg_replace( '/[^0-9]/', '', $matches[1] );
$plural = preg_replace( '#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2] );
$body = str_replace(
array( 'plural', 'n', '$n$plurals', ),
array( '$plural', '$n', '$nplurals', ),
'nplurals='. $nplurals . '; plural=' . $plural
);
// add parents
// important since PHP's ternary evaluates from left to right
$body .= ';';
$res = '';
$p = 0;
for($i = 0; $i < strlen($body); $i++) {
$ch = $body[$i];
switch ( $ch ) {
case '?':
$res .= ' ? (';
$p++;
break;
case ':':
$res .= ') : (';
break;
case ';':
$res .= str_repeat( ')', $p ) . ';';
$p = 0;
break;
default:
$res .= $ch;
}
}
$body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);';
return create_function('$n', $body);
}
else {
// default: one plural form for all cases but n==1 (english)
return create_function(
'$n',
'$nplurals=2;$plural=($n==1?0:1);return ($plural>=$nplurals?$nplurals-1:$plural);'
);
}
}
/**
|
|
6d9380f96
|
235 236 |
* Translating * @param string $text The text we need a translation for |
|
03e52840d
|
237 238 239 240 241 242 243 244 245 246 247 |
* @param array $parameters default:array() Parameters for sprintf
* @return \OC_L10N_String Translation or the same text
*
* Returns the translation. If no translation is found, $text will be
* returned.
*/
public function t($text, $parameters = array()) {
return new OC_L10N_String($this, $text, $parameters);
}
/**
|
|
6d9380f96
|
248 249 250 251 |
* Translating * @param string $text_singular the string to translate for exactly one object * @param string $text_plural the string to translate for n objects * @param integer $count Number of objects |
|
31b7f2792
|
252 253 254 255 256 257 258 259 260 261 262 263 |
* @param array $parameters default:array() Parameters for sprintf
* @return \OC_L10N_String Translation or the same text
*
* Returns the translation. If no translation is found, $text will be
* returned. %n will be replaced with the number of objects.
*
* The correct plural is determined by the plural_forms-function
* provided by the po file.
*
*/
public function n($text_singular, $text_plural, $count, $parameters = array()) {
$this->init();
|
|
923852aa1
|
264 |
$identifier = "_${text_singular}_::_${text_plural}_";
|
|
31b7f2792
|
265 266 |
if( array_key_exists($identifier, $this->translations)) {
return new OC_L10N_String( $this, $identifier, $parameters, $count );
|
|
6d9380f96
|
267 |
}else{
|
|
31b7f2792
|
268 269 |
if($count === 1) {
return new OC_L10N_String($this, $text_singular, $parameters, $count);
|
|
6d9380f96
|
270 |
}else{
|
|
31b7f2792
|
271 272 273 274 275 276 |
return new OC_L10N_String($this, $text_plural, $parameters, $count); } } } /** |
|
6d9380f96
|
277 278 |
* getTranslations * @return array Fetch all translations |
|
03e52840d
|
279 280 281 282 283 284 285 286 287 |
*
* Returns an associative array with all translations
*/
public function getTranslations() {
$this->init();
return $this->translations;
}
/**
|
|
6d9380f96
|
288 289 |
* getPluralFormString * @return string containing the gettext "Plural-Forms"-string |
|
31b7f2792
|
290 291 292 293 294 295 296 297 298 |
*
* Returns a string like "nplurals=2; plural=(n != 1);"
*/
public function getPluralFormString() {
$this->init();
return $this->plural_form_string;
}
/**
|
|
6d9380f96
|
299 300 |
* getPluralFormFunction * @return string the plural form function |
|
31b7f2792
|
301 302 303 304 305 306 307 308 309 310 311 312 |
*
* returned function accepts the argument $n
*/
public function getPluralFormFunction() {
$this->init();
if(is_null($this->plural_form_function)) {
$this->plural_form_function = $this->createPluralFormFunction($this->plural_form_string);
}
return $this->plural_form_function;
}
/**
|
|
6d9380f96
|
313 314 |
* get localizations * @return array Fetch all localizations |
|
31b7f2792
|
315 316 317 318 319 320 321 322 323 |
*
* Returns an associative array with all localizations
*/
public function getLocalizations() {
$this->init();
return $this->localizations;
}
/**
|
|
6d9380f96
|
324 325 326 327 |
* Localization * @param string $type Type of localization * @param array|int|string $data parameters for this localization * @return String or false |
|
03e52840d
|
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 |
*
* Returns the localized data.
*
* Implemented types:
* - date
* - Creates a date
* - l10n-field: date
* - params: timestamp (int/string)
* - datetime
* - Creates date and time
* - l10n-field: datetime
* - params: timestamp (int/string)
* - time
* - Creates a time
* - l10n-field: time
* - params: timestamp (int/string)
*/
public function l($type, $data) {
$this->init();
switch($type) {
// If you add something don't forget to add it to $localizations
// at the top of the page
case 'date':
case 'datetime':
case 'time':
if($data instanceof DateTime) {
return $data->format($this->localizations[$type]);
} elseif(is_string($data) && !is_numeric($data)) {
$data = strtotime($data);
}
$locales = array(self::findLanguage());
if (strlen($locales[0]) == 2) {
$locales[] = $locales[0].'_'.strtoupper($locales[0]);
}
setlocale(LC_TIME, $locales);
$format = $this->localizations[$type];
// Check for Windows to find and replace the %e modifier correctly
if (strtoupper(substr(PHP_OS, 0, 3)) == 'WIN') {
$format = preg_replace('#(?<!%)((?:%%)*)%e#', '\1%#d', $format);
}
return strftime($format, $data);
break;
case 'firstday':
case 'jsdate':
return $this->localizations[$type];
default:
return false;
}
}
/**
|
|
6d9380f96
|
379 380 381 |
* Choose a language * @param array $text Associative Array with possible strings * @return String |
|
03e52840d
|
382 383 384 385 386 387 388 389 390 391 392 393 |
*
* $text is an array 'de' => 'hallo welt', 'en' => 'hello world', ...
*
* This function is useful to avoid loading thousands of files if only one
* simple string is needed, for example in appinfo.php
*/
public static function selectLanguage($text) {
$lang = self::findLanguage(array_keys($text));
return $text[$lang];
}
/**
|
|
6d9380f96
|
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
* The given language is forced to be used while executing the current request
* @param string $lang
*/
public static function forceLanguage($lang) {
self::$language = $lang;
}
/**
* find the best language
*
* @param array|string $app details below
*
* If $app is an array, ownCloud assumes that these are the available
* languages. Otherwise ownCloud tries to find the files in the l10n
* folder.
*
* If nothing works it returns 'en'
* @return string language
*/
public function getLanguageCode($app=null) {
return self::findLanguage($app);
}
/**
* find the best language
* @param array|string $app details below
* @return string language
|
|
03e52840d
|
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 |
*
* If $app is an array, ownCloud assumes that these are the available
* languages. Otherwise ownCloud tries to find the files in the l10n
* folder.
*
* If nothing works it returns 'en'
*/
public static function findLanguage($app = null) {
if(!is_array($app) && self::$language != '') {
return self::$language;
}
if(OC_User::getUser() && OC_Preferences::getValue(OC_User::getUser(), 'core', 'lang')) {
$lang = OC_Preferences::getValue(OC_User::getUser(), 'core', 'lang');
self::$language = $lang;
if(is_array($app)) {
$available = $app;
$lang_exists = array_search($lang, $available) !== false;
|
|
31b7f2792
|
441 |
} else {
|
|
03e52840d
|
442 443 444 445 446 447 448 449 |
$lang_exists = self::languageExists($app, $lang);
}
if($lang_exists) {
return $lang;
}
}
$default_language = OC_Config::getValue('default_language', false);
|
|
31b7f2792
|
450 |
if($default_language !== false) {
|
|
03e52840d
|
451 452 453 454 |
return $default_language;
}
if(isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
|
|
03e52840d
|
455 456 |
if(is_array($app)) {
$available = $app;
|
|
31b7f2792
|
457 |
} else {
|
|
03e52840d
|
458 459 |
$available = self::findAvailableLanguages($app); } |
|
31b7f2792
|
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
// E.g. make sure that 'de' is before 'de_DE'.
sort($available);
$preferences = preg_split('/,\s*/', strtolower($_SERVER['HTTP_ACCEPT_LANGUAGE']));
foreach($preferences as $preference) {
list($preferred_language) = explode(';', $preference);
$preferred_language = str_replace('-', '_', $preferred_language);
foreach($available as $available_language) {
if ($preferred_language === strtolower($available_language)) {
if (is_null($app)) {
self::$language = $available_language;
}
return $available_language;
}
|
|
03e52840d
|
475 |
} |
|
31b7f2792
|
476 477 478 479 480 481 |
foreach($available as $available_language) {
if (substr($preferred_language, 0, 2) === $available_language) {
if (is_null($app)) {
self::$language = $available_language;
}
return $available_language;
|
|
03e52840d
|
482 483 484 485 486 487 488 489 490 491 |
} } } } // Last try: English return 'en'; } /** |
|
6d9380f96
|
492 493 494 |
* find the l10n directory * @param string $app App that needs to be translated * @return directory |
|
03e52840d
|
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 |
*/
protected static function findI18nDir($app) {
// find the i18n dir
$i18ndir = OC::$SERVERROOT.'/core/l10n/';
if($app != '') {
// Check if the app is in the app folder
if(file_exists(OC_App::getAppPath($app).'/l10n/')) {
$i18ndir = OC_App::getAppPath($app).'/l10n/';
}
else{
$i18ndir = OC::$SERVERROOT.'/'.$app.'/l10n/';
}
}
return $i18ndir;
}
/**
|
|
6d9380f96
|
512 513 514 |
* find all available languages for an app * @param string $app App that needs to be translated * @return array an array of available languages |
|
03e52840d
|
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 |
*/
public static function findAvailableLanguages($app=null) {
$available=array('en');//english is always available
$dir = self::findI18nDir($app);
if(is_dir($dir)) {
$files=scandir($dir);
foreach($files as $file) {
if(substr($file, -4, 4) === '.php' && substr($file, 0, 4) !== 'l10n') {
$i = substr($file, 0, -4);
$available[] = $i;
}
}
}
return $available;
}
|
|
6d9380f96
|
530 531 532 533 534 |
/** * @param string $app * @param string $lang * @return bool */ |
|
03e52840d
|
535 536 537 538 539 540 541 542 543 544 545 |
public static function languageExists($app, $lang) {
if ($lang == 'en') {//english is always available
return true;
}
$dir = self::findI18nDir($app);
if(is_dir($dir)) {
return file_exists($dir.'/'.$lang.'.php');
}
return false;
}
}
|