vendor/symfony/http-kernel/HttpKernel.php line 217

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;
  65.         if (null === $this->argumentResolver) {
  66.             $this->argumentResolver = new ArgumentResolver();
  67.         }
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      */
  73.     public function handle(Request $request, int $type = HttpKernelInterface::MAIN_REQUEST, bool $catch = true)
  74.     {
  75.         $request->headers->set('X-Php-Ob-Level', (string) ob_get_level());
  77.         try {
  78.             return $this->handleRaw($request, $type);
  79.         } catch (\Exception $e) {
  80.             if ($e instanceof RequestExceptionInterface) {
  81.                 $e = new BadRequestHttpException($e->getMessage(), $e);
  82.             }
  83.             if (false === $catch) {
  84.                 $this->finishRequest($request, $type);
  86.                 throw $e;
  87.             }
  89.             return $this->handleThrowable($e, $request, $type);
  90.         }
  91.     }
  93.     /**
  94.      * {@inheritdoc}
  95.      */
  96.     public function terminate(Request $request, Response $response)
  97.     {
  98.         $this->dispatcher->dispatch(new TerminateEvent($this, $request, $response), KernelEvents::TERMINATE);
  99.     }
  101.     /**
  102.      * @internal
  103.      */
  104.     public function terminateWithException(\Throwable $exception, Request $request = null)
  105.     {
  106.         if (!$request = $request ?: $this->requestStack->getMainRequest()) {
  107.             throw $exception;
  108.         }
  110.         $response = $this->handleThrowable($exception, $request, self::MAIN_REQUEST);
  112.         $response->sendHeaders();
  113.         $response->sendContent();
  115.         $this->terminate($request, $response);
  116.     }
  118.     /**
  119.      * Handles a request to convert it to a response.
  120.      *
  121.      * Exceptions are not caught.
  122.      *
  123.      * @throws \LogicException       If one of the listener does not behave as expected
  124.      * @throws NotFoundHttpException When controller cannot be found
  125.      */
  126.     private function handleRaw(Request $request, int $type = self::MAIN_REQUEST): Response
  127.     {
  128.         $this->requestStack->push($request);
  130.         // request
  131.         $event = new RequestEvent($this, $request, $type);
  132.         $this->dispatcher->dispatch($event, KernelEvents::REQUEST);
  134.         if ($event->hasResponse()) {
  135.             return $this->filterResponse($event->getResponse(), $request, $type);
  136.         }
  138.         // load controller
  139.         if (false === $controller = $this->resolver->getController($request)) {
  140.             throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s". The route is wrongly configured.', $request->getPathInfo()));
  141.         }
  143.         $event = new ControllerEvent($this, $controller, $request, $type);
  144.         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER);
  145.         $controller = $event->getController();
  147.         // controller arguments
  148.         $arguments = $this->argumentResolver->getArguments($request, $controller);
  150.         $event = new ControllerArgumentsEvent($this, $controller, $arguments, $request, $type);
  151.         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER_ARGUMENTS);
  152.         $controller = $event->getController();
  153.         $arguments = $event->getArguments();
  155.         // call controller
  156.         $response = $controller(...$arguments);
  158.         // view
  159.         if (!$response instanceof Response) {
  160.             $event = new ViewEvent($this, $request, $type, $response);
  161.             $this->dispatcher->dispatch($event, KernelEvents::VIEW);
  163.             if ($event->hasResponse()) {
  164.                 $response = $event->getResponse();
  165.             } else {
  166.                 $msg = sprintf('The controller must return a "Symfony\Component\HttpFoundation\Response" object but it returned %s.', $this->varToString($response));
  168.                 // the user may have forgotten to return something
  169.                 if (null === $response) {
  170.                     $msg .= ' Did you forget to add a return statement somewhere in your controller?';
  171.                 }
  173.                 throw new ControllerDoesNotReturnResponseException($msg, $controller, __FILE__, __LINE__ - 17);
  174.             }
  175.         }
  177.         return $this->filterResponse($response, $request, $type);
  178.     }
  180.     /**
  181.      * Filters a response object.
  182.      *
  183.      * @throws \RuntimeException if the passed object is not a Response instance
  184.      */
  185.     private function filterResponse(Response $response, Request $request, int $type): Response
  186.     {
  187.         $event = new ResponseEvent($this, $request, $type, $response);
  189.         $this->dispatcher->dispatch($event, KernelEvents::RESPONSE);
  191.         $this->finishRequest($request, $type);
  193.         return $event->getResponse();
  194.     }
  196.     /**
  197.      * Publishes the finish request event, then pop the request from the stack.
  198.      *
  199.      * Note that the order of the operations is important here, otherwise
  200.      * operations such as {@link RequestStack::getParentRequest()} can lead to
  201.      * weird results.
  202.      */
  203.     private function finishRequest(Request $request, int $type)
  204.     {
  205.         $this->dispatcher->dispatch(new FinishRequestEvent($this, $request, $type), KernelEvents::FINISH_REQUEST);
  206.         $this->requestStack->pop();
  207.     }
  209.     /**
  210.      * Handles a throwable by trying to convert it to a Response.
  211.      *
  212.      * @throws \Exception
  213.      */
  214.     private function handleThrowable(\Throwable $e, Request $request, int $type): Response
  215.     {
  216.         $event = new ExceptionEvent($this, $request, $type, $e);
  217.         $this->dispatcher->dispatch($event, KernelEvents::EXCEPTION);
  219.         // a listener might have replaced the exception
  220.         $e = $event->getThrowable();
  222.         if (!$event->hasResponse()) {
  223.             $this->finishRequest($request, $type);
  225.             throw $e;
  226.         }
  228.         $response = $event->getResponse();
  230.         // the developer asked for a specific status code
  231.         if (!$event->isAllowingCustomResponseCode() && !$response->isClientError() && !$response->isServerError() && !$response->isRedirect()) {
  232.             // ensure that we actually have an error response
  233.             if ($e instanceof HttpExceptionInterface) {
  234.                 // keep the HTTP status code and headers
  235.                 $response->setStatusCode($e->getStatusCode());
  236.                 $response->headers->add($e->getHeaders());
  237.             } else {
  238.                 $response->setStatusCode(500);
  239.             }
  240.         }
  242.         try {
  243.             return $this->filterResponse($response, $request, $type);
  244.         } catch (\Exception $e) {
  245.             return $response;
  246.         }
  247.     }
  249.     /**
  250.      * Returns a human-readable string for the specified variable.
  251.      */
  252.     private function varToString($var): string
  253.     {
  254.         if (\is_object($var)) {
  255.             return sprintf('an object of type %s', \get_class($var));
  256.         }
  258.         if (\is_array($var)) {
  259.             $a = [];
  260.             foreach ($var as $k => $v) {
  261.                 $a[] = sprintf('%s => ...', $k);
  262.             }
  264.             return sprintf('an array ([%s])', mb_substr(implode(', ', $a), 0, 255));
  265.         }
  267.         if (\is_resource($var)) {
  268.             return sprintf('a resource (%s)', get_resource_type($var));
  269.         }
  271.         if (null === $var) {
  272.             return 'null';
  273.         }
  275.         if (false === $var) {
  276.             return 'a boolean value (false)';
  277.         }
  279.         if (true === $var) {
  280.             return 'a boolean value (true)';
  281.         }
  283.         if (\is_string($var)) {
  284.             return sprintf('a string ("%s%s")', mb_substr($var, 0, 255), mb_strlen($var) > 255 ? '...' : '');
  285.         }
  287.         if (is_numeric($var)) {
  288.             return sprintf('a number (%s)', (string) $var);
  289.         }
  291.         return (string) $var;
  292.     }
  293. }