vendor/symfony/symfony/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php line 313

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\HttpKernel\DataCollector;
  11. use Symfony\Component\HttpFoundation\ParameterBag;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpFoundation\Response;
  14. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  15. use Symfony\Component\HttpKernel\KernelEvents;
  16. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. /**
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  */
  21. class RequestDataCollector extends DataCollector implements EventSubscriberInterfaceLateDataCollectorInterface
  22. {
  23.     protected $controllers;
  24.     public function __construct()
  25.     {
  26.         $this->controllers = new \SplObjectStorage();
  27.     }
  28.     /**
  29.      * {@inheritdoc}
  30.      */
  31.     public function collect(Request $requestResponse $response, \Exception $exception null)
  32.     {
  33.         // attributes are serialized and as they can be anything, they need to be converted to strings.
  34.         $attributes = array();
  35.         $route '';
  36.         foreach ($request->attributes->all() as $key => $value) {
  37.             if ('_route' === $key) {
  38.                 $route is_object($value) ? $value->getPath() : $value;
  39.                 $attributes[$key] = $route;
  40.             } else {
  41.                 $attributes[$key] = $value;
  42.             }
  43.         }
  44.         $content null;
  45.         try {
  46.             $content $request->getContent();
  47.         } catch (\LogicException $e) {
  48.             // the user already got the request content as a resource
  49.             $content false;
  50.         }
  51.         $sessionMetadata = array();
  52.         $sessionAttributes = array();
  53.         $session null;
  54.         $flashes = array();
  55.         if ($request->hasSession()) {
  56.             $session $request->getSession();
  57.             if ($session->isStarted()) {
  58.                 $sessionMetadata['Created'] = date(DATE_RFC822$session->getMetadataBag()->getCreated());
  59.                 $sessionMetadata['Last used'] = date(DATE_RFC822$session->getMetadataBag()->getLastUsed());
  60.                 $sessionMetadata['Lifetime'] = $session->getMetadataBag()->getLifetime();
  61.                 $sessionAttributes $session->all();
  62.                 $flashes $session->getFlashBag()->peekAll();
  63.             }
  64.         }
  65.         $statusCode $response->getStatusCode();
  66.         $responseCookies = array();
  67.         foreach ($response->headers->getCookies() as $cookie) {
  68.             $responseCookies[$cookie->getName()] = $cookie;
  69.         }
  70.         $this->data = array(
  71.             'method' => $request->getMethod(),
  72.             'format' => $request->getRequestFormat(),
  73.             'content' => $content,
  74.             'content_type' => $response->headers->get('Content-Type''text/html'),
  75.             'status_text' => isset(Response::$statusTexts[$statusCode]) ? Response::$statusTexts[$statusCode] : '',
  76.             'status_code' => $statusCode,
  77.             'request_query' => $request->query->all(),
  78.             'request_request' => $request->request->all(),
  79.             'request_headers' => $request->headers->all(),
  80.             'request_server' => $request->server->all(),
  81.             'request_cookies' => $request->cookies->all(),
  82.             'request_attributes' => $attributes,
  83.             'route' => $route,
  84.             'response_headers' => $response->headers->all(),
  85.             'response_cookies' => $responseCookies,
  86.             'session_metadata' => $sessionMetadata,
  87.             'session_attributes' => $sessionAttributes,
  88.             'flashes' => $flashes,
  89.             'path_info' => $request->getPathInfo(),
  90.             'controller' => 'n/a',
  91.             'locale' => $request->getLocale(),
  92.         );
  93.         if (isset($this->data['request_headers']['php-auth-pw'])) {
  94.             $this->data['request_headers']['php-auth-pw'] = '******';
  95.         }
  96.         if (isset($this->data['request_server']['PHP_AUTH_PW'])) {
  97.             $this->data['request_server']['PHP_AUTH_PW'] = '******';
  98.         }
  99.         if (isset($this->data['request_request']['_password'])) {
  100.             $this->data['request_request']['_password'] = '******';
  101.         }
  102.         foreach ($this->data as $key => $value) {
  103.             if (!is_array($value)) {
  104.                 continue;
  105.             }
  106.             if ('request_headers' === $key || 'response_headers' === $key) {
  107.                 $this->data[$key] = array_map(function ($v) { return isset($v[0]) && !isset($v[1]) ? $v[0] : $v; }, $value);
  108.             }
  109.         }
  110.         if (isset($this->controllers[$request])) {
  111.             $this->data['controller'] = $this->parseController($this->controllers[$request]);
  112.             unset($this->controllers[$request]);
  113.         }
  114.         if (null !== $session) {
  115.             if ($request->attributes->has('_redirected')) {
  116.                 $this->data['redirect'] = $session->remove('sf_redirect');
  117.             }
  118.             if ($response->isRedirect()) {
  119.                 $session->set('sf_redirect', array(
  120.                     'token' => $response->headers->get('x-debug-token'),
  121.                     'route' => $request->attributes->get('_route''n/a'),
  122.                     'method' => $request->getMethod(),
  123.                     'controller' => $this->parseController($request->attributes->get('_controller')),
  124.                     'status_code' => $statusCode,
  125.                     'status_text' => Response::$statusTexts[(int) $statusCode],
  126.                 ));
  127.             }
  128.         }
  129.         $this->data['identifier'] = $this->data['route'] ?: (is_array($this->data['controller']) ? $this->data['controller']['class'].'::'.$this->data['controller']['method'].'()' $this->data['controller']);
  130.     }
  131.     public function lateCollect()
  132.     {
  133.         $this->data $this->cloneVar($this->data);
  134.     }
  135.     public function reset()
  136.     {
  137.         $this->data = array();
  138.         $this->controllers = new \SplObjectStorage();
  139.     }
  140.     public function getMethod()
  141.     {
  142.         return $this->data['method'];
  143.     }
  144.     public function getPathInfo()
  145.     {
  146.         return $this->data['path_info'];
  147.     }
  148.     public function getRequestRequest()
  149.     {
  150.         return new ParameterBag($this->data['request_request']->getValue());
  151.     }
  152.     public function getRequestQuery()
  153.     {
  154.         return new ParameterBag($this->data['request_query']->getValue());
  155.     }
  156.     public function getRequestHeaders()
  157.     {
  158.         return new ParameterBag($this->data['request_headers']->getValue());
  159.     }
  160.     public function getRequestServer($raw false)
  161.     {
  162.         return new ParameterBag($this->data['request_server']->getValue($raw));
  163.     }
  164.     public function getRequestCookies($raw false)
  165.     {
  166.         return new ParameterBag($this->data['request_cookies']->getValue($raw));
  167.     }
  168.     public function getRequestAttributes()
  169.     {
  170.         return new ParameterBag($this->data['request_attributes']->getValue());
  171.     }
  172.     public function getResponseHeaders()
  173.     {
  174.         return new ParameterBag($this->data['response_headers']->getValue());
  175.     }
  176.     public function getResponseCookies()
  177.     {
  178.         return new ParameterBag($this->data['response_cookies']->getValue());
  179.     }
  180.     public function getSessionMetadata()
  181.     {
  182.         return $this->data['session_metadata']->getValue();
  183.     }
  184.     public function getSessionAttributes()
  185.     {
  186.         return $this->data['session_attributes']->getValue();
  187.     }
  188.     public function getFlashes()
  189.     {
  190.         return $this->data['flashes']->getValue();
  191.     }
  192.     public function getContent()
  193.     {
  194.         return $this->data['content'];
  195.     }
  196.     public function getContentType()
  197.     {
  198.         return $this->data['content_type'];
  199.     }
  200.     public function getStatusText()
  201.     {
  202.         return $this->data['status_text'];
  203.     }
  204.     public function getStatusCode()
  205.     {
  206.         return $this->data['status_code'];
  207.     }
  208.     public function getFormat()
  209.     {
  210.         return $this->data['format'];
  211.     }
  212.     public function getLocale()
  213.     {
  214.         return $this->data['locale'];
  215.     }
  216.     /**
  217.      * Gets the route name.
  218.      *
  219.      * The _route request attributes is automatically set by the Router Matcher.
  220.      *
  221.      * @return string The route
  222.      */
  223.     public function getRoute()
  224.     {
  225.         return $this->data['route'];
  226.     }
  227.     public function getIdentifier()
  228.     {
  229.         return $this->data['identifier'];
  230.     }
  231.     /**
  232.      * Gets the route parameters.
  233.      *
  234.      * The _route_params request attributes is automatically set by the RouterListener.
  235.      *
  236.      * @return array The parameters
  237.      */
  238.     public function getRouteParams()
  239.     {
  240.         return isset($this->data['request_attributes']['_route_params']) ? $this->data['request_attributes']['_route_params']->getValue() : array();
  241.     }
  242.     /**
  243.      * Gets the parsed controller.
  244.      *
  245.      * @return array|string The controller as a string or array of data
  246.      *                      with keys 'class', 'method', 'file' and 'line'
  247.      */
  248.     public function getController()
  249.     {
  250.         return $this->data['controller'];
  251.     }
  252.     /**
  253.      * Gets the previous request attributes.
  254.      *
  255.      * @return array|bool A legacy array of data from the previous redirection response
  256.      *                    or false otherwise
  257.      */
  258.     public function getRedirect()
  259.     {
  260.         return isset($this->data['redirect']) ? $this->data['redirect'] : false;
  261.     }
  262.     public function onKernelController(FilterControllerEvent $event)
  263.     {
  264.         $this->controllers[$event->getRequest()] = $event->getController();
  265.     }
  266.     public function onKernelResponse(FilterResponseEvent $event)
  267.     {
  268.         if (!$event->isMasterRequest() || !$event->getRequest()->hasSession()) {
  269.             return;
  270.         }
  271.         if ($event->getRequest()->getSession()->has('sf_redirect')) {
  272.             $event->getRequest()->attributes->set('_redirected'true);
  273.         }
  274.     }
  275.     public static function getSubscribedEvents()
  276.     {
  277.         return array(
  278.             KernelEvents::CONTROLLER => 'onKernelController',
  279.             KernelEvents::RESPONSE => 'onKernelResponse',
  280.         );
  281.     }
  282.     /**
  283.      * {@inheritdoc}
  284.      */
  285.     public function getName()
  286.     {
  287.         return 'request';
  288.     }
  289.     /**
  290.      * Parse a controller.
  291.      *
  292.      * @param mixed $controller The controller to parse
  293.      *
  294.      * @return array|string An array of controller data or a simple string
  295.      */
  296.     protected function parseController($controller)
  297.     {
  298.         if (is_string($controller) && false !== strpos($controller'::')) {
  299.             $controller explode('::'$controller);
  300.         }
  301.         if (is_array($controller)) {
  302.             try {
  303.                 $r = new \ReflectionMethod($controller[0], $controller[1]);
  304.                 return array(
  305.                     'class' => is_object($controller[0]) ? get_class($controller[0]) : $controller[0],
  306.                     'method' => $controller[1],
  307.                     'file' => $r->getFileName(),
  308.                     'line' => $r->getStartLine(),
  309.                 );
  310.             } catch (\ReflectionException $e) {
  311.                 if (is_callable($controller)) {
  312.                     // using __call or  __callStatic
  313.                     return array(
  314.                         'class' => is_object($controller[0]) ? get_class($controller[0]) : $controller[0],
  315.                         'method' => $controller[1],
  316.                         'file' => 'n/a',
  317.                         'line' => 'n/a',
  318.                     );
  319.                 }
  320.             }
  321.         }
  322.         if ($controller instanceof \Closure) {
  323.             $r = new \ReflectionFunction($controller);
  324.             return array(
  325.                 'class' => $r->getName(),
  326.                 'method' => null,
  327.                 'file' => $r->getFileName(),
  328.                 'line' => $r->getStartLine(),
  329.             );
  330.         }
  331.         if (is_object($controller)) {
  332.             $r = new \ReflectionClass($controller);
  333.             return array(
  334.                 'class' => $r->getName(),
  335.                 'method' => null,
  336.                 'file' => $r->getFileName(),
  337.                 'line' => $r->getStartLine(),
  338.             );
  339.         }
  340.         return is_string($controller) ? $controller 'n/a';
  341.     }
  342. }