vendor/symfony/framework-bundle/Controller/AbstractController.php line 212

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.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. namespace Symfony\Bundle\FrameworkBundle\Controller;
  14. use Psr\Container\ContainerInterface;
  15. use Psr\Link\EvolvableLinkInterface;
  16. use Psr\Link\LinkInterface;
  17. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  18. use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
  19. use Symfony\Component\Form\Extension\Core\Type\FormType;
  20. use Symfony\Component\Form\FormBuilderInterface;
  21. use Symfony\Component\Form\FormFactoryInterface;
  22. use Symfony\Component\Form\FormInterface;
  23. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  24. use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
  25. use Symfony\Component\HttpFoundation\JsonResponse;
  26. use Symfony\Component\HttpFoundation\RedirectResponse;
  27. use Symfony\Component\HttpFoundation\Request;
  28. use Symfony\Component\HttpFoundation\RequestStack;
  29. use Symfony\Component\HttpFoundation\Response;
  30. use Symfony\Component\HttpFoundation\ResponseHeaderBag;
  31. use Symfony\Component\HttpFoundation\Session\FlashBagAwareSessionInterface;
  32. use Symfony\Component\HttpFoundation\StreamedResponse;
  33. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  34. use Symfony\Component\HttpKernel\HttpKernelInterface;
  35. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  36. use Symfony\Component\Routing\RouterInterface;
  37. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  38. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  39. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  40. use Symfony\Component\Security\Core\User\UserInterface;
  41. use Symfony\Component\Security\Csrf\CsrfToken;
  42. use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
  43. use Symfony\Component\Serializer\SerializerInterface;
  44. use Symfony\Component\WebLink\EventListener\AddLinkHeaderListener;
  45. use Symfony\Component\WebLink\GenericLinkProvider;
  46. use Symfony\Component\WebLink\HttpHeaderSerializer;
  47. use Symfony\Component\WebLink\Link;
  48. use Symfony\Contracts\Service\Attribute\Required;
  49. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  50. use Twig\Environment;
  52. /**
  53.  * Provides shortcuts for HTTP-related features in controllers.
  54.  *
  55.  * @author Fabien Potencier <fabien@symfony.com>
  56.  */
  57. abstract class AbstractController implements ServiceSubscriberInterface
  58. {
  59.     /**
  60.      * @var ContainerInterface
  61.      */
  62.     protected $container;
  64.     #[Required]
  65.     public function setContainer(ContainerInterface $container): ?ContainerInterface
  66.     {
  67.         $previous = $this->container;
  68.         $this->container = $container;
  70.         return $previous;
  71.     }
  73.     /**
  74.      * Gets a container parameter by its name.
  75.      */
  76.     protected function getParameter(string $name): array|bool|string|int|float|\UnitEnum|null
  77.     {
  78.         if (!$this->container->has('parameter_bag')) {
  79.             throw new ServiceNotFoundException('parameter_bag.', null, null, [], sprintf('The "%s::getParameter()" method is missing a parameter bag to work properly. Did you forget to register your controller as a service subscriber? This can be fixed either by using autoconfiguration or by manually wiring a "parameter_bag" in the service locator passed to the controller.', static::class));
  80.         }
  82.         return $this->container->get('parameter_bag')->get($name);
  83.     }
  85.     public static function getSubscribedServices(): array
  86.     {
  87.         return [
  88.             'router' => '?'.RouterInterface::class,
  89.             'request_stack' => '?'.RequestStack::class,
  90.             'http_kernel' => '?'.HttpKernelInterface::class,
  91.             'serializer' => '?'.SerializerInterface::class,
  92.             'security.authorization_checker' => '?'.AuthorizationCheckerInterface::class,
  93.             'twig' => '?'.Environment::class,
  94.             'form.factory' => '?'.FormFactoryInterface::class,
  95.             'security.token_storage' => '?'.TokenStorageInterface::class,
  96.             'security.csrf.token_manager' => '?'.CsrfTokenManagerInterface::class,
  97.             'parameter_bag' => '?'.ContainerBagInterface::class,
  98.             'web_link.http_header_serializer' => '?'.HttpHeaderSerializer::class,
  99.         ];
  100.     }
  102.     /**
  103.      * Generates a URL from the given parameters.
  104.      *
  105.      * @see UrlGeneratorInterface
  106.      */
  107.     protected function generateUrl(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
  108.     {
  109.         return $this->container->get('router')->generate($route, $parameters, $referenceType);
  110.     }
  112.     /**
  113.      * Forwards the request to another controller.
  114.      *
  115.      * @param string $controller The controller name (a string like "App\Controller\PostController::index" or "App\Controller\PostController" if it is invokable)
  116.      */
  117.     protected function forward(string $controller, array $path = [], array $query = []): Response
  118.     {
  119.         $request = $this->container->get('request_stack')->getCurrentRequest();
  120.         $path['_controller'] = $controller;
  121.         $subRequest = $request->duplicate($query, null, $path);
  123.         return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
  124.     }
  126.     /**
  127.      * Returns a RedirectResponse to the given URL.
  128.      *
  129.      * @param int $status The HTTP status code (302 "Found" by default)
  130.      */
  131.     protected function redirect(string $url, int $status = 302): RedirectResponse
  132.     {
  133.         return new RedirectResponse($url, $status);
  134.     }
  136.     /**
  137.      * Returns a RedirectResponse to the given route with the given parameters.
  138.      *
  139.      * @param int $status The HTTP status code (302 "Found" by default)
  140.      */
  141.     protected function redirectToRoute(string $route, array $parameters = [], int $status = 302): RedirectResponse
  142.     {
  143.         return $this->redirect($this->generateUrl($route, $parameters), $status);
  144.     }
  146.     /**
  147.      * Returns a JsonResponse that uses the serializer component if enabled, or json_encode.
  148.      *
  149.      * @param int $status The HTTP status code (200 "OK" by default)
  150.      */
  151.     protected function json(mixed $data, int $status = 200, array $headers = [], array $context = []): JsonResponse
  152.     {
  153.         if ($this->container->has('serializer')) {
  154.             $json = $this->container->get('serializer')->serialize($data, 'json', array_merge([
  155.                 'json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS,
  156.             ], $context));
  158.             return new JsonResponse($json, $status, $headers, true);
  159.         }
  161.         return new JsonResponse($data, $status, $headers);
  162.     }
  164.     /**
  165.      * Returns a BinaryFileResponse object with original or customized file name and disposition header.
  166.      */
  167.     protected function file(\SplFileInfo|string $file, ?string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT): BinaryFileResponse
  168.     {
  169.         $response = new BinaryFileResponse($file);
  170.         $response->setContentDisposition($disposition, $fileName ?? $response->getFile()->getFilename());
  172.         return $response;
  173.     }
  175.     /**
  176.      * Adds a flash message to the current session for type.
  177.      *
  178.      * @throws \LogicException
  179.      */
  180.     protected function addFlash(string $type, mixed $message): void
  181.     {
  182.         try {
  183.             $session = $this->container->get('request_stack')->getSession();
  184.         } catch (SessionNotFoundException $e) {
  185.             throw new \LogicException('You cannot use the addFlash method if sessions are disabled. Enable them in "config/packages/framework.yaml".', 0, $e);
  186.         }
  188.         if (!$session instanceof FlashBagAwareSessionInterface) {
  189.             trigger_deprecation('symfony/framework-bundle', '6.2', 'Calling "addFlash()" method when the session does not implement %s is deprecated.', FlashBagAwareSessionInterface::class);
  190.         }
  192.         $session->getFlashBag()->add($type, $message);
  193.     }
  195.     /**
  196.      * Checks if the attribute is granted against the current authentication token and optionally supplied subject.
  197.      *
  198.      * @throws \LogicException
  199.      */
  200.     protected function isGranted(mixed $attribute, mixed $subject = null): bool
  201.     {
  202.         if (!$this->container->has('security.authorization_checker')) {
  203.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  204.         }
  206.         return $this->container->get('security.authorization_checker')->isGranted($attribute, $subject);
  207.     }
  209.     /**
  210.      * Throws an exception unless the attribute is granted against the current authentication token and optionally
  211.      * supplied subject.
  212.      *
  213.      * @throws AccessDeniedException
  214.      */
  215.     protected function denyAccessUnlessGranted(mixed $attribute, mixed $subject = null, string $message = 'Access Denied.'): void
  216.     {
  217.         if (!$this->isGranted($attribute, $subject)) {
  218.             $exception = $this->createAccessDeniedException($message);
  219.             $exception->setAttributes([$attribute]);
  220.             $exception->setSubject($subject);
  222.             throw $exception;
  223.         }
  224.     }
  226.     /**
  227.      * Returns a rendered view.
  228.      *
  229.      * Forms found in parameters are auto-cast to form views.
  230.      */
  231.     protected function renderView(string $view, array $parameters = []): string
  232.     {
  233.         if (!$this->container->has('twig')) {
  234.             throw new \LogicException('You cannot use the "renderView" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  235.         }
  237.         foreach ($parameters as $k => $v) {
  238.             if ($v instanceof FormInterface) {
  239.                 $parameters[$k] = $v->createView();
  240.             }
  241.         }
  243.         return $this->container->get('twig')->render($view, $parameters);
  244.     }
  246.     /**
  247.      * Renders a view.
  248.      *
  249.      * If an invalid form is found in the list of parameters, a 422 status code is returned.
  250.      * Forms found in parameters are auto-cast to form views.
  251.      */
  252.     protected function render(string $view, array $parameters = [], ?Response $response = null): Response
  253.     {
  254.         $content = $this->renderView($view, $parameters);
  255.         $response ??= new Response();
  257.         if (200 === $response->getStatusCode()) {
  258.             foreach ($parameters as $v) {
  259.                 if ($v instanceof FormInterface && $v->isSubmitted() && !$v->isValid()) {
  260.                     $response->setStatusCode(422);
  261.                     break;
  262.                 }
  263.             }
  264.         }
  266.         $response->setContent($content);
  268.         return $response;
  269.     }
  271.     /**
  272.      * Renders a view and sets the appropriate status code when a form is listed in parameters.
  273.      *
  274.      * If an invalid form is found in the list of parameters, a 422 status code is returned.
  275.      *
  276.      * @deprecated since Symfony 6.2, use render() instead
  277.      */
  278.     protected function renderForm(string $view, array $parameters = [], ?Response $response = null): Response
  279.     {
  280.         trigger_deprecation('symfony/framework-bundle', '6.2', 'The "%s::renderForm()" method is deprecated, use "render()" instead.', get_debug_type($this));
  282.         return $this->render($view, $parameters, $response);
  283.     }
  285.     /**
  286.      * Streams a view.
  287.      */
  288.     protected function stream(string $view, array $parameters = [], ?StreamedResponse $response = null): StreamedResponse
  289.     {
  290.         if (!$this->container->has('twig')) {
  291.             throw new \LogicException('You cannot use the "stream" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  292.         }
  294.         $twig = $this->container->get('twig');
  296.         $callback = function () use ($twig, $view, $parameters) {
  297.             $twig->display($view, $parameters);
  298.         };
  300.         if (null === $response) {
  301.             return new StreamedResponse($callback);
  302.         }
  304.         $response->setCallback($callback);
  306.         return $response;
  307.     }
  309.     /**
  310.      * Returns a NotFoundHttpException.
  311.      *
  312.      * This will result in a 404 response code. Usage example:
  313.      *
  314.      *     throw $this->createNotFoundException('Page not found!');
  315.      */
  316.     protected function createNotFoundException(string $message = 'Not Found', ?\Throwable $previous = null): NotFoundHttpException
  317.     {
  318.         return new NotFoundHttpException($message, $previous);
  319.     }
  321.     /**
  322.      * Returns an AccessDeniedException.
  323.      *
  324.      * This will result in a 403 response code. Usage example:
  325.      *
  326.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  327.      *
  328.      * @throws \LogicException If the Security component is not available
  329.      */
  330.     protected function createAccessDeniedException(string $message = 'Access Denied.', ?\Throwable $previous = null): AccessDeniedException
  331.     {
  332.         if (!class_exists(AccessDeniedException::class)) {
  333.             throw new \LogicException('You cannot use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  334.         }
  336.         return new AccessDeniedException($message, $previous);
  337.     }
  339.     /**
  340.      * Creates and returns a Form instance from the type of the form.
  341.      */
  342.     protected function createForm(string $type, mixed $data = null, array $options = []): FormInterface
  343.     {
  344.         return $this->container->get('form.factory')->create($type, $data, $options);
  345.     }
  347.     /**
  348.      * Creates and returns a form builder instance.
  349.      */
  350.     protected function createFormBuilder(mixed $data = null, array $options = []): FormBuilderInterface
  351.     {
  352.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  353.     }
  355.     /**
  356.      * Get a user from the Security Token Storage.
  357.      *
  358.      * @throws \LogicException If SecurityBundle is not available
  359.      *
  360.      * @see TokenInterface::getUser()
  361.      */
  362.     protected function getUser(): ?UserInterface
  363.     {
  364.         if (!$this->container->has('security.token_storage')) {
  365.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  366.         }
  368.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  369.             return null;
  370.         }
  372.         return $token->getUser();
  373.     }
  375.     /**
  376.      * Checks the validity of a CSRF token.
  377.      *
  378.      * @param string      $id    The id used when generating the token
  379.      * @param string|null $token The actual token sent with the request that should be validated
  380.      */
  381.     protected function isCsrfTokenValid(string $id, #[\SensitiveParameter] ?string $token): bool
  382.     {
  383.         if (!$this->container->has('security.csrf.token_manager')) {
  384.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  385.         }
  387.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  388.     }
  390.     /**
  391.      * Adds a Link HTTP header to the current response.
  392.      *
  393.      * @see https://tools.ietf.org/html/rfc5988
  394.      */
  395.     protected function addLink(Request $request, LinkInterface $link): void
  396.     {
  397.         if (!class_exists(AddLinkHeaderListener::class)) {
  398.             throw new \LogicException('You cannot use the "addLink" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  399.         }
  401.         if (null === $linkProvider = $request->attributes->get('_links')) {
  402.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  404.             return;
  405.         }
  407.         $request->attributes->set('_links', $linkProvider->withLink($link));
  408.     }
  410.     /**
  411.      * @param LinkInterface[] $links
  412.      */
  413.     protected function sendEarlyHints(iterable $links = [], ?Response $response = null): Response
  414.     {
  415.         if (!$this->container->has('web_link.http_header_serializer')) {
  416.             throw new \LogicException('You cannot use the "sendEarlyHints" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  417.         }
  419.         $response ??= new Response();
  421.         $populatedLinks = [];
  422.         foreach ($links as $link) {
  423.             if ($link instanceof EvolvableLinkInterface && !$link->getRels()) {
  424.                 $link = $link->withRel('preload');
  425.             }
  427.             $populatedLinks[] = $link;
  428.         }
  430.         $response->headers->set('Link', $this->container->get('web_link.http_header_serializer')->serialize($populatedLinks), false);
  431.         $response->sendHeaders(103);
  433.         return $response;
  434.     }
  435. }