Symfony Profiler

<?php
/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* 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\Symfony\EventListener;
use ApiPlatform\Api\FormatMatcher;
use ApiPlatform\Metadata\Error as ErrorOperation;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
use Negotiation\Exception\InvalidArgument;
use Negotiation\Negotiator;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
/**
* Chooses the format to use according to the Accept header and supported formats.
*
* @author Kévin Dunglas <dunglas@gmail.com>
*/
final class AddFormatListener
{
use OperationRequestInitiatorTrait;
public function __construct(private readonly Negotiator $negotiator, ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, private readonly array $formats = [], private readonly array $errorFormats = [], private readonly array $docsFormats = [], private readonly ?bool $eventsBackwardCompatibility = null) // @phpstan-ignore-line
{
$this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
}
/**
* Sets the applicable format to the HttpFoundation Request.
*
* @throws NotFoundHttpException
* @throws NotAcceptableHttpException
*/
public function onKernelRequest(RequestEvent $event): void
{
$request = $event->getRequest();
$operation = $this->initializeOperation($request);
if ('api_platform.action.entrypoint' === $request->attributes->get('_controller')) {
return;
}
if ('api_platform.symfony.main_controller' === $operation?->getController() || $request->attributes->get('_api_platform_disable_listeners')) {
return;
}
if ($operation instanceof ErrorOperation) {
return;
}
if (!($request->attributes->has('_api_resource_class')
|| $request->attributes->getBoolean('_api_respond', false)
|| $request->attributes->getBoolean('_graphql', false)
)) {
return;
}
$formats = $operation?->getOutputFormats() ?? ('api_doc' === $request->attributes->get('_route') ? $this->docsFormats : $this->formats);
$this->addRequestFormats($request, $formats);
// Empty strings must be converted to null because the Symfony router doesn't support parameter typing before 3.2 (_format)
if (null === $routeFormat = $request->attributes->get('_format') ?: null) {
$flattenedMimeTypes = $this->flattenMimeTypes($formats);
$mimeTypes = array_keys($flattenedMimeTypes);
} elseif (!isset($formats[$routeFormat])) {
if (!$request->attributes->get('data') instanceof \Exception) {
throw new NotFoundHttpException(sprintf('Format "%s" is not supported', $routeFormat));
}
$this->setRequestErrorFormat($operation, $request);
return;
} else {
$mimeTypes = Request::getMimeTypes($routeFormat);
$flattenedMimeTypes = $this->flattenMimeTypes([$routeFormat => $mimeTypes]);
}
// First, try to guess the format from the Accept header
/** @var string|null $accept */
$accept = $request->headers->get('Accept');
if (null !== $accept) {
$mediaType = null;
try {
$mediaType = $this->negotiator->getBest($accept, $mimeTypes);
} catch (InvalidArgument) {
throw $this->getNotAcceptableHttpException($accept, $flattenedMimeTypes);
}
if (null === $mediaType) {
if (!$request->attributes->get('data') instanceof \Exception) {
throw $this->getNotAcceptableHttpException($accept, $flattenedMimeTypes);
}
$this->setRequestErrorFormat($operation, $request);
return;
}
$formatMatcher = new FormatMatcher($formats);
$request->setRequestFormat($formatMatcher->getFormat($mediaType->getType()));
return;
}
// Then use the Symfony request format if available and applicable
$requestFormat = $request->getRequestFormat('') ?: null;
if (null !== $requestFormat) {
$mimeType = $request->getMimeType($requestFormat);
if (isset($flattenedMimeTypes[$mimeType])) {
return;
}
if ($request->attributes->get('data') instanceof \Exception) {
$this->setRequestErrorFormat($operation, $request);
return;
}
throw $this->getNotAcceptableHttpException($mimeType, $flattenedMimeTypes);
}
// Finally, if no Accept header nor Symfony request format is set, return the default format
foreach ($formats as $format => $mimeType) {
$request->setRequestFormat($format);
return;
}
}
/**
* 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): void
{
foreach ($formats as $format => $mimeTypes) {
$request->setFormat($format, (array) $mimeTypes);
}
}
/**
* Retries the flattened list of MIME types.
*/
private function flattenMimeTypes(array $formats): array
{
$flattenedMimeTypes = [];
foreach ($formats as $format => $mimeTypes) {
foreach ($mimeTypes as $mimeType) {
$flattenedMimeTypes[$mimeType] = $format;
}
}
return $flattenedMimeTypes;
}
/**
* Retrieves an instance of NotAcceptableHttpException.
*/
private function getNotAcceptableHttpException(string $accept, array $mimeTypes): NotAcceptableHttpException
{
return new NotAcceptableHttpException(sprintf(
'Requested format "%s" is not supported. Supported MIME types are "%s".',
$accept,
implode('", "', array_keys($mimeTypes))
));
}
public function setRequestErrorFormat(?HttpOperation $operation, Request $request): void
{
$errorResourceFormats = array_merge($operation?->getOutputFormats() ?? [], $operation?->getFormats() ?? [], $this->errorFormats);
$flattened = $this->flattenMimeTypes($errorResourceFormats);
if ($flattened[$accept = $request->headers->get('Accept')] ?? false) {
$request->setRequestFormat($flattened[$accept]);
return;
}
if (isset($errorResourceFormats['jsonproblem'])) {
$request->setRequestFormat('jsonproblem');
$request->setFormat('jsonproblem', $errorResourceFormats['jsonproblem']);
return;
}
$request->setRequestFormat(array_key_first($errorResourceFormats));
}
}

vendor/api-platform/core/src/Symfony/EventListener/AddFormatListener.php line 48