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         'cy'          => ['iso' => 'cy_GB', 'windows' => 'Welsh'],
  31         'da'          => ['iso' => 'da_DK', 'windows' => 'Danish'],
  32         'de'          => ['iso' => 'de_DE', 'windows' => 'German'],
  33         'de_informal' => ['iso' => 'de_DE', 'windows' => 'German'],
  34         'el'          => ['iso' => 'el_GR', 'windows' => 'Greek'],
  35         'en'          => ['iso' => 'en_GB', 'windows' => 'English'],
  36         'es'          => ['iso' => 'es_ES', 'windows' => 'Spanish'],
  37         'es_AR'       => ['iso' => 'es_AR', 'windows' => 'Spanish'],
  38         'et'          => ['iso' => 'et_EE', 'windows' => 'Estonian'],
  39         'eu'          => ['iso' => 'eu_ES', 'windows' => 'Basque'],
  40         'fa'          => ['iso' => 'fa_IR', 'windows' => 'Persian'],
  41         'fr'          => ['iso' => 'fr_FR', 'windows' => 'French'],
  42         'he'          => ['iso' => 'he_IL', 'windows' => 'Hebrew'],
  43         'hr'          => ['iso' => 'hr_HR', 'windows' => 'Croatian'],
  44         'hu'          => ['iso' => 'hu_HU', 'windows' => 'Hungarian'],
  45         'id'          => ['iso' => 'id_ID', 'windows' => 'Indonesian'],
  46         'it'          => ['iso' => 'it_IT', 'windows' => 'Italian'],
  47         'ja'          => ['iso' => 'ja', 'windows' => 'Japanese'],
  48         'ka'          => ['iso' => 'ka_GE', 'windows' => 'Georgian'],
  49         'ko'          => ['iso' => 'ko_KR', 'windows' => 'Korean'],
  50         'lt'          => ['iso' => 'lt_LT', 'windows' => 'Lithuanian'],
  51         'lv'          => ['iso' => 'lv_LV', 'windows' => 'Latvian'],
  52         'nb'          => ['iso' => 'nb_NO', 'windows' => 'Norwegian (Bokmal)'],
  53         'nl'          => ['iso' => 'nl_NL', 'windows' => 'Dutch'],
  54         'pl'          => ['iso' => 'pl_PL', 'windows' => 'Polish'],
  55         'pt'          => ['iso' => 'pt_PT', 'windows' => 'Portuguese'],
  56         'pt_BR'       => ['iso' => 'pt_BR', 'windows' => 'Portuguese'],
  57         'ro'          => ['iso' => 'ro_RO', 'windows' => 'Romanian'],
  58         'ru'          => ['iso' => 'ru', 'windows' => 'Russian'],
  59         'sk'          => ['iso' => 'sk_SK', 'windows' => 'Slovak'],
  60         'sl'          => ['iso' => 'sl_SI', 'windows' => 'Slovenian'],
  61         'sv'          => ['iso' => 'sv_SE', 'windows' => 'Swedish'],
  62         'tr'          => ['iso' => 'tr_TR', 'windows' => 'Turkish'],
  63         'uk'          => ['iso' => 'uk_UA', 'windows' => 'Ukrainian'],
  64         'uz'          => ['iso' => 'uz_UZ', 'windows' => 'Uzbek'],
  65         'vi'          => ['iso' => 'vi_VN', 'windows' => 'Vietnamese'],
  66         'zh_CN'       => ['iso' => 'zh_CN', 'windows' => 'Chinese (Simplified)'],
  67         'zh_TW'       => ['iso' => 'zh_TW', 'windows' => 'Chinese (Traditional)'],
  68     ];
  69
  70     /**
  71      * Get the BookStack locale string for the given user.
  72      */
  73     protected function getLocaleForUser(User $user): string
  74     {
  75         $default = config('app.default_locale');
  76
  77         if ($user->isGuest() && config('app.auto_detect_locale')) {
  78             return $this->autoDetectLocale(request(), $default);
  79         }
  80
  81         return setting()->getUser($user, 'language', $default);
  82     }
  83
  84     /**
  85      * Get a locale definition for the current user.
  86      */
  87     public function getForUser(User $user): LocaleDefinition
  88     {
  89         $localeString = $this->getLocaleForUser($user);
  90
  91         return new LocaleDefinition(
  92             $localeString,
  93             $this->getIsoName($localeString),
  94             in_array($localeString, $this->rtlLocales),
  95         );
  96     }
  97
  98     /**
  99      * Autodetect the visitors locale by matching locales in their headers
 100      * against the locales supported by BookStack.
 101      */
 102     protected function autoDetectLocale(Request $request, string $default): string
 103     {
 104         $availableLocales = $this->getAllAppLocales();
 105
 106         foreach ($request->getLanguages() as $lang) {
 107             if (in_array($lang, $availableLocales)) {
 108                 return $lang;
 109             }
 110         }
 111
 112         return $default;
 113     }
 114
 115     /**
 116      * Get the ISO version of a BookStack locale.
 117      */
 118     protected function getIsoName(string $locale): string
 119     {
 120         return $this->localeMap[$locale]['iso'] ?? $locale;
 121     }
 122
 123     /**
 124      * Sets the active locale for system level components.
 125      */
 126     public function setAppLocale(LocaleDefinition $locale): void
 127     {
 128         app()->setLocale($locale->appLocale());
 129         Carbon::setLocale($locale->isoLocale());
 130         $this->setPhpDateTimeLocale($locale);
 131     }
 132
 133     /**
 134      * Set the system date locale for localized date formatting.
 135      * Will try both the standard locale name and the UTF8 variant.
 136      */
 137     public function setPhpDateTimeLocale(LocaleDefinition $locale): void
 138     {
 139         $appLocale = $locale->appLocale();
 140         $isoLocale = $this->localeMap[$appLocale]['iso'] ?? '';
 141         $isoLocalePrefix = explode('_', $isoLocale)[0];
 142
 143         $locales = array_values(array_filter([
 144             $isoLocale ? $isoLocale . '.utf8' : false,
 145             $isoLocale ?: false,
 146             $isoLocale ? str_replace('_', '-', $isoLocale) : false,
 147             $isoLocale ? $isoLocalePrefix . '.UTF-8' : false,
 148             $this->localeMap[$appLocale]['windows'] ?? false,
 149             $appLocale,
 150         ]));
 151
 152         if (!empty($locales)) {
 153             setlocale(LC_TIME, $locales[0], ...array_slice($locales, 1));
 154         }
 155     }
 156
 157     /**
 158      * Get all the available app-specific level locale strings.
 159      */
 160     public function getAllAppLocales(): array
 161     {
 162         return array_keys($this->localeMap);
 163     }
 164 }