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

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpKernel\DataCollector;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Cookie;
  16. use Symfony\Component\HttpFoundation\ParameterBag;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpFoundation\RequestStack;
  19. use Symfony\Component\HttpFoundation\Response;
  20. use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
  21. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  22. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  23. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  24. use Symfony\Component\HttpKernel\KernelEvents;
  25. use Symfony\Component\VarDumper\Cloner\Data;
  27. /**
  28.  * @author Fabien Potencier <fabien@symfony.com>
  29.  *
  30.  * @final
  31.  */
  32. class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
  33. {
  34.     /**
  35.      * @var \SplObjectStorage<Request, callable>
  36.      */
  37.     private \SplObjectStorage $controllers;
  38.     private array $sessionUsages = [];
  39.     private ?RequestStack $requestStack;
  41.     public function __construct(RequestStack $requestStack = null)
  42.     {
  43.         $this->controllers = new \SplObjectStorage();
  44.         $this->requestStack = $requestStack;
  45.     }
  47.     public function collect(Request $request, Response $response, \Throwable $exception = null)
  48.     {
  49.         // attributes are serialized and as they can be anything, they need to be converted to strings.
  50.         $attributes = [];
  51.         $route = '';
  52.         foreach ($request->attributes->all() as $key => $value) {
  53.             if ('_route' === $key) {
  54.                 $route = \is_object($value) ? $value->getPath() : $value;
  55.                 $attributes[$key] = $route;
  56.             } else {
  57.                 $attributes[$key] = $value;
  58.             }
  59.         }
  61.         $content = $request->getContent();
  63.         $sessionMetadata = [];
  64.         $sessionAttributes = [];
  65.         $flashes = [];
  66.         if ($request->hasSession()) {
  67.             $session = $request->getSession();
  68.             if ($session->isStarted()) {
  69.                 $sessionMetadata['Created'] = date(\DATE_RFC822, $session->getMetadataBag()->getCreated());
  70.                 $sessionMetadata['Last used'] = date(\DATE_RFC822, $session->getMetadataBag()->getLastUsed());
  71.                 $sessionMetadata['Lifetime'] = $session->getMetadataBag()->getLifetime();
  72.                 $sessionAttributes = $session->all();
  73.                 $flashes = $session->getFlashBag()->peekAll();
  74.             }
  75.         }
  77.         $statusCode = $response->getStatusCode();
  79.         $responseCookies = [];
  80.         foreach ($response->headers->getCookies() as $cookie) {
  81.             $responseCookies[$cookie->getName()] = $cookie;
  82.         }
  84.         $dotenvVars = [];
  85.         foreach (explode(',', $_SERVER['SYMFONY_DOTENV_VARS'] ?? $_ENV['SYMFONY_DOTENV_VARS'] ?? '') as $name) {
  86.             if ('' !== $name && isset($_ENV[$name])) {
  87.                 $dotenvVars[$name] = $_ENV[$name];
  88.             }
  89.         }
  91.         $this->data = [
  92.             'method' => $request->getMethod(),
  93.             'format' => $request->getRequestFormat(),
  94.             'content_type' => $response->headers->get('Content-Type', 'text/html'),
  95.             'status_text' => Response::$statusTexts[$statusCode] ?? '',
  96.             'status_code' => $statusCode,
  97.             'request_query' => $request->query->all(),
  98.             'request_request' => $request->request->all(),
  99.             'request_files' => $request->files->all(),
  100.             'request_headers' => $request->headers->all(),
  101.             'request_server' => $request->server->all(),
  102.             'request_cookies' => $request->cookies->all(),
  103.             'request_attributes' => $attributes,
  104.             'route' => $route,
  105.             'response_headers' => $response->headers->all(),
  106.             'response_cookies' => $responseCookies,
  107.             'session_metadata' => $sessionMetadata,
  108.             'session_attributes' => $sessionAttributes,
  109.             'session_usages' => array_values($this->sessionUsages),
  110.             'stateless_check' => $this->requestStack?->getMainRequest()?->attributes->get('_stateless') ?? false,
  111.             'flashes' => $flashes,
  112.             'path_info' => $request->getPathInfo(),
  113.             'controller' => 'n/a',
  114.             'locale' => $request->getLocale(),
  115.             'dotenv_vars' => $dotenvVars,
  116.         ];
  118.         if (isset($this->data['request_headers']['php-auth-pw'])) {
  119.             $this->data['request_headers']['php-auth-pw'] = '******';
  120.         }
  122.         if (isset($this->data['request_server']['PHP_AUTH_PW'])) {
  123.             $this->data['request_server']['PHP_AUTH_PW'] = '******';
  124.         }
  126.         if (isset($this->data['request_request']['_password'])) {
  127.             $encodedPassword = rawurlencode($this->data['request_request']['_password']);
  128.             $content = str_replace('_password='.$encodedPassword, '_password=******', $content);
  129.             $this->data['request_request']['_password'] = '******';
  130.         }
  132.         $this->data['content'] = $content;
  134.         foreach ($this->data as $key => $value) {
  135.             if (!\is_array($value)) {
  136.                 continue;
  137.             }
  138.             if ('request_headers' === $key || 'response_headers' === $key) {
  139.                 $this->data[$key] = array_map(function ($v) { return isset($v[0]) && !isset($v[1]) ? $v[0] : $v; }, $value);
  140.             }
  141.         }
  143.         if (isset($this->controllers[$request])) {
  144.             $this->data['controller'] = $this->parseController($this->controllers[$request]);
  145.             unset($this->controllers[$request]);
  146.         }
  148.         if ($request->attributes->has('_redirected') && $redirectCookie = $request->cookies->get('sf_redirect')) {
  149.             $this->data['redirect'] = json_decode($redirectCookie, true);
  151.             $response->headers->clearCookie('sf_redirect');
  152.         }
  154.         if ($response->isRedirect()) {
  155.             $response->headers->setCookie(new Cookie(
  156.                 'sf_redirect',
  157.                 json_encode([
  158.                     'token' => $response->headers->get('x-debug-token'),
  159.                     'route' => $request->attributes->get('_route', 'n/a'),
  160.                     'method' => $request->getMethod(),
  161.                     'controller' => $this->parseController($request->attributes->get('_controller')),
  162.                     'status_code' => $statusCode,
  163.                     'status_text' => Response::$statusTexts[$statusCode],
  164.                 ]),
  165.                 0, '/', null, $request->isSecure(), true, false, 'lax'
  166.             ));
  167.         }
  169.         $this->data['identifier'] = $this->data['route'] ?: (\is_array($this->data['controller']) ? $this->data['controller']['class'].'::'.$this->data['controller']['method'].'()' : $this->data['controller']);
  171.         if ($response->headers->has('x-previous-debug-token')) {
  172.             $this->data['forward_token'] = $response->headers->get('x-previous-debug-token');
  173.         }
  174.     }
  176.     public function lateCollect()
  177.     {
  178.         $this->data = $this->cloneVar($this->data);
  179.     }
  181.     public function reset()
  182.     {
  183.         $this->data = [];
  184.         $this->controllers = new \SplObjectStorage();
  185.         $this->sessionUsages = [];
  186.     }
  188.     public function getMethod()
  189.     {
  190.         return $this->data['method'];
  191.     }
  193.     public function getPathInfo()
  194.     {
  195.         return $this->data['path_info'];
  196.     }
  198.     public function getRequestRequest()
  199.     {
  200.         return new ParameterBag($this->data['request_request']->getValue());
  201.     }
  203.     public function getRequestQuery()
  204.     {
  205.         return new ParameterBag($this->data['request_query']->getValue());
  206.     }
  208.     public function getRequestFiles()
  209.     {
  210.         return new ParameterBag($this->data['request_files']->getValue());
  211.     }
  213.     public function getRequestHeaders()
  214.     {
  215.         return new ParameterBag($this->data['request_headers']->getValue());
  216.     }
  218.     public function getRequestServer(bool $raw = false)
  219.     {
  220.         return new ParameterBag($this->data['request_server']->getValue($raw));
  221.     }
  223.     public function getRequestCookies(bool $raw = false)
  224.     {
  225.         return new ParameterBag($this->data['request_cookies']->getValue($raw));
  226.     }
  228.     public function getRequestAttributes()
  229.     {
  230.         return new ParameterBag($this->data['request_attributes']->getValue());
  231.     }
  233.     public function getResponseHeaders()
  234.     {
  235.         return new ParameterBag($this->data['response_headers']->getValue());
  236.     }
  238.     public function getResponseCookies()
  239.     {
  240.         return new ParameterBag($this->data['response_cookies']->getValue());
  241.     }
  243.     public function getSessionMetadata()
  244.     {
  245.         return $this->data['session_metadata']->getValue();
  246.     }
  248.     public function getSessionAttributes()
  249.     {
  250.         return $this->data['session_attributes']->getValue();
  251.     }
  253.     public function getStatelessCheck()
  254.     {
  255.         return $this->data['stateless_check'];
  256.     }
  258.     public function getSessionUsages()
  259.     {
  260.         return $this->data['session_usages'];
  261.     }
  263.     public function getFlashes()
  264.     {
  265.         return $this->data['flashes']->getValue();
  266.     }
  268.     public function getContent()
  269.     {
  270.         return $this->data['content'];
  271.     }
  273.     public function isJsonRequest()
  274.     {
  275.         return 1 === preg_match('{^application/(?:\w+\++)*json$}i', $this->data['request_headers']['content-type']);
  276.     }
  278.     public function getPrettyJson()
  279.     {
  280.         $decoded = json_decode($this->getContent());
  282.         return \JSON_ERROR_NONE === json_last_error() ? json_encode($decoded, \JSON_PRETTY_PRINT) : null;
  283.     }
  285.     public function getContentType()
  286.     {
  287.         return $this->data['content_type'];
  288.     }
  290.     public function getStatusText()
  291.     {
  292.         return $this->data['status_text'];
  293.     }
  295.     public function getStatusCode()
  296.     {
  297.         return $this->data['status_code'];
  298.     }
  300.     public function getFormat()
  301.     {
  302.         return $this->data['format'];
  303.     }
  305.     public function getLocale()
  306.     {
  307.         return $this->data['locale'];
  308.     }
  310.     public function getDotenvVars()
  311.     {
  312.         return new ParameterBag($this->data['dotenv_vars']->getValue());
  313.     }
  315.     /**
  316.      * Gets the route name.
  317.      *
  318.      * The _route request attributes is automatically set by the Router Matcher.
  319.      */
  320.     public function getRoute(): string
  321.     {
  322.         return $this->data['route'];
  323.     }
  325.     public function getIdentifier()
  326.     {
  327.         return $this->data['identifier'];
  328.     }
  330.     /**
  331.      * Gets the route parameters.
  332.      *
  333.      * The _route_params request attributes is automatically set by the RouterListener.
  334.      */
  335.     public function getRouteParams(): array
  336.     {
  337.         return isset($this->data['request_attributes']['_route_params']) ? $this->data['request_attributes']['_route_params']->getValue() : [];
  338.     }
  340.     /**
  341.      * Gets the parsed controller.
  342.      *
  343.      * @return array|string|Data The controller as a string or array of data
  344.      *                           with keys 'class', 'method', 'file' and 'line'
  345.      */
  346.     public function getController(): array|string|Data
  347.     {
  348.         return $this->data['controller'];
  349.     }
  351.     /**
  352.      * Gets the previous request attributes.
  353.      *
  354.      * @return array|Data|false A legacy array of data from the previous redirection response
  355.      *                          or false otherwise
  356.      */
  357.     public function getRedirect(): array|Data|false
  358.     {
  359.         return $this->data['redirect'] ?? false;
  360.     }
  362.     public function getForwardToken()
  363.     {
  364.         return $this->data['forward_token'] ?? null;
  365.     }
  367.     public function onKernelController(ControllerEvent $event)
  368.     {
  369.         $this->controllers[$event->getRequest()] = $event->getController();
  370.     }
  372.     public function onKernelResponse(ResponseEvent $event)
  373.     {
  374.         if (!$event->isMainRequest()) {
  375.             return;
  376.         }
  378.         if ($event->getRequest()->cookies->has('sf_redirect')) {
  379.             $event->getRequest()->attributes->set('_redirected', true);
  380.         }
  381.     }
  383.     public static function getSubscribedEvents(): array
  384.     {
  385.         return [
  386.             KernelEvents::CONTROLLER => 'onKernelController',
  387.             KernelEvents::RESPONSE => 'onKernelResponse',
  388.         ];
  389.     }
  391.     public function getName(): string
  392.     {
  393.         return 'request';
  394.     }
  396.     public function collectSessionUsage(): void
  397.     {
  398.         $trace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS);
  400.         $traceEndIndex = \count($trace) - 1;
  401.         for ($i = $traceEndIndex; $i > 0; --$i) {
  402.             if (null !== ($class = $trace[$i]['class'] ?? null) && (is_subclass_of($class, SessionInterface::class) || is_subclass_of($class, SessionBagInterface::class))) {
  403.                 $traceEndIndex = $i;
  404.                 break;
  405.             }
  406.         }
  408.         if ((\count($trace) - 1) === $traceEndIndex) {
  409.             return;
  410.         }
  412.         // Remove part of the backtrace that belongs to session only
  413.         array_splice($trace, 0, $traceEndIndex);
  415.         // Merge identical backtraces generated by internal call reports
  416.         $name = sprintf('%s:%s', $trace[1]['class'] ?? $trace[0]['file'], $trace[0]['line']);
  417.         if (!\array_key_exists($name, $this->sessionUsages)) {
  418.             $this->sessionUsages[$name] = [
  419.                 'name' => $name,
  420.                 'file' => $trace[0]['file'],
  421.                 'line' => $trace[0]['line'],
  422.                 'trace' => $trace,
  423.             ];
  424.         }
  425.     }
  427.     /**
  428.      * @return array|string An array of controller data or a simple string
  429.      */
  430.     private function parseController(array|object|string|null $controller): array|string
  431.     {
  432.         if (\is_string($controller) && str_contains($controller, '::')) {
  433.             $controller = explode('::', $controller);
  434.         }
  436.         if (\is_array($controller)) {
  437.             try {
  438.                 $r = new \ReflectionMethod($controller[0], $controller[1]);
  440.                 return [
  441.                     'class' => \is_object($controller[0]) ? get_debug_type($controller[0]) : $controller[0],
  442.                     'method' => $controller[1],
  443.                     'file' => $r->getFileName(),
  444.                     'line' => $r->getStartLine(),
  445.                 ];
  446.             } catch (\ReflectionException) {
  447.                 if (\is_callable($controller)) {
  448.                     // using __call or  __callStatic
  449.                     return [
  450.                         'class' => \is_object($controller[0]) ? get_debug_type($controller[0]) : $controller[0],
  451.                         'method' => $controller[1],
  452.                         'file' => 'n/a',
  453.                         'line' => 'n/a',
  454.                     ];
  455.                 }
  456.             }
  457.         }
  459.         if ($controller instanceof \Closure) {
  460.             $r = new \ReflectionFunction($controller);
  462.             $controller = [
  463.                 'class' => $r->getName(),
  464.                 'method' => null,
  465.                 'file' => $r->getFileName(),
  466.                 'line' => $r->getStartLine(),
  467.             ];
  469.             if (str_contains($r->name, '{closure}')) {
  470.                 return $controller;
  471.             }
  472.             $controller['method'] = $r->name;
  474.             if ($class = \PHP_VERSION_ID >= 80111 ? $r->getClosureCalledClass() : $r->getClosureScopeClass()) {
  475.                 $controller['class'] = $class->name;
  476.             } else {
  477.                 return $r->name;
  478.             }
  480.             return $controller;
  481.         }
  483.         if (\is_object($controller)) {
  484.             $r = new \ReflectionClass($controller);
  486.             return [
  487.                 'class' => $r->getName(),
  488.                 'method' => null,
  489.                 'file' => $r->getFileName(),
  490.                 'line' => $r->getStartLine(),
  491.             ];
  492.         }
  494.         return \is_string($controller) ? $controller : 'n/a';
  495.     }
  496. }