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

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