Merge pull request #17894 from MauricioFauth/dblist-global-removal

Remove the `dblist` global variable
phpmyadmin · Nov 14, 2022 · 40e44c0 · 40e44c0
2 parents c08b4a7 + d0d9055
commit 40e44c0
Show file tree

Hide file tree

Showing 25 changed files with 133 additions and 266 deletions.
diff --git a/libraries/classes/Controllers/Database/Structure/CopyFormController.php b/libraries/classes/Controllers/Database/Structure/CopyFormController.php
@@ -13,8 +13,6 @@ final class CopyFormController extends AbstractController
 {
     public function __invoke(ServerRequest $request): void
     {
-        $GLOBALS['dblist'] = $GLOBALS['dblist'] ?? null;
-
         $selected = $_POST['selected_tbl'] ?? [];
 
         if (empty($selected)) {
@@ -29,7 +27,7 @@ public function __invoke(ServerRequest $request): void
             $urlParams['selected'][] = $selectedValue;
         }
 
-        $databasesList = $GLOBALS['dblist']->databases;
+        $databasesList = $GLOBALS['dbi']->getDatabaseList();
         foreach ($databasesList as $key => $databaseName) {
             if ($databaseName == $GLOBALS['db']) {
                 $databasesList->offsetUnset($key);

diff --git a/libraries/classes/Controllers/DatabaseController.php b/libraries/classes/Controllers/DatabaseController.php
@@ -10,7 +10,6 @@ final class DatabaseController extends AbstractController
 {
     public function __invoke(ServerRequest $request): void
     {
-        $GLOBALS['dblist'] = $GLOBALS['dblist'] ?? null;
-        $this->response->addJSON(['databases' => $GLOBALS['dblist']->databases]);
+        $this->response->addJSON(['databases' => $GLOBALS['dbi']->getDatabaseList()]);
     }
 }
diff --git a/libraries/classes/Controllers/Server/Databases/DestroyController.php b/libraries/classes/Controllers/Server/Databases/DestroyController.php
@@ -48,7 +48,6 @@ public function __invoke(ServerRequest $request): void
     {
         $GLOBALS['selected'] = $GLOBALS['selected'] ?? null;
         $GLOBALS['errorUrl'] = $GLOBALS['errorUrl'] ?? null;
-        $GLOBALS['dblist'] = $GLOBALS['dblist'] ?? null;
         $GLOBALS['reload'] = $GLOBALS['reload'] ?? null;
 
         $selected_dbs = $_POST['selected_dbs'] ?? null;
@@ -90,7 +89,7 @@ public function __invoke(ServerRequest $request): void
             $this->transformations->clear($database);
         }
 
-        $GLOBALS['dblist']->databases->build();
+        $this->dbi->getDatabaseList()->build();
 
         $message = Message::success(
             _ngettext(

diff --git a/libraries/classes/Controllers/Server/DatabasesController.php b/libraries/classes/Controllers/Server/DatabasesController.php
@@ -78,7 +78,6 @@ public function __construct(
     public function __invoke(ServerRequest $request): void
     {
         $GLOBALS['server'] = $GLOBALS['server'] ?? null;
-        $GLOBALS['dblist'] = $GLOBALS['dblist'] ?? null;
         $GLOBALS['is_create_db_priv'] = $GLOBALS['is_create_db_priv'] ?? null;
         $GLOBALS['db_to_create'] = $GLOBALS['db_to_create'] ?? null;
         $GLOBALS['text_dir'] = $GLOBALS['text_dir'] ?? null;
@@ -121,7 +120,7 @@ public function __invoke(ServerRequest $request): void
                 $this->position,
                 true
             );
-            $this->databaseCount = count($GLOBALS['dblist']->databases);
+            $this->databaseCount = count($this->dbi->getDatabaseList());
         }
 
         $urlParams = [

diff --git a/libraries/classes/Controllers/Table/OperationsController.php b/libraries/classes/Controllers/Table/OperationsController.php
@@ -489,8 +489,9 @@ public function __invoke(ServerRequest $request): void
         $possibleRowFormats = $this->operations->getPossibleRowFormat();
 
         $databaseList = [];
-        if (count($GLOBALS['dblist']->databases) <= $GLOBALS['cfg']['MaxDbList']) {
-            $databaseList = $GLOBALS['dblist']->databases->getList();
+        $listDatabase = $this->dbi->getDatabaseList();
+        if (count($listDatabase) <= $GLOBALS['cfg']['MaxDbList']) {
+            $databaseList = $listDatabase->getList();
         }
 
         $hasForeignKeys = ! empty($this->relation->getForeigners($GLOBALS['db'], $GLOBALS['table'], '', 'foreign'));

diff --git a/libraries/classes/Controllers/Table/RelationController.php b/libraries/classes/Controllers/Table/RelationController.php
@@ -179,7 +179,7 @@ public function __invoke(ServerRequest $request): void
                 'db' => $GLOBALS['db'],
                 'table' => $GLOBALS['table'],
                 'url_params' => $GLOBALS['urlParams'],
-                'databases' => $GLOBALS['dblist']->databases,
+                'databases' => $this->dbi->getDatabaseList(),
                 'foreign_db' => $foreignDb,
                 'foreign_table' => $foreignTable,
                 'unique_columns' => $uniqueColumns,
@@ -198,7 +198,7 @@ public function __invoke(ServerRequest $request): void
             'db' => $GLOBALS['db'],
             'table' => $GLOBALS['table'],
             'url_params' => $GLOBALS['urlParams'],
-            'databases' => $GLOBALS['dblist']->databases,
+            'databases' => $this->dbi->getDatabaseList(),
             'foreign_db' => false,
             'foreign_table' => false,
             'unique_columns' => [],
@@ -220,7 +220,7 @@ public function __invoke(ServerRequest $request): void
             'column_hash_array' => $column_hash_array,
             'save_row' => array_values($columns),
             'url_params' => $GLOBALS['urlParams'],
-            'databases' => $GLOBALS['dblist']->databases,
+            'databases' => $this->dbi->getDatabaseList(),
             'dbi' => $this->dbi,
             'default_sliders_state' => $GLOBALS['cfg']['InitialSlidersState'],
             'route' => $request->getRoute(),

diff --git a/libraries/classes/Database/DatabaseList.php b/libraries/classes/Database/DatabaseList.php
diff --git a/libraries/classes/DatabaseInterface.php b/libraries/classes/DatabaseInterface.php
@@ -9,7 +9,6 @@
 
 use PhpMyAdmin\Config\Settings\Server;
 use PhpMyAdmin\ConfigStorage\Relation;
-use PhpMyAdmin\Database\DatabaseList;
 use PhpMyAdmin\Dbal\DatabaseName;
 use PhpMyAdmin\Dbal\DbalInterface;
 use PhpMyAdmin\Dbal\DbiExtension;
@@ -141,6 +140,9 @@ class DatabaseInterface implements DbalInterface
     /** @var float */
     public $lastQueryExecutionTime = 0;
 
+    /** @var ListDatabase|null */
+    private $databaseList = null;
+
     /**
      * @param DbiExtension $ext Object to be used for database queries
      */
@@ -701,14 +703,14 @@ public function getDatabasesFull(
             // f.e. to apply hide_db and only_db
             $drops = array_diff(
                 array_keys($databases),
-                (array) $GLOBALS['dblist']->databases
+                (array) $this->getDatabaseList()
             );
             foreach ($drops as $drop) {
                 unset($databases[$drop]);
             }
         } else {
             $databases = [];
-            foreach ($GLOBALS['dblist']->databases as $databaseName) {
+            foreach ($this->getDatabaseList() as $databaseName) {
                 // Compatibility with INFORMATION_SCHEMA output
                 $databases[$databaseName]['SCHEMA_NAME'] = $databaseName;
 
@@ -843,7 +845,7 @@ public function getColumnsFull(
 
         $columns = [];
         if ($database === null) {
-            foreach ($GLOBALS['dblist']->databases as $database) {
+            foreach ($this->getDatabaseList() as $database) {
                 $columns[$database] = $this->getColumnsFull($database, null, null, $link);
             }
 
@@ -1145,10 +1147,7 @@ public function postConnect(): void
         /* Loads closest context to this version. */
         Context::loadClosest(($this->isMariaDb ? 'MariaDb' : 'MySql') . $this->versionInt);
 
-        /**
-         * the DatabaseList class as a stub for the ListDatabase class
-         */
-        $GLOBALS['dblist'] = new DatabaseList();
+        $this->databaseList = null;
     }
 
     /**
@@ -1190,14 +1189,11 @@ public function setCollation(string $collation): void
     public function postConnectControl(Relation $relation): void
     {
         // If Zero configuration mode enabled, check PMA tables in current db.
-        if ($GLOBALS['cfg']['ZeroConf'] != true) {
+        if (! $GLOBALS['cfg']['ZeroConf']) {
             return;
         }
 
-        /**
-         * the DatabaseList class as a stub for the ListDatabase class
-         */
-        $GLOBALS['dblist'] = new DatabaseList();
+        $this->databaseList = null;
 
         $relation->initRelationParamsCache();
     }
@@ -2108,4 +2104,13 @@ public function prepare(string $query, $link = self::CONNECT_USER)
     {
         return $this->extension->prepare($this->links[$link], $query);
     }
+
+    public function getDatabaseList(): ListDatabase
+    {
+        if ($this->databaseList === null) {
+            $this->databaseList = new ListDatabase();
+        }
+
+        return $this->databaseList;
+    }
 }
diff --git a/libraries/classes/Export.php b/libraries/classes/Export.php
@@ -594,7 +594,7 @@ public function exportServer(
         }
 
         // Walk over databases
-        foreach ($GLOBALS['dblist']->databases as $currentDb) {
+        foreach ($this->dbi->getDatabaseList() as $currentDb) {
             if (! isset($tmpSelect) || ! mb_strpos(' ' . $tmpSelect, '|' . $currentDb . '|')) {
                 continue;
             }

diff --git a/libraries/classes/Export/Options.php b/libraries/classes/Export/Options.php
@@ -67,7 +67,7 @@ public function getDatabasesForSelectOptions($tmpSelect = '')
         }
 
         $databases = [];
-        foreach ($GLOBALS['dblist']->databases as $currentDb) {
+        foreach ($GLOBALS['dbi']->getDatabaseList() as $currentDb) {
             if (Utilities::isSystemSchema($currentDb, true)) {
                 continue;
             }

diff --git a/libraries/classes/Operations.php b/libraries/classes/Operations.php
@@ -122,7 +122,7 @@ public function createDbBeforeCopy(DatabaseName $newDatabaseName): void
 
         // rebuild the database list because Table::moveCopy
         // checks in this list if the target db exists
-        $GLOBALS['dblist']->databases->build();
+        $this->dbi->getDatabaseList()->build();
     }
 
     /**

diff --git a/libraries/classes/ReplicationGui.php b/libraries/classes/ReplicationGui.php
@@ -212,7 +212,7 @@ public function getHtmlForReplicaConfiguration(
     public function getHtmlForReplicationDbMultibox(): string
     {
         $databases = [];
-        foreach ($GLOBALS['dblist']->databases as $database) {
+        foreach ($GLOBALS['dbi']->getDatabaseList() as $database) {
             if (Utilities::isSystemSchema($database)) {
                 continue;
             }

diff --git a/libraries/classes/Server/Privileges.php b/libraries/classes/Server/Privileges.php
@@ -1914,32 +1914,30 @@ public function getHtmlForAllTableSpecificRights(
         $data['type'] = $type;
 
         if ($type === 'database') {
-            $predDbArray = $GLOBALS['dblist']->databases;
+            $predDbArray = $this->dbi->getDatabaseList();
             $databasesToSkip = [
                 'information_schema',
                 'performance_schema',
             ];
 
             $databases = [];
             $escapedDatabases = [];
-            if (! empty($predDbArray)) {
-                foreach ($predDbArray as $currentDb) {
-                    if (in_array($currentDb, $databasesToSkip)) {
-                        continue;
-                    }
-
-                    $currentDbEscaped = Util::escapeMysqlWildcards($currentDb);
-                    // cannot use array_diff() once, outside of the loop,
-                    // because the list of databases has special characters
-                    // already escaped in $foundRows,
-                    // contrary to the output of SHOW DATABASES
-                    if (in_array($currentDbEscaped, $foundRows)) {
-                        continue;
-                    }
+            foreach ($predDbArray as $currentDb) {
+                if (in_array($currentDb, $databasesToSkip)) {
+                    continue;
+                }
 
-                    $databases[] = $currentDb;
-                    $escapedDatabases[] = $currentDbEscaped;
+                $currentDbEscaped = Util::escapeMysqlWildcards($currentDb);
+                // cannot use array_diff() once, outside of the loop,
+                // because the list of databases has special characters
+                // already escaped in $foundRows,
+                // contrary to the output of SHOW DATABASES
+                if (in_array($currentDbEscaped, $foundRows)) {
+                    continue;
                 }
+
+                $databases[] = $currentDb;
+                $escapedDatabases[] = $currentDbEscaped;
             }
 
             $data['databases'] = $databases;

diff --git a/libraries/classes/Table.php b/libraries/classes/Table.php
@@ -984,8 +984,9 @@ public static function moveCopy(
         $GLOBALS['asfile'] = 1;
 
         // Ensuring the target database is valid.
-        if (! $GLOBALS['dblist']->databases->exists($sourceDb, $targetDb)) {
-            if (! $GLOBALS['dblist']->databases->exists($sourceDb)) {
+        $databaseList = $GLOBALS['dbi']->getDatabaseList();
+        if (! $databaseList->exists($sourceDb, $targetDb)) {
+            if (! $databaseList->exists($sourceDb)) {
                 $GLOBALS['message'] = Message::rawError(
                     sprintf(
                         __('Source database `%s` was not found!'),
@@ -994,7 +995,7 @@ public static function moveCopy(
                 );
             }
 
-            if (! $GLOBALS['dblist']->databases->exists($targetDb)) {
+            if (! $databaseList->exists($targetDb)) {
                 $GLOBALS['message'] = Message::rawError(
                     sprintf(
                         __('Target database `%s` was not found!'),
@@ -1461,7 +1462,7 @@ public function rename($newName, $newDb = null): bool
 
         if ($newDb !== null && $newDb !== $this->getDbName()) {
             // Ensure the target is valid
-            if (! $GLOBALS['dblist']->databases->exists($newDb)) {
+            if (! $this->dbi->getDatabaseList()->exists($newDb)) {
                 $this->errors[] = __('Invalid database:') . ' ' . $newDb;
 
                 return false;

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -11165,11 +11165,6 @@ parameters:
 			count: 1
 			path: test/classes/TableTest.php
 
-		-
-			message: "#^Strict comparison using \\=\\=\\= between mixed and mixed will always evaluate to true\\.$#"
-			count: 1
-			path: test/classes/TableTest.php
-
 		-
 			message: "#^Method PhpMyAdmin\\\\Tests\\\\TemplateTest\\:\\:providerTestDynamicRender\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1