From 4d2b8c26fa6c1bf75bd8264b656cd5a61e76cac4 Mon Sep 17 00:00:00 2001 From: Hugo Sales Date: Wed, 11 Mar 2020 20:30:06 +0000 Subject: [PATCH] [CORE][I18N] Port the translation system to rely on symfony's --- src/Util/Language.php | 280 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 280 insertions(+) create mode 100644 src/Util/Language.php diff --git a/src/Util/Language.php b/src/Util/Language.php new file mode 100644 index 0000000000..84603a2022 --- /dev/null +++ b/src/Util/Language.php @@ -0,0 +1,280 @@ +. + +/** + * Utility functions for i18n + * + * @category I18n + * @package GNU social + * @author Matthew Gregg + * @author Ciaran Gultnieks + * @author Evan Prodromou + * @author Diogo Cordeiro + * @copyright 2010, 2019 Free Software Foundation, Inc http://www.fsf.org + * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later + */ + +defined('GNUSOCIAL') || die(); + +private Translator $translator; +public function setTranslator($trans): void { $translator = $trans; } + + +// Locale category constants are usually predefined, but may not be +// on some systems such as Win32. +$LC_CATEGORIES = ['LC_CTYPE', + 'LC_NUMERIC', + 'LC_TIME', + 'LC_COLLATE', + 'LC_MONETARY', + 'LC_MESSAGES', + 'LC_ALL']; +foreach ($LC_CATEGORIES as $key => $name) { + if (!defined($name)) { + define($name, $key); + } +} + +/** + * Wrapper for symfony translation with smart domain detection. + * + * If calling from a plugin, this function checks which plugin it was + * being called from and uses that as text domain, which will have + * been set up during plugin initialization. + * + * Also handles plurals and contexts depending on what parameters + * are passed to it: + * + * _m($msg) -- simple message + * _m($ctx, $msg) -- message with context + * _m($msg1, $msg2, $n) -- message that cann be singular or plural + * _m($ctx, $msg1, $msg2, $n) -- combination of the previous two + * + * @param string $msg + * @param extra params as described above + * @return string + * @throws Exception + */ +public function _m(string $msg /*, ...*/): string +{ + $domain = _mdomain(debug_backtrace()); + $args = func_get_args(); + list($context, $msg_single, $msg_plural, $n) = $args; + switch (count($args)) { + case 1: + // Empty parameters + return $translator->trans($msg, [], $domain); + case 2: + // ASCII 4 is EOT, used to separate context from string + return $translator->trans($context . '\004' . $msg_single, [], $domain); + case 3: + // '|' separates the singular from the plural version + $msg_single = $args[0]; + $msg_plural = $args[1]; + $n = $args[2]; + return $translator->trans($msg_single . '|' . $msg_plural, ['%d' => $n], $domain); + case 4: + // Combine both + return $translator->trans($context . '\004' . $msg_single . '|' . $msg_plural, + ['%d' => $n], $domain); + default: + throw new Exception("Bad parameter count to _m()"); + } +} + +/** + * Looks for which plugin we've been called from to set the gettext domain; + * if not in a plugin subdirectory, we'll use the default 'gnusocial'. + * + * Note: we can't return null for default domain since most of the PHP gettext + * wrapper functions turn null into "" before passing to the backend library. + * + * @param array $backtrace debug_backtrace() output + * @return string + * @private + */ +private function _mdomain(array $backtrace): string +{ + /* + 0 => + array + 'file' => string '/var/www/mublog/plugins/FeedSub/FeedSubPlugin.php' (length=49) + 'line' => int 77 + 'function' => string '_m' (length=2) + 'args' => + array + 0 => &string 'Feeds' (length=5) + */ + static $cached; + $path = $backtrace[0]['file']; + if (!isset($cached[$path])) { + $path = common::normalizePath($path); + $cached[$path] = common::pluginFromPath($path); + } + return $cached[$path]; +} + + +/** + * Content negotiation for language codes + * + * @param string $http_accept_lang_header HTTP Accept-Language header + * @return string language code for best language match, false otherwise + */ + +function client_preferred_language(string $http_accept_lang_header): string +{ + $client_langs = []; + $all_languages = common_config('site', 'languages'); + + preg_match_all('"(((\S\S)-?(\S\S)?)(;q=([0-9.]+))?)\s*(,\s*|$)"', + strtolower($http_accept_lang_header), $http_langs); + + for ($i = 0; $i < count($http_langs); ++$i) { + if (!empty($http_langs[2][$i])) { + // if no q default to 1.0 + $client_langs[$http_langs[2][$i]] = + ($http_langs[6][$i] ? (float)$http_langs[6][$i] : 1.0 - ($i * 0.01)); + } + if (!empty($http_langs[3][$i]) && empty($client_langs[$http_langs[3][$i]])) { + // if a catchall default 0.01 lower + $client_langs[$http_langs[3][$i]] = + ($http_langs[6][$i] ? (float)$http_langs[6][$i] - 0.01 : 0.99); + } + } + // sort in descending q + arsort($client_langs); + + foreach ($client_langs as $lang => $q) { + if (isset($all_languages[$lang])) { + return ($all_languages[$lang]['lang']); + } + } + return false; +} + +/** + * returns a simple code -> name mapping for languages + * + * @return array map of available languages by code to language name. + */ + +function get_nice_language_list(): array +{ + $nice_lang = []; + $all_languages = common_config('site', 'languages'); + + foreach ($all_languages as $lang) { + $nice_lang[$lang['lang']] = $lang['name']; + } + return $nice_lang; +} + +/** + * Check whether a language is right-to-left + * + * @param string $lang language code of the language to check + * + * @return boolean true if language is rtl + */ + +function is_rtl(string $lang_value): bool +{ + foreach (common_config('site', 'languages') as $code => $info) { + if ($lang_value == $info['lang']) { + return $info['direction'] == 'rtl'; + } + } +} + +/** + * Get a list of all languages that are enabled in the default config + * + * This should ONLY be called when setting up the default config in common.php. + * Any other attempt to get a list of languages should instead call + * common_config('site','languages') + * + * @return array mapping of language codes to language info + */ +function get_all_languages(): array +{ + return [ + 'af' => ['q' => 0.8, 'lang' => 'af', 'name' => 'Afrikaans', 'direction' => 'ltr'], + 'ar' => ['q' => 0.8, 'lang' => 'ar', 'name' => 'Arabic', 'direction' => 'rtl'], + 'ast' => ['q' => 1, 'lang' => 'ast', 'name' => 'Asturian', 'direction' => 'ltr'], + 'eu' => ['q' => 1, 'lang' => 'eu', 'name' => 'Basque', 'direction' => 'ltr'], + 'be-tarask' => ['q' => 0.5, 'lang' => 'be-tarask', 'name' => 'Belarusian (Taraškievica orthography)', 'direction' => 'ltr'], + 'br' => ['q' => 0.8, 'lang' => 'br', 'name' => 'Breton', 'direction' => 'ltr'], + 'bg' => ['q' => 0.8, 'lang' => 'bg', 'name' => 'Bulgarian', 'direction' => 'ltr'], + 'my' => ['q' => 1, 'lang' => 'my', 'name' => 'Burmese', 'direction' => 'ltr'], + 'ca' => ['q' => 0.5, 'lang' => 'ca', 'name' => 'Catalan', 'direction' => 'ltr'], + 'zh-cn' => ['q' => 0.9, 'lang' => 'zh_CN', 'name' => 'Chinese (Simplified)', 'direction' => 'ltr'], + 'zh-hant' => ['q' => 0.2, 'lang' => 'zh_TW', 'name' => 'Chinese (Taiwanese)', 'direction' => 'ltr'], + 'ksh' => ['q' => 1, 'lang' => 'ksh', 'name' => 'Colognian', 'direction' => 'ltr'], + 'cs' => ['q' => 0.5, 'lang' => 'cs', 'name' => 'Czech', 'direction' => 'ltr'], + 'da' => ['q' => 0.8, 'lang' => 'da', 'name' => 'Danish', 'direction' => 'ltr'], + 'nl' => ['q' => 0.5, 'lang' => 'nl', 'name' => 'Dutch', 'direction' => 'ltr'], + 'arz' => ['q' => 0.8, 'lang' => 'arz', 'name' => 'Egyptian Spoken Arabic', 'direction' => 'rtl'], + 'en' => ['q' => 1, 'lang' => 'en', 'name' => 'English', 'direction' => 'ltr'], + 'en-us' => ['q' => 1, 'lang' => 'en', 'name' => 'English (US)', 'direction' => 'ltr'], + 'en-gb' => ['q' => 1, 'lang' => 'en_GB', 'name' => 'English (UK)', 'direction' => 'ltr'], + 'eo' => ['q' => 0.8, 'lang' => 'eo', 'name' => 'Esperanto', 'direction' => 'ltr'], + 'fi' => ['q' => 1, 'lang' => 'fi', 'name' => 'Finnish', 'direction' => 'ltr'], + 'fr' => ['q' => 1, 'lang' => 'fr', 'name' => 'French', 'direction' => 'ltr'], + 'fr-fr' => ['q' => 1, 'lang' => 'fr', 'name' => 'French (France)', 'direction' => 'ltr'], + 'fur' => ['q' => 0.8, 'lang' => 'fur', 'name' => 'Friulian', 'direction' => 'ltr'], + 'gl' => ['q' => 0.8, 'lang' => 'gl', 'name' => 'Galician', 'direction' => 'ltr'], + 'ka' => ['q' => 0.8, 'lang' => 'ka', 'name' => 'Georgian', 'direction' => 'ltr'], + 'de' => ['q' => 0.8, 'lang' => 'de', 'name' => 'German', 'direction' => 'ltr'], + 'el' => ['q' => 0.1, 'lang' => 'el', 'name' => 'Greek', 'direction' => 'ltr'], + 'he' => ['q' => 0.5, 'lang' => 'he', 'name' => 'Hebrew', 'direction' => 'rtl'], + 'hu' => ['q' => 0.8, 'lang' => 'hu', 'name' => 'Hungarian', 'direction' => 'ltr'], + 'is' => ['q' => 0.1, 'lang' => 'is', 'name' => 'Icelandic', 'direction' => 'ltr'], + 'id' => ['q' => 1, 'lang' => 'id', 'name' => 'Indonesian', 'direction' => 'ltr'], + 'ia' => ['q' => 0.8, 'lang' => 'ia', 'name' => 'Interlingua', 'direction' => 'ltr'], + 'ga' => ['q' => 0.5, 'lang' => 'ga', 'name' => 'Irish', 'direction' => 'ltr'], + 'it' => ['q' => 1, 'lang' => 'it', 'name' => 'Italian', 'direction' => 'ltr'], + 'ja' => ['q' => 0.5, 'lang' => 'ja', 'name' => 'Japanese', 'direction' => 'ltr'], + 'ko' => ['q' => 0.9, 'lang' => 'ko', 'name' => 'Korean', 'direction' => 'ltr'], + 'lv' => ['q' => 1, 'lang' => 'lv', 'name' => 'Latvian', 'direction' => 'ltr'], + 'lt' => ['q' => 1, 'lang' => 'lt', 'name' => 'Lithuanian', 'direction' => 'ltr'], + 'lb' => ['q' => 1, 'lang' => 'lb', 'name' => 'Luxembourgish', 'direction' => 'ltr'], + 'mk' => ['q' => 0.5, 'lang' => 'mk', 'name' => 'Macedonian', 'direction' => 'ltr'], + 'mg' => ['q' => 1, 'lang' => 'mg', 'name' => 'Malagasy', 'direction' => 'ltr'], + 'ms' => ['q' => 1, 'lang' => 'ms', 'name' => 'Malay', 'direction' => 'ltr'], + 'ml' => ['q' => 0.5, 'lang' => 'ml', 'name' => 'Malayalam', 'direction' => 'ltr'], + 'ne' => ['q' => 1, 'lang' => 'ne', 'name' => 'Nepali', 'direction' => 'ltr'], + 'nb' => ['q' => 0.1, 'lang' => 'nb', 'name' => 'Norwegian (Bokmål)', 'direction' => 'ltr'], + 'no' => ['q' => 0.1, 'lang' => 'nb', 'name' => 'Norwegian (Bokmål)', 'direction' => 'ltr'], + 'nn' => ['q' => 1, 'lang' => 'nn', 'name' => 'Norwegian (Nynorsk)', 'direction' => 'ltr'], + 'fa' => ['q' => 1, 'lang' => 'fa', 'name' => 'Persian', 'direction' => 'rtl'], + 'pl' => ['q' => 0.5, 'lang' => 'pl', 'name' => 'Polish', 'direction' => 'ltr'], + 'pt' => ['q' => 1, 'lang' => 'pt', 'name' => 'Portuguese', 'direction' => 'ltr'], + 'pt-br' => ['q' => 0.9, 'lang' => 'pt_BR', 'name' => 'Brazilian Portuguese', 'direction' => 'ltr'], + 'ru' => ['q' => 0.9, 'lang' => 'ru', 'name' => 'Russian', 'direction' => 'ltr'], + 'sr-ec' => ['q' => 1, 'lang' => 'sr-ec', 'name' => 'Serbian', 'direction' => 'ltr'], + 'es' => ['q' => 1, 'lang' => 'es', 'name' => 'Spanish', 'direction' => 'ltr'], + 'sv' => ['q' => 0.8, 'lang' => 'sv', 'name' => 'Swedish', 'direction' => 'ltr'], + 'tl' => ['q' => 0.8, 'lang' => 'tl', 'name' => 'Tagalog', 'direction' => 'ltr'], + 'ta' => ['q' => 1, 'lang' => 'ta', 'name' => 'Tamil', 'direction' => 'ltr'], + 'te' => ['q' => 0.3, 'lang' => 'te', 'name' => 'Telugu', 'direction' => 'ltr'], + 'tr' => ['q' => 0.5, 'lang' => 'tr', 'name' => 'Turkish', 'direction' => 'ltr'], + 'uk' => ['q' => 1, 'lang' => 'uk', 'name' => 'Ukrainian', 'direction' => 'ltr'], + 'hsb' => ['q' => 0.8, 'lang' => 'hsb', 'name' => 'Upper Sorbian', 'direction' => 'ltr'], + 'ur' => ['q' => 1, 'lang' => 'ur_PK', 'name' => 'Urdu (Pakistan)', 'direction' => 'rtl'], + 'vi' => ['q' => 0.8, 'lang' => 'vi', 'name' => 'Vietnamese', 'direction' => 'ltr'], + ]; +}