PhpMyAdmin\Database\CentralColumns

Complexity

Total Complexity

103

Size/Duplication

Total Lines	877
Duplicated Lines	0 %

Test Coverage

Coverage

58.98%

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	getColumnsCount()	0	20	4
A	getWhereInColumns()	0	5	1
A	getListRaw()	0	27	4
A	__construct()	0	10	1
C	syncUniqueColumns()	0	86	12
A	findExistingColumns()	0	20	2
A	getStorageNotReadyMessage()	0	4	1
A	updateOneColumn()	0	51	5
A	getInsertQuery()	0	26	2
B	handleColumnExtra()	0	18	7
B	getHtmlForEditTableRow()	0	41	10
B	deleteColumnsFromList()	0	70	11
A	getHtmlForEditingPage()	0	12	2
C	getTemplateVariablesForMain()	0	86	14
A	getColumnsList()	0	23	3
A	getCount()	0	18	3
B	makeConsistentWithList()	0	60	11
A	getColumnsNotInCentralList()	0	7	1
A	updateMultipleColumn()	0	34	5
A	getParams()	0	11	2
A	findExistingColNames()	0	18	2

<?php

declare(strict_types=1);

namespace PhpMyAdmin\Database;

use PhpMyAdmin\Charsets;
use PhpMyAdmin\ColumnFull;
use PhpMyAdmin\Config;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\Dbal\ConnectionType;
use PhpMyAdmin\Identifiers\DatabaseName;

The type PhpMyAdmin\Identifiers\DatabaseName was not found. Maybe you did not declare it correctly or list all dependencies?

use PhpMyAdmin\Message;
use PhpMyAdmin\Template;
use PhpMyAdmin\Util;

use function __;
use function array_column;
use function array_diff;
use function array_map;
use function array_merge;
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
{
    /**
     * Current user
     */
    private string $user;

    /**
     * Number of rows displayed when browsing a result set
     */
    private int $maxRows;

    /**
     * Which editor should be used for CHAR/VARCHAR fields
     */
    private string $charEditing;

    /**
     * Disable use of INFORMATION_SCHEMA
     */
    private bool $disableIs;

    private Relation $relation;

    public Template $template;

    public function __construct(private DatabaseInterface $dbi)
    {
        $config = Config::getInstance();

The function PhpMyAdmin\Config::getInstance() has been deprecated: Use dependency injection instead.

        $this->user = $config->selectedServer['user'];
        $this->maxRows = $config->settings['MaxRows'];
        $this->charEditing = $config->settings['CharEditing'];
        $this->disableIs = $config->selectedServer['DisableIS'];

        $this->relation = new Relation($this->dbi);
        $this->template = new Template();
    }

    /**
     * Returns the configuration storage settings for central columns or false if no storage is available
     *
     * @return array{user:string, db: string, table:string}|false
     */
    public function getParams(): array|false
    {
        $centralColumnsFeature = $this->relation->getRelationParameters()->centralColumnsFeature;
        if ($centralColumnsFeature === null) {
            return false;
        }

        return [
            'user' => $this->user,
            'db' => $centralColumnsFeature->database->getName(),
            'table' => $centralColumnsFeature->centralColumns->getName(),
        ];
    }

    /**
     * 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 mixed[] 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'];
        $centralListTable = $cfgCentralColumns['table'];
        //get current values of $db from central column list
        if ($num === 0) {
            $query = 'SELECT * FROM ' . Util::backquote($pmadb) . '.' . Util::backquote($centralListTable) . ' '
                . 'WHERE db_name = ' . $this->dbi->quoteString($db, ConnectionType::ControlUser) . ';';
        } else {
            $query = 'SELECT * FROM ' . Util::backquote($pmadb) . '.' . Util::backquote($centralListTable) . ' '
                . 'WHERE db_name = ' . $this->dbi->quoteString($db, ConnectionType::ControlUser) . ' '
                . 'LIMIT ' . $from . ', ' . $num . ';';
        }

        $hasList = $this->dbi->fetchResult($query, null, null, ConnectionType::ControlUser);
        $this->handleColumnExtra($hasList);

        return $hasList;
    }

    /**
     * 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'];
        $centralListTable = $cfgCentralColumns['table'];
        $query = 'SELECT count(db_name) FROM '
            . Util::backquote($pmadb) . '.' . Util::backquote($centralListTable) . ' '
            . 'WHERE db_name = ' . $this->dbi->quoteString($db, ConnectionType::ControlUser) . ';';
        $res = $this->dbi->fetchResult($query, null, null, ConnectionType::ControlUser);
        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 list of given columns
     *
     * @return string[] list of columns in central columns among given set of columns
     */
    public function findExistingColNames(
        string $db,
        array $cols,
    ): array {
        $cfgCentralColumns = $this->getParams();
        if (! is_array($cfgCentralColumns)) {
            return [];
        }

        $cols = $this->getWhereInColumns($cols);

        $pmadb = $cfgCentralColumns['db'];
        $centralListTable = $cfgCentralColumns['table'];
        $query = 'SELECT col_name FROM '
            . Util::backquote($pmadb) . '.' . Util::backquote($centralListTable) . ' WHERE db_name = '
            . $this->dbi->quoteString($db, ConnectionType::ControlUser) . ' AND col_name IN (' . $cols . ');';

        return $this->dbi->fetchResult($query, null, null, ConnectionType::ControlUser);

The expression return $this->dbi->fetchResult($query, null, null, PhpMyAdmin\Dbal\ConnectionType::ControlUser) returns an array which contains values of type array<mixed,null|string> which are incompatible with the documented value type string.

    }

    /**
     * return the existing columns in central list among the given list of columns
     *
     * @param string   $db   the selected database
     * @param string[] $cols list of given columns
     *
     * @return (string|null)[][] list of columns in central columns among given set of columns
     */
    private function findExistingColumns(
        string $db,
        array $cols,
    ): array {
        $cfgCentralColumns = $this->getParams();
        if (! is_array($cfgCentralColumns)) {
            return [];
        }

        $cols = $this->getWhereInColumns($cols);

        $pmadb = $cfgCentralColumns['db'];
        $centralListTable = $cfgCentralColumns['table'];
        $query = 'SELECT * FROM '
            . Util::backquote($pmadb) . '.' . Util::backquote($centralListTable) . ' WHERE db_name = '
            . $this->dbi->quoteString($db, ConnectionType::ControlUser) . ' AND col_name IN (' . $cols . ');';
        $hasList = $this->dbi->fetchResult($query, null, null, ConnectionType::ControlUser);
        $this->handleColumnExtra($hasList);

        return $hasList;
    }

    /**
     * build the insert query for central columns list given PMA storage
     * db, central_columns table, column name and corresponding definition to be added
     *
     * @param ColumnFull $def              list of attributes of the column being added
     * @param string     $db               PMA configuration storage database name
     * @param string     $centralListTable central columns configuration storage table name
     *
     * @return string query string to insert the given column
     * with definition into central list
     */
    private function getInsertQuery(
        ColumnFull $def,
        string $db,
        string $centralListDb,
        string $centralListTable,
    ): string {
        $extractedColumnSpec = Util::extractColumnSpec($def->type);
        $attribute = trim($extractedColumnSpec['attribute']);
        $type = $extractedColumnSpec['type'];
        $length = $extractedColumnSpec['spec_in_brackets'];

        $collation = $def->collation ?? '';
        $isNull = $def->isNull ? '1' : '0';
        $extra = $def->extra;
        $default = $def->default ?? '';

        return 'INSERT INTO '
            . Util::backquote($centralListDb) . '.' . Util::backquote($centralListTable) . ' '
            . 'VALUES ( ' . $this->dbi->quoteString($db, ConnectionType::ControlUser) . ' ,'
            . $this->dbi->quoteString($def->field, ConnectionType::ControlUser) . ','
            . $this->dbi->quoteString($type, ConnectionType::ControlUser) . ','
            . $this->dbi->quoteString((string) $length, ConnectionType::ControlUser) . ','
            . $this->dbi->quoteString($collation, ConnectionType::ControlUser) . ','
            . $this->dbi->quoteString($isNull, ConnectionType::ControlUser) . ','
            . '\'' . implode(',', [$extra, $attribute])
            . '\',' . $this->dbi->quoteString($default, ConnectionType::ControlUser) . ');';
    }

    /**
     * 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 string[] $fieldSelect     if $isTable is true selected tables list otherwise selected columns list
     * @param bool     $isTable         if passed array is of tables or columns
     * @param string   $containingTable if $isTable is false, then table name to which columns belong
     *
     * @return true|Message
     */
    public function syncUniqueColumns(
        DatabaseName $databaseName,
        array $fieldSelect,
        bool $isTable = true,
        string $containingTable = '',
    ): bool|Message {
        $cfgCentralColumns = $this->getParams();
        if (! is_array($cfgCentralColumns)) {
            return $this->getStorageNotReadyMessage();
        }

        $existingCols = [];
        $insQuery = [];
        if ($isTable) {
            $cols = [];
            $fields = [];
            foreach ($fieldSelect as $table) {
                $fields[$table] = $this->dbi->getColumns($databaseName->getName(), $table, true);
                $cols = array_merge($cols, array_column($fields[$table], 'field'));
            }

            $hasList = $this->findExistingColNames($databaseName->getName(), $cols);
            foreach ($fieldSelect as $table) {
                foreach ($fields[$table] as $def) {
                    $field = $def->field;
                    if (! in_array($field, $hasList, true)) {
                        $hasList[] = $field;
                        $insQuery[] = $this->getInsertQuery(
                            $def,
                            $databaseName->getName(),
                            $cfgCentralColumns['db'],
                            $cfgCentralColumns['table'],
                        );
                    } else {
                        $existingCols[] = "'" . $field . "'";
                    }
                }
            }
        } else {
            $hasList = $this->findExistingColNames($databaseName->getName(), $fieldSelect);
            foreach ($fieldSelect as $column) {
                if (! in_array($column, $hasList, true)) {
                    $hasList[] = $column;
                    $field = $this->dbi->getColumn($databaseName->getName(), $containingTable, $column, true);
                    $insQuery[] = $this->getInsertQuery(
                        $field,

It seems like $field can also be of type PhpMyAdmin\Column and null; however, parameter $def of PhpMyAdmin\Database\CentralColumns::getInsertQuery() does only seem to accept PhpMyAdmin\ColumnFull, maybe add an additional type check?

                        $databaseName->getName(),
                        $cfgCentralColumns['db'],
                        $cfgCentralColumns['table'],
                    );
                } else {
                    $existingCols[] = "'" . $column . "'";
                }
            }
        }

        $message = true;
        if ($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',
                ),
            );
        }

        foreach ($insQuery as $query) {
            if (! $this->dbi->tryQuery($query, ConnectionType::ControlUser)) {
                $message = Message::error(__('Could not add columns!'));
                $message->addMessage(
                    Message::rawError($this->dbi->getError(ConnectionType::ControlUser)),
                );

                return $message;
            }
        }

        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 string[] $fieldSelect 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 $fieldSelect,
        bool $isTable = true,
    ): bool|Message {
        $cfgCentralColumns = $this->getParams();
        if (! is_array($cfgCentralColumns)) {
            return $this->getStorageNotReadyMessage();
        }

        $pmadb = $cfgCentralColumns['db'];
        $centralListTable = $cfgCentralColumns['table'];
        $colNotExist = [];
        if ($isTable) {
            $fields = [];
            $cols = [];
            foreach ($fieldSelect as $table) {
                $fields[$table] = $this->dbi->getColumnNames($database, $table);
                $cols = array_merge($cols, $fields[$table]);
            }

            $hasList = $this->findExistingColNames($database, $cols);
            foreach ($fieldSelect as $table) {
                foreach ($fields[$table] as $column) {
                    if (in_array($column, $hasList, true)) {
                        continue;
                    }

                    $colNotExist[] = "'" . $column . "'";
                }
            }
        } else {
            $cols = $fieldSelect;
            $hasList = $this->findExistingColNames($database, $cols);
            foreach ($fieldSelect as $column) {
                if (in_array($column, $hasList, true)) {
                    continue;
                }

                $colNotExist[] = "'" . $column . "'";
            }
        }

        $message = true;
        if ($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),
                ),
            );
        }

        $cols = $this->getWhereInColumns($cols);
        $query = 'DELETE FROM '
            . Util::backquote($pmadb) . '.' . Util::backquote($centralListTable) . ' WHERE db_name = '
            . $this->dbi->quoteString($database, ConnectionType::ControlUser) . ' AND col_name IN (' . $cols . ');';

        if (! $this->dbi->tryQuery($query, ConnectionType::ControlUser)) {
            $message = Message::error(__('Could not remove columns!'));
            $message->addHtml('<br>' . htmlspecialchars($cols) . '<br>');
            $message->addMessage(
                Message::rawError($this->dbi->getError(ConnectionType::ControlUser)),
            );
        }

        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 string[] $selectedTables list of selected tables.
     *
     * @return true|Message
     */
    public function makeConsistentWithList(
        string $db,
        array $selectedTables,
    ): bool|Message {
        $message = true;
        $this->dbi->selectDb($db);
        foreach ($selectedTables as $table) {
            $query = 'ALTER TABLE ' . Util::backquote($table);
            $hasList = $this->findExistingColumns($db, $this->dbi->getColumnNames($db, $table));
            foreach ($hasList as $column) {
                $columnStatus = $this->relation->checkChildForeignReferences($db, $table, $column['col_name']);
                //column definition can only be changed if
                //it is not referenced by another column
                if (! $columnStatus['isEditable']) {
                    continue;
                }

                $query .= ' MODIFY ' . Util::backquote($column['col_name']) . ' ' . $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->quoteString(
                            $column['col_default'],
                            ConnectionType::ControlUser,
                        );
                    } else {
                        $query .= ' DEFAULT ' . $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;
    }

    /**
     * update a column in central columns list if a edit is requested
     *
     * @param string $db           current database
     * @param string $origColName  original column name before edit
     * @param string $colName      new column name
     * @param string $colType      new column type
     * @param string $colAttribute new column attribute
     * @param string $colLength    new column length
     * @param bool   $colIsNull    value 1 if new column isNull is true, 0 otherwise
     * @param string $collation    new column collation
     * @param string $colExtra     new column extra property
     * @param string $colDefault   new column default value
     *
     * @return true|Message
     */
    public function updateOneColumn(
        string $db,
        string $origColName,
        string $colName,
        string $colType,
        string $colAttribute,
        string $colLength,
        bool $colIsNull,
        string $collation,
        string $colExtra,
        string $colDefault,
    ): bool|Message {
        $cfgCentralColumns = $this->getParams();
        if (! is_array($cfgCentralColumns)) {
            return $this->getStorageNotReadyMessage();
        }

        $centralListDb = $cfgCentralColumns['db'];
        $centralTable = $cfgCentralColumns['table'];
        if ($origColName === '') {
            $def = new ColumnFull(
                $colName,
                $colType . ($colLength !== '' ? '(' . $colLength . ')' : ''),
                $collation,
                $colIsNull,
                '',
                $colDefault,
                $colExtra,
                '',
                '',
            );
            $query = $this->getInsertQuery($def, $db, $centralListDb, $centralTable);
        } else {
            $query = 'UPDATE ' . Util::backquote($centralListDb) . '.' . Util::backquote($centralTable)
                . ' SET col_type = ' . $this->dbi->quoteString($colType, ConnectionType::ControlUser)
                . ', col_name = ' . $this->dbi->quoteString($colName, ConnectionType::ControlUser)
                . ', col_length = ' . $this->dbi->quoteString($colLength, ConnectionType::ControlUser)
                . ', col_isNull = ' . $colIsNull
                . ', col_collation = ' . $this->dbi->quoteString($collation, ConnectionType::ControlUser)
                . ', col_extra = \''
                . implode(',', [$colExtra, $colAttribute]) . '\''
                . ', col_default = ' . $this->dbi->quoteString($colDefault, ConnectionType::ControlUser)
                . ' WHERE db_name = ' . $this->dbi->quoteString($db, ConnectionType::ControlUser)
                . ' AND col_name = ' . $this->dbi->quoteString($origColName, ConnectionType::ControlUser);
        }

        if (! $this->dbi->tryQuery($query, ConnectionType::ControlUser)) {
            return Message::error($this->dbi->getError(ConnectionType::ControlUser));
        }

        return true;
    }

    /**
     * Update Multiple column in central columns list if a change is requested
     *
     * @param mixed[] $params Request parameters
     *
     * @return true|Message
     */
    public function updateMultipleColumn(array $params): bool|Message
    {
        $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]);
            $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 (string|null)[] $row    array contains complete information of a particular row of central list table
     * @param int             $rowNum position the row in the table
     *
     * @return string html of a particular row in the central columns table.
     */
    private function getHtmlForEditTableRow(array $row, int $rowNum): 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' => $rowNum,
            '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 mixed[] 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 [];
        }

        $pmadb = $cfgCentralColumns['db'];
        $centralTable = $cfgCentralColumns['table'];
        if ($table === '') {
            $query = 'SELECT * FROM ' . Util::backquote($pmadb) . '.' . Util::backquote($centralTable) . ' '
                . 'WHERE db_name = ' . $this->dbi->quoteString($db, ConnectionType::ControlUser) . ';';
        } else {
            $columns = $this->dbi->getColumnNames($db, $table);
            $query = 'SELECT * FROM ' . Util::backquote($pmadb) . '.' . Util::backquote($centralTable) . ' '
                . 'WHERE db_name = ' . $this->dbi->quoteString($db, ConnectionType::ControlUser);
            if ($columns !== []) {
                $query .= ' AND col_name NOT IN (' . $this->getWhereInColumns($columns) . ')';
            }

            $query .= ';';
        }

        $columnsList = $this->dbi->fetchResult($query, null, null, ConnectionType::ControlUser);
        $this->handleColumnExtra($columnsList);

        return $columnsList;
    }

    /**
     * Column `col_extra` is used to store both extra and attributes for a column.
     * This method separates them.
     *
     * @param mixed[] $columnsList columns list
     */
    private function handleColumnExtra(array &$columnsList): void
    {
        foreach ($columnsList as &$row) {
            $vals = explode(',', $row['col_extra']);

            if (in_array('BINARY', $vals, true)) {
                $row['col_attribute'] = 'BINARY';
            } elseif (in_array('UNSIGNED', $vals, true)) {
                $row['col_attribute'] = 'UNSIGNED';
            } elseif (in_array('UNSIGNED ZEROFILL', $vals, true)) {
                $row['col_attribute'] = 'UNSIGNED ZEROFILL';
            } elseif (in_array('on update CURRENT_TIMESTAMP', $vals, true)) {
                $row['col_attribute'] = 'on update CURRENT_TIMESTAMP';
            } else {
                $row['col_attribute'] = '';
            }

            $row['col_extra'] = in_array('auto_increment', $vals, true) ? 'auto_increment' : '';
        }
    }

    /**
     * Get HTML for editing page central columns
     *
     * @param string[] $selectedFld Array containing the selected fields
     * @param string   $selectedDb  String containing the name of database
     *
     * @return string HTML for complete editing page for central columns
     */
    public function getHtmlForEditingPage(array $selectedFld, string $selectedDb): string
    {
        $html = '';
        $listDetailCols = $this->findExistingColumns($selectedDb, $selectedFld);
        $rowNum = 0;
        foreach ($listDetailCols as $row) {
            $tableHtmlRow = $this->getHtmlForEditTableRow($row, $rowNum);
            $html .= $tableHtmlRow;
            $rowNum++;
        }

        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'];
        $centralListTable = $cfgCentralColumns['table'];
        //get current values of $db from central column list
        $query = 'SELECT COUNT(db_name) FROM ' . Util::backquote($pmadb) . '.' . Util::backquote($centralListTable)
            . ' WHERE db_name = ' . $this->dbi->quoteString($db, ConnectionType::ControlUser)
            . ($num === 0 ? '' : 'LIMIT ' . $from . ', ' . $num) . ';';
        $result = $this->dbi->fetchResult($query, null, null, ConnectionType::ControlUser);

        if (isset($result[0])) {
            return (int) $result[0];
        }

        return -1;
    }

    /** @return string[] */
    public function getColumnsNotInCentralList(string $db, string $table): array
    {
        $existingColumns = $this->findExistingColNames($db, $this->dbi->getColumnNames($db, $table));
        $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    $totalRows number of rows in central columns
     * @param int    $pos       offset of first result with complete result set
     * @param string $textDir   table footer arrow direction
     *
     * @return mixed[]
     */
    public function getTemplateVariablesForMain(
        string $db,
        int $totalRows,
        int $pos,
        string $textDir,
    ): array {
        $maxRows = $this->maxRows;
        $attributeTypes = $this->dbi->types->getAttributes();

        $tnPageNow = ($pos / $this->maxRows) + 1;
        $tnNbTotalPage = (int) ceil($totalRows / $this->maxRows);
        $tnPageSelector = $tnNbTotalPage > 1 ? Util::pageselector(
            'pos',
            $this->maxRows,
            $tnPageNow,
            $tnNbTotalPage,
        ) : '';
        $tables = $this->dbi->getTables($db);
        $rowsList = $this->getColumnsList($db, $pos, $maxRows);

        $defaultValues = [];
        $rowsMeta = [];
        $typesUpper = [];
        $rowNum = 0;
        foreach ($rowsList as $row) {
            $rowsMeta[$rowNum] = [];
            if (! isset($row['col_default']) || $row['col_default'] == '') {
                $rowsMeta[$rowNum]['DefaultType'] = 'NONE';
            } elseif ($row['col_default'] === 'CURRENT_TIMESTAMP' || $row['col_default'] === 'current_timestamp()') {
                $rowsMeta[$rowNum]['DefaultType'] = 'CURRENT_TIMESTAMP';
            } elseif ($row['col_default'] === 'NULL') {
                $rowsMeta[$rowNum]['DefaultType'] = $row['col_default'];
            } else {
                $rowsMeta[$rowNum]['DefaultType'] = 'USER_DEFINED';
                $rowsMeta[$rowNum]['DefaultValue'] = $row['col_default'];
            }

            $typesUpper[$rowNum] = mb_strtoupper((string) $row['col_type']);

            // For a TIMESTAMP, do not show the string "CURRENT_TIMESTAMP" as a default value
            $defaultValues[$rowNum] = '';
            if (isset($rowsMeta[$rowNum]['DefaultValue'])) {
                $defaultValues[$rowNum] = $rowsMeta[$rowNum]['DefaultValue'];

                if ($typesUpper[$rowNum] === 'BIT') {
                    $defaultValues[$rowNum] = Util::convertBitDefaultValue($rowsMeta[$rowNum]['DefaultValue']);
                } elseif ($typesUpper[$rowNum] === 'BINARY' || $typesUpper[$rowNum] === 'VARBINARY') {
                    $defaultValues[$rowNum] = bin2hex($rowsMeta[$rowNum]['DefaultValue']);
                }
            }

            $rowNum++;
        }

        $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' => $totalRows,
            'max_rows' => $maxRows,
            'pos' => $pos,
            'char_editing' => $this->charEditing,
            'attribute_types' => $attributeTypes,
            'tn_nbTotalPage' => $tnNbTotalPage,
            'tn_page_selector' => $tnPageSelector,
            'tables' => $tables,
            'rows_list' => $rowsList,
            'rows_meta' => $rowsMeta,
            'default_values' => $defaultValues,
            'types_upper' => $typesUpper,
            'text_dir' => $textDir,
            'charsets' => $charsetsList,
        ];
    }

    /** @param string[] $columns */
    private function getWhereInColumns(array $columns): string
    {
        return implode(',', array_map(
            fn (string $string): string => $this->dbi->quoteString($string, ConnectionType::ControlUser),
            $columns,
        ));
    }

    private function getStorageNotReadyMessage(): Message
    {
        return Message::error(
            __('The configuration storage is not ready for the central list of columns feature.'),
        );
    }
}