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