annotate vendor/symfony/http-kernel/HttpKernel.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\HttpKernel;
Chris@0 13
Chris@17 14 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
Chris@17 15 use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
Chris@17 16 use Symfony\Component\HttpFoundation\Request;
Chris@17 17 use Symfony\Component\HttpFoundation\RequestStack;
Chris@17 18 use Symfony\Component\HttpFoundation\Response;
Chris@0 19 use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
Chris@0 20 use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
Chris@0 21 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
Chris@0 22 use Symfony\Component\HttpKernel\Event\FilterControllerArgumentsEvent;
Chris@0 23 use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
Chris@0 24 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
Chris@0 25 use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
Chris@0 26 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
Chris@0 27 use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
Chris@0 28 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
Chris@0 29 use Symfony\Component\HttpKernel\Event\PostResponseEvent;
Chris@17 30 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
Chris@17 31 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
Chris@17 32 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
Chris@0 33
Chris@0 34 /**
Chris@0 35 * HttpKernel notifies events to convert a Request object to a Response one.
Chris@0 36 *
Chris@0 37 * @author Fabien Potencier <fabien@symfony.com>
Chris@0 38 */
Chris@0 39 class HttpKernel implements HttpKernelInterface, TerminableInterface
Chris@0 40 {
Chris@0 41 protected $dispatcher;
Chris@0 42 protected $resolver;
Chris@0 43 protected $requestStack;
Chris@0 44 private $argumentResolver;
Chris@0 45
Chris@0 46 public function __construct(EventDispatcherInterface $dispatcher, ControllerResolverInterface $resolver, RequestStack $requestStack = null, ArgumentResolverInterface $argumentResolver = null)
Chris@0 47 {
Chris@0 48 $this->dispatcher = $dispatcher;
Chris@0 49 $this->resolver = $resolver;
Chris@0 50 $this->requestStack = $requestStack ?: new RequestStack();
Chris@0 51 $this->argumentResolver = $argumentResolver;
Chris@0 52
Chris@0 53 if (null === $this->argumentResolver) {
Chris@0 54 @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 55 // fallback in case of deprecations
Chris@0 56 $this->argumentResolver = $resolver;
Chris@0 57 }
Chris@0 58 }
Chris@0 59
Chris@0 60 /**
Chris@0 61 * {@inheritdoc}
Chris@0 62 */
Chris@0 63 public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
Chris@0 64 {
Chris@0 65 $request->headers->set('X-Php-Ob-Level', ob_get_level());
Chris@0 66
Chris@0 67 try {
Chris@0 68 return $this->handleRaw($request, $type);
Chris@0 69 } catch (\Exception $e) {
Chris@14 70 if ($e instanceof RequestExceptionInterface) {
Chris@14 71 $e = new BadRequestHttpException($e->getMessage(), $e);
Chris@0 72 }
Chris@0 73 if (false === $catch) {
Chris@0 74 $this->finishRequest($request, $type);
Chris@0 75
Chris@0 76 throw $e;
Chris@0 77 }
Chris@0 78
Chris@0 79 return $this->handleException($e, $request, $type);
Chris@0 80 }
Chris@0 81 }
Chris@0 82
Chris@0 83 /**
Chris@0 84 * {@inheritdoc}
Chris@0 85 */
Chris@0 86 public function terminate(Request $request, Response $response)
Chris@0 87 {
Chris@0 88 $this->dispatcher->dispatch(KernelEvents::TERMINATE, new PostResponseEvent($this, $request, $response));
Chris@0 89 }
Chris@0 90
Chris@0 91 /**
Chris@0 92 * @internal
Chris@0 93 */
Chris@14 94 public function terminateWithException(\Exception $exception, Request $request = null)
Chris@0 95 {
Chris@14 96 if (!$request = $request ?: $this->requestStack->getMasterRequest()) {
Chris@14 97 throw $exception;
Chris@0 98 }
Chris@0 99
Chris@0 100 $response = $this->handleException($exception, $request, self::MASTER_REQUEST);
Chris@0 101
Chris@0 102 $response->sendHeaders();
Chris@0 103 $response->sendContent();
Chris@0 104
Chris@0 105 $this->terminate($request, $response);
Chris@0 106 }
Chris@0 107
Chris@0 108 /**
Chris@0 109 * Handles a request to convert it to a response.
Chris@0 110 *
Chris@0 111 * Exceptions are not caught.
Chris@0 112 *
Chris@0 113 * @param Request $request A Request instance
Chris@0 114 * @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
Chris@0 115 *
Chris@0 116 * @return Response A Response instance
Chris@0 117 *
Chris@0 118 * @throws \LogicException If one of the listener does not behave as expected
Chris@0 119 * @throws NotFoundHttpException When controller cannot be found
Chris@0 120 */
Chris@0 121 private function handleRaw(Request $request, $type = self::MASTER_REQUEST)
Chris@0 122 {
Chris@0 123 $this->requestStack->push($request);
Chris@0 124
Chris@0 125 // request
Chris@0 126 $event = new GetResponseEvent($this, $request, $type);
Chris@0 127 $this->dispatcher->dispatch(KernelEvents::REQUEST, $event);
Chris@0 128
Chris@0 129 if ($event->hasResponse()) {
Chris@0 130 return $this->filterResponse($event->getResponse(), $request, $type);
Chris@0 131 }
Chris@0 132
Chris@0 133 // load controller
Chris@0 134 if (false === $controller = $this->resolver->getController($request)) {
Chris@0 135 throw new NotFoundHttpException(sprintf('Unable to find the controller for path "%s". The route is wrongly configured.', $request->getPathInfo()));
Chris@0 136 }
Chris@0 137
Chris@0 138 $event = new FilterControllerEvent($this, $controller, $request, $type);
Chris@0 139 $this->dispatcher->dispatch(KernelEvents::CONTROLLER, $event);
Chris@0 140 $controller = $event->getController();
Chris@0 141
Chris@0 142 // controller arguments
Chris@0 143 $arguments = $this->argumentResolver->getArguments($request, $controller);
Chris@0 144
Chris@0 145 $event = new FilterControllerArgumentsEvent($this, $controller, $arguments, $request, $type);
Chris@0 146 $this->dispatcher->dispatch(KernelEvents::CONTROLLER_ARGUMENTS, $event);
Chris@0 147 $controller = $event->getController();
Chris@0 148 $arguments = $event->getArguments();
Chris@0 149
Chris@0 150 // call controller
Chris@14 151 $response = \call_user_func_array($controller, $arguments);
Chris@0 152
Chris@0 153 // view
Chris@0 154 if (!$response instanceof Response) {
Chris@0 155 $event = new GetResponseForControllerResultEvent($this, $request, $type, $response);
Chris@0 156 $this->dispatcher->dispatch(KernelEvents::VIEW, $event);
Chris@0 157
Chris@0 158 if ($event->hasResponse()) {
Chris@0 159 $response = $event->getResponse();
Chris@0 160 }
Chris@0 161
Chris@0 162 if (!$response instanceof Response) {
Chris@0 163 $msg = sprintf('The controller must return a response (%s given).', $this->varToString($response));
Chris@0 164
Chris@0 165 // the user may have forgotten to return something
Chris@0 166 if (null === $response) {
Chris@0 167 $msg .= ' Did you forget to add a return statement somewhere in your controller?';
Chris@0 168 }
Chris@0 169 throw new \LogicException($msg);
Chris@0 170 }
Chris@0 171 }
Chris@0 172
Chris@0 173 return $this->filterResponse($response, $request, $type);
Chris@0 174 }
Chris@0 175
Chris@0 176 /**
Chris@0 177 * Filters a response object.
Chris@0 178 *
Chris@0 179 * @param Response $response A Response instance
Chris@0 180 * @param Request $request An error message in case the response is not a Response object
Chris@0 181 * @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
Chris@0 182 *
Chris@0 183 * @return Response The filtered Response instance
Chris@0 184 *
Chris@0 185 * @throws \RuntimeException if the passed object is not a Response instance
Chris@0 186 */
Chris@0 187 private function filterResponse(Response $response, Request $request, $type)
Chris@0 188 {
Chris@0 189 $event = new FilterResponseEvent($this, $request, $type, $response);
Chris@0 190
Chris@0 191 $this->dispatcher->dispatch(KernelEvents::RESPONSE, $event);
Chris@0 192
Chris@0 193 $this->finishRequest($request, $type);
Chris@0 194
Chris@0 195 return $event->getResponse();
Chris@0 196 }
Chris@0 197
Chris@0 198 /**
Chris@0 199 * Publishes the finish request event, then pop the request from the stack.
Chris@0 200 *
Chris@0 201 * Note that the order of the operations is important here, otherwise
Chris@0 202 * operations such as {@link RequestStack::getParentRequest()} can lead to
Chris@0 203 * weird results.
Chris@0 204 *
Chris@0 205 * @param Request $request
Chris@0 206 * @param int $type
Chris@0 207 */
Chris@0 208 private function finishRequest(Request $request, $type)
Chris@0 209 {
Chris@0 210 $this->dispatcher->dispatch(KernelEvents::FINISH_REQUEST, new FinishRequestEvent($this, $request, $type));
Chris@0 211 $this->requestStack->pop();
Chris@0 212 }
Chris@0 213
Chris@0 214 /**
Chris@0 215 * Handles an exception by trying to convert it to a Response.
Chris@0 216 *
Chris@0 217 * @param \Exception $e An \Exception instance
Chris@0 218 * @param Request $request A Request instance
Chris@0 219 * @param int $type The type of the request
Chris@0 220 *
Chris@0 221 * @return Response A Response instance
Chris@0 222 *
Chris@0 223 * @throws \Exception
Chris@0 224 */
Chris@0 225 private function handleException(\Exception $e, $request, $type)
Chris@0 226 {
Chris@0 227 $event = new GetResponseForExceptionEvent($this, $request, $type, $e);
Chris@0 228 $this->dispatcher->dispatch(KernelEvents::EXCEPTION, $event);
Chris@0 229
Chris@0 230 // a listener might have replaced the exception
Chris@0 231 $e = $event->getException();
Chris@0 232
Chris@0 233 if (!$event->hasResponse()) {
Chris@0 234 $this->finishRequest($request, $type);
Chris@0 235
Chris@0 236 throw $e;
Chris@0 237 }
Chris@0 238
Chris@0 239 $response = $event->getResponse();
Chris@0 240
Chris@0 241 // the developer asked for a specific status code
Chris@0 242 if ($response->headers->has('X-Status-Code')) {
Chris@14 243 @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 244
Chris@0 245 $response->setStatusCode($response->headers->get('X-Status-Code'));
Chris@0 246
Chris@0 247 $response->headers->remove('X-Status-Code');
Chris@14 248 } elseif (!$event->isAllowingCustomResponseCode() && !$response->isClientError() && !$response->isServerError() && !$response->isRedirect()) {
Chris@0 249 // ensure that we actually have an error response
Chris@0 250 if ($e instanceof HttpExceptionInterface) {
Chris@0 251 // keep the HTTP status code and headers
Chris@0 252 $response->setStatusCode($e->getStatusCode());
Chris@0 253 $response->headers->add($e->getHeaders());
Chris@0 254 } else {
Chris@0 255 $response->setStatusCode(500);
Chris@0 256 }
Chris@0 257 }
Chris@0 258
Chris@0 259 try {
Chris@0 260 return $this->filterResponse($response, $request, $type);
Chris@0 261 } catch (\Exception $e) {
Chris@0 262 return $response;
Chris@0 263 }
Chris@0 264 }
Chris@0 265
Chris@17 266 /**
Chris@17 267 * Returns a human-readable string for the specified variable.
Chris@17 268 */
Chris@0 269 private function varToString($var)
Chris@0 270 {
Chris@17 271 if (\is_object($var)) {
Chris@17 272 return sprintf('Object(%s)', \get_class($var));
Chris@0 273 }
Chris@0 274
Chris@17 275 if (\is_array($var)) {
Chris@17 276 $a = [];
Chris@0 277 foreach ($var as $k => $v) {
Chris@0 278 $a[] = sprintf('%s => %s', $k, $this->varToString($v));
Chris@0 279 }
Chris@0 280
Chris@0 281 return sprintf('Array(%s)', implode(', ', $a));
Chris@0 282 }
Chris@0 283
Chris@17 284 if (\is_resource($var)) {
Chris@0 285 return sprintf('Resource(%s)', get_resource_type($var));
Chris@0 286 }
Chris@0 287
Chris@0 288 if (null === $var) {
Chris@0 289 return 'null';
Chris@0 290 }
Chris@0 291
Chris@0 292 if (false === $var) {
Chris@0 293 return 'false';
Chris@0 294 }
Chris@0 295
Chris@0 296 if (true === $var) {
Chris@0 297 return 'true';
Chris@0 298 }
Chris@0 299
Chris@0 300 return (string) $var;
Chris@0 301 }
Chris@0 302 }