src/Core/L10n.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core;
  23
  24 use Friendica\Core\Config\Capability\IManageConfigValues;
  25 use Friendica\Core\Session\Capability\IHandleSessions;
  26 use Friendica\Database\Database;
  27 use Friendica\Util\Strings;
  28
  29 /**
  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").
  32  */
  33 class L10n
  34 {
  35         /** @var string The default language */
  36         const DEFAULT = 'en';
  37         /** @var string[] The language names in their language */
  38         const LANG_NAMES = [
  39                 'ar'    => 'العربية',
  40                 'bg'    => 'Български',
  41                 'ca'    => 'Català',
  42                 'cs'    => 'Česky',
  43                 'da-dk' => 'Dansk (Danmark)',
  44                 'de'    => 'Deutsch',
  45                 'en-gb' => 'English (United Kingdom)',
  46                 'en-us' => 'English (United States)',
  47                 'en'    => 'English (Default)',
  48                 'eo'    => 'Esperanto',
  49                 'es'    => 'Español',
  50                 'et'    => 'Eesti',
  51                 'fi-fi' => 'Suomi',
  52                 'fr'    => 'Français',
  53                 'gd'    => 'Gàidhlig',
  54                 'hu'    => 'Magyar',
  55                 'is'    => 'Íslenska',
  56                 'it'    => 'Italiano',
  57                 'ja'    => '日本語',
  58                 'nb-no' => 'Norsk bokmål',
  59                 'nl'    => 'Nederlands',
  60                 'pl'    => 'Polski',
  61                 'pt-br' => 'Português Brasileiro',
  62                 'ro'    => 'Română',
  63                 'ru'    => 'Русский',
  64                 'sv'    => 'Svenska',
  65                 'zh-cn' => '简体中文',
  66         ];
  67
  68         /**
  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.
  72          *
  73          * @var string
  74          */
  75         private $lang = '';
  76
  77         /**
  78          * An array of translation strings whose key is the neutral english message.
  79          *
  80          * @var array
  81          */
  82         private $strings = [];
  83
  84         /**
  85          * @var Database
  86          */
  87         private $dba;
  88         /**
  89          * @var IManageConfigValues
  90          */
  91         private $config;
  92
  93         public function __construct(IManageConfigValues $config, Database $dba, IHandleSessions $session, array $server, array $get)
  94         {
  95                 $this->dba    = $dba;
  96                 $this->config = $config;
  97
  98                 $this->loadTranslationTable(L10n::detectLanguage($server, $get, $config->get('system', 'language', self::DEFAULT)));
  99                 $this->setSessionVariable($session);
 100                 $this->setLangFromSession($session);
 101         }
 102
 103         /**
 104          * Returns the current language code
 105          *
 106          * @return string Language code
 107          */
 108         public function getCurrentLang()
 109         {
 110                 return $this->lang;
 111         }
 112
 113         /**
 114          * Sets the language session variable
 115          */
 116         private function setSessionVariable(IHandleSessions $session)
 117         {
 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']);
 125                                 }
 126                         }
 127                 }
 128
 129                 if (isset($_GET['lang'])) {
 130                         $session->set('language', $_GET['lang']);
 131                 }
 132         }
 133
 134         private function setLangFromSession(IHandleSessions $session)
 135         {
 136                 if ($session->get('language') !== $this->lang) {
 137                         $this->loadTranslationTable($session->get('language') ?? $this->lang);
 138                 }
 139         }
 140
 141         /**
 142          * Loads string translation table
 143          *
 144          * First addon strings are loaded, then globals
 145          *
 146          * Uses an App object shim since all the strings files refer to $a->strings
 147          *
 148          * @param string $lang language code to load
 149          * @return void
 150          * @throws \Exception
 151          */
 152         private function loadTranslationTable(string $lang)
 153         {
 154                 $lang = Strings::sanitizeFilePathItem($lang);
 155
 156                 // Don't override the language setting with empty languages
 157                 if (empty($lang)) {
 158                         return;
 159                 }
 160
 161                 $a          = new \stdClass();
 162                 $a->strings = [];
 163
 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";
 170                         }
 171                 }
 172
 173                 if (file_exists(__DIR__ . "/../../view/lang/$lang/strings.php")) {
 174                         include __DIR__ . "/../../view/lang/$lang/strings.php";
 175                 }
 176
 177                 $this->lang    = $lang;
 178                 $this->strings = $a->strings;
 179
 180                 unset($a);
 181         }
 182
 183         /**
 184          * Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header
 185          *
 186          * @param string $sysLang The default fallback language
 187          * @param array  $server  The $_SERVER array
 188          * @param array  $get     The $_GET array
 189          *
 190          * @return string The two-letter language code
 191          */
 192         public static function detectLanguage(array $server, array $get, string $sysLang = self::DEFAULT): string
 193         {
 194                 $lang_variable = $server['HTTP_ACCEPT_LANGUAGE'] ?? null;
 195
 196                 if (empty($lang_variable)) {
 197                         $acceptedLanguages = [];
 198                 } else {
 199                         $acceptedLanguages = preg_split('/,\s*/', $lang_variable);
 200                 }
 201
 202                 // Add get as absolute quality accepted language (except this language isn't valid)
 203                 if (!empty($get['lang'])) {
 204                         $acceptedLanguages[] = $get['lang'];
 205                 }
 206
 207                 // return the sys language in case there's nothing to do
 208                 if (empty($acceptedLanguages)) {
 209                         return $sysLang;
 210                 }
 211
 212                 // Set the syslang as default fallback
 213                 $current_lang = $sysLang;
 214                 // start with quality zero (every guessed language is more acceptable ..)
 215                 $current_q = 0;
 216
 217                 foreach ($acceptedLanguages as $acceptedLanguage) {
 218                         $res = preg_match(
 219                                 '/^([a-z]{1,8}(?:-[a-z]{1,8})*)(?:;\s*q=(0(?:\.[0-9]{1,3})?|1(?:\.0{1,3})?))?$/i',
 220                                 $acceptedLanguage,
 221                                 $matches
 222                         );
 223
 224                         // Invalid language? -> skip
 225                         if (!$res) {
 226                                 continue;
 227                         }
 228
 229                         // split language codes based on it's "-"
 230                         $lang_code = explode('-', $matches[1]);
 231
 232                         // determine the quality of the guess
 233                         if (isset($matches[2])) {
 234                                 $lang_quality = (float)$matches[2];
 235                         } else {
 236                                 // fallback so without a quality parameter, it's probably the best
 237                                 $lang_quality = 1;
 238                         }
 239
 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;
 249                                                 break;
 250                                         }
 251                                 }
 252
 253                                 // remove the most right code-part
 254                                 array_pop($lang_code);
 255                         }
 256                 }
 257
 258                 return $current_lang;
 259         }
 260
 261         /**
 262          * Return the localized version of the provided string with optional string interpolation
 263          *
 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.
 267          *
 268          * Usages:
 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)
 272          *
 273          * @param string $s
 274          * @param array  $vars Variables to interpolate in the translation string
 275          *
 276          * @return string
 277          */
 278         public function t(string $s, ...$vars): string
 279         {
 280                 if (empty($s)) {
 281                         return '';
 282                 }
 283
 284                 if (!empty($this->strings[$s])) {
 285                         $t = $this->strings[$s];
 286                         $s = is_array($t) ? $t[0] : $t;
 287                 }
 288
 289                 if (count($vars) > 0) {
 290                         $s = sprintf($s, ...$vars);
 291                 }
 292
 293                 return $s;
 294         }
 295
 296         /**
 297          * Return the localized version of a singular/plural string with optional string interpolation
 298          *
 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.
 304          *
 305          * Usages:
 306          * - DI::l10n()->tt('Like', 'Likes', $count)
 307          * - DI::l10n()->tt("%s user deleted", "%s users deleted", count($users))
 308          *
 309          * @param string $singular
 310          * @param string $plural
 311          * @param int    $count
 312          * @param array  $vars Variables to interpolate in the translation string
 313          *
 314          * @return string
 315          * @throws \Exception
 316          */
 317         public function tt(string $singular, string $plural, int $count, ...$vars): string
 318         {
 319                 $s = null;
 320
 321                 if (!empty($this->strings[$singular])) {
 322                         $t = $this->strings[$singular];
 323                         if (is_array($t)) {
 324                                 $plural_function = 'string_plural_select_' . str_replace('-', '_', $this->lang);
 325                                 if (function_exists($plural_function)) {
 326                                         $i = $plural_function($count);
 327                                 } else {
 328                                         $i = $this->stringPluralSelectDefault($count);
 329                                 }
 330
 331                                 if (isset($t[$i])) {
 332                                         $s = $t[$i];
 333                                 } elseif (count($t) > 0) {
 334                                         // for some languages there is only a single array item
 335                                         $s = $t[0];
 336                                 }
 337                                 // if $t is empty, skip it, because empty strings array are intended
 338                                 // to make string file smaller when there's no translation
 339                         } else {
 340                                 $s = $t;
 341                         }
 342                 }
 343
 344                 if (is_null($s) && $this->stringPluralSelectDefault($count)) {
 345                         $s = $plural;
 346                 } elseif (is_null($s)) {
 347                         $s = $singular;
 348                 }
 349
 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);
 353
 354                 return $s;
 355         }
 356
 357         /**
 358          * Provide a fallback which will not collide with a function defined in any language file
 359          *
 360          * @param int $n
 361          *
 362          * @return bool
 363          */
 364         private function stringPluralSelectDefault(int $n): bool
 365         {
 366                 return $n != 1;
 367         }
 368
 369         /**
 370          * Return installed languages codes as associative array
 371          *
 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.
 376          *
 377          * Ex: array('de' => 'Deutsch', 'en' => 'English', 'fr' => 'Français', ...)
 378          *
 379          * @return array
 380          */
 381         public function getAvailableLanguages(): array
 382         {
 383                 $langs              = [];
 384                 $strings_file_paths = glob('view/lang/*/strings.php');
 385
 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';
 389                         }
 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];
 394                         }
 395                 }
 396                 return $langs;
 397         }
 398
 399         /**
 400          * Get language codes that are detectable by our language detection routines.
 401          * Öanguages are excluded that aren't used often and that tend to false detections.
 402          * The listed codes are a collection of both the official ISO 639-1 codes and
 403          * the codes that are used by our built-in language detection routine.
 404          * When the detection is done, the result only consists of the official ISO 639-1 codes.
 405          *
 406          * @return array
 407          */
 408         public function getDetectableLanguages(): array
 409         {
 410                 $additional_langs = [
 411                         'af', 'az', 'az-Cyrl', 'az-Latn', 'be', 'bn', 'bs', 'bs-Cyrl', 'bs-Latn',
 412                         'cy', 'da', 'el', 'el-monoton', 'el-polyton', 'en', 'eu', 'fa', 'fi',
 413                         'ga', 'gl', 'gu', 'he', 'hi', 'hr', 'hy', 'id', 'in', 'iu', 'iw', 'jv', 'jw',
 414                         'ka', 'km', 'ko', 'lt', 'lv', 'mo', 'ms', 'ms-Arab', 'ms-Latn', 'nb', 'nn', 'no',
 415                         'pt', 'pt-PT', 'pt-BR', 'ro', 'sa', 'sk', 'sl', 'sq', 'sr', 'sr-Cyrl', 'sr-Latn', 'sw',
 416                         'ta', 'th', 'tl', 'tr', 'ug', 'uk', 'uz', 'vi', 'zh', 'zh-Hant', 'zh-Hans',
 417                 ];
 418
 419                 if (in_array('cld2', get_loaded_extensions())) {
 420                         $additional_langs = array_merge($additional_langs,
 421                                 ['dv', 'kn', 'lo', 'ml', 'or', 'pa', 'sd', 'si', 'te', 'yi']);
 422                 }
 423
 424                 $langs = array_merge($additional_langs, array_keys($this->getAvailableLanguages()));
 425                 sort($langs);
 426                 return $langs;
 427         }
 428
 429         /**
 430          * Return a list of supported languages witzh their two byte language codes.
 431          *
 432          * @param bool $international If set to true, additionally the international language name is returned as well.
 433          * @return array
 434          */
 435         public function getLanguageCodes(bool $international = false): array
 436         {
 437                 $iso639 = new \Matriphe\ISO639\ISO639;
 438
 439                 $languages = [];
 440
 441                 foreach ($this->getDetectableLanguages() as $code) {
 442                         $code     = $this->toISO6391($code);
 443                         $native   = $iso639->nativeByCode1($code);
 444                         $language = $iso639->languageByCode1($code);
 445                         if ($native != $language && $international) {
 446                                 $languages[$code] = $this->t('%s (%s)', $native, $language);
 447                         } else {
 448                                 $languages[$code] = $native;
 449                         }
 450                 }
 451
 452                 return $languages;
 453         }
 454
 455         /**
 456          * Convert the language code to ISO639-1
 457          * It also converts old codes to their new counterparts.
 458          *
 459          * @param string $code
 460          * @return string
 461          */
 462         public function toISO6391(string $code): string
 463         {
 464                 if ((strlen($code) > 2) && (substr($code, 2, 1) == '-')) {
 465                         $code = substr($code, 0, 2);
 466                 }
 467                 if (in_array($code, ['nb', 'nn'])) {
 468                         $code = 'no';
 469                 }
 470                 if ($code == 'in') {
 471                         $code = 'id';
 472                 }
 473                 if ($code == 'iw') {
 474                         $code = 'he';
 475                 }
 476                 if ($code == 'jw') {
 477                         $code = 'jv';
 478                 }
 479                 if ($code == 'mo') {
 480                         $code = 'ro';
 481                 }
 482                 return $code;
 483         }
 484
 485         /**
 486          * Translate days and months names.
 487          *
 488          * @param string $s String with day or month name.
 489          * @return string Translated string.
 490          */
 491         public function getDay(string $s): string
 492         {
 493                 $ret = str_replace(['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'],
 494                         [$this->t('Monday'), $this->t('Tuesday'), $this->t('Wednesday'), $this->t('Thursday'), $this->t('Friday'), $this->t('Saturday'), $this->t('Sunday')],
 495                         $s);
 496
 497                 $ret = str_replace(['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
 498                         [$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')],
 499                         $ret);
 500
 501                 return $ret;
 502         }
 503
 504         /**
 505          * Translate short days and months names.
 506          *
 507          * @param string $s String with short day or month name.
 508          * @return string Translated string.
 509          */
 510         public function getDayShort(string $s): string
 511         {
 512                 $ret = str_replace(['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
 513                         [$this->t('Mon'), $this->t('Tue'), $this->t('Wed'), $this->t('Thu'), $this->t('Fri'), $this->t('Sat'), $this->t('Sun')],
 514                         $s);
 515
 516                 $ret = str_replace(['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
 517                         [$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')],
 518                         $ret);
 519
 520                 return $ret;
 521         }
 522
 523         /**
 524          * Creates a new L10n instance based on the given langauge
 525          *
 526          * @param string $lang The new language
 527          *
 528          * @return static A new L10n instance
 529          * @throws \Exception
 530          */
 531         public function withLang(string $lang): L10n
 532         {
 533                 // Don't create a new instance for same language
 534                 if ($lang === $this->lang) {
 535                         return $this;
 536                 }
 537
 538                 $newL10n = clone $this;
 539                 $newL10n->loadTranslationTable($lang);
 540                 return $newL10n;
 541         }
 542 }