bug #47516 [HttpFoundation] Prevent BinaryFileResponse::prepare from adding content type if no content is sent (naitsirch)

fabpot · fabpot · commit 2f7c7bb6ac71 · 2022-09-13T08:14:50.000+02:00
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- [HttpFoundation] Prevent BinaryFileResponse::prepare from adding content type if no content is sent | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #47473 | License | MIT | Doc PR | - Until now, `BinaryFileResponse::prepare()` adds `Content-Type` and other content related header even if no content is sent. This happens for example if the provided file's modification date is not older than the cached version of the client and http status 304 is sent. See issue #47473 Commits ------- e6275ea [HttpFoundation] Prevent BinaryFileResponse::prepare from adding content type if no content is sent
diff --git a/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php b/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php
@@ -201,22 +201,25 @@ public function setContentDisposition($disposition, $filename = '', $filenameFal
      */
     public function prepare(Request $request)
     {
-        if (!$this->headers->has('Content-Type')) {
-            $this->headers->set('Content-Type', $this->file->getMimeType() ?: 'application/octet-stream');
-        }
+        parent::prepare($request);
 
-        if ('HTTP/1.0' !== $request->server->get('SERVER_PROTOCOL')) {
-            $this->setProtocolVersion('1.1');
+        if ($this->isInformational() || $this->isEmpty()) {
+            $this->maxlen = 0;
+
+            return $this;
         }
 
-        $this->ensureIEOverSSLCompatibility($request);
+        if (!$this->headers->has('Content-Type')) {
+            $this->headers->set('Content-Type', $this->file->getMimeType() ?: 'application/octet-stream');
+        }
 
         $this->offset = 0;
         $this->maxlen = -1;
 
         if (false === $fileSize = $this->file->getSize()) {
             return $this;
         }
+        $this->headers->remove('Transfer-Encoding');
         $this->headers->set('Content-Length', $fileSize);
 
         if (!$this->headers->has('Accept-Ranges')) {
@@ -286,6 +289,10 @@ public function prepare(Request $request)
             }
         }
 
+        if ($request->isMethod('HEAD')) {
+            $this->maxlen = 0;
+        }
+
         return $this;
     }
 
@@ -309,40 +316,42 @@ private function hasValidIfRangeHeader(?string $header): bool
      */
     public function sendContent()
     {
-        if (!$this->isSuccessful()) {
-            return parent::sendContent();
-        }
+        try {
+            if (!$this->isSuccessful()) {
+                return parent::sendContent();
+            }
 
-        if (0 === $this->maxlen) {
-            return $this;
-        }
+            if (0 === $this->maxlen) {
+                return $this;
+            }
 
-        $out = fopen('php://output', 'w');
-        $file = fopen($this->file->getPathname(), 'r');
+            $out = fopen('php://output', 'w');
+            $file = fopen($this->file->getPathname(), 'r');
 
-        ignore_user_abort(true);
+            ignore_user_abort(true);
 
-        if (0 !== $this->offset) {
-            fseek($file, $this->offset);
-        }
+            if (0 !== $this->offset) {
+                fseek($file, $this->offset);
+            }
 
-        $length = $this->maxlen;
-        while ($length && !feof($file)) {
-            $read = ($length > $this->chunkSize) ? $this->chunkSize : $length;
-            $length -= $read;
+            $length = $this->maxlen;
+            while ($length && !feof($file)) {
+                $read = ($length > $this->chunkSize) ? $this->chunkSize : $length;
+                $length -= $read;
 
-            stream_copy_to_stream($file, $out, $read);
+                stream_copy_to_stream($file, $out, $read);
 
-            if (connection_aborted()) {
-                break;
+                if (connection_aborted()) {
+                    break;
+                }
             }
-        }
 
-        fclose($out);
-        fclose($file);
-
-        if ($this->deleteFileAfterSend && file_exists($this->file->getPathname())) {
-            unlink($this->file->getPathname());
+            fclose($out);
+            fclose($file);
+        } finally {
+            if ($this->deleteFileAfterSend && file_exists($this->file->getPathname())) {
+                unlink($this->file->getPathname());
+            }
         }
 
         return $this;
diff --git a/src/Symfony/Component/HttpFoundation/Tests/BinaryFileResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/BinaryFileResponseTest.php
@@ -373,6 +373,21 @@ public function testStream()
         $this->assertNull($response->headers->get('Content-Length'));
     }
 
+    public function testPrepareNotAddingContentTypeHeaderIfNoContentResponse()
+    {
+        $request = Request::create('/');
+        $request->headers->set('If-Modified-Since', date('D, d M Y H:i:s').' GMT');
+
+        $response = new BinaryFileResponse(__DIR__.'/File/Fixtures/test.gif', 200, ['Content-Type' => 'application/octet-stream']);
+        $response->setLastModified(new \DateTimeImmutable('-1 day'));
+        $response->isNotModified($request);
+
+        $response->prepare($request);
+
+        $this->assertSame(BinaryFileResponse::HTTP_NOT_MODIFIED, $response->getStatusCode());
+        $this->assertFalse($response->headers->has('Content-Type'));
+    }
+
     protected function provideResponse()
     {
         return new BinaryFileResponse(__DIR__.'/../README.md', 200, ['Content-Type' => 'application/octet-stream']);
