3 * @file src/Core/L10n.php
5 namespace Friendica\Core;
7 use Friendica\BaseObject;
8 use Friendica\Database\DBA;
11 * Provide Language, Translation, and Localization functions to the application
12 * Localization can be referred to by the numeronym L10N (as in: "L", followed by ten more letters, and then "N").
14 class L10n extends BaseObject
17 * A string indicating the current language used for translation:
18 * - Two-letter ISO 639-1 code.
19 * - Two-letter ISO 639-1 code + dash + Two-letter ISO 3166-1 alpha-2 country code.
22 private static $lang = '';
24 * A language code saved for later after pushLang() has been called.
28 private static $langSave = '';
31 * An array of translation strings whose key is the neutral english message.
35 private static $strings = [];
37 * An array of translation strings saved for later after pushLang() has been called.
41 private static $stringsSave = [];
44 * Detects the language and sets the translation table
46 public static function init()
48 $lang = self::detectLanguage();
49 self::loadTranslationTable($lang);
53 * Returns the current language code
55 * @return string Language code
57 public static function getCurrentLang()
63 * Sets the language session variable
65 public static function setSessionVariable()
67 if (!empty($_SESSION['authenticated']) && empty($_SESSION['language'])) {
68 $_SESSION['language'] = self::$lang;
69 // we haven't loaded user data yet, but we need user language
70 if (!empty($_SESSION['uid'])) {
71 $user = DBA::selectFirst('user', ['language'], ['uid' => $_SESSION['uid']]);
72 if (DBA::isResult($user)) {
73 $_SESSION['language'] = $user['language'];
78 if (isset($_GET['lang'])) {
79 $_SESSION['language'] = $_GET['lang'];
83 public static function setLangFromSession()
85 if (!empty($_SESSION['language']) && $_SESSION['language'] !== self::$lang) {
86 self::loadTranslationTable($_SESSION['language']);
91 * @brief Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header
92 * @return string The two-letter language code
94 public static function detectLanguage()
98 if (!empty($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
99 // break up string into pieces (languages and q factors)
100 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);
102 if (count($lang_parse[1])) {
103 // go through the list of prefered languages and add a generic language
104 // for sub-linguas (e.g. de-ch will add de) if not already in array
105 for ($i = 0; $i < count($lang_parse[1]); $i++) {
106 $lang_list[] = strtolower($lang_parse[1][$i]);
107 if (strlen($lang_parse[1][$i])>3) {
108 $dashpos = strpos($lang_parse[1][$i], '-');
109 if (!in_array(substr($lang_parse[1][$i], 0, $dashpos), $lang_list)) {
110 $lang_list[] = strtolower(substr($lang_parse[1][$i], 0, $dashpos));
117 if (isset($_GET['lang'])) {
118 $lang_list = [$_GET['lang']];
121 // check if we have translations for the preferred languages and pick the 1st that has
122 foreach ($lang_list as $lang) {
123 if ($lang === 'en' || (file_exists("view/lang/$lang") && is_dir("view/lang/$lang"))) {
128 if (isset($preferred)) {
132 // in case none matches, get the system wide configured language, or fall back to English
133 return Config::get('system', 'language', 'en');
137 * This function should be called before formatting messages in a specific target language
138 * different from the current user/system language.
140 * It saves the current translation strings in a separate variable and loads new translations strings.
142 * If called repeatedly, it won't save the translation strings again, just load the new ones.
145 * @brief Stores the current language strings and load a different language.
146 * @param string $lang Language code
148 public static function pushLang($lang)
154 if ($lang === self::$lang) {
158 if (!self::$langSave) {
159 self::$langSave = self::$lang;
160 self::$stringsSave = self::$strings;
163 self::loadTranslationTable($lang);
167 * Restores the original user/system language after having used pushLang()
169 public static function popLang()
171 if (!self::$langSave) {
175 self::$strings = self::$stringsSave;
176 self::$lang = self::$langSave;
178 self::$stringsSave = [];
179 self::$langSave = '';
183 * Loads string translation table
185 * First addon strings are loaded, then globals
187 * Uses an App object shim since all the strings files refer to $a->strings
189 * @param string $lang language code to load
191 private static function loadTranslationTable($lang)
193 if ($lang === self::$lang) {
197 $a = new \stdClass();
200 // load enabled addons strings
201 $addons = DBA::select('addon', ['name'], ['installed' => true]);
202 while ($p = DBA::fetch($addons)) {
204 if (file_exists("addon/$name/lang/$lang/strings.php")) {
205 include "addon/$name/lang/$lang/strings.php";
209 if (file_exists("view/lang/$lang/strings.php")) {
210 include "view/lang/$lang/strings.php";
214 self::$strings = $a->strings;
220 * @brief Return the localized version of the provided string with optional string interpolation
222 * This function takes a english string as parameter, and if a localized version
223 * exists for the current language, substitutes it before performing an eventual
224 * string interpolation (sprintf) with additional optional arguments.
227 * - L10n::t('This is an example')
228 * - L10n::t('URL %s returned no result', $url)
229 * - L10n::t('Current version: %s, new version: %s', $current_version, $new_version)
232 * @param array $vars Variables to interpolate in the translation string
235 public static function t($s, ...$vars)
245 if (!empty(self::$strings[$s])) {
246 $t = self::$strings[$s];
247 $s = is_array($t) ? $t[0] : $t;
250 if (count($vars) > 0) {
251 $s = sprintf($s, ...$vars);
258 * @brief Return the localized version of a singular/plural string with optional string interpolation
260 * This function takes two english strings as parameters, singular and plural, as
261 * well as a count. If a localized version exists for the current language, they
262 * are used instead. Discrimination between singular and plural is done using the
263 * localized function if any or the default one. Finally, a string interpolation
264 * is performed using the count as parameter.
267 * - L10n::tt('Like', 'Likes', $count)
268 * - L10n::tt("%s user deleted", "%s users deleted", count($users))
270 * @param string $singular
271 * @param string $plural
275 public static function tt($singular, $plural, $count)
277 if (!is_numeric($count)) {
278 Logger::log('Non numeric count called by ' . System::callstack(20));
285 if (!empty(self::$strings[$singular])) {
286 $t = self::$strings[$singular];
288 $plural_function = 'string_plural_select_' . str_replace('-', '_', self::$lang);
289 if (function_exists($plural_function)) {
290 $i = $plural_function($count);
292 $i = self::stringPluralSelectDefault($count);
295 // for some languages there is only a single array item
296 if (!isset($t[$i])) {
304 } elseif (self::stringPluralSelectDefault($count)) {
310 $s = @sprintf($s, $count);
316 * Provide a fallback which will not collide with a function defined in any language file
318 private static function stringPluralSelectDefault($n)
324 * @brief Return installed languages codes as associative array
326 * Scans the view/lang directory for the existence of "strings.php" files, and
327 * returns an alphabetical list of their folder names (@-char language codes).
328 * Adds the english language if it's missing from the list.
330 * Ex: array('de' => 'de', 'en' => 'en', 'fr' => 'fr', ...)
334 public static function getAvailableLanguages()
337 $strings_file_paths = glob('view/lang/*/strings.php');
339 if (is_array($strings_file_paths) && count($strings_file_paths)) {
340 if (!in_array('view/lang/en/strings.php', $strings_file_paths)) {
341 $strings_file_paths[] = 'view/lang/en/strings.php';
343 asort($strings_file_paths);
344 foreach ($strings_file_paths as $strings_file_path) {
345 $path_array = explode('/', $strings_file_path);
346 $langs[$path_array[2]] = $path_array[2];
353 * @brief Translate days and months names.
355 * @param string $s String with day or month name.
356 * @return string Translated string.
358 public static function getDay($s)
360 $ret = str_replace(['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'],
361 [self::t('Monday'), self::t('Tuesday'), self::t('Wednesday'), self::t('Thursday'), self::t('Friday'), self::t('Saturday'), self::t('Sunday')],
364 $ret = str_replace(['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
365 [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')],
372 * @brief Translate short days and months names.
374 * @param string $s String with short day or month name.
375 * @return string Translated string.
377 public static function getDayShort($s)
379 $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
380 [self::t('Mon'), self::t('Tue'), self::t('Wed'), self::t('Thu'), self::t('Fri'), self::t('Sat'), self::t('Sun')],
383 $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
384 [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')],
393 * @return array index is present tense verb
394 * value is array containing past tense verb, translation of present, translation of past
395 * @hook poke_verbs pokes array
397 public static function getPokeVerbs()
399 // index is present tense verb
400 // value is array containing past tense verb, translation of present, translation of past
402 'poke' => ['poked', self::t('poke'), self::t('poked')],
403 'ping' => ['pinged', self::t('ping'), self::t('pinged')],
404 'prod' => ['prodded', self::t('prod'), self::t('prodded')],
405 'slap' => ['slapped', self::t('slap'), self::t('slapped')],
406 'finger' => ['fingered', self::t('finger'), self::t('fingered')],
407 'rebuff' => ['rebuffed', self::t('rebuff'), self::t('rebuffed')],
410 Hook::callAll('poke_verbs', $arr);