bug #58274 [Dotenv] throw a meaningful exception when parsing dotenv files with BOM (xabbuh)

nicolas-grekas · nicolas-grekas · commit dcb07df384df · 2024-09-16T16:06:29.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Dotenv] throw a meaningful exception when parsing dotenv files with BOM | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #58214 | License | MIT This replaces #58216. Other than in that PR I did not account for UTF-16 and UTF-32 byte-order-mark variants as that would IMO require us to first reliably detect the file encoding. Commits ------- b4f3eaa throw a meaningful exception when parsing dotenv files with BOM
diff --git a/src/Symfony/Component/Dotenv/Dotenv.php b/src/Symfony/Component/Dotenv/Dotenv.php
@@ -568,7 +568,13 @@ private function doLoad(bool $overrideExistingVars, array $paths): void
                 throw new PathException($path);
             }
 
-            $this->populate($this->parse(file_get_contents($path), $path), $overrideExistingVars);
+            $data = file_get_contents($path);
+
+            if ("\xEF\xBB\xBF" === substr($data, 0, 3)) {
+                throw new FormatException('Loading files starting with a byte-order-mark (BOM) is not supported.', new FormatExceptionContext($data, $path, 1, 0));
+            }
+
+            $this->populate($this->parse($data, $path), $overrideExistingVars);
         }
     }
 }
diff --git a/src/Symfony/Component/Dotenv/Tests/DotenvTest.php b/src/Symfony/Component/Dotenv/Tests/DotenvTest.php
@@ -604,4 +604,14 @@ public function testBootEnv()
         $resetContext();
         rmdir($tmpdir);
     }
+
+    public function testExceptionWithBom()
+    {
+        $dotenv = new Dotenv();
+
+        $this->expectException(FormatException::class);
+        $this->expectExceptionMessage('Loading files starting with a byte-order-mark (BOM) is not supported.');
+
+        $dotenv->load(__DIR__.'/fixtures/file_with_bom');
+    }
 }
diff --git a/src/Symfony/Component/Dotenv/Tests/fixtures/file_with_bom b/src/Symfony/Component/Dotenv/Tests/fixtures/file_with_bom
@@ -0,0 +1 @@
+﻿FOO=BAR

Original file line number	Diff line number	Diff line change
`@@ -568,7 +568,13 @@ private function doLoad(bool $overrideExistingVars, array $paths): void`
`568`	`568`	`throw new PathException($path);`
`569`	`569`	`}`
`570`	`570`
`571`		`- $this->populate($this->parse(file_get_contents($path), $path), $overrideExistingVars);`
	`571`	`+ $data = file_get_contents($path);`
	`572`	`+`
	`573`	`+ if ("\xEF\xBB\xBF" === substr($data, 0, 3)) {`
	`574`	`+ throw new FormatException('Loading files starting with a byte-order-mark (BOM) is not supported.', new FormatExceptionContext($data, $path, 1, 0));`
	`575`	`+ }`
	`576`	`+`
	`577`	`+ $this->populate($this->parse($data, $path), $overrideExistingVars);`
`572`	`578`	`}`
`573`	`579`	`}`
`574`	`580`	`}`