vendor/symfony/http-kernel/EventListener/RouterListener.php line 128

  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\Component\HttpKernel\EventListener;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\HttpFoundation\Response;
  19. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  20. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  21. use Symfony\Component\HttpKernel\Event\RequestEvent;
  22. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  23. use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
  24. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  25. use Symfony\Component\HttpKernel\Kernel;
  26. use Symfony\Component\HttpKernel\KernelEvents;
  27. use Symfony\Component\Routing\Exception\MethodNotAllowedException;
  28. use Symfony\Component\Routing\Exception\NoConfigurationException;
  29. use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  30. use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
  31. use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
  32. use Symfony\Component\Routing\RequestContext;
  33. use Symfony\Component\Routing\RequestContextAwareInterface;
  35. /**
  36.  * Initializes the context from the request and sets request attributes based on a matching route.
  37.  *
  38.  * @author Fabien Potencier <fabien@symfony.com>
  39.  * @author Yonel Ceruto <yonelceruto@gmail.com>
  40.  *
  41.  * @final
  42.  */
  43. class RouterListener implements EventSubscriberInterface
  44. {
  45.     private RequestMatcherInterface|UrlMatcherInterface $matcher;
  46.     private RequestContext $context;
  47.     private ?LoggerInterface $logger;
  48.     private RequestStack $requestStack;
  49.     private ?string $projectDir;
  50.     private bool $debug;
  52.     /**
  53.      * @param RequestContext|null $context The RequestContext (can be null when $matcher implements RequestContextAwareInterface)
  54.      *
  55.      * @throws \InvalidArgumentException
  56.      */
  57.     public function __construct(UrlMatcherInterface|RequestMatcherInterface $matcher, RequestStack $requestStack, RequestContext $context = null, LoggerInterface $logger = null, string $projectDir = null, bool $debug = true)
  58.     {
  59.         if (null === $context && !$matcher instanceof RequestContextAwareInterface) {
  60.             throw new \InvalidArgumentException('You must either pass a RequestContext or the matcher must implement RequestContextAwareInterface.');
  61.         }
  63.         $this->matcher = $matcher;
  64.         $this->context = $context ?? $matcher->getContext();
  65.         $this->requestStack = $requestStack;
  66.         $this->logger = $logger;
  67.         $this->projectDir = $projectDir;
  68.         $this->debug = $debug;
  69.     }
  71.     private function setCurrentRequest(?Request $request)
  72.     {
  73.         if (null !== $request) {
  74.             try {
  75.                 $this->context->fromRequest($request);
  76.             } catch (\UnexpectedValueException $e) {
  77.                 throw new BadRequestHttpException($e->getMessage(), $e, $e->getCode());
  78.             }
  79.         }
  80.     }
  82.     /**
  83.      * After a sub-request is done, we need to reset the routing context to the parent request so that the URL generator
  84.      * operates on the correct context again.
  85.      */
  86.     public function onKernelFinishRequest()
  87.     {
  88.         $this->setCurrentRequest($this->requestStack->getParentRequest());
  89.     }
  91.     public function onKernelRequest(RequestEvent $event)
  92.     {
  93.         $request = $event->getRequest();
  95.         $this->setCurrentRequest($request);
  97.         if ($request->attributes->has('_controller')) {
  98.             // routing is already done
  99.             return;
  100.         }
  102.         // add attributes based on the request (routing)
  103.         try {
  104.             // matching a request is more powerful than matching a URL path + context, so try that first
  105.             if ($this->matcher instanceof RequestMatcherInterface) {
  106.                 $parameters = $this->matcher->matchRequest($request);
  107.             } else {
  108.                 $parameters = $this->matcher->match($request->getPathInfo());
  109.             }
  111.             $this->logger?->info('Matched route "{route}".', [
  112.                 'route' => $parameters['_route'] ?? 'n/a',
  113.                 'route_parameters' => $parameters,
  114.                 'request_uri' => $request->getUri(),
  115.                 'method' => $request->getMethod(),
  116.             ]);
  118.             $request->attributes->add($parameters);
  119.             unset($parameters['_route'], $parameters['_controller']);
  120.             $request->attributes->set('_route_params', $parameters);
  121.         } catch (ResourceNotFoundException $e) {
  122.             $message = sprintf('No route found for "%s %s"', $request->getMethod(), $request->getUriForPath($request->getPathInfo()));
  124.             if ($referer = $request->headers->get('referer')) {
  125.                 $message .= sprintf(' (from "%s")', $referer);
  126.             }
  128.             throw new NotFoundHttpException($message, $e);
  129.         } catch (MethodNotAllowedException $e) {
  130.             $message = sprintf('No route found for "%s %s": Method Not Allowed (Allow: %s)', $request->getMethod(), $request->getUriForPath($request->getPathInfo()), implode(', ', $e->getAllowedMethods()));
  132.             throw new MethodNotAllowedHttpException($e->getAllowedMethods(), $message, $e);
  133.         }
  134.     }
  136.     public function onKernelException(ExceptionEvent $event)
  137.     {
  138.         if (!$this->debug || !($e = $event->getThrowable()) instanceof NotFoundHttpException) {
  139.             return;
  140.         }
  142.         if ($e->getPrevious() instanceof NoConfigurationException) {
  143.             $event->setResponse($this->createWelcomeResponse());
  144.         }
  145.     }
  147.     public static function getSubscribedEvents(): array
  148.     {
  149.         return [
  150.             KernelEvents::REQUEST => [['onKernelRequest', 32]],
  151.             KernelEvents::FINISH_REQUEST => [['onKernelFinishRequest', 0]],
  152.             KernelEvents::EXCEPTION => ['onKernelException', -64],
  153.         ];
  154.     }
  156.     private function createWelcomeResponse(): Response
  157.     {
  158.         $version = Kernel::VERSION;
  159.         $projectDir = realpath((string) $this->projectDir).\DIRECTORY_SEPARATOR;
  160.         $docVersion = substr(Kernel::VERSION, 0, 3);
  162.         ob_start();
  163.         include \dirname(__DIR__).'/Resources/welcome.html.php';
  165.         return new Response(ob_get_clean(), Response::HTTP_NOT_FOUND);
  166.     }
  167. }