bug #58266 [HttpKernel] pass CSV escape characters explicitly (xabbuh)

xabbuh · xabbuh · commit e104cd2a6294 · 2024-09-16T07:54:20.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [HttpKernel] pass CSV escape characters explicitly | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | | License | MIT Not passing the `$escape` parameter is deprecated since PHP 8.4 as the default value will change in the future. Commits ------- 8c32db3 pass CSV escape characters explicitly
diff --git a/src/Symfony/Component/HttpKernel/Profiler/FileProfilerStorage.php b/src/Symfony/Component/HttpKernel/Profiler/FileProfilerStorage.php
@@ -60,7 +60,7 @@ public function find(?string $ip, ?string $url, ?int $limit, ?string $method, ?i
 
         $result = [];
         while (\count($result) < $limit && $line = $this->readLineFromFile($file)) {
-            $values = str_getcsv($line);
+            $values = str_getcsv($line, ',', '"', '\\');
 
             if (7 !== \count($values)) {
                 // skip invalid lines
@@ -187,7 +187,7 @@ public function write(Profile $profile): bool
                 $profile->getTime(),
                 $profile->getParentToken(),
                 $profile->getStatusCode(),
-            ]);
+            ], ',', '"', '\\');
             fclose($file);
         }
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/Profiler/FileProfilerStorageTest.php b/src/Symfony/Component/HttpKernel/Tests/Profiler/FileProfilerStorageTest.php
@@ -336,12 +336,12 @@ public function testMultiRowIndexFile()
 
         $handle = fopen($this->tmpDir.'/index.csv', 'r');
         for ($i = 0; $i < $iteration; ++$i) {
-            $row = fgetcsv($handle);
+            $row = fgetcsv($handle, null, ',', '"', '\\');
             $this->assertEquals('token'.$i, $row[0]);
             $this->assertEquals('127.0.0.'.$i, $row[1]);
             $this->assertEquals('http://foo.bar/'.$i, $row[3]);
         }
-        $this->assertFalse(fgetcsv($handle));
+        $this->assertFalse(fgetcsv($handle, null, ',', '"', '\\'));
     }
 
     public function testReadLineFromFile()
diff --git a/src/Symfony/Component/Translation/Dumper/CsvFileDumper.php b/src/Symfony/Component/Translation/Dumper/CsvFileDumper.php
@@ -31,7 +31,7 @@ public function formatCatalogue(MessageCatalogue $messages, string $domain, arra
         $handle = fopen('php://memory', 'r+');
 
         foreach ($messages->all($domain) as $source => $target) {
-            fputcsv($handle, [$source, $target], $this->delimiter, $this->enclosure);
+            fputcsv($handle, [$source, $target], $this->delimiter, $this->enclosure, '\\');
         }
 
         rewind($handle);
diff --git a/src/Symfony/Component/Validator/Resources/bin/sync-iban-formats.php b/src/Symfony/Component/Validator/Resources/bin/sync-iban-formats.php
@@ -129,7 +129,7 @@ private function readPropertiesFromRegistry(array $properties): array
         array_shift($lines);
 
         foreach ($lines as $line) {
-            $columns = str_getcsv($line, "\t");
+            $columns = str_getcsv($line, "\t", '"', '\\');
             $propertyLabel = array_shift($columns);
 
             if (!isset($properties[$propertyLabel])) {

Original file line number	Diff line number	Diff line change
`@@ -336,12 +336,12 @@ public function testMultiRowIndexFile()`
`336`	`336`
`337`	`337`	`$handle = fopen($this->tmpDir.'/index.csv', 'r');`
`338`	`338`	`for ($i = 0; $i < $iteration; ++$i) {`
`339`		`- $row = fgetcsv($handle);`
	`339`	`+ $row = fgetcsv($handle, null, ',', '"', '\\');`
`340`	`340`	`$this->assertEquals('token'.$i, $row[0]);`
`341`	`341`	`$this->assertEquals('127.0.0.'.$i, $row[1]);`
`342`	`342`	`$this->assertEquals('http://foo.bar/'.$i, $row[3]);`
`343`	`343`	`}`
`344`		`- $this->assertFalse(fgetcsv($handle));`
	`344`	`+ $this->assertFalse(fgetcsv($handle, null, ',', '"', '\\'));`
`345`	`345`	`}`
`346`	`346`
`347`	`347`	`public function testReadLineFromFile()`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function formatCatalogue(MessageCatalogue $messages, string $domain, arra`
`31`	`31`	`$handle = fopen('php://memory', 'r+');`
`32`	`32`
`33`	`33`	`foreach ($messages->all($domain) as $source => $target) {`
`34`		`- fputcsv($handle, [$source, $target], $this->delimiter, $this->enclosure);`
	`34`	`+ fputcsv($handle, [$source, $target], $this->delimiter, $this->enclosure, '\\');`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`rewind($handle);`