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

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\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 <fabien@symfony.com>
  40.  */
  41. class Request
  42. {
  43.     const HEADER_FORWARDED = 0b000001; // When using RFC 7239
  44.     const HEADER_X_FORWARDED_FOR = 0b000010;
  45.     const HEADER_X_FORWARDED_HOST = 0b000100;
  46.     const HEADER_X_FORWARDED_PROTO = 0b001000;
  47.     const HEADER_X_FORWARDED_PORT = 0b010000;
  48.     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.     const HEADER_X_FORWARDED_ALL = 0b1011110; // All "X-Forwarded-*" headers sent by "usual" reverse proxy
  52.     const HEADER_X_FORWARDED_AWS_ELB = 0b0011010; // AWS ELB doesn't send X-Forwarded-Host
  53.     const HEADER_X_FORWARDED_TRAEFIK = 0b0111110; // All "X-Forwarded-*" headers sent by Traefik reverse proxy
  55.     const METHOD_HEAD = 'HEAD';
  56.     const METHOD_GET = 'GET';
  57.     const METHOD_POST = 'POST';
  58.     const METHOD_PUT = 'PUT';
  59.     const METHOD_PATCH = 'PATCH';
  60.     const METHOD_DELETE = 'DELETE';
  61.     const METHOD_PURGE = 'PURGE';
  62.     const METHOD_OPTIONS = 'OPTIONS';
  63.     const METHOD_TRACE = 'TRACE';
  64.     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 static $forwardedParams = [
  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 static $trustedHeaders = [
  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 (0 === strpos($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.         ], $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.             $qs = HeaderUtils::parseQuery(html_entity_decode($components['query']));
  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 ParameterBag($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.         try {
  520.             $content = $this->getContent();
  521.         } catch (\LogicException $e) {
  522.             if (\PHP_VERSION_ID >= 70400) {
  523.                 throw $e;
  524.             }
  526.             return trigger_error($e, \E_USER_ERROR);
  527.         }
  529.         $cookieHeader = '';
  530.         $cookies = [];
  532.         foreach ($this->cookies as $k => $v) {
  533.             $cookies[] = $k.'='.$v;
  534.         }
  536.         if (!empty($cookies)) {
  537.             $cookieHeader = 'Cookie: '.implode('; ', $cookies)."\r\n";
  538.         }
  540.         return
  541.             sprintf('%s %s %s', $this->getMethod(), $this->getRequestUri(), $this->server->get('SERVER_PROTOCOL'))."\r\n".
  542.             $this->headers.
  543.             $cookieHeader."\r\n".
  544.             $content;
  545.     }
  547.     /**
  548.      * Overrides the PHP global variables according to this request instance.
  549.      *
  550.      * It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE.
  551.      * $_FILES is never overridden, see rfc1867
  552.      */
  553.     public function overrideGlobals()
  554.     {
  555.         $this->server->set('QUERY_STRING', static::normalizeQueryString(http_build_query($this->query->all(), '', '&')));
  557.         $_GET = $this->query->all();
  558.         $_POST = $this->request->all();
  559.         $_SERVER = $this->server->all();
  560.         $_COOKIE = $this->cookies->all();
  562.         foreach ($this->headers->all() as $key => $value) {
  563.             $key = strtoupper(str_replace('-', '_', $key));
  564.             if (\in_array($key, ['CONTENT_TYPE', 'CONTENT_LENGTH', 'CONTENT_MD5'], true)) {
  565.                 $_SERVER[$key] = implode(', ', $value);
  566.             } else {
  567.                 $_SERVER['HTTP_'.$key] = implode(', ', $value);
  568.             }
  569.         }
  571.         $request = ['g' => $_GET, 'p' => $_POST, 'c' => $_COOKIE];
  573.         $requestOrder = ini_get('request_order') ?: ini_get('variables_order');
  574.         $requestOrder = preg_replace('#[^cgp]#', '', strtolower($requestOrder)) ?: 'gp';
  576.         $_REQUEST = [[]];
  578.         foreach (str_split($requestOrder) as $order) {
  579.             $_REQUEST[] = $request[$order];
  580.         }
  582.         $_REQUEST = array_merge(...$_REQUEST);
  583.     }
  585.     /**
  586.      * Sets a list of trusted proxies.
  587.      *
  588.      * You should only list the reverse proxies that you manage directly.
  589.      *
  590.      * @param array $proxies          A list of trusted proxies, the string 'REMOTE_ADDR' will be replaced with $_SERVER['REMOTE_ADDR']
  591.      * @param int   $trustedHeaderSet A bit field of Request::HEADER_*, to set which headers to trust from your proxies
  592.      *
  593.      * @throws \InvalidArgumentException When $trustedHeaderSet is invalid
  594.      */
  595.     public static function setTrustedProxies(array $proxies, int $trustedHeaderSet)
  596.     {
  597.         if (self::HEADER_X_FORWARDED_ALL === $trustedHeaderSet) {
  598.             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.');
  599.         }
  600.         self::$trustedProxies = array_reduce($proxies, function ($proxies, $proxy) {
  601.             if ('REMOTE_ADDR' !== $proxy) {
  602.                 $proxies[] = $proxy;
  603.             } elseif (isset($_SERVER['REMOTE_ADDR'])) {
  604.                 $proxies[] = $_SERVER['REMOTE_ADDR'];
  605.             }
  607.             return $proxies;
  608.         }, []);
  609.         self::$trustedHeaderSet = $trustedHeaderSet;
  610.     }
  612.     /**
  613.      * Gets the list of trusted proxies.
  614.      *
  615.      * @return array An array of trusted proxies
  616.      */
  617.     public static function getTrustedProxies()
  618.     {
  619.         return self::$trustedProxies;
  620.     }
  622.     /**
  623.      * Gets the set of trusted headers from trusted proxies.
  624.      *
  625.      * @return int A bit field of Request::HEADER_* that defines which headers are trusted from your proxies
  626.      */
  627.     public static function getTrustedHeaderSet()
  628.     {
  629.         return self::$trustedHeaderSet;
  630.     }
  632.     /**
  633.      * Sets a list of trusted host patterns.
  634.      *
  635.      * You should only list the hosts you manage using regexs.
  636.      *
  637.      * @param array $hostPatterns A list of trusted host patterns
  638.      */
  639.     public static function setTrustedHosts(array $hostPatterns)
  640.     {
  641.         self::$trustedHostPatterns = array_map(function ($hostPattern) {
  642.             return sprintf('{%s}i', $hostPattern);
  643.         }, $hostPatterns);
  644.         // we need to reset trusted hosts on trusted host patterns change
  645.         self::$trustedHosts = [];
  646.     }
  648.     /**
  649.      * Gets the list of trusted host patterns.
  650.      *
  651.      * @return array An array of trusted host patterns
  652.      */
  653.     public static function getTrustedHosts()
  654.     {
  655.         return self::$trustedHostPatterns;
  656.     }
  658.     /**
  659.      * Normalizes a query string.
  660.      *
  661.      * It builds a normalized query string, where keys/value pairs are alphabetized,
  662.      * have consistent escaping and unneeded delimiters are removed.
  663.      *
  664.      * @return string A normalized query string for the Request
  665.      */
  666.     public static function normalizeQueryString(?string $qs)
  667.     {
  668.         if ('' === ($qs ?? '')) {
  669.             return '';
  670.         }
  672.         $qs = HeaderUtils::parseQuery($qs);
  673.         ksort($qs);
  675.         return http_build_query($qs, '', '&', \PHP_QUERY_RFC3986);
  676.     }
  678.     /**
  679.      * Enables support for the _method request parameter to determine the intended HTTP method.
  680.      *
  681.      * Be warned that enabling this feature might lead to CSRF issues in your code.
  682.      * Check that you are using CSRF tokens when required.
  683.      * If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered
  684.      * and used to send a "PUT" or "DELETE" request via the _method request parameter.
  685.      * If these methods are not protected against CSRF, this presents a possible vulnerability.
  686.      *
  687.      * The HTTP method can only be overridden when the real HTTP method is POST.
  688.      */
  689.     public static function enableHttpMethodParameterOverride()
  690.     {
  691.         self::$httpMethodParameterOverride = true;
  692.     }
  694.     /**
  695.      * Checks whether support for the _method request parameter is enabled.
  696.      *
  697.      * @return bool True when the _method request parameter is enabled, false otherwise
  698.      */
  699.     public static function getHttpMethodParameterOverride()
  700.     {
  701.         return self::$httpMethodParameterOverride;
  702.     }
  704.     /**
  705.      * Gets a "parameter" value from any bag.
  706.      *
  707.      * This method is mainly useful for libraries that want to provide some flexibility. If you don't need the
  708.      * flexibility in controllers, it is better to explicitly get request parameters from the appropriate
  709.      * public property instead (attributes, query, request).
  710.      *
  711.      * Order of precedence: PATH (routing placeholders or custom attributes), GET, BODY
  712.      *
  713.      * @param mixed $default The default value if the parameter key does not exist
  714.      *
  715.      * @return mixed
  716.      */
  717.     public function get(string $key, $default = null)
  718.     {
  719.         if ($this !== $result = $this->attributes->get($key, $this)) {
  720.             return $result;
  721.         }
  723.         if ($this->query->has($key)) {
  724.             return $this->query->all()[$key];
  725.         }
  727.         if ($this->request->has($key)) {
  728.             return $this->request->all()[$key];
  729.         }
  731.         return $default;
  732.     }
  734.     /**
  735.      * Gets the Session.
  736.      *
  737.      * @return SessionInterface The session
  738.      */
  739.     public function getSession()
  740.     {
  741.         $session = $this->session;
  742.         if (!$session instanceof SessionInterface && null !== $session) {
  743.             $this->setSession($session = $session());
  744.         }
  746.         if (null === $session) {
  747.             throw new \BadMethodCallException('Session has not been set.');
  748.         }
  750.         return $session;
  751.     }
  753.     /**
  754.      * Whether the request contains a Session which was started in one of the
  755.      * previous requests.
  756.      *
  757.      * @return bool
  758.      */
  759.     public function hasPreviousSession()
  760.     {
  761.         // the check for $this->session avoids malicious users trying to fake a session cookie with proper name
  762.         return $this->hasSession() && $this->cookies->has($this->getSession()->getName());
  763.     }
  765.     /**
  766.      * Whether the request contains a Session object.
  767.      *
  768.      * This method does not give any information about the state of the session object,
  769.      * like whether the session is started or not. It is just a way to check if this Request
  770.      * is associated with a Session instance.
  771.      *
  772.      * @return bool true when the Request contains a Session object, false otherwise
  773.      */
  774.     public function hasSession()
  775.     {
  776.         return null !== $this->session;
  777.     }
  779.     public function setSession(SessionInterface $session)
  780.     {
  781.         $this->session = $session;
  782.     }
  784.     /**
  785.      * @internal
  786.      */
  787.     public function setSessionFactory(callable $factory)
  788.     {
  789.         $this->session = $factory;
  790.     }
  792.     /**
  793.      * Returns the client IP addresses.
  794.      *
  795.      * In the returned array the most trusted IP address is first, and the
  796.      * least trusted one last. The "real" client IP address is the last one,
  797.      * but this is also the least trusted one. Trusted proxies are stripped.
  798.      *
  799.      * Use this method carefully; you should use getClientIp() instead.
  800.      *
  801.      * @return array The client IP addresses
  802.      *
  803.      * @see getClientIp()
  804.      */
  805.     public function getClientIps()
  806.     {
  807.         $ip = $this->server->get('REMOTE_ADDR');
  809.         if (!$this->isFromTrustedProxy()) {
  810.             return [$ip];
  811.         }
  813.         return $this->getTrustedValues(self::HEADER_X_FORWARDED_FOR, $ip) ?: [$ip];
  814.     }
  816.     /**
  817.      * Returns the client IP address.
  818.      *
  819.      * This method can read the client IP address from the "X-Forwarded-For" header
  820.      * when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For"
  821.      * header value is a comma+space separated list of IP addresses, the left-most
  822.      * being the original client, and each successive proxy that passed the request
  823.      * adding the IP address where it received the request from.
  824.      *
  825.      * If your reverse proxy uses a different header name than "X-Forwarded-For",
  826.      * ("Client-Ip" for instance), configure it via the $trustedHeaderSet
  827.      * argument of the Request::setTrustedProxies() method instead.
  828.      *
  829.      * @return string|null The client IP address
  830.      *
  831.      * @see getClientIps()
  832.      * @see https://wikipedia.org/wiki/X-Forwarded-For
  833.      */
  834.     public function getClientIp()
  835.     {
  836.         $ipAddresses = $this->getClientIps();
  838.         return $ipAddresses[0];
  839.     }
  841.     /**
  842.      * Returns current script name.
  843.      *
  844.      * @return string
  845.      */
  846.     public function getScriptName()
  847.     {
  848.         return $this->server->get('SCRIPT_NAME', $this->server->get('ORIG_SCRIPT_NAME', ''));
  849.     }
  851.     /**
  852.      * Returns the path being requested relative to the executed script.
  853.      *
  854.      * The path info always starts with a /.
  855.      *
  856.      * Suppose this request is instantiated from /mysite on localhost:
  857.      *
  858.      *  * http://localhost/mysite              returns an empty string
  859.      *  * http://localhost/mysite/about        returns '/about'
  860.      *  * http://localhost/mysite/enco%20ded   returns '/enco%20ded'
  861.      *  * http://localhost/mysite/about?var=1  returns '/about'
  862.      *
  863.      * @return string The raw path (i.e. not urldecoded)
  864.      */
  865.     public function getPathInfo()
  866.     {
  867.         if (null === $this->pathInfo) {
  868.             $this->pathInfo = $this->preparePathInfo();
  869.         }
  871.         return $this->pathInfo;
  872.     }
  874.     /**
  875.      * Returns the root path from which this request is executed.
  876.      *
  877.      * Suppose that an index.php file instantiates this request object:
  878.      *
  879.      *  * http://localhost/index.php         returns an empty string
  880.      *  * http://localhost/index.php/page    returns an empty string
  881.      *  * http://localhost/web/index.php     returns '/web'
  882.      *  * http://localhost/we%20b/index.php  returns '/we%20b'
  883.      *
  884.      * @return string The raw path (i.e. not urldecoded)
  885.      */
  886.     public function getBasePath()
  887.     {
  888.         if (null === $this->basePath) {
  889.             $this->basePath = $this->prepareBasePath();
  890.         }
  892.         return $this->basePath;
  893.     }
  895.     /**
  896.      * Returns the root URL from which this request is executed.
  897.      *
  898.      * The base URL never ends with a /.
  899.      *
  900.      * This is similar to getBasePath(), except that it also includes the
  901.      * script filename (e.g. index.php) if one exists.
  902.      *
  903.      * @return string The raw URL (i.e. not urldecoded)
  904.      */
  905.     public function getBaseUrl()
  906.     {
  907.         $trustedPrefix = '';
  909.         // the proxy prefix must be prepended to any prefix being needed at the webserver level
  910.         if ($this->isFromTrustedProxy() && $trustedPrefixValues = $this->getTrustedValues(self::HEADER_X_FORWARDED_PREFIX)) {
  911.             $trustedPrefix = rtrim($trustedPrefixValues[0], '/');
  912.         }
  914.         return $trustedPrefix.$this->getBaseUrlReal();
  915.     }
  917.     /**
  918.      * Returns the real base URL received by the webserver from which this request is executed.
  919.      * The URL does not include trusted reverse proxy prefix.
  920.      *
  921.      * @return string The raw URL (i.e. not urldecoded)
  922.      */
  923.     private function getBaseUrlReal()
  924.     {
  925.         if (null === $this->baseUrl) {
  926.             $this->baseUrl = $this->prepareBaseUrl();
  927.         }
  929.         return $this->baseUrl;
  930.     }
  932.     /**
  933.      * Gets the request's scheme.
  934.      *
  935.      * @return string
  936.      */
  937.     public function getScheme()
  938.     {
  939.         return $this->isSecure() ? 'https' : 'http';
  940.     }
  942.     /**
  943.      * Returns the port on which the request is made.
  944.      *
  945.      * This method can read the client port from the "X-Forwarded-Port" header
  946.      * when trusted proxies were set via "setTrustedProxies()".
  947.      *
  948.      * The "X-Forwarded-Port" header must contain the client port.
  949.      *
  950.      * @return int|string can be a string if fetched from the server bag
  951.      */
  952.     public function getPort()
  953.     {
  954.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_PORT)) {
  955.             $host = $host[0];
  956.         } elseif ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  957.             $host = $host[0];
  958.         } elseif (!$host = $this->headers->get('HOST')) {
  959.             return $this->server->get('SERVER_PORT');
  960.         }
  962.         if ('[' === $host[0]) {
  963.             $pos = strpos($host, ':', strrpos($host, ']'));
  964.         } else {
  965.             $pos = strrpos($host, ':');
  966.         }
  968.         if (false !== $pos && $port = substr($host, $pos + 1)) {
  969.             return (int) $port;
  970.         }
  972.         return 'https' === $this->getScheme() ? 443 : 80;
  973.     }
  975.     /**
  976.      * Returns the user.
  977.      *
  978.      * @return string|null
  979.      */
  980.     public function getUser()
  981.     {
  982.         return $this->headers->get('PHP_AUTH_USER');
  983.     }
  985.     /**
  986.      * Returns the password.
  987.      *
  988.      * @return string|null
  989.      */
  990.     public function getPassword()
  991.     {
  992.         return $this->headers->get('PHP_AUTH_PW');
  993.     }
  995.     /**
  996.      * Gets the user info.
  997.      *
  998.      * @return string A user name and, optionally, scheme-specific information about how to gain authorization to access the server
  999.      */
  1000.     public function getUserInfo()
  1001.     {
  1002.         $userinfo = $this->getUser();
  1004.         $pass = $this->getPassword();
  1005.         if ('' != $pass) {
  1006.             $userinfo .= ":$pass";
  1007.         }
  1009.         return $userinfo;
  1010.     }
  1012.     /**
  1013.      * Returns the HTTP host being requested.
  1014.      *
  1015.      * The port name will be appended to the host if it's non-standard.
  1016.      *
  1017.      * @return string
  1018.      */
  1019.     public function getHttpHost()
  1020.     {
  1021.         $scheme = $this->getScheme();
  1022.         $port = $this->getPort();
  1024.         if (('http' == $scheme && 80 == $port) || ('https' == $scheme && 443 == $port)) {
  1025.             return $this->getHost();
  1026.         }
  1028.         return $this->getHost().':'.$port;
  1029.     }
  1031.     /**
  1032.      * Returns the requested URI (path and query string).
  1033.      *
  1034.      * @return string The raw URI (i.e. not URI decoded)
  1035.      */
  1036.     public function getRequestUri()
  1037.     {
  1038.         if (null === $this->requestUri) {
  1039.             $this->requestUri = $this->prepareRequestUri();
  1040.         }
  1042.         return $this->requestUri;
  1043.     }
  1045.     /**
  1046.      * Gets the scheme and HTTP host.
  1047.      *
  1048.      * If the URL was called with basic authentication, the user
  1049.      * and the password are not added to the generated string.
  1050.      *
  1051.      * @return string The scheme and HTTP host
  1052.      */
  1053.     public function getSchemeAndHttpHost()
  1054.     {
  1055.         return $this->getScheme().'://'.$this->getHttpHost();
  1056.     }
  1058.     /**
  1059.      * Generates a normalized URI (URL) for the Request.
  1060.      *
  1061.      * @return string A normalized URI (URL) for the Request
  1062.      *
  1063.      * @see getQueryString()
  1064.      */
  1065.     public function getUri()
  1066.     {
  1067.         if (null !== $qs = $this->getQueryString()) {
  1068.             $qs = '?'.$qs;
  1069.         }
  1071.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$this->getPathInfo().$qs;
  1072.     }
  1074.     /**
  1075.      * Generates a normalized URI for the given path.
  1076.      *
  1077.      * @param string $path A path to use instead of the current one
  1078.      *
  1079.      * @return string The normalized URI for the path
  1080.      */
  1081.     public function getUriForPath(string $path)
  1082.     {
  1083.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$path;
  1084.     }
  1086.     /**
  1087.      * Returns the path as relative reference from the current Request path.
  1088.      *
  1089.      * Only the URIs path component (no schema, host etc.) is relevant and must be given.
  1090.      * Both paths must be absolute and not contain relative parts.
  1091.      * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
  1092.      * Furthermore, they can be used to reduce the link size in documents.
  1093.      *
  1094.      * Example target paths, given a base path of "/a/b/c/d":
  1095.      * - "/a/b/c/d"     -> ""
  1096.      * - "/a/b/c/"      -> "./"
  1097.      * - "/a/b/"        -> "../"
  1098.      * - "/a/b/c/other" -> "other"
  1099.      * - "/a/x/y"       -> "../../x/y"
  1100.      *
  1101.      * @return string The relative target path
  1102.      */
  1103.     public function getRelativeUriForPath(string $path)
  1104.     {
  1105.         // be sure that we are dealing with an absolute path
  1106.         if (!isset($path[0]) || '/' !== $path[0]) {
  1107.             return $path;
  1108.         }
  1110.         if ($path === $basePath = $this->getPathInfo()) {
  1111.             return '';
  1112.         }
  1114.         $sourceDirs = explode('/', isset($basePath[0]) && '/' === $basePath[0] ? substr($basePath, 1) : $basePath);
  1115.         $targetDirs = explode('/', substr($path, 1));
  1116.         array_pop($sourceDirs);
  1117.         $targetFile = array_pop($targetDirs);
  1119.         foreach ($sourceDirs as $i => $dir) {
  1120.             if (isset($targetDirs[$i]) && $dir === $targetDirs[$i]) {
  1121.                 unset($sourceDirs[$i], $targetDirs[$i]);
  1122.             } else {
  1123.                 break;
  1124.             }
  1125.         }
  1127.         $targetDirs[] = $targetFile;
  1128.         $path = str_repeat('../', \count($sourceDirs)).implode('/', $targetDirs);
  1130.         // A reference to the same base directory or an empty subdirectory must be prefixed with "./".
  1131.         // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used
  1132.         // as the first segment of a relative-path reference, as it would be mistaken for a scheme name
  1133.         // (see https://tools.ietf.org/html/rfc3986#section-4.2).
  1134.         return !isset($path[0]) || '/' === $path[0]
  1135.             || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)
  1136.             ? "./$path" : $path;
  1137.     }
  1139.     /**
  1140.      * Generates the normalized query string for the Request.
  1141.      *
  1142.      * It builds a normalized query string, where keys/value pairs are alphabetized
  1143.      * and have consistent escaping.
  1144.      *
  1145.      * @return string|null A normalized query string for the Request
  1146.      */
  1147.     public function getQueryString()
  1148.     {
  1149.         $qs = static::normalizeQueryString($this->server->get('QUERY_STRING'));
  1151.         return '' === $qs ? null : $qs;
  1152.     }
  1154.     /**
  1155.      * Checks whether the request is secure or not.
  1156.      *
  1157.      * This method can read the client protocol from the "X-Forwarded-Proto" header
  1158.      * when trusted proxies were set via "setTrustedProxies()".
  1159.      *
  1160.      * The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".
  1161.      *
  1162.      * @return bool
  1163.      */
  1164.     public function isSecure()
  1165.     {
  1166.         if ($this->isFromTrustedProxy() && $proto = $this->getTrustedValues(self::HEADER_X_FORWARDED_PROTO)) {
  1167.             return \in_array(strtolower($proto[0]), ['https', 'on', 'ssl', '1'], true);
  1168.         }
  1170.         $https = $this->server->get('HTTPS');
  1172.         return !empty($https) && 'off' !== strtolower($https);
  1173.     }
  1175.     /**
  1176.      * Returns the host name.
  1177.      *
  1178.      * This method can read the client host name from the "X-Forwarded-Host" header
  1179.      * when trusted proxies were set via "setTrustedProxies()".
  1180.      *
  1181.      * The "X-Forwarded-Host" header must contain the client host name.
  1182.      *
  1183.      * @return string
  1184.      *
  1185.      * @throws SuspiciousOperationException when the host name is invalid or not trusted
  1186.      */
  1187.     public function getHost()
  1188.     {
  1189.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  1190.             $host = $host[0];
  1191.         } elseif (!$host = $this->headers->get('HOST')) {
  1192.             if (!$host = $this->server->get('SERVER_NAME')) {
  1193.                 $host = $this->server->get('SERVER_ADDR', '');
  1194.             }
  1195.         }
  1197.         // trim and remove port number from host
  1198.         // host is lowercase as per RFC 952/2181
  1199.         $host = strtolower(preg_replace('/:\d+$/', '', trim($host)));
  1201.         // as the host can come from the user (HTTP_HOST and depending on the configuration, SERVER_NAME too can come from the user)
  1202.         // check that it does not contain forbidden characters (see RFC 952 and RFC 2181)
  1203.         // use preg_replace() instead of preg_match() to prevent DoS attacks with long host names
  1204.         if ($host && '' !== preg_replace('/(?:^\[)?[a-zA-Z0-9-:\]_]+\.?/', '', $host)) {
  1205.             if (!$this->isHostValid) {
  1206.                 return '';
  1207.             }
  1208.             $this->isHostValid = false;
  1210.             throw new SuspiciousOperationException(sprintf('Invalid Host "%s".', $host));
  1211.         }
  1213.         if (\count(self::$trustedHostPatterns) > 0) {
  1214.             // to avoid host header injection attacks, you should provide a list of trusted host patterns
  1216.             if (\in_array($host, self::$trustedHosts)) {
  1217.                 return $host;
  1218.             }
  1220.             foreach (self::$trustedHostPatterns as $pattern) {
  1221.                 if (preg_match($pattern, $host)) {
  1222.                     self::$trustedHosts[] = $host;
  1224.                     return $host;
  1225.                 }
  1226.             }
  1228.             if (!$this->isHostValid) {
  1229.                 return '';
  1230.             }
  1231.             $this->isHostValid = false;
  1233.             throw new SuspiciousOperationException(sprintf('Untrusted Host "%s".', $host));
  1234.         }
  1236.         return $host;
  1237.     }
  1239.     /**
  1240.      * Sets the request method.
  1241.      */
  1242.     public function setMethod(string $method)
  1243.     {
  1244.         $this->method = null;
  1245.         $this->server->set('REQUEST_METHOD', $method);
  1246.     }
  1248.     /**
  1249.      * Gets the request "intended" method.
  1250.      *
  1251.      * If the X-HTTP-Method-Override header is set, and if the method is a POST,
  1252.      * then it is used to determine the "real" intended HTTP method.
  1253.      *
  1254.      * The _method request parameter can also be used to determine the HTTP method,
  1255.      * but only if enableHttpMethodParameterOverride() has been called.
  1256.      *
  1257.      * The method is always an uppercased string.
  1258.      *
  1259.      * @return string The request method
  1260.      *
  1261.      * @see getRealMethod()
  1262.      */
  1263.     public function getMethod()
  1264.     {
  1265.         if (null !== $this->method) {
  1266.             return $this->method;
  1267.         }
  1269.         $this->method = strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1271.         if ('POST' !== $this->method) {
  1272.             return $this->method;
  1273.         }
  1275.         $method = $this->headers->get('X-HTTP-METHOD-OVERRIDE');
  1277.         if (!$method && self::$httpMethodParameterOverride) {
  1278.             $method = $this->request->get('_method', $this->query->get('_method', 'POST'));
  1279.         }
  1281.         if (!\is_string($method)) {
  1282.             return $this->method;
  1283.         }
  1285.         $method = strtoupper($method);
  1287.         if (\in_array($method, ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'PATCH', 'PURGE', 'TRACE'], true)) {
  1288.             return $this->method = $method;
  1289.         }
  1291.         if (!preg_match('/^[A-Z]++$/D', $method)) {
  1292.             throw new SuspiciousOperationException(sprintf('Invalid method override "%s".', $method));
  1293.         }
  1295.         return $this->method = $method;
  1296.     }
  1298.     /**
  1299.      * Gets the "real" request method.
  1300.      *
  1301.      * @return string The request method
  1302.      *
  1303.      * @see getMethod()
  1304.      */
  1305.     public function getRealMethod()
  1306.     {
  1307.         return strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1308.     }
  1310.     /**
  1311.      * Gets the mime type associated with the format.
  1312.      *
  1313.      * @return string|null The associated mime type (null if not found)
  1314.      */
  1315.     public function getMimeType(string $format)
  1316.     {
  1317.         if (null === static::$formats) {
  1318.             static::initializeFormats();
  1319.         }
  1321.         return isset(static::$formats[$format]) ? static::$formats[$format][0] : null;
  1322.     }
  1324.     /**
  1325.      * Gets the mime types associated with the format.
  1326.      *
  1327.      * @return array The associated mime types
  1328.      */
  1329.     public static function getMimeTypes(string $format)
  1330.     {
  1331.         if (null === static::$formats) {
  1332.             static::initializeFormats();
  1333.         }
  1335.         return isset(static::$formats[$format]) ? static::$formats[$format] : [];
  1336.     }
  1338.     /**
  1339.      * Gets the format associated with the mime type.
  1340.      *
  1341.      * @return string|null The format (null if not found)
  1342.      */
  1343.     public function getFormat(?string $mimeType)
  1344.     {
  1345.         $canonicalMimeType = null;
  1346.         if (false !== $pos = strpos($mimeType, ';')) {
  1347.             $canonicalMimeType = trim(substr($mimeType, 0, $pos));
  1348.         }
  1350.         if (null === static::$formats) {
  1351.             static::initializeFormats();
  1352.         }
  1354.         foreach (static::$formats as $format => $mimeTypes) {
  1355.             if (\in_array($mimeType, (array) $mimeTypes)) {
  1356.                 return $format;
  1357.             }
  1358.             if (null !== $canonicalMimeType && \in_array($canonicalMimeType, (array) $mimeTypes)) {
  1359.                 return $format;
  1360.             }
  1361.         }
  1363.         return null;
  1364.     }
  1366.     /**
  1367.      * Associates a format with mime types.
  1368.      *
  1369.      * @param string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
  1370.      */
  1371.     public function setFormat(?string $format, $mimeTypes)
  1372.     {
  1373.         if (null === static::$formats) {
  1374.             static::initializeFormats();
  1375.         }
  1377.         static::$formats[$format] = \is_array($mimeTypes) ? $mimeTypes : [$mimeTypes];
  1378.     }
  1380.     /**
  1381.      * Gets the request format.
  1382.      *
  1383.      * Here is the process to determine the format:
  1384.      *
  1385.      *  * format defined by the user (with setRequestFormat())
  1386.      *  * _format request attribute
  1387.      *  * $default
  1388.      *
  1389.      * @see getPreferredFormat
  1390.      *
  1391.      * @return string|null The request format
  1392.      */
  1393.     public function getRequestFormat(?string $default = 'html')
  1394.     {
  1395.         if (null === $this->format) {
  1396.             $this->format = $this->attributes->get('_format');
  1397.         }
  1399.         return null === $this->format ? $default : $this->format;
  1400.     }
  1402.     /**
  1403.      * Sets the request format.
  1404.      */
  1405.     public function setRequestFormat(?string $format)
  1406.     {
  1407.         $this->format = $format;
  1408.     }
  1410.     /**
  1411.      * Gets the format associated with the request.
  1412.      *
  1413.      * @return string|null The format (null if no content type is present)
  1414.      */
  1415.     public function getContentType()
  1416.     {
  1417.         return $this->getFormat($this->headers->get('CONTENT_TYPE'));
  1418.     }
  1420.     /**
  1421.      * Sets the default locale.
  1422.      */
  1423.     public function setDefaultLocale(string $locale)
  1424.     {
  1425.         $this->defaultLocale = $locale;
  1427.         if (null === $this->locale) {
  1428.             $this->setPhpDefaultLocale($locale);
  1429.         }
  1430.     }
  1432.     /**
  1433.      * Get the default locale.
  1434.      *
  1435.      * @return string
  1436.      */
  1437.     public function getDefaultLocale()
  1438.     {
  1439.         return $this->defaultLocale;
  1440.     }
  1442.     /**
  1443.      * Sets the locale.
  1444.      */
  1445.     public function setLocale(string $locale)
  1446.     {
  1447.         $this->setPhpDefaultLocale($this->locale = $locale);
  1448.     }
  1450.     /**
  1451.      * Get the locale.
  1452.      *
  1453.      * @return string
  1454.      */
  1455.     public function getLocale()
  1456.     {
  1457.         return null === $this->locale ? $this->defaultLocale : $this->locale;
  1458.     }
  1460.     /**
  1461.      * Checks if the request method is of specified type.
  1462.      *
  1463.      * @param string $method Uppercase request method (GET, POST etc)
  1464.      *
  1465.      * @return bool
  1466.      */
  1467.     public function isMethod(string $method)
  1468.     {
  1469.         return $this->getMethod() === strtoupper($method);
  1470.     }
  1472.     /**
  1473.      * Checks whether or not the method is safe.
  1474.      *
  1475.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
  1476.      *
  1477.      * @return bool
  1478.      */
  1479.     public function isMethodSafe()
  1480.     {
  1481.         return \in_array($this->getMethod(), ['GET', 'HEAD', 'OPTIONS', 'TRACE']);
  1482.     }
  1484.     /**
  1485.      * Checks whether or not the method is idempotent.
  1486.      *
  1487.      * @return bool
  1488.      */
  1489.     public function isMethodIdempotent()
  1490.     {
  1491.         return \in_array($this->getMethod(), ['HEAD', 'GET', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'PURGE']);
  1492.     }
  1494.     /**
  1495.      * Checks whether the method is cacheable or not.
  1496.      *
  1497.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
  1498.      *
  1499.      * @return bool True for GET and HEAD, false otherwise
  1500.      */
  1501.     public function isMethodCacheable()
  1502.     {
  1503.         return \in_array($this->getMethod(), ['GET', 'HEAD']);
  1504.     }
  1506.     /**
  1507.      * Returns the protocol version.
  1508.      *
  1509.      * If the application is behind a proxy, the protocol version used in the
  1510.      * requests between the client and the proxy and between the proxy and the
  1511.      * server might be different. This returns the former (from the "Via" header)
  1512.      * if the proxy is trusted (see "setTrustedProxies()"), otherwise it returns
  1513.      * the latter (from the "SERVER_PROTOCOL" server parameter).
  1514.      *
  1515.      * @return string
  1516.      */
  1517.     public function getProtocolVersion()
  1518.     {
  1519.         if ($this->isFromTrustedProxy()) {
  1520.             preg_match('~^(HTTP/)?([1-9]\.[0-9]) ~', $this->headers->get('Via'), $matches);
  1522.             if ($matches) {
  1523.                 return 'HTTP/'.$matches[2];
  1524.             }
  1525.         }
  1527.         return $this->server->get('SERVER_PROTOCOL');
  1528.     }
  1530.     /**
  1531.      * Returns the request body content.
  1532.      *
  1533.      * @param bool $asResource If true, a resource will be returned
  1534.      *
  1535.      * @return string|resource The request body content or a resource to read the body stream
  1536.      *
  1537.      * @throws \LogicException
  1538.      */
  1539.     public function getContent(bool $asResource = false)
  1540.     {
  1541.         $currentContentIsResource = \is_resource($this->content);
  1543.         if (true === $asResource) {
  1544.             if ($currentContentIsResource) {
  1545.                 rewind($this->content);
  1547.                 return $this->content;
  1548.             }
  1550.             // Content passed in parameter (test)
  1551.             if (\is_string($this->content)) {
  1552.                 $resource = fopen('php://temp', 'r+');
  1553.                 fwrite($resource, $this->content);
  1554.                 rewind($resource);
  1556.                 return $resource;
  1557.             }
  1559.             $this->content = false;
  1561.             return fopen('php://input', 'rb');
  1562.         }
  1564.         if ($currentContentIsResource) {
  1565.             rewind($this->content);
  1567.             return stream_get_contents($this->content);
  1568.         }
  1570.         if (null === $this->content || false === $this->content) {
  1571.             $this->content = file_get_contents('php://input');
  1572.         }
  1574.         return $this->content;
  1575.     }
  1577.     /**
  1578.      * Gets the request body decoded as array, typically from a JSON payload.
  1579.      *
  1580.      * @throws JsonException When the body cannot be decoded to an array
  1581.      *
  1582.      * @return array
  1583.      */
  1584.     public function toArray()
  1585.     {
  1586.         if ('' === $content = $this->getContent()) {
  1587.             throw new JsonException('Response body is empty.');
  1588.         }
  1590.         try {
  1591.             $content = json_decode($content, true, 512, \JSON_BIGINT_AS_STRING | (\PHP_VERSION_ID >= 70300 ? \JSON_THROW_ON_ERROR : 0));
  1592.         } catch (\JsonException $e) {
  1593.             throw new JsonException('Could not decode request body.', $e->getCode(), $e);
  1594.         }
  1596.         if (\PHP_VERSION_ID < 70300 && \JSON_ERROR_NONE !== json_last_error()) {
  1597.             throw new JsonException('Could not decode request body: '.json_last_error_msg(), json_last_error());
  1598.         }
  1600.         if (!\is_array($content)) {
  1601.             throw new JsonException(sprintf('JSON content was expected to decode to an array, "%s" returned.', get_debug_type($content)));
  1602.         }
  1604.         return $content;
  1605.     }
  1607.     /**
  1608.      * Gets the Etags.
  1609.      *
  1610.      * @return array The entity tags
  1611.      */
  1612.     public function getETags()
  1613.     {
  1614.         return preg_split('/\s*,\s*/', $this->headers->get('if_none_match'), null, \PREG_SPLIT_NO_EMPTY);
  1615.     }
  1617.     /**
  1618.      * @return bool
  1619.      */
  1620.     public function isNoCache()
  1621.     {
  1622.         return $this->headers->hasCacheControlDirective('no-cache') || 'no-cache' == $this->headers->get('Pragma');
  1623.     }
  1625.     /**
  1626.      * Gets the preferred format for the response by inspecting, in the following order:
  1627.      *   * the request format set using setRequestFormat;
  1628.      *   * the values of the Accept HTTP header.
  1629.      *
  1630.      * Note that if you use this method, you should send the "Vary: Accept" header
  1631.      * in the response to prevent any issues with intermediary HTTP caches.
  1632.      */
  1633.     public function getPreferredFormat(?string $default = 'html'): ?string
  1634.     {
  1635.         if (null !== $this->preferredFormat || null !== $this->preferredFormat = $this->getRequestFormat(null)) {
  1636.             return $this->preferredFormat;
  1637.         }
  1639.         foreach ($this->getAcceptableContentTypes() as $mimeType) {
  1640.             if ($this->preferredFormat = $this->getFormat($mimeType)) {
  1641.                 return $this->preferredFormat;
  1642.             }
  1643.         }
  1645.         return $default;
  1646.     }
  1648.     /**
  1649.      * Returns the preferred language.
  1650.      *
  1651.      * @param string[] $locales An array of ordered available locales
  1652.      *
  1653.      * @return string|null The preferred locale
  1654.      */
  1655.     public function getPreferredLanguage(array $locales = null)
  1656.     {
  1657.         $preferredLanguages = $this->getLanguages();
  1659.         if (empty($locales)) {
  1660.             return isset($preferredLanguages[0]) ? $preferredLanguages[0] : null;
  1661.         }
  1663.         if (!$preferredLanguages) {
  1664.             return $locales[0];
  1665.         }
  1667.         $extendedPreferredLanguages = [];
  1668.         foreach ($preferredLanguages as $language) {
  1669.             $extendedPreferredLanguages[] = $language;
  1670.             if (false !== $position = strpos($language, '_')) {
  1671.                 $superLanguage = substr($language, 0, $position);
  1672.                 if (!\in_array($superLanguage, $preferredLanguages)) {
  1673.                     $extendedPreferredLanguages[] = $superLanguage;
  1674.                 }
  1675.             }
  1676.         }
  1678.         $preferredLanguages = array_values(array_intersect($extendedPreferredLanguages, $locales));
  1680.         return isset($preferredLanguages[0]) ? $preferredLanguages[0] : $locales[0];
  1681.     }
  1683.     /**
  1684.      * Gets a list of languages acceptable by the client browser.
  1685.      *
  1686.      * @return array Languages ordered in the user browser preferences
  1687.      */
  1688.     public function getLanguages()
  1689.     {
  1690.         if (null !== $this->languages) {
  1691.             return $this->languages;
  1692.         }
  1694.         $languages = AcceptHeader::fromString($this->headers->get('Accept-Language'))->all();
  1695.         $this->languages = [];
  1696.         foreach ($languages as $lang => $acceptHeaderItem) {
  1697.             if (false !== strpos($lang, '-')) {
  1698.                 $codes = explode('-', $lang);
  1699.                 if ('i' === $codes[0]) {
  1700.                     // Language not listed in ISO 639 that are not variants
  1701.                     // of any listed language, which can be registered with the
  1702.                     // i-prefix, such as i-cherokee
  1703.                     if (\count($codes) > 1) {
  1704.                         $lang = $codes[1];
  1705.                     }
  1706.                 } else {
  1707.                     for ($i = 0, $max = \count($codes); $i < $max; ++$i) {
  1708.                         if (0 === $i) {
  1709.                             $lang = strtolower($codes[0]);
  1710.                         } else {
  1711.                             $lang .= '_'.strtoupper($codes[$i]);
  1712.                         }
  1713.                     }
  1714.                 }
  1715.             }
  1717.             $this->languages[] = $lang;
  1718.         }
  1720.         return $this->languages;
  1721.     }
  1723.     /**
  1724.      * Gets a list of charsets acceptable by the client browser.
  1725.      *
  1726.      * @return array List of charsets in preferable order
  1727.      */
  1728.     public function getCharsets()
  1729.     {
  1730.         if (null !== $this->charsets) {
  1731.             return $this->charsets;
  1732.         }
  1734.         return $this->charsets = array_keys(AcceptHeader::fromString($this->headers->get('Accept-Charset'))->all());
  1735.     }
  1737.     /**
  1738.      * Gets a list of encodings acceptable by the client browser.
  1739.      *
  1740.      * @return array List of encodings in preferable order
  1741.      */
  1742.     public function getEncodings()
  1743.     {
  1744.         if (null !== $this->encodings) {
  1745.             return $this->encodings;
  1746.         }
  1748.         return $this->encodings = array_keys(AcceptHeader::fromString($this->headers->get('Accept-Encoding'))->all());
  1749.     }
  1751.     /**
  1752.      * Gets a list of content types acceptable by the client browser.
  1753.      *
  1754.      * @return array List of content types in preferable order
  1755.      */
  1756.     public function getAcceptableContentTypes()
  1757.     {
  1758.         if (null !== $this->acceptableContentTypes) {
  1759.             return $this->acceptableContentTypes;
  1760.         }
  1762.         return $this->acceptableContentTypes = array_keys(AcceptHeader::fromString($this->headers->get('Accept'))->all());
  1763.     }
  1765.     /**
  1766.      * Returns true if the request is a XMLHttpRequest.
  1767.      *
  1768.      * It works if your JavaScript library sets an X-Requested-With HTTP header.
  1769.      * It is known to work with common JavaScript frameworks:
  1770.      *
  1771.      * @see https://wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
  1772.      *
  1773.      * @return bool true if the request is an XMLHttpRequest, false otherwise
  1774.      */
  1775.     public function isXmlHttpRequest()
  1776.     {
  1777.         return 'XMLHttpRequest' == $this->headers->get('X-Requested-With');
  1778.     }
  1780.     /**
  1781.      * Checks whether the client browser prefers safe content or not according to RFC8674.
  1782.      *
  1783.      * @see https://tools.ietf.org/html/rfc8674
  1784.      */
  1785.     public function preferSafeContent(): bool
  1786.     {
  1787.         if (null !== $this->isSafeContentPreferred) {
  1788.             return $this->isSafeContentPreferred;
  1789.         }
  1791.         if (!$this->isSecure()) {
  1792.             // see https://tools.ietf.org/html/rfc8674#section-3
  1793.             $this->isSafeContentPreferred = false;
  1795.             return $this->isSafeContentPreferred;
  1796.         }
  1798.         $this->isSafeContentPreferred = AcceptHeader::fromString($this->headers->get('Prefer'))->has('safe');
  1800.         return $this->isSafeContentPreferred;
  1801.     }
  1803.     /*
  1804.      * The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)
  1805.      *
  1806.      * Code subject to the new BSD license (https://framework.zend.com/license).
  1807.      *
  1808.      * Copyright (c) 2005-2010 Zend Technologies USA Inc. (https://www.zend.com/)
  1809.      */
  1811.     protected function prepareRequestUri()
  1812.     {
  1813.         $requestUri = '';
  1815.         if ('1' == $this->server->get('IIS_WasUrlRewritten') && '' != $this->server->get('UNENCODED_URL')) {
  1816.             // IIS7 with URL Rewrite: make sure we get the unencoded URL (double slash problem)
  1817.             $requestUri = $this->server->get('UNENCODED_URL');
  1818.             $this->server->remove('UNENCODED_URL');
  1819.             $this->server->remove('IIS_WasUrlRewritten');
  1820.         } elseif ($this->server->has('REQUEST_URI')) {
  1821.             $requestUri = $this->server->get('REQUEST_URI');
  1823.             if ('' !== $requestUri && '/' === $requestUri[0]) {
  1824.                 // To only use path and query remove the fragment.
  1825.                 if (false !== $pos = strpos($requestUri, '#')) {
  1826.                     $requestUri = substr($requestUri, 0, $pos);
  1827.                 }
  1828.             } else {
  1829.                 // HTTP proxy reqs setup request URI with scheme and host [and port] + the URL path,
  1830.                 // only use URL path.
  1831.                 $uriComponents = parse_url($requestUri);
  1833.                 if (isset($uriComponents['path'])) {
  1834.                     $requestUri = $uriComponents['path'];
  1835.                 }
  1837.                 if (isset($uriComponents['query'])) {
  1838.                     $requestUri .= '?'.$uriComponents['query'];
  1839.                 }
  1840.             }
  1841.         } elseif ($this->server->has('ORIG_PATH_INFO')) {
  1842.             // IIS 5.0, PHP as CGI
  1843.             $requestUri = $this->server->get('ORIG_PATH_INFO');
  1844.             if ('' != $this->server->get('QUERY_STRING')) {
  1845.                 $requestUri .= '?'.$this->server->get('QUERY_STRING');
  1846.             }
  1847.             $this->server->remove('ORIG_PATH_INFO');
  1848.         }
  1850.         // normalize the request URI to ease creating sub-requests from this request
  1851.         $this->server->set('REQUEST_URI', $requestUri);
  1853.         return $requestUri;
  1854.     }
  1856.     /**
  1857.      * Prepares the base URL.
  1858.      *
  1859.      * @return string
  1860.      */
  1861.     protected function prepareBaseUrl()
  1862.     {
  1863.         $filename = basename($this->server->get('SCRIPT_FILENAME'));
  1865.         if (basename($this->server->get('SCRIPT_NAME')) === $filename) {
  1866.             $baseUrl = $this->server->get('SCRIPT_NAME');
  1867.         } elseif (basename($this->server->get('PHP_SELF')) === $filename) {
  1868.             $baseUrl = $this->server->get('PHP_SELF');
  1869.         } elseif (basename($this->server->get('ORIG_SCRIPT_NAME')) === $filename) {
  1870.             $baseUrl = $this->server->get('ORIG_SCRIPT_NAME'); // 1and1 shared hosting compatibility
  1871.         } else {
  1872.             // Backtrack up the script_filename to find the portion matching
  1873.             // php_self
  1874.             $path = $this->server->get('PHP_SELF', '');
  1875.             $file = $this->server->get('SCRIPT_FILENAME', '');
  1876.             $segs = explode('/', trim($file, '/'));
  1877.             $segs = array_reverse($segs);
  1878.             $index = 0;
  1879.             $last = \count($segs);
  1880.             $baseUrl = '';
  1881.             do {
  1882.                 $seg = $segs[$index];
  1883.                 $baseUrl = '/'.$seg.$baseUrl;
  1884.                 ++$index;
  1885.             } while ($last > $index && (false !== $pos = strpos($path, $baseUrl)) && 0 != $pos);
  1886.         }
  1888.         // Does the baseUrl have anything in common with the request_uri?
  1889.         $requestUri = $this->getRequestUri();
  1890.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1891.             $requestUri = '/'.$requestUri;
  1892.         }
  1894.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, $baseUrl)) {
  1895.             // full $baseUrl matches
  1896.             return $prefix;
  1897.         }
  1899.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, rtrim(\dirname($baseUrl), '/'.\DIRECTORY_SEPARATOR).'/')) {
  1900.             // directory portion of $baseUrl matches
  1901.             return rtrim($prefix, '/'.\DIRECTORY_SEPARATOR);
  1902.         }
  1904.         $truncatedRequestUri = $requestUri;
  1905.         if (false !== $pos = strpos($requestUri, '?')) {
  1906.             $truncatedRequestUri = substr($requestUri, 0, $pos);
  1907.         }
  1909.         $basename = basename($baseUrl);
  1910.         if (empty($basename) || !strpos(rawurldecode($truncatedRequestUri).'/', '/'.$basename.'/')) {
  1911.             // strip autoindex filename, for virtualhost based on URL path
  1912.             $baseUrl = \dirname($baseUrl).'/';
  1914.             $basename = basename($baseUrl);
  1915.             if (empty($basename) || !strpos(rawurldecode($truncatedRequestUri).'/', '/'.$basename.'/')) {
  1916.                 // no match whatsoever; set it blank
  1917.                 return '';
  1918.             }
  1919.         }
  1921.         // If using mod_rewrite or ISAPI_Rewrite strip the script filename
  1922.         // out of baseUrl. $pos !== 0 makes sure it is not matching a value
  1923.         // from PATH_INFO or QUERY_STRING
  1924.         if (\strlen($requestUri) >= \strlen($baseUrl) && (false !== $pos = strpos($requestUri, $baseUrl)) && 0 !== $pos) {
  1925.             $baseUrl = substr($requestUri, 0, $pos + \strlen($baseUrl));
  1926.         }
  1928.         return rtrim($baseUrl, '/'.\DIRECTORY_SEPARATOR);
  1929.     }
  1931.     /**
  1932.      * Prepares the base path.
  1933.      *
  1934.      * @return string base path
  1935.      */
  1936.     protected function prepareBasePath()
  1937.     {
  1938.         $baseUrl = $this->getBaseUrl();
  1939.         if (empty($baseUrl)) {
  1940.             return '';
  1941.         }
  1943.         $filename = basename($this->server->get('SCRIPT_FILENAME'));
  1944.         if (basename($baseUrl) === $filename) {
  1945.             $basePath = \dirname($baseUrl);
  1946.         } else {
  1947.             $basePath = $baseUrl;
  1948.         }
  1950.         if ('\\' === \DIRECTORY_SEPARATOR) {
  1951.             $basePath = str_replace('\\', '/', $basePath);
  1952.         }
  1954.         return rtrim($basePath, '/');
  1955.     }
  1957.     /**
  1958.      * Prepares the path info.
  1959.      *
  1960.      * @return string path info
  1961.      */
  1962.     protected function preparePathInfo()
  1963.     {
  1964.         if (null === ($requestUri = $this->getRequestUri())) {
  1965.             return '/';
  1966.         }
  1968.         // Remove the query string from REQUEST_URI
  1969.         if (false !== $pos = strpos($requestUri, '?')) {
  1970.             $requestUri = substr($requestUri, 0, $pos);
  1971.         }
  1972.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1973.             $requestUri = '/'.$requestUri;
  1974.         }
  1976.         if (null === ($baseUrl = $this->getBaseUrlReal())) {
  1977.             return $requestUri;
  1978.         }
  1980.         $pathInfo = substr($requestUri, \strlen($baseUrl));
  1981.         if (false === $pathInfo || '' === $pathInfo) {
  1982.             // If substr() returns false then PATH_INFO is set to an empty string
  1983.             return '/';
  1984.         }
  1986.         return (string) $pathInfo;
  1987.     }
  1989.     /**
  1990.      * Initializes HTTP request formats.
  1991.      */
  1992.     protected static function initializeFormats()
  1993.     {
  1994.         static::$formats = [
  1995.             'html' => ['text/html', 'application/xhtml+xml'],
  1996.             'txt' => ['text/plain'],
  1997.             'js' => ['application/javascript', 'application/x-javascript', 'text/javascript'],
  1998.             'css' => ['text/css'],
  1999.             'json' => ['application/json', 'application/x-json'],
  2000.             'jsonld' => ['application/ld+json'],
  2001.             'xml' => ['text/xml', 'application/xml', 'application/x-xml'],
  2002.             'rdf' => ['application/rdf+xml'],
  2003.             'atom' => ['application/atom+xml'],
  2004.             'rss' => ['application/rss+xml'],
  2005.             'form' => ['application/x-www-form-urlencoded'],
  2006.         ];
  2007.     }
  2009.     private function setPhpDefaultLocale(string $locale): void
  2010.     {
  2011.         // if either the class Locale doesn't exist, or an exception is thrown when
  2012.         // setting the default locale, the intl module is not installed, and
  2013.         // the call can be ignored:
  2014.         try {
  2015.             if (class_exists('Locale', false)) {
  2016.                 \Locale::setDefault($locale);
  2017.             }
  2018.         } catch (\Exception $e) {
  2019.         }
  2020.     }
  2022.     /**
  2023.      * Returns the prefix as encoded in the string when the string starts with
  2024.      * the given prefix, null otherwise.
  2025.      */
  2026.     private function getUrlencodedPrefix(string $string, string $prefix): ?string
  2027.     {
  2028.         if (0 !== strpos(rawurldecode($string), $prefix)) {
  2029.             return null;
  2030.         }
  2032.         $len = \strlen($prefix);
  2034.         if (preg_match(sprintf('#^(%%[[:xdigit:]]{2}|.){%d}#', $len), $string, $match)) {
  2035.             return $match[0];
  2036.         }
  2038.         return null;
  2039.     }
  2041.     private static function createRequestFromFactory(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null): self
  2042.     {
  2043.         if (self::$requestFactory) {
  2044.             $request = (self::$requestFactory)($query, $request, $attributes, $cookies, $files, $server, $content);
  2046.             if (!$request instanceof self) {
  2047.                 throw new \LogicException('The Request factory must return an instance of Symfony\Component\HttpFoundation\Request.');
  2048.             }
  2050.             return $request;
  2051.         }
  2053.         return new static($query, $request, $attributes, $cookies, $files, $server, $content);
  2054.     }
  2056.     /**
  2057.      * Indicates whether this request originated from a trusted proxy.
  2058.      *
  2059.      * This can be useful to determine whether or not to trust the
  2060.      * contents of a proxy-specific header.
  2061.      *
  2062.      * @return bool true if the request came from a trusted proxy, false otherwise
  2063.      */
  2064.     public function isFromTrustedProxy()
  2065.     {
  2066.         return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR'), self::$trustedProxies);
  2067.     }
  2069.     private function getTrustedValues(int $type, string $ip = null): array
  2070.     {
  2071.         $clientValues = [];
  2072.         $forwardedValues = [];
  2074.         if ((self::$trustedHeaderSet & $type) && $this->headers->has(self::$trustedHeaders[$type])) {
  2075.             foreach (explode(',', $this->headers->get(self::$trustedHeaders[$type])) as $v) {
  2076.                 $clientValues[] = (self::HEADER_X_FORWARDED_PORT === $type ? '0.0.0.0:' : '').trim($v);
  2077.             }
  2078.         }
  2080.         if ((self::$trustedHeaderSet & self::HEADER_FORWARDED) && (isset(self::$forwardedParams[$type])) && $this->headers->has(self::$trustedHeaders[self::HEADER_FORWARDED])) {
  2081.             $forwarded = $this->headers->get(self::$trustedHeaders[self::HEADER_FORWARDED]);
  2082.             $parts = HeaderUtils::split($forwarded, ',;=');
  2083.             $forwardedValues = [];
  2084.             $param = self::$forwardedParams[$type];
  2085.             foreach ($parts as $subParts) {
  2086.                 if (null === $v = HeaderUtils::combine($subParts)[$param] ?? null) {
  2087.                     continue;
  2088.                 }
  2089.                 if (self::HEADER_X_FORWARDED_PORT === $type) {
  2090.                     if (']' === substr($v, -1) || false === $v = strrchr($v, ':')) {
  2091.                         $v = $this->isSecure() ? ':443' : ':80';
  2092.                     }
  2093.                     $v = '0.0.0.0'.$v;
  2094.                 }
  2095.                 $forwardedValues[] = $v;
  2096.             }
  2097.         }
  2099.         if (null !== $ip) {
  2100.             $clientValues = $this->normalizeAndFilterClientIps($clientValues, $ip);
  2101.             $forwardedValues = $this->normalizeAndFilterClientIps($forwardedValues, $ip);
  2102.         }
  2104.         if ($forwardedValues === $clientValues || !$clientValues) {
  2105.             return $forwardedValues;
  2106.         }
  2108.         if (!$forwardedValues) {
  2109.             return $clientValues;
  2110.         }
  2112.         if (!$this->isForwardedValid) {
  2113.             return null !== $ip ? ['0.0.0.0', $ip] : [];
  2114.         }
  2115.         $this->isForwardedValid = false;
  2117.         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::$trustedHeaders[self::HEADER_FORWARDED], self::$trustedHeaders[$type]));
  2118.     }
  2120.     private function normalizeAndFilterClientIps(array $clientIps, string $ip): array
  2121.     {
  2122.         if (!$clientIps) {
  2123.             return [];
  2124.         }
  2125.         $clientIps[] = $ip; // Complete the IP chain with the IP the request actually came from
  2126.         $firstTrustedIp = null;
  2128.         foreach ($clientIps as $key => $clientIp) {
  2129.             if (strpos($clientIp, '.')) {
  2130.                 // Strip :port from IPv4 addresses. This is allowed in Forwarded
  2131.                 // and may occur in X-Forwarded-For.
  2132.                 $i = strpos($clientIp, ':');
  2133.                 if ($i) {
  2134.                     $clientIps[$key] = $clientIp = substr($clientIp, 0, $i);
  2135.                 }
  2136.             } elseif (0 === strpos($clientIp, '[')) {
  2137.                 // Strip brackets and :port from IPv6 addresses.
  2138.                 $i = strpos($clientIp, ']', 1);
  2139.                 $clientIps[$key] = $clientIp = substr($clientIp, 1, $i - 1);
  2140.             }
  2142.             if (!filter_var($clientIp, \FILTER_VALIDATE_IP)) {
  2143.                 unset($clientIps[$key]);
  2145.                 continue;
  2146.             }
  2148.             if (IpUtils::checkIp($clientIp, self::$trustedProxies)) {
  2149.                 unset($clientIps[$key]);
  2151.                 // Fallback to this when the client IP falls into the range of trusted proxies
  2152.                 if (null === $firstTrustedIp) {
  2153.                     $firstTrustedIp = $clientIp;
  2154.                 }
  2155.             }
  2156.         }
  2158.         // Now the IP chain contains only untrusted proxies and the client IP
  2159.         return $clientIps ? array_reverse($clientIps) : [$firstTrustedIp];
  2160.     }
  2161. }