1791 lines
67 KiB
PHP
1791 lines
67 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpMyAdmin\ConfigStorage;
|
|
|
|
use PhpMyAdmin\ConfigStorage\Features\PdfFeature;
|
|
use PhpMyAdmin\DatabaseInterface;
|
|
use PhpMyAdmin\Dbal\Connection;
|
|
use PhpMyAdmin\Identifiers\DatabaseName;
|
|
use PhpMyAdmin\Identifiers\TableName;
|
|
use PhpMyAdmin\InternalRelations;
|
|
use PhpMyAdmin\SqlParser\Parser;
|
|
use PhpMyAdmin\SqlParser\Statements\CreateStatement;
|
|
use PhpMyAdmin\SqlParser\Utils\Table as TableUtils;
|
|
use PhpMyAdmin\Table;
|
|
use PhpMyAdmin\Util;
|
|
use PhpMyAdmin\Version;
|
|
|
|
use function __;
|
|
use function array_fill_keys;
|
|
use function array_keys;
|
|
use function array_reverse;
|
|
use function array_search;
|
|
use function array_shift;
|
|
use function asort;
|
|
use function bin2hex;
|
|
use function count;
|
|
use function explode;
|
|
use function file_get_contents;
|
|
use function htmlspecialchars;
|
|
use function implode;
|
|
use function in_array;
|
|
use function is_array;
|
|
use function is_scalar;
|
|
use function is_string;
|
|
use function ksort;
|
|
use function mb_check_encoding;
|
|
use function mb_strlen;
|
|
use function mb_strtolower;
|
|
use function mb_strtoupper;
|
|
use function mb_substr;
|
|
use function natcasesort;
|
|
use function preg_match;
|
|
use function sprintf;
|
|
use function str_contains;
|
|
use function str_replace;
|
|
use function strlen;
|
|
use function trim;
|
|
use function uksort;
|
|
use function usort;
|
|
|
|
use const SQL_DIR;
|
|
|
|
/**
|
|
* Set of functions used with the relation and PDF feature
|
|
*/
|
|
class Relation
|
|
{
|
|
/** @var RelationParameters[] $cache */
|
|
private static array $cache = [];
|
|
|
|
public function __construct(public DatabaseInterface $dbi)
|
|
{
|
|
}
|
|
|
|
public function getRelationParameters(): RelationParameters
|
|
{
|
|
$server = $GLOBALS['server'];
|
|
|
|
if (isset(self::$cache[$server])) {
|
|
return self::$cache[$server];
|
|
}
|
|
|
|
if (! isset($_SESSION['relation']) || ! is_array($_SESSION['relation'])) {
|
|
$_SESSION['relation'] = [];
|
|
}
|
|
|
|
if (
|
|
isset($_SESSION['relation'][$server]) && is_array($_SESSION['relation'][$server])
|
|
&& isset($_SESSION['relation'][$server]['version'])
|
|
&& $_SESSION['relation'][$server]['version'] === Version::VERSION
|
|
) {
|
|
self::$cache[$server] = RelationParameters::fromArray($_SESSION['relation'][$server]);
|
|
|
|
return self::$cache[$server];
|
|
}
|
|
|
|
self::$cache[$server] = RelationParameters::fromArray($this->checkRelationsParam());
|
|
$_SESSION['relation'][$server] = self::$cache[$server]->toArray();
|
|
|
|
return self::$cache[$server];
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool|string|null> $relationParams
|
|
*
|
|
* @return array<string, bool|string|null>
|
|
*/
|
|
private function checkTableAccess(array $relationParams): array
|
|
{
|
|
if (isset($relationParams['relation'], $relationParams['table_info'])) {
|
|
if ($this->canAccessStorageTable((string) $relationParams['table_info'])) {
|
|
$relationParams['displaywork'] = true;
|
|
}
|
|
}
|
|
|
|
if (isset($relationParams['table_coords'], $relationParams['pdf_pages'])) {
|
|
if ($this->canAccessStorageTable((string) $relationParams['table_coords'])) {
|
|
if ($this->canAccessStorageTable((string) $relationParams['pdf_pages'])) {
|
|
$relationParams['pdfwork'] = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isset($relationParams['column_info'])) {
|
|
if ($this->canAccessStorageTable((string) $relationParams['column_info'])) {
|
|
$relationParams['commwork'] = true;
|
|
// phpMyAdmin 4.3+
|
|
// Check for input transformations upgrade.
|
|
$relationParams['mimework'] = $this->tryUpgradeTransformations();
|
|
}
|
|
}
|
|
|
|
if (isset($relationParams['users'], $relationParams['usergroups'])) {
|
|
if ($this->canAccessStorageTable((string) $relationParams['users'])) {
|
|
if ($this->canAccessStorageTable((string) $relationParams['usergroups'])) {
|
|
$relationParams['menuswork'] = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
$settings = [
|
|
'export_templates' => 'exporttemplateswork',
|
|
'designer_settings' => 'designersettingswork',
|
|
'central_columns' => 'centralcolumnswork',
|
|
'savedsearches' => 'savedsearcheswork',
|
|
'navigationhiding' => 'navwork',
|
|
'bookmark' => 'bookmarkwork',
|
|
'userconfig' => 'userconfigwork',
|
|
'tracking' => 'trackingwork',
|
|
'table_uiprefs' => 'uiprefswork',
|
|
'favorite' => 'favoritework',
|
|
'recent' => 'recentwork',
|
|
'history' => 'historywork',
|
|
'relation' => 'relwork',
|
|
];
|
|
|
|
foreach ($settings as $setingName => $worksKey) {
|
|
if (! isset($relationParams[$setingName])) {
|
|
continue;
|
|
}
|
|
|
|
if (! $this->canAccessStorageTable((string) $relationParams[$setingName])) {
|
|
continue;
|
|
}
|
|
|
|
$relationParams[$worksKey] = true;
|
|
}
|
|
|
|
return $relationParams;
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool|string|null> $relationParams
|
|
*
|
|
* @return array<string, bool|string|null>|null
|
|
*/
|
|
private function fillRelationParamsWithTableNames(array $relationParams): array|null
|
|
{
|
|
if ($this->arePmadbTablesAllDisabled()) {
|
|
return null;
|
|
}
|
|
|
|
$tabQuery = 'SHOW TABLES FROM '
|
|
. Util::backquote($GLOBALS['cfg']['Server']['pmadb']);
|
|
$tableRes = $this->dbi->tryQueryAsControlUser($tabQuery);
|
|
if ($tableRes === false) {
|
|
return null;
|
|
}
|
|
|
|
while ($currTable = $tableRes->fetchRow()) {
|
|
if ($currTable[0] == $GLOBALS['cfg']['Server']['bookmarktable']) {
|
|
$relationParams['bookmark'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['relation']) {
|
|
$relationParams['relation'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['table_info']) {
|
|
$relationParams['table_info'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['table_coords']) {
|
|
$relationParams['table_coords'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['column_info']) {
|
|
$relationParams['column_info'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['pdf_pages']) {
|
|
$relationParams['pdf_pages'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['history']) {
|
|
$relationParams['history'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['recent']) {
|
|
$relationParams['recent'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['favorite']) {
|
|
$relationParams['favorite'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['table_uiprefs']) {
|
|
$relationParams['table_uiprefs'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['tracking']) {
|
|
$relationParams['tracking'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['userconfig']) {
|
|
$relationParams['userconfig'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['users']) {
|
|
$relationParams['users'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['usergroups']) {
|
|
$relationParams['usergroups'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['navigationhiding']) {
|
|
$relationParams['navigationhiding'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['savedsearches']) {
|
|
$relationParams['savedsearches'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['central_columns']) {
|
|
$relationParams['central_columns'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['designer_settings']) {
|
|
$relationParams['designer_settings'] = (string) $currTable[0];
|
|
} elseif ($currTable[0] == $GLOBALS['cfg']['Server']['export_templates']) {
|
|
$relationParams['export_templates'] = (string) $currTable[0];
|
|
}
|
|
}
|
|
|
|
return $relationParams;
|
|
}
|
|
|
|
/**
|
|
* Defines the relation parameters for the current user
|
|
* just a copy of the functions used for relations ;-)
|
|
* but added some stuff to check what will work
|
|
*
|
|
* @return array<string, bool|string|null> the relation parameters for the current user
|
|
*/
|
|
private function checkRelationsParam(): array
|
|
{
|
|
$workToTable = [
|
|
'relwork' => 'relation',
|
|
'displaywork' => ['relation', 'table_info'],
|
|
'bookmarkwork' => 'bookmarktable',
|
|
'pdfwork' => ['table_coords', 'pdf_pages'],
|
|
'commwork' => 'column_info',
|
|
'mimework' => 'column_info',
|
|
'historywork' => 'history',
|
|
'recentwork' => 'recent',
|
|
'favoritework' => 'favorite',
|
|
'uiprefswork' => 'table_uiprefs',
|
|
'trackingwork' => 'tracking',
|
|
'userconfigwork' => 'userconfig',
|
|
'menuswork' => ['users', 'usergroups'],
|
|
'navwork' => 'navigationhiding',
|
|
'savedsearcheswork' => 'savedsearches',
|
|
'centralcolumnswork' => 'central_columns',
|
|
'designersettingswork' => 'designer_settings',
|
|
'exporttemplateswork' => 'export_templates',
|
|
];
|
|
|
|
$relationParams = array_fill_keys(array_keys($workToTable), false);
|
|
|
|
$relationParams['version'] = Version::VERSION;
|
|
$relationParams['allworks'] = false;
|
|
$relationParams['user'] = null;
|
|
$relationParams['db'] = null;
|
|
|
|
if (
|
|
$GLOBALS['server'] == 0
|
|
|| empty($GLOBALS['cfg']['Server']['pmadb'])
|
|
|| ! $this->dbi->selectDb($GLOBALS['cfg']['Server']['pmadb'], Connection::TYPE_CONTROL)
|
|
) {
|
|
// No server selected -> no bookmark table
|
|
// we return the array with the falses in it,
|
|
// to avoid some 'Uninitialized string offset' errors later
|
|
$GLOBALS['cfg']['Server']['pmadb'] = false;
|
|
|
|
return $relationParams;
|
|
}
|
|
|
|
$relationParams['user'] = $GLOBALS['cfg']['Server']['user'];
|
|
$relationParams['db'] = $GLOBALS['cfg']['Server']['pmadb'];
|
|
|
|
// Now I just check if all tables that i need are present so I can for
|
|
// example enable relations but not pdf...
|
|
// I was thinking of checking if they have all required columns but I
|
|
// fear it might be too slow
|
|
|
|
$relationParamsFilled = $this->fillRelationParamsWithTableNames($relationParams);
|
|
|
|
if ($relationParamsFilled === null) {
|
|
// query failed ... ?
|
|
//$GLOBALS['cfg']['Server']['pmadb'] = false;
|
|
return $relationParams;
|
|
}
|
|
|
|
// Filling did success
|
|
$relationParams = $relationParamsFilled;
|
|
|
|
$relationParams = $this->checkTableAccess($relationParams);
|
|
|
|
$allWorks = true;
|
|
foreach ($workToTable as $work => $table) {
|
|
if ($relationParams[$work]) {
|
|
continue;
|
|
}
|
|
|
|
if (is_string($table)) {
|
|
if (isset($GLOBALS['cfg']['Server'][$table]) && $GLOBALS['cfg']['Server'][$table] !== false) {
|
|
$allWorks = false;
|
|
break;
|
|
}
|
|
} else {
|
|
$oneNull = false;
|
|
foreach ($table as $t) {
|
|
if (isset($GLOBALS['cfg']['Server'][$t]) && $GLOBALS['cfg']['Server'][$t] === false) {
|
|
$oneNull = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (! $oneNull) {
|
|
$allWorks = false;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
$relationParams['allworks'] = $allWorks;
|
|
|
|
return $relationParams;
|
|
}
|
|
|
|
/**
|
|
* Check if the table is accessible
|
|
*
|
|
* @param string $tableDbName The table or table.db
|
|
*/
|
|
public function canAccessStorageTable(string $tableDbName): bool
|
|
{
|
|
$result = $this->dbi->tryQueryAsControlUser('SELECT NULL FROM ' . Util::backquote($tableDbName) . ' LIMIT 0');
|
|
|
|
return $result !== false;
|
|
}
|
|
|
|
/**
|
|
* Check whether column_info table input transformation
|
|
* upgrade is required and try to upgrade silently
|
|
*/
|
|
public function tryUpgradeTransformations(): bool
|
|
{
|
|
// From 4.3, new input oriented transformation feature was introduced.
|
|
// Check whether column_info table has input transformation columns
|
|
$newCols = ['input_transformation', 'input_transformation_options'];
|
|
$query = 'SHOW COLUMNS FROM '
|
|
. Util::backquote($GLOBALS['cfg']['Server']['pmadb'])
|
|
. '.' . Util::backquote($GLOBALS['cfg']['Server']['column_info'])
|
|
. ' WHERE Field IN (\'' . implode('\', \'', $newCols) . '\')';
|
|
$result = $this->dbi->tryQueryAsControlUser($query);
|
|
if ($result) {
|
|
$rows = $result->numRows();
|
|
unset($result);
|
|
// input transformations are present
|
|
// no need to upgrade
|
|
if ($rows === 2) {
|
|
return true;
|
|
|
|
// try silent upgrade without disturbing the user
|
|
}
|
|
|
|
// read upgrade query file
|
|
$query = @file_get_contents(SQL_DIR . 'upgrade_column_info_4_3_0+.sql');
|
|
// replace database name from query to with set in config.inc.php
|
|
// replace pma__column_info table name from query
|
|
// to with set in config.inc.php
|
|
$query = str_replace(
|
|
['`phpmyadmin`', '`pma__column_info`'],
|
|
[
|
|
Util::backquote($GLOBALS['cfg']['Server']['pmadb']),
|
|
Util::backquote($GLOBALS['cfg']['Server']['column_info']),
|
|
],
|
|
(string) $query,
|
|
);
|
|
$this->dbi->tryMultiQuery($query, Connection::TYPE_CONTROL);
|
|
// skips result sets of query as we are not interested in it
|
|
do {
|
|
$hasResult = (
|
|
$this->dbi->moreResults(Connection::TYPE_CONTROL)
|
|
&& $this->dbi->nextResult(Connection::TYPE_CONTROL)
|
|
);
|
|
} while ($hasResult);
|
|
|
|
$error = $this->dbi->getError(Connection::TYPE_CONTROL);
|
|
|
|
// return true if no error exists otherwise false
|
|
return $error === '';
|
|
}
|
|
|
|
// some failure, either in upgrading or something else
|
|
// make some noise, time to wake up user.
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Gets all Relations to foreign tables for a given table or
|
|
* optionally a given column in a table
|
|
*
|
|
* @param string $db the name of the db to check for
|
|
* @param string $table the name of the table to check for
|
|
* @param string $column the name of the column to check for
|
|
* @param string $source the source for foreign key information
|
|
*
|
|
* @return mixed[] db,table,column
|
|
*/
|
|
public function getForeigners(string $db, string $table, string $column = '', string $source = 'both'): array
|
|
{
|
|
$relationFeature = $this->getRelationParameters()->relationFeature;
|
|
$foreign = [];
|
|
|
|
if ($relationFeature !== null && ($source === 'both' || $source === 'internal')) {
|
|
$relQuery = 'SELECT `master_field`, `foreign_db`, '
|
|
. '`foreign_table`, `foreign_field`'
|
|
. ' FROM ' . Util::backquote($relationFeature->database)
|
|
. '.' . Util::backquote($relationFeature->relation)
|
|
. ' WHERE `master_db` = ' . $this->dbi->quoteString($db)
|
|
. ' AND `master_table` = ' . $this->dbi->quoteString($table);
|
|
if (strlen($column) > 0) {
|
|
$relQuery .= ' AND `master_field` = ' . $this->dbi->quoteString($column);
|
|
}
|
|
|
|
$foreign = $this->dbi->fetchResult($relQuery, 'master_field', null, Connection::TYPE_CONTROL);
|
|
}
|
|
|
|
if (($source === 'both' || $source === 'foreign') && strlen($table) > 0) {
|
|
$tableObj = new Table($table, $db, $this->dbi);
|
|
$showCreateTable = $tableObj->showCreate();
|
|
if ($showCreateTable) {
|
|
$parser = new Parser($showCreateTable);
|
|
$stmt = $parser->statements[0];
|
|
$foreign['foreign_keys_data'] = [];
|
|
if ($stmt instanceof CreateStatement) {
|
|
$foreign['foreign_keys_data'] = TableUtils::getForeignKeys($stmt);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Emulating relations for some information_schema tables
|
|
*/
|
|
$isInformationSchema = mb_strtolower($db) === 'information_schema';
|
|
$isMysql = mb_strtolower($db) === 'mysql';
|
|
if (($isInformationSchema || $isMysql) && ($source === 'internal' || $source === 'both')) {
|
|
if ($isInformationSchema) {
|
|
$internalRelations = InternalRelations::getInformationSchema();
|
|
} else {
|
|
$internalRelations = InternalRelations::getMySql();
|
|
}
|
|
|
|
if (isset($internalRelations[$table])) {
|
|
foreach ($internalRelations[$table] as $field => $relations) {
|
|
if (
|
|
(strlen($column) !== 0 && $column != $field)
|
|
|| (isset($foreign[$field])
|
|
&& strlen($foreign[$field]) !== 0)
|
|
) {
|
|
continue;
|
|
}
|
|
|
|
$foreign[$field] = $relations;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $foreign;
|
|
}
|
|
|
|
/**
|
|
* Gets the display field of a table
|
|
*
|
|
* @param string $db the name of the db to check for
|
|
* @param string $table the name of the table to check for
|
|
*
|
|
* @return string field name
|
|
*/
|
|
public function getDisplayField(string $db, string $table): string
|
|
{
|
|
$displayFeature = $this->getRelationParameters()->displayFeature;
|
|
|
|
/**
|
|
* Try to fetch the display field from DB.
|
|
*/
|
|
if ($displayFeature !== null) {
|
|
$dispQuery = 'SELECT `display_field`'
|
|
. ' FROM ' . Util::backquote($displayFeature->database)
|
|
. '.' . Util::backquote($displayFeature->tableInfo)
|
|
. ' WHERE `db_name` = ' . $this->dbi->quoteString($db)
|
|
. ' AND `table_name` = ' . $this->dbi->quoteString($table);
|
|
|
|
$row = $this->dbi->fetchSingleRow($dispQuery, DatabaseInterface::FETCH_ASSOC, Connection::TYPE_CONTROL);
|
|
if (isset($row['display_field'])) {
|
|
return $row['display_field'];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Emulating the display field for some information_schema tables.
|
|
*/
|
|
if ($db === 'information_schema') {
|
|
switch ($table) {
|
|
case 'CHARACTER_SETS':
|
|
return 'DESCRIPTION';
|
|
|
|
case 'TABLES':
|
|
return 'TABLE_COMMENT';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Pick first char field
|
|
*/
|
|
$columns = $this->dbi->getColumnsFull($db, $table);
|
|
foreach ($columns as $column) {
|
|
if ($this->dbi->types->getTypeClass($column['DATA_TYPE']) === 'CHAR') {
|
|
return $column['COLUMN_NAME'];
|
|
}
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Gets the comments for all columns of a table or the db itself
|
|
*
|
|
* @param string $db the name of the db to check for
|
|
* @param string $table the name of the table to check for
|
|
*
|
|
* @return string[] [column_name] = comment
|
|
*/
|
|
public function getComments(string $db, string $table = ''): array
|
|
{
|
|
if ($table === '') {
|
|
return [$this->getDbComment($db)];
|
|
}
|
|
|
|
$comments = [];
|
|
|
|
// MySQL native column comments
|
|
$columns = $this->dbi->getColumns($db, $table, true);
|
|
foreach ($columns as $column) {
|
|
if ($column['Comment'] === '') {
|
|
continue;
|
|
}
|
|
|
|
$comments[$column['Field']] = $column['Comment'];
|
|
}
|
|
|
|
return $comments;
|
|
}
|
|
|
|
/**
|
|
* Gets the comment for a db
|
|
*
|
|
* @param string $db the name of the db to check for
|
|
*/
|
|
public function getDbComment(string $db): string
|
|
{
|
|
$columnCommentsFeature = $this->getRelationParameters()->columnCommentsFeature;
|
|
if ($columnCommentsFeature !== null) {
|
|
// pmadb internal db comment
|
|
$comQry = 'SELECT `comment`'
|
|
. ' FROM ' . Util::backquote($columnCommentsFeature->database)
|
|
. '.' . Util::backquote($columnCommentsFeature->columnInfo)
|
|
. ' WHERE db_name = ' . $this->dbi->quoteString($db, Connection::TYPE_CONTROL)
|
|
. ' AND table_name = \'\''
|
|
. ' AND column_name = \'(db_comment)\'';
|
|
$comRs = $this->dbi->tryQueryAsControlUser($comQry);
|
|
|
|
if ($comRs && $comRs->numRows() > 0) {
|
|
$row = $comRs->fetchAssoc();
|
|
|
|
return (string) $row['comment'];
|
|
}
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Gets the comment for a db
|
|
*
|
|
* @return mixed[] comments
|
|
*/
|
|
public function getDbComments(): array
|
|
{
|
|
$columnCommentsFeature = $this->getRelationParameters()->columnCommentsFeature;
|
|
|
|
if ($columnCommentsFeature !== null) {
|
|
// pmadb internal db comment
|
|
$comQry = 'SELECT `db_name`, `comment`'
|
|
. ' FROM ' . Util::backquote($columnCommentsFeature->database)
|
|
. '.' . Util::backquote($columnCommentsFeature->columnInfo)
|
|
. ' WHERE `column_name` = \'(db_comment)\'';
|
|
$comRs = $this->dbi->tryQueryAsControlUser($comQry);
|
|
|
|
if ($comRs && $comRs->numRows() > 0) {
|
|
return $comRs->fetchAllKeyPair();
|
|
}
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Set a database comment to a certain value.
|
|
*
|
|
* @param string $db the name of the db
|
|
* @param string $comment the value of the column
|
|
*/
|
|
public function setDbComment(string $db, string $comment = ''): bool
|
|
{
|
|
$columnCommentsFeature = $this->getRelationParameters()->columnCommentsFeature;
|
|
if ($columnCommentsFeature === null) {
|
|
return false;
|
|
}
|
|
|
|
if (strlen($comment) > 0) {
|
|
$updQuery = 'INSERT INTO '
|
|
. Util::backquote($columnCommentsFeature->database) . '.'
|
|
. Util::backquote($columnCommentsFeature->columnInfo)
|
|
. ' (`db_name`, `table_name`, `column_name`, `comment`)'
|
|
. ' VALUES ('
|
|
. $this->dbi->quoteString($db, Connection::TYPE_CONTROL)
|
|
. ", '', '(db_comment)', "
|
|
. $this->dbi->quoteString($comment, Connection::TYPE_CONTROL)
|
|
. ') '
|
|
. ' ON DUPLICATE KEY UPDATE '
|
|
. '`comment` = ' . $this->dbi->quoteString($comment, Connection::TYPE_CONTROL);
|
|
} else {
|
|
$updQuery = 'DELETE FROM '
|
|
. Util::backquote($columnCommentsFeature->database) . '.'
|
|
. Util::backquote($columnCommentsFeature->columnInfo)
|
|
. ' WHERE `db_name` = ' . $this->dbi->quoteString($db, Connection::TYPE_CONTROL)
|
|
. '
|
|
AND `table_name` = \'\'
|
|
AND `column_name` = \'(db_comment)\'';
|
|
}
|
|
|
|
return (bool) $this->dbi->queryAsControlUser($updQuery);
|
|
}
|
|
|
|
/**
|
|
* Set a SQL history entry
|
|
*
|
|
* @param string $db the name of the db
|
|
* @param string $table the name of the table
|
|
* @param string $username the username
|
|
* @param string $sqlquery the sql query
|
|
*/
|
|
public function setHistory(string $db, string $table, string $username, string $sqlquery): void
|
|
{
|
|
$maxCharactersInDisplayedSQL = $GLOBALS['cfg']['MaxCharactersInDisplayedSQL'];
|
|
// Prevent to run this automatically on Footer class destroying in testsuite
|
|
if (mb_strlen($sqlquery) > $maxCharactersInDisplayedSQL) {
|
|
return;
|
|
}
|
|
|
|
$sqlHistoryFeature = $this->getRelationParameters()->sqlHistoryFeature;
|
|
|
|
if (! isset($_SESSION['sql_history'])) {
|
|
$_SESSION['sql_history'] = [];
|
|
}
|
|
|
|
$_SESSION['sql_history'][] = ['db' => $db, 'table' => $table, 'sqlquery' => $sqlquery];
|
|
|
|
if (count($_SESSION['sql_history']) > $GLOBALS['cfg']['QueryHistoryMax']) {
|
|
// history should not exceed a maximum count
|
|
array_shift($_SESSION['sql_history']);
|
|
}
|
|
|
|
if ($sqlHistoryFeature === null || ! $GLOBALS['cfg']['QueryHistoryDB']) {
|
|
return;
|
|
}
|
|
|
|
$this->dbi->queryAsControlUser(
|
|
'INSERT INTO '
|
|
. Util::backquote($sqlHistoryFeature->database) . '.'
|
|
. Util::backquote($sqlHistoryFeature->history) . '
|
|
(`username`,
|
|
`db`,
|
|
`table`,
|
|
`timevalue`,
|
|
`sqlquery`)
|
|
VALUES
|
|
(' . $this->dbi->quoteString($username, Connection::TYPE_CONTROL) . ',
|
|
' . $this->dbi->quoteString($db, Connection::TYPE_CONTROL) . ',
|
|
' . $this->dbi->quoteString($table, Connection::TYPE_CONTROL) . ',
|
|
NOW(),
|
|
' . $this->dbi->quoteString($sqlquery, Connection::TYPE_CONTROL) . ')',
|
|
);
|
|
|
|
$this->purgeHistory($username);
|
|
}
|
|
|
|
/**
|
|
* Gets a SQL history entry
|
|
*
|
|
* @param string $username the username
|
|
*
|
|
* @return mixed[]|bool list of history items
|
|
*/
|
|
public function getHistory(string $username): array|bool
|
|
{
|
|
$sqlHistoryFeature = $this->getRelationParameters()->sqlHistoryFeature;
|
|
if ($sqlHistoryFeature === null) {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* if db-based history is disabled but there exists a session-based
|
|
* history, use it
|
|
*/
|
|
if (! $GLOBALS['cfg']['QueryHistoryDB']) {
|
|
if (isset($_SESSION['sql_history'])) {
|
|
return array_reverse($_SESSION['sql_history']);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
$histQuery = '
|
|
SELECT `db`,
|
|
`table`,
|
|
`sqlquery`,
|
|
`timevalue`
|
|
FROM ' . Util::backquote($sqlHistoryFeature->database)
|
|
. '.' . Util::backquote($sqlHistoryFeature->history) . '
|
|
WHERE `username` = ' . $this->dbi->quoteString($username) . '
|
|
ORDER BY `id` DESC';
|
|
|
|
return $this->dbi->fetchResult($histQuery, null, null, Connection::TYPE_CONTROL);
|
|
}
|
|
|
|
/**
|
|
* purges SQL history
|
|
*
|
|
* deletes entries that exceeds $cfg['QueryHistoryMax'], oldest first, for the
|
|
* given user
|
|
*
|
|
* @param string $username the username
|
|
*/
|
|
public function purgeHistory(string $username): void
|
|
{
|
|
$sqlHistoryFeature = $this->getRelationParameters()->sqlHistoryFeature;
|
|
if (! $GLOBALS['cfg']['QueryHistoryDB'] || $sqlHistoryFeature === null) {
|
|
return;
|
|
}
|
|
|
|
$searchQuery = '
|
|
SELECT `timevalue`
|
|
FROM ' . Util::backquote($sqlHistoryFeature->database)
|
|
. '.' . Util::backquote($sqlHistoryFeature->history) . '
|
|
WHERE `username` = ' . $this->dbi->quoteString($username) . '
|
|
ORDER BY `timevalue` DESC
|
|
LIMIT ' . $GLOBALS['cfg']['QueryHistoryMax'] . ', 1';
|
|
|
|
$maxTime = $this->dbi->fetchValue($searchQuery, 0, Connection::TYPE_CONTROL);
|
|
|
|
if (! $maxTime) {
|
|
return;
|
|
}
|
|
|
|
$this->dbi->queryAsControlUser(
|
|
'DELETE FROM '
|
|
. Util::backquote($sqlHistoryFeature->database) . '.'
|
|
. Util::backquote($sqlHistoryFeature->history) . '
|
|
WHERE `username` = ' . $this->dbi->quoteString($username, Connection::TYPE_CONTROL)
|
|
. '
|
|
AND `timevalue` <= \'' . $maxTime . '\'',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Prepares the dropdown for one mode
|
|
*
|
|
* @param mixed[] $foreign the keys and values for foreigns
|
|
* @param string $data the current data of the dropdown
|
|
* @param string $mode the needed mode
|
|
*
|
|
* @return string[] the <option value=""><option>s
|
|
*/
|
|
public function buildForeignDropdown(array $foreign, string $data, string $mode): array
|
|
{
|
|
$reloptions = [];
|
|
|
|
// id-only is a special mode used when no foreign display column
|
|
// is available
|
|
if ($mode === 'id-content' || $mode === 'id-only') {
|
|
// sort for id-content
|
|
if ($GLOBALS['cfg']['NaturalOrder']) {
|
|
uksort($foreign, 'strnatcasecmp');
|
|
} else {
|
|
ksort($foreign);
|
|
}
|
|
} elseif ($mode === 'content-id') {
|
|
// sort for content-id
|
|
if ($GLOBALS['cfg']['NaturalOrder']) {
|
|
natcasesort($foreign);
|
|
} else {
|
|
asort($foreign);
|
|
}
|
|
}
|
|
|
|
foreach ($foreign as $key => $value) {
|
|
$key = (string) $key;
|
|
$value = (string) $value;
|
|
|
|
if (mb_check_encoding($key, 'utf-8') && ! preg_match('/[\x00-\x08\x0B\x0C\x0E-\x1F\x80-\x9F]/u', $key)) {
|
|
$selected = ($key === $data);
|
|
// show as text if it's valid utf-8
|
|
$key = htmlspecialchars($key);
|
|
} else {
|
|
$key = '0x' . bin2hex($key);
|
|
if (str_contains($data, '0x')) {
|
|
$selected = ($key === trim($data));
|
|
} else {
|
|
$selected = ($key === '0x' . $data);
|
|
}
|
|
}
|
|
|
|
if (
|
|
mb_check_encoding($value, 'utf-8')
|
|
&& ! preg_match('/[\x00-\x08\x0B\x0C\x0E-\x1F\x80-\x9F]/u', $value)
|
|
) {
|
|
if (mb_strlen($value) <= $GLOBALS['cfg']['LimitChars']) {
|
|
// show as text if it's valid utf-8
|
|
$value = htmlspecialchars($value);
|
|
} else {
|
|
// show as truncated text if it's valid utf-8
|
|
$value = htmlspecialchars(
|
|
mb_substr(
|
|
$value,
|
|
0,
|
|
(int) $GLOBALS['cfg']['LimitChars'],
|
|
) . '...',
|
|
);
|
|
}
|
|
} else {
|
|
$value = '0x' . bin2hex($value);
|
|
}
|
|
|
|
$reloption = '<option value="' . $key . '"';
|
|
|
|
if ($selected) {
|
|
$reloption .= ' selected="selected"';
|
|
}
|
|
|
|
if ($mode === 'content-id') {
|
|
$reloptions[] = $reloption . '>'
|
|
. $value . ' - ' . $key . '</option>';
|
|
} elseif ($mode === 'id-content') {
|
|
$reloptions[] = $reloption . '>'
|
|
. $key . ' - ' . $value . '</option>';
|
|
} elseif ($mode === 'id-only') {
|
|
$reloptions[] = $reloption . '>'
|
|
. $key . '</option>';
|
|
}
|
|
}
|
|
|
|
return $reloptions;
|
|
}
|
|
|
|
/**
|
|
* Outputs dropdown with values of foreign fields
|
|
*
|
|
* @param mixed[][] $dispRow array of the displayed row
|
|
* @param string $foreignField the foreign field
|
|
* @param string $foreignDisplay the foreign field to display
|
|
* @param string $data the current data of the dropdown (field in row)
|
|
* @param int|null $max maximum number of items in the dropdown
|
|
*
|
|
* @return string the <option value=""><option>s
|
|
*/
|
|
public function foreignDropdown(
|
|
array $dispRow,
|
|
string $foreignField,
|
|
string $foreignDisplay,
|
|
string $data,
|
|
int|null $max = null,
|
|
): string {
|
|
if ($max === null) {
|
|
$max = $GLOBALS['cfg']['ForeignKeyMaxLimit'];
|
|
}
|
|
|
|
$foreign = [];
|
|
|
|
// collect the data
|
|
foreach ($dispRow as $relrow) {
|
|
$key = $relrow[$foreignField];
|
|
|
|
// if the display field has been defined for this foreign table
|
|
if ($foreignDisplay) {
|
|
$value = $relrow[$foreignDisplay];
|
|
} else {
|
|
$value = '';
|
|
}
|
|
|
|
$foreign[$key] = $value;
|
|
}
|
|
|
|
// put the dropdown sections in correct order
|
|
$top = [];
|
|
$bottom = [];
|
|
if ($foreignDisplay) {
|
|
if (
|
|
isset($GLOBALS['cfg']['ForeignKeyDropdownOrder'])
|
|
&& is_array($GLOBALS['cfg']['ForeignKeyDropdownOrder'])
|
|
) {
|
|
if (
|
|
isset($GLOBALS['cfg']['ForeignKeyDropdownOrder'][0])
|
|
&& is_scalar($GLOBALS['cfg']['ForeignKeyDropdownOrder'][0])
|
|
&& strlen((string) $GLOBALS['cfg']['ForeignKeyDropdownOrder'][0]) > 0
|
|
) {
|
|
$top = $this->buildForeignDropdown(
|
|
$foreign,
|
|
$data,
|
|
(string) $GLOBALS['cfg']['ForeignKeyDropdownOrder'][0],
|
|
);
|
|
}
|
|
|
|
if (
|
|
isset($GLOBALS['cfg']['ForeignKeyDropdownOrder'][1])
|
|
&& is_scalar($GLOBALS['cfg']['ForeignKeyDropdownOrder'][1])
|
|
&& strlen((string) $GLOBALS['cfg']['ForeignKeyDropdownOrder'][1]) > 0
|
|
) {
|
|
$bottom = $this->buildForeignDropdown(
|
|
$foreign,
|
|
$data,
|
|
(string) $GLOBALS['cfg']['ForeignKeyDropdownOrder'][1],
|
|
);
|
|
}
|
|
} else {
|
|
$top = $this->buildForeignDropdown($foreign, $data, 'id-content');
|
|
$bottom = $this->buildForeignDropdown($foreign, $data, 'content-id');
|
|
}
|
|
} else {
|
|
$top = $this->buildForeignDropdown($foreign, $data, 'id-only');
|
|
}
|
|
|
|
// beginning of dropdown
|
|
$ret = '<option value=""> </option>';
|
|
$topCount = count($top);
|
|
if ($max == -1 || $topCount < $max) {
|
|
$ret .= implode('', $top);
|
|
if ($foreignDisplay && $topCount > 0) {
|
|
// this empty option is to visually mark the beginning of the
|
|
// second series of values (bottom)
|
|
$ret .= '<option value=""> </option>';
|
|
}
|
|
}
|
|
|
|
if ($foreignDisplay) {
|
|
$ret .= implode('', $bottom);
|
|
}
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Gets foreign keys in preparation for a drop-down selector
|
|
*
|
|
* @param mixed[]|bool $foreigners array of the foreign keys
|
|
* @param string $field the foreign field name
|
|
* @param bool $overrideTotal whether to override the total
|
|
* @param string $foreignFilter a possible filter
|
|
* @param string $foreignLimit a possible LIMIT clause
|
|
* @param bool $getTotal optional, whether to get total num of rows
|
|
* in $foreignData['the_total;]
|
|
* (has an effect of performance)
|
|
*
|
|
* @return array<string, mixed> data about the foreign keys
|
|
* @psalm-return array{
|
|
* foreign_link: bool,
|
|
* the_total: int|string|null,
|
|
* foreign_display: string,
|
|
* disp_row: list<non-empty-array>|null,
|
|
* foreign_field: mixed
|
|
* }
|
|
*/
|
|
public function getForeignData(
|
|
array|bool $foreigners,
|
|
string $field,
|
|
bool $overrideTotal,
|
|
string $foreignFilter,
|
|
string $foreignLimit,
|
|
bool $getTotal = false,
|
|
): array {
|
|
// we always show the foreign field in the drop-down; if a display
|
|
// field is defined, we show it besides the foreign field
|
|
$foreignLink = false;
|
|
$dispRow = $foreignDisplay = $theTotal = $foreignField = null;
|
|
do {
|
|
if (! $foreigners) {
|
|
break;
|
|
}
|
|
|
|
$foreigner = $this->searchColumnInForeigners($foreigners, $field);
|
|
if ($foreigner == false) {
|
|
break;
|
|
}
|
|
|
|
$foreignDb = $foreigner['foreign_db'];
|
|
$foreignTable = $foreigner['foreign_table'];
|
|
$foreignField = $foreigner['foreign_field'];
|
|
|
|
// Count number of rows in the foreign table. Currently we do
|
|
// not use a drop-down if more than ForeignKeyMaxLimit rows in the
|
|
// foreign table,
|
|
// for speed reasons and because we need a better interface for this.
|
|
//
|
|
// We could also do the SELECT anyway, with a LIMIT, and ensure that
|
|
// the current value of the field is one of the choices.
|
|
|
|
// Check if table has more rows than specified by
|
|
// $GLOBALS['cfg']['ForeignKeyMaxLimit']
|
|
$moreThanLimit = $this->dbi->getTable($foreignDb, $foreignTable)
|
|
->checkIfMinRecordsExist($GLOBALS['cfg']['ForeignKeyMaxLimit']);
|
|
|
|
if ($overrideTotal || ! $moreThanLimit) {
|
|
// foreign_display can be false if no display field defined:
|
|
$foreignDisplay = $this->getDisplayField($foreignDb, $foreignTable);
|
|
|
|
$fQueryMain = 'SELECT ' . Util::backquote($foreignField)
|
|
. (
|
|
$foreignDisplay === ''
|
|
? ''
|
|
: ', ' . Util::backquote($foreignDisplay)
|
|
);
|
|
$fQueryFrom = ' FROM ' . Util::backquote($foreignDb)
|
|
. '.' . Util::backquote($foreignTable);
|
|
$fQueryFilter = $foreignFilter === '' ? '' : ' WHERE '
|
|
. Util::backquote($foreignField)
|
|
. ' LIKE ' . $this->dbi->quoteString(
|
|
'%' . $this->dbi->escapeMysqlWildcards($foreignFilter) . '%',
|
|
)
|
|
. (
|
|
$foreignDisplay === ''
|
|
? ''
|
|
: ' OR ' . Util::backquote($foreignDisplay)
|
|
. ' LIKE ' . $this->dbi->quoteString(
|
|
'%' . $this->dbi->escapeMysqlWildcards($foreignFilter) . '%',
|
|
)
|
|
);
|
|
$fQueryOrder = $foreignDisplay === '' ? '' : ' ORDER BY '
|
|
. Util::backquote($foreignTable) . '.'
|
|
. Util::backquote($foreignDisplay);
|
|
|
|
$fQueryLimit = $foreignLimit !== '' ? $foreignLimit : '';
|
|
|
|
if ($foreignFilter !== '') {
|
|
$theTotal = $this->dbi->fetchValue('SELECT COUNT(*)' . $fQueryFrom . $fQueryFilter);
|
|
if ($theTotal === false) {
|
|
$theTotal = 0;
|
|
}
|
|
}
|
|
|
|
$disp = $this->dbi->tryQuery($fQueryMain . $fQueryFrom . $fQueryFilter . $fQueryOrder . $fQueryLimit);
|
|
if ($disp && $disp->numRows() > 0) {
|
|
// If a resultset has been created, pre-cache it in the $disp_row
|
|
// array. This helps us from not needing to use mysql_data_seek by
|
|
// accessing a pre-cached PHP array. Usually those resultsets are
|
|
// not that big, so a performance hit should not be expected.
|
|
$dispRow = $disp->fetchAllAssoc();
|
|
} else {
|
|
// Either no data in the foreign table or
|
|
// user does not have select permission to foreign table/field
|
|
// Show an input field with a 'Browse foreign values' link
|
|
$dispRow = null;
|
|
$foreignLink = true;
|
|
}
|
|
} else {
|
|
$dispRow = null;
|
|
$foreignLink = true;
|
|
}
|
|
} while (false);
|
|
|
|
if ($getTotal && isset($foreignDb, $foreignTable)) {
|
|
$theTotal = $this->dbi->getTable($foreignDb, $foreignTable)
|
|
->countRecords(true);
|
|
}
|
|
|
|
return [
|
|
'foreign_link' => $foreignLink,
|
|
'the_total' => $theTotal,
|
|
'foreign_display' => is_string($foreignDisplay) ? $foreignDisplay : '',
|
|
'disp_row' => $dispRow,
|
|
'foreign_field' => $foreignField,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Rename a field in relation tables
|
|
*
|
|
* usually called after a column in a table was renamed
|
|
*
|
|
* @param string $db database name
|
|
* @param string $table table name
|
|
* @param string $field old field name
|
|
* @param string $newName new field name
|
|
*/
|
|
public function renameField(string $db, string $table, string $field, string $newName): void
|
|
{
|
|
$relationParameters = $this->getRelationParameters();
|
|
|
|
if ($relationParameters->displayFeature !== null) {
|
|
$tableQuery = 'UPDATE '
|
|
. Util::backquote($relationParameters->displayFeature->database) . '.'
|
|
. Util::backquote($relationParameters->displayFeature->tableInfo)
|
|
. ' SET display_field = ' . $this->dbi->quoteString($newName, Connection::TYPE_CONTROL)
|
|
. ' WHERE db_name = ' . $this->dbi->quoteString($db, Connection::TYPE_CONTROL)
|
|
. ' AND table_name = ' . $this->dbi->quoteString($table, Connection::TYPE_CONTROL)
|
|
. ' AND display_field = ' . $this->dbi->quoteString($field, Connection::TYPE_CONTROL);
|
|
$this->dbi->queryAsControlUser($tableQuery);
|
|
}
|
|
|
|
if ($relationParameters->relationFeature === null) {
|
|
return;
|
|
}
|
|
|
|
$tableQuery = 'UPDATE '
|
|
. Util::backquote($relationParameters->relationFeature->database) . '.'
|
|
. Util::backquote($relationParameters->relationFeature->relation)
|
|
. ' SET master_field = ' . $this->dbi->quoteString($newName, Connection::TYPE_CONTROL)
|
|
. ' WHERE master_db = ' . $this->dbi->quoteString($db, Connection::TYPE_CONTROL)
|
|
. ' AND master_table = ' . $this->dbi->quoteString($table, Connection::TYPE_CONTROL)
|
|
. ' AND master_field = ' . $this->dbi->quoteString($field, Connection::TYPE_CONTROL);
|
|
$this->dbi->queryAsControlUser($tableQuery);
|
|
|
|
$tableQuery = 'UPDATE '
|
|
. Util::backquote($relationParameters->relationFeature->database) . '.'
|
|
. Util::backquote($relationParameters->relationFeature->relation)
|
|
. ' SET foreign_field = ' . $this->dbi->quoteString($newName, Connection::TYPE_CONTROL)
|
|
. ' WHERE foreign_db = ' . $this->dbi->quoteString($db, Connection::TYPE_CONTROL)
|
|
. ' AND foreign_table = ' . $this->dbi->quoteString($table, Connection::TYPE_CONTROL)
|
|
. ' AND foreign_field = ' . $this->dbi->quoteString($field, Connection::TYPE_CONTROL);
|
|
$this->dbi->queryAsControlUser($tableQuery);
|
|
}
|
|
|
|
/**
|
|
* Performs SQL query used for renaming table.
|
|
*
|
|
* @param string $sourceDb Source database name
|
|
* @param string $targetDb Target database name
|
|
* @param string $sourceTable Source table name
|
|
* @param string $targetTable Target table name
|
|
* @param string $dbField Name of database field
|
|
* @param string $tableField Name of table field
|
|
*/
|
|
public function renameSingleTable(
|
|
DatabaseName $configStorageDatabase,
|
|
TableName $configStorageTable,
|
|
string $sourceDb,
|
|
string $targetDb,
|
|
string $sourceTable,
|
|
string $targetTable,
|
|
string $dbField,
|
|
string $tableField,
|
|
): void {
|
|
$query = 'UPDATE '
|
|
. Util::backquote($configStorageDatabase) . '.'
|
|
. Util::backquote($configStorageTable)
|
|
. ' SET '
|
|
. $dbField . ' = ' . $this->dbi->quoteString($targetDb, Connection::TYPE_CONTROL)
|
|
. ', '
|
|
. $tableField . ' = ' . $this->dbi->quoteString($targetTable, Connection::TYPE_CONTROL)
|
|
. ' WHERE '
|
|
. $dbField . ' = ' . $this->dbi->quoteString($sourceDb, Connection::TYPE_CONTROL)
|
|
. ' AND '
|
|
. $tableField . ' = ' . $this->dbi->quoteString($sourceTable, Connection::TYPE_CONTROL);
|
|
$this->dbi->queryAsControlUser($query);
|
|
}
|
|
|
|
/**
|
|
* Rename a table in relation tables
|
|
*
|
|
* usually called after table has been moved
|
|
*
|
|
* @param string $sourceDb Source database name
|
|
* @param string $targetDb Target database name
|
|
* @param string $sourceTable Source table name
|
|
* @param string $targetTable Target table name
|
|
*/
|
|
public function renameTable(string $sourceDb, string $targetDb, string $sourceTable, string $targetTable): void
|
|
{
|
|
$relationParameters = $this->getRelationParameters();
|
|
|
|
// Move old entries from PMA-DBs to new table
|
|
if ($relationParameters->columnCommentsFeature !== null) {
|
|
$this->renameSingleTable(
|
|
$relationParameters->columnCommentsFeature->database,
|
|
$relationParameters->columnCommentsFeature->columnInfo,
|
|
$sourceDb,
|
|
$targetDb,
|
|
$sourceTable,
|
|
$targetTable,
|
|
'db_name',
|
|
'table_name',
|
|
);
|
|
}
|
|
|
|
// updating bookmarks is not possible since only a single table is
|
|
// moved, and not the whole DB.
|
|
|
|
if ($relationParameters->displayFeature !== null) {
|
|
$this->renameSingleTable(
|
|
$relationParameters->displayFeature->database,
|
|
$relationParameters->displayFeature->tableInfo,
|
|
$sourceDb,
|
|
$targetDb,
|
|
$sourceTable,
|
|
$targetTable,
|
|
'db_name',
|
|
'table_name',
|
|
);
|
|
}
|
|
|
|
if ($relationParameters->relationFeature !== null) {
|
|
$this->renameSingleTable(
|
|
$relationParameters->relationFeature->database,
|
|
$relationParameters->relationFeature->relation,
|
|
$sourceDb,
|
|
$targetDb,
|
|
$sourceTable,
|
|
$targetTable,
|
|
'foreign_db',
|
|
'foreign_table',
|
|
);
|
|
|
|
$this->renameSingleTable(
|
|
$relationParameters->relationFeature->database,
|
|
$relationParameters->relationFeature->relation,
|
|
$sourceDb,
|
|
$targetDb,
|
|
$sourceTable,
|
|
$targetTable,
|
|
'master_db',
|
|
'master_table',
|
|
);
|
|
}
|
|
|
|
if ($relationParameters->pdfFeature !== null) {
|
|
if ($sourceDb === $targetDb) {
|
|
// rename within the database can be handled
|
|
$this->renameSingleTable(
|
|
$relationParameters->pdfFeature->database,
|
|
$relationParameters->pdfFeature->tableCoords,
|
|
$sourceDb,
|
|
$targetDb,
|
|
$sourceTable,
|
|
$targetTable,
|
|
'db_name',
|
|
'table_name',
|
|
);
|
|
} else {
|
|
// if the table is moved out of the database we can no longer keep the
|
|
// record for table coordinate
|
|
$removeQuery = 'DELETE FROM '
|
|
. Util::backquote($relationParameters->pdfFeature->database) . '.'
|
|
. Util::backquote($relationParameters->pdfFeature->tableCoords)
|
|
. ' WHERE db_name = ' . $this->dbi->quoteString($sourceDb, Connection::TYPE_CONTROL)
|
|
. ' AND table_name = ' . $this->dbi->quoteString($sourceTable, Connection::TYPE_CONTROL);
|
|
$this->dbi->queryAsControlUser($removeQuery);
|
|
}
|
|
}
|
|
|
|
if ($relationParameters->uiPreferencesFeature !== null) {
|
|
$this->renameSingleTable(
|
|
$relationParameters->uiPreferencesFeature->database,
|
|
$relationParameters->uiPreferencesFeature->tableUiPrefs,
|
|
$sourceDb,
|
|
$targetDb,
|
|
$sourceTable,
|
|
$targetTable,
|
|
'db_name',
|
|
'table_name',
|
|
);
|
|
}
|
|
|
|
if ($relationParameters->navigationItemsHidingFeature === null) {
|
|
return;
|
|
}
|
|
|
|
// update hidden items inside table
|
|
$this->renameSingleTable(
|
|
$relationParameters->navigationItemsHidingFeature->database,
|
|
$relationParameters->navigationItemsHidingFeature->navigationHiding,
|
|
$sourceDb,
|
|
$targetDb,
|
|
$sourceTable,
|
|
$targetTable,
|
|
'db_name',
|
|
'table_name',
|
|
);
|
|
|
|
// update data for hidden table
|
|
$query = 'UPDATE '
|
|
. Util::backquote($relationParameters->navigationItemsHidingFeature->database) . '.'
|
|
. Util::backquote($relationParameters->navigationItemsHidingFeature->navigationHiding)
|
|
. ' SET db_name = ' . $this->dbi->quoteString($targetDb, Connection::TYPE_CONTROL)
|
|
. ','
|
|
. ' item_name = ' . $this->dbi->quoteString($targetTable, Connection::TYPE_CONTROL)
|
|
. ' WHERE db_name = ' . $this->dbi->quoteString($sourceDb, Connection::TYPE_CONTROL)
|
|
. ' AND item_name = ' . $this->dbi->quoteString($sourceTable, Connection::TYPE_CONTROL)
|
|
. " AND item_type = 'table'";
|
|
$this->dbi->queryAsControlUser($query);
|
|
}
|
|
|
|
/**
|
|
* Create a PDF page
|
|
*
|
|
* @param string|null $newpage name of the new PDF page
|
|
* @param string $db database name
|
|
*/
|
|
public function createPage(string|null $newpage, PdfFeature $pdfFeature, string $db): int
|
|
{
|
|
$insQuery = 'INSERT INTO '
|
|
. Util::backquote($pdfFeature->database) . '.'
|
|
. Util::backquote($pdfFeature->pdfPages)
|
|
. ' (db_name, page_descr)'
|
|
. ' VALUES ('
|
|
. $this->dbi->quoteString($db, Connection::TYPE_CONTROL) . ', '
|
|
. $this->dbi->quoteString($newpage ?: __('no description'), Connection::TYPE_CONTROL) . ')';
|
|
$this->dbi->tryQueryAsControlUser($insQuery);
|
|
|
|
return $this->dbi->insertId(Connection::TYPE_CONTROL);
|
|
}
|
|
|
|
/**
|
|
* Get child table references for a table column.
|
|
* This works only if 'DisableIS' is false. An empty array is returned otherwise.
|
|
*
|
|
* @param string $db name of master table db.
|
|
* @param string $table name of master table.
|
|
* @param string $column name of master table column.
|
|
*
|
|
* @return mixed[]
|
|
*/
|
|
public function getChildReferences(string $db, string $table, string $column = ''): array
|
|
{
|
|
if (! $GLOBALS['cfg']['Server']['DisableIS']) {
|
|
$relQuery = 'SELECT `column_name`, `table_name`,'
|
|
. ' `table_schema`, `referenced_column_name`'
|
|
. ' FROM `information_schema`.`key_column_usage`'
|
|
. ' WHERE `referenced_table_name` = '
|
|
. $this->dbi->quoteString($table)
|
|
. ' AND `referenced_table_schema` = '
|
|
. $this->dbi->quoteString($db);
|
|
if ($column) {
|
|
$relQuery .= ' AND `referenced_column_name` = '
|
|
. $this->dbi->quoteString($column);
|
|
}
|
|
|
|
return $this->dbi->fetchResult(
|
|
$relQuery,
|
|
['referenced_column_name', null],
|
|
);
|
|
}
|
|
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Check child table references and foreign key for a table column.
|
|
*
|
|
* @param string $db name of master table db.
|
|
* @param string $table name of master table.
|
|
* @param string $column name of master table column.
|
|
* @param mixed[]|null $foreignersFull foreigners array for the whole table.
|
|
* @param mixed[]|null $childReferencesFull child references for the whole table.
|
|
*
|
|
* @return array<string, mixed> telling about references if foreign key.
|
|
* @psalm-return array{isEditable: bool, isForeignKey: bool, isReferenced: bool, references: string[]}
|
|
*/
|
|
public function checkChildForeignReferences(
|
|
string $db,
|
|
string $table,
|
|
string $column,
|
|
array|null $foreignersFull = null,
|
|
array|null $childReferencesFull = null,
|
|
): array {
|
|
$columnStatus = ['isEditable' => true, 'isReferenced' => false, 'isForeignKey' => false, 'references' => []];
|
|
|
|
$foreigners = [];
|
|
if ($foreignersFull !== null) {
|
|
if (isset($foreignersFull[$column])) {
|
|
$foreigners[$column] = $foreignersFull[$column];
|
|
}
|
|
|
|
if (isset($foreignersFull['foreign_keys_data'])) {
|
|
$foreigners['foreign_keys_data'] = $foreignersFull['foreign_keys_data'];
|
|
}
|
|
} else {
|
|
$foreigners = $this->getForeigners($db, $table, $column, 'foreign');
|
|
}
|
|
|
|
$foreigner = $this->searchColumnInForeigners($foreigners, $column);
|
|
|
|
$childReferences = [];
|
|
if ($childReferencesFull !== null) {
|
|
if (isset($childReferencesFull[$column])) {
|
|
$childReferences = $childReferencesFull[$column];
|
|
}
|
|
} else {
|
|
$childReferences = $this->getChildReferences($db, $table, $column);
|
|
}
|
|
|
|
if (count($childReferences) > 0 || $foreigner) {
|
|
$columnStatus['isEditable'] = false;
|
|
if (count($childReferences) > 0) {
|
|
$columnStatus['isReferenced'] = true;
|
|
foreach ($childReferences as $columns) {
|
|
$columnStatus['references'][] = Util::backquote($columns['table_schema'])
|
|
. '.' . Util::backquote($columns['table_name']);
|
|
}
|
|
}
|
|
|
|
if ($foreigner) {
|
|
$columnStatus['isForeignKey'] = true;
|
|
}
|
|
}
|
|
|
|
return $columnStatus;
|
|
}
|
|
|
|
/**
|
|
* Search a table column in foreign data.
|
|
*
|
|
* @param mixed[] $foreigners Table Foreign data
|
|
* @param string $column Column name
|
|
*/
|
|
public function searchColumnInForeigners(array $foreigners, string $column): array|false
|
|
{
|
|
if (isset($foreigners[$column])) {
|
|
return $foreigners[$column];
|
|
}
|
|
|
|
if (! isset($foreigners['foreign_keys_data'])) {
|
|
return false;
|
|
}
|
|
|
|
$foreigner = [];
|
|
foreach ($foreigners['foreign_keys_data'] as $oneKey) {
|
|
$columnIndex = array_search($column, $oneKey['index_list']);
|
|
if ($columnIndex !== false) {
|
|
$foreigner['foreign_field'] = $oneKey['ref_index_list'][$columnIndex];
|
|
$foreigner['foreign_db'] = $oneKey['ref_db_name'] ?? $GLOBALS['db'];
|
|
$foreigner['foreign_table'] = $oneKey['ref_table_name'];
|
|
$foreigner['constraint'] = $oneKey['constraint'];
|
|
$foreigner['on_update'] = $oneKey['on_update'] ?? 'RESTRICT';
|
|
$foreigner['on_delete'] = $oneKey['on_delete'] ?? 'RESTRICT';
|
|
|
|
return $foreigner;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns default PMA table names and their create queries.
|
|
*
|
|
* @param array<string, string> $tableNameReplacements
|
|
*
|
|
* @return array<string, string> table name, create query
|
|
*/
|
|
public function getCreateTableSqlQueries(array $tableNameReplacements): array
|
|
{
|
|
$pmaTables = [];
|
|
$createTablesFile = (string) file_get_contents(SQL_DIR . 'create_tables.sql');
|
|
|
|
$queries = explode(';', $createTablesFile);
|
|
|
|
foreach ($queries as $query) {
|
|
if (! preg_match('/CREATE TABLE IF NOT EXISTS `(.*)` \(/', $query, $table)) {
|
|
continue;
|
|
}
|
|
|
|
// The following redundant cast is needed for PHPStan
|
|
$tableName = (string) $table[1];
|
|
|
|
// Replace the table name with another one
|
|
if (isset($tableNameReplacements[$tableName])) {
|
|
$query = str_replace($tableName, $tableNameReplacements[$tableName], $query);
|
|
}
|
|
|
|
$pmaTables[$tableName] = $query . ';';
|
|
}
|
|
|
|
return $pmaTables;
|
|
}
|
|
|
|
/**
|
|
* Create a database to be used as configuration storage
|
|
*/
|
|
public function createPmaDatabase(string $configurationStorageDbName): bool
|
|
{
|
|
$this->dbi->tryQuery(
|
|
'CREATE DATABASE IF NOT EXISTS ' . Util::backquote($configurationStorageDbName),
|
|
Connection::TYPE_CONTROL,
|
|
);
|
|
|
|
$error = $this->dbi->getError(Connection::TYPE_CONTROL);
|
|
if (! $error) {
|
|
// Re-build the cache to show the list of tables created or not
|
|
// This is the case when the DB could be created but no tables just after
|
|
// So just purge the cache and show the new configuration storage state
|
|
unset($_SESSION['relation'][$GLOBALS['server']]);
|
|
unset(self::$cache[$GLOBALS['server']]);
|
|
$this->getRelationParameters();
|
|
|
|
return true;
|
|
}
|
|
|
|
$GLOBALS['message'] = $error;
|
|
|
|
if ($GLOBALS['errno'] === 1044) {
|
|
$GLOBALS['message'] = sprintf(
|
|
__(
|
|
'You do not have necessary privileges to create a database named'
|
|
. ' \'%s\'. You may go to \'Operations\' tab of any'
|
|
. ' database to set up the phpMyAdmin configuration storage there.',
|
|
),
|
|
$configurationStorageDbName,
|
|
);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Creates PMA tables in the given db, updates if already exists.
|
|
*
|
|
* @param string $db database
|
|
* @param bool $create whether to create tables if they don't exist.
|
|
*/
|
|
public function fixPmaTables(string $db, bool $create = true): void
|
|
{
|
|
if ($this->arePmadbTablesAllDisabled()) {
|
|
return;
|
|
}
|
|
|
|
$tablesToFeatures = [
|
|
'pma__bookmark' => 'bookmarktable',
|
|
'pma__relation' => 'relation',
|
|
'pma__table_info' => 'table_info',
|
|
'pma__table_coords' => 'table_coords',
|
|
'pma__pdf_pages' => 'pdf_pages',
|
|
'pma__column_info' => 'column_info',
|
|
'pma__history' => 'history',
|
|
'pma__recent' => 'recent',
|
|
'pma__favorite' => 'favorite',
|
|
'pma__table_uiprefs' => 'table_uiprefs',
|
|
'pma__tracking' => 'tracking',
|
|
'pma__userconfig' => 'userconfig',
|
|
'pma__users' => 'users',
|
|
'pma__usergroups' => 'usergroups',
|
|
'pma__navigationhiding' => 'navigationhiding',
|
|
'pma__savedsearches' => 'savedsearches',
|
|
'pma__central_columns' => 'central_columns',
|
|
'pma__designer_settings' => 'designer_settings',
|
|
'pma__export_templates' => 'export_templates',
|
|
];
|
|
|
|
$existingTables = $this->dbi->getTables($db, Connection::TYPE_CONTROL);
|
|
|
|
$tableNameReplacements = $this->getTableReplacementNames($tablesToFeatures);
|
|
|
|
$createQueries = [];
|
|
if ($create) {
|
|
$createQueries = $this->getCreateTableSqlQueries($tableNameReplacements);
|
|
if (! $this->dbi->selectDb($db, Connection::TYPE_CONTROL)) {
|
|
$GLOBALS['message'] = $this->dbi->getError(Connection::TYPE_CONTROL);
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
$foundOne = false;
|
|
foreach ($tablesToFeatures as $table => $feature) {
|
|
if (($GLOBALS['cfg']['Server'][$feature] ?? null) === false) {
|
|
// The feature is disabled by the user in config
|
|
continue;
|
|
}
|
|
|
|
// Check if the table already exists
|
|
// use the possible replaced name first and fallback on the table name
|
|
// if no replacement exists
|
|
if (! in_array($tableNameReplacements[$table] ?? $table, $existingTables)) {
|
|
if (! $create) {
|
|
continue;
|
|
}
|
|
|
|
$this->dbi->tryQuery($createQueries[$table], Connection::TYPE_CONTROL);
|
|
|
|
$error = $this->dbi->getError(Connection::TYPE_CONTROL);
|
|
if ($error) {
|
|
$GLOBALS['message'] = $error;
|
|
|
|
return;
|
|
}
|
|
}
|
|
|
|
$foundOne = true;
|
|
|
|
// Do not override a user defined value, only fill if empty
|
|
if (isset($GLOBALS['cfg']['Server'][$feature]) && $GLOBALS['cfg']['Server'][$feature] !== '') {
|
|
continue;
|
|
}
|
|
|
|
// Fill it with the default table name
|
|
$GLOBALS['cfg']['Server'][$feature] = $table;
|
|
}
|
|
|
|
if (! $foundOne) {
|
|
return;
|
|
}
|
|
|
|
$GLOBALS['cfg']['Server']['pmadb'] = $db;
|
|
|
|
//NOTE: I am unsure why we do that, as it defeats the purpose of the session cache
|
|
// Unset the cache
|
|
unset($_SESSION['relation'][$GLOBALS['server']]);
|
|
unset(self::$cache[$GLOBALS['server']]);
|
|
// Fill back the cache
|
|
$this->getRelationParameters();
|
|
}
|
|
|
|
/**
|
|
* Gets the relations info and status, depending on the condition
|
|
*
|
|
* @param bool $condition whether to look for foreigners or not
|
|
* @param string $db database name
|
|
* @param string $table table name
|
|
*
|
|
* @return mixed[] ($res_rel, $have_rel)
|
|
* @psalm-return array{array, bool}
|
|
*/
|
|
public function getRelationsAndStatus(bool $condition, string $db, string $table): array
|
|
{
|
|
$haveRel = false;
|
|
$resRel = [];
|
|
if ($condition) {
|
|
// Find which tables are related with the current one and write it in
|
|
// an array
|
|
$resRel = $this->getForeigners($db, $table);
|
|
|
|
$haveRel = $resRel !== [];
|
|
}
|
|
|
|
return [$resRel, $haveRel];
|
|
}
|
|
|
|
/**
|
|
* Verifies that all pmadb features are disabled
|
|
*/
|
|
public function arePmadbTablesAllDisabled(): bool
|
|
{
|
|
return ($GLOBALS['cfg']['Server']['bookmarktable'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['relation'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['table_info'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['table_coords'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['column_info'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['pdf_pages'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['history'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['recent'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['favorite'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['table_uiprefs'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['tracking'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['userconfig'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['users'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['usergroups'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['navigationhiding'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['savedsearches'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['central_columns'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['designer_settings'] ?? null) === false
|
|
&& ($GLOBALS['cfg']['Server']['export_templates'] ?? null) === false;
|
|
}
|
|
|
|
/**
|
|
* Verifies if all the pmadb tables are defined
|
|
*/
|
|
public function arePmadbTablesDefined(): bool
|
|
{
|
|
return ! (empty($GLOBALS['cfg']['Server']['bookmarktable'])
|
|
|| empty($GLOBALS['cfg']['Server']['relation'])
|
|
|| empty($GLOBALS['cfg']['Server']['table_info'])
|
|
|| empty($GLOBALS['cfg']['Server']['table_coords'])
|
|
|| empty($GLOBALS['cfg']['Server']['column_info'])
|
|
|| empty($GLOBALS['cfg']['Server']['pdf_pages'])
|
|
|| empty($GLOBALS['cfg']['Server']['history'])
|
|
|| empty($GLOBALS['cfg']['Server']['recent'])
|
|
|| empty($GLOBALS['cfg']['Server']['favorite'])
|
|
|| empty($GLOBALS['cfg']['Server']['table_uiprefs'])
|
|
|| empty($GLOBALS['cfg']['Server']['tracking'])
|
|
|| empty($GLOBALS['cfg']['Server']['userconfig'])
|
|
|| empty($GLOBALS['cfg']['Server']['users'])
|
|
|| empty($GLOBALS['cfg']['Server']['usergroups'])
|
|
|| empty($GLOBALS['cfg']['Server']['navigationhiding'])
|
|
|| empty($GLOBALS['cfg']['Server']['savedsearches'])
|
|
|| empty($GLOBALS['cfg']['Server']['central_columns'])
|
|
|| empty($GLOBALS['cfg']['Server']['designer_settings'])
|
|
|| empty($GLOBALS['cfg']['Server']['export_templates']));
|
|
}
|
|
|
|
/**
|
|
* Get tables for foreign key constraint
|
|
*
|
|
* @param string $foreignDb Database name
|
|
* @param string $tblStorageEngine Table storage engine
|
|
*
|
|
* @return mixed[] Table names
|
|
*/
|
|
public function getTables(string $foreignDb, string $tblStorageEngine): array
|
|
{
|
|
$tables = [];
|
|
$tablesRows = $this->dbi->query('SHOW TABLE STATUS FROM ' . Util::backquote($foreignDb));
|
|
while ($row = $tablesRows->fetchRow()) {
|
|
if (! isset($row[1]) || mb_strtoupper($row[1]) !== $tblStorageEngine) {
|
|
continue;
|
|
}
|
|
|
|
$tables[] = $row[0];
|
|
}
|
|
|
|
if ($GLOBALS['cfg']['NaturalOrder']) {
|
|
usort($tables, 'strnatcasecmp');
|
|
}
|
|
|
|
return $tables;
|
|
}
|
|
|
|
public function getConfigurationStorageDbName(): string
|
|
{
|
|
$cfgStorageDbName = $GLOBALS['cfg']['Server']['pmadb'] ?? '';
|
|
|
|
// Use "phpmyadmin" as a default database name to check to keep the behavior consistent
|
|
return empty($cfgStorageDbName) ? 'phpmyadmin' : $cfgStorageDbName;
|
|
}
|
|
|
|
/**
|
|
* This function checks and initializes the phpMyAdmin configuration
|
|
* storage state before it is used into session cache.
|
|
*/
|
|
public function initRelationParamsCache(): void
|
|
{
|
|
$storageDbName = $GLOBALS['cfg']['Server']['pmadb'] ?? '';
|
|
// Use "phpmyadmin" as a default database name to check to keep the behavior consistent
|
|
$storageDbName = is_string($storageDbName) && $storageDbName !== '' ? $storageDbName : 'phpmyadmin';
|
|
|
|
// This will make users not having explicitly listed databases
|
|
// have config values filled by the default phpMyAdmin storage table name values
|
|
$this->fixPmaTables($storageDbName, false);
|
|
|
|
// This global will be changed if fixPmaTables did find one valid table
|
|
$storageDbName = $GLOBALS['cfg']['Server']['pmadb'] ?? '';
|
|
|
|
// Empty means that until now no pmadb was found eligible
|
|
if (! empty($storageDbName)) {
|
|
return;
|
|
}
|
|
|
|
$this->fixPmaTables($GLOBALS['db'], false);
|
|
}
|
|
|
|
/**
|
|
* @param non-empty-array<string, string> $tablesToFeatures
|
|
*
|
|
* @return array<string, string>
|
|
*/
|
|
private function getTableReplacementNames(array $tablesToFeatures): array
|
|
{
|
|
$tableNameReplacements = [];
|
|
|
|
foreach ($tablesToFeatures as $table => $feature) {
|
|
if (empty($GLOBALS['cfg']['Server'][$feature]) || $GLOBALS['cfg']['Server'][$feature] === $table) {
|
|
continue;
|
|
}
|
|
|
|
// Set the replacement to transform the default table name into a custom name
|
|
$tableNameReplacements[$table] = $GLOBALS['cfg']['Server'][$feature];
|
|
}
|
|
|
|
return $tableNameReplacements;
|
|
}
|
|
}
|
