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

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