Support quoted strings in config string parser

Author: trowski

src/SqlConfig.php

@@ -12,6 +12,10 @@ abstract class SqlConfig
         'dbname' => 'db',
     ];
 
+    private const KEY_VALUE_PAIR_REGEXP = <<<'REGEXP'
+        [\G\s*(\w+)=((['"])(?:\\(?:\\|\3)|(?!\3).)*+\3|[^ '";]\S*?)(?:\s+|;|$)]
+        REGEXP;
+
     private string $host;
 
     private int $port;
@@ -33,26 +37,48 @@ abstract class SqlConfig
     protected static function parseConnectionString(string $connectionString, array $keymap = self::KEY_MAP): array
     {
         $values = [];
+        $connectionString = \trim($connectionString);
 
-        $params = \explode(";", $connectionString);
+        if ($connectionString === '') {
+            throw new \ValueError("Empty connection string");
+        }
 
-        if (\count($params) === 1) { // Attempt to explode on a space if no ';' are found.
-            $params = \explode(" ", $connectionString);
+        if (!\preg_match_all(
+            self::KEY_VALUE_PAIR_REGEXP,
+            $connectionString,
+            $matches,
+            flags: \PREG_SET_ORDER | \PREG_UNMATCHED_AS_NULL,
+        )) {
+            throw new \ValueError("Invalid connection string");
         }
 
-        foreach ($params as $param) {
-            /** @psalm-suppress PossiblyInvalidArgument */
-            [$key, $value] = \array_map(\trim(...), \explode("=", $param, 2) + [1 => ""]);
-            if ($key === '') {
-                throw new \ValueError("Empty key name in connection string");
+        $offset = 0;
+        foreach ($matches as [$pair, $key, $value, $quote]) {
+            if ($quote) {
+                $value = \stripslashes(\substr($value, 1, -1));
+
+                if ($value === '') {
+                    throw new \ValueError("Empty connection string value for key '{$key}'");
+                }
+            }
+
+            $key = $keymap[$key] ?? $key;
+            if (\array_key_exists($key, $values)) {
+                throw new \ValueError("Duplicate connection string key '{$key}'");
             }
 
-            $values[$keymap[$key] ?? $key] = $value;
+            $values[$key] = $value;
+
+            $offset += \strlen($pair);
+        }
+
+        if ($offset !== \strlen($connectionString)) {
+            throw new \ValueError("Trailing characters in connection string");
         }
 
-        if (\preg_match('/^(?<host>.+):(?<port>\d{1,5})$/', $values["host"] ?? "", $matches)) {
-            $values["host"] = $matches["host"];
-            $values["port"] = $matches["port"];
+        if (\preg_match('[^(?<host>.+):(?<port>\d{1,5})$]', $values["host"] ?? "", $match)) {
+            $values["host"] = $match["host"];
+            $values["port"] = $match["port"];
         }
 
         return $values;

test/SqlConfigTest.php

@@ -25,20 +25,25 @@ public function __construct(string $connectionString)
         };
     }
 
-    public function testPortInHost(): void
+    public function provideValidConnectionStrings(): array
     {
-        $config = $this->createConfigFromString("host=localhost:5432 user=user database=test");
-
-        self::assertSame("localhost", $config->getHost());
-        self::assertSame(5432, $config->getPort());
-        self::assertSame("user", $config->getUser());
-        self::assertSame("", $config->getPassword());
-        self::assertSame("test", $config->getDatabase());
+        return [
+            'basic' => ["host=localhost port=5432 user=user pass=test db=test"],
+            'alternative' => ["host=localhost;port=5432;user=user;password=test;db=test"],
+            'port-in-host' => ["host=localhost:5432 user=user pass=test db=test"],
+            'whitespace' => ["   host=localhost   port=5432   user=user   pass=test   db=test   "],
+            'whitespace-after-semicolon' => ["host=localhost; port=5432; user=user; password=test; db=test; "],
+            'quotes' => ['host="localhost" port=5432 user="user" pass="test" db="test"'],
+            'alternative-with-whitespace' => ["host=localhost; port=5432; user=user; password=test; db=test;"],
+        ];
     }
 
-    public function testBasicSyntax(): void
+    /**
+     * @dataProvider provideValidConnectionStrings
+     */
+    public function testValidStrings(string $connectionString): void
     {
-        $config = $this->createConfigFromString("host=localhost port=5432 user=user pass=test db=test");
+        $config = $this->createConfigFromString($connectionString);
 
         self::assertSame("localhost", $config->getHost());
         self::assertSame(5432, $config->getPort());
@@ -47,21 +52,37 @@ public function testBasicSyntax(): void
         self::assertSame("test", $config->getDatabase());
     }
 
-    public function testAlternativeSyntax(): void
+    public function testQuoteInQuotedValue(): void
     {
-        $config = $this->createConfigFromString("host=localhost;port=3306;user=user;password=test;db=test");
+        $config = $this->createConfigFromString(
+            <<<'CS'
+            host="local\"host:3306" database='test'
+            CS
+        );
 
-        self::assertSame("localhost", $config->getHost());
+        self::assertSame('local"host', $config->getHost());
         self::assertSame(3306, $config->getPort());
-        self::assertSame("user", $config->getUser());
-        self::assertSame("test", $config->getPassword());
-        self::assertSame("test", $config->getDatabase());
+        self::assertSame('test', $config->getDatabase());
+    }
+
+    public function provideInvalidConnectionStrings(): array
+    {
+        return [
+            'missing-value' => ['host='],
+            'empty-value' => ['host=""'],
+            'leading-characters' => ['test host=localhost'],
+            'trailing-characters' => ['host=localhost test'],
+            'invalid-whitespace' => ['host= localhost'],
+            'duplicate-key' => ['host=localhost port=5432 port=5433']
+        ];
     }
 
-    public function testInvalidString(): void
+    /**
+     * @dataProvider provideInvalidConnectionStrings
+     */
+    public function testInvalidStrings(string $connectionString): void
     {
         $this->expectException(\ValueError::class);
-        $this->expectExceptionMessage("Empty key name in connection string");
-        $this->createConfigFromString("invalid =connection string");
+        $this->createConfigFromString($connectionString);
     }
 }