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

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