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

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