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 <[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\EventDispatcherInterface;
  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\FilterControllerArgumentsEvent;
  23. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  24. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  25. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  26. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  27. use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
  28. use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
  29. use Symfony\Component\HttpKernel\Event\PostResponseEvent;
  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;
  35. /**
  36.  * HttpKernel notifies events to convert a Request object to a Response one.
  37.  *
  38.  * @author Fabien Potencier <[email protected]>
  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, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
  63.     {
  64.         $request->headers->set('X-Php-Ob-Level', 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->handleException($e, $request, $type);
  79.         }
  80.     }
  82.     /**
  83.      * {@inheritdoc}
  84.      */
  85.     public function terminate(Request $request, Response $response)
  86.     {
  87.         $this->dispatcher->dispatch(KernelEvents::TERMINATE, new PostResponseEvent($this, $request, $response));
  88.     }
  90.     /**
  91.      * @internal
  92.      */
  93.     public function terminateWithException(\Exception $exception, Request $request = null)
  94.     {
  95.         if (!$request = $request ?: $this->requestStack->getMasterRequest()) {
  96.             throw $exception;
  97.         }
  99.         $response = $this->handleException($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.      * @param Request $request A Request instance
  113.      * @param int     $type    The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
  114.      *
  115.      * @return Response A Response instance
  116.      *
  117.      * @throws \LogicException       If one of the listener does not behave as expected
  118.      * @throws NotFoundHttpException When controller cannot be found
  119.      */
  120.     private function handleRaw(Request $request, int $type = self::MASTER_REQUEST)
  121.     {
  122.         $this->requestStack->push($request);
  124.         // request
  125.         $event = new GetResponseEvent($this, $request, $type);
  126.         $this->dispatcher->dispatch(KernelEvents::REQUEST, $event);
  128.         if ($event->hasResponse()) {
  129.             return $this->filterResponse($event->getResponse(), $request, $type);
  130.         }
  132.         // load controller
  133.         if (false === $controller = $this->resolver->getController($request)) {
  134.             throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s". The route is wrongly configured.', $request->getPathInfo()));
  135.         }
  137.         $event = new FilterControllerEvent($this, $controller, $request, $type);
  138.         $this->dispatcher->dispatch(KernelEvents::CONTROLLER, $event);
  139.         $controller = $event->getController();
  141.         // controller arguments
  142.         $arguments = $this->argumentResolver->getArguments($request, $controller);
  144.         $event = new FilterControllerArgumentsEvent($this, $controller, $arguments, $request, $type);
  145.         $this->dispatcher->dispatch(KernelEvents::CONTROLLER_ARGUMENTS, $event);
  146.         $controller = $event->getController();
  147.         $arguments = $event->getArguments();
  149.         // call controller
  150.         $response = $controller(...$arguments);
  152.         // view
  153.         if (!$response instanceof Response) {
  154.             $event = new GetResponseForControllerResultEvent($this, $request, $type, $response);
  155.             $this->dispatcher->dispatch(KernelEvents::VIEW, $event);
  157.             if ($event->hasResponse()) {
  158.                 $response = $event->getResponse();
  159.             } else {
  160.                 $msg = sprintf('The controller must return a "Symfony\Component\HttpFoundation\Response" object but it returned %s.', $this->varToString($response));
  162.                 // the user may have forgotten to return something
  163.                 if (null === $response) {
  164.                     $msg .= ' Did you forget to add a return statement somewhere in your controller?';
  165.                 }
  167.                 throw new ControllerDoesNotReturnResponseException($msg, $controller, __FILE__, __LINE__ - 17);
  168.             }
  169.         }
  171.         return $this->filterResponse($response, $request, $type);
  172.     }
  174.     /**
  175.      * Filters a response object.
  176.      *
  177.      * @param Response $response A Response instance
  178.      * @param Request  $request  An error message in case the response is not a Response object
  179.      * @param int      $type     The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
  180.      *
  181.      * @return Response The filtered Response instance
  182.      *
  183.      * @throws \RuntimeException if the passed object is not a Response instance
  184.      */
  185.     private function filterResponse(Response $response, Request $request, int $type)
  186.     {
  187.         $event = new FilterResponseEvent($this, $request, $type, $response);
  189.         $this->dispatcher->dispatch(KernelEvents::RESPONSE, $event);
  191.         $this->finishRequest($request, $type);
  193.         return $event->getResponse();
  194.     }
  196.     /**
  197.      * Publishes the finish request event, then pop the request from the stack.
  198.      *
  199.      * Note that the order of the operations is important here, otherwise
  200.      * operations such as {@link RequestStack::getParentRequest()} can lead to
  201.      * weird results.
  202.      */
  203.     private function finishRequest(Request $request, int $type)
  204.     {
  205.         $this->dispatcher->dispatch(KernelEvents::FINISH_REQUEST, new FinishRequestEvent($this, $request, $type));
  206.         $this->requestStack->pop();
  207.     }
  209.     /**
  210.      * Handles an exception by trying to convert it to a Response.
  211.      *
  212.      * @param \Exception $e       An \Exception instance
  213.      * @param Request    $request A Request instance
  214.      * @param int        $type    The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
  215.      *
  216.      * @throws \Exception
  217.      */
  218.     private function handleException(\Exception $e, Request $request, int $type): Response
  219.     {
  220.         $event = new GetResponseForExceptionEvent($this, $request, $type, $e);
  221.         $this->dispatcher->dispatch(KernelEvents::EXCEPTION, $event);
  223.         // a listener might have replaced the exception
  224.         $e = $event->getException();
  226.         if (!$event->hasResponse()) {
  227.             $this->finishRequest($request, $type);
  229.             throw $e;
  230.         }
  232.         $response = $event->getResponse();
  234.         // the developer asked for a specific status code
  235.         if (!$event->isAllowingCustomResponseCode() && !$response->isClientError() && !$response->isServerError() && !$response->isRedirect()) {
  236.             // ensure that we actually have an error response
  237.             if ($e instanceof HttpExceptionInterface) {
  238.                 // keep the HTTP status code and headers
  239.                 $response->setStatusCode($e->getStatusCode());
  240.                 $response->headers->add($e->getHeaders());
  241.             } else {
  242.                 $response->setStatusCode(500);
  243.             }
  244.         }
  246.         try {
  247.             return $this->filterResponse($response, $request, $type);
  248.         } catch (\Exception $e) {
  249.             return $response;
  250.         }
  251.     }
  253.     /**
  254.      * Returns a human-readable string for the specified variable.
  255.      */
  256.     private function varToString($var): string
  257.     {
  258.         if (\is_object($var)) {
  259.             return sprintf('an object of type %s', \get_class($var));
  260.         }
  262.         if (\is_array($var)) {
  263.             $a = [];
  264.             foreach ($var as $k => $v) {
  265.                 $a[] = sprintf('%s => ...', $k);
  266.             }
  268.             return sprintf('an array ([%s])', mb_substr(implode(', ', $a), 0, 255));
  269.         }
  271.         if (\is_resource($var)) {
  272.             return sprintf('a resource (%s)', get_resource_type($var));
  273.         }
  275.         if (null === $var) {
  276.             return 'null';
  277.         }
  279.         if (false === $var) {
  280.             return 'a boolean value (false)';
  281.         }
  283.         if (true === $var) {
  284.             return 'a boolean value (true)';
  285.         }
  287.         if (\is_string($var)) {
  288.             return sprintf('a string ("%s%s")', mb_substr($var, 0, 255), mb_strlen($var) > 255 ? '...' : '');
  289.         }
  291.         if (is_numeric($var)) {
  292.             return sprintf('a number (%s)', (string) $var);
  293.         }
  295.         return (string) $var;
  296.     }
  297. }