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

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