src/Core/L10n.php

   1 <?php
   2 /**
   3  * @file src/Core/L10n.php
   4  */
   5 namespace Friendica\Core;
   6
   7 use Friendica\BaseObject;
   8 use Friendica\Database\DBA;
   9
  10 /**
  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").
  13  */
  14 class L10n extends BaseObject
  15 {
  16         /**
  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.
  20          * @var string
  21          */
  22         private static $lang = '';
  23         /**
  24          * A language code saved for later after pushLang() has been called.
  25          *
  26          * @var string
  27          */
  28         private static $langSave = '';
  29
  30         /**
  31          * An array of translation strings whose key is the neutral english message.
  32          *
  33          * @var array
  34          */
  35         private static $strings = [];
  36         /**
  37          * An array of translation strings saved for later after pushLang() has been called.
  38          *
  39          * @var array
  40          */
  41         private static $stringsSave = [];
  42
  43         /**
  44          * Detects the language and sets the translation table
  45          */
  46         public static function init()
  47         {
  48                 $lang = self::detectLanguage();
  49                 self::loadTranslationTable($lang);
  50         }
  51
  52         /**
  53          * Returns the current language code
  54          *
  55          * @return string Language code
  56          */
  57         public static function getCurrentLang()
  58         {
  59                 return self::$lang;
  60         }
  61
  62         /**
  63          * Sets the language session variable
  64          */
  65         public static function setSessionVariable()
  66         {
  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'];
  74                                 }
  75                         }
  76                 }
  77
  78                 if (isset($_GET['lang'])) {
  79                         $_SESSION['language'] = $_GET['lang'];
  80                 }
  81         }
  82
  83         public static function setLangFromSession()
  84         {
  85                 if (!empty($_SESSION['language']) && $_SESSION['language'] !== self::$lang) {
  86                         self::loadTranslationTable($_SESSION['language']);
  87                 }
  88         }
  89
  90         /**
  91          * @brief Returns the preferred language from the HTTP_ACCEPT_LANGUAGE header
  92          * @return string The two-letter language code
  93          */
  94         public static function detectLanguage()
  95         {
  96                 $lang_list = [];
  97
  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);
 101
 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));
 111                                                 }
 112                                         }
 113                                 }
 114                         }
 115                 }
 116
 117                 if (isset($_GET['lang'])) {
 118                         $lang_list = [$_GET['lang']];
 119                 }
 120
 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"))) {
 124                                 $preferred = $lang;
 125                                 break;
 126                         }
 127                 }
 128                 if (isset($preferred)) {
 129                         return $preferred;
 130                 }
 131
 132                 // in case none matches, get the system wide configured language, or fall back to English
 133                 return Config::get('system', 'language', 'en');
 134         }
 135
 136         /**
 137          * This function should be called before formatting messages in a specific target language
 138          * different from the current user/system language.
 139          *
 140          * It saves the current translation strings in a separate variable and loads new translations strings.
 141          *
 142          * If called repeatedly, it won't save the translation strings again, just load the new ones.
 143          *
 144          * @see popLang()
 145          * @brief Stores the current language strings and load a different language.
 146          * @param string $lang Language code
 147          */
 148         public static function pushLang($lang)
 149         {
 150                 if (!self::$lang) {
 151                         self::init();
 152                 }
 153
 154                 if ($lang === self::$lang) {
 155                         return;
 156                 }
 157
 158                 if (!self::$langSave) {
 159                         self::$langSave = self::$lang;
 160                         self::$stringsSave = self::$strings;
 161                 }
 162
 163                 self::loadTranslationTable($lang);
 164         }
 165
 166         /**
 167          * Restores the original user/system language after having used pushLang()
 168          */
 169         public static function popLang()
 170         {
 171                 if (!self::$langSave) {
 172                         return;
 173                 }
 174
 175                 self::$strings = self::$stringsSave;
 176                 self::$lang = self::$langSave;
 177
 178                 self::$stringsSave = [];
 179                 self::$langSave = '';
 180         }
 181
 182         /**
 183          * Loads string translation table
 184          *
 185          * First addon strings are loaded, then globals
 186          *
 187          * Uses an App object shim since all the strings files refer to $a->strings
 188          *
 189          * @param string $lang language code to load
 190          */
 191         private static function loadTranslationTable($lang)
 192         {
 193                 if ($lang === self::$lang) {
 194                         return;
 195                 }
 196
 197                 $a = new \stdClass();
 198                 $a->strings = [];
 199
 200                 // load enabled addons strings
 201                 $addons = DBA::select('addon', ['name'], ['installed' => true]);
 202                 while ($p = DBA::fetch($addons)) {
 203                         $name = $p['name'];
 204                         if (file_exists("addon/$name/lang/$lang/strings.php")) {
 205                                 include "addon/$name/lang/$lang/strings.php";
 206                         }
 207                 }
 208
 209                 if (file_exists("view/lang/$lang/strings.php")) {
 210                         include "view/lang/$lang/strings.php";
 211                 }
 212
 213                 self::$lang = $lang;
 214                 self::$strings = $a->strings;
 215
 216                 unset($a);
 217         }
 218
 219         /**
 220          * @brief Return the localized version of the provided string with optional string interpolation
 221          *
 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.
 225          *
 226          * Usages:
 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)
 230          *
 231          * @param string $s
 232          * @param array  $vars Variables to interpolate in the translation string
 233          * @return string
 234          */
 235         public static function t($s, ...$vars)
 236         {
 237                 if (empty($s)) {
 238                         return '';
 239                 }
 240
 241                 if (!self::$lang) {
 242                         self::init();
 243                 }
 244
 245                 if (!empty(self::$strings[$s])) {
 246                         $t = self::$strings[$s];
 247                         $s = is_array($t) ? $t[0] : $t;
 248                 }
 249
 250                 if (count($vars) > 0) {
 251                         $s = sprintf($s, ...$vars);
 252                 }
 253
 254                 return $s;
 255         }
 256
 257         /**
 258          * @brief Return the localized version of a singular/plural string with optional string interpolation
 259          *
 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.
 265          *
 266          * Usages:
 267          * - L10n::tt('Like', 'Likes', $count)
 268          * - L10n::tt("%s user deleted", "%s users deleted", count($users))
 269          *
 270          * @param string $singular
 271          * @param string $plural
 272          * @param int $count
 273          * @return string
 274          */
 275         public static function tt($singular, $plural, $count)
 276         {
 277                 if (!is_numeric($count)) {
 278                         Logger::log('Non numeric count called by ' . System::callstack(20));
 279                 }
 280
 281                 if (!self::$lang) {
 282                         self::init();
 283                 }
 284
 285                 if (!empty(self::$strings[$singular])) {
 286                         $t = self::$strings[$singular];
 287                         if (is_array($t)) {
 288                                 $plural_function = 'string_plural_select_' . str_replace('-', '_', self::$lang);
 289                                 if (function_exists($plural_function)) {
 290                                         $i = $plural_function($count);
 291                                 } else {
 292                                         $i = self::stringPluralSelectDefault($count);
 293                                 }
 294
 295                                 // for some languages there is only a single array item
 296                                 if (!isset($t[$i])) {
 297                                         $s = $t[0];
 298                                 } else {
 299                                         $s = $t[$i];
 300                                 }
 301                         } else {
 302                                 $s = $t;
 303                         }
 304                 } elseif (self::stringPluralSelectDefault($count)) {
 305                         $s = $plural;
 306                 } else {
 307                         $s = $singular;
 308                 }
 309
 310                 $s = @sprintf($s, $count);
 311
 312                 return $s;
 313         }
 314
 315         /**
 316          * Provide a fallback which will not collide with a function defined in any language file
 317          */
 318         private static function stringPluralSelectDefault($n)
 319         {
 320                 return $n != 1;
 321         }
 322
 323         /**
 324          * @brief Return installed languages codes as associative array
 325          *
 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.
 329          *
 330          * Ex: array('de' => 'de', 'en' => 'en', 'fr' => 'fr', ...)
 331          *
 332          * @return array
 333          */
 334         public static function getAvailableLanguages()
 335         {
 336                 $langs = [];
 337                 $strings_file_paths = glob('view/lang/*/strings.php');
 338
 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';
 342                         }
 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];
 347                         }
 348                 }
 349                 return $langs;
 350         }
 351
 352         /**
 353          * @brief Translate days and months names.
 354          *
 355          * @param string $s String with day or month name.
 356          * @return string Translated string.
 357          */
 358         public static function getDay($s)
 359         {
 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')],
 362                         $s);
 363
 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')],
 366                         $ret);
 367
 368                 return $ret;
 369         }
 370
 371         /**
 372          * @brief Translate short days and months names.
 373          *
 374          * @param string $s String with short day or month name.
 375          * @return string Translated string.
 376          */
 377         public static function getDayShort($s)
 378         {
 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')],
 381                         $s);
 382
 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')],
 385                         $ret);
 386
 387                 return $ret;
 388         }
 389
 390         /**
 391          * Load poke verbs
 392          *
 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
 396          */
 397         public static function getPokeVerbs()
 398         {
 399                 // index is present tense verb
 400                 // value is array containing past tense verb, translation of present, translation of past
 401                 $arr = [
 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')],
 408                 ];
 409
 410                 Hook::callAll('poke_verbs', $arr);
 411
 412                 return $arr;
 413         }
 414 }