3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core;
24 use Friendica\Core\Config\Capability\IManageConfigValues;
25 use Friendica\Core\Session\Capability\IHandleSessions;
26 use Friendica\Database\Database;
27 use Friendica\Util\Strings;
30 * Provide Language, Translation, and Localization functions to the application
31 * Localization can be referred to by the numeronym L10N (as in: "L", followed by ten more letters, and then "N").
35 /** @var string The default language */
37 /** @var string[] The language names in their language */
43 'da-dk' => 'Dansk (Danmark)',
45 'en-gb' => 'English (United Kingdom)',
46 'en-us' => 'English (United States)',
47 'en' => 'English (Default)',
58 'nb-no' => 'Norsk bokmål',
61 'pt-br' => 'Português Brasileiro',
69 * A string indicating the current language used for translation:
70 * - Two-letter ISO 639-1 code.
71 * - Two-letter ISO 639-1 code + dash + Two-letter ISO 3166-1 alpha-2 country code.
78 * An array of translation strings whose key is the neutral english message.
82 private $strings = [];
89 * @var IManageConfigValues
93 public function __construct(IManageConfigValues $config, Database $dba, IHandleSessions $session, array $server, array $get)
96 $this->config = $config;
98 $this->loadTranslationTable(L10n::detectLanguage($server, $get, $config->get('system', 'language', self::DEFAULT)));
99 $this->setSessionVariable($session);
100 $this->setLangFromSession($session);
104 * Returns the current language code
106 * @return string Language code
108 public function getCurrentLang()
114 * Sets the language session variable
116 private function setSessionVariable(IHandleSessions $session)
118 if ($session->get('authenticated') && !$session->get('language')) {
119 $session->set('language', $this->lang);
120 // we haven't loaded user data yet, but we need user language
121 if ($session->get('uid')) {
122 $user = $this->dba->selectFirst('user', ['language'], ['uid' => $_SESSION['uid']]);
123 if ($this->dba->isResult($user)) {
124 $session->set('language', $user['language']);
129 if (isset($_GET['lang'])) {
130 $session->set('language', $_GET['lang']);
134 private function setLangFromSession(IHandleSessions $session)
136 if ($session->get('language') !== $this->lang) {
137 $this->loadTranslationTable($session->get('language') ?? $this->lang);
142 * Loads string translation table
144 * First addon strings are loaded, then globals
146 * Uses an App object shim since all the strings files refer to $a->strings
148 * @param string $lang language code to load
152 private function loadTranslationTable(string $lang)
154 $lang = Strings::sanitizeFilePathItem($lang);
156 // Don't override the language setting with empty languages
161 $a = new \stdClass();
164 // load enabled addons strings
165 $addons = array_keys($this->config->get('addons') ?? []);
166 foreach ($addons as $addon) {
167 $name = Strings::sanitizeFilePathItem($addon);
168 if (file_exists(__DIR__ . "/../../addon/$name/lang/$lang/strings.php")) {
169 include __DIR__ . "/../../addon/$name/lang/$lang/strings.php";
173 if (file_exists(__DIR__ . "/../../view/lang/$lang/strings.php")) {
174 include __DIR__ . "/../../view/lang/$lang/strings.php";
178 $this->strings = $a->strings;
184 * Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header
186 * @param string $sysLang The default fallback language
187 * @param array $server The $_SERVER array
188 * @param array $get The $_GET array
190 * @return string The two-letter language code
192 public static function detectLanguage(array $server, array $get, string $sysLang = self::DEFAULT): string
194 $lang_variable = $server['HTTP_ACCEPT_LANGUAGE'] ?? null;
196 if (empty($lang_variable)) {
197 $acceptedLanguages = [];
199 $acceptedLanguages = preg_split('/,\s*/', $lang_variable);
202 // Add get as absolute quality accepted language (except this language isn't valid)
203 if (!empty($get['lang'])) {
204 $acceptedLanguages[] = $get['lang'];
207 // return the sys language in case there's nothing to do
208 if (empty($acceptedLanguages)) {
212 // Set the syslang as default fallback
213 $current_lang = $sysLang;
214 // start with quality zero (every guessed language is more acceptable ..)
217 foreach ($acceptedLanguages as $acceptedLanguage) {
219 '/^([a-z]{1,8}(?:-[a-z]{1,8})*)(?:;\s*q=(0(?:\.[0-9]{1,3})?|1(?:\.0{1,3})?))?$/i',
224 // Invalid language? -> skip
229 // split language codes based on it's "-"
230 $lang_code = explode('-', $matches[1]);
232 // determine the quality of the guess
233 if (isset($matches[2])) {
234 $lang_quality = (float)$matches[2];
236 // fallback so without a quality parameter, it's probably the best
240 // loop through each part of the code-parts
241 while (count($lang_code)) {
242 // try to mix them so we can get double-code parts too
243 $match_lang = strtolower(join('-', $lang_code));
244 if (file_exists(__DIR__ . "/../../view/lang/$match_lang") &&
245 is_dir(__DIR__ . "/../../view/lang/$match_lang")) {
246 if ($lang_quality > $current_q) {
247 $current_lang = $match_lang;
248 $current_q = $lang_quality;
253 // remove the most right code-part
254 array_pop($lang_code);
258 return $current_lang;
262 * Return the localized version of the provided string with optional string interpolation
264 * This function takes a english string as parameter, and if a localized version
265 * exists for the current language, substitutes it before performing an eventual
266 * string interpolation (sprintf) with additional optional arguments.
269 * - DI::l10n()->t('This is an example')
270 * - DI::l10n()->t('URL %s returned no result', $url)
271 * - DI::l10n()->t('Current version: %s, new version: %s', $current_version, $new_version)
274 * @param array $vars Variables to interpolate in the translation string
278 public function t(string $s, ...$vars): string
284 if (!empty($this->strings[$s])) {
285 $t = $this->strings[$s];
286 $s = is_array($t) ? $t[0] : $t;
289 if (count($vars) > 0) {
290 $s = sprintf($s, ...$vars);
297 * Return the localized version of a singular/plural string with optional string interpolation
299 * This function takes two english strings as parameters, singular and plural, as
300 * well as a count. If a localized version exists for the current language, they
301 * are used instead. Discrimination between singular and plural is done using the
302 * localized function if any or the default one. Finally, a string interpolation
303 * is performed using the count as parameter.
306 * - DI::l10n()->tt('Like', 'Likes', $count)
307 * - DI::l10n()->tt("%s user deleted", "%s users deleted", count($users))
309 * @param string $singular
310 * @param string $plural
312 * @param array $vars Variables to interpolate in the translation string
317 public function tt(string $singular, string $plural, int $count, ...$vars): string
321 if (!empty($this->strings[$singular])) {
322 $t = $this->strings[$singular];
324 $plural_function = 'string_plural_select_' . str_replace('-', '_', $this->lang);
325 if (function_exists($plural_function)) {
326 $i = $plural_function($count);
328 $i = $this->stringPluralSelectDefault($count);
333 } elseif (count($t) > 0) {
334 // for some languages there is only a single array item
337 // if $t is empty, skip it, because empty strings array are intended
338 // to make string file smaller when there's no translation
344 if (is_null($s) && $this->stringPluralSelectDefault($count)) {
346 } elseif (is_null($s)) {
350 // We mute errors here because the translation strings may not be referencing the count at all,
351 // but we still have to try the interpolation just in case it is indeed referenced.
352 $s = @sprintf($s, $count, ...$vars);
358 * Provide a fallback which will not collide with a function defined in any language file
364 private function stringPluralSelectDefault(int $n): bool
370 * Return installed languages codes as associative array
372 * Scans the view/lang directory for the existence of "strings.php" files, and
373 * returns an alphabetical list of their folder names (@-char language codes).
374 * Adds the english language if it's missing from the list. Folder names are
375 * replaced by nativ language names.
377 * Ex: array('de' => 'Deutsch', 'en' => 'English', 'fr' => 'Français', ...)
381 public function getAvailableLanguages(bool $additional = false): array
384 $strings_file_paths = glob('view/lang/*/strings.php');
386 if (is_array($strings_file_paths) && count($strings_file_paths)) {
387 if (!in_array('view/lang/en/strings.php', $strings_file_paths)) {
388 $strings_file_paths[] = 'view/lang/en/strings.php';
390 asort($strings_file_paths);
391 foreach ($strings_file_paths as $strings_file_path) {
392 $path_array = explode('/', $strings_file_path);
393 $langs[$path_array[2]] = self::LANG_NAMES[$path_array[2]] ?? $path_array[2];
397 // See https://github.com/friendica/friendica/issues/10511
398 // Persian is manually added to language detection until a persian translation is provided for the interface, at
399 // which point it will be automatically available through `getAvailableLanguages()` and this should be removed.
400 // Additionally Portuguese, Ukrainian, traditional Chinese and Welsh are added to that list.
401 $langs = array_merge(['cy' => 'Cymraeg', 'uk' => 'Українська', 'pt-PT' => 'Português', 'zh-hant' => '繁體', 'fa' => 'فارسی'], $langs);
409 * The language detection routine uses some slightly different language codes.
410 * This function changes the language array accordingly.
412 * @param array $languages
415 public function convertForLanguageDetection(array $languages): array
417 $languages['fi'] = $languages['fi-fi'];
418 unset($languages['fi-fi']);
419 $languages['da'] = $languages['da-dk'];
420 unset($languages['da-dk']);
421 $languages['nb'] = $languages['nb-no'];
422 unset($languages['nb-no']);
423 $languages['pt-BR'] = $languages['pt-br'];
424 unset($languages['pt-br']);
425 $languages['zh-Hans'] = $languages['zh-cn'];
426 unset($languages['zh-cn']);
434 * The language detection routine uses some slightly different language codes.
435 * This function changes the language codes accordingly.
437 * @param string $language
440 public function convertCodeForLanguageDetection(string $language): string
462 * Translate days and months names.
464 * @param string $s String with day or month name.
465 * @return string Translated string.
467 public function getDay(string $s): string
469 $ret = str_replace(['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'],
470 [$this->t('Monday'), $this->t('Tuesday'), $this->t('Wednesday'), $this->t('Thursday'), $this->t('Friday'), $this->t('Saturday'), $this->t('Sunday')],
473 $ret = str_replace(['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
474 [$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')],
481 * Translate short days and months names.
483 * @param string $s String with short day or month name.
484 * @return string Translated string.
486 public function getDayShort(string $s): string
488 $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
489 [$this->t('Mon'), $this->t('Tue'), $this->t('Wed'), $this->t('Thu'), $this->t('Fri'), $this->t('Sat'), $this->t('Sun')],
492 $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
493 [$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')],
500 * Creates a new L10n instance based on the given langauge
502 * @param string $lang The new language
504 * @return static A new L10n instance
507 public function withLang(string $lang): L10n
509 // Don't create a new instance for same language
510 if ($lang === $this->lang) {
514 $newL10n = clone $this;
515 $newL10n->loadTranslationTable($lang);