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

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