PhpMyAdmin\Tracking\Tracker

Complexity

Total Complexity

86

Size/Duplication

Total Lines	649
Duplicated Lines	0 %

Test Coverage

Coverage

65.73%

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	deactivateTracking()	0	3	1
A	isEnabled()	0	3	1
A	changeTracking()	0	25	2
A	activateTracking()	0	3	1
A	enable()	0	3	1
A	getLogComment()	0	6	1
A	createDatabaseVersion()	0	48	4
C	handleQuery()	0	131	17
A	disable()	0	3	1
A	isTracked()	0	31	4
A	isActive()	0	10	2
A	getVersion()	0	30	4
B	createVersion()	0	91	10
A	isAnyTrackingInProgress()	0	13	1
F	parseQuery()	0	123	36

<?php
/**
 * Tracking changes on databases, tables and views
 */

declare(strict_types=1);

namespace PhpMyAdmin\Tracking;

use PhpMyAdmin\Config;
use PhpMyAdmin\ConfigStorage\Features\TrackingFeature;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\Current;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\Dbal\ConnectionType;
use PhpMyAdmin\Plugins;
use PhpMyAdmin\Plugins\Export\ExportSql;
use PhpMyAdmin\SqlParser\Parser;
use PhpMyAdmin\SqlParser\Statements\AlterStatement;
use PhpMyAdmin\SqlParser\Statements\CreateStatement;
use PhpMyAdmin\SqlParser\Statements\DeleteStatement;
use PhpMyAdmin\SqlParser\Statements\DropStatement;
use PhpMyAdmin\SqlParser\Statements\InsertStatement;
use PhpMyAdmin\SqlParser\Statements\RenameStatement;
use PhpMyAdmin\SqlParser\Statements\TruncateStatement;
use PhpMyAdmin\SqlParser\Statements\UpdateStatement;
use PhpMyAdmin\Util;

use function preg_quote;
use function preg_replace;
use function serialize;
use function sprintf;
use function str_ends_with;
use function str_starts_with;
use function trim;

/**
 * This class tracks changes on databases, tables and views.
 */
class Tracker
{
    private static bool $enabled = false;

    /**
     * Cache to avoid quering tracking status multiple times.
     *
     * @var mixed[]
     */
    protected static array $trackingCache = [];

    /**
     * Actually enables tracking. This needs to be done after all
     * underlaying code is initialized.
     */
    public static function enable(): void
    {
        self::$enabled = true;
    }

    public static function disable(): void
    {
        self::$enabled = false;
    }

    public static function isEnabled(): bool
    {
        return self::$enabled;
    }

    /**
     * Gets the on/off value of the Tracker module, starts initialization.
     */
    public static function isActive(): bool
    {
        if (! self::$enabled) {
            return false;
        }

        $relation = new Relation(DatabaseInterface::getInstance());

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

        $relationParameters = $relation->getRelationParameters();

        return $relationParameters->trackingFeature !== null;
    }

    /**
     * Gets the tracking status of a table, is it active or disabled ?
     *
     * @param string $dbName    name of database
     * @param string $tableName name of table
     */
    public static function isTracked(string $dbName, string $tableName): bool
    {
        if (! self::$enabled) {
            return false;
        }

        if (isset(self::$trackingCache[$dbName][$tableName])) {
            return self::$trackingCache[$dbName][$tableName];
        }

        $dbi = DatabaseInterface::getInstance();

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

        $relation = new Relation($dbi);
        $trackingFeature = $relation->getRelationParameters()->trackingFeature;
        if ($trackingFeature === null) {
            return false;
        }

        $sqlQuery = sprintf(
            'SELECT tracking_active FROM %s.%s WHERE db_name = %s AND table_name = %s'
                . ' ORDER BY version DESC LIMIT 1',
            Util::backquote($trackingFeature->database),
            Util::backquote($trackingFeature->tracking),
            $dbi->quoteString($dbName, ConnectionType::ControlUser),
            $dbi->quoteString($tableName, ConnectionType::ControlUser),
        );

        $result = $dbi->fetchValue($sqlQuery, 0, ConnectionType::ControlUser) == 1;

        self::$trackingCache[$dbName][$tableName] = $result;

        return $result;
    }

    /**
     * Returns the comment line for the log.
     *
     * @return string Comment, contains date and username
     */
    public static function getLogComment(): string
    {
        $date = Util::date('Y-m-d H:i:s');
        $user = preg_replace('/\s+/', ' ', Config::getInstance()->selectedServer['user']);

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

        return '# log ' . $date . ' ' . $user . "\n";
    }

    /**
     * Creates tracking version of a table / view
     * (in other words: create a job to track future changes on the table).
     *
     * @param string $dbName      name of database
     * @param string $tableName   name of table
     * @param string $version     version
     * @param string $trackingSet set of tracking statements
     * @param bool   $isView      if table is a view
     */
    public static function createVersion(
        string $dbName,
        string $tableName,
        string $version,
        string $trackingSet = '',
        bool $isView = false,
    ): bool {
        $GLOBALS['export_type'] ??= null;
        $dbi = DatabaseInterface::getInstance();

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

        $relation = new Relation($dbi);

        $config = Config::getInstance();

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

        if ($trackingSet === '') {
            $trackingSet = $config->selectedServer['tracking_default_statements'];
        }

        $exportSqlPlugin = Plugins::getPlugin('export', 'sql', [
            'export_type' => (string) $GLOBALS['export_type'],
            'single_table' => false,
        ]);
        if (! $exportSqlPlugin instanceof ExportSql) {
            return false;
        }

        $exportSqlPlugin->useSqlBackquotes(true);

        $date = Util::date('Y-m-d H:i:s');

        // Get data definition snapshot of table

        $columns = [];
        foreach ($dbi->getColumns($dbName, $tableName, true) as $column) {
            $columns[] = [
                'Field' => $column->field,
                'Type' => $column->type,
                'Collation' => $column->collation,
                'Null' => $column->isNull ? 'YES' : 'NO',
                'Key' => $column->key,
                'Default' => $column->default,
                'Extra' => $column->extra,
                'Comment' => $column->comment,
            ];
        }

        $indexes = $dbi->getTableIndexes($dbName, $tableName);

        $snapshot = ['COLUMNS' => $columns, 'INDEXES' => $indexes];
        $snapshot = serialize($snapshot);

        // Get DROP TABLE / DROP VIEW and CREATE TABLE SQL statements
        $createSql = '';

        if ($config->selectedServer['tracking_add_drop_table'] == true && ! $isView) {
            $createSql .= self::getLogComment()
                . 'DROP TABLE IF EXISTS ' . Util::backquote($tableName) . ";\n";
        }

        if ($config->selectedServer['tracking_add_drop_view'] == true && $isView) {
            $createSql .= self::getLogComment()
                . 'DROP VIEW IF EXISTS ' . Util::backquote($tableName) . ";\n";
        }

        $createSql .= self::getLogComment() . $exportSqlPlugin->getTableDef($dbName, $tableName);

        // Save version
        $trackingFeature = $relation->getRelationParameters()->trackingFeature;
        if ($trackingFeature === null) {
            return false;
        }

        $sqlQuery = sprintf(
            '/*NOTRACK*/' . "\n" . 'INSERT INTO %s.%s (db_name, table_name, version,'
                . ' date_created, date_updated, schema_snapshot, schema_sql, data_sql, tracking)'
                . ' values (%s, %s, %s, %s, %s, %s, %s, %s, %s)',
            Util::backquote($trackingFeature->database),
            Util::backquote($trackingFeature->tracking),
            $dbi->quoteString($dbName, ConnectionType::ControlUser),
            $dbi->quoteString($tableName, ConnectionType::ControlUser),
            $dbi->quoteString($version, ConnectionType::ControlUser),
            $dbi->quoteString($date, ConnectionType::ControlUser),
            $dbi->quoteString($date, ConnectionType::ControlUser),
            $dbi->quoteString($snapshot, ConnectionType::ControlUser),
            $dbi->quoteString($createSql, ConnectionType::ControlUser),
            $dbi->quoteString("\n", ConnectionType::ControlUser),
            $dbi->quoteString($trackingSet, ConnectionType::ControlUser),
        );

        $dbi->queryAsControlUser($sqlQuery);

        // Deactivate previous version
        return self::deactivateTracking($dbName, $tableName, (string) ((int) $version - 1));
    }

    /**
     * Creates tracking version of a database
     * (in other words: create a job to track future changes on the database).
     *
     * @param string $dbName      name of database
     * @param string $version     version
     * @param string $query       query
     * @param string $trackingSet set of tracking statements
     */
    public static function createDatabaseVersion(
        string $dbName,
        string $version,
        string $query,
        string $trackingSet = 'CREATE DATABASE,ALTER DATABASE,DROP DATABASE',
    ): bool {
        $dbi = DatabaseInterface::getInstance();

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

        $relation = new Relation($dbi);

        $date = Util::date('Y-m-d H:i:s');

        $config = Config::getInstance();

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

        if ($trackingSet === '') {
            $trackingSet = $config->selectedServer['tracking_default_statements'];
        }

        $createSql = '';

        if ($config->selectedServer['tracking_add_drop_database'] == true) {
            $createSql .= self::getLogComment() . 'DROP DATABASE IF EXISTS ' . Util::backquote($dbName) . ";\n";
        }

        $createSql .= self::getLogComment() . $query;

        $trackingFeature = $relation->getRelationParameters()->trackingFeature;
        if ($trackingFeature === null) {
            return false;
        }

        // Save version
        $sqlQuery = sprintf(
            '/*NOTRACK*/' . "\n" . 'INSERT INTO %s.%s (db_name, table_name, version,'
                . ' date_created, date_updated, schema_snapshot, schema_sql, data_sql, tracking)'
                . ' values (%s, %s, %s, %s, %s, %s, %s, %s, %s)',
            Util::backquote($trackingFeature->database),
            Util::backquote($trackingFeature->tracking),
            $dbi->quoteString($dbName, ConnectionType::ControlUser),
            $dbi->quoteString('', ConnectionType::ControlUser),
            $dbi->quoteString($version, ConnectionType::ControlUser),
            $dbi->quoteString($date, ConnectionType::ControlUser),
            $dbi->quoteString($date, ConnectionType::ControlUser),
            $dbi->quoteString('', ConnectionType::ControlUser),
            $dbi->quoteString($createSql, ConnectionType::ControlUser),
            $dbi->quoteString("\n", ConnectionType::ControlUser),
            $dbi->quoteString($trackingSet, ConnectionType::ControlUser),
        );

        return (bool) $dbi->queryAsControlUser($sqlQuery);
    }

    /**
     * Changes tracking of a table.
     *
     * @param string $dbName    name of database
     * @param string $tableName name of table
     * @param string $version   version
     * @param int    $newState  the new state of tracking
     */
    private static function changeTracking(
        string $dbName,
        string $tableName,
        string $version,
        int $newState,
    ): bool {
        $dbi = DatabaseInterface::getInstance();

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

        $relation = new Relation($dbi);
        $trackingFeature = $relation->getRelationParameters()->trackingFeature;
        if ($trackingFeature === null) {
            return false;
        }

        $sqlQuery = sprintf(
            'UPDATE %s.%s SET `tracking_active` = %d'
                . ' WHERE `db_name` = %s AND `table_name` = %s AND `version` = %s',
            Util::backquote($trackingFeature->database),
            Util::backquote($trackingFeature->tracking),
            $newState,
            $dbi->quoteString($dbName, ConnectionType::ControlUser),
            $dbi->quoteString($tableName, ConnectionType::ControlUser),
            $dbi->quoteString($version, ConnectionType::ControlUser),
        );

        return (bool) $dbi->queryAsControlUser($sqlQuery);
    }

    /**
     * Activates tracking of a table.
     *
     * @param string $dbname    name of database
     * @param string $tablename name of table
     * @param string $version   version
     */
    public static function activateTracking(string $dbname, string $tablename, string $version): bool
    {
        return self::changeTracking($dbname, $tablename, $version, 1);
    }

    /**
     * Deactivates tracking of a table.
     *
     * @param string $dbname    name of database
     * @param string $tablename name of table
     * @param string $version   version
     */
    public static function deactivateTracking(string $dbname, string $tablename, string $version): bool
    {
        return self::changeTracking($dbname, $tablename, $version, 0);
    }

    /**
     * Gets the newest version of a tracking job
     * (in other words: gets the HEAD version).
     *
     * @param string      $dbname    name of database
     * @param string      $tablename name of table
     * @param string|null $statement tracked statement
     *
     * @return int (-1 if no version exists | >  0 if a version exists)
     */
    private static function getVersion(string $dbname, string $tablename, string|null $statement = null): int
    {
        $dbi = DatabaseInterface::getInstance();

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

        $relation = new Relation($dbi);
        $trackingFeature = $relation->getRelationParameters()->trackingFeature;
        if ($trackingFeature === null) {
            return -1;
        }

        $sqlQuery = sprintf(
            'SELECT MAX(version) FROM %s.%s WHERE `db_name` = %s AND `table_name` = %s',
            Util::backquote($trackingFeature->database),
            Util::backquote($trackingFeature->tracking),
            $dbi->quoteString($dbname, ConnectionType::ControlUser),
            $dbi->quoteString($tablename, ConnectionType::ControlUser),
        );

        if ($statement != '') {
            $sqlQuery .= " AND FIND_IN_SET('" . $statement . "',tracking) > 0";
        }

        $result = $dbi->tryQueryAsControlUser($sqlQuery);

        if ($result === false) {
            return -1;
        }

        $row = $result->fetchRow();

        return (int) ($row[0] ?? -1);
    }

    /**
     * Parses a query. Gets
     *  - statement identifier (UPDATE, ALTER TABLE, ...)
     *  - type of statement, is it part of DDL or DML ?
     *  - tablename
     *
     * @param string $query query
     *
     * @return mixed[] containing identifier, type and tablename.
     *
     * @todo: using PMA SQL Parser when possible
     * @todo: support multi-table/view drops
     */
    public static function parseQuery(string $query): array
    {
        // Usage of PMA_SQP does not work here
        //
        // require_once("libraries/sqlparser.lib.php");
        // $parsed_sql = PMA_SQP_parse($query);
        // $sql_info = PMA_SQP_analyze($parsed_sql);

        $parser = new Parser($query);

        $tokens = $parser->list->tokens;

        // Parse USE statement, need it for SQL dump imports
        if ($tokens[0]->value === 'USE') {
            Current::$database = $tokens[2]->value;
        }

        $result = [];

        if ($parser->statements !== []) {
            $statement = $parser->statements[0];
            $options = $statement->options?->options;

            // DDL statements
            $result['type'] = 'DDL';

            // Parse CREATE statement
            if ($statement instanceof CreateStatement) {
                if ($options === null || $options === [] || ! isset($options[6])) {
                    return $result;
                }

                if ($options[6] === 'VIEW' || $options[6] === 'TABLE') {
                    $result['identifier'] = 'CREATE ' . $options[6];
                    $result['tablename'] = $statement->name?->table;
                } elseif ($options[6] === 'DATABASE') {
                    $result['identifier'] = 'CREATE DATABASE';
                    $result['tablename'] = '';

                    // In case of CREATE DATABASE, database field of the CreateStatement is the name of the database
                    Current::$database = $statement->name?->database;
                } elseif (
                    $options[6] === 'INDEX'
                          || $options[6] === 'UNIQUE INDEX'
                          || $options[6] === 'FULLTEXT INDEX'
                          || $options[6] === 'SPATIAL INDEX'
                ) {
                    $result['identifier'] = 'CREATE INDEX';

                    // In case of CREATE INDEX, we have to get the table name from body of the statement
                    $result['tablename'] = $statement->body[3]->value === '.' ? $statement->body[4]->value
                                                                              : $statement->body[2]->value;
                }
            } elseif ($statement instanceof AlterStatement) { // Parse ALTER statement
                if ($options === null || $options === [] || ! isset($options[3])) {
                    return $result;
                }

                if ($options[3] === 'VIEW' || $options[3] === 'TABLE') {
                    $result['identifier'] = 'ALTER ' . $options[3];
                    $result['tablename'] = $statement->table->table;
                } elseif ($options[3] === 'DATABASE') {
                    $result['identifier'] = 'ALTER DATABASE';
                    $result['tablename'] = '';

                    Current::$database = $statement->table->table;
                }
            } elseif ($statement instanceof DropStatement) { // Parse DROP statement
                if ($options === null || $options === [] || ! isset($options[1])) {
                    return $result;
                }

                if ($options[1] === 'VIEW' || $options[1] === 'TABLE') {
                    $result['identifier'] = 'DROP ' . $options[1];
                    $result['tablename'] = $statement->fields[0]->table;
                } elseif ($options[1] === 'DATABASE') {
                    $result['identifier'] = 'DROP DATABASE';
                    $result['tablename'] = '';

                    Current::$database = $statement->fields[0]->table;
                } elseif ($options[1] === 'INDEX') {
                    $result['identifier'] = 'DROP INDEX';
                    $result['tablename'] = $statement->table->table;
                }
            } elseif ($statement instanceof RenameStatement) { // Parse RENAME statement
                $result['identifier'] = 'RENAME TABLE';
                $result['tablename'] = $statement->renames[0]->old->table;
                $result['tablename_after_rename'] = $statement->renames[0]->new->table;
            }

            if (isset($result['identifier'])) {
                return $result;
            }

            // DML statements
            $result['type'] = 'DML';

            // Parse UPDATE statement
            if ($statement instanceof UpdateStatement) {
                $result['identifier'] = 'UPDATE';
                $result['tablename'] = $statement->tables[0]->table;
            }

            // Parse INSERT INTO statement
            if ($statement instanceof InsertStatement) {
                $result['identifier'] = 'INSERT';
                $result['tablename'] = $statement->into->dest->table;
            }

            // Parse DELETE statement
            if ($statement instanceof DeleteStatement) {
                $result['identifier'] = 'DELETE';
                $result['tablename'] = $statement->from[0]->table;
            }

            // Parse TRUNCATE statement
            if ($statement instanceof TruncateStatement) {
                $result['identifier'] = 'TRUNCATE';
                $result['tablename'] = $statement->table->table;
            }
        }

        return $result;
    }

    /**
     * Analyzes a given SQL statement and saves tracking data.
     *
     * @param string $query a SQL query
     */
    public static function handleQuery(string $query): void
    {
        // If query is marked as untouchable, leave
        if (str_starts_with($query, '/*NOTRACK*/')) {
            return;
        }

        if (! str_ends_with($query, ';')) {
            $query .= ";\n";
        }

        // Get database name
        $dbname = trim(Current::$database, '`');
        // $dbname can be empty, for example when coming from Synchronize
        // and this is a query for the remote server
        if ($dbname === '') {
            return;
        }

        $dbi = DatabaseInterface::getInstance();

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

        $relation = new Relation($dbi);
        $trackingFeature = $relation->getRelationParameters()->trackingFeature;
        if ($trackingFeature === null) {
            return;
        }

        if (! self::isAnyTrackingInProgress($dbi, $trackingFeature, $dbname)) {
            return;
        }

        // Get some information about query
        $result = self::parseQuery($query);

        // If we found a valid statement
        if (! isset($result['identifier'])) {
            return;
        }

        // The table name was not found, see issue: #16837 as an example
        // Also checks if the value is not null
        if (! isset($result['tablename'])) {
            return;
        }

        $version = self::getVersion($dbname, $result['tablename'], $result['identifier']);

        // If version not exists and auto-creation is enabled
        if (Config::getInstance()->selectedServer['tracking_version_auto_create'] == true && $version == -1) {

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

            // Create the version

            switch ($result['identifier']) {
                case 'CREATE TABLE':
                    self::createVersion($dbname, $result['tablename'], '1');
                    break;
                case 'CREATE VIEW':
                    self::createVersion($dbname, $result['tablename'], '1', '', true);
                    break;
                case 'CREATE DATABASE':
                    self::createDatabaseVersion($dbname, '1', $query);
                    break;
            }
        }

        // If version exists
        if ($version == -1) {
            return;
        }

        if (! self::isTracked($dbname, $result['tablename'])) {
            return;
        }

        $saveTo = match ($result['type']) {
            'DDL' => 'schema_sql',
            'DML' => 'data_sql',
            default => '',
        };

        $date = Util::date('Y-m-d H:i:s');

        // Cut off `dbname`. from query
        $query = preg_replace(
            '/`' . preg_quote($dbname, '/') . '`\s?\./',
            '',
            $query,
        );

        // Add log information
        $query = self::getLogComment() . $query;

        $relation = new Relation($dbi);
        $trackingFeature = $relation->getRelationParameters()->trackingFeature;
        if ($trackingFeature === null) {
            return;
        }

        // Mark it as untouchable
        $sqlQuery = sprintf(
            '/*NOTRACK*/' . "\n" . 'UPDATE %s.%s SET %s = CONCAT(%s, %s), `date_updated` = %s',
            Util::backquote($trackingFeature->database),
            Util::backquote($trackingFeature->tracking),
            Util::backquote($saveTo),
            Util::backquote($saveTo),
            $dbi->quoteString("\n" . $query, ConnectionType::ControlUser),
            $dbi->quoteString($date, ConnectionType::ControlUser),
        );

        // If table was renamed we have to change
        // the tablename attribute in pma_tracking too
        if ($result['identifier'] === 'RENAME TABLE') {
            $sqlQuery .= ', `table_name` = '
                . $dbi->quoteString($result['tablename_after_rename'], ConnectionType::ControlUser)
                . ' ';
        }

        // Save the tracking information only for
        //     1. the database
        //     2. the table / view
        //     3. the statements
        // we want to track
        $sqlQuery .= sprintf(
            " WHERE FIND_IN_SET('" . $result['identifier'] . "',tracking) > 0" .
            ' AND `db_name` = %s ' .
            ' AND `table_name` = %s ' .
            ' AND `version` = %s ',
            $dbi->quoteString($dbname, ConnectionType::ControlUser),
            $dbi->quoteString($result['tablename'], ConnectionType::ControlUser),
            $dbi->quoteString((string) $version, ConnectionType::ControlUser),
        );

        $dbi->queryAsControlUser($sqlQuery);
    }

    private static function isAnyTrackingInProgress(
        DatabaseInterface $dbi,
        TrackingFeature $trackingFeature,
        string $dbname,
    ): bool {
        $sqlQuery = sprintf(
            '/*NOTRACK*/ SELECT 1 FROM %s.%s WHERE tracking_active = 1 AND db_name = %s LIMIT 1',
            Util::backquote($trackingFeature->database),
            Util::backquote($trackingFeature->tracking),
            $dbi->quoteString($dbname, ConnectionType::ControlUser),
        );

        return $dbi->queryAsControlUser($sqlQuery)->fetchValue() !== false;
    }
}