vendor/api-platform/core/src/GraphQl/Action/EntrypointAction.php line 42

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\GraphQl\Action;
  16. use ApiPlatform\GraphQl\Error\ErrorHandlerInterface;
  17. use ApiPlatform\GraphQl\ExecutorInterface;
  18. use ApiPlatform\GraphQl\Type\SchemaBuilderInterface;
  19. use GraphQL\Error\DebugFlag;
  20. use GraphQL\Error\Error;
  21. use GraphQL\Executor\ExecutionResult;
  22. use Symfony\Component\HttpFoundation\JsonResponse;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  26. use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
  28. /**
  29.  * GraphQL API entrypoint.
  30.  *
  31.  * @author Alan Poulain <contact@alanpoulain.eu>
  32.  */
  33. final class EntrypointAction
  34. {
  35.     private int $debug;
  37.     public function __construct(private readonly SchemaBuilderInterface $schemaBuilder, private readonly ExecutorInterface $executor, private readonly ?GraphiQlAction $graphiQlAction, private readonly ?GraphQlPlaygroundAction $graphQlPlaygroundAction, private readonly NormalizerInterface $normalizer, private readonly ErrorHandlerInterface $errorHandler, bool $debug = false, private readonly bool $graphiqlEnabled = false, private readonly bool $graphQlPlaygroundEnabled = false, private readonly ?string $defaultIde = null)
  38.     {
  39.         $this->debug = $debug ? DebugFlag::INCLUDE_DEBUG_MESSAGE | DebugFlag::INCLUDE_TRACE : DebugFlag::NONE;
  40.     }
  42.     public function __invoke(Request $request): Response
  43.     {
  44.         try {
  45.             if ($request->isMethod('GET') && 'html' === $request->getRequestFormat()) {
  46.                 if ('graphiql' === $this->defaultIde && $this->graphiqlEnabled && $this->graphiQlAction) {
  47.                     return ($this->graphiQlAction)($request);
  48.                 }
  50.                 if ('graphql-playground' === $this->defaultIde && $this->graphQlPlaygroundEnabled && $this->graphQlPlaygroundAction) {
  51.                     return ($this->graphQlPlaygroundAction)($request);
  52.                 }
  53.             }
  55.             [$query, $operationName, $variables] = $this->parseRequest($request);
  56.             if (null === $query) {
  57.                 throw new BadRequestHttpException('GraphQL query is not valid.');
  58.             }
  60.             $executionResult = $this->executor
  61.                 ->executeQuery($this->schemaBuilder->getSchema(), $query, null, null, $variables, $operationName)
  62.                 ->setErrorsHandler($this->errorHandler)
  63.                 ->setErrorFormatter($this->normalizer->normalize(...));
  64.         } catch (\Exception $exception) {
  65.             $executionResult = (new ExecutionResult(null, [new Error($exception->getMessage(), null, null, [], null, $exception)]))
  66.                 ->setErrorsHandler($this->errorHandler)
  67.                 ->setErrorFormatter($this->normalizer->normalize(...));
  68.         }
  70.         return new JsonResponse($executionResult->toArray($this->debug));
  71.     }
  73.     /**
  74.      * @throws BadRequestHttpException
  75.      */
  76.     private function parseRequest(Request $request): array
  77.     {
  78.         $queryParameters = $request->query->all();
  79.         $query = $queryParameters['query'] ?? null;
  80.         $operationName = $queryParameters['operationName'] ?? null;
  81.         if ($variables = $queryParameters['variables'] ?? []) {
  82.             $variables = $this->decodeVariables($variables);
  83.         }
  85.         if (!$request->isMethod('POST')) {
  86.             return [$query, $operationName, $variables];
  87.         }
  89.         $contentType = method_exists(Request::class, 'getContentTypeFormat') ? $request->getContentTypeFormat() : $request->getContentType();
  90.         if ('json' === $contentType) {
  91.             return $this->parseData($query, $operationName, $variables, $request->getContent());
  92.         }
  94.         if ('graphql' === $contentType) {
  95.             $query = $request->getContent();
  96.         }
  98.         if (\in_array($contentType, ['multipart', 'form'], true)) {
  99.             return $this->parseMultipartRequest($query, $operationName, $variables, $request->request->all(), $request->files->all());
  100.         }
  102.         return [$query, $operationName, $variables];
  103.     }
  105.     /**
  106.      * @throws BadRequestHttpException
  107.      */
  108.     private function parseData(?string $query, ?string $operationName, array $variables, string $jsonContent): array
  109.     {
  110.         if (!\is_array($data = json_decode($jsonContent, true, 512, \JSON_ERROR_NONE))) {
  111.             throw new BadRequestHttpException('GraphQL data is not valid JSON.');
  112.         }
  114.         if (isset($data['query'])) {
  115.             $query = $data['query'];
  116.         }
  118.         if (isset($data['variables'])) {
  119.             $variables = \is_array($data['variables']) ? $data['variables'] : $this->decodeVariables($data['variables']);
  120.         }
  122.         if (isset($data['operationName'])) {
  123.             $operationName = $data['operationName'];
  124.         }
  126.         return [$query, $operationName, $variables];
  127.     }
  129.     /**
  130.      * @throws BadRequestHttpException
  131.      */
  132.     private function parseMultipartRequest(?string $query, ?string $operationName, array $variables, array $bodyParameters, array $files): array
  133.     {
  134.         if ((null === $operations = $bodyParameters['operations'] ?? null) || (null === $map = $bodyParameters['map'] ?? null)) {
  135.             throw new BadRequestHttpException('GraphQL multipart request does not respect the specification.');
  136.         }
  138.         [$query, $operationName, $variables] = $this->parseData($query, $operationName, $variables, $operations);
  140.         /** @var string $map */
  141.         if (!\is_array($decodedMap = json_decode($map, true, 512, \JSON_ERROR_NONE))) {
  142.             throw new BadRequestHttpException('GraphQL multipart request map is not valid JSON.');
  143.         }
  145.         $variables = $this->applyMapToVariables($decodedMap, $variables, $files);
  147.         return [$query, $operationName, $variables];
  148.     }
  150.     /**
  151.      * @throws BadRequestHttpException
  152.      */
  153.     private function applyMapToVariables(array $map, array $variables, array $files): array
  154.     {
  155.         foreach ($map as $key => $value) {
  156.             if (null === $file = $files[$key] ?? null) {
  157.                 throw new BadRequestHttpException('GraphQL multipart request file has not been sent correctly.');
  158.             }
  160.             foreach ($value as $mapValue) {
  161.                 $path = explode('.', (string) $mapValue);
  163.                 if ('variables' !== $path[0]) {
  164.                     throw new BadRequestHttpException('GraphQL multipart request path in map is invalid.');
  165.                 }
  167.                 unset($path[0]);
  169.                 $mapPathExistsInVariables = array_reduce($path, static fn (array $inVariables, string $pathElement) => \array_key_exists($pathElement, $inVariables) ? $inVariables[$pathElement] : false, $variables);
  171.                 if (false === $mapPathExistsInVariables) {
  172.                     throw new BadRequestHttpException('GraphQL multipart request path in map does not match the variables.');
  173.                 }
  175.                 $variableFileValue = &$variables;
  176.                 foreach ($path as $pathValue) {
  177.                     $variableFileValue = &$variableFileValue[$pathValue];
  178.                 }
  179.                 $variableFileValue = $file;
  180.             }
  181.         }
  183.         return $variables;
  184.     }
  186.     /**
  187.      * @throws BadRequestHttpException
  188.      */
  189.     private function decodeVariables(string $variables): array
  190.     {
  191.         if (!\is_array($decoded = json_decode($variables, true, 512, \JSON_ERROR_NONE))) {
  192.             throw new BadRequestHttpException('GraphQL variables are not valid JSON.');
  193.         }
  195.         return $decoded;
  196.     }
  197. }