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

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