[HttpFoundation] Prevent BinaryFileResponse::prepare from adding content type if no content is sent #47516
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Good catch. Can you please try the following patch? It might fix a few more things. --- a/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php
+++ b/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php
@@ -210,11 +210,13 @@ class BinaryFileResponse extends Response
$this->headers->set('Content-Type', $this->file->getMimeType() ?: 'application/octet-stream');
}
- if ('HTTP/1.0' !== $request->server->get('SERVER_PROTOCOL')) {
- $this->setProtocolVersion('1.1');
- }
+ parent::prepare($request);
+
+ if ($this->isInformational() || $this->isEmpty()) {
+ $this->maxlen = 0;
- $this->ensureIEOverSSLCompatibility($request);
+ return $this;
+ }
$this->offset = 0;
$this->maxlen = -1;
@@ -222,6 +224,7 @@ class BinaryFileResponse extends Response
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')) {
@@ -291,6 +294,10 @@ class BinaryFileResponse extends Response
}
}
+ if ($request->isMethod('HEAD')) {
+ $this->maxlen = 0;
+ }
+
return $this;
}
@@ -312,6 +319,7 @@ class BinaryFileResponse extends Response
*/
public function sendContent()
{
+ try {
if (!$this->isSuccessful()) {
return parent::sendContent();
}
@@ -343,10 +351,11 @@ class BinaryFileResponse extends Response
fclose($out);
fclose($file);
+ } finally {
if ($this->deleteFileAfterSend && is_file($this->file->getPathname())) {
unlink($this->file->getPathname());
}
+ }
return $this;
} |
|
@nicolas-grekas Thanks for your review and improvements. They are much cleaner! There is just one part where my commit differs from your suggestion. I have added the |
nicolas-grekas
approved these changes
Sep 12, 2022
fabpot
approved these changes
Sep 13, 2022
…ent type if no content is sent
|
Thank you @Naitsirch. |
This was referenced Sep 30, 2022
Merged
Merged
Merged
Merged
fabpot
added a commit
that referenced
this pull request
Sep 30, 2022
…tion logic (X-Coder264) This PR was merged into the 4.4 branch. Discussion ---------- [HttpFoundation] Fix BinaryFileResponse content type detection logic | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - I've just upgraded to 5.4.13 (from 5.4.8) and a lot of my tests started failing. Upon further debugging I've found the issue to be caused by #47516 Prior to that PR ```php if (!$this->headers->has('Content-Type')) { $this->headers->set('Content-Type', $this->file->getMimeType() ?: 'application/octet-stream'); } ``` was called before the `parent::prepare($request);` call. After that PR `parent::prepare($request);` was called first and that would call ```php // Content-type based on the Request if (!$headers->has('Content-Type')) { $format = $request->getRequestFormat(null); if (null !== $format && $mimeType = $request->getMimeType($format)) { $headers->set('Content-Type', $mimeType); } } ``` which would set the content type from the request so by the time ```php if (!$this->headers->has('Content-Type')) { $this->headers->set('Content-Type', $this->file->getMimeType() ?: 'application/octet-stream'); } ``` is executed again in the BinaryFileResponse `prepare` method that `if` statement never evaluates to `true` because the `Content-Type` header was already set (to the wrong one). This PR fixes this issue by making sure the order of the method calls is correct. Commits ------- 87f58ae Fix BinaryFileResponse content type detection logic
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Until now,
BinaryFileResponse::prepare()addsContent-Typeand 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