bug #34921 [HttpFoundation] Removed "Content-Type" from the preferred format guessing mechanism (yceruto)

fabpot · fabpot · commit d91efd31f620 · 2019-12-11T01:19:19.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [HttpFoundation] Removed "Content-Type" from the preferred format guessing mechanism | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #34906, Fix #34857 | License | MIT | Doc PR | - Confirmed, inferring the `Content-Type` of the response using the `Content-Type` provided for the request body is NOT a good idea. The HTTP RFC explicitly states that `Accept` must be used to hint a preferred response format (`Content-Type` on the request indicates the type of associated its the body). Use `Accept` if provided (a best practice anyway), and fallback to the default value (HTML by default) otherwise. Commits ------- 776523e Removed request header "Content-Type" from the preferred format guessing mechanism
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1586,20 +1586,17 @@ public function isNoCache()
      */
     public function getPreferredFormat(?string $default = 'html'): ?string
     {
-        if (null !== $this->preferredFormat) {
+        if (null !== $this->preferredFormat || null !== $this->preferredFormat = $this->getRequestFormat(null)) {
             return $this->preferredFormat;
         }
 
-        $preferredFormat = null;
-        foreach ($this->getAcceptableContentTypes() as $contentType) {
-            if ($preferredFormat = $this->getFormat($contentType)) {
-                break;
+        foreach ($this->getAcceptableContentTypes() as $mimeType) {
+            if ($this->preferredFormat = $this->getFormat($mimeType)) {
+                return $this->preferredFormat;
             }
         }
 
-        $this->preferredFormat = $this->getRequestFormat($preferredFormat ?: $this->getContentType());
-
-        return $this->preferredFormat ?: $default;
+        return $default;
     }
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php b/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php
@@ -408,12 +408,10 @@ public function testGetPreferredFormat()
 
         $request->setRequestFormat('atom');
         $request->headers->set('Accept', 'application/ld+json');
-        $request->headers->set('Content-Type', 'application/merge-patch+json');
         $this->assertSame('atom', $request->getPreferredFormat());
 
         $request = new Request();
         $request->headers->set('Accept', 'application/xml');
-        $request->headers->set('Content-Type', 'application/json');
         $this->assertSame('xml', $request->getPreferredFormat());
 
         $request = new Request();

Original file line number	Diff line number	Diff line change
`@@ -1586,20 +1586,17 @@ public function isNoCache()`
`1586`	`1586`	`*/`
`1587`	`1587`	`public function getPreferredFormat(?string $default = 'html'): ?string`
`1588`	`1588`	`{`
`1589`		`- if (null !== $this->preferredFormat) {`
	`1589`	`+ if (null !== $this->preferredFormat \|\| null !== $this->preferredFormat = $this->getRequestFormat(null)) {`
`1590`	`1590`	`return $this->preferredFormat;`
`1591`	`1591`	`}`
`1592`	`1592`
`1593`		`- $preferredFormat = null;`
`1594`		`- foreach ($this->getAcceptableContentTypes() as $contentType) {`
`1595`		`- if ($preferredFormat = $this->getFormat($contentType)) {`
`1596`		`- break;`
	`1593`	`+ foreach ($this->getAcceptableContentTypes() as $mimeType) {`
	`1594`	`+ if ($this->preferredFormat = $this->getFormat($mimeType)) {`
	`1595`	`+ return $this->preferredFormat;`
`1597`	`1596`	`}`
`1598`	`1597`	`}`
`1599`	`1598`
`1600`		`- $this->preferredFormat = $this->getRequestFormat($preferredFormat ?: $this->getContentType());`
`1601`		`-`
`1602`		`- return $this->preferredFormat ?: $default;`
	`1599`	`+ return $default;`
`1603`	`1600`	`}`
`1604`	`1601`
`1605`	`1602`	`/**`