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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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. // Help opcache.preload discover always-needed symbols
  37. class_exists(LegacyEventDispatcherProxy::class);
  38. class_exists(ControllerArgumentsEvent::class);
  39. class_exists(ControllerEvent::class);
  40. class_exists(ExceptionEvent::class);
  41. class_exists(FinishRequestEvent::class);
  42. class_exists(RequestEvent::class);
  43. class_exists(ResponseEvent::class);
  44. class_exists(TerminateEvent::class);
  45. class_exists(ViewEvent::class);
  46. class_exists(KernelEvents::class);
  48. /**
  49.  * HttpKernel notifies events to convert a Request object to a Response one.
  50.  *
  51.  * @author Fabien Potencier <[email protected]>
  52.  */
  53. class HttpKernel implements HttpKernelInterface, TerminableInterface
  54. {
  55.     protected $dispatcher;
  56.     protected $resolver;
  57.     protected $requestStack;
  58.     private $argumentResolver;
  60.     public function __construct(EventDispatcherInterface $dispatcher, ControllerResolverInterface $resolver, RequestStack $requestStack = null, ArgumentResolverInterface $argumentResolver = null)
  61.     {
  62.         $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
  63.         $this->resolver = $resolver;
  64.         $this->requestStack = $requestStack ?? new RequestStack();
  65.         $this->argumentResolver = $argumentResolver;
  67.         if (null === $this->argumentResolver) {
  68.             $this->argumentResolver = new ArgumentResolver();
  69.         }
  70.     }
  72.     /**
  73.      * {@inheritdoc}
  74.      */
  75.     public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
  76.     {
  77.         $request->headers->set('X-Php-Ob-Level', (string) ob_get_level());
  79.         $this->requestStack->push($request);
  80.         try {
  81.             return $this->handleRaw($request, $type);
  82.         } catch (\Exception $e) {
  83.             if ($e instanceof RequestExceptionInterface) {
  84.                 $e = new BadRequestHttpException($e->getMessage(), $e);
  85.             }
  86.             if (false === $catch) {
  87.                 $this->finishRequest($request, $type);
  89.                 throw $e;
  90.             }
  92.             return $this->handleThrowable($e, $request, $type);
  93.         } finally {
  94.             $this->requestStack->pop();
  95.         }
  96.     }
  98.     /**
  99.      * {@inheritdoc}
  100.      */
  101.     public function terminate(Request $request, Response $response)
  102.     {
  103.         $this->dispatcher->dispatch(new TerminateEvent($this, $request, $response), KernelEvents::TERMINATE);
  104.     }
  106.     /**
  107.      * @internal
  108.      */
  109.     public function terminateWithException(\Throwable $exception, Request $request = null)
  110.     {
  111.         if (!$request = $request ?: $this->requestStack->getMasterRequest()) {
  112.             throw $exception;
  113.         }
  115.         if ($pop = $request !== $this->requestStack->getMasterRequest()) {
  116.             $this->requestStack->push($request);
  117.         }
  119.         try {
  120.             $response = $this->handleThrowable($exception, $request, self::MASTER_REQUEST);
  121.         } finally {
  122.             if ($pop) {
  123.                 $this->requestStack->pop();
  124.             }
  125.         }
  127.         $response->sendHeaders();
  128.         $response->sendContent();
  130.         $this->terminate($request, $response);
  131.     }
  133.     /**
  134.      * Handles a request to convert it to a response.
  135.      *
  136.      * Exceptions are not caught.
  137.      *
  138.      * @throws \LogicException       If one of the listener does not behave as expected
  139.      * @throws NotFoundHttpException When controller cannot be found
  140.      */
  141.     private function handleRaw(Request $request, int $type = self::MASTER_REQUEST): Response
  142.     {
  143.         // request
  144.         $event = new RequestEvent($this, $request, $type);
  145.         $this->dispatcher->dispatch($event, KernelEvents::REQUEST);
  147.         if ($event->hasResponse()) {
  148.             return $this->filterResponse($event->getResponse(), $request, $type);
  149.         }
  151.         // load controller
  152.         if (false === $controller = $this->resolver->getController($request)) {
  153.             throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s". The route is wrongly configured.', $request->getPathInfo()));
  154.         }
  156.         $event = new ControllerEvent($this, $controller, $request, $type);
  157.         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER);
  158.         $controller = $event->getController();
  160.         // controller arguments
  161.         $arguments = $this->argumentResolver->getArguments($request, $controller);
  163.         $event = new ControllerArgumentsEvent($this, $controller, $arguments, $request, $type);
  164.         $this->dispatcher->dispatch($event, KernelEvents::CONTROLLER_ARGUMENTS);
  165.         $controller = $event->getController();
  166.         $arguments = $event->getArguments();
  168.         // call controller
  169.         $response = $controller(...$arguments);
  171.         // view
  172.         if (!$response instanceof Response) {
  173.             $event = new ViewEvent($this, $request, $type, $response);
  174.             $this->dispatcher->dispatch($event, KernelEvents::VIEW);
  176.             if ($event->hasResponse()) {
  177.                 $response = $event->getResponse();
  178.             } else {
  179.                 $msg = sprintf('The controller must return a "Symfony\Component\HttpFoundation\Response" object but it returned %s.', $this->varToString($response));
  181.                 // the user may have forgotten to return something
  182.                 if (null === $response) {
  183.                     $msg .= ' Did you forget to add a return statement somewhere in your controller?';
  184.                 }
  186.                 throw new ControllerDoesNotReturnResponseException($msg, $controller, __FILE__, __LINE__ - 17);
  187.             }
  188.         }
  190.         return $this->filterResponse($response, $request, $type);
  191.     }
  193.     /**
  194.      * Filters a response object.
  195.      *
  196.      * @throws \RuntimeException if the passed object is not a Response instance
  197.      */
  198.     private function filterResponse(Response $response, Request $request, int $type): Response
  199.     {
  200.         $event = new ResponseEvent($this, $request, $type, $response);
  202.         $this->dispatcher->dispatch($event, KernelEvents::RESPONSE);
  204.         $this->finishRequest($request, $type);
  206.         return $event->getResponse();
  207.     }
  209.     /**
  210.      * Publishes the finish request event, then pop the request from the stack.
  211.      *
  212.      * Note that the order of the operations is important here, otherwise
  213.      * operations such as {@link RequestStack::getParentRequest()} can lead to
  214.      * weird results.
  215.      */
  216.     private function finishRequest(Request $request, int $type)
  217.     {
  218.         $this->dispatcher->dispatch(new FinishRequestEvent($this, $request, $type), KernelEvents::FINISH_REQUEST);
  219.     }
  221.     /**
  222.      * Handles a throwable by trying to convert it to a Response.
  223.      *
  224.      * @throws \Exception
  225.      */
  226.     private function handleThrowable(\Throwable $e, Request $request, int $type): Response
  227.     {
  228.         $event = new ExceptionEvent($this, $request, $type, $e);
  229.         $this->dispatcher->dispatch($event, KernelEvents::EXCEPTION);
  231.         // a listener might have replaced the exception
  232.         $e = $event->getThrowable();
  234.         if (!$event->hasResponse()) {
  235.             $this->finishRequest($request, $type);
  237.             throw $e;
  238.         }
  240.         $response = $event->getResponse();
  242.         // the developer asked for a specific status code
  243.         if (!$event->isAllowingCustomResponseCode() && !$response->isClientError() && !$response->isServerError() && !$response->isRedirect()) {
  244.             // ensure that we actually have an error response
  245.             if ($e instanceof HttpExceptionInterface) {
  246.                 // keep the HTTP status code and headers
  247.                 $response->setStatusCode($e->getStatusCode());
  248.                 $response->headers->add($e->getHeaders());
  249.             } else {
  250.                 $response->setStatusCode(500);
  251.             }
  252.         }
  254.         try {
  255.             return $this->filterResponse($response, $request, $type);
  256.         } catch (\Exception $e) {
  257.             return $response;
  258.         }
  259.     }
  261.     /**
  262.      * Returns a human-readable string for the specified variable.
  263.      */
  264.     private function varToString($var): string
  265.     {
  266.         if (\is_object($var)) {
  267.             return sprintf('an object of type %s', \get_class($var));
  268.         }
  270.         if (\is_array($var)) {
  271.             $a = [];
  272.             foreach ($var as $k => $v) {
  273.                 $a[] = sprintf('%s => ...', $k);
  274.             }
  276.             return sprintf('an array ([%s])', mb_substr(implode(', ', $a), 0, 255));
  277.         }
  279.         if (\is_resource($var)) {
  280.             return sprintf('a resource (%s)', get_resource_type($var));
  281.         }
  283.         if (null === $var) {
  284.             return 'null';
  285.         }
  287.         if (false === $var) {
  288.             return 'a boolean value (false)';
  289.         }
  291.         if (true === $var) {
  292.             return 'a boolean value (true)';
  293.         }
  295.         if (\is_string($var)) {
  296.             return sprintf('a string ("%s%s")', mb_substr($var, 0, 255), mb_strlen($var) > 255 ? '...' : '');
  297.         }
  299.         if (is_numeric($var)) {
  300.             return sprintf('a number (%s)', (string) $var);
  301.         }
  303.         return (string) $var;
  304.     }
  305. }