Just fiddling. Give credit where credit is due. Template class header() function...
[squirrelmail.git] / include / languages.php
CommitLineData
202bcbcc 1<?php
2
3/**
4 * SquirrelMail internationalization functions
5 *
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 *
867fed37 12 * Before 1.5.2 functions were stored in functions/i18n.php. Script is moved
13 * because it executes some code in order to detect functions supported by
14 * existing PHP installation and implements fallback functions when required
15 * functions are not available. Scripts in functions/ directory should not
16 * setup anything when they are loaded.
4b5049de 17 * @copyright &copy; 1999-2007 The SquirrelMail Project Team
202bcbcc 18 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
19 * @version $Id$
20 * @package squirrelmail
21 * @subpackage i18n
22 */
23
24
25/**
328c71cd 26 * Wrapper for textdomain(), bindtextdomain() and
27 * bind_textdomain_codeset() primarily intended for
28 * plugins when changing into their own text domain
29 * and back again.
30 *
b0963383 31 * Note that if plugins using this function have
328c71cd 32 * their translation files located in the SquirrelMail
b0963383 33 * locale directory, the second argument is optional.
328c71cd 34 *
35 * @param string $domain_name The name of the text domain
36 * (usually the plugin name, or
37 * "squirrelmail") being switched to.
b0963383 38 * @param string $directory The directory that contains
39 * all translations for the domain
40 * (OPTIONAL; default is SquirrelMail
41 * locale directory).
328c71cd 42 *
f06e5b6d 43 * @return string The name of the text domain that was set
44 * *BEFORE* it is changed herein - NOTE that
45 * this differs from PHP's textdomain()
328c71cd 46 *
47 * @since 1.5.2 and 1.4.10
48 */
b0963383 49function sq_change_text_domain($domain_name, $directory='') {
50
328c71cd 51 static $domains_already_seen = array();
f06e5b6d 52 global $gettext_domain;
53 $return_value = $gettext_domain;
328c71cd 54
55 // only need to call bindtextdomain() once
56 //
57 if (in_array($domain_name, $domains_already_seen)) {
58 sq_textdomain($domain_name);
f06e5b6d 59 return $return_value;
328c71cd 60 }
61
62 $domains_already_seen[] = $domain_name;
63
f06e5b6d 64 if (empty($directory)) $directory = SM_PATH . 'locale/';
65
b0963383 66 sq_bindtextdomain($domain_name, $directory);
328c71cd 67 sq_textdomain($domain_name);
68
f06e5b6d 69 return $return_value;
328c71cd 70}
71
72/**
202bcbcc 73 * Gettext bindtextdomain wrapper.
74 *
75 * Wrapper solves differences between php versions in order to provide
76 * ngettext support. Should be used if translation uses ngettext
77 * functions.
b0963383 78 *
79 * This also provides a bind_textdomain_codeset call to make sure the
80 * domain's encoding will not be overridden.
81 *
82 * @since 1.4.10 and 1.5.1
202bcbcc 83 * @param string $domain gettext domain name
87eaef7c 84 * @param string $dir directory that contains all translations (OPTIONAL;
85 * if not specified, defaults to SquirrelMail locale
86 * directory)
202bcbcc 87 * @return string path to translation directory
88 */
87eaef7c 89function sq_bindtextdomain($domain,$dir='') {
202bcbcc 90 global $l10n, $gettext_flags, $sm_notAlias;
91
da271ac9 92 if (empty($dir)) $dir = SM_PATH . 'locale/';
87eaef7c 93
202bcbcc 94 if ($gettext_flags==7) {
95 // gettext extension without ngettext
96 if (substr($dir, -1) != '/') $dir .= '/';
97 $mofile=$dir . $sm_notAlias . '/LC_MESSAGES/' . $domain . '.mo';
98 $input = new FileReader($mofile);
99 $l10n[$domain] = new gettext_reader($input);
100 }
101
102 $dir=bindtextdomain($domain,$dir);
103
b0963383 104 // set codeset in order to avoid gettext charset conversions
105 if (function_exists('bind_textdomain_codeset')
106 && isset($languages[$sm_notAlias]['CHARSET'])) {
107
108 // Japanese translation uses different internal charset
109 if ($sm_notAlias == 'ja_JP') {
110 bind_textdomain_codeset ($domain_name, 'EUC-JP');
111 } else {
112 bind_textdomain_codeset ($domain_name, $languages[$sm_notAlias]['CHARSET']);
113 }
114
115 }
116
202bcbcc 117 return $dir;
118}
119
120/**
121 * Gettext textdomain wrapper.
122 * Makes sure that gettext_domain global is modified.
123 * @since 1.5.1
124 * @param string $name gettext domain name
125 * @return string gettext domain name
126 */
127function sq_textdomain($domain) {
128 global $gettext_domain;
129 $gettext_domain=textdomain($domain);
130 return $gettext_domain;
131}
132
133/**
134 * php setlocale function wrapper
135 *
136 * From php 4.3.0 it is possible to use arrays in order to set locale.
137 * php gettext extension works only when locale is set. This wrapper
138 * function allows to use more than one locale name.
139 *
140 * @param int $category locale category name. Use php named constants
141 * (LC_ALL, LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME)
142 * @param mixed $locale option contains array with possible locales or string with one locale
143 * @return string name of set locale or false, if all locales fail.
144 * @since 1.5.1 and 1.4.5
145 * @see http://www.php.net/setlocale
146 */
147function sq_setlocale($category,$locale) {
06783280 148 if (is_string($locale)) {
149 // string with only one locale
150 $ret = setlocale($category,$locale);
151 } elseif (! check_php_version(4,3)) {
152 // older php version (second setlocale argument must be string)
202bcbcc 153 $ret=false;
154 $index=0;
155 while ( ! $ret && $index<count($locale)) {
156 $ret=setlocale($category,$locale[$index]);
157 $index++;
158 }
159 } else {
160 // php 4.3.0 or better, use entire array
161 $ret=setlocale($category,$locale);
162 }
06783280 163
164 /* safety checks */
165 if (preg_match("/^.*\/.*\/.*\/.*\/.*\/.*$/",$ret)) {
166 /**
167 * Welcome to We-Don't-Follow-Own-Fine-Manual department
168 * OpenBSD 3.8, 3.9-current and maybe later versions
169 * return invalid response to setlocale command.
170 * SM bug report #1427512.
171 */
172 $ret = false;
173 }
202bcbcc 174 return $ret;
175}
176
177/**
178 * Converts string from given charset to charset, that can be displayed by user translation.
179 *
180 * Function by default returns html encoded strings, if translation uses different encoding.
181 * If Japanese translation is used - function returns string converted to euc-jp
182 * If iconv or recode functions are enabled and translation uses utf-8 - function returns utf-8 encoded string.
183 * If $charset is not supported - function returns unconverted string.
184 *
185 * sanitizing of html tags is also done by this function.
186 *
187 * @param string $charset
188 * @param string $string Text to be decoded
189 * @param boolean $force_decode converts string to html without $charset!=$default_charset check.
190 * Argument is available since 1.5.1 and 1.4.5.
191 * @param boolean $save_html disables htmlspecialchars() in order to preserve
192 * html formating. Use with care. Available since 1.5.1
193 * @return string decoded string
194 */
195function charset_decode ($charset, $string, $force_decode=false, $save_html=false) {
196 global $languages, $squirrelmail_language, $default_charset;
197 global $use_php_recode, $use_php_iconv, $aggressive_decoding;
198
199 if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
200 function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode')) {
201 $string = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode', $string);
202 }
203
204 $charset = strtolower($charset);
205
206 set_my_charset();
207
208 // Variables that allow to use functions without function_exist() calls
209 if (! isset($use_php_recode) || $use_php_recode=="" ) {
210 $use_php_recode=false; }
211 if (! isset($use_php_iconv) || $use_php_iconv=="" ) {
212 $use_php_iconv=false; }
213
214 // Don't do conversion if charset is the same.
215 if ( ! $force_decode && $charset == strtolower($default_charset) )
216 return ($save_html ? $string : htmlspecialchars($string));
217
218 // catch iso-8859-8-i thing
219 if ( $charset == "iso-8859-8-i" )
220 $charset = "iso-8859-8";
221
222 /*
223 * Recode converts html special characters automatically if you use
224 * 'charset..html' decoding. There is no documented way to put -d option
225 * into php recode function call.
226 */
227 if ( $use_php_recode ) {
228 if ( $default_charset == "utf-8" ) {
229 // other charsets can be converted to utf-8 without loss.
230 // and output string is smaller
231 $string = recode_string($charset . "..utf-8",$string);
232 return ($save_html ? $string : htmlspecialchars($string));
233 } else {
234 $string = recode_string($charset . "..html",$string);
235 // recode does not convert single quote, htmlspecialchars does.
236 $string = str_replace("'", '&#039;', $string);
237 // undo html specialchars
238 if ($save_html)
239 $string=str_replace(array('&amp;','&quot;','&lt;','&gt;'),
240 array('&','"','<','>'),$string);
241 return $string;
242 }
243 }
244
245 // iconv functions does not have html target and can be used only with utf-8
246 if ( $use_php_iconv && $default_charset=='utf-8') {
247 $string = iconv($charset,$default_charset,$string);
248 return ($save_html ? $string : htmlspecialchars($string));
249 }
250
251 // If we don't use recode and iconv, we'll do it old way.
252
253 /* All HTML special characters are 7 bit and can be replaced first */
254 if (! $save_html) $string = htmlspecialchars ($string);
255
256 /* controls cpu and memory intensive decoding cycles */
257 if (! isset($aggressive_decoding) || $aggressive_decoding=="" ) {
258 $aggressive_decoding=false; }
259
260 $decode=fixcharset($charset);
261 $decodefile=SM_PATH . 'functions/decode/' . $decode . '.php';
ee872922 262 if ($decode != 'index' && file_exists($decodefile)) {
202bcbcc 263 include_once($decodefile);
264 // send $save_html argument to decoding function. needed for iso-2022-xx decoding.
265 $ret = call_user_func('charset_decode_'.$decode, $string, $save_html);
266 } else {
267 $ret = $string;
268 }
269 return( $ret );
270}
271
272/**
273 * Converts html string to given charset
274 * @since 1.5.1 and 1.4.4
275 * @param string $string
276 * @param string $charset
277 * @param boolean $htmlencode keep htmlspecialchars encoding
69022e98 278 * @return string
202bcbcc 279 */
280function charset_encode($string,$charset,$htmlencode=true) {
281 global $default_charset;
282
283 $encode=fixcharset($charset);
284 $encodefile=SM_PATH . 'functions/encode/' . $encode . '.php';
ee872922 285 if ($encode != 'index' && file_exists($encodefile)) {
202bcbcc 286 include_once($encodefile);
287 $ret = call_user_func('charset_encode_'.$encode, $string);
288 } elseif(file_exists(SM_PATH . 'functions/encode/us_ascii.php')) {
289 // function replaces all 8bit html entities with question marks.
290 // it is used when other encoding functions are unavailable
291 include_once(SM_PATH . 'functions/encode/us_ascii.php');
292 $ret = charset_encode_us_ascii($string);
293 } else {
294 /**
295 * fix for yahoo users that remove all us-ascii related things
296 */
297 $ret = $string;
298 }
299
300 /**
301 * Undo html special chars, some places (like compose form) have
302 * own sanitizing functions and don't need html symbols.
303 * Undo chars only after encoding in order to prevent conversion of
304 * html entities in plain text emails.
305 */
306 if (! $htmlencode ) {
307 $ret = str_replace(array('&amp;','&gt;','&lt;','&quot;'),array('&','>','<','"'),$ret);
308 }
309 return( $ret );
310}
311
312/**
313 * Combined decoding and encoding functions
314 *
315 * If conversion is done to charset different that utf-8, unsupported symbols
316 * will be replaced with question marks.
317 * @since 1.5.1 and 1.4.4
318 * @param string $in_charset initial charset
319 * @param string $string string that has to be converted
320 * @param string $out_charset final charset
321 * @param boolean $htmlencode keep htmlspecialchars encoding
322 * @return string converted string
323 */
324function charset_convert($in_charset,$string,$out_charset,$htmlencode=true) {
325 $string=charset_decode($in_charset,$string,true);
326 $string=sqi18n_convert_entities($string);
327 $string=charset_encode($string,$out_charset,$htmlencode);
328 return $string;
329}
330
331/**
332 * Makes charset name suitable for decoding cycles
333 *
334 * @since 1.5.0 and 1.4.4
335 * @param string $charset Name of charset
336 * @return string $charset Adjusted name of charset
337 */
338function fixcharset($charset) {
339 /* remove minus and characters that might be used in paths from charset
340 * name in order to be able to use it in function names and include calls.
341 */
342 $charset=preg_replace("/[-:.\/\\\]/",'_',$charset);
343
344 // OE ks_c_5601_1987 > cp949
345 $charset=str_replace('ks_c_5601_1987','cp949',$charset);
346 // Moz x-euc-tw > euc-tw
347 $charset=str_replace('x_euc','euc',$charset);
348 // Moz x-windows-949 > cp949
349 $charset=str_replace('x_windows_','cp',$charset);
350
351 // windows-125x and cp125x charsets
352 $charset=str_replace('windows_','cp',$charset);
353
354 // ibm > cp
355 $charset=str_replace('ibm','cp',$charset);
356
357 // iso-8859-8-i -> iso-8859-8
358 // use same cycle until I'll find differences
359 $charset=str_replace('iso_8859_8_i','iso_8859_8',$charset);
360
361 return $charset;
362}
363
364/**
365 * Set up the language to be output
366 * if $do_search is true, then scan the browser information
367 * for a possible language that we know
368 *
369 * Function sets system locale environment (LC_ALL, LANG, LANGUAGE),
370 * gettext translation bindings and html header information.
371 *
372 * Function returns error codes, if there is some fatal error.
373 * 0 = no error,
374 * 1 = mbstring support is not present,
375 * 2 = mbstring support is not present, user's translation reverted to en_US.
376 *
0d56053e 377 * @param string $sm_language Translation used by user's interface
378 * @param bool $do_search Use browser's preferred language detection functions.
379 * Defaults to false.
380 * @param bool $default Set $sm_language to $squirrelmail_default_language if
381 * language detection fails or language is not set.
382 * Defaults to false.
383 * @param string $content_type The content type being served currently (OPTIONAL;
384 * if not specified, defaults to whatever the template
385 * set that is in use has defined).
386 *
202bcbcc 387 * @return int function execution error codes.
0d56053e 388 *
202bcbcc 389 */
0d56053e 390function set_up_language($sm_language, $do_search=false,
391 $default=false, $content_type='') {
202bcbcc 392
393 static $SetupAlready = 0;
0d56053e 394 global $use_gettext, $languages, $oTemplate,
202bcbcc 395 $squirrelmail_language, $squirrelmail_default_language, $default_charset,
396 $sm_notAlias, $username, $data_dir;
397
398 if ($SetupAlready) {
399 return;
400 }
401
402 $SetupAlready = TRUE;
403 sqgetGlobalVar('HTTP_ACCEPT_LANGUAGE', $accept_lang, SQ_SERVER);
404
0d56053e 405 // grab content type if needed
406 //
407 if (empty($content_type)) $content_type = $oTemplate->get_content_type();
408
202bcbcc 409 /**
410 * If function is asked to detect preferred language
411 * OR squirrelmail default language is set to empty string
412 * AND
413 * squirrelmail language ($sm_language) is empty string
414 * (not set in user's prefs and no cookie with language info)
415 * AND
416 * browser provides list of preferred languages
417 * THEN
418 * get preferred language from HTTP_ACCEPT_LANGUAGE header
419 */
420 if (($do_search || empty($squirrelmail_default_language)) &&
421 ! $sm_language &&
422 isset($accept_lang)) {
423 // TODO: use more than one language, if first language is not available
424 // FIXME: function assumes that string contains two or more characters.
425 // FIXME: some languages use 5 chars
426 $sm_language = substr($accept_lang, 0, 2);
427 }
428
429 /**
430 * If language preference is not set OR script asks to use default language
431 * AND
432 * default squirrelmail language is not set to empty string
433 * THEN
434 * use default squirrelmail language value from configuration.
435 */
436 if ((!$sm_language||$default) &&
437 ! empty($squirrelmail_default_language)) {
438 $squirrelmail_language = $squirrelmail_default_language;
439 $sm_language = $squirrelmail_default_language;
440 }
441
442 /** provide failsafe language when detection fails */
443 if (! $sm_language) $sm_language='en_US';
444
445 $sm_notAlias = $sm_language;
446
447 // Catching removed translation
448 // System reverts to English translation if user prefs contain translation
449 // that is not available in $languages array
450 if (!isset($languages[$sm_notAlias])) {
451 $sm_notAlias="en_US";
452 }
453
454 while (isset($languages[$sm_notAlias]['ALIAS'])) {
455 $sm_notAlias = $languages[$sm_notAlias]['ALIAS'];
456 }
457
458 if ( isset($sm_language) &&
459 $use_gettext &&
460 $sm_language != '' &&
461 isset($languages[$sm_notAlias]['CHARSET']) ) {
462 sq_bindtextdomain( 'squirrelmail', SM_PATH . 'locale/' );
463 sq_textdomain( 'squirrelmail' );
464
202bcbcc 465 // Use LOCALE key, if it is set.
466 if (isset($languages[$sm_notAlias]['LOCALE'])){
467 $longlocale=$languages[$sm_notAlias]['LOCALE'];
468 } else {
469 $longlocale=$sm_notAlias;
470 }
471
472 // try setting locale
473 $retlocale=sq_setlocale(LC_ALL, $longlocale);
474
475 // check if locale is set and assign that locale to $longlocale
476 // in order to use it in putenv calls.
477 if (! is_bool($retlocale)) {
478 $longlocale=$retlocale;
479 } elseif (is_array($longlocale)) {
480 // setting of all locales failed.
481 // we need string instead of array used in LOCALE key.
482 $longlocale=$sm_notAlias;
483 }
484
485 if ( !((bool)ini_get('safe_mode')) &&
486 getenv( 'LC_ALL' ) != $longlocale ) {
487 putenv( "LC_ALL=$longlocale" );
488 putenv( "LANG=$longlocale" );
489 putenv( "LANGUAGE=$longlocale" );
490 putenv( "LC_NUMERIC=C" );
491 if ($sm_notAlias=='tr_TR') putenv( "LC_CTYPE=C" );
492 }
493 // Workaround for plugins that use numbers with floating point
494 // It might be removed if plugins use correct decimal delimiters
495 // according to locale settings.
496 setlocale(LC_NUMERIC, 'C');
497 // Workaround for specific Turkish strtolower/strtoupper rules.
498 // Many functions expect English conversion rules.
499 if ($sm_notAlias=='tr_TR') setlocale(LC_CTYPE,'C');
500
501 /**
502 * Set text direction/alignment variables
503 * When language environment is setup, scripts can use these globals
504 * without accessing $languages directly and making checks for optional
505 * array key.
506 */
507 global $text_direction, $left_align, $right_align;
508 if (isset($languages[$sm_notAlias]['DIR']) &&
509 $languages[$sm_notAlias]['DIR'] == 'rtl') {
510 /**
511 * Text direction
512 * @global string $text_direction
513 */
514 $text_direction='rtl';
515 /**
516 * Left alignment
517 * @global string $left_align
518 */
519 $left_align='right';
520 /**
521 * Right alignment
522 * @global string $right_align
523 */
524 $right_align='left';
525 } else {
526 $text_direction='ltr';
527 $left_align='left';
528 $right_align='right';
529 }
530
531 $squirrelmail_language = $sm_notAlias;
532 if ($squirrelmail_language == 'ja_JP') {
0d56053e 533 $oTemplate->header ('Content-Type: ' . $content_type . '; charset=EUC-JP');
202bcbcc 534 if (!function_exists('mb_internal_encoding')) {
535 // Error messages can't be displayed here
536 $error = 1;
537 // Revert to English if possible.
538 if (function_exists('setPref') && $username!='' && $data_dir!="") {
539 setPref($data_dir, $username, 'language', "en_US");
540 $error = 2;
541 }
542 // stop further execution in order not to get php errors on mb_internal_encoding().
543 return $error;
544 }
545 if (function_exists('mb_language')) {
546 mb_language('Japanese');
547 }
548 mb_internal_encoding('EUC-JP');
549 mb_http_output('pass');
550 } elseif ($squirrelmail_language == 'en_US') {
0d56053e 551 $oTemplate->header( 'Content-Type: ' . $content_type . '; charset=' . $default_charset );
202bcbcc 552 } else {
0d56053e 553 $oTemplate->header( 'Content-Type: ' . $content_type . '; charset=' . $languages[$sm_notAlias]['CHARSET'] );
202bcbcc 554 }
555 /**
556 * mbstring.func_overload fix (#929644).
557 *
558 * php mbstring extension can replace standard string functions with their multibyte
559 * equivalents. See http://www.php.net/ref.mbstring#mbstring.overload. This feature
560 * was added in php v.4.2.0
561 *
562 * Some SquirrelMail functions work with 8bit strings in bytes. If interface is forced
563 * to use mbstring functions and mbstring internal encoding is set to multibyte charset,
564 * interface can't trust regular string functions. Due to mbstring overloading design
565 * limits php scripts can't control this setting.
566 *
567 * This hack should fix some issues related to 8bit strings in passwords. Correct fix is
568 * to disable mbstring overloading. Japanese translation uses different internal encoding.
569 */
570 if ($squirrelmail_language != 'ja_JP' &&
571 function_exists('mb_internal_encoding') &&
572 check_php_version(4,2,0) &&
573 (int)ini_get('mbstring.func_overload')!=0) {
574 mb_internal_encoding('pass');
575 }
576 }
577 return 0;
578}
579
580/**
581 * Sets default_charset variable according to the one that is used by user's translations.
582 *
583 * Function changes global $default_charset variable in order to be sure, that it
584 * contains charset used by user's translation. Sanity of $squirrelmail_language
585 * and $default_charset combination is also tested.
586 *
587 * There can be a $default_charset setting in the
588 * config.php file, but the user may have a different language
589 * selected for a user interface. This function checks the
590 * language selected by the user and tags the outgoing messages
591 * with the appropriate charset corresponding to the language
592 * selection. This is "more right" (tm), than just stamping the
593 * message blindly with the system-wide $default_charset.
594 */
595function set_my_charset(){
596 global $data_dir, $username, $default_charset, $languages, $squirrelmail_language;
597
598 $my_language = getPref($data_dir, $username, 'language');
599 if (!$my_language) {
600 $my_language = $squirrelmail_language ;
601 }
602 // Catch removed translation
603 if (!isset($languages[$my_language])) {
604 $my_language="en_US";
605 }
606 while (isset($languages[$my_language]['ALIAS'])) {
607 $my_language = $languages[$my_language]['ALIAS'];
608 }
609 $my_charset = $languages[$my_language]['CHARSET'];
610 if ($my_language!='en_US') {
611 $default_charset = $my_charset;
612 }
613}
614
615/**
616 * Replaces non-braking spaces inserted by some browsers with regular space
617 *
618 * This function can be used to replace non-braking space symbols
619 * that are inserted in forms by some browsers instead of normal
620 * space symbol.
621 *
622 * @param string $string Text that needs to be cleaned
623 * @param string $charset Charset used in text
624 * @return string Cleaned text
625 */
626function cleanup_nbsp($string,$charset) {
627
628 // reduce number of case statements
629 if (stristr('iso-8859-',substr($charset,0,9))){
630 $output_charset="iso-8859-x";
631 }
632 if (stristr('windows-125',substr($charset,0,11))){
633 $output_charset="cp125x";
634 }
635 if (stristr('koi8',substr($charset,0,4))){
636 $output_charset="koi8-x";
637 }
638 if (! isset($output_charset)){
639 $output_charset=strtolower($charset);
640 }
641
642// where is non-braking space symbol
643switch($output_charset):
644 case "iso-8859-x":
645 case "cp125x":
646 case "iso-2022-jp":
647 $nbsp="\xA0";
648 break;
649 case "koi8-x":
650 $nbsp="\x9A";
651 break;
652 case "utf-8":
653 $nbsp="\xC2\xA0";
654 break;
655 default:
656 // don't change string if charset is unmatched
657 return $string;
658endswitch;
659
660// return space instead of non-braking space.
661 return str_replace($nbsp,' ',$string);
662}
663
664/**
665 * Function informs if it is safe to convert given charset to the one that is used by user.
666 *
667 * It is safe to use conversion only if user uses utf-8 encoding and when
668 * converted charset is similar to the one that is used by user.
669 *
670 * @param string $input_charset Charset of text that needs to be converted
671 * @return bool is it possible to convert to user's charset
672 */
673function is_conversion_safe($input_charset) {
674 global $languages, $sm_notAlias, $default_charset, $lossy_encoding;
675
676 if (isset($lossy_encoding) && $lossy_encoding )
677 return true;
678
679 // convert to lower case
680 $input_charset = strtolower($input_charset);
681
682 // Is user's locale Unicode based ?
683 if ( $default_charset == "utf-8" ) {
684 return true;
685 }
686
687 // Charsets that are similar
688 switch ($default_charset) {
689 case "windows-1251":
690 if ( $input_charset == "iso-8859-5" ||
691 $input_charset == "koi8-r" ||
692 $input_charset == "koi8-u" ) {
693 return true;
694 } else {
695 return false;
696 }
697 case "windows-1257":
698 if ( $input_charset == "iso-8859-13" ||
699 $input_charset == "iso-8859-4" ) {
700 return true;
701 } else {
702 return false;
703 }
704 case "iso-8859-4":
705 if ( $input_charset == "iso-8859-13" ||
706 $input_charset == "windows-1257" ) {
707 return true;
708 } else {
709 return false;
710 }
711 case "iso-8859-5":
712 if ( $input_charset == "windows-1251" ||
713 $input_charset == "koi8-r" ||
714 $input_charset == "koi8-u" ) {
715 return true;
716 } else {
717 return false;
718 }
719 case "iso-8859-13":
720 if ( $input_charset == "iso-8859-4" ||
721 $input_charset == "windows-1257" ) {
722 return true;
723 } else {
724 return false;
725 }
726 case "koi8-r":
727 if ( $input_charset == "windows-1251" ||
728 $input_charset == "iso-8859-5" ||
729 $input_charset == "koi8-u" ) {
730 return true;
731 } else {
732 return false;
733 }
734 case "koi8-u":
735 if ( $input_charset == "windows-1251" ||
736 $input_charset == "iso-8859-5" ||
737 $input_charset == "koi8-r" ) {
738 return true;
739 } else {
740 return false;
741 }
742 default:
743 return false;
744 }
745}
746
747/**
748 * Converts html character entities to numeric entities
749 *
750 * SquirrelMail encoding functions work only with numeric entities.
751 * This function fixes issues with decoding functions that might convert
752 * some symbols to character entities. Issue is specific to PHP recode
753 * extension decoding. Function is used internally in charset_convert()
754 * function.
755 * @param string $str string that might contain html character entities
756 * @return string string with character entities converted to decimals.
757 * @since 1.5.2
758 */
759function sqi18n_convert_entities($str) {
760
761 $entities = array(
762 // Latin 1
763 '&nbsp;' => '&#160;',
764 '&iexcl;' => '&#161;',
765 '&cent;' => '&#162;',
766 '&pound;' => '&#163;',
767 '&curren;' => '&#164;',
768 '&yen;' => '&#165;',
769 '&brvbar;' => '&#166;',
770 '&sect;' => '&#167;',
771 '&uml;' => '&#168;',
772 '&copy;' => '&#169;',
773 '&ordf;' => '&#170;',
774 '&laquo;' => '&#171;',
775 '&not;' => '&#172;',
776 '&shy;' => '&#173;',
777 '&reg;' => '&#174;',
778 '&macr;' => '&#175;',
779 '&deg;' => '&#176;',
780 '&plusmn;' => '&#177;',
781 '&sup2;' => '&#178;',
782 '&sup3;' => '&#179;',
783 '&acute;' => '&#180;',
784 '&micro;' => '&#181;',
785 '&para;' => '&#182;',
786 '&middot;' => '&#183;',
787 '&cedil;' => '&#184;',
788 '&sup1;' => '&#185;',
789 '&ordm;' => '&#186;',
790 '&raquo;' => '&#187;',
791 '&frac14;' => '&#188;',
792 '&frac12;' => '&#189;',
793 '&frac34;' => '&#190;',
794 '&iquest;' => '&#191;',
795 '&Agrave;' => '&#192;',
796 '&Aacute;' => '&#193;',
797 '&Acirc;' => '&#194;',
798 '&Atilde;' => '&#195;',
799 '&Auml;' => '&#196;',
800 '&Aring;' => '&#197;',
801 '&AElig;' => '&#198;',
802 '&Ccedil;' => '&#199;',
803 '&Egrave;' => '&#200;',
804 '&Eacute;' => '&#201;',
805 '&Ecirc;' => '&#202;',
806 '&Euml;' => '&#203;',
807 '&Igrave;' => '&#204;',
808 '&Iacute;' => '&#205;',
809 '&Icirc;' => '&#206;',
810 '&Iuml;' => '&#207;',
811 '&ETH;' => '&#208;',
812 '&Ntilde;' => '&#209;',
813 '&Ograve;' => '&#210;',
814 '&Oacute;' => '&#211;',
815 '&Ocirc;' => '&#212;',
816 '&Otilde;' => '&#213;',
817 '&Ouml;' => '&#214;',
818 '&times;' => '&#215;',
819 '&Oslash;' => '&#216;',
820 '&Ugrave;' => '&#217;',
821 '&Uacute;' => '&#218;',
822 '&Ucirc;' => '&#219;',
823 '&Uuml;' => '&#220;',
824 '&Yacute;' => '&#221;',
825 '&THORN;' => '&#222;',
826 '&szlig;' => '&#223;',
827 '&agrave;' => '&#224;',
828 '&aacute;' => '&#225;',
829 '&acirc;' => '&#226;',
830 '&atilde;' => '&#227;',
831 '&auml;' => '&#228;',
832 '&aring;' => '&#229;',
833 '&aelig;' => '&#230;',
834 '&ccedil;' => '&#231;',
835 '&egrave;' => '&#232;',
836 '&eacute;' => '&#233;',
837 '&ecirc;' => '&#234;',
838 '&euml;' => '&#235;',
839 '&igrave;' => '&#236;',
840 '&iacute;' => '&#237;',
841 '&icirc;' => '&#238;',
842 '&iuml;' => '&#239;',
843 '&eth;' => '&#240;',
844 '&ntilde;' => '&#241;',
845 '&ograve;' => '&#242;',
846 '&oacute;' => '&#243;',
847 '&ocirc;' => '&#244;',
848 '&otilde;' => '&#245;',
849 '&ouml;' => '&#246;',
850 '&divide;' => '&#247;',
851 '&oslash;' => '&#248;',
852 '&ugrave;' => '&#249;',
853 '&uacute;' => '&#250;',
854 '&ucirc;' => '&#251;',
855 '&uuml;' => '&#252;',
856 '&yacute;' => '&#253;',
857 '&thorn;' => '&#254;',
858 '&yuml;' => '&#255;',
859 // Latin Extended-A
860 '&OElig;' => '&#338;',
861 '&oelig;' => '&#339;',
862 '&Scaron;' => '&#352;',
863 '&scaron;' => '&#353;',
864 '&Yuml;' => '&#376;',
865 // Spacing Modifier Letters
866 '&circ;' => '&#710;',
867 '&tilde;' => '&#732;',
868 // General Punctuation
869 '&ensp;' => '&#8194;',
870 '&emsp;' => '&#8195;',
871 '&thinsp;' => '&#8201;',
872 '&zwnj;' => '&#8204;',
873 '&zwj;' => '&#8205;',
874 '&lrm;' => '&#8206;',
875 '&rlm;' => '&#8207;',
876 '&ndash;' => '&#8211;',
877 '&mdash;' => '&#8212;',
878 '&lsquo;' => '&#8216;',
879 '&rsquo;' => '&#8217;',
880 '&sbquo;' => '&#8218;',
881 '&ldquo;' => '&#8220;',
882 '&rdquo;' => '&#8221;',
883 '&bdquo;' => '&#8222;',
884 '&dagger;' => '&#8224;',
885 '&Dagger;' => '&#8225;',
886 '&permil;' => '&#8240;',
887 '&lsaquo;' => '&#8249;',
888 '&rsaquo;' => '&#8250;',
889 '&euro;' => '&#8364;',
890 // Latin Extended-B
891 '&fnof;' => '&#402;',
892 // Greek
893 '&Alpha;' => '&#913;',
894 '&Beta;' => '&#914;',
895 '&Gamma;' => '&#915;',
896 '&Delta;' => '&#916;',
897 '&Epsilon;' => '&#917;',
898 '&Zeta;' => '&#918;',
899 '&Eta;' => '&#919;',
900 '&Theta;' => '&#920;',
901 '&Iota;' => '&#921;',
902 '&Kappa;' => '&#922;',
903 '&Lambda;' => '&#923;',
904 '&Mu;' => '&#924;',
905 '&Nu;' => '&#925;',
906 '&Xi;' => '&#926;',
907 '&Omicron;' => '&#927;',
908 '&Pi;' => '&#928;',
909 '&Rho;' => '&#929;',
910 '&Sigma;' => '&#931;',
911 '&Tau;' => '&#932;',
912 '&Upsilon;' => '&#933;',
913 '&Phi;' => '&#934;',
914 '&Chi;' => '&#935;',
915 '&Psi;' => '&#936;',
916 '&Omega;' => '&#937;',
917 '&alpha;' => '&#945;',
918 '&beta;' => '&#946;',
919 '&gamma;' => '&#947;',
920 '&delta;' => '&#948;',
921 '&epsilon;' => '&#949;',
922 '&zeta;' => '&#950;',
923 '&eta;' => '&#951;',
924 '&theta;' => '&#952;',
925 '&iota;' => '&#953;',
926 '&kappa;' => '&#954;',
927 '&lambda;' => '&#955;',
928 '&mu;' => '&#956;',
929 '&nu;' => '&#957;',
930 '&xi;' => '&#958;',
931 '&omicron;' => '&#959;',
932 '&pi;' => '&#960;',
933 '&rho;' => '&#961;',
934 '&sigmaf;' => '&#962;',
935 '&sigma;' => '&#963;',
936 '&tau;' => '&#964;',
937 '&upsilon;' => '&#965;',
938 '&phi;' => '&#966;',
939 '&chi;' => '&#967;',
940 '&psi;' => '&#968;',
941 '&omega;' => '&#969;',
942 '&thetasym;' => '&#977;',
943 '&upsih;' => '&#978;',
944 '&piv;' => '&#982;',
945 // General Punctuation
946 '&bull;' => '&#8226;',
947 '&hellip;' => '&#8230;',
948 '&prime;' => '&#8242;',
949 '&Prime;' => '&#8243;',
950 '&oline;' => '&#8254;',
951 '&frasl;' => '&#8260;',
952 // Letterlike Symbols
953 '&weierp;' => '&#8472;',
954 '&image;' => '&#8465;',
955 '&real;' => '&#8476;',
956 '&trade;' => '&#8482;',
957 '&alefsym;' => '&#8501;',
958 // Arrows
959 '&larr;' => '&#8592;',
960 '&uarr;' => '&#8593;',
961 '&rarr;' => '&#8594;',
962 '&darr;' => '&#8595;',
963 '&harr;' => '&#8596;',
964 '&crarr;' => '&#8629;',
965 '&lArr;' => '&#8656;',
966 '&uArr;' => '&#8657;',
967 '&rArr;' => '&#8658;',
968 '&dArr;' => '&#8659;',
969 '&hArr;' => '&#8660;',
970 // Mathematical Operators
971 '&forall;' => '&#8704;',
972 '&part;' => '&#8706;',
973 '&exist;' => '&#8707;',
974 '&empty;' => '&#8709;',
975 '&nabla;' => '&#8711;',
976 '&isin;' => '&#8712;',
977 '&notin;' => '&#8713;',
978 '&ni;' => '&#8715;',
979 '&prod;' => '&#8719;',
980 '&sum;' => '&#8721;',
981 '&minus;' => '&#8722;',
982 '&lowast;' => '&#8727;',
983 '&radic;' => '&#8730;',
984 '&prop;' => '&#8733;',
985 '&infin;' => '&#8734;',
986 '&ang;' => '&#8736;',
987 '&and;' => '&#8743;',
988 '&or;' => '&#8744;',
989 '&cap;' => '&#8745;',
990 '&cup;' => '&#8746;',
991 '&int;' => '&#8747;',
992 '&there4;' => '&#8756;',
993 '&sim;' => '&#8764;',
994 '&cong;' => '&#8773;',
995 '&asymp;' => '&#8776;',
996 '&ne;' => '&#8800;',
997 '&equiv;' => '&#8801;',
998 '&le;' => '&#8804;',
999 '&ge;' => '&#8805;',
1000 '&sub;' => '&#8834;',
1001 '&sup;' => '&#8835;',
1002 '&nsub;' => '&#8836;',
1003 '&sube;' => '&#8838;',
1004 '&supe;' => '&#8839;',
1005 '&oplus;' => '&#8853;',
1006 '&otimes;' => '&#8855;',
1007 '&perp;' => '&#8869;',
1008 '&sdot;' => '&#8901;',
1009 // Miscellaneous Technical
1010 '&lceil;' => '&#8968;',
1011 '&rceil;' => '&#8969;',
1012 '&lfloor;' => '&#8970;',
1013 '&rfloor;' => '&#8971;',
1014 '&lang;' => '&#9001;',
1015 '&rang;' => '&#9002;',
1016 // Geometric Shapes
1017 '&loz;' => '&#9674;',
1018 // Miscellaneous Symbols
1019 '&spades;' => '&#9824;',
1020 '&clubs;' => '&#9827;',
1021 '&hearts;' => '&#9829;',
1022 '&diams;' => '&#9830;');
1023
1024 $str = str_replace(array_keys($entities), array_values($entities), $str);
1025
1026 return $str;
1027}
1028
1029/* ------------------------------ main --------------------------- */
1030
1031global $squirrelmail_language, $languages, $use_gettext;
1032
1033if (! sqgetGlobalVar('squirrelmail_language',$squirrelmail_language,SQ_COOKIE)) {
1034 $squirrelmail_language = '';
1035}
1036
1037/**
1038 * Array specifies the available translations.
1039 *
1040 * Structure of array:
1041 * $languages['language']['variable'] = 'value'
1042 *
1043 * Possible 'variable' names:
1044 * NAME - Translation name in English
1045 * CHARSET - Encoding used by translation
1046 * ALIAS - used when 'language' is only short name and 'value' should provide long language name
1047 * ALTNAME - Native translation name. Any 8bit symbols must be html encoded.
1048 * 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
1049 * DIR - Text direction. Used to define Right-to-Left languages. Possible values 'rtl' or 'ltr'. If undefined - defaults to 'ltr'
1050 * XTRA_CODE - translation uses special functions. See doc/i18n.txt
1051 *
1052 * Each 'language' definition requires NAME+CHARSET or ALIAS variables.
1053 *
1054 * @name $languages
1055 * @global array $languages
1056 */
1057$languages['en_US']['NAME'] = 'English';
1058$languages['en_US']['CHARSET'] = 'iso-8859-1';
1059$languages['en_US']['LOCALE'] = 'en_US.ISO8859-1';
1060$languages['en']['ALIAS'] = 'en_US';
1061
1062/**
1063 * Automatic translation loading from setup.php files.
1064 * Solution for bug. 1240889.
1065 * setup.php file can contain $languages array entries and XTRA_CODE functions.
1066 */
1067if (is_dir(SM_PATH . 'locale') &&
1068 is_readable(SM_PATH . 'locale')) {
1069 $localedir = dir(SM_PATH . 'locale');
1070 while($lang_dir=$localedir->read()) {
1071 // remove trailing slash, if present
1072 if (substr($lang_dir,-1)=='/') {
1073 $lang_dir = substr($lang_dir,0,-1);
1074 }
1075 if ($lang_dir != '..' && $lang_dir != '.' && $lang_dir != 'CVS' &&
fdf58ef9 1076 $lang_dir != '.svn' && is_dir(SM_PATH.'locale/'.$lang_dir) &&
202bcbcc 1077 file_exists(SM_PATH.'locale/'.$lang_dir.'/setup.php')) {
1078 include_once(SM_PATH.'locale/'.$lang_dir.'/setup.php');
1079 }
1080 }
1081 $localedir->close();
1082}
1083
1084/* Detect whether gettext is installed. */
1085$gettext_flags = 0;
1086if (function_exists('_')) {
1087 $gettext_flags += 1;
1088}
1089if (function_exists('bindtextdomain')) {
1090 $gettext_flags += 2;
1091}
1092if (function_exists('textdomain')) {
1093 $gettext_flags += 4;
1094}
1095if (function_exists('ngettext')) {
1096 $gettext_flags += 8;
1097}
1098
1099/* If gettext is fully loaded, cool */
1100if ($gettext_flags == 15) {
1101 $use_gettext = true;
1102}
1103
1104/* If ngettext support is missing, load it */
1105elseif ($gettext_flags == 7) {
1106 $use_gettext = true;
1107 // load internal ngettext functions
1108 include_once(SM_PATH . 'class/l10n.class.php');
1109 include_once(SM_PATH . 'functions/ngettext.php');
1110}
1111
1112/* If we can fake gettext, try that */
1113elseif ($gettext_flags == 0) {
1114 $use_gettext = true;
1115 include_once(SM_PATH . 'functions/gettext.php');
1116} else {
1117 /* Uh-ho. A weird install */
1118 if (! $gettext_flags & 1) {
1119 /**
1120 * Function is used as replacement in broken installs
1121 * @ignore
1122 */
1123 function _($str) {
1124 return $str;
1125 }
1126 }
1127 if (! $gettext_flags & 2) {
1128 /**
1129 * Function is used as replacement in broken installs
1130 * @ignore
1131 */
1132 function bindtextdomain() {
1133 return;
1134 }
1135 }
1136 if (! $gettext_flags & 4) {
1137 /**
1138 * Function is used as replacemet in broken installs
1139 * @ignore
1140 */
1141 function textdomain() {
1142 return;
1143 }
1144 }
1145 if (! $gettext_flags & 8) {
1146 /**
1147 * Function is used as replacemet in broken installs
1148 * @ignore
1149 */
1150 function ngettext($str,$str2,$number) {
1151 if ($number>1) {
1152 return $str2;
1153 } else {
1154 return $str;
1155 }
1156 }
1157 }
1158 if (! function_exists('dgettext')) {
1159 /**
1160 * Replacement for broken setups.
1161 * @ignore
1162 */
1163 function dgettext($domain,$str) {
1164 return $str;
1165 }
1166 }
1167 if (! function_exists('dngettext')) {
1168 /**
1169 * Replacement for broken setups
1170 * @ignore
1171 */
1172 function dngettext($domain,$str1,$strn,$number) {
1173 return ($number==1 ? $str1 : $strn);
1174 }
1175 }
1176}