BookStack Code Mirror - bookstack/blob - app/Util/LanguageManager.php

   1 <?php
   2
   3 namespace BookStack\Util;
   4
   5 use Illuminate\Http\Request;
   6
   7 class LanguageManager
   8 {
   9     /**
  10      * Array of right-to-left language options.
  11      */
  12     protected array $rtlLanguages = ['ar', 'fa', 'he'];
  13
  14     /**
  15      * Map of BookStack language names to best-estimate ISO and windows locale names.
  16      * Locales can often be found by running `locale -a` on a linux system.
  17      * Windows locales can be found at:
  18      * https://docs.microsoft.com/en-us/cpp/c-runtime-library/language-strings?view=msvc-170.
  19      *
  20      * @var array<string, array{iso: string, windows: string}>
  21      */
  22     protected array $localeMap = [
  23         'ar'          => ['iso' => 'ar', 'windows' => 'Arabic'],
  24         'bg'          => ['iso' => 'bg_BG', 'windows' => 'Bulgarian'],
  25         'bs'          => ['iso' => 'bs_BA', 'windows' => 'Bosnian (Latin)'],
  26         'ca'          => ['iso' => 'ca', 'windows' => 'Catalan'],
  27         'da'          => ['iso' => 'da_DK', 'windows' => 'Danish'],
  28         'de'          => ['iso' => 'de_DE', 'windows' => 'German'],
  29         'de_informal' => ['iso' => 'de_DE', 'windows' => 'German'],
  30         'en'          => ['iso' => 'en_GB', 'windows' => 'English'],
  31         'es'          => ['iso' => 'es_ES', 'windows' => 'Spanish'],
  32         'es_AR'       => ['iso' => 'es_AR', 'windows' => 'Spanish'],
  33         'et'          => ['iso' => 'et_EE', 'windows' => 'Estonian'],
  34         'eu'          => ['iso' => 'eu_ES', 'windows' => 'Basque'],
  35         'fa'          => ['iso' => 'fa_IR', 'windows' => 'Persian'],
  36         'fr'          => ['iso' => 'fr_FR', 'windows' => 'French'],
  37         'he'          => ['iso' => 'he_IL', 'windows' => 'Hebrew'],
  38         'hr'          => ['iso' => 'hr_HR', 'windows' => 'Croatian'],
  39         'hu'          => ['iso' => 'hu_HU', 'windows' => 'Hungarian'],
  40         'id'          => ['iso' => 'id_ID', 'windows' => 'Indonesian'],
  41         'it'          => ['iso' => 'it_IT', 'windows' => 'Italian'],
  42         'ja'          => ['iso' => 'ja', 'windows' => 'Japanese'],
  43         'ko'          => ['iso' => 'ko_KR', 'windows' => 'Korean'],
  44         'lt'          => ['iso' => 'lt_LT', 'windows' => 'Lithuanian'],
  45         'lv'          => ['iso' => 'lv_LV', 'windows' => 'Latvian'],
  46         'nl'          => ['iso' => 'nl_NL', 'windows' => 'Dutch'],
  47         'nb'          => ['iso' => 'nb_NO', 'windows' => 'Norwegian (Bokmal)'],
  48         'pl'          => ['iso' => 'pl_PL', 'windows' => 'Polish'],
  49         'pt'          => ['iso' => 'pt_PT', 'windows' => 'Portuguese'],
  50         'pt_BR'       => ['iso' => 'pt_BR', 'windows' => 'Portuguese'],
  51         'ru'          => ['iso' => 'ru', 'windows' => 'Russian'],
  52         'sk'          => ['iso' => 'sk_SK', 'windows' => 'Slovak'],
  53         'sl'          => ['iso' => 'sl_SI', 'windows' => 'Slovenian'],
  54         'sv'          => ['iso' => 'sv_SE', 'windows' => 'Swedish'],
  55         'uk'          => ['iso' => 'uk_UA', 'windows' => 'Ukrainian'],
  56         'vi'          => ['iso' => 'vi_VN', 'windows' => 'Vietnamese'],
  57         'zh_CN'       => ['iso' => 'zh_CN', 'windows' => 'Chinese (Simplified)'],
  58         'zh_TW'       => ['iso' => 'zh_TW', 'windows' => 'Chinese (Traditional)'],
  59         'tr'          => ['iso' => 'tr_TR', 'windows' => 'Turkish'],
  60     ];
  61
  62     /**
  63      * Get the language specifically for the currently logged-in user if available.
  64      */
  65     public function getUserLanguage(Request $request, string $default): string
  66     {
  67         try {
  68             $user = user();
  69         } catch (\Exception $exception) {
  70             return $default;
  71         }
  72
  73         if ($user->isDefault() && config('app.auto_detect_locale')) {
  74             return $this->autoDetectLocale($request, $default);
  75         }
  76
  77         return setting()->getUser($user, 'language', $default);
  78     }
  79
  80     /**
  81      * Check if the given BookStack language value is a right-to-left language.
  82      */
  83     public function isRTL(string $language): bool
  84     {
  85         return in_array($language, $this->rtlLanguages);
  86     }
  87
  88     /**
  89      * Autodetect the visitors locale by matching locales in their headers
  90      * against the locales supported by BookStack.
  91      */
  92     protected function autoDetectLocale(Request $request, string $default): string
  93     {
  94         $availableLocales = config('app.locales');
  95         foreach ($request->getLanguages() as $lang) {
  96             if (in_array($lang, $availableLocales)) {
  97                 return $lang;
  98             }
  99         }
 100
 101         return $default;
 102     }
 103
 104     /**
 105      * Get the ISO version of a BookStack language name.
 106      */
 107     public function getIsoName(string $language): string
 108     {
 109         return $this->localeMap[$language]['iso'] ?? $language;
 110     }
 111
 112     /**
 113      * Set the system date locale for localized date formatting.
 114      * Will try both the standard locale name and the UTF8 variant.
 115      */
 116     public function setPhpDateTimeLocale(string $language): void
 117     {
 118         $isoLang = $this->localeMap[$language]['iso'] ?? false;
 119
 120         $locales = array_filter([
 121             $isoLang ? $isoLang . '.utf8' : false,
 122             $isoLang ?: false,
 123             $isoLang ? str_replace('_', '-', $isoLang) : false,
 124             $this->localeMap[$language]['windows'] ?? false,
 125             $language,
 126         ]);
 127
 128         if (!empty($locales)) {
 129             setlocale(LC_TIME, ...$locales);
 130         }
 131     }
 132 }