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

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