summaryrefslogtreecommitdiff
path: root/includes/lib/l10n.php
blob: e325add9f115448943a0c459d7eabe7a803e8874 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
<?php /*
    LibreSSL - CAcert web application
    Copyright (C) 2004-2011  CAcert Inc.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; version 2 of the License.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

/**
 * This class provides some functions for language handling
 */
class L10n {
	/**
	 * These are tranlations we currently support.
	 *
	 * If another translation is added, it doesn't suffice to have gettext set
	 * up, you also need to add it here, because it acts as a white list.
	 *
	 * @var array("ISO-language code" => "native name of the language")
	 */
	public static $translations = array(
				"ar" => "&#1575;&#1604;&#1593;&#1585;&#1576;&#1610;&#1577;",
				"bg" => "&#1041;&#1098;&#1083;&#1075;&#1072;&#1088;&#1089;&#1082;&#1080;",
				"cs" => "&#268;e&scaron;tina",
				"da" => "Dansk",
				"de" => "Deutsch",
				"el" => "&Epsilon;&lambda;&lambda;&eta;&nu;&iota;&kappa;&#940;",
				"en" => "English",
				"es" => "Espa&#xf1;ol",
				"fi" => "Suomi",
				"fr" => "Fran&#xe7;ais",
				"hu" => "Magyar",
				"it" => "Italiano",
				"ja" => "&#26085;&#26412;&#35486;",
				"lv" => "Latvie&scaron;u",
				"nl" => "Nederlands",
				"pl" => "Polski",
				"pt" => "Portugu&#xea;s",
				"pt-br" => "Portugu&#xea;s Brasileiro",
				"ru" => "&#x420;&#x443;&#x441;&#x441;&#x43a;&#x438;&#x439;",
				"sv" => "Svenska",
				"tr" => "T&#xfc;rk&#xe7;e",
				"zh-cn" => "&#x4e2d;&#x6587;(&#x7b80;&#x4f53;)",
				"zh-tw" => "&#x4e2d;&#x6587;(&#33274;&#28771;)",
			);

	/**
	 * setlocale needs a language + region code for whatever reason so here's
	 * the mapping from a translation code to locales with the region that
	 * seemed the most common for this language
	 *
	 * You probably never need this. Use {@link set_translation()} to change the
	 * language instead of manually calling setlocale().
	 *
	 * @var array(string => string)
	 */
	private static $locales = array(
				"ar" => "ar_JO",
				"bg" => "bg_BG",
				"cs" => "cs_CZ",
				"da" => "da_DK",
				"de" => "de_DE",
				"el" => "el_GR",
				"en" => "en_US",
				"es" => "es_ES",
				"fa" => "fa_IR",
				"fi" => "fi_FI",
				"fr" => "fr_FR",
				"he" => "he_IL",
				"hr" => "hr_HR",
				"hu" => "hu_HU",
				"id" => "id_ID",
				"is" => "is_IS",
				"it" => "it_IT",
				"ja" => "ja_JP",
				"ka" => "ka_GE",
				"ko" => "ko_KR",
				"lv" => "lv_LV",
				"nb" => "nb_NO",
				"nl" => "nl_NL",
				"pl" => "pl_PL",
				"pt" => "pt_PT",
				"pt-br" => "pt_BR",
				"ro" => "ro_RO",
				"ru" => "ru_RU",
				"sl" => "sl_SI",
				"sv" => "sv_SE",
				"th" => "th_TH",
				"tr" => "tr_TR",
				"uk" => "uk_UA",
				"zh-cn" => "zh_CN",
				"zh-tw" => "zh_TW",
			);

	/**
	 * Auto-detects the language that should be used and sets it. Only works for
	 * HTTP, not in a command line script.
	 *
	 * Priority:
	 * <ol>
	 * 	<li>explicit parameter "lang" passed in HTTP (e.g. via GET)</li>
	 * 	<li>existing setting in the session (stick to the setting we had before)
	 * 		</li>
	 * 	<li>auto-detect via the HTTP Accept-Language header sent by the user
	 * 		agent</li>
	 * </ol>
	 */
	public static function detect_language() {
		if (    (self::get_translation() != "")
		            // already set in the session?
		    &&
		        !(array_key_exists("lang", $_REQUEST) &&
		            trim($_REQUEST["lang"]) != "")
		            // explicit parameter?
		    )
		{
			if ( self::set_translation(self::get_translation()) ) {
				return;
			}
		}


		$languages = array();

		// parse Accept-Language header
		if (array_key_exists('HTTP_ACCEPT_LANGUAGE', $_SERVER)) {
			$bits = explode(",", strtolower(
						str_replace(" ", "", $_SERVER['HTTP_ACCEPT_LANGUAGE'])
					));
			foreach($bits as $lang)
			{
				$b = explode(";", $lang);
				if(count($b)>1 && substr($b[1], 0, 2) == "q=")
					$c = floatval(substr($b[1], 2));
				else
					$c = 1;

				if ($c != 0)
				{
					$languages[trim($b[0])] = $c;
				}
			}
		}

		// check if there is an explicit language given as parameter
		if(array_key_exists("lang",$_REQUEST) && trim($_REQUEST["lang"]) != "")
		{
			// higher priority than those values in the header
			$languages[strtolower(trim($_REQUEST["lang"]))] = 2.0;
		}

		arsort($languages, SORT_NUMERIC);

		// this is used to be compatible with browsers like internet
		// explorer which only provide the language code including the
		// region not without. Also handles the fallback to English (qvalues
		// may only have three digits after the .)
		$fallbacks = array("en" => 0.0005);

		foreach($languages as $lang => $qvalue)
		{
			// ignore any non-conforming values (that's why we don't need to
			// mysql_real_escape() or escapeshellarg(), but take care of
			// the '*')
			// spec: ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )
			if ( preg_match('/^(?:([a-zA-Z]{1,8})(?:-[a-zA-Z]{1,8})*|\*)$/',
			                   $lang, $matches) !== 1 ) {
				continue;
			}
			$lang_prefix = $matches[1]; // usually two-letter language code
			$fallbacks[$lang_prefix] = $qvalue;

			$chosen_translation = "";
			if ($lang === '*') {
				// According to the standard '*' matches anything but any
				// language explicitly specified. So in theory if there
				// was an explicit mention of "en" with a lower priority
				// this would be incorrect, but that's too much trouble.
				$chosen_translation = "en";
			} else {
				$lang_length = strlen($lang);
				foreach (self::$translations as $translation => $ignore)
				{
					// May match exactly or on every '-'
					if ( $translation === $lang ||
					         substr($translation, 0, $lang_length + 1)
					             === $lang.'-'
					    )
					{
						$chosen_translation = $translation;
						break;
					}
				}
			}

			if ($chosen_translation !== "")
			{
				if (self::set_translation($chosen_translation)) {
					return;
				}
			}
		}

		// No translation found yet => try the prefixes
		arsort($fallbacks, SORT_NUMERIC);
		foreach ($fallbacks as $lang => $qvalue) {
			if (self::set_translation($lang)) {
				return;
			}
		}

		// should not get here, as the fallback of "en" is provided and that
		// should always work => log an error
		trigger_error("L10n::detect_language(): could not set language",
		        E_USER_WARNING);
	}

	/**
	 * Normalise the translation code (e.g. from the old codes to the new)
	 *
	 * @return string
	 * 		a translation code or the empty string if it can't be normalised
	 */
	public static function normalise_translation($translation_code) {
		// check $translation_code against whitelist
		if (array_key_exists($translation_code, self::$translations) ) {
			return $translation_code;
		}

		// maybe it's a locale as previously used in the system? e.g. en_AU
		if (preg_match('/^([a-z][a-z])_([A-Z][A-Z])$/', $translation_code, $matches) !== 1) {
			return '';
		}

		$lang_code = $matches[1];
		$region_code = strtolower($matches[2]);

		if (array_key_exists("${lang_code}-${region_code}", self::$translations)) {
			return "${lang_code}-${region_code}";
		}

		if (array_key_exists($lang_code, self::$translations)) {
			return $lang_code;
		}

		return '';
	}

	/**
	 * Get the set translation
	 *
	 * @return string
	 * 		a translation code or the empty string if not set
	 */
	public static function get_translation() {
		if (array_key_exists('language', $_SESSION['_config'])) {
			return $_SESSION['_config']['language'];
		} else {
			return "";
		}
	}

	/**
	 * Set the translation to use.
	 *
	 * @param string $translation_code
	 * 		the translation code as specified in the keys of {@link $translations}
	 *
	 * @return bool
	 * 		<ul>
	 * 		<li>true if the translation has been set successfully</li>
	 * 		<li>false if the $translation_code was not contained in the white
	 * 			list or could not be set for other reasons (e.g. setlocale()
	 * 			failed because the locale has not been set up on the system -
	 * 			details will be logged)</li>
	 * 		</ul>
	 */
	public static function set_translation($translation_code) {
		$translation_code = self::normalise_translation($translation_code);
		if (empty($translation_code)) {
			return false;
		}

		// map translation to locale
		if ( !array_key_exists($translation_code, self::$locales) ) {
			// weird. maybe you added a translation but haven't added a
			// translation to locale mapping in self::locales?
			trigger_error("L10n::set_translation(): could not map the ".
				"translation $translation_code to a locale", E_USER_WARNING);
			return false;
		}
		$locale = self::$locales[$translation_code];

		// set up locale
		if ( !putenv("LANG=$locale") ) {
			trigger_error("L10n::set_translation(): could not set the ".
				"environment variable LANG to $locale", E_USER_WARNING);
			return false;
		}
		if ( !setlocale(LC_ALL, $locale) ) {
			trigger_error("L10n::set_translation(): could not setlocale() ".
				"LC_ALL to $locale", E_USER_WARNING);
			return false;
		}


		// only set if we're running in a server not in a script
		if (isset($_SESSION)) {
			// save the setting
			$_SESSION['_config']['language'] = $translation_code;


			// Set up the recode settings needed e.g. in PDF creation
			$_SESSION['_config']['recode'] = "html..latin-1";

			if($translation_code === "zh-cn" || $translation_code === "zh-tw")
			{
				$_SESSION['_config']['recode'] = "html..gb2312";

			} else if($translation_code === "pl" || $translation_code === "hu") {
				$_SESSION['_config']['recode'] = "html..ISO-8859-2";

			} else if($translation_code === "ja") {
				$_SESSION['_config']['recode'] = "html..SHIFT-JIS";

			} else if($translation_code === "ru") {
				$_SESSION['_config']['recode'] = "html..ISO-8859-5";

			} else if($translation_code == "lt") { // legacy, keep for reference
				$_SESSION['_config']['recode'] = "html..ISO-8859-13";

			}
		}

		return true;
	}

	/**
	 * Sets up the text domain used by gettext
	 *
	 * @param string $domain
	 * 		the gettext domain that should be used, defaults to "messages"
	 */
	public static function init_gettext($domain = 'messages') {
		bindtextdomain($domain, $_SESSION['_config']['filepath'].'/locale');
		textdomain($domain);
	}
}