libraries/classes/Charsets.php

   1 <?php
   2 /**
   3  * MySQL charset metadata and manipulations
   4  */
   5
   6 declare(strict_types=1);
   7
   8 namespace PhpMyAdmin;
   9
  10 use PhpMyAdmin\Charsets\Charset;
  11 use PhpMyAdmin\Charsets\Collation;
  12 use const SORT_STRING;
  13 use function array_keys;
  14 use function count;
  15 use function explode;
  16 use function is_string;
  17 use function ksort;
  18
  19 /**
  20  * Class used to manage MySQL charsets
  21  */
  22 class Charsets
  23 {
  24     /**
  25      * MySQL charsets map
  26      *
  27      * @var array
  28      */
  29     public static $mysqlCharsetMap = [
  30         'big5'         => 'big5',
  31         'cp-866'       => 'cp866',
  32         'euc-jp'       => 'ujis',
  33         'euc-kr'       => 'euckr',
  34         'gb2312'       => 'gb2312',
  35         'gbk'          => 'gbk',
  36         'iso-8859-1'   => 'latin1',
  37         'iso-8859-2'   => 'latin2',
  38         'iso-8859-7'   => 'greek',
  39         'iso-8859-8'   => 'hebrew',
  40         'iso-8859-8-i' => 'hebrew',
  41         'iso-8859-9'   => 'latin5',
  42         'iso-8859-13'  => 'latin7',
  43         'iso-8859-15'  => 'latin1',
  44         'koi8-r'       => 'koi8r',
  45         'shift_jis'    => 'sjis',
  46         'tis-620'      => 'tis620',
  47         'utf-8'        => 'utf8',
  48         'windows-1250' => 'cp1250',
  49         'windows-1251' => 'cp1251',
  50         'windows-1252' => 'latin1',
  51         'windows-1256' => 'cp1256',
  52         'windows-1257' => 'cp1257',
  53     ];
  54
  55     /**
  56      * The charset for the server
  57      *
  58      * @var Charset|null
  59      */
  60     private static $serverCharset = null;
  61
  62     /** @var array<string, Charset> */
  63     private static $charsets = [];
  64
  65     /** @var array<string, array<string, Collation>> */
  66     private static $collations = [];
  67
  68     /**
  69      * Loads charset data from the server
  70      *
  71      * @param DatabaseInterface $dbi       DatabaseInterface instance
  72      * @param bool              $disableIs Disable use of INFORMATION_SCHEMA
  73      */
  74     private static function loadCharsets(DatabaseInterface $dbi, bool $disableIs): void
  75     {
  76         /* Data already loaded */
  77         if (count(self::$charsets) > 0) {
  78             return;
  79         }
  80
  81         if ($disableIs) {
  82             $sql = 'SHOW CHARACTER SET';
  83         } else {
  84             $sql = 'SELECT `CHARACTER_SET_NAME` AS `Charset`,'
  85                 . ' `DEFAULT_COLLATE_NAME` AS `Default collation`,'
  86                 . ' `DESCRIPTION` AS `Description`,'
  87                 . ' `MAXLEN` AS `Maxlen`'
  88                 . ' FROM `information_schema`.`CHARACTER_SETS`';
  89         }
  90         $res = $dbi->query($sql);
  91
  92         self::$charsets = [];
  93         while ($row = $dbi->fetchAssoc($res)) {
  94             self::$charsets[$row['Charset']] = Charset::fromServer($row);
  95         }
  96         $dbi->freeResult($res);
  97
  98         ksort(self::$charsets, SORT_STRING);
  99     }
 100
 101     /**
 102      * Loads collation data from the server
 103      *
 104      * @param DatabaseInterface $dbi       DatabaseInterface instance
 105      * @param bool              $disableIs Disable use of INFORMATION_SCHEMA
 106      */
 107     private static function loadCollations(DatabaseInterface $dbi, bool $disableIs): void
 108     {
 109         /* Data already loaded */
 110         if (count(self::$collations) > 0) {
 111             return;
 112         }
 113
 114         if ($disableIs) {
 115             $sql = 'SHOW COLLATION';
 116         } else {
 117             $sql = 'SELECT `COLLATION_NAME` AS `Collation`,'
 118                 . ' `CHARACTER_SET_NAME` AS `Charset`,'
 119                 . ' `ID` AS `Id`,'
 120                 . ' `IS_DEFAULT` AS `Default`,'
 121                 . ' `IS_COMPILED` AS `Compiled`,'
 122                 . ' `SORTLEN` AS `Sortlen`'
 123                 . ' FROM `information_schema`.`COLLATIONS`';
 124         }
 125         $res = $dbi->query($sql);
 126
 127         self::$collations = [];
 128         while ($row = $dbi->fetchAssoc($res)) {
 129             self::$collations[$row['Charset']][$row['Collation']] = Collation::fromServer($row);
 130         }
 131         $dbi->freeResult($res);
 132
 133         foreach (array_keys(self::$collations) as $charset) {
 134             ksort(self::$collations[$charset], SORT_STRING);
 135         }
 136     }
 137
 138      /**
 139       * Get current server charset
 140       *
 141       * @param DatabaseInterface $dbi       DatabaseInterface instance
 142       * @param bool              $disableIs Disable use of INFORMATION_SCHEMA
 143       */
 144     public static function getServerCharset(DatabaseInterface $dbi, bool $disableIs): Charset
 145     {
 146         if (self::$serverCharset !== null) {
 147             return self::$serverCharset;
 148         }
 149         self::loadCharsets($dbi, $disableIs);
 150         $serverCharset = $dbi->getVariable('character_set_server');
 151         if (! is_string($serverCharset)) {// MySQL 5.7.8 fallback, issue #15614
 152             $serverCharset = $dbi->fetchValue('SELECT @@character_set_server;');
 153         }
 154         self::$serverCharset = self::$charsets[$serverCharset];
 155
 156         return self::$serverCharset;
 157     }
 158
 159     /**
 160      * Get all server charsets
 161      *
 162      * @param DatabaseInterface $dbi       DatabaseInterface instance
 163      * @param bool              $disableIs Disable use of INFORMATION_SCHEMA
 164      *
 165      * @return array
 166      */
 167     public static function getCharsets(DatabaseInterface $dbi, bool $disableIs): array
 168     {
 169         self::loadCharsets($dbi, $disableIs);
 170
 171         return self::$charsets;
 172     }
 173
 174     /**
 175      * Get all server collations
 176      *
 177      * @param DatabaseInterface $dbi       DatabaseInterface instance
 178      * @param bool              $disableIs Disable use of INFORMATION_SCHEMA
 179      *
 180      * @return array
 181      */
 182     public static function getCollations(DatabaseInterface $dbi, bool $disableIs): array
 183     {
 184         self::loadCollations($dbi, $disableIs);
 185
 186         return self::$collations;
 187     }
 188
 189     /**
 190      * @param DatabaseInterface $dbi       DatabaseInterface instance
 191      * @param bool              $disableIs Disable use of INFORMATION_SCHEMA
 192      * @param string|null       $name      Collation name
 193      */
 194     public static function findCollationByName(DatabaseInterface $dbi, bool $disableIs, ?string $name): ?Collation
 195     {
 196         $pieces = explode('_', (string) $name);
 197         if ($pieces === false || ! isset($pieces[0])) {
 198             return null;
 199         }
 200         $charset = $pieces[0];
 201         $collations = self::getCollations($dbi, $disableIs);
 202
 203         return $collations[$charset][$name] ?? null;
 204     }
 205 }