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

  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\Contracts\Service\Attribute\Required;
  48. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  49. use Twig\Environment;
  51. /**
  52.  * Provides shortcuts for HTTP-related features in controllers.
  53.  *
  54.  * @author Fabien Potencier <fabien@symfony.com>
  55.  */
  56. abstract class AbstractController implements ServiceSubscriberInterface
  57. {
  58.     /**
  59.      * @var ContainerInterface
  60.      */
  61.     protected $container;
  63.     #[Required]
  64.     public function setContainer(ContainerInterface $container): ?ContainerInterface
  65.     {
  66.         $previous = $this->container ?? null;
  67.         $this->container = $container;
  69.         return $previous;
  70.     }
  72.     /**
  73.      * Gets a container parameter by its name.
  74.      */
  75.     protected function getParameter(string $name): array|bool|string|int|float|\UnitEnum|null
  76.     {
  77.         if (!$this->container->has('parameter_bag')) {
  78.             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));
  79.         }
  81.         return $this->container->get('parameter_bag')->get($name);
  82.     }
  84.     public static function getSubscribedServices(): array
  85.     {
  86.         return [
  87.             'router' => '?'.RouterInterface::class,
  88.             'request_stack' => '?'.RequestStack::class,
  89.             'http_kernel' => '?'.HttpKernelInterface::class,
  90.             'serializer' => '?'.SerializerInterface::class,
  91.             'security.authorization_checker' => '?'.AuthorizationCheckerInterface::class,
  92.             'twig' => '?'.Environment::class,
  93.             'form.factory' => '?'.FormFactoryInterface::class,
  94.             'security.token_storage' => '?'.TokenStorageInterface::class,
  95.             'security.csrf.token_manager' => '?'.CsrfTokenManagerInterface::class,
  96.             'parameter_bag' => '?'.ContainerBagInterface::class,
  97.             'web_link.http_header_serializer' => '?'.HttpHeaderSerializer::class,
  98.         ];
  99.     }
  101.     /**
  102.      * Generates a URL from the given parameters.
  103.      *
  104.      * @see UrlGeneratorInterface
  105.      */
  106.     protected function generateUrl(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
  107.     {
  108.         return $this->container->get('router')->generate($route, $parameters, $referenceType);
  109.     }
  111.     /**
  112.      * Forwards the request to another controller.
  113.      *
  114.      * @param string $controller The controller name (a string like "App\Controller\PostController::index" or "App\Controller\PostController" if it is invokable)
  115.      */
  116.     protected function forward(string $controller, array $path = [], array $query = []): Response
  117.     {
  118.         $request = $this->container->get('request_stack')->getCurrentRequest();
  119.         $path['_controller'] = $controller;
  120.         $subRequest = $request->duplicate($query, null, $path);
  122.         return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
  123.     }
  125.     /**
  126.      * Returns a RedirectResponse to the given URL.
  127.      *
  128.      * @param int $status The HTTP status code (302 "Found" by default)
  129.      */
  130.     protected function redirect(string $url, int $status = 302): RedirectResponse
  131.     {
  132.         return new RedirectResponse($url, $status);
  133.     }
  135.     /**
  136.      * Returns a RedirectResponse to the given route with the given parameters.
  137.      *
  138.      * @param int $status The HTTP status code (302 "Found" by default)
  139.      */
  140.     protected function redirectToRoute(string $route, array $parameters = [], int $status = 302): RedirectResponse
  141.     {
  142.         return $this->redirect($this->generateUrl($route, $parameters), $status);
  143.     }
  145.     /**
  146.      * Returns a JsonResponse that uses the serializer component if enabled, or json_encode.
  147.      *
  148.      * @param int $status The HTTP status code (200 "OK" by default)
  149.      */
  150.     protected function json(mixed $data, int $status = 200, array $headers = [], array $context = []): JsonResponse
  151.     {
  152.         if ($this->container->has('serializer')) {
  153.             $json = $this->container->get('serializer')->serialize($data, 'json', array_merge([
  154.                 'json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS,
  155.             ], $context));
  157.             return new JsonResponse($json, $status, $headers, true);
  158.         }
  160.         return new JsonResponse($data, $status, $headers);
  161.     }
  163.     /**
  164.      * Returns a BinaryFileResponse object with original or customized file name and disposition header.
  165.      */
  166.     protected function file(\SplFileInfo|string $file, ?string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT): BinaryFileResponse
  167.     {
  168.         $response = new BinaryFileResponse($file);
  169.         $response->setContentDisposition($disposition, $fileName ?? $response->getFile()->getFilename());
  171.         return $response;
  172.     }
  174.     /**
  175.      * Adds a flash message to the current session for type.
  176.      *
  177.      * @throws \LogicException
  178.      */
  179.     protected function addFlash(string $type, mixed $message): void
  180.     {
  181.         try {
  182.             $session = $this->container->get('request_stack')->getSession();
  183.         } catch (SessionNotFoundException $e) {
  184.             throw new \LogicException('You cannot use the addFlash method if sessions are disabled. Enable them in "config/packages/framework.yaml".', 0, $e);
  185.         }
  187.         if (!$session instanceof FlashBagAwareSessionInterface) {
  188.             trigger_deprecation('symfony/framework-bundle', '6.2', 'Calling "addFlash()" method when the session does not implement %s is deprecated.', FlashBagAwareSessionInterface::class);
  189.         }
  191.         $session->getFlashBag()->add($type, $message);
  192.     }
  194.     /**
  195.      * Checks if the attribute is granted against the current authentication token and optionally supplied subject.
  196.      *
  197.      * @throws \LogicException
  198.      */
  199.     protected function isGranted(mixed $attribute, mixed $subject = null): bool
  200.     {
  201.         if (!$this->container->has('security.authorization_checker')) {
  202.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  203.         }
  205.         return $this->container->get('security.authorization_checker')->isGranted($attribute, $subject);
  206.     }
  208.     /**
  209.      * Throws an exception unless the attribute is granted against the current authentication token and optionally
  210.      * supplied subject.
  211.      *
  212.      * @throws AccessDeniedException
  213.      */
  214.     protected function denyAccessUnlessGranted(mixed $attribute, mixed $subject = null, string $message = 'Access Denied.'): void
  215.     {
  216.         if (!$this->isGranted($attribute, $subject)) {
  217.             $exception = $this->createAccessDeniedException($message);
  218.             $exception->setAttributes([$attribute]);
  219.             $exception->setSubject($subject);
  221.             throw $exception;
  222.         }
  223.     }
  225.     /**
  226.      * Returns a rendered view.
  227.      *
  228.      * Forms found in parameters are auto-cast to form views.
  229.      */
  230.     protected function renderView(string $view, array $parameters = []): string
  231.     {
  232.         return $this->doRenderView($view, null, $parameters, __FUNCTION__);
  233.     }
  235.     /**
  236.      * Returns a rendered block from a view.
  237.      *
  238.      * Forms found in parameters are auto-cast to form views.
  239.      */
  240.     protected function renderBlockView(string $view, string $block, array $parameters = []): string
  241.     {
  242.         return $this->doRenderView($view, $block, $parameters, __FUNCTION__);
  243.     }
  245.     /**
  246.      * Renders a view.
  247.      *
  248.      * If an invalid form is found in the list of parameters, a 422 status code is returned.
  249.      * Forms found in parameters are auto-cast to form views.
  250.      */
  251.     protected function render(string $view, array $parameters = [], ?Response $response = null): Response
  252.     {
  253.         return $this->doRender($view, null, $parameters, $response, __FUNCTION__);
  254.     }
  256.     /**
  257.      * Renders a block in a view.
  258.      *
  259.      * If an invalid form is found in the list of parameters, a 422 status code is returned.
  260.      * Forms found in parameters are auto-cast to form views.
  261.      */
  262.     protected function renderBlock(string $view, string $block, array $parameters = [], ?Response $response = null): Response
  263.     {
  264.         return $this->doRender($view, $block, $parameters, $response, __FUNCTION__);
  265.     }
  267.     /**
  268.      * Renders a view and sets the appropriate status code when a form is listed in parameters.
  269.      *
  270.      * If an invalid form is found in the list of parameters, a 422 status code is returned.
  271.      *
  272.      * @deprecated since Symfony 6.2, use render() instead
  273.      */
  274.     protected function renderForm(string $view, array $parameters = [], ?Response $response = null): Response
  275.     {
  276.         trigger_deprecation('symfony/framework-bundle', '6.2', 'The "%s::renderForm()" method is deprecated, use "render()" instead.', get_debug_type($this));
  278.         return $this->render($view, $parameters, $response);
  279.     }
  281.     /**
  282.      * Streams a view.
  283.      */
  284.     protected function stream(string $view, array $parameters = [], ?StreamedResponse $response = null): StreamedResponse
  285.     {
  286.         if (!$this->container->has('twig')) {
  287.             throw new \LogicException('You cannot use the "stream" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  288.         }
  290.         $twig = $this->container->get('twig');
  292.         $callback = function () use ($twig, $view, $parameters) {
  293.             $twig->display($view, $parameters);
  294.         };
  296.         if (null === $response) {
  297.             return new StreamedResponse($callback);
  298.         }
  300.         $response->setCallback($callback);
  302.         return $response;
  303.     }
  305.     /**
  306.      * Returns a NotFoundHttpException.
  307.      *
  308.      * This will result in a 404 response code. Usage example:
  309.      *
  310.      *     throw $this->createNotFoundException('Page not found!');
  311.      */
  312.     protected function createNotFoundException(string $message = 'Not Found', ?\Throwable $previous = null): NotFoundHttpException
  313.     {
  314.         return new NotFoundHttpException($message, $previous);
  315.     }
  317.     /**
  318.      * Returns an AccessDeniedException.
  319.      *
  320.      * This will result in a 403 response code. Usage example:
  321.      *
  322.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  323.      *
  324.      * @throws \LogicException If the Security component is not available
  325.      */
  326.     protected function createAccessDeniedException(string $message = 'Access Denied.', ?\Throwable $previous = null): AccessDeniedException
  327.     {
  328.         if (!class_exists(AccessDeniedException::class)) {
  329.             throw new \LogicException('You cannot use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  330.         }
  332.         return new AccessDeniedException($message, $previous);
  333.     }
  335.     /**
  336.      * Creates and returns a Form instance from the type of the form.
  337.      */
  338.     protected function createForm(string $type, mixed $data = null, array $options = []): FormInterface
  339.     {
  340.         return $this->container->get('form.factory')->create($type, $data, $options);
  341.     }
  343.     /**
  344.      * Creates and returns a form builder instance.
  345.      */
  346.     protected function createFormBuilder(mixed $data = null, array $options = []): FormBuilderInterface
  347.     {
  348.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  349.     }
  351.     /**
  352.      * Get a user from the Security Token Storage.
  353.      *
  354.      * @throws \LogicException If SecurityBundle is not available
  355.      *
  356.      * @see TokenInterface::getUser()
  357.      */
  358.     protected function getUser(): ?UserInterface
  359.     {
  360.         if (!$this->container->has('security.token_storage')) {
  361.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  362.         }
  364.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  365.             return null;
  366.         }
  368.         return $token->getUser();
  369.     }
  371.     /**
  372.      * Checks the validity of a CSRF token.
  373.      *
  374.      * @param string      $id    The id used when generating the token
  375.      * @param string|null $token The actual token sent with the request that should be validated
  376.      */
  377.     protected function isCsrfTokenValid(string $id, #[\SensitiveParameter] ?string $token): bool
  378.     {
  379.         if (!$this->container->has('security.csrf.token_manager')) {
  380.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  381.         }
  383.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  384.     }
  386.     /**
  387.      * Adds a Link HTTP header to the current response.
  388.      *
  389.      * @see https://tools.ietf.org/html/rfc5988
  390.      */
  391.     protected function addLink(Request $request, LinkInterface $link): void
  392.     {
  393.         if (!class_exists(AddLinkHeaderListener::class)) {
  394.             throw new \LogicException('You cannot use the "addLink" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  395.         }
  397.         if (null === $linkProvider = $request->attributes->get('_links')) {
  398.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  400.             return;
  401.         }
  403.         $request->attributes->set('_links', $linkProvider->withLink($link));
  404.     }
  406.     /**
  407.      * @param LinkInterface[] $links
  408.      */
  409.     protected function sendEarlyHints(iterable $links = [], ?Response $response = null): Response
  410.     {
  411.         if (!$this->container->has('web_link.http_header_serializer')) {
  412.             throw new \LogicException('You cannot use the "sendEarlyHints" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  413.         }
  415.         $response ??= new Response();
  417.         $populatedLinks = [];
  418.         foreach ($links as $link) {
  419.             if ($link instanceof EvolvableLinkInterface && !$link->getRels()) {
  420.                 $link = $link->withRel('preload');
  421.             }
  423.             $populatedLinks[] = $link;
  424.         }
  426.         $response->headers->set('Link', $this->container->get('web_link.http_header_serializer')->serialize($populatedLinks), false);
  427.         $response->sendHeaders(103);
  429.         return $response;
  430.     }
  432.     private function doRenderView(string $view, ?string $block, array $parameters, string $method): string
  433.     {
  434.         if (!$this->container->has('twig')) {
  435.             throw new \LogicException(sprintf('You cannot use the "%s" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".', $method));
  436.         }
  438.         foreach ($parameters as $k => $v) {
  439.             if ($v instanceof FormInterface) {
  440.                 $parameters[$k] = $v->createView();
  441.             }
  442.         }
  444.         if (null !== $block) {
  445.             return $this->container->get('twig')->load($view)->renderBlock($block, $parameters);
  446.         }
  448.         return $this->container->get('twig')->render($view, $parameters);
  449.     }
  451.     private function doRender(string $view, ?string $block, array $parameters, ?Response $response, string $method): Response
  452.     {
  453.         $content = $this->doRenderView($view, $block, $parameters, $method);
  454.         $response ??= new Response();
  456.         if (200 === $response->getStatusCode()) {
  457.             foreach ($parameters as $v) {
  458.                 if ($v instanceof FormInterface && $v->isSubmitted() && !$v->isValid()) {
  459.                     $response->setStatusCode(422);
  460.                     break;
  461.                 }
  462.             }
  463.         }
  465.         $response->setContent($content);
  467.         return $response;
  468.     }
  469. }