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

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\HttpKernel;
  11. use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpFoundation\RequestStack;
  14. use Symfony\Component\HttpFoundation\Response;
  15. use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
  16. use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
  17. use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
  18. use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
  19. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  20. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  21. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  22. use Symfony\Component\HttpKernel\Event\RequestEvent;
  23. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  24. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  25. use Symfony\Component\HttpKernel\Event\ViewEvent;
  26. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  27. use Symfony\Component\HttpKernel\Exception\ControllerDoesNotReturnResponseException;
  28. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  29. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  30. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  31. // Help opcache.preload discover always-needed symbols
  32. class_exists(ControllerArgumentsEvent::class);
  33. class_exists(ControllerEvent::class);
  34. class_exists(ExceptionEvent::class);
  35. class_exists(FinishRequestEvent::class);
  36. class_exists(RequestEvent::class);
  37. class_exists(ResponseEvent::class);
  38. class_exists(TerminateEvent::class);
  39. class_exists(ViewEvent::class);
  40. class_exists(KernelEvents::class);
  41. /**
  42.  * HttpKernel notifies events to convert a Request object to a Response one.
  43.  *
  44.  * @author Fabien Potencier <fabien@symfony.com>
  45.  */
  46. class HttpKernel implements HttpKernelInterfaceTerminableInterface
  47. {
  48.     protected $dispatcher;
  49.     protected $resolver;
  50.     protected $requestStack;
  51.     private $argumentResolver;
  52.     public function __construct(EventDispatcherInterface $dispatcherControllerResolverInterface $resolverRequestStack $requestStack nullArgumentResolverInterface $argumentResolver null)
  53.     {
  54.         $this->dispatcher $dispatcher;
  55.         $this->resolver $resolver;
  56.         $this->requestStack $requestStack ?? new RequestStack();
  57.         $this->argumentResolver $argumentResolver;
  58.         if (null === $this->argumentResolver) {
  59.             $this->argumentResolver = new ArgumentResolver();
  60.         }
  61.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function handle(Request $requestint $type HttpKernelInterface::MAIN_REQUESTbool $catch true)
  66.     {
  67.         $request->headers->set('X-Php-Ob-Level', (string) ob_get_level());
  68.         try {
  69.             return $this->handleRaw($request$type);
  70.         } catch (\Exception $e) {
  71.             if ($e instanceof RequestExceptionInterface) {
  72.                 $e = new BadRequestHttpException($e->getMessage(), $e);
  73.             }
  74.             if (false === $catch) {
  75.                 $this->finishRequest($request$type);
  76.                 throw $e;
  77.             }
  78.             return $this->handleThrowable($e$request$type);
  79.         }
  80.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      */
  84.     public function terminate(Request $requestResponse $response)
  85.     {
  86.         $this->dispatcher->dispatch(new TerminateEvent($this$request$response), KernelEvents::TERMINATE);
  87.     }
  88.     /**
  89.      * @internal
  90.      */
  91.     public function terminateWithException(\Throwable $exceptionRequest $request null)
  92.     {
  93.         if (!$request $request ?: $this->requestStack->getMainRequest()) {
  94.             throw $exception;
  95.         }
  96.         $response $this->handleThrowable($exception$requestself::MAIN_REQUEST);
  97.         $response->sendHeaders();
  98.         $response->sendContent();
  99.         $this->terminate($request$response);
  100.     }
  101.     /**
  102.      * Handles a request to convert it to a response.
  103.      *
  104.      * Exceptions are not caught.
  105.      *
  106.      * @throws \LogicException       If one of the listener does not behave as expected
  107.      * @throws NotFoundHttpException When controller cannot be found
  108.      */
  109.     private function handleRaw(Request $requestint $type self::MAIN_REQUEST): Response
  110.     {
  111.         $this->requestStack->push($request);
  112.         // request
  113.         $event = new RequestEvent($this$request$type);
  114.         $this->dispatcher->dispatch($eventKernelEvents::REQUEST);
  115.         if ($event->hasResponse()) {
  116.             return $this->filterResponse($event->getResponse(), $request$type);
  117.         }
  118.         // load controller
  119.         if (false === $controller $this->resolver->getController($request)) {
  120.             throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s". The route is wrongly configured.'$request->getPathInfo()));
  121.         }
  122.         $event = new ControllerEvent($this$controller$request$type);
  123.         $this->dispatcher->dispatch($eventKernelEvents::CONTROLLER);
  124.         $controller $event->getController();
  125.         // controller arguments
  126.         $arguments $this->argumentResolver->getArguments($request$controller);
  127.         $event = new ControllerArgumentsEvent($this$controller$arguments$request$type);
  128.         $this->dispatcher->dispatch($eventKernelEvents::CONTROLLER_ARGUMENTS);
  129.         $controller $event->getController();
  130.         $arguments $event->getArguments();
  131.         // call controller
  132.         $response $controller(...$arguments);
  133.         // view
  134.         if (!$response instanceof Response) {
  135.             $event = new ViewEvent($this$request$type$response);
  136.             $this->dispatcher->dispatch($eventKernelEvents::VIEW);
  137.             if ($event->hasResponse()) {
  138.                 $response $event->getResponse();
  139.             } else {
  140.                 $msg sprintf('The controller must return a "Symfony\Component\HttpFoundation\Response" object but it returned %s.'$this->varToString($response));
  141.                 // the user may have forgotten to return something
  142.                 if (null === $response) {
  143.                     $msg .= ' Did you forget to add a return statement somewhere in your controller?';
  144.                 }
  145.                 throw new ControllerDoesNotReturnResponseException($msg$controller__FILE____LINE__ 17);
  146.             }
  147.         }
  148.         return $this->filterResponse($response$request$type);
  149.     }
  150.     /**
  151.      * Filters a response object.
  152.      *
  153.      * @throws \RuntimeException if the passed object is not a Response instance
  154.      */
  155.     private function filterResponse(Response $responseRequest $requestint $type): Response
  156.     {
  157.         $event = new ResponseEvent($this$request$type$response);
  158.         $this->dispatcher->dispatch($eventKernelEvents::RESPONSE);
  159.         $this->finishRequest($request$type);
  160.         return $event->getResponse();
  161.     }
  162.     /**
  163.      * Publishes the finish request event, then pop the request from the stack.
  164.      *
  165.      * Note that the order of the operations is important here, otherwise
  166.      * operations such as {@link RequestStack::getParentRequest()} can lead to
  167.      * weird results.
  168.      */
  169.     private function finishRequest(Request $requestint $type)
  170.     {
  171.         $this->dispatcher->dispatch(new FinishRequestEvent($this$request$type), KernelEvents::FINISH_REQUEST);
  172.         $this->requestStack->pop();
  173.     }
  174.     /**
  175.      * Handles a throwable by trying to convert it to a Response.
  176.      *
  177.      * @throws \Exception
  178.      */
  179.     private function handleThrowable(\Throwable $eRequest $requestint $type): Response
  180.     {
  181.         $event = new ExceptionEvent($this$request$type$e);
  182.         $this->dispatcher->dispatch($eventKernelEvents::EXCEPTION);
  183.         // a listener might have replaced the exception
  184.         $e $event->getThrowable();
  185.         if (!$event->hasResponse()) {
  186.             $this->finishRequest($request$type);
  187.             throw $e;
  188.         }
  189.         $response $event->getResponse();
  190.         // the developer asked for a specific status code
  191.         if (!$event->isAllowingCustomResponseCode() && !$response->isClientError() && !$response->isServerError() && !$response->isRedirect()) {
  192.             // ensure that we actually have an error response
  193.             if ($e instanceof HttpExceptionInterface) {
  194.                 // keep the HTTP status code and headers
  195.                 $response->setStatusCode($e->getStatusCode());
  196.                 $response->headers->add($e->getHeaders());
  197.             } else {
  198.                 $response->setStatusCode(500);
  199.             }
  200.         }
  201.         try {
  202.             return $this->filterResponse($response$request$type);
  203.         } catch (\Exception $e) {
  204.             return $response;
  205.         }
  206.     }
  207.     /**
  208.      * Returns a human-readable string for the specified variable.
  209.      */
  210.     private function varToString($var): string
  211.     {
  212.         if (\is_object($var)) {
  213.             return sprintf('an object of type %s', \get_class($var));
  214.         }
  215.         if (\is_array($var)) {
  216.             $a = [];
  217.             foreach ($var as $k => $v) {
  218.                 $a[] = sprintf('%s => ...'$k);
  219.             }
  220.             return sprintf('an array ([%s])'mb_substr(implode(', '$a), 0255));
  221.         }
  222.         if (\is_resource($var)) {
  223.             return sprintf('a resource (%s)'get_resource_type($var));
  224.         }
  225.         if (null === $var) {
  226.             return 'null';
  227.         }
  228.         if (false === $var) {
  229.             return 'a boolean value (false)';
  230.         }
  231.         if (true === $var) {
  232.             return 'a boolean value (true)';
  233.         }
  234.         if (\is_string($var)) {
  235.             return sprintf('a string ("%s%s")'mb_substr($var0255), mb_strlen($var) > 255 '...' '');
  236.         }
  237.         if (is_numeric($var)) {
  238.             return sprintf('a number (%s)', (string) $var);
  239.         }
  240.         return (string) $var;
  241.     }
  242. }