Merge pull request #2437 from teohhanhui/fix/content-negotiation-format

Fix content negotiation format matching

Author: antograssiot

src/Api/FormatMatcher.php

@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Api;
+
+/**
+ * Matches a mime type to a format.
+ *
+ * @internal
+ */
+final class FormatMatcher
+{
+    private $formats;
+
+    public function __construct(array $formats)
+    {
+        $normalizedFormats = [];
+        foreach ($formats as $format => $mimeTypes) {
+            $normalizedFormats[$format] = (array) $mimeTypes;
+        }
+        $this->formats = $normalizedFormats;
+    }
+
+    /**
+     * Gets the format associated with the mime type.
+     *
+     * Adapted from {@see \Symfony\Component\HttpFoundation\Request::getFormat}.
+     */
+    public function getFormat(string $mimeType): ?string
+    {
+        $canonicalMimeType = null;
+        $pos = strpos($mimeType, ';');
+        if (false !== $pos) {
+            $canonicalMimeType = trim(substr($mimeType, 0, $pos));
+        }
+
+        foreach ($this->formats as $format => $mimeTypes) {
+            if (\in_array($mimeType, $mimeTypes, true)) {
+                return $format;
+            }
+            if (null !== $canonicalMimeType && \in_array($canonicalMimeType, $mimeTypes, true)) {
+                return $format;
+            }
+        }
+
+        return null;
+    }
+}

src/EventListener/AddFormatListener.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Core\EventListener;
 
+use ApiPlatform\Core\Api\FormatMatcher;
 use ApiPlatform\Core\Api\FormatsProviderInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Util\RequestAttributesExtractor;
@@ -23,7 +24,7 @@
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
- * Chooses the format to user according to the Accept header and supported formats.
+ * Chooses the format to use according to the Accept header and supported formats.
  *
  * @author Kévin Dunglas <[email protected]>
  */
@@ -33,6 +34,7 @@ final class AddFormatListener
     private $formats = [];
     private $mimeTypes;
     private $formatsProvider;
+    private $formatMatcher;
 
     /**
      * @throws InvalidArgumentException
@@ -43,14 +45,13 @@ public function __construct(Negotiator $negotiator, /* FormatsProviderInterface
         if (\is_array($formatsProvider)) {
             @trigger_error('Using an array as formats provider is deprecated since API Platform 2.3 and will not be possible anymore in API Platform 3', E_USER_DEPRECATED);
             $this->formats = $formatsProvider;
+        } else {
+            if (!$formatsProvider instanceof FormatsProviderInterface) {
+                throw new InvalidArgumentException(sprintf('The "$formatsProvider" argument is expected to be an implementation of the "%s" interface.', FormatsProviderInterface::class));
+            }
 
-            return;
+            $this->formatsProvider = $formatsProvider;
         }
-        if (!$formatsProvider instanceof FormatsProviderInterface) {
-            throw new InvalidArgumentException(sprintf('The "$formatsProvider" argument is expected to be an implementation of the "%s" interface.', FormatsProviderInterface::class));
-        }
-
-        $this->formatsProvider = $formatsProvider;
     }
 
     /**
@@ -69,6 +70,7 @@ public function onKernelRequest(GetResponseEvent $event)
         if (null !== $this->formatsProvider) {
             $this->formats = $this->formatsProvider->getFormatsFromAttributes(RequestAttributesExtractor::extractAttributes($request));
         }
+        $this->formatMatcher = new FormatMatcher($this->formats);
 
         $this->populateMimeTypes();
         $this->addRequestFormats($request, $this->formats);
@@ -86,11 +88,11 @@ public function onKernelRequest(GetResponseEvent $event)
         /** @var string|null $accept */
         $accept = $request->headers->get('Accept');
         if (null !== $accept) {
-            if (null === $acceptHeader = $this->negotiator->getBest($accept, $mimeTypes)) {
+            if (null === $mediaType = $this->negotiator->getBest($accept, $mimeTypes)) {
                 throw $this->getNotAcceptableHttpException($accept, $mimeTypes);
             }
 
-            $request->setRequestFormat($request->getFormat($acceptHeader->getType()));
+            $request->setRequestFormat($this->formatMatcher->getFormat($mediaType->getType()));
 
             return;
         }
@@ -116,12 +118,14 @@ public function onKernelRequest(GetResponseEvent $event)
     }
 
     /**
-     * Adds API formats to the HttpFoundation Request.
+     * Adds the supported formats to the request.
+     *
+     * This is necessary for {@see Request::getMimeType} and {@see Request::getMimeTypes} to work.
      */
     private function addRequestFormats(Request $request, array $formats)
     {
         foreach ($formats as $format => $mimeTypes) {
-            $request->setFormat($format, $mimeTypes);
+            $request->setFormat($format, (array) $mimeTypes);
         }
     }
 

src/EventListener/DeserializeListener.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Core\EventListener;
 
+use ApiPlatform\Core\Api\FormatMatcher;
 use ApiPlatform\Core\Api\FormatsProviderInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
@@ -34,6 +35,7 @@ final class DeserializeListener
     private $serializerContextBuilder;
     private $formats = [];
     private $formatsProvider;
+    private $formatMatcher;
 
     /**
      * @throws InvalidArgumentException
@@ -45,14 +47,13 @@ public function __construct(SerializerInterface $serializer, SerializerContextBu
         if (\is_array($formatsProvider)) {
             @trigger_error('Using an array as formats provider is deprecated since API Platform 2.3 and will not be possible anymore in API Platform 3', E_USER_DEPRECATED);
             $this->formats = $formatsProvider;
+        } else {
+            if (!$formatsProvider instanceof FormatsProviderInterface) {
+                throw new InvalidArgumentException(sprintf('The "$formatsProvider" argument is expected to be an implementation of the "%s" interface.', FormatsProviderInterface::class));
+            }
 
-            return;
+            $this->formatsProvider = $formatsProvider;
         }
-        if (!$formatsProvider instanceof FormatsProviderInterface) {
-            throw new InvalidArgumentException(sprintf('The "$formatsProvider" argument is expected to be an implementation of the "%s" interface.', FormatsProviderInterface::class));
-        }
-
-        $this->formatsProvider = $formatsProvider;
     }
 
     /**
@@ -78,6 +79,7 @@ public function onKernelRequest(GetResponseEvent $event)
         if (null !== $this->formatsProvider) {
             $this->formats = $this->formatsProvider->getFormatsFromAttributes($attributes);
         }
+        $this->formatMatcher = new FormatMatcher($this->formats);
 
         $format = $this->getFormat($request);
         $context = $this->serializerContextBuilder->createFromRequest($request, false, $attributes);
@@ -110,7 +112,7 @@ private function getFormat(Request $request): string
             throw new NotAcceptableHttpException('The "Content-Type" header must exist.');
         }
 
-        $format = $request->getFormat($contentType);
+        $format = $this->formatMatcher->getFormat($contentType);
         if (null === $format || !isset($this->formats[$format])) {
             $supportedMimeTypes = [];
             foreach ($this->formats as $mimeTypes) {