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

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