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

Open in your IDE?
  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\Form\FormView;
  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\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.     protected function redirect(string $url, int $status = 302): RedirectResponse
  129.     {
  130.         return new RedirectResponse($url, $status);
  131.     }
  133.     /**
  134.      * Returns a RedirectResponse to the given route with the given parameters.
  135.      */
  136.     protected function redirectToRoute(string $route, array $parameters = [], int $status = 302): RedirectResponse
  137.     {
  138.         return $this->redirect($this->generateUrl($route, $parameters), $status);
  139.     }
  141.     /**
  142.      * Returns a JsonResponse that uses the serializer component if enabled, or json_encode.
  143.      */
  144.     protected function json(mixed $data, int $status = 200, array $headers = [], array $context = []): JsonResponse
  145.     {
  146.         if ($this->container->has('serializer')) {
  147.             $json = $this->container->get('serializer')->serialize($data, 'json', array_merge([
  148.                 'json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS,
  149.             ], $context));
  151.             return new JsonResponse($json, $status, $headers, true);
  152.         }
  154.         return new JsonResponse($data, $status, $headers);
  155.     }
  157.     /**
  158.      * Returns a BinaryFileResponse object with original or customized file name and disposition header.
  159.      */
  160.     protected function file(\SplFileInfo|string $file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT): BinaryFileResponse
  161.     {
  162.         $response = new BinaryFileResponse($file);
  163.         $response->setContentDisposition($disposition, null === $fileName ? $response->getFile()->getFilename() : $fileName);
  165.         return $response;
  166.     }
  168.     /**
  169.      * Adds a flash message to the current session for type.
  170.      *
  171.      * @throws \LogicException
  172.      */
  173.     protected function addFlash(string $type, mixed $message): void
  174.     {
  175.         try {
  176.             $this->container->get('request_stack')->getSession()->getFlashBag()->add($type, $message);
  177.         } catch (SessionNotFoundException $e) {
  178.             throw new \LogicException('You cannot use the addFlash method if sessions are disabled. Enable them in "config/packages/framework.yaml".', 0, $e);
  179.         }
  180.     }
  182.     /**
  183.      * Checks if the attribute is granted against the current authentication token and optionally supplied subject.
  184.      *
  185.      * @throws \LogicException
  186.      */
  187.     protected function isGranted(mixed $attribute, mixed $subject = null): bool
  188.     {
  189.         if (!$this->container->has('security.authorization_checker')) {
  190.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  191.         }
  193.         return $this->container->get('security.authorization_checker')->isGranted($attribute, $subject);
  194.     }
  196.     /**
  197.      * Throws an exception unless the attribute is granted against the current authentication token and optionally
  198.      * supplied subject.
  199.      *
  200.      * @throws AccessDeniedException
  201.      */
  202.     protected function denyAccessUnlessGranted(mixed $attribute, mixed $subject = null, string $message = 'Access Denied.'): void
  203.     {
  204.         if (!$this->isGranted($attribute, $subject)) {
  205.             $exception = $this->createAccessDeniedException($message);
  206.             $exception->setAttributes($attribute);
  207.             $exception->setSubject($subject);
  209.             throw $exception;
  210.         }
  211.     }
  213.     /**
  214.      * Returns a rendered view.
  215.      */
  216.     protected function renderView(string $view, array $parameters = []): string
  217.     {
  218.         if (!$this->container->has('twig')) {
  219.             throw new \LogicException('You cannot use the "renderView" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  220.         }
  222.         return $this->container->get('twig')->render($view, $parameters);
  223.     }
  225.     /**
  226.      * Renders a view.
  227.      */
  228.     protected function render(string $view, array $parameters = [], Response $response = null): Response
  229.     {
  230.         $content = $this->renderView($view, $parameters);
  232.         if (null === $response) {
  233.             $response = new Response();
  234.         }
  236.         $response->setContent($content);
  238.         return $response;
  239.     }
  241.     /**
  242.      * Renders a view and sets the appropriate status code when a form is listed in parameters.
  243.      *
  244.      * If an invalid form is found in the list of parameters, a 422 status code is returned.
  245.      */
  246.     protected function renderForm(string $view, array $parameters = [], Response $response = null): Response
  247.     {
  248.         if (null === $response) {
  249.             $response = new Response();
  250.         }
  252.         foreach ($parameters as $k => $v) {
  253.             if ($v instanceof FormView) {
  254.                 throw new \LogicException(sprintf('Passing a FormView to "%s::renderForm()" is not supported, pass directly the form instead for parameter "%s".', get_debug_type($this), $k));
  255.             }
  257.             if (!$v instanceof FormInterface) {
  258.                 continue;
  259.             }
  261.             $parameters[$k] = $v->createView();
  263.             if (200 === $response->getStatusCode() && $v->isSubmitted() && !$v->isValid()) {
  264.                 $response->setStatusCode(422);
  265.             }
  266.         }
  268.         return $this->render($view, $parameters, $response);
  269.     }
  271.     /**
  272.      * Streams a view.
  273.      */
  274.     protected function stream(string $view, array $parameters = [], StreamedResponse $response = null): StreamedResponse
  275.     {
  276.         if (!$this->container->has('twig')) {
  277.             throw new \LogicException('You cannot use the "stream" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  278.         }
  280.         $twig = $this->container->get('twig');
  282.         $callback = function () use ($twig, $view, $parameters) {
  283.             $twig->display($view, $parameters);
  284.         };
  286.         if (null === $response) {
  287.             return new StreamedResponse($callback);
  288.         }
  290.         $response->setCallback($callback);
  292.         return $response;
  293.     }
  295.     /**
  296.      * Returns a NotFoundHttpException.
  297.      *
  298.      * This will result in a 404 response code. Usage example:
  299.      *
  300.      *     throw $this->createNotFoundException('Page not found!');
  301.      */
  302.     protected function createNotFoundException(string $message = 'Not Found', \Throwable $previous = null): NotFoundHttpException
  303.     {
  304.         return new NotFoundHttpException($message, $previous);
  305.     }
  307.     /**
  308.      * Returns an AccessDeniedException.
  309.      *
  310.      * This will result in a 403 response code. Usage example:
  311.      *
  312.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  313.      *
  314.      * @throws \LogicException If the Security component is not available
  315.      */
  316.     protected function createAccessDeniedException(string $message = 'Access Denied.', \Throwable $previous = null): AccessDeniedException
  317.     {
  318.         if (!class_exists(AccessDeniedException::class)) {
  319.             throw new \LogicException('You cannot use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  320.         }
  322.         return new AccessDeniedException($message, $previous);
  323.     }
  325.     /**
  326.      * Creates and returns a Form instance from the type of the form.
  327.      */
  328.     protected function createForm(string $type, mixed $data = null, array $options = []): FormInterface
  329.     {
  330.         return $this->container->get('form.factory')->create($type, $data, $options);
  331.     }
  333.     /**
  334.      * Creates and returns a form builder instance.
  335.      */
  336.     protected function createFormBuilder(mixed $data = null, array $options = []): FormBuilderInterface
  337.     {
  338.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  339.     }
  341.     /**
  342.      * Get a user from the Security Token Storage.
  343.      *
  344.      * @throws \LogicException If SecurityBundle is not available
  345.      *
  346.      * @see TokenInterface::getUser()
  347.      */
  348.     protected function getUser(): ?UserInterface
  349.     {
  350.         if (!$this->container->has('security.token_storage')) {
  351.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  352.         }
  354.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  355.             return null;
  356.         }
  358.         return $token->getUser();
  359.     }
  361.     /**
  362.      * Checks the validity of a CSRF token.
  363.      *
  364.      * @param string      $id    The id used when generating the token
  365.      * @param string|null $token The actual token sent with the request that should be validated
  366.      */
  367.     protected function isCsrfTokenValid(string $id, ?string $token): bool
  368.     {
  369.         if (!$this->container->has('security.csrf.token_manager')) {
  370.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  371.         }
  373.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  374.     }
  376.     /**
  377.      * Adds a Link HTTP header to the current response.
  378.      *
  379.      * @see https://tools.ietf.org/html/rfc5988
  380.      */
  381.     protected function addLink(Request $request, LinkInterface $link): void
  382.     {
  383.         if (!class_exists(AddLinkHeaderListener::class)) {
  384.             throw new \LogicException('You cannot use the "addLink" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  385.         }
  387.         if (null === $linkProvider = $request->attributes->get('_links')) {
  388.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  390.             return;
  391.         }
  393.         $request->attributes->set('_links', $linkProvider->withLink($link));
  394.     }
  395. }