vendor/symfony/http-foundation/Request.php line 773

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\HttpFoundation;
  14. use Symfony\Component\HttpFoundation\Exception\BadRequestException;
  15. use Symfony\Component\HttpFoundation\Exception\ConflictingHeadersException;
  16. use Symfony\Component\HttpFoundation\Exception\JsonException;
  17. use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
  18. use Symfony\Component\HttpFoundation\Exception\SuspiciousOperationException;
  19. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  21. // Help opcache.preload discover always-needed symbols
  22. class_exists(AcceptHeader::class);
  23. class_exists(FileBag::class);
  24. class_exists(HeaderBag::class);
  25. class_exists(HeaderUtils::class);
  26. class_exists(InputBag::class);
  27. class_exists(ParameterBag::class);
  28. class_exists(ServerBag::class);
  30. /**
  31.  * Request represents an HTTP request.
  32.  *
  33.  * The methods dealing with URL accept / return a raw path (% encoded):
  34.  *   * getBasePath
  35.  *   * getBaseUrl
  36.  *   * getPathInfo
  37.  *   * getRequestUri
  38.  *   * getUri
  39.  *   * getUriForPath
  40.  *
  41.  * @author Fabien Potencier <fabien@symfony.com>
  42.  */
  43. class Request
  44. {
  45.     public const HEADER_FORWARDED = 0b000001; // When using RFC 7239
  46.     public const HEADER_X_FORWARDED_FOR = 0b000010;
  47.     public const HEADER_X_FORWARDED_HOST = 0b000100;
  48.     public const HEADER_X_FORWARDED_PROTO = 0b001000;
  49.     public const HEADER_X_FORWARDED_PORT = 0b010000;
  50.     public const HEADER_X_FORWARDED_PREFIX = 0b100000;
  52.     public const HEADER_X_FORWARDED_AWS_ELB = 0b0011010; // AWS ELB doesn't send X-Forwarded-Host
  53.     public const HEADER_X_FORWARDED_TRAEFIK = 0b0111110; // All "X-Forwarded-*" headers sent by Traefik reverse proxy
  55.     public const METHOD_HEAD = 'HEAD';
  56.     public const METHOD_GET = 'GET';
  57.     public const METHOD_POST = 'POST';
  58.     public const METHOD_PUT = 'PUT';
  59.     public const METHOD_PATCH = 'PATCH';
  60.     public const METHOD_DELETE = 'DELETE';
  61.     public const METHOD_PURGE = 'PURGE';
  62.     public const METHOD_OPTIONS = 'OPTIONS';
  63.     public const METHOD_TRACE = 'TRACE';
  64.     public const METHOD_CONNECT = 'CONNECT';
  66.     /**
  67.      * @var string[]
  68.      */
  69.     protected static $trustedProxies = [];
  71.     /**
  72.      * @var string[]
  73.      */
  74.     protected static $trustedHostPatterns = [];
  76.     /**
  77.      * @var string[]
  78.      */
  79.     protected static $trustedHosts = [];
  81.     protected static $httpMethodParameterOverride = false;
  83.     /**
  84.      * Custom parameters.
  85.      *
  86.      * @var ParameterBag
  87.      */
  88.     public $attributes;
  90.     /**
  91.      * Request body parameters ($_POST).
  92.      *
  93.      * @see getPayload() for portability between content types
  94.      *
  95.      * @var InputBag
  96.      */
  97.     public $request;
  99.     /**
  100.      * Query string parameters ($_GET).
  101.      *
  102.      * @var InputBag
  103.      */
  104.     public $query;
  106.     /**
  107.      * Server and execution environment parameters ($_SERVER).
  108.      *
  109.      * @var ServerBag
  110.      */
  111.     public $server;
  113.     /**
  114.      * Uploaded files ($_FILES).
  115.      *
  116.      * @var FileBag
  117.      */
  118.     public $files;
  120.     /**
  121.      * Cookies ($_COOKIE).
  122.      *
  123.      * @var InputBag
  124.      */
  125.     public $cookies;
  127.     /**
  128.      * Headers (taken from the $_SERVER).
  129.      *
  130.      * @var HeaderBag
  131.      */
  132.     public $headers;
  134.     /**
  135.      * @var string|resource|false|null
  136.      */
  137.     protected $content;
  139.     /**
  140.      * @var string[]|null
  141.      */
  142.     protected $languages;
  144.     /**
  145.      * @var string[]|null
  146.      */
  147.     protected $charsets;
  149.     /**
  150.      * @var string[]|null
  151.      */
  152.     protected $encodings;
  154.     /**
  155.      * @var string[]|null
  156.      */
  157.     protected $acceptableContentTypes;
  159.     /**
  160.      * @var string|null
  161.      */
  162.     protected $pathInfo;
  164.     /**
  165.      * @var string|null
  166.      */
  167.     protected $requestUri;
  169.     /**
  170.      * @var string|null
  171.      */
  172.     protected $baseUrl;
  174.     /**
  175.      * @var string|null
  176.      */
  177.     protected $basePath;
  179.     /**
  180.      * @var string|null
  181.      */
  182.     protected $method;
  184.     /**
  185.      * @var string|null
  186.      */
  187.     protected $format;
  189.     /**
  190.      * @var SessionInterface|callable():SessionInterface|null
  191.      */
  192.     protected $session;
  194.     /**
  195.      * @var string|null
  196.      */
  197.     protected $locale;
  199.     /**
  200.      * @var string
  201.      */
  202.     protected $defaultLocale = 'en';
  204.     /**
  205.      * @var array<string, string[]>|null
  206.      */
  207.     protected static $formats;
  209.     protected static $requestFactory;
  211.     private ?string $preferredFormat = null;
  212.     private bool $isHostValid = true;
  213.     private bool $isForwardedValid = true;
  214.     private bool $isSafeContentPreferred;
  216.     private array $trustedValuesCache = [];
  218.     private static int $trustedHeaderSet = -1;
  220.     private const FORWARDED_PARAMS = [
  221.         self::HEADER_X_FORWARDED_FOR => 'for',
  222.         self::HEADER_X_FORWARDED_HOST => 'host',
  223.         self::HEADER_X_FORWARDED_PROTO => 'proto',
  224.         self::HEADER_X_FORWARDED_PORT => 'host',
  225.     ];
  227.     /**
  228.      * Names for headers that can be trusted when
  229.      * using trusted proxies.
  230.      *
  231.      * The FORWARDED header is the standard as of rfc7239.
  232.      *
  233.      * The other headers are non-standard, but widely used
  234.      * by popular reverse proxies (like Apache mod_proxy or Amazon EC2).
  235.      */
  236.     private const TRUSTED_HEADERS = [
  237.         self::HEADER_FORWARDED => 'FORWARDED',
  238.         self::HEADER_X_FORWARDED_FOR => 'X_FORWARDED_FOR',
  239.         self::HEADER_X_FORWARDED_HOST => 'X_FORWARDED_HOST',
  240.         self::HEADER_X_FORWARDED_PROTO => 'X_FORWARDED_PROTO',
  241.         self::HEADER_X_FORWARDED_PORT => 'X_FORWARDED_PORT',
  242.         self::HEADER_X_FORWARDED_PREFIX => 'X_FORWARDED_PREFIX',
  243.     ];
  245.     /** @var bool */
  246.     private $isIisRewrite = false;
  248.     /**
  249.      * @param array                $query      The GET parameters
  250.      * @param array                $request    The POST parameters
  251.      * @param array                $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  252.      * @param array                $cookies    The COOKIE parameters
  253.      * @param array                $files      The FILES parameters
  254.      * @param array                $server     The SERVER parameters
  255.      * @param string|resource|null $content    The raw body data
  256.      */
  257.     public function __construct(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
  258.     {
  259.         $this->initialize($query, $request, $attributes, $cookies, $files, $server, $content);
  260.     }
  262.     /**
  263.      * Sets the parameters for this request.
  264.      *
  265.      * This method also re-initializes all properties.
  266.      *
  267.      * @param array                $query      The GET parameters
  268.      * @param array                $request    The POST parameters
  269.      * @param array                $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  270.      * @param array                $cookies    The COOKIE parameters
  271.      * @param array                $files      The FILES parameters
  272.      * @param array                $server     The SERVER parameters
  273.      * @param string|resource|null $content    The raw body data
  274.      *
  275.      * @return void
  276.      */
  277.     public function initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
  278.     {
  279.         $this->request = new InputBag($request);
  280.         $this->query = new InputBag($query);
  281.         $this->attributes = new ParameterBag($attributes);
  282.         $this->cookies = new InputBag($cookies);
  283.         $this->files = new FileBag($files);
  284.         $this->server = new ServerBag($server);
  285.         $this->headers = new HeaderBag($this->server->getHeaders());
  287.         $this->content = $content;
  288.         $this->languages = null;
  289.         $this->charsets = null;
  290.         $this->encodings = null;
  291.         $this->acceptableContentTypes = null;
  292.         $this->pathInfo = null;
  293.         $this->requestUri = null;
  294.         $this->baseUrl = null;
  295.         $this->basePath = null;
  296.         $this->method = null;
  297.         $this->format = null;
  298.     }
  300.     /**
  301.      * Creates a new request with values from PHP's super globals.
  302.      */
  303.     public static function createFromGlobals(): static
  304.     {
  305.         $request = self::createRequestFromFactory($_GET, $_POST, [], $_COOKIE, $_FILES, $_SERVER);
  307.         if (str_starts_with($request->headers->get('CONTENT_TYPE', ''), 'application/x-www-form-urlencoded')
  308.             && \in_array(strtoupper($request->server->get('REQUEST_METHOD', 'GET')), ['PUT', 'DELETE', 'PATCH'])
  309.         ) {
  310.             parse_str($request->getContent(), $data);
  311.             $request->request = new InputBag($data);
  312.         }
  314.         return $request;
  315.     }
  317.     /**
  318.      * Creates a Request based on a given URI and configuration.
  319.      *
  320.      * The information contained in the URI always take precedence
  321.      * over the other information (server and parameters).
  322.      *
  323.      * @param string               $uri        The URI
  324.      * @param string               $method     The HTTP method
  325.      * @param array                $parameters The query (GET) or request (POST) parameters
  326.      * @param array                $cookies    The request cookies ($_COOKIE)
  327.      * @param array                $files      The request files ($_FILES)
  328.      * @param array                $server     The server parameters ($_SERVER)
  329.      * @param string|resource|null $content    The raw body data
  330.      *
  331.      * @throws BadRequestException When the URI is invalid
  332.      */
  333.     public static function create(string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], $content = null): static
  334.     {
  335.         $server = array_replace([
  336.             'SERVER_NAME' => 'localhost',
  337.             'SERVER_PORT' => 80,
  338.             'HTTP_HOST' => 'localhost',
  339.             'HTTP_USER_AGENT' => 'Symfony',
  340.             'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
  341.             'HTTP_ACCEPT_LANGUAGE' => 'en-us,en;q=0.5',
  342.             'HTTP_ACCEPT_CHARSET' => 'ISO-8859-1,utf-8;q=0.7,*;q=0.7',
  343.             'REMOTE_ADDR' => '127.0.0.1',
  344.             'SCRIPT_NAME' => '',
  345.             'SCRIPT_FILENAME' => '',
  346.             'SERVER_PROTOCOL' => 'HTTP/1.1',
  347.             'REQUEST_TIME' => time(),
  348.             'REQUEST_TIME_FLOAT' => microtime(true),
  349.         ], $server);
  351.         $server['PATH_INFO'] = '';
  352.         $server['REQUEST_METHOD'] = strtoupper($method);
  354.         if (($i = strcspn($uri, ':/?#')) && ':' === ($uri[$i] ?? null) && (strspn($uri, 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-.') !== $i || strcspn($uri, 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'))) {
  355.             throw new BadRequestException('Invalid URI: Scheme is malformed.');
  356.         }
  357.         if (false === $components = parse_url(\strlen($uri) !== strcspn($uri, '?#') ? $uri : $uri.'#')) {
  358.             throw new BadRequestException('Invalid URI.');
  359.         }
  361.         $part = ($components['user'] ?? '').':'.($components['pass'] ?? '');
  363.         if (':' !== $part && \strlen($part) !== strcspn($part, '[]')) {
  364.             throw new BadRequestException('Invalid URI: Userinfo is malformed.');
  365.         }
  366.         if (($part = $components['host'] ?? '') && !self::isHostValid($part)) {
  367.             throw new BadRequestException('Invalid URI: Host is malformed.');
  368.         }
  369.         if (false !== ($i = strpos($uri, '\\')) && $i < strcspn($uri, '?#')) {
  370.             throw new BadRequestException('Invalid URI: A URI cannot contain a backslash.');
  371.         }
  372.         if (\strlen($uri) !== strcspn($uri, "\r\n\t")) {
  373.             throw new BadRequestException('Invalid URI: A URI cannot contain CR/LF/TAB characters.');
  374.         }
  375.         if ('' !== $uri && (\ord($uri[0]) <= 32 || \ord($uri[-1]) <= 32)) {
  376.             throw new BadRequestException('Invalid URI: A URI must not start nor end with ASCII control characters or spaces.');
  377.         }
  379.         if (isset($components['host'])) {
  380.             $server['SERVER_NAME'] = $components['host'];
  381.             $server['HTTP_HOST'] = $components['host'];
  382.         }
  384.         if (isset($components['scheme'])) {
  385.             if ('https' === $components['scheme']) {
  386.                 $server['HTTPS'] = 'on';
  387.                 $server['SERVER_PORT'] = 443;
  388.             } else {
  389.                 unset($server['HTTPS']);
  390.                 $server['SERVER_PORT'] = 80;
  391.             }
  392.         }
  394.         if (isset($components['port'])) {
  395.             $server['SERVER_PORT'] = $components['port'];
  396.             $server['HTTP_HOST'] .= ':'.$components['port'];
  397.         }
  399.         if (isset($components['user'])) {
  400.             $server['PHP_AUTH_USER'] = $components['user'];
  401.         }
  403.         if (isset($components['pass'])) {
  404.             $server['PHP_AUTH_PW'] = $components['pass'];
  405.         }
  407.         if ('' === $path = $components['path'] ?? '') {
  408.             $components['path'] = '/';
  409.         } elseif (!isset($components['scheme']) && !isset($components['host']) && '/' !== $path[0]) {
  410.             if (false !== $pos = strpos($path, '/')) {
  411.                 $path = substr($path, 0, $pos);
  412.             }
  414.             if (str_contains($path, ':')) {
  415.                 throw new BadRequestException('Invalid URI: Path is malformed.');
  416.             }
  417.         }
  419.         switch (strtoupper($method)) {
  420.             case 'POST':
  421.             case 'PUT':
  422.             case 'DELETE':
  423.                 if (!isset($server['CONTENT_TYPE'])) {
  424.                     $server['CONTENT_TYPE'] = 'application/x-www-form-urlencoded';
  425.                 }
  426.                 // no break
  427.             case 'PATCH':
  428.                 $request = $parameters;
  429.                 $query = [];
  430.                 break;
  431.             default:
  432.                 $request = [];
  433.                 $query = $parameters;
  434.                 break;
  435.         }
  437.         $queryString = '';
  438.         if (isset($components['query'])) {
  439.             parse_str(html_entity_decode($components['query']), $qs);
  441.             if ($query) {
  442.                 $query = array_replace($qs, $query);
  443.                 $queryString = http_build_query($query, '', '&');
  444.             } else {
  445.                 $query = $qs;
  446.                 $queryString = $components['query'];
  447.             }
  448.         } elseif ($query) {
  449.             $queryString = http_build_query($query, '', '&');
  450.         }
  452.         $server['REQUEST_URI'] = $components['path'].('' !== $queryString ? '?'.$queryString : '');
  453.         $server['QUERY_STRING'] = $queryString;
  455.         return self::createRequestFromFactory($query, $request, [], $cookies, $files, $server, $content);
  456.     }
  458.     /**
  459.      * Sets a callable able to create a Request instance.
  460.      *
  461.      * This is mainly useful when you need to override the Request class
  462.      * to keep BC with an existing system. It should not be used for any
  463.      * other purpose.
  464.      *
  465.      * @return void
  466.      */
  467.     public static function setFactory(?callable $callable)
  468.     {
  469.         self::$requestFactory = $callable;
  470.     }
  472.     /**
  473.      * Clones a request and overrides some of its parameters.
  474.      *
  475.      * @param array|null $query      The GET parameters
  476.      * @param array|null $request    The POST parameters
  477.      * @param array|null $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  478.      * @param array|null $cookies    The COOKIE parameters
  479.      * @param array|null $files      The FILES parameters
  480.      * @param array|null $server     The SERVER parameters
  481.      */
  482.     public function duplicate(?array $query = null, ?array $request = null, ?array $attributes = null, ?array $cookies = null, ?array $files = null, ?array $server = null): static
  483.     {
  484.         $dup = clone $this;
  485.         if (null !== $query) {
  486.             $dup->query = new InputBag($query);
  487.         }
  488.         if (null !== $request) {
  489.             $dup->request = new InputBag($request);
  490.         }
  491.         if (null !== $attributes) {
  492.             $dup->attributes = new ParameterBag($attributes);
  493.         }
  494.         if (null !== $cookies) {
  495.             $dup->cookies = new InputBag($cookies);
  496.         }
  497.         if (null !== $files) {
  498.             $dup->files = new FileBag($files);
  499.         }
  500.         if (null !== $server) {
  501.             $dup->server = new ServerBag($server);
  502.             $dup->headers = new HeaderBag($dup->server->getHeaders());
  503.         }
  504.         $dup->languages = null;
  505.         $dup->charsets = null;
  506.         $dup->encodings = null;
  507.         $dup->acceptableContentTypes = null;
  508.         $dup->pathInfo = null;
  509.         $dup->requestUri = null;
  510.         $dup->baseUrl = null;
  511.         $dup->basePath = null;
  512.         $dup->method = null;
  513.         $dup->format = null;
  515.         if (!$dup->get('_format') && $this->get('_format')) {
  516.             $dup->attributes->set('_format', $this->get('_format'));
  517.         }
  519.         if (!$dup->getRequestFormat(null)) {
  520.             $dup->setRequestFormat($this->getRequestFormat(null));
  521.         }
  523.         return $dup;
  524.     }
  526.     /**
  527.      * Clones the current request.
  528.      *
  529.      * Note that the session is not cloned as duplicated requests
  530.      * are most of the time sub-requests of the main one.
  531.      */
  532.     public function __clone()
  533.     {
  534.         $this->query = clone $this->query;
  535.         $this->request = clone $this->request;
  536.         $this->attributes = clone $this->attributes;
  537.         $this->cookies = clone $this->cookies;
  538.         $this->files = clone $this->files;
  539.         $this->server = clone $this->server;
  540.         $this->headers = clone $this->headers;
  541.     }
  543.     public function __toString(): string
  544.     {
  545.         $content = $this->getContent();
  547.         $cookieHeader = '';
  548.         $cookies = [];
  550.         foreach ($this->cookies as $k => $v) {
  551.             $cookies[] = \is_array($v) ? http_build_query([$k => $v], '', '; ', \PHP_QUERY_RFC3986) : "$k=$v";
  552.         }
  554.         if ($cookies) {
  555.             $cookieHeader = 'Cookie: '.implode('; ', $cookies)."\r\n";
  556.         }
  558.         return
  559.             \sprintf('%s %s %s', $this->getMethod(), $this->getRequestUri(), $this->server->get('SERVER_PROTOCOL'))."\r\n".
  560.             $this->headers.
  561.             $cookieHeader."\r\n".
  562.             $content;
  563.     }
  565.     /**
  566.      * Overrides the PHP global variables according to this request instance.
  567.      *
  568.      * It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE.
  569.      * $_FILES is never overridden, see rfc1867
  570.      *
  571.      * @return void
  572.      */
  573.     public function overrideGlobals()
  574.     {
  575.         $this->server->set('QUERY_STRING', static::normalizeQueryString(http_build_query($this->query->all(), '', '&')));
  577.         $_GET = $this->query->all();
  578.         $_POST = $this->request->all();
  579.         $_SERVER = $this->server->all();
  580.         $_COOKIE = $this->cookies->all();
  582.         foreach ($this->headers->all() as $key => $value) {
  583.             $key = strtoupper(str_replace('-', '_', $key));
  584.             if (\in_array($key, ['CONTENT_TYPE', 'CONTENT_LENGTH', 'CONTENT_MD5'], true)) {
  585.                 $_SERVER[$key] = implode(', ', $value);
  586.             } else {
  587.                 $_SERVER['HTTP_'.$key] = implode(', ', $value);
  588.             }
  589.         }
  591.         $request = ['g' => $_GET, 'p' => $_POST, 'c' => $_COOKIE];
  593.         $requestOrder = \ini_get('request_order') ?: \ini_get('variables_order');
  594.         $requestOrder = preg_replace('#[^cgp]#', '', strtolower($requestOrder)) ?: 'gp';
  596.         $_REQUEST = [[]];
  598.         foreach (str_split($requestOrder) as $order) {
  599.             $_REQUEST[] = $request[$order];
  600.         }
  602.         $_REQUEST = array_merge(...$_REQUEST);
  603.     }
  605.     /**
  606.      * Sets a list of trusted proxies.
  607.      *
  608.      * You should only list the reverse proxies that you manage directly.
  609.      *
  610.      * @param array $proxies          A list of trusted proxies, the string 'REMOTE_ADDR' will be replaced with $_SERVER['REMOTE_ADDR']
  611.      * @param int   $trustedHeaderSet A bit field of Request::HEADER_*, to set which headers to trust from your proxies
  612.      *
  613.      * @return void
  614.      */
  615.     public static function setTrustedProxies(array $proxies, int $trustedHeaderSet)
  616.     {
  617.         self::$trustedProxies = array_reduce($proxies, function ($proxies, $proxy) {
  618.             if ('REMOTE_ADDR' !== $proxy) {
  619.                 $proxies[] = $proxy;
  620.             } elseif (isset($_SERVER['REMOTE_ADDR'])) {
  621.                 $proxies[] = $_SERVER['REMOTE_ADDR'];
  622.             }
  624.             return $proxies;
  625.         }, []);
  626.         self::$trustedHeaderSet = $trustedHeaderSet;
  627.     }
  629.     /**
  630.      * Gets the list of trusted proxies.
  631.      *
  632.      * @return string[]
  633.      */
  634.     public static function getTrustedProxies(): array
  635.     {
  636.         return self::$trustedProxies;
  637.     }
  639.     /**
  640.      * Gets the set of trusted headers from trusted proxies.
  641.      *
  642.      * @return int A bit field of Request::HEADER_* that defines which headers are trusted from your proxies
  643.      */
  644.     public static function getTrustedHeaderSet(): int
  645.     {
  646.         return self::$trustedHeaderSet;
  647.     }
  649.     /**
  650.      * Sets a list of trusted host patterns.
  651.      *
  652.      * You should only list the hosts you manage using regexs.
  653.      *
  654.      * @param array $hostPatterns A list of trusted host patterns
  655.      *
  656.      * @return void
  657.      */
  658.     public static function setTrustedHosts(array $hostPatterns)
  659.     {
  660.         self::$trustedHostPatterns = array_map(fn ($hostPattern) => \sprintf('{%s}i', $hostPattern), $hostPatterns);
  661.         // we need to reset trusted hosts on trusted host patterns change
  662.         self::$trustedHosts = [];
  663.     }
  665.     /**
  666.      * Gets the list of trusted host patterns.
  667.      *
  668.      * @return string[]
  669.      */
  670.     public static function getTrustedHosts(): array
  671.     {
  672.         return self::$trustedHostPatterns;
  673.     }
  675.     /**
  676.      * Normalizes a query string.
  677.      *
  678.      * It builds a normalized query string, where keys/value pairs are alphabetized,
  679.      * have consistent escaping and unneeded delimiters are removed.
  680.      */
  681.     public static function normalizeQueryString(?string $qs): string
  682.     {
  683.         if ('' === ($qs ?? '')) {
  684.             return '';
  685.         }
  687.         $qs = HeaderUtils::parseQuery($qs);
  688.         ksort($qs);
  690.         return http_build_query($qs, '', '&', \PHP_QUERY_RFC3986);
  691.     }
  693.     /**
  694.      * Enables support for the _method request parameter to determine the intended HTTP method.
  695.      *
  696.      * Be warned that enabling this feature might lead to CSRF issues in your code.
  697.      * Check that you are using CSRF tokens when required.
  698.      * If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered
  699.      * and used to send a "PUT" or "DELETE" request via the _method request parameter.
  700.      * If these methods are not protected against CSRF, this presents a possible vulnerability.
  701.      *
  702.      * The HTTP method can only be overridden when the real HTTP method is POST.
  703.      *
  704.      * @return void
  705.      */
  706.     public static function enableHttpMethodParameterOverride()
  707.     {
  708.         self::$httpMethodParameterOverride = true;
  709.     }
  711.     /**
  712.      * Checks whether support for the _method request parameter is enabled.
  713.      */
  714.     public static function getHttpMethodParameterOverride(): bool
  715.     {
  716.         return self::$httpMethodParameterOverride;
  717.     }
  719.     /**
  720.      * Gets a "parameter" value from any bag.
  721.      *
  722.      * This method is mainly useful for libraries that want to provide some flexibility. If you don't need the
  723.      * flexibility in controllers, it is better to explicitly get request parameters from the appropriate
  724.      * public property instead (attributes, query, request).
  725.      *
  726.      * Order of precedence: PATH (routing placeholders or custom attributes), GET, POST
  727.      *
  728.      * @internal use explicit input sources instead
  729.      */
  730.     public function get(string $key, mixed $default = null): mixed
  731.     {
  732.         if ($this !== $result = $this->attributes->get($key, $this)) {
  733.             return $result;
  734.         }
  736.         if ($this->query->has($key)) {
  737.             return $this->query->all()[$key];
  738.         }
  740.         if ($this->request->has($key)) {
  741.             return $this->request->all()[$key];
  742.         }
  744.         return $default;
  745.     }
  747.     /**
  748.      * Gets the Session.
  749.      *
  750.      * @throws SessionNotFoundException When session is not set properly
  751.      */
  752.     public function getSession(): SessionInterface
  753.     {
  754.         $session = $this->session;
  755.         if (!$session instanceof SessionInterface && null !== $session) {
  756.             $this->setSession($session = $session());
  757.         }
  759.         if (null === $session) {
  760.             throw new SessionNotFoundException('Session has not been set.');
  761.         }
  763.         return $session;
  764.     }
  766.     /**
  767.      * Whether the request contains a Session which was started in one of the
  768.      * previous requests.
  769.      */
  770.     public function hasPreviousSession(): bool
  771.     {
  772.         // the check for $this->session avoids malicious users trying to fake a session cookie with proper name
  773.         return $this->hasSession() && $this->cookies->has($this->getSession()->getName());
  774.     }
  776.     /**
  777.      * Whether the request contains a Session object.
  778.      *
  779.      * This method does not give any information about the state of the session object,
  780.      * like whether the session is started or not. It is just a way to check if this Request
  781.      * is associated with a Session instance.
  782.      *
  783.      * @param bool $skipIfUninitialized When true, ignores factories injected by `setSessionFactory`
  784.      */
  785.     public function hasSession(bool $skipIfUninitialized = false): bool
  786.     {
  787.         return null !== $this->session && (!$skipIfUninitialized || $this->session instanceof SessionInterface);
  788.     }
  790.     /**
  791.      * @return void
  792.      */
  793.     public function setSession(SessionInterface $session)
  794.     {
  795.         $this->session = $session;
  796.     }
  798.     /**
  799.      * @internal
  800.      *
  801.      * @param callable(): SessionInterface $factory
  802.      */
  803.     public function setSessionFactory(callable $factory): void
  804.     {
  805.         $this->session = $factory(...);
  806.     }
  808.     /**
  809.      * Returns the client IP addresses.
  810.      *
  811.      * In the returned array the most trusted IP address is first, and the
  812.      * least trusted one last. The "real" client IP address is the last one,
  813.      * but this is also the least trusted one. Trusted proxies are stripped.
  814.      *
  815.      * Use this method carefully; you should use getClientIp() instead.
  816.      *
  817.      * @see getClientIp()
  818.      */
  819.     public function getClientIps(): array
  820.     {
  821.         $ip = $this->server->get('REMOTE_ADDR');
  823.         if (!$this->isFromTrustedProxy()) {
  824.             return [$ip];
  825.         }
  827.         return $this->getTrustedValues(self::HEADER_X_FORWARDED_FOR, $ip) ?: [$ip];
  828.     }
  830.     /**
  831.      * Returns the client IP address.
  832.      *
  833.      * This method can read the client IP address from the "X-Forwarded-For" header
  834.      * when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For"
  835.      * header value is a comma+space separated list of IP addresses, the left-most
  836.      * being the original client, and each successive proxy that passed the request
  837.      * adding the IP address where it received the request from.
  838.      *
  839.      * If your reverse proxy uses a different header name than "X-Forwarded-For",
  840.      * ("Client-Ip" for instance), configure it via the $trustedHeaderSet
  841.      * argument of the Request::setTrustedProxies() method instead.
  842.      *
  843.      * @see getClientIps()
  844.      * @see https://wikipedia.org/wiki/X-Forwarded-For
  845.      */
  846.     public function getClientIp(): ?string
  847.     {
  848.         $ipAddresses = $this->getClientIps();
  850.         return $ipAddresses[0];
  851.     }
  853.     /**
  854.      * Returns current script name.
  855.      */
  856.     public function getScriptName(): string
  857.     {
  858.         return $this->server->get('SCRIPT_NAME', $this->server->get('ORIG_SCRIPT_NAME', ''));
  859.     }
  861.     /**
  862.      * Returns the path being requested relative to the executed script.
  863.      *
  864.      * The path info always starts with a /.
  865.      *
  866.      * Suppose this request is instantiated from /mysite on localhost:
  867.      *
  868.      *  * http://localhost/mysite              returns '/'
  869.      *  * http://localhost/mysite/about        returns '/about'
  870.      *  * http://localhost/mysite/enco%20ded   returns '/enco%20ded'
  871.      *  * http://localhost/mysite/about?var=1  returns '/about'
  872.      *
  873.      * @return string The raw path (i.e. not urldecoded)
  874.      */
  875.     public function getPathInfo(): string
  876.     {
  877.         return $this->pathInfo ??= $this->preparePathInfo();
  878.     }
  880.     /**
  881.      * Returns the root path from which this request is executed.
  882.      *
  883.      * Suppose that an index.php file instantiates this request object:
  884.      *
  885.      *  * http://localhost/index.php         returns an empty string
  886.      *  * http://localhost/index.php/page    returns an empty string
  887.      *  * http://localhost/web/index.php     returns '/web'
  888.      *  * http://localhost/we%20b/index.php  returns '/we%20b'
  889.      *
  890.      * @return string The raw path (i.e. not urldecoded)
  891.      */
  892.     public function getBasePath(): string
  893.     {
  894.         return $this->basePath ??= $this->prepareBasePath();
  895.     }
  897.     /**
  898.      * Returns the root URL from which this request is executed.
  899.      *
  900.      * The base URL never ends with a /.
  901.      *
  902.      * This is similar to getBasePath(), except that it also includes the
  903.      * script filename (e.g. index.php) if one exists.
  904.      *
  905.      * @return string The raw URL (i.e. not urldecoded)
  906.      */
  907.     public function getBaseUrl(): string
  908.     {
  909.         $trustedPrefix = '';
  911.         // the proxy prefix must be prepended to any prefix being needed at the webserver level
  912.         if ($this->isFromTrustedProxy() && $trustedPrefixValues = $this->getTrustedValues(self::HEADER_X_FORWARDED_PREFIX)) {
  913.             $trustedPrefix = rtrim($trustedPrefixValues[0], '/');
  914.         }
  916.         return $trustedPrefix.$this->getBaseUrlReal();
  917.     }
  919.     /**
  920.      * Returns the real base URL received by the webserver from which this request is executed.
  921.      * The URL does not include trusted reverse proxy prefix.
  922.      *
  923.      * @return string The raw URL (i.e. not urldecoded)
  924.      */
  925.     private function getBaseUrlReal(): string
  926.     {
  927.         return $this->baseUrl ??= $this->prepareBaseUrl();
  928.     }
  930.     /**
  931.      * Gets the request's scheme.
  932.      */
  933.     public function getScheme(): string
  934.     {
  935.         return $this->isSecure() ? 'https' : 'http';
  936.     }
  938.     /**
  939.      * Returns the port on which the request is made.
  940.      *
  941.      * This method can read the client port from the "X-Forwarded-Port" header
  942.      * when trusted proxies were set via "setTrustedProxies()".
  943.      *
  944.      * The "X-Forwarded-Port" header must contain the client port.
  945.      *
  946.      * @return int|string|null Can be a string if fetched from the server bag
  947.      */
  948.     public function getPort(): int|string|null
  949.     {
  950.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_PORT)) {
  951.             $host = $host[0];
  952.         } elseif ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  953.             $host = $host[0];
  954.         } elseif (!$host = $this->headers->get('HOST')) {
  955.             return $this->server->get('SERVER_PORT');
  956.         }
  958.         if ('[' === $host[0]) {
  959.             $pos = strpos($host, ':', strrpos($host, ']'));
  960.         } else {
  961.             $pos = strrpos($host, ':');
  962.         }
  964.         if (false !== $pos && $port = substr($host, $pos + 1)) {
  965.             return (int) $port;
  966.         }
  968.         return 'https' === $this->getScheme() ? 443 : 80;
  969.     }
  971.     /**
  972.      * Returns the user.
  973.      */
  974.     public function getUser(): ?string
  975.     {
  976.         return $this->headers->get('PHP_AUTH_USER');
  977.     }
  979.     /**
  980.      * Returns the password.
  981.      */
  982.     public function getPassword(): ?string
  983.     {
  984.         return $this->headers->get('PHP_AUTH_PW');
  985.     }
  987.     /**
  988.      * Gets the user info.
  989.      *
  990.      * @return string|null A user name if any and, optionally, scheme-specific information about how to gain authorization to access the server
  991.      */
  992.     public function getUserInfo(): ?string
  993.     {
  994.         $userinfo = $this->getUser();
  996.         $pass = $this->getPassword();
  997.         if ('' != $pass) {
  998.             $userinfo .= ":$pass";
  999.         }
  1001.         return $userinfo;
  1002.     }
  1004.     /**
  1005.      * Returns the HTTP host being requested.
  1006.      *
  1007.      * The port name will be appended to the host if it's non-standard.
  1008.      */
  1009.     public function getHttpHost(): string
  1010.     {
  1011.         $scheme = $this->getScheme();
  1012.         $port = $this->getPort();
  1014.         if (('http' === $scheme && 80 == $port) || ('https' === $scheme && 443 == $port)) {
  1015.             return $this->getHost();
  1016.         }
  1018.         return $this->getHost().':'.$port;
  1019.     }
  1021.     /**
  1022.      * Returns the requested URI (path and query string).
  1023.      *
  1024.      * @return string The raw URI (i.e. not URI decoded)
  1025.      */
  1026.     public function getRequestUri(): string
  1027.     {
  1028.         return $this->requestUri ??= $this->prepareRequestUri();
  1029.     }
  1031.     /**
  1032.      * Gets the scheme and HTTP host.
  1033.      *
  1034.      * If the URL was called with basic authentication, the user
  1035.      * and the password are not added to the generated string.
  1036.      */
  1037.     public function getSchemeAndHttpHost(): string
  1038.     {
  1039.         return $this->getScheme().'://'.$this->getHttpHost();
  1040.     }
  1042.     /**
  1043.      * Generates a normalized URI (URL) for the Request.
  1044.      *
  1045.      * @see getQueryString()
  1046.      */
  1047.     public function getUri(): string
  1048.     {
  1049.         if (null !== $qs = $this->getQueryString()) {
  1050.             $qs = '?'.$qs;
  1051.         }
  1053.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$this->getPathInfo().$qs;
  1054.     }
  1056.     /**
  1057.      * Generates a normalized URI for the given path.
  1058.      *
  1059.      * @param string $path A path to use instead of the current one
  1060.      */
  1061.     public function getUriForPath(string $path): string
  1062.     {
  1063.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$path;
  1064.     }
  1066.     /**
  1067.      * Returns the path as relative reference from the current Request path.
  1068.      *
  1069.      * Only the URIs path component (no schema, host etc.) is relevant and must be given.
  1070.      * Both paths must be absolute and not contain relative parts.
  1071.      * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
  1072.      * Furthermore, they can be used to reduce the link size in documents.
  1073.      *
  1074.      * Example target paths, given a base path of "/a/b/c/d":
  1075.      * - "/a/b/c/d"     -> ""
  1076.      * - "/a/b/c/"      -> "./"
  1077.      * - "/a/b/"        -> "../"
  1078.      * - "/a/b/c/other" -> "other"
  1079.      * - "/a/x/y"       -> "../../x/y"
  1080.      */
  1081.     public function getRelativeUriForPath(string $path): string
  1082.     {
  1083.         // be sure that we are dealing with an absolute path
  1084.         if (!isset($path[0]) || '/' !== $path[0]) {
  1085.             return $path;
  1086.         }
  1088.         if ($path === $basePath = $this->getPathInfo()) {
  1089.             return '';
  1090.         }
  1092.         $sourceDirs = explode('/', isset($basePath[0]) && '/' === $basePath[0] ? substr($basePath, 1) : $basePath);
  1093.         $targetDirs = explode('/', substr($path, 1));
  1094.         array_pop($sourceDirs);
  1095.         $targetFile = array_pop($targetDirs);
  1097.         foreach ($sourceDirs as $i => $dir) {
  1098.             if (isset($targetDirs[$i]) && $dir === $targetDirs[$i]) {
  1099.                 unset($sourceDirs[$i], $targetDirs[$i]);
  1100.             } else {
  1101.                 break;
  1102.             }
  1103.         }
  1105.         $targetDirs[] = $targetFile;
  1106.         $path = str_repeat('../', \count($sourceDirs)).implode('/', $targetDirs);
  1108.         // A reference to the same base directory or an empty subdirectory must be prefixed with "./".
  1109.         // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used
  1110.         // as the first segment of a relative-path reference, as it would be mistaken for a scheme name
  1111.         // (see https://tools.ietf.org/html/rfc3986#section-4.2).
  1112.         return !isset($path[0]) || '/' === $path[0]
  1113.             || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)
  1114.             ? "./$path" : $path;
  1115.     }
  1117.     /**
  1118.      * Generates the normalized query string for the Request.
  1119.      *
  1120.      * It builds a normalized query string, where keys/value pairs are alphabetized
  1121.      * and have consistent escaping.
  1122.      */
  1123.     public function getQueryString(): ?string
  1124.     {
  1125.         $qs = static::normalizeQueryString($this->server->get('QUERY_STRING'));
  1127.         return '' === $qs ? null : $qs;
  1128.     }
  1130.     /**
  1131.      * Checks whether the request is secure or not.
  1132.      *
  1133.      * This method can read the client protocol from the "X-Forwarded-Proto" header
  1134.      * when trusted proxies were set via "setTrustedProxies()".
  1135.      *
  1136.      * The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".
  1137.      */
  1138.     public function isSecure(): bool
  1139.     {
  1140.         if ($this->isFromTrustedProxy() && $proto = $this->getTrustedValues(self::HEADER_X_FORWARDED_PROTO)) {
  1141.             return \in_array(strtolower($proto[0]), ['https', 'on', 'ssl', '1'], true);
  1142.         }
  1144.         $https = $this->server->get('HTTPS');
  1146.         return !empty($https) && 'off' !== strtolower($https);
  1147.     }
  1149.     /**
  1150.      * Returns the host name.
  1151.      *
  1152.      * This method can read the client host name from the "X-Forwarded-Host" header
  1153.      * when trusted proxies were set via "setTrustedProxies()".
  1154.      *
  1155.      * The "X-Forwarded-Host" header must contain the client host name.
  1156.      *
  1157.      * @throws SuspiciousOperationException when the host name is invalid or not trusted
  1158.      */
  1159.     public function getHost(): string
  1160.     {
  1161.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  1162.             $host = $host[0];
  1163.         } elseif (!$host = $this->headers->get('HOST')) {
  1164.             if (!$host = $this->server->get('SERVER_NAME')) {
  1165.                 $host = $this->server->get('SERVER_ADDR', '');
  1166.             }
  1167.         }
  1169.         // trim and remove port number from host
  1170.         // host is lowercase as per RFC 952/2181
  1171.         $host = strtolower(preg_replace('/:\d+$/', '', trim($host)));
  1173.         // the host can come from the user (HTTP_HOST and depending on the configuration, SERVER_NAME too can come from the user)
  1174.         if ($host && !self::isHostValid($host)) {
  1175.             if (!$this->isHostValid) {
  1176.                 return '';
  1177.             }
  1178.             $this->isHostValid = false;
  1180.             throw new SuspiciousOperationException(\sprintf('Invalid Host "%s".', $host));
  1181.         }
  1183.         if (\count(self::$trustedHostPatterns) > 0) {
  1184.             // to avoid host header injection attacks, you should provide a list of trusted host patterns
  1186.             if (\in_array($host, self::$trustedHosts)) {
  1187.                 return $host;
  1188.             }
  1190.             foreach (self::$trustedHostPatterns as $pattern) {
  1191.                 if (preg_match($pattern, $host)) {
  1192.                     self::$trustedHosts[] = $host;
  1194.                     return $host;
  1195.                 }
  1196.             }
  1198.             if (!$this->isHostValid) {
  1199.                 return '';
  1200.             }
  1201.             $this->isHostValid = false;
  1203.             throw new SuspiciousOperationException(\sprintf('Untrusted Host "%s".', $host));
  1204.         }
  1206.         return $host;
  1207.     }
  1209.     /**
  1210.      * Sets the request method.
  1211.      *
  1212.      * @return void
  1213.      */
  1214.     public function setMethod(string $method)
  1215.     {
  1216.         $this->method = null;
  1217.         $this->server->set('REQUEST_METHOD', $method);
  1218.     }
  1220.     /**
  1221.      * Gets the request "intended" method.
  1222.      *
  1223.      * If the X-HTTP-Method-Override header is set, and if the method is a POST,
  1224.      * then it is used to determine the "real" intended HTTP method.
  1225.      *
  1226.      * The _method request parameter can also be used to determine the HTTP method,
  1227.      * but only if enableHttpMethodParameterOverride() has been called.
  1228.      *
  1229.      * The method is always an uppercased string.
  1230.      *
  1231.      * @see getRealMethod()
  1232.      */
  1233.     public function getMethod(): string
  1234.     {
  1235.         if (null !== $this->method) {
  1236.             return $this->method;
  1237.         }
  1239.         $this->method = strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1241.         if ('POST' !== $this->method) {
  1242.             return $this->method;
  1243.         }
  1245.         $method = $this->headers->get('X-HTTP-METHOD-OVERRIDE');
  1247.         if (!$method && self::$httpMethodParameterOverride) {
  1248.             $method = $this->request->get('_method', $this->query->get('_method', 'POST'));
  1249.         }
  1251.         if (!\is_string($method)) {
  1252.             return $this->method;
  1253.         }
  1255.         $method = strtoupper($method);
  1257.         if (\in_array($method, ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'PATCH', 'PURGE', 'TRACE'], true)) {
  1258.             return $this->method = $method;
  1259.         }
  1261.         if (!preg_match('/^[A-Z]++$/D', $method)) {
  1262.             throw new SuspiciousOperationException('Invalid HTTP method override.');
  1263.         }
  1265.         return $this->method = $method;
  1266.     }
  1268.     /**
  1269.      * Gets the "real" request method.
  1270.      *
  1271.      * @see getMethod()
  1272.      */
  1273.     public function getRealMethod(): string
  1274.     {
  1275.         return strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1276.     }
  1278.     /**
  1279.      * Gets the mime type associated with the format.
  1280.      */
  1281.     public function getMimeType(string $format): ?string
  1282.     {
  1283.         if (null === static::$formats) {
  1284.             static::initializeFormats();
  1285.         }
  1287.         return isset(static::$formats[$format]) ? static::$formats[$format][0] : null;
  1288.     }
  1290.     /**
  1291.      * Gets the mime types associated with the format.
  1292.      *
  1293.      * @return string[]
  1294.      */
  1295.     public static function getMimeTypes(string $format): array
  1296.     {
  1297.         if (null === static::$formats) {
  1298.             static::initializeFormats();
  1299.         }
  1301.         return static::$formats[$format] ?? [];
  1302.     }
  1304.     /**
  1305.      * Gets the format associated with the mime type.
  1306.      */
  1307.     public function getFormat(?string $mimeType): ?string
  1308.     {
  1309.         $canonicalMimeType = null;
  1310.         if ($mimeType && false !== $pos = strpos($mimeType, ';')) {
  1311.             $canonicalMimeType = trim(substr($mimeType, 0, $pos));
  1312.         }
  1314.         if (null === static::$formats) {
  1315.             static::initializeFormats();
  1316.         }
  1318.         $exactFormat = null;
  1319.         $canonicalFormat = null;
  1321.         foreach (static::$formats as $format => $mimeTypes) {
  1322.             if (\in_array($mimeType, $mimeTypes, true)) {
  1323.                 $exactFormat = $format;
  1324.             }
  1325.             if (null !== $canonicalMimeType && \in_array($canonicalMimeType, $mimeTypes, true)) {
  1326.                 $canonicalFormat = $format;
  1327.             }
  1328.         }
  1330.         if ($format = $exactFormat ?? $canonicalFormat) {
  1331.             return $format;
  1332.         }
  1334.         return null;
  1335.     }
  1337.     /**
  1338.      * Associates a format with mime types.
  1339.      *
  1340.      * @param string|string[] $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
  1341.      *
  1342.      * @return void
  1343.      */
  1344.     public function setFormat(?string $format, string|array $mimeTypes)
  1345.     {
  1346.         if (null === static::$formats) {
  1347.             static::initializeFormats();
  1348.         }
  1350.         static::$formats[$format ?? ''] = (array) $mimeTypes;
  1351.     }
  1353.     /**
  1354.      * Gets the request format.
  1355.      *
  1356.      * Here is the process to determine the format:
  1357.      *
  1358.      *  * format defined by the user (with setRequestFormat())
  1359.      *  * _format request attribute
  1360.      *  * $default
  1361.      *
  1362.      * @see getPreferredFormat
  1363.      */
  1364.     public function getRequestFormat(?string $default = 'html'): ?string
  1365.     {
  1366.         $this->format ??= $this->attributes->get('_format');
  1368.         return $this->format ?? $default;
  1369.     }
  1371.     /**
  1372.      * Sets the request format.
  1373.      *
  1374.      * @return void
  1375.      */
  1376.     public function setRequestFormat(?string $format)
  1377.     {
  1378.         $this->format = $format;
  1379.     }
  1381.     /**
  1382.      * Gets the usual name of the format associated with the request's media type (provided in the Content-Type header).
  1383.      *
  1384.      * @deprecated since Symfony 6.2, use getContentTypeFormat() instead
  1385.      */
  1386.     public function getContentType(): ?string
  1387.     {
  1388.         trigger_deprecation('symfony/http-foundation', '6.2', 'The "%s()" method is deprecated, use "getContentTypeFormat()" instead.', __METHOD__);
  1390.         return $this->getContentTypeFormat();
  1391.     }
  1393.     /**
  1394.      * Gets the usual name of the format associated with the request's media type (provided in the Content-Type header).
  1395.      *
  1396.      * @see Request::$formats
  1397.      */
  1398.     public function getContentTypeFormat(): ?string
  1399.     {
  1400.         return $this->getFormat($this->headers->get('CONTENT_TYPE', ''));
  1401.     }
  1403.     /**
  1404.      * Sets the default locale.
  1405.      *
  1406.      * @return void
  1407.      */
  1408.     public function setDefaultLocale(string $locale)
  1409.     {
  1410.         $this->defaultLocale = $locale;
  1412.         if (null === $this->locale) {
  1413.             $this->setPhpDefaultLocale($locale);
  1414.         }
  1415.     }
  1417.     /**
  1418.      * Get the default locale.
  1419.      */
  1420.     public function getDefaultLocale(): string
  1421.     {
  1422.         return $this->defaultLocale;
  1423.     }
  1425.     /**
  1426.      * Sets the locale.
  1427.      *
  1428.      * @return void
  1429.      */
  1430.     public function setLocale(string $locale)
  1431.     {
  1432.         $this->setPhpDefaultLocale($this->locale = $locale);
  1433.     }
  1435.     /**
  1436.      * Get the locale.
  1437.      */
  1438.     public function getLocale(): string
  1439.     {
  1440.         return $this->locale ?? $this->defaultLocale;
  1441.     }
  1443.     /**
  1444.      * Checks if the request method is of specified type.
  1445.      *
  1446.      * @param string $method Uppercase request method (GET, POST etc)
  1447.      */
  1448.     public function isMethod(string $method): bool
  1449.     {
  1450.         return $this->getMethod() === strtoupper($method);
  1451.     }
  1453.     /**
  1454.      * Checks whether or not the method is safe.
  1455.      *
  1456.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
  1457.      */
  1458.     public function isMethodSafe(): bool
  1459.     {
  1460.         return \in_array($this->getMethod(), ['GET', 'HEAD', 'OPTIONS', 'TRACE']);
  1461.     }
  1463.     /**
  1464.      * Checks whether or not the method is idempotent.
  1465.      */
  1466.     public function isMethodIdempotent(): bool
  1467.     {
  1468.         return \in_array($this->getMethod(), ['HEAD', 'GET', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'PURGE']);
  1469.     }
  1471.     /**
  1472.      * Checks whether the method is cacheable or not.
  1473.      *
  1474.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
  1475.      */
  1476.     public function isMethodCacheable(): bool
  1477.     {
  1478.         return \in_array($this->getMethod(), ['GET', 'HEAD']);
  1479.     }
  1481.     /**
  1482.      * Returns the protocol version.
  1483.      *
  1484.      * If the application is behind a proxy, the protocol version used in the
  1485.      * requests between the client and the proxy and between the proxy and the
  1486.      * server might be different. This returns the former (from the "Via" header)
  1487.      * if the proxy is trusted (see "setTrustedProxies()"), otherwise it returns
  1488.      * the latter (from the "SERVER_PROTOCOL" server parameter).
  1489.      */
  1490.     public function getProtocolVersion(): ?string
  1491.     {
  1492.         if ($this->isFromTrustedProxy()) {
  1493.             preg_match('~^(HTTP/)?([1-9]\.[0-9])\b~', $this->headers->get('Via') ?? '', $matches);
  1495.             if ($matches) {
  1496.                 return 'HTTP/'.$matches[2];
  1497.             }
  1498.         }
  1500.         return $this->server->get('SERVER_PROTOCOL');
  1501.     }
  1503.     /**
  1504.      * Returns the request body content.
  1505.      *
  1506.      * @param bool $asResource If true, a resource will be returned
  1507.      *
  1508.      * @return string|resource
  1509.      *
  1510.      * @psalm-return ($asResource is true ? resource : string)
  1511.      */
  1512.     public function getContent(bool $asResource = false)
  1513.     {
  1514.         $currentContentIsResource = \is_resource($this->content);
  1516.         if (true === $asResource) {
  1517.             if ($currentContentIsResource) {
  1518.                 rewind($this->content);
  1520.                 return $this->content;
  1521.             }
  1523.             // Content passed in parameter (test)
  1524.             if (\is_string($this->content)) {
  1525.                 $resource = fopen('php://temp', 'r+');
  1526.                 fwrite($resource, $this->content);
  1527.                 rewind($resource);
  1529.                 return $resource;
  1530.             }
  1532.             $this->content = false;
  1534.             return fopen('php://input', 'r');
  1535.         }
  1537.         if ($currentContentIsResource) {
  1538.             rewind($this->content);
  1540.             return stream_get_contents($this->content);
  1541.         }
  1543.         if (null === $this->content || false === $this->content) {
  1544.             $this->content = file_get_contents('php://input');
  1545.         }
  1547.         return $this->content;
  1548.     }
  1550.     /**
  1551.      * Gets the decoded form or json request body.
  1552.      *
  1553.      * @throws JsonException When the body cannot be decoded to an array
  1554.      */
  1555.     public function getPayload(): InputBag
  1556.     {
  1557.         if ($this->request->count()) {
  1558.             return clone $this->request;
  1559.         }
  1561.         if ('' === $content = $this->getContent()) {
  1562.             return new InputBag([]);
  1563.         }
  1565.         try {
  1566.             $content = json_decode($content, true, 512, \JSON_BIGINT_AS_STRING | \JSON_THROW_ON_ERROR);
  1567.         } catch (\JsonException $e) {
  1568.             throw new JsonException('Could not decode request body.', $e->getCode(), $e);
  1569.         }
  1571.         if (!\is_array($content)) {
  1572.             throw new JsonException(\sprintf('JSON content was expected to decode to an array, "%s" returned.', get_debug_type($content)));
  1573.         }
  1575.         return new InputBag($content);
  1576.     }
  1578.     /**
  1579.      * Gets the request body decoded as array, typically from a JSON payload.
  1580.      *
  1581.      * @see getPayload() for portability between content types
  1582.      *
  1583.      * @throws JsonException When the body cannot be decoded to an array
  1584.      */
  1585.     public function toArray(): array
  1586.     {
  1587.         if ('' === $content = $this->getContent()) {
  1588.             throw new JsonException('Request body is empty.');
  1589.         }
  1591.         try {
  1592.             $content = json_decode($content, true, 512, \JSON_BIGINT_AS_STRING | \JSON_THROW_ON_ERROR);
  1593.         } catch (\JsonException $e) {
  1594.             throw new JsonException('Could not decode request body.', $e->getCode(), $e);
  1595.         }
  1597.         if (!\is_array($content)) {
  1598.             throw new JsonException(\sprintf('JSON content was expected to decode to an array, "%s" returned.', get_debug_type($content)));
  1599.         }
  1601.         return $content;
  1602.     }
  1604.     /**
  1605.      * Gets the Etags.
  1606.      */
  1607.     public function getETags(): array
  1608.     {
  1609.         return preg_split('/\s*,\s*/', $this->headers->get('If-None-Match', ''), -1, \PREG_SPLIT_NO_EMPTY);
  1610.     }
  1612.     public function isNoCache(): bool
  1613.     {
  1614.         return $this->headers->hasCacheControlDirective('no-cache') || 'no-cache' == $this->headers->get('Pragma');
  1615.     }
  1617.     /**
  1618.      * Gets the preferred format for the response by inspecting, in the following order:
  1619.      *   * the request format set using setRequestFormat;
  1620.      *   * the values of the Accept HTTP header.
  1621.      *
  1622.      * Note that if you use this method, you should send the "Vary: Accept" header
  1623.      * in the response to prevent any issues with intermediary HTTP caches.
  1624.      */
  1625.     public function getPreferredFormat(?string $default = 'html'): ?string
  1626.     {
  1627.         if ($this->preferredFormat ??= $this->getRequestFormat(null)) {
  1628.             return $this->preferredFormat;
  1629.         }
  1631.         foreach ($this->getAcceptableContentTypes() as $mimeType) {
  1632.             if ($this->preferredFormat = $this->getFormat($mimeType)) {
  1633.                 return $this->preferredFormat;
  1634.             }
  1635.         }
  1637.         return $default;
  1638.     }
  1640.     /**
  1641.      * Returns the preferred language.
  1642.      *
  1643.      * @param string[] $locales An array of ordered available locales
  1644.      */
  1645.     public function getPreferredLanguage(?array $locales = null): ?string
  1646.     {
  1647.         $preferredLanguages = $this->getLanguages();
  1649.         if (empty($locales)) {
  1650.             return $preferredLanguages[0] ?? null;
  1651.         }
  1653.         if (!$preferredLanguages) {
  1654.             return $locales[0];
  1655.         }
  1657.         $extendedPreferredLanguages = [];
  1658.         foreach ($preferredLanguages as $language) {
  1659.             $extendedPreferredLanguages[] = $language;
  1660.             if (false !== $position = strpos($language, '_')) {
  1661.                 $superLanguage = substr($language, 0, $position);
  1662.                 if (!\in_array($superLanguage, $preferredLanguages)) {
  1663.                     $extendedPreferredLanguages[] = $superLanguage;
  1664.                 }
  1665.             }
  1666.         }
  1668.         $preferredLanguages = array_values(array_intersect($extendedPreferredLanguages, $locales));
  1670.         return $preferredLanguages[0] ?? $locales[0];
  1671.     }
  1673.     /**
  1674.      * Gets a list of languages acceptable by the client browser ordered in the user browser preferences.
  1675.      *
  1676.      * @return string[]
  1677.      */
  1678.     public function getLanguages(): array
  1679.     {
  1680.         if (null !== $this->languages) {
  1681.             return $this->languages;
  1682.         }
  1684.         $languages = AcceptHeader::fromString($this->headers->get('Accept-Language'))->all();
  1685.         $this->languages = [];
  1686.         foreach ($languages as $acceptHeaderItem) {
  1687.             $lang = $acceptHeaderItem->getValue();
  1688.             if (str_contains($lang, '-')) {
  1689.                 $codes = explode('-', $lang);
  1690.                 if ('i' === $codes[0]) {
  1691.                     // Language not listed in ISO 639 that are not variants
  1692.                     // of any listed language, which can be registered with the
  1693.                     // i-prefix, such as i-cherokee
  1694.                     if (\count($codes) > 1) {
  1695.                         $lang = $codes[1];
  1696.                     }
  1697.                 } else {
  1698.                     for ($i = 0, $max = \count($codes); $i < $max; ++$i) {
  1699.                         if (0 === $i) {
  1700.                             $lang = strtolower($codes[0]);
  1701.                         } else {
  1702.                             $lang .= '_'.strtoupper($codes[$i]);
  1703.                         }
  1704.                     }
  1705.                 }
  1706.             }
  1708.             $this->languages[] = $lang;
  1709.         }
  1711.         return $this->languages;
  1712.     }
  1714.     /**
  1715.      * Gets a list of charsets acceptable by the client browser in preferable order.
  1716.      *
  1717.      * @return string[]
  1718.      */
  1719.     public function getCharsets(): array
  1720.     {
  1721.         return $this->charsets ??= array_map('strval', array_keys(AcceptHeader::fromString($this->headers->get('Accept-Charset'))->all()));
  1722.     }
  1724.     /**
  1725.      * Gets a list of encodings acceptable by the client browser in preferable order.
  1726.      *
  1727.      * @return string[]
  1728.      */
  1729.     public function getEncodings(): array
  1730.     {
  1731.         return $this->encodings ??= array_map('strval', array_keys(AcceptHeader::fromString($this->headers->get('Accept-Encoding'))->all()));
  1732.     }
  1734.     /**
  1735.      * Gets a list of content types acceptable by the client browser in preferable order.
  1736.      *
  1737.      * @return string[]
  1738.      */
  1739.     public function getAcceptableContentTypes(): array
  1740.     {
  1741.         return $this->acceptableContentTypes ??= array_map('strval', array_keys(AcceptHeader::fromString($this->headers->get('Accept'))->all()));
  1742.     }
  1744.     /**
  1745.      * Returns true if the request is an XMLHttpRequest.
  1746.      *
  1747.      * It works if your JavaScript library sets an X-Requested-With HTTP header.
  1748.      * It is known to work with common JavaScript frameworks:
  1749.      *
  1750.      * @see https://wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
  1751.      */
  1752.     public function isXmlHttpRequest(): bool
  1753.     {
  1754.         return 'XMLHttpRequest' == $this->headers->get('X-Requested-With');
  1755.     }
  1757.     /**
  1758.      * Checks whether the client browser prefers safe content or not according to RFC8674.
  1759.      *
  1760.      * @see https://tools.ietf.org/html/rfc8674
  1761.      */
  1762.     public function preferSafeContent(): bool
  1763.     {
  1764.         if (isset($this->isSafeContentPreferred)) {
  1765.             return $this->isSafeContentPreferred;
  1766.         }
  1768.         if (!$this->isSecure()) {
  1769.             // see https://tools.ietf.org/html/rfc8674#section-3
  1770.             return $this->isSafeContentPreferred = false;
  1771.         }
  1773.         return $this->isSafeContentPreferred = AcceptHeader::fromString($this->headers->get('Prefer'))->has('safe');
  1774.     }
  1776.     /*
  1777.      * The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)
  1778.      *
  1779.      * Code subject to the new BSD license (https://framework.zend.com/license).
  1780.      *
  1781.      * Copyright (c) 2005-2010 Zend Technologies USA Inc. (https://www.zend.com/)
  1782.      */
  1784.     /**
  1785.      * @return string
  1786.      */
  1787.     protected function prepareRequestUri()
  1788.     {
  1789.         $requestUri = '';
  1791.         if ($this->isIisRewrite() && '' != $this->server->get('UNENCODED_URL')) {
  1792.             // IIS7 with URL Rewrite: make sure we get the unencoded URL (double slash problem)
  1793.             $requestUri = $this->server->get('UNENCODED_URL');
  1794.             $this->server->remove('UNENCODED_URL');
  1795.         } elseif ($this->server->has('REQUEST_URI')) {
  1796.             $requestUri = $this->server->get('REQUEST_URI');
  1798.             if ('' !== $requestUri && '/' === $requestUri[0]) {
  1799.                 // To only use path and query remove the fragment.
  1800.                 if (false !== $pos = strpos($requestUri, '#')) {
  1801.                     $requestUri = substr($requestUri, 0, $pos);
  1802.                 }
  1803.             } else {
  1804.                 // HTTP proxy reqs setup request URI with scheme and host [and port] + the URL path,
  1805.                 // only use URL path.
  1806.                 $uriComponents = parse_url($requestUri);
  1808.                 if (isset($uriComponents['path'])) {
  1809.                     $requestUri = $uriComponents['path'];
  1810.                 }
  1812.                 if (isset($uriComponents['query'])) {
  1813.                     $requestUri .= '?'.$uriComponents['query'];
  1814.                 }
  1815.             }
  1816.         } elseif ($this->server->has('ORIG_PATH_INFO')) {
  1817.             // IIS 5.0, PHP as CGI
  1818.             $requestUri = $this->server->get('ORIG_PATH_INFO');
  1819.             if ('' != $this->server->get('QUERY_STRING')) {
  1820.                 $requestUri .= '?'.$this->server->get('QUERY_STRING');
  1821.             }
  1822.             $this->server->remove('ORIG_PATH_INFO');
  1823.         }
  1825.         // normalize the request URI to ease creating sub-requests from this request
  1826.         $this->server->set('REQUEST_URI', $requestUri);
  1828.         return $requestUri;
  1829.     }
  1831.     /**
  1832.      * Prepares the base URL.
  1833.      */
  1834.     protected function prepareBaseUrl(): string
  1835.     {
  1836.         $filename = basename($this->server->get('SCRIPT_FILENAME', ''));
  1838.         if (basename($this->server->get('SCRIPT_NAME', '')) === $filename) {
  1839.             $baseUrl = $this->server->get('SCRIPT_NAME');
  1840.         } elseif (basename($this->server->get('PHP_SELF', '')) === $filename) {
  1841.             $baseUrl = $this->server->get('PHP_SELF');
  1842.         } elseif (basename($this->server->get('ORIG_SCRIPT_NAME', '')) === $filename) {
  1843.             $baseUrl = $this->server->get('ORIG_SCRIPT_NAME'); // 1and1 shared hosting compatibility
  1844.         } else {
  1845.             // Backtrack up the script_filename to find the portion matching
  1846.             // php_self
  1847.             $path = $this->server->get('PHP_SELF', '');
  1848.             $file = $this->server->get('SCRIPT_FILENAME', '');
  1849.             $segs = explode('/', trim($file, '/'));
  1850.             $segs = array_reverse($segs);
  1851.             $index = 0;
  1852.             $last = \count($segs);
  1853.             $baseUrl = '';
  1854.             do {
  1855.                 $seg = $segs[$index];
  1856.                 $baseUrl = '/'.$seg.$baseUrl;
  1857.                 ++$index;
  1858.             } while ($last > $index && (false !== $pos = strpos($path, $baseUrl)) && 0 != $pos);
  1859.         }
  1861.         // Does the baseUrl have anything in common with the request_uri?
  1862.         $requestUri = $this->getRequestUri();
  1863.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1864.             $requestUri = '/'.$requestUri;
  1865.         }
  1867.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, $baseUrl)) {
  1868.             // full $baseUrl matches
  1869.             return $prefix;
  1870.         }
  1872.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, rtrim(\dirname($baseUrl), '/'.\DIRECTORY_SEPARATOR).'/')) {
  1873.             // directory portion of $baseUrl matches
  1874.             return rtrim($prefix, '/'.\DIRECTORY_SEPARATOR);
  1875.         }
  1877.         $truncatedRequestUri = $requestUri;
  1878.         if (false !== $pos = strpos($requestUri, '?')) {
  1879.             $truncatedRequestUri = substr($requestUri, 0, $pos);
  1880.         }
  1882.         $basename = basename($baseUrl ?? '');
  1883.         if (empty($basename) || !strpos(rawurldecode($truncatedRequestUri), $basename)) {
  1884.             // no match whatsoever; set it blank
  1885.             return '';
  1886.         }
  1888.         // If using mod_rewrite or ISAPI_Rewrite strip the script filename
  1889.         // out of baseUrl. $pos !== 0 makes sure it is not matching a value
  1890.         // from PATH_INFO or QUERY_STRING
  1891.         if (\strlen($requestUri) >= \strlen($baseUrl) && (false !== $pos = strpos($requestUri, $baseUrl)) && 0 !== $pos) {
  1892.             $baseUrl = substr($requestUri, 0, $pos + \strlen($baseUrl));
  1893.         }
  1895.         return rtrim($baseUrl, '/'.\DIRECTORY_SEPARATOR);
  1896.     }
  1898.     /**
  1899.      * Prepares the base path.
  1900.      */
  1901.     protected function prepareBasePath(): string
  1902.     {
  1903.         $baseUrl = $this->getBaseUrl();
  1904.         if (empty($baseUrl)) {
  1905.             return '';
  1906.         }
  1908.         $filename = basename($this->server->get('SCRIPT_FILENAME'));
  1909.         if (basename($baseUrl) === $filename) {
  1910.             $basePath = \dirname($baseUrl);
  1911.         } else {
  1912.             $basePath = $baseUrl;
  1913.         }
  1915.         if ('\\' === \DIRECTORY_SEPARATOR) {
  1916.             $basePath = str_replace('\\', '/', $basePath);
  1917.         }
  1919.         return rtrim($basePath, '/');
  1920.     }
  1922.     /**
  1923.      * Prepares the path info.
  1924.      */
  1925.     protected function preparePathInfo(): string
  1926.     {
  1927.         if (null === ($requestUri = $this->getRequestUri())) {
  1928.             return '/';
  1929.         }
  1931.         // Remove the query string from REQUEST_URI
  1932.         if (false !== $pos = strpos($requestUri, '?')) {
  1933.             $requestUri = substr($requestUri, 0, $pos);
  1934.         }
  1935.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1936.             $requestUri = '/'.$requestUri;
  1937.         }
  1939.         if (null === ($baseUrl = $this->getBaseUrlReal())) {
  1940.             return $requestUri;
  1941.         }
  1943.         $pathInfo = substr($requestUri, \strlen($baseUrl));
  1944.         if (false === $pathInfo || '' === $pathInfo || '/' !== $pathInfo[0]) {
  1945.             return '/'.$pathInfo;
  1946.         }
  1948.         return $pathInfo;
  1949.     }
  1951.     /**
  1952.      * Initializes HTTP request formats.
  1953.      *
  1954.      * @return void
  1955.      */
  1956.     protected static function initializeFormats()
  1957.     {
  1958.         static::$formats = [
  1959.             'html' => ['text/html', 'application/xhtml+xml'],
  1960.             'txt' => ['text/plain'],
  1961.             'js' => ['application/javascript', 'application/x-javascript', 'text/javascript'],
  1962.             'css' => ['text/css'],
  1963.             'json' => ['application/json', 'application/x-json'],
  1964.             'jsonld' => ['application/ld+json'],
  1965.             'xml' => ['text/xml', 'application/xml', 'application/x-xml'],
  1966.             'rdf' => ['application/rdf+xml'],
  1967.             'atom' => ['application/atom+xml'],
  1968.             'rss' => ['application/rss+xml'],
  1969.             'form' => ['application/x-www-form-urlencoded', 'multipart/form-data'],
  1970.         ];
  1971.     }
  1973.     private function setPhpDefaultLocale(string $locale): void
  1974.     {
  1975.         // if either the class Locale doesn't exist, or an exception is thrown when
  1976.         // setting the default locale, the intl module is not installed, and
  1977.         // the call can be ignored:
  1978.         try {
  1979.             if (class_exists(\Locale::class, false)) {
  1980.                 \Locale::setDefault($locale);
  1981.             }
  1982.         } catch (\Exception) {
  1983.         }
  1984.     }
  1986.     /**
  1987.      * Returns the prefix as encoded in the string when the string starts with
  1988.      * the given prefix, null otherwise.
  1989.      */
  1990.     private function getUrlencodedPrefix(string $string, string $prefix): ?string
  1991.     {
  1992.         if ($this->isIisRewrite()) {
  1993.             // ISS with UrlRewriteModule might report SCRIPT_NAME/PHP_SELF with wrong case
  1994.             // see https://github.com/php/php-src/issues/11981
  1995.             if (0 !== stripos(rawurldecode($string), $prefix)) {
  1996.                 return null;
  1997.             }
  1998.         } elseif (!str_starts_with(rawurldecode($string), $prefix)) {
  1999.             return null;
  2000.         }
  2002.         $len = \strlen($prefix);
  2004.         if (preg_match(\sprintf('#^(%%[[:xdigit:]]{2}|.){%d}#', $len), $string, $match)) {
  2005.             return $match[0];
  2006.         }
  2008.         return null;
  2009.     }
  2011.     private static function createRequestFromFactory(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null): static
  2012.     {
  2013.         if (self::$requestFactory) {
  2014.             $request = (self::$requestFactory)($query, $request, $attributes, $cookies, $files, $server, $content);
  2016.             if (!$request instanceof self) {
  2017.                 throw new \LogicException('The Request factory must return an instance of Symfony\Component\HttpFoundation\Request.');
  2018.             }
  2020.             return $request;
  2021.         }
  2023.         return new static($query, $request, $attributes, $cookies, $files, $server, $content);
  2024.     }
  2026.     /**
  2027.      * Indicates whether this request originated from a trusted proxy.
  2028.      *
  2029.      * This can be useful to determine whether or not to trust the
  2030.      * contents of a proxy-specific header.
  2031.      */
  2032.     public function isFromTrustedProxy(): bool
  2033.     {
  2034.         return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR', ''), self::$trustedProxies);
  2035.     }
  2037.     /**
  2038.      * This method is rather heavy because it splits and merges headers, and it's called by many other methods such as
  2039.      * getPort(), isSecure(), getHost(), getClientIps(), getBaseUrl() etc. Thus, we try to cache the results for
  2040.      * best performance.
  2041.      */
  2042.     private function getTrustedValues(int $type, ?string $ip = null): array
  2043.     {
  2044.         $cacheKey = $type."\0".((self::$trustedHeaderSet & $type) ? $this->headers->get(self::TRUSTED_HEADERS[$type]) : '');
  2045.         $cacheKey .= "\0".$ip."\0".$this->headers->get(self::TRUSTED_HEADERS[self::HEADER_FORWARDED]);
  2047.         if (isset($this->trustedValuesCache[$cacheKey])) {
  2048.             return $this->trustedValuesCache[$cacheKey];
  2049.         }
  2051.         $clientValues = [];
  2052.         $forwardedValues = [];
  2054.         if ((self::$trustedHeaderSet & $type) && $this->headers->has(self::TRUSTED_HEADERS[$type])) {
  2055.             foreach (explode(',', $this->headers->get(self::TRUSTED_HEADERS[$type])) as $v) {
  2056.                 $clientValues[] = (self::HEADER_X_FORWARDED_PORT === $type ? '0.0.0.0:' : '').trim($v);
  2057.             }
  2058.         }
  2060.         if ((self::$trustedHeaderSet & self::HEADER_FORWARDED) && (isset(self::FORWARDED_PARAMS[$type])) && $this->headers->has(self::TRUSTED_HEADERS[self::HEADER_FORWARDED])) {
  2061.             $forwarded = $this->headers->get(self::TRUSTED_HEADERS[self::HEADER_FORWARDED]);
  2062.             $parts = HeaderUtils::split($forwarded, ',;=');
  2063.             $param = self::FORWARDED_PARAMS[$type];
  2064.             foreach ($parts as $subParts) {
  2065.                 if (null === $v = HeaderUtils::combine($subParts)[$param] ?? null) {
  2066.                     continue;
  2067.                 }
  2068.                 if (self::HEADER_X_FORWARDED_PORT === $type) {
  2069.                     if (str_ends_with($v, ']') || false === $v = strrchr($v, ':')) {
  2070.                         $v = $this->isSecure() ? ':443' : ':80';
  2071.                     }
  2072.                     $v = '0.0.0.0'.$v;
  2073.                 }
  2074.                 $forwardedValues[] = $v;
  2075.             }
  2076.         }
  2078.         if (null !== $ip) {
  2079.             $clientValues = $this->normalizeAndFilterClientIps($clientValues, $ip);
  2080.             $forwardedValues = $this->normalizeAndFilterClientIps($forwardedValues, $ip);
  2081.         }
  2083.         if ($forwardedValues === $clientValues || !$clientValues) {
  2084.             return $this->trustedValuesCache[$cacheKey] = $forwardedValues;
  2085.         }
  2087.         if (!$forwardedValues) {
  2088.             return $this->trustedValuesCache[$cacheKey] = $clientValues;
  2089.         }
  2091.         if (!$this->isForwardedValid) {
  2092.             return $this->trustedValuesCache[$cacheKey] = null !== $ip ? ['0.0.0.0', $ip] : [];
  2093.         }
  2094.         $this->isForwardedValid = false;
  2096.         throw new ConflictingHeadersException(\sprintf('The request has both a trusted "%s" header and a trusted "%s" header, conflicting with each other. You should either configure your proxy to remove one of them, or configure your project to distrust the offending one.', self::TRUSTED_HEADERS[self::HEADER_FORWARDED], self::TRUSTED_HEADERS[$type]));
  2097.     }
  2099.     private function normalizeAndFilterClientIps(array $clientIps, string $ip): array
  2100.     {
  2101.         if (!$clientIps) {
  2102.             return [];
  2103.         }
  2104.         $clientIps[] = $ip; // Complete the IP chain with the IP the request actually came from
  2105.         $firstTrustedIp = null;
  2107.         foreach ($clientIps as $key => $clientIp) {
  2108.             if (strpos($clientIp, '.')) {
  2109.                 // Strip :port from IPv4 addresses. This is allowed in Forwarded
  2110.                 // and may occur in X-Forwarded-For.
  2111.                 $i = strpos($clientIp, ':');
  2112.                 if ($i) {
  2113.                     $clientIps[$key] = $clientIp = substr($clientIp, 0, $i);
  2114.                 }
  2115.             } elseif (str_starts_with($clientIp, '[')) {
  2116.                 // Strip brackets and :port from IPv6 addresses.
  2117.                 $i = strpos($clientIp, ']', 1);
  2118.                 $clientIps[$key] = $clientIp = substr($clientIp, 1, $i - 1);
  2119.             }
  2121.             if (!filter_var($clientIp, \FILTER_VALIDATE_IP)) {
  2122.                 unset($clientIps[$key]);
  2124.                 continue;
  2125.             }
  2127.             if (IpUtils::checkIp($clientIp, self::$trustedProxies)) {
  2128.                 unset($clientIps[$key]);
  2130.                 // Fallback to this when the client IP falls into the range of trusted proxies
  2131.                 $firstTrustedIp ??= $clientIp;
  2132.             }
  2133.         }
  2135.         // Now the IP chain contains only untrusted proxies and the client IP
  2136.         return $clientIps ? array_reverse($clientIps) : [$firstTrustedIp];
  2137.     }
  2139.     /**
  2140.      * Is this IIS with UrlRewriteModule?
  2141.      *
  2142.      * This method consumes, caches and removed the IIS_WasUrlRewritten env var,
  2143.      * so we don't inherit it to sub-requests.
  2144.      */
  2145.     private function isIisRewrite(): bool
  2146.     {
  2147.         if (1 === $this->server->getInt('IIS_WasUrlRewritten')) {
  2148.             $this->isIisRewrite = true;
  2149.             $this->server->remove('IIS_WasUrlRewritten');
  2150.         }
  2152.         return $this->isIisRewrite;
  2153.     }
  2155.     /**
  2156.      * See https://url.spec.whatwg.org/.
  2157.      */
  2158.     private static function isHostValid(string $host): bool
  2159.     {
  2160.         if ('[' === $host[0]) {
  2161.             return ']' === $host[-1] && filter_var(substr($host, 1, -1), \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV6);
  2162.         }
  2164.         if (preg_match('/\.[0-9]++\.?$/D', $host)) {
  2165.             return null !== filter_var($host, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4 | \FILTER_NULL_ON_FAILURE);
  2166.         }
  2168.         // use preg_replace() instead of preg_match() to prevent DoS attacks with long host names
  2169.         return '' === preg_replace('/[-a-zA-Z0-9_]++\.?/', '', $host);
  2170.     }
  2171. }