]> BookStack Code Mirror - bookstack/blob - app/Util/LanguageManager.php
Added system cli, and created backups directory
[bookstack] / 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         'cs'          => ['iso' => 'cs_CZ', 'windows' => 'Czech'],
28         'da'          => ['iso' => 'da_DK', 'windows' => 'Danish'],
29         'de'          => ['iso' => 'de_DE', 'windows' => 'German'],
30         'de_informal' => ['iso' => 'de_DE', 'windows' => 'German'],
31         'en'          => ['iso' => 'en_GB', 'windows' => 'English'],
32         'el'          => ['iso' => 'el_GR', 'windows' => 'Greek'],
33         'es'          => ['iso' => 'es_ES', 'windows' => 'Spanish'],
34         'es_AR'       => ['iso' => 'es_AR', 'windows' => 'Spanish'],
35         'et'          => ['iso' => 'et_EE', 'windows' => 'Estonian'],
36         'eu'          => ['iso' => 'eu_ES', 'windows' => 'Basque'],
37         'fa'          => ['iso' => 'fa_IR', 'windows' => 'Persian'],
38         'fr'          => ['iso' => 'fr_FR', 'windows' => 'French'],
39         'he'          => ['iso' => 'he_IL', 'windows' => 'Hebrew'],
40         'hr'          => ['iso' => 'hr_HR', 'windows' => 'Croatian'],
41         'hu'          => ['iso' => 'hu_HU', 'windows' => 'Hungarian'],
42         'id'          => ['iso' => 'id_ID', 'windows' => 'Indonesian'],
43         'it'          => ['iso' => 'it_IT', 'windows' => 'Italian'],
44         'ja'          => ['iso' => 'ja', 'windows' => 'Japanese'],
45         'ko'          => ['iso' => 'ko_KR', 'windows' => 'Korean'],
46         'lt'          => ['iso' => 'lt_LT', 'windows' => 'Lithuanian'],
47         'lv'          => ['iso' => 'lv_LV', 'windows' => 'Latvian'],
48         'nl'          => ['iso' => 'nl_NL', 'windows' => 'Dutch'],
49         'nb'          => ['iso' => 'nb_NO', 'windows' => 'Norwegian (Bokmal)'],
50         'pl'          => ['iso' => 'pl_PL', 'windows' => 'Polish'],
51         'pt'          => ['iso' => 'pt_PT', 'windows' => 'Portuguese'],
52         'pt_BR'       => ['iso' => 'pt_BR', 'windows' => 'Portuguese'],
53         'ro'          => ['iso' => 'ro_RO', 'windows' => 'Romanian'],
54         'ru'          => ['iso' => 'ru', 'windows' => 'Russian'],
55         'sk'          => ['iso' => 'sk_SK', 'windows' => 'Slovak'],
56         'sl'          => ['iso' => 'sl_SI', 'windows' => 'Slovenian'],
57         'sv'          => ['iso' => 'sv_SE', 'windows' => 'Swedish'],
58         'uk'          => ['iso' => 'uk_UA', 'windows' => 'Ukrainian'],
59         'vi'          => ['iso' => 'vi_VN', 'windows' => 'Vietnamese'],
60         'zh_CN'       => ['iso' => 'zh_CN', 'windows' => 'Chinese (Simplified)'],
61         'zh_TW'       => ['iso' => 'zh_TW', 'windows' => 'Chinese (Traditional)'],
62         'tr'          => ['iso' => 'tr_TR', 'windows' => 'Turkish'],
63     ];
64
65     /**
66      * Get the language specifically for the currently logged-in user if available.
67      */
68     public function getUserLanguage(Request $request, string $default): string
69     {
70         try {
71             $user = user();
72         } catch (\Exception $exception) {
73             return $default;
74         }
75
76         if ($user->isDefault() && config('app.auto_detect_locale')) {
77             return $this->autoDetectLocale($request, $default);
78         }
79
80         return setting()->getUser($user, 'language', $default);
81     }
82
83     /**
84      * Check if the given BookStack language value is a right-to-left language.
85      */
86     public function isRTL(string $language): bool
87     {
88         return in_array($language, $this->rtlLanguages);
89     }
90
91     /**
92      * Autodetect the visitors locale by matching locales in their headers
93      * against the locales supported by BookStack.
94      */
95     protected function autoDetectLocale(Request $request, string $default): string
96     {
97         $availableLocales = config('app.locales');
98         foreach ($request->getLanguages() as $lang) {
99             if (in_array($lang, $availableLocales)) {
100                 return $lang;
101             }
102         }
103
104         return $default;
105     }
106
107     /**
108      * Get the ISO version of a BookStack language name.
109      */
110     public function getIsoName(string $language): string
111     {
112         return $this->localeMap[$language]['iso'] ?? $language;
113     }
114
115     /**
116      * Set the system date locale for localized date formatting.
117      * Will try both the standard locale name and the UTF8 variant.
118      */
119     public function setPhpDateTimeLocale(string $language): void
120     {
121         $isoLang = $this->localeMap[$language]['iso'] ?? '';
122         $isoLangPrefix = explode('_', $isoLang)[0];
123
124         $locales = array_values(array_filter([
125             $isoLang ? $isoLang . '.utf8' : false,
126             $isoLang ?: false,
127             $isoLang ? str_replace('_', '-', $isoLang) : false,
128             $isoLang ? $isoLangPrefix . '.UTF-8' : false,
129             $this->localeMap[$language]['windows'] ?? false,
130             $language,
131         ]));
132
133         if (!empty($locales)) {
134             setlocale(LC_TIME, $locales[0], ...array_slice($locales, 1));
135         }
136     }
137 }