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

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