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

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