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 <[email protected]>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpFoundation;
  14. use Symfony\Component\HttpFoundation\Exception\ConflictingHeadersException;
  15. use Symfony\Component\HttpFoundation\Exception\JsonException;
  16. use Symfony\Component\HttpFoundation\Exception\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 <[email protected]>
  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[] = $k.'='.$v;
  506.         }
  508.         if (!empty($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.      * @throws SessionNotFoundException When session is not set properly
  695.      */
  696.     public function getSession(): SessionInterface
  697.     {
  698.         $session = $this->session;
  699.         if (!$session instanceof SessionInterface && null !== $session) {
  700.             $this->setSession($session = $session());
  701.         }
  703.         if (null === $session) {
  704.             throw new SessionNotFoundException('Session has not been set.');
  705.         }
  707.         return $session;
  708.     }
  710.     /**
  711.      * Whether the request contains a Session which was started in one of the
  712.      * previous requests.
  713.      */
  714.     public function hasPreviousSession(): bool
  715.     {
  716.         // the check for $this->session avoids malicious users trying to fake a session cookie with proper name
  717.         return $this->hasSession() && $this->cookies->has($this->getSession()->getName());
  718.     }
  720.     /**
  721.      * Whether the request contains a Session object.
  722.      *
  723.      * This method does not give any information about the state of the session object,
  724.      * like whether the session is started or not. It is just a way to check if this Request
  725.      * is associated with a Session instance.
  726.      *
  727.      * @param bool $skipIfUninitialized When true, ignores factories injected by `setSessionFactory`
  728.      */
  729.     public function hasSession(bool $skipIfUninitialized = false): bool
  730.     {
  731.         return null !== $this->session && (!$skipIfUninitialized || $this->session instanceof SessionInterface);
  732.     }
  734.     public function setSession(SessionInterface $session)
  735.     {
  736.         $this->session = $session;
  737.     }
  739.     /**
  740.      * @internal
  741.      *
  742.      * @param callable(): SessionInterface $factory
  743.      */
  744.     public function setSessionFactory(callable $factory)
  745.     {
  746.         $this->session = $factory;
  747.     }
  749.     /**
  750.      * Returns the client IP addresses.
  751.      *
  752.      * In the returned array the most trusted IP address is first, and the
  753.      * least trusted one last. The "real" client IP address is the last one,
  754.      * but this is also the least trusted one. Trusted proxies are stripped.
  755.      *
  756.      * Use this method carefully; you should use getClientIp() instead.
  757.      *
  758.      * @see getClientIp()
  759.      */
  760.     public function getClientIps(): array
  761.     {
  762.         $ip = $this->server->get('REMOTE_ADDR');
  764.         if (!$this->isFromTrustedProxy()) {
  765.             return [$ip];
  766.         }
  768.         return $this->getTrustedValues(self::HEADER_X_FORWARDED_FOR, $ip) ?: [$ip];
  769.     }
  771.     /**
  772.      * Returns the client IP address.
  773.      *
  774.      * This method can read the client IP address from the "X-Forwarded-For" header
  775.      * when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For"
  776.      * header value is a comma+space separated list of IP addresses, the left-most
  777.      * being the original client, and each successive proxy that passed the request
  778.      * adding the IP address where it received the request from.
  779.      *
  780.      * If your reverse proxy uses a different header name than "X-Forwarded-For",
  781.      * ("Client-Ip" for instance), configure it via the $trustedHeaderSet
  782.      * argument of the Request::setTrustedProxies() method instead.
  783.      *
  784.      * @see getClientIps()
  785.      * @see https://wikipedia.org/wiki/X-Forwarded-For
  786.      */
  787.     public function getClientIp(): ?string
  788.     {
  789.         $ipAddresses = $this->getClientIps();
  791.         return $ipAddresses[0];
  792.     }
  794.     /**
  795.      * Returns current script name.
  796.      */
  797.     public function getScriptName(): string
  798.     {
  799.         return $this->server->get('SCRIPT_NAME', $this->server->get('ORIG_SCRIPT_NAME', ''));
  800.     }
  802.     /**
  803.      * Returns the path being requested relative to the executed script.
  804.      *
  805.      * The path info always starts with a /.
  806.      *
  807.      * Suppose this request is instantiated from /mysite on localhost:
  808.      *
  809.      *  * http://localhost/mysite              returns an empty string
  810.      *  * http://localhost/mysite/about        returns '/about'
  811.      *  * http://localhost/mysite/enco%20ded   returns '/enco%20ded'
  812.      *  * http://localhost/mysite/about?var=1  returns '/about'
  813.      *
  814.      * @return string The raw path (i.e. not urldecoded)
  815.      */
  816.     public function getPathInfo(): string
  817.     {
  818.         if (null === $this->pathInfo) {
  819.             $this->pathInfo = $this->preparePathInfo();
  820.         }
  822.         return $this->pathInfo;
  823.     }
  825.     /**
  826.      * Returns the root path from which this request is executed.
  827.      *
  828.      * Suppose that an index.php file instantiates this request object:
  829.      *
  830.      *  * http://localhost/index.php         returns an empty string
  831.      *  * http://localhost/index.php/page    returns an empty string
  832.      *  * http://localhost/web/index.php     returns '/web'
  833.      *  * http://localhost/we%20b/index.php  returns '/we%20b'
  834.      *
  835.      * @return string The raw path (i.e. not urldecoded)
  836.      */
  837.     public function getBasePath(): string
  838.     {
  839.         if (null === $this->basePath) {
  840.             $this->basePath = $this->prepareBasePath();
  841.         }
  843.         return $this->basePath;
  844.     }
  846.     /**
  847.      * Returns the root URL from which this request is executed.
  848.      *
  849.      * The base URL never ends with a /.
  850.      *
  851.      * This is similar to getBasePath(), except that it also includes the
  852.      * script filename (e.g. index.php) if one exists.
  853.      *
  854.      * @return string The raw URL (i.e. not urldecoded)
  855.      */
  856.     public function getBaseUrl(): string
  857.     {
  858.         $trustedPrefix = '';
  860.         // the proxy prefix must be prepended to any prefix being needed at the webserver level
  861.         if ($this->isFromTrustedProxy() && $trustedPrefixValues = $this->getTrustedValues(self::HEADER_X_FORWARDED_PREFIX)) {
  862.             $trustedPrefix = rtrim($trustedPrefixValues[0], '/');
  863.         }
  865.         return $trustedPrefix.$this->getBaseUrlReal();
  866.     }
  868.     /**
  869.      * Returns the real base URL received by the webserver from which this request is executed.
  870.      * The URL does not include trusted reverse proxy prefix.
  871.      *
  872.      * @return string The raw URL (i.e. not urldecoded)
  873.      */
  874.     private function getBaseUrlReal(): string
  875.     {
  876.         if (null === $this->baseUrl) {
  877.             $this->baseUrl = $this->prepareBaseUrl();
  878.         }
  880.         return $this->baseUrl;
  881.     }
  883.     /**
  884.      * Gets the request's scheme.
  885.      */
  886.     public function getScheme(): string
  887.     {
  888.         return $this->isSecure() ? 'https' : 'http';
  889.     }
  891.     /**
  892.      * Returns the port on which the request is made.
  893.      *
  894.      * This method can read the client port from the "X-Forwarded-Port" header
  895.      * when trusted proxies were set via "setTrustedProxies()".
  896.      *
  897.      * The "X-Forwarded-Port" header must contain the client port.
  898.      *
  899.      * @return int|string|null Can be a string if fetched from the server bag
  900.      */
  901.     public function getPort(): int|string|null
  902.     {
  903.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_PORT)) {
  904.             $host = $host[0];
  905.         } elseif ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  906.             $host = $host[0];
  907.         } elseif (!$host = $this->headers->get('HOST')) {
  908.             return $this->server->get('SERVER_PORT');
  909.         }
  911.         if ('[' === $host[0]) {
  912.             $pos = strpos($host, ':', strrpos($host, ']'));
  913.         } else {
  914.             $pos = strrpos($host, ':');
  915.         }
  917.         if (false !== $pos && $port = substr($host, $pos + 1)) {
  918.             return (int) $port;
  919.         }
  921.         return 'https' === $this->getScheme() ? 443 : 80;
  922.     }
  924.     /**
  925.      * Returns the user.
  926.      */
  927.     public function getUser(): ?string
  928.     {
  929.         return $this->headers->get('PHP_AUTH_USER');
  930.     }
  932.     /**
  933.      * Returns the password.
  934.      */
  935.     public function getPassword(): ?string
  936.     {
  937.         return $this->headers->get('PHP_AUTH_PW');
  938.     }
  940.     /**
  941.      * Gets the user info.
  942.      *
  943.      * @return string|null A user name if any and, optionally, scheme-specific information about how to gain authorization to access the server
  944.      */
  945.     public function getUserInfo(): ?string
  946.     {
  947.         $userinfo = $this->getUser();
  949.         $pass = $this->getPassword();
  950.         if ('' != $pass) {
  951.             $userinfo .= ":$pass";
  952.         }
  954.         return $userinfo;
  955.     }
  957.     /**
  958.      * Returns the HTTP host being requested.
  959.      *
  960.      * The port name will be appended to the host if it's non-standard.
  961.      */
  962.     public function getHttpHost(): string
  963.     {
  964.         $scheme = $this->getScheme();
  965.         $port = $this->getPort();
  967.         if (('http' == $scheme && 80 == $port) || ('https' == $scheme && 443 == $port)) {
  968.             return $this->getHost();
  969.         }
  971.         return $this->getHost().':'.$port;
  972.     }
  974.     /**
  975.      * Returns the requested URI (path and query string).
  976.      *
  977.      * @return string The raw URI (i.e. not URI decoded)
  978.      */
  979.     public function getRequestUri(): string
  980.     {
  981.         if (null === $this->requestUri) {
  982.             $this->requestUri = $this->prepareRequestUri();
  983.         }
  985.         return $this->requestUri;
  986.     }
  988.     /**
  989.      * Gets the scheme and HTTP host.
  990.      *
  991.      * If the URL was called with basic authentication, the user
  992.      * and the password are not added to the generated string.
  993.      */
  994.     public function getSchemeAndHttpHost(): string
  995.     {
  996.         return $this->getScheme().'://'.$this->getHttpHost();
  997.     }
  999.     /**
  1000.      * Generates a normalized URI (URL) for the Request.
  1001.      *
  1002.      * @see getQueryString()
  1003.      */
  1004.     public function getUri(): string
  1005.     {
  1006.         if (null !== $qs = $this->getQueryString()) {
  1007.             $qs = '?'.$qs;
  1008.         }
  1010.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$this->getPathInfo().$qs;
  1011.     }
  1013.     /**
  1014.      * Generates a normalized URI for the given path.
  1015.      *
  1016.      * @param string $path A path to use instead of the current one
  1017.      */
  1018.     public function getUriForPath(string $path): string
  1019.     {
  1020.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$path;
  1021.     }
  1023.     /**
  1024.      * Returns the path as relative reference from the current Request path.
  1025.      *
  1026.      * Only the URIs path component (no schema, host etc.) is relevant and must be given.
  1027.      * Both paths must be absolute and not contain relative parts.
  1028.      * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
  1029.      * Furthermore, they can be used to reduce the link size in documents.
  1030.      *
  1031.      * Example target paths, given a base path of "/a/b/c/d":
  1032.      * - "/a/b/c/d"     -> ""
  1033.      * - "/a/b/c/"      -> "./"
  1034.      * - "/a/b/"        -> "../"
  1035.      * - "/a/b/c/other" -> "other"
  1036.      * - "/a/x/y"       -> "../../x/y"
  1037.      */
  1038.     public function getRelativeUriForPath(string $path): string
  1039.     {
  1040.         // be sure that we are dealing with an absolute path
  1041.         if (!isset($path[0]) || '/' !== $path[0]) {
  1042.             return $path;
  1043.         }
  1045.         if ($path === $basePath = $this->getPathInfo()) {
  1046.             return '';
  1047.         }
  1049.         $sourceDirs = explode('/', isset($basePath[0]) && '/' === $basePath[0] ? substr($basePath, 1) : $basePath);
  1050.         $targetDirs = explode('/', substr($path, 1));
  1051.         array_pop($sourceDirs);
  1052.         $targetFile = array_pop($targetDirs);
  1054.         foreach ($sourceDirs as $i => $dir) {
  1055.             if (isset($targetDirs[$i]) && $dir === $targetDirs[$i]) {
  1056.                 unset($sourceDirs[$i], $targetDirs[$i]);
  1057.             } else {
  1058.                 break;
  1059.             }
  1060.         }
  1062.         $targetDirs[] = $targetFile;
  1063.         $path = str_repeat('../', \count($sourceDirs)).implode('/', $targetDirs);
  1065.         // A reference to the same base directory or an empty subdirectory must be prefixed with "./".
  1066.         // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used
  1067.         // as the first segment of a relative-path reference, as it would be mistaken for a scheme name
  1068.         // (see https://tools.ietf.org/html/rfc3986#section-4.2).
  1069.         return !isset($path[0]) || '/' === $path[0]
  1070.             || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)
  1071.             ? "./$path" : $path;
  1072.     }
  1074.     /**
  1075.      * Generates the normalized query string for the Request.
  1076.      *
  1077.      * It builds a normalized query string, where keys/value pairs are alphabetized
  1078.      * and have consistent escaping.
  1079.      */
  1080.     public function getQueryString(): ?string
  1081.     {
  1082.         $qs = static::normalizeQueryString($this->server->get('QUERY_STRING'));
  1084.         return '' === $qs ? null : $qs;
  1085.     }
  1087.     /**
  1088.      * Checks whether the request is secure or not.
  1089.      *
  1090.      * This method can read the client protocol from the "X-Forwarded-Proto" header
  1091.      * when trusted proxies were set via "setTrustedProxies()".
  1092.      *
  1093.      * The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".
  1094.      */
  1095.     public function isSecure(): bool
  1096.     {
  1097.         if ($this->isFromTrustedProxy() && $proto = $this->getTrustedValues(self::HEADER_X_FORWARDED_PROTO)) {
  1098.             return \in_array(strtolower($proto[0]), ['https', 'on', 'ssl', '1'], true);
  1099.         }
  1101.         $https = $this->server->get('HTTPS');
  1103.         return !empty($https) && 'off' !== strtolower($https);
  1104.     }
  1106.     /**
  1107.      * Returns the host name.
  1108.      *
  1109.      * This method can read the client host name from the "X-Forwarded-Host" header
  1110.      * when trusted proxies were set via "setTrustedProxies()".
  1111.      *
  1112.      * The "X-Forwarded-Host" header must contain the client host name.
  1113.      *
  1114.      * @throws SuspiciousOperationException when the host name is invalid or not trusted
  1115.      */
  1116.     public function getHost(): string
  1117.     {
  1118.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  1119.             $host = $host[0];
  1120.         } elseif (!$host = $this->headers->get('HOST')) {
  1121.             if (!$host = $this->server->get('SERVER_NAME')) {
  1122.                 $host = $this->server->get('SERVER_ADDR', '');
  1123.             }
  1124.         }
  1126.         // trim and remove port number from host
  1127.         // host is lowercase as per RFC 952/2181
  1128.         $host = strtolower(preg_replace('/:\d+$/', '', trim($host)));
  1130.         // as the host can come from the user (HTTP_HOST and depending on the configuration, SERVER_NAME too can come from the user)
  1131.         // check that it does not contain forbidden characters (see RFC 952 and RFC 2181)
  1132.         // use preg_replace() instead of preg_match() to prevent DoS attacks with long host names
  1133.         if ($host && '' !== preg_replace('/(?:^\[)?[a-zA-Z0-9-:\]_]+\.?/', '', $host)) {
  1134.             if (!$this->isHostValid) {
  1135.                 return '';
  1136.             }
  1137.             $this->isHostValid = false;
  1139.             throw new SuspiciousOperationException(sprintf('Invalid Host "%s".', $host));
  1140.         }
  1142.         if (\count(self::$trustedHostPatterns) > 0) {
  1143.             // to avoid host header injection attacks, you should provide a list of trusted host patterns
  1145.             if (\in_array($host, self::$trustedHosts)) {
  1146.                 return $host;
  1147.             }
  1149.             foreach (self::$trustedHostPatterns as $pattern) {
  1150.                 if (preg_match($pattern, $host)) {
  1151.                     self::$trustedHosts[] = $host;
  1153.                     return $host;
  1154.                 }
  1155.             }
  1157.             if (!$this->isHostValid) {
  1158.                 return '';
  1159.             }
  1160.             $this->isHostValid = false;
  1162.             throw new SuspiciousOperationException(sprintf('Untrusted Host "%s".', $host));
  1163.         }
  1165.         return $host;
  1166.     }
  1168.     /**
  1169.      * Sets the request method.
  1170.      */
  1171.     public function setMethod(string $method)
  1172.     {
  1173.         $this->method = null;
  1174.         $this->server->set('REQUEST_METHOD', $method);
  1175.     }
  1177.     /**
  1178.      * Gets the request "intended" method.
  1179.      *
  1180.      * If the X-HTTP-Method-Override header is set, and if the method is a POST,
  1181.      * then it is used to determine the "real" intended HTTP method.
  1182.      *
  1183.      * The _method request parameter can also be used to determine the HTTP method,
  1184.      * but only if enableHttpMethodParameterOverride() has been called.
  1185.      *
  1186.      * The method is always an uppercased string.
  1187.      *
  1188.      * @see getRealMethod()
  1189.      */
  1190.     public function getMethod(): string
  1191.     {
  1192.         if (null !== $this->method) {
  1193.             return $this->method;
  1194.         }
  1196.         $this->method = strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1198.         if ('POST' !== $this->method) {
  1199.             return $this->method;
  1200.         }
  1202.         $method = $this->headers->get('X-HTTP-METHOD-OVERRIDE');
  1204.         if (!$method && self::$httpMethodParameterOverride) {
  1205.             $method = $this->request->get('_method', $this->query->get('_method', 'POST'));
  1206.         }
  1208.         if (!\is_string($method)) {
  1209.             return $this->method;
  1210.         }
  1212.         $method = strtoupper($method);
  1214.         if (\in_array($method, ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'PATCH', 'PURGE', 'TRACE'], true)) {
  1215.             return $this->method = $method;
  1216.         }
  1218.         if (!preg_match('/^[A-Z]++$/D', $method)) {
  1219.             throw new SuspiciousOperationException(sprintf('Invalid method override "%s".', $method));
  1220.         }
  1222.         return $this->method = $method;
  1223.     }
  1225.     /**
  1226.      * Gets the "real" request method.
  1227.      *
  1228.      * @see getMethod()
  1229.      */
  1230.     public function getRealMethod(): string
  1231.     {
  1232.         return strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1233.     }
  1235.     /**
  1236.      * Gets the mime type associated with the format.
  1237.      */
  1238.     public function getMimeType(string $format): ?string
  1239.     {
  1240.         if (null === static::$formats) {
  1241.             static::initializeFormats();
  1242.         }
  1244.         return isset(static::$formats[$format]) ? static::$formats[$format][0] : null;
  1245.     }
  1247.     /**
  1248.      * Gets the mime types associated with the format.
  1249.      */
  1250.     public static function getMimeTypes(string $format): array
  1251.     {
  1252.         if (null === static::$formats) {
  1253.             static::initializeFormats();
  1254.         }
  1256.         return static::$formats[$format] ?? [];
  1257.     }
  1259.     /**
  1260.      * Gets the format associated with the mime type.
  1261.      */
  1262.     public function getFormat(?string $mimeType): ?string
  1263.     {
  1264.         $canonicalMimeType = null;
  1265.         if ($mimeType && false !== $pos = strpos($mimeType, ';')) {
  1266.             $canonicalMimeType = trim(substr($mimeType, 0, $pos));
  1267.         }
  1269.         if (null === static::$formats) {
  1270.             static::initializeFormats();
  1271.         }
  1273.         foreach (static::$formats as $format => $mimeTypes) {
  1274.             if (\in_array($mimeType, (array) $mimeTypes)) {
  1275.                 return $format;
  1276.             }
  1277.             if (null !== $canonicalMimeType && \in_array($canonicalMimeType, (array) $mimeTypes)) {
  1278.                 return $format;
  1279.             }
  1280.         }
  1282.         return null;
  1283.     }
  1285.     /**
  1286.      * Associates a format with mime types.
  1287.      *
  1288.      * @param string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
  1289.      */
  1290.     public function setFormat(?string $format, string|array $mimeTypes)
  1291.     {
  1292.         if (null === static::$formats) {
  1293.             static::initializeFormats();
  1294.         }
  1296.         static::$formats[$format] = \is_array($mimeTypes) ? $mimeTypes : [$mimeTypes];
  1297.     }
  1299.     /**
  1300.      * Gets the request format.
  1301.      *
  1302.      * Here is the process to determine the format:
  1303.      *
  1304.      *  * format defined by the user (with setRequestFormat())
  1305.      *  * _format request attribute
  1306.      *  * $default
  1307.      *
  1308.      * @see getPreferredFormat
  1309.      */
  1310.     public function getRequestFormat(?string $default = 'html'): ?string
  1311.     {
  1312.         if (null === $this->format) {
  1313.             $this->format = $this->attributes->get('_format');
  1314.         }
  1316.         return $this->format ?? $default;
  1317.     }
  1319.     /**
  1320.      * Sets the request format.
  1321.      */
  1322.     public function setRequestFormat(?string $format)
  1323.     {
  1324.         $this->format = $format;
  1325.     }
  1327.     /**
  1328.      * Gets the format associated with the request.
  1329.      */
  1330.     public function getContentType(): ?string
  1331.     {
  1332.         return $this->getFormat($this->headers->get('CONTENT_TYPE', ''));
  1333.     }
  1335.     /**
  1336.      * Sets the default locale.
  1337.      */
  1338.     public function setDefaultLocale(string $locale)
  1339.     {
  1340.         $this->defaultLocale = $locale;
  1342.         if (null === $this->locale) {
  1343.             $this->setPhpDefaultLocale($locale);
  1344.         }
  1345.     }
  1347.     /**
  1348.      * Get the default locale.
  1349.      */
  1350.     public function getDefaultLocale(): string
  1351.     {
  1352.         return $this->defaultLocale;
  1353.     }
  1355.     /**
  1356.      * Sets the locale.
  1357.      */
  1358.     public function setLocale(string $locale)
  1359.     {
  1360.         $this->setPhpDefaultLocale($this->locale = $locale);
  1361.     }
  1363.     /**
  1364.      * Get the locale.
  1365.      */
  1366.     public function getLocale(): string
  1367.     {
  1368.         return null === $this->locale ? $this->defaultLocale : $this->locale;
  1369.     }
  1371.     /**
  1372.      * Checks if the request method is of specified type.
  1373.      *
  1374.      * @param string $method Uppercase request method (GET, POST etc)
  1375.      */
  1376.     public function isMethod(string $method): bool
  1377.     {
  1378.         return $this->getMethod() === strtoupper($method);
  1379.     }
  1381.     /**
  1382.      * Checks whether or not the method is safe.
  1383.      *
  1384.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
  1385.      */
  1386.     public function isMethodSafe(): bool
  1387.     {
  1388.         return \in_array($this->getMethod(), ['GET', 'HEAD', 'OPTIONS', 'TRACE']);
  1389.     }
  1391.     /**
  1392.      * Checks whether or not the method is idempotent.
  1393.      */
  1394.     public function isMethodIdempotent(): bool
  1395.     {
  1396.         return \in_array($this->getMethod(), ['HEAD', 'GET', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'PURGE']);
  1397.     }
  1399.     /**
  1400.      * Checks whether the method is cacheable or not.
  1401.      *
  1402.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
  1403.      */
  1404.     public function isMethodCacheable(): bool
  1405.     {
  1406.         return \in_array($this->getMethod(), ['GET', 'HEAD']);
  1407.     }
  1409.     /**
  1410.      * Returns the protocol version.
  1411.      *
  1412.      * If the application is behind a proxy, the protocol version used in the
  1413.      * requests between the client and the proxy and between the proxy and the
  1414.      * server might be different. This returns the former (from the "Via" header)
  1415.      * if the proxy is trusted (see "setTrustedProxies()"), otherwise it returns
  1416.      * the latter (from the "SERVER_PROTOCOL" server parameter).
  1417.      */
  1418.     public function getProtocolVersion(): ?string
  1419.     {
  1420.         if ($this->isFromTrustedProxy()) {
  1421.             preg_match('~^(HTTP/)?([1-9]\.[0-9]) ~', $this->headers->get('Via') ?? '', $matches);
  1423.             if ($matches) {
  1424.                 return 'HTTP/'.$matches[2];
  1425.             }
  1426.         }
  1428.         return $this->server->get('SERVER_PROTOCOL');
  1429.     }
  1431.     /**
  1432.      * Returns the request body content.
  1433.      *
  1434.      * @param bool $asResource If true, a resource will be returned
  1435.      *
  1436.      * @return string|resource
  1437.      */
  1438.     public function getContent(bool $asResource = false)
  1439.     {
  1440.         $currentContentIsResource = \is_resource($this->content);
  1442.         if (true === $asResource) {
  1443.             if ($currentContentIsResource) {
  1444.                 rewind($this->content);
  1446.                 return $this->content;
  1447.             }
  1449.             // Content passed in parameter (test)
  1450.             if (\is_string($this->content)) {
  1451.                 $resource = fopen('php://temp', 'r+');
  1452.                 fwrite($resource, $this->content);
  1453.                 rewind($resource);
  1455.                 return $resource;
  1456.             }
  1458.             $this->content = false;
  1460.             return fopen('php://input', 'r');
  1461.         }
  1463.         if ($currentContentIsResource) {
  1464.             rewind($this->content);
  1466.             return stream_get_contents($this->content);
  1467.         }
  1469.         if (null === $this->content || false === $this->content) {
  1470.             $this->content = file_get_contents('php://input');
  1471.         }
  1473.         return $this->content;
  1474.     }
  1476.     /**
  1477.      * Gets the request body decoded as array, typically from a JSON payload.
  1478.      *
  1479.      * @throws JsonException When the body cannot be decoded to an array
  1480.      */
  1481.     public function toArray(): array
  1482.     {
  1483.         if ('' === $content = $this->getContent()) {
  1484.             throw new JsonException('Request body is empty.');
  1485.         }
  1487.         try {
  1488.             $content = json_decode($content, true, 512, \JSON_BIGINT_AS_STRING | \JSON_THROW_ON_ERROR);
  1489.         } catch (\JsonException $e) {
  1490.             throw new JsonException('Could not decode request body.', $e->getCode(), $e);
  1491.         }
  1493.         if (!\is_array($content)) {
  1494.             throw new JsonException(sprintf('JSON content was expected to decode to an array, "%s" returned.', get_debug_type($content)));
  1495.         }
  1497.         return $content;
  1498.     }
  1500.     /**
  1501.      * Gets the Etags.
  1502.      */
  1503.     public function getETags(): array
  1504.     {
  1505.         return preg_split('/\s*,\s*/', $this->headers->get('If-None-Match', ''), -1, \PREG_SPLIT_NO_EMPTY);
  1506.     }
  1508.     public function isNoCache(): bool
  1509.     {
  1510.         return $this->headers->hasCacheControlDirective('no-cache') || 'no-cache' == $this->headers->get('Pragma');
  1511.     }
  1513.     /**
  1514.      * Gets the preferred format for the response by inspecting, in the following order:
  1515.      *   * the request format set using setRequestFormat;
  1516.      *   * the values of the Accept HTTP header.
  1517.      *
  1518.      * Note that if you use this method, you should send the "Vary: Accept" header
  1519.      * in the response to prevent any issues with intermediary HTTP caches.
  1520.      */
  1521.     public function getPreferredFormat(?string $default = 'html'): ?string
  1522.     {
  1523.         if (null !== $this->preferredFormat || null !== $this->preferredFormat = $this->getRequestFormat(null)) {
  1524.             return $this->preferredFormat;
  1525.         }
  1527.         foreach ($this->getAcceptableContentTypes() as $mimeType) {
  1528.             if ($this->preferredFormat = $this->getFormat($mimeType)) {
  1529.                 return $this->preferredFormat;
  1530.             }
  1531.         }
  1533.         return $default;
  1534.     }
  1536.     /**
  1537.      * Returns the preferred language.
  1538.      *
  1539.      * @param string[] $locales An array of ordered available locales
  1540.      */
  1541.     public function getPreferredLanguage(array $locales = null): ?string
  1542.     {
  1543.         $preferredLanguages = $this->getLanguages();
  1545.         if (empty($locales)) {
  1546.             return $preferredLanguages[0] ?? null;
  1547.         }
  1549.         if (!$preferredLanguages) {
  1550.             return $locales[0];
  1551.         }
  1553.         $extendedPreferredLanguages = [];
  1554.         foreach ($preferredLanguages as $language) {
  1555.             $extendedPreferredLanguages[] = $language;
  1556.             if (false !== $position = strpos($language, '_')) {
  1557.                 $superLanguage = substr($language, 0, $position);
  1558.                 if (!\in_array($superLanguage, $preferredLanguages)) {
  1559.                     $extendedPreferredLanguages[] = $superLanguage;
  1560.                 }
  1561.             }
  1562.         }
  1564.         $preferredLanguages = array_values(array_intersect($extendedPreferredLanguages, $locales));
  1566.         return $preferredLanguages[0] ?? $locales[0];
  1567.     }
  1569.     /**
  1570.      * Gets a list of languages acceptable by the client browser ordered in the user browser preferences.
  1571.      */
  1572.     public function getLanguages(): array
  1573.     {
  1574.         if (null !== $this->languages) {
  1575.             return $this->languages;
  1576.         }
  1578.         $languages = AcceptHeader::fromString($this->headers->get('Accept-Language'))->all();
  1579.         $this->languages = [];
  1580.         foreach ($languages as $acceptHeaderItem) {
  1581.             $lang = $acceptHeaderItem->getValue();
  1582.             if (str_contains($lang, '-')) {
  1583.                 $codes = explode('-', $lang);
  1584.                 if ('i' === $codes[0]) {
  1585.                     // Language not listed in ISO 639 that are not variants
  1586.                     // of any listed language, which can be registered with the
  1587.                     // i-prefix, such as i-cherokee
  1588.                     if (\count($codes) > 1) {
  1589.                         $lang = $codes[1];
  1590.                     }
  1591.                 } else {
  1592.                     for ($i = 0, $max = \count($codes); $i < $max; ++$i) {
  1593.                         if (0 === $i) {
  1594.                             $lang = strtolower($codes[0]);
  1595.                         } else {
  1596.                             $lang .= '_'.strtoupper($codes[$i]);
  1597.                         }
  1598.                     }
  1599.                 }
  1600.             }
  1602.             $this->languages[] = $lang;
  1603.         }
  1605.         return $this->languages;
  1606.     }
  1608.     /**
  1609.      * Gets a list of charsets acceptable by the client browser in preferable order.
  1610.      */
  1611.     public function getCharsets(): array
  1612.     {
  1613.         if (null !== $this->charsets) {
  1614.             return $this->charsets;
  1615.         }
  1617.         return $this->charsets = array_map('strval', array_keys(AcceptHeader::fromString($this->headers->get('Accept-Charset'))->all()));
  1618.     }
  1620.     /**
  1621.      * Gets a list of encodings acceptable by the client browser in preferable order.
  1622.      */
  1623.     public function getEncodings(): array
  1624.     {
  1625.         if (null !== $this->encodings) {
  1626.             return $this->encodings;
  1627.         }
  1629.         return $this->encodings = array_map('strval', array_keys(AcceptHeader::fromString($this->headers->get('Accept-Encoding'))->all()));
  1630.     }
  1632.     /**
  1633.      * Gets a list of content types acceptable by the client browser in preferable order.
  1634.      */
  1635.     public function getAcceptableContentTypes(): array
  1636.     {
  1637.         if (null !== $this->acceptableContentTypes) {
  1638.             return $this->acceptableContentTypes;
  1639.         }
  1641.         return $this->acceptableContentTypes = array_map('strval', array_keys(AcceptHeader::fromString($this->headers->get('Accept'))->all()));
  1642.     }
  1644.     /**
  1645.      * Returns true if the request is an XMLHttpRequest.
  1646.      *
  1647.      * It works if your JavaScript library sets an X-Requested-With HTTP header.
  1648.      * It is known to work with common JavaScript frameworks:
  1649.      *
  1650.      * @see https://wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
  1651.      */
  1652.     public function isXmlHttpRequest(): bool
  1653.     {
  1654.         return 'XMLHttpRequest' == $this->headers->get('X-Requested-With');
  1655.     }
  1657.     /**
  1658.      * Checks whether the client browser prefers safe content or not according to RFC8674.
  1659.      *
  1660.      * @see https://tools.ietf.org/html/rfc8674
  1661.      */
  1662.     public function preferSafeContent(): bool
  1663.     {
  1664.         if (isset($this->isSafeContentPreferred)) {
  1665.             return $this->isSafeContentPreferred;
  1666.         }
  1668.         if (!$this->isSecure()) {
  1669.             // see https://tools.ietf.org/html/rfc8674#section-3
  1670.             return $this->isSafeContentPreferred = false;
  1671.         }
  1673.         return $this->isSafeContentPreferred = AcceptHeader::fromString($this->headers->get('Prefer'))->has('safe');
  1674.     }
  1676.     /*
  1677.      * The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)
  1678.      *
  1679.      * Code subject to the new BSD license (https://framework.zend.com/license).
  1680.      *
  1681.      * Copyright (c) 2005-2010 Zend Technologies USA Inc. (https://www.zend.com/)
  1682.      */
  1684.     protected function prepareRequestUri()
  1685.     {
  1686.         $requestUri = '';
  1688.         if ('1' == $this->server->get('IIS_WasUrlRewritten') && '' != $this->server->get('UNENCODED_URL')) {
  1689.             // IIS7 with URL Rewrite: make sure we get the unencoded URL (double slash problem)
  1690.             $requestUri = $this->server->get('UNENCODED_URL');
  1691.             $this->server->remove('UNENCODED_URL');
  1692.             $this->server->remove('IIS_WasUrlRewritten');
  1693.         } elseif ($this->server->has('REQUEST_URI')) {
  1694.             $requestUri = $this->server->get('REQUEST_URI');
  1696.             if ('' !== $requestUri && '/' === $requestUri[0]) {
  1697.                 // To only use path and query remove the fragment.
  1698.                 if (false !== $pos = strpos($requestUri, '#')) {
  1699.                     $requestUri = substr($requestUri, 0, $pos);
  1700.                 }
  1701.             } else {
  1702.                 // HTTP proxy reqs setup request URI with scheme and host [and port] + the URL path,
  1703.                 // only use URL path.
  1704.                 $uriComponents = parse_url($requestUri);
  1706.                 if (isset($uriComponents['path'])) {
  1707.                     $requestUri = $uriComponents['path'];
  1708.                 }
  1710.                 if (isset($uriComponents['query'])) {
  1711.                     $requestUri .= '?'.$uriComponents['query'];
  1712.                 }
  1713.             }
  1714.         } elseif ($this->server->has('ORIG_PATH_INFO')) {
  1715.             // IIS 5.0, PHP as CGI
  1716.             $requestUri = $this->server->get('ORIG_PATH_INFO');
  1717.             if ('' != $this->server->get('QUERY_STRING')) {
  1718.                 $requestUri .= '?'.$this->server->get('QUERY_STRING');
  1719.             }
  1720.             $this->server->remove('ORIG_PATH_INFO');
  1721.         }
  1723.         // normalize the request URI to ease creating sub-requests from this request
  1724.         $this->server->set('REQUEST_URI', $requestUri);
  1726.         return $requestUri;
  1727.     }
  1729.     /**
  1730.      * Prepares the base URL.
  1731.      */
  1732.     protected function prepareBaseUrl(): string
  1733.     {
  1734.         $filename = basename($this->server->get('SCRIPT_FILENAME', ''));
  1736.         if (basename($this->server->get('SCRIPT_NAME', '')) === $filename) {
  1737.             $baseUrl = $this->server->get('SCRIPT_NAME');
  1738.         } elseif (basename($this->server->get('PHP_SELF', '')) === $filename) {
  1739.             $baseUrl = $this->server->get('PHP_SELF');
  1740.         } elseif (basename($this->server->get('ORIG_SCRIPT_NAME', '')) === $filename) {
  1741.             $baseUrl = $this->server->get('ORIG_SCRIPT_NAME'); // 1and1 shared hosting compatibility
  1742.         } else {
  1743.             // Backtrack up the script_filename to find the portion matching
  1744.             // php_self
  1745.             $path = $this->server->get('PHP_SELF', '');
  1746.             $file = $this->server->get('SCRIPT_FILENAME', '');
  1747.             $segs = explode('/', trim($file, '/'));
  1748.             $segs = array_reverse($segs);
  1749.             $index = 0;
  1750.             $last = \count($segs);
  1751.             $baseUrl = '';
  1752.             do {
  1753.                 $seg = $segs[$index];
  1754.                 $baseUrl = '/'.$seg.$baseUrl;
  1755.                 ++$index;
  1756.             } while ($last > $index && (false !== $pos = strpos($path, $baseUrl)) && 0 != $pos);
  1757.         }
  1759.         // Does the baseUrl have anything in common with the request_uri?
  1760.         $requestUri = $this->getRequestUri();
  1761.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1762.             $requestUri = '/'.$requestUri;
  1763.         }
  1765.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, $baseUrl)) {
  1766.             // full $baseUrl matches
  1767.             return $prefix;
  1768.         }
  1770.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, rtrim(\dirname($baseUrl), '/'.\DIRECTORY_SEPARATOR).'/')) {
  1771.             // directory portion of $baseUrl matches
  1772.             return rtrim($prefix, '/'.\DIRECTORY_SEPARATOR);
  1773.         }
  1775.         $truncatedRequestUri = $requestUri;
  1776.         if (false !== $pos = strpos($requestUri, '?')) {
  1777.             $truncatedRequestUri = substr($requestUri, 0, $pos);
  1778.         }
  1780.         $basename = basename($baseUrl ?? '');
  1781.         if (empty($basename) || !strpos(rawurldecode($truncatedRequestUri), $basename)) {
  1782.             // no match whatsoever; set it blank
  1783.             return '';
  1784.         }
  1786.         // If using mod_rewrite or ISAPI_Rewrite strip the script filename
  1787.         // out of baseUrl. $pos !== 0 makes sure it is not matching a value
  1788.         // from PATH_INFO or QUERY_STRING
  1789.         if (\strlen($requestUri) >= \strlen($baseUrl) && (false !== $pos = strpos($requestUri, $baseUrl)) && 0 !== $pos) {
  1790.             $baseUrl = substr($requestUri, 0, $pos + \strlen($baseUrl));
  1791.         }
  1793.         return rtrim($baseUrl, '/'.\DIRECTORY_SEPARATOR);
  1794.     }
  1796.     /**
  1797.      * Prepares the base path.
  1798.      */
  1799.     protected function prepareBasePath(): string
  1800.     {
  1801.         $baseUrl = $this->getBaseUrl();
  1802.         if (empty($baseUrl)) {
  1803.             return '';
  1804.         }
  1806.         $filename = basename($this->server->get('SCRIPT_FILENAME'));
  1807.         if (basename($baseUrl) === $filename) {
  1808.             $basePath = \dirname($baseUrl);
  1809.         } else {
  1810.             $basePath = $baseUrl;
  1811.         }
  1813.         if ('\\' === \DIRECTORY_SEPARATOR) {
  1814.             $basePath = str_replace('\\', '/', $basePath);
  1815.         }
  1817.         return rtrim($basePath, '/');
  1818.     }
  1820.     /**
  1821.      * Prepares the path info.
  1822.      */
  1823.     protected function preparePathInfo(): string
  1824.     {
  1825.         if (null === ($requestUri = $this->getRequestUri())) {
  1826.             return '/';
  1827.         }
  1829.         // Remove the query string from REQUEST_URI
  1830.         if (false !== $pos = strpos($requestUri, '?')) {
  1831.             $requestUri = substr($requestUri, 0, $pos);
  1832.         }
  1833.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1834.             $requestUri = '/'.$requestUri;
  1835.         }
  1837.         if (null === ($baseUrl = $this->getBaseUrlReal())) {
  1838.             return $requestUri;
  1839.         }
  1841.         $pathInfo = substr($requestUri, \strlen($baseUrl));
  1842.         if (false === $pathInfo || '' === $pathInfo) {
  1843.             // If substr() returns false then PATH_INFO is set to an empty string
  1844.             return '/';
  1845.         }
  1847.         return $pathInfo;
  1848.     }
  1850.     /**
  1851.      * Initializes HTTP request formats.
  1852.      */
  1853.     protected static function initializeFormats()
  1854.     {
  1855.         static::$formats = [
  1856.             'html' => ['text/html', 'application/xhtml+xml'],
  1857.             'txt' => ['text/plain'],
  1858.             'js' => ['application/javascript', 'application/x-javascript', 'text/javascript'],
  1859.             'css' => ['text/css'],
  1860.             'json' => ['application/json', 'application/x-json'],
  1861.             'jsonld' => ['application/ld+json'],
  1862.             'xml' => ['text/xml', 'application/xml', 'application/x-xml'],
  1863.             'rdf' => ['application/rdf+xml'],
  1864.             'atom' => ['application/atom+xml'],
  1865.             'rss' => ['application/rss+xml'],
  1866.             'form' => ['application/x-www-form-urlencoded', 'multipart/form-data'],
  1867.         ];
  1868.     }
  1870.     private function setPhpDefaultLocale(string $locale): void
  1871.     {
  1872.         // if either the class Locale doesn't exist, or an exception is thrown when
  1873.         // setting the default locale, the intl module is not installed, and
  1874.         // the call can be ignored:
  1875.         try {
  1876.             if (class_exists(\Locale::class, false)) {
  1877.                 \Locale::setDefault($locale);
  1878.             }
  1879.         } catch (\Exception) {
  1880.         }
  1881.     }
  1883.     /**
  1884.      * Returns the prefix as encoded in the string when the string starts with
  1885.      * the given prefix, null otherwise.
  1886.      */
  1887.     private function getUrlencodedPrefix(string $string, string $prefix): ?string
  1888.     {
  1889.         if (!str_starts_with(rawurldecode($string), $prefix)) {
  1890.             return null;
  1891.         }
  1893.         $len = \strlen($prefix);
  1895.         if (preg_match(sprintf('#^(%%[[:xdigit:]]{2}|.){%d}#', $len), $string, $match)) {
  1896.             return $match[0];
  1897.         }
  1899.         return null;
  1900.     }
  1902.     private static function createRequestFromFactory(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null): static
  1903.     {
  1904.         if (self::$requestFactory) {
  1905.             $request = (self::$requestFactory)($query, $request, $attributes, $cookies, $files, $server, $content);
  1907.             if (!$request instanceof self) {
  1908.                 throw new \LogicException('The Request factory must return an instance of Symfony\Component\HttpFoundation\Request.');
  1909.             }
  1911.             return $request;
  1912.         }
  1914.         return new static($query, $request, $attributes, $cookies, $files, $server, $content);
  1915.     }
  1917.     /**
  1918.      * Indicates whether this request originated from a trusted proxy.
  1919.      *
  1920.      * This can be useful to determine whether or not to trust the
  1921.      * contents of a proxy-specific header.
  1922.      */
  1923.     public function isFromTrustedProxy(): bool
  1924.     {
  1925.         return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR', ''), self::$trustedProxies);
  1926.     }
  1928.     private function getTrustedValues(int $type, string $ip = null): array
  1929.     {
  1930.         $clientValues = [];
  1931.         $forwardedValues = [];
  1933.         if ((self::$trustedHeaderSet & $type) && $this->headers->has(self::TRUSTED_HEADERS[$type])) {
  1934.             foreach (explode(',', $this->headers->get(self::TRUSTED_HEADERS[$type])) as $v) {
  1935.                 $clientValues[] = (self::HEADER_X_FORWARDED_PORT === $type ? '0.0.0.0:' : '').trim($v);
  1936.             }
  1937.         }
  1939.         if ((self::$trustedHeaderSet & self::HEADER_FORWARDED) && (isset(self::FORWARDED_PARAMS[$type])) && $this->headers->has(self::TRUSTED_HEADERS[self::HEADER_FORWARDED])) {
  1940.             $forwarded = $this->headers->get(self::TRUSTED_HEADERS[self::HEADER_FORWARDED]);
  1941.             $parts = HeaderUtils::split($forwarded, ',;=');
  1942.             $forwardedValues = [];
  1943.             $param = self::FORWARDED_PARAMS[$type];
  1944.             foreach ($parts as $subParts) {
  1945.                 if (null === $v = HeaderUtils::combine($subParts)[$param] ?? null) {
  1946.                     continue;
  1947.                 }
  1948.                 if (self::HEADER_X_FORWARDED_PORT === $type) {
  1949.                     if (str_ends_with($v, ']') || false === $v = strrchr($v, ':')) {
  1950.                         $v = $this->isSecure() ? ':443' : ':80';
  1951.                     }
  1952.                     $v = '0.0.0.0'.$v;
  1953.                 }
  1954.                 $forwardedValues[] = $v;
  1955.             }
  1956.         }
  1958.         if (null !== $ip) {
  1959.             $clientValues = $this->normalizeAndFilterClientIps($clientValues, $ip);
  1960.             $forwardedValues = $this->normalizeAndFilterClientIps($forwardedValues, $ip);
  1961.         }
  1963.         if ($forwardedValues === $clientValues || !$clientValues) {
  1964.             return $forwardedValues;
  1965.         }
  1967.         if (!$forwardedValues) {
  1968.             return $clientValues;
  1969.         }
  1971.         if (!$this->isForwardedValid) {
  1972.             return null !== $ip ? ['0.0.0.0', $ip] : [];
  1973.         }
  1974.         $this->isForwardedValid = false;
  1976.         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]));
  1977.     }
  1979.     private function normalizeAndFilterClientIps(array $clientIps, string $ip): array
  1980.     {
  1981.         if (!$clientIps) {
  1982.             return [];
  1983.         }
  1984.         $clientIps[] = $ip; // Complete the IP chain with the IP the request actually came from
  1985.         $firstTrustedIp = null;
  1987.         foreach ($clientIps as $key => $clientIp) {
  1988.             if (strpos($clientIp, '.')) {
  1989.                 // Strip :port from IPv4 addresses. This is allowed in Forwarded
  1990.                 // and may occur in X-Forwarded-For.
  1991.                 $i = strpos($clientIp, ':');
  1992.                 if ($i) {
  1993.                     $clientIps[$key] = $clientIp = substr($clientIp, 0, $i);
  1994.                 }
  1995.             } elseif (str_starts_with($clientIp, '[')) {
  1996.                 // Strip brackets and :port from IPv6 addresses.
  1997.                 $i = strpos($clientIp, ']', 1);
  1998.                 $clientIps[$key] = $clientIp = substr($clientIp, 1, $i - 1);
  1999.             }
  2001.             if (!filter_var($clientIp, \FILTER_VALIDATE_IP)) {
  2002.                 unset($clientIps[$key]);
  2004.                 continue;
  2005.             }
  2007.             if (IpUtils::checkIp($clientIp, self::$trustedProxies)) {
  2008.                 unset($clientIps[$key]);
  2010.                 // Fallback to this when the client IP falls into the range of trusted proxies
  2011.                 if (null === $firstTrustedIp) {
  2012.                     $firstTrustedIp = $clientIp;
  2013.                 }
  2014.             }
  2015.         }
  2017.         // Now the IP chain contains only untrusted proxies and the client IP
  2018.         return $clientIps ? array_reverse($clientIps) : [$firstTrustedIp];
  2019.     }
  2020. }