X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FL10n.php;h=aca57793ca9711d1208c5e60f5c37231784f4a64;hb=06284e60073f374c1bd411e0bba6474a13c14f10;hp=b27228cf809f66f0a39aa8bd664b35a85d8f719f;hpb=61fccaeb30bb0b8bd1294d90002b30c270af0d3d;p=friendica.git diff --git a/src/Core/L10n.php b/src/Core/L10n.php index b27228cf80..aca57793ca 100644 --- a/src/Core/L10n.php +++ b/src/Core/L10n.php @@ -1,64 +1,272 @@ . + * */ + namespace Friendica\Core; -use Friendica\BaseObject; -use Friendica\Core\L10n\L10n as L10nClass; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\Session\Capability\IHandleSessions; +use Friendica\Database\Database; +use Friendica\Util\Strings; +use Psr\Log\LoggerInterface; /** * 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'; + + /** + * 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 $lang = ''; + + /** + * An array of translation strings whose key is the neutral english message. + * + * @var array + */ + private $strings = []; + + /** + * @var Database + */ + private $dba; + + /** + * @var LoggerInterface + */ + private $logger; + + public function __construct(IManageConfigValues $config, Database $dba, LoggerInterface $logger, IHandleSessions $session, array $server, array $get) + { + $this->dba = $dba; + $this->logger = $logger; + + $this->loadTranslationTable(L10n::detectLanguage($server, $get, $config->get('system', 'language', self::DEFAULT))); + $this->setSessionVariable($session); + $this->setLangFromSession($session); + } + /** * Returns the current language code * * @return string Language code */ - public static function getCurrentLang() + public function getCurrentLang() { - return self::getClass(L10nClass::class)->getCurrentLang(); + return $this->lang; } /** - * @param string $lang + * Sets the language session variable + */ + private function setSessionVariable(IHandleSessions $session) + { + 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 ($session->get('uid')) { + $user = $this->dba->selectFirst('user', ['language'], ['uid' => $_SESSION['uid']]); + if ($this->dba->isResult($user)) { + $session->set('language', $user['language']); + } + } + } + + if (isset($_GET['lang'])) { + $session->set('language', $_GET['lang']); + } + } + + private function setLangFromSession(IHandleSessions $session) + { + if ($session->get('language') !== $this->lang) { + $this->loadTranslationTable($session->get('language')); + } + } + + /** + * Loads string translation table * - * @return L10nClass The new L10n class with the new language + * First addon strings are loaded, then globals * - * @throws \Friendica\Network\HTTPException\InternalServerErrorException + * Uses an App object shim since all the strings files refer to $a->strings + * + * @param string $lang language code to load + * + * @throws \Exception + */ + private function loadTranslationTable($lang) + { + $lang = Strings::sanitizeFilePathItem($lang); + + // Don't override the language setting with empty languages + if (empty($lang)) { + return; + } + + $a = new \stdClass(); + $a->strings = []; + + // 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"; + } + } + + if (file_exists(__DIR__ . "/../../view/lang/$lang/strings.php")) { + include __DIR__ . "/../../view/lang/$lang/strings.php"; + } + + $this->lang = $lang; + $this->strings = $a->strings; + + unset($a); + } + + /** + * Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header + * + * @param string $sysLang The default fallback language + * @param array $server The $_SERVER array + * @param array $get The $_GET array + * + * @return string The two-letter language code */ - public static function withLang(string $lang) + public static function detectLanguage(array $server, array $get, string $sysLang = self::DEFAULT) { - return self::getClass(L10nClass::class)->withLang($lang); + $lang_variable = $server['HTTP_ACCEPT_LANGUAGE'] ?? null; + + $acceptedLanguages = preg_split('/,\s*/', $lang_variable); + + if (empty($acceptedLanguages)) { + $acceptedLanguages = []; + } + + // Add get as absolute quality accepted language (except this language isn't valid) + if (!empty($get['lang'])) { + $acceptedLanguages[] = $get['lang']; + } + + // return the sys language in case there's nothing to do + if (empty($acceptedLanguages)) { + return $sysLang; + } + + // 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) { - return self::getClass(L10nClass::class)->t($s, ...$vars); + if (empty($s)) { + return ''; + } + + if (!empty($this->strings[$s])) { + $t = $this->strings[$s]; + $s = is_array($t) ? $t[0] : $t; + } + + if (count($vars) > 0) { + $s = sprintf($s, ...$vars); + } + + return $s; } /** - * @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 @@ -67,8 +275,8 @@ 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 @@ -77,13 +285,58 @@ class L10n extends BaseObject * @return string * @throws \Exception */ - public static function tt(string $singular, string $plural, int $count) + public function tt(string $singular, string $plural, int $count) { - return self::getClass(L10nClass::class)->tt($singular, $plural, $count); + $s = null; + + if (!empty($this->strings[$singular])) { + $t = $this->strings[$singular]; + if (is_array($t)) { + $plural_function = 'string_plural_select_' . str_replace('-', '_', $this->lang); + if (function_exists($plural_function)) { + $i = $plural_function($count); + } else { + $i = $this->stringPluralSelectDefault($count); + } + + 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; + } + } + + if (is_null($s) && $this->stringPluralSelectDefault($count)) { + $s = $plural; + } elseif (is_null($s)) { + $s = $singular; + } + + $s = @sprintf($s, $count); + + return $s; } /** - * @brief Return installed languages codes as associative array + * Provide a fallback which will not collide with a function defined in any language file + * + * @param int $n + * + * @return bool + */ + private function stringPluralSelectDefault($n) + { + return $n != 1; + } + + /** + * 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). @@ -95,31 +348,60 @@ class L10n extends BaseObject */ public static function getAvailableLanguages() { - return L10nClass::getAvailableLanguages(); + $langs = []; + $strings_file_paths = glob('view/lang/*/strings.php'); + + if (is_array($strings_file_paths) && count($strings_file_paths)) { + if (!in_array('view/lang/en/strings.php', $strings_file_paths)) { + $strings_file_paths[] = 'view/lang/en/strings.php'; + } + 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]; + } + } + 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) { - return self::getClass(L10nClass::class)->getDay($s); + $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'], + [$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) { - return self::getClass(L10nClass::class)->getDayShort($s); + $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', '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'], + [$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; } /** @@ -127,10 +409,44 @@ class L10n extends BaseObject * * @return array index is present tense verb * 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() { - return self::getClass(L10nClass::class)->getPokeVerbs(); + // index is present tense verb + // value is array containing past tense verb, translation of present, translation of past + $arr = [ + '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')], + ]; + + 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; } }