Merge pull request phpmyadmin#19552 from kamil-tekiela/Fix-default-va…

…lues Fix default values
liviuconcioiu · Jan 30, 2025 · a7af119 · a7af119
2 parents b0d985c + d5e9a91
commit a7af119
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 52 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -8935,7 +8935,7 @@ parameters:
 			path: src/InsertEdit.php
 
 		-
-			message: '#^Parameter \#1 \$defaultValue of method PhpMyAdmin\\InsertEdit\:\:getSpecialCharsForInsertingMode\(\) expects string\|null, mixed given\.$#'
+			message: '#^Parameter \#1 \$defaultValue of method PhpMyAdmin\\InsertEdit\:\:getDefaultValue\(\) expects string\|null, mixed given\.$#'
 			identifier: argument.type
 			count: 1
 			path: src/InsertEdit.php

diff --git a/src/Dbal/DatabaseInterface.php b/src/Dbal/DatabaseInterface.php
@@ -892,7 +892,10 @@ private function convertToColumns(array $fields): array
                 $column['Collation'],
                 $column['Null'] === 'YES',
                 $column['Key'],
-                $column['Default'],
+                // null means lack of default value, 'NULL' means default value is NULL
+                $column['Default'] === null || $column['Default'] === 'NULL'
+                    ? null
+                    : Util::unquoteDefaultValue($column['Default']),
                 $column['Extra'],
                 $column['Privileges'],
                 $column['Comment'],

diff --git a/src/InsertEdit.php b/src/InsertEdit.php
@@ -34,12 +34,9 @@
 use function preg_match;
 use function preg_replace;
 use function str_contains;
-use function str_ends_with;
 use function str_replace;
 use function str_starts_with;
-use function stripcslashes;
 use function stripslashes;
-use function substr;
 use function trim;
 
 use const ENT_COMPAT;
@@ -766,7 +763,7 @@ private function getSpecialCharsAndBackupFieldForExistingRow(
     /**
      * display default values
      */
-    private function getSpecialCharsForInsertingMode(
+    private function getDefaultValue(
         string|null $defaultValue,
         string $trueType,
     ): string {
@@ -775,19 +772,18 @@ private function getSpecialCharsForInsertingMode(
         }
 
         if ($trueType === 'bit') {
-            $specialChars = Util::convertBitDefaultValue($defaultValue);
-        } elseif ($trueType === 'timestamp' || $trueType === 'datetime' || $trueType === 'time') {
-            $specialChars = Util::addMicroseconds($defaultValue);
-        } elseif ($trueType === 'binary' || $trueType === 'varbinary') {
-            $specialChars = bin2hex($defaultValue);
-        } elseif (str_ends_with($trueType, 'text')) {
-            $textDefault = substr($defaultValue, 1, -1);
-            $specialChars = htmlspecialchars(stripcslashes($textDefault !== '' ? $textDefault : $defaultValue));
-        } else {
-            $specialChars = htmlspecialchars($defaultValue);
+            return Util::convertBitDefaultValue($defaultValue);
+        }
+
+        if ($trueType === 'timestamp' || $trueType === 'datetime' || $trueType === 'time') {
+            return Util::addMicroseconds($defaultValue);
+        }
+
+        if ($trueType === 'binary' || $trueType === 'varbinary') {
+            return bin2hex($defaultValue);
         }
 
-        return $specialChars;
+        return $defaultValue;
     }
 
     /**
@@ -1572,7 +1568,7 @@ private function getHtmlForInsertEditFormColumn(
 
             $realNullValue = $defaultValue === null;
             $data = (string) $defaultValue;
-            $specialChars = $this->getSpecialCharsForInsertingMode($defaultValue, $column->trueType);
+            $specialChars = htmlspecialchars($this->getDefaultValue($defaultValue, $column->trueType));
             $specialCharsEncoded = Util::duplicateFirstNewline($specialChars);
             $backupField = '';
         }

diff --git a/src/Table/ColumnsDefinition.php b/src/Table/ColumnsDefinition.php
@@ -28,9 +28,6 @@
 use function preg_quote;
 use function preg_replace;
 use function rtrim;
-use function str_ends_with;
-use function stripcslashes;
-use function substr;
 use function trim;
 
 /**
@@ -186,7 +183,6 @@ public function displayForm(
                 }
 
                 $columnMetaDefault = self::decorateColumnMetaDefault(
-                    $columnMeta['Type'],
                     $columnMeta['Default'],
                     $columnMeta['Null'] === 'YES',
                 );
@@ -365,9 +361,9 @@ public function displayForm(
     /**
      * Set default type and default value according to the column metadata
      *
-     * @return array{DefaultType:string, DefaultValue: string, Default?: string}
+     * @return array{DefaultType:string, DefaultValue: string}
      */
-    public static function decorateColumnMetaDefault(string $type, string|null $default, bool $isNull): array
+    public static function decorateColumnMetaDefault(string|null $default, bool $isNull): array
     {
         $metaDefault = ['DefaultType' => 'USER_DEFINED', 'DefaultValue' => ''];
 
@@ -389,11 +385,6 @@ public static function decorateColumnMetaDefault(string $type, string|null $defa
             default:
                 $metaDefault['DefaultValue'] = $default;
 
-                if (str_ends_with($type, 'text')) {
-                    $textDefault = substr($default, 1, -1);
-                    $metaDefault['Default'] = stripcslashes($textDefault);
-                }
-
                 break;
         }
 

diff --git a/src/Util.php b/src/Util.php
@@ -78,6 +78,7 @@
 use function strrev;
 use function strtolower;
 use function strtr;
+use function substr;
 use function trim;
 use function uksort;
 
@@ -2013,4 +2014,13 @@ public static function getUploadSizeInBytes(): int
 
         return $size;
     }
+
+    public static function unquoteDefaultValue(string $value): string
+    {
+        if (! str_starts_with($value, "'")) {
+            return $value;
+        }
+
+        return strtr(substr($value, 1, -1), ["''" => "'", "\\'" => "'", '\\\\' => '\\']);
+    }
 }
diff --git a/tests/unit/InsertEditTest.php b/tests/unit/InsertEditTest.php
@@ -1182,10 +1182,10 @@ public function testGetSpecialCharsAndBackupFieldForExistingRow(): void
     }
 
     /**
-     * Test for getSpecialCharsForInsertingMode
+     * Test for getDefaultValue
      */
     #[DataProvider('providerForTestGetSpecialCharsForInsertingMode')]
-    public function testGetSpecialCharsForInsertingMode(
+    public function testGetDefaultValue(
         string|null $defaultValue,
         string $trueType,
         string $expected,
@@ -1198,15 +1198,15 @@ public function testGetSpecialCharsForInsertingMode(
         $result = $this->callFunction(
             $this->insertEdit,
             InsertEdit::class,
-            'getSpecialCharsForInsertingMode',
+            'getDefaultValue',
             [$defaultValue, $trueType],
         );
 
         self::assertSame($expected, $result);
     }
 
     /**
-     * Data provider for test getSpecialCharsForInsertingMode()
+     * Data provider for test getDefaultValue()
      *
      * @return array<string, array{string|null, string, string}>
      */
@@ -1246,17 +1246,17 @@ public static function providerForTestGetSpecialCharsForInsertingMode(): array
             'any text with escape text default' => [
                 '"lorem\"ipsem"',
                 'text',
-                'lorem&quot;ipsem',
+                '"lorem\"ipsem"',
             ],
             'varchar with html special chars' => [
                 'hello world<br><b>lorem</b> ipsem',
                 'varchar',
-                'hello world&lt;br&gt;&lt;b&gt;lorem&lt;/b&gt; ipsem',
+                'hello world<br><b>lorem</b> ipsem',
             ],
             'text with html special chars' => [
                 '\'</textarea><script>alert(1)</script>\'',
                 'text',
-                '&lt;/textarea&gt;&lt;script&gt;alert(1)&lt;/script&gt;',
+                '\'</textarea><script>alert(1)</script>\'',
             ],
         ];
     }

diff --git a/tests/unit/Stubs/DbiDummy.php b/tests/unit/Stubs/DbiDummy.php
@@ -1681,9 +1681,9 @@ private function init(): void
                     . ' WHERE `TABLE_SCHEMA` COLLATE utf8_bin = \'test_db\' AND `TABLE_NAME` COLLATE utf8_bin = \'test_table\'',
                 'columns' => ['Field', 'Type', 'Collation', 'Null', 'Key', 'Default', 'Extra', 'Privileges', 'Comment'],
                 'result' => [
-                    ['id', 'int(11)', null, 'NO', 'PRI', 'NULL', 'auto_increment', '', ''],
-                    ['name', 'varchar(20)', null, 'NO', '', 'NULL', '', '', ''],
-                    ['datetimefield', 'datetime', null, 'NO', '', 'NULL', '', '', ''],
+                    ['id', 'int(11)', null, 'NO', 'PRI', "'NULL'", 'auto_increment', '', ''],
+                    ['name', 'varchar(20)', null, 'NO', '', "'NULL'", '', '', ''],
+                    ['datetimefield', 'datetime', null, 'NO', '', "'NULL'", '', '', ''],
                 ],
             ],
             [

diff --git a/tests/unit/Table/ColumnsDefinitionTest.php b/tests/unit/Table/ColumnsDefinitionTest.php
@@ -224,68 +224,59 @@ public function testDisplayForm(): void
      */
     #[DataProvider('providerColumnMetaDefault')]
     public function testDecorateColumnMetaDefault(
-        string $type,
         string|null $default,
         bool $isNull,
         array $expected,
     ): void {
-        $result = ColumnsDefinition::decorateColumnMetaDefault($type, $default, $isNull);
+        $result = ColumnsDefinition::decorateColumnMetaDefault($default, $isNull);
 
         self::assertEquals($expected, $result);
     }
 
     /**
      * Data provider for testDecorateColumnMetaDefault
      *
-     * @psalm-return array<string, array{string, string|null, bool, array<string, string>}>
+     * @psalm-return array<string, array{string|null, bool, array<string, string>}>
      */
     public static function providerColumnMetaDefault(): array
     {
         return [
             'when Default is null and Null is YES' => [
-                '',
                 null,
                 true,
                 ['DefaultType' => 'NULL', 'DefaultValue' => ''],
             ],
             'when Default is null and Null is NO' => [
-                '',
                 null,
                 false,
                 ['DefaultType' => 'NONE', 'DefaultValue' => ''],
             ],
             'when Default is CURRENT_TIMESTAMP' => [
-                '',
                 'CURRENT_TIMESTAMP',
                 false,
                 ['DefaultType' => 'CURRENT_TIMESTAMP', 'DefaultValue' => ''],
             ],
             'when Default is current_timestamp' => [
-                '',
                 'current_timestamp()',
                 false,
                 ['DefaultType' => 'CURRENT_TIMESTAMP', 'DefaultValue' => ''],
             ],
             'when Default is UUID' => [
-                '',
                 'UUID',
                 false,
                 ['DefaultType' => 'UUID', 'DefaultValue' => ''],
             ],
             'when Default is uuid()' => [
-                '',
                 'uuid()',
                 false,
                 ['DefaultType' => 'UUID', 'DefaultValue' => ''],
             ],
             'when Default is anything else and Type is text' => [
-                'text',
-                '"some\/thing"',
+                '"some/thing"',
                 false,
-                ['Default' => 'some/thing', 'DefaultType' => 'USER_DEFINED', 'DefaultValue' => '"some\/thing"'],
+                ['DefaultType' => 'USER_DEFINED', 'DefaultValue' => '"some/thing"'],
             ],
             'when Default is anything else and Type is not text' => [
-                'something',
                 '"some\/thing"',
                 false,
                 ['DefaultType' => 'USER_DEFINED', 'DefaultValue' => '"some\/thing"'],

diff --git a/tests/unit/UtilTest.php b/tests/unit/UtilTest.php
@@ -1551,4 +1551,17 @@ public static function providerForTestGetValueByKey(): iterable
             'def',
         ];
     }
+
+    public function testUnquoteDefaultValue(): void
+    {
+        self::assertSame('foo', Util::unquoteDefaultValue('foo'));
+        self::assertSame('"foo"', Util::unquoteDefaultValue('"foo"'));
+        self::assertSame('`foo`', Util::unquoteDefaultValue('`foo`'));
+        self::assertSame('foo', Util::unquoteDefaultValue('\'foo\''));
+        self::assertSame('', Util::unquoteDefaultValue('\'\''));
+        self::assertSame('\'', Util::unquoteDefaultValue('\'\'\'\''));
+        self::assertSame('q\'q', Util::unquoteDefaultValue('\'q\'q\''));
+        self::assertSame('s\\s', Util::unquoteDefaultValue('\'s\\\\s\''));
+        self::assertSame('sq\'sq', Util::unquoteDefaultValue('\'sq\\\'sq\''));
+    }
 }