3 * @copyright Copyright (C) 2020, Friendica
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\IConfig;
25 use Friendica\Core\Session\ISession;
26 use Friendica\Database\Database;
27 use Friendica\Util\Strings;
28 use Psr\Log\LoggerInterface;
31 * Provide Language, Translation, and Localization functions to the application
32 * Localization can be referred to by the numeronym L10N (as in: "L", followed by ten more letters, and then "N").
36 /** @var string The default language */
40 * A string indicating the current language used for translation:
41 * - Two-letter ISO 639-1 code.
42 * - Two-letter ISO 639-1 code + dash + Two-letter ISO 3166-1 alpha-2 country code.
49 * An array of translation strings whose key is the neutral english message.
53 private $strings = [];
61 * @var LoggerInterface
65 public function __construct(IConfig $config, Database $dba, LoggerInterface $logger, ISession $session, array $server, array $get)
68 $this->logger = $logger;
70 $this->loadTranslationTable(L10n::detectLanguage($server, $get, $config->get('system', 'language', self::DEFAULT)));
71 $this->setSessionVariable($session);
72 $this->setLangFromSession($session);
76 * Returns the current language code
78 * @return string Language code
80 public function getCurrentLang()
86 * Sets the language session variable
88 private function setSessionVariable(ISession $session)
90 if ($session->get('authenticated') && !$session->get('language')) {
91 $session->set('language', $this->lang);
92 // we haven't loaded user data yet, but we need user language
93 if ($session->get('uid')) {
94 $user = $this->dba->selectFirst('user', ['language'], ['uid' => $_SESSION['uid']]);
95 if ($this->dba->isResult($user)) {
96 $session->set('language', $user['language']);
101 if (isset($_GET['lang'])) {
102 $session->set('language', $_GET['lang']);
106 private function setLangFromSession(ISession $session)
108 if ($session->get('language') !== $this->lang) {
109 $this->loadTranslationTable($session->get('language'));
114 * Loads string translation table
116 * First addon strings are loaded, then globals
118 * Uses an App object shim since all the strings files refer to $a->strings
120 * @param string $lang language code to load
124 private function loadTranslationTable($lang)
126 $lang = Strings::sanitizeFilePathItem($lang);
128 // Don't override the language setting with empty languages
133 $a = new \stdClass();
136 // load enabled addons strings
137 $addons = $this->dba->select('addon', ['name'], ['installed' => true]);
138 while ($p = $this->dba->fetch($addons)) {
139 $name = Strings::sanitizeFilePathItem($p['name']);
140 if (file_exists(__DIR__ . "/../../addon/$name/lang/$lang/strings.php")) {
141 include __DIR__ . "/../../addon/$name/lang/$lang/strings.php";
145 if (file_exists(__DIR__ . "/../../view/lang/$lang/strings.php")) {
146 include __DIR__ . "/../../view/lang/$lang/strings.php";
150 $this->strings = $a->strings;
156 * Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header
158 * @param string $sysLang The default fallback language
159 * @param array $server The $_SERVER array
160 * @param array $get The $_GET array
162 * @return string The two-letter language code
164 public static function detectLanguage(array $server, array $get, string $sysLang = self::DEFAULT)
166 $lang_variable = $server['HTTP_ACCEPT_LANGUAGE'] ?? null;
168 $acceptedLanguages = preg_split('/,\s*/', $lang_variable);
170 if (empty($acceptedLanguages)) {
171 $acceptedLanguages = [];
174 // Add get as absolute quality accepted language (except this language isn't valid)
175 if (!empty($get['lang'])) {
176 $acceptedLanguages[] = $get['lang'];
179 // return the sys language in case there's nothing to do
180 if (empty($acceptedLanguages)) {
184 // Set the syslang as default fallback
185 $current_lang = $sysLang;
186 // start with quality zero (every guessed language is more acceptable ..)
189 foreach ($acceptedLanguages as $acceptedLanguage) {
191 '/^([a-z]{1,8}(?:-[a-z]{1,8})*)(?:;\s*q=(0(?:\.[0-9]{1,3})?|1(?:\.0{1,3})?))?$/i',
196 // Invalid language? -> skip
201 // split language codes based on it's "-"
202 $lang_code = explode('-', $matches[1]);
204 // determine the quality of the guess
205 if (isset($matches[2])) {
206 $lang_quality = (float)$matches[2];
208 // fallback so without a quality parameter, it's probably the best
212 // loop through each part of the code-parts
213 while (count($lang_code)) {
214 // try to mix them so we can get double-code parts too
215 $match_lang = strtolower(join('-', $lang_code));
216 if (file_exists(__DIR__ . "/../../view/lang/$match_lang") &&
217 is_dir(__DIR__ . "/../../view/lang/$match_lang")) {
218 if ($lang_quality > $current_q) {
219 $current_lang = $match_lang;
220 $current_q = $lang_quality;
225 // remove the most right code-part
226 array_pop($lang_code);
230 return $current_lang;
234 * Return the localized version of the provided string with optional string interpolation
236 * This function takes a english string as parameter, and if a localized version
237 * exists for the current language, substitutes it before performing an eventual
238 * string interpolation (sprintf) with additional optional arguments.
241 * - DI::l10n()->t('This is an example')
242 * - DI::l10n()->t('URL %s returned no result', $url)
243 * - DI::l10n()->t('Current version: %s, new version: %s', $current_version, $new_version)
246 * @param array $vars Variables to interpolate in the translation string
250 public function t($s, ...$vars)
256 if (!empty($this->strings[$s])) {
257 $t = $this->strings[$s];
258 $s = is_array($t) ? $t[0] : $t;
261 if (count($vars) > 0) {
262 $s = sprintf($s, ...$vars);
269 * Return the localized version of a singular/plural string with optional string interpolation
271 * This function takes two english strings as parameters, singular and plural, as
272 * well as a count. If a localized version exists for the current language, they
273 * are used instead. Discrimination between singular and plural is done using the
274 * localized function if any or the default one. Finally, a string interpolation
275 * is performed using the count as parameter.
278 * - DI::l10n()->tt('Like', 'Likes', $count)
279 * - DI::l10n()->tt("%s user deleted", "%s users deleted", count($users))
281 * @param string $singular
282 * @param string $plural
288 public function tt(string $singular, string $plural, int $count)
290 if (!empty($this->strings[$singular])) {
291 $t = $this->strings[$singular];
293 $plural_function = 'string_plural_select_' . str_replace('-', '_', $this->lang);
294 if (function_exists($plural_function)) {
295 $i = $plural_function($count);
297 $i = $this->stringPluralSelectDefault($count);
300 // for some languages there is only a single array item
301 if (!isset($t[$i])) {
309 } elseif ($this->stringPluralSelectDefault($count)) {
315 $s = @sprintf($s, $count);
321 * Provide a fallback which will not collide with a function defined in any language file
327 private function stringPluralSelectDefault($n)
333 * Return installed languages codes as associative array
335 * Scans the view/lang directory for the existence of "strings.php" files, and
336 * returns an alphabetical list of their folder names (@-char language codes).
337 * Adds the english language if it's missing from the list.
339 * Ex: array('de' => 'de', 'en' => 'en', 'fr' => 'fr', ...)
343 public static function getAvailableLanguages()
346 $strings_file_paths = glob('view/lang/*/strings.php');
348 if (is_array($strings_file_paths) && count($strings_file_paths)) {
349 if (!in_array('view/lang/en/strings.php', $strings_file_paths)) {
350 $strings_file_paths[] = 'view/lang/en/strings.php';
352 asort($strings_file_paths);
353 foreach ($strings_file_paths as $strings_file_path) {
354 $path_array = explode('/', $strings_file_path);
355 $langs[$path_array[2]] = $path_array[2];
362 * Translate days and months names.
364 * @param string $s String with day or month name.
366 * @return string Translated string.
368 public function getDay($s)
370 $ret = str_replace(['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'],
371 [$this->t('Monday'), $this->t('Tuesday'), $this->t('Wednesday'), $this->t('Thursday'), $this->t('Friday'), $this->t('Saturday'), $this->t('Sunday')],
374 $ret = str_replace(['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
375 [$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')],
382 * Translate short days and months names.
384 * @param string $s String with short day or month name.
386 * @return string Translated string.
388 public function getDayShort($s)
390 $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
391 [$this->t('Mon'), $this->t('Tue'), $this->t('Wed'), $this->t('Thu'), $this->t('Fri'), $this->t('Sat'), $this->t('Sun')],
394 $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
395 [$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')],
404 * @return array index is present tense verb
405 * value is array containing past tense verb, translation of present, translation of past
406 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
407 * @hook poke_verbs pokes array
409 public function getPokeVerbs()
411 // index is present tense verb
412 // value is array containing past tense verb, translation of present, translation of past
414 'poke' => ['poked', $this->t('poke'), $this->t('poked')],
415 'ping' => ['pinged', $this->t('ping'), $this->t('pinged')],
416 'prod' => ['prodded', $this->t('prod'), $this->t('prodded')],
417 'slap' => ['slapped', $this->t('slap'), $this->t('slapped')],
418 'finger' => ['fingered', $this->t('finger'), $this->t('fingered')],
419 'rebuff' => ['rebuffed', $this->t('rebuff'), $this->t('rebuffed')],
422 Hook::callAll('poke_verbs', $arr);
428 * Creates a new L10n instance based on the given langauge
430 * @param string $lang The new language
432 * @return static A new L10n instance
435 public function withLang(string $lang)
437 // Don't create a new instance for same language
438 if ($lang === $this->lang) {
442 $newL10n = clone $this;
443 $newL10n->loadTranslationTable($lang);