vendor/symfony/http-kernel/DataCollector/RequestDataCollector.php line 362

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.         $dotenvVars = [];
  70.         foreach (explode(','$_SERVER['SYMFONY_DOTENV_VARS'] ?? $_ENV['SYMFONY_DOTENV_VARS'] ?? '') as $name) {
  71.             if ('' !== $name && isset($_ENV[$name])) {
  72.                 $dotenvVars[$name] = $_ENV[$name];
  73.             }
  74.         }
  75.         $this->data = [
  76.             'method' => $request->getMethod(),
  77.             'format' => $request->getRequestFormat(),
  78.             'content' => $content,
  79.             'content_type' => $response->headers->get('Content-Type''text/html'),
  80.             'status_text' => isset(Response::$statusTexts[$statusCode]) ? Response::$statusTexts[$statusCode] : '',
  81.             'status_code' => $statusCode,
  82.             'request_query' => $request->query->all(),
  83.             'request_request' => $request->request->all(),
  84.             'request_files' => $request->files->all(),
  85.             'request_headers' => $request->headers->all(),
  86.             'request_server' => $request->server->all(),
  87.             'request_cookies' => $request->cookies->all(),
  88.             'request_attributes' => $attributes,
  89.             'route' => $route,
  90.             'response_headers' => $response->headers->all(),
  91.             'response_cookies' => $responseCookies,
  92.             'session_metadata' => $sessionMetadata,
  93.             'session_attributes' => $sessionAttributes,
  94.             'flashes' => $flashes,
  95.             'path_info' => $request->getPathInfo(),
  96.             'controller' => 'n/a',
  97.             'locale' => $request->getLocale(),
  98.             'dotenv_vars' => $dotenvVars,
  99.         ];
  100.         if (isset($this->data['request_headers']['php-auth-pw'])) {
  101.             $this->data['request_headers']['php-auth-pw'] = '******';
  102.         }
  103.         if (isset($this->data['request_server']['PHP_AUTH_PW'])) {
  104.             $this->data['request_server']['PHP_AUTH_PW'] = '******';
  105.         }
  106.         if (isset($this->data['request_request']['_password'])) {
  107.             $this->data['request_request']['_password'] = '******';
  108.         }
  109.         foreach ($this->data as $key => $value) {
  110.             if (!\is_array($value)) {
  111.                 continue;
  112.             }
  113.             if ('request_headers' === $key || 'response_headers' === $key) {
  114.                 $this->data[$key] = array_map(function ($v) { return isset($v[0]) && !isset($v[1]) ? $v[0] : $v; }, $value);
  115.             }
  116.         }
  117.         if (isset($this->controllers[$request])) {
  118.             $this->data['controller'] = $this->parseController($this->controllers[$request]);
  119.             unset($this->controllers[$request]);
  120.         }
  121.         if ($request->attributes->has('_redirected') && $redirectCookie $request->cookies->get('sf_redirect')) {
  122.             $this->data['redirect'] = json_decode($redirectCookietrue);
  123.             $response->headers->clearCookie('sf_redirect');
  124.         }
  125.         if ($response->isRedirect()) {
  126.             $response->headers->setCookie(new Cookie(
  127.                 'sf_redirect',
  128.                 json_encode([
  129.                     'token' => $response->headers->get('x-debug-token'),
  130.                     'route' => $request->attributes->get('_route''n/a'),
  131.                     'method' => $request->getMethod(),
  132.                     'controller' => $this->parseController($request->attributes->get('_controller')),
  133.                     'status_code' => $statusCode,
  134.                     'status_text' => Response::$statusTexts[(int) $statusCode],
  135.                 ]),
  136.                 0'/'null$request->isSecure(), truefalse'lax'
  137.             ));
  138.         }
  139.         $this->data['identifier'] = $this->data['route'] ?: (\is_array($this->data['controller']) ? $this->data['controller']['class'].'::'.$this->data['controller']['method'].'()' $this->data['controller']);
  140.         if ($response->headers->has('x-previous-debug-token')) {
  141.             $this->data['forward_token'] = $response->headers->get('x-previous-debug-token');
  142.         }
  143.     }
  144.     public function lateCollect()
  145.     {
  146.         $this->data $this->cloneVar($this->data);
  147.     }
  148.     public function reset()
  149.     {
  150.         $this->data = [];
  151.         $this->controllers = new \SplObjectStorage();
  152.     }
  153.     public function getMethod()
  154.     {
  155.         return $this->data['method'];
  156.     }
  157.     public function getPathInfo()
  158.     {
  159.         return $this->data['path_info'];
  160.     }
  161.     public function getRequestRequest()
  162.     {
  163.         return new ParameterBag($this->data['request_request']->getValue());
  164.     }
  165.     public function getRequestQuery()
  166.     {
  167.         return new ParameterBag($this->data['request_query']->getValue());
  168.     }
  169.     public function getRequestFiles()
  170.     {
  171.         return new ParameterBag($this->data['request_files']->getValue());
  172.     }
  173.     public function getRequestHeaders()
  174.     {
  175.         return new ParameterBag($this->data['request_headers']->getValue());
  176.     }
  177.     public function getRequestServer($raw false)
  178.     {
  179.         return new ParameterBag($this->data['request_server']->getValue($raw));
  180.     }
  181.     public function getRequestCookies($raw false)
  182.     {
  183.         return new ParameterBag($this->data['request_cookies']->getValue($raw));
  184.     }
  185.     public function getRequestAttributes()
  186.     {
  187.         return new ParameterBag($this->data['request_attributes']->getValue());
  188.     }
  189.     public function getResponseHeaders()
  190.     {
  191.         return new ParameterBag($this->data['response_headers']->getValue());
  192.     }
  193.     public function getResponseCookies()
  194.     {
  195.         return new ParameterBag($this->data['response_cookies']->getValue());
  196.     }
  197.     public function getSessionMetadata()
  198.     {
  199.         return $this->data['session_metadata']->getValue();
  200.     }
  201.     public function getSessionAttributes()
  202.     {
  203.         return $this->data['session_attributes']->getValue();
  204.     }
  205.     public function getFlashes()
  206.     {
  207.         return $this->data['flashes']->getValue();
  208.     }
  209.     public function getContent()
  210.     {
  211.         return $this->data['content'];
  212.     }
  213.     public function isJsonRequest()
  214.     {
  215.         return === preg_match('{^application/(?:\w+\++)*json$}i'$this->data['request_headers']['content-type']);
  216.     }
  217.     public function getPrettyJson()
  218.     {
  219.         $decoded json_decode($this->getContent());
  220.         return JSON_ERROR_NONE === json_last_error() ? json_encode($decodedJSON_PRETTY_PRINT) : null;
  221.     }
  222.     public function getContentType()
  223.     {
  224.         return $this->data['content_type'];
  225.     }
  226.     public function getStatusText()
  227.     {
  228.         return $this->data['status_text'];
  229.     }
  230.     public function getStatusCode()
  231.     {
  232.         return $this->data['status_code'];
  233.     }
  234.     public function getFormat()
  235.     {
  236.         return $this->data['format'];
  237.     }
  238.     public function getLocale()
  239.     {
  240.         return $this->data['locale'];
  241.     }
  242.     public function getDotenvVars()
  243.     {
  244.         return new ParameterBag($this->data['dotenv_vars']->getValue());
  245.     }
  246.     /**
  247.      * Gets the route name.
  248.      *
  249.      * The _route request attributes is automatically set by the Router Matcher.
  250.      *
  251.      * @return string The route
  252.      */
  253.     public function getRoute()
  254.     {
  255.         return $this->data['route'];
  256.     }
  257.     public function getIdentifier()
  258.     {
  259.         return $this->data['identifier'];
  260.     }
  261.     /**
  262.      * Gets the route parameters.
  263.      *
  264.      * The _route_params request attributes is automatically set by the RouterListener.
  265.      *
  266.      * @return array The parameters
  267.      */
  268.     public function getRouteParams()
  269.     {
  270.         return isset($this->data['request_attributes']['_route_params']) ? $this->data['request_attributes']['_route_params']->getValue() : [];
  271.     }
  272.     /**
  273.      * Gets the parsed controller.
  274.      *
  275.      * @return array|string The controller as a string or array of data
  276.      *                      with keys 'class', 'method', 'file' and 'line'
  277.      */
  278.     public function getController()
  279.     {
  280.         return $this->data['controller'];
  281.     }
  282.     /**
  283.      * Gets the previous request attributes.
  284.      *
  285.      * @return array|bool A legacy array of data from the previous redirection response
  286.      *                    or false otherwise
  287.      */
  288.     public function getRedirect()
  289.     {
  290.         return isset($this->data['redirect']) ? $this->data['redirect'] : false;
  291.     }
  292.     public function getForwardToken()
  293.     {
  294.         return isset($this->data['forward_token']) ? $this->data['forward_token'] : null;
  295.     }
  296.     /**
  297.      * @final since Symfony 4.3
  298.      */
  299.     public function onKernelController(FilterControllerEvent $event)
  300.     {
  301.         $this->controllers[$event->getRequest()] = $event->getController();
  302.     }
  303.     /**
  304.      * @final since Symfony 4.3
  305.      */
  306.     public function onKernelResponse(FilterResponseEvent $event)
  307.     {
  308.         if (!$event->isMasterRequest()) {
  309.             return;
  310.         }
  311.         if ($event->getRequest()->cookies->has('sf_redirect')) {
  312.             $event->getRequest()->attributes->set('_redirected'true);
  313.         }
  314.     }
  315.     public static function getSubscribedEvents()
  316.     {
  317.         return [
  318.             KernelEvents::CONTROLLER => 'onKernelController',
  319.             KernelEvents::RESPONSE => 'onKernelResponse',
  320.         ];
  321.     }
  322.     /**
  323.      * {@inheritdoc}
  324.      */
  325.     public function getName()
  326.     {
  327.         return 'request';
  328.     }
  329.     /**
  330.      * Parse a controller.
  331.      *
  332.      * @param mixed $controller The controller to parse
  333.      *
  334.      * @return array|string An array of controller data or a simple string
  335.      */
  336.     protected function parseController($controller)
  337.     {
  338.         if (\is_string($controller) && false !== strpos($controller'::')) {
  339.             $controller explode('::'$controller);
  340.         }
  341.         if (\is_array($controller)) {
  342.             try {
  343.                 $r = new \ReflectionMethod($controller[0], $controller[1]);
  344.                 return [
  345.                     'class' => \is_object($controller[0]) ? \get_class($controller[0]) : $controller[0],
  346.                     'method' => $controller[1],
  347.                     'file' => $r->getFileName(),
  348.                     'line' => $r->getStartLine(),
  349.                 ];
  350.             } catch (\ReflectionException $e) {
  351.                 if (\is_callable($controller)) {
  352.                     // using __call or  __callStatic
  353.                     return [
  354.                         'class' => \is_object($controller[0]) ? \get_class($controller[0]) : $controller[0],
  355.                         'method' => $controller[1],
  356.                         'file' => 'n/a',
  357.                         'line' => 'n/a',
  358.                     ];
  359.                 }
  360.             }
  361.         }
  362.         if ($controller instanceof \Closure) {
  363.             $r = new \ReflectionFunction($controller);
  364.             $controller = [
  365.                 'class' => $r->getName(),
  366.                 'method' => null,
  367.                 'file' => $r->getFileName(),
  368.                 'line' => $r->getStartLine(),
  369.             ];
  370.             if (false !== strpos($r->name'{closure}')) {
  371.                 return $controller;
  372.             }
  373.             $controller['method'] = $r->name;
  374.             if ($class $r->getClosureScopeClass()) {
  375.                 $controller['class'] = $class->name;
  376.             } else {
  377.                 return $r->name;
  378.             }
  379.             return $controller;
  380.         }
  381.         if (\is_object($controller)) {
  382.             $r = new \ReflectionClass($controller);
  383.             return [
  384.                 'class' => $r->getName(),
  385.                 'method' => null,
  386.                 'file' => $r->getFileName(),
  387.                 'line' => $r->getStartLine(),
  388.             ];
  389.         }
  390.         return \is_string($controller) ? $controller 'n/a';
  391.     }
  392. }