File Source for languages.php

<?php
/**
* SquirrelMail internationalization functions
*
* This file contains variuos functions that are needed to do
* internationalization of SquirrelMail.
*
* Internally the output character set is used. Other characters are
* encoded using Unicode entities according to HTML 4.0.
*
* Before 1.5.2 functions were stored in functions/i18n.php. Script is moved
* because it executes some code in order to detect functions supported by
* existing PHP installation and implements fallback functions when required
* functions are not available. Scripts in functions/ directory should not
* setup anything when they are loaded.
* @copyright © 1999-2006 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id: languages.php,v 1.5 2006/08/06 08:46:36 tokul Exp $
* @package squirrelmail
* @subpackage i18n
*/
/**
* Gettext bindtextdomain wrapper.
*
* Wrapper solves differences between php versions in order to provide
* ngettext support. Should be used if translation uses ngettext
* functions.
* @since 1.5.1
* @param string $domain gettext domain name
* @param string $dir directory that contains all translations
* @return string path to translation directory
*/
function sq_bindtextdomain($domain,$dir) {
global $l10n, $gettext_flags, $sm_notAlias;
if ($gettext_flags==7) {
// gettext extension without ngettext
if (substr($dir, -1) != '/') $dir .= '/';
$mofile=$dir . $sm_notAlias . '/LC_MESSAGES/' . $domain . '.mo';
$input = new FileReader($mofile);
$l10n[$domain] = new gettext_reader($input);
}
$dir=bindtextdomain($domain,$dir);
return $dir;
}
/**
* Gettext textdomain wrapper.
* Makes sure that gettext_domain global is modified.
* @since 1.5.1
* @param string $name gettext domain name
* @return string gettext domain name
*/
function sq_textdomain($domain) {
global $gettext_domain;
$gettext_domain=textdomain($domain);
return $gettext_domain;
}
/**
* php setlocale function wrapper
*
* From php 4.3.0 it is possible to use arrays in order to set locale.
* php gettext extension works only when locale is set. This wrapper
* function allows to use more than one locale name.
*
* @param int $category locale category name. Use php named constants
* (LC_ALL, LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME)
* @param mixed $locale option contains array with possible locales or string with one locale
* @return string name of set locale or false, if all locales fail.
* @since 1.5.1 and 1.4.5
* @see http://www.php.net/setlocale
*/
function sq_setlocale($category,$locale) {
if (is_string($locale)) {
// string with only one locale
$ret = setlocale($category,$locale);
} elseif (! check_php_version(4,3)) {
// older php version (second setlocale argument must be string)
$ret=false;
$index=0;
while ( ! $ret && $index<count($locale)) {
$ret=setlocale($category,$locale[$index]);
$index++;
}
} else {
// php 4.3.0 or better, use entire array
$ret=setlocale($category,$locale);
}
/* safety checks */
if (preg_match("/^.*\/.*\/.*\/.*\/.*\/.*$/",$ret)) {
/**
* Welcome to We-Don't-Follow-Own-Fine-Manual department
* OpenBSD 3.8, 3.9-current and maybe later versions
* return invalid response to setlocale command.
* SM bug report #1427512.
*/
$ret = false;
}
return $ret;
}
/**
* Converts string from given charset to charset, that can be displayed by user translation.
*
* Function by default returns html encoded strings, if translation uses different encoding.
* If Japanese translation is used - function returns string converted to euc-jp
* If iconv or recode functions are enabled and translation uses utf-8 - function returns utf-8 encoded string.
* If $charset is not supported - function returns unconverted string.
*
* sanitizing of html tags is also done by this function.
*
* @param string $charset
* @param string $string Text to be decoded
* @param boolean $force_decode converts string to html without $charset!=$default_charset check.
* Argument is available since 1.5.1 and 1.4.5.
* @param boolean $save_html disables htmlspecialchars() in order to preserve
* html formating. Use with care. Available since 1.5.1
* @return string decoded string
*/
function charset_decode ($charset, $string, $force_decode=false, $save_html=false) {
global $languages, $squirrelmail_language, $default_charset;
global $use_php_recode, $use_php_iconv, $aggressive_decoding;
if (isset($languages[$squirrelmail_language]['XTRA_CODE']) &&
function_exists($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode')) {
$string = call_user_func($languages[$squirrelmail_language]['XTRA_CODE'] . '_decode', $string);
}
$charset = strtolower($charset);
set_my_charset();
// Variables that allow to use functions without function_exist() calls
if (! isset($use_php_recode) || $use_php_recode=="" ) {
$use_php_recode=false; }
if (! isset($use_php_iconv) || $use_php_iconv=="" ) {
$use_php_iconv=false; }
// Don't do conversion if charset is the same.
if ( ! $force_decode && $charset == strtolower($default_charset) )
return ($save_html ? $string : htmlspecialchars($string));
// catch iso-8859-8-i thing
if ( $charset == "iso-8859-8-i" )
$charset = "iso-8859-8";
/*
* Recode converts html special characters automatically if you use
* 'charset..html' decoding. There is no documented way to put -d option
* into php recode function call.
*/
if ( $use_php_recode ) {
if ( $default_charset == "utf-8" ) {
// other charsets can be converted to utf-8 without loss.
// and output string is smaller
$string = recode_string($charset . "..utf-8",$string);
return ($save_html ? $string : htmlspecialchars($string));
} else {
$string = recode_string($charset . "..html",$string);
// recode does not convert single quote, htmlspecialchars does.
$string = str_replace("'", ''', $string);
// undo html specialchars
if ($save_html)
$string=str_replace(array('&','"','<','>'),
array('&','"','<','>'),$string);
return $string;
}
}
// iconv functions does not have html target and can be used only with utf-8
if ( $use_php_iconv && $default_charset=='utf-8') {
$string = iconv($charset,$default_charset,$string);
return ($save_html ? $string : htmlspecialchars($string));
}
// If we don't use recode and iconv, we'll do it old way.
/* All HTML special characters are 7 bit and can be replaced first */
if (! $save_html) $string = htmlspecialchars ($string);
/* controls cpu and memory intensive decoding cycles */
if (! isset($aggressive_decoding) || $aggressive_decoding=="" ) {
$aggressive_decoding=false; }
$decode=fixcharset($charset);
$decodefile=SM_PATH . 'functions/decode/' . $decode . '.php';
if (file_exists($decodefile)) {
include_once($decodefile);
// send $save_html argument to decoding function. needed for iso-2022-xx decoding.
$ret = call_user_func('charset_decode_'.$decode, $string, $save_html);
} else {
$ret = $string;
}
return( $ret );
}
/**
* Converts html string to given charset
* @since 1.5.1 and 1.4.4
* @param string $string
* @param string $charset
* @param boolean $htmlencode keep htmlspecialchars encoding
* @return string
*/
function charset_encode($string,$charset,$htmlencode=true) {
global $default_charset;
$encode=fixcharset($charset);
$encodefile=SM_PATH . 'functions/encode/' . $encode . '.php';
if (file_exists($encodefile)) {
include_once($encodefile);
$ret = call_user_func('charset_encode_'.$encode, $string);
} elseif(file_exists(SM_PATH . 'functions/encode/us_ascii.php')) {
// function replaces all 8bit html entities with question marks.
// it is used when other encoding functions are unavailable
include_once(SM_PATH . 'functions/encode/us_ascii.php');
$ret = charset_encode_us_ascii($string);
} else {
/**
* fix for yahoo users that remove all us-ascii related things
*/
$ret = $string;
}
/**
* Undo html special chars, some places (like compose form) have
* own sanitizing functions and don't need html symbols.
* Undo chars only after encoding in order to prevent conversion of
* html entities in plain text emails.
*/
if (! $htmlencode ) {
$ret = str_replace(array('&','>','<','"'),array('&','>','<','"'),$ret);
}
return( $ret );
}
/**
* Combined decoding and encoding functions
*
* If conversion is done to charset different that utf-8, unsupported symbols
* will be replaced with question marks.
* @since 1.5.1 and 1.4.4
* @param string $in_charset initial charset
* @param string $string string that has to be converted
* @param string $out_charset final charset
* @param boolean $htmlencode keep htmlspecialchars encoding
* @return string converted string
*/
function charset_convert($in_charset,$string,$out_charset,$htmlencode=true) {
$string=charset_decode($in_charset,$string,true);
$string=sqi18n_convert_entities($string);
$string=charset_encode($string,$out_charset,$htmlencode);
return $string;
}
/**
* Makes charset name suitable for decoding cycles
*
* @since 1.5.0 and 1.4.4
* @param string $charset Name of charset
* @return string $charset Adjusted name of charset
*/
function fixcharset($charset) {
/* remove minus and characters that might be used in paths from charset
* name in order to be able to use it in function names and include calls.
*/
$charset=preg_replace("/[-:.\/\\\]/",'_',$charset);
// OE ks_c_5601_1987 > cp949
$charset=str_replace('ks_c_5601_1987','cp949',$charset);
// Moz x-euc-tw > euc-tw
$charset=str_replace('x_euc','euc',$charset);
// Moz x-windows-949 > cp949
$charset=str_replace('x_windows_','cp',$charset);
// windows-125x and cp125x charsets
$charset=str_replace('windows_','cp',$charset);
// ibm > cp
$charset=str_replace('ibm','cp',$charset);
// iso-8859-8-i -> iso-8859-8
// use same cycle until I'll find differences
$charset=str_replace('iso_8859_8_i','iso_8859_8',$charset);
return $charset;
}
/**
* Set up the language to be output
* if $do_search is true, then scan the browser information
* for a possible language that we know
*
* Function sets system locale environment (LC_ALL, LANG, LANGUAGE),
* gettext translation bindings and html header information.
*
* Function returns error codes, if there is some fatal error.
* 0 = no error,
* 1 = mbstring support is not present,
* 2 = mbstring support is not present, user's translation reverted to en_US.
*
* @param string $sm_language translation used by user's interface
* @param bool $do_search use browser's preferred language detection functions. Defaults to false.
* @param bool $default set $sm_language to $squirrelmail_default_language if language detection fails or language is not set. Defaults to false.
* @return int function execution error codes.
*/
function set_up_language($sm_language, $do_search = false, $default = false) {
static $SetupAlready = 0;
global $use_gettext, $languages,
$squirrelmail_language, $squirrelmail_default_language, $default_charset,
$sm_notAlias, $username, $data_dir;
if ($SetupAlready) {
return;
}
$SetupAlready = TRUE;
sqgetGlobalVar('HTTP_ACCEPT_LANGUAGE', $accept_lang, SQ_SERVER);
/**
* If function is asked to detect preferred language
* OR squirrelmail default language is set to empty string
* AND
* squirrelmail language ($sm_language) is empty string
* (not set in user's prefs and no cookie with language info)
* AND
* browser provides list of preferred languages
* THEN
* get preferred language from HTTP_ACCEPT_LANGUAGE header
*/
if (($do_search || empty($squirrelmail_default_language)) &&
! $sm_language &&
isset($accept_lang)) {
// TODO: use more than one language, if first language is not available
// FIXME: function assumes that string contains two or more characters.
// FIXME: some languages use 5 chars
$sm_language = substr($accept_lang, 0, 2);
}
/**
* If language preference is not set OR script asks to use default language
* AND
* default squirrelmail language is not set to empty string
* THEN
* use default squirrelmail language value from configuration.
*/
if ((!$sm_language||$default) &&
! empty($squirrelmail_default_language)) {
$squirrelmail_language = $squirrelmail_default_language;
$sm_language = $squirrelmail_default_language;
}
/** provide failsafe language when detection fails */
if (! $sm_language) $sm_language='en_US';
$sm_notAlias = $sm_language;
// Catching removed translation
// System reverts to English translation if user prefs contain translation
// that is not available in $languages array
if (!isset($languages[$sm_notAlias])) {
$sm_notAlias="en_US";
}
while (isset($languages[$sm_notAlias]['ALIAS'])) {
$sm_notAlias = $languages[$sm_notAlias]['ALIAS'];
}
if ( isset($sm_language) &&
$use_gettext &&
$sm_language != '' &&
isset($languages[$sm_notAlias]['CHARSET']) ) {
sq_bindtextdomain( 'squirrelmail', SM_PATH . 'locale/' );
sq_textdomain( 'squirrelmail' );
// set codeset in order to avoid gettext charset conversions
if (function_exists('bind_textdomain_codeset')) {
// Japanese translation uses different internal charset
if ($sm_notAlias == 'ja_JP') {
bind_textdomain_codeset ('squirrelmail', 'EUC-JP');
} else {
bind_textdomain_codeset ('squirrelmail', $languages[$sm_notAlias]['CHARSET'] );
}
}
// Use LOCALE key, if it is set.
if (isset($languages[$sm_notAlias]['LOCALE'])){
$longlocale=$languages[$sm_notAlias]['LOCALE'];
} else {
$longlocale=$sm_notAlias;
}
// try setting locale
$retlocale=sq_setlocale(LC_ALL, $longlocale);
// check if locale is set and assign that locale to $longlocale
// in order to use it in putenv calls.
if (! is_bool($retlocale)) {
$longlocale=$retlocale;
} elseif (is_array($longlocale)) {
// setting of all locales failed.
// we need string instead of array used in LOCALE key.
$longlocale=$sm_notAlias;
}
if ( !((bool)ini_get('safe_mode')) &&
getenv( 'LC_ALL' ) != $longlocale ) {
putenv( "LC_ALL=$longlocale" );
putenv( "LANG=$longlocale" );
putenv( "LANGUAGE=$longlocale" );
putenv( "LC_NUMERIC=C" );
if ($sm_notAlias=='tr_TR') putenv( "LC_CTYPE=C" );
}
// Workaround for plugins that use numbers with floating point
// It might be removed if plugins use correct decimal delimiters
// according to locale settings.
setlocale(LC_NUMERIC, 'C');
// Workaround for specific Turkish strtolower/strtoupper rules.
// Many functions expect English conversion rules.
if ($sm_notAlias=='tr_TR') setlocale(LC_CTYPE,'C');
/**
* Set text direction/alignment variables
* When language environment is setup, scripts can use these globals
* without accessing $languages directly and making checks for optional
* array key.
*/
global $text_direction, $left_align, $right_align;
if (isset($languages[$sm_notAlias]['DIR']) &&
$languages[$sm_notAlias]['DIR'] == 'rtl') {
/**
* Text direction
* @global string $text_direction
*/
$text_direction='rtl';
/**
* Left alignment
* @global string $left_align
*/
$left_align='right';
/**
* Right alignment
* @global string $right_align
*/
$right_align='left';
} else {
$text_direction='ltr';
$left_align='left';
$right_align='right';
}
$squirrelmail_language = $sm_notAlias;
if ($squirrelmail_language == 'ja_JP') {
header ('Content-Type: text/html; charset=EUC-JP');
if (!function_exists('mb_internal_encoding')) {
// Error messages can't be displayed here
$error = 1;
// Revert to English if possible.
if (function_exists('setPref') && $username!='' && $data_dir!="") {
setPref($data_dir, $username, 'language', "en_US");
$error = 2;
}
// stop further execution in order not to get php errors on mb_internal_encoding().
return $error;
}
if (function_exists('mb_language')) {
mb_language('Japanese');
}
mb_internal_encoding('EUC-JP');
mb_http_output('pass');
} elseif ($squirrelmail_language == 'en_US') {
header( 'Content-Type: text/html; charset=' . $default_charset );
} else {
header( 'Content-Type: text/html; charset=' . $languages[$sm_notAlias]['CHARSET'] );
}
/**
* mbstring.func_overload fix (#929644).
*
* php mbstring extension can replace standard string functions with their multibyte
* equivalents. See http://www.php.net/ref.mbstring#mbstring.overload. This feature
* was added in php v.4.2.0
*
* Some SquirrelMail functions work with 8bit strings in bytes. If interface is forced
* to use mbstring functions and mbstring internal encoding is set to multibyte charset,
* interface can't trust regular string functions. Due to mbstring overloading design
* limits php scripts can't control this setting.
*
* This hack should fix some issues related to 8bit strings in passwords. Correct fix is
* to disable mbstring overloading. Japanese translation uses different internal encoding.
*/
if ($squirrelmail_language != 'ja_JP' &&
function_exists('mb_internal_encoding') &&
check_php_version(4,2,0) &&
(int)ini_get('mbstring.func_overload')!=0) {
mb_internal_encoding('pass');
}
}
return 0;
}
/**
* Sets default_charset variable according to the one that is used by user's translations.
*
* Function changes global $default_charset variable in order to be sure, that it
* contains charset used by user's translation. Sanity of $squirrelmail_language
* and $default_charset combination is also tested.
*
* There can be a $default_charset setting in the
* config.php file, but the user may have a different language
* selected for a user interface. This function checks the
* language selected by the user and tags the outgoing messages
* with the appropriate charset corresponding to the language
* selection. This is "more right" (tm), than just stamping the
* message blindly with the system-wide $default_charset.
*/
function set_my_charset(){
global $data_dir, $username, $default_charset, $languages, $squirrelmail_language;
$my_language = getPref($data_dir, $username, 'language');
if (!$my_language) {
$my_language = $squirrelmail_language ;
}
// Catch removed translation
if (!isset($languages[$my_language])) {
$my_language="en_US";
}
while (isset($languages[$my_language]['ALIAS'])) {
$my_language = $languages[$my_language]['ALIAS'];
}
$my_charset = $languages[$my_language]['CHARSET'];
if ($my_language!='en_US') {
$default_charset = $my_charset;
}
}
/**
* Replaces non-braking spaces inserted by some browsers with regular space
*
* This function can be used to replace non-braking space symbols

Source for file languages.php