[HttpFoundation] Add BinaryFileResponse::createFromTempFile()

alexandre-daubois · alexandre-daubois · commit 0151376fef4b · 2023-10-11T13:12:22.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php b/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php
@@ -31,6 +31,7 @@ class BinaryFileResponse extends Response
      * @var File
      */
     protected $file;
+    protected ?\SplTempFileObject $tempFileObject = null;
     protected $offset = 0;
     protected $maxlen = -1;
     protected $deleteFileAfterSend = false;
@@ -65,15 +66,18 @@ public function __construct(\SplFileInfo|string $file, int $status = 200, array
      */
     public function setFile(\SplFileInfo|string $file, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true): static
     {
+        $isTemporaryFile = $file instanceof \SplTempFileObject;
+        $this->tempFileObject = $isTemporaryFile ? $file : null;
+
         if (!$file instanceof File) {
             if ($file instanceof \SplFileInfo) {
-                $file = new File($file->getPathname());
+                $file = new File($file->getPathname(), !$isTemporaryFile);
             } else {
                 $file = new File((string) $file);
             }
         }
 
-        if (!$file->isReadable()) {
+        if (!$file->isReadable() && !$isTemporaryFile) {
             throw new FileException('File must be readable.');
         }
 
@@ -83,7 +87,7 @@ public function setFile(\SplFileInfo|string $file, string $contentDisposition =
             $this->setAutoEtag();
         }
 
-        if ($autoLastModified) {
+        if ($autoLastModified && !$isTemporaryFile) {
             $this->setAutoLastModified();
         }
 
@@ -301,19 +305,25 @@ public function sendContent(): static
             }
 
             $out = fopen('php://output', 'w');
-            $file = fopen($this->file->getPathname(), 'r');
+
+            if ($this->tempFileObject) {
+                $file = $this->tempFileObject;
+                $file->rewind();
+            } else {
+                $file = new \SplFileObject($this->file->getPathname(), 'r');
+            }
 
             ignore_user_abort(true);
 
             if (0 !== $this->offset) {
-                fseek($file, $this->offset);
+                $file->fseek($this->offset);
             }
 
             $length = $this->maxlen;
-            while ($length && !feof($file)) {
+            while ($length && !$file->eof()) {
                 $read = $length > $this->chunkSize || 0 > $length ? $this->chunkSize : $length;
 
-                if (false === $data = fread($file, $read)) {
+                if (false === $data = $file->fread($read)) {
                     break;
                 }
                 while ('' !== $data) {
@@ -329,9 +339,8 @@ public function sendContent(): static
             }
 
             fclose($out);
-            fclose($file);
         } finally {
-            if ($this->deleteFileAfterSend && is_file($this->file->getPathname())) {
+            if (null === $this->tempFileObject && $this->deleteFileAfterSend && is_file($this->file->getPathname())) {
                 unlink($this->file->getPathname());
             }
         }
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Make `HeaderBag::getDate()`, `Response::getDate()`, `getExpires()` and `getLastModified()` return a `DateTimeImmutable`
  * Support root-level `Generator` in `StreamedJsonResponse`
  * Add `UriSigner` from the HttpKernel component
+ * Add `BinaryFileResponse::createFromTempFile()`
 
 6.3
 ---
diff --git a/src/Symfony/Component/HttpFoundation/Tests/BinaryFileResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/BinaryFileResponseTest.php
@@ -434,4 +434,25 @@ public static function tearDownAfterClass(): void
             @unlink($path);
         }
     }
+
+    public function testCreateFromTemporaryFile()
+    {
+        $file = new \SplTempFileObject();
+        $file->fwrite('foo,bar');
+
+        $response = new BinaryFileResponse($file, 201, [
+            'Content-Type' => 'text/csv',
+        ]);
+
+        $response->setContentDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT);
+
+        $this->assertSame(201, $response->getStatusCode());
+        $this->assertSame('text/csv', $response->headers->get('Content-Type'));
+        $this->assertEquals('attachment; filename=temp', $response->headers->get('Content-Disposition'));
+
+        ob_start();
+        $response->sendContent();
+        $string = ob_get_clean();
+        $this->assertSame('foo,bar', $string);
+    }
 }
