[TASK] Remove comments that contain v4 or FLOW information
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Localization / Locales.php
1 <?php
2 namespace TYPO3\CMS\Core\Localization;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Utility\ArrayUtility;
18 use TYPO3\CMS\Core\Utility\GeneralUtility;
19
20 /**
21 * Locales.
22 *
23 * Used to define backend system languages
24 * When adding new keys, remember to:
25 * - Update 'setup' extension labels (sysext/setup/Resources/Private/Language/locallang.xlf)
26 * That's it!
27 */
28 class Locales implements \TYPO3\CMS\Core\SingletonInterface
29 {
30 /**
31 * Supported TYPO3 languages with locales
32 *
33 * @var array
34 */
35 protected $languages = [
36 'default' => 'English',
37 'af' => 'Afrikaans',
38 'ar' => 'Arabic',
39 'bs' => 'Bosnian',
40 'bg' => 'Bulgarian',
41 'ca' => 'Catalan',
42 'ch' => 'Chinese (Simpl.)',
43 'cs' => 'Czech',
44 'da' => 'Danish',
45 'de' => 'German',
46 'el' => 'Greek',
47 'eo' => 'Esperanto',
48 'es' => 'Spanish',
49 'et' => 'Estonian',
50 'eu' => 'Basque',
51 'fa' => 'Persian',
52 'fi' => 'Finnish',
53 'fo' => 'Faroese',
54 'fr' => 'French',
55 'fr_CA' => 'French (Canada)',
56 'gl' => 'Galician',
57 'he' => 'Hebrew',
58 'hi' => 'Hindi',
59 'hr' => 'Croatian',
60 'hu' => 'Hungarian',
61 'is' => 'Icelandic',
62 'it' => 'Italian',
63 'ja' => 'Japanese',
64 'ka' => 'Georgian',
65 'kl' => 'Greenlandic',
66 'km' => 'Khmer',
67 'ko' => 'Korean',
68 'lt' => 'Lithuanian',
69 'lv' => 'Latvian',
70 'ms' => 'Malay',
71 'nl' => 'Dutch',
72 'no' => 'Norwegian',
73 'pl' => 'Polish',
74 'pt' => 'Portuguese',
75 'pt_BR' => 'Brazilian Portuguese',
76 'ro' => 'Romanian',
77 'ru' => 'Russian',
78 'sk' => 'Slovak',
79 'sl' => 'Slovenian',
80 'sq' => 'Albanian',
81 'sr' => 'Serbian',
82 'sv' => 'Swedish',
83 'th' => 'Thai',
84 'tr' => 'Turkish',
85 'uk' => 'Ukrainian',
86 'vi' => 'Vietnamese',
87 'zh' => 'Chinese (Trad.)'
88 ];
89
90 /**
91 * Reversed mapping for backward compatibility codes
92 *
93 * @var array
94 */
95 protected $isoReverseMapping = [
96 'bs' => 'ba', // Bosnian
97 'cs' => 'cz', // Czech
98 'da' => 'dk', // Danish
99 'el' => 'gr', // Greek
100 'fr_CA' => 'qc', // French (Canada)
101 'gl' => 'ga', // Galician
102 'ja' => 'jp', // Japanese
103 'ka' => 'ge', // Georgian
104 'kl' => 'gl', // Greenlandic
105 'ko' => 'kr', // Korean
106 'ms' => 'my', // Malay
107 'pt_BR' => 'br', // Portuguese (Brazil)
108 'sl' => 'si', // Slovenian
109 'sv' => 'se', // Swedish
110 'uk' => 'ua', // Ukrainian
111 'vi' => 'vn', // Vietnamese
112 'zh' => 'hk', // Chinese (China)
113 'zh_CN' => 'ch', // Chinese (Simplified)
114 'zh_HK' => 'hk', // Chinese (Simplified Hong Kong)
115 'zh_Hans_CN' => 'ch' // Chinese (Simplified Han)
116 ];
117
118 /**
119 * Mapping for backward compatibility codes
120 *
121 * @var array
122 */
123 protected $isoMapping;
124
125 /**
126 * Dependencies for locales
127 *
128 * @var array
129 */
130 protected $localeDependencies;
131
132 /**
133 * Initializes the languages.
134 */
135 public static function initialize()
136 {
137 /** @var $instance Locales */
138 $instance = GeneralUtility::makeInstance(self::class);
139 $instance->isoMapping = array_flip($instance->isoReverseMapping);
140 // Allow user-defined locales
141 foreach ($GLOBALS['TYPO3_CONF_VARS']['SYS']['localization']['locales']['user'] ?? [] as $locale => $name) {
142 if (!isset($instance->languages[$locale])) {
143 $instance->languages[$locale] = $name;
144 }
145 }
146 // Initializes the locale dependencies with TYPO3 supported locales
147 $instance->localeDependencies = [];
148 foreach ($instance->languages as $locale => $name) {
149 if (strlen($locale) === 5) {
150 $instance->localeDependencies[$locale] = [substr($locale, 0, 2)];
151 }
152 }
153 // Merge user-provided locale dependencies
154 ArrayUtility::mergeRecursiveWithOverrule($instance->localeDependencies, $GLOBALS['TYPO3_CONF_VARS']['SYS']['localization']['locales']['dependencies'] ?? []);
155 }
156
157 /**
158 * Returns the locales.
159 *
160 * @return array
161 */
162 public function getLocales()
163 {
164 return array_keys($this->languages);
165 }
166
167 /**
168 * Returns the supported languages indexed by their corresponding locale.
169 *
170 * @return array
171 */
172 public function getLanguages()
173 {
174 return $this->languages;
175 }
176
177 /**
178 * Returns the mapping between TYPO3 (old) language codes and ISO codes.
179 *
180 * @return array
181 */
182 public function getIsoMapping()
183 {
184 return $this->isoMapping;
185 }
186
187 /**
188 * Returns the dependencies of a given locale, if any.
189 *
190 * @param string $locale
191 * @return array
192 */
193 public function getLocaleDependencies($locale)
194 {
195 $dependencies = [];
196 if (isset($this->localeDependencies[$locale])) {
197 $dependencies = $this->localeDependencies[$locale];
198 // Search for dependencies recursively
199 $localeDependencies = $dependencies;
200 foreach ($localeDependencies as $dependency) {
201 if (isset($this->localeDependencies[$dependency])) {
202 $dependencies = array_merge($dependencies, $this->getLocaleDependencies($dependency));
203 }
204 }
205 }
206 return $dependencies;
207 }
208
209 /**
210 * Converts the language codes that we get from the client (usually HTTP_ACCEPT_LANGUAGE)
211 * into a TYPO3-readable language code
212 *
213 * @param string $languageCodesList List of language codes. something like 'de,en-us;q=0.9,de-de;q=0.7,es-cl;q=0.6,en;q=0.4,es;q=0.3,zh;q=0.1'
214 * @return string A preferred language that TYPO3 supports, or "default" if none found
215 */
216 public function getPreferredClientLanguage($languageCodesList)
217 {
218 $allLanguageCodesFromLocales = ['en' => 'default'];
219 foreach ($this->isoReverseMapping as $isoLang => $typo3Lang) {
220 $isoLang = str_replace('_', '-', $isoLang);
221 $allLanguageCodesFromLocales[$isoLang] = $typo3Lang;
222 }
223 foreach ($this->getLocales() as $locale) {
224 $locale = str_replace('_', '-', $locale);
225 $allLanguageCodesFromLocales[$locale] = $locale;
226 }
227 $selectedLanguage = 'default';
228 $preferredLanguages = GeneralUtility::trimExplode(',', $languageCodesList);
229 // Order the preferred languages after they key
230 $sortedPreferredLanguages = [];
231 foreach ($preferredLanguages as $preferredLanguage) {
232 $quality = 1.0;
233 if (strpos($preferredLanguage, ';q=') !== false) {
234 list($preferredLanguage, $quality) = explode(';q=', $preferredLanguage);
235 }
236 $sortedPreferredLanguages[$preferredLanguage] = $quality;
237 }
238 // Loop through the languages, with the highest priority first
239 arsort($sortedPreferredLanguages, SORT_NUMERIC);
240 foreach ($sortedPreferredLanguages as $preferredLanguage => $quality) {
241 if (isset($allLanguageCodesFromLocales[$preferredLanguage])) {
242 $selectedLanguage = $allLanguageCodesFromLocales[$preferredLanguage];
243 break;
244 }
245 // Strip the country code from the end
246 list($preferredLanguage, ) = explode('-', $preferredLanguage);
247 if (isset($allLanguageCodesFromLocales[$preferredLanguage])) {
248 $selectedLanguage = $allLanguageCodesFromLocales[$preferredLanguage];
249 break;
250 }
251 }
252 if (!$selectedLanguage || $selectedLanguage === 'en') {
253 $selectedLanguage = 'default';
254 }
255 return $selectedLanguage;
256 }
257 }