Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\HttpKernel;
Chris@0: 
Chris@17: use Symfony\Component\EventDispatcher\EventDispatcherInterface;
Chris@17: use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
Chris@17: use Symfony\Component\HttpFoundation\Request;
Chris@17: use Symfony\Component\HttpFoundation\RequestStack;
Chris@17: use Symfony\Component\HttpFoundation\Response;
Chris@0: use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
Chris@0: use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
Chris@0: use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
Chris@0: use Symfony\Component\HttpKernel\Event\FilterControllerArgumentsEvent;
Chris@0: use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
Chris@0: use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
Chris@0: use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
Chris@0: use Symfony\Component\HttpKernel\Event\GetResponseEvent;
Chris@0: use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
Chris@0: use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
Chris@0: use Symfony\Component\HttpKernel\Event\PostResponseEvent;
Chris@17: use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
Chris@17: use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
Chris@17: use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
Chris@0: 
Chris@0: /**
Chris@0:  * HttpKernel notifies events to convert a Request object to a Response one.
Chris@0:  *
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@0: class HttpKernel implements HttpKernelInterface, TerminableInterface
Chris@0: {
Chris@0:     protected $dispatcher;
Chris@0:     protected $resolver;
Chris@0:     protected $requestStack;
Chris@0:     private $argumentResolver;
Chris@0: 
Chris@0:     public function __construct(EventDispatcherInterface $dispatcher, ControllerResolverInterface $resolver, RequestStack $requestStack = null, ArgumentResolverInterface $argumentResolver = null)
Chris@0:     {
Chris@0:         $this->dispatcher = $dispatcher;
Chris@0:         $this->resolver = $resolver;
Chris@0:         $this->requestStack = $requestStack ?: new RequestStack();
Chris@0:         $this->argumentResolver = $argumentResolver;
Chris@0: 
Chris@0:         if (null === $this->argumentResolver) {
Chris@0:             @trigger_error(sprintf('As of 3.1 an %s is used to resolve arguments. In 4.0 the $argumentResolver becomes the %s if no other is provided instead of using the $resolver argument.', ArgumentResolverInterface::class, ArgumentResolver::class), E_USER_DEPRECATED);
Chris@0:             // fallback in case of deprecations
Chris@0:             $this->argumentResolver = $resolver;
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
Chris@0:     {
Chris@0:         $request->headers->set('X-Php-Ob-Level', ob_get_level());
Chris@0: 
Chris@0:         try {
Chris@0:             return $this->handleRaw($request, $type);
Chris@0:         } catch (\Exception $e) {
Chris@14:             if ($e instanceof RequestExceptionInterface) {
Chris@14:                 $e = new BadRequestHttpException($e->getMessage(), $e);
Chris@0:             }
Chris@0:             if (false === $catch) {
Chris@0:                 $this->finishRequest($request, $type);
Chris@0: 
Chris@0:                 throw $e;
Chris@0:             }
Chris@0: 
Chris@0:             return $this->handleException($e, $request, $type);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function terminate(Request $request, Response $response)
Chris@0:     {
Chris@0:         $this->dispatcher->dispatch(KernelEvents::TERMINATE, new PostResponseEvent($this, $request, $response));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @internal
Chris@0:      */
Chris@14:     public function terminateWithException(\Exception $exception, Request $request = null)
Chris@0:     {
Chris@14:         if (!$request = $request ?: $this->requestStack->getMasterRequest()) {
Chris@14:             throw $exception;
Chris@0:         }
Chris@0: 
Chris@0:         $response = $this->handleException($exception, $request, self::MASTER_REQUEST);
Chris@0: 
Chris@0:         $response->sendHeaders();
Chris@0:         $response->sendContent();
Chris@0: 
Chris@0:         $this->terminate($request, $response);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Handles a request to convert it to a response.
Chris@0:      *
Chris@0:      * Exceptions are not caught.
Chris@0:      *
Chris@0:      * @param Request $request A Request instance
Chris@0:      * @param int     $type    The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
Chris@0:      *
Chris@0:      * @return Response A Response instance
Chris@0:      *
Chris@0:      * @throws \LogicException       If one of the listener does not behave as expected
Chris@0:      * @throws NotFoundHttpException When controller cannot be found
Chris@0:      */
Chris@0:     private function handleRaw(Request $request, $type = self::MASTER_REQUEST)
Chris@0:     {
Chris@0:         $this->requestStack->push($request);
Chris@0: 
Chris@0:         // request
Chris@0:         $event = new GetResponseEvent($this, $request, $type);
Chris@0:         $this->dispatcher->dispatch(KernelEvents::REQUEST, $event);
Chris@0: 
Chris@0:         if ($event->hasResponse()) {
Chris@0:             return $this->filterResponse($event->getResponse(), $request, $type);
Chris@0:         }
Chris@0: 
Chris@0:         // load controller
Chris@0:         if (false === $controller = $this->resolver->getController($request)) {
Chris@0:             throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s". The route is wrongly configured.', $request->getPathInfo()));
Chris@0:         }
Chris@0: 
Chris@0:         $event = new FilterControllerEvent($this, $controller, $request, $type);
Chris@0:         $this->dispatcher->dispatch(KernelEvents::CONTROLLER, $event);
Chris@0:         $controller = $event->getController();
Chris@0: 
Chris@0:         // controller arguments
Chris@0:         $arguments = $this->argumentResolver->getArguments($request, $controller);
Chris@0: 
Chris@0:         $event = new FilterControllerArgumentsEvent($this, $controller, $arguments, $request, $type);
Chris@0:         $this->dispatcher->dispatch(KernelEvents::CONTROLLER_ARGUMENTS, $event);
Chris@0:         $controller = $event->getController();
Chris@0:         $arguments = $event->getArguments();
Chris@0: 
Chris@0:         // call controller
Chris@14:         $response = \call_user_func_array($controller, $arguments);
Chris@0: 
Chris@0:         // view
Chris@0:         if (!$response instanceof Response) {
Chris@0:             $event = new GetResponseForControllerResultEvent($this, $request, $type, $response);
Chris@0:             $this->dispatcher->dispatch(KernelEvents::VIEW, $event);
Chris@0: 
Chris@0:             if ($event->hasResponse()) {
Chris@0:                 $response = $event->getResponse();
Chris@0:             }
Chris@0: 
Chris@0:             if (!$response instanceof Response) {
Chris@0:                 $msg = sprintf('The controller must return a response (%s given).', $this->varToString($response));
Chris@0: 
Chris@0:                 // the user may have forgotten to return something
Chris@0:                 if (null === $response) {
Chris@0:                     $msg .= ' Did you forget to add a return statement somewhere in your controller?';
Chris@0:                 }
Chris@0:                 throw new \LogicException($msg);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return $this->filterResponse($response, $request, $type);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Filters a response object.
Chris@0:      *
Chris@0:      * @param Response $response A Response instance
Chris@0:      * @param Request  $request  An error message in case the response is not a Response object
Chris@0:      * @param int      $type     The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
Chris@0:      *
Chris@0:      * @return Response The filtered Response instance
Chris@0:      *
Chris@0:      * @throws \RuntimeException if the passed object is not a Response instance
Chris@0:      */
Chris@0:     private function filterResponse(Response $response, Request $request, $type)
Chris@0:     {
Chris@0:         $event = new FilterResponseEvent($this, $request, $type, $response);
Chris@0: 
Chris@0:         $this->dispatcher->dispatch(KernelEvents::RESPONSE, $event);
Chris@0: 
Chris@0:         $this->finishRequest($request, $type);
Chris@0: 
Chris@0:         return $event->getResponse();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Publishes the finish request event, then pop the request from the stack.
Chris@0:      *
Chris@0:      * Note that the order of the operations is important here, otherwise
Chris@0:      * operations such as {@link RequestStack::getParentRequest()} can lead to
Chris@0:      * weird results.
Chris@0:      *
Chris@0:      * @param Request $request
Chris@0:      * @param int     $type
Chris@0:      */
Chris@0:     private function finishRequest(Request $request, $type)
Chris@0:     {
Chris@0:         $this->dispatcher->dispatch(KernelEvents::FINISH_REQUEST, new FinishRequestEvent($this, $request, $type));
Chris@0:         $this->requestStack->pop();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Handles an exception by trying to convert it to a Response.
Chris@0:      *
Chris@0:      * @param \Exception $e       An \Exception instance
Chris@0:      * @param Request    $request A Request instance
Chris@0:      * @param int        $type    The type of the request
Chris@0:      *
Chris@0:      * @return Response A Response instance
Chris@0:      *
Chris@0:      * @throws \Exception
Chris@0:      */
Chris@0:     private function handleException(\Exception $e, $request, $type)
Chris@0:     {
Chris@0:         $event = new GetResponseForExceptionEvent($this, $request, $type, $e);
Chris@0:         $this->dispatcher->dispatch(KernelEvents::EXCEPTION, $event);
Chris@0: 
Chris@0:         // a listener might have replaced the exception
Chris@0:         $e = $event->getException();
Chris@0: 
Chris@0:         if (!$event->hasResponse()) {
Chris@0:             $this->finishRequest($request, $type);
Chris@0: 
Chris@0:             throw $e;
Chris@0:         }
Chris@0: 
Chris@0:         $response = $event->getResponse();
Chris@0: 
Chris@0:         // the developer asked for a specific status code
Chris@0:         if ($response->headers->has('X-Status-Code')) {
Chris@14:             @trigger_error(sprintf('Using the X-Status-Code header is deprecated since Symfony 3.3 and will be removed in 4.0. Use %s::allowCustomResponseCode() instead.', GetResponseForExceptionEvent::class), E_USER_DEPRECATED);
Chris@14: 
Chris@0:             $response->setStatusCode($response->headers->get('X-Status-Code'));
Chris@0: 
Chris@0:             $response->headers->remove('X-Status-Code');
Chris@14:         } elseif (!$event->isAllowingCustomResponseCode() && !$response->isClientError() && !$response->isServerError() && !$response->isRedirect()) {
Chris@0:             // ensure that we actually have an error response
Chris@0:             if ($e instanceof HttpExceptionInterface) {
Chris@0:                 // keep the HTTP status code and headers
Chris@0:                 $response->setStatusCode($e->getStatusCode());
Chris@0:                 $response->headers->add($e->getHeaders());
Chris@0:             } else {
Chris@0:                 $response->setStatusCode(500);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         try {
Chris@0:             return $this->filterResponse($response, $request, $type);
Chris@0:         } catch (\Exception $e) {
Chris@0:             return $response;
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@17:     /**
Chris@17:      * Returns a human-readable string for the specified variable.
Chris@17:      */
Chris@0:     private function varToString($var)
Chris@0:     {
Chris@17:         if (\is_object($var)) {
Chris@17:             return sprintf('Object(%s)', \get_class($var));
Chris@0:         }
Chris@0: 
Chris@17:         if (\is_array($var)) {
Chris@17:             $a = [];
Chris@0:             foreach ($var as $k => $v) {
Chris@0:                 $a[] = sprintf('%s => %s', $k, $this->varToString($v));
Chris@0:             }
Chris@0: 
Chris@0:             return sprintf('Array(%s)', implode(', ', $a));
Chris@0:         }
Chris@0: 
Chris@17:         if (\is_resource($var)) {
Chris@0:             return sprintf('Resource(%s)', get_resource_type($var));
Chris@0:         }
Chris@0: 
Chris@0:         if (null === $var) {
Chris@0:             return 'null';
Chris@0:         }
Chris@0: 
Chris@0:         if (false === $var) {
Chris@0:             return 'false';
Chris@0:         }
Chris@0: 
Chris@0:         if (true === $var) {
Chris@0:             return 'true';
Chris@0:         }
Chris@0: 
Chris@0:         return (string) $var;
Chris@0:     }
Chris@0: }