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\DataCollector;
Chris@0: 
Chris@17: use Symfony\Component\EventDispatcher\EventSubscriberInterface;
Chris@14: use Symfony\Component\HttpFoundation\Cookie;
Chris@0: use Symfony\Component\HttpFoundation\ParameterBag;
Chris@0: use Symfony\Component\HttpFoundation\Request;
Chris@0: use Symfony\Component\HttpFoundation\Response;
Chris@17: use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
Chris@0: use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
Chris@0: use Symfony\Component\HttpKernel\KernelEvents;
Chris@0: 
Chris@0: /**
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@14: class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
Chris@0: {
Chris@0:     protected $controllers;
Chris@0: 
Chris@0:     public function __construct()
Chris@0:     {
Chris@0:         $this->controllers = new \SplObjectStorage();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function collect(Request $request, Response $response, \Exception $exception = null)
Chris@0:     {
Chris@0:         // attributes are serialized and as they can be anything, they need to be converted to strings.
Chris@17:         $attributes = [];
Chris@0:         $route = '';
Chris@0:         foreach ($request->attributes->all() as $key => $value) {
Chris@0:             if ('_route' === $key) {
Chris@17:                 $route = \is_object($value) ? $value->getPath() : $value;
Chris@0:                 $attributes[$key] = $route;
Chris@0:             } else {
Chris@0:                 $attributes[$key] = $value;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $content = null;
Chris@0:         try {
Chris@0:             $content = $request->getContent();
Chris@0:         } catch (\LogicException $e) {
Chris@0:             // the user already got the request content as a resource
Chris@0:             $content = false;
Chris@0:         }
Chris@0: 
Chris@17:         $sessionMetadata = [];
Chris@17:         $sessionAttributes = [];
Chris@0:         $session = null;
Chris@17:         $flashes = [];
Chris@0:         if ($request->hasSession()) {
Chris@0:             $session = $request->getSession();
Chris@0:             if ($session->isStarted()) {
Chris@0:                 $sessionMetadata['Created'] = date(DATE_RFC822, $session->getMetadataBag()->getCreated());
Chris@0:                 $sessionMetadata['Last used'] = date(DATE_RFC822, $session->getMetadataBag()->getLastUsed());
Chris@0:                 $sessionMetadata['Lifetime'] = $session->getMetadataBag()->getLifetime();
Chris@0:                 $sessionAttributes = $session->all();
Chris@0:                 $flashes = $session->getFlashBag()->peekAll();
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $statusCode = $response->getStatusCode();
Chris@0: 
Chris@17:         $responseCookies = [];
Chris@14:         foreach ($response->headers->getCookies() as $cookie) {
Chris@14:             $responseCookies[$cookie->getName()] = $cookie;
Chris@14:         }
Chris@14: 
Chris@17:         $this->data = [
Chris@0:             'method' => $request->getMethod(),
Chris@0:             'format' => $request->getRequestFormat(),
Chris@0:             'content' => $content,
Chris@0:             'content_type' => $response->headers->get('Content-Type', 'text/html'),
Chris@0:             'status_text' => isset(Response::$statusTexts[$statusCode]) ? Response::$statusTexts[$statusCode] : '',
Chris@0:             'status_code' => $statusCode,
Chris@0:             'request_query' => $request->query->all(),
Chris@0:             'request_request' => $request->request->all(),
Chris@0:             'request_headers' => $request->headers->all(),
Chris@0:             'request_server' => $request->server->all(),
Chris@0:             'request_cookies' => $request->cookies->all(),
Chris@0:             'request_attributes' => $attributes,
Chris@0:             'route' => $route,
Chris@14:             'response_headers' => $response->headers->all(),
Chris@14:             'response_cookies' => $responseCookies,
Chris@0:             'session_metadata' => $sessionMetadata,
Chris@0:             'session_attributes' => $sessionAttributes,
Chris@0:             'flashes' => $flashes,
Chris@0:             'path_info' => $request->getPathInfo(),
Chris@0:             'controller' => 'n/a',
Chris@0:             'locale' => $request->getLocale(),
Chris@17:         ];
Chris@0: 
Chris@0:         if (isset($this->data['request_headers']['php-auth-pw'])) {
Chris@0:             $this->data['request_headers']['php-auth-pw'] = '******';
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($this->data['request_server']['PHP_AUTH_PW'])) {
Chris@0:             $this->data['request_server']['PHP_AUTH_PW'] = '******';
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($this->data['request_request']['_password'])) {
Chris@0:             $this->data['request_request']['_password'] = '******';
Chris@0:         }
Chris@0: 
Chris@0:         foreach ($this->data as $key => $value) {
Chris@17:             if (!\is_array($value)) {
Chris@0:                 continue;
Chris@0:             }
Chris@0:             if ('request_headers' === $key || 'response_headers' === $key) {
Chris@14:                 $this->data[$key] = array_map(function ($v) { return isset($v[0]) && !isset($v[1]) ? $v[0] : $v; }, $value);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($this->controllers[$request])) {
Chris@0:             $this->data['controller'] = $this->parseController($this->controllers[$request]);
Chris@0:             unset($this->controllers[$request]);
Chris@0:         }
Chris@0: 
Chris@14:         if ($request->attributes->has('_redirected') && $redirectCookie = $request->cookies->get('sf_redirect')) {
Chris@14:             $this->data['redirect'] = json_decode($redirectCookie, true);
Chris@0: 
Chris@14:             $response->headers->clearCookie('sf_redirect');
Chris@14:         }
Chris@14: 
Chris@14:         if ($response->isRedirect()) {
Chris@14:             $response->headers->setCookie(new Cookie(
Chris@14:                 'sf_redirect',
Chris@17:                 json_encode([
Chris@0:                     'token' => $response->headers->get('x-debug-token'),
Chris@0:                     'route' => $request->attributes->get('_route', 'n/a'),
Chris@0:                     'method' => $request->getMethod(),
Chris@0:                     'controller' => $this->parseController($request->attributes->get('_controller')),
Chris@0:                     'status_code' => $statusCode,
Chris@0:                     'status_text' => Response::$statusTexts[(int) $statusCode],
Chris@17:                 ])
Chris@14:             ));
Chris@0:         }
Chris@14: 
Chris@17:         $this->data['identifier'] = $this->data['route'] ?: (\is_array($this->data['controller']) ? $this->data['controller']['class'].'::'.$this->data['controller']['method'].'()' : $this->data['controller']);
Chris@14:     }
Chris@14: 
Chris@14:     public function lateCollect()
Chris@14:     {
Chris@14:         $this->data = $this->cloneVar($this->data);
Chris@14:     }
Chris@14: 
Chris@14:     public function reset()
Chris@14:     {
Chris@17:         $this->data = [];
Chris@14:         $this->controllers = new \SplObjectStorage();
Chris@0:     }
Chris@0: 
Chris@0:     public function getMethod()
Chris@0:     {
Chris@0:         return $this->data['method'];
Chris@0:     }
Chris@0: 
Chris@0:     public function getPathInfo()
Chris@0:     {
Chris@0:         return $this->data['path_info'];
Chris@0:     }
Chris@0: 
Chris@0:     public function getRequestRequest()
Chris@0:     {
Chris@14:         return new ParameterBag($this->data['request_request']->getValue());
Chris@0:     }
Chris@0: 
Chris@0:     public function getRequestQuery()
Chris@0:     {
Chris@14:         return new ParameterBag($this->data['request_query']->getValue());
Chris@0:     }
Chris@0: 
Chris@0:     public function getRequestHeaders()
Chris@0:     {
Chris@14:         return new ParameterBag($this->data['request_headers']->getValue());
Chris@0:     }
Chris@0: 
Chris@0:     public function getRequestServer($raw = false)
Chris@0:     {
Chris@14:         return new ParameterBag($this->data['request_server']->getValue($raw));
Chris@0:     }
Chris@0: 
Chris@0:     public function getRequestCookies($raw = false)
Chris@0:     {
Chris@14:         return new ParameterBag($this->data['request_cookies']->getValue($raw));
Chris@0:     }
Chris@0: 
Chris@0:     public function getRequestAttributes()
Chris@0:     {
Chris@14:         return new ParameterBag($this->data['request_attributes']->getValue());
Chris@0:     }
Chris@0: 
Chris@0:     public function getResponseHeaders()
Chris@0:     {
Chris@14:         return new ParameterBag($this->data['response_headers']->getValue());
Chris@14:     }
Chris@14: 
Chris@14:     public function getResponseCookies()
Chris@14:     {
Chris@14:         return new ParameterBag($this->data['response_cookies']->getValue());
Chris@0:     }
Chris@0: 
Chris@0:     public function getSessionMetadata()
Chris@0:     {
Chris@14:         return $this->data['session_metadata']->getValue();
Chris@0:     }
Chris@0: 
Chris@0:     public function getSessionAttributes()
Chris@0:     {
Chris@14:         return $this->data['session_attributes']->getValue();
Chris@0:     }
Chris@0: 
Chris@0:     public function getFlashes()
Chris@0:     {
Chris@14:         return $this->data['flashes']->getValue();
Chris@0:     }
Chris@0: 
Chris@0:     public function getContent()
Chris@0:     {
Chris@0:         return $this->data['content'];
Chris@0:     }
Chris@0: 
Chris@0:     public function getContentType()
Chris@0:     {
Chris@0:         return $this->data['content_type'];
Chris@0:     }
Chris@0: 
Chris@0:     public function getStatusText()
Chris@0:     {
Chris@0:         return $this->data['status_text'];
Chris@0:     }
Chris@0: 
Chris@0:     public function getStatusCode()
Chris@0:     {
Chris@0:         return $this->data['status_code'];
Chris@0:     }
Chris@0: 
Chris@0:     public function getFormat()
Chris@0:     {
Chris@0:         return $this->data['format'];
Chris@0:     }
Chris@0: 
Chris@0:     public function getLocale()
Chris@0:     {
Chris@0:         return $this->data['locale'];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets the route name.
Chris@0:      *
Chris@0:      * The _route request attributes is automatically set by the Router Matcher.
Chris@0:      *
Chris@0:      * @return string The route
Chris@0:      */
Chris@0:     public function getRoute()
Chris@0:     {
Chris@0:         return $this->data['route'];
Chris@0:     }
Chris@0: 
Chris@0:     public function getIdentifier()
Chris@0:     {
Chris@14:         return $this->data['identifier'];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets the route parameters.
Chris@0:      *
Chris@0:      * The _route_params request attributes is automatically set by the RouterListener.
Chris@0:      *
Chris@0:      * @return array The parameters
Chris@0:      */
Chris@0:     public function getRouteParams()
Chris@0:     {
Chris@17:         return isset($this->data['request_attributes']['_route_params']) ? $this->data['request_attributes']['_route_params']->getValue() : [];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets the parsed controller.
Chris@0:      *
Chris@0:      * @return array|string The controller as a string or array of data
Chris@0:      *                      with keys 'class', 'method', 'file' and 'line'
Chris@0:      */
Chris@0:     public function getController()
Chris@0:     {
Chris@0:         return $this->data['controller'];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets the previous request attributes.
Chris@0:      *
Chris@0:      * @return array|bool A legacy array of data from the previous redirection response
Chris@0:      *                    or false otherwise
Chris@0:      */
Chris@0:     public function getRedirect()
Chris@0:     {
Chris@0:         return isset($this->data['redirect']) ? $this->data['redirect'] : false;
Chris@0:     }
Chris@0: 
Chris@0:     public function onKernelController(FilterControllerEvent $event)
Chris@0:     {
Chris@0:         $this->controllers[$event->getRequest()] = $event->getController();
Chris@0:     }
Chris@0: 
Chris@0:     public function onKernelResponse(FilterResponseEvent $event)
Chris@0:     {
Chris@14:         if (!$event->isMasterRequest()) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@14:         if ($event->getRequest()->cookies->has('sf_redirect')) {
Chris@0:             $event->getRequest()->attributes->set('_redirected', true);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     public static function getSubscribedEvents()
Chris@0:     {
Chris@17:         return [
Chris@0:             KernelEvents::CONTROLLER => 'onKernelController',
Chris@0:             KernelEvents::RESPONSE => 'onKernelResponse',
Chris@17:         ];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getName()
Chris@0:     {
Chris@0:         return 'request';
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Parse a controller.
Chris@0:      *
Chris@0:      * @param mixed $controller The controller to parse
Chris@0:      *
Chris@0:      * @return array|string An array of controller data or a simple string
Chris@0:      */
Chris@0:     protected function parseController($controller)
Chris@0:     {
Chris@17:         if (\is_string($controller) && false !== strpos($controller, '::')) {
Chris@0:             $controller = explode('::', $controller);
Chris@0:         }
Chris@0: 
Chris@17:         if (\is_array($controller)) {
Chris@0:             try {
Chris@0:                 $r = new \ReflectionMethod($controller[0], $controller[1]);
Chris@0: 
Chris@17:                 return [
Chris@17:                     'class' => \is_object($controller[0]) ? \get_class($controller[0]) : $controller[0],
Chris@0:                     'method' => $controller[1],
Chris@0:                     'file' => $r->getFileName(),
Chris@0:                     'line' => $r->getStartLine(),
Chris@17:                 ];
Chris@0:             } catch (\ReflectionException $e) {
Chris@17:                 if (\is_callable($controller)) {
Chris@0:                     // using __call or  __callStatic
Chris@17:                     return [
Chris@17:                         'class' => \is_object($controller[0]) ? \get_class($controller[0]) : $controller[0],
Chris@0:                         'method' => $controller[1],
Chris@0:                         'file' => 'n/a',
Chris@0:                         'line' => 'n/a',
Chris@17:                     ];
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if ($controller instanceof \Closure) {
Chris@0:             $r = new \ReflectionFunction($controller);
Chris@0: 
Chris@17:             $controller = [
Chris@0:                 'class' => $r->getName(),
Chris@0:                 'method' => null,
Chris@0:                 'file' => $r->getFileName(),
Chris@0:                 'line' => $r->getStartLine(),
Chris@17:             ];
Chris@17: 
Chris@17:             if (false !== strpos($r->name, '{closure}')) {
Chris@17:                 return $controller;
Chris@17:             }
Chris@17:             $controller['method'] = $r->name;
Chris@17: 
Chris@17:             if ($class = $r->getClosureScopeClass()) {
Chris@17:                 $controller['class'] = $class->name;
Chris@17:             } else {
Chris@17:                 return $r->name;
Chris@17:             }
Chris@17: 
Chris@17:             return $controller;
Chris@0:         }
Chris@0: 
Chris@17:         if (\is_object($controller)) {
Chris@0:             $r = new \ReflectionClass($controller);
Chris@0: 
Chris@17:             return [
Chris@0:                 'class' => $r->getName(),
Chris@0:                 'method' => null,
Chris@0:                 'file' => $r->getFileName(),
Chris@0:                 'line' => $r->getStartLine(),
Chris@17:             ];
Chris@0:         }
Chris@0: 
Chris@17:         return \is_string($controller) ? $controller : 'n/a';
Chris@0:     }
Chris@0: }