nextcloud/lib/l10n.php

343 lines
8.8 KiB
PHP
Raw Normal View History

2011-06-19 16:27:52 +04:00
<?php
/**
* ownCloud
*
* @author Jakob Sack
2012-05-26 21:14:24 +04:00
* @copyright 2012 Frank Karlitschek frank@owncloud.org
2011-06-19 16:27:52 +04:00
*
* 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
*/
class OC_L10N{
2012-04-14 18:44:15 +04:00
/**
* cached instances
*/
protected static $instances=array();
2012-08-29 10:38:33 +04:00
2011-06-19 16:27:52 +04:00
/**
* cache
*/
protected static $cache = array();
2012-08-29 10:38:33 +04:00
2011-06-19 16:27:52 +04:00
/**
* The best language
*/
protected static $language = '';
2012-08-29 10:38:33 +04:00
/**
* App of this object
*/
protected $app;
/**
* Language of this object
*/
protected $lang;
2011-06-19 16:27:52 +04:00
/**
* Translations
*/
private $translations = array();
2012-08-29 10:38:33 +04:00
2011-06-19 16:27:52 +04:00
/**
* Localization
*/
private $localizations = array(
'date' => 'd.m.Y',
'datetime' => 'd.m.Y H:i:s',
'time' => 'H:i:s');
2012-08-29 10:38:33 +04:00
2012-04-14 18:44:15 +04:00
/**
* get an L10N instance
* @return OC_L10N
*/
2012-09-07 17:22:01 +04:00
public static function get($app,$lang=null) {
if(is_null($lang)) {
if(!isset(self::$instances[$app])) {
2012-04-14 18:44:15 +04:00
self::$instances[$app]=new OC_L10N($app);
}
return self::$instances[$app];
}else{
return new OC_L10N($app,$lang);
}
}
2012-08-29 10:38:33 +04:00
2011-06-19 16:27:52 +04:00
/**
* @brief The constructor
* @param $app the app requesting l10n
* @param $lang default: null Language
* @returns OC_L10N-Object
*
* If language is not set, the constructor tries to find the right
* language.
*/
2012-09-07 17:22:01 +04:00
public function __construct($app, $lang = null) {
$this->app = $app;
$this->lang = $lang;
2012-06-07 19:25:25 +04:00
}
2012-08-29 10:38:33 +04:00
2012-09-07 17:22:01 +04:00
protected function init() {
if ($this->app === true) {
return;
}
$app = $this->app;
$lang = $this->lang;
$this->app = true;
2011-06-19 16:27:52 +04:00
// Find the right language
if(is_null($lang) || $lang == '') {
$lang = self::findLanguage($app);
2011-06-19 16:27:52 +04:00
}
// Use cache if possible
2012-09-07 17:22:01 +04:00
if(array_key_exists($app.'::'.$lang, self::$cache)) {
2011-06-19 20:53:02 +04:00
2011-06-19 16:27:52 +04:00
$this->translations = self::$cache[$app.'::'.$lang]['t'];
$this->localizations = self::$cache[$app.'::'.$lang]['l'];
}
else{
$i18ndir = self::findI18nDir($app);
2011-06-19 16:27:52 +04:00
// Localization is in /l10n, Texts are in $i18ndir
// (Just no need to define date/time format etc. twice)
2012-09-07 16:05:51 +04:00
if((OC_Helper::issubdirectory($i18ndir.$lang.'.php', OC_App::getAppPath($app).'/l10n/') ||
OC_Helper::issubdirectory($i18ndir.$lang.'.php', OC::$SERVERROOT.'/core/l10n/') ||
OC_Helper::issubdirectory($i18ndir.$lang.'.php', OC::$SERVERROOT.'/lib/l10n/') ||
2012-08-31 02:43:50 +04:00
OC_Helper::issubdirectory($i18ndir.$lang.'.php', OC::$SERVERROOT.'/settings')) && file_exists($i18ndir.$lang.'.php')) {
2011-06-19 16:27:52 +04:00
// Include the file, save the data from $CONFIG
2012-07-01 23:50:53 +04:00
include(strip_tags($i18ndir).strip_tags($lang).'.php');
2012-09-07 17:22:01 +04:00
if(isset($TRANSLATIONS) && is_array($TRANSLATIONS)) {
2011-06-19 16:27:52 +04:00
$this->translations = $TRANSLATIONS;
}
2012-08-29 10:38:33 +04:00
}
2011-06-19 16:27:52 +04:00
2012-09-07 17:22:01 +04:00
if(file_exists(OC::$SERVERROOT.'/core/l10n/l10n-'.$lang.'.php')) {
2011-06-19 16:27:52 +04:00
// Include the file, save the data from $CONFIG
include(OC::$SERVERROOT.'/core/l10n/l10n-'.$lang.'.php');
2012-09-07 17:22:01 +04:00
if(isset($LOCALIZATIONS) && is_array($LOCALIZATIONS)) {
$this->localizations = array_merge($this->localizations, $LOCALIZATIONS);
2011-06-19 16:27:52 +04:00
}
}
self::$cache[$app.'::'.$lang]['t'] = $this->translations;
self::$cache[$app.'::'.$lang]['l'] = $this->localizations;
}
}
2012-09-04 23:01:36 +04:00
/**
* @brief Translating
* @param $text String The text we need a translation for
2012-09-23 04:39:11 +04:00
* @param array $parameters default:array() Parameters for sprintf
2012-09-04 23:01:36 +04:00
* @return \OC_L10N_String Translation or the same text
*
* Returns the translation. If no translation is found, $text will be
* returned.
*/
2012-09-07 17:22:01 +04:00
public function t($text, $parameters = array()) {
return new OC_L10N_String($this, $text, $parameters);
2011-06-19 16:27:52 +04:00
}
/**
* @brief Translating
* @param $textArray The text array we need a translation for
* @returns Translation or the same text
*
* Returns the translation. If no translation is found, $textArray will be
* returned.
*
*
* @deprecated deprecated since ownCloud version 5.0
* This method will probably be removed with ownCloud 6.0
*
*
*/
2012-09-07 17:22:01 +04:00
public function tA($textArray) {
OC_Log::write('core', 'DEPRECATED: the method tA is deprecated and will be removed soon.',OC_Log::WARN);
$result = array();
2012-09-07 17:22:01 +04:00
foreach($textArray as $key => $text) {
$result[$key] = (string)$this->t($text);
}
return $result;
}
2011-06-20 01:33:34 +04:00
/**
* @brief getTranslations
* @returns Fetch all translations
*
* Returns an associative array with all translations
*/
2012-09-07 17:22:01 +04:00
public function getTranslations() {
$this->init();
2011-06-20 01:33:34 +04:00
return $this->translations;
}
2011-06-19 16:27:52 +04:00
/**
* @brief Localization
* @param $type Type of localization
* @param $params parameters for this localization
* @returns String or false
*
* Returns the localized data.
2012-08-29 10:38:33 +04:00
*
2011-06-19 16:27:52 +04:00
* Implemented types:
* - date
* - Creates a date
* - l10n-field: date
2011-06-19 21:38:51 +04:00
* - params: timestamp (int/string)
2011-06-19 16:27:52 +04:00
* - datetime
* - Creates date and time
* - l10n-field: datetime
2011-06-19 21:38:51 +04:00
* - params: timestamp (int/string)
2011-06-19 16:27:52 +04:00
* - time
* - Creates a time
* - l10n-field: time
2011-06-19 21:38:51 +04:00
* - params: timestamp (int/string)
2011-06-19 16:27:52 +04:00
*/
2012-09-07 17:22:01 +04:00
public function l($type, $data) {
$this->init();
2012-09-07 17:22:01 +04:00
switch($type) {
2011-06-19 21:38:51 +04:00
// If you add something don't forget to add it to $localizations
// at the top of the page
2011-06-19 16:27:52 +04:00
case 'date':
case 'datetime':
case 'time':
if($data instanceof DateTime) return $data->format($this->localizations[$type]);
elseif(is_string($data)) $data = strtotime($data);
return date($this->localizations[$type], $data);
2011-06-19 16:27:52 +04:00
break;
default:
return false;
}
}
/**
* @brief Choose a language
* @param $texts Associative Array with possible strings
* @returns String
*
* $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
*/
2012-09-07 17:22:01 +04:00
public static function selectLanguage($text) {
$lang = self::findLanguage(array_keys($text));
2011-06-19 16:27:52 +04:00
return $text[$lang];
}
/**
* @brief find the best language
* @param $app Array or string, details below
* @returns language
*
* If $app is an array, ownCloud assumes that these are the available
2012-08-29 10:38:33 +04:00
* languages. Otherwise ownCloud tries to find the files in the l10n
2011-06-19 16:27:52 +04:00
* folder.
*
* If nothing works it returns 'en'
*/
2012-09-07 17:22:01 +04:00
public static function findLanguage($app = null) {
if(!is_array($app) && self::$language != '') {
2011-06-19 16:27:52 +04:00
return self::$language;
}
2012-09-07 17:22:01 +04:00
if(OC_User::getUser() && OC_Preferences::getValue(OC_User::getUser(), 'core', 'lang')) {
$lang = OC_Preferences::getValue(OC_User::getUser(), 'core', 'lang');
2011-06-19 16:27:52 +04:00
self::$language = $lang;
2012-09-07 17:22:01 +04:00
if(is_array($app)) {
$available = $app;
$lang_exists = array_search($lang, $available) !== false;
}
else {
$lang_exists = self::languageExists($app, $lang);
}
2012-09-07 17:22:01 +04:00
if($lang_exists) {
2011-06-19 16:27:52 +04:00
return $lang;
}
}
2012-09-07 17:22:01 +04:00
if(isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
$accepted_languages = preg_split('/,\s*/', $_SERVER['HTTP_ACCEPT_LANGUAGE']);
2012-09-07 17:22:01 +04:00
if(is_array($app)) {
$available = $app;
}
else{
$available = self::findAvailableLanguages($app);
}
2012-09-07 17:22:01 +04:00
foreach($accepted_languages as $i) {
$temp = explode(';', $i);
2012-09-07 17:22:01 +04:00
if(array_search($temp[0], $available) !== false) {
2011-06-19 16:27:52 +04:00
return $temp[0];
}
}
}
// Last try: English
return 'en';
}
/**
2011-06-20 01:33:34 +04:00
* @brief find the l10n directory
2011-06-19 16:27:52 +04:00
* @param $app App that needs to be translated
2011-06-20 01:33:34 +04:00
* @returns directory
2011-06-19 16:27:52 +04:00
*/
2012-09-07 17:22:01 +04:00
protected static function findI18nDir($app) {
2011-06-19 16:27:52 +04:00
// find the i18n dir
$i18ndir = OC::$SERVERROOT.'/core/l10n/';
2012-09-07 17:22:01 +04:00
if($app != '') {
2011-06-19 16:27:52 +04:00
// Check if the app is in the app folder
2012-09-07 17:22:01 +04:00
if(file_exists(OC_App::getAppPath($app).'/l10n/')) {
2012-06-02 02:05:20 +04:00
$i18ndir = OC_App::getAppPath($app).'/l10n/';
2011-06-19 16:27:52 +04:00
}
else{
$i18ndir = OC::$SERVERROOT.'/'.$app.'/l10n/';
2011-06-19 16:27:52 +04:00
}
}
return $i18ndir;
}
2011-06-20 16:33:02 +04:00
/**
* @brief find all available languages for an app
* @param $app App that needs to be translated
* @returns array an array of available languages
*/
2012-09-07 17:22:01 +04:00
public static function findAvailableLanguages($app=null) {
2011-06-20 16:33:02 +04:00
$available=array('en');//english is always available
$dir = self::findI18nDir($app);
2012-09-07 17:22:01 +04:00
if(is_dir($dir)) {
2012-04-14 18:28:36 +04:00
$files=scandir($dir);
2012-09-07 17:22:01 +04:00
foreach($files as $file) {
if(substr($file, -4, 4) == '.php') {
$i = substr($file, 0, -4);
2012-04-14 18:28:36 +04:00
$available[] = $i;
2011-06-20 16:33:02 +04:00
}
}
}
return $available;
}
2012-09-07 17:22:01 +04:00
public static function languageExists($app, $lang) {
if ($lang == 'en') {//english is always available
return true;
}
$dir = self::findI18nDir($app);
2012-09-07 17:22:01 +04:00
if(is_dir($dir)) {
return file_exists($dir.'/'.$lang.'.php');
}
return false;
}
}