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

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