vendor/symfony/symfony/src/Symfony/Component/HttpKernel/HttpKernel.php line 184

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\Component\HttpKernel;
  14. use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
  19. use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
  20. use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
  21. use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
  22. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  23. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  24. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  25. use Symfony\Component\HttpKernel\Event\RequestEvent;
  26. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  27. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  28. use Symfony\Component\HttpKernel\Event\ViewEvent;
  29. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  30. use Symfony\Component\HttpKernel\Exception\ControllerDoesNotReturnResponseException;
  31. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  32. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  33. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  35. // Help opcache.preload discover always-needed symbols
  36. class_exists(ControllerArgumentsEvent::class);
  37. class_exists(ControllerEvent::class);
  38. class_exists(ExceptionEvent::class);
  39. class_exists(FinishRequestEvent::class);
  40. class_exists(RequestEvent::class);
  41. class_exists(ResponseEvent::class);
  42. class_exists(TerminateEvent::class);
  43. class_exists(ViewEvent::class);
  44. class_exists(KernelEvents::class);
  46. /**
  47.  * HttpKernel notifies events to convert a Request object to a Response one.
  48.  *
  49.  * @author Fabien Potencier <fabien@symfony.com>
  50.  */
  51. class HttpKernel implements HttpKernelInterface, TerminableInterface
  52. {
  53.     protected $dispatcher;
  54.     protected $resolver;
  55.     protected $requestStack;
  56.     private $argumentResolver;
  58.     public function __construct(EventDispatcherInterface $dispatcher, ControllerResolverInterface $resolver, ?RequestStack $requestStack = null, ?ArgumentResolverInterface $argumentResolver = null)
  59.     {
  60.         $this->dispatcher = $dispatcher;
  61.         $this->resolver = $resolver;
  62.         $this->requestStack = $requestStack ?? new RequestStack();
  63.         $this->argumentResolver = $argumentResolver ?? new ArgumentResolver();
  64.     }
  66.     /**
  67.      * {@inheritdoc}
  68.      */
  69.     public function handle(Request $request, int $type = HttpKernelInterface::MAIN_REQUEST, bool $catch = true)
  70.     {
  71.         $request->headers->set('X-Php-Ob-Level', (string) ob_get_level());
  73.         $this->requestStack->push($request);
  74.         try {
  75.             return $this->handleRaw($request, $type);
  76.         } catch (\Exception $e) {
  77.             if ($e instanceof RequestExceptionInterface) {
  78.                 $e = new BadRequestHttpException($e->getMessage(), $e);
  79.             }
  80.             if (false === $catch) {
  81.                 $this->finishRequest($request, $type);
  83.                 throw $e;
  84.             }
  86.             return $this->handleThrowable($e, $request, $type);
  87.         } finally {
  88.             $this->requestStack->pop();
  89.         }
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function terminate(Request $request, Response $response)
  96.     {
  97.         $this->dispatcher->dispatch(new TerminateEvent($this, $request, $response), KernelEvents::TERMINATE);
  98.     }
  100.     /**
  101.      * @internal
  102.      */
  103.     public function terminateWithException(\Throwable $exception, ?Request $request = null)
  104.     {
  105.         if (!$request = $request ?: $this->requestStack->getMainRequest()) {
  106.             throw $exception;
  107.         }
  109.         if ($pop = $request !== $this->requestStack->getMainRequest()) {
  110.             $this->requestStack->push($request);
  111.         }
  113.         try {
  114.             $response = $this->handleThrowable($exception, $request, self::MAIN_REQUEST);
  115.         } finally {
  116.             if ($pop) {
  117.                 $this->requestStack->pop();
  118.             }
  119.         }
  121.         $response->sendHeaders();
  122.         $response->sendContent();
  124.         $this->terminate($request, $response);
  125.     }
  127.     /**
  128.      * Handles a request to convert it to a response.
  129.      *
  130.      * Exceptions are not caught.
  131.      *
  132.      * @throws \LogicException       If one of the listener does not behave as expected
  133.      * @throws NotFoundHttpException When controller cannot be found
  134.      */
  135.     private function handleRaw(Request $request, int $type = self::MAIN_REQUEST): Response
  136.     {
  137.         // request
  138.         $event = new RequestEvent($this, $request, $type);
  139.         $this->dispatcher->dispatch($event, KernelEvents::REQUEST);
  141.         if ($event->hasResponse()) {
  142.             return $this->filterResponse($event->getResponse(), $request, $type);
  143.         }
  145.         // load controller
  146.         if (false === $controller = $this->resolver->getController($request)) {
  147.             throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s". The route is wrongly configured.', $request->getPathInfo()));
  148.         }
  150.         $event = new ControllerEvent($this, $controller, $request, $type);
  151.         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER);
  152.         $controller = $event->getController();
  154.         // controller arguments
  155.         $arguments = $this->argumentResolver->getArguments($request, $controller);
  157.         $event = new ControllerArgumentsEvent($this, $controller, $arguments, $request, $type);
  158.         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER_ARGUMENTS);
  159.         $controller = $event->getController();
  160.         $arguments = $event->getArguments();
  162.         // call controller
  163.         $response = $controller(...$arguments);
  165.         // view
  166.         if (!$response instanceof Response) {
  167.             $event = new ViewEvent($this, $request, $type, $response);
  168.             $this->dispatcher->dispatch($event, KernelEvents::VIEW);
  170.             if ($event->hasResponse()) {
  171.                 $response = $event->getResponse();
  172.             } else {
  173.                 $msg = sprintf('The controller must return a "Symfony\Component\HttpFoundation\Response" object but it returned %s.', $this->varToString($response));
  175.                 // the user may have forgotten to return something
  176.                 if (null === $response) {
  177.                     $msg .= ' Did you forget to add a return statement somewhere in your controller?';
  178.                 }
  180.                 throw new ControllerDoesNotReturnResponseException($msg, $controller, __FILE__, __LINE__ - 17);
  181.             }
  182.         }
  184.         return $this->filterResponse($response, $request, $type);
  185.     }
  187.     /**
  188.      * Filters a response object.
  189.      *
  190.      * @throws \RuntimeException if the passed object is not a Response instance
  191.      */
  192.     private function filterResponse(Response $response, Request $request, int $type): Response
  193.     {
  194.         $event = new ResponseEvent($this, $request, $type, $response);
  196.         $this->dispatcher->dispatch($event, KernelEvents::RESPONSE);
  198.         $this->finishRequest($request, $type);
  200.         return $event->getResponse();
  201.     }
  203.     /**
  204.      * Publishes the finish request event, then pop the request from the stack.
  205.      *
  206.      * Note that the order of the operations is important here, otherwise
  207.      * operations such as {@link RequestStack::getParentRequest()} can lead to
  208.      * weird results.
  209.      */
  210.     private function finishRequest(Request $request, int $type)
  211.     {
  212.         $this->dispatcher->dispatch(new FinishRequestEvent($this, $request, $type), KernelEvents::FINISH_REQUEST);
  213.     }
  215.     /**
  216.      * Handles a throwable by trying to convert it to a Response.
  217.      *
  218.      * @throws \Exception
  219.      */
  220.     private function handleThrowable(\Throwable $e, Request $request, int $type): Response
  221.     {
  222.         $event = new ExceptionEvent($this, $request, $type, $e);
  223.         $this->dispatcher->dispatch($event, KernelEvents::EXCEPTION);
  225.         // a listener might have replaced the exception
  226.         $e = $event->getThrowable();
  228.         if (!$event->hasResponse()) {
  229.             $this->finishRequest($request, $type);
  231.             throw $e;
  232.         }
  234.         $response = $event->getResponse();
  236.         // the developer asked for a specific status code
  237.         if (!$event->isAllowingCustomResponseCode() && !$response->isClientError() && !$response->isServerError() && !$response->isRedirect()) {
  238.             // ensure that we actually have an error response
  239.             if ($e instanceof HttpExceptionInterface) {
  240.                 // keep the HTTP status code and headers
  241.                 $response->setStatusCode($e->getStatusCode());
  242.                 $response->headers->add($e->getHeaders());
  243.             } else {
  244.                 $response->setStatusCode(500);
  245.             }
  246.         }
  248.         try {
  249.             return $this->filterResponse($response, $request, $type);
  250.         } catch (\Exception $e) {
  251.             return $response;
  252.         }
  253.     }
  255.     /**
  256.      * Returns a human-readable string for the specified variable.
  257.      */
  258.     private function varToString($var): string
  259.     {
  260.         if (\is_object($var)) {
  261.             return sprintf('an object of type %s', \get_class($var));
  262.         }
  264.         if (\is_array($var)) {
  265.             $a = [];
  266.             foreach ($var as $k => $v) {
  267.                 $a[] = sprintf('%s => ...', $k);
  268.             }
  270.             return sprintf('an array ([%s])', mb_substr(implode(', ', $a), 0, 255));
  271.         }
  273.         if (\is_resource($var)) {
  274.             return sprintf('a resource (%s)', get_resource_type($var));
  275.         }
  277.         if (null === $var) {
  278.             return 'null';
  279.         }
  281.         if (false === $var) {
  282.             return 'a boolean value (false)';
  283.         }
  285.         if (true === $var) {
  286.             return 'a boolean value (true)';
  287.         }
  289.         if (\is_string($var)) {
  290.             return sprintf('a string ("%s%s")', mb_substr($var, 0, 255), mb_strlen($var) > 255 ? '...' : '');
  291.         }
  293.         if (is_numeric($var)) {
  294.             return sprintf('a number (%s)', (string) $var);
  295.         }
  297.         return (string) $var;
  298.     }
  299. }