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

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