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

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\ServiceSubscriberInterface;
  46. use Twig\Environment;
  48. /**
  49.  * Provides shortcuts for HTTP-related features in controllers.
  50.  *
  51.  * @author Fabien Potencier <fabien@symfony.com>
  52.  */
  53. abstract class AbstractController implements ServiceSubscriberInterface
  54. {
  55.     /**
  56.      * @var ContainerInterface
  57.      */
  58.     protected $container;
  60.     /**
  61.      * @required
  62.      */
  63.     public function setContainer(ContainerInterface $container): ?ContainerInterface
  64.     {
  65.         $previous = $this->container;
  66.         $this->container = $container;
  68.         return $previous;
  69.     }
  71.     /**
  72.      * Gets a container parameter by its name.
  73.      */
  74.     protected function getParameter(string $name): array|bool|string|int|float|\UnitEnum|null
  75.     {
  76.         if (!$this->container->has('parameter_bag')) {
  77.             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));
  78.         }
  80.         return $this->container->get('parameter_bag')->get($name);
  81.     }
  83.     public static function getSubscribedServices(): array
  84.     {
  85.         return [
  86.             'router' => '?'.RouterInterface::class,
  87.             'request_stack' => '?'.RequestStack::class,
  88.             'http_kernel' => '?'.HttpKernelInterface::class,
  89.             'serializer' => '?'.SerializerInterface::class,
  90.             'security.authorization_checker' => '?'.AuthorizationCheckerInterface::class,
  91.             'twig' => '?'.Environment::class,
  92.             'form.factory' => '?'.FormFactoryInterface::class,
  93.             'security.token_storage' => '?'.TokenStorageInterface::class,
  94.             'security.csrf.token_manager' => '?'.CsrfTokenManagerInterface::class,
  95.             'parameter_bag' => '?'.ContainerBagInterface::class,
  96.         ];
  97.     }
  99.     /**
  100.      * Generates a URL from the given parameters.
  101.      *
  102.      * @see UrlGeneratorInterface
  103.      */
  104.     protected function generateUrl(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
  105.     {
  106.         return $this->container->get('router')->generate($route, $parameters, $referenceType);
  107.     }
  109.     /**
  110.      * Forwards the request to another controller.
  111.      *
  112.      * @param string $controller The controller name (a string like Bundle\BlogBundle\Controller\PostController::indexAction)
  113.      */
  114.     protected function forward(string $controller, array $path = [], array $query = []): Response
  115.     {
  116.         $request = $this->container->get('request_stack')->getCurrentRequest();
  117.         $path['_controller'] = $controller;
  118.         $subRequest = $request->duplicate($query, null, $path);
  120.         return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
  121.     }
  123.     /**
  124.      * Returns a RedirectResponse to the given URL.
  125.      */
  126.     protected function redirect(string $url, int $status = 302): RedirectResponse
  127.     {
  128.         return new RedirectResponse($url, $status);
  129.     }
  131.     /**
  132.      * Returns a RedirectResponse to the given route with the given parameters.
  133.      */
  134.     protected function redirectToRoute(string $route, array $parameters = [], int $status = 302): RedirectResponse
  135.     {
  136.         return $this->redirect($this->generateUrl($route, $parameters), $status);
  137.     }
  139.     /**
  140.      * Returns a JsonResponse that uses the serializer component if enabled, or json_encode.
  141.      */
  142.     protected function json(mixed $data, int $status = 200, array $headers = [], array $context = []): JsonResponse
  143.     {
  144.         if ($this->container->has('serializer')) {
  145.             $json = $this->container->get('serializer')->serialize($data, 'json', array_merge([
  146.                 'json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS,
  147.             ], $context));
  149.             return new JsonResponse($json, $status, $headers, true);
  150.         }
  152.         return new JsonResponse($data, $status, $headers);
  153.     }
  155.     /**
  156.      * Returns a BinaryFileResponse object with original or customized file name and disposition header.
  157.      */
  158.     protected function file(\SplFileInfo|string $file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT): BinaryFileResponse
  159.     {
  160.         $response = new BinaryFileResponse($file);
  161.         $response->setContentDisposition($disposition, null === $fileName ? $response->getFile()->getFilename() : $fileName);
  163.         return $response;
  164.     }
  166.     /**
  167.      * Adds a flash message to the current session for type.
  168.      *
  169.      * @throws \LogicException
  170.      */
  171.     protected function addFlash(string $type, mixed $message): void
  172.     {
  173.         try {
  174.             $this->container->get('request_stack')->getSession()->getFlashBag()->add($type, $message);
  175.         } catch (SessionNotFoundException $e) {
  176.             throw new \LogicException('You cannot use the addFlash method if sessions are disabled. Enable them in "config/packages/framework.yaml".', 0, $e);
  177.         }
  178.     }
  180.     /**
  181.      * Checks if the attribute is granted against the current authentication token and optionally supplied subject.
  182.      *
  183.      * @throws \LogicException
  184.      */
  185.     protected function isGranted(mixed $attribute, mixed $subject = null): bool
  186.     {
  187.         if (!$this->container->has('security.authorization_checker')) {
  188.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  189.         }
  191.         return $this->container->get('security.authorization_checker')->isGranted($attribute, $subject);
  192.     }
  194.     /**
  195.      * Throws an exception unless the attribute is granted against the current authentication token and optionally
  196.      * supplied subject.
  197.      *
  198.      * @throws AccessDeniedException
  199.      */
  200.     protected function denyAccessUnlessGranted(mixed $attribute, mixed $subject = null, string $message = 'Access Denied.'): void
  201.     {
  202.         if (!$this->isGranted($attribute, $subject)) {
  203.             $exception = $this->createAccessDeniedException($message);
  204.             $exception->setAttributes($attribute);
  205.             $exception->setSubject($subject);
  207.             throw $exception;
  208.         }
  209.     }
  211.     /**
  212.      * Returns a rendered view.
  213.      */
  214.     protected function renderView(string $view, array $parameters = []): string
  215.     {
  216.         if (!$this->container->has('twig')) {
  217.             throw new \LogicException('You cannot use the "renderView" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  218.         }
  220.         return $this->container->get('twig')->render($view, $parameters);
  221.     }
  223.     /**
  224.      * Renders a view.
  225.      */
  226.     protected function render(string $view, array $parameters = [], Response $response = null): Response
  227.     {
  228.         $content = $this->renderView($view, $parameters);
  230.         if (null === $response) {
  231.             $response = new Response();
  232.         }
  234.         $response->setContent($content);
  236.         return $response;
  237.     }
  239.     /**
  240.      * Renders a view and sets the appropriate status code when a form is listed in parameters.
  241.      *
  242.      * If an invalid form is found in the list of parameters, a 422 status code is returned.
  243.      */
  244.     protected function renderForm(string $view, array $parameters = [], Response $response = null): Response
  245.     {
  246.         if (null === $response) {
  247.             $response = new Response();
  248.         }
  250.         foreach ($parameters as $k => $v) {
  251.             if ($v instanceof FormView) {
  252.                 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));
  253.             }
  255.             if (!$v instanceof FormInterface) {
  256.                 continue;
  257.             }
  259.             $parameters[$k] = $v->createView();
  261.             if (200 === $response->getStatusCode() && $v->isSubmitted() && !$v->isValid()) {
  262.                 $response->setStatusCode(422);
  263.             }
  264.         }
  266.         return $this->render($view, $parameters, $response);
  267.     }
  269.     /**
  270.      * Streams a view.
  271.      */
  272.     protected function stream(string $view, array $parameters = [], StreamedResponse $response = null): StreamedResponse
  273.     {
  274.         if (!$this->container->has('twig')) {
  275.             throw new \LogicException('You cannot use the "stream" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
  276.         }
  278.         $twig = $this->container->get('twig');
  280.         $callback = function () use ($twig, $view, $parameters) {
  281.             $twig->display($view, $parameters);
  282.         };
  284.         if (null === $response) {
  285.             return new StreamedResponse($callback);
  286.         }
  288.         $response->setCallback($callback);
  290.         return $response;
  291.     }
  293.     /**
  294.      * Returns a NotFoundHttpException.
  295.      *
  296.      * This will result in a 404 response code. Usage example:
  297.      *
  298.      *     throw $this->createNotFoundException('Page not found!');
  299.      */
  300.     protected function createNotFoundException(string $message = 'Not Found', \Throwable $previous = null): NotFoundHttpException
  301.     {
  302.         return new NotFoundHttpException($message, $previous);
  303.     }
  305.     /**
  306.      * Returns an AccessDeniedException.
  307.      *
  308.      * This will result in a 403 response code. Usage example:
  309.      *
  310.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  311.      *
  312.      * @throws \LogicException If the Security component is not available
  313.      */
  314.     protected function createAccessDeniedException(string $message = 'Access Denied.', \Throwable $previous = null): AccessDeniedException
  315.     {
  316.         if (!class_exists(AccessDeniedException::class)) {
  317.             throw new \LogicException('You cannot use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  318.         }
  320.         return new AccessDeniedException($message, $previous);
  321.     }
  323.     /**
  324.      * Creates and returns a Form instance from the type of the form.
  325.      */
  326.     protected function createForm(string $type, mixed $data = null, array $options = []): FormInterface
  327.     {
  328.         return $this->container->get('form.factory')->create($type, $data, $options);
  329.     }
  331.     /**
  332.      * Creates and returns a form builder instance.
  333.      */
  334.     protected function createFormBuilder(mixed $data = null, array $options = []): FormBuilderInterface
  335.     {
  336.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  337.     }
  339.     /**
  340.      * Get a user from the Security Token Storage.
  341.      *
  342.      * @throws \LogicException If SecurityBundle is not available
  343.      *
  344.      * @see TokenInterface::getUser()
  345.      */
  346.     protected function getUser(): ?UserInterface
  347.     {
  348.         if (!$this->container->has('security.token_storage')) {
  349.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  350.         }
  352.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  353.             return null;
  354.         }
  356.         return $token->getUser();
  357.     }
  359.     /**
  360.      * Checks the validity of a CSRF token.
  361.      *
  362.      * @param string      $id    The id used when generating the token
  363.      * @param string|null $token The actual token sent with the request that should be validated
  364.      */
  365.     protected function isCsrfTokenValid(string $id, ?string $token): bool
  366.     {
  367.         if (!$this->container->has('security.csrf.token_manager')) {
  368.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  369.         }
  371.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  372.     }
  374.     /**
  375.      * Adds a Link HTTP header to the current response.
  376.      *
  377.      * @see https://tools.ietf.org/html/rfc5988
  378.      */
  379.     protected function addLink(Request $request, LinkInterface $link): void
  380.     {
  381.         if (!class_exists(AddLinkHeaderListener::class)) {
  382.             throw new \LogicException('You cannot use the "addLink" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  383.         }
  385.         if (null === $linkProvider = $request->attributes->get('_links')) {
  386.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  388.             return;
  389.         }
  391.         $request->attributes->set('_links', $linkProvider->withLink($link));
  392.     }
  393. }