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