<?php
declare(strict_types=1);
namespace PhpMyAdmin\Database;
use PhpMyAdmin\Charsets;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\Message;
use PhpMyAdmin\Template;
use PhpMyAdmin\Util;
use function __;
use function array_diff;
use function array_keys;
use function array_unique;
use function array_values;
use function bin2hex;
use function ceil;
use function count;
use function explode;
use function htmlspecialchars;
use function implode;
use function in_array;
use function is_array;
use function is_bool;
use function mb_strtoupper;
use function sprintf;
use function trim;
class CentralColumns
{
/**
* DatabaseInterface instance
*
* @var DatabaseInterface
*/
private $dbi;
/**
* Current user
*
* @var string
*/
private $user;
/**
* Number of rows displayed when browsing a result set
*
* @var int
*/
private $maxRows;
/**
* Which editor should be used for CHAR/VARCHAR fields
*
* @var string
*/
private $charEditing;
/**
* Disable use of INFORMATION_SCHEMA
*
* @var bool
*/
private $disableIs;
/** @var Relation */
private $relation;
/** @var Template */
public $template;
/**
* @param DatabaseInterface $dbi DatabaseInterface instance
*/
public function __construct(DatabaseInterface $dbi)
{
$this->dbi = $dbi;
$this->user = $GLOBALS['cfg']['Server']['user'];
$this->maxRows = (int) $GLOBALS['cfg']['MaxRows'];
$this->charEditing = $GLOBALS['cfg']['CharEditing'];
$this->disableIs = (bool) $GLOBALS['cfg']['Server']['DisableIS'];
$this->relation = new Relation($this->dbi);
$this->template = new Template();
}
/**
* Defines the central_columns parameters for the current user
*
* @return array|bool the central_columns parameters for the current user
*/
public function getParams()
{
static $cfgCentralColumns = null;
if ($cfgCentralColumns !== null) {
return $cfgCentralColumns;
}
$centralColumnsFeature = $this->relation->getRelationParameters()->centralColumnsFeature;
if ($centralColumnsFeature === null) {
$cfgCentralColumns = false;
return $cfgCentralColumns;
}
$cfgCentralColumns = [
'user' => $this->user,
'db' => $centralColumnsFeature->database->getName(),
'table' => $centralColumnsFeature->centralColumns->getName(),
];
return $cfgCentralColumns;
}
/**
* get $num columns of given database from central columns list
* starting at offset $from
*
* @param string $db selected database
* @param int $from starting offset of first result
* @param int $num maximum number of results to return
*
* @return array list of $num columns present in central columns list
* starting at offset $from for the given database
*/
public function getColumnsList(string $db, int $from = 0, int $num = 25): array
{
$cfgCentralColumns = $this->getParams();
if (! is_array($cfgCentralColumns)) {
return [];
}
$pmadb = $cfgCentralColumns['db'];
$this->dbi->selectDb($pmadb, DatabaseInterface::CONNECT_CONTROL);
$central_list_table = $cfgCentralColumns['table'];
//get current values of $db from central column list
if ($num == 0) {
$query = 'SELECT * FROM ' . Util::backquote($central_list_table) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($db) . '\';';
} else {
$query = 'SELECT * FROM ' . Util::backquote($central_list_table) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($db) . '\' '
. 'LIMIT ' . $from . ', ' . $num . ';';
}
$has_list = $this->dbi->fetchResult($query, null, null, DatabaseInterface::CONNECT_CONTROL);
$this->handleColumnExtra($has_list);
return $has_list;
}
/**
* Get the number of columns present in central list for given db
*
* @param string $db current database
*
* @return int number of columns in central list of columns for $db
*/
public function getCount(string $db): int
{
$cfgCentralColumns = $this->getParams();
if (! is_array($cfgCentralColumns)) {
return 0;
}
$pmadb = $cfgCentralColumns['db'];
$this->dbi->selectDb($pmadb, DatabaseInterface::CONNECT_CONTROL);
$central_list_table = $cfgCentralColumns['table'];
$query = 'SELECT count(db_name) FROM ' .
Util::backquote($central_list_table) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($db) . '\';';
$res = $this->dbi->fetchResult($query, null, null, DatabaseInterface::CONNECT_CONTROL);
if (isset($res[0])) {
return (int) $res[0];
}
return 0;
}
/**
* return the existing columns in central list among the given list of columns
*
* @param string $db the selected database
* @param string $cols comma separated list of given columns
* @param bool $allFields set if need all the fields of existing columns,
* otherwise only column_name is returned
*
* @return array list of columns in central columns among given set of columns
*/
private function findExistingColNames(
string $db,
string $cols,
bool $allFields = false
): array {
$cfgCentralColumns = $this->getParams();
if (! is_array($cfgCentralColumns)) {
return [];
}
$pmadb = $cfgCentralColumns['db'];
$this->dbi->selectDb($pmadb, DatabaseInterface::CONNECT_CONTROL);
$central_list_table = $cfgCentralColumns['table'];
if ($allFields) {
$query = 'SELECT * FROM ' . Util::backquote($central_list_table) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($db) . '\' AND col_name IN (' . $cols . ');';
$has_list = $this->dbi->fetchResult($query, null, null, DatabaseInterface::CONNECT_CONTROL);
$this->handleColumnExtra($has_list);
} else {
$query = 'SELECT col_name FROM '
. Util::backquote($central_list_table) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($db) . '\' AND col_name IN (' . $cols . ');';
$has_list = $this->dbi->fetchResult($query, null, null, DatabaseInterface::CONNECT_CONTROL);
}
return $has_list;
}
/**
* build the insert query for central columns list given PMA storage
* db, central_columns table, column name and corresponding definition to be added
*
* @param string $column column to add into central list
* @param array $def list of attributes of the column being added
* @param string $db PMA configuration storage database name
* @param string $central_list_table central columns configuration storage table name
*
* @return string query string to insert the given column
* with definition into central list
*/
private function getInsertQuery(
string $column,
array $def,
string $db,
string $central_list_table
): string {
$type = '';
$length = 0;
$attribute = '';
if (isset($def['Type'])) {
$extracted_columnspec = Util::extractColumnSpec($def['Type']);
$attribute = trim($extracted_columnspec['attribute']);
$type = $extracted_columnspec['type'];
$length = $extracted_columnspec['spec_in_brackets'];
}
if (isset($def['Attribute'])) {
$attribute = $def['Attribute'];
}
$collation = $def['Collation'] ?? '';
$isNull = $def['Null'] === 'NO' ? '0' : '1';
$extra = $def['Extra'] ?? '';
$default = $def['Default'] ?? '';
return 'INSERT INTO '
. Util::backquote($central_list_table) . ' '
. 'VALUES ( \'' . $this->dbi->escapeString($db) . '\' ,'
. '\'' . $this->dbi->escapeString($column) . '\',\''
. $this->dbi->escapeString($type) . '\','
. '\'' . $this->dbi->escapeString((string) $length) . '\',\''
. $this->dbi->escapeString($collation) . '\','
. '\'' . $this->dbi->escapeString($isNull) . '\','
. '\'' . implode(',', [$extra, $attribute])
. '\',\'' . $this->dbi->escapeString($default) . '\');';
}
/**
* If $isTable is true then unique columns from given tables as $field_select
* are added to central list otherwise the $field_select is considered as
* list of columns and these columns are added to central list if not already added
*
* @param array $field_select if $isTable is true selected tables list
* otherwise selected columns list
* @param bool $isTable if passed array is of tables or columns
* @param string $table if $isTable is false, then table name to
* which columns belong
*
* @return true|Message
*/
public function syncUniqueColumns(
array $field_select,
bool $isTable = true,
?string $table = null
) {
$cfgCentralColumns = $this->getParams();
if (! is_array($cfgCentralColumns)) {
return Message::error(
__('The configuration storage is not ready for the central list of columns feature.')
);
}
$db = $_POST['db'];
$pmadb = $cfgCentralColumns['db'];
$central_list_table = $cfgCentralColumns['table'];
$this->dbi->selectDb($db);
$existingCols = [];
$cols = '';
$insQuery = [];
$fields = [];
$message = true;
if ($isTable) {
foreach ($field_select as $table) {
$fields[$table] = $this->dbi->getColumns($db, $table, true);
foreach (array_keys($fields[$table]) as $field) {
$cols .= "'" . $this->dbi->escapeString($field) . "',";
}
}
$has_list = $this->findExistingColNames($db, trim($cols, ','));
foreach ($field_select as $table) {
foreach ($fields[$table] as $field => $def) {
if (! in_array($field, $has_list)) {
$has_list[] = $field;
$insQuery[] = $this->getInsertQuery($field, $def, $db, $central_list_table);
} else {
$existingCols[] = "'" . $field . "'";
}
}
}
} else {
if ($table === null) {
$table = $_POST['table'];
}
foreach ($field_select as $column) {
$cols .= "'" . $this->dbi->escapeString($column) . "',";
}
$has_list = $this->findExistingColNames($db, trim($cols, ','));
foreach ($field_select as $column) {
if (! in_array($column, $has_list)) {
$has_list[] = $column;
$field = $this->dbi->getColumn($db, $table, $column, true);
$insQuery[] = $this->getInsertQuery($column, $field, $db, $central_list_table);
} else {
$existingCols[] = "'" . $column . "'";
}
}
}
if (! empty($existingCols)) {
$existingCols = implode(',', array_unique($existingCols));
$message = Message::notice(
sprintf(
__(
'Could not add %1$s as they already exist in central list!'
),
htmlspecialchars($existingCols)
)
);
$message->addMessage(
Message::notice(
'Please remove them first from central list if you want to update above columns'
)
);
}
$this->dbi->selectDb($pmadb, DatabaseInterface::CONNECT_CONTROL);
if (! empty($insQuery)) {
foreach ($insQuery as $query) {
if (! $this->dbi->tryQuery($query, DatabaseInterface::CONNECT_CONTROL)) {
$message = Message::error(__('Could not add columns!'));
$message->addMessage(
Message::rawError($this->dbi->getError(DatabaseInterface::CONNECT_CONTROL))
);
break;
}
}
}
return $message;
}
/**
* if $isTable is true it removes all columns of given tables as $field_select from
* central columns list otherwise $field_select is columns list and it removes
* given columns if present in central list
*
* @param string $database Database name
* @param array $field_select if $isTable selected list of tables otherwise
* selected list of columns to remove from central list
* @param bool $isTable if passed array is of tables or columns
*
* @return true|Message
*/
public function deleteColumnsFromList(
string $database,
array $field_select,
bool $isTable = true
) {
$cfgCentralColumns = $this->getParams();
if (! is_array($cfgCentralColumns)) {
return Message::error(
__('The configuration storage is not ready for the central list of columns feature.')
);
}
$pmadb = $cfgCentralColumns['db'];
$central_list_table = $cfgCentralColumns['table'];
$this->dbi->selectDb($database);
$message = true;
$colNotExist = [];
$fields = [];
if ($isTable) {
$cols = '';
foreach ($field_select as $table) {
$fields[$table] = $this->dbi->getColumnNames($database, $table);
foreach ($fields[$table] as $col_select) {
$cols .= '\'' . $this->dbi->escapeString($col_select) . '\',';
}
}
$cols = trim($cols, ',');
$has_list = $this->findExistingColNames($database, $cols);
foreach ($field_select as $table) {
foreach ($fields[$table] as $column) {
if (in_array($column, $has_list)) {
continue;
}
$colNotExist[] = "'" . $column . "'";
}
}
} else {
$cols = '';
foreach ($field_select as $col_select) {
$cols .= '\'' . $this->dbi->escapeString($col_select) . '\',';
}
$cols = trim($cols, ',');
$has_list = $this->findExistingColNames($database, $cols);
foreach ($field_select as $column) {
if (in_array($column, $has_list)) {
continue;
}
$colNotExist[] = "'" . $column . "'";
}
}
if (! empty($colNotExist)) {
$colNotExist = implode(',', array_unique($colNotExist));
$message = Message::notice(
sprintf(
__(
'Couldn\'t remove Column(s) %1$s as they don\'t exist in central columns list!'
),
htmlspecialchars($colNotExist)
)
);
}
$this->dbi->selectDb($pmadb, DatabaseInterface::CONNECT_CONTROL);
$query = 'DELETE FROM ' . Util::backquote($central_list_table) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($database) . '\' AND col_name IN (' . $cols . ');';
if (! $this->dbi->tryQuery($query, DatabaseInterface::CONNECT_CONTROL)) {
$message = Message::error(__('Could not remove columns!'));
$message->addHtml('<br>' . htmlspecialchars($cols) . '<br>');
$message->addMessage(
Message::rawError($this->dbi->getError(DatabaseInterface::CONNECT_CONTROL))
);
}
return $message;
}
/**
* Make the columns of given tables consistent with central list of columns.
* Updates only those columns which are not being referenced.
*
* @param string $db current database
* @param array $selected_tables list of selected tables.
*
* @return true|Message
*/
public function makeConsistentWithList(
string $db,
array $selected_tables
) {
$message = true;
foreach ($selected_tables as $table) {
$query = 'ALTER TABLE ' . Util::backquote($table);
$has_list = $this->getFromTable($db, $table, true);
$this->dbi->selectDb($db);
foreach ($has_list as $column) {
$column_status = $this->relation->checkChildForeignReferences($db, $table, $column['col_name']);
//column definition can only be changed if
//it is not referenced by another column
if (! $column_status['isEditable']) {
continue;
}
$query .= ' MODIFY ' . Util::backquote($column['col_name']) . ' '
. $this->dbi->escapeString($column['col_type']);
if ($column['col_length']) {
$query .= '(' . $column['col_length'] . ')';
}
$query .= ' ' . $column['col_attribute'];
if ($column['col_isNull']) {
$query .= ' NULL';
} else {
$query .= ' NOT NULL';
}
$query .= ' ' . $column['col_extra'];
if ($column['col_default']) {
if (
$column['col_default'] !== 'CURRENT_TIMESTAMP'
&& $column['col_default'] !== 'current_timestamp()'
) {
$query .= ' DEFAULT \'' . $this->dbi->escapeString((string) $column['col_default']) . '\'';
} else {
$query .= ' DEFAULT ' . $this->dbi->escapeString($column['col_default']);
}
}
$query .= ',';
}
$query = trim($query, ' ,') . ';';
if ($this->dbi->tryQuery($query)) {
continue;
}
if ($message === true) {
$message = Message::error($this->dbi->getError());
} else {
$message->addText($this->dbi->getError(), '<br>');
}
}
return $message;
}
/**
* return the columns present in central list of columns for a given
* table of a given database
*
* @param string $db given database
* @param string $table given table
* @param bool $allFields set if need all the fields of existing columns,
* otherwise only column_name is returned
*
* @return array columns present in central list from given table of given db.
*/
public function getFromTable(
string $db,
string $table,
bool $allFields = false
): array {
$cfgCentralColumns = $this->getParams();
if (empty($cfgCentralColumns)) {
return [];
}
$this->dbi->selectDb($db);
$fields = $this->dbi->getColumnNames($db, $table);
$cols = '';
foreach ($fields as $col_select) {
$cols .= '\'' . $this->dbi->escapeString($col_select) . '\',';
}
$cols = trim($cols, ',');
$has_list = $this->findExistingColNames($db, $cols, $allFields);
if (! empty($has_list)) {
return (array) $has_list;
}
return [];
}
/**
* update a column in central columns list if a edit is requested
*
* @param string $db current database
* @param string $orig_col_name original column name before edit
* @param string $col_name new column name
* @param string $col_type new column type
* @param string $col_attribute new column attribute
* @param string $col_length new column length
* @param int $col_isNull value 1 if new column isNull is true, 0 otherwise
* @param string $collation new column collation
* @param string $col_extra new column extra property
* @param string $col_default new column default value
*
* @return true|Message
*/
public function updateOneColumn(
string $db,
string $orig_col_name,
string $col_name,
string $col_type,
string $col_attribute,
string $col_length,
int $col_isNull,
string $collation,
string $col_extra,
string $col_default
) {
$cfgCentralColumns = $this->getParams();
if (! is_array($cfgCentralColumns)) {
return Message::error(
__('The configuration storage is not ready for the central list of columns feature.')
);
}
$centralTable = $cfgCentralColumns['table'];
$this->dbi->selectDb($cfgCentralColumns['db'], DatabaseInterface::CONNECT_CONTROL);
if ($orig_col_name == '') {
$def = [];
$def['Type'] = $col_type;
if ($col_length) {
$def['Type'] .= '(' . $col_length . ')';
}
$def['Collation'] = $collation;
$def['Null'] = $col_isNull ? __('YES') : __('NO');
$def['Extra'] = $col_extra;
$def['Attribute'] = $col_attribute;
$def['Default'] = $col_default;
$query = $this->getInsertQuery($col_name, $def, $db, $centralTable);
} else {
$query = 'UPDATE ' . Util::backquote($centralTable)
. ' SET col_type = \'' . $this->dbi->escapeString($col_type) . '\''
. ', col_name = \'' . $this->dbi->escapeString($col_name) . '\''
. ', col_length = \'' . $this->dbi->escapeString($col_length) . '\''
. ', col_isNull = ' . $col_isNull
. ', col_collation = \'' . $this->dbi->escapeString($collation) . '\''
. ', col_extra = \''
. implode(',', [$col_extra, $col_attribute]) . '\''
. ', col_default = \'' . $this->dbi->escapeString($col_default) . '\''
. ' WHERE db_name = \'' . $this->dbi->escapeString($db) . '\' '
. 'AND col_name = \'' . $this->dbi->escapeString($orig_col_name)
. '\'';
}
if (! $this->dbi->tryQuery($query, DatabaseInterface::CONNECT_CONTROL)) {
return Message::error($this->dbi->getError(DatabaseInterface::CONNECT_CONTROL));
}
return true;
}
/**
* Update Multiple column in central columns list if a change is requested
*
* @param array $params Request parameters
*
* @return true|Message
*/
public function updateMultipleColumn(array $params)
{
$columnDefault = $params['field_default_type'];
$columnIsNull = [];
$columnExtra = [];
$numberCentralFields = count($params['orig_col_name']);
for ($i = 0; $i < $numberCentralFields; $i++) {
$columnIsNull[$i] = isset($params['field_null'][$i]) ? 1 : 0;
$columnExtra[$i] = $params['col_extra'][$i] ?? '';
if ($columnDefault[$i] === 'NONE') {
$columnDefault[$i] = '';
} elseif ($columnDefault[$i] === 'USER_DEFINED') {
$columnDefault[$i] = $params['field_default_value'][$i];
}
$message = $this->updateOneColumn(
$params['db'],
$params['orig_col_name'][$i],
$params['field_name'][$i],
$params['field_type'][$i],
$params['field_attribute'][$i],
$params['field_length'][$i],
$columnIsNull[$i],
$params['field_collation'][$i],
$columnExtra[$i],
$columnDefault[$i]
);
if (! is_bool($message)) {
return $message;
}
}
return true;
}
/**
* build html for editing a row in central columns table
*
* @param array $row array contains complete information of a
* particular row of central list table
* @param int $row_num position the row in the table
*
* @return string html of a particular row in the central columns table.
*/
private function getHtmlForEditTableRow(array $row, int $row_num): string
{
$meta = [];
if (! isset($row['col_default']) || $row['col_default'] == '') {
$meta['DefaultType'] = 'NONE';
} elseif ($row['col_default'] === 'CURRENT_TIMESTAMP' || $row['col_default'] === 'current_timestamp()') {
$meta['DefaultType'] = 'CURRENT_TIMESTAMP';
} elseif ($row['col_default'] === 'NULL') {
$meta['DefaultType'] = $row['col_default'];
} else {
$meta['DefaultType'] = 'USER_DEFINED';
$meta['DefaultValue'] = $row['col_default'];
}
$defaultValue = '';
$typeUpper = mb_strtoupper((string) $row['col_type']);
// For a TIMESTAMP, do not show the string "CURRENT_TIMESTAMP" as a default value
if (isset($meta['DefaultValue'])) {
$defaultValue = $meta['DefaultValue'];
if ($typeUpper === 'BIT') {
$defaultValue = Util::convertBitDefaultValue($meta['DefaultValue']);
} elseif ($typeUpper == 'BINARY' || $typeUpper == 'VARBINARY') {
$defaultValue = bin2hex($meta['DefaultValue']);
}
}
$charsets = Charsets::getCharsets($this->dbi, $this->disableIs);
$collations = Charsets::getCollations($this->dbi, $this->disableIs);
return $this->template->render('database/central_columns/edit_table_row', [
'row_num' => $row_num,
'row' => $row,
'max_rows' => $this->maxRows,
'meta' => $meta,
'default_value' => $defaultValue,
'char_editing' => $this->charEditing,
'charsets' => $charsets,
'collations' => $collations,
'attribute_types' => $this->dbi->types->getAttributes(),
]);
}
/**
* get the list of columns in given database excluding
* the columns present in current table
*
* @param string $db selected database
* @param string $table current table name
*
* @return array encoded list of columns present in central list for the given
* database
*/
public function getListRaw(string $db, string $table): array
{
$cfgCentralColumns = $this->getParams();
if (! is_array($cfgCentralColumns)) {
return [];
}
$centralTable = $cfgCentralColumns['table'];
if (empty($table) || $table == '') {
$query = 'SELECT * FROM ' . Util::backquote($centralTable) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($db) . '\';';
} else {
$this->dbi->selectDb($db);
$columns = $this->dbi->getColumnNames($db, $table);
$cols = '';
foreach ($columns as $col_select) {
$cols .= '\'' . $this->dbi->escapeString($col_select) . '\',';
}
$cols = trim($cols, ',');
$query = 'SELECT * FROM ' . Util::backquote($centralTable) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($db) . '\'';
if ($cols) {
$query .= ' AND col_name NOT IN (' . $cols . ')';
}
$query .= ';';
}
$this->dbi->selectDb($cfgCentralColumns['db'], DatabaseInterface::CONNECT_CONTROL);
$columns_list = $this->dbi->fetchResult($query, null, null, DatabaseInterface::CONNECT_CONTROL);
$this->handleColumnExtra($columns_list);
return $columns_list;
}
/**
* Column `col_extra` is used to store both extra and attributes for a column.
* This method separates them.
*
* @param array $columns_list columns list
*/
private function handleColumnExtra(array &$columns_list): void
{
foreach ($columns_list as &$row) {
$vals = explode(',', $row['col_extra']);
if (in_array('BINARY', $vals)) {
$row['col_attribute'] = 'BINARY';
} elseif (in_array('UNSIGNED', $vals)) {
$row['col_attribute'] = 'UNSIGNED';
} elseif (in_array('UNSIGNED ZEROFILL', $vals)) {
$row['col_attribute'] = 'UNSIGNED ZEROFILL';
} elseif (in_array('on update CURRENT_TIMESTAMP', $vals)) {
$row['col_attribute'] = 'on update CURRENT_TIMESTAMP';
} else {
$row['col_attribute'] = '';
}
if (in_array('auto_increment', $vals)) {
$row['col_extra'] = 'auto_increment';
} else {
$row['col_extra'] = '';
}
}
}
/**
* Get HTML for editing page central columns
*
* @param array $selected_fld Array containing the selected fields
* @param string $selected_db String containing the name of database
*
* @return string HTML for complete editing page for central columns
*/
public function getHtmlForEditingPage(array $selected_fld, string $selected_db): string
{
$html = '';
$selected_fld_safe = [];
foreach ($selected_fld as $key) {
$selected_fld_safe[] = $this->dbi->escapeString($key);
}
$columns_list = implode("','", $selected_fld_safe);
$columns_list = "'" . $columns_list . "'";
$list_detail_cols = $this->findExistingColNames($selected_db, $columns_list, true);
$row_num = 0;
foreach ($list_detail_cols as $row) {
$tableHtmlRow = $this->getHtmlForEditTableRow($row, $row_num);
$html .= $tableHtmlRow;
$row_num++;
}
return $html;
}
/**
* get number of columns of given database from central columns list
* starting at offset $from
*
* @param string $db selected database
* @param int $from starting offset of first result
* @param int $num maximum number of results to return
*
* @return int count of $num columns present in central columns list
* starting at offset $from for the given database
*/
public function getColumnsCount(string $db, int $from = 0, int $num = 25): int
{
$cfgCentralColumns = $this->getParams();
if (! is_array($cfgCentralColumns)) {
return 0;
}
$pmadb = $cfgCentralColumns['db'];
$this->dbi->selectDb($pmadb, DatabaseInterface::CONNECT_CONTROL);
$central_list_table = $cfgCentralColumns['table'];
//get current values of $db from central column list
$query = 'SELECT COUNT(db_name) FROM ' . Util::backquote($central_list_table) . ' '
. 'WHERE db_name = \'' . $this->dbi->escapeString($db) . '\'' .
($num === 0 ? '' : 'LIMIT ' . $from . ', ' . $num) . ';';
$result = $this->dbi->fetchResult($query, null, null, DatabaseInterface::CONNECT_CONTROL);
if (isset($result[0])) {
return (int) $result[0];
}
return -1;
}
/**
* @return string[]
*/
public function getColumnsNotInCentralList(string $db, string $table): array
{
$existingColumns = $this->getFromTable($db, $table);
$this->dbi->selectDb($db);
$columnNames = $this->dbi->getColumnNames($db, $table);
// returns a list of column names less the ones from $existingColumns
return array_values(array_diff($columnNames, $existingColumns));
}
/**
* Adding a new user defined column to central list
*
* @param string $db current database
* @param int $total_rows number of rows in central columns
* @param int $pos offset of first result with complete result set
* @param string $text_dir table footer arrow direction
*
* @return array
*/
public function getTemplateVariablesForMain(
string $db,
int $total_rows,
int $pos,
string $text_dir
): array {
$max_rows = $this->maxRows;
$attribute_types = $this->dbi->types->getAttributes();
$tn_pageNow = ($pos / $this->maxRows) + 1;
$tn_nbTotalPage = (int) ceil($total_rows / $this->maxRows);
$tn_page_selector = $tn_nbTotalPage > 1 ? Util::pageselector(
'pos',
$this->maxRows,
$tn_pageNow,
$tn_nbTotalPage
) : '';
$this->dbi->selectDb($db);
$tables = $this->dbi->getTables($db);
$rows_list = $this->getColumnsList($db, $pos, $max_rows);
$defaultValues = [];
$rows_meta = [];
$types_upper = [];
$row_num = 0;
foreach ($rows_list as $row) {
$rows_meta[$row_num] = [];
if (! isset($row['col_default']) || $row['col_default'] == '') {
$rows_meta[$row_num]['DefaultType'] = 'NONE';
} elseif ($row['col_default'] === 'CURRENT_TIMESTAMP' || $row['col_default'] === 'current_timestamp()') {
$rows_meta[$row_num]['DefaultType'] = 'CURRENT_TIMESTAMP';
} elseif ($row['col_default'] == 'NULL') {
$rows_meta[$row_num]['DefaultType'] = $row['col_default'];
} else {
$rows_meta[$row_num]['DefaultType'] = 'USER_DEFINED';
$rows_meta[$row_num]['DefaultValue'] = $row['col_default'];
}
$types_upper[$row_num] = mb_strtoupper((string) $row['col_type']);
// For a TIMESTAMP, do not show the string "CURRENT_TIMESTAMP" as a default value
$defaultValues[$row_num] = '';
if (isset($rows_meta[$row_num]['DefaultValue'])) {
$defaultValues[$row_num] = $rows_meta[$row_num]['DefaultValue'];
if ($types_upper[$row_num] === 'BIT') {
$defaultValues[$row_num] = Util::convertBitDefaultValue($rows_meta[$row_num]['DefaultValue']);
} elseif ($types_upper[$row_num] === 'BINARY' || $types_upper[$row_num] === 'VARBINARY') {
$defaultValues[$row_num] = bin2hex($rows_meta[$row_num]['DefaultValue']);
}
}
$row_num++;
}
$charsets = Charsets::getCharsets($this->dbi, $this->disableIs);
$collations = Charsets::getCollations($this->dbi, $this->disableIs);
$charsetsList = [];
foreach ($charsets as $charset) {
$collationsList = [];
foreach ($collations[$charset->getName()] as $collation) {
$collationsList[] = [
'name' => $collation->getName(),
'description' => $collation->getDescription(),
];
}
$charsetsList[] = [
'name' => $charset->getName(),
'description' => $charset->getDescription(),
'collations' => $collationsList,
];
}
return [
'db' => $db,
'total_rows' => $total_rows,
'max_rows' => $max_rows,
'pos' => $pos,
'char_editing' => $this->charEditing,
'attribute_types' => $attribute_types,
'tn_nbTotalPage' => $tn_nbTotalPage,
'tn_page_selector' => $tn_page_selector,
'tables' => $tables,
'rows_list' => $rows_list,
'rows_meta' => $rows_meta,
'default_values' => $defaultValues,
'types_upper' => $types_upper,
'text_dir' => $text_dir,
'charsets' => $charsetsList,
];
}
}