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

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