phpmyadmin/libraries/charset_conversion.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Charset conversion functions.
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 define('PMA_CHARSET_NONE', 0);
  13 define('PMA_CHARSET_ICONV', 1);
  14 define('PMA_CHARSET_RECODE', 2);
  15 define('PMA_CHARSET_ICONV_AIX', 3);
  16 define('PMA_CHARSET_MB', 4);
  17
  18 if (! isset($GLOBALS['cfg']['RecodingEngine'])) {
  19     $GLOBALS['cfg']['RecodingEngine'] = '';
  20 }
  21 // Finally detect which function we will use:
  22 if ($GLOBALS['cfg']['RecodingEngine'] == 'iconv') {
  23     if (@function_exists('iconv')) {
  24         $PMA_recoding_engine = PMA_getIconvRecodingEngine();
  25     } else {
  26         $PMA_recoding_engine = PMA_CHARSET_NONE;
  27         PMA_warnMissingExtension('iconv');
  28     }
  29 } elseif ($GLOBALS['cfg']['RecodingEngine'] == 'recode') {
  30     if (@function_exists('recode_string')) {
  31         $PMA_recoding_engine = PMA_CHARSET_RECODE;
  32     } else {
  33         $PMA_recoding_engine = PMA_CHARSET_NONE;
  34         PMA_warnMissingExtension('recode');
  35     }
  36 } elseif ($GLOBALS['cfg']['RecodingEngine'] == 'mb') {
  37     if (@function_exists('mb_convert_encoding')) {
  38         $PMA_recoding_engine = PMA_CHARSET_MB;
  39     } else {
  40         $PMA_recoding_engine = PMA_CHARSET_NONE;
  41         PMA_warnMissingExtension('mbstring');
  42     }
  43 } elseif ($GLOBALS['cfg']['RecodingEngine'] == 'auto') {
  44     /*
  45      * We also need to verify iconv works, see
  46      * https://github.com/phpmyadmin/phpmyadmin/issues/11787/
  47      * and
  48      * https://bugs.php.net/bug.php?id=44096
  49      */
  50     if (@function_exists('iconv') && @iconv_strlen('', 'cp1250') !== false) {
  51         $PMA_recoding_engine = PMA_getIconvRecodingEngine();
  52     } elseif (@function_exists('recode_string')) {
  53         $PMA_recoding_engine = PMA_CHARSET_RECODE;
  54     } elseif (@function_exists('mb_convert_encoding')) {
  55         $PMA_recoding_engine = PMA_CHARSET_MB;
  56     } else {
  57         $PMA_recoding_engine = PMA_CHARSET_NONE;
  58     }
  59 } else {
  60     $PMA_recoding_engine = PMA_CHARSET_NONE;
  61 }
  62
  63 /* Load AIX iconv wrapper if needed */
  64 if ($PMA_recoding_engine == PMA_CHARSET_ICONV_AIX) {
  65     include_once './libraries/iconv_wrapper.lib.php';
  66 }
  67
  68 /**
  69  * Determines the correct recoding engine to use
  70  *
  71  * @return int $PMA_recoding_engine
  72  *
  73  * @access  public
  74  *
  75  */
  76 function PMA_getIconvRecodingEngine()
  77 {
  78     if ((@stristr(PHP_OS, 'AIX'))
  79         && (@strcasecmp(ICONV_IMPL, 'unknown') == 0)
  80         && (@strcasecmp(ICONV_VERSION, 'unknown') == 0)
  81     ) {
  82         return PMA_CHARSET_ICONV_AIX;
  83     } else {
  84         return PMA_CHARSET_ICONV;
  85     }
  86 }
  87
  88 /**
  89  * Converts encoding of text according to parameters with detected
  90  * conversion function.
  91  *
  92  * @param string $src_charset  source charset
  93  * @param string $dest_charset target charset
  94  * @param string $what         what to convert
  95  *
  96  * @return string   converted text
  97  *
  98  * @access  public
  99  *
 100  */
 101 function PMA_convertString($src_charset, $dest_charset, $what)
 102 {
 103     if ($src_charset == $dest_charset) {
 104         return $what;
 105     }
 106     switch ($GLOBALS['PMA_recoding_engine']) {
 107     case PMA_CHARSET_RECODE:
 108         return recode_string($src_charset . '..'  . $dest_charset, $what);
 109     case PMA_CHARSET_ICONV:
 110         return iconv(
 111             $src_charset, $dest_charset . $GLOBALS['cfg']['IconvExtraParams'], $what
 112         );
 113     case PMA_CHARSET_ICONV_AIX:
 114         return PMA_convertAIXIconv(
 115             $src_charset, $dest_charset . $GLOBALS['cfg']['IconvExtraParams'], $what
 116         );
 117     case PMA_CHARSET_MB:
 118         return mb_convert_encoding(
 119             $what, $dest_charset, $src_charset
 120         );
 121     default:
 122         return $what;
 123     }
 124 } //  end of the "PMA_convertString()" function
 125