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
  190.      */
  191.     protected $session;
  193.     /**
  194.      * @var string
  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.     /**
  250.      * @param array                $query      The GET parameters
  251.      * @param array                $request    The POST parameters
  252.      * @param array                $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  253.      * @param array                $cookies    The COOKIE parameters
  254.      * @param array                $files      The FILES parameters
  255.      * @param array                $server     The SERVER parameters
  256.      * @param string|resource|null $content    The raw body data
  257.      */
  258.     public function __construct(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
  259.     {
  260.         $this->initialize($query, $request, $attributes, $cookies, $files, $server, $content);
  261.     }
  263.     /**
  264.      * Sets the parameters for this request.
  265.      *
  266.      * This method also re-initializes all properties.
  267.      *
  268.      * @param array                $query      The GET parameters
  269.      * @param array                $request    The POST parameters
  270.      * @param array                $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  271.      * @param array                $cookies    The COOKIE parameters
  272.      * @param array                $files      The FILES parameters
  273.      * @param array                $server     The SERVER parameters
  274.      * @param string|resource|null $content    The raw body data
  275.      */
  276.     public function initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
  277.     {
  278.         $this->request = new InputBag($request);
  279.         $this->query = new InputBag($query);
  280.         $this->attributes = new ParameterBag($attributes);
  281.         $this->cookies = new InputBag($cookies);
  282.         $this->files = new FileBag($files);
  283.         $this->server = new ServerBag($server);
  284.         $this->headers = new HeaderBag($this->server->getHeaders());
  286.         $this->content = $content;
  287.         $this->languages = null;
  288.         $this->charsets = null;
  289.         $this->encodings = null;
  290.         $this->acceptableContentTypes = null;
  291.         $this->pathInfo = null;
  292.         $this->requestUri = null;
  293.         $this->baseUrl = null;
  294.         $this->basePath = null;
  295.         $this->method = null;
  296.         $this->format = null;
  297.     }
  299.     /**
  300.      * Creates a new request with values from PHP's super globals.
  301.      *
  302.      * @return static
  303.      */
  304.     public static function createFromGlobals()
  305.     {
  306.         $request = self::createRequestFromFactory($_GET, $_POST, [], $_COOKIE, $_FILES, $_SERVER);
  308.         if (str_starts_with($request->headers->get('CONTENT_TYPE', ''), 'application/x-www-form-urlencoded')
  309.             && \in_array(strtoupper($request->server->get('REQUEST_METHOD', 'GET')), ['PUT', 'DELETE', 'PATCH'])
  310.         ) {
  311.             parse_str($request->getContent(), $data);
  312.             $request->request = new InputBag($data);
  313.         }
  315.         return $request;
  316.     }
  318.     /**
  319.      * Creates a Request based on a given URI and configuration.
  320.      *
  321.      * The information contained in the URI always take precedence
  322.      * over the other information (server and parameters).
  323.      *
  324.      * @param string               $uri        The URI
  325.      * @param string               $method     The HTTP method
  326.      * @param array                $parameters The query (GET) or request (POST) parameters
  327.      * @param array                $cookies    The request cookies ($_COOKIE)
  328.      * @param array                $files      The request files ($_FILES)
  329.      * @param array                $server     The server parameters ($_SERVER)
  330.      * @param string|resource|null $content    The raw body data
  331.      *
  332.      * @return static
  333.      */
  334.     public static function create(string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], $content = null)
  335.     {
  336.         $server = array_replace([
  337.             'SERVER_NAME' => 'localhost',
  338.             'SERVER_PORT' => 80,
  339.             'HTTP_HOST' => 'localhost',
  340.             'HTTP_USER_AGENT' => 'Symfony',
  341.             'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
  342.             'HTTP_ACCEPT_LANGUAGE' => 'en-us,en;q=0.5',
  343.             'HTTP_ACCEPT_CHARSET' => 'ISO-8859-1,utf-8;q=0.7,*;q=0.7',
  344.             'REMOTE_ADDR' => '127.0.0.1',
  345.             'SCRIPT_NAME' => '',
  346.             'SCRIPT_FILENAME' => '',
  347.             'SERVER_PROTOCOL' => 'HTTP/1.1',
  348.             'REQUEST_TIME' => time(),
  349.             'REQUEST_TIME_FLOAT' => microtime(true),
  350.         ], $server);
  352.         $server['PATH_INFO'] = '';
  353.         $server['REQUEST_METHOD'] = strtoupper($method);
  355.         $components = parse_url($uri);
  356.         if (isset($components['host'])) {
  357.             $server['SERVER_NAME'] = $components['host'];
  358.             $server['HTTP_HOST'] = $components['host'];
  359.         }
  361.         if (isset($components['scheme'])) {
  362.             if ('https' === $components['scheme']) {
  363.                 $server['HTTPS'] = 'on';
  364.                 $server['SERVER_PORT'] = 443;
  365.             } else {
  366.                 unset($server['HTTPS']);
  367.                 $server['SERVER_PORT'] = 80;
  368.             }
  369.         }
  371.         if (isset($components['port'])) {
  372.             $server['SERVER_PORT'] = $components['port'];
  373.             $server['HTTP_HOST'] .= ':'.$components['port'];
  374.         }
  376.         if (isset($components['user'])) {
  377.             $server['PHP_AUTH_USER'] = $components['user'];
  378.         }
  380.         if (isset($components['pass'])) {
  381.             $server['PHP_AUTH_PW'] = $components['pass'];
  382.         }
  384.         if (!isset($components['path'])) {
  385.             $components['path'] = '/';
  386.         }
  388.         switch (strtoupper($method)) {
  389.             case 'POST':
  390.             case 'PUT':
  391.             case 'DELETE':
  392.                 if (!isset($server['CONTENT_TYPE'])) {
  393.                     $server['CONTENT_TYPE'] = 'application/x-www-form-urlencoded';
  394.                 }
  395.                 // no break
  396.             case 'PATCH':
  397.                 $request = $parameters;
  398.                 $query = [];
  399.                 break;
  400.             default:
  401.                 $request = [];
  402.                 $query = $parameters;
  403.                 break;
  404.         }
  406.         $queryString = '';
  407.         if (isset($components['query'])) {
  408.             parse_str(html_entity_decode($components['query']), $qs);
  410.             if ($query) {
  411.                 $query = array_replace($qs, $query);
  412.                 $queryString = http_build_query($query, '', '&');
  413.             } else {
  414.                 $query = $qs;
  415.                 $queryString = $components['query'];
  416.             }
  417.         } elseif ($query) {
  418.             $queryString = http_build_query($query, '', '&');
  419.         }
  421.         $server['REQUEST_URI'] = $components['path'].('' !== $queryString ? '?'.$queryString : '');
  422.         $server['QUERY_STRING'] = $queryString;
  424.         return self::createRequestFromFactory($query, $request, [], $cookies, $files, $server, $content);
  425.     }
  427.     /**
  428.      * Sets a callable able to create a Request instance.
  429.      *
  430.      * This is mainly useful when you need to override the Request class
  431.      * to keep BC with an existing system. It should not be used for any
  432.      * other purpose.
  433.      */
  434.     public static function setFactory(?callable $callable)
  435.     {
  436.         self::$requestFactory = $callable;
  437.     }
  439.     /**
  440.      * Clones a request and overrides some of its parameters.
  441.      *
  442.      * @param array $query      The GET parameters
  443.      * @param array $request    The POST parameters
  444.      * @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  445.      * @param array $cookies    The COOKIE parameters
  446.      * @param array $files      The FILES parameters
  447.      * @param array $server     The SERVER parameters
  448.      *
  449.      * @return static
  450.      */
  451.     public function duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)
  452.     {
  453.         $dup = clone $this;
  454.         if (null !== $query) {
  455.             $dup->query = new InputBag($query);
  456.         }
  457.         if (null !== $request) {
  458.             $dup->request = new InputBag($request);
  459.         }
  460.         if (null !== $attributes) {
  461.             $dup->attributes = new ParameterBag($attributes);
  462.         }
  463.         if (null !== $cookies) {
  464.             $dup->cookies = new InputBag($cookies);
  465.         }
  466.         if (null !== $files) {
  467.             $dup->files = new FileBag($files);
  468.         }
  469.         if (null !== $server) {
  470.             $dup->server = new ServerBag($server);
  471.             $dup->headers = new HeaderBag($dup->server->getHeaders());
  472.         }
  473.         $dup->languages = null;
  474.         $dup->charsets = null;
  475.         $dup->encodings = null;
  476.         $dup->acceptableContentTypes = null;
  477.         $dup->pathInfo = null;
  478.         $dup->requestUri = null;
  479.         $dup->baseUrl = null;
  480.         $dup->basePath = null;
  481.         $dup->method = null;
  482.         $dup->format = null;
  484.         if (!$dup->get('_format') && $this->get('_format')) {
  485.             $dup->attributes->set('_format', $this->get('_format'));
  486.         }
  488.         if (!$dup->getRequestFormat(null)) {
  489.             $dup->setRequestFormat($this->getRequestFormat(null));
  490.         }
  492.         return $dup;
  493.     }
  495.     /**
  496.      * Clones the current request.
  497.      *
  498.      * Note that the session is not cloned as duplicated requests
  499.      * are most of the time sub-requests of the main one.
  500.      */
  501.     public function __clone()
  502.     {
  503.         $this->query = clone $this->query;
  504.         $this->request = clone $this->request;
  505.         $this->attributes = clone $this->attributes;
  506.         $this->cookies = clone $this->cookies;
  507.         $this->files = clone $this->files;
  508.         $this->server = clone $this->server;
  509.         $this->headers = clone $this->headers;
  510.     }
  512.     /**
  513.      * Returns the request as a string.
  514.      *
  515.      * @return string The request
  516.      */
  517.     public function __toString()
  518.     {
  519.         $content = $this->getContent();
  521.         $cookieHeader = '';
  522.         $cookies = [];
  524.         foreach ($this->cookies as $k => $v) {
  525.             $cookies[] = $k.'='.$v;
  526.         }
  528.         if (!empty($cookies)) {
  529.             $cookieHeader = 'Cookie: '.implode('; ', $cookies)."\r\n";
  530.         }
  532.         return
  533.             sprintf('%s %s %s', $this->getMethod(), $this->getRequestUri(), $this->server->get('SERVER_PROTOCOL'))."\r\n".
  534.             $this->headers.
  535.             $cookieHeader."\r\n".
  536.             $content;
  537.     }
  539.     /**
  540.      * Overrides the PHP global variables according to this request instance.
  541.      *
  542.      * It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE.
  543.      * $_FILES is never overridden, see rfc1867
  544.      */
  545.     public function overrideGlobals()
  546.     {
  547.         $this->server->set('QUERY_STRING', static::normalizeQueryString(http_build_query($this->query->all(), '', '&')));
  549.         $_GET = $this->query->all();
  550.         $_POST = $this->request->all();
  551.         $_SERVER = $this->server->all();
  552.         $_COOKIE = $this->cookies->all();
  554.         foreach ($this->headers->all() as $key => $value) {
  555.             $key = strtoupper(str_replace('-', '_', $key));
  556.             if (\in_array($key, ['CONTENT_TYPE', 'CONTENT_LENGTH', 'CONTENT_MD5'], true)) {
  557.                 $_SERVER[$key] = implode(', ', $value);
  558.             } else {
  559.                 $_SERVER['HTTP_'.$key] = implode(', ', $value);
  560.             }
  561.         }
  563.         $request = ['g' => $_GET, 'p' => $_POST, 'c' => $_COOKIE];
  565.         $requestOrder = ini_get('request_order') ?: ini_get('variables_order');
  566.         $requestOrder = preg_replace('#[^cgp]#', '', strtolower($requestOrder)) ?: 'gp';
  568.         $_REQUEST = [[]];
  570.         foreach (str_split($requestOrder) as $order) {
  571.             $_REQUEST[] = $request[$order];
  572.         }
  574.         $_REQUEST = array_merge(...$_REQUEST);
  575.     }
  577.     /**
  578.      * Sets a list of trusted proxies.
  579.      *
  580.      * You should only list the reverse proxies that you manage directly.
  581.      *
  582.      * @param array $proxies          A list of trusted proxies, the string 'REMOTE_ADDR' will be replaced with $_SERVER['REMOTE_ADDR']
  583.      * @param int   $trustedHeaderSet A bit field of Request::HEADER_*, to set which headers to trust from your proxies
  584.      */
  585.     public static function setTrustedProxies(array $proxies, int $trustedHeaderSet)
  586.     {
  587.         if (self::HEADER_X_FORWARDED_ALL === $trustedHeaderSet) {
  588.             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.');
  589.         }
  590.         self::$trustedProxies = array_reduce($proxies, function ($proxies, $proxy) {
  591.             if ('REMOTE_ADDR' !== $proxy) {
  592.                 $proxies[] = $proxy;
  593.             } elseif (isset($_SERVER['REMOTE_ADDR'])) {
  594.                 $proxies[] = $_SERVER['REMOTE_ADDR'];
  595.             }
  597.             return $proxies;
  598.         }, []);
  599.         self::$trustedHeaderSet = $trustedHeaderSet;
  600.     }
  602.     /**
  603.      * Gets the list of trusted proxies.
  604.      *
  605.      * @return array An array of trusted proxies
  606.      */
  607.     public static function getTrustedProxies()
  608.     {
  609.         return self::$trustedProxies;
  610.     }
  612.     /**
  613.      * Gets the set of trusted headers from trusted proxies.
  614.      *
  615.      * @return int A bit field of Request::HEADER_* that defines which headers are trusted from your proxies
  616.      */
  617.     public static function getTrustedHeaderSet()
  618.     {
  619.         return self::$trustedHeaderSet;
  620.     }
  622.     /**
  623.      * Sets a list of trusted host patterns.
  624.      *
  625.      * You should only list the hosts you manage using regexs.
  626.      *
  627.      * @param array $hostPatterns A list of trusted host patterns
  628.      */
  629.     public static function setTrustedHosts(array $hostPatterns)
  630.     {
  631.         self::$trustedHostPatterns = array_map(function ($hostPattern) {
  632.             return sprintf('{%s}i', $hostPattern);
  633.         }, $hostPatterns);
  634.         // we need to reset trusted hosts on trusted host patterns change
  635.         self::$trustedHosts = [];
  636.     }
  638.     /**
  639.      * Gets the list of trusted host patterns.
  640.      *
  641.      * @return array An array of trusted host patterns
  642.      */
  643.     public static function getTrustedHosts()
  644.     {
  645.         return self::$trustedHostPatterns;
  646.     }
  648.     /**
  649.      * Normalizes a query string.
  650.      *
  651.      * It builds a normalized query string, where keys/value pairs are alphabetized,
  652.      * have consistent escaping and unneeded delimiters are removed.
  653.      *
  654.      * @return string A normalized query string for the Request
  655.      */
  656.     public static function normalizeQueryString(?string $qs)
  657.     {
  658.         if ('' === ($qs ?? '')) {
  659.             return '';
  660.         }
  662.         $qs = HeaderUtils::parseQuery($qs);
  663.         ksort($qs);
  665.         return http_build_query($qs, '', '&', \PHP_QUERY_RFC3986);
  666.     }
  668.     /**
  669.      * Enables support for the _method request parameter to determine the intended HTTP method.
  670.      *
  671.      * Be warned that enabling this feature might lead to CSRF issues in your code.
  672.      * Check that you are using CSRF tokens when required.
  673.      * If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered
  674.      * and used to send a "PUT" or "DELETE" request via the _method request parameter.
  675.      * If these methods are not protected against CSRF, this presents a possible vulnerability.
  676.      *
  677.      * The HTTP method can only be overridden when the real HTTP method is POST.
  678.      */
  679.     public static function enableHttpMethodParameterOverride()
  680.     {
  681.         self::$httpMethodParameterOverride = true;
  682.     }
  684.     /**
  685.      * Checks whether support for the _method request parameter is enabled.
  686.      *
  687.      * @return bool True when the _method request parameter is enabled, false otherwise
  688.      */
  689.     public static function getHttpMethodParameterOverride()
  690.     {
  691.         return self::$httpMethodParameterOverride;
  692.     }
  694.     /**
  695.      * Gets a "parameter" value from any bag.
  696.      *
  697.      * This method is mainly useful for libraries that want to provide some flexibility. If you don't need the
  698.      * flexibility in controllers, it is better to explicitly get request parameters from the appropriate
  699.      * public property instead (attributes, query, request).
  700.      *
  701.      * Order of precedence: PATH (routing placeholders or custom attributes), GET, POST
  702.      *
  703.      * @param mixed $default The default value if the parameter key does not exist
  704.      *
  705.      * @return mixed
  706.      */
  707.     public function get(string $key, $default = null)
  708.     {
  709.         if ($this !== $result = $this->attributes->get($key, $this)) {
  710.             return $result;
  711.         }
  713.         if ($this->query->has($key)) {
  714.             return $this->query->all()[$key];
  715.         }
  717.         if ($this->request->has($key)) {
  718.             return $this->request->all()[$key];
  719.         }
  721.         return $default;
  722.     }
  724.     /**
  725.      * Gets the Session.
  726.      *
  727.      * @return SessionInterface The session
  728.      */
  729.     public function getSession()
  730.     {
  731.         $session = $this->session;
  732.         if (!$session instanceof SessionInterface && null !== $session) {
  733.             $this->setSession($session = $session());
  734.         }
  736.         if (null === $session) {
  737.             throw new SessionNotFoundException('Session has not been set.');
  738.         }
  740.         return $session;
  741.     }
  743.     /**
  744.      * Whether the request contains a Session which was started in one of the
  745.      * previous requests.
  746.      *
  747.      * @return bool
  748.      */
  749.     public function hasPreviousSession()
  750.     {
  751.         // the check for $this->session avoids malicious users trying to fake a session cookie with proper name
  752.         return $this->hasSession() && $this->cookies->has($this->getSession()->getName());
  753.     }
  755.     /**
  756.      * Whether the request contains a Session object.
  757.      *
  758.      * This method does not give any information about the state of the session object,
  759.      * like whether the session is started or not. It is just a way to check if this Request
  760.      * is associated with a Session instance.
  761.      *
  762.      * @return bool true when the Request contains a Session object, false otherwise
  763.      */
  764.     public function hasSession()
  765.     {
  766.         return null !== $this->session;
  767.     }
  769.     public function setSession(SessionInterface $session)
  770.     {
  771.         $this->session = $session;
  772.     }
  774.     /**
  775.      * @internal
  776.      */
  777.     public function setSessionFactory(callable $factory)
  778.     {
  779.         $this->session = $factory;
  780.     }
  782.     /**
  783.      * Returns the client IP addresses.
  784.      *
  785.      * In the returned array the most trusted IP address is first, and the
  786.      * least trusted one last. The "real" client IP address is the last one,
  787.      * but this is also the least trusted one. Trusted proxies are stripped.
  788.      *
  789.      * Use this method carefully; you should use getClientIp() instead.
  790.      *
  791.      * @return array The client IP addresses
  792.      *
  793.      * @see getClientIp()
  794.      */
  795.     public function getClientIps()
  796.     {
  797.         $ip = $this->server->get('REMOTE_ADDR');
  799.         if (!$this->isFromTrustedProxy()) {
  800.             return [$ip];
  801.         }
  803.         return $this->getTrustedValues(self::HEADER_X_FORWARDED_FOR, $ip) ?: [$ip];
  804.     }
  806.     /**
  807.      * Returns the client IP address.
  808.      *
  809.      * This method can read the client IP address from the "X-Forwarded-For" header
  810.      * when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For"
  811.      * header value is a comma+space separated list of IP addresses, the left-most
  812.      * being the original client, and each successive proxy that passed the request
  813.      * adding the IP address where it received the request from.
  814.      *
  815.      * If your reverse proxy uses a different header name than "X-Forwarded-For",
  816.      * ("Client-Ip" for instance), configure it via the $trustedHeaderSet
  817.      * argument of the Request::setTrustedProxies() method instead.
  818.      *
  819.      * @return string|null The client IP address
  820.      *
  821.      * @see getClientIps()
  822.      * @see https://wikipedia.org/wiki/X-Forwarded-For
  823.      */
  824.     public function getClientIp()
  825.     {
  826.         $ipAddresses = $this->getClientIps();
  828.         return $ipAddresses[0];
  829.     }
  831.     /**
  832.      * Returns current script name.
  833.      *
  834.      * @return string
  835.      */
  836.     public function getScriptName()
  837.     {
  838.         return $this->server->get('SCRIPT_NAME', $this->server->get('ORIG_SCRIPT_NAME', ''));
  839.     }
  841.     /**
  842.      * Returns the path being requested relative to the executed script.
  843.      *
  844.      * The path info always starts with a /.
  845.      *
  846.      * Suppose this request is instantiated from /mysite on localhost:
  847.      *
  848.      *  * http://localhost/mysite              returns an empty string
  849.      *  * http://localhost/mysite/about        returns '/about'
  850.      *  * http://localhost/mysite/enco%20ded   returns '/enco%20ded'
  851.      *  * http://localhost/mysite/about?var=1  returns '/about'
  852.      *
  853.      * @return string The raw path (i.e. not urldecoded)
  854.      */
  855.     public function getPathInfo()
  856.     {
  857.         if (null === $this->pathInfo) {
  858.             $this->pathInfo = $this->preparePathInfo();
  859.         }
  861.         return $this->pathInfo;
  862.     }
  864.     /**
  865.      * Returns the root path from which this request is executed.
  866.      *
  867.      * Suppose that an index.php file instantiates this request object:
  868.      *
  869.      *  * http://localhost/index.php         returns an empty string
  870.      *  * http://localhost/index.php/page    returns an empty string
  871.      *  * http://localhost/web/index.php     returns '/web'
  872.      *  * http://localhost/we%20b/index.php  returns '/we%20b'
  873.      *
  874.      * @return string The raw path (i.e. not urldecoded)
  875.      */
  876.     public function getBasePath()
  877.     {
  878.         if (null === $this->basePath) {
  879.             $this->basePath = $this->prepareBasePath();
  880.         }
  882.         return $this->basePath;
  883.     }
  885.     /**
  886.      * Returns the root URL from which this request is executed.
  887.      *
  888.      * The base URL never ends with a /.
  889.      *
  890.      * This is similar to getBasePath(), except that it also includes the
  891.      * script filename (e.g. index.php) if one exists.
  892.      *
  893.      * @return string The raw URL (i.e. not urldecoded)
  894.      */
  895.     public function getBaseUrl()
  896.     {
  897.         $trustedPrefix = '';
  899.         // the proxy prefix must be prepended to any prefix being needed at the webserver level
  900.         if ($this->isFromTrustedProxy() && $trustedPrefixValues = $this->getTrustedValues(self::HEADER_X_FORWARDED_PREFIX)) {
  901.             $trustedPrefix = rtrim($trustedPrefixValues[0], '/');
  902.         }
  904.         return $trustedPrefix.$this->getBaseUrlReal();
  905.     }
  907.     /**
  908.      * Returns the real base URL received by the webserver from which this request is executed.
  909.      * The URL does not include trusted reverse proxy prefix.
  910.      *
  911.      * @return string The raw URL (i.e. not urldecoded)
  912.      */
  913.     private function getBaseUrlReal()
  914.     {
  915.         if (null === $this->baseUrl) {
  916.             $this->baseUrl = $this->prepareBaseUrl();
  917.         }
  919.         return $this->baseUrl;
  920.     }
  922.     /**
  923.      * Gets the request's scheme.
  924.      *
  925.      * @return string
  926.      */
  927.     public function getScheme()
  928.     {
  929.         return $this->isSecure() ? 'https' : 'http';
  930.     }
  932.     /**
  933.      * Returns the port on which the request is made.
  934.      *
  935.      * This method can read the client port from the "X-Forwarded-Port" header
  936.      * when trusted proxies were set via "setTrustedProxies()".
  937.      *
  938.      * The "X-Forwarded-Port" header must contain the client port.
  939.      *
  940.      * @return int|string can be a string if fetched from the server bag
  941.      */
  942.     public function getPort()
  943.     {
  944.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_PORT)) {
  945.             $host = $host[0];
  946.         } elseif ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  947.             $host = $host[0];
  948.         } elseif (!$host = $this->headers->get('HOST')) {
  949.             return $this->server->get('SERVER_PORT');
  950.         }
  952.         if ('[' === $host[0]) {
  953.             $pos = strpos($host, ':', strrpos($host, ']'));
  954.         } else {
  955.             $pos = strrpos($host, ':');
  956.         }
  958.         if (false !== $pos && $port = substr($host, $pos + 1)) {
  959.             return (int) $port;
  960.         }
  962.         return 'https' === $this->getScheme() ? 443 : 80;
  963.     }
  965.     /**
  966.      * Returns the user.
  967.      *
  968.      * @return string|null
  969.      */
  970.     public function getUser()
  971.     {
  972.         return $this->headers->get('PHP_AUTH_USER');
  973.     }
  975.     /**
  976.      * Returns the password.
  977.      *
  978.      * @return string|null
  979.      */
  980.     public function getPassword()
  981.     {
  982.         return $this->headers->get('PHP_AUTH_PW');
  983.     }
  985.     /**
  986.      * Gets the user info.
  987.      *
  988.      * @return string A user name and, optionally, scheme-specific information about how to gain authorization to access the server
  989.      */
  990.     public function getUserInfo()
  991.     {
  992.         $userinfo = $this->getUser();
  994.         $pass = $this->getPassword();
  995.         if ('' != $pass) {
  996.             $userinfo .= ":$pass";
  997.         }
  999.         return $userinfo;
  1000.     }
  1002.     /**
  1003.      * Returns the HTTP host being requested.
  1004.      *
  1005.      * The port name will be appended to the host if it's non-standard.
  1006.      *
  1007.      * @return string
  1008.      */
  1009.     public function getHttpHost()
  1010.     {
  1011.         $scheme = $this->getScheme();
  1012.         $port = $this->getPort();
  1014.         if (('http' == $scheme && 80 == $port) || ('https' == $scheme && 443 == $port)) {
  1015.             return $this->getHost();
  1016.         }
  1018.         return $this->getHost().':'.$port;
  1019.     }
  1021.     /**
  1022.      * Returns the requested URI (path and query string).
  1023.      *
  1024.      * @return string The raw URI (i.e. not URI decoded)
  1025.      */
  1026.     public function getRequestUri()
  1027.     {
  1028.         if (null === $this->requestUri) {
  1029.             $this->requestUri = $this->prepareRequestUri();
  1030.         }
  1032.         return $this->requestUri;
  1033.     }
  1035.     /**
  1036.      * Gets the scheme and HTTP host.
  1037.      *
  1038.      * If the URL was called with basic authentication, the user
  1039.      * and the password are not added to the generated string.
  1040.      *
  1041.      * @return string The scheme and HTTP host
  1042.      */
  1043.     public function getSchemeAndHttpHost()
  1044.     {
  1045.         return $this->getScheme().'://'.$this->getHttpHost();
  1046.     }
  1048.     /**
  1049.      * Generates a normalized URI (URL) for the Request.
  1050.      *
  1051.      * @return string A normalized URI (URL) for the Request
  1052.      *
  1053.      * @see getQueryString()
  1054.      */
  1055.     public function getUri()
  1056.     {
  1057.         if (null !== $qs = $this->getQueryString()) {
  1058.             $qs = '?'.$qs;
  1059.         }
  1061.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$this->getPathInfo().$qs;
  1062.     }
  1064.     /**
  1065.      * Generates a normalized URI for the given path.
  1066.      *
  1067.      * @param string $path A path to use instead of the current one
  1068.      *
  1069.      * @return string The normalized URI for the path
  1070.      */
  1071.     public function getUriForPath(string $path)
  1072.     {
  1073.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$path;
  1074.     }
  1076.     /**
  1077.      * Returns the path as relative reference from the current Request path.
  1078.      *
  1079.      * Only the URIs path component (no schema, host etc.) is relevant and must be given.
  1080.      * Both paths must be absolute and not contain relative parts.
  1081.      * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
  1082.      * Furthermore, they can be used to reduce the link size in documents.
  1083.      *
  1084.      * Example target paths, given a base path of "/a/b/c/d":
  1085.      * - "/a/b/c/d"     -> ""
  1086.      * - "/a/b/c/"      -> "./"
  1087.      * - "/a/b/"        -> "../"
  1088.      * - "/a/b/c/other" -> "other"
  1089.      * - "/a/x/y"       -> "../../x/y"
  1090.      *
  1091.      * @return string The relative target path
  1092.      */
  1093.     public function getRelativeUriForPath(string $path)
  1094.     {
  1095.         // be sure that we are dealing with an absolute path
  1096.         if (!isset($path[0]) || '/' !== $path[0]) {
  1097.             return $path;
  1098.         }
  1100.         if ($path === $basePath = $this->getPathInfo()) {
  1101.             return '';
  1102.         }
  1104.         $sourceDirs = explode('/', isset($basePath[0]) && '/' === $basePath[0] ? substr($basePath, 1) : $basePath);
  1105.         $targetDirs = explode('/', substr($path, 1));
  1106.         array_pop($sourceDirs);
  1107.         $targetFile = array_pop($targetDirs);
  1109.         foreach ($sourceDirs as $i => $dir) {
  1110.             if (isset($targetDirs[$i]) && $dir === $targetDirs[$i]) {
  1111.                 unset($sourceDirs[$i], $targetDirs[$i]);
  1112.             } else {
  1113.                 break;
  1114.             }
  1115.         }
  1117.         $targetDirs[] = $targetFile;
  1118.         $path = str_repeat('../', \count($sourceDirs)).implode('/', $targetDirs);
  1120.         // A reference to the same base directory or an empty subdirectory must be prefixed with "./".
  1121.         // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used
  1122.         // as the first segment of a relative-path reference, as it would be mistaken for a scheme name
  1123.         // (see https://tools.ietf.org/html/rfc3986#section-4.2).
  1124.         return !isset($path[0]) || '/' === $path[0]
  1125.             || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)
  1126.             ? "./$path" : $path;
  1127.     }
  1129.     /**
  1130.      * Generates the normalized query string for the Request.
  1131.      *
  1132.      * It builds a normalized query string, where keys/value pairs are alphabetized
  1133.      * and have consistent escaping.
  1134.      *
  1135.      * @return string|null A normalized query string for the Request
  1136.      */
  1137.     public function getQueryString()
  1138.     {
  1139.         $qs = static::normalizeQueryString($this->server->get('QUERY_STRING'));
  1141.         return '' === $qs ? null : $qs;
  1142.     }
  1144.     /**
  1145.      * Checks whether the request is secure or not.
  1146.      *
  1147.      * This method can read the client protocol from the "X-Forwarded-Proto" header
  1148.      * when trusted proxies were set via "setTrustedProxies()".
  1149.      *
  1150.      * The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".
  1151.      *
  1152.      * @return bool
  1153.      */
  1154.     public function isSecure()
  1155.     {
  1156.         if ($this->isFromTrustedProxy() && $proto = $this->getTrustedValues(self::HEADER_X_FORWARDED_PROTO)) {
  1157.             return \in_array(strtolower($proto[0]), ['https', 'on', 'ssl', '1'], true);
  1158.         }
  1160.         $https = $this->server->get('HTTPS');
  1162.         return !empty($https) && 'off' !== strtolower($https);
  1163.     }
  1165.     /**
  1166.      * Returns the host name.
  1167.      *
  1168.      * This method can read the client host name from the "X-Forwarded-Host" header
  1169.      * when trusted proxies were set via "setTrustedProxies()".
  1170.      *
  1171.      * The "X-Forwarded-Host" header must contain the client host name.
  1172.      *
  1173.      * @return string
  1174.      *
  1175.      * @throws SuspiciousOperationException when the host name is invalid or not trusted
  1176.      */
  1177.     public function getHost()
  1178.     {
  1179.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  1180.             $host = $host[0];
  1181.         } elseif (!$host = $this->headers->get('HOST')) {
  1182.             if (!$host = $this->server->get('SERVER_NAME')) {
  1183.                 $host = $this->server->get('SERVER_ADDR', '');
  1184.             }
  1185.         }
  1187.         // trim and remove port number from host
  1188.         // host is lowercase as per RFC 952/2181
  1189.         $host = strtolower(preg_replace('/:\d+$/', '', trim($host)));
  1191.         // as the host can come from the user (HTTP_HOST and depending on the configuration, SERVER_NAME too can come from the user)
  1192.         // check that it does not contain forbidden characters (see RFC 952 and RFC 2181)
  1193.         // use preg_replace() instead of preg_match() to prevent DoS attacks with long host names
  1194.         if ($host && '' !== preg_replace('/(?:^\[)?[a-zA-Z0-9-:\]_]+\.?/', '', $host)) {
  1195.             if (!$this->isHostValid) {
  1196.                 return '';
  1197.             }
  1198.             $this->isHostValid = false;
  1200.             throw new SuspiciousOperationException(sprintf('Invalid Host "%s".', $host));
  1201.         }
  1203.         if (\count(self::$trustedHostPatterns) > 0) {
  1204.             // to avoid host header injection attacks, you should provide a list of trusted host patterns
  1206.             if (\in_array($host, self::$trustedHosts)) {
  1207.                 return $host;
  1208.             }
  1210.             foreach (self::$trustedHostPatterns as $pattern) {
  1211.                 if (preg_match($pattern, $host)) {
  1212.                     self::$trustedHosts[] = $host;
  1214.                     return $host;
  1215.                 }
  1216.             }
  1218.             if (!$this->isHostValid) {
  1219.                 return '';
  1220.             }
  1221.             $this->isHostValid = false;
  1223.             throw new SuspiciousOperationException(sprintf('Untrusted Host "%s".', $host));
  1224.         }
  1226.         return $host;
  1227.     }
  1229.     /**
  1230.      * Sets the request method.
  1231.      */
  1232.     public function setMethod(string $method)
  1233.     {
  1234.         $this->method = null;
  1235.         $this->server->set('REQUEST_METHOD', $method);
  1236.     }
  1238.     /**
  1239.      * Gets the request "intended" method.
  1240.      *
  1241.      * If the X-HTTP-Method-Override header is set, and if the method is a POST,
  1242.      * then it is used to determine the "real" intended HTTP method.
  1243.      *
  1244.      * The _method request parameter can also be used to determine the HTTP method,
  1245.      * but only if enableHttpMethodParameterOverride() has been called.
  1246.      *
  1247.      * The method is always an uppercased string.
  1248.      *
  1249.      * @return string The request method
  1250.      *
  1251.      * @see getRealMethod()
  1252.      */
  1253.     public function getMethod()
  1254.     {
  1255.         if (null !== $this->method) {
  1256.             return $this->method;
  1257.         }
  1259.         $this->method = strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1261.         if ('POST' !== $this->method) {
  1262.             return $this->method;
  1263.         }
  1265.         $method = $this->headers->get('X-HTTP-METHOD-OVERRIDE');
  1267.         if (!$method && self::$httpMethodParameterOverride) {
  1268.             $method = $this->request->get('_method', $this->query->get('_method', 'POST'));
  1269.         }
  1271.         if (!\is_string($method)) {
  1272.             return $this->method;
  1273.         }
  1275.         $method = strtoupper($method);
  1277.         if (\in_array($method, ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'PATCH', 'PURGE', 'TRACE'], true)) {
  1278.             return $this->method = $method;
  1279.         }
  1281.         if (!preg_match('/^[A-Z]++$/D', $method)) {
  1282.             throw new SuspiciousOperationException(sprintf('Invalid method override "%s".', $method));
  1283.         }
  1285.         return $this->method = $method;
  1286.     }
  1288.     /**
  1289.      * Gets the "real" request method.
  1290.      *
  1291.      * @return string The request method
  1292.      *
  1293.      * @see getMethod()
  1294.      */
  1295.     public function getRealMethod()
  1296.     {
  1297.         return strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1298.     }
  1300.     /**
  1301.      * Gets the mime type associated with the format.
  1302.      *
  1303.      * @return string|null The associated mime type (null if not found)
  1304.      */
  1305.     public function getMimeType(string $format)
  1306.     {
  1307.         if (null === static::$formats) {
  1308.             static::initializeFormats();
  1309.         }
  1311.         return isset(static::$formats[$format]) ? static::$formats[$format][0] : null;
  1312.     }
  1314.     /**
  1315.      * Gets the mime types associated with the format.
  1316.      *
  1317.      * @return array The associated mime types
  1318.      */
  1319.     public static function getMimeTypes(string $format)
  1320.     {
  1321.         if (null === static::$formats) {
  1322.             static::initializeFormats();
  1323.         }
  1325.         return static::$formats[$format] ?? [];
  1326.     }
  1328.     /**
  1329.      * Gets the format associated with the mime type.
  1330.      *
  1331.      * @return string|null The format (null if not found)
  1332.      */
  1333.     public function getFormat(?string $mimeType)
  1334.     {
  1335.         $canonicalMimeType = null;
  1336.         if ($mimeType && false !== $pos = strpos($mimeType, ';')) {
  1337.             $canonicalMimeType = trim(substr($mimeType, 0, $pos));
  1338.         }
  1340.         if (null === static::$formats) {
  1341.             static::initializeFormats();
  1342.         }
  1344.         foreach (static::$formats as $format => $mimeTypes) {
  1345.             if (\in_array($mimeType, (array) $mimeTypes)) {
  1346.                 return $format;
  1347.             }
  1348.             if (null !== $canonicalMimeType && \in_array($canonicalMimeType, (array) $mimeTypes)) {
  1349.                 return $format;
  1350.             }
  1351.         }
  1353.         return null;
  1354.     }
  1356.     /**
  1357.      * Associates a format with mime types.
  1358.      *
  1359.      * @param string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
  1360.      */
  1361.     public function setFormat(?string $format, $mimeTypes)
  1362.     {
  1363.         if (null === static::$formats) {
  1364.             static::initializeFormats();
  1365.         }
  1367.         static::$formats[$format] = \is_array($mimeTypes) ? $mimeTypes : [$mimeTypes];
  1368.     }
  1370.     /**
  1371.      * Gets the request format.
  1372.      *
  1373.      * Here is the process to determine the format:
  1374.      *
  1375.      *  * format defined by the user (with setRequestFormat())
  1376.      *  * _format request attribute
  1377.      *  * $default
  1378.      *
  1379.      * @see getPreferredFormat
  1380.      *
  1381.      * @return string|null The request format
  1382.      */
  1383.     public function getRequestFormat(?string $default = 'html')
  1384.     {
  1385.         if (null === $this->format) {
  1386.             $this->format = $this->attributes->get('_format');
  1387.         }
  1389.         return $this->format ?? $default;
  1390.     }
  1392.     /**
  1393.      * Sets the request format.
  1394.      */
  1395.     public function setRequestFormat(?string $format)
  1396.     {
  1397.         $this->format = $format;
  1398.     }
  1400.     /**
  1401.      * Gets the format associated with the request.
  1402.      *
  1403.      * @return string|null The format (null if no content type is present)
  1404.      */
  1405.     public function getContentType()
  1406.     {
  1407.         return $this->getFormat($this->headers->get('CONTENT_TYPE', ''));
  1408.     }
  1410.     /**
  1411.      * Sets the default locale.
  1412.      */
  1413.     public function setDefaultLocale(string $locale)
  1414.     {
  1415.         $this->defaultLocale = $locale;
  1417.         if (null === $this->locale) {
  1418.             $this->setPhpDefaultLocale($locale);
  1419.         }
  1420.     }
  1422.     /**
  1423.      * Get the default locale.
  1424.      *
  1425.      * @return string
  1426.      */
  1427.     public function getDefaultLocale()
  1428.     {
  1429.         return $this->defaultLocale;
  1430.     }
  1432.     /**
  1433.      * Sets the locale.
  1434.      */
  1435.     public function setLocale(string $locale)
  1436.     {
  1437.         $this->setPhpDefaultLocale($this->locale = $locale);
  1438.     }
  1440.     /**
  1441.      * Get the locale.
  1442.      *
  1443.      * @return string
  1444.      */
  1445.     public function getLocale()
  1446.     {
  1447.         return null === $this->locale ? $this->defaultLocale : $this->locale;
  1448.     }
  1450.     /**
  1451.      * Checks if the request method is of specified type.
  1452.      *
  1453.      * @param string $method Uppercase request method (GET, POST etc)
  1454.      *
  1455.      * @return bool
  1456.      */
  1457.     public function isMethod(string $method)
  1458.     {
  1459.         return $this->getMethod() === strtoupper($method);
  1460.     }
  1462.     /**
  1463.      * Checks whether or not the method is safe.
  1464.      *
  1465.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
  1466.      *
  1467.      * @return bool
  1468.      */
  1469.     public function isMethodSafe()
  1470.     {
  1471.         return \in_array($this->getMethod(), ['GET', 'HEAD', 'OPTIONS', 'TRACE']);
  1472.     }
  1474.     /**
  1475.      * Checks whether or not the method is idempotent.
  1476.      *
  1477.      * @return bool
  1478.      */
  1479.     public function isMethodIdempotent()
  1480.     {
  1481.         return \in_array($this->getMethod(), ['HEAD', 'GET', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'PURGE']);
  1482.     }
  1484.     /**
  1485.      * Checks whether the method is cacheable or not.
  1486.      *
  1487.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
  1488.      *
  1489.      * @return bool True for GET and HEAD, false otherwise
  1490.      */
  1491.     public function isMethodCacheable()
  1492.     {
  1493.         return \in_array($this->getMethod(), ['GET', 'HEAD']);
  1494.     }
  1496.     /**
  1497.      * Returns the protocol version.
  1498.      *
  1499.      * If the application is behind a proxy, the protocol version used in the
  1500.      * requests between the client and the proxy and between the proxy and the
  1501.      * server might be different. This returns the former (from the "Via" header)
  1502.      * if the proxy is trusted (see "setTrustedProxies()"), otherwise it returns
  1503.      * the latter (from the "SERVER_PROTOCOL" server parameter).
  1504.      *
  1505.      * @return string|null
  1506.      */
  1507.     public function getProtocolVersion()
  1508.     {
  1509.         if ($this->isFromTrustedProxy()) {
  1510.             preg_match('~^(HTTP/)?([1-9]\.[0-9]) ~', $this->headers->get('Via'), $matches);
  1512.             if ($matches) {
  1513.                 return 'HTTP/'.$matches[2];
  1514.             }
  1515.         }
  1517.         return $this->server->get('SERVER_PROTOCOL');
  1518.     }
  1520.     /**
  1521.      * Returns the request body content.
  1522.      *
  1523.      * @param bool $asResource If true, a resource will be returned
  1524.      *
  1525.      * @return string|resource The request body content or a resource to read the body stream
  1526.      */
  1527.     public function getContent(bool $asResource = false)
  1528.     {
  1529.         $currentContentIsResource = \is_resource($this->content);
  1531.         if (true === $asResource) {
  1532.             if ($currentContentIsResource) {
  1533.                 rewind($this->content);
  1535.                 return $this->content;
  1536.             }
  1538.             // Content passed in parameter (test)
  1539.             if (\is_string($this->content)) {
  1540.                 $resource = fopen('php://temp', 'r+');
  1541.                 fwrite($resource, $this->content);
  1542.                 rewind($resource);
  1544.                 return $resource;
  1545.             }
  1547.             $this->content = false;
  1549.             return fopen('php://input', 'r');
  1550.         }
  1552.         if ($currentContentIsResource) {
  1553.             rewind($this->content);
  1555.             return stream_get_contents($this->content);
  1556.         }
  1558.         if (null === $this->content || false === $this->content) {
  1559.             $this->content = file_get_contents('php://input');
  1560.         }
  1562.         return $this->content;
  1563.     }
  1565.     /**
  1566.      * Gets the request body decoded as array, typically from a JSON payload.
  1567.      *
  1568.      * @throws JsonException When the body cannot be decoded to an array
  1569.      *
  1570.      * @return array
  1571.      */
  1572.     public function toArray()
  1573.     {
  1574.         if ('' === $content = $this->getContent()) {
  1575.             throw new JsonException('Request body is empty.');
  1576.         }
  1578.         try {
  1579.             $content = json_decode($content, true, 512, \JSON_BIGINT_AS_STRING | (\PHP_VERSION_ID >= 70300 ? \JSON_THROW_ON_ERROR : 0));
  1580.         } catch (\JsonException $e) {
  1581.             throw new JsonException('Could not decode request body.', $e->getCode(), $e);
  1582.         }
  1584.         if (\PHP_VERSION_ID < 70300 && \JSON_ERROR_NONE !== json_last_error()) {
  1585.             throw new JsonException('Could not decode request body: '.json_last_error_msg(), json_last_error());
  1586.         }
  1588.         if (!\is_array($content)) {
  1589.             throw new JsonException(sprintf('JSON content was expected to decode to an array, "%s" returned.', get_debug_type($content)));
  1590.         }
  1592.         return $content;
  1593.     }
  1595.     /**
  1596.      * Gets the Etags.
  1597.      *
  1598.      * @return array The entity tags
  1599.      */
  1600.     public function getETags()
  1601.     {
  1602.         return preg_split('/\s*,\s*/', $this->headers->get('If-None-Match', ''), -1, \PREG_SPLIT_NO_EMPTY);
  1603.     }
  1605.     /**
  1606.      * @return bool
  1607.      */
  1608.     public function isNoCache()
  1609.     {
  1610.         return $this->headers->hasCacheControlDirective('no-cache') || 'no-cache' == $this->headers->get('Pragma');
  1611.     }
  1613.     /**
  1614.      * Gets the preferred format for the response by inspecting, in the following order:
  1615.      *   * the request format set using setRequestFormat;
  1616.      *   * the values of the Accept HTTP header.
  1617.      *
  1618.      * Note that if you use this method, you should send the "Vary: Accept" header
  1619.      * in the response to prevent any issues with intermediary HTTP caches.
  1620.      */
  1621.     public function getPreferredFormat(?string $default = 'html'): ?string
  1622.     {
  1623.         if (null !== $this->preferredFormat || null !== $this->preferredFormat = $this->getRequestFormat(null)) {
  1624.             return $this->preferredFormat;
  1625.         }
  1627.         foreach ($this->getAcceptableContentTypes() as $mimeType) {
  1628.             if ($this->preferredFormat = $this->getFormat($mimeType)) {
  1629.                 return $this->preferredFormat;
  1630.             }
  1631.         }
  1633.         return $default;
  1634.     }
  1636.     /**
  1637.      * Returns the preferred language.
  1638.      *
  1639.      * @param string[] $locales An array of ordered available locales
  1640.      *
  1641.      * @return string|null The preferred locale
  1642.      */
  1643.     public function getPreferredLanguage(array $locales = null)
  1644.     {
  1645.         $preferredLanguages = $this->getLanguages();
  1647.         if (empty($locales)) {
  1648.             return $preferredLanguages[0] ?? null;
  1649.         }
  1651.         if (!$preferredLanguages) {
  1652.             return $locales[0];
  1653.         }
  1655.         $extendedPreferredLanguages = [];
  1656.         foreach ($preferredLanguages as $language) {
  1657.             $extendedPreferredLanguages[] = $language;
  1658.             if (false !== $position = strpos($language, '_')) {
  1659.                 $superLanguage = substr($language, 0, $position);
  1660.                 if (!\in_array($superLanguage, $preferredLanguages)) {
  1661.                     $extendedPreferredLanguages[] = $superLanguage;
  1662.                 }
  1663.             }
  1664.         }
  1666.         $preferredLanguages = array_values(array_intersect($extendedPreferredLanguages, $locales));
  1668.         return $preferredLanguages[0] ?? $locales[0];
  1669.     }
  1671.     /**
  1672.      * Gets a list of languages acceptable by the client browser.
  1673.      *
  1674.      * @return array Languages ordered in the user browser preferences
  1675.      */
  1676.     public function getLanguages()
  1677.     {
  1678.         if (null !== $this->languages) {
  1679.             return $this->languages;
  1680.         }
  1682.         $languages = AcceptHeader::fromString($this->headers->get('Accept-Language'))->all();
  1683.         $this->languages = [];
  1684.         foreach ($languages as $lang => $acceptHeaderItem) {
  1685.             if (str_contains($lang, '-')) {
  1686.                 $codes = explode('-', $lang);
  1687.                 if ('i' === $codes[0]) {
  1688.                     // Language not listed in ISO 639 that are not variants
  1689.                     // of any listed language, which can be registered with the
  1690.                     // i-prefix, such as i-cherokee
  1691.                     if (\count($codes) > 1) {
  1692.                         $lang = $codes[1];
  1693.                     }
  1694.                 } else {
  1695.                     for ($i = 0, $max = \count($codes); $i < $max; ++$i) {
  1696.                         if (0 === $i) {
  1697.                             $lang = strtolower($codes[0]);
  1698.                         } else {
  1699.                             $lang .= '_'.strtoupper($codes[$i]);
  1700.                         }
  1701.                     }
  1702.                 }
  1703.             }
  1705.             $this->languages[] = $lang;
  1706.         }
  1708.         return $this->languages;
  1709.     }
  1711.     /**
  1712.      * Gets a list of charsets acceptable by the client browser.
  1713.      *
  1714.      * @return array List of charsets in preferable order
  1715.      */
  1716.     public function getCharsets()
  1717.     {
  1718.         if (null !== $this->charsets) {
  1719.             return $this->charsets;
  1720.         }
  1722.         return $this->charsets = array_keys(AcceptHeader::fromString($this->headers->get('Accept-Charset'))->all());
  1723.     }
  1725.     /**
  1726.      * Gets a list of encodings acceptable by the client browser.
  1727.      *
  1728.      * @return array List of encodings in preferable order
  1729.      */
  1730.     public function getEncodings()
  1731.     {
  1732.         if (null !== $this->encodings) {
  1733.             return $this->encodings;
  1734.         }
  1736.         return $this->encodings = array_keys(AcceptHeader::fromString($this->headers->get('Accept-Encoding'))->all());
  1737.     }
  1739.     /**
  1740.      * Gets a list of content types acceptable by the client browser.
  1741.      *
  1742.      * @return array List of content types in preferable order
  1743.      */
  1744.     public function getAcceptableContentTypes()
  1745.     {
  1746.         if (null !== $this->acceptableContentTypes) {
  1747.             return $this->acceptableContentTypes;
  1748.         }
  1750.         return $this->acceptableContentTypes = array_keys(AcceptHeader::fromString($this->headers->get('Accept'))->all());
  1751.     }
  1753.     /**
  1754.      * Returns true if the request is an XMLHttpRequest.
  1755.      *
  1756.      * It works if your JavaScript library sets an X-Requested-With HTTP header.
  1757.      * It is known to work with common JavaScript frameworks:
  1758.      *
  1759.      * @see https://wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
  1760.      *
  1761.      * @return bool true if the request is an XMLHttpRequest, false otherwise
  1762.      */
  1763.     public function isXmlHttpRequest()
  1764.     {
  1765.         return 'XMLHttpRequest' == $this->headers->get('X-Requested-With');
  1766.     }
  1768.     /**
  1769.      * Checks whether the client browser prefers safe content or not according to RFC8674.
  1770.      *
  1771.      * @see https://tools.ietf.org/html/rfc8674
  1772.      */
  1773.     public function preferSafeContent(): bool
  1774.     {
  1775.         if (null !== $this->isSafeContentPreferred) {
  1776.             return $this->isSafeContentPreferred;
  1777.         }
  1779.         if (!$this->isSecure()) {
  1780.             // see https://tools.ietf.org/html/rfc8674#section-3
  1781.             $this->isSafeContentPreferred = false;
  1783.             return $this->isSafeContentPreferred;
  1784.         }
  1786.         $this->isSafeContentPreferred = AcceptHeader::fromString($this->headers->get('Prefer'))->has('safe');
  1788.         return $this->isSafeContentPreferred;
  1789.     }
  1791.     /*
  1792.      * The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)
  1793.      *
  1794.      * Code subject to the new BSD license (https://framework.zend.com/license).
  1795.      *
  1796.      * Copyright (c) 2005-2010 Zend Technologies USA Inc. (https://www.zend.com/)
  1797.      */
  1799.     protected function prepareRequestUri()
  1800.     {
  1801.         $requestUri = '';
  1803.         if ('1' == $this->server->get('IIS_WasUrlRewritten') && '' != $this->server->get('UNENCODED_URL')) {
  1804.             // IIS7 with URL Rewrite: make sure we get the unencoded URL (double slash problem)
  1805.             $requestUri = $this->server->get('UNENCODED_URL');
  1806.             $this->server->remove('UNENCODED_URL');
  1807.             $this->server->remove('IIS_WasUrlRewritten');
  1808.         } elseif ($this->server->has('REQUEST_URI')) {
  1809.             $requestUri = $this->server->get('REQUEST_URI');
  1811.             if ('' !== $requestUri && '/' === $requestUri[0]) {
  1812.                 // To only use path and query remove the fragment.
  1813.                 if (false !== $pos = strpos($requestUri, '#')) {
  1814.                     $requestUri = substr($requestUri, 0, $pos);
  1815.                 }
  1816.             } else {
  1817.                 // HTTP proxy reqs setup request URI with scheme and host [and port] + the URL path,
  1818.                 // only use URL path.
  1819.                 $uriComponents = parse_url($requestUri);
  1821.                 if (isset($uriComponents['path'])) {
  1822.                     $requestUri = $uriComponents['path'];
  1823.                 }
  1825.                 if (isset($uriComponents['query'])) {
  1826.                     $requestUri .= '?'.$uriComponents['query'];
  1827.                 }
  1828.             }
  1829.         } elseif ($this->server->has('ORIG_PATH_INFO')) {
  1830.             // IIS 5.0, PHP as CGI
  1831.             $requestUri = $this->server->get('ORIG_PATH_INFO');
  1832.             if ('' != $this->server->get('QUERY_STRING')) {
  1833.                 $requestUri .= '?'.$this->server->get('QUERY_STRING');
  1834.             }
  1835.             $this->server->remove('ORIG_PATH_INFO');
  1836.         }
  1838.         // normalize the request URI to ease creating sub-requests from this request
  1839.         $this->server->set('REQUEST_URI', $requestUri);
  1841.         return $requestUri;
  1842.     }
  1844.     /**
  1845.      * Prepares the base URL.
  1846.      *
  1847.      * @return string
  1848.      */
  1849.     protected function prepareBaseUrl()
  1850.     {
  1851.         $filename = basename($this->server->get('SCRIPT_FILENAME', ''));
  1853.         if (basename($this->server->get('SCRIPT_NAME', '')) === $filename) {
  1854.             $baseUrl = $this->server->get('SCRIPT_NAME');
  1855.         } elseif (basename($this->server->get('PHP_SELF', '')) === $filename) {
  1856.             $baseUrl = $this->server->get('PHP_SELF');
  1857.         } elseif (basename($this->server->get('ORIG_SCRIPT_NAME', '')) === $filename) {
  1858.             $baseUrl = $this->server->get('ORIG_SCRIPT_NAME'); // 1and1 shared hosting compatibility
  1859.         } else {
  1860.             // Backtrack up the script_filename to find the portion matching
  1861.             // php_self
  1862.             $path = $this->server->get('PHP_SELF', '');
  1863.             $file = $this->server->get('SCRIPT_FILENAME', '');
  1864.             $segs = explode('/', trim($file, '/'));
  1865.             $segs = array_reverse($segs);
  1866.             $index = 0;
  1867.             $last = \count($segs);
  1868.             $baseUrl = '';
  1869.             do {
  1870.                 $seg = $segs[$index];
  1871.                 $baseUrl = '/'.$seg.$baseUrl;
  1872.                 ++$index;
  1873.             } while ($last > $index && (false !== $pos = strpos($path, $baseUrl)) && 0 != $pos);
  1874.         }
  1876.         // Does the baseUrl have anything in common with the request_uri?
  1877.         $requestUri = $this->getRequestUri();
  1878.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1879.             $requestUri = '/'.$requestUri;
  1880.         }
  1882.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, $baseUrl)) {
  1883.             // full $baseUrl matches
  1884.             return $prefix;
  1885.         }
  1887.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, rtrim(\dirname($baseUrl), '/'.\DIRECTORY_SEPARATOR).'/')) {
  1888.             // directory portion of $baseUrl matches
  1889.             return rtrim($prefix, '/'.\DIRECTORY_SEPARATOR);
  1890.         }
  1892.         $truncatedRequestUri = $requestUri;
  1893.         if (false !== $pos = strpos($requestUri, '?')) {
  1894.             $truncatedRequestUri = substr($requestUri, 0, $pos);
  1895.         }
  1897.         $basename = basename($baseUrl ?? '');
  1898.         if (empty($basename) || !strpos(rawurldecode($truncatedRequestUri), $basename)) {
  1899.             // no match whatsoever; set it blank
  1900.             return '';
  1901.         }
  1903.         // If using mod_rewrite or ISAPI_Rewrite strip the script filename
  1904.         // out of baseUrl. $pos !== 0 makes sure it is not matching a value
  1905.         // from PATH_INFO or QUERY_STRING
  1906.         if (\strlen($requestUri) >= \strlen($baseUrl) && (false !== $pos = strpos($requestUri, $baseUrl)) && 0 !== $pos) {
  1907.             $baseUrl = substr($requestUri, 0, $pos + \strlen($baseUrl));
  1908.         }
  1910.         return rtrim($baseUrl, '/'.\DIRECTORY_SEPARATOR);
  1911.     }
  1913.     /**
  1914.      * Prepares the base path.
  1915.      *
  1916.      * @return string base path
  1917.      */
  1918.     protected function prepareBasePath()
  1919.     {
  1920.         $baseUrl = $this->getBaseUrl();
  1921.         if (empty($baseUrl)) {
  1922.             return '';
  1923.         }
  1925.         $filename = basename($this->server->get('SCRIPT_FILENAME'));
  1926.         if (basename($baseUrl) === $filename) {
  1927.             $basePath = \dirname($baseUrl);
  1928.         } else {
  1929.             $basePath = $baseUrl;
  1930.         }
  1932.         if ('\\' === \DIRECTORY_SEPARATOR) {
  1933.             $basePath = str_replace('\\', '/', $basePath);
  1934.         }
  1936.         return rtrim($basePath, '/');
  1937.     }
  1939.     /**
  1940.      * Prepares the path info.
  1941.      *
  1942.      * @return string path info
  1943.      */
  1944.     protected function preparePathInfo()
  1945.     {
  1946.         if (null === ($requestUri = $this->getRequestUri())) {
  1947.             return '/';
  1948.         }
  1950.         // Remove the query string from REQUEST_URI
  1951.         if (false !== $pos = strpos($requestUri, '?')) {
  1952.             $requestUri = substr($requestUri, 0, $pos);
  1953.         }
  1954.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1955.             $requestUri = '/'.$requestUri;
  1956.         }
  1958.         if (null === ($baseUrl = $this->getBaseUrlReal())) {
  1959.             return $requestUri;
  1960.         }
  1962.         $pathInfo = substr($requestUri, \strlen($baseUrl));
  1963.         if (false === $pathInfo || '' === $pathInfo) {
  1964.             // If substr() returns false then PATH_INFO is set to an empty string
  1965.             return '/';
  1966.         }
  1968.         return (string) $pathInfo;
  1969.     }
  1971.     /**
  1972.      * Initializes HTTP request formats.
  1973.      */
  1974.     protected static function initializeFormats()
  1975.     {
  1976.         static::$formats = [
  1977.             'html' => ['text/html', 'application/xhtml+xml'],
  1978.             'txt' => ['text/plain'],
  1979.             'js' => ['application/javascript', 'application/x-javascript', 'text/javascript'],
  1980.             'css' => ['text/css'],
  1981.             'json' => ['application/json', 'application/x-json'],
  1982.             'jsonld' => ['application/ld+json'],
  1983.             'xml' => ['text/xml', 'application/xml', 'application/x-xml'],
  1984.             'rdf' => ['application/rdf+xml'],
  1985.             'atom' => ['application/atom+xml'],
  1986.             'rss' => ['application/rss+xml'],
  1987.             'form' => ['application/x-www-form-urlencoded'],
  1988.         ];
  1989.     }
  1991.     private function setPhpDefaultLocale(string $locale): void
  1992.     {
  1993.         // if either the class Locale doesn't exist, or an exception is thrown when
  1994.         // setting the default locale, the intl module is not installed, and
  1995.         // the call can be ignored:
  1996.         try {
  1997.             if (class_exists(\Locale::class, false)) {
  1998.                 \Locale::setDefault($locale);
  1999.             }
  2000.         } catch (\Exception $e) {
  2001.         }
  2002.     }
  2004.     /**
  2005.      * Returns the prefix as encoded in the string when the string starts with
  2006.      * the given prefix, null otherwise.
  2007.      */
  2008.     private function getUrlencodedPrefix(string $string, string $prefix): ?string
  2009.     {
  2010.         if (!str_starts_with(rawurldecode($string), $prefix)) {
  2011.             return null;
  2012.         }
  2014.         $len = \strlen($prefix);
  2016.         if (preg_match(sprintf('#^(%%[[:xdigit:]]{2}|.){%d}#', $len), $string, $match)) {
  2017.             return $match[0];
  2018.         }
  2020.         return null;
  2021.     }
  2023.     private static function createRequestFromFactory(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null): self
  2024.     {
  2025.         if (self::$requestFactory) {
  2026.             $request = (self::$requestFactory)($query, $request, $attributes, $cookies, $files, $server, $content);
  2028.             if (!$request instanceof self) {
  2029.                 throw new \LogicException('The Request factory must return an instance of Symfony\Component\HttpFoundation\Request.');
  2030.             }
  2032.             return $request;
  2033.         }
  2035.         return new static($query, $request, $attributes, $cookies, $files, $server, $content);
  2036.     }
  2038.     /**
  2039.      * Indicates whether this request originated from a trusted proxy.
  2040.      *
  2041.      * This can be useful to determine whether or not to trust the
  2042.      * contents of a proxy-specific header.
  2043.      *
  2044.      * @return bool true if the request came from a trusted proxy, false otherwise
  2045.      */
  2046.     public function isFromTrustedProxy()
  2047.     {
  2048.         return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR', ''), self::$trustedProxies);
  2049.     }
  2051.     private function getTrustedValues(int $type, string $ip = null): array
  2052.     {
  2053.         $clientValues = [];
  2054.         $forwardedValues = [];
  2056.         if ((self::$trustedHeaderSet & $type) && $this->headers->has(self::TRUSTED_HEADERS[$type])) {
  2057.             foreach (explode(',', $this->headers->get(self::TRUSTED_HEADERS[$type])) as $v) {
  2058.                 $clientValues[] = (self::HEADER_X_FORWARDED_PORT === $type ? '0.0.0.0:' : '').trim($v);
  2059.             }
  2060.         }
  2062.         if ((self::$trustedHeaderSet & self::HEADER_FORWARDED) && (isset(self::FORWARDED_PARAMS[$type])) && $this->headers->has(self::TRUSTED_HEADERS[self::HEADER_FORWARDED])) {
  2063.             $forwarded = $this->headers->get(self::TRUSTED_HEADERS[self::HEADER_FORWARDED]);
  2064.             $parts = HeaderUtils::split($forwarded, ',;=');
  2065.             $forwardedValues = [];
  2066.             $param = self::FORWARDED_PARAMS[$type];
  2067.             foreach ($parts as $subParts) {
  2068.                 if (null === $v = HeaderUtils::combine($subParts)[$param] ?? null) {
  2069.                     continue;
  2070.                 }
  2071.                 if (self::HEADER_X_FORWARDED_PORT === $type) {
  2072.                     if (str_ends_with($v, ']') || false === $v = strrchr($v, ':')) {
  2073.                         $v = $this->isSecure() ? ':443' : ':80';
  2074.                     }
  2075.                     $v = '0.0.0.0'.$v;
  2076.                 }
  2077.                 $forwardedValues[] = $v;
  2078.             }
  2079.         }
  2081.         if (null !== $ip) {
  2082.             $clientValues = $this->normalizeAndFilterClientIps($clientValues, $ip);
  2083.             $forwardedValues = $this->normalizeAndFilterClientIps($forwardedValues, $ip);
  2084.         }
  2086.         if ($forwardedValues === $clientValues || !$clientValues) {
  2087.             return $forwardedValues;
  2088.         }
  2090.         if (!$forwardedValues) {
  2091.             return $clientValues;
  2092.         }
  2094.         if (!$this->isForwardedValid) {
  2095.             return null !== $ip ? ['0.0.0.0', $ip] : [];
  2096.         }
  2097.         $this->isForwardedValid = false;
  2099.         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]));
  2100.     }
  2102.     private function normalizeAndFilterClientIps(array $clientIps, string $ip): array
  2103.     {
  2104.         if (!$clientIps) {
  2105.             return [];
  2106.         }
  2107.         $clientIps[] = $ip; // Complete the IP chain with the IP the request actually came from
  2108.         $firstTrustedIp = null;
  2110.         foreach ($clientIps as $key => $clientIp) {
  2111.             if (strpos($clientIp, '.')) {
  2112.                 // Strip :port from IPv4 addresses. This is allowed in Forwarded
  2113.                 // and may occur in X-Forwarded-For.
  2114.                 $i = strpos($clientIp, ':');
  2115.                 if ($i) {
  2116.                     $clientIps[$key] = $clientIp = substr($clientIp, 0, $i);
  2117.                 }
  2118.             } elseif (str_starts_with($clientIp, '[')) {
  2119.                 // Strip brackets and :port from IPv6 addresses.
  2120.                 $i = strpos($clientIp, ']', 1);
  2121.                 $clientIps[$key] = $clientIp = substr($clientIp, 1, $i - 1);
  2122.             }
  2124.             if (!filter_var($clientIp, \FILTER_VALIDATE_IP)) {
  2125.                 unset($clientIps[$key]);
  2127.                 continue;
  2128.             }
  2130.             if (IpUtils::checkIp($clientIp, self::$trustedProxies)) {
  2131.                 unset($clientIps[$key]);
  2133.                 // Fallback to this when the client IP falls into the range of trusted proxies
  2134.                 if (null === $firstTrustedIp) {
  2135.                     $firstTrustedIp = $clientIp;
  2136.                 }
  2137.             }
  2138.         }
  2140.         // Now the IP chain contains only untrusted proxies and the client IP
  2141.         return $clientIps ? array_reverse($clientIps) : [$firstTrustedIp];
  2142.     }
  2143. }