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

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