update @since tags
[squirrelmail.git] / functions / i18n.php
CommitLineData
59177427 1<?php
4b4abf93 2
35586184 3/**
d3bab52e 4 * SquirrelMail internationalization functions
35586184 5 *
35586184 6 * This file contains variuos functions that are needed to do
7 * internationalization of SquirrelMail.
8 *
9 * Internally the output character set is used. Other characters are
10 * encoded using Unicode entities according to HTML 4.0.
11 *
4b4abf93 12 * @copyright &copy; 1999-2005 The SquirrelMail Project Team
13 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
a8a1c36d 14 * @version $Id$
d6c32258 15 * @package squirrelmail
a8a1c36d 16 * @subpackage i18n
35586184 17 */
18
c6cd3136 19/** @ignore */
20if (! defined('SM_PATH')) define('SM_PATH','../');
21
d6c32258 22/** Everything uses global.php... */
961ca3d8 23require_once(SM_PATH . 'functions/global.php');
24
3b84e1b1 25/**
26 * Gettext bindtextdomain wrapper.
27 *
28 * Wrapper solves differences between php versions in order to provide
29 * ngettext support. Should be used if translation uses ngettext
30 * functions.
81be3f39 31 * @since 1.5.1
3b84e1b1 32 * @param string $domain gettext domain name
33 * @param string $dir directory that contains all translations
34 * @return string path to translation directory
35 */
36function sq_bindtextdomain($domain,$dir) {
37 global $l10n, $gettext_flags, $sm_notAlias;
38
39 if ($gettext_flags==7) {
40 // gettext extension without ngettext
41 if (substr($dir, -1) != '/') $dir .= '/';
42 $mofile=$dir . $sm_notAlias . '/LC_MESSAGES/' . $domain . '.mo';
43 $input = new FileReader($mofile);
44 $l10n[$domain] = new gettext_reader($input);
45 }
46
47 $dir=bindtextdomain($domain,$dir);
48
49 return $dir;
50}
51
52/**
53 * Gettext textdomain wrapper.
54 * Makes sure that gettext_domain global is modified.
81be3f39 55 * @since 1.5.1
3b84e1b1 56 * @param string $name gettext domain name
57 * @return string gettext domain name
58 */
59function sq_textdomain($domain) {
60 global $gettext_domain;
61 $gettext_domain=textdomain($domain);
62 return $gettext_domain;
63}
64
1989cc04 65/**
66 * php setlocale function wrapper
67 *
68 * From php 4.3.0 it is possible to use arrays in order to set locale.
69 * php gettext extension works only when locale is set. This wrapper
70 * function allows to use more than one locale name.
71 *
598294a7 72 * @param int $category locale category name. Use php named constants
73 * (LC_ALL, LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME)
1989cc04 74 * @param mixed $locale option contains array with possible locales or string with one locale
75 * @return string name of set locale or false, if all locales fail.
480feeac 76 * @since 1.5.1 and 1.4.5
1989cc04 77 * @see http://www.php.net/setlocale
78 */
79function sq_setlocale($category,$locale) {
80 // string with only one locale
81 if (is_string($locale))
82 return setlocale($category,$locale);
83
84 if (! check_php_version(4,3)) {
85 $ret=false;
86 $index=0;
87 while ( ! $ret && $index<count($locale)) {
88 $ret=setlocale($category,$locale[$index]);
89 $index++;
90 }
91 } else {
92 // php 4.3.0 or better, use entire array
93 $ret=setlocale($category,$locale);
94 }
95 return $ret;
96}
97
d6c32258 98/**
51468260 99 * Converts string from given charset to charset, that can be displayed by user translation.
100 *
101 * Function by default returns html encoded strings, if translation uses different encoding.
102 * If Japanese translation is used - function returns string converted to euc-jp
103 * If iconv or recode functions are enabled and translation uses utf-8 - function returns utf-8 encoded string.
104 * If $charset is not supported - function returns unconverted string.
62f7daa5 105 *
51468260 106 * sanitizing of html tags is also done by this function.
107 *
d6c32258 108 * @param string $charset
109 * @param string $string Text to be decoded
f8a1ed5a 110 * @param boolean $force_decode converts string to html without $charset!=$default_charset check.
480feeac 111 * Argument is available since 1.5.1 and 1.4.5.
b6c52e61 112 * @param boolean $save_html disables htmlspecialchars() in order to preserve
113 * html formating. Use with care. Available since 1.5.1
51468260 114 * @return string decoded string
d6c32258 115 */
b6c52e61 116function charset_decode ($charset, $string, $force_decode=false, $save_html=false) {
3ec81e63 117 global $languages, $squirrelmail_language, $default_charset;
f03f6ee7 118 global $use_php_recode, $use_php_iconv, $aggressive_decoding;
a2a7852b 119
3714db45 120 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
1bb86586 121 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode')) {
122 $string = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode', $string);
6fbd125b 123 }
b05c8961 124
3ec81e63 125 $charset = strtolower($charset);
126
127 set_my_charset();
128
129 // Variables that allow to use functions without function_exist() calls
edf2c0ba 130 if (! isset($use_php_recode) || $use_php_recode=="" ) {
3b84e1b1 131 $use_php_recode=false; }
edf2c0ba 132 if (! isset($use_php_iconv) || $use_php_iconv=="" ) {
3b84e1b1 133 $use_php_iconv=false; }
3ec81e63 134
135 // Don't do conversion if charset is the same.
5341ce66 136 if ( ! $force_decode && $charset == strtolower($default_charset) )
4a46b538 137 return ($save_html ? $string : htmlspecialchars($string));
3ec81e63 138
139 // catch iso-8859-8-i thing
140 if ( $charset == "iso-8859-8-i" )
3b84e1b1 141 $charset = "iso-8859-8";
3ec81e63 142
143 /*
62f7daa5 144 * Recode converts html special characters automatically if you use
145 * 'charset..html' decoding. There is no documented way to put -d option
3ec81e63 146 * into php recode function call.
147 */
148 if ( $use_php_recode ) {
3b84e1b1 149 if ( $default_charset == "utf-8" ) {
150 // other charsets can be converted to utf-8 without loss.
151 // and output string is smaller
152 $string = recode_string($charset . "..utf-8",$string);
4a46b538 153 return ($save_html ? $string : htmlspecialchars($string));
3b84e1b1 154 } else {
155 $string = recode_string($charset . "..html",$string);
156 // recode does not convert single quote, htmlspecialchars does.
157 $string = str_replace("'", '&#039;', $string);
b6c52e61 158 // undo html specialchars
159 if ($save_html)
160 $string=str_replace(array('&amp;','&quot;','&lt;','&gt;'),
161 array('&','"','<','>'),$string);
3b84e1b1 162 return $string;
163 }
3ec81e63 164 }
165
166 // iconv functions does not have html target and can be used only with utf-8
167 if ( $use_php_iconv && $default_charset=='utf-8') {
3b84e1b1 168 $string = iconv($charset,$default_charset,$string);
4a46b538 169 return ($save_html ? $string : htmlspecialchars($string));
3ec81e63 170 }
171
172 // If we don't use recode and iconv, we'll do it old way.
173
a2a7852b 174 /* All HTML special characters are 7 bit and can be replaced first */
b6c52e61 175 if (! $save_html) $string = htmlspecialchars ($string);
a2a7852b 176
5dd23dac 177 /* controls cpu and memory intensive decoding cycles */
f03f6ee7 178 if (! isset($aggressive_decoding) || $aggressive_decoding=="" ) {
3b84e1b1 179 $aggressive_decoding=false; }
5dd23dac 180
b142de74 181 $decode=fixcharset($charset);
182 $decodefile=SM_PATH . 'functions/decode/' . $decode . '.php';
183 if (file_exists($decodefile)) {
3b84e1b1 184 include_once($decodefile);
b6c52e61 185 // send $save_html argument to decoding function. needed for iso-2022-xx decoding.
186 $ret = call_user_func('charset_decode_'.$decode, $string, $save_html);
a2a7852b 187 } else {
3b84e1b1 188 $ret = $string;
a2a7852b 189 }
190 return( $ret );
191}
03db90bc 192
d3bab52e 193/**
194 * Converts html string to given charset
480feeac 195 * @since 1.5.1 and 1.4.4
d3bab52e 196 * @param string $string
197 * @param string $charset
78be8403 198 * @param boolean $htmlencode keep htmlspecialchars encoding
62f7daa5 199 * @param string
d3bab52e 200 */
78be8403 201function charset_encode($string,$charset,$htmlencode=true) {
3b84e1b1 202 global $default_charset;
203
3b84e1b1 204 $encode=fixcharset($charset);
205 $encodefile=SM_PATH . 'functions/encode/' . $encode . '.php';
206 if (file_exists($encodefile)) {
207 include_once($encodefile);
208 $ret = call_user_func('charset_encode_'.$encode, $string);
9280dd9d 209 } elseif(file_exists(SM_PATH . 'functions/encode/us_ascii.php')) {
210 // function replaces all 8bit html entities with question marks.
211 // it is used when other encoding functions are unavailable
3b84e1b1 212 include_once(SM_PATH . 'functions/encode/us_ascii.php');
213 $ret = charset_encode_us_ascii($string);
9280dd9d 214 } else {
215 /**
216 * fix for yahoo users that remove all us-ascii related things
217 */
218 $ret = $string;
3b84e1b1 219 }
039fee57 220
221 /**
222 * Undo html special chars, some places (like compose form) have
223 * own sanitizing functions and don't need html symbols.
224 * Undo chars only after encoding in order to prevent conversion of
225 * html entities in plain text emails.
226 */
227 if (! $htmlencode ) {
228 $ret = str_replace(array('&amp;','&gt;','&lt;','&quot;'),array('&','>','<','"'),$ret);
229 }
3b84e1b1 230 return( $ret );
d3bab52e 231}
232
233/**
234 * Combined decoding and encoding functions
235 *
236 * If conversion is done to charset different that utf-8, unsupported symbols
237 * will be replaced with question marks.
480feeac 238 * @since 1.5.1 and 1.4.4
d3bab52e 239 * @param string $in_charset initial charset
240 * @param string $string string that has to be converted
241 * @param string $out_charset final charset
78be8403 242 * @param boolean $htmlencode keep htmlspecialchars encoding
d3bab52e 243 * @return string converted string
244 */
78be8403 245function charset_convert($in_charset,$string,$out_charset,$htmlencode=true) {
5341ce66 246 $string=charset_decode($in_charset,$string,true);
33991968 247 $string=charset_encode($string,$out_charset,$htmlencode);
248 return $string;
d3bab52e 249}
250
b142de74 251/**
252 * Makes charset name suitable for decoding cycles
253 *
480feeac 254 * @since 1.5.0 and 1.4.4
b142de74 255 * @param string $charset Name of charset
256 * @return string $charset Adjusted name of charset
257 */
258function fixcharset($charset) {
91e0dccc 259 /* remove minus and characters that might be used in paths from charset
dbebf058 260 * name in order to be able to use it in function names and include calls.
261 */
262 $charset=preg_replace("/[-:.\/\\\]/",'_',$charset);
62f7daa5 263
b142de74 264 // windows-125x and cp125x charsets
265 $charset=str_replace('windows_','cp',$charset);
a2a7852b 266
b142de74 267 // ibm > cp
268 $charset=str_replace('ibm','cp',$charset);
269
270 // iso-8859-8-i -> iso-8859-8
271 // use same cycle until I'll find differences
272 $charset=str_replace('iso_8859_8_i','iso_8859_8',$charset);
273
274 return $charset;
275}
a2a7852b 276
51468260 277/**
a2a7852b 278 * Set up the language to be output
279 * if $do_search is true, then scan the browser information
280 * for a possible language that we know
51468260 281 *
62f7daa5 282 * Function sets system locale environment (LC_ALL, LANG, LANGUAGE),
51468260 283 * gettext translation bindings and html header information.
284 *
5679405c 285 * Function returns error codes, if there is some fatal error.
62f7daa5 286 * 0 = no error,
287 * 1 = mbstring support is not present,
51468260 288 * 2 = mbstring support is not present, user's translation reverted to en_US.
289 *
290 * @param string $sm_language translation used by user's interface
291 * @param bool $do_search use browser's preferred language detection functions. Defaults to false.
292 * @param bool $default set $sm_language to $squirrelmail_default_language if language detection fails or language is not set. Defaults to false.
62f7daa5 293 * @return int function execution error codes.
a2a7852b 294 */
67a8c90a 295function set_up_language($sm_language, $do_search = false, $default = false) {
a2a7852b 296
297 static $SetupAlready = 0;
9eb0fbd4 298 global $use_gettext, $languages,
fe48c808 299 $squirrelmail_language, $squirrelmail_default_language, $default_charset,
51468260 300 $sm_notAlias, $username, $data_dir;
a2a7852b 301
302 if ($SetupAlready) {
303 return;
304 }
a65846a7 305
5c920668 306 $SetupAlready = TRUE;
961ca3d8 307 sqgetGlobalVar('HTTP_ACCEPT_LANGUAGE', $accept_lang, SQ_SERVER);
a2a7852b 308
0d7a48b0 309 /**
310 * If function is asked to detect preferred language
311 * OR squirrelmail default language is set to empty string
312 * AND
f8a1ed5a 313 * squirrelmail language ($sm_language) is empty string
0d7a48b0 314 * (not set in user's prefs and no cookie with language info)
315 * AND
316 * browser provides list of preferred languages
317 * THEN
318 * get preferred language from HTTP_ACCEPT_LANGUAGE header
319 */
f8a1ed5a 320 if (($do_search || empty($squirrelmail_default_language)) &&
321 ! $sm_language &&
0d7a48b0 322 isset($accept_lang)) {
323 // TODO: use more than one language, if first language is not available
324 // FIXME: function assumes that string contains two or more characters.
325 // FIXME: some languages use 5 chars
961ca3d8 326 $sm_language = substr($accept_lang, 0, 2);
a2a7852b 327 }
62f7daa5 328
0d7a48b0 329 /**
330 * If language preference is not set OR script asks to use default language
331 * AND
332 * default squirrelmail language is not set to empty string
333 * THEN
334 * use default squirrelmail language value from configuration.
335 */
f8a1ed5a 336 if ((!$sm_language||$default) &&
0d7a48b0 337 ! empty($squirrelmail_default_language)) {
a2a7852b 338 $squirrelmail_language = $squirrelmail_default_language;
66d7950f 339 $sm_language = $squirrelmail_default_language;
a2a7852b 340 }
7be4d717 341
342 /** provide failsafe language when detection fails */
343 if (! $sm_language) $sm_language='en_US';
344
a2a7852b 345 $sm_notAlias = $sm_language;
62f7daa5 346
3ec81e63 347 // Catching removed translation
348 // System reverts to English translation if user prefs contain translation
2ba706ef 349 // that is not available in $languages array
3ec81e63 350 if (!isset($languages[$sm_notAlias])) {
3b84e1b1 351 $sm_notAlias="en_US";
3ec81e63 352 }
353
a2a7852b 354 while (isset($languages[$sm_notAlias]['ALIAS'])) {
355 $sm_notAlias = $languages[$sm_notAlias]['ALIAS'];
356 }
357
88cb1b4d 358 if ( isset($sm_language) &&
5c920668 359 $use_gettext &&
360 $sm_language != '' &&
361 isset($languages[$sm_notAlias]['CHARSET']) ) {
3b84e1b1 362 sq_bindtextdomain( 'squirrelmail', SM_PATH . 'locale/' );
363 sq_textdomain( 'squirrelmail' );
1989cc04 364
365 // set codeset in order to avoid gettext charset conversions
03db90bc 366 if (function_exists('bind_textdomain_codeset')) {
1989cc04 367 // Japanese translation uses different internal charset
3b84e1b1 368 if ($sm_notAlias == 'ja_JP') {
598294a7 369 bind_textdomain_codeset ('squirrelmail', 'EUC-JP');
a5970d71 370 } else {
598294a7 371 bind_textdomain_codeset ('squirrelmail', $languages[$sm_notAlias]['CHARSET'] );
03db90bc 372 }
373 }
1989cc04 374
375 // Use LOCALE key, if it is set.
03db90bc 376 if (isset($languages[$sm_notAlias]['LOCALE'])){
3b84e1b1 377 $longlocale=$languages[$sm_notAlias]['LOCALE'];
03db90bc 378 } else {
3b84e1b1 379 $longlocale=$sm_notAlias;
03db90bc 380 }
1989cc04 381
382 // try setting locale
383 $retlocale=sq_setlocale(LC_ALL, $longlocale);
384
385 // check if locale is set and assign that locale to $longlocale
386 // in order to use it in putenv calls.
387 if (! is_bool($retlocale)) {
388 $longlocale=$retlocale;
389 } elseif (is_array($longlocale)) {
390 // setting of all locales failed.
391 // we need string instead of array used in LOCALE key.
392 $longlocale=$sm_notAlias;
393 }
394
5a4689fb 395 if ( !((bool)ini_get('safe_mode')) &&
f2374580 396 getenv( 'LC_ALL' ) != $longlocale ) {
397 putenv( "LC_ALL=$longlocale" );
398 putenv( "LANG=$longlocale" );
399 putenv( "LANGUAGE=$longlocale" );
54b168cf 400 putenv( "LC_NUMERIC=C" );
475df436 401 if ($sm_notAlias=='tr_TR') putenv( "LC_CTYPE=C" );
a2a7852b 402 }
54b168cf 403 // Workaround for plugins that use numbers with floating point
91e0dccc 404 // It might be removed if plugins use correct decimal delimiters
405 // according to locale settings.
54b168cf 406 setlocale(LC_NUMERIC, 'C');
407 // Workaround for specific Turkish strtolower/strtoupper rules.
408 // Many functions expect English conversion rules.
475df436 409 if ($sm_notAlias=='tr_TR') setlocale(LC_CTYPE,'C');
03db90bc 410
411 // Set text direction/alignment variables
8d8da447 412 // These don't appear to be used... are they safe to remove?
62f7daa5 413 if (isset($languages[$sm_notAlias]['DIR']) &&
03db90bc 414 $languages[$sm_notAlias]['DIR'] == 'rtl') {
3b84e1b1 415 /**
416 * Text direction
417 * @global string $text_direction
418 */
419 $text_direction='rtl';
420 /**
421 * Left alignment
422 * @global string $left_align
423 */
424 $left_align='right';
425 /**
426 * Right alignment
427 * @global string $right_align
428 */
429 $right_align='left';
03db90bc 430 } else {
3b84e1b1 431 $text_direction='ltr';
432 $left_align='left';
433 $right_align='right';
03db90bc 434 }
435
436 $squirrelmail_language = $sm_notAlias;
a5970d71 437 if ($squirrelmail_language == 'ja_JP') {
b05c8961 438 header ('Content-Type: text/html; charset=EUC-JP');
439 if (!function_exists('mb_internal_encoding')) {
3b84e1b1 440 // Error messages can't be displayed here
441 $error = 1;
442 // Revert to English if possible.
443 if (function_exists('setPref') && $username!='' && $data_dir!="") {
444 setPref($data_dir, $username, 'language', "en_US");
445 $error = 2;
446 }
447 // stop further execution in order not to get php errors on mb_internal_encoding().
448 return $error;
e842b215 449 }
450 if (function_exists('mb_language')) {
451 mb_language('Japanese');
b05c8961 452 }
453 mb_internal_encoding('EUC-JP');
454 mb_http_output('pass');
fe48c808 455 } elseif ($squirrelmail_language == 'en_US') {
456 header( 'Content-Type: text/html; charset=' . $default_charset );
b05c8961 457 } else {
fe48c808 458 header( 'Content-Type: text/html; charset=' . $languages[$sm_notAlias]['CHARSET'] );
459 }
f5c507dc 460 /**
461 * mbstring.func_overload fix (#929644).
462 *
f8a1ed5a 463 * php mbstring extension can replace standard string functions with their multibyte
4c12c858 464 * equivalents. See http://www.php.net/ref.mbstring#mbstring.overload. This feature
465 * was added in php v.4.2.0
f5c507dc 466 *
467 * Some SquirrelMail functions work with 8bit strings in bytes. If interface is forced
468 * to use mbstring functions and mbstring internal encoding is set to multibyte charset,
f8a1ed5a 469 * interface can't trust regular string functions. Due to mbstring overloading design
f5c507dc 470 * limits php scripts can't control this setting.
471 *
472 * This hack should fix some issues related to 8bit strings in passwords. Correct fix is
473 * to disable mbstring overloading. Japanese translation uses different internal encoding.
474 */
f8a1ed5a 475 if ($squirrelmail_language != 'ja_JP' &&
f5c507dc 476 function_exists('mb_internal_encoding') &&
477 check_php_version(4,2,0) &&
478 (int)ini_get('mbstring.func_overload')!=0) {
fa4cfb07 479 mb_internal_encoding('pass');
f5c507dc 480 }
a2a7852b 481 }
51468260 482 return 0;
b05c8961 483}
a2a7852b 484
51468260 485/**
486 * Sets default_charset variable according to the one that is used by user's translations.
487 *
488 * Function changes global $default_charset variable in order to be sure, that it
0d7a48b0 489 * contains charset used by user's translation. Sanity of $squirrelmail_language
490 * and $default_charset combination is also tested.
51468260 491 *
492 * There can be a $default_charset setting in the
493 * config.php file, but the user may have a different language
494 * selected for a user interface. This function checks the
495 * language selected by the user and tags the outgoing messages
496 * with the appropriate charset corresponding to the language
497 * selection. This is "more right" (tm), than just stamping the
498 * message blindly with the system-wide $default_charset.
499 */
a2a7852b 500function set_my_charset(){
0d7a48b0 501 global $data_dir, $username, $default_charset, $languages, $squirrelmail_language;
88cb1b4d 502
a2a7852b 503 $my_language = getPref($data_dir, $username, 'language');
5c920668 504 if (!$my_language) {
0d7a48b0 505 $my_language = $squirrelmail_language ;
5c920668 506 }
3ec81e63 507 // Catch removed translation
508 if (!isset($languages[$my_language])) {
3b84e1b1 509 $my_language="en_US";
3ec81e63 510 }
a2a7852b 511 while (isset($languages[$my_language]['ALIAS'])) {
f7e8861e 512 $my_language = $languages[$my_language]['ALIAS'];
a2a7852b 513 }
5c920668 514 $my_charset = $languages[$my_language]['CHARSET'];
fe48c808 515 if ($my_language!='en_US') {
a2a7852b 516 $default_charset = $my_charset;
517 }
518}
519
e0e1b169 520/**
521 * Replaces non-braking spaces inserted by some browsers with regular space
522 *
523 * This function can be used to replace non-braking space symbols
524 * that are inserted in forms by some browsers instead of normal
525 * space symbol.
526 *
527 * @param string $string Text that needs to be cleaned
528 * @param string $charset Charset used in text
529 * @return string Cleaned text
530 */
531function cleanup_nbsp($string,$charset) {
a8fa8e33 532
e0e1b169 533 // reduce number of case statements
534 if (stristr('iso-8859-',substr($charset,0,9))){
535 $output_charset="iso-8859-x";
536 }
537 if (stristr('windows-125',substr($charset,0,11))){
538 $output_charset="cp125x";
539 }
540 if (stristr('koi8',substr($charset,0,4))){
541 $output_charset="koi8-x";
542 }
543 if (! isset($output_charset)){
544 $output_charset=strtolower($charset);
545 }
a8fa8e33 546
e0e1b169 547// where is non-braking space symbol
548switch($output_charset):
549 case "iso-8859-x":
550 case "cp125x":
551 case "iso-2022-jp":
552 $nbsp="\xA0";
553 break;
554 case "koi8-x":
555 $nbsp="\x9A";
556 break;
557 case "utf-8":
558 $nbsp="\xC2\xA0";
559 break;
560 default:
561 // don't change string if charset is unmatched
562 return $string;
563endswitch;
a8fa8e33 564
e0e1b169 565// return space instead of non-braking space.
566 return str_replace($nbsp,' ',$string);
567}
a8fa8e33 568
e0e1b169 569/**
570 * Function informs if it is safe to convert given charset to the one that is used by user.
571 *
572 * It is safe to use conversion only if user uses utf-8 encoding and when
573 * converted charset is similar to the one that is used by user.
574 *
575 * @param string $input_charset Charset of text that needs to be converted
576 * @return bool is it possible to convert to user's charset
577 */
578function is_conversion_safe($input_charset) {
579 global $languages, $sm_notAlias, $default_charset, $lossy_encoding;
a8fa8e33 580
e0e1b169 581 if (isset($lossy_encoding) && $lossy_encoding )
91e0dccc 582 return true;
a8fa8e33 583
e0e1b169 584 // convert to lower case
585 $input_charset = strtolower($input_charset);
a8fa8e33 586
e0e1b169 587 // Is user's locale Unicode based ?
588 if ( $default_charset == "utf-8" ) {
589 return true;
590 }
a8fa8e33 591
e0e1b169 592 // Charsets that are similar
593switch ($default_charset):
594case "windows-1251":
595 if ( $input_charset == "iso-8859-5" ||
596 $input_charset == "koi8-r" ||
597 $input_charset == "koi8-u" ) {
598 return true;
599 } else {
600 return false;
601 }
602case "windows-1257":
603 if ( $input_charset == "iso-8859-13" ||
604 $input_charset == "iso-8859-4" ) {
605 return true;
606 } else {
607 return false;
608 }
609case "iso-8859-4":
610 if ( $input_charset == "iso-8859-13" ||
611 $input_charset == "windows-1257" ) {
612 return true;
613 } else {
614 return false;
615 }
616case "iso-8859-5":
617 if ( $input_charset == "windows-1251" ||
618 $input_charset == "koi8-r" ||
619 $input_charset == "koi8-u" ) {
620 return true;
621 } else {
622 return false;
623 }
624case "iso-8859-13":
625 if ( $input_charset == "iso-8859-4" ||
626 $input_charset == "windows-1257" ) {
627 return true;
628 } else {
629 return false;
630 }
631case "koi8-r":
632 if ( $input_charset == "windows-1251" ||
633 $input_charset == "iso-8859-5" ||
634 $input_charset == "koi8-u" ) {
635 return true;
636 } else {
637 return false;
638 }
639case "koi8-u":
640 if ( $input_charset == "windows-1251" ||
641 $input_charset == "iso-8859-5" ||
642 $input_charset == "koi8-r" ) {
643 return true;
644 } else {
645 return false;
646 }
647default:
648 return false;
649endswitch;
650}
551a09c7 651
a8fa8e33 652
e0e1b169 653/* ------------------------------ main --------------------------- */
a8fa8e33 654
e0e1b169 655global $squirrelmail_language, $languages, $use_gettext;
060c9483 656
0d7a48b0 657if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE)) {
e0e1b169 658 $squirrelmail_language = '';
659}
c30be3cf 660
e0e1b169 661/**
662 * Array specifies the available translations.
663 *
664 * Structure of array:
665 * $languages['language']['variable'] = 'value'
666 *
667 * Possible 'variable' names:
668 * NAME - Translation name in English
669 * CHARSET - Encoding used by translation
670 * ALIAS - used when 'language' is only short name and 'value' should provide long language name
671 * ALTNAME - Native translation name. Any 8bit symbols must be html encoded.
c6cd3136 672 * LOCALE - Full locale name (in xx_XX.charset format). It can use array with more than one locale name since 1.4.5 and 1.5.1
e0e1b169 673 * DIR - Text direction. Used to define Right-to-Left languages. Possible values 'rtl' or 'ltr'. If undefined - defaults to 'ltr'
674 * XTRA_CODE - translation uses special functions. See doc/i18n.txt
675 *
676 * Each 'language' definition requires NAME+CHARSET or ALIAS variables.
677 *
678 * @name $languages
679 * @global array $languages
680 */
e0e1b169 681$languages['en_US']['NAME'] = 'English';
682$languages['en_US']['CHARSET'] = 'iso-8859-1';
683$languages['en_US']['LOCALE'] = 'en_US.ISO8859-1';
684$languages['en']['ALIAS'] = 'en_US';
a2a7852b 685
89b3545c 686/**
687 * Automatic translation loading from setup.php files.
688 * Solution for bug. 1240889.
689 * setup.php file can contain $languages array entries and XTRA_CODE functions.
89b3545c 690 */
6c8a387f 691if (is_dir(SM_PATH . 'locale') &&
692 is_readable(SM_PATH . 'locale')) {
693 $localedir = dir(SM_PATH . 'locale');
694 while($lang_dir=$localedir->read()) {
695 // remove trailing slash, if present
696 if (substr($lang_dir,-1)=='/') {
697 $lang_dir = substr($lang_dir,0,-1);
698 }
699 if ($lang_dir != '..' && $lang_dir != '.' && $lang_dir != 'CVS' &&
700 is_dir(SM_PATH.'locale/'.$lang_dir) &&
701 file_exists(SM_PATH.'locale/'.$lang_dir.'/setup.php')) {
702 include_once(SM_PATH.'locale/'.$lang_dir.'/setup.php');
703 }
89b3545c 704 }
6c8a387f 705 $localedir->close();
89b3545c 706}
89b3545c 707
e0e1b169 708/* Detect whether gettext is installed. */
709$gettext_flags = 0;
710if (function_exists('_')) {
711 $gettext_flags += 1;
712}
713if (function_exists('bindtextdomain')) {
714 $gettext_flags += 2;
715}
716if (function_exists('textdomain')) {
717 $gettext_flags += 4;
718}
719if (function_exists('ngettext')) {
720 $gettext_flags += 8;
721}
722
723/* If gettext is fully loaded, cool */
724if ($gettext_flags == 15) {
725 $use_gettext = true;
726}
727
728/* If ngettext support is missing, load it */
729elseif ($gettext_flags == 7) {
730 $use_gettext = true;
731 // load internal ngettext functions
732 include_once(SM_PATH . 'class/l10n.class.php');
733 include_once(SM_PATH . 'functions/ngettext.php');
734}
735
736/* If we can fake gettext, try that */
737elseif ($gettext_flags == 0) {
738 $use_gettext = true;
739 include_once(SM_PATH . 'functions/gettext.php');
740} else {
741 /* Uh-ho. A weird install */
742 if (! $gettext_flags & 1) {
743 /**
744 * Function is used as replacement in broken installs
745 * @ignore
746 */
747 function _($str) {
748 return $str;
749 }
750 }
751 if (! $gettext_flags & 2) {
752 /**
753 * Function is used as replacement in broken installs
754 * @ignore
755 */
756 function bindtextdomain() {
757 return;
758 }
759 }
760 if (! $gettext_flags & 4) {
761 /**
762 * Function is used as replacemet in broken installs
763 * @ignore
764 */
765 function textdomain() {
766 return;
767 }
768 }
769 if (! $gettext_flags & 8) {
770 /**
771 * Function is used as replacemet in broken installs
772 * @ignore
773 */
774 function ngettext($str,$str2,$number) {
775 if ($number>1) {
776 return $str2;
777 } else {
778 return $str;
779 }
780 }
781 }
a9a10f57 782 if (! function_exists('dgettext')) {
783 /**
784 * Replacement for broken setups.
785 * @ignore
786 */
787 function dgettext($domain,$str) {
788 return $str;
789 }
790 }
791 if (! function_exists('dngettext')) {
792 /**
793 * Replacement for broken setups
794 * @ignore
795 */
796 function dngettext($domain,$str1,$strn,$number) {
797 return ($number==1 ? $str1 : $strn);
798 }
799 }
4e519821 800}
51468260 801?>