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

Open in your IDE?
  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;
  26. /**
  27.  * @author Fabien Potencier <fabien@symfony.com>
  28.  *
  29.  * @final
  30.  */
  31. class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
  32. {
  33.     protected $controllers;
  34.     private $sessionUsages = [];
  35.     private $requestStack;
  37.     public function __construct(RequestStack $requestStack = null)
  38.     {
  39.         $this->controllers = new \SplObjectStorage();
  40.         $this->requestStack = $requestStack;
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function collect(Request $request, Response $response, \Throwable $exception = null)
  47.     {
  48.         // attributes are serialized and as they can be anything, they need to be converted to strings.
  49.         $attributes = [];
  50.         $route = '';
  51.         foreach ($request->attributes->all() as $key => $value) {
  52.             if ('_route' === $key) {
  53.                 $route = \is_object($value) ? $value->getPath() : $value;
  54.                 $attributes[$key] = $route;
  55.             } else {
  56.                 $attributes[$key] = $value;
  57.             }
  58.         }
  60.         $content = $request->getContent();
  62.         $sessionMetadata = [];
  63.         $sessionAttributes = [];
  64.         $flashes = [];
  65.         if ($request->hasSession()) {
  66.             $session = $request->getSession();
  67.             if ($session->isStarted()) {
  68.                 $sessionMetadata['Created'] = date(\DATE_RFC822, $session->getMetadataBag()->getCreated());
  69.                 $sessionMetadata['Last used'] = date(\DATE_RFC822, $session->getMetadataBag()->getLastUsed());
  70.                 $sessionMetadata['Lifetime'] = $session->getMetadataBag()->getLifetime();
  71.                 $sessionAttributes = $session->all();
  72.                 $flashes = $session->getFlashBag()->peekAll();
  73.             }
  74.         }
  76.         $statusCode = $response->getStatusCode();
  78.         $responseCookies = [];
  79.         foreach ($response->headers->getCookies() as $cookie) {
  80.             $responseCookies[$cookie->getName()] = $cookie;
  81.         }
  83.         $dotenvVars = [];
  84.         foreach (explode(',', $_SERVER['SYMFONY_DOTENV_VARS'] ?? $_ENV['SYMFONY_DOTENV_VARS'] ?? '') as $name) {
  85.             if ('' !== $name && isset($_ENV[$name])) {
  86.                 $dotenvVars[$name] = $_ENV[$name];
  87.             }
  88.         }
  90.         $this->data = [
  91.             'method' => $request->getMethod(),
  92.             'format' => $request->getRequestFormat(),
  93.             'content_type' => $response->headers->get('Content-Type', 'text/html'),
  94.             'status_text' => Response::$statusTexts[$statusCode] ?? '',
  95.             'status_code' => $statusCode,
  96.             'request_query' => $request->query->all(),
  97.             'request_request' => $request->request->all(),
  98.             'request_files' => $request->files->all(),
  99.             'request_headers' => $request->headers->all(),
  100.             'request_server' => $request->server->all(),
  101.             'request_cookies' => $request->cookies->all(),
  102.             'request_attributes' => $attributes,
  103.             'route' => $route,
  104.             'response_headers' => $response->headers->all(),
  105.             'response_cookies' => $responseCookies,
  106.             'session_metadata' => $sessionMetadata,
  107.             'session_attributes' => $sessionAttributes,
  108.             'session_usages' => array_values($this->sessionUsages),
  109.             'stateless_check' => $this->requestStack && $this->requestStack->getMainRequest()->attributes->get('_stateless', false),
  110.             'flashes' => $flashes,
  111.             'path_info' => $request->getPathInfo(),
  112.             'controller' => 'n/a',
  113.             'locale' => $request->getLocale(),
  114.             'dotenv_vars' => $dotenvVars,
  115.         ];
  117.         if (isset($this->data['request_headers']['php-auth-pw'])) {
  118.             $this->data['request_headers']['php-auth-pw'] = '******';
  119.         }
  121.         if (isset($this->data['request_server']['PHP_AUTH_PW'])) {
  122.             $this->data['request_server']['PHP_AUTH_PW'] = '******';
  123.         }
  125.         if (isset($this->data['request_request']['_password'])) {
  126.             $encodedPassword = rawurlencode($this->data['request_request']['_password']);
  127.             $content = str_replace('_password='.$encodedPassword, '_password=******', $content);
  128.             $this->data['request_request']['_password'] = '******';
  129.         }
  131.         $this->data['content'] = $content;
  133.         foreach ($this->data as $key => $value) {
  134.             if (!\is_array($value)) {
  135.                 continue;
  136.             }
  137.             if ('request_headers' === $key || 'response_headers' === $key) {
  138.                 $this->data[$key] = array_map(function ($v) { return isset($v[0]) && !isset($v[1]) ? $v[0] : $v; }, $value);
  139.             }
  140.         }
  142.         if (isset($this->controllers[$request])) {
  143.             $this->data['controller'] = $this->parseController($this->controllers[$request]);
  144.             unset($this->controllers[$request]);
  145.         }
  147.         if ($request->attributes->has('_redirected') && $redirectCookie = $request->cookies->get('sf_redirect')) {
  148.             $this->data['redirect'] = json_decode($redirectCookie, true);
  150.             $response->headers->clearCookie('sf_redirect');
  151.         }
  153.         if ($response->isRedirect()) {
  154.             $response->headers->setCookie(new Cookie(
  155.                 'sf_redirect',
  156.                 json_encode([
  157.                     'token' => $response->headers->get('x-debug-token'),
  158.                     'route' => $request->attributes->get('_route', 'n/a'),
  159.                     'method' => $request->getMethod(),
  160.                     'controller' => $this->parseController($request->attributes->get('_controller')),
  161.                     'status_code' => $statusCode,
  162.                     'status_text' => Response::$statusTexts[$statusCode],
  163.                 ]),
  164.                 0, '/', null, $request->isSecure(), true, false, 'lax'
  165.             ));
  166.         }
  168.         $this->data['identifier'] = $this->data['route'] ?: (\is_array($this->data['controller']) ? $this->data['controller']['class'].'::'.$this->data['controller']['method'].'()' : $this->data['controller']);
  170.         if ($response->headers->has('x-previous-debug-token')) {
  171.             $this->data['forward_token'] = $response->headers->get('x-previous-debug-token');
  172.         }
  173.     }
  175.     public function lateCollect()
  176.     {
  177.         $this->data = $this->cloneVar($this->data);
  178.     }
  180.     public function reset()
  181.     {
  182.         $this->data = [];
  183.         $this->controllers = new \SplObjectStorage();
  184.         $this->sessionUsages = [];
  185.     }
  187.     public function getMethod()
  188.     {
  189.         return $this->data['method'];
  190.     }
  192.     public function getPathInfo()
  193.     {
  194.         return $this->data['path_info'];
  195.     }
  197.     public function getRequestRequest()
  198.     {
  199.         return new ParameterBag($this->data['request_request']->getValue());
  200.     }
  202.     public function getRequestQuery()
  203.     {
  204.         return new ParameterBag($this->data['request_query']->getValue());
  205.     }
  207.     public function getRequestFiles()
  208.     {
  209.         return new ParameterBag($this->data['request_files']->getValue());
  210.     }
  212.     public function getRequestHeaders()
  213.     {
  214.         return new ParameterBag($this->data['request_headers']->getValue());
  215.     }
  217.     public function getRequestServer(bool $raw = false)
  218.     {
  219.         return new ParameterBag($this->data['request_server']->getValue($raw));
  220.     }
  222.     public function getRequestCookies(bool $raw = false)
  223.     {
  224.         return new ParameterBag($this->data['request_cookies']->getValue($raw));
  225.     }
  227.     public function getRequestAttributes()
  228.     {
  229.         return new ParameterBag($this->data['request_attributes']->getValue());
  230.     }
  232.     public function getResponseHeaders()
  233.     {
  234.         return new ParameterBag($this->data['response_headers']->getValue());
  235.     }
  237.     public function getResponseCookies()
  238.     {
  239.         return new ParameterBag($this->data['response_cookies']->getValue());
  240.     }
  242.     public function getSessionMetadata()
  243.     {
  244.         return $this->data['session_metadata']->getValue();
  245.     }
  247.     public function getSessionAttributes()
  248.     {
  249.         return $this->data['session_attributes']->getValue();
  250.     }
  252.     public function getStatelessCheck()
  253.     {
  254.         return $this->data['stateless_check'];
  255.     }
  257.     public function getSessionUsages()
  258.     {
  259.         return $this->data['session_usages'];
  260.     }
  262.     public function getFlashes()
  263.     {
  264.         return $this->data['flashes']->getValue();
  265.     }
  267.     public function getContent()
  268.     {
  269.         return $this->data['content'];
  270.     }
  272.     public function isJsonRequest()
  273.     {
  274.         return 1 === preg_match('{^application/(?:\w+\++)*json$}i', $this->data['request_headers']['content-type']);
  275.     }
  277.     public function getPrettyJson()
  278.     {
  279.         $decoded = json_decode($this->getContent());
  281.         return \JSON_ERROR_NONE === json_last_error() ? json_encode($decoded, \JSON_PRETTY_PRINT) : null;
  282.     }
  284.     public function getContentType()
  285.     {
  286.         return $this->data['content_type'];
  287.     }
  289.     public function getStatusText()
  290.     {
  291.         return $this->data['status_text'];
  292.     }
  294.     public function getStatusCode()
  295.     {
  296.         return $this->data['status_code'];
  297.     }
  299.     public function getFormat()
  300.     {
  301.         return $this->data['format'];
  302.     }
  304.     public function getLocale()
  305.     {
  306.         return $this->data['locale'];
  307.     }
  309.     public function getDotenvVars()
  310.     {
  311.         return new ParameterBag($this->data['dotenv_vars']->getValue());
  312.     }
  314.     /**
  315.      * Gets the route name.
  316.      *
  317.      * The _route request attributes is automatically set by the Router Matcher.
  318.      *
  319.      * @return string The route
  320.      */
  321.     public function getRoute()
  322.     {
  323.         return $this->data['route'];
  324.     }
  326.     public function getIdentifier()
  327.     {
  328.         return $this->data['identifier'];
  329.     }
  331.     /**
  332.      * Gets the route parameters.
  333.      *
  334.      * The _route_params request attributes is automatically set by the RouterListener.
  335.      *
  336.      * @return array The parameters
  337.      */
  338.     public function getRouteParams()
  339.     {
  340.         return isset($this->data['request_attributes']['_route_params']) ? $this->data['request_attributes']['_route_params']->getValue() : [];
  341.     }
  343.     /**
  344.      * Gets the parsed controller.
  345.      *
  346.      * @return array|string The controller as a string or array of data
  347.      *                      with keys 'class', 'method', 'file' and 'line'
  348.      */
  349.     public function getController()
  350.     {
  351.         return $this->data['controller'];
  352.     }
  354.     /**
  355.      * Gets the previous request attributes.
  356.      *
  357.      * @return array|bool A legacy array of data from the previous redirection response
  358.      *                    or false otherwise
  359.      */
  360.     public function getRedirect()
  361.     {
  362.         return $this->data['redirect'] ?? false;
  363.     }
  365.     public function getForwardToken()
  366.     {
  367.         return $this->data['forward_token'] ?? null;
  368.     }
  370.     public function onKernelController(ControllerEvent $event)
  371.     {
  372.         $this->controllers[$event->getRequest()] = $event->getController();
  373.     }
  375.     public function onKernelResponse(ResponseEvent $event)
  376.     {
  377.         if (!$event->isMainRequest()) {
  378.             return;
  379.         }
  381.         if ($event->getRequest()->cookies->has('sf_redirect')) {
  382.             $event->getRequest()->attributes->set('_redirected', true);
  383.         }
  384.     }
  386.     public static function getSubscribedEvents()
  387.     {
  388.         return [
  389.             KernelEvents::CONTROLLER => 'onKernelController',
  390.             KernelEvents::RESPONSE => 'onKernelResponse',
  391.         ];
  392.     }
  394.     /**
  395.      * {@inheritdoc}
  396.      */
  397.     public function getName()
  398.     {
  399.         return 'request';
  400.     }
  402.     public function collectSessionUsage(): void
  403.     {
  404.         $trace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS);
  406.         $traceEndIndex = \count($trace) - 1;
  407.         for ($i = $traceEndIndex; $i > 0; --$i) {
  408.             if (null !== ($class = $trace[$i]['class'] ?? null) && (is_subclass_of($class, SessionInterface::class) || is_subclass_of($class, SessionBagInterface::class))) {
  409.                 $traceEndIndex = $i;
  410.                 break;
  411.             }
  412.         }
  414.         if ((\count($trace) - 1) === $traceEndIndex) {
  415.             return;
  416.         }
  418.         // Remove part of the backtrace that belongs to session only
  419.         array_splice($trace, 0, $traceEndIndex);
  421.         // Merge identical backtraces generated by internal call reports
  422.         $name = sprintf('%s:%s', $trace[1]['class'] ?? $trace[0]['file'], $trace[0]['line']);
  423.         if (!\array_key_exists($name, $this->sessionUsages)) {
  424.             $this->sessionUsages[$name] = [
  425.                 'name' => $name,
  426.                 'file' => $trace[0]['file'],
  427.                 'line' => $trace[0]['line'],
  428.                 'trace' => $trace,
  429.             ];
  430.         }
  431.     }
  433.     /**
  434.      * Parse a controller.
  435.      *
  436.      * @param string|object|array|null $controller The controller to parse
  437.      *
  438.      * @return array|string An array of controller data or a simple string
  439.      */
  440.     protected function parseController($controller)
  441.     {
  442.         if (\is_string($controller) && str_contains($controller, '::')) {
  443.             $controller = explode('::', $controller);
  444.         }
  446.         if (\is_array($controller)) {
  447.             try {
  448.                 $r = new \ReflectionMethod($controller[0], $controller[1]);
  450.                 return [
  451.                     'class' => \is_object($controller[0]) ? get_debug_type($controller[0]) : $controller[0],
  452.                     'method' => $controller[1],
  453.                     'file' => $r->getFileName(),
  454.                     'line' => $r->getStartLine(),
  455.                 ];
  456.             } catch (\ReflectionException $e) {
  457.                 if (\is_callable($controller)) {
  458.                     // using __call or  __callStatic
  459.                     return [
  460.                         'class' => \is_object($controller[0]) ? get_debug_type($controller[0]) : $controller[0],
  461.                         'method' => $controller[1],
  462.                         'file' => 'n/a',
  463.                         'line' => 'n/a',
  464.                     ];
  465.                 }
  466.             }
  467.         }
  469.         if ($controller instanceof \Closure) {
  470.             $r = new \ReflectionFunction($controller);
  472.             $controller = [
  473.                 'class' => $r->getName(),
  474.                 'method' => null,
  475.                 'file' => $r->getFileName(),
  476.                 'line' => $r->getStartLine(),
  477.             ];
  479.             if (str_contains($r->name, '{closure}')) {
  480.                 return $controller;
  481.             }
  482.             $controller['method'] = $r->name;
  484.             if ($class = $r->getClosureScopeClass()) {
  485.                 $controller['class'] = $class->name;
  486.             } else {
  487.                 return $r->name;
  488.             }
  490.             return $controller;
  491.         }
  493.         if (\is_object($controller)) {
  494.             $r = new \ReflectionClass($controller);
  496.             return [
  497.                 'class' => $r->getName(),
  498.                 'method' => null,
  499.                 'file' => $r->getFileName(),
  500.                 'line' => $r->getStartLine(),
  501.             ];
  502.         }
  504.         return \is_string($controller) ? $controller : 'n/a';
  505.     }
  506. }