diff options
| author | Charles Cabergs <me@cacharle.xyz> | 2020-07-27 10:05:23 +0200 |
|---|---|---|
| committer | Charles Cabergs <me@cacharle.xyz> | 2020-07-27 10:05:23 +0200 |
| commit | 5bf66662a9bdd62c5bccab15e607cd95cfb8fcab (patch) | |
| tree | 39a1a4629749056191c05dfd899f931701b7acf3 /srcs/phpmyadmin/libraries/classes/DatabaseInterface.php | |
| parent | 5afd237bbd22028b85532b8c0b3fcead49a00764 (diff) | |
| download | ft_server-5bf66662a9bdd62c5bccab15e607cd95cfb8fcab.tar.gz ft_server-5bf66662a9bdd62c5bccab15e607cd95cfb8fcab.tar.bz2 ft_server-5bf66662a9bdd62c5bccab15e607cd95cfb8fcab.zip | |
Removed wordpress and phpmyadmin, my server doesn't handle it well and it brings shame on my famillyHEADmaster
Diffstat (limited to 'srcs/phpmyadmin/libraries/classes/DatabaseInterface.php')
| -rw-r--r-- | srcs/phpmyadmin/libraries/classes/DatabaseInterface.php | 3187 |
1 files changed, 0 insertions, 3187 deletions
diff --git a/srcs/phpmyadmin/libraries/classes/DatabaseInterface.php b/srcs/phpmyadmin/libraries/classes/DatabaseInterface.php deleted file mode 100644 index 3e12302..0000000 --- a/srcs/phpmyadmin/libraries/classes/DatabaseInterface.php +++ /dev/null @@ -1,3187 +0,0 @@ -<?php -/* vim: set expandtab sw=4 ts=4 sts=4: */ -/** - * Main interface for database interactions - * - * @package PhpMyAdmin-DBI - */ -declare(strict_types=1); - -namespace PhpMyAdmin; - -use mysqli_result; -use PhpMyAdmin\Database\DatabaseList; -use PhpMyAdmin\Dbi\DbiExtension; -use PhpMyAdmin\Dbi\DbiMysqli; -use PhpMyAdmin\SqlParser\Context; - -/** - * Main interface for database interactions - * - * @package PhpMyAdmin-DBI - */ -class DatabaseInterface -{ - /** - * Force STORE_RESULT method, ignored by classic MySQL. - */ - public const QUERY_STORE = 1; - /** - * Do not read whole query. - */ - public const QUERY_UNBUFFERED = 2; - /** - * Get session variable. - */ - public const GETVAR_SESSION = 1; - /** - * Get global variable. - */ - public const GETVAR_GLOBAL = 2; - - /** - * User connection. - */ - public const CONNECT_USER = 0x100; - /** - * Control user connection. - */ - public const CONNECT_CONTROL = 0x101; - /** - * Auxiliary connection. - * - * Used for example for replication setup. - */ - public const CONNECT_AUXILIARY = 0x102; - - /** - * @var DbiExtension - */ - private $_extension; - - /** - * Opened database links - * - * @var array - */ - private $_links; - - /** - * @var array Table data cache - */ - private $_table_cache; - - /** - * @var array Current user and host cache - */ - private $_current_user; - - /** - * @var null|string lower_case_table_names value cache - */ - private $_lower_case_table_names = null; - - /** - * @var boolean Whether connection is MariaDB - */ - private $_is_mariadb = false; - /** - * @var boolean Whether connection is Percona - */ - private $_is_percona = false; - /** - * @var integer Server version as number - */ - private $_version_int = 55000; - /** - * @var string Server version - */ - private $_version_str = '5.50.0'; - /** - * @var string Server version comment - */ - private $_version_comment = ''; - - /** - * @var Types MySQL types data - */ - public $types; - - /** - * @var Relation - */ - private $relation; - - /** - * Constructor - * - * @param DbiExtension $ext Object to be used for database queries - */ - public function __construct(DbiExtension $ext) - { - $this->_extension = $ext; - $this->_links = []; - if (defined('TESTSUITE')) { - $this->_links[DatabaseInterface::CONNECT_USER] = 1; - $this->_links[DatabaseInterface::CONNECT_CONTROL] = 2; - } - $this->_table_cache = []; - $this->_current_user = []; - $this->types = new Types($this); - $this->relation = new Relation($this); - } - - /** - * Checks whether database extension is loaded - * - * @param string $extension mysql extension to check - * - * @return bool - */ - public static function checkDbExtension(string $extension = 'mysqli'): bool - { - return function_exists($extension . '_connect'); - } - - /** - * runs a query - * - * @param string $query SQL query to execute - * @param mixed $link optional database link to use - * @param int $options optional query options - * @param bool $cache_affected_rows whether to cache affected rows - * - * @return mixed - */ - public function query( - string $query, - $link = DatabaseInterface::CONNECT_USER, - int $options = 0, - bool $cache_affected_rows = true - ) { - $res = $this->tryQuery($query, $link, $options, $cache_affected_rows) - or Util::mysqlDie($this->getError($link), $query); - - return $res; - } - - /** - * Get a cached value from table cache. - * - * @param array $contentPath Array of the name of the target value - * @param mixed $default Return value on cache miss - * - * @return mixed cached value or default - */ - public function getCachedTableContent(array $contentPath, $default = null) - { - return Util::getValueByKey($this->_table_cache, $contentPath, $default); - } - - /** - * Set an item in table cache using dot notation. - * - * @param array $contentPath Array with the target path - * @param mixed $value Target value - * - * @return void - */ - public function cacheTableContent(array $contentPath, $value): void - { - $loc = &$this->_table_cache; - - if (! isset($contentPath)) { - $loc = $value; - return; - } - - while (count($contentPath) > 1) { - $key = array_shift($contentPath); - - // If the key doesn't exist at this depth, we will just create an empty - // array to hold the next value, allowing us to create the arrays to hold - // final values at the correct depth. Then we'll keep digging into the - // array. - if (! isset($loc[$key]) || ! is_array($loc[$key])) { - $loc[$key] = []; - } - $loc = &$loc[$key]; - } - - $loc[array_shift($contentPath)] = $value; - } - - /** - * Clear the table cache. - * - * @return void - */ - public function clearTableCache(): void - { - $this->_table_cache = []; - } - - /** - * Caches table data so Table does not require to issue - * SHOW TABLE STATUS again - * - * @param array $tables information for tables of some databases - * @param string|bool $table table name - * - * @return void - */ - private function _cacheTableData(array $tables, $table): void - { - // Note: I don't see why we would need array_merge_recursive() here, - // as it creates double entries for the same table (for example a double - // entry for Comment when changing the storage engine in Operations) - // Note 2: Instead of array_merge(), simply use the + operator because - // array_merge() renumbers numeric keys starting with 0, therefore - // we would lose a db name that consists only of numbers - - foreach ($tables as $one_database => $its_tables) { - if (isset($this->_table_cache[$one_database])) { - // the + operator does not do the intended effect - // when the cache for one table already exists - if ($table - && isset($this->_table_cache[$one_database][$table]) - ) { - unset($this->_table_cache[$one_database][$table]); - } - $this->_table_cache[$one_database] - += $tables[$one_database]; - } else { - $this->_table_cache[$one_database] = $tables[$one_database]; - } - } - } - - /** - * Stores query data into session data for debugging purposes - * - * @param string $query Query text - * @param mixed $link link type - * @param object|boolean $result Query result - * @param integer|float $time Time to execute query - * - * @return void - */ - private function _dbgQuery(string $query, $link, $result, $time): void - { - $dbgInfo = []; - $error_message = $this->getError($link); - if ($result == false && is_string($error_message)) { - $dbgInfo['error'] - = '<span class="color_red">' - . htmlspecialchars($error_message) . '</span>'; - } - $dbgInfo['query'] = htmlspecialchars($query); - $dbgInfo['time'] = $time; - // Get and slightly format backtrace, this is used - // in the javascript console. - // Strip call to _dbgQuery - $dbgInfo['trace'] = Error::processBacktrace( - array_slice(debug_backtrace(), 1) - ); - $dbgInfo['hash'] = md5($query); - - $_SESSION['debug']['queries'][] = $dbgInfo; - } - - /** - * runs a query and returns the result - * - * @param string $query query to run - * @param mixed $link link type - * @param integer $options query options - * @param bool $cache_affected_rows whether to cache affected row - * - * @return mixed - */ - public function tryQuery( - string $query, - $link = DatabaseInterface::CONNECT_USER, - int $options = 0, - bool $cache_affected_rows = true - ) { - $debug = isset($GLOBALS['cfg']['DBG']) ? $GLOBALS['cfg']['DBG']['sql'] : false; - if (! isset($this->_links[$link])) { - return false; - } - - if ($debug) { - $time = microtime(true); - } - - $result = $this->_extension->realQuery($query, $this->_links[$link], $options); - - if ($cache_affected_rows) { - $GLOBALS['cached_affected_rows'] = $this->affectedRows($link, false); - } - - if ($debug) { - $time = microtime(true) - $time; - $this->_dbgQuery($query, $link, $result, $time); - if ($GLOBALS['cfg']['DBG']['sqllog']) { - $warningsCount = ''; - if (($options & DatabaseInterface::QUERY_STORE) == DatabaseInterface::QUERY_STORE) { - if (isset($this->_links[$link]->warning_count)) { - $warningsCount = $this->_links[$link]->warning_count; - } - } - - openlog('phpMyAdmin', LOG_NDELAY | LOG_PID, LOG_USER); - - syslog( - LOG_INFO, - 'SQL[' . basename($_SERVER['SCRIPT_NAME']) . ']: ' - . sprintf('%0.3f', $time) . '(W:' . $warningsCount . ') > ' . $query - ); - closelog(); - } - } - - if ($result !== false && Tracker::isActive()) { - Tracker::handleQuery($query); - } - - return $result; - } - - /** - * Run multi query statement and return results - * - * @param string $multiQuery multi query statement to execute - * @param int $linkIndex index of the opened database link - * - * @return mysqli_result[]|boolean (false) - */ - public function tryMultiQuery( - string $multiQuery = '', - $linkIndex = DatabaseInterface::CONNECT_USER - ) { - if (! isset($this->_links[$linkIndex])) { - return false; - } - return $this->_extension->realMultiQuery($this->_links[$linkIndex], $multiQuery); - } - - /** - * returns array with table names for given db - * - * @param string $database name of database - * @param mixed $link mysql link resource|object - * - * @return array tables names - */ - public function getTables(string $database, $link = DatabaseInterface::CONNECT_USER): array - { - $tables = $this->fetchResult( - 'SHOW TABLES FROM ' . Util::backquote($database) . ';', - null, - 0, - $link, - self::QUERY_STORE - ); - if ($GLOBALS['cfg']['NaturalOrder']) { - usort($tables, 'strnatcasecmp'); - } - return $tables; - } - - - /** - * returns - * - * @param string $database name of database - * @param array $tables list of tables to search for for relations - * @param int $link mysql link resource|object - * - * @return array array of found foreign keys - */ - public function getForeignKeyConstrains(string $database, array $tables, $link = DatabaseInterface::CONNECT_USER): array - { - $tablesListForQuery = ''; - foreach ($tables as $table) { - $tablesListForQuery .= "'" . $this->escapeString($table) . "',"; - } - $tablesListForQuery = rtrim($tablesListForQuery, ','); - - $foreignKeyConstrains = $this->fetchResult( - "SELECT" - . " TABLE_NAME," - . " COLUMN_NAME," - . " REFERENCED_TABLE_NAME," - . " REFERENCED_COLUMN_NAME" - . " FROM information_schema.key_column_usage" - . " WHERE referenced_table_name IS NOT NULL" - . " AND TABLE_SCHEMA = '" . $this->escapeString($database) . "'" - . " AND TABLE_NAME IN (" . $tablesListForQuery . ")" - . " AND REFERENCED_TABLE_NAME IN (" . $tablesListForQuery . ");", - null, - null, - $link, - self::QUERY_STORE - ); - return $foreignKeyConstrains; - } - - /** - * returns a segment of the SQL WHERE clause regarding table name and type - * - * @param array|string $table table(s) - * @param boolean $tbl_is_group $table is a table group - * @param string $table_type whether table or view - * - * @return string a segment of the WHERE clause - */ - private function _getTableCondition( - $table, - bool $tbl_is_group, - ?string $table_type - ): string { - // get table information from information_schema - if ($table) { - if (is_array($table)) { - $sql_where_table = 'AND t.`TABLE_NAME` ' - . Util::getCollateForIS() . ' IN (\'' - . implode( - '\', \'', - array_map( - [ - $this, - 'escapeString', - ], - $table - ) - ) - . '\')'; - } elseif (true === $tbl_is_group) { - $sql_where_table = 'AND t.`TABLE_NAME` LIKE \'' - . Util::escapeMysqlWildcards( - $this->escapeString($table) - ) - . '%\''; - } else { - $sql_where_table = 'AND t.`TABLE_NAME` ' - . Util::getCollateForIS() . ' = \'' - . $this->escapeString($table) . '\''; - } - } else { - $sql_where_table = ''; - } - - if ($table_type) { - if ($table_type == 'view') { - $sql_where_table .= " AND t.`TABLE_TYPE` NOT IN ('BASE TABLE', 'SYSTEM VERSIONED')"; - } elseif ($table_type == 'table') { - $sql_where_table .= " AND t.`TABLE_TYPE` IN ('BASE TABLE', 'SYSTEM VERSIONED')"; - } - } - return $sql_where_table; - } - - /** - * returns the beginning of the SQL statement to fetch the list of tables - * - * @param string[] $this_databases databases to list - * @param string $sql_where_table additional condition - * - * @return string the SQL statement - */ - private function _getSqlForTablesFull($this_databases, string $sql_where_table): string - { - return ' - SELECT *, - `TABLE_SCHEMA` AS `Db`, - `TABLE_NAME` AS `Name`, - `TABLE_TYPE` AS `TABLE_TYPE`, - `ENGINE` AS `Engine`, - `ENGINE` AS `Type`, - `VERSION` AS `Version`, - `ROW_FORMAT` AS `Row_format`, - `TABLE_ROWS` AS `Rows`, - `AVG_ROW_LENGTH` AS `Avg_row_length`, - `DATA_LENGTH` AS `Data_length`, - `MAX_DATA_LENGTH` AS `Max_data_length`, - `INDEX_LENGTH` AS `Index_length`, - `DATA_FREE` AS `Data_free`, - `AUTO_INCREMENT` AS `Auto_increment`, - `CREATE_TIME` AS `Create_time`, - `UPDATE_TIME` AS `Update_time`, - `CHECK_TIME` AS `Check_time`, - `TABLE_COLLATION` AS `Collation`, - `CHECKSUM` AS `Checksum`, - `CREATE_OPTIONS` AS `Create_options`, - `TABLE_COMMENT` AS `Comment` - FROM `information_schema`.`TABLES` t - WHERE `TABLE_SCHEMA` ' . Util::getCollateForIS() . ' - IN (\'' . implode("', '", $this_databases) . '\') - ' . $sql_where_table; - } - - /** - * returns array of all tables in given db or dbs - * this function expects unquoted names: - * RIGHT: my_database - * WRONG: `my_database` - * WRONG: my\_database - * if $tbl_is_group is true, $table is used as filter for table names - * - * <code> - * $dbi->getTablesFull('my_database'); - * $dbi->getTablesFull('my_database', 'my_table')); - * $dbi->getTablesFull('my_database', 'my_tables_', true)); - * </code> - * - * @param string $database database - * @param string|array $table table name(s) - * @param boolean $tbl_is_group $table is a table group - * @param integer $limit_offset zero-based offset for the count - * @param boolean|integer $limit_count number of tables to return - * @param string $sort_by table attribute to sort by - * @param string $sort_order direction to sort (ASC or DESC) - * @param string $table_type whether table or view - * @param mixed $link link type - * - * @todo move into Table - * - * @return array list of tables in given db(s) - */ - public function getTablesFull( - string $database, - $table = '', - bool $tbl_is_group = false, - int $limit_offset = 0, - $limit_count = false, - string $sort_by = 'Name', - string $sort_order = 'ASC', - ?string $table_type = null, - $link = DatabaseInterface::CONNECT_USER - ): array { - if (true === $limit_count) { - $limit_count = $GLOBALS['cfg']['MaxTableList']; - } - // prepare and check parameters - if (! is_array($database)) { - $databases = [$database]; - } else { - $databases = $database; - } - - $tables = []; - - if (! $GLOBALS['cfg']['Server']['DisableIS']) { - $sql_where_table = $this->_getTableCondition( - $table, - $tbl_is_group, - $table_type - ); - - // for PMA bc: - // `SCHEMA_FIELD_NAME` AS `SHOW_TABLE_STATUS_FIELD_NAME` - // - // on non-Windows servers, - // added BINARY in the WHERE clause to force a case sensitive - // comparison (if we are looking for the db Aa we don't want - // to find the db aa) - $this_databases = array_map( - [ - $this, - 'escapeString', - ], - $databases - ); - - $sql = $this->_getSqlForTablesFull($this_databases, $sql_where_table); - - // Sort the tables - $sql .= " ORDER BY $sort_by $sort_order"; - - if ($limit_count) { - $sql .= ' LIMIT ' . $limit_count . ' OFFSET ' . $limit_offset; - } - - $tables = $this->fetchResult( - $sql, - [ - 'TABLE_SCHEMA', - 'TABLE_NAME', - ], - null, - $link - ); - - if ($sort_by == 'Name' && $GLOBALS['cfg']['NaturalOrder']) { - // here, the array's first key is by schema name - foreach ($tables as $one_database_name => $one_database_tables) { - uksort($one_database_tables, 'strnatcasecmp'); - - if ($sort_order == 'DESC') { - $one_database_tables = array_reverse($one_database_tables); - } - $tables[$one_database_name] = $one_database_tables; - } - } elseif ($sort_by == 'Data_length') { - // Size = Data_length + Index_length - foreach ($tables as $one_database_name => $one_database_tables) { - uasort( - $one_database_tables, - function ($a, $b) { - $aLength = $a['Data_length'] + $a['Index_length']; - $bLength = $b['Data_length'] + $b['Index_length']; - return $aLength <=> $bLength; - } - ); - - if ($sort_order == 'DESC') { - $one_database_tables = array_reverse($one_database_tables); - } - $tables[$one_database_name] = $one_database_tables; - } - } - } // end (get information from table schema) - - // If permissions are wrong on even one database directory, - // information_schema does not return any table info for any database - // this is why we fall back to SHOW TABLE STATUS even for MySQL >= 50002 - if (empty($tables)) { - foreach ($databases as $each_database) { - if ($table || (true === $tbl_is_group) || ! empty($table_type)) { - $sql = 'SHOW TABLE STATUS FROM ' - . Util::backquote($each_database) - . ' WHERE'; - $needAnd = false; - if ($table || (true === $tbl_is_group)) { - if (is_array($table)) { - $sql .= ' `Name` IN (\'' - . implode( - '\', \'', - array_map( - [ - $this, - 'escapeString', - ], - $table, - $link - ) - ) . '\')'; - } else { - $sql .= " `Name` LIKE '" - . Util::escapeMysqlWildcards( - $this->escapeString($table, $link) - ) - . "%'"; - } - $needAnd = true; - } - if (! empty($table_type)) { - if ($needAnd) { - $sql .= " AND"; - } - if ($table_type == 'view') { - $sql .= " `Comment` = 'VIEW'"; - } elseif ($table_type == 'table') { - $sql .= " `Comment` != 'VIEW'"; - } - } - } else { - $sql = 'SHOW TABLE STATUS FROM ' - . Util::backquote($each_database); - } - - $each_tables = $this->fetchResult($sql, 'Name', null, $link); - - // Sort naturally if the config allows it and we're sorting - // the Name column. - if ($sort_by == 'Name' && $GLOBALS['cfg']['NaturalOrder']) { - uksort($each_tables, 'strnatcasecmp'); - - if ($sort_order == 'DESC') { - $each_tables = array_reverse($each_tables); - } - } else { - // Prepare to sort by creating array of the selected sort - // value to pass to array_multisort - - // Size = Data_length + Index_length - if ($sort_by == 'Data_length') { - foreach ($each_tables as $table_name => $table_data) { - ${$sort_by}[$table_name] = strtolower( - $table_data['Data_length'] - + $table_data['Index_length'] - ); - } - } else { - foreach ($each_tables as $table_name => $table_data) { - ${$sort_by}[$table_name] - = strtolower($table_data[$sort_by]); - } - } - - if (! empty($$sort_by)) { - if ($sort_order == 'DESC') { - array_multisort($$sort_by, SORT_DESC, $each_tables); - } else { - array_multisort($$sort_by, SORT_ASC, $each_tables); - } - } - - // cleanup the temporary sort array - unset($$sort_by); - } - - if ($limit_count) { - $each_tables = array_slice( - $each_tables, - $limit_offset, - $limit_count - ); - } - - foreach ($each_tables as $table_name => $each_table) { - if (! isset($each_tables[$table_name]['Type']) - && isset($each_tables[$table_name]['Engine']) - ) { - // pma BC, same parts of PMA still uses 'Type' - $each_tables[$table_name]['Type'] - =& $each_tables[$table_name]['Engine']; - } elseif (! isset($each_tables[$table_name]['Engine']) - && isset($each_tables[$table_name]['Type']) - ) { - // old MySQL reports Type, newer MySQL reports Engine - $each_tables[$table_name]['Engine'] - =& $each_tables[$table_name]['Type']; - } - - // Compatibility with INFORMATION_SCHEMA output - $each_tables[$table_name]['TABLE_SCHEMA'] - = $each_database; - $each_tables[$table_name]['TABLE_NAME'] - =& $each_tables[$table_name]['Name']; - $each_tables[$table_name]['ENGINE'] - =& $each_tables[$table_name]['Engine']; - $each_tables[$table_name]['VERSION'] - =& $each_tables[$table_name]['Version']; - $each_tables[$table_name]['ROW_FORMAT'] - =& $each_tables[$table_name]['Row_format']; - $each_tables[$table_name]['TABLE_ROWS'] - =& $each_tables[$table_name]['Rows']; - $each_tables[$table_name]['AVG_ROW_LENGTH'] - =& $each_tables[$table_name]['Avg_row_length']; - $each_tables[$table_name]['DATA_LENGTH'] - =& $each_tables[$table_name]['Data_length']; - $each_tables[$table_name]['MAX_DATA_LENGTH'] - =& $each_tables[$table_name]['Max_data_length']; - $each_tables[$table_name]['INDEX_LENGTH'] - =& $each_tables[$table_name]['Index_length']; - $each_tables[$table_name]['DATA_FREE'] - =& $each_tables[$table_name]['Data_free']; - $each_tables[$table_name]['AUTO_INCREMENT'] - =& $each_tables[$table_name]['Auto_increment']; - $each_tables[$table_name]['CREATE_TIME'] - =& $each_tables[$table_name]['Create_time']; - $each_tables[$table_name]['UPDATE_TIME'] - =& $each_tables[$table_name]['Update_time']; - $each_tables[$table_name]['CHECK_TIME'] - =& $each_tables[$table_name]['Check_time']; - $each_tables[$table_name]['TABLE_COLLATION'] - =& $each_tables[$table_name]['Collation']; - $each_tables[$table_name]['CHECKSUM'] - =& $each_tables[$table_name]['Checksum']; - $each_tables[$table_name]['CREATE_OPTIONS'] - =& $each_tables[$table_name]['Create_options']; - $each_tables[$table_name]['TABLE_COMMENT'] - =& $each_tables[$table_name]['Comment']; - - if (strtoupper($each_tables[$table_name]['Comment']) === 'VIEW' - && $each_tables[$table_name]['Engine'] == null - ) { - $each_tables[$table_name]['TABLE_TYPE'] = 'VIEW'; - } elseif ($each_database == 'information_schema') { - $each_tables[$table_name]['TABLE_TYPE'] = 'SYSTEM VIEW'; - } else { - /** - * @todo difference between 'TEMPORARY' and 'BASE TABLE' - * but how to detect? - */ - $each_tables[$table_name]['TABLE_TYPE'] = 'BASE TABLE'; - } - } - - $tables[$each_database] = $each_tables; - } - } - - // cache table data - // so Table does not require to issue SHOW TABLE STATUS again - $this->_cacheTableData($tables, $table); - - if (is_array($database)) { - return $tables; - } - - if (isset($tables[$database])) { - return $tables[$database]; - } - - if (isset($tables[mb_strtolower($database)])) { - // on windows with lower_case_table_names = 1 - // MySQL returns - // with SHOW DATABASES or information_schema.SCHEMATA: `Test` - // but information_schema.TABLES gives `test` - // see https://github.com/phpmyadmin/phpmyadmin/issues/8402 - return $tables[mb_strtolower($database)]; - } - - return $tables; - } - - /** - * Get VIEWs in a particular database - * - * @param string $db Database name to look in - * - * @return array Set of VIEWs inside the database - */ - public function getVirtualTables(string $db): array - { - $tables_full = $this->getTablesFull($db); - $views = []; - - foreach ($tables_full as $table => $tmp) { - $_table = $this->getTable($db, (string) $table); - if ($_table->isView()) { - $views[] = $table; - } - } - - return $views; - } - - - /** - * returns array with databases containing extended infos about them - * - * @param string $database database - * @param boolean $force_stats retrieve stats also for MySQL < 5 - * @param integer $link link type - * @param string $sort_by column to order by - * @param string $sort_order ASC or DESC - * @param integer $limit_offset starting offset for LIMIT - * @param bool|int $limit_count row count for LIMIT or true - * for $GLOBALS['cfg']['MaxDbList'] - * - * @todo move into ListDatabase? - * - * @return array - */ - public function getDatabasesFull( - ?string $database = null, - bool $force_stats = false, - $link = DatabaseInterface::CONNECT_USER, - string $sort_by = 'SCHEMA_NAME', - string $sort_order = 'ASC', - int $limit_offset = 0, - $limit_count = false - ): array { - $sort_order = strtoupper($sort_order); - - if (true === $limit_count) { - $limit_count = $GLOBALS['cfg']['MaxDbList']; - } - - $apply_limit_and_order_manual = true; - - if (! $GLOBALS['cfg']['Server']['DisableIS']) { - /** - * if $GLOBALS['cfg']['NaturalOrder'] is enabled, we cannot use LIMIT - * cause MySQL does not support natural ordering, - * we have to do it afterward - */ - $limit = ''; - if (! $GLOBALS['cfg']['NaturalOrder']) { - if ($limit_count) { - $limit = ' LIMIT ' . $limit_count . ' OFFSET ' . $limit_offset; - } - - $apply_limit_and_order_manual = false; - } - - // get table information from information_schema - if (! empty($database)) { - $sql_where_schema = 'WHERE `SCHEMA_NAME` LIKE \'' - . $this->escapeString($database, $link) . '\''; - } else { - $sql_where_schema = ''; - } - - $sql = 'SELECT *, - CAST(BIN_NAME AS CHAR CHARACTER SET utf8) AS SCHEMA_NAME - FROM ('; - $sql .= 'SELECT - BINARY s.SCHEMA_NAME AS BIN_NAME, - s.DEFAULT_COLLATION_NAME'; - if ($force_stats) { - $sql .= ', - COUNT(t.TABLE_SCHEMA) AS SCHEMA_TABLES, - SUM(t.TABLE_ROWS) AS SCHEMA_TABLE_ROWS, - SUM(t.DATA_LENGTH) AS SCHEMA_DATA_LENGTH, - SUM(t.MAX_DATA_LENGTH) AS SCHEMA_MAX_DATA_LENGTH, - SUM(t.INDEX_LENGTH) AS SCHEMA_INDEX_LENGTH, - SUM(t.DATA_LENGTH + t.INDEX_LENGTH) - AS SCHEMA_LENGTH, - SUM(IF(t.ENGINE <> \'InnoDB\', t.DATA_FREE, 0)) - AS SCHEMA_DATA_FREE'; - } - $sql .= ' - FROM `information_schema`.SCHEMATA s '; - if ($force_stats) { - $sql .= ' - LEFT JOIN `information_schema`.TABLES t - ON BINARY t.TABLE_SCHEMA = BINARY s.SCHEMA_NAME'; - } - $sql .= $sql_where_schema . ' - GROUP BY BINARY s.SCHEMA_NAME, s.DEFAULT_COLLATION_NAME - ORDER BY '; - if ($sort_by == 'SCHEMA_NAME' - || $sort_by == 'DEFAULT_COLLATION_NAME' - ) { - $sql .= 'BINARY '; - } - $sql .= Util::backquote($sort_by) - . ' ' . $sort_order - . $limit; - $sql .= ') a'; - - $databases = $this->fetchResult($sql, 'SCHEMA_NAME', null, $link); - - $mysql_error = $this->getError($link); - if (! count($databases) && $GLOBALS['errno']) { - Util::mysqlDie($mysql_error, $sql); - } - - // display only databases also in official database list - // f.e. to apply hide_db and only_db - $drops = array_diff( - array_keys($databases), - (array) $GLOBALS['dblist']->databases - ); - foreach ($drops as $drop) { - unset($databases[$drop]); - } - } else { - $databases = []; - foreach ($GLOBALS['dblist']->databases as $database_name) { - // Compatibility with INFORMATION_SCHEMA output - $databases[$database_name]['SCHEMA_NAME'] = $database_name; - - $databases[$database_name]['DEFAULT_COLLATION_NAME'] - = $this->getDbCollation($database_name); - - if (! $force_stats) { - continue; - } - - // get additional info about tables - $databases[$database_name]['SCHEMA_TABLES'] = 0; - $databases[$database_name]['SCHEMA_TABLE_ROWS'] = 0; - $databases[$database_name]['SCHEMA_DATA_LENGTH'] = 0; - $databases[$database_name]['SCHEMA_MAX_DATA_LENGTH'] = 0; - $databases[$database_name]['SCHEMA_INDEX_LENGTH'] = 0; - $databases[$database_name]['SCHEMA_LENGTH'] = 0; - $databases[$database_name]['SCHEMA_DATA_FREE'] = 0; - - $res = $this->query( - 'SHOW TABLE STATUS FROM ' - . Util::backquote($database_name) . ';' - ); - - if ($res === false) { - unset($res); - continue; - } - - while ($row = $this->fetchAssoc($res)) { - $databases[$database_name]['SCHEMA_TABLES']++; - $databases[$database_name]['SCHEMA_TABLE_ROWS'] - += $row['Rows']; - $databases[$database_name]['SCHEMA_DATA_LENGTH'] - += $row['Data_length']; - $databases[$database_name]['SCHEMA_MAX_DATA_LENGTH'] - += $row['Max_data_length']; - $databases[$database_name]['SCHEMA_INDEX_LENGTH'] - += $row['Index_length']; - - // for InnoDB, this does not contain the number of - // overhead bytes but the total free space - if ('InnoDB' != $row['Engine']) { - $databases[$database_name]['SCHEMA_DATA_FREE'] - += $row['Data_free']; - } - $databases[$database_name]['SCHEMA_LENGTH'] - += $row['Data_length'] + $row['Index_length']; - } - $this->freeResult($res); - unset($res); - } - } - - /** - * apply limit and order manually now - * (caused by older MySQL < 5 or $GLOBALS['cfg']['NaturalOrder']) - */ - if ($apply_limit_and_order_manual) { - $GLOBALS['callback_sort_order'] = $sort_order; - $GLOBALS['callback_sort_by'] = $sort_by; - usort( - $databases, - [ - self::class, - '_usortComparisonCallback', - ] - ); - unset($GLOBALS['callback_sort_order'], $GLOBALS['callback_sort_by']); - - /** - * now apply limit - */ - if ($limit_count) { - $databases = array_slice($databases, $limit_offset, $limit_count); - } - } - - return $databases; - } - - /** - * usort comparison callback - * - * @param array $a first argument to sort - * @param array $b second argument to sort - * - * @return int a value representing whether $a should be before $b in the - * sorted array or not - * - * @access private - */ - private static function _usortComparisonCallback($a, $b): int - { - if ($GLOBALS['cfg']['NaturalOrder']) { - $sorter = 'strnatcasecmp'; - } else { - $sorter = 'strcasecmp'; - } - /* No sorting when key is not present */ - if (! isset($a[$GLOBALS['callback_sort_by']]) - || ! isset($b[$GLOBALS['callback_sort_by']]) - ) { - return 0; - } - // produces f.e.: - // return -1 * strnatcasecmp($a["SCHEMA_TABLES"], $b["SCHEMA_TABLES"]) - return ($GLOBALS['callback_sort_order'] == 'ASC' ? 1 : -1) * $sorter( - $a[$GLOBALS['callback_sort_by']], - $b[$GLOBALS['callback_sort_by']] - ); - } - - /** - * returns detailed array with all columns for sql - * - * @param string $sql_query target SQL query to get columns - * @param array $view_columns alias for columns - * - * @return array - */ - public function getColumnMapFromSql(string $sql_query, array $view_columns = []): array - { - $result = $this->tryQuery($sql_query); - - if ($result === false) { - return []; - } - - $meta = $this->getFieldsMeta( - $result - ); - - $nbFields = count($meta); - if ($nbFields <= 0) { - return []; - } - - $column_map = []; - $nbColumns = count($view_columns); - - for ($i = 0; $i < $nbFields; $i++) { - $map = []; - $map['table_name'] = $meta[$i]->table; - $map['refering_column'] = $meta[$i]->name; - - if ($nbColumns > 1) { - $map['real_column'] = $view_columns[$i]; - } - - $column_map[] = $map; - } - - return $column_map; - } - - /** - * returns detailed array with all columns for given table in database, - * or all tables/databases - * - * @param string $database name of database - * @param string $table name of table to retrieve columns from - * @param string $column name of specific column - * @param mixed $link mysql link resource - * - * @return array - */ - public function getColumnsFull( - ?string $database = null, - ?string $table = null, - ?string $column = null, - $link = DatabaseInterface::CONNECT_USER - ): array { - if (! $GLOBALS['cfg']['Server']['DisableIS']) { - $sql_wheres = []; - $array_keys = []; - - // get columns information from information_schema - if (null !== $database) { - $sql_wheres[] = '`TABLE_SCHEMA` = \'' - . $this->escapeString($database, $link) . '\' '; - } else { - $array_keys[] = 'TABLE_SCHEMA'; - } - if (null !== $table) { - $sql_wheres[] = '`TABLE_NAME` = \'' - . $this->escapeString($table, $link) . '\' '; - } else { - $array_keys[] = 'TABLE_NAME'; - } - if (null !== $column) { - $sql_wheres[] = '`COLUMN_NAME` = \'' - . $this->escapeString($column, $link) . '\' '; - } else { - $array_keys[] = 'COLUMN_NAME'; - } - - // for PMA bc: - // `[SCHEMA_FIELD_NAME]` AS `[SHOW_FULL_COLUMNS_FIELD_NAME]` - $sql = ' - SELECT *, - `COLUMN_NAME` AS `Field`, - `COLUMN_TYPE` AS `Type`, - `COLLATION_NAME` AS `Collation`, - `IS_NULLABLE` AS `Null`, - `COLUMN_KEY` AS `Key`, - `COLUMN_DEFAULT` AS `Default`, - `EXTRA` AS `Extra`, - `PRIVILEGES` AS `Privileges`, - `COLUMN_COMMENT` AS `Comment` - FROM `information_schema`.`COLUMNS`'; - - if (count($sql_wheres)) { - $sql .= "\n" . ' WHERE ' . implode(' AND ', $sql_wheres); - } - return $this->fetchResult($sql, $array_keys, null, $link); - } - - $columns = []; - if (null === $database) { - foreach ($GLOBALS['dblist']->databases as $database) { - $columns[$database] = $this->getColumnsFull( - $database, - null, - null, - $link - ); - } - return $columns; - } elseif (null === $table) { - $tables = $this->getTables($database); - foreach ($tables as $table) { - $columns[$table] = $this->getColumnsFull( - $database, - $table, - null, - $link - ); - } - return $columns; - } - $sql = 'SHOW FULL COLUMNS FROM ' - . Util::backquote($database) . '.' . Util::backquote($table); - if (null !== $column) { - $sql .= " LIKE '" . $this->escapeString($column, $link) . "'"; - } - - $columns = $this->fetchResult($sql, 'Field', null, $link); - $ordinal_position = 1; - foreach ($columns as $column_name => $each_column) { - // Compatibility with INFORMATION_SCHEMA output - $columns[$column_name]['COLUMN_NAME'] - =& $columns[$column_name]['Field']; - $columns[$column_name]['COLUMN_TYPE'] - =& $columns[$column_name]['Type']; - $columns[$column_name]['COLLATION_NAME'] - =& $columns[$column_name]['Collation']; - $columns[$column_name]['IS_NULLABLE'] - =& $columns[$column_name]['Null']; - $columns[$column_name]['COLUMN_KEY'] - =& $columns[$column_name]['Key']; - $columns[$column_name]['COLUMN_DEFAULT'] - =& $columns[$column_name]['Default']; - $columns[$column_name]['EXTRA'] - =& $columns[$column_name]['Extra']; - $columns[$column_name]['PRIVILEGES'] - =& $columns[$column_name]['Privileges']; - $columns[$column_name]['COLUMN_COMMENT'] - =& $columns[$column_name]['Comment']; - - $columns[$column_name]['TABLE_CATALOG'] = null; - $columns[$column_name]['TABLE_SCHEMA'] = $database; - $columns[$column_name]['TABLE_NAME'] = $table; - $columns[$column_name]['ORDINAL_POSITION'] = $ordinal_position; - $colType = $columns[$column_name]['COLUMN_TYPE']; - $colType = is_string($colType) ? $colType : ''; - $colTypePosComa = strpos($colType, '('); - $colTypePosComa = $colTypePosComa !== false ? $colTypePosComa : strlen($colType); - $columns[$column_name]['DATA_TYPE'] - = substr( - $colType, - 0, - $colTypePosComa - ); - /** - * @todo guess CHARACTER_MAXIMUM_LENGTH from COLUMN_TYPE - */ - $columns[$column_name]['CHARACTER_MAXIMUM_LENGTH'] = null; - /** - * @todo guess CHARACTER_OCTET_LENGTH from CHARACTER_MAXIMUM_LENGTH - */ - $columns[$column_name]['CHARACTER_OCTET_LENGTH'] = null; - $columns[$column_name]['NUMERIC_PRECISION'] = null; - $columns[$column_name]['NUMERIC_SCALE'] = null; - $colCollation = $columns[$column_name]['COLLATION_NAME']; - $colCollation = is_string($colCollation) ? $colCollation : ''; - $colCollationPosUnderscore = strpos($colCollation, '_'); - $colCollationPosUnderscore = $colCollationPosUnderscore !== false ? $colCollationPosUnderscore : strlen($colCollation); - $columns[$column_name]['CHARACTER_SET_NAME'] - = substr( - $colCollation, - 0, - $colCollationPosUnderscore - ); - - $ordinal_position++; - } - - if (null !== $column) { - return reset($columns); - } - - return $columns; - } - - /** - * Returns SQL query for fetching columns for a table - * - * The 'Key' column is not calculated properly, use $dbi->getColumns() - * to get correct values. - * - * @param string $database name of database - * @param string $table name of table to retrieve columns from - * @param string $column name of column, null to show all columns - * @param boolean $full whether to return full info or only column names - * - * @see getColumns() - * - * @return string - */ - public function getColumnsSql( - string $database, - string $table, - ?string $column = null, - bool $full = false - ): string { - $sql = 'SHOW ' . ($full ? 'FULL' : '') . ' COLUMNS FROM ' - . Util::backquote($database) . '.' . Util::backquote($table) - . ($column !== null ? "LIKE '" - . $this->escapeString($column) . "'" : ''); - - return $sql; - } - - /** - * Returns descriptions of columns in given table (all or given by $column) - * - * @param string $database name of database - * @param string $table name of table to retrieve columns from - * @param string $column name of column, null to show all columns - * @param boolean $full whether to return full info or only column names - * @param integer $link link type - * - * @return array array indexed by column names or, - * if $column is given, flat array description - */ - public function getColumns( - string $database, - string $table, - ?string $column = null, - bool $full = false, - $link = DatabaseInterface::CONNECT_USER - ): array { - $sql = $this->getColumnsSql($database, $table, $column, $full); - $fields = $this->fetchResult($sql, 'Field', null, $link); - if (! is_array($fields) || count($fields) === 0) { - return []; - } - // Check if column is a part of multiple-column index and set its 'Key'. - $indexes = Index::getFromTable($table, $database); - foreach ($fields as $field => $field_data) { - if (! empty($field_data['Key'])) { - continue; - } - - foreach ($indexes as $index) { - /** @var Index $index */ - if (! $index->hasColumn($field)) { - continue; - } - - $index_columns = $index->getColumns(); - if ($index_columns[$field]->getSeqInIndex() > 1) { - if ($index->isUnique()) { - $fields[$field]['Key'] = 'UNI'; - } else { - $fields[$field]['Key'] = 'MUL'; - } - } - } - } - - return $column != null ? array_shift($fields) : $fields; - } - - /** - * Returns all column names in given table - * - * @param string $database name of database - * @param string $table name of table to retrieve columns from - * @param mixed $link mysql link resource - * - * @return null|array - */ - public function getColumnNames( - string $database, - string $table, - $link = DatabaseInterface::CONNECT_USER - ): ?array { - $sql = $this->getColumnsSql($database, $table); - // We only need the 'Field' column which contains the table's column names - $fields = array_keys($this->fetchResult($sql, 'Field', null, $link)); - - if (! is_array($fields) || count($fields) === 0) { - return null; - } - return $fields; - } - - /** - * Returns SQL for fetching information on table indexes (SHOW INDEXES) - * - * @param string $database name of database - * @param string $table name of the table whose indexes are to be retrieved - * @param string $where additional conditions for WHERE - * - * @return string SQL for getting indexes - */ - public function getTableIndexesSql( - string $database, - string $table, - ?string $where = null - ): string { - $sql = 'SHOW INDEXES FROM ' . Util::backquote($database) . '.' - . Util::backquote($table); - if ($where) { - $sql .= ' WHERE (' . $where . ')'; - } - return $sql; - } - - /** - * Returns indexes of a table - * - * @param string $database name of database - * @param string $table name of the table whose indexes are to be retrieved - * @param mixed $link mysql link resource - * - * @return array - */ - public function getTableIndexes( - string $database, - string $table, - $link = DatabaseInterface::CONNECT_USER - ): array { - $sql = $this->getTableIndexesSql($database, $table); - $indexes = $this->fetchResult($sql, null, null, $link); - - if (! is_array($indexes) || count($indexes) < 1) { - return []; - } - return $indexes; - } - - /** - * returns value of given mysql server variable - * - * @param string $var mysql server variable name - * @param int $type DatabaseInterface::GETVAR_SESSION | - * DatabaseInterface::GETVAR_GLOBAL - * @param mixed $link mysql link resource|object - * - * @return mixed value for mysql server variable - */ - public function getVariable( - string $var, - int $type = self::GETVAR_SESSION, - $link = DatabaseInterface::CONNECT_USER - ) { - switch ($type) { - case self::GETVAR_SESSION: - $modifier = ' SESSION'; - break; - case self::GETVAR_GLOBAL: - $modifier = ' GLOBAL'; - break; - default: - $modifier = ''; - } - return $this->fetchValue( - 'SHOW' . $modifier . ' VARIABLES LIKE \'' . $var . '\';', - 0, - 1, - $link - ); - } - - /** - * Sets new value for a variable if it is different from the current value - * - * @param string $var variable name - * @param string $value value to set - * @param mixed $link mysql link resource|object - * - * @return bool whether query was a successful - */ - public function setVariable( - string $var, - string $value, - $link = DatabaseInterface::CONNECT_USER - ): bool { - $current_value = $this->getVariable( - $var, - self::GETVAR_SESSION, - $link - ); - if ($current_value == $value) { - return true; - } - - return $this->query("SET " . $var . " = " . $value . ';', $link); - } - - /** - * Convert version string to integer. - * - * @param string $version MySQL server version - * - * @return int - */ - public static function versionToInt(string $version): int - { - $match = explode('.', $version); - return (int) sprintf('%d%02d%02d', $match[0], $match[1], intval($match[2])); - } - - /** - * Function called just after a connection to the MySQL database server has - * been established. It sets the connection collation, and determines the - * version of MySQL which is running. - * - * @return void - */ - public function postConnect(): void - { - $version = $this->fetchSingleRow( - 'SELECT @@version, @@version_comment', - 'ASSOC', - DatabaseInterface::CONNECT_USER - ); - - if ($version) { - $this->_version_str = isset($version['@@version']) ? $version['@@version'] : ''; - $this->_version_int = self::versionToInt($this->_version_str); - $this->_version_comment = isset($version['@@version_comment']) ? $version['@@version_comment'] : ''; - if (stripos($this->_version_str, 'mariadb') !== false) { - $this->_is_mariadb = true; - } - if (stripos($this->_version_comment, 'percona') !== false) { - $this->_is_percona = true; - } - } - - if ($this->_version_int > 50503) { - $default_charset = 'utf8mb4'; - $default_collation = 'utf8mb4_general_ci'; - } else { - $default_charset = 'utf8'; - $default_collation = 'utf8_general_ci'; - } - $GLOBALS['collation_connection'] = $default_collation; - $GLOBALS['charset_connection'] = $default_charset; - $this->query( - "SET NAMES '$default_charset' COLLATE '$default_collation';", - DatabaseInterface::CONNECT_USER, - self::QUERY_STORE - ); - - /* Locale for messages */ - $locale = LanguageManager::getInstance()->getCurrentLanguage()->getMySQLLocale(); - if (! empty($locale)) { - $this->query( - "SET lc_messages = '" . $locale . "';", - DatabaseInterface::CONNECT_USER, - self::QUERY_STORE - ); - } - - // Set timezone for the session, if required. - if ($GLOBALS['cfg']['Server']['SessionTimeZone'] != '') { - $sql_query_tz = 'SET ' . Util::backquote('time_zone') . ' = ' - . '\'' - . $this->escapeString($GLOBALS['cfg']['Server']['SessionTimeZone']) - . '\''; - - if (! $this->tryQuery($sql_query_tz)) { - $error_message_tz = sprintf( - __( - 'Unable to use timezone "%1$s" for server %2$d. ' - . 'Please check your configuration setting for ' - . '[em]$cfg[\'Servers\'][%3$d][\'SessionTimeZone\'][/em]. ' - . 'phpMyAdmin is currently using the default time zone ' - . 'of the database server.' - ), - $GLOBALS['cfg']['Server']['SessionTimeZone'], - $GLOBALS['server'], - $GLOBALS['server'] - ); - - trigger_error($error_message_tz, E_USER_WARNING); - } - } - - /* Loads closest context to this version. */ - Context::loadClosest( - ($this->_is_mariadb ? 'MariaDb' : 'MySql') . $this->_version_int - ); - - /** - * the DatabaseList class as a stub for the ListDatabase class - */ - $GLOBALS['dblist'] = new DatabaseList(); - } - - /** - * Sets collation connection for user link - * - * @param string $collation collation to set - * - * @return void - */ - public function setCollation(string $collation): void - { - $charset = $GLOBALS['charset_connection']; - /* Automatically adjust collation if not supported by server */ - if ($charset == 'utf8' && strncmp('utf8mb4_', $collation, 8) == 0) { - $collation = 'utf8_' . substr($collation, 8); - } - $result = $this->tryQuery( - "SET collation_connection = '" - . $this->escapeString($collation, DatabaseInterface::CONNECT_USER) - . "';", - DatabaseInterface::CONNECT_USER, - self::QUERY_STORE - ); - if ($result === false) { - trigger_error( - __('Failed to set configured collation connection!'), - E_USER_WARNING - ); - } else { - $GLOBALS['collation_connection'] = $collation; - } - } - - /** - * This function checks and initialises the phpMyAdmin configuration - * storage state before it is used into session cache. - * - * @return void - */ - public function initRelationParamsCache() - { - if (strlen($GLOBALS['db'])) { - $cfgRelation = $this->relation->getRelationsParam(); - if (empty($cfgRelation['db'])) { - $this->relation->fixPmaTables($GLOBALS['db'], false); - } - } - $cfgRelation = $this->relation->getRelationsParam(); - if (empty($cfgRelation['db']) && isset($GLOBALS['dblist'])) { - if ($GLOBALS['dblist']->databases->exists('phpmyadmin')) { - $this->relation->fixPmaTables('phpmyadmin', false); - } - } - } - - /** - * Function called just after a connection to the MySQL database server has - * been established. It sets the connection collation, and determines the - * version of MySQL which is running. - * - * @return void - */ - public function postConnectControl(): void - { - // If Zero configuration mode enabled, check PMA tables in current db. - if ($GLOBALS['cfg']['ZeroConf'] == true) { - /** - * the DatabaseList class as a stub for the ListDatabase class - */ - $GLOBALS['dblist'] = new DatabaseList(); - - $this->initRelationParamsCache(); - } - } - - /** - * returns a single value from the given result or query, - * if the query or the result has more than one row or field - * the first field of the first row is returned - * - * <code> - * $sql = 'SELECT `name` FROM `user` WHERE `id` = 123'; - * $user_name = $dbi->fetchValue($sql); - * // produces - * // $user_name = 'John Doe' - * </code> - * - * @param string $query The query to execute - * @param integer $row_number row to fetch the value from, - * starting at 0, with 0 being default - * @param integer|string $field field to fetch the value from, - * starting at 0, with 0 being default - * @param integer $link link type - * - * @return mixed value of first field in first row from result - * or false if not found - */ - public function fetchValue( - string $query, - int $row_number = 0, - $field = 0, - $link = DatabaseInterface::CONNECT_USER - ) { - $value = false; - - $result = $this->tryQuery( - $query, - $link, - self::QUERY_STORE, - false - ); - if ($result === false) { - return false; - } - - // return false if result is empty or false - // or requested row is larger than rows in result - if ($this->numRows($result) < ($row_number + 1)) { - return $value; - } - - // if $field is an integer use non associative mysql fetch function - if (is_int($field)) { - $fetch_function = 'fetchRow'; - } else { - $fetch_function = 'fetchAssoc'; - } - - // get requested row - for ($i = 0; $i <= $row_number; $i++) { - $row = $this->$fetch_function($result); - } - $this->freeResult($result); - - // return requested field - if (isset($row[$field])) { - $value = $row[$field]; - } - - return $value; - } - - /** - * returns only the first row from the result - * - * <code> - * $sql = 'SELECT * FROM `user` WHERE `id` = 123'; - * $user = $dbi->fetchSingleRow($sql); - * // produces - * // $user = array('id' => 123, 'name' => 'John Doe') - * </code> - * - * @param string $query The query to execute - * @param string $type NUM|ASSOC|BOTH returned array should either numeric - * associative or both - * @param integer $link link type - * - * @return array|boolean first row from result - * or false if result is empty - */ - public function fetchSingleRow( - string $query, - string $type = 'ASSOC', - $link = DatabaseInterface::CONNECT_USER - ) { - $result = $this->tryQuery( - $query, - $link, - self::QUERY_STORE, - false - ); - if ($result === false) { - return false; - } - - // return false if result is empty or false - if (! $this->numRows($result)) { - return false; - } - - switch ($type) { - case 'NUM': - $fetch_function = 'fetchRow'; - break; - case 'ASSOC': - $fetch_function = 'fetchAssoc'; - break; - case 'BOTH': - default: - $fetch_function = 'fetchArray'; - break; - } - - $row = $this->$fetch_function($result); - $this->freeResult($result); - return $row; - } - - /** - * Returns row or element of a row - * - * @param array $row Row to process - * @param string|null|int $value Which column to return - * - * @return mixed - */ - private function _fetchValue(array $row, $value) - { - if ($value === null) { - return $row; - } - - return $row[$value]; - } - - /** - * returns all rows in the resultset in one array - * - * <code> - * $sql = 'SELECT * FROM `user`'; - * $users = $dbi->fetchResult($sql); - * // produces - * // $users[] = array('id' => 123, 'name' => 'John Doe') - * - * $sql = 'SELECT `id`, `name` FROM `user`'; - * $users = $dbi->fetchResult($sql, 'id'); - * // produces - * // $users['123'] = array('id' => 123, 'name' => 'John Doe') - * - * $sql = 'SELECT `id`, `name` FROM `user`'; - * $users = $dbi->fetchResult($sql, 0); - * // produces - * // $users['123'] = array(0 => 123, 1 => 'John Doe') - * - * $sql = 'SELECT `id`, `name` FROM `user`'; - * $users = $dbi->fetchResult($sql, 'id', 'name'); - * // or - * $users = $dbi->fetchResult($sql, 0, 1); - * // produces - * // $users['123'] = 'John Doe' - * - * $sql = 'SELECT `name` FROM `user`'; - * $users = $dbi->fetchResult($sql); - * // produces - * // $users[] = 'John Doe' - * - * $sql = 'SELECT `group`, `name` FROM `user`' - * $users = $dbi->fetchResult($sql, array('group', null), 'name'); - * // produces - * // $users['admin'][] = 'John Doe' - * - * $sql = 'SELECT `group`, `name` FROM `user`' - * $users = $dbi->fetchResult($sql, array('group', 'name'), 'id'); - * // produces - * // $users['admin']['John Doe'] = '123' - * </code> - * - * @param string $query query to execute - * @param string|integer|array $key field-name or offset - * used as key for array - * or array of those - * @param string|integer $value value-name or offset - * used as value for array - * @param integer $link link type - * @param integer $options query options - * - * @return array resultrows or values indexed by $key - */ - public function fetchResult( - string $query, - $key = null, - $value = null, - $link = DatabaseInterface::CONNECT_USER, - int $options = 0 - ) { - $resultrows = []; - - $result = $this->tryQuery($query, $link, $options, false); - - // return empty array if result is empty or false - if ($result === false) { - return $resultrows; - } - - $fetch_function = 'fetchAssoc'; - - // no nested array if only one field is in result - if (null === $key && 1 === $this->numFields($result)) { - $value = 0; - $fetch_function = 'fetchRow'; - } - - // if $key is an integer use non associative mysql fetch function - if (is_int($key)) { - $fetch_function = 'fetchRow'; - } - - if (null === $key) { - while ($row = $this->$fetch_function($result)) { - $resultrows[] = $this->_fetchValue($row, $value); - } - } else { - if (is_array($key)) { - while ($row = $this->$fetch_function($result)) { - $result_target =& $resultrows; - foreach ($key as $key_index) { - if (null === $key_index) { - $result_target =& $result_target[]; - continue; - } - - if (! isset($result_target[$row[$key_index]])) { - $result_target[$row[$key_index]] = []; - } - $result_target =& $result_target[$row[$key_index]]; - } - $result_target = $this->_fetchValue($row, $value); - } - } else { - while ($row = $this->$fetch_function($result)) { - $resultrows[$row[$key]] = $this->_fetchValue($row, $value); - } - } - } - - $this->freeResult($result); - return $resultrows; - } - - /** - * Get supported SQL compatibility modes - * - * @return array supported SQL compatibility modes - */ - public function getCompatibilities(): array - { - $compats = ['NONE']; - $compats[] = 'ANSI'; - $compats[] = 'DB2'; - $compats[] = 'MAXDB'; - $compats[] = 'MYSQL323'; - $compats[] = 'MYSQL40'; - $compats[] = 'MSSQL'; - $compats[] = 'ORACLE'; - // removed; in MySQL 5.0.33, this produces exports that - // can't be read by POSTGRESQL (see our bug #1596328) - //$compats[] = 'POSTGRESQL'; - $compats[] = 'TRADITIONAL'; - - return $compats; - } - - /** - * returns warnings for last query - * - * @param integer $link link type - * - * @return array warnings - */ - public function getWarnings($link = DatabaseInterface::CONNECT_USER): array - { - return $this->fetchResult('SHOW WARNINGS', null, null, $link); - } - - /** - * returns an array of PROCEDURE or FUNCTION names for a db - * - * @param string $db db name - * @param string $which PROCEDURE | FUNCTION - * @param integer $link link type - * - * @return array the procedure names or function names - */ - public function getProceduresOrFunctions( - string $db, - string $which, - $link = DatabaseInterface::CONNECT_USER - ): array { - $shows = $this->fetchResult( - 'SHOW ' . $which . ' STATUS;', - null, - null, - $link - ); - $result = []; - foreach ($shows as $one_show) { - if ($one_show['Db'] == $db && $one_show['Type'] == $which) { - $result[] = $one_show['Name']; - } - } - return $result; - } - - /** - * returns the definition of a specific PROCEDURE, FUNCTION, EVENT or VIEW - * - * @param string $db db name - * @param string $which PROCEDURE | FUNCTION | EVENT | VIEW - * @param string $name the procedure|function|event|view name - * @param integer $link link type - * - * @return string|null the definition - */ - public function getDefinition( - string $db, - string $which, - string $name, - $link = DatabaseInterface::CONNECT_USER - ): ?string { - $returned_field = [ - 'PROCEDURE' => 'Create Procedure', - 'FUNCTION' => 'Create Function', - 'EVENT' => 'Create Event', - 'VIEW' => 'Create View', - ]; - $query = 'SHOW CREATE ' . $which . ' ' - . Util::backquote($db) . '.' - . Util::backquote($name); - $result = $this->fetchValue($query, 0, $returned_field[$which], $link); - return is_string($result) ? $result : null; - } - - /** - * returns details about the PROCEDUREs or FUNCTIONs for a specific database - * or details about a specific routine - * - * @param string $db db name - * @param string $which PROCEDURE | FUNCTION or null for both - * @param string $name name of the routine (to fetch a specific routine) - * - * @return array information about ROCEDUREs or FUNCTIONs - */ - public function getRoutines( - string $db, - ?string $which = null, - string $name = '' - ): array { - $routines = []; - if (! $GLOBALS['cfg']['Server']['DisableIS']) { - $query = "SELECT" - . " `ROUTINE_SCHEMA` AS `Db`," - . " `SPECIFIC_NAME` AS `Name`," - . " `ROUTINE_TYPE` AS `Type`," - . " `DEFINER` AS `Definer`," - . " `LAST_ALTERED` AS `Modified`," - . " `CREATED` AS `Created`," - . " `SECURITY_TYPE` AS `Security_type`," - . " `ROUTINE_COMMENT` AS `Comment`," - . " `CHARACTER_SET_CLIENT` AS `character_set_client`," - . " `COLLATION_CONNECTION` AS `collation_connection`," - . " `DATABASE_COLLATION` AS `Database Collation`," - . " `DTD_IDENTIFIER`" - . " FROM `information_schema`.`ROUTINES`" - . " WHERE `ROUTINE_SCHEMA` " . Util::getCollateForIS() - . " = '" . $this->escapeString($db) . "'"; - if (Core::isValid($which, ['FUNCTION', 'PROCEDURE'])) { - $query .= " AND `ROUTINE_TYPE` = '" . $which . "'"; - } - if (! empty($name)) { - $query .= " AND `SPECIFIC_NAME`" - . " = '" . $this->escapeString($name) . "'"; - } - $result = $this->fetchResult($query); - if (! empty($result)) { - $routines = $result; - } - } else { - if ($which == 'FUNCTION' || $which == null) { - $query = "SHOW FUNCTION STATUS" - . " WHERE `Db` = '" . $this->escapeString($db) . "'"; - if (! empty($name)) { - $query .= " AND `Name` = '" - . $this->escapeString($name) . "'"; - } - $result = $this->fetchResult($query); - if (! empty($result)) { - $routines = array_merge($routines, $result); - } - } - if ($which == 'PROCEDURE' || $which == null) { - $query = "SHOW PROCEDURE STATUS" - . " WHERE `Db` = '" . $this->escapeString($db) . "'"; - if (! empty($name)) { - $query .= " AND `Name` = '" - . $this->escapeString($name) . "'"; - } - $result = $this->fetchResult($query); - if (! empty($result)) { - $routines = array_merge($routines, $result); - } - } - } - - $ret = []; - foreach ($routines as $routine) { - $one_result = []; - $one_result['db'] = $routine['Db']; - $one_result['name'] = $routine['Name']; - $one_result['type'] = $routine['Type']; - $one_result['definer'] = $routine['Definer']; - $one_result['returns'] = isset($routine['DTD_IDENTIFIER']) - ? $routine['DTD_IDENTIFIER'] : ""; - $ret[] = $one_result; - } - - // Sort results by name - $name = []; - foreach ($ret as $value) { - $name[] = $value['name']; - } - array_multisort($name, SORT_ASC, $ret); - - return $ret; - } - - /** - * returns details about the EVENTs for a specific database - * - * @param string $db db name - * @param string $name event name - * - * @return array information about EVENTs - */ - public function getEvents(string $db, string $name = ''): array - { - if (! $GLOBALS['cfg']['Server']['DisableIS']) { - $query = "SELECT" - . " `EVENT_SCHEMA` AS `Db`," - . " `EVENT_NAME` AS `Name`," - . " `DEFINER` AS `Definer`," - . " `TIME_ZONE` AS `Time zone`," - . " `EVENT_TYPE` AS `Type`," - . " `EXECUTE_AT` AS `Execute at`," - . " `INTERVAL_VALUE` AS `Interval value`," - . " `INTERVAL_FIELD` AS `Interval field`," - . " `STARTS` AS `Starts`," - . " `ENDS` AS `Ends`," - . " `STATUS` AS `Status`," - . " `ORIGINATOR` AS `Originator`," - . " `CHARACTER_SET_CLIENT` AS `character_set_client`," - . " `COLLATION_CONNECTION` AS `collation_connection`, " - . "`DATABASE_COLLATION` AS `Database Collation`" - . " FROM `information_schema`.`EVENTS`" - . " WHERE `EVENT_SCHEMA` " . Util::getCollateForIS() - . " = '" . $this->escapeString($db) . "'"; - if (! empty($name)) { - $query .= " AND `EVENT_NAME`" - . " = '" . $this->escapeString($name) . "'"; - } - } else { - $query = "SHOW EVENTS FROM " . Util::backquote($db); - if (! empty($name)) { - $query .= " AND `Name` = '" - . $this->escapeString($name) . "'"; - } - } - - $result = []; - if ($events = $this->fetchResult($query)) { - foreach ($events as $event) { - $one_result = []; - $one_result['name'] = $event['Name']; - $one_result['type'] = $event['Type']; - $one_result['status'] = $event['Status']; - $result[] = $one_result; - } - } - - // Sort results by name - $name = []; - foreach ($result as $value) { - $name[] = $value['name']; - } - array_multisort($name, SORT_ASC, $result); - - return $result; - } - - /** - * returns details about the TRIGGERs for a specific table or database - * - * @param string $db db name - * @param string $table table name - * @param string $delimiter the delimiter to use (may be empty) - * - * @return array information about triggers (may be empty) - */ - public function getTriggers(string $db, string $table = '', $delimiter = '//') - { - $result = []; - if (! $GLOBALS['cfg']['Server']['DisableIS']) { - $query = 'SELECT TRIGGER_SCHEMA, TRIGGER_NAME, EVENT_MANIPULATION' - . ', EVENT_OBJECT_TABLE, ACTION_TIMING, ACTION_STATEMENT' - . ', EVENT_OBJECT_SCHEMA, EVENT_OBJECT_TABLE, DEFINER' - . ' FROM information_schema.TRIGGERS' - . ' WHERE EVENT_OBJECT_SCHEMA ' . Util::getCollateForIS() . '=' - . ' \'' . $this->escapeString($db) . '\''; - - if (! empty($table)) { - $query .= " AND EVENT_OBJECT_TABLE " . Util::getCollateForIS() - . " = '" . $this->escapeString($table) . "';"; - } - } else { - $query = "SHOW TRIGGERS FROM " . Util::backquote($db); - if (! empty($table)) { - $query .= " LIKE '" . $this->escapeString($table) . "';"; - } - } - - if ($triggers = $this->fetchResult($query)) { - foreach ($triggers as $trigger) { - if ($GLOBALS['cfg']['Server']['DisableIS']) { - $trigger['TRIGGER_NAME'] = $trigger['Trigger']; - $trigger['ACTION_TIMING'] = $trigger['Timing']; - $trigger['EVENT_MANIPULATION'] = $trigger['Event']; - $trigger['EVENT_OBJECT_TABLE'] = $trigger['Table']; - $trigger['ACTION_STATEMENT'] = $trigger['Statement']; - $trigger['DEFINER'] = $trigger['Definer']; - } - $one_result = []; - $one_result['name'] = $trigger['TRIGGER_NAME']; - $one_result['table'] = $trigger['EVENT_OBJECT_TABLE']; - $one_result['action_timing'] = $trigger['ACTION_TIMING']; - $one_result['event_manipulation'] = $trigger['EVENT_MANIPULATION']; - $one_result['definition'] = $trigger['ACTION_STATEMENT']; - $one_result['definer'] = $trigger['DEFINER']; - - // do not prepend the schema name; this way, importing the - // definition into another schema will work - $one_result['full_trigger_name'] = Util::backquote( - $trigger['TRIGGER_NAME'] - ); - $one_result['drop'] = 'DROP TRIGGER IF EXISTS ' - . $one_result['full_trigger_name']; - $one_result['create'] = 'CREATE TRIGGER ' - . $one_result['full_trigger_name'] . ' ' - . $trigger['ACTION_TIMING'] . ' ' - . $trigger['EVENT_MANIPULATION'] - . ' ON ' . Util::backquote($trigger['EVENT_OBJECT_TABLE']) - . "\n" . ' FOR EACH ROW ' - . $trigger['ACTION_STATEMENT'] . "\n" . $delimiter . "\n"; - - $result[] = $one_result; - } - } - - // Sort results by name - $name = []; - foreach ($result as $value) { - $name[] = $value['name']; - } - array_multisort($name, SORT_ASC, $result); - - return $result; - } - - /** - * Formats database error message in a friendly way. - * This is needed because some errors messages cannot - * be obtained by mysql_error(). - * - * @param int $error_number Error code - * @param string $error_message Error message as returned by server - * - * @return string HML text with error details - */ - public static function formatError(int $error_number, string $error_message): string - { - $error_message = htmlspecialchars($error_message); - - $error = '#' . ((string) $error_number); - $separator = ' — '; - - if ($error_number == 2002) { - $error .= ' - ' . $error_message; - $error .= $separator; - $error .= __( - 'The server is not responding (or the local server\'s socket' - . ' is not correctly configured).' - ); - } elseif ($error_number == 2003) { - $error .= ' - ' . $error_message; - $error .= $separator . __('The server is not responding.'); - } elseif ($error_number == 1698) { - $error .= ' - ' . $error_message; - $error .= $separator . '<a href="logout.php' . Url::getCommon() . '" class="disableAjax">'; - $error .= __('Logout and try as another user.') . '</a>'; - } elseif ($error_number == 1005) { - if (strpos($error_message, 'errno: 13') !== false) { - $error .= ' - ' . $error_message; - $error .= $separator - . __( - 'Please check privileges of directory containing database.' - ); - } else { - /* InnoDB constraints, see - * https://dev.mysql.com/doc/refman/5.0/en/ - * innodb-foreign-key-constraints.html - */ - $error .= ' - ' . $error_message . - ' (<a href="server_engines.php' . - Url::getCommon( - [ - 'engine' => 'InnoDB', - 'page' => 'Status', - ] - ) . '">' . __('Details…') . '</a>)'; - } - } else { - $error .= ' - ' . $error_message; - } - - return $error; - } - - /** - * gets the current user with host - * - * @return string the current user i.e. user@host - */ - public function getCurrentUser(): string - { - if (Util::cacheExists('mysql_cur_user')) { - return Util::cacheGet('mysql_cur_user'); - } - $user = $this->fetchValue('SELECT CURRENT_USER();'); - if ($user !== false) { - Util::cacheSet('mysql_cur_user', $user); - return $user; - } - return '@'; - } - - /** - * Checks if current user is superuser - * - * @return bool Whether user is a superuser - */ - public function isSuperuser(): bool - { - return self::isUserType('super'); - } - - /** - * Checks if current user has global create user/grant privilege - * or is a superuser (i.e. SELECT on mysql.users) - * while caching the result in session. - * - * @param string $type type of user to check for - * i.e. 'create', 'grant', 'super' - * - * @return bool Whether user is a given type of user - */ - public function isUserType(string $type): bool - { - if (Util::cacheExists('is_' . $type . 'user')) { - return Util::cacheGet('is_' . $type . 'user'); - } - - // when connection failed we don't have a $userlink - if (! isset($this->_links[DatabaseInterface::CONNECT_USER])) { - return false; - } - - // checking if user is logged in - if ($type === 'logged') { - return true; - } - - if (! $GLOBALS['cfg']['Server']['DisableIS'] || $type === 'super') { - // Prepare query for each user type check - $query = ''; - if ($type === 'super') { - $query = 'SELECT 1 FROM mysql.user LIMIT 1'; - } elseif ($type === 'create') { - list($user, $host) = $this->getCurrentUserAndHost(); - $query = "SELECT 1 FROM `INFORMATION_SCHEMA`.`USER_PRIVILEGES` " - . "WHERE `PRIVILEGE_TYPE` = 'CREATE USER' AND " - . "'''" . $user . "''@''" . $host . "''' LIKE `GRANTEE` LIMIT 1"; - } elseif ($type === 'grant') { - list($user, $host) = $this->getCurrentUserAndHost(); - $query = "SELECT 1 FROM (" - . "SELECT `GRANTEE`, `IS_GRANTABLE` FROM " - . "`INFORMATION_SCHEMA`.`COLUMN_PRIVILEGES` UNION " - . "SELECT `GRANTEE`, `IS_GRANTABLE` FROM " - . "`INFORMATION_SCHEMA`.`TABLE_PRIVILEGES` UNION " - . "SELECT `GRANTEE`, `IS_GRANTABLE` FROM " - . "`INFORMATION_SCHEMA`.`SCHEMA_PRIVILEGES` UNION " - . "SELECT `GRANTEE`, `IS_GRANTABLE` FROM " - . "`INFORMATION_SCHEMA`.`USER_PRIVILEGES`) t " - . "WHERE `IS_GRANTABLE` = 'YES' AND " - . "'''" . $user . "''@''" . $host . "''' LIKE `GRANTEE` LIMIT 1"; - } - - $is = false; - $result = $this->tryQuery( - $query, - self::CONNECT_USER, - self::QUERY_STORE - ); - if ($result) { - $is = (bool) $this->numRows($result); - } - $this->freeResult($result); - } else { - $is = false; - $grants = $this->fetchResult( - "SHOW GRANTS FOR CURRENT_USER();", - null, - null, - self::CONNECT_USER, - self::QUERY_STORE - ); - if ($grants) { - foreach ($grants as $grant) { - if ($type === 'create') { - if (strpos($grant, "ALL PRIVILEGES ON *.*") !== false - || strpos($grant, "CREATE USER") !== false - ) { - $is = true; - break; - } - } elseif ($type === 'grant') { - if (strpos($grant, "WITH GRANT OPTION") !== false) { - $is = true; - break; - } - } - } - } - } - - Util::cacheSet('is_' . $type . 'user', $is); - return $is; - } - - /** - * Get the current user and host - * - * @return array array of username and hostname - */ - public function getCurrentUserAndHost(): array - { - if (count($this->_current_user) === 0) { - $user = $this->getCurrentUser(); - $this->_current_user = explode("@", $user); - } - return $this->_current_user; - } - - /** - * Returns value for lower_case_table_names variable - * - * @return string|bool - */ - public function getLowerCaseNames() - { - if ($this->_lower_case_table_names === null) { - $this->_lower_case_table_names = $this->fetchValue( - "SELECT @@lower_case_table_names" - ); - } - return $this->_lower_case_table_names; - } - - /** - * Get the list of system schemas - * - * @return array list of system schemas - */ - public function getSystemSchemas(): array - { - $schemas = [ - 'information_schema', - 'performance_schema', - 'mysql', - 'sys', - ]; - $systemSchemas = []; - foreach ($schemas as $schema) { - if ($this->isSystemSchema($schema, true)) { - $systemSchemas[] = $schema; - } - } - return $systemSchemas; - } - - /** - * Checks whether given schema is a system schema - * - * @param string $schema_name Name of schema (database) to test - * @param bool $testForMysqlSchema Whether 'mysql' schema should - * be treated the same as IS and DD - * - * @return bool - */ - public function isSystemSchema( - string $schema_name, - bool $testForMysqlSchema = false - ): bool { - $schema_name = strtolower($schema_name); - return $schema_name == 'information_schema' - || $schema_name == 'performance_schema' - || ($schema_name == 'mysql' && $testForMysqlSchema) - || $schema_name == 'sys'; - } - - /** - * Return connection parameters for the database server - * - * @param integer $mode Connection mode on of CONNECT_USER, CONNECT_CONTROL - * or CONNECT_AUXILIARY. - * @param array|null $server Server information like host/port/socket/persistent - * - * @return array user, host and server settings array - */ - public function getConnectionParams(int $mode, ?array $server = null): array - { - global $cfg; - - $user = null; - $password = null; - - if ($mode == DatabaseInterface::CONNECT_USER) { - $user = $cfg['Server']['user']; - $password = $cfg['Server']['password']; - $server = $cfg['Server']; - } elseif ($mode == DatabaseInterface::CONNECT_CONTROL) { - $user = $cfg['Server']['controluser']; - $password = $cfg['Server']['controlpass']; - - $server = []; - - if (! empty($cfg['Server']['controlhost'])) { - $server['host'] = $cfg['Server']['controlhost']; - } else { - $server['host'] = $cfg['Server']['host']; - } - // Share the settings if the host is same - if ($server['host'] == $cfg['Server']['host']) { - $shared = [ - 'port', - 'socket', - 'compress', - 'ssl', - 'ssl_key', - 'ssl_cert', - 'ssl_ca', - 'ssl_ca_path', - 'ssl_ciphers', - 'ssl_verify', - ]; - foreach ($shared as $item) { - if (isset($cfg['Server'][$item])) { - $server[$item] = $cfg['Server'][$item]; - } - } - } - // Set configured port - if (! empty($cfg['Server']['controlport'])) { - $server['port'] = $cfg['Server']['controlport']; - } - // Set any configuration with control_ prefix - foreach ($cfg['Server'] as $key => $val) { - if (substr($key, 0, 8) === 'control_') { - $server[substr($key, 8)] = $val; - } - } - } else { - if ($server === null) { - return [ - null, - null, - null, - ]; - } - if (isset($server['user'])) { - $user = $server['user']; - } - if (isset($server['password'])) { - $password = $server['password']; - } - } - - // Perform sanity checks on some variables - if (empty($server['port'])) { - $server['port'] = 0; - } else { - $server['port'] = intval($server['port']); - } - if (empty($server['socket'])) { - $server['socket'] = null; - } - if (empty($server['host'])) { - $server['host'] = 'localhost'; - } - if (! isset($server['ssl'])) { - $server['ssl'] = false; - } - if (! isset($server['compress'])) { - $server['compress'] = false; - } - - return [ - $user, - $password, - $server, - ]; - } - - /** - * connects to the database server - * - * @param integer $mode Connection mode on of CONNECT_USER, CONNECT_CONTROL - * or CONNECT_AUXILIARY. - * @param array|null $server Server information like host/port/socket/persistent - * @param integer $target How to store connection link, defaults to $mode - * - * @return mixed false on error or a connection object on success - */ - public function connect(int $mode, ?array $server = null, ?int $target = null) - { - list($user, $password, $server) = $this->getConnectionParams($mode, $server); - - if ($target === null) { - $target = $mode; - } - - if ($user === null || $password === null) { - trigger_error( - __('Missing connection parameters!'), - E_USER_WARNING - ); - return false; - } - - // Do not show location and backtrace for connection errors - $GLOBALS['error_handler']->setHideLocation(true); - $result = $this->_extension->connect( - $user, - $password, - $server - ); - $GLOBALS['error_handler']->setHideLocation(false); - - if ($result) { - $this->_links[$target] = $result; - /* Run post connect for user connections */ - if ($target == DatabaseInterface::CONNECT_USER) { - $this->postConnect(); - } - return $result; - } - - if ($mode == DatabaseInterface::CONNECT_CONTROL) { - trigger_error( - __( - 'Connection for controluser as defined in your ' - . 'configuration failed.' - ), - E_USER_WARNING - ); - return false; - } elseif ($mode == DatabaseInterface::CONNECT_AUXILIARY) { - // Do not go back to main login if connection failed - // (currently used only in unit testing) - return false; - } - - return $result; - } - - /** - * selects given database - * - * @param string $dbname database name to select - * @param integer $link link type - * - * @return boolean - */ - public function selectDb(string $dbname, $link = DatabaseInterface::CONNECT_USER): bool - { - if (! isset($this->_links[$link])) { - return false; - } - return $this->_extension->selectDb($dbname, $this->_links[$link]); - } - - /** - * returns array of rows with associative and numeric keys from $result - * - * @param object $result result set identifier - * - * @return array - */ - public function fetchArray($result) - { - return $this->_extension->fetchArray($result); - } - - /** - * returns array of rows with associative keys from $result - * - * @param object $result result set identifier - * - * @return array|bool - */ - public function fetchAssoc($result) - { - return $this->_extension->fetchAssoc($result); - } - - /** - * returns array of rows with numeric keys from $result - * - * @param object $result result set identifier - * - * @return array|bool - */ - public function fetchRow($result) - { - return $this->_extension->fetchRow($result); - } - - /** - * Adjusts the result pointer to an arbitrary row in the result - * - * @param object $result database result - * @param integer $offset offset to seek - * - * @return bool true on success, false on failure - */ - public function dataSeek($result, int $offset): bool - { - return $this->_extension->dataSeek($result, $offset); - } - - /** - * Frees memory associated with the result - * - * @param object $result database result - * - * @return void - */ - public function freeResult($result): void - { - $this->_extension->freeResult($result); - } - - /** - * Check if there are any more query results from a multi query - * - * @param integer $link link type - * - * @return bool true or false - */ - public function moreResults($link = DatabaseInterface::CONNECT_USER): bool - { - if (! isset($this->_links[$link])) { - return false; - } - return $this->_extension->moreResults($this->_links[$link]); - } - - /** - * Prepare next result from multi_query - * - * @param integer $link link type - * - * @return bool true or false - */ - public function nextResult($link = DatabaseInterface::CONNECT_USER): bool - { - if (! isset($this->_links[$link])) { - return false; - } - return $this->_extension->nextResult($this->_links[$link]); - } - - /** - * Store the result returned from multi query - * - * @param integer $link link type - * - * @return mixed false when empty results / result set when not empty - */ - public function storeResult($link = DatabaseInterface::CONNECT_USER) - { - if (! isset($this->_links[$link])) { - return false; - } - return $this->_extension->storeResult($this->_links[$link]); - } - - /** - * Returns a string representing the type of connection used - * - * @param integer $link link type - * - * @return string|bool type of connection used - */ - public function getHostInfo($link = DatabaseInterface::CONNECT_USER) - { - if (! isset($this->_links[$link])) { - return false; - } - return $this->_extension->getHostInfo($this->_links[$link]); - } - - /** - * Returns the version of the MySQL protocol used - * - * @param integer $link link type - * - * @return int|bool version of the MySQL protocol used - */ - public function getProtoInfo($link = DatabaseInterface::CONNECT_USER) - { - if (! isset($this->_links[$link])) { - return false; - } - return $this->_extension->getProtoInfo($this->_links[$link]); - } - - /** - * returns a string that represents the client library version - * - * @param integer $link link type - * - * @return string MySQL client library version - */ - public function getClientInfo($link = DatabaseInterface::CONNECT_USER): string - { - if (! isset($this->_links[$link])) { - return ''; - } - return $this->_extension->getClientInfo($this->_links[$link]); - } - - /** - * returns last error message or false if no errors occurred - * - * @param integer $link link type - * - * @return string|bool error or false - */ - public function getError($link = DatabaseInterface::CONNECT_USER) - { - if (! isset($this->_links[$link])) { - return false; - } - return $this->_extension->getError($this->_links[$link]); - } - - /** - * returns the number of rows returned by last query - * - * @param object $result result set identifier - * - * @return string|int - */ - public function numRows($result) - { - return $this->_extension->numRows($result); - } - - /** - * returns last inserted auto_increment id for given $link - * or $GLOBALS['userlink'] - * - * @param integer $link link type - * - * @return int|boolean - */ - public function insertId($link = DatabaseInterface::CONNECT_USER) - { - // If the primary key is BIGINT we get an incorrect result - // (sometimes negative, sometimes positive) - // and in the present function we don't know if the PK is BIGINT - // so better play safe and use LAST_INSERT_ID() - // - // When no controluser is defined, using mysqli_insert_id($link) - // does not always return the last insert id due to a mixup with - // the tracking mechanism, but this works: - return $this->fetchValue('SELECT LAST_INSERT_ID();', 0, 0, $link); - } - - /** - * returns the number of rows affected by last query - * - * @param integer $link link type - * @param bool $get_from_cache whether to retrieve from cache - * - * @return int|boolean - */ - public function affectedRows( - $link = DatabaseInterface::CONNECT_USER, - bool $get_from_cache = true - ) { - if (! isset($this->_links[$link])) { - return false; - } - - if ($get_from_cache) { - return $GLOBALS['cached_affected_rows']; - } - - return $this->_extension->affectedRows($this->_links[$link]); - } - - /** - * returns metainfo for fields in $result - * - * @param object $result result set identifier - * - * @return mixed meta info for fields in $result - */ - public function getFieldsMeta($result) - { - $result = $this->_extension->getFieldsMeta($result); - - if ($this->getLowerCaseNames() === '2') { - /** - * Fixup orgtable for lower_case_table_names = 2 - * - * In this setup MySQL server reports table name lower case - * but we still need to operate on original case to properly - * match existing strings - */ - foreach ($result as $value) { - if (strlen($value->orgtable) !== 0 && - mb_strtolower($value->orgtable) === mb_strtolower($value->table)) { - $value->orgtable = $value->table; - } - } - } - - return $result; - } - - /** - * return number of fields in given $result - * - * @param object $result result set identifier - * - * @return int field count - */ - public function numFields($result): int - { - return $this->_extension->numFields($result); - } - - /** - * returns the length of the given field $i in $result - * - * @param object $result result set identifier - * @param int $i field - * - * @return int|bool length of field - */ - public function fieldLen($result, int $i) - { - return $this->_extension->fieldLen($result, $i); - } - - /** - * returns name of $i. field in $result - * - * @param object $result result set identifier - * @param int $i field - * - * @return string name of $i. field in $result - */ - public function fieldName($result, int $i): string - { - return $this->_extension->fieldName($result, $i); - } - - /** - * returns concatenated string of human readable field flags - * - * @param object $result result set identifier - * @param int $i field - * - * @return string field flags - */ - public function fieldFlags($result, $i): string - { - return $this->_extension->fieldFlags($result, $i); - } - - /** - * returns properly escaped string for use in MySQL queries - * - * @param string $str string to be escaped - * @param mixed $link optional database link to use - * - * @return string a MySQL escaped string - */ - public function escapeString(string $str, $link = DatabaseInterface::CONNECT_USER) - { - if ($this->_extension === null || ! isset($this->_links[$link])) { - return $str; - } - - return $this->_extension->escapeString($this->_links[$link], $str); - } - - /** - * Checks if this database server is running on Amazon RDS. - * - * @return boolean - */ - public function isAmazonRds(): bool - { - if (Util::cacheExists('is_amazon_rds')) { - return Util::cacheGet('is_amazon_rds'); - } - $sql = 'SELECT @@basedir'; - $result = $this->fetchValue($sql); - $rds = (substr($result, 0, 10) == '/rdsdbbin/'); - Util::cacheSet('is_amazon_rds', $rds); - - return $rds; - } - - /** - * Gets SQL for killing a process. - * - * @param int $process Process ID - * - * @return string - */ - public function getKillQuery(int $process): string - { - if ($this->isAmazonRds()) { - return 'CALL mysql.rds_kill(' . $process . ');'; - } - - return 'KILL ' . $process . ';'; - } - - /** - * Get the phpmyadmin database manager - * - * @return SystemDatabase - */ - public function getSystemDatabase(): SystemDatabase - { - return new SystemDatabase($this); - } - - /** - * Get a table with database name and table name - * - * @param string $db_name DB name - * @param string $table_name Table name - * - * @return Table - */ - public function getTable(string $db_name, string $table_name): Table - { - return new Table($table_name, $db_name, $this); - } - - /** - * returns collation of given db - * - * @param string $db name of db - * - * @return string collation of $db - */ - public function getDbCollation(string $db): string - { - if ($this->isSystemSchema($db)) { - // We don't have to check the collation of the virtual - // information_schema database: We know it! - return 'utf8_general_ci'; - } - - if (! $GLOBALS['cfg']['Server']['DisableIS']) { - // this is slow with thousands of databases - $sql = 'SELECT DEFAULT_COLLATION_NAME FROM information_schema.SCHEMATA' - . ' WHERE SCHEMA_NAME = \'' . $this->escapeString($db) - . '\' LIMIT 1'; - return $this->fetchValue($sql); - } - - $this->selectDb($db); - $return = $this->fetchValue('SELECT @@collation_database'); - if ($db !== $GLOBALS['db']) { - $this->selectDb($GLOBALS['db']); - } - return $return; - } - - /** - * returns default server collation from show variables - * - * @return string - */ - public function getServerCollation(): string - { - return $this->fetchValue('SELECT @@collation_server'); - } - - /** - * Server version as number - * - * @return integer - */ - public function getVersion(): int - { - return $this->_version_int; - } - - /** - * Server version - * - * @return string - */ - public function getVersionString(): string - { - return $this->_version_str; - } - - /** - * Server version comment - * - * @return string - */ - public function getVersionComment(): string - { - return $this->_version_comment; - } - - /** - * Whether connection is MariaDB - * - * @return boolean - */ - public function isMariaDB(): bool - { - return $this->_is_mariadb; - } - - /** - * Whether connection is Percona - * - * @return boolean - */ - public function isPercona(): bool - { - return $this->_is_percona; - } - - /** - * Load correct database driver - * - * @param DbiExtension|null $extension Force the use of an alternative extension - * - * @return self - */ - public static function load(?DbiExtension $extension = null): self - { - global $dbi; - - if ($extension !== null) { - $dbi = new self($extension); - return $dbi; - } - - if (! self::checkDbExtension('mysqli')) { - $docUrl = Util::getDocuLink('faq', 'faqmysql'); - $docLink = sprintf( - __('See %sour documentation%s for more information.'), - '[a@' . $docUrl . '@documentation]', - '[/a]' - ); - Core::warnMissingExtension( - 'mysqli', - true, - $docLink - ); - } - - $dbi = new self(new DbiMysqli()); - return $dbi; - } -} |