libraries/select_lang.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * phpMyAdmin Language Loading File
   5  *
   6  * @version $Id$
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * tries to find the language to use
  14  *
  15  * @uses    $GLOBALS['cfg']['lang']
  16  * @uses    $GLOBALS['cfg']['DefaultLang']
  17  * @uses    $GLOBALS['lang_failed_cfg']
  18  * @uses    $GLOBALS['lang_failed_cookie']
  19  * @uses    $GLOBALS['lang_failed_request']
  20  * @uses    $GLOBALS['convcharset'] to set it if not set
  21  * @uses    $_REQUEST['lang']
  22  * @uses    $_COOKIE['pma_lang']
  23  * @uses    $_SERVER['HTTP_ACCEPT_LANGUAGE']
  24  * @uses    $_SERVER['HTTP_USER_AGENT']
  25  * @uses    PMA_langSet()
  26  * @uses    PMA_langDetect()
  27  * @uses    explode()
  28  * @return  bool    success if valid lang is found, otherwise false
  29  */
  30 function PMA_langCheck()
  31 {
  32     // check forced language
  33     if (! empty($GLOBALS['cfg']['Lang'])) {
  34         if (PMA_langSet($GLOBALS['cfg']['Lang'])) {
  35             return true;
  36         } else {
  37             $GLOBALS['lang_failed_cfg'] = $GLOBALS['cfg']['Lang'];
  38         }
  39     }
  40
  41     // Don't use REQUEST in following code as it might be confused by cookies with same name
  42     // check user requested language (POST)
  43     if (! empty($_POST['lang'])) {
  44         if (PMA_langSet($_POST['lang'])) {
  45             return true;
  46         } elseif (!is_string($_POST['lang'])) {
  47             /* Faked request, don't care on localisation */
  48             $GLOBALS['lang_failed_request'] = 'Yes';
  49         } else {
  50             $GLOBALS['lang_failed_request'] = $_POST['lang'];
  51         }
  52     }
  53
  54     // check user requested language (GET)
  55     if (! empty($_GET['lang'])) {
  56         if (PMA_langSet($_GET['lang'])) {
  57             return true;
  58         } elseif (!is_string($_GET['lang'])) {
  59             /* Faked request, don't care on localisation */
  60             $GLOBALS['lang_failed_request'] = 'Yes';
  61         } else {
  62             $GLOBALS['lang_failed_request'] = $_GET['lang'];
  63         }
  64     }
  65
  66     // check previous set language
  67     if (! empty($_COOKIE['pma_lang'])) {
  68         if (PMA_langSet($_COOKIE['pma_lang'])) {
  69             return true;
  70         } elseif (!is_string($_COOKIE['lang'])) {
  71             /* Faked request, don't care on localisation */
  72             $GLOBALS['lang_failed_request'] = 'Yes';
  73         } else {
  74             $GLOBALS['lang_failed_cookie'] = $_COOKIE['pma_lang'];
  75         }
  76     }
  77
  78     // try to findout user's language by checking its HTTP_ACCEPT_LANGUAGE variable
  79     if (PMA_getenv('HTTP_ACCEPT_LANGUAGE')) {
  80         foreach (explode(',', PMA_getenv('HTTP_ACCEPT_LANGUAGE')) as $lang) {
  81             if (PMA_langDetect($lang, 1)) {
  82                 return true;
  83             }
  84         }
  85     }
  86
  87     // try to findout user's language by checking its HTTP_USER_AGENT variable
  88     if (PMA_langDetect(PMA_getenv('HTTP_USER_AGENT'), 2)) {
  89         return true;
  90     }
  91
  92     // Didn't catch any valid lang : we use the default settings
  93     if (PMA_langSet($GLOBALS['cfg']['DefaultLang'])) {
  94         return true;
  95     }
  96
  97     return false;
  98 }
  99
 100 /**
 101  * checks given lang and sets it if valid
 102  * returns true on success, otherwise flase
 103  *
 104  * @uses    $GLOBALS['available_languages'] to check $lang
 105  * @uses    $GLOBALS['lang']                to set it
 106  * @param   string  $lang   language to set
 107  * @return  bool    success
 108  */
 109 function PMA_langSet(&$lang)
 110 {
 111     if (!is_string($lang) || empty($lang) || empty($GLOBALS['available_languages'][$lang])) {
 112         return false;
 113     }
 114     $GLOBALS['lang'] = $lang;
 115     return true;
 116 }
 117
 118 /**
 119  * Analyzes some PHP environment variables to find the most probable language
 120  * that should be used
 121  *
 122  * @param   string   string to analyze
 123  * @param   integer  type of the PHP environment variable which value is $str
 124  *
 125  * @return  bool    true on success, otherwise false
 126  *
 127  * @global  $available_languages
 128  *
 129  * @access  private
 130  */
 131 function PMA_langDetect(&$str, $envType)
 132 {
 133     if (empty($str)) {
 134         return false;
 135     }
 136     if (empty($GLOBALS['available_languages'])) {
 137         return false;
 138     }
 139
 140     foreach ($GLOBALS['available_languages'] as $lang => $value) {
 141         // $envType =  1 for the 'HTTP_ACCEPT_LANGUAGE' environment variable,
 142         //             2 for the 'HTTP_USER_AGENT' one
 143         $expr = $value[0];
 144         if (strpos($expr, '[-_]') === FALSE) {
 145             $expr = str_replace('|', '([-_][[:alpha:]]{2,3})?|', $expr);
 146         }
 147         if (($envType == 1 && eregi('^(' . $expr . ')(;q=[0-9]\\.[0-9])?$', $str))
 148             || ($envType == 2 && eregi('(\(|\[|;[[:space:]])(' . $expr . ')(;|\]|\))', $str))) {
 149             if (PMA_langSet($lang)) {
 150                 return true;
 151             }
 152         }
 153     }
 154
 155     return false;
 156 } // end of the 'PMA_langDetect()' function
 157
 158 /**
 159  * Returns list of languages supported by phpMyAdmin
 160  *
 161  * @return array
 162  */
 163 function PMA_langList()
 164 {
 165     /**
 166      * All the supported languages have to be listed in the array below.
 167      * 1. The key must be the "official" ISO 639 language code and, if required,
 168      *    the dialect code. It can also contain some information about the
 169      *    charset (see the Russian case).
 170      * 2. The first of the values associated to the key is used in a regular
 171      *    expression to find some keywords corresponding to the language inside two
 172      *    environment variables.
 173      *    These values contain:
 174      *    - the "official" ISO language code and, if required, the dialect code
 175      *      too ('bu' for Bulgarian, 'fr([-_][[:alpha:]]{2})?' for all French
 176      *      dialects, 'zh[-_]tw' for Chinese traditional...), the dialect has to
 177      *      be specified first;
 178      *    - the '|' character (it means 'OR');
 179      *    - the full language name.
 180      * 3. The second value associated to the key is the name of the file to load
 181      *    without the 'inc.php' extension.
 182      * 4. The third value associated to the key is the language code as defined by
 183      *    the RFC1766.
 184      * 5. The fourth value is its native name in html entities.
 185      *
 186      * Beware that the sorting order (first values associated to keys by
 187      * alphabetical reverse order in the array) is important: 'zh-tw' (chinese
 188      * traditional) must be detected before 'zh' (chinese simplified) for
 189      * example.
 190      *
 191      */
 192     return array(
 193         'af-utf-8'    => array('af|afrikaans', 'afrikaans-utf-8', 'af', ''),
 194         'ar-utf-8'    => array('ar|arabic', 'arabic-utf-8', 'ar', '&#1575;&#1604;&#1593;&#1585;&#1576;&#1610;&#1577;'),
 195         'az-utf-8'    => array('az|azerbaijani', 'azerbaijani-utf-8', 'az', 'Az&#601;rbaycanca'),
 196         'bn-utf-8'    => array('bn|bangla', 'bangla-utf-8', 'bn', ''),
 197         'becyr-utf-8' => array('be|belarusian', 'belarusian_cyrillic-utf-8', 'be', '&#1041;&#1077;&#1083;&#1072;&#1088;&#1091;&#1089;&#1082;&#1072;&#1103;'),
 198         'belat-utf-8' => array('be[-_]lat|belarusian latin', 'belarusian_latin-utf-8', 'be-lat', 'Bie&#0322;aruskaja'),
 199         'bg-utf-8'    => array('bg|bulgarian', 'bulgarian-utf-8', 'bg', '&#1041;&#1098;&#1083;&#1075;&#1072;&#1088;&#1089;&#1082;&#1080;'),
 200         'bs-utf-8'    => array('bs|bosnian', 'bosnian-utf-8', 'bs', 'Bosanski'),
 201         'ca-utf-8'    => array('ca|catalan', 'catalan-utf-8', 'ca', 'Catal&agrave;'),
 202         'cs-utf-8'    => array('cs|czech', 'czech-utf-8', 'cs', '&#268;esky'),
 203         'da-utf-8'    => array('da|danish', 'danish-utf-8', 'da', 'Dansk'),
 204         'de-utf-8'    => array('de|german', 'german-utf-8', 'de', 'Deutsch'),
 205         'el-utf-8'    => array('el|greek',  'greek-utf-8', 'el', '&Epsilon;&lambda;&lambda;&eta;&nu;&iota;&kappa;&#940;'),
 206         'en-utf-8'    => array('en|english',  'english-utf-8', 'en', ''),
 207         'es-utf-8'    => array('es|spanish', 'spanish-utf-8', 'es', 'Espa&ntilde;ol'),
 208         'et-utf-8'    => array('et|estonian', 'estonian-utf-8', 'et', 'Eesti'),
 209         'eu-utf-8'    => array('eu|basque', 'basque-utf-8', 'eu', 'Euskara'),
 210         'fa-utf-8'    => array('fa|persian', 'persian-utf-8', 'fa', '&#1601;&#1575;&#1585;&#1587;&#1740;'),
 211         'fi-utf-8'    => array('fi|finnish', 'finnish-utf-8', 'fi', 'Suomi'),
 212         'fr-utf-8'    => array('fr|french', 'french-utf-8', 'fr', 'Fran&ccedil;ais'),
 213         'gl-utf-8'    => array('gl|galician', 'galician-utf-8', 'gl', 'Galego'),
 214         'he-utf-8'    => array('he|hebrew', 'hebrew-utf-8', 'he', '&#1506;&#1489;&#1512;&#1497;&#1514;'),
 215         'hi-utf-8'    => array('hi|hindi', 'hindi-utf-8', 'hi', '&#2361;&#2367;&#2344;&#2381;&#2342;&#2368;'),
 216         'hr-utf-8'    => array('hr|croatian', 'croatian-utf-8', 'hr', 'Hrvatski'),
 217         'hu-utf-8'    => array('hu|hungarian', 'hungarian-utf-8', 'hu', 'Magyar'),
 218         'id-utf-8'    => array('id|indonesian', 'indonesian-utf-8', 'id', 'Bahasa Indonesia'),
 219         'it-utf-8'    => array('it|italian', 'italian-utf-8', 'it', 'Italiano'),
 220         'ja-utf-8'    => array('ja|japanese', 'japanese-utf-8', 'ja', '&#26085;&#26412;&#35486;'),
 221         'ko-utf-8'    => array('ko|korean', 'korean-utf-8', 'ko', '&#54620;&#44397;&#50612;'),
 222         'ka-utf-8'    => array('ka|georgian', 'georgian-utf-8', 'ka', '&#4325;&#4304;&#4320;&#4311;&#4323;&#4314;&#4312;'),
 223         'lt-utf-8'    => array('lt|lithuanian', 'lithuanian-utf-8', 'lt', 'Lietuvi&#371;'),
 224         'lv-utf-8'    => array('lv|latvian', 'latvian-utf-8', 'lv', 'Latvie&scaron;u'),
 225         'mkcyr-utf-8' => array('mk|macedonian', 'macedonian_cyrillic-utf-8', 'mk', 'Macedonian'),
 226         'mn-utf-8'    => array('mn|mongolian', 'mongolian-utf-8', 'mn', '&#1052;&#1086;&#1085;&#1075;&#1086;&#1083;'),
 227         'ms-utf-8'    => array('ms|malay', 'malay-utf-8', 'ms', 'Bahasa Melayu'),
 228         'nl-utf-8'    => array('nl|dutch', 'dutch-utf-8', 'nl', 'Nederlands'),
 229         'no-utf-8'    => array('no|norwegian', 'norwegian-utf-8', 'no', 'Norsk'),
 230         'pl-utf-8'    => array('pl|polish', 'polish-utf-8', 'pl', 'Polski'),
 231         'ptbr-utf-8'  => array('pt[-_]br|brazilian portuguese', 'brazilian_portuguese-utf-8', 'pt-BR', 'Portugu&ecirc;s'),
 232         'pt-utf-8'    => array('pt|portuguese', 'portuguese-utf-8', 'pt', 'Portugu&ecirc;s'),
 233         'ro-utf-8'    => array('ro|romanian', 'romanian-utf-8', 'ro', 'Rom&acirc;n&#259;'),
 234         'ru-utf-8'    => array('ru|russian', 'russian-utf-8', 'ru', '&#1056;&#1091;&#1089;&#1089;&#1082;&#1080;&#1081;'),
 235         'si-utf-8'    => array('si|sinhala', 'sinhala-utf-8', 'si', '&#3523;&#3538;&#3458;&#3524;&#3517;'),
 236         'sk-utf-8'    => array('sk|slovak', 'slovak-utf-8', 'sk', 'Sloven&#269;ina'),
 237         'sl-utf-8'    => array('sl|slovenian', 'slovenian-utf-8', 'sl', 'Sloven&scaron;&#269;ina'),
 238         'sq-utf-8'    => array('sq|albanian', 'albanian-utf-8', 'sq', 'Shqip'),
 239         'srlat-utf-8' => array('sr[-_]lat|serbian latin', 'serbian_latin-utf-8', 'sr-lat', 'Srpski'),
 240         'srcyr-utf-8' => array('sr|serbian', 'serbian_cyrillic-utf-8', 'sr', '&#1057;&#1088;&#1087;&#1089;&#1082;&#1080;'),
 241         'sv-utf-8'    => array('sv|swedish', 'swedish-utf-8', 'sv', 'Svenska'),
 242         'th-utf-8'    => array('th|thai', 'thai-utf-8', 'th', '&#3616;&#3634;&#3625;&#3634;&#3652;&#3607;&#3618;'),
 243         'tr-utf-8'    => array('tr|turkish', 'turkish-utf-8', 'tr', 'T&uuml;rk&ccedil;e'),
 244         'tt-utf-8'    => array('tt|tatarish', 'tatarish-utf-8', 'tt', 'Tatar&ccedil;a'),
 245         'uk-utf-8'    => array('uk|ukrainian', 'ukrainian-utf-8', 'uk', '&#1059;&#1082;&#1088;&#1072;&#1111;&#1085;&#1089;&#1100;&#1082;&#1072;'),
 246         'zhtw-utf-8'  => array('zh[-_](tw|hk)|chinese traditional', 'chinese_traditional-utf-8', 'zh-TW', '&#20013;&#25991;'),
 247         'zh-utf-8'    => array('zh|chinese simplified', 'chinese_simplified-utf-8', 'zh', '&#20013;&#25991;'),
 248     );
 249 }
 250
 251 /**
 252  * @global string  path to the translations directory
 253  */
 254 $GLOBALS['lang_path'] = './lang/';
 255
 256 /**
 257  * @global string  interface language
 258  */
 259 $GLOBALS['lang'] = 'en-utf-8';
 260 /**
 261  * @global boolean whether loading lang from cfg failed
 262  */
 263 $GLOBALS['lang_failed_cfg'] = false;
 264 /**
 265  * @global boolean whether loading lang from cookie failed
 266  */
 267 $GLOBALS['lang_failed_cookie'] = false;
 268 /**
 269  * @global boolean whether loading lang from user request failed
 270  */
 271 $GLOBALS['lang_failed_request'] = false;
 272 /**
 273  * @global string text direction ltr or rtl
 274  */
 275 $GLOBALS['text_dir'] = 'ltr';
 276
 277 /**
 278  * @global array supported languages
 279  */
 280 $GLOBALS['available_languages'] = PMA_langList();
 281
 282 // Language filtering support
 283 if (! empty($GLOBALS['cfg']['FilterLanguages'])) {
 284     $new_lang = array();
 285     foreach ($GLOBALS['available_languages'] as $key => $val) {
 286         if (preg_match('@' . $GLOBALS['cfg']['FilterLanguages'] . '@', $key)) {
 287             $new_lang[$key] = $val;
 288         }
 289     }
 290     if (count($new_lang) > 0) {
 291         $GLOBALS['available_languages'] = $new_lang;
 292     }
 293     unset($key, $val, $new_lang);
 294 }
 295
 296 /**
 297  * first check for lang dir exists
 298  */
 299 if (! is_dir($GLOBALS['lang_path'])) {
 300     // language directory not found
 301     trigger_error('phpMyAdmin-ERROR: path not found: '
 302         . $GLOBALS['lang_path'] . ', check your language directory.',
 303         E_USER_WARNING);
 304     // and tell the user
 305     PMA_fatalError('path to languages is invalid: ' . $GLOBALS['lang_path']);
 306 }
 307
 308 /**
 309  * check for language files
 310  */
 311 foreach ($GLOBALS['available_languages'] as $each_lang_key => $each_lang) {
 312     if (! file_exists($GLOBALS['lang_path'] . $each_lang[1] . '.inc.php')) {
 313         unset($GLOBALS['available_languages'][$each_lang_key]);
 314     }
 315 }
 316 unset($each_lang_key, $each_lang);
 317
 318 /**
 319  * @global array MySQL charsets map
 320  */
 321 $GLOBALS['mysql_charset_map'] = array(
 322     'big5'         => 'big5',
 323     'cp-866'       => 'cp866',
 324     'euc-jp'       => 'ujis',
 325     'euc-kr'       => 'euckr',
 326     'gb2312'       => 'gb2312',
 327     'gbk'          => 'gbk',
 328     'iso-8859-1'   => 'latin1',
 329     'iso-8859-2'   => 'latin2',
 330     'iso-8859-7'   => 'greek',
 331     'iso-8859-8'   => 'hebrew',
 332     'iso-8859-8-i' => 'hebrew',
 333     'iso-8859-9'   => 'latin5',
 334     'iso-8859-13'  => 'latin7',
 335     'iso-8859-15'  => 'latin1',
 336     'koi8-r'       => 'koi8r',
 337     'shift_jis'    => 'sjis',
 338     'tis-620'      => 'tis620',
 339     'utf-8'        => 'utf8',
 340     'windows-1250' => 'cp1250',
 341     'windows-1251' => 'cp1251',
 342     'windows-1252' => 'latin1',
 343     'windows-1256' => 'cp1256',
 344     'windows-1257' => 'cp1257',
 345 );
 346
 347 /*
 348  * Do the work!
 349  */
 350
 351 if (empty($GLOBALS['convcharset'])) {
 352     if (isset($_COOKIE['pma_charset'])) {
 353         $GLOBALS['convcharset'] = $_COOKIE['pma_charset'];
 354     } else {
 355         // session.save_path might point to a bad folder, in which case
 356         // $GLOBALS['cfg'] would not exist
 357         $GLOBALS['convcharset'] = isset($GLOBALS['cfg']['DefaultCharset']) ? $GLOBALS['cfg']['DefaultCharset'] : 'utf-8';
 358     }
 359 }
 360
 361 if (! PMA_langCheck()) {
 362     // fallback language
 363     $fall_back_lang = 'en-utf-8';
 364     $line = __LINE__;
 365     if (! PMA_langSet($fall_back_lang)) {
 366         trigger_error('phpMyAdmin-ERROR: invalid lang code: '
 367             . __FILE__ . '#' . $line . ', check hard coded fall back language.',
 368             E_USER_WARNING);
 369         // stop execution
 370         // and tell the user that his choosen language is invalid
 371         PMA_fatalError('Could not load any language, please check your language settings and folder.');
 372     }
 373 }
 374
 375 // Defines the associated filename and load the translation
 376 $lang_file = $GLOBALS['lang_path'] . $GLOBALS['available_languages'][$GLOBALS['lang']][1] . '.inc.php';
 377 require_once $lang_file;
 378
 379 // now, that we have loaded the language strings we can send the errors
 380 if ($GLOBALS['lang_failed_cfg']) {
 381     trigger_error(
 382         sprintf($GLOBALS['strLanguageUnknown'],
 383             htmlspecialchars($GLOBALS['lang_failed_cfg'])),
 384         E_USER_ERROR);
 385 }
 386 if ($GLOBALS['lang_failed_cookie']) {
 387     trigger_error(
 388         sprintf($GLOBALS['strLanguageUnknown'],
 389             htmlspecialchars($GLOBALS['lang_failed_cookie'])),
 390         E_USER_ERROR);
 391 }
 392 if ($GLOBALS['lang_failed_request']) {
 393     trigger_error(
 394         sprintf($GLOBALS['strLanguageUnknown'],
 395             htmlspecialchars($GLOBALS['lang_failed_request'])),
 396         E_USER_ERROR);
 397 }
 398
 399 unset($line, $fall_back_lang,
 400     $GLOBALS['lang_failed_cfg'], $GLOBALS['lang_failed_cookie'], $GLOBALS['ang_failed_request'], $GLOBALS['strLanguageUnknown']);
 401 ?>