bug #18255 [HttpFoundation] Fix support of custom mime types with parameters (Ener-Getick)

fabpot · fabpot · commit 09cc0b20d538 · 2016-03-25T17:26:41.000+01:00
This PR was merged into the 2.3 branch. Discussion ---------- [HttpFoundation] Fix support of custom mime types with parameters | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | FriendsOfSymfony/FOSRestBundle#1399 | License | MIT When using mime types with parameters, ``getFormat`` won't return the expected format as illustrated: ```php $request = new Request(); $request->setFormat('custom', 'app/foo;param=bar'); $request->getFormat('app/foo;param=bar'); // will return null as the parameters are removed ``` So my proposal is to search the format corresponding to a mime type with its raw value or with the its parameters removed. Commits ------- f7ad285 [Request] Fix support of custom mime types with parameters
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1238,8 +1238,9 @@ public function getMimeType($format)
      */
     public function getFormat($mimeType)
     {
+        $canonicalMimeType = null;
         if (false !== $pos = strpos($mimeType, ';')) {
-            $mimeType = substr($mimeType, 0, $pos);
+            $canonicalMimeType = substr($mimeType, 0, $pos);
         }
 
         if (null === static::$formats) {
@@ -1250,6 +1251,9 @@ public function getFormat($mimeType)
             if (in_array($mimeType, (array) $mimeTypes)) {
                 return $format;
             }
+            if (null !== $canonicalMimeType && in_array($canonicalMimeType, (array) $mimeTypes)) {
+                return $format;
+            }
         }
     }
 
diff --git a/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php b/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php
@@ -325,6 +325,13 @@ public function testGetMimeTypeFromFormat($format, $mimeTypes)
         }
     }
 
+    public function testGetFormatWithCustomMimeType()
+    {
+        $request = new Request();
+        $request->setFormat('custom', 'application/vnd.foo.api;myversion=2.3');
+        $this->assertEquals('custom', $request->getFormat('application/vnd.foo.api;myversion=2.3'));
+    }
+
     public function getFormatToMimeTypeMapProvider()
     {
         return array(

Original file line number	Diff line number	Diff line change
`@@ -1238,8 +1238,9 @@ public function getMimeType($format)`
`1238`	`1238`	`*/`
`1239`	`1239`	`public function getFormat($mimeType)`
`1240`	`1240`	`{`
	`1241`	`+ $canonicalMimeType = null;`
`1241`	`1242`	`if (false !== $pos = strpos($mimeType, ';')) {`
`1242`		`- $mimeType = substr($mimeType, 0, $pos);`
	`1243`	`+ $canonicalMimeType = substr($mimeType, 0, $pos);`
`1243`	`1244`	`}`
`1244`	`1245`
`1245`	`1246`	`if (null === static::$formats) {`
`@@ -1250,6 +1251,9 @@ public function getFormat($mimeType)`
`1250`	`1251`	`if (in_array($mimeType, (array) $mimeTypes)) {`
`1251`	`1252`	`return $format;`
`1252`	`1253`	`}`
	`1254`	`+ if (null !== $canonicalMimeType && in_array($canonicalMimeType, (array) $mimeTypes)) {`
	`1255`	`+ return $format;`
	`1256`	`+ }`
`1253`	`1257`	`}`
`1254`	`1258`	`}`
`1255`	`1259`
Original file line number	Diff line number	Diff line change
`@@ -325,6 +325,13 @@ public function testGetMimeTypeFromFormat($format, $mimeTypes)`
`325`	`325`	`}`
`326`	`326`	`}`
`327`	`327`
	`328`	`+ public function testGetFormatWithCustomMimeType()`
	`329`	`+ {`
	`330`	`+ $request = new Request();`
	`331`	`+ $request->setFormat('custom', 'application/vnd.foo.api;myversion=2.3');`
	`332`	`+ $this->assertEquals('custom', $request->getFormat('application/vnd.foo.api;myversion=2.3'));`
	`333`	`+ }`
	`334`	`+`
`328`	`335`	`public function getFormatToMimeTypeMapProvider()`
`329`	`336`	`{`
`330`	`337`	`return array(`