4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\HttpKernel\DataCollector;
14 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
15 use Symfony\Component\HttpFoundation\Cookie;
16 use Symfony\Component\HttpFoundation\ParameterBag;
17 use Symfony\Component\HttpFoundation\Request;
18 use Symfony\Component\HttpFoundation\Response;
19 use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
20 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
21 use Symfony\Component\HttpKernel\KernelEvents;
24 * @author Fabien Potencier <fabien@symfony.com>
26 class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
28 protected $controllers;
30 public function __construct()
32 $this->controllers = new \SplObjectStorage();
38 public function collect(Request $request, Response $response, \Exception $exception = null)
40 // attributes are serialized and as they can be anything, they need to be converted to strings.
41 $attributes = array();
43 foreach ($request->attributes->all() as $key => $value) {
44 if ('_route' === $key) {
45 $route = \is_object($value) ? $value->getPath() : $value;
46 $attributes[$key] = $route;
48 $attributes[$key] = $value;
54 $content = $request->getContent();
55 } catch (\LogicException $e) {
56 // the user already got the request content as a resource
60 $sessionMetadata = array();
61 $sessionAttributes = array();
64 if ($request->hasSession()) {
65 $session = $request->getSession();
66 if ($session->isStarted()) {
67 $sessionMetadata['Created'] = date(DATE_RFC822, $session->getMetadataBag()->getCreated());
68 $sessionMetadata['Last used'] = date(DATE_RFC822, $session->getMetadataBag()->getLastUsed());
69 $sessionMetadata['Lifetime'] = $session->getMetadataBag()->getLifetime();
70 $sessionAttributes = $session->all();
71 $flashes = $session->getFlashBag()->peekAll();
75 $statusCode = $response->getStatusCode();
77 $responseCookies = array();
78 foreach ($response->headers->getCookies() as $cookie) {
79 $responseCookies[$cookie->getName()] = $cookie;
83 'method' => $request->getMethod(),
84 'format' => $request->getRequestFormat(),
85 'content' => $content,
86 'content_type' => $response->headers->get('Content-Type', 'text/html'),
87 'status_text' => isset(Response::$statusTexts[$statusCode]) ? Response::$statusTexts[$statusCode] : '',
88 'status_code' => $statusCode,
89 'request_query' => $request->query->all(),
90 'request_request' => $request->request->all(),
91 'request_headers' => $request->headers->all(),
92 'request_server' => $request->server->all(),
93 'request_cookies' => $request->cookies->all(),
94 'request_attributes' => $attributes,
96 'response_headers' => $response->headers->all(),
97 'response_cookies' => $responseCookies,
98 'session_metadata' => $sessionMetadata,
99 'session_attributes' => $sessionAttributes,
100 'flashes' => $flashes,
101 'path_info' => $request->getPathInfo(),
102 'controller' => 'n/a',
103 'locale' => $request->getLocale(),
106 if (isset($this->data['request_headers']['php-auth-pw'])) {
107 $this->data['request_headers']['php-auth-pw'] = '******';
110 if (isset($this->data['request_server']['PHP_AUTH_PW'])) {
111 $this->data['request_server']['PHP_AUTH_PW'] = '******';
114 if (isset($this->data['request_request']['_password'])) {
115 $this->data['request_request']['_password'] = '******';
118 foreach ($this->data as $key => $value) {
119 if (!\is_array($value)) {
122 if ('request_headers' === $key || 'response_headers' === $key) {
123 $this->data[$key] = array_map(function ($v) { return isset($v[0]) && !isset($v[1]) ? $v[0] : $v; }, $value);
127 if (isset($this->controllers[$request])) {
128 $this->data['controller'] = $this->parseController($this->controllers[$request]);
129 unset($this->controllers[$request]);
132 if ($request->attributes->has('_redirected') && $redirectCookie = $request->cookies->get('sf_redirect')) {
133 $this->data['redirect'] = json_decode($redirectCookie, true);
135 $response->headers->clearCookie('sf_redirect');
138 if ($response->isRedirect()) {
139 $response->headers->setCookie(new Cookie(
142 'token' => $response->headers->get('x-debug-token'),
143 'route' => $request->attributes->get('_route', 'n/a'),
144 'method' => $request->getMethod(),
145 'controller' => $this->parseController($request->attributes->get('_controller')),
146 'status_code' => $statusCode,
147 'status_text' => Response::$statusTexts[(int) $statusCode],
152 $this->data['identifier'] = $this->data['route'] ?: (\is_array($this->data['controller']) ? $this->data['controller']['class'].'::'.$this->data['controller']['method'].'()' : $this->data['controller']);
155 public function lateCollect()
157 $this->data = $this->cloneVar($this->data);
160 public function reset()
162 $this->data = array();
163 $this->controllers = new \SplObjectStorage();
166 public function getMethod()
168 return $this->data['method'];
171 public function getPathInfo()
173 return $this->data['path_info'];
176 public function getRequestRequest()
178 return new ParameterBag($this->data['request_request']->getValue());
181 public function getRequestQuery()
183 return new ParameterBag($this->data['request_query']->getValue());
186 public function getRequestHeaders()
188 return new ParameterBag($this->data['request_headers']->getValue());
191 public function getRequestServer($raw = false)
193 return new ParameterBag($this->data['request_server']->getValue($raw));
196 public function getRequestCookies($raw = false)
198 return new ParameterBag($this->data['request_cookies']->getValue($raw));
201 public function getRequestAttributes()
203 return new ParameterBag($this->data['request_attributes']->getValue());
206 public function getResponseHeaders()
208 return new ParameterBag($this->data['response_headers']->getValue());
211 public function getResponseCookies()
213 return new ParameterBag($this->data['response_cookies']->getValue());
216 public function getSessionMetadata()
218 return $this->data['session_metadata']->getValue();
221 public function getSessionAttributes()
223 return $this->data['session_attributes']->getValue();
226 public function getFlashes()
228 return $this->data['flashes']->getValue();
231 public function getContent()
233 return $this->data['content'];
236 public function getContentType()
238 return $this->data['content_type'];
241 public function getStatusText()
243 return $this->data['status_text'];
246 public function getStatusCode()
248 return $this->data['status_code'];
251 public function getFormat()
253 return $this->data['format'];
256 public function getLocale()
258 return $this->data['locale'];
262 * Gets the route name.
264 * The _route request attributes is automatically set by the Router Matcher.
266 * @return string The route
268 public function getRoute()
270 return $this->data['route'];
273 public function getIdentifier()
275 return $this->data['identifier'];
279 * Gets the route parameters.
281 * The _route_params request attributes is automatically set by the RouterListener.
283 * @return array The parameters
285 public function getRouteParams()
287 return isset($this->data['request_attributes']['_route_params']) ? $this->data['request_attributes']['_route_params']->getValue() : array();
291 * Gets the parsed controller.
293 * @return array|string The controller as a string or array of data
294 * with keys 'class', 'method', 'file' and 'line'
296 public function getController()
298 return $this->data['controller'];
302 * Gets the previous request attributes.
304 * @return array|bool A legacy array of data from the previous redirection response
307 public function getRedirect()
309 return isset($this->data['redirect']) ? $this->data['redirect'] : false;
312 public function onKernelController(FilterControllerEvent $event)
314 $this->controllers[$event->getRequest()] = $event->getController();
317 public function onKernelResponse(FilterResponseEvent $event)
319 if (!$event->isMasterRequest()) {
323 if ($event->getRequest()->cookies->has('sf_redirect')) {
324 $event->getRequest()->attributes->set('_redirected', true);
328 public static function getSubscribedEvents()
331 KernelEvents::CONTROLLER => 'onKernelController',
332 KernelEvents::RESPONSE => 'onKernelResponse',
339 public function getName()
345 * Parse a controller.
347 * @param mixed $controller The controller to parse
349 * @return array|string An array of controller data or a simple string
351 protected function parseController($controller)
353 if (\is_string($controller) && false !== strpos($controller, '::')) {
354 $controller = explode('::', $controller);
357 if (\is_array($controller)) {
359 $r = new \ReflectionMethod($controller[0], $controller[1]);
362 'class' => \is_object($controller[0]) ? \get_class($controller[0]) : $controller[0],
363 'method' => $controller[1],
364 'file' => $r->getFileName(),
365 'line' => $r->getStartLine(),
367 } catch (\ReflectionException $e) {
368 if (\is_callable($controller)) {
369 // using __call or __callStatic
371 'class' => \is_object($controller[0]) ? \get_class($controller[0]) : $controller[0],
372 'method' => $controller[1],
380 if ($controller instanceof \Closure) {
381 $r = new \ReflectionFunction($controller);
384 'class' => $r->getName(),
386 'file' => $r->getFileName(),
387 'line' => $r->getStartLine(),
391 if (\is_object($controller)) {
392 $r = new \ReflectionClass($controller);
395 'class' => $r->getName(),
397 'file' => $r->getFileName(),
398 'line' => $r->getStartLine(),
402 return \is_string($controller) ? $controller : 'n/a';