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

  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\LinkInterface;
  16. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  17. use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
  18. use Symfony\Component\Form\Extension\Core\Type\FormType;
  19. use Symfony\Component\Form\FormBuilderInterface;
  20. use Symfony\Component\Form\FormFactoryInterface;
  21. use Symfony\Component\Form\FormInterface;
  22. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  23. use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
  24. use Symfony\Component\HttpFoundation\JsonResponse;
  25. use Symfony\Component\HttpFoundation\RedirectResponse;
  26. use Symfony\Component\HttpFoundation\Request;
  27. use Symfony\Component\HttpFoundation\RequestStack;
  28. use Symfony\Component\HttpFoundation\Response;
  29. use Symfony\Component\HttpFoundation\ResponseHeaderBag;
  30. use Symfony\Component\HttpFoundation\Session\FlashBagAwareSessionInterface;
  31. use Symfony\Component\HttpFoundation\StreamedResponse;
  32. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  33. use Symfony\Component\HttpKernel\HttpKernelInterface;
  34. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  35. use Symfony\Component\Routing\RouterInterface;
  36. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  37. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  38. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  39. use Symfony\Component\Security\Core\User\UserInterface;
  40. use Symfony\Component\Security\Csrf\CsrfToken;
  41. use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
  42. use Symfony\Component\Serializer\SerializerInterface;
  43. use Symfony\Component\WebLink\EventListener\AddLinkHeaderListener;
  44. use Symfony\Component\WebLink\GenericLinkProvider;
  45. use Symfony\Contracts\Service\Attribute\Required;
  46. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  47. use Twig\Environment;
  49. /**
  50.  * Provides shortcuts for HTTP-related features in controllers.
  51.  *
  52.  * @author Fabien Potencier <fabien@symfony.com>
  53.  */
  54. abstract class AbstractController implements ServiceSubscriberInterface
  55. {
  56.     /**
  57.      * @var ContainerInterface
  58.      */
  59.     protected $container;
  61.     /**
  62.      * @required
  63.      */
  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.         ];
  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 Bundle\BlogBundle\Controller\PostController::indexAction)
  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, null === $fileName ? $response->getFile()->getFilename() : $fileName);
  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.         if (!$this->container->has('twig')) {
  233.             throw new \LogicException('You cannot use the "renderView" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  234.         }
  236.         foreach ($parameters as $k => $v) {
  237.             if ($v instanceof FormInterface) {
  238.                 $parameters[$k] = $v->createView();
  239.             }
  240.         }
  242.         return $this->container->get('twig')->render($view, $parameters);
  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.         $content = $this->renderView($view, $parameters);
  254.         $response ??= new Response();
  256.         if (200 === $response->getStatusCode()) {
  257.             foreach ($parameters as $v) {
  258.                 if ($v instanceof FormInterface && $v->isSubmitted() && !$v->isValid()) {
  259.                     $response->setStatusCode(422);
  260.                     break;
  261.                 }
  262.             }
  263.         }
  265.         $response->setContent($content);
  267.         return $response;
  268.     }
  270.     /**
  271.      * Renders a view and sets the appropriate status code when a form is listed in parameters.
  272.      *
  273.      * If an invalid form is found in the list of parameters, a 422 status code is returned.
  274.      *
  275.      * @deprecated since Symfony 6.2, use render() instead
  276.      */
  277.     protected function renderForm(string $view, array $parameters = [], Response $response = null): Response
  278.     {
  279.         trigger_deprecation('symfony/framework-bundle', '6.2', 'The "%s::renderForm()" method is deprecated, use "render()" instead.', get_debug_type($this));
  281.         return $this->render($view, $parameters, $response);
  282.     }
  284.     /**
  285.      * Streams a view.
  286.      */
  287.     protected function stream(string $view, array $parameters = [], StreamedResponse $response = null): StreamedResponse
  288.     {
  289.         if (!$this->container->has('twig')) {
  290.             throw new \LogicException('You cannot use the "stream" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  291.         }
  293.         $twig = $this->container->get('twig');
  295.         $callback = function () use ($twig, $view, $parameters) {
  296.             $twig->display($view, $parameters);
  297.         };
  299.         if (null === $response) {
  300.             return new StreamedResponse($callback);
  301.         }
  303.         $response->setCallback($callback);
  305.         return $response;
  306.     }
  308.     /**
  309.      * Returns a NotFoundHttpException.
  310.      *
  311.      * This will result in a 404 response code. Usage example:
  312.      *
  313.      *     throw $this->createNotFoundException('Page not found!');
  314.      */
  315.     protected function createNotFoundException(string $message = 'Not Found', \Throwable $previous = null): NotFoundHttpException
  316.     {
  317.         return new NotFoundHttpException($message, $previous);
  318.     }
  320.     /**
  321.      * Returns an AccessDeniedException.
  322.      *
  323.      * This will result in a 403 response code. Usage example:
  324.      *
  325.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  326.      *
  327.      * @throws \LogicException If the Security component is not available
  328.      */
  329.     protected function createAccessDeniedException(string $message = 'Access Denied.', \Throwable $previous = null): AccessDeniedException
  330.     {
  331.         if (!class_exists(AccessDeniedException::class)) {
  332.             throw new \LogicException('You cannot use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  333.         }
  335.         return new AccessDeniedException($message, $previous);
  336.     }
  338.     /**
  339.      * Creates and returns a Form instance from the type of the form.
  340.      */
  341.     protected function createForm(string $type, mixed $data = null, array $options = []): FormInterface
  342.     {
  343.         return $this->container->get('form.factory')->create($type, $data, $options);
  344.     }
  346.     /**
  347.      * Creates and returns a form builder instance.
  348.      */
  349.     protected function createFormBuilder(mixed $data = null, array $options = []): FormBuilderInterface
  350.     {
  351.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  352.     }
  354.     /**
  355.      * Get a user from the Security Token Storage.
  356.      *
  357.      * @throws \LogicException If SecurityBundle is not available
  358.      *
  359.      * @see TokenInterface::getUser()
  360.      */
  361.     protected function getUser(): ?UserInterface
  362.     {
  363.         if (!$this->container->has('security.token_storage')) {
  364.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  365.         }
  367.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  368.             return null;
  369.         }
  371.         return $token->getUser();
  372.     }
  374.     /**
  375.      * Checks the validity of a CSRF token.
  376.      *
  377.      * @param string      $id    The id used when generating the token
  378.      * @param string|null $token The actual token sent with the request that should be validated
  379.      */
  380.     protected function isCsrfTokenValid(string $id, #[\SensitiveParameter] ?string $token): bool
  381.     {
  382.         if (!$this->container->has('security.csrf.token_manager')) {
  383.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  384.         }
  386.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  387.     }
  389.     /**
  390.      * Adds a Link HTTP header to the current response.
  391.      *
  392.      * @see https://tools.ietf.org/html/rfc5988
  393.      */
  394.     protected function addLink(Request $request, LinkInterface $link): void
  395.     {
  396.         if (!class_exists(AddLinkHeaderListener::class)) {
  397.             throw new \LogicException('You cannot use the "addLink" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  398.         }
  400.         if (null === $linkProvider = $request->attributes->get('_links')) {
  401.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  403.             return;
  404.         }
  406.         $request->attributes->set('_links', $linkProvider->withLink($link));
  407.     }
  408. }