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

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