Merge pull request #6600 from morozov/sqlite-quoted-table-comment

Fix parsing quoted table name on SQLite
doctrine · Nov 15, 2024 · 34ea36f · 34ea36f
2 parents 232fd06 + 395269a
commit 34ea36f
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 8 deletions.
diff --git a/src/Schema/SqliteSchemaManager.php b/src/Schema/SqliteSchemaManager.php
@@ -508,9 +508,8 @@ protected function _getPortableTableForeignKeyDefinition($tableForeignKey): Fore
 
     private function parseColumnCollationFromSQL(string $column, string $sql): ?string
     {
-        $pattern = '{(?:\W' . preg_quote($column) . '\W|\W'
-            . preg_quote($this->_platform->quoteSingleIdentifier($column))
-            . '\W)[^,(]+(?:\([^()]+\)[^,]*)?(?:(?:DEFAULT|CHECK)\s*(?:\(.*?\))?[^,]*)*COLLATE\s+["\']?([^\s,"\')]+)}is';
+        $pattern = '{' . $this->buildIdentifierPattern($column)
+            . '[^,(]+(?:\([^()]+\)[^,]*)?(?:(?:DEFAULT|CHECK)\s*(?:\(.*?\))?[^,]*)*COLLATE\s+["\']?([^\s,"\')]+)}is';
 
         if (preg_match($pattern, $sql, $match) !== 1) {
             return null;
@@ -522,9 +521,7 @@ private function parseColumnCollationFromSQL(string $column, string $sql): ?stri
     private function parseTableCommentFromSQL(string $table, string $sql): ?string
     {
         $pattern = '/\s* # Allow whitespace characters at start of line
-CREATE\sTABLE # Match "CREATE TABLE"
-(?:\W"' . preg_quote($this->_platform->quoteSingleIdentifier($table), '/') . '"\W|\W' . preg_quote($table, '/')
-            . '\W) # Match table name (quoted and unquoted)
+CREATE\sTABLE' . $this->buildIdentifierPattern($table) . '
 ( # Start capture
    (?:\s*--[^\n]*\n?)+ # Capture anything that starts with whitespaces followed by -- until the end of the line(s)
 )/ix';
@@ -540,8 +537,8 @@ private function parseTableCommentFromSQL(string $table, string $sql): ?string
 
     private function parseColumnCommentFromSQL(string $column, string $sql): ?string
     {
-        $pattern = '{[\s(,](?:\W' . preg_quote($this->_platform->quoteSingleIdentifier($column))
-            . '\W|\W' . preg_quote($column) . '\W)(?:\([^)]*?\)|[^,(])*?,?((?:(?!\n))(?:\s*--[^\n]*\n?)+)}i';
+        $pattern = '{[\s(,]' . $this->buildIdentifierPattern($column)
+            . '(?:\([^)]*?\)|[^,(])*?,?((?:(?!\n))(?:\s*--[^\n]*\n?)+)}i';
 
         if (preg_match($pattern, $sql, $match) !== 1) {
             return null;
@@ -552,6 +549,22 @@ private function parseColumnCommentFromSQL(string $column, string $sql): ?string
         return $comment === '' ? null : $comment;
     }
 
+    /**
+     * Returns a regular expression pattern that matches the given unquoted or quoted identifier.
+     */
+    private function buildIdentifierPattern(string $identifier): string
+    {
+        return '(?:' . implode('|', array_map(
+            static function (string $sql): string {
+                return '\W' . preg_quote($sql, '/') . '\W';
+            },
+            [
+                $identifier,
+                $this->_platform->quoteSingleIdentifier($identifier),
+            ],
+        )) . ')';
+    }
+
     /** @throws Exception */
     private function getCreateTableSQL(string $table): string
     {

diff --git a/tests/Functional/Schema/SqliteSchemaManagerTest.php b/tests/Functional/Schema/SqliteSchemaManagerTest.php
@@ -397,4 +397,25 @@ public function testShorthandInForeignKeyReferenceWithMultipleColumns(): void
             $createTableTrackSql,
         );
     }
+
+    /**
+     * This test duplicates {@see parent::testCommentInTable()} with the only difference that the name of the table
+     * being created is quoted. It is only meant to cover the logic of parsing the SQLite CREATE TABLE statement
+     * when the table name is quoted.
+     *
+     * Running the same test for all platforms, on the one hand, won't produce additional coverage, and on the other,
+     * is not feasible due to the differences in case sensitivity depending on whether the name is quoted.
+     *
+     * Once all identifiers are quoted by default, this test can be removed.
+     */
+    public function testCommentInQuotedTable(): void
+    {
+        $table = new Table('"table_with_comment"');
+        $table->addColumn('id', Types::INTEGER);
+        $table->setComment('This is a comment');
+        $this->dropAndCreateTable($table);
+
+        $table = $this->schemaManager->introspectTable('table_with_comment');
+        self::assertSame('This is a comment', $table->getComment());
+    }
 }