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

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