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

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(LegacyEventDispatcherProxy::class);
  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 $argumentResolver;
  59.     public function __construct(EventDispatcherInterface $dispatcher, ControllerResolverInterface $resolver, RequestStack $requestStack = null, ArgumentResolverInterface $argumentResolver = null)
  60.     {
  61.         $this->dispatcher = $dispatcher;
  62.         $this->resolver = $resolver;
  63.         $this->requestStack = $requestStack ?? new RequestStack();
  64.         $this->argumentResolver = $argumentResolver;
  66.         if (null === $this->argumentResolver) {
  67.             $this->argumentResolver = new ArgumentResolver();
  68.         }
  69.     }
  71.     /**
  72.      * {@inheritdoc}
  73.      */
  74.     public function handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true)
  75.     {
  76.         $request->headers->set('X-Php-Ob-Level', (string) ob_get_level());
  78.         try {
  79.             return $this->handleRaw($request, $type);
  80.         } catch (\Exception $e) {
  81.             if ($e instanceof RequestExceptionInterface) {
  82.                 $e = new BadRequestHttpException($e->getMessage(), $e);
  83.             }
  84.             if (false === $catch) {
  85.                 $this->finishRequest($request, $type);
  87.                 throw $e;
  88.             }
  90.             return $this->handleThrowable($e, $request, $type);
  91.         }
  92.     }
  94.     /**
  95.      * {@inheritdoc}
  96.      */
  97.     public function terminate(Request $request, Response $response)
  98.     {
  99.         $this->dispatcher->dispatch(new TerminateEvent($this, $request, $response), KernelEvents::TERMINATE);
  100.     }
  102.     /**
  103.      * @internal
  104.      */
  105.     public function terminateWithException(\Throwable $exception, Request $request = null)
  106.     {
  107.         if (!$request = $request ?: $this->requestStack->getMasterRequest()) {
  108.             throw $exception;
  109.         }
  111.         $response = $this->handleThrowable($exception, $request, self::MASTER_REQUEST);
  113.         $response->sendHeaders();
  114.         $response->sendContent();
  116.         $this->terminate($request, $response);
  117.     }
  119.     /**
  120.      * Handles a request to convert it to a response.
  121.      *
  122.      * Exceptions are not caught.
  123.      *
  124.      * @throws \LogicException       If one of the listener does not behave as expected
  125.      * @throws NotFoundHttpException When controller cannot be found
  126.      */
  127.     private function handleRaw(Request $request, int $type = self::MASTER_REQUEST): Response
  128.     {
  129.         $this->requestStack->push($request);
  131.         // request
  132.         $event = new RequestEvent($this, $request, $type);
  133.         $this->dispatcher->dispatch($event, KernelEvents::REQUEST);
  135.         if ($event->hasResponse()) {
  136.             return $this->filterResponse($event->getResponse(), $request, $type);
  137.         }
  139.         // load controller
  140.         if (false === $controller = $this->resolver->getController($request)) {
  141.             throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s". The route is wrongly configured.', $request->getPathInfo()));
  142.         }
  144.         $event = new ControllerEvent($this, $controller, $request, $type);
  145.         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER);
  146.         $controller = $event->getController();
  148.         // controller arguments
  149.         $arguments = $this->argumentResolver->getArguments($request, $controller);
  151.         $event = new ControllerArgumentsEvent($this, $controller, $arguments, $request, $type);
  152.         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER_ARGUMENTS);
  153.         $controller = $event->getController();
  154.         $arguments = $event->getArguments();
  156.         // call controller
  157.         $response = $controller(...$arguments);
  159.         // view
  160.         if (!$response instanceof Response) {
  161.             $event = new ViewEvent($this, $request, $type, $response);
  162.             $this->dispatcher->dispatch($event, KernelEvents::VIEW);
  164.             if ($event->hasResponse()) {
  165.                 $response = $event->getResponse();
  166.             } else {
  167.                 $msg = sprintf('The controller must return a "Symfony\Component\HttpFoundation\Response" object but it returned %s.', $this->varToString($response));
  169.                 // the user may have forgotten to return something
  170.                 if (null === $response) {
  171.                     $msg .= ' Did you forget to add a return statement somewhere in your controller?';
  172.                 }
  174.                 throw new ControllerDoesNotReturnResponseException($msg, $controller, __FILE__, __LINE__ - 17);
  175.             }
  176.         }
  178.         return $this->filterResponse($response, $request, $type);
  179.     }
  181.     /**
  182.      * Filters a response object.
  183.      *
  184.      * @throws \RuntimeException if the passed object is not a Response instance
  185.      */
  186.     private function filterResponse(Response $response, Request $request, int $type): Response
  187.     {
  188.         $event = new ResponseEvent($this, $request, $type, $response);
  190.         $this->dispatcher->dispatch($event, KernelEvents::RESPONSE);
  192.         $this->finishRequest($request, $type);
  194.         return $event->getResponse();
  195.     }
  197.     /**
  198.      * Publishes the finish request event, then pop the request from the stack.
  199.      *
  200.      * Note that the order of the operations is important here, otherwise
  201.      * operations such as {@link RequestStack::getParentRequest()} can lead to
  202.      * weird results.
  203.      */
  204.     private function finishRequest(Request $request, int $type)
  205.     {
  206.         $this->dispatcher->dispatch(new FinishRequestEvent($this, $request, $type), KernelEvents::FINISH_REQUEST);
  207.         $this->requestStack->pop();
  208.     }
  210.     /**
  211.      * Handles a throwable by trying to convert it to a Response.
  212.      *
  213.      * @throws \Exception
  214.      */
  215.     private function handleThrowable(\Throwable $e, Request $request, int $type): Response
  216.     {
  217.         $event = new ExceptionEvent($this, $request, $type, $e);
  218.         $this->dispatcher->dispatch($event, KernelEvents::EXCEPTION);
  220.         // a listener might have replaced the exception
  221.         $e = $event->getThrowable();
  223.         if (!$event->hasResponse()) {
  224.             $this->finishRequest($request, $type);
  226.             throw $e;
  227.         }
  229.         $response = $event->getResponse();
  231.         // the developer asked for a specific status code
  232.         if (!$event->isAllowingCustomResponseCode() && !$response->isClientError() && !$response->isServerError() && !$response->isRedirect()) {
  233.             // ensure that we actually have an error response
  234.             if ($e instanceof HttpExceptionInterface) {
  235.                 // keep the HTTP status code and headers
  236.                 $response->setStatusCode($e->getStatusCode());
  237.                 $response->headers->add($e->getHeaders());
  238.             } else {
  239.                 $response->setStatusCode(500);
  240.             }
  241.         }
  243.         try {
  244.             return $this->filterResponse($response, $request, $type);
  245.         } catch (\Exception $e) {
  246.             return $response;
  247.         }
  248.     }
  250.     /**
  251.      * Returns a human-readable string for the specified variable.
  252.      */
  253.     private function varToString($var): string
  254.     {
  255.         if (\is_object($var)) {
  256.             return sprintf('an object of type %s', \get_class($var));
  257.         }
  259.         if (\is_array($var)) {
  260.             $a = [];
  261.             foreach ($var as $k => $v) {
  262.                 $a[] = sprintf('%s => ...', $k);
  263.             }
  265.             return sprintf('an array ([%s])', mb_substr(implode(', ', $a), 0, 255));
  266.         }
  268.         if (\is_resource($var)) {
  269.             return sprintf('a resource (%s)', get_resource_type($var));
  270.         }
  272.         if (null === $var) {
  273.             return 'null';
  274.         }
  276.         if (false === $var) {
  277.             return 'a boolean value (false)';
  278.         }
  280.         if (true === $var) {
  281.             return 'a boolean value (true)';
  282.         }
  284.         if (\is_string($var)) {
  285.             return sprintf('a string ("%s%s")', mb_substr($var, 0, 255), mb_strlen($var) > 255 ? '...' : '');
  286.         }
  288.         if (is_numeric($var)) {
  289.             return sprintf('a number (%s)', (string) $var);
  290.         }
  292.         return (string) $var;
  293.     }
  294. }