Use DatabaseName VO for db names in Table\Partition

- Adds DatabaseName support for DatabaseInterface::selectDb method Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · May 22, 2021 · 5faf950 · 5faf950
1 parent c2b1896
commit 5faf950
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 39 deletions.
diff --git a/libraries/classes/Controllers/Table/PartitionController.php b/libraries/classes/Controllers/Table/PartitionController.php
@@ -69,7 +69,14 @@ public function check(): void
             return;
         }
 
-        [$rows, $query] = $this->model->check($this->db, $this->table, $partitionName);
+        try {
+            [$rows, $query] = $this->model->check(new DatabaseName($this->db), $this->table, $partitionName);
+        } catch (Throwable $e) {
+            $message = Message::error($e->getMessage());
+            $this->response->addHTML($message->getDisplay());
+
+            return;
+        }
 
         $message = Generator::getMessage(
             __('Your SQL query has been executed successfully.'),
@@ -92,7 +99,14 @@ public function drop(): void
             return;
         }
 
-        [$result, $query] = $this->model->drop($this->db, $this->table, $partitionName);
+        try {
+            [$result, $query] = $this->model->drop(new DatabaseName($this->db), $this->table, $partitionName);
+        } catch (Throwable $e) {
+            $message = Message::error($e->getMessage());
+            $this->response->addHTML($message->getDisplay());
+
+            return;
+        }
 
         if ($result) {
             $message = Generator::getMessage(
@@ -122,7 +136,14 @@ public function optimize(): void
             return;
         }
 
-        [$rows, $query] = $this->model->optimize($this->db, $this->table, $partitionName);
+        try {
+            [$rows, $query] = $this->model->optimize(new DatabaseName($this->db), $this->table, $partitionName);
+        } catch (Throwable $e) {
+            $message = Message::error($e->getMessage());
+            $this->response->addHTML($message->getDisplay());
+
+            return;
+        }
 
         $message = Generator::getMessage(
             __('Your SQL query has been executed successfully.'),
@@ -145,7 +166,14 @@ public function rebuild(): void
             return;
         }
 
-        [$result, $query] = $this->model->rebuild($this->db, $this->table, $partitionName);
+        try {
+            [$result, $query] = $this->model->rebuild(new DatabaseName($this->db), $this->table, $partitionName);
+        } catch (Throwable $e) {
+            $message = Message::error($e->getMessage());
+            $this->response->addHTML($message->getDisplay());
+
+            return;
+        }
 
         if ($result) {
             $message = Generator::getMessage(
@@ -175,7 +203,14 @@ public function repair(): void
             return;
         }
 
-        [$rows, $query] = $this->model->repair($this->db, $this->table, $partitionName);
+        try {
+            [$rows, $query] = $this->model->repair(new DatabaseName($this->db), $this->table, $partitionName);
+        } catch (Throwable $e) {
+            $message = Message::error($e->getMessage());
+            $this->response->addHTML($message->getDisplay());
+
+            return;
+        }
 
         $message = Generator::getMessage(
             __('Your SQL query has been executed successfully.'),
@@ -198,7 +233,14 @@ public function truncate(): void
             return;
         }
 
-        [$result, $query] = $this->model->truncate($this->db, $this->table, $partitionName);
+        try {
+            [$result, $query] = $this->model->truncate(new DatabaseName($this->db), $this->table, $partitionName);
+        } catch (Throwable $e) {
+            $message = Message::error($e->getMessage());
+            $this->response->addHTML($message->getDisplay());
+
+            return;
+        }
 
         if ($result) {
             $message = Generator::getMessage(

diff --git a/libraries/classes/DatabaseInterface.php b/libraries/classes/DatabaseInterface.php
@@ -9,6 +9,7 @@
 
 use mysqli_result;
 use PhpMyAdmin\Database\DatabaseList;
+use PhpMyAdmin\Dbal\DatabaseName;
 use PhpMyAdmin\Dbal\DbalInterface;
 use PhpMyAdmin\Dbal\DbiExtension;
 use PhpMyAdmin\Dbal\DbiMysqli;
@@ -1984,10 +1985,10 @@ public function connect(int $mode, ?array $server = null, ?int $target = null)
     /**
      * selects given database
      *
-     * @param string $dbname database name to select
-     * @param int    $link   link type
+     * @param string|DatabaseName $dbname database name to select
+     * @param int                 $link   link type
      */
-    public function selectDb(string $dbname, $link = self::CONNECT_USER): bool
+    public function selectDb($dbname, $link = self::CONNECT_USER): bool
     {
         if (! isset($this->links[$link])) {
             return false;

diff --git a/libraries/classes/Dbal/DatabaseName.php b/libraries/classes/Dbal/DatabaseName.php
@@ -4,6 +4,7 @@
 
 namespace PhpMyAdmin\Dbal;
 
+use InvalidArgumentException;
 use Webmozart\Assert\Assert;
 
 /** @psalm-immutable */
@@ -21,6 +22,7 @@ final class DatabaseName
      */
     private $name;
 
+    /** @throws InvalidArgumentException */
     public function __construct(string $name)
     {
         Assert::stringNotEmpty($name);

diff --git a/libraries/classes/Dbal/DbalInterface.php b/libraries/classes/Dbal/DbalInterface.php
@@ -516,10 +516,10 @@ public function connect(int $mode, ?array $server = null, ?int $target = null);
     /**
      * selects given database
      *
-     * @param string $dbname database name to select
-     * @param int    $link   link type
+     * @param string|DatabaseName $dbname database name to select
+     * @param int                 $link   link type
      */
-    public function selectDb(string $dbname, $link = DatabaseInterface::CONNECT_USER): bool;
+    public function selectDb($dbname, $link = DatabaseInterface::CONNECT_USER): bool;
 
     /**
      * returns array of rows with associative and numeric keys from $result

diff --git a/libraries/classes/Dbal/DbiExtension.php b/libraries/classes/Dbal/DbiExtension.php
@@ -32,8 +32,8 @@ public function connect(
     /**
      * selects given database
      *
-     * @param string $dbname database name to select
-     * @param object $link   connection object
+     * @param string|DatabaseName $dbname database name to select
+     * @param object              $link   connection object
      *
      * @return bool
      */

diff --git a/libraries/classes/Dbal/DbiMysqli.php b/libraries/classes/Dbal/DbiMysqli.php
@@ -159,14 +159,14 @@ public function connect($user, $password, array $server)
     /**
      * selects given database
      *
-     * @param string $databaseName database name to select
-     * @param mysqli $mysqli       the mysqli object
+     * @param string|DatabaseName $databaseName database name to select
+     * @param mysqli              $mysqli       the mysqli object
      *
      * @return bool
      */
     public function selectDb($databaseName, $mysqli)
     {
-        return $mysqli->select_db($databaseName);
+        return $mysqli->select_db((string) $databaseName);
     }
 
     /**

diff --git a/libraries/classes/Sql.php b/libraries/classes/Sql.php
@@ -1803,7 +1803,7 @@ public function executeQueryAndGetQueryResponse(
         }
 
         $GLOBALS['reload'] = $this->hasCurrentDbChanged($db);
-        $this->dbi->selectDb($db);
+        $this->dbi->selectDb($db ?? '');
 
         [
             $result,
@@ -1851,7 +1851,7 @@ public function executeQueryAndGetQueryResponse(
             $htmlOutput = $this->getQueryResponseForResultsReturned(
                 $result ?? null,
                 $analyzedSqlResults,
-                $db,
+                $db ?? '',
                 $table,
                 $sqlData ?? null,
                 $displayResultsObject,

diff --git a/libraries/classes/Table/Partition.php b/libraries/classes/Table/Partition.php
@@ -28,7 +28,7 @@ public function analyze(DatabaseName $db, string $table, string $partition): arr
             Util::backquote($partition)
         );
 
-        $this->dbi->selectDb($db->getName());
+        $this->dbi->selectDb($db);
         $result = $this->dbi->fetchResult($query);
 
         $rows = [];
@@ -39,7 +39,7 @@ public function analyze(DatabaseName $db, string $table, string $partition): arr
         return [$rows, $query];
     }
 
-    public function check(string $db, string $table, string $partition): array
+    public function check(DatabaseName $db, string $table, string $partition): array
     {
         $query = sprintf(
             'ALTER TABLE %s CHECK PARTITION %s;',
@@ -58,7 +58,7 @@ public function check(string $db, string $table, string $partition): array
         return [$rows, $query];
     }
 
-    public function drop(string $db, string $table, string $partition): array
+    public function drop(DatabaseName $db, string $table, string $partition): array
     {
         $query = sprintf(
             'ALTER TABLE %s DROP PARTITION %s;',
@@ -72,7 +72,7 @@ public function drop(string $db, string $table, string $partition): array
         return [(bool) $result, $query];
     }
 
-    public function optimize(string $db, string $table, string $partition): array
+    public function optimize(DatabaseName $db, string $table, string $partition): array
     {
         $query = sprintf(
             'ALTER TABLE %s OPTIMIZE PARTITION %s;',
@@ -91,7 +91,7 @@ public function optimize(string $db, string $table, string $partition): array
         return [$rows, $query];
     }
 
-    public function rebuild(string $db, string $table, string $partition): array
+    public function rebuild(DatabaseName $db, string $table, string $partition): array
     {
         $query = sprintf(
             'ALTER TABLE %s REBUILD PARTITION %s;',
@@ -105,7 +105,7 @@ public function rebuild(string $db, string $table, string $partition): array
         return [(bool) $result, $query];
     }
 
-    public function repair(string $db, string $table, string $partition): array
+    public function repair(DatabaseName $db, string $table, string $partition): array
     {
         $query = sprintf(
             'ALTER TABLE %s REPAIR PARTITION %s;',
@@ -124,7 +124,7 @@ public function repair(string $db, string $table, string $partition): array
         return [$rows, $query];
     }
 
-    public function truncate(string $db, string $table, string $partition): array
+    public function truncate(DatabaseName $db, string $table, string $partition): array
     {
         $query = sprintf(
             'ALTER TABLE %s TRUNCATE PARTITION %s;',

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1810,11 +1810,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Sql.php
 
-		-
-			message: "#^Parameter \\#1 \\$dbname of method PhpMyAdmin\\\\DatabaseInterface\\:\\:selectDb\\(\\) expects string, string\\|null given\\.$#"
-			count: 1
-			path: libraries/classes/Sql.php
-
 		-
 			message: "#^Parameter \\#1 \\$messageToShow of method PhpMyAdmin\\\\Sql\\:\\:getMessageForNoRowsReturned\\(\\) expects string, string\\|null given\\.$#"
 			count: 1
@@ -1865,11 +1860,6 @@ parameters:
 			count: 1
 			path: libraries/classes/Sql.php
 
-		-
-			message: "#^Parameter \\#3 \\$db of method PhpMyAdmin\\\\Sql\\:\\:getQueryResponseForResultsReturned\\(\\) expects string, string\\|null given\\.$#"
-			count: 1
-			path: libraries/classes/Sql.php
-
 		-
 			message: "#^Parameter \\#3 \\$isModifyLink of static method PhpMyAdmin\\\\Html\\\\Generator\\:\\:mysqlDie\\(\\) expects bool, string given\\.$#"
 			count: 1

diff --git a/test/classes/Stubs/DbiDummy.php b/test/classes/Stubs/DbiDummy.php
@@ -11,6 +11,7 @@
 
 namespace PhpMyAdmin\Tests\Stubs;
 
+use PhpMyAdmin\Dbal\DatabaseName;
 use PhpMyAdmin\Dbal\DbiExtension;
 use PhpMyAdmin\FieldMetadata;
 
@@ -67,14 +68,14 @@ public function connect(
     /**
      * selects given database
      *
-     * @param string $dbname name of db to select
-     * @param object $link   mysql link resource
+     * @param string|DatabaseName $dbname name of db to select
+     * @param object              $link   mysql link resource
      *
      * @return bool
      */
     public function selectDb($dbname, $link)
     {
-        $GLOBALS['dummy_db'] = $dbname;
+        $GLOBALS['dummy_db'] = (string) $dbname;
 
         return true;
     }