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

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(ParameterBag::class);
  24. class_exists(ServerBag::class);
  26. /**
  27.  * Request represents an HTTP request.
  28.  *
  29.  * The methods dealing with URL accept / return a raw path (% encoded):
  30.  *   * getBasePath
  31.  *   * getBaseUrl
  32.  *   * getPathInfo
  33.  *   * getRequestUri
  34.  *   * getUri
  35.  *   * getUriForPath
  36.  *
  37.  * @author Fabien Potencier <fabien@symfony.com>
  38.  */
  39. class Request
  40. {
  41.     public const HEADER_FORWARDED = 0b00001; // When using RFC 7239
  42.     public const HEADER_X_FORWARDED_FOR = 0b00010;
  43.     public const HEADER_X_FORWARDED_HOST = 0b00100;
  44.     public const HEADER_X_FORWARDED_PROTO = 0b01000;
  45.     public const HEADER_X_FORWARDED_PORT = 0b10000;
  46.     public const HEADER_X_FORWARDED_ALL = 0b11110; // All "X-Forwarded-*" headers
  47.     public const HEADER_X_FORWARDED_AWS_ELB = 0b11010; // AWS ELB doesn't send X-Forwarded-Host
  49.     public const METHOD_HEAD = 'HEAD';
  50.     public const METHOD_GET = 'GET';
  51.     public const METHOD_POST = 'POST';
  52.     public const METHOD_PUT = 'PUT';
  53.     public const METHOD_PATCH = 'PATCH';
  54.     public const METHOD_DELETE = 'DELETE';
  55.     public const METHOD_PURGE = 'PURGE';
  56.     public const METHOD_OPTIONS = 'OPTIONS';
  57.     public const METHOD_TRACE = 'TRACE';
  58.     public const METHOD_CONNECT = 'CONNECT';
  60.     /**
  61.      * @var string[]
  62.      */
  63.     protected static $trustedProxies = [];
  65.     /**
  66.      * @var string[]
  67.      */
  68.     protected static $trustedHostPatterns = [];
  70.     /**
  71.      * @var string[]
  72.      */
  73.     protected static $trustedHosts = [];
  75.     protected static $httpMethodParameterOverride = false;
  77.     /**
  78.      * Custom parameters.
  79.      *
  80.      * @var ParameterBag
  81.      */
  82.     public $attributes;
  84.     /**
  85.      * Request body parameters ($_POST).
  86.      *
  87.      * @var ParameterBag
  88.      */
  89.     public $request;
  91.     /**
  92.      * Query string parameters ($_GET).
  93.      *
  94.      * @var ParameterBag
  95.      */
  96.     public $query;
  98.     /**
  99.      * Server and execution environment parameters ($_SERVER).
  100.      *
  101.      * @var ServerBag
  102.      */
  103.     public $server;
  105.     /**
  106.      * Uploaded files ($_FILES).
  107.      *
  108.      * @var FileBag
  109.      */
  110.     public $files;
  112.     /**
  113.      * Cookies ($_COOKIE).
  114.      *
  115.      * @var ParameterBag
  116.      */
  117.     public $cookies;
  119.     /**
  120.      * Headers (taken from the $_SERVER).
  121.      *
  122.      * @var HeaderBag
  123.      */
  124.     public $headers;
  126.     /**
  127.      * @var string|resource|false|null
  128.      */
  129.     protected $content;
  131.     /**
  132.      * @var array
  133.      */
  134.     protected $languages;
  136.     /**
  137.      * @var array
  138.      */
  139.     protected $charsets;
  141.     /**
  142.      * @var array
  143.      */
  144.     protected $encodings;
  146.     /**
  147.      * @var array
  148.      */
  149.     protected $acceptableContentTypes;
  151.     /**
  152.      * @var string
  153.      */
  154.     protected $pathInfo;
  156.     /**
  157.      * @var string
  158.      */
  159.     protected $requestUri;
  161.     /**
  162.      * @var string
  163.      */
  164.     protected $baseUrl;
  166.     /**
  167.      * @var string
  168.      */
  169.     protected $basePath;
  171.     /**
  172.      * @var string
  173.      */
  174.     protected $method;
  176.     /**
  177.      * @var string
  178.      */
  179.     protected $format;
  181.     /**
  182.      * @var SessionInterface|callable
  183.      */
  184.     protected $session;
  186.     /**
  187.      * @var string
  188.      */
  189.     protected $locale;
  191.     /**
  192.      * @var string
  193.      */
  194.     protected $defaultLocale = 'en';
  196.     /**
  197.      * @var array
  198.      */
  199.     protected static $formats;
  201.     protected static $requestFactory;
  203.     /**
  204.      * @var string|null
  205.      */
  206.     private $preferredFormat;
  207.     private $isHostValid = true;
  208.     private $isForwardedValid = true;
  210.     private static $trustedHeaderSet = -1;
  212.     private const FORWARDED_PARAMS = [
  213.         self::HEADER_X_FORWARDED_FOR => 'for',
  214.         self::HEADER_X_FORWARDED_HOST => 'host',
  215.         self::HEADER_X_FORWARDED_PROTO => 'proto',
  216.         self::HEADER_X_FORWARDED_PORT => 'host',
  217.     ];
  219.     /**
  220.      * Names for headers that can be trusted when
  221.      * using trusted proxies.
  222.      *
  223.      * The FORWARDED header is the standard as of rfc7239.
  224.      *
  225.      * The other headers are non-standard, but widely used
  226.      * by popular reverse proxies (like Apache mod_proxy or Amazon EC2).
  227.      */
  228.     private const TRUSTED_HEADERS = [
  229.         self::HEADER_FORWARDED => 'FORWARDED',
  230.         self::HEADER_X_FORWARDED_FOR => 'X_FORWARDED_FOR',
  231.         self::HEADER_X_FORWARDED_HOST => 'X_FORWARDED_HOST',
  232.         self::HEADER_X_FORWARDED_PROTO => 'X_FORWARDED_PROTO',
  233.         self::HEADER_X_FORWARDED_PORT => 'X_FORWARDED_PORT',
  234.     ];
  236.     /**
  237.      * @param array                $query      The GET parameters
  238.      * @param array                $request    The POST parameters
  239.      * @param array                $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  240.      * @param array                $cookies    The COOKIE parameters
  241.      * @param array                $files      The FILES parameters
  242.      * @param array                $server     The SERVER parameters
  243.      * @param string|resource|null $content    The raw body data
  244.      */
  245.     public function __construct(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
  246.     {
  247.         $this->initialize($query, $request, $attributes, $cookies, $files, $server, $content);
  248.     }
  250.     /**
  251.      * Sets the parameters for this request.
  252.      *
  253.      * This method also re-initializes all properties.
  254.      *
  255.      * @param array                $query      The GET parameters
  256.      * @param array                $request    The POST parameters
  257.      * @param array                $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  258.      * @param array                $cookies    The COOKIE parameters
  259.      * @param array                $files      The FILES parameters
  260.      * @param array                $server     The SERVER parameters
  261.      * @param string|resource|null $content    The raw body data
  262.      */
  263.     public function initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
  264.     {
  265.         $this->request = new ParameterBag($request);
  266.         $this->query = new ParameterBag($query);
  267.         $this->attributes = new ParameterBag($attributes);
  268.         $this->cookies = new ParameterBag($cookies);
  269.         $this->files = new FileBag($files);
  270.         $this->server = new ServerBag($server);
  271.         $this->headers = new HeaderBag($this->server->getHeaders());
  273.         $this->content = $content;
  274.         $this->languages = null;
  275.         $this->charsets = null;
  276.         $this->encodings = null;
  277.         $this->acceptableContentTypes = null;
  278.         $this->pathInfo = null;
  279.         $this->requestUri = null;
  280.         $this->baseUrl = null;
  281.         $this->basePath = null;
  282.         $this->method = null;
  283.         $this->format = null;
  284.     }
  286.     /**
  287.      * Creates a new request with values from PHP's super globals.
  288.      *
  289.      * @return static
  290.      */
  291.     public static function createFromGlobals()
  292.     {
  293.         $request = self::createRequestFromFactory($_GET, $_POST, [], $_COOKIE, $_FILES, $_SERVER);
  295.         if (0 === strpos($request->headers->get('CONTENT_TYPE'), 'application/x-www-form-urlencoded')
  296.             && \in_array(strtoupper($request->server->get('REQUEST_METHOD', 'GET')), ['PUT', 'DELETE', 'PATCH'])
  297.         ) {
  298.             parse_str($request->getContent(), $data);
  299.             $request->request = new ParameterBag($data);
  300.         }
  302.         return $request;
  303.     }
  305.     /**
  306.      * Creates a Request based on a given URI and configuration.
  307.      *
  308.      * The information contained in the URI always take precedence
  309.      * over the other information (server and parameters).
  310.      *
  311.      * @param string               $uri        The URI
  312.      * @param string               $method     The HTTP method
  313.      * @param array                $parameters The query (GET) or request (POST) parameters
  314.      * @param array                $cookies    The request cookies ($_COOKIE)
  315.      * @param array                $files      The request files ($_FILES)
  316.      * @param array                $server     The server parameters ($_SERVER)
  317.      * @param string|resource|null $content    The raw body data
  318.      *
  319.      * @return static
  320.      */
  321.     public static function create($uri, $method = 'GET', $parameters = [], $cookies = [], $files = [], $server = [], $content = null)
  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.         ], $server);
  338.         $server['PATH_INFO'] = '';
  339.         $server['REQUEST_METHOD'] = strtoupper($method);
  341.         $components = parse_url($uri);
  342.         if (isset($components['host'])) {
  343.             $server['SERVER_NAME'] = $components['host'];
  344.             $server['HTTP_HOST'] = $components['host'];
  345.         }
  347.         if (isset($components['scheme'])) {
  348.             if ('https' === $components['scheme']) {
  349.                 $server['HTTPS'] = 'on';
  350.                 $server['SERVER_PORT'] = 443;
  351.             } else {
  352.                 unset($server['HTTPS']);
  353.                 $server['SERVER_PORT'] = 80;
  354.             }
  355.         }
  357.         if (isset($components['port'])) {
  358.             $server['SERVER_PORT'] = $components['port'];
  359.             $server['HTTP_HOST'] .= ':'.$components['port'];
  360.         }
  362.         if (isset($components['user'])) {
  363.             $server['PHP_AUTH_USER'] = $components['user'];
  364.         }
  366.         if (isset($components['pass'])) {
  367.             $server['PHP_AUTH_PW'] = $components['pass'];
  368.         }
  370.         if (!isset($components['path'])) {
  371.             $components['path'] = '/';
  372.         }
  374.         switch (strtoupper($method)) {
  375.             case 'POST':
  376.             case 'PUT':
  377.             case 'DELETE':
  378.                 if (!isset($server['CONTENT_TYPE'])) {
  379.                     $server['CONTENT_TYPE'] = 'application/x-www-form-urlencoded';
  380.                 }
  381.                 // no break
  382.             case 'PATCH':
  383.                 $request = $parameters;
  384.                 $query = [];
  385.                 break;
  386.             default:
  387.                 $request = [];
  388.                 $query = $parameters;
  389.                 break;
  390.         }
  392.         $queryString = '';
  393.         if (isset($components['query'])) {
  394.             parse_str(html_entity_decode($components['query']), $qs);
  396.             if ($query) {
  397.                 $query = array_replace($qs, $query);
  398.                 $queryString = http_build_query($query, '', '&');
  399.             } else {
  400.                 $query = $qs;
  401.                 $queryString = $components['query'];
  402.             }
  403.         } elseif ($query) {
  404.             $queryString = http_build_query($query, '', '&');
  405.         }
  407.         $server['REQUEST_URI'] = $components['path'].('' !== $queryString ? '?'.$queryString : '');
  408.         $server['QUERY_STRING'] = $queryString;
  410.         return self::createRequestFromFactory($query, $request, [], $cookies, $files, $server, $content);
  411.     }
  413.     /**
  414.      * Sets a callable able to create a Request instance.
  415.      *
  416.      * This is mainly useful when you need to override the Request class
  417.      * to keep BC with an existing system. It should not be used for any
  418.      * other purpose.
  419.      *
  420.      * @param callable|null $callable A PHP callable
  421.      */
  422.     public static function setFactory($callable)
  423.     {
  424.         self::$requestFactory = $callable;
  425.     }
  427.     /**
  428.      * Clones a request and overrides some of its parameters.
  429.      *
  430.      * @param array $query      The GET parameters
  431.      * @param array $request    The POST parameters
  432.      * @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
  433.      * @param array $cookies    The COOKIE parameters
  434.      * @param array $files      The FILES parameters
  435.      * @param array $server     The SERVER parameters
  436.      *
  437.      * @return static
  438.      */
  439.     public function duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)
  440.     {
  441.         $dup = clone $this;
  442.         if (null !== $query) {
  443.             $dup->query = new ParameterBag($query);
  444.         }
  445.         if (null !== $request) {
  446.             $dup->request = new ParameterBag($request);
  447.         }
  448.         if (null !== $attributes) {
  449.             $dup->attributes = new ParameterBag($attributes);
  450.         }
  451.         if (null !== $cookies) {
  452.             $dup->cookies = new ParameterBag($cookies);
  453.         }
  454.         if (null !== $files) {
  455.             $dup->files = new FileBag($files);
  456.         }
  457.         if (null !== $server) {
  458.             $dup->server = new ServerBag($server);
  459.             $dup->headers = new HeaderBag($dup->server->getHeaders());
  460.         }
  461.         $dup->languages = null;
  462.         $dup->charsets = null;
  463.         $dup->encodings = null;
  464.         $dup->acceptableContentTypes = null;
  465.         $dup->pathInfo = null;
  466.         $dup->requestUri = null;
  467.         $dup->baseUrl = null;
  468.         $dup->basePath = null;
  469.         $dup->method = null;
  470.         $dup->format = null;
  472.         if (!$dup->get('_format') && $this->get('_format')) {
  473.             $dup->attributes->set('_format', $this->get('_format'));
  474.         }
  476.         if (!$dup->getRequestFormat(null)) {
  477.             $dup->setRequestFormat($this->getRequestFormat(null));
  478.         }
  480.         return $dup;
  481.     }
  483.     /**
  484.      * Clones the current request.
  485.      *
  486.      * Note that the session is not cloned as duplicated requests
  487.      * are most of the time sub-requests of the main one.
  488.      */
  489.     public function __clone()
  490.     {
  491.         $this->query = clone $this->query;
  492.         $this->request = clone $this->request;
  493.         $this->attributes = clone $this->attributes;
  494.         $this->cookies = clone $this->cookies;
  495.         $this->files = clone $this->files;
  496.         $this->server = clone $this->server;
  497.         $this->headers = clone $this->headers;
  498.     }
  500.     /**
  501.      * Returns the request as a string.
  502.      *
  503.      * @return string The request
  504.      */
  505.     public function __toString()
  506.     {
  507.         $content = $this->getContent();
  509.         $cookieHeader = '';
  510.         $cookies = [];
  512.         foreach ($this->cookies as $k => $v) {
  513.             $cookies[] = $k.'='.$v;
  514.         }
  516.         if (!empty($cookies)) {
  517.             $cookieHeader = 'Cookie: '.implode('; ', $cookies)."\r\n";
  518.         }
  520.         return
  521.             sprintf('%s %s %s', $this->getMethod(), $this->getRequestUri(), $this->server->get('SERVER_PROTOCOL'))."\r\n".
  522.             $this->headers.
  523.             $cookieHeader."\r\n".
  524.             $content;
  525.     }
  527.     /**
  528.      * Overrides the PHP global variables according to this request instance.
  529.      *
  530.      * It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE.
  531.      * $_FILES is never overridden, see rfc1867
  532.      */
  533.     public function overrideGlobals()
  534.     {
  535.         $this->server->set('QUERY_STRING', static::normalizeQueryString(http_build_query($this->query->all(), '', '&')));
  537.         $_GET = $this->query->all();
  538.         $_POST = $this->request->all();
  539.         $_SERVER = $this->server->all();
  540.         $_COOKIE = $this->cookies->all();
  542.         foreach ($this->headers->all() as $key => $value) {
  543.             $key = strtoupper(str_replace('-', '_', $key));
  544.             if (\in_array($key, ['CONTENT_TYPE', 'CONTENT_LENGTH', 'CONTENT_MD5'], true)) {
  545.                 $_SERVER[$key] = implode(', ', $value);
  546.             } else {
  547.                 $_SERVER['HTTP_'.$key] = implode(', ', $value);
  548.             }
  549.         }
  551.         $request = ['g' => $_GET, 'p' => $_POST, 'c' => $_COOKIE];
  553.         $requestOrder = ini_get('request_order') ?: ini_get('variables_order');
  554.         $requestOrder = preg_replace('#[^cgp]#', '', strtolower($requestOrder)) ?: 'gp';
  556.         $_REQUEST = [[]];
  558.         foreach (str_split($requestOrder) as $order) {
  559.             $_REQUEST[] = $request[$order];
  560.         }
  562.         $_REQUEST = array_merge(...$_REQUEST);
  563.     }
  565.     /**
  566.      * Sets a list of trusted proxies.
  567.      *
  568.      * You should only list the reverse proxies that you manage directly.
  569.      *
  570.      * @param array $proxies          A list of trusted proxies, the string 'REMOTE_ADDR' will be replaced with $_SERVER['REMOTE_ADDR']
  571.      * @param int   $trustedHeaderSet A bit field of Request::HEADER_*, to set which headers to trust from your proxies
  572.      */
  573.     public static function setTrustedProxies(array $proxies, int $trustedHeaderSet)
  574.     {
  575.         self::$trustedProxies = array_reduce($proxies, function ($proxies, $proxy) {
  576.             if ('REMOTE_ADDR' !== $proxy) {
  577.                 $proxies[] = $proxy;
  578.             } elseif (isset($_SERVER['REMOTE_ADDR'])) {
  579.                 $proxies[] = $_SERVER['REMOTE_ADDR'];
  580.             }
  582.             return $proxies;
  583.         }, []);
  584.         self::$trustedHeaderSet = $trustedHeaderSet;
  585.     }
  587.     /**
  588.      * Gets the list of trusted proxies.
  589.      *
  590.      * @return array An array of trusted proxies
  591.      */
  592.     public static function getTrustedProxies()
  593.     {
  594.         return self::$trustedProxies;
  595.     }
  597.     /**
  598.      * Gets the set of trusted headers from trusted proxies.
  599.      *
  600.      * @return int A bit field of Request::HEADER_* that defines which headers are trusted from your proxies
  601.      */
  602.     public static function getTrustedHeaderSet()
  603.     {
  604.         return self::$trustedHeaderSet;
  605.     }
  607.     /**
  608.      * Sets a list of trusted host patterns.
  609.      *
  610.      * You should only list the hosts you manage using regexs.
  611.      *
  612.      * @param array $hostPatterns A list of trusted host patterns
  613.      */
  614.     public static function setTrustedHosts(array $hostPatterns)
  615.     {
  616.         self::$trustedHostPatterns = array_map(function ($hostPattern) {
  617.             return sprintf('{%s}i', $hostPattern);
  618.         }, $hostPatterns);
  619.         // we need to reset trusted hosts on trusted host patterns change
  620.         self::$trustedHosts = [];
  621.     }
  623.     /**
  624.      * Gets the list of trusted host patterns.
  625.      *
  626.      * @return array An array of trusted host patterns
  627.      */
  628.     public static function getTrustedHosts()
  629.     {
  630.         return self::$trustedHostPatterns;
  631.     }
  633.     /**
  634.      * Normalizes a query string.
  635.      *
  636.      * It builds a normalized query string, where keys/value pairs are alphabetized,
  637.      * have consistent escaping and unneeded delimiters are removed.
  638.      *
  639.      * @param string $qs Query string
  640.      *
  641.      * @return string A normalized query string for the Request
  642.      */
  643.     public static function normalizeQueryString($qs)
  644.     {
  645.         if ('' === ($qs ?? '')) {
  646.             return '';
  647.         }
  649.         parse_str($qs, $qs);
  650.         ksort($qs);
  652.         return http_build_query($qs, '', '&', \PHP_QUERY_RFC3986);
  653.     }
  655.     /**
  656.      * Enables support for the _method request parameter to determine the intended HTTP method.
  657.      *
  658.      * Be warned that enabling this feature might lead to CSRF issues in your code.
  659.      * Check that you are using CSRF tokens when required.
  660.      * If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered
  661.      * and used to send a "PUT" or "DELETE" request via the _method request parameter.
  662.      * If these methods are not protected against CSRF, this presents a possible vulnerability.
  663.      *
  664.      * The HTTP method can only be overridden when the real HTTP method is POST.
  665.      */
  666.     public static function enableHttpMethodParameterOverride()
  667.     {
  668.         self::$httpMethodParameterOverride = true;
  669.     }
  671.     /**
  672.      * Checks whether support for the _method request parameter is enabled.
  673.      *
  674.      * @return bool True when the _method request parameter is enabled, false otherwise
  675.      */
  676.     public static function getHttpMethodParameterOverride()
  677.     {
  678.         return self::$httpMethodParameterOverride;
  679.     }
  681.     /**
  682.      * Gets a "parameter" value from any bag.
  683.      *
  684.      * This method is mainly useful for libraries that want to provide some flexibility. If you don't need the
  685.      * flexibility in controllers, it is better to explicitly get request parameters from the appropriate
  686.      * public property instead (attributes, query, request).
  687.      *
  688.      * Order of precedence: PATH (routing placeholders or custom attributes), GET, BODY
  689.      *
  690.      * @param string $key     The key
  691.      * @param mixed  $default The default value if the parameter key does not exist
  692.      *
  693.      * @return mixed
  694.      */
  695.     public function get($key, $default = null)
  696.     {
  697.         if ($this !== $result = $this->attributes->get($key, $this)) {
  698.             return $result;
  699.         }
  701.         if ($this !== $result = $this->query->get($key, $this)) {
  702.             return $result;
  703.         }
  705.         if ($this !== $result = $this->request->get($key, $this)) {
  706.             return $result;
  707.         }
  709.         return $default;
  710.     }
  712.     /**
  713.      * Gets the Session.
  714.      *
  715.      * @return SessionInterface The session
  716.      */
  717.     public function getSession()
  718.     {
  719.         $session = $this->session;
  720.         if (!$session instanceof SessionInterface && null !== $session) {
  721.             $this->setSession($session = $session());
  722.         }
  724.         if (null === $session) {
  725.             @trigger_error(sprintf('Calling "%s()" when no session has been set is deprecated since Symfony 4.1 and will throw an exception in 5.0. Use "hasSession()" instead.', __METHOD__), \E_USER_DEPRECATED);
  726.             // throw new \BadMethodCallException('Session has not been set.');
  727.         }
  729.         return $session;
  730.     }
  732.     /**
  733.      * Whether the request contains a Session which was started in one of the
  734.      * previous requests.
  735.      *
  736.      * @return bool
  737.      */
  738.     public function hasPreviousSession()
  739.     {
  740.         // the check for $this->session avoids malicious users trying to fake a session cookie with proper name
  741.         return $this->hasSession() && $this->cookies->has($this->getSession()->getName());
  742.     }
  744.     /**
  745.      * Whether the request contains a Session object.
  746.      *
  747.      * This method does not give any information about the state of the session object,
  748.      * like whether the session is started or not. It is just a way to check if this Request
  749.      * is associated with a Session instance.
  750.      *
  751.      * @return bool true when the Request contains a Session object, false otherwise
  752.      */
  753.     public function hasSession()
  754.     {
  755.         return null !== $this->session;
  756.     }
  758.     public function setSession(SessionInterface $session)
  759.     {
  760.         $this->session = $session;
  761.     }
  763.     /**
  764.      * @internal
  765.      */
  766.     public function setSessionFactory(callable $factory)
  767.     {
  768.         $this->session = $factory;
  769.     }
  771.     /**
  772.      * Returns the client IP addresses.
  773.      *
  774.      * In the returned array the most trusted IP address is first, and the
  775.      * least trusted one last. The "real" client IP address is the last one,
  776.      * but this is also the least trusted one. Trusted proxies are stripped.
  777.      *
  778.      * Use this method carefully; you should use getClientIp() instead.
  779.      *
  780.      * @return array The client IP addresses
  781.      *
  782.      * @see getClientIp()
  783.      */
  784.     public function getClientIps()
  785.     {
  786.         $ip = $this->server->get('REMOTE_ADDR');
  788.         if (!$this->isFromTrustedProxy()) {
  789.             return [$ip];
  790.         }
  792.         return $this->getTrustedValues(self::HEADER_X_FORWARDED_FOR, $ip) ?: [$ip];
  793.     }
  795.     /**
  796.      * Returns the client IP address.
  797.      *
  798.      * This method can read the client IP address from the "X-Forwarded-For" header
  799.      * when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For"
  800.      * header value is a comma+space separated list of IP addresses, the left-most
  801.      * being the original client, and each successive proxy that passed the request
  802.      * adding the IP address where it received the request from.
  803.      *
  804.      * If your reverse proxy uses a different header name than "X-Forwarded-For",
  805.      * ("Client-Ip" for instance), configure it via the $trustedHeaderSet
  806.      * argument of the Request::setTrustedProxies() method instead.
  807.      *
  808.      * @return string|null The client IP address
  809.      *
  810.      * @see getClientIps()
  811.      * @see https://wikipedia.org/wiki/X-Forwarded-For
  812.      */
  813.     public function getClientIp()
  814.     {
  815.         $ipAddresses = $this->getClientIps();
  817.         return $ipAddresses[0];
  818.     }
  820.     /**
  821.      * Returns current script name.
  822.      *
  823.      * @return string
  824.      */
  825.     public function getScriptName()
  826.     {
  827.         return $this->server->get('SCRIPT_NAME', $this->server->get('ORIG_SCRIPT_NAME', ''));
  828.     }
  830.     /**
  831.      * Returns the path being requested relative to the executed script.
  832.      *
  833.      * The path info always starts with a /.
  834.      *
  835.      * Suppose this request is instantiated from /mysite on localhost:
  836.      *
  837.      *  * http://localhost/mysite              returns an empty string
  838.      *  * http://localhost/mysite/about        returns '/about'
  839.      *  * http://localhost/mysite/enco%20ded   returns '/enco%20ded'
  840.      *  * http://localhost/mysite/about?var=1  returns '/about'
  841.      *
  842.      * @return string The raw path (i.e. not urldecoded)
  843.      */
  844.     public function getPathInfo()
  845.     {
  846.         if (null === $this->pathInfo) {
  847.             $this->pathInfo = $this->preparePathInfo();
  848.         }
  850.         return $this->pathInfo;
  851.     }
  853.     /**
  854.      * Returns the root path from which this request is executed.
  855.      *
  856.      * Suppose that an index.php file instantiates this request object:
  857.      *
  858.      *  * http://localhost/index.php         returns an empty string
  859.      *  * http://localhost/index.php/page    returns an empty string
  860.      *  * http://localhost/web/index.php     returns '/web'
  861.      *  * http://localhost/we%20b/index.php  returns '/we%20b'
  862.      *
  863.      * @return string The raw path (i.e. not urldecoded)
  864.      */
  865.     public function getBasePath()
  866.     {
  867.         if (null === $this->basePath) {
  868.             $this->basePath = $this->prepareBasePath();
  869.         }
  871.         return $this->basePath;
  872.     }
  874.     /**
  875.      * Returns the root URL from which this request is executed.
  876.      *
  877.      * The base URL never ends with a /.
  878.      *
  879.      * This is similar to getBasePath(), except that it also includes the
  880.      * script filename (e.g. index.php) if one exists.
  881.      *
  882.      * @return string The raw URL (i.e. not urldecoded)
  883.      */
  884.     public function getBaseUrl()
  885.     {
  886.         if (null === $this->baseUrl) {
  887.             $this->baseUrl = $this->prepareBaseUrl();
  888.         }
  890.         return $this->baseUrl;
  891.     }
  893.     /**
  894.      * Gets the request's scheme.
  895.      *
  896.      * @return string
  897.      */
  898.     public function getScheme()
  899.     {
  900.         return $this->isSecure() ? 'https' : 'http';
  901.     }
  903.     /**
  904.      * Returns the port on which the request is made.
  905.      *
  906.      * This method can read the client port from the "X-Forwarded-Port" header
  907.      * when trusted proxies were set via "setTrustedProxies()".
  908.      *
  909.      * The "X-Forwarded-Port" header must contain the client port.
  910.      *
  911.      * @return int|string can be a string if fetched from the server bag
  912.      */
  913.     public function getPort()
  914.     {
  915.         if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_PORT)) {
  916.             $host = $host[0];
  917.         } elseif ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
  918.             $host = $host[0];
  919.         } elseif (!$host = $this->headers->get('HOST')) {
  920.             return $this->server->get('SERVER_PORT');
  921.         }
  923.         if ('[' === $host[0]) {
  924.             $pos = strpos($host, ':', strrpos($host, ']'));
  925.         } else {
  926.             $pos = strrpos($host, ':');
  927.         }
  929.         if (false !== $pos && $port = substr($host, $pos + 1)) {
  930.             return (int) $port;
  931.         }
  933.         return 'https' === $this->getScheme() ? 443 : 80;
  934.     }
  936.     /**
  937.      * Returns the user.
  938.      *
  939.      * @return string|null
  940.      */
  941.     public function getUser()
  942.     {
  943.         return $this->headers->get('PHP_AUTH_USER');
  944.     }
  946.     /**
  947.      * Returns the password.
  948.      *
  949.      * @return string|null
  950.      */
  951.     public function getPassword()
  952.     {
  953.         return $this->headers->get('PHP_AUTH_PW');
  954.     }
  956.     /**
  957.      * Gets the user info.
  958.      *
  959.      * @return string A user name and, optionally, scheme-specific information about how to gain authorization to access the server
  960.      */
  961.     public function getUserInfo()
  962.     {
  963.         $userinfo = $this->getUser();
  965.         $pass = $this->getPassword();
  966.         if ('' != $pass) {
  967.             $userinfo .= ":$pass";
  968.         }
  970.         return $userinfo;
  971.     }
  973.     /**
  974.      * Returns the HTTP host being requested.
  975.      *
  976.      * The port name will be appended to the host if it's non-standard.
  977.      *
  978.      * @return string
  979.      */
  980.     public function getHttpHost()
  981.     {
  982.         $scheme = $this->getScheme();
  983.         $port = $this->getPort();
  985.         if (('http' == $scheme && 80 == $port) || ('https' == $scheme && 443 == $port)) {
  986.             return $this->getHost();
  987.         }
  989.         return $this->getHost().':'.$port;
  990.     }
  992.     /**
  993.      * Returns the requested URI (path and query string).
  994.      *
  995.      * @return string The raw URI (i.e. not URI decoded)
  996.      */
  997.     public function getRequestUri()
  998.     {
  999.         if (null === $this->requestUri) {
  1000.             $this->requestUri = $this->prepareRequestUri();
  1001.         }
  1003.         return $this->requestUri;
  1004.     }
  1006.     /**
  1007.      * Gets the scheme and HTTP host.
  1008.      *
  1009.      * If the URL was called with basic authentication, the user
  1010.      * and the password are not added to the generated string.
  1011.      *
  1012.      * @return string The scheme and HTTP host
  1013.      */
  1014.     public function getSchemeAndHttpHost()
  1015.     {
  1016.         return $this->getScheme().'://'.$this->getHttpHost();
  1017.     }
  1019.     /**
  1020.      * Generates a normalized URI (URL) for the Request.
  1021.      *
  1022.      * @return string A normalized URI (URL) for the Request
  1023.      *
  1024.      * @see getQueryString()
  1025.      */
  1026.     public function getUri()
  1027.     {
  1028.         if (null !== $qs = $this->getQueryString()) {
  1029.             $qs = '?'.$qs;
  1030.         }
  1032.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$this->getPathInfo().$qs;
  1033.     }
  1035.     /**
  1036.      * Generates a normalized URI for the given path.
  1037.      *
  1038.      * @param string $path A path to use instead of the current one
  1039.      *
  1040.      * @return string The normalized URI for the path
  1041.      */
  1042.     public function getUriForPath($path)
  1043.     {
  1044.         return $this->getSchemeAndHttpHost().$this->getBaseUrl().$path;
  1045.     }
  1047.     /**
  1048.      * Returns the path as relative reference from the current Request path.
  1049.      *
  1050.      * Only the URIs path component (no schema, host etc.) is relevant and must be given.
  1051.      * Both paths must be absolute and not contain relative parts.
  1052.      * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
  1053.      * Furthermore, they can be used to reduce the link size in documents.
  1054.      *
  1055.      * Example target paths, given a base path of "/a/b/c/d":
  1056.      * - "/a/b/c/d"     -> ""
  1057.      * - "/a/b/c/"      -> "./"
  1058.      * - "/a/b/"        -> "../"
  1059.      * - "/a/b/c/other" -> "other"
  1060.      * - "/a/x/y"       -> "../../x/y"
  1061.      *
  1062.      * @param string $path The target path
  1063.      *
  1064.      * @return string The relative target path
  1065.      */
  1066.     public function getRelativeUriForPath($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.      * @param string $method
  1206.      */
  1207.     public function setMethod($method)
  1208.     {
  1209.         $this->method = null;
  1210.         $this->server->set('REQUEST_METHOD', $method);
  1211.     }
  1213.     /**
  1214.      * Gets the request "intended" method.
  1215.      *
  1216.      * If the X-HTTP-Method-Override header is set, and if the method is a POST,
  1217.      * then it is used to determine the "real" intended HTTP method.
  1218.      *
  1219.      * The _method request parameter can also be used to determine the HTTP method,
  1220.      * but only if enableHttpMethodParameterOverride() has been called.
  1221.      *
  1222.      * The method is always an uppercased string.
  1223.      *
  1224.      * @return string The request method
  1225.      *
  1226.      * @see getRealMethod()
  1227.      */
  1228.     public function getMethod()
  1229.     {
  1230.         if (null !== $this->method) {
  1231.             return $this->method;
  1232.         }
  1234.         $this->method = strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1236.         if ('POST' !== $this->method) {
  1237.             return $this->method;
  1238.         }
  1240.         $method = $this->headers->get('X-HTTP-METHOD-OVERRIDE');
  1242.         if (!$method && self::$httpMethodParameterOverride) {
  1243.             $method = $this->request->get('_method', $this->query->get('_method', 'POST'));
  1244.         }
  1246.         if (!\is_string($method)) {
  1247.             return $this->method;
  1248.         }
  1250.         $method = strtoupper($method);
  1252.         if (\in_array($method, ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'PATCH', 'PURGE', 'TRACE'], true)) {
  1253.             return $this->method = $method;
  1254.         }
  1256.         if (!preg_match('/^[A-Z]++$/D', $method)) {
  1257.             throw new SuspiciousOperationException(sprintf('Invalid method override "%s".', $method));
  1258.         }
  1260.         return $this->method = $method;
  1261.     }
  1263.     /**
  1264.      * Gets the "real" request method.
  1265.      *
  1266.      * @return string The request method
  1267.      *
  1268.      * @see getMethod()
  1269.      */
  1270.     public function getRealMethod()
  1271.     {
  1272.         return strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
  1273.     }
  1275.     /**
  1276.      * Gets the mime type associated with the format.
  1277.      *
  1278.      * @param string $format The format
  1279.      *
  1280.      * @return string|null The associated mime type (null if not found)
  1281.      */
  1282.     public function getMimeType($format)
  1283.     {
  1284.         if (null === static::$formats) {
  1285.             static::initializeFormats();
  1286.         }
  1288.         return isset(static::$formats[$format]) ? static::$formats[$format][0] : null;
  1289.     }
  1291.     /**
  1292.      * Gets the mime types associated with the format.
  1293.      *
  1294.      * @param string $format The format
  1295.      *
  1296.      * @return array The associated mime types
  1297.      */
  1298.     public static function getMimeTypes($format)
  1299.     {
  1300.         if (null === static::$formats) {
  1301.             static::initializeFormats();
  1302.         }
  1304.         return static::$formats[$format] ?? [];
  1305.     }
  1307.     /**
  1308.      * Gets the format associated with the mime type.
  1309.      *
  1310.      * @param string $mimeType The associated mime type
  1311.      *
  1312.      * @return string|null The format (null if not found)
  1313.      */
  1314.     public function getFormat($mimeType)
  1315.     {
  1316.         $canonicalMimeType = null;
  1317.         if (false !== $pos = strpos($mimeType, ';')) {
  1318.             $canonicalMimeType = trim(substr($mimeType, 0, $pos));
  1319.         }
  1321.         if (null === static::$formats) {
  1322.             static::initializeFormats();
  1323.         }
  1325.         foreach (static::$formats as $format => $mimeTypes) {
  1326.             if (\in_array($mimeType, (array) $mimeTypes)) {
  1327.                 return $format;
  1328.             }
  1329.             if (null !== $canonicalMimeType && \in_array($canonicalMimeType, (array) $mimeTypes)) {
  1330.                 return $format;
  1331.             }
  1332.         }
  1334.         return null;
  1335.     }
  1337.     /**
  1338.      * Associates a format with mime types.
  1339.      *
  1340.      * @param string       $format    The format
  1341.      * @param string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
  1342.      */
  1343.     public function setFormat($format, $mimeTypes)
  1344.     {
  1345.         if (null === static::$formats) {
  1346.             static::initializeFormats();
  1347.         }
  1349.         static::$formats[$format] = \is_array($mimeTypes) ? $mimeTypes : [$mimeTypes];
  1350.     }
  1352.     /**
  1353.      * Gets the request format.
  1354.      *
  1355.      * Here is the process to determine the format:
  1356.      *
  1357.      *  * format defined by the user (with setRequestFormat())
  1358.      *  * _format request attribute
  1359.      *  * $default
  1360.      *
  1361.      * @see getPreferredFormat
  1362.      *
  1363.      * @param string|null $default The default format
  1364.      *
  1365.      * @return string|null The request format
  1366.      */
  1367.     public function getRequestFormat($default = 'html')
  1368.     {
  1369.         if (null === $this->format) {
  1370.             $this->format = $this->attributes->get('_format');
  1371.         }
  1373.         return null === $this->format ? $default : $this->format;
  1374.     }
  1376.     /**
  1377.      * Sets the request format.
  1378.      *
  1379.      * @param string $format The request format
  1380.      */
  1381.     public function setRequestFormat($format)
  1382.     {
  1383.         $this->format = $format;
  1384.     }
  1386.     /**
  1387.      * Gets the format associated with the request.
  1388.      *
  1389.      * @return string|null The format (null if no content type is present)
  1390.      */
  1391.     public function getContentType()
  1392.     {
  1393.         return $this->getFormat($this->headers->get('CONTENT_TYPE'));
  1394.     }
  1396.     /**
  1397.      * Sets the default locale.
  1398.      *
  1399.      * @param string $locale
  1400.      */
  1401.     public function setDefaultLocale($locale)
  1402.     {
  1403.         $this->defaultLocale = $locale;
  1405.         if (null === $this->locale) {
  1406.             $this->setPhpDefaultLocale($locale);
  1407.         }
  1408.     }
  1410.     /**
  1411.      * Get the default locale.
  1412.      *
  1413.      * @return string
  1414.      */
  1415.     public function getDefaultLocale()
  1416.     {
  1417.         return $this->defaultLocale;
  1418.     }
  1420.     /**
  1421.      * Sets the locale.
  1422.      *
  1423.      * @param string $locale
  1424.      */
  1425.     public function setLocale($locale)
  1426.     {
  1427.         $this->setPhpDefaultLocale($this->locale = $locale);
  1428.     }
  1430.     /**
  1431.      * Get the locale.
  1432.      *
  1433.      * @return string
  1434.      */
  1435.     public function getLocale()
  1436.     {
  1437.         return null === $this->locale ? $this->defaultLocale : $this->locale;
  1438.     }
  1440.     /**
  1441.      * Checks if the request method is of specified type.
  1442.      *
  1443.      * @param string $method Uppercase request method (GET, POST etc)
  1444.      *
  1445.      * @return bool
  1446.      */
  1447.     public function isMethod($method)
  1448.     {
  1449.         return $this->getMethod() === strtoupper($method);
  1450.     }
  1452.     /**
  1453.      * Checks whether or not the method is safe.
  1454.      *
  1455.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
  1456.      *
  1457.      * @return bool
  1458.      */
  1459.     public function isMethodSafe()
  1460.     {
  1461.         if (\func_num_args() > 0) {
  1462.             @trigger_error(sprintf('Passing arguments to "%s()" has been deprecated since Symfony 4.4; use "%s::isMethodCacheable()" to check if the method is cacheable instead.', __METHOD__, __CLASS__), \E_USER_DEPRECATED);
  1463.         }
  1465.         return \in_array($this->getMethod(), ['GET', 'HEAD', 'OPTIONS', 'TRACE']);
  1466.     }
  1468.     /**
  1469.      * Checks whether or not the method is idempotent.
  1470.      *
  1471.      * @return bool
  1472.      */
  1473.     public function isMethodIdempotent()
  1474.     {
  1475.         return \in_array($this->getMethod(), ['HEAD', 'GET', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'PURGE']);
  1476.     }
  1478.     /**
  1479.      * Checks whether the method is cacheable or not.
  1480.      *
  1481.      * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
  1482.      *
  1483.      * @return bool True for GET and HEAD, false otherwise
  1484.      */
  1485.     public function isMethodCacheable()
  1486.     {
  1487.         return \in_array($this->getMethod(), ['GET', 'HEAD']);
  1488.     }
  1490.     /**
  1491.      * Returns the protocol version.
  1492.      *
  1493.      * If the application is behind a proxy, the protocol version used in the
  1494.      * requests between the client and the proxy and between the proxy and the
  1495.      * server might be different. This returns the former (from the "Via" header)
  1496.      * if the proxy is trusted (see "setTrustedProxies()"), otherwise it returns
  1497.      * the latter (from the "SERVER_PROTOCOL" server parameter).
  1498.      *
  1499.      * @return string
  1500.      */
  1501.     public function getProtocolVersion()
  1502.     {
  1503.         if ($this->isFromTrustedProxy()) {
  1504.             preg_match('~^(HTTP/)?([1-9]\.[0-9]) ~', $this->headers->get('Via'), $matches);
  1506.             if ($matches) {
  1507.                 return 'HTTP/'.$matches[2];
  1508.             }
  1509.         }
  1511.         return $this->server->get('SERVER_PROTOCOL');
  1512.     }
  1514.     /**
  1515.      * Returns the request body content.
  1516.      *
  1517.      * @param bool $asResource If true, a resource will be returned
  1518.      *
  1519.      * @return string|resource The request body content or a resource to read the body stream
  1520.      */
  1521.     public function getContent($asResource = false)
  1522.     {
  1523.         $currentContentIsResource = \is_resource($this->content);
  1525.         if (true === $asResource) {
  1526.             if ($currentContentIsResource) {
  1527.                 rewind($this->content);
  1529.                 return $this->content;
  1530.             }
  1532.             // Content passed in parameter (test)
  1533.             if (\is_string($this->content)) {
  1534.                 $resource = fopen('php://temp', 'r+');
  1535.                 fwrite($resource, $this->content);
  1536.                 rewind($resource);
  1538.                 return $resource;
  1539.             }
  1541.             $this->content = false;
  1543.             return fopen('php://input', 'r');
  1544.         }
  1546.         if ($currentContentIsResource) {
  1547.             rewind($this->content);
  1549.             return stream_get_contents($this->content);
  1550.         }
  1552.         if (null === $this->content || false === $this->content) {
  1553.             $this->content = file_get_contents('php://input');
  1554.         }
  1556.         return $this->content;
  1557.     }
  1559.     /**
  1560.      * Gets the Etags.
  1561.      *
  1562.      * @return array The entity tags
  1563.      */
  1564.     public function getETags()
  1565.     {
  1566.         return preg_split('/\s*,\s*/', $this->headers->get('if_none_match'), null, \PREG_SPLIT_NO_EMPTY);
  1567.     }
  1569.     /**
  1570.      * @return bool
  1571.      */
  1572.     public function isNoCache()
  1573.     {
  1574.         return $this->headers->hasCacheControlDirective('no-cache') || 'no-cache' == $this->headers->get('Pragma');
  1575.     }
  1577.     /**
  1578.      * Gets the preferred format for the response by inspecting, in the following order:
  1579.      *   * the request format set using setRequestFormat
  1580.      *   * the values of the Accept HTTP header.
  1581.      *
  1582.      * Note that if you use this method, you should send the "Vary: Accept" header
  1583.      * in the response to prevent any issues with intermediary HTTP caches.
  1584.      */
  1585.     public function getPreferredFormat(?string $default = 'html'): ?string
  1586.     {
  1587.         if (null !== $this->preferredFormat || null !== $this->preferredFormat = $this->getRequestFormat(null)) {
  1588.             return $this->preferredFormat;
  1589.         }
  1591.         foreach ($this->getAcceptableContentTypes() as $mimeType) {
  1592.             if ($this->preferredFormat = $this->getFormat($mimeType)) {
  1593.                 return $this->preferredFormat;
  1594.             }
  1595.         }
  1597.         return $default;
  1598.     }
  1600.     /**
  1601.      * Returns the preferred language.
  1602.      *
  1603.      * @param string[] $locales An array of ordered available locales
  1604.      *
  1605.      * @return string|null The preferred locale
  1606.      */
  1607.     public function getPreferredLanguage(array $locales = null)
  1608.     {
  1609.         $preferredLanguages = $this->getLanguages();
  1611.         if (empty($locales)) {
  1612.             return $preferredLanguages[0] ?? null;
  1613.         }
  1615.         if (!$preferredLanguages) {
  1616.             return $locales[0];
  1617.         }
  1619.         $extendedPreferredLanguages = [];
  1620.         foreach ($preferredLanguages as $language) {
  1621.             $extendedPreferredLanguages[] = $language;
  1622.             if (false !== $position = strpos($language, '_')) {
  1623.                 $superLanguage = substr($language, 0, $position);
  1624.                 if (!\in_array($superLanguage, $preferredLanguages)) {
  1625.                     $extendedPreferredLanguages[] = $superLanguage;
  1626.                 }
  1627.             }
  1628.         }
  1630.         $preferredLanguages = array_values(array_intersect($extendedPreferredLanguages, $locales));
  1632.         return $preferredLanguages[0] ?? $locales[0];
  1633.     }
  1635.     /**
  1636.      * Gets a list of languages acceptable by the client browser.
  1637.      *
  1638.      * @return array Languages ordered in the user browser preferences
  1639.      */
  1640.     public function getLanguages()
  1641.     {
  1642.         if (null !== $this->languages) {
  1643.             return $this->languages;
  1644.         }
  1646.         $languages = AcceptHeader::fromString($this->headers->get('Accept-Language'))->all();
  1647.         $this->languages = [];
  1648.         foreach ($languages as $lang => $acceptHeaderItem) {
  1649.             if (false !== strpos($lang, '-')) {
  1650.                 $codes = explode('-', $lang);
  1651.                 if ('i' === $codes[0]) {
  1652.                     // Language not listed in ISO 639 that are not variants
  1653.                     // of any listed language, which can be registered with the
  1654.                     // i-prefix, such as i-cherokee
  1655.                     if (\count($codes) > 1) {
  1656.                         $lang = $codes[1];
  1657.                     }
  1658.                 } else {
  1659.                     for ($i = 0, $max = \count($codes); $i < $max; ++$i) {
  1660.                         if (0 === $i) {
  1661.                             $lang = strtolower($codes[0]);
  1662.                         } else {
  1663.                             $lang .= '_'.strtoupper($codes[$i]);
  1664.                         }
  1665.                     }
  1666.                 }
  1667.             }
  1669.             $this->languages[] = $lang;
  1670.         }
  1672.         return $this->languages;
  1673.     }
  1675.     /**
  1676.      * Gets a list of charsets acceptable by the client browser.
  1677.      *
  1678.      * @return array List of charsets in preferable order
  1679.      */
  1680.     public function getCharsets()
  1681.     {
  1682.         if (null !== $this->charsets) {
  1683.             return $this->charsets;
  1684.         }
  1686.         return $this->charsets = array_keys(AcceptHeader::fromString($this->headers->get('Accept-Charset'))->all());
  1687.     }
  1689.     /**
  1690.      * Gets a list of encodings acceptable by the client browser.
  1691.      *
  1692.      * @return array List of encodings in preferable order
  1693.      */
  1694.     public function getEncodings()
  1695.     {
  1696.         if (null !== $this->encodings) {
  1697.             return $this->encodings;
  1698.         }
  1700.         return $this->encodings = array_keys(AcceptHeader::fromString($this->headers->get('Accept-Encoding'))->all());
  1701.     }
  1703.     /**
  1704.      * Gets a list of content types acceptable by the client browser.
  1705.      *
  1706.      * @return array List of content types in preferable order
  1707.      */
  1708.     public function getAcceptableContentTypes()
  1709.     {
  1710.         if (null !== $this->acceptableContentTypes) {
  1711.             return $this->acceptableContentTypes;
  1712.         }
  1714.         return $this->acceptableContentTypes = array_keys(AcceptHeader::fromString($this->headers->get('Accept'))->all());
  1715.     }
  1717.     /**
  1718.      * Returns true if the request is a XMLHttpRequest.
  1719.      *
  1720.      * It works if your JavaScript library sets an X-Requested-With HTTP header.
  1721.      * It is known to work with common JavaScript frameworks:
  1722.      *
  1723.      * @see https://wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
  1724.      *
  1725.      * @return bool true if the request is an XMLHttpRequest, false otherwise
  1726.      */
  1727.     public function isXmlHttpRequest()
  1728.     {
  1729.         return 'XMLHttpRequest' == $this->headers->get('X-Requested-With');
  1730.     }
  1732.     /*
  1733.      * The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)
  1734.      *
  1735.      * Code subject to the new BSD license (https://framework.zend.com/license).
  1736.      *
  1737.      * Copyright (c) 2005-2010 Zend Technologies USA Inc. (https://www.zend.com/)
  1738.      */
  1740.     protected function prepareRequestUri()
  1741.     {
  1742.         $requestUri = '';
  1744.         if ('1' == $this->server->get('IIS_WasUrlRewritten') && '' != $this->server->get('UNENCODED_URL')) {
  1745.             // IIS7 with URL Rewrite: make sure we get the unencoded URL (double slash problem)
  1746.             $requestUri = $this->server->get('UNENCODED_URL');
  1747.             $this->server->remove('UNENCODED_URL');
  1748.             $this->server->remove('IIS_WasUrlRewritten');
  1749.         } elseif ($this->server->has('REQUEST_URI')) {
  1750.             $requestUri = $this->server->get('REQUEST_URI');
  1752.             if ('' !== $requestUri && '/' === $requestUri[0]) {
  1753.                 // To only use path and query remove the fragment.
  1754.                 if (false !== $pos = strpos($requestUri, '#')) {
  1755.                     $requestUri = substr($requestUri, 0, $pos);
  1756.                 }
  1757.             } else {
  1758.                 // HTTP proxy reqs setup request URI with scheme and host [and port] + the URL path,
  1759.                 // only use URL path.
  1760.                 $uriComponents = parse_url($requestUri);
  1762.                 if (isset($uriComponents['path'])) {
  1763.                     $requestUri = $uriComponents['path'];
  1764.                 }
  1766.                 if (isset($uriComponents['query'])) {
  1767.                     $requestUri .= '?'.$uriComponents['query'];
  1768.                 }
  1769.             }
  1770.         } elseif ($this->server->has('ORIG_PATH_INFO')) {
  1771.             // IIS 5.0, PHP as CGI
  1772.             $requestUri = $this->server->get('ORIG_PATH_INFO');
  1773.             if ('' != $this->server->get('QUERY_STRING')) {
  1774.                 $requestUri .= '?'.$this->server->get('QUERY_STRING');
  1775.             }
  1776.             $this->server->remove('ORIG_PATH_INFO');
  1777.         }
  1779.         // normalize the request URI to ease creating sub-requests from this request
  1780.         $this->server->set('REQUEST_URI', $requestUri);
  1782.         return $requestUri;
  1783.     }
  1785.     /**
  1786.      * Prepares the base URL.
  1787.      *
  1788.      * @return string
  1789.      */
  1790.     protected function prepareBaseUrl()
  1791.     {
  1792.         $filename = basename($this->server->get('SCRIPT_FILENAME'));
  1794.         if (basename($this->server->get('SCRIPT_NAME')) === $filename) {
  1795.             $baseUrl = $this->server->get('SCRIPT_NAME');
  1796.         } elseif (basename($this->server->get('PHP_SELF')) === $filename) {
  1797.             $baseUrl = $this->server->get('PHP_SELF');
  1798.         } elseif (basename($this->server->get('ORIG_SCRIPT_NAME')) === $filename) {
  1799.             $baseUrl = $this->server->get('ORIG_SCRIPT_NAME'); // 1and1 shared hosting compatibility
  1800.         } else {
  1801.             // Backtrack up the script_filename to find the portion matching
  1802.             // php_self
  1803.             $path = $this->server->get('PHP_SELF', '');
  1804.             $file = $this->server->get('SCRIPT_FILENAME', '');
  1805.             $segs = explode('/', trim($file, '/'));
  1806.             $segs = array_reverse($segs);
  1807.             $index = 0;
  1808.             $last = \count($segs);
  1809.             $baseUrl = '';
  1810.             do {
  1811.                 $seg = $segs[$index];
  1812.                 $baseUrl = '/'.$seg.$baseUrl;
  1813.                 ++$index;
  1814.             } while ($last > $index && (false !== $pos = strpos($path, $baseUrl)) && 0 != $pos);
  1815.         }
  1817.         // Does the baseUrl have anything in common with the request_uri?
  1818.         $requestUri = $this->getRequestUri();
  1819.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1820.             $requestUri = '/'.$requestUri;
  1821.         }
  1823.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, $baseUrl)) {
  1824.             // full $baseUrl matches
  1825.             return $prefix;
  1826.         }
  1828.         if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, rtrim(\dirname($baseUrl), '/'.\DIRECTORY_SEPARATOR).'/')) {
  1829.             // directory portion of $baseUrl matches
  1830.             return rtrim($prefix, '/'.\DIRECTORY_SEPARATOR);
  1831.         }
  1833.         $truncatedRequestUri = $requestUri;
  1834.         if (false !== $pos = strpos($requestUri, '?')) {
  1835.             $truncatedRequestUri = substr($requestUri, 0, $pos);
  1836.         }
  1838.         $basename = basename($baseUrl);
  1839.         if (empty($basename) || !strpos(rawurldecode($truncatedRequestUri), $basename)) {
  1840.             // no match whatsoever; set it blank
  1841.             return '';
  1842.         }
  1844.         // If using mod_rewrite or ISAPI_Rewrite strip the script filename
  1845.         // out of baseUrl. $pos !== 0 makes sure it is not matching a value
  1846.         // from PATH_INFO or QUERY_STRING
  1847.         if (\strlen($requestUri) >= \strlen($baseUrl) && (false !== $pos = strpos($requestUri, $baseUrl)) && 0 !== $pos) {
  1848.             $baseUrl = substr($requestUri, 0, $pos + \strlen($baseUrl));
  1849.         }
  1851.         return rtrim($baseUrl, '/'.\DIRECTORY_SEPARATOR);
  1852.     }
  1854.     /**
  1855.      * Prepares the base path.
  1856.      *
  1857.      * @return string base path
  1858.      */
  1859.     protected function prepareBasePath()
  1860.     {
  1861.         $baseUrl = $this->getBaseUrl();
  1862.         if (empty($baseUrl)) {
  1863.             return '';
  1864.         }
  1866.         $filename = basename($this->server->get('SCRIPT_FILENAME'));
  1867.         if (basename($baseUrl) === $filename) {
  1868.             $basePath = \dirname($baseUrl);
  1869.         } else {
  1870.             $basePath = $baseUrl;
  1871.         }
  1873.         if ('\\' === \DIRECTORY_SEPARATOR) {
  1874.             $basePath = str_replace('\\', '/', $basePath);
  1875.         }
  1877.         return rtrim($basePath, '/');
  1878.     }
  1880.     /**
  1881.      * Prepares the path info.
  1882.      *
  1883.      * @return string path info
  1884.      */
  1885.     protected function preparePathInfo()
  1886.     {
  1887.         if (null === ($requestUri = $this->getRequestUri())) {
  1888.             return '/';
  1889.         }
  1891.         // Remove the query string from REQUEST_URI
  1892.         if (false !== $pos = strpos($requestUri, '?')) {
  1893.             $requestUri = substr($requestUri, 0, $pos);
  1894.         }
  1895.         if ('' !== $requestUri && '/' !== $requestUri[0]) {
  1896.             $requestUri = '/'.$requestUri;
  1897.         }
  1899.         if (null === ($baseUrl = $this->getBaseUrl())) {
  1900.             return $requestUri;
  1901.         }
  1903.         $pathInfo = substr($requestUri, \strlen($baseUrl));
  1904.         if (false === $pathInfo || '' === $pathInfo) {
  1905.             // If substr() returns false then PATH_INFO is set to an empty string
  1906.             return '/';
  1907.         }
  1909.         return (string) $pathInfo;
  1910.     }
  1912.     /**
  1913.      * Initializes HTTP request formats.
  1914.      */
  1915.     protected static function initializeFormats()
  1916.     {
  1917.         static::$formats = [
  1918.             'html' => ['text/html', 'application/xhtml+xml'],
  1919.             'txt' => ['text/plain'],
  1920.             'js' => ['application/javascript', 'application/x-javascript', 'text/javascript'],
  1921.             'css' => ['text/css'],
  1922.             'json' => ['application/json', 'application/x-json'],
  1923.             'jsonld' => ['application/ld+json'],
  1924.             'xml' => ['text/xml', 'application/xml', 'application/x-xml'],
  1925.             'rdf' => ['application/rdf+xml'],
  1926.             'atom' => ['application/atom+xml'],
  1927.             'rss' => ['application/rss+xml'],
  1928.             'form' => ['application/x-www-form-urlencoded'],
  1929.         ];
  1930.     }
  1932.     private function setPhpDefaultLocale(string $locale): void
  1933.     {
  1934.         // if either the class Locale doesn't exist, or an exception is thrown when
  1935.         // setting the default locale, the intl module is not installed, and
  1936.         // the call can be ignored:
  1937.         try {
  1938.             if (class_exists(\Locale::class, false)) {
  1939.                 \Locale::setDefault($locale);
  1940.             }
  1941.         } catch (\Exception $e) {
  1942.         }
  1943.     }
  1945.     /**
  1946.      * Returns the prefix as encoded in the string when the string starts with
  1947.      * the given prefix, null otherwise.
  1948.      */
  1949.     private function getUrlencodedPrefix(string $string, string $prefix): ?string
  1950.     {
  1951.         if (0 !== strpos(rawurldecode($string), $prefix)) {
  1952.             return null;
  1953.         }
  1955.         $len = \strlen($prefix);
  1957.         if (preg_match(sprintf('#^(%%[[:xdigit:]]{2}|.){%d}#', $len), $string, $match)) {
  1958.             return $match[0];
  1959.         }
  1961.         return null;
  1962.     }
  1964.     private static function createRequestFromFactory(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null): self
  1965.     {
  1966.         if (self::$requestFactory) {
  1967.             $request = (self::$requestFactory)($query, $request, $attributes, $cookies, $files, $server, $content);
  1969.             if (!$request instanceof self) {
  1970.                 throw new \LogicException('The Request factory must return an instance of Symfony\Component\HttpFoundation\Request.');
  1971.             }
  1973.             return $request;
  1974.         }
  1976.         return new static($query, $request, $attributes, $cookies, $files, $server, $content);
  1977.     }
  1979.     /**
  1980.      * Indicates whether this request originated from a trusted proxy.
  1981.      *
  1982.      * This can be useful to determine whether or not to trust the
  1983.      * contents of a proxy-specific header.
  1984.      *
  1985.      * @return bool true if the request came from a trusted proxy, false otherwise
  1986.      */
  1987.     public function isFromTrustedProxy()
  1988.     {
  1989.         return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR'), self::$trustedProxies);
  1990.     }
  1992.     private function getTrustedValues(int $type, string $ip = null): array
  1993.     {
  1994.         $clientValues = [];
  1995.         $forwardedValues = [];
  1997.         if ((self::$trustedHeaderSet & $type) && $this->headers->has(self::TRUSTED_HEADERS[$type])) {
  1998.             foreach (explode(',', $this->headers->get(self::TRUSTED_HEADERS[$type])) as $v) {
  1999.                 $clientValues[] = (self::HEADER_X_FORWARDED_PORT === $type ? '0.0.0.0:' : '').trim($v);
  2000.             }
  2001.         }
  2003.         if ((self::$trustedHeaderSet & self::HEADER_FORWARDED) && $this->headers->has(self::TRUSTED_HEADERS[self::HEADER_FORWARDED])) {
  2004.             $forwarded = $this->headers->get(self::TRUSTED_HEADERS[self::HEADER_FORWARDED]);
  2005.             $parts = HeaderUtils::split($forwarded, ',;=');
  2006.             $forwardedValues = [];
  2007.             $param = self::FORWARDED_PARAMS[$type];
  2008.             foreach ($parts as $subParts) {
  2009.                 if (null === $v = HeaderUtils::combine($subParts)[$param] ?? null) {
  2010.                     continue;
  2011.                 }
  2012.                 if (self::HEADER_X_FORWARDED_PORT === $type) {
  2013.                     if (']' === substr($v, -1) || false === $v = strrchr($v, ':')) {
  2014.                         $v = $this->isSecure() ? ':443' : ':80';
  2015.                     }
  2016.                     $v = '0.0.0.0'.$v;
  2017.                 }
  2018.                 $forwardedValues[] = $v;
  2019.             }
  2020.         }
  2022.         if (null !== $ip) {
  2023.             $clientValues = $this->normalizeAndFilterClientIps($clientValues, $ip);
  2024.             $forwardedValues = $this->normalizeAndFilterClientIps($forwardedValues, $ip);
  2025.         }
  2027.         if ($forwardedValues === $clientValues || !$clientValues) {
  2028.             return $forwardedValues;
  2029.         }
  2031.         if (!$forwardedValues) {
  2032.             return $clientValues;
  2033.         }
  2035.         if (!$this->isForwardedValid) {
  2036.             return null !== $ip ? ['0.0.0.0', $ip] : [];
  2037.         }
  2038.         $this->isForwardedValid = false;
  2040.         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]));
  2041.     }
  2043.     private function normalizeAndFilterClientIps(array $clientIps, string $ip): array
  2044.     {
  2045.         if (!$clientIps) {
  2046.             return [];
  2047.         }
  2048.         $clientIps[] = $ip; // Complete the IP chain with the IP the request actually came from
  2049.         $firstTrustedIp = null;
  2051.         foreach ($clientIps as $key => $clientIp) {
  2052.             if (strpos($clientIp, '.')) {
  2053.                 // Strip :port from IPv4 addresses. This is allowed in Forwarded
  2054.                 // and may occur in X-Forwarded-For.
  2055.                 $i = strpos($clientIp, ':');
  2056.                 if ($i) {
  2057.                     $clientIps[$key] = $clientIp = substr($clientIp, 0, $i);
  2058.                 }
  2059.             } elseif (0 === strpos($clientIp, '[')) {
  2060.                 // Strip brackets and :port from IPv6 addresses.
  2061.                 $i = strpos($clientIp, ']', 1);
  2062.                 $clientIps[$key] = $clientIp = substr($clientIp, 1, $i - 1);
  2063.             }
  2065.             if (!filter_var($clientIp, \FILTER_VALIDATE_IP)) {
  2066.                 unset($clientIps[$key]);
  2068.                 continue;
  2069.             }
  2071.             if (IpUtils::checkIp($clientIp, self::$trustedProxies)) {
  2072.                 unset($clientIps[$key]);
  2074.                 // Fallback to this when the client IP falls into the range of trusted proxies
  2075.                 if (null === $firstTrustedIp) {
  2076.                     $firstTrustedIp = $clientIp;
  2077.                 }
  2078.             }
  2079.         }
  2081.         // Now the IP chain contains only untrusted proxies and the client IP
  2082.         return $clientIps ? array_reverse($clientIps) : [$firstTrustedIp];
  2083.     }
  2084. }