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

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