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

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