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

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