X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FL10n.php;h=050c1907371983be027d54defafd183b37b9864d;hb=69984ac6bcf08a1c3ce8967ad3ec4ca954039b75;hp=4d538acb2faa3d7055aa4d77d673da3a91d99bdd;hpb=dfd48596d3c7092d55a37572cfa0ad21896ebcbd;p=friendica.git diff --git a/src/Core/L10n.php b/src/Core/L10n.php index 4d538acb2f..050c190737 100644 --- a/src/Core/L10n.php +++ b/src/Core/L10n.php @@ -1,58 +1,97 @@ . + * */ -namespace Friendica\Core; -use Friendica\BaseObject; -use Friendica\Database\DBA; -use Friendica\Core\Addon; -use Friendica\Core\Logger; -use Friendica\Core\System; +namespace Friendica\Core; -require_once 'boot.php'; -require_once 'include/dba.php'; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\Session\Capability\IHandleSessions; +use Friendica\Database\Database; +use Friendica\Util\Strings; /** * Provide Language, Translation, and Localization functions to the application * Localization can be referred to by the numeronym L10N (as in: "L", followed by ten more letters, and then "N"). */ -class L10n extends BaseObject +class L10n { + /** @var string The default language */ + const DEFAULT = 'en'; + /** @var string[] The language names in their language */ + const LANG_NAMES = [ + 'ar' => 'العربية', + 'bg' => 'Български', + 'ca' => 'Català', + 'cs' => 'Česky', + 'da-dk' => 'Dansk (Danmark)', + 'de' => 'Deutsch', + 'en-gb' => 'English (United Kingdom)', + 'en-us' => 'English (United States)', + 'en' => 'English (Default)', + 'eo' => 'Esperanto', + 'es' => 'Español', + 'et' => 'Eesti', + 'fi-fi' => 'Suomi', + 'fr' => 'Français', + 'hu' => 'Magyar', + 'is' => 'Íslenska', + 'it' => 'Italiano', + 'ja' => '日本語', + 'nb-no' => 'Norsk bokmål', + 'nl' => 'Nederlands', + 'pl' => 'Polski', + 'pt-br' => 'Português Brasileiro', + 'ro' => 'Română', + 'ru' => 'Русский', + 'sv' => 'Svenska', + 'zh-cn' => '简体中文', + ]; + /** * A string indicating the current language used for translation: * - Two-letter ISO 639-1 code. * - Two-letter ISO 639-1 code + dash + Two-letter ISO 3166-1 alpha-2 country code. - * @var string - */ - private static $lang = ''; - /** - * A language code saved for later after pushLang() has been called. * * @var string */ - private static $langSave = ''; + private $lang = ''; /** * An array of translation strings whose key is the neutral english message. * * @var array */ - private static $strings = []; - /** - * An array of translation strings saved for later after pushLang() has been called. - * - * @var array - */ - private static $stringsSave = []; + private $strings = []; /** - * Detects the language and sets the translation table + * @var Database */ - public static function init() + private $dba; + + public function __construct(IManageConfigValues $config, Database $dba, IHandleSessions $session, array $server, array $get) { - $lang = self::detectLanguage(); - self::loadTranslationTable($lang); + $this->dba = $dba; + + $this->loadTranslationTable(L10n::detectLanguage($server, $get, $config->get('system', 'language', self::DEFAULT))); + $this->setSessionVariable($session); + $this->setLangFromSession($session); } /** @@ -60,188 +99,184 @@ class L10n extends BaseObject * * @return string Language code */ - public static function getCurrentLang() + public function getCurrentLang() { - return self::$lang; + return $this->lang; } /** * Sets the language session variable */ - public static function setSessionVariable() + private function setSessionVariable(IHandleSessions $session) { - if (!empty($_SESSION['authenticated']) && empty($_SESSION['language'])) { - $_SESSION['language'] = self::$lang; + if ($session->get('authenticated') && !$session->get('language')) { + $session->set('language', $this->lang); // we haven't loaded user data yet, but we need user language - if (!empty($_SESSION['uid'])) { - $user = DBA::selectFirst('user', ['language'], ['uid' => $_SESSION['uid']]); - if (DBA::isResult($user)) { - $_SESSION['language'] = $user['language']; + if ($session->get('uid')) { + $user = $this->dba->selectFirst('user', ['language'], ['uid' => $_SESSION['uid']]); + if ($this->dba->isResult($user)) { + $session->set('language', $user['language']); } } } - } - public static function setLangFromSession() - { - if (!empty($_SESSION['language']) && $_SESSION['language'] !== self::$lang) { - self::loadTranslationTable($_SESSION['language']); + if (isset($_GET['lang'])) { + $session->set('language', $_GET['lang']); } } - /** - * @brief Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header - * @return string The two-letter language code - */ - public static function detectLanguage() + private function setLangFromSession(IHandleSessions $session) { - $lang_list = []; - - if (!empty($_SERVER['HTTP_ACCEPT_LANGUAGE'])) { - // break up string into pieces (languages and q factors) - preg_match_all('/([a-z]{1,8}(-[a-z]{1,8})?)\s*(;\s*q\s*=\s*(1|0\.[0-9]+))?/i', $_SERVER['HTTP_ACCEPT_LANGUAGE'], $lang_parse); - - if (count($lang_parse[1])) { - // go through the list of prefered languages and add a generic language - // for sub-linguas (e.g. de-ch will add de) if not already in array - for ($i = 0; $i < count($lang_parse[1]); $i++) { - $lang_list[] = strtolower($lang_parse[1][$i]); - if (strlen($lang_parse[1][$i])>3) { - $dashpos = strpos($lang_parse[1][$i], '-'); - if (!in_array(substr($lang_parse[1][$i], 0, $dashpos), $lang_list)) { - $lang_list[] = strtolower(substr($lang_parse[1][$i], 0, $dashpos)); - } - } - } - } - } - - // check if we have translations for the preferred languages and pick the 1st that has - foreach ($lang_list as $lang) { - if ($lang === 'en' || (file_exists("view/lang/$lang") && is_dir("view/lang/$lang"))) { - $preferred = $lang; - break; - } + if ($session->get('language') !== $this->lang) { + $this->loadTranslationTable($session->get('language')); } - if (isset($preferred)) { - return $preferred; - } - - // in case none matches, get the system wide configured language, or fall back to English - return Config::get('system', 'language', 'en'); } /** - * This function should be called before formatting messages in a specific target language - * different from the current user/system language. + * Loads string translation table * - * It saves the current translation strings in a separate variable and loads new translations strings. + * First addon strings are loaded, then globals + * + * Uses an App object shim since all the strings files refer to $a->strings * - * If called repeatedly, it won't save the translation strings again, just load the new ones. + * @param string $lang language code to load * - * @see popLang() - * @brief Stores the current language strings and load a different language. - * @param string $lang Language code + * @throws \Exception */ - public static function pushLang($lang) + private function loadTranslationTable($lang) { - if (!self::$lang) { - self::init(); - } + $lang = Strings::sanitizeFilePathItem($lang); - if ($lang === self::$lang) { + // Don't override the language setting with empty languages + if (empty($lang)) { return; } - if (!self::$langSave) { - self::$langSave = self::$lang; - self::$stringsSave = self::$strings; - } + $a = new \stdClass(); + $a->strings = []; - self::loadTranslationTable($lang); - } + // load enabled addons strings + $addons = $this->dba->select('addon', ['name'], ['installed' => true]); + while ($p = $this->dba->fetch($addons)) { + $name = Strings::sanitizeFilePathItem($p['name']); + if (file_exists(__DIR__ . "/../../addon/$name/lang/$lang/strings.php")) { + include __DIR__ . "/../../addon/$name/lang/$lang/strings.php"; + } + } - /** - * Restores the original user/system language after having used pushLang() - */ - public static function popLang() - { - if (!self::$langSave) { - return; + if (file_exists(__DIR__ . "/../../view/lang/$lang/strings.php")) { + include __DIR__ . "/../../view/lang/$lang/strings.php"; } - self::$strings = self::$stringsSave; - self::$lang = self::$langSave; + $this->lang = $lang; + $this->strings = $a->strings; - self::$stringsSave = []; - self::$langSave = ''; + unset($a); } /** - * Loads string translation table + * Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header * - * First addon strings are loaded, then globals - * - * Uses an App object shim since all the strings files refer to $a->strings + * @param string $sysLang The default fallback language + * @param array $server The $_SERVER array + * @param array $get The $_GET array * - * @param string $lang language code to load + * @return string The two-letter language code */ - private static function loadTranslationTable($lang) + public static function detectLanguage(array $server, array $get, string $sysLang = self::DEFAULT) { - if ($lang === self::$lang) { - return; - } + $lang_variable = $server['HTTP_ACCEPT_LANGUAGE'] ?? null; - $a = new \stdClass(); - $a->strings = []; + $acceptedLanguages = preg_split('/,\s*/', $lang_variable); - // load enabled addons strings - $addons = DBA::select('addon', ['name'], ['installed' => true]); - while ($p = DBA::fetch($addons)) { - $name = $p['name']; - if (file_exists("addon/$name/lang/$lang/strings.php")) { - include "addon/$name/lang/$lang/strings.php"; - } + if (empty($acceptedLanguages)) { + $acceptedLanguages = []; } - if (file_exists("view/lang/$lang/strings.php")) { - include "view/lang/$lang/strings.php"; + // Add get as absolute quality accepted language (except this language isn't valid) + if (!empty($get['lang'])) { + $acceptedLanguages[] = $get['lang']; } - self::$lang = $lang; - self::$strings = $a->strings; + // return the sys language in case there's nothing to do + if (empty($acceptedLanguages)) { + return $sysLang; + } - unset($a); + // Set the syslang as default fallback + $current_lang = $sysLang; + // start with quality zero (every guessed language is more acceptable ..) + $current_q = 0; + + foreach ($acceptedLanguages as $acceptedLanguage) { + $res = preg_match( + '/^([a-z]{1,8}(?:-[a-z]{1,8})*)(?:;\s*q=(0(?:\.[0-9]{1,3})?|1(?:\.0{1,3})?))?$/i', + $acceptedLanguage, + $matches + ); + + // Invalid language? -> skip + if (!$res) { + continue; + } + + // split language codes based on it's "-" + $lang_code = explode('-', $matches[1]); + + // determine the quality of the guess + if (isset($matches[2])) { + $lang_quality = (float)$matches[2]; + } else { + // fallback so without a quality parameter, it's probably the best + $lang_quality = 1; + } + + // loop through each part of the code-parts + while (count($lang_code)) { + // try to mix them so we can get double-code parts too + $match_lang = strtolower(join('-', $lang_code)); + if (file_exists(__DIR__ . "/../../view/lang/$match_lang") && + is_dir(__DIR__ . "/../../view/lang/$match_lang")) { + if ($lang_quality > $current_q) { + $current_lang = $match_lang; + $current_q = $lang_quality; + break; + } + } + + // remove the most right code-part + array_pop($lang_code); + } + } + + return $current_lang; } /** - * @brief Return the localized version of the provided string with optional string interpolation + * Return the localized version of the provided string with optional string interpolation * * This function takes a english string as parameter, and if a localized version * exists for the current language, substitutes it before performing an eventual * string interpolation (sprintf) with additional optional arguments. * * Usages: - * - L10n::t('This is an example') - * - L10n::t('URL %s returned no result', $url) - * - L10n::t('Current version: %s, new version: %s', $current_version, $new_version) + * - DI::l10n()->t('This is an example') + * - DI::l10n()->t('URL %s returned no result', $url) + * - DI::l10n()->t('Current version: %s, new version: %s', $current_version, $new_version) * * @param string $s * @param array $vars Variables to interpolate in the translation string + * * @return string */ - public static function t($s, ...$vars) + public function t($s, ...$vars) { if (empty($s)) { return ''; } - if (!self::$lang) { - self::init(); - } - - if (!empty(self::$strings[$s])) { - $t = self::$strings[$s]; + if (!empty($this->strings[$s])) { + $t = $this->strings[$s]; $s = is_array($t) ? $t[0] : $t; } @@ -253,7 +288,7 @@ class L10n extends BaseObject } /** - * @brief Return the localized version of a singular/plural string with optional string interpolation + * Return the localized version of a singular/plural string with optional string interpolation * * This function takes two english strings as parameters, singular and plural, as * well as a count. If a localized version exists for the current language, they @@ -262,46 +297,46 @@ class L10n extends BaseObject * is performed using the count as parameter. * * Usages: - * - L10n::tt('Like', 'Likes', $count) - * - L10n::tt("%s user deleted", "%s users deleted", count($users)) + * - DI::l10n()->tt('Like', 'Likes', $count) + * - DI::l10n()->tt("%s user deleted", "%s users deleted", count($users)) * * @param string $singular * @param string $plural - * @param int $count + * @param int $count + * * @return string + * @throws \Exception */ - public static function tt($singular, $plural, $count) + public function tt(string $singular, string $plural, int $count) { - if (!is_numeric($count)) { - Logger::log('Non numeric count called by ' . System::callstack(20)); - } + $s = null; - if (!self::$lang) { - self::init(); - } - - if (!empty(self::$strings[$singular])) { - $t = self::$strings[$singular]; + if (!empty($this->strings[$singular])) { + $t = $this->strings[$singular]; if (is_array($t)) { - $plural_function = 'string_plural_select_' . str_replace('-', '_', self::$lang); + $plural_function = 'string_plural_select_' . str_replace('-', '_', $this->lang); if (function_exists($plural_function)) { $i = $plural_function($count); } else { - $i = self::stringPluralSelectDefault($count); + $i = $this->stringPluralSelectDefault($count); } - // for some languages there is only a single array item - if (!isset($t[$i])) { - $s = $t[0]; - } else { + if (isset($t[$i])) { $s = $t[$i]; + } elseif (count($t) > 0) { + // for some languages there is only a single array item + $s = $t[0]; } + // if $t is empty, skip it, because empty strings array are indended + // to make string file smaller when there's no translation } else { $s = $t; } - } elseif (self::stringPluralSelectDefault($count)) { + } + + if (is_null($s) && $this->stringPluralSelectDefault($count)) { $s = $plural; - } else { + } elseif (is_null($s)) { $s = $singular; } @@ -312,26 +347,31 @@ class L10n extends BaseObject /** * Provide a fallback which will not collide with a function defined in any language file + * + * @param int $n + * + * @return bool */ - private static function stringPluralSelectDefault($n) + private function stringPluralSelectDefault($n) { return $n != 1; } /** - * @brief Return installed languages codes as associative array + * Return installed languages codes as associative array * * Scans the view/lang directory for the existence of "strings.php" files, and * returns an alphabetical list of their folder names (@-char language codes). - * Adds the english language if it's missing from the list. + * Adds the english language if it's missing from the list. Folder names are + * replaced by nativ language names. * - * Ex: array('de' => 'de', 'en' => 'en', 'fr' => 'fr', ...) + * Ex: array('de' => 'Deutsch', 'en' => 'English', 'fr' => 'Français', ...) * * @return array */ public static function getAvailableLanguages() { - $langs = []; + $langs = []; $strings_file_paths = glob('view/lang/*/strings.php'); if (is_array($strings_file_paths) && count($strings_file_paths)) { @@ -340,46 +380,48 @@ class L10n extends BaseObject } asort($strings_file_paths); foreach ($strings_file_paths as $strings_file_path) { - $path_array = explode('/', $strings_file_path); - $langs[$path_array[2]] = $path_array[2]; + $path_array = explode('/', $strings_file_path); + $langs[$path_array[2]] = self::LANG_NAMES[$path_array[2]] ?? $path_array[2]; } } return $langs; } /** - * @brief Translate days and months names. + * Translate days and months names. * * @param string $s String with day or month name. + * * @return string Translated string. */ - public static function getDay($s) + public function getDay($s) { - $ret = str_replace(['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'], - [self::t('Monday'), self::t('Tuesday'), self::t('Wednesday'), self::t('Thursday'), self::t('Friday'), self::t('Saturday'), self::t('Sunday')], + $ret = str_replace(['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'], + [$this->t('Monday'), $this->t('Tuesday'), $this->t('Wednesday'), $this->t('Thursday'), $this->t('Friday'), $this->t('Saturday'), $this->t('Sunday')], $s); - $ret = str_replace(['January','February','March','April','May','June','July','August','September','October','November','December'], - [self::t('January'), self::t('February'), self::t('March'), self::t('April'), self::t('May'), self::t('June'), self::t('July'), self::t('August'), self::t('September'), self::t('October'), self::t('November'), self::t('December')], + $ret = str_replace(['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'], + [$this->t('January'), $this->t('February'), $this->t('March'), $this->t('April'), $this->t('May'), $this->t('June'), $this->t('July'), $this->t('August'), $this->t('September'), $this->t('October'), $this->t('November'), $this->t('December')], $ret); return $ret; } /** - * @brief Translate short days and months names. + * Translate short days and months names. * * @param string $s String with short day or month name. + * * @return string Translated string. */ - public static function getDayShort($s) + public function getDayShort($s) { $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'], - [self::t('Mon'), self::t('Tue'), self::t('Wed'), self::t('Thu'), self::t('Fri'), self::t('Sat'), self::t('Sun')], + [$this->t('Mon'), $this->t('Tue'), $this->t('Wed'), $this->t('Thu'), $this->t('Fri'), $this->t('Sat'), $this->t('Sun')], $s); - $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov','Dec'], - [self::t('Jan'), self::t('Feb'), self::t('Mar'), self::t('Apr'), self::t('May'), ('Jun'), self::t('Jul'), self::t('Aug'), self::t('Sep'), self::t('Oct'), self::t('Nov'), self::t('Dec')], + $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'], + [$this->t('Jan'), $this->t('Feb'), $this->t('Mar'), $this->t('Apr'), $this->t('May'), $this->t('Jun'), $this->t('Jul'), $this->t('Aug'), $this->t('Sep'), $this->t('Oct'), $this->t('Nov'), $this->t('Dec')], $ret); return $ret; @@ -389,24 +431,45 @@ class L10n extends BaseObject * Load poke verbs * * @return array index is present tense verb - * value is array containing past tense verb, translation of present, translation of past + * value is array containing past tense verb, translation of present, translation of past + * @throws \Friendica\Network\HTTPException\InternalServerErrorException * @hook poke_verbs pokes array */ - public static function getPokeVerbs() + public function getPokeVerbs() { // index is present tense verb // value is array containing past tense verb, translation of present, translation of past $arr = [ - 'poke' => ['poked', self::t('poke'), self::t('poked')], - 'ping' => ['pinged', self::t('ping'), self::t('pinged')], - 'prod' => ['prodded', self::t('prod'), self::t('prodded')], - 'slap' => ['slapped', self::t('slap'), self::t('slapped')], - 'finger' => ['fingered', self::t('finger'), self::t('fingered')], - 'rebuff' => ['rebuffed', self::t('rebuff'), self::t('rebuffed')], + 'poke' => ['poked', $this->t('poke'), $this->t('poked')], + 'ping' => ['pinged', $this->t('ping'), $this->t('pinged')], + 'prod' => ['prodded', $this->t('prod'), $this->t('prodded')], + 'slap' => ['slapped', $this->t('slap'), $this->t('slapped')], + 'finger' => ['fingered', $this->t('finger'), $this->t('fingered')], + 'rebuff' => ['rebuffed', $this->t('rebuff'), $this->t('rebuffed')], ]; - Addon::callHooks('poke_verbs', $arr); + Hook::callAll('poke_verbs', $arr); return $arr; } + + /** + * Creates a new L10n instance based on the given langauge + * + * @param string $lang The new language + * + * @return static A new L10n instance + * @throws \Exception + */ + public function withLang(string $lang) + { + // Don't create a new instance for same language + if ($lang === $this->lang) { + return $this; + } + + $newL10n = clone $this; + $newL10n->loadTranslationTable($lang); + return $newL10n; + } }