www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/http-foundation/Request.php

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