%PDF- %PDF-
Direktori : /var/www/projetos/admin.iigd.com.br/libraries/classes/Database/Designer/ |
Current File : /var/www/projetos/admin.iigd.com.br/libraries/classes/Database/Designer/Common.php |
<?php declare(strict_types=1); namespace PhpMyAdmin\Database\Designer; use PhpMyAdmin\ConfigStorage\Relation; use PhpMyAdmin\DatabaseInterface; use PhpMyAdmin\Index; use PhpMyAdmin\Query\Generator as QueryGenerator; use PhpMyAdmin\Table; use PhpMyAdmin\Util; use PhpMyAdmin\Utils\ForeignKey; use function __; use function _pgettext; use function array_keys; use function count; use function explode; use function in_array; use function intval; use function is_array; use function is_string; use function json_decode; use function json_encode; use function mb_strtoupper; use function rawurlencode; /** * Common functions for Designer */ class Common { /** @var Relation */ private $relation; /** @var DatabaseInterface */ private $dbi; /** * @param DatabaseInterface $dbi DatabaseInterface object * @param Relation $relation Relation instance */ public function __construct(DatabaseInterface $dbi, Relation $relation) { $this->dbi = $dbi; $this->relation = $relation; } /** * Retrieves table info and returns it * * @param string $db (optional) Filter only a DB ($table is required if you use $db) * @param string $table (optional) Filter only a table ($db is now required) * * @return DesignerTable[] with table info */ public function getTablesInfo(?string $db = null, ?string $table = null): array { $designerTables = []; $db = $db ?? $GLOBALS['db']; // seems to be needed later $this->dbi->selectDb($db); if ($table === null) { $tables = $this->dbi->getTablesFull($db); } else { $tables = $this->dbi->getTablesFull($db, $table); } foreach ($tables as $one_table) { $DF = $this->relation->getDisplayField($db, $one_table['TABLE_NAME']); $DF = is_string($DF) ? $DF : ''; $DF = $DF !== '' ? $DF : null; $designerTables[] = new DesignerTable( $db, $one_table['TABLE_NAME'], is_string($one_table['ENGINE']) ? $one_table['ENGINE'] : '', $DF ); } return $designerTables; } /** * Retrieves table column info * * @param DesignerTable[] $designerTables The designer tables * * @return array table column nfo */ public function getColumnsInfo(array $designerTables): array { //$this->dbi->selectDb($GLOBALS['db']); $tabColumn = []; foreach ($designerTables as $designerTable) { $fieldsRs = $this->dbi->query( QueryGenerator::getColumnsSql( $designerTable->getDatabaseName(), $designerTable->getTableName() ) ); $j = 0; while ($row = $fieldsRs->fetchAssoc()) { if (! isset($tabColumn[$designerTable->getDbTableString()])) { $tabColumn[$designerTable->getDbTableString()] = []; } $tabColumn[$designerTable->getDbTableString()]['COLUMN_ID'][$j] = $j; $tabColumn[$designerTable->getDbTableString()]['COLUMN_NAME'][$j] = $row['Field']; $tabColumn[$designerTable->getDbTableString()]['TYPE'][$j] = $row['Type']; $tabColumn[$designerTable->getDbTableString()]['NULLABLE'][$j] = $row['Null']; $j++; } } return $tabColumn; } /** * Returns JavaScript code for initializing vars * * @param DesignerTable[] $designerTables The designer tables * * @return array JavaScript code */ public function getScriptContr(array $designerTables): array { $this->dbi->selectDb($GLOBALS['db']); $con = []; $con['C_NAME'] = []; $i = 0; $alltab_rs = $this->dbi->query('SHOW TABLES FROM ' . Util::backquote($GLOBALS['db'])); while ($val = $alltab_rs->fetchRow()) { $val = (string) $val[0]; $row = $this->relation->getForeigners($GLOBALS['db'], $val, '', 'internal'); foreach ($row as $field => $value) { $con['C_NAME'][$i] = ''; $con['DTN'][$i] = rawurlencode($GLOBALS['db'] . '.' . $val); $con['DCN'][$i] = rawurlencode((string) $field); $con['STN'][$i] = rawurlencode($value['foreign_db'] . '.' . $value['foreign_table']); $con['SCN'][$i] = rawurlencode($value['foreign_field']); $i++; } $row = $this->relation->getForeigners($GLOBALS['db'], $val, '', 'foreign'); // We do not have access to the foreign keys if the user has partial access to the columns if (! isset($row['foreign_keys_data'])) { continue; } foreach ($row['foreign_keys_data'] as $one_key) { foreach ($one_key['index_list'] as $index => $one_field) { $con['C_NAME'][$i] = rawurlencode($one_key['constraint']); $con['DTN'][$i] = rawurlencode($GLOBALS['db'] . '.' . $val); $con['DCN'][$i] = rawurlencode($one_field); $con['STN'][$i] = rawurlencode( ($one_key['ref_db_name'] ?? $GLOBALS['db']) . '.' . $one_key['ref_table_name'] ); $con['SCN'][$i] = rawurlencode($one_key['ref_index_list'][$index]); $i++; } } } $tableDbNames = []; foreach ($designerTables as $designerTable) { $tableDbNames[] = rawurlencode($designerTable->getDbTableString()); } $ti = 0; $retval = []; for ($i = 0, $cnt = count($con['C_NAME']); $i < $cnt; $i++) { $c_name_i = $con['C_NAME'][$i]; $dtn_i = $con['DTN'][$i]; $retval[$ti] = []; $retval[$ti][$c_name_i] = []; if (in_array($dtn_i, $tableDbNames) && in_array($con['STN'][$i], $tableDbNames)) { $retval[$ti][$c_name_i][$dtn_i] = []; $retval[$ti][$c_name_i][$dtn_i][$con['DCN'][$i]] = [ 0 => $con['STN'][$i], 1 => $con['SCN'][$i], ]; } $ti++; } return $retval; } /** * Returns UNIQUE and PRIMARY indices * * @param DesignerTable[] $designerTables The designer tables * * @return array unique or primary indices */ public function getPkOrUniqueKeys(array $designerTables): array { return $this->getAllKeys($designerTables, true); } /** * Returns all indices * * @param DesignerTable[] $designerTables The designer tables * @param bool $unique_only whether to include only unique ones * * @return array indices */ public function getAllKeys(array $designerTables, bool $unique_only = false): array { $keys = []; foreach ($designerTables as $designerTable) { $schema = $designerTable->getDatabaseName(); // for now, take into account only the first index segment foreach (Index::getFromTable($designerTable->getTableName(), $schema) as $index) { if ($unique_only && ! $index->isUnique()) { continue; } $columns = $index->getColumns(); foreach (array_keys($columns) as $column_name) { $keys[$schema . '.' . $designerTable->getTableName() . '.' . $column_name] = 1; } } } return $keys; } /** * Return j_tab and h_tab arrays * * @param DesignerTable[] $designerTables The designer tables * * @return array */ public function getScriptTabs(array $designerTables): array { $retval = [ 'j_tabs' => [], 'h_tabs' => [], ]; foreach ($designerTables as $designerTable) { $key = rawurlencode($designerTable->getDbTableString()); $retval['j_tabs'][$key] = $designerTable->supportsForeignkeys() ? 1 : 0; $retval['h_tabs'][$key] = 1; } return $retval; } /** * Returns table positions of a given pdf page * * @param int $pg pdf page id * * @return array|null of table positions */ public function getTablePositions($pg): ?array { $pdfFeature = $this->relation->getRelationParameters()->pdfFeature; if ($pdfFeature === null) { return []; } $query = " SELECT CONCAT_WS('.', `db_name`, `table_name`) AS `name`, `db_name` as `dbName`, `table_name` as `tableName`, `x` AS `X`, `y` AS `Y`, 1 AS `V`, 1 AS `H` FROM " . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->tableCoords) . ' WHERE pdf_page_number = ' . intval($pg); return $this->dbi->fetchResult( $query, 'name', null, DatabaseInterface::CONNECT_CONTROL ); } /** * Returns page name of a given pdf page * * @param int $pg pdf page id * * @return string|null table name */ public function getPageName($pg) { $pdfFeature = $this->relation->getRelationParameters()->pdfFeature; if ($pdfFeature === null) { return null; } $query = 'SELECT `page_descr`' . ' FROM ' . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->pdfPages) . ' WHERE ' . Util::backquote('page_nr') . ' = ' . intval($pg); $page_name = $this->dbi->fetchResult( $query, null, null, DatabaseInterface::CONNECT_CONTROL ); return $page_name[0] ?? null; } /** * Deletes a given pdf page and its corresponding coordinates * * @param int $pg page id */ public function deletePage($pg): bool { $pdfFeature = $this->relation->getRelationParameters()->pdfFeature; if ($pdfFeature === null) { return false; } $query = 'DELETE FROM ' . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->tableCoords) . ' WHERE ' . Util::backquote('pdf_page_number') . ' = ' . intval($pg); $this->dbi->queryAsControlUser($query); $query = 'DELETE FROM ' . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->pdfPages) . ' WHERE ' . Util::backquote('page_nr') . ' = ' . intval($pg); $this->dbi->queryAsControlUser($query); return true; } /** * Returns the id of the default pdf page of the database. * Default page is the one which has the same name as the database. * * @param string $db database * * @return int|null id of the default pdf page for the database */ public function getDefaultPage($db): ?int { $pdfFeature = $this->relation->getRelationParameters()->pdfFeature; if ($pdfFeature === null) { return -1; } $query = 'SELECT `page_nr`' . ' FROM ' . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->pdfPages) . " WHERE `db_name` = '" . $this->dbi->escapeString($db) . "'" . " AND `page_descr` = '" . $this->dbi->escapeString($db) . "'"; $default_page_no = $this->dbi->fetchResult( $query, null, null, DatabaseInterface::CONNECT_CONTROL ); if (isset($default_page_no[0])) { return intval($default_page_no[0]); } return -1; } /** * Get the status if the page already exists * If no such exists, returns negative index. * * @param string $pg name */ public function getPageExists(string $pg): bool { $pdfFeature = $this->relation->getRelationParameters()->pdfFeature; if ($pdfFeature === null) { return false; } $query = 'SELECT `page_nr`' . ' FROM ' . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->pdfPages) . " WHERE `page_descr` = '" . $this->dbi->escapeString($pg) . "'"; $pageNos = $this->dbi->fetchResult( $query, null, null, DatabaseInterface::CONNECT_CONTROL ); return count($pageNos) > 0; } /** * Get the id of the page to load. If a default page exists it will be returned. * If no such exists, returns the id of the first page of the database. * * @param string $db database * * @return int id of the page to load */ public function getLoadingPage($db) { $pdfFeature = $this->relation->getRelationParameters()->pdfFeature; if ($pdfFeature === null) { return -1; } $default_page_no = $this->getDefaultPage($db); if ($default_page_no != -1) { return intval($default_page_no); } $query = 'SELECT MIN(`page_nr`)' . ' FROM ' . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->pdfPages) . " WHERE `db_name` = '" . $this->dbi->escapeString($db) . "'"; $min_page_no = $this->dbi->fetchResult( $query, null, null, DatabaseInterface::CONNECT_CONTROL ); $page_no = $min_page_no[0] ?? -1; return intval($page_no); } /** * Creates a new page and returns its auto-incrementing id * * @param string $pageName name of the page * @param string $db name of the database * * @return int|null */ public function createNewPage($pageName, $db) { $pdfFeature = $this->relation->getRelationParameters()->pdfFeature; if ($pdfFeature === null) { return null; } return $this->relation->createPage($pageName, $pdfFeature, $db); } /** * Saves positions of table(s) of a given pdf page * * @param int $pg pdf page id */ public function saveTablePositions($pg): bool { $pageId = $this->dbi->escapeString((string) $pg); $pdfFeature = $this->relation->getRelationParameters()->pdfFeature; if ($pdfFeature === null) { return false; } $query = 'DELETE FROM ' . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->tableCoords) . " WHERE `pdf_page_number` = '" . $pageId . "'"; $this->dbi->queryAsControlUser($query); foreach ($_POST['t_h'] as $key => $value) { $DB = $_POST['t_db'][$key]; $TAB = $_POST['t_tbl'][$key]; if (! $value) { continue; } $query = 'INSERT INTO ' . Util::backquote($pdfFeature->database) . '.' . Util::backquote($pdfFeature->tableCoords) . ' (`db_name`, `table_name`, `pdf_page_number`, `x`, `y`)' . ' VALUES (' . "'" . $this->dbi->escapeString($DB) . "', " . "'" . $this->dbi->escapeString($TAB) . "', " . "'" . $pageId . "', " . "'" . $this->dbi->escapeString($_POST['t_x'][$key]) . "', " . "'" . $this->dbi->escapeString($_POST['t_y'][$key]) . "')"; $this->dbi->queryAsControlUser($query); } return true; } /** * Saves the display field for a table. * * @param string $db database name * @param string $table table name * @param string $field display field name * * @return array<int,string|bool|null> * @psalm-return array{0: bool, 1: string|null} */ public function saveDisplayField($db, $table, $field): array { $displayFeature = $this->relation->getRelationParameters()->displayFeature; if ($displayFeature === null) { return [ false, _pgettext( 'phpMyAdmin configuration storage is not configured for' . ' "Display Features" on designer when user tries to set a display field.', 'phpMyAdmin configuration storage is not configured for "Display Features".' ), ]; } $upd_query = new Table($table, $db, $this->dbi); $upd_query->updateDisplayField($field, $displayFeature); return [ true, null, ]; } /** * Adds a new foreign relation * * @param string $db database name * @param string $T1 foreign table * @param string $F1 foreign field * @param string $T2 master table * @param string $F2 master field * @param string $on_delete on delete action * @param string $on_update on update action * @param string $DB1 database * @param string $DB2 database * * @return array<int,string|bool> array of success/failure and message * @psalm-return array{0: bool, 1: string} */ public function addNewRelation($db, $T1, $F1, $T2, $F2, $on_delete, $on_update, $DB1, $DB2): array { $tables = $this->dbi->getTablesFull($DB1, $T1); $type_T1 = mb_strtoupper($tables[$T1]['ENGINE'] ?? ''); $tables = $this->dbi->getTablesFull($DB2, $T2); $type_T2 = mb_strtoupper($tables[$T2]['ENGINE'] ?? ''); // native foreign key if (ForeignKey::isSupported($type_T1) && ForeignKey::isSupported($type_T2) && $type_T1 == $type_T2) { // relation exists? $existrel_foreign = $this->relation->getForeigners($DB2, $T2, '', 'foreign'); $foreigner = $this->relation->searchColumnInForeigners($existrel_foreign, $F2); if ($foreigner && isset($foreigner['constraint'])) { return [ false, __('Error: relationship already exists.'), ]; } // note: in InnoDB, the index does not requires to be on a PRIMARY // or UNIQUE key // improve: check all other requirements for InnoDB relations $result = $this->dbi->query( 'SHOW INDEX FROM ' . Util::backquote($DB1) . '.' . Util::backquote($T1) . ';' ); // will be use to emphasis prim. keys in the table view $index_array1 = []; while ($row = $result->fetchAssoc()) { $index_array1[$row['Column_name']] = 1; } $result = $this->dbi->query( 'SHOW INDEX FROM ' . Util::backquote($DB2) . '.' . Util::backquote($T2) . ';' ); // will be used to emphasis prim. keys in the table view $index_array2 = []; while ($row = $result->fetchAssoc()) { $index_array2[$row['Column_name']] = 1; } unset($result); if (! empty($index_array1[$F1]) && ! empty($index_array2[$F2])) { $upd_query = 'ALTER TABLE ' . Util::backquote($DB2) . '.' . Util::backquote($T2) . ' ADD FOREIGN KEY (' . Util::backquote($F2) . ')' . ' REFERENCES ' . Util::backquote($DB1) . '.' . Util::backquote($T1) . '(' . Util::backquote($F1) . ')'; if ($on_delete !== 'nix') { $upd_query .= ' ON DELETE ' . $on_delete; } if ($on_update !== 'nix') { $upd_query .= ' ON UPDATE ' . $on_update; } $upd_query .= ';'; if ($this->dbi->tryQuery($upd_query)) { return [ true, __('FOREIGN KEY relationship has been added.'), ]; } $error = $this->dbi->getError(); return [ false, __('Error: FOREIGN KEY relationship could not be added!') . '<br>' . $error, ]; } return [ false, __('Error: Missing index on column(s).'), ]; } $relationFeature = $this->relation->getRelationParameters()->relationFeature; if ($relationFeature === null) { return [ false, __('Error: Relational features are disabled!'), ]; } // no need to recheck if the keys are primary or unique at this point, // this was checked on the interface part $q = 'INSERT INTO ' . Util::backquote($relationFeature->database) . '.' . Util::backquote($relationFeature->relation) . '(master_db, master_table, master_field, ' . 'foreign_db, foreign_table, foreign_field)' . ' values(' . "'" . $this->dbi->escapeString($DB2) . "', " . "'" . $this->dbi->escapeString($T2) . "', " . "'" . $this->dbi->escapeString($F2) . "', " . "'" . $this->dbi->escapeString($DB1) . "', " . "'" . $this->dbi->escapeString($T1) . "', " . "'" . $this->dbi->escapeString($F1) . "')"; if ($this->dbi->tryQueryAsControlUser($q)) { return [ true, __('Internal relationship has been added.'), ]; } $error = $this->dbi->getError(DatabaseInterface::CONNECT_CONTROL); return [ false, __('Error: Internal relationship could not be added!') . '<br>' . $error, ]; } /** * Removes a foreign relation * * @param string $T1 foreign db.table * @param string $F1 foreign field * @param string $T2 master db.table * @param string $F2 master field * * @return array array of success/failure and message */ public function removeRelation($T1, $F1, $T2, $F2) { [$DB1, $T1] = explode('.', $T1); [$DB2, $T2] = explode('.', $T2); $tables = $this->dbi->getTablesFull($DB1, $T1); $type_T1 = mb_strtoupper($tables[$T1]['ENGINE']); $tables = $this->dbi->getTablesFull($DB2, $T2); $type_T2 = mb_strtoupper($tables[$T2]['ENGINE']); if (ForeignKey::isSupported($type_T1) && ForeignKey::isSupported($type_T2) && $type_T1 == $type_T2) { // InnoDB $existrel_foreign = $this->relation->getForeigners($DB2, $T2, '', 'foreign'); $foreigner = $this->relation->searchColumnInForeigners($existrel_foreign, $F2); if (is_array($foreigner) && isset($foreigner['constraint'])) { $upd_query = 'ALTER TABLE ' . Util::backquote($DB2) . '.' . Util::backquote($T2) . ' DROP FOREIGN KEY ' . Util::backquote($foreigner['constraint']) . ';'; $this->dbi->query($upd_query); return [ true, __('FOREIGN KEY relationship has been removed.'), ]; } } $relationFeature = $this->relation->getRelationParameters()->relationFeature; if ($relationFeature === null) { return [ false, __('Error: Relational features are disabled!'), ]; } // internal relations $delete_query = 'DELETE FROM ' . Util::backquote($relationFeature->database) . '.' . Util::backquote($relationFeature->relation) . ' WHERE ' . "master_db = '" . $this->dbi->escapeString($DB2) . "'" . " AND master_table = '" . $this->dbi->escapeString($T2) . "'" . " AND master_field = '" . $this->dbi->escapeString($F2) . "'" . " AND foreign_db = '" . $this->dbi->escapeString($DB1) . "'" . " AND foreign_table = '" . $this->dbi->escapeString($T1) . "'" . " AND foreign_field = '" . $this->dbi->escapeString($F1) . "'"; $result = $this->dbi->tryQueryAsControlUser($delete_query); if (! $result) { $error = $this->dbi->getError(DatabaseInterface::CONNECT_CONTROL); return [ false, __('Error: Internal relationship could not be removed!') . '<br>' . $error, ]; } return [ true, __('Internal relationship has been removed.'), ]; } /** * Save value for a designer setting * * @param string $index setting * @param string $value value */ public function saveSetting($index, $value): bool { $databaseDesignerSettingsFeature = $this->relation->getRelationParameters()->databaseDesignerSettingsFeature; if ($databaseDesignerSettingsFeature !== null) { $cfgDesigner = [ 'user' => $GLOBALS['cfg']['Server']['user'], 'db' => $databaseDesignerSettingsFeature->database->getName(), 'table' => $databaseDesignerSettingsFeature->designerSettings->getName(), ]; $orig_data_query = 'SELECT settings_data' . ' FROM ' . Util::backquote($cfgDesigner['db']) . '.' . Util::backquote($cfgDesigner['table']) . " WHERE username = '" . $this->dbi->escapeString($cfgDesigner['user']) . "';"; $orig_data = $this->dbi->fetchSingleRow( $orig_data_query, DatabaseInterface::FETCH_ASSOC, DatabaseInterface::CONNECT_CONTROL ); if (! empty($orig_data)) { $orig_data = json_decode($orig_data['settings_data'], true); $orig_data[$index] = $value; $orig_data = json_encode($orig_data); $save_query = 'UPDATE ' . Util::backquote($cfgDesigner['db']) . '.' . Util::backquote($cfgDesigner['table']) . " SET settings_data = '" . $orig_data . "'" . " WHERE username = '" . $this->dbi->escapeString($cfgDesigner['user']) . "';"; $this->dbi->queryAsControlUser($save_query); } else { $save_data = [$index => $value]; $query = 'INSERT INTO ' . Util::backquote($cfgDesigner['db']) . '.' . Util::backquote($cfgDesigner['table']) . ' (username, settings_data)' . " VALUES('" . $this->dbi->escapeString($cfgDesigner['user']) . "', '" . json_encode($save_data) . "');"; $this->dbi->queryAsControlUser($query); } } return true; } }