12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\HttpFoundation;
- use Symfony\Component\HttpFoundation\Exception\ConflictingHeadersException;
- use Symfony\Component\HttpFoundation\Exception\JsonException;
- use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
- use Symfony\Component\HttpFoundation\Exception\SuspiciousOperationException;
- use Symfony\Component\HttpFoundation\Session\SessionInterface;
- // Help opcache.preload discover always-needed symbols
- class_exists(AcceptHeader::class);
- class_exists(FileBag::class);
- class_exists(HeaderBag::class);
- class_exists(HeaderUtils::class);
- class_exists(InputBag::class);
- class_exists(ParameterBag::class);
- class_exists(ServerBag::class);
- /**
- * Request represents an HTTP request.
- *
- * The methods dealing with URL accept / return a raw path (% encoded):
- * * getBasePath
- * * getBaseUrl
- * * getPathInfo
- * * getRequestUri
- * * getUri
- * * getUriForPath
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class Request
- {
- public const HEADER_FORWARDED = 0b000001; // When using RFC 7239
- public const HEADER_X_FORWARDED_FOR = 0b000010;
- public const HEADER_X_FORWARDED_HOST = 0b000100;
- public const HEADER_X_FORWARDED_PROTO = 0b001000;
- public const HEADER_X_FORWARDED_PORT = 0b010000;
- public const HEADER_X_FORWARDED_PREFIX = 0b100000;
- /** @deprecated since Symfony 5.2, use either "HEADER_X_FORWARDED_FOR | HEADER_X_FORWARDED_HOST | HEADER_X_FORWARDED_PORT | HEADER_X_FORWARDED_PROTO" or "HEADER_X_FORWARDED_AWS_ELB" or "HEADER_X_FORWARDED_TRAEFIK" constants instead. */
- public const HEADER_X_FORWARDED_ALL = 0b1011110; // All "X-Forwarded-*" headers sent by "usual" reverse proxy
- public const HEADER_X_FORWARDED_AWS_ELB = 0b0011010; // AWS ELB doesn't send X-Forwarded-Host
- public const HEADER_X_FORWARDED_TRAEFIK = 0b0111110; // All "X-Forwarded-*" headers sent by Traefik reverse proxy
- public const METHOD_HEAD = 'HEAD';
- public const METHOD_GET = 'GET';
- public const METHOD_POST = 'POST';
- public const METHOD_PUT = 'PUT';
- public const METHOD_PATCH = 'PATCH';
- public const METHOD_DELETE = 'DELETE';
- public const METHOD_PURGE = 'PURGE';
- public const METHOD_OPTIONS = 'OPTIONS';
- public const METHOD_TRACE = 'TRACE';
- public const METHOD_CONNECT = 'CONNECT';
- /**
- * @var string[]
- */
- protected static $trustedProxies = [];
- /**
- * @var string[]
- */
- protected static $trustedHostPatterns = [];
- /**
- * @var string[]
- */
- protected static $trustedHosts = [];
- protected static $httpMethodParameterOverride = false;
- /**
- * Custom parameters.
- *
- * @var ParameterBag
- */
- public $attributes;
- /**
- * Request body parameters ($_POST).
- *
- * @var InputBag
- */
- public $request;
- /**
- * Query string parameters ($_GET).
- *
- * @var InputBag
- */
- public $query;
- /**
- * Server and execution environment parameters ($_SERVER).
- *
- * @var ServerBag
- */
- public $server;
- /**
- * Uploaded files ($_FILES).
- *
- * @var FileBag
- */
- public $files;
- /**
- * Cookies ($_COOKIE).
- *
- * @var InputBag
- */
- public $cookies;
- /**
- * Headers (taken from the $_SERVER).
- *
- * @var HeaderBag
- */
- public $headers;
- /**
- * @var string|resource|false|null
- */
- protected $content;
- /**
- * @var array
- */
- protected $languages;
- /**
- * @var array
- */
- protected $charsets;
- /**
- * @var array
- */
- protected $encodings;
- /**
- * @var array
- */
- protected $acceptableContentTypes;
- /**
- * @var string
- */
- protected $pathInfo;
- /**
- * @var string
- */
- protected $requestUri;
- /**
- * @var string
- */
- protected $baseUrl;
- /**
- * @var string
- */
- protected $basePath;
- /**
- * @var string
- */
- protected $method;
- /**
- * @var string
- */
- protected $format;
- /**
- * @var SessionInterface|callable(): SessionInterface
- */
- protected $session;
- /**
- * @var string
- */
- protected $locale;
- /**
- * @var string
- */
- protected $defaultLocale = 'en';
- /**
- * @var array
- */
- protected static $formats;
- protected static $requestFactory;
- /**
- * @var string|null
- */
- private $preferredFormat;
- private $isHostValid = true;
- private $isForwardedValid = true;
- /**
- * @var bool|null
- */
- private $isSafeContentPreferred;
- private static $trustedHeaderSet = -1;
- private const FORWARDED_PARAMS = [
- self::HEADER_X_FORWARDED_FOR => 'for',
- self::HEADER_X_FORWARDED_HOST => 'host',
- self::HEADER_X_FORWARDED_PROTO => 'proto',
- self::HEADER_X_FORWARDED_PORT => 'host',
- ];
- /**
- * Names for headers that can be trusted when
- * using trusted proxies.
- *
- * The FORWARDED header is the standard as of rfc7239.
- *
- * The other headers are non-standard, but widely used
- * by popular reverse proxies (like Apache mod_proxy or Amazon EC2).
- */
- private const TRUSTED_HEADERS = [
- self::HEADER_FORWARDED => 'FORWARDED',
- self::HEADER_X_FORWARDED_FOR => 'X_FORWARDED_FOR',
- self::HEADER_X_FORWARDED_HOST => 'X_FORWARDED_HOST',
- self::HEADER_X_FORWARDED_PROTO => 'X_FORWARDED_PROTO',
- self::HEADER_X_FORWARDED_PORT => 'X_FORWARDED_PORT',
- self::HEADER_X_FORWARDED_PREFIX => 'X_FORWARDED_PREFIX',
- ];
- /**
- * @param array $query The GET parameters
- * @param array $request The POST parameters
- * @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
- * @param array $cookies The COOKIE parameters
- * @param array $files The FILES parameters
- * @param array $server The SERVER parameters
- * @param string|resource|null $content The raw body data
- */
- public function __construct(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
- {
- $this->initialize($query, $request, $attributes, $cookies, $files, $server, $content);
- }
- /**
- * Sets the parameters for this request.
- *
- * This method also re-initializes all properties.
- *
- * @param array $query The GET parameters
- * @param array $request The POST parameters
- * @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
- * @param array $cookies The COOKIE parameters
- * @param array $files The FILES parameters
- * @param array $server The SERVER parameters
- * @param string|resource|null $content The raw body data
- */
- public function initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null)
- {
- $this->request = new InputBag($request);
- $this->query = new InputBag($query);
- $this->attributes = new ParameterBag($attributes);
- $this->cookies = new InputBag($cookies);
- $this->files = new FileBag($files);
- $this->server = new ServerBag($server);
- $this->headers = new HeaderBag($this->server->getHeaders());
- $this->content = $content;
- $this->languages = null;
- $this->charsets = null;
- $this->encodings = null;
- $this->acceptableContentTypes = null;
- $this->pathInfo = null;
- $this->requestUri = null;
- $this->baseUrl = null;
- $this->basePath = null;
- $this->method = null;
- $this->format = null;
- }
- /**
- * Creates a new request with values from PHP's super globals.
- *
- * @return static
- */
- public static function createFromGlobals()
- {
- $request = self::createRequestFromFactory($_GET, $_POST, [], $_COOKIE, $_FILES, $_SERVER);
- if (str_starts_with($request->headers->get('CONTENT_TYPE', ''), 'application/x-www-form-urlencoded')
- && \in_array(strtoupper($request->server->get('REQUEST_METHOD', 'GET')), ['PUT', 'DELETE', 'PATCH'])
- ) {
- parse_str($request->getContent(), $data);
- $request->request = new InputBag($data);
- }
- return $request;
- }
- /**
- * Creates a Request based on a given URI and configuration.
- *
- * The information contained in the URI always take precedence
- * over the other information (server and parameters).
- *
- * @param string $uri The URI
- * @param string $method The HTTP method
- * @param array $parameters The query (GET) or request (POST) parameters
- * @param array $cookies The request cookies ($_COOKIE)
- * @param array $files The request files ($_FILES)
- * @param array $server The server parameters ($_SERVER)
- * @param string|resource|null $content The raw body data
- *
- * @return static
- */
- public static function create(string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], $content = null)
- {
- $server = array_replace([
- 'SERVER_NAME' => 'localhost',
- 'SERVER_PORT' => 80,
- 'HTTP_HOST' => 'localhost',
- 'HTTP_USER_AGENT' => 'Symfony',
- 'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
- 'HTTP_ACCEPT_LANGUAGE' => 'en-us,en;q=0.5',
- 'HTTP_ACCEPT_CHARSET' => 'ISO-8859-1,utf-8;q=0.7,*;q=0.7',
- 'REMOTE_ADDR' => '127.0.0.1',
- 'SCRIPT_NAME' => '',
- 'SCRIPT_FILENAME' => '',
- 'SERVER_PROTOCOL' => 'HTTP/1.1',
- 'REQUEST_TIME' => time(),
- 'REQUEST_TIME_FLOAT' => microtime(true),
- ], $server);
- $server['PATH_INFO'] = '';
- $server['REQUEST_METHOD'] = strtoupper($method);
- $components = parse_url($uri);
- if (isset($components['host'])) {
- $server['SERVER_NAME'] = $components['host'];
- $server['HTTP_HOST'] = $components['host'];
- }
- if (isset($components['scheme'])) {
- if ('https' === $components['scheme']) {
- $server['HTTPS'] = 'on';
- $server['SERVER_PORT'] = 443;
- } else {
- unset($server['HTTPS']);
- $server['SERVER_PORT'] = 80;
- }
- }
- if (isset($components['port'])) {
- $server['SERVER_PORT'] = $components['port'];
- $server['HTTP_HOST'] .= ':'.$components['port'];
- }
- if (isset($components['user'])) {
- $server['PHP_AUTH_USER'] = $components['user'];
- }
- if (isset($components['pass'])) {
- $server['PHP_AUTH_PW'] = $components['pass'];
- }
- if (!isset($components['path'])) {
- $components['path'] = '/';
- }
- switch (strtoupper($method)) {
- case 'POST':
- case 'PUT':
- case 'DELETE':
- if (!isset($server['CONTENT_TYPE'])) {
- $server['CONTENT_TYPE'] = 'application/x-www-form-urlencoded';
- }
- // no break
- case 'PATCH':
- $request = $parameters;
- $query = [];
- break;
- default:
- $request = [];
- $query = $parameters;
- break;
- }
- $queryString = '';
- if (isset($components['query'])) {
- parse_str(html_entity_decode($components['query']), $qs);
- if ($query) {
- $query = array_replace($qs, $query);
- $queryString = http_build_query($query, '', '&');
- } else {
- $query = $qs;
- $queryString = $components['query'];
- }
- } elseif ($query) {
- $queryString = http_build_query($query, '', '&');
- }
- $server['REQUEST_URI'] = $components['path'].('' !== $queryString ? '?'.$queryString : '');
- $server['QUERY_STRING'] = $queryString;
- return self::createRequestFromFactory($query, $request, [], $cookies, $files, $server, $content);
- }
- /**
- * Sets a callable able to create a Request instance.
- *
- * This is mainly useful when you need to override the Request class
- * to keep BC with an existing system. It should not be used for any
- * other purpose.
- */
- public static function setFactory(?callable $callable)
- {
- self::$requestFactory = $callable;
- }
- /**
- * Clones a request and overrides some of its parameters.
- *
- * @param array $query The GET parameters
- * @param array $request The POST parameters
- * @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
- * @param array $cookies The COOKIE parameters
- * @param array $files The FILES parameters
- * @param array $server The SERVER parameters
- *
- * @return static
- */
- public function duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)
- {
- $dup = clone $this;
- if (null !== $query) {
- $dup->query = new InputBag($query);
- }
- if (null !== $request) {
- $dup->request = new InputBag($request);
- }
- if (null !== $attributes) {
- $dup->attributes = new ParameterBag($attributes);
- }
- if (null !== $cookies) {
- $dup->cookies = new InputBag($cookies);
- }
- if (null !== $files) {
- $dup->files = new FileBag($files);
- }
- if (null !== $server) {
- $dup->server = new ServerBag($server);
- $dup->headers = new HeaderBag($dup->server->getHeaders());
- }
- $dup->languages = null;
- $dup->charsets = null;
- $dup->encodings = null;
- $dup->acceptableContentTypes = null;
- $dup->pathInfo = null;
- $dup->requestUri = null;
- $dup->baseUrl = null;
- $dup->basePath = null;
- $dup->method = null;
- $dup->format = null;
- if (!$dup->get('_format') && $this->get('_format')) {
- $dup->attributes->set('_format', $this->get('_format'));
- }
- if (!$dup->getRequestFormat(null)) {
- $dup->setRequestFormat($this->getRequestFormat(null));
- }
- return $dup;
- }
- /**
- * Clones the current request.
- *
- * Note that the session is not cloned as duplicated requests
- * are most of the time sub-requests of the main one.
- */
- public function __clone()
- {
- $this->query = clone $this->query;
- $this->request = clone $this->request;
- $this->attributes = clone $this->attributes;
- $this->cookies = clone $this->cookies;
- $this->files = clone $this->files;
- $this->server = clone $this->server;
- $this->headers = clone $this->headers;
- }
- /**
- * Returns the request as a string.
- *
- * @return string
- */
- public function __toString()
- {
- $content = $this->getContent();
- $cookieHeader = '';
- $cookies = [];
- foreach ($this->cookies as $k => $v) {
- $cookies[] = $k.'='.$v;
- }
- if (!empty($cookies)) {
- $cookieHeader = 'Cookie: '.implode('; ', $cookies)."\r\n";
- }
- return
- sprintf('%s %s %s', $this->getMethod(), $this->getRequestUri(), $this->server->get('SERVER_PROTOCOL'))."\r\n".
- $this->headers.
- $cookieHeader."\r\n".
- $content;
- }
- /**
- * Overrides the PHP global variables according to this request instance.
- *
- * It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE.
- * $_FILES is never overridden, see rfc1867
- */
- public function overrideGlobals()
- {
- $this->server->set('QUERY_STRING', static::normalizeQueryString(http_build_query($this->query->all(), '', '&')));
- $_GET = $this->query->all();
- $_POST = $this->request->all();
- $_SERVER = $this->server->all();
- $_COOKIE = $this->cookies->all();
- foreach ($this->headers->all() as $key => $value) {
- $key = strtoupper(str_replace('-', '_', $key));
- if (\in_array($key, ['CONTENT_TYPE', 'CONTENT_LENGTH', 'CONTENT_MD5'], true)) {
- $_SERVER[$key] = implode(', ', $value);
- } else {
- $_SERVER['HTTP_'.$key] = implode(', ', $value);
- }
- }
- $request = ['g' => $_GET, 'p' => $_POST, 'c' => $_COOKIE];
- $requestOrder = ini_get('request_order') ?: ini_get('variables_order');
- $requestOrder = preg_replace('#[^cgp]#', '', strtolower($requestOrder)) ?: 'gp';
- $_REQUEST = [[]];
- foreach (str_split($requestOrder) as $order) {
- $_REQUEST[] = $request[$order];
- }
- $_REQUEST = array_merge(...$_REQUEST);
- }
- /**
- * Sets a list of trusted proxies.
- *
- * You should only list the reverse proxies that you manage directly.
- *
- * @param array $proxies A list of trusted proxies, the string 'REMOTE_ADDR' will be replaced with $_SERVER['REMOTE_ADDR']
- * @param int $trustedHeaderSet A bit field of Request::HEADER_*, to set which headers to trust from your proxies
- */
- public static function setTrustedProxies(array $proxies, int $trustedHeaderSet)
- {
- if (self::HEADER_X_FORWARDED_ALL === $trustedHeaderSet) {
- trigger_deprecation('symfony/http-foundation', '5.2', 'The "HEADER_X_FORWARDED_ALL" constant is deprecated, use either "HEADER_X_FORWARDED_FOR | HEADER_X_FORWARDED_HOST | HEADER_X_FORWARDED_PORT | HEADER_X_FORWARDED_PROTO" or "HEADER_X_FORWARDED_AWS_ELB" or "HEADER_X_FORWARDED_TRAEFIK" constants instead.');
- }
- self::$trustedProxies = array_reduce($proxies, function ($proxies, $proxy) {
- if ('REMOTE_ADDR' !== $proxy) {
- $proxies[] = $proxy;
- } elseif (isset($_SERVER['REMOTE_ADDR'])) {
- $proxies[] = $_SERVER['REMOTE_ADDR'];
- }
- return $proxies;
- }, []);
- self::$trustedHeaderSet = $trustedHeaderSet;
- }
- /**
- * Gets the list of trusted proxies.
- *
- * @return array
- */
- public static function getTrustedProxies()
- {
- return self::$trustedProxies;
- }
- /**
- * Gets the set of trusted headers from trusted proxies.
- *
- * @return int A bit field of Request::HEADER_* that defines which headers are trusted from your proxies
- */
- public static function getTrustedHeaderSet()
- {
- return self::$trustedHeaderSet;
- }
- /**
- * Sets a list of trusted host patterns.
- *
- * You should only list the hosts you manage using regexs.
- *
- * @param array $hostPatterns A list of trusted host patterns
- */
- public static function setTrustedHosts(array $hostPatterns)
- {
- self::$trustedHostPatterns = array_map(function ($hostPattern) {
- return sprintf('{%s}i', $hostPattern);
- }, $hostPatterns);
- // we need to reset trusted hosts on trusted host patterns change
- self::$trustedHosts = [];
- }
- /**
- * Gets the list of trusted host patterns.
- *
- * @return array
- */
- public static function getTrustedHosts()
- {
- return self::$trustedHostPatterns;
- }
- /**
- * Normalizes a query string.
- *
- * It builds a normalized query string, where keys/value pairs are alphabetized,
- * have consistent escaping and unneeded delimiters are removed.
- *
- * @return string
- */
- public static function normalizeQueryString(?string $qs)
- {
- if ('' === ($qs ?? '')) {
- return '';
- }
- $qs = HeaderUtils::parseQuery($qs);
- ksort($qs);
- return http_build_query($qs, '', '&', \PHP_QUERY_RFC3986);
- }
- /**
- * Enables support for the _method request parameter to determine the intended HTTP method.
- *
- * Be warned that enabling this feature might lead to CSRF issues in your code.
- * Check that you are using CSRF tokens when required.
- * If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered
- * and used to send a "PUT" or "DELETE" request via the _method request parameter.
- * If these methods are not protected against CSRF, this presents a possible vulnerability.
- *
- * The HTTP method can only be overridden when the real HTTP method is POST.
- */
- public static function enableHttpMethodParameterOverride()
- {
- self::$httpMethodParameterOverride = true;
- }
- /**
- * Checks whether support for the _method request parameter is enabled.
- *
- * @return bool
- */
- public static function getHttpMethodParameterOverride()
- {
- return self::$httpMethodParameterOverride;
- }
- /**
- * Gets a "parameter" value from any bag.
- *
- * This method is mainly useful for libraries that want to provide some flexibility. If you don't need the
- * flexibility in controllers, it is better to explicitly get request parameters from the appropriate
- * public property instead (attributes, query, request).
- *
- * Order of precedence: PATH (routing placeholders or custom attributes), GET, POST
- *
- * @param mixed $default The default value if the parameter key does not exist
- *
- * @return mixed
- *
- * @internal since Symfony 5.4, use explicit input sources instead
- */
- public function get(string $key, $default = null)
- {
- if ($this !== $result = $this->attributes->get($key, $this)) {
- return $result;
- }
- if ($this->query->has($key)) {
- return $this->query->all()[$key];
- }
- if ($this->request->has($key)) {
- return $this->request->all()[$key];
- }
- return $default;
- }
- /**
- * Gets the Session.
- *
- * @return SessionInterface
- */
- public function getSession()
- {
- $session = $this->session;
- if (!$session instanceof SessionInterface && null !== $session) {
- $this->setSession($session = $session());
- }
- if (null === $session) {
- throw new SessionNotFoundException('Session has not been set.');
- }
- return $session;
- }
- /**
- * Whether the request contains a Session which was started in one of the
- * previous requests.
- *
- * @return bool
- */
- public function hasPreviousSession()
- {
- // the check for $this->session avoids malicious users trying to fake a session cookie with proper name
- return $this->hasSession() && $this->cookies->has($this->getSession()->getName());
- }
- /**
- * Whether the request contains a Session object.
- *
- * This method does not give any information about the state of the session object,
- * like whether the session is started or not. It is just a way to check if this Request
- * is associated with a Session instance.
- *
- * @param bool $skipIfUninitialized When true, ignores factories injected by `setSessionFactory`
- *
- * @return bool
- */
- public function hasSession(/* bool $skipIfUninitialized = false */)
- {
- $skipIfUninitialized = \func_num_args() > 0 ? func_get_arg(0) : false;
- return null !== $this->session && (!$skipIfUninitialized || $this->session instanceof SessionInterface);
- }
- public function setSession(SessionInterface $session)
- {
- $this->session = $session;
- }
- /**
- * @internal
- *
- * @param callable(): SessionInterface $factory
- */
- public function setSessionFactory(callable $factory)
- {
- $this->session = $factory;
- }
- /**
- * Returns the client IP addresses.
- *
- * In the returned array the most trusted IP address is first, and the
- * least trusted one last. The "real" client IP address is the last one,
- * but this is also the least trusted one. Trusted proxies are stripped.
- *
- * Use this method carefully; you should use getClientIp() instead.
- *
- * @return array
- *
- * @see getClientIp()
- */
- public function getClientIps()
- {
- $ip = $this->server->get('REMOTE_ADDR');
- if (!$this->isFromTrustedProxy()) {
- return [$ip];
- }
- return $this->getTrustedValues(self::HEADER_X_FORWARDED_FOR, $ip) ?: [$ip];
- }
- /**
- * Returns the client IP address.
- *
- * This method can read the client IP address from the "X-Forwarded-For" header
- * when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For"
- * header value is a comma+space separated list of IP addresses, the left-most
- * being the original client, and each successive proxy that passed the request
- * adding the IP address where it received the request from.
- *
- * If your reverse proxy uses a different header name than "X-Forwarded-For",
- * ("Client-Ip" for instance), configure it via the $trustedHeaderSet
- * argument of the Request::setTrustedProxies() method instead.
- *
- * @return string|null
- *
- * @see getClientIps()
- * @see https://wikipedia.org/wiki/X-Forwarded-For
- */
- public function getClientIp()
- {
- $ipAddresses = $this->getClientIps();
- return $ipAddresses[0];
- }
- /**
- * Returns current script name.
- *
- * @return string
- */
- public function getScriptName()
- {
- return $this->server->get('SCRIPT_NAME', $this->server->get('ORIG_SCRIPT_NAME', ''));
- }
- /**
- * Returns the path being requested relative to the executed script.
- *
- * The path info always starts with a /.
- *
- * Suppose this request is instantiated from /mysite on localhost:
- *
- * * http://localhost/mysite returns an empty string
- * * http://localhost/mysite/about returns '/about'
- * * http://localhost/mysite/enco%20ded returns '/enco%20ded'
- * * http://localhost/mysite/about?var=1 returns '/about'
- *
- * @return string The raw path (i.e. not urldecoded)
- */
- public function getPathInfo()
- {
- if (null === $this->pathInfo) {
- $this->pathInfo = $this->preparePathInfo();
- }
- return $this->pathInfo;
- }
- /**
- * Returns the root path from which this request is executed.
- *
- * Suppose that an index.php file instantiates this request object:
- *
- * * http://localhost/index.php returns an empty string
- * * http://localhost/index.php/page returns an empty string
- * * http://localhost/web/index.php returns '/web'
- * * http://localhost/we%20b/index.php returns '/we%20b'
- *
- * @return string The raw path (i.e. not urldecoded)
- */
- public function getBasePath()
- {
- if (null === $this->basePath) {
- $this->basePath = $this->prepareBasePath();
- }
- return $this->basePath;
- }
- /**
- * Returns the root URL from which this request is executed.
- *
- * The base URL never ends with a /.
- *
- * This is similar to getBasePath(), except that it also includes the
- * script filename (e.g. index.php) if one exists.
- *
- * @return string The raw URL (i.e. not urldecoded)
- */
- public function getBaseUrl()
- {
- $trustedPrefix = '';
- // the proxy prefix must be prepended to any prefix being needed at the webserver level
- if ($this->isFromTrustedProxy() && $trustedPrefixValues = $this->getTrustedValues(self::HEADER_X_FORWARDED_PREFIX)) {
- $trustedPrefix = rtrim($trustedPrefixValues[0], '/');
- }
- return $trustedPrefix.$this->getBaseUrlReal();
- }
- /**
- * Returns the real base URL received by the webserver from which this request is executed.
- * The URL does not include trusted reverse proxy prefix.
- *
- * @return string The raw URL (i.e. not urldecoded)
- */
- private function getBaseUrlReal(): string
- {
- if (null === $this->baseUrl) {
- $this->baseUrl = $this->prepareBaseUrl();
- }
- return $this->baseUrl;
- }
- /**
- * Gets the request's scheme.
- *
- * @return string
- */
- public function getScheme()
- {
- return $this->isSecure() ? 'https' : 'http';
- }
- /**
- * Returns the port on which the request is made.
- *
- * This method can read the client port from the "X-Forwarded-Port" header
- * when trusted proxies were set via "setTrustedProxies()".
- *
- * The "X-Forwarded-Port" header must contain the client port.
- *
- * @return int|string|null Can be a string if fetched from the server bag
- */
- public function getPort()
- {
- if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_PORT)) {
- $host = $host[0];
- } elseif ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
- $host = $host[0];
- } elseif (!$host = $this->headers->get('HOST')) {
- return $this->server->get('SERVER_PORT');
- }
- if ('[' === $host[0]) {
- $pos = strpos($host, ':', strrpos($host, ']'));
- } else {
- $pos = strrpos($host, ':');
- }
- if (false !== $pos && $port = substr($host, $pos + 1)) {
- return (int) $port;
- }
- return 'https' === $this->getScheme() ? 443 : 80;
- }
- /**
- * Returns the user.
- *
- * @return string|null
- */
- public function getUser()
- {
- return $this->headers->get('PHP_AUTH_USER');
- }
- /**
- * Returns the password.
- *
- * @return string|null
- */
- public function getPassword()
- {
- return $this->headers->get('PHP_AUTH_PW');
- }
- /**
- * Gets the user info.
- *
- * @return string|null A user name if any and, optionally, scheme-specific information about how to gain authorization to access the server
- */
- public function getUserInfo()
- {
- $userinfo = $this->getUser();
- $pass = $this->getPassword();
- if ('' != $pass) {
- $userinfo .= ":$pass";
- }
- return $userinfo;
- }
- /**
- * Returns the HTTP host being requested.
- *
- * The port name will be appended to the host if it's non-standard.
- *
- * @return string
- */
- public function getHttpHost()
- {
- $scheme = $this->getScheme();
- $port = $this->getPort();
- if (('http' == $scheme && 80 == $port) || ('https' == $scheme && 443 == $port)) {
- return $this->getHost();
- }
- return $this->getHost().':'.$port;
- }
- /**
- * Returns the requested URI (path and query string).
- *
- * @return string The raw URI (i.e. not URI decoded)
- */
- public function getRequestUri()
- {
- if (null === $this->requestUri) {
- $this->requestUri = $this->prepareRequestUri();
- }
- return $this->requestUri;
- }
- /**
- * Gets the scheme and HTTP host.
- *
- * If the URL was called with basic authentication, the user
- * and the password are not added to the generated string.
- *
- * @return string
- */
- public function getSchemeAndHttpHost()
- {
- return $this->getScheme().'://'.$this->getHttpHost();
- }
- /**
- * Generates a normalized URI (URL) for the Request.
- *
- * @return string
- *
- * @see getQueryString()
- */
- public function getUri()
- {
- if (null !== $qs = $this->getQueryString()) {
- $qs = '?'.$qs;
- }
- return $this->getSchemeAndHttpHost().$this->getBaseUrl().$this->getPathInfo().$qs;
- }
- /**
- * Generates a normalized URI for the given path.
- *
- * @param string $path A path to use instead of the current one
- *
- * @return string
- */
- public function getUriForPath(string $path)
- {
- return $this->getSchemeAndHttpHost().$this->getBaseUrl().$path;
- }
- /**
- * Returns the path as relative reference from the current Request path.
- *
- * Only the URIs path component (no schema, host etc.) is relevant and must be given.
- * Both paths must be absolute and not contain relative parts.
- * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
- * Furthermore, they can be used to reduce the link size in documents.
- *
- * Example target paths, given a base path of "/a/b/c/d":
- * - "/a/b/c/d" -> ""
- * - "/a/b/c/" -> "./"
- * - "/a/b/" -> "../"
- * - "/a/b/c/other" -> "other"
- * - "/a/x/y" -> "../../x/y"
- *
- * @return string
- */
- public function getRelativeUriForPath(string $path)
- {
- // be sure that we are dealing with an absolute path
- if (!isset($path[0]) || '/' !== $path[0]) {
- return $path;
- }
- if ($path === $basePath = $this->getPathInfo()) {
- return '';
- }
- $sourceDirs = explode('/', isset($basePath[0]) && '/' === $basePath[0] ? substr($basePath, 1) : $basePath);
- $targetDirs = explode('/', substr($path, 1));
- array_pop($sourceDirs);
- $targetFile = array_pop($targetDirs);
- foreach ($sourceDirs as $i => $dir) {
- if (isset($targetDirs[$i]) && $dir === $targetDirs[$i]) {
- unset($sourceDirs[$i], $targetDirs[$i]);
- } else {
- break;
- }
- }
- $targetDirs[] = $targetFile;
- $path = str_repeat('../', \count($sourceDirs)).implode('/', $targetDirs);
- // A reference to the same base directory or an empty subdirectory must be prefixed with "./".
- // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used
- // as the first segment of a relative-path reference, as it would be mistaken for a scheme name
- // (see https://tools.ietf.org/html/rfc3986#section-4.2).
- return !isset($path[0]) || '/' === $path[0]
- || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)
- ? "./$path" : $path;
- }
- /**
- * Generates the normalized query string for the Request.
- *
- * It builds a normalized query string, where keys/value pairs are alphabetized
- * and have consistent escaping.
- *
- * @return string|null
- */
- public function getQueryString()
- {
- $qs = static::normalizeQueryString($this->server->get('QUERY_STRING'));
- return '' === $qs ? null : $qs;
- }
- /**
- * Checks whether the request is secure or not.
- *
- * This method can read the client protocol from the "X-Forwarded-Proto" header
- * when trusted proxies were set via "setTrustedProxies()".
- *
- * The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".
- *
- * @return bool
- */
- public function isSecure()
- {
- if ($this->isFromTrustedProxy() && $proto = $this->getTrustedValues(self::HEADER_X_FORWARDED_PROTO)) {
- return \in_array(strtolower($proto[0]), ['https', 'on', 'ssl', '1'], true);
- }
- $https = $this->server->get('HTTPS');
- return !empty($https) && 'off' !== strtolower($https);
- }
- /**
- * Returns the host name.
- *
- * This method can read the client host name from the "X-Forwarded-Host" header
- * when trusted proxies were set via "setTrustedProxies()".
- *
- * The "X-Forwarded-Host" header must contain the client host name.
- *
- * @return string
- *
- * @throws SuspiciousOperationException when the host name is invalid or not trusted
- */
- public function getHost()
- {
- if ($this->isFromTrustedProxy() && $host = $this->getTrustedValues(self::HEADER_X_FORWARDED_HOST)) {
- $host = $host[0];
- } elseif (!$host = $this->headers->get('HOST')) {
- if (!$host = $this->server->get('SERVER_NAME')) {
- $host = $this->server->get('SERVER_ADDR', '');
- }
- }
- // trim and remove port number from host
- // host is lowercase as per RFC 952/2181
- $host = strtolower(preg_replace('/:\d+$/', '', trim($host)));
- // as the host can come from the user (HTTP_HOST and depending on the configuration, SERVER_NAME too can come from the user)
- // check that it does not contain forbidden characters (see RFC 952 and RFC 2181)
- // use preg_replace() instead of preg_match() to prevent DoS attacks with long host names
- if ($host && '' !== preg_replace('/(?:^\[)?[a-zA-Z0-9-:\]_]+\.?/', '', $host)) {
- if (!$this->isHostValid) {
- return '';
- }
- $this->isHostValid = false;
- throw new SuspiciousOperationException(sprintf('Invalid Host "%s".', $host));
- }
- if (\count(self::$trustedHostPatterns) > 0) {
- // to avoid host header injection attacks, you should provide a list of trusted host patterns
- if (\in_array($host, self::$trustedHosts)) {
- return $host;
- }
- foreach (self::$trustedHostPatterns as $pattern) {
- if (preg_match($pattern, $host)) {
- self::$trustedHosts[] = $host;
- return $host;
- }
- }
- if (!$this->isHostValid) {
- return '';
- }
- $this->isHostValid = false;
- throw new SuspiciousOperationException(sprintf('Untrusted Host "%s".', $host));
- }
- return $host;
- }
- /**
- * Sets the request method.
- */
- public function setMethod(string $method)
- {
- $this->method = null;
- $this->server->set('REQUEST_METHOD', $method);
- }
- /**
- * Gets the request "intended" method.
- *
- * If the X-HTTP-Method-Override header is set, and if the method is a POST,
- * then it is used to determine the "real" intended HTTP method.
- *
- * The _method request parameter can also be used to determine the HTTP method,
- * but only if enableHttpMethodParameterOverride() has been called.
- *
- * The method is always an uppercased string.
- *
- * @return string
- *
- * @see getRealMethod()
- */
- public function getMethod()
- {
- if (null !== $this->method) {
- return $this->method;
- }
- $this->method = strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
- if ('POST' !== $this->method) {
- return $this->method;
- }
- $method = $this->headers->get('X-HTTP-METHOD-OVERRIDE');
- if (!$method && self::$httpMethodParameterOverride) {
- $method = $this->request->get('_method', $this->query->get('_method', 'POST'));
- }
- if (!\is_string($method)) {
- return $this->method;
- }
- $method = strtoupper($method);
- if (\in_array($method, ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'PATCH', 'PURGE', 'TRACE'], true)) {
- return $this->method = $method;
- }
- if (!preg_match('/^[A-Z]++$/D', $method)) {
- throw new SuspiciousOperationException(sprintf('Invalid method override "%s".', $method));
- }
- return $this->method = $method;
- }
- /**
- * Gets the "real" request method.
- *
- * @return string
- *
- * @see getMethod()
- */
- public function getRealMethod()
- {
- return strtoupper($this->server->get('REQUEST_METHOD', 'GET'));
- }
- /**
- * Gets the mime type associated with the format.
- *
- * @return string|null
- */
- public function getMimeType(string $format)
- {
- if (null === static::$formats) {
- static::initializeFormats();
- }
- return isset(static::$formats[$format]) ? static::$formats[$format][0] : null;
- }
- /**
- * Gets the mime types associated with the format.
- *
- * @return array
- */
- public static function getMimeTypes(string $format)
- {
- if (null === static::$formats) {
- static::initializeFormats();
- }
- return static::$formats[$format] ?? [];
- }
- /**
- * Gets the format associated with the mime type.
- *
- * @return string|null
- */
- public function getFormat(?string $mimeType)
- {
- $canonicalMimeType = null;
- if ($mimeType && false !== $pos = strpos($mimeType, ';')) {
- $canonicalMimeType = trim(substr($mimeType, 0, $pos));
- }
- if (null === static::$formats) {
- static::initializeFormats();
- }
- foreach (static::$formats as $format => $mimeTypes) {
- if (\in_array($mimeType, (array) $mimeTypes)) {
- return $format;
- }
- if (null !== $canonicalMimeType && \in_array($canonicalMimeType, (array) $mimeTypes)) {
- return $format;
- }
- }
- return null;
- }
- /**
- * Associates a format with mime types.
- *
- * @param string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
- */
- public function setFormat(?string $format, $mimeTypes)
- {
- if (null === static::$formats) {
- static::initializeFormats();
- }
- static::$formats[$format] = \is_array($mimeTypes) ? $mimeTypes : [$mimeTypes];
- }
- /**
- * Gets the request format.
- *
- * Here is the process to determine the format:
- *
- * * format defined by the user (with setRequestFormat())
- * * _format request attribute
- * * $default
- *
- * @see getPreferredFormat
- *
- * @return string|null
- */
- public function getRequestFormat(?string $default = 'html')
- {
- if (null === $this->format) {
- $this->format = $this->attributes->get('_format');
- }
- return $this->format ?? $default;
- }
- /**
- * Sets the request format.
- */
- public function setRequestFormat(?string $format)
- {
- $this->format = $format;
- }
- /**
- * Gets the format associated with the request.
- *
- * @return string|null
- */
- public function getContentType()
- {
- return $this->getFormat($this->headers->get('CONTENT_TYPE', ''));
- }
- /**
- * Sets the default locale.
- */
- public function setDefaultLocale(string $locale)
- {
- $this->defaultLocale = $locale;
- if (null === $this->locale) {
- $this->setPhpDefaultLocale($locale);
- }
- }
- /**
- * Get the default locale.
- *
- * @return string
- */
- public function getDefaultLocale()
- {
- return $this->defaultLocale;
- }
- /**
- * Sets the locale.
- */
- public function setLocale(string $locale)
- {
- $this->setPhpDefaultLocale($this->locale = $locale);
- }
- /**
- * Get the locale.
- *
- * @return string
- */
- public function getLocale()
- {
- return null === $this->locale ? $this->defaultLocale : $this->locale;
- }
- /**
- * Checks if the request method is of specified type.
- *
- * @param string $method Uppercase request method (GET, POST etc)
- *
- * @return bool
- */
- public function isMethod(string $method)
- {
- return $this->getMethod() === strtoupper($method);
- }
- /**
- * Checks whether or not the method is safe.
- *
- * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
- *
- * @return bool
- */
- public function isMethodSafe()
- {
- return \in_array($this->getMethod(), ['GET', 'HEAD', 'OPTIONS', 'TRACE']);
- }
- /**
- * Checks whether or not the method is idempotent.
- *
- * @return bool
- */
- public function isMethodIdempotent()
- {
- return \in_array($this->getMethod(), ['HEAD', 'GET', 'PUT', 'DELETE', 'TRACE', 'OPTIONS', 'PURGE']);
- }
- /**
- * Checks whether the method is cacheable or not.
- *
- * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
- *
- * @return bool
- */
- public function isMethodCacheable()
- {
- return \in_array($this->getMethod(), ['GET', 'HEAD']);
- }
- /**
- * Returns the protocol version.
- *
- * If the application is behind a proxy, the protocol version used in the
- * requests between the client and the proxy and between the proxy and the
- * server might be different. This returns the former (from the "Via" header)
- * if the proxy is trusted (see "setTrustedProxies()"), otherwise it returns
- * the latter (from the "SERVER_PROTOCOL" server parameter).
- *
- * @return string|null
- */
- public function getProtocolVersion()
- {
- if ($this->isFromTrustedProxy()) {
- preg_match('~^(HTTP/)?([1-9]\.[0-9]) ~', $this->headers->get('Via') ?? '', $matches);
- if ($matches) {
- return 'HTTP/'.$matches[2];
- }
- }
- return $this->server->get('SERVER_PROTOCOL');
- }
- /**
- * Returns the request body content.
- *
- * @param bool $asResource If true, a resource will be returned
- *
- * @return string|resource
- */
- public function getContent(bool $asResource = false)
- {
- $currentContentIsResource = \is_resource($this->content);
- if (true === $asResource) {
- if ($currentContentIsResource) {
- rewind($this->content);
- return $this->content;
- }
- // Content passed in parameter (test)
- if (\is_string($this->content)) {
- $resource = fopen('php://temp', 'r+');
- fwrite($resource, $this->content);
- rewind($resource);
- return $resource;
- }
- $this->content = false;
- return fopen('php://input', 'r');
- }
- if ($currentContentIsResource) {
- rewind($this->content);
- return stream_get_contents($this->content);
- }
- if (null === $this->content || false === $this->content) {
- $this->content = file_get_contents('php://input');
- }
- return $this->content;
- }
- /**
- * Gets the request body decoded as array, typically from a JSON payload.
- *
- * @throws JsonException When the body cannot be decoded to an array
- *
- * @return array
- */
- public function toArray()
- {
- if ('' === $content = $this->getContent()) {
- throw new JsonException('Request body is empty.');
- }
- try {
- $content = json_decode($content, true, 512, \JSON_BIGINT_AS_STRING | (\PHP_VERSION_ID >= 70300 ? \JSON_THROW_ON_ERROR : 0));
- } catch (\JsonException $e) {
- throw new JsonException('Could not decode request body.', $e->getCode(), $e);
- }
- if (\PHP_VERSION_ID < 70300 && \JSON_ERROR_NONE !== json_last_error()) {
- throw new JsonException('Could not decode request body: '.json_last_error_msg(), json_last_error());
- }
- if (!\is_array($content)) {
- throw new JsonException(sprintf('JSON content was expected to decode to an array, "%s" returned.', get_debug_type($content)));
- }
- return $content;
- }
- /**
- * Gets the Etags.
- *
- * @return array
- */
- public function getETags()
- {
- return preg_split('/\s*,\s*/', $this->headers->get('If-None-Match', ''), -1, \PREG_SPLIT_NO_EMPTY);
- }
- /**
- * @return bool
- */
- public function isNoCache()
- {
- return $this->headers->hasCacheControlDirective('no-cache') || 'no-cache' == $this->headers->get('Pragma');
- }
- /**
- * Gets the preferred format for the response by inspecting, in the following order:
- * * the request format set using setRequestFormat;
- * * the values of the Accept HTTP header.
- *
- * Note that if you use this method, you should send the "Vary: Accept" header
- * in the response to prevent any issues with intermediary HTTP caches.
- */
- public function getPreferredFormat(?string $default = 'html'): ?string
- {
- if (null !== $this->preferredFormat || null !== $this->preferredFormat = $this->getRequestFormat(null)) {
- return $this->preferredFormat;
- }
- foreach ($this->getAcceptableContentTypes() as $mimeType) {
- if ($this->preferredFormat = $this->getFormat($mimeType)) {
- return $this->preferredFormat;
- }
- }
- return $default;
- }
- /**
- * Returns the preferred language.
- *
- * @param string[] $locales An array of ordered available locales
- *
- * @return string|null
- */
- public function getPreferredLanguage(array $locales = null)
- {
- $preferredLanguages = $this->getLanguages();
- if (empty($locales)) {
- return $preferredLanguages[0] ?? null;
- }
- if (!$preferredLanguages) {
- return $locales[0];
- }
- $extendedPreferredLanguages = [];
- foreach ($preferredLanguages as $language) {
- $extendedPreferredLanguages[] = $language;
- if (false !== $position = strpos($language, '_')) {
- $superLanguage = substr($language, 0, $position);
- if (!\in_array($superLanguage, $preferredLanguages)) {
- $extendedPreferredLanguages[] = $superLanguage;
- }
- }
- }
- $preferredLanguages = array_values(array_intersect($extendedPreferredLanguages, $locales));
- return $preferredLanguages[0] ?? $locales[0];
- }
- /**
- * Gets a list of languages acceptable by the client browser ordered in the user browser preferences.
- *
- * @return array
- */
- public function getLanguages()
- {
- if (null !== $this->languages) {
- return $this->languages;
- }
- $languages = AcceptHeader::fromString($this->headers->get('Accept-Language'))->all();
- $this->languages = [];
- foreach ($languages as $lang => $acceptHeaderItem) {
- if (str_contains($lang, '-')) {
- $codes = explode('-', $lang);
- if ('i' === $codes[0]) {
- // Language not listed in ISO 639 that are not variants
- // of any listed language, which can be registered with the
- // i-prefix, such as i-cherokee
- if (\count($codes) > 1) {
- $lang = $codes[1];
- }
- } else {
- for ($i = 0, $max = \count($codes); $i < $max; ++$i) {
- if (0 === $i) {
- $lang = strtolower($codes[0]);
- } else {
- $lang .= '_'.strtoupper($codes[$i]);
- }
- }
- }
- }
- $this->languages[] = $lang;
- }
- return $this->languages;
- }
- /**
- * Gets a list of charsets acceptable by the client browser in preferable order.
- *
- * @return array
- */
- public function getCharsets()
- {
- if (null !== $this->charsets) {
- return $this->charsets;
- }
- return $this->charsets = array_keys(AcceptHeader::fromString($this->headers->get('Accept-Charset'))->all());
- }
- /**
- * Gets a list of encodings acceptable by the client browser in preferable order.
- *
- * @return array
- */
- public function getEncodings()
- {
- if (null !== $this->encodings) {
- return $this->encodings;
- }
- return $this->encodings = array_keys(AcceptHeader::fromString($this->headers->get('Accept-Encoding'))->all());
- }
- /**
- * Gets a list of content types acceptable by the client browser in preferable order.
- *
- * @return array
- */
- public function getAcceptableContentTypes()
- {
- if (null !== $this->acceptableContentTypes) {
- return $this->acceptableContentTypes;
- }
- return $this->acceptableContentTypes = array_keys(AcceptHeader::fromString($this->headers->get('Accept'))->all());
- }
- /**
- * Returns true if the request is an XMLHttpRequest.
- *
- * It works if your JavaScript library sets an X-Requested-With HTTP header.
- * It is known to work with common JavaScript frameworks:
- *
- * @see https://wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
- *
- * @return bool
- */
- public function isXmlHttpRequest()
- {
- return 'XMLHttpRequest' == $this->headers->get('X-Requested-With');
- }
- /**
- * Checks whether the client browser prefers safe content or not according to RFC8674.
- *
- * @see https://tools.ietf.org/html/rfc8674
- */
- public function preferSafeContent(): bool
- {
- if (null !== $this->isSafeContentPreferred) {
- return $this->isSafeContentPreferred;
- }
- if (!$this->isSecure()) {
- // see https://tools.ietf.org/html/rfc8674#section-3
- return $this->isSafeContentPreferred = false;
- }
- return $this->isSafeContentPreferred = AcceptHeader::fromString($this->headers->get('Prefer'))->has('safe');
- }
- /*
- * The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)
- *
- * Code subject to the new BSD license (https://framework.zend.com/license).
- *
- * Copyright (c) 2005-2010 Zend Technologies USA Inc. (https://www.zend.com/)
- */
- protected function prepareRequestUri()
- {
- $requestUri = '';
- if ('1' == $this->server->get('IIS_WasUrlRewritten') && '' != $this->server->get('UNENCODED_URL')) {
- // IIS7 with URL Rewrite: make sure we get the unencoded URL (double slash problem)
- $requestUri = $this->server->get('UNENCODED_URL');
- $this->server->remove('UNENCODED_URL');
- $this->server->remove('IIS_WasUrlRewritten');
- } elseif ($this->server->has('REQUEST_URI')) {
- $requestUri = $this->server->get('REQUEST_URI');
- if ('' !== $requestUri && '/' === $requestUri[0]) {
- // To only use path and query remove the fragment.
- if (false !== $pos = strpos($requestUri, '#')) {
- $requestUri = substr($requestUri, 0, $pos);
- }
- } else {
- // HTTP proxy reqs setup request URI with scheme and host [and port] + the URL path,
- // only use URL path.
- $uriComponents = parse_url($requestUri);
- if (isset($uriComponents['path'])) {
- $requestUri = $uriComponents['path'];
- }
- if (isset($uriComponents['query'])) {
- $requestUri .= '?'.$uriComponents['query'];
- }
- }
- } elseif ($this->server->has('ORIG_PATH_INFO')) {
- // IIS 5.0, PHP as CGI
- $requestUri = $this->server->get('ORIG_PATH_INFO');
- if ('' != $this->server->get('QUERY_STRING')) {
- $requestUri .= '?'.$this->server->get('QUERY_STRING');
- }
- $this->server->remove('ORIG_PATH_INFO');
- }
- // normalize the request URI to ease creating sub-requests from this request
- $this->server->set('REQUEST_URI', $requestUri);
- return $requestUri;
- }
- /**
- * Prepares the base URL.
- *
- * @return string
- */
- protected function prepareBaseUrl()
- {
- $filename = basename($this->server->get('SCRIPT_FILENAME', ''));
- if (basename($this->server->get('SCRIPT_NAME', '')) === $filename) {
- $baseUrl = $this->server->get('SCRIPT_NAME');
- } elseif (basename($this->server->get('PHP_SELF', '')) === $filename) {
- $baseUrl = $this->server->get('PHP_SELF');
- } elseif (basename($this->server->get('ORIG_SCRIPT_NAME', '')) === $filename) {
- $baseUrl = $this->server->get('ORIG_SCRIPT_NAME'); // 1and1 shared hosting compatibility
- } else {
- // Backtrack up the script_filename to find the portion matching
- // php_self
- $path = $this->server->get('PHP_SELF', '');
- $file = $this->server->get('SCRIPT_FILENAME', '');
- $segs = explode('/', trim($file, '/'));
- $segs = array_reverse($segs);
- $index = 0;
- $last = \count($segs);
- $baseUrl = '';
- do {
- $seg = $segs[$index];
- $baseUrl = '/'.$seg.$baseUrl;
- ++$index;
- } while ($last > $index && (false !== $pos = strpos($path, $baseUrl)) && 0 != $pos);
- }
- // Does the baseUrl have anything in common with the request_uri?
- $requestUri = $this->getRequestUri();
- if ('' !== $requestUri && '/' !== $requestUri[0]) {
- $requestUri = '/'.$requestUri;
- }
- if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, $baseUrl)) {
- // full $baseUrl matches
- return $prefix;
- }
- if ($baseUrl && null !== $prefix = $this->getUrlencodedPrefix($requestUri, rtrim(\dirname($baseUrl), '/'.\DIRECTORY_SEPARATOR).'/')) {
- // directory portion of $baseUrl matches
- return rtrim($prefix, '/'.\DIRECTORY_SEPARATOR);
- }
- $truncatedRequestUri = $requestUri;
- if (false !== $pos = strpos($requestUri, '?')) {
- $truncatedRequestUri = substr($requestUri, 0, $pos);
- }
- $basename = basename($baseUrl ?? '');
- if (empty($basename) || !strpos(rawurldecode($truncatedRequestUri), $basename)) {
- // no match whatsoever; set it blank
- return '';
- }
- // If using mod_rewrite or ISAPI_Rewrite strip the script filename
- // out of baseUrl. $pos !== 0 makes sure it is not matching a value
- // from PATH_INFO or QUERY_STRING
- if (\strlen($requestUri) >= \strlen($baseUrl) && (false !== $pos = strpos($requestUri, $baseUrl)) && 0 !== $pos) {
- $baseUrl = substr($requestUri, 0, $pos + \strlen($baseUrl));
- }
- return rtrim($baseUrl, '/'.\DIRECTORY_SEPARATOR);
- }
- /**
- * Prepares the base path.
- *
- * @return string
- */
- protected function prepareBasePath()
- {
- $baseUrl = $this->getBaseUrl();
- if (empty($baseUrl)) {
- return '';
- }
- $filename = basename($this->server->get('SCRIPT_FILENAME'));
- if (basename($baseUrl) === $filename) {
- $basePath = \dirname($baseUrl);
- } else {
- $basePath = $baseUrl;
- }
- if ('\\' === \DIRECTORY_SEPARATOR) {
- $basePath = str_replace('\\', '/', $basePath);
- }
- return rtrim($basePath, '/');
- }
- /**
- * Prepares the path info.
- *
- * @return string
- */
- protected function preparePathInfo()
- {
- if (null === ($requestUri = $this->getRequestUri())) {
- return '/';
- }
- // Remove the query string from REQUEST_URI
- if (false !== $pos = strpos($requestUri, '?')) {
- $requestUri = substr($requestUri, 0, $pos);
- }
- if ('' !== $requestUri && '/' !== $requestUri[0]) {
- $requestUri = '/'.$requestUri;
- }
- if (null === ($baseUrl = $this->getBaseUrlReal())) {
- return $requestUri;
- }
- $pathInfo = substr($requestUri, \strlen($baseUrl));
- if (false === $pathInfo || '' === $pathInfo) {
- // If substr() returns false then PATH_INFO is set to an empty string
- return '/';
- }
- return $pathInfo;
- }
- /**
- * Initializes HTTP request formats.
- */
- protected static function initializeFormats()
- {
- static::$formats = [
- 'html' => ['text/html', 'application/xhtml+xml'],
- 'txt' => ['text/plain'],
- 'js' => ['application/javascript', 'application/x-javascript', 'text/javascript'],
- 'css' => ['text/css'],
- 'json' => ['application/json', 'application/x-json'],
- 'jsonld' => ['application/ld+json'],
- 'xml' => ['text/xml', 'application/xml', 'application/x-xml'],
- 'rdf' => ['application/rdf+xml'],
- 'atom' => ['application/atom+xml'],
- 'rss' => ['application/rss+xml'],
- 'form' => ['application/x-www-form-urlencoded', 'multipart/form-data'],
- ];
- }
- private function setPhpDefaultLocale(string $locale): void
- {
- // if either the class Locale doesn't exist, or an exception is thrown when
- // setting the default locale, the intl module is not installed, and
- // the call can be ignored:
- try {
- if (class_exists(\Locale::class, false)) {
- \Locale::setDefault($locale);
- }
- } catch (\Exception $e) {
- }
- }
- /**
- * Returns the prefix as encoded in the string when the string starts with
- * the given prefix, null otherwise.
- */
- private function getUrlencodedPrefix(string $string, string $prefix): ?string
- {
- if (!str_starts_with(rawurldecode($string), $prefix)) {
- return null;
- }
- $len = \strlen($prefix);
- if (preg_match(sprintf('#^(%%[[:xdigit:]]{2}|.){%d}#', $len), $string, $match)) {
- return $match[0];
- }
- return null;
- }
- private static function createRequestFromFactory(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null): self
- {
- if (self::$requestFactory) {
- $request = (self::$requestFactory)($query, $request, $attributes, $cookies, $files, $server, $content);
- if (!$request instanceof self) {
- throw new \LogicException('The Request factory must return an instance of Symfony\Component\HttpFoundation\Request.');
- }
- return $request;
- }
- return new static($query, $request, $attributes, $cookies, $files, $server, $content);
- }
- /**
- * Indicates whether this request originated from a trusted proxy.
- *
- * This can be useful to determine whether or not to trust the
- * contents of a proxy-specific header.
- *
- * @return bool
- */
- public function isFromTrustedProxy()
- {
- return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR', ''), self::$trustedProxies);
- }
- private function getTrustedValues(int $type, string $ip = null): array
- {
- $clientValues = [];
- $forwardedValues = [];
- if ((self::$trustedHeaderSet & $type) && $this->headers->has(self::TRUSTED_HEADERS[$type])) {
- foreach (explode(',', $this->headers->get(self::TRUSTED_HEADERS[$type])) as $v) {
- $clientValues[] = (self::HEADER_X_FORWARDED_PORT === $type ? '0.0.0.0:' : '').trim($v);
- }
- }
- if ((self::$trustedHeaderSet & self::HEADER_FORWARDED) && (isset(self::FORWARDED_PARAMS[$type])) && $this->headers->has(self::TRUSTED_HEADERS[self::HEADER_FORWARDED])) {
- $forwarded = $this->headers->get(self::TRUSTED_HEADERS[self::HEADER_FORWARDED]);
- $parts = HeaderUtils::split($forwarded, ',;=');
- $forwardedValues = [];
- $param = self::FORWARDED_PARAMS[$type];
- foreach ($parts as $subParts) {
- if (null === $v = HeaderUtils::combine($subParts)[$param] ?? null) {
- continue;
- }
- if (self::HEADER_X_FORWARDED_PORT === $type) {
- if (str_ends_with($v, ']') || false === $v = strrchr($v, ':')) {
- $v = $this->isSecure() ? ':443' : ':80';
- }
- $v = '0.0.0.0'.$v;
- }
- $forwardedValues[] = $v;
- }
- }
- if (null !== $ip) {
- $clientValues = $this->normalizeAndFilterClientIps($clientValues, $ip);
- $forwardedValues = $this->normalizeAndFilterClientIps($forwardedValues, $ip);
- }
- if ($forwardedValues === $clientValues || !$clientValues) {
- return $forwardedValues;
- }
- if (!$forwardedValues) {
- return $clientValues;
- }
- if (!$this->isForwardedValid) {
- return null !== $ip ? ['0.0.0.0', $ip] : [];
- }
- $this->isForwardedValid = false;
- throw new ConflictingHeadersException(sprintf('The request has both a trusted "%s" header and a trusted "%s" header, conflicting with each other. You should either configure your proxy to remove one of them, or configure your project to distrust the offending one.', self::TRUSTED_HEADERS[self::HEADER_FORWARDED], self::TRUSTED_HEADERS[$type]));
- }
- private function normalizeAndFilterClientIps(array $clientIps, string $ip): array
- {
- if (!$clientIps) {
- return [];
- }
- $clientIps[] = $ip; // Complete the IP chain with the IP the request actually came from
- $firstTrustedIp = null;
- foreach ($clientIps as $key => $clientIp) {
- if (strpos($clientIp, '.')) {
- // Strip :port from IPv4 addresses. This is allowed in Forwarded
- // and may occur in X-Forwarded-For.
- $i = strpos($clientIp, ':');
- if ($i) {
- $clientIps[$key] = $clientIp = substr($clientIp, 0, $i);
- }
- } elseif (str_starts_with($clientIp, '[')) {
- // Strip brackets and :port from IPv6 addresses.
- $i = strpos($clientIp, ']', 1);
- $clientIps[$key] = $clientIp = substr($clientIp, 1, $i - 1);
- }
- if (!filter_var($clientIp, \FILTER_VALIDATE_IP)) {
- unset($clientIps[$key]);
- continue;
- }
- if (IpUtils::checkIp($clientIp, self::$trustedProxies)) {
- unset($clientIps[$key]);
- // Fallback to this when the client IP falls into the range of trusted proxies
- if (null === $firstTrustedIp) {
- $firstTrustedIp = $clientIp;
- }
- }
- }
- // Now the IP chain contains only untrusted proxies and the client IP
- return $clientIps ? array_reverse($clientIps) : [$firstTrustedIp];
- }
- }
|