Merge pull request #2286 from cakephp/fix-database-escaped-characters

Fix quoting DB name when creating/dropping
cakephp · Jun 4, 2024 · b1e128c · b1e128c
2 parents a31003d + 606797e
commit b1e128c
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 9 deletions.
diff --git a/src/Phinx/Db/Adapter/MysqlAdapter.php b/src/Phinx/Db/Adapter/MysqlAdapter.php
@@ -1301,13 +1301,13 @@ public function createDatabase(string $name, array $options = []): void
 
         if (isset($options['collation'])) {
             $this->execute(sprintf(
-                'CREATE DATABASE `%s` DEFAULT CHARACTER SET `%s` COLLATE `%s`',
-                $name,
+                'CREATE DATABASE %s DEFAULT CHARACTER SET `%s` COLLATE `%s`',
+                $this->quoteColumnName($name),
                 $charset,
                 $options['collation']
             ));
         } else {
-            $this->execute(sprintf('CREATE DATABASE `%s` DEFAULT CHARACTER SET `%s`', $name, $charset));
+            $this->execute(sprintf('CREATE DATABASE %s DEFAULT CHARACTER SET `%s`', $this->quoteColumnName($name), $charset));
         }
     }
 
@@ -1337,7 +1337,7 @@ public function hasDatabase(string $name): bool
      */
     public function dropDatabase(string $name): void
     {
-        $this->execute(sprintf('DROP DATABASE IF EXISTS `%s`', $name));
+        $this->execute(sprintf('DROP DATABASE IF EXISTS %s', $this->quoteColumnName($name)));
         $this->createdTables = [];
     }
 

diff --git a/src/Phinx/Db/Adapter/PostgresAdapter.php b/src/Phinx/Db/Adapter/PostgresAdapter.php
@@ -1178,7 +1178,7 @@ public function getPhinxType(string $sqlType): string
     public function createDatabase(string $name, array $options = []): void
     {
         $charset = $options['charset'] ?? 'utf8';
-        $this->execute(sprintf("CREATE DATABASE %s WITH ENCODING = '%s'", $name, $charset));
+        $this->execute(sprintf("CREATE DATABASE %s WITH ENCODING = '%s'", $this->quoteColumnName($name), $charset));
     }
 
     /**
@@ -1198,7 +1198,7 @@ public function hasDatabase(string $name): bool
     public function dropDatabase($name): void
     {
         $this->disconnect();
-        $this->execute(sprintf('DROP DATABASE IF EXISTS %s', $name));
+        $this->execute(sprintf('DROP DATABASE IF EXISTS %s', $this->quoteColumnName($name)));
         $this->createdTables = [];
         $this->connect();
     }

diff --git a/src/Phinx/Db/Adapter/SqlServerAdapter.php b/src/Phinx/Db/Adapter/SqlServerAdapter.php
@@ -1174,12 +1174,13 @@ public function getPhinxType(string $sqlType): string
      */
     public function createDatabase(string $name, array $options = []): void
     {
+        $databaseName = $this->quoteColumnName($name);
         if (isset($options['collation'])) {
-            $this->execute(sprintf('CREATE DATABASE [%s] COLLATE [%s]', $name, $options['collation']));
+            $this->execute(sprintf('CREATE DATABASE %s COLLATE [%s]', $databaseName, $options['collation']));
         } else {
-            $this->execute(sprintf('CREATE DATABASE [%s]', $name));
+            $this->execute(sprintf('CREATE DATABASE %s', $databaseName));
         }
-        $this->execute(sprintf('USE [%s]', $name));
+        $this->execute(sprintf('USE %s', $databaseName));
     }
 
     /**

diff --git a/tests/Phinx/Db/Adapter/MysqlAdapterTest.php b/tests/Phinx/Db/Adapter/MysqlAdapterTest.php
@@ -2035,6 +2035,24 @@ public function testDropDatabase()
         $this->adapter->dropDatabase('phinx_temp_database');
     }
 
+    public function testDatabaseNameWithEscapedCharacter()
+    {
+        $databaseName = MYSQL_DB_CONFIG['name'] . '-`test`';
+        $this->adapter->dropDatabase($databaseName);
+        $this->adapter->createDatabase($databaseName);
+        $this->assertTrue($this->adapter->hasDatabase($databaseName));
+        $this->adapter->dropDatabase($databaseName);
+    }
+
+    public function testDatabaseNameWithEscapedCharacterWithCollation()
+    {
+        $databaseName = MYSQL_DB_CONFIG['name'] . '-`test`';
+        $this->adapter->dropDatabase($databaseName);
+        $this->adapter->createDatabase($databaseName, ['charset' => 'utf8mb4', 'collation' => 'utf8mb4_unicode_ci']);
+        $this->assertTrue($this->adapter->hasDatabase($databaseName));
+        $this->adapter->dropDatabase($databaseName);
+    }
+
     public function testAddColumnWithComment()
     {
         $table = new Table('table1', [], $this->adapter);

diff --git a/tests/Phinx/Db/Adapter/PostgresAdapterTest.php b/tests/Phinx/Db/Adapter/PostgresAdapterTest.php
@@ -1895,6 +1895,15 @@ public function testDropDatabase()
         $this->adapter->dropDatabase('phinx_temp_database');
     }
 
+    public function testDatabaseNameWithEscapedCharacter()
+    {
+        $databaseName = PGSQL_DB_CONFIG['name'] . '-test';
+        $this->adapter->dropDatabase($databaseName);
+        $this->adapter->createDatabase($databaseName);
+        $this->assertTrue($this->adapter->hasDatabase($databaseName));
+        $this->adapter->dropDatabase($databaseName);
+    }
+
     public function testCreateSchema()
     {
         $this->adapter->createSchema('foo');

diff --git a/tests/Phinx/Db/Adapter/SqlServerAdapterTest.php b/tests/Phinx/Db/Adapter/SqlServerAdapterTest.php
@@ -1127,6 +1127,24 @@ public function testHasNamedForeignKey()
         $this->assertFalse($this->adapter->hasForeignKey($table->getName(), [], 'my_constraint2'));
     }
 
+    public function testDatabaseNameWithEscapedCharacter()
+    {
+        $databaseName = SQLSRV_DB_CONFIG['name'] . '-[test]';
+        $this->adapter->dropDatabase($databaseName);
+        $this->adapter->createDatabase($databaseName);
+        $this->assertTrue($this->adapter->hasDatabase($databaseName));
+        $this->adapter->dropDatabase($databaseName);
+    }
+
+    public function testDatabaseNameWithEscapedCharacterWithCollation()
+    {
+        $databaseName = SQLSRV_DB_CONFIG['name'] . '-[test]';
+        $this->adapter->dropDatabase($databaseName);
+        $this->adapter->createDatabase($databaseName, ['collation' => 'SQL_Latin1_General_CP1_CS_AS']);
+        $this->assertTrue($this->adapter->hasDatabase($databaseName));
+        $this->adapter->dropDatabase($databaseName);
+    }
+
     public function testHasDatabase()
     {
         $this->assertFalse($this->adapter->hasDatabase('fake_database_name'));