3 namespace Friendica\Core\L10n;
5 use Friendica\Core\Config\Configuration;
6 use Friendica\Core\Hook;
7 use Friendica\Core\Session;
8 use Friendica\Database\Database;
9 use Friendica\Util\Strings;
10 use Psr\Log\LoggerInterface;
13 * Provide Language, Translation, and Localization functions to the application
14 * Localization can be referred to by the numeronym L10N (as in: "L", followed by ten more letters, and then "N").
19 * A string indicating the current language used for translation:
20 * - Two-letter ISO 639-1 code.
21 * - Two-letter ISO 639-1 code + dash + Two-letter ISO 3166-1 alpha-2 country code.
27 * A language code saved for later after pushLang() has been called.
31 private $langSave = '';
34 * An array of translation strings whose key is the neutral english message.
38 private $strings = [];
40 * An array of translation strings saved for later after pushLang() has been called.
44 private $stringsSave = [];
52 * @var LoggerInterface
56 public function __construct(Configuration $config, Database $dba, LoggerInterface $logger)
59 $this->logger = $logger;
61 $this->loadTranslationTable(L10n::detectLanguage($config->get('system', 'language', 'en')));
65 * Returns the current language code
67 * @return string Language code
69 public function getCurrentLang()
75 * Sets the language session variable
77 public function setSessionVariable()
79 if (Session::get('authenticated') && !Session::get('language')) {
80 $_SESSION['language'] = $this->lang;
81 // we haven't loaded user data yet, but we need user language
82 if (Session::get('uid')) {
83 $user = $this->dba->selectFirst('user', ['language'], ['uid' => $_SESSION['uid']]);
84 if ($this->dba->isResult($user)) {
85 $_SESSION['language'] = $user['language'];
90 if (isset($_GET['lang'])) {
91 Session::set('language', $_GET['lang']);
95 public function setLangFromSession()
97 if (Session::get('language') !== $this->lang) {
98 $this->loadTranslationTable(Session::get('language'));
103 * This function should be called before formatting messages in a specific target language
104 * different from the current user/system language.
106 * It saves the current translation strings in a separate variable and loads new translations strings.
108 * If called repeatedly, it won't save the translation strings again, just load the new ones.
110 * @param string $lang Language code
114 * @brief Stores the current language strings and load a different language.
116 public function pushLang($lang)
118 if ($lang === $this->lang) {
122 if (empty($this->langSave)) {
123 $this->langSave = $this->lang;
124 $this->stringsSave = $this->strings;
127 $this->loadTranslationTable($lang);
131 * Restores the original user/system language after having used pushLang()
133 public function popLang()
135 if (!isset($this->langSave)) {
139 $this->strings = $this->stringsSave;
140 $this->lang = $this->langSave;
142 $this->stringsSave = null;
143 $this->langSave = null;
147 * Loads string translation table
149 * First addon strings are loaded, then globals
151 * Uses an App object shim since all the strings files refer to $a->strings
153 * @param string $lang language code to load
157 private function loadTranslationTable($lang)
159 $lang = Strings::sanitizeFilePathItem($lang);
161 $a = new \stdClass();
164 // load enabled addons strings
165 $addons = $this->dba->select('addon', ['name'], ['installed' => true]);
166 while ($p = $this->dba->fetch($addons)) {
167 $name = Strings::sanitizeFilePathItem($p['name']);
168 if (file_exists("addon/$name/lang/$lang/strings.php")) {
169 include "addon/$name/lang/$lang/strings.php";
173 if (file_exists("view/lang/$lang/strings.php")) {
174 include "view/lang/$lang/strings.php";
178 $this->strings = $a->strings;
184 * @brief Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header
186 * @param string $sysLang The default fallback language
188 * @return string The two-letter language code
190 public static function detectLanguage(string $sysLang = 'en')
194 if (!empty($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
195 // break up string into pieces (languages and q factors)
196 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);
198 if (count($lang_parse[1])) {
199 // go through the list of prefered languages and add a generic language
200 // for sub-linguas (e.g. de-ch will add de) if not already in array
201 for ($i = 0; $i < count($lang_parse[1]); $i++) {
202 $lang_list[] = strtolower($lang_parse[1][$i]);
203 if (strlen($lang_parse[1][$i]) > 3) {
204 $dashpos = strpos($lang_parse[1][$i], '-');
205 if (!in_array(substr($lang_parse[1][$i], 0, $dashpos), $lang_list)) {
206 $lang_list[] = strtolower(substr($lang_parse[1][$i], 0, $dashpos));
213 if (isset($_GET['lang'])) {
214 $lang_list = [$_GET['lang']];
217 // check if we have translations for the preferred languages and pick the 1st that has
218 foreach ($lang_list as $lang) {
219 if ($lang === 'en' || (file_exists("view/lang/$lang") && is_dir("view/lang/$lang"))) {
224 if (isset($preferred)) {
228 // in case none matches, get the system wide configured language, or fall back to English
233 * @brief Return the localized version of the provided string with optional string interpolation
235 * This function takes a english string as parameter, and if a localized version
236 * exists for the current language, substitutes it before performing an eventual
237 * string interpolation (sprintf) with additional optional arguments.
240 * - L10n::t('This is an example')
241 * - L10n::t('URL %s returned no result', $url)
242 * - L10n::t('Current version: %s, new version: %s', $current_version, $new_version)
245 * @param array $vars Variables to interpolate in the translation string
249 public function t($s, ...$vars)
255 if (!empty($this->strings[$s])) {
256 $t = $this->strings[$s];
257 $s = is_array($t) ? $t[0] : $t;
260 if (count($vars) > 0) {
261 $s = sprintf($s, ...$vars);
268 * @brief Return the localized version of a singular/plural string with optional string interpolation
270 * This function takes two english strings as parameters, singular and plural, as
271 * well as a count. If a localized version exists for the current language, they
272 * are used instead. Discrimination between singular and plural is done using the
273 * localized function if any or the default one. Finally, a string interpolation
274 * is performed using the count as parameter.
277 * - L10n::tt('Like', 'Likes', $count)
278 * - L10n::tt("%s user deleted", "%s users deleted", count($users))
280 * @param string $singular
281 * @param string $plural
287 public function tt(string $singular, string $plural, int $count)
289 if (!empty($this->strings[$singular])) {
290 $t = $this->strings[$singular];
292 $plural_function = 'string_plural_select_' . str_replace('-', '_', $this->lang);
293 if (function_exists($plural_function)) {
294 $i = $plural_function($count);
296 $i = $this->stringPluralSelectDefault($count);
299 // for some languages there is only a single array item
300 if (!isset($t[$i])) {
308 } elseif ($this->stringPluralSelectDefault($count)) {
314 $s = @sprintf($s, $count);
320 * Provide a fallback which will not collide with a function defined in any language file
326 private function stringPluralSelectDefault($n)
332 * Return installed languages codes as associative array
334 * Scans the view/lang directory for the existence of "strings.php" files, and
335 * returns an alphabetical list of their folder names (@-char language codes).
336 * Adds the english language if it's missing from the list.
338 * Ex: array('de' => 'de', 'en' => 'en', 'fr' => 'fr', ...)
342 public static function getAvailableLanguages()
345 $strings_file_paths = glob('view/lang/*/strings.php');
347 if (is_array($strings_file_paths) && count($strings_file_paths)) {
348 if (!in_array('view/lang/en/strings.php', $strings_file_paths)) {
349 $strings_file_paths[] = 'view/lang/en/strings.php';
351 asort($strings_file_paths);
352 foreach ($strings_file_paths as $strings_file_path) {
353 $path_array = explode('/', $strings_file_path);
354 $langs[$path_array[2]] = $path_array[2];
361 * Translate days and months names.
363 * @param string $s String with day or month name.
365 * @return string Translated string.
367 public function getDay($s)
369 $ret = str_replace(['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'],
370 [$this->t('Monday'), $this->t('Tuesday'), $this->t('Wednesday'), $this->t('Thursday'), $this->t('Friday'), $this->t('Saturday'), $this->t('Sunday')],
373 $ret = str_replace(['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
374 [$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')],
381 * Translate short days and months names.
383 * @param string $s String with short day or month name.
385 * @return string Translated string.
387 public function getDayShort($s)
389 $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
390 [$this->t('Mon'), $this->t('Tue'), $this->t('Wed'), $this->t('Thu'), $this->t('Fri'), $this->t('Sat'), $this->t('Sun')],
393 $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
394 [$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')],
403 * @return array index is present tense verb
404 * value is array containing past tense verb, translation of present, translation of past
405 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
406 * @hook poke_verbs pokes array
408 public function getPokeVerbs()
410 // index is present tense verb
411 // value is array containing past tense verb, translation of present, translation of past
413 'poke' => ['poked', $this->t('poke'), $this->t('poked')],
414 'ping' => ['pinged', $this->t('ping'), $this->t('pinged')],
415 'prod' => ['prodded', $this->t('prod'), $this->t('prodded')],
416 'slap' => ['slapped', $this->t('slap'), $this->t('slapped')],
417 'finger' => ['fingered', $this->t('finger'), $this->t('fingered')],
418 'rebuff' => ['rebuffed', $this->t('rebuff'), $this->t('rebuffed')],
421 Hook::callAll('poke_verbs', $arr);