* * and Dan Kuykendall * * Handles multi-language support use SQL tables * * Copyright (C) 2000, 2001 Joseph Engo * * ------------------------------------------------------------------------ * * This library is part of the eGroupWare API * * http://www.egroupware.org/api * * ------------------------------------------------------------------------ * * This library is free software; you can redistribute it and/or modify it * * under the terms of the GNU Lesser General Public License as published by * * the Free Software Foundation; either version 2.1 of the License, * * or any later version. * * This library 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * * along with this library; if not, write to the Free Software Foundation, * * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * \**************************************************************************/ /* $Id$ */ // define the maximal length of a message_id, all message_ids have to be unique // in this length, our column is varchar 255, but addslashes might add some length if (!defined('MAX_MESSAGE_ID_LENGTH')) { define('MAX_MESSAGE_ID_LENGTH',230); } // some constanst for pre php4.3 if (!defined('PHP_SHLIB_SUFFIX')) { define('PHP_SHLIB_SUFFIX',strtoupper(substr(PHP_OS, 0,3)) == 'WIN' ? 'dll' : 'so'); } if (!defined('PHP_SHLIB_PREFIX')) { define('PHP_SHLIB_PREFIX',PHP_SHLIB_SUFFIX == 'dll' ? 'php_' : ''); } class translation { var $userlang = 'en'; var $loaded_apps = array(); var $line_rejected = array(); function translation($warnings = False) { for ($i = 1; $i <= 9; $i++) { $this->placeholders[] = '%'.$i; } $this->db = is_object($GLOBALS['phpgw']->db) ? $GLOBALS['phpgw']->db : $GLOBALS['phpgw_setup']->db; if (!isset($GLOBALS['phpgw_setup'])) { $this->system_charset = @$GLOBALS['phpgw_info']['server']['system_charset']; } else { $this->db->query("SELECT config_value FROM phpgw_config WHERE config_app='phpgwapi' AND config_name='system_charset'",__LINE__,__FILE__); if ($this->db->next_record()) { $this->system_charset = $this->db->f(0); } } // load multi-byte-string-extension if needed, and set its internal encodeing to your system_charset if ($this->system_charset && substr($this->system_charset,0,9) != 'iso-8859-1') { if ($this->mbstring = extension_loaded('mbstring') || @dl(PHP_SHLIB_PREFIX.'mbstring.'.PHP_SHLIB_SUFFIX)) { ini_set('mbstring.internal_encoding',$this->system_charset); if (ini_get('mbstring.func_overload') < 7) { if ($warnings) { echo "

Warning: Please set mbstring.func_overload = 7 in your php.ini for useing $this->system_charset as your charset !!!

\n"; } } } else { if ($warnings) { echo "

Warning: Please get and/or enable the mbstring extension in your php.ini for useing $this->system_charset as your charset, we are defaulting to iconv for now !!!

\n"; } } } } /* @function charset @abstract returns the charset to use (!$lang) or the charset of the lang-files or $lang */ function charset($lang=False) { if ($lang) { if (!isset($this->charsets[$lang])) { $this->db->query("SELECT content FROM phpgw_lang WHERE lang='$lang' AND message_id='charset' AND app_name='common'",__LINE__,__FILE__); $this->charsets[$lang] = $this->db->next_record() ? strtolower($this->db->f(0)) : 'iso-8859-1'; } return $this->charsets[$lang]; } if ($this->system_charset) // do we have a system-charset ==> return it { return $this->system_charset; } // if no translations are loaded (system-startup) use a default, else lang('charset') return !is_array(@$GLOBALS['lang']) ? 'iso-8859-1' : strtolower($this->translate('charset')); } function init() { // post-nuke and php-nuke are using $GLOBALS['lang'] too // but not as array! // this produces very strange results if (!is_array(@$GLOBALS['lang'])) { $GLOBALS['lang'] = array(); } if ($GLOBALS['phpgw_info']['user']['preferences']['common']['lang']) { $this->userlang = $GLOBALS['phpgw_info']['user']['preferences']['common']['lang']; } $this->add_app('common'); if (!count($GLOBALS['lang'])) { $this->userlang = 'en'; $this->add_app('common'); } $this->add_app($GLOBALS['phpgw_info']['flags']['currentapp']); } /*! @function translate @abstract translates a phrase and evtl. substitute some variables @returns the translation */ function translate($key, $vars=false, $not_found='*' ) { if (!is_array(@$GLOBALS['lang']) || !count($GLOBALS['lang'])) { $this->init(); } $ret = $key.$not_found; // save key if we dont find a translation if (isset($GLOBALS['lang'][$key])) { $ret = $GLOBALS['lang'][$key]; } else { $new_key = strtolower(trim(substr($key,0,MAX_MESSAGE_ID_LENGTH))); if (isset($GLOBALS['lang'][$new_key])) { // we save the original key for performance $ret = $GLOBALS['lang'][$key] = $GLOBALS['lang'][$new_key]; } } if (is_array($vars) && count($vars)) { if (count($vars) > 1) { $ret = str_replace($this->placeholders,$vars,$ret); } else { $ret = str_replace('%1',$vars[0],$ret); } } return $ret; } /*! @function add_app @abstract adds translations for an application from the database to the lang-array @syntax add_app($app,$lang=False) @param $app name of the application to add (or 'common' for the general translations) @param $lang 2-char code of the language to use or False if the users language should be used */ function add_app($app,$lang=False) { $lang = $lang ? $lang : $this->userlang; if (!isset($this->loaded_apps[$app]) || $this->loaded_apps[$app] != $lang) { $sql = "select message_id,content from phpgw_lang where lang='".$lang."' and app_name='".$app."'"; $this->db->query($sql,__LINE__,__FILE__); while ($this->db->next_record()) { $GLOBALS['lang'][strtolower ($this->db->f('message_id'))] = $this->db->f('content'); } $this->loaded_apps[$app] = $lang; } } /*! @function get_installed_langs @abstract returns a list of installed langs @returns array with 2-character lang-code as key and descriptiv lang-name as data */ function get_installed_langs() { if (!is_array($this->langs)) { $this->db->query("SELECT DISTINCT l.lang,ln.lang_name FROM phpgw_lang l,phpgw_languages ln WHERE l.lang = ln.lang_id",__LINE__,__FILE__); if (!$this->db->num_rows()) { return False; } while ($this->db->next_record()) { $this->langs[$this->db->f('lang')] = $this->db->f('lang_name'); } foreach($this->langs as $lang => $name) { $this->langs[$lang] = $this->translate($name,False,''); } } return $this->langs; } /*! @function get_installed_charsets @abstract returns a list of installed charsets @returns array with charset as key and comma-separated list of langs useing the charset as data */ function get_installed_charsets() { if (!is_array($this->charsets)) { $distinct = 'DISTINCT'; switch($this->db->Type) { case 'mssql': $distinct = ''; // cant use distinct on text columns (l.content is text) } $this->db->query("SELECT $distinct l.lang,lx.lang_name,l.content AS charset FROM phpgw_lang l,phpgw_languages lx WHERE l.lang = lx.lang_id AND l.message_id='charset'",__LINE__,__FILE__); if (!$this->db->num_rows()) { return False; } while ($this->db->next_record()) { $data = &$this->charsets[$charset = strtolower($this->db->f('charset'))]; $lang = $this->db->f('lang_name').' ('.$this->db->f('lang').')'; if ($distinct || strstr($data,$lang) === false) { $data .= ($data ? ', ' : $charset.': ').$lang; } } } return $this->charsets; } /*! @function convert @abstract converts a string $data from charset $from to charset $to @syntax convert($data,$from=False,$to=False) @param $data string or array of strings to convert @param $from charset $data is in or False if it should be detected @param $to charset to convert to or False for the system-charset @returns the converted string */ function convert($data,$from=False,$to=False) { if (is_array($data)) { foreach($data as $key => $str) { $ret[$key] = $this->convert($str,$from,$to); } return $ret; } if ($from) { $from = strtolower($from); } if ($to) { $to = strtolower($to); } if (!$from) { $from = $this->mbstring ? strtolower(mb_detect_encoding($data)) : 'iso-8859-1'; if($from == 'ascii') { $from = 'iso-8859-1'; } //echo "

autodetected charset of '$data' = '$from'

\n"; } /* php does not seem to support gb2312 but seems to be able to decode it as EUC-CN */ switch($from) { case 'gb2312': case 'gb18030': $from = 'EUC-CN'; break; case 'us-ascii': case 'macroman': $from = 'iso-8859-1'; break; } if (!$to) { $to = $this->charset(); } if ($from == $to || !$from || !$to || !$data) { return $data; } if ($from == 'iso-8859-1' && $to == 'utf-8') { return utf8_encode($data); } if ($to == 'iso-8859-1' && $from == 'utf-8') { return utf8_decode($data); } if ($this->mbstring) { return @mb_convert_encoding($data,$to,$from); } if(function_exists('iconv')) { if($from=='EUC-CN') $from='gb18030'; // the above is to workaround patch #962307 // if using EUC-CN, for iconv it strickly follow GB2312 and fail // in an email on the first Traditional/Japanese/Korean character, // but in reality when people send mails in GB2312, UMA mostly use // extended GB13000/GB18030 which allow T/Jap/Korean characters. if (($data = iconv($from,$to,$data))) { return $data; } } #die("

Can't convert from charset '$from' to '$to' without the mbstring extension !!!

"); // this is not good, not convert did succed return $data; } /*! @function install_langs @abstract installs translations for the selected langs into the database @syntax install_langs($langs,$upgrademethod='dumpold') @param $langs array of langs to install (as data NOT keys (!)) @param $upgrademethod 'dumpold' (recommended & fastest), 'addonlynew' languages, 'addmissing' phrases */ function install_langs($langs,$upgrademethod='dumpold',$only_app=False) { @set_time_limit(0); // we might need some time if (!isset($GLOBALS['phpgw_info']['server']) && $upgrademethod != 'dumpold') { $this->db->query("SELECT * FROM phpgw_config WHERE config_app='phpgwapi' AND config_name='lang_ctimes'",__LINE__,__FILE__); if ($this->db->next_record()) { $GLOBALS['phpgw_info']['server']['lang_ctimes'] = unserialize(stripslashes($this->db->f('config_value'))); } } if (!is_array($langs) || !count($langs)) { return; } $this->db->transaction_begin(); if ($upgrademethod == 'dumpold') { // dont delete the custom main- & loginscreen messages every time $this->db->query("DELETE FROM phpgw_lang WHERE app_name != 'mainscreen' AND app_name != 'loginscreen'",__LINE__,__FILE__); //echo '
Test: dumpold'; $GLOBALS['phpgw_info']['server']['lang_ctimes'] = array(); } foreach($langs as $lang) { //echo '
Working on: ' . $lang; $addlang = False; if ($upgrademethod == 'addonlynew') { //echo "
Test: addonlynew - select count(*) from phpgw_lang where lang='".$lang."'"; $this->db->query("SELECT COUNT(*) FROM phpgw_lang WHERE lang='".$lang."'",__LINE__,__FILE__); $this->db->next_record(); if ($this->db->f(0) == 0) { //echo '
Test: addonlynew - True'; $addlang = True; } } if ($addlang && $upgrademethod == 'addonlynew' || $upgrademethod != 'addonlynew') { //echo '
Test: loop above file()'; if (!is_object($GLOBALS['phpgw_setup'])) { $GLOBALS['phpgw_setup'] = CreateObject('phpgwapi.setup'); $GLOBALS['phpgw_setup']->db = $this->db; } $setup_info = $GLOBALS['phpgw_setup']->detection->get_versions(); $setup_info = $GLOBALS['phpgw_setup']->detection->get_db_versions($setup_info); $raw = array(); $apps = $only_app ? array($only_app) : array_keys($setup_info); // Visit each app/setup dir, look for a phpgw_lang file foreach($apps as $app) { $appfile = PHPGW_SERVER_ROOT . SEP . $app . SEP . 'setup' . SEP . 'phpgw_' . strtolower($lang) . '.lang'; //echo '
Checking in: ' . $app['name']; if($GLOBALS['phpgw_setup']->app_registered($app) && file_exists($appfile)) { //echo '
Including: ' . $appfile; $lines = file($appfile); foreach($lines as $line) { // explode with "\t" and removing "\n" with str_replace, needed to work with mbstring.overload=7 list($message_id,$app_name,,$content) = $_f_buffer = explode("\t",$line); $content=str_replace(array("\n","\r"),'',$content); if( count($_f_buffer) != 4 ) { $line_display = str_replace(array("\t","\n"), array("\\t","\\n"), $line); $this->line_rejected[] = array( 'appfile' => $appfile, 'line' => $line_display, ); } $message_id = substr(strtolower(chop($message_id)),0,MAX_MESSAGE_ID_LENGTH); $app_name = chop($app_name); $raw[$app_name][$message_id] = $content; } $GLOBALS['phpgw_info']['server']['lang_ctimes'][$lang][$app] = filectime($appfile); } } $charset = strtolower(@$raw['common']['charset'] ? $raw['common']['charset'] : $this->charset($lang)); //echo "

lang='$lang', charset='$charset', system_charset='$this->system_charset')

\n"; //echo "

raw($lang)=

".print_r($raw,True)."
\n"; foreach($raw as $app_name => $ids) { $app_name = $this->db->db_addslashes($app_name); foreach($ids as $message_id => $content) { if ($this->system_charset) { $content = $this->convert($content,$charset,$this->system_charset); } $message_id = $this->db->db_addslashes($message_id); $content = $this->db->db_addslashes($content); $addit = False; //echo '
APPNAME:' . $app_name . ' PHRASE:' . $message_id; if ($upgrademethod == 'addmissing') { //echo '
Test: addmissing'; $this->db->query("SELECT content,CASE WHEN app_name IN ('common') then 1 else 0 END AS in_api FROM phpgw_lang WHERE message_id='$message_id' AND lang='$lang' AND (app_name='$app_name' OR app_name='common') ORDER BY in_api DESC",__LINE__,__FILE__); if (!($row = $this->db->row(True))) { $addit = True; } else { if ($row['in_api']) // same phrase is in the api { $addit = $row['content'] != $content; // only add if not identical } $row2 = $this->db->row(True); if (!$row['in_api'] || $app_name=='common' || $row2) // phrase is alread in the db { $addit = $content != ($row2 ? $row2['content'] : $row['content']); if ($addit) // if we want to add/update it ==> delete it { $this->db->query($q="DELETE FROM phpgw_lang WHERE message_id='$message_id' AND lang='$lang' AND app_name='$app_name'",__LINE__,__FILE__); } } } } if ($addit || $upgrademethod == 'addonlynew' || $upgrademethod == 'dumpold') { if($message_id && $content) { //echo "
adding - insert into phpgw_lang values ('$message_id','$app_name','$lang','$content')"; $result = $this->db->query("INSERT INTO phpgw_lang (message_id,app_name,lang,content) VALUES('$message_id','$app_name','$lang','$content')",__LINE__,__FILE__); if ((int)$result <= 0) { echo "
Error inserting record: phpgw_lang values ('$message_id','$app_name','$lang','$content')"; } } } } } } } $this->db->transaction_commit(); // update the ctimes of the installed langsfiles for the autoloading of the lang-files // $config = CreateObject('phpgwapi.config.save_value'); $config->save_value('lang_ctimes',$GLOBALS['phpgw_info']['server']['lang_ctimes'],'phpgwapi'); } /*! @function autolaod_changed_langfiles @abstract re-loads all (!) langfiles if one langfile for the an app and the language of the user has changed */ function autoload_changed_langfiles() { //echo "

check_langs()

\n"; if ($GLOBALS['phpgw_info']['server']['lang_ctimes'] && !is_array($GLOBALS['phpgw_info']['server']['lang_ctimes'])) { $GLOBALS['phpgw_info']['server']['lang_ctimes'] = unserialize($GLOBALS['phpgw_info']['server']['lang_ctimes']); } //_debug_array($GLOBALS['phpgw_info']['server']['lang_ctimes']); $lang = $GLOBALS['phpgw_info']['user']['preferences']['common']['lang']; $apps = $GLOBALS['phpgw_info']['user']['apps']; $apps['phpgwapi'] = True; // check the api too foreach($apps as $app => $data) { $fname = PHPGW_SERVER_ROOT . "/$app/setup/phpgw_$lang.lang"; if (file_exists($fname)) { $ctime = filectime($fname); /* This is done to avoid string offset error at least in php5 */ $tmp = $GLOBALS['phpgw_info']['server']['lang_ctimes'][$lang]; $ltime = (int)$tmp[$app]; unset($tmp); //echo "checking lang='$lang', app='$app', ctime='$ctime', ltime='$ltime'
\n"; if ($ctime != $ltime) { // update all langs $installed = $this->get_installed_langs(); //echo "

install_langs(".print_r($installed,True).")

\n"; $this->install_langs($installed ? array_keys($installed) : array()); break; } } } } /* Following functions are called for app (un)install */ /*! @function get_langs @abstract return array of installed languages, e.g. array('de','en') */ function get_langs($DEBUG=False) { if($DEBUG) { echo '
get_langs(): checking db...' . "\n"; } if (!$this->langs) { $this->get_installed_langs(); } return $this->langs ? array_keys($this->langs) : array(); } /*! @function drop_langs @abstract delete all lang entries for an application, return True if langs were found @param $appname app_name whose translations you want to delete */ function drop_langs($appname,$DEBUG=False) { if($DEBUG) { echo '
drop_langs(): Working on: ' . $appname; } $this->db->query("SELECT COUNT(message_id) FROM phpgw_lang WHERE app_name='$appname'",__LINE__,__FILE__); $this->db->next_record(); if($this->db->f(0)) { $this->db->query("DELETE FROM phpgw_lang WHERE app_name='$appname'",__LINE__,__FILE__); return True; } return False; } /*! @function add_langs @abstract process an application's lang files, calling get_langs() to see what langs the admin installed already @param $appname app_name of application to process */ function add_langs($appname,$DEBUG=False,$force_langs=False) { $langs = $this->get_langs($DEBUG); if(is_array($force_langs)) { foreach($force_langs as $lang) { if (!in_array($lang,$langs)) { $langs[] = $lang; } } } if($DEBUG) { echo '
add_langs(): chose these langs: '; _debug_array($langs); } $this->install_langs($langs,'addmissing',$appname); } }