73 protected $headers = [];
85 private static $reqId;
122 protected $markedAsSafe =
false;
128 $this->requestTime = $_SERVER[
'REQUEST_TIME_FLOAT'];
132 $this->data = $_POST + $_GET;
134 $this->queryAndPathParams = $this->queryParams = $_GET;
161 if ( isset( $_SERVER[
'REQUEST_URI'] ) ) {
163 $url = $_SERVER[
'REQUEST_URI'];
164 if ( !preg_match(
'!^https?://!', $url ) ) {
165 $url =
'http://unused' . $url;
167 $a = parse_url( $url );
171 $path = $a[
'path'] ??
'';
183 $router->
add(
"$wgScript/$1" );
193 if ( $articlePaths ) {
194 $router->add( $articlePaths, [
'action' =>
'$key' ] );
199 $services = MediaWikiServices::getInstance();
202 [
'variant' =>
'$2' ],
203 [
'$2' => $services->getLanguageConverterFactory()
204 ->getLanguageConverter( $services->getContentLanguage() )
209 Hooks::runner()->onWebRequestPathInfoRouter( $router );
216 if ( !empty( $_SERVER[
'ORIG_PATH_INFO'] ) ) {
220 $matches[
'title'] = substr( $_SERVER[
'ORIG_PATH_INFO'], 1 );
221 } elseif ( !empty( $_SERVER[
'PATH_INFO'] ) ) {
223 $matches[
'title'] = substr( $_SERVER[
'PATH_INFO'], 1 );
243 $basePath = rtrim( $basePath,
'/' ) .
'/';
244 $requestUrl = self::getGlobalRequestURL();
245 $qpos = strpos( $requestUrl,
'?' );
246 if ( $qpos !==
false ) {
247 $requestPath = substr( $requestUrl, 0, $qpos );
249 $requestPath = $requestUrl;
251 if ( !str_starts_with( $requestPath, $basePath ) ) {
254 return rawurldecode( substr( $requestPath, strlen( $basePath ) ) );
268 public static function detectServer( $assumeProxiesUseDefaultProtocolPorts =
null ) {
269 $assumeProxiesUseDefaultProtocolPorts ??= $GLOBALS[
'wgAssumeProxiesUseDefaultProtocolPorts'];
271 $proto = self::detectProtocol();
272 $stdPort = $proto ===
'https' ? 443 : 80;
274 $varNames = [
'HTTP_HOST',
'SERVER_NAME',
'HOSTNAME',
'SERVER_ADDR' ];
277 foreach ( $varNames as $varName ) {
278 if ( !isset( $_SERVER[$varName] ) ) {
282 $parts = IPUtils::splitHostAndPort( $_SERVER[$varName] );
289 if ( $assumeProxiesUseDefaultProtocolPorts && isset( $_SERVER[
'HTTP_X_FORWARDED_PROTO'] ) ) {
294 } elseif ( $parts[1] ===
false ) {
295 if ( isset( $_SERVER[
'SERVER_PORT'] ) ) {
296 $port = $_SERVER[
'SERVER_PORT'];
304 return $proto .
'://' . IPUtils::combineHostAndPort( $host, $port, $stdPort );
315 if ( ( !empty( $_SERVER[
'HTTPS'] ) && $_SERVER[
'HTTPS'] !==
'off' ) ||
316 ( isset( $_SERVER[
'HTTP_X_FORWARDED_PROTO'] ) &&
317 $_SERVER[
'HTTP_X_FORWARDED_PROTO'] ===
'https' ) ) {
332 return microtime(
true ) - $this->requestTime;
346 if ( !self::$reqId ) {
349 $id = $_SERVER[
'HTTP_X_REQUEST_ID'] ?? $_SERVER[
'UNIQUE_ID'] ??
wfRandomString( 24 );
375 $this->protocol ??= self::detectProtocol();
376 return $this->protocol;
387 $matches = self::getPathInfo(
'title' );
388 foreach (
$matches as $key => $val ) {
389 $this->data[$key] = $this->queryAndPathParams[$key] = $val;
404 foreach ( (array)$bases as $keyValue =>
$base ) {
407 $baseLen = strlen(
$base );
408 if ( substr(
$path, 0, $baseLen ) ==
$base ) {
409 $raw = substr(
$path, $baseLen );
411 $matches = [
'title' => rawurldecode( $raw ) ];
430 if ( is_array( $data ) ) {
431 foreach ( $data as $key => $val ) {
435 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
436 $data = $contLang->normalize( $data );
449 private function getGPCVal( $arr, $name, $default ) {
450 # PHP is so nice to not touch input data, except sometimes:
452 # Work around PHP *feature* to avoid *bugs* elsewhere.
453 $name = strtr( $name,
'.',
'_' );
455 if ( !isset( $arr[$name] ) ) {
460 # Optimisation: Skip UTF-8 normalization and legacy transcoding for simple ASCII strings.
461 $isAsciiStr = ( is_string( $data ) && preg_match(
'/[^\x20-\x7E]/', $data ) === 0 );
462 if ( !$isAsciiStr ) {
463 if ( isset( $_GET[$name] ) && is_string( $data ) ) {
464 # Check for alternate/legacy character encoding.
465 $data = MediaWikiServices::getInstance()
466 ->getContentLanguage()
467 ->checkTitleEncoding( $data );
488 $name = strtr( $name,
'.',
'_' );
489 if ( isset( $this->data[$name] ) && !is_array( $this->data[$name] ) ) {
490 $val = $this->data[$name];
495 return $val ===
null ? null : (string)$val;
514 public function getVal( $name, $default =
null ) {
515 $val = $this->getGPCVal( $this->data, $name, $default );
516 if ( is_array( $val ) ) {
520 return $val ===
null ? null : (string)$val;
539 public function getText( $name, $default =
'' ) {
540 $val = $this->
getVal( $name, $default );
541 return str_replace(
"\r\n",
"\n", $val );
552 $ret = $this->data[$key] ??
null;
553 $this->data[$key] = $value;
564 if ( !isset( $this->data[$key] ) ) {
567 $ret = $this->data[$key];
568 unset( $this->data[$key] );
582 public function getArray( $name, $default =
null ) {
583 $val = $this->getGPCVal( $this->data, $name, $default );
584 if ( $val ===
null ) {
602 $val = $this->
getArray( $name, $default );
603 if ( is_array( $val ) ) {
604 $val = array_map(
'intval', $val );
618 public function getInt( $name, $default = 0 ) {
620 return intval( $this->
getRawVal( $name, $default ) );
633 return is_numeric( $val )
648 public function getFloat( $name, $default = 0.0 ) {
650 return floatval( $this->
getRawVal( $name, $default ) );
662 public function getBool( $name, $default =
false ) {
664 return (
bool)$this->
getRawVal( $name, $default );
677 return $this->
getBool( $name, $default )
678 && strcasecmp( $this->
getRawVal( $name ),
'false' ) !== 0;
690 # Checkboxes and buttons are only present when clicked
691 # Presence connotes truth, absence false
692 return $this->
getRawVal( $name,
null ) !==
null;
703 if ( $names === [] ) {
704 $names = array_keys( $this->data );
708 foreach ( $names as $name ) {
709 $value = $this->getGPCVal( $this->data, $name,
null );
710 if ( $value !==
null ) {
711 $retVal[$name] = $value;
724 return array_diff( array_keys( $this->
getValues() ), $exclude );
735 return $this->queryAndPathParams;
748 return $this->queryParams;
771 return $_SERVER[
'QUERY_STRING'];
795 static $input =
null;
796 $input ??= file_get_contents(
'php://input' );
806 return $_SERVER[
'REQUEST_METHOD'] ??
'GET';
833 if ( $this->sessionId !==
null ) {
834 $session = SessionManager::singleton()->getSessionById( (
string)$this->sessionId,
true, $this );
840 $session = SessionManager::singleton()->getSessionForRequest( $this );
841 $this->sessionId = $session->getSessionId();
852 $this->sessionId = $sessionId;
862 return $this->sessionId;
873 public function getCookie( $key, $prefix =
null, $default =
null ) {
874 if ( $prefix ===
null ) {
878 $name = $prefix . $key;
880 $name = strtr( $name,
'.',
'_' );
881 if ( isset( $_COOKIE[$name] ) ) {
882 return $_COOKIE[$name];
898 $name = $prefix . $key;
900 $name = strtr( $name,
'.',
'_' );
901 if ( isset( $_COOKIE[$name] ) ) {
902 return $_COOKIE[$name];
905 $legacyName = $prefix .
"ss0-" . $key;
906 $legacyName = strtr( $legacyName,
'.',
'_' );
907 if ( isset( $_COOKIE[$legacyName] ) ) {
908 return $_COOKIE[$legacyName];
924 if ( isset( $_SERVER[
'REQUEST_URI'] ) && strlen( $_SERVER[
'REQUEST_URI'] ) ) {
925 $base = $_SERVER[
'REQUEST_URI'];
926 } elseif ( isset( $_SERVER[
'HTTP_X_ORIGINAL_URL'] )
927 && strlen( $_SERVER[
'HTTP_X_ORIGINAL_URL'] )
930 $base = $_SERVER[
'HTTP_X_ORIGINAL_URL'];
931 } elseif ( isset( $_SERVER[
'SCRIPT_NAME'] ) ) {
932 $base = $_SERVER[
'SCRIPT_NAME'];
933 if ( isset( $_SERVER[
'QUERY_STRING'] ) && $_SERVER[
'QUERY_STRING'] !=
'' ) {
934 $base .=
'?' . $_SERVER[
'QUERY_STRING'];
938 throw new MWException(
"Web server doesn't provide either " .
939 "REQUEST_URI, HTTP_X_ORIGINAL_URL or SCRIPT_NAME. Report details " .
940 "of your web server configuration to https://phabricator.wikimedia.org/" );
946 $hash = strpos(
$base,
'#' );
947 if ( $hash !==
false ) {
951 if (
$base[0] ==
'/' ) {
953 return preg_replace(
'!^/+!',
'/',
$base );
956 return preg_replace(
'!^[^:]+://[^/]+/+!',
'/',
$base );
968 return self::getGlobalRequestURL();
1009 unset( $newquery[
'title'] );
1010 $newquery = array_merge( $newquery, $array );
1026 $limit = $this->
getInt(
'limit', 0 );
1030 if ( ( $limit == 0 ) && ( $optionname !=
'' ) ) {
1031 $limit = MediaWikiServices::getInstance()
1032 ->getUserOptionsLookup()
1033 ->getIntOption( $user, $optionname );
1035 if ( $limit <= 0 ) {
1038 if ( $limit > 5000 ) {
1039 $limit = 5000; # We have *some* limits...
1042 $offset = $this->
getInt(
'offset', 0 );
1043 if ( $offset < 0 ) {
1047 return [ $limit, $offset ];
1057 return $this->
getUpload( $key )->getTempName();
1067 return $this->
getUpload( $key )->getError();
1082 return $this->
getUpload( $key )->getName();
1103 if ( !is_object( $this->
response ) ) {
1104 $class = ( $this instanceof
FauxRequest ) ? FauxResponse::class : WebResponse::class;
1107 return $this->response;
1114 if ( count( $this->headers ) ) {
1118 $this->headers = array_change_key_case( getallheaders(), CASE_UPPER );
1128 return $this->headers;
1145 $name = strtoupper( $name );
1146 if ( !isset( $this->headers[$name] ) ) {
1149 $value = $this->headers[$name];
1150 if ( $flags & self::GETHEADER_LIST ) {
1151 $value = array_map(
'trim', explode(
',', $value ) );
1192 $acceptLang = $this->
getHeader(
'Accept-Language' );
1193 if ( !$acceptLang ) {
1198 $acceptLang = strtolower( $acceptLang );
1201 if ( !preg_match_all(
1203 # a language code or a star is required
1204 ([a-z]{1,8}(?:-[a-z]{1,8})*|\*)
1205 # from here everything is optional
1208 # this accepts only numbers in the range ;q=0.000 to ;q=1.000
1210 (1(?:\.0{0,3})?|0(?:\.\d{0,3})?)?
1223 $languageCode = $match[1];
1225 $qValue = (float)( $match[2] ?? 1.0 );
1227 $langs[$languageCode] = $qValue;
1232 arsort( $langs, SORT_NUMERIC );
1243 $remoteAddr = $_SERVER[
'REMOTE_ADDR'] ??
null;
1244 if ( !$remoteAddr ) {
1247 if ( is_array( $remoteAddr ) || str_contains( $remoteAddr,
',' ) ) {
1248 throw new MWException(
'Remote IP must not contain multiple values' );
1251 return IPUtils::canonicalize( $remoteAddr );
1264 # Return cached result
1265 if ( $this->ip !==
null ) {
1269 # collect the originating IPs
1272 throw new MWException(
'Unable to determine IP.' );
1276 $forwardedFor = $this->
getHeader(
'X-Forwarded-For' );
1277 if ( $forwardedFor !==
false ) {
1278 $proxyLookup = MediaWikiServices::getInstance()->getProxyLookup();
1279 $isConfigured = $proxyLookup->isConfiguredProxy( $ip );
1280 $ipchain = array_map(
'trim', explode(
',', $forwardedFor ) );
1281 $ipchain = array_reverse( $ipchain );
1282 array_unshift( $ipchain, $ip );
1284 # Step through XFF list and find the last address in the list which is a
1285 # trusted server. Set $ip to the IP address given by that trusted server,
1286 # unless the address is not sensible (e.g. private). However, prefer private
1287 # IP addresses over proxy servers controlled by this site (more sensible).
1288 # Note that some XFF values might be "unknown" with Squid/Varnish.
1289 foreach ( $ipchain as $i => $curIP ) {
1290 $curIP = IPUtils::sanitizeIP(
1291 IPUtils::canonicalize(
1292 self::canonicalizeIPv6LoopbackAddress( $curIP )
1295 if ( !$curIP || !isset( $ipchain[$i + 1] ) || $ipchain[$i + 1] ===
'unknown'
1296 || !$proxyLookup->isTrustedProxy( $curIP )
1301 IPUtils::isPublic( $ipchain[$i + 1] ) ||
1304 $proxyLookup->isConfiguredProxy( $curIP )
1306 $nextIP = $ipchain[$i + 1];
1309 $nextIP = IPUtils::canonicalize(
1310 self::canonicalizeIPv6LoopbackAddress( $nextIP )
1312 if ( !$nextIP && $isConfigured ) {
1315 throw new MWException(
"Invalid IP given in XFF '$forwardedFor'." );
1328 if ( Hooks::isRegistered(
'GetIP' ) ) {
1330 Hooks::runner()->onGetIP( $ip );
1334 throw new MWException(
'Unable to determine IP.' );
1352 if ( preg_match(
'/^0*' . IPUtils::RE_IPV6_GAP .
'1$/', $ip, $m ) ) {
1380 if ( !isset( $_SERVER[
'REQUEST_METHOD'] ) ) {
1384 return in_array( $_SERVER[
'REQUEST_METHOD'], [
'GET',
'HEAD',
'OPTIONS',
'TRACE' ] );
1406 if ( $this->markedAsSafe && $this->
wasPosted() ) {
1424 $this->markedAsSafe =
true;
1440 $config = MediaWikiServices::getInstance()->getMainConfig();
1441 if ( $config->get( MainConfigNames::CdnMatchParameterOrder ) ) {
1443 return in_array( $reqUrl, $cdnUrls,
true );
1447 $reqUrlParts = explode(
'?', $reqUrl, 2 );
1448 $reqUrlBase = $reqUrlParts[0];
1449 $reqUrlParams = count( $reqUrlParts ) === 2 ? explode(
'&', $reqUrlParts[1] ) : [];
1454 sort( $reqUrlParams );
1455 foreach ( $cdnUrls as $cdnUrl ) {
1456 if ( strlen( $reqUrl ) !== strlen( $cdnUrl ) ) {
1459 $cdnUrlParts = explode(
'?', $cdnUrl, 2 );
1460 $cdnUrlBase = $cdnUrlParts[0];
1461 if ( $reqUrlBase !== $cdnUrlBase ) {
1464 $cdnUrlParams = count( $cdnUrlParts ) === 2 ? explode(
'&', $cdnUrlParts[1] ) : [];
1465 sort( $cdnUrlParams );
1466 if ( $reqUrlParams === $cdnUrlParams ) {
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfGetServerUrl( $proto)
Get the wiki's "server", i.e.
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
A class containing constants representing the names of configuration variables.
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
matchURLForCDN(array $cdnUrls)
Determine if the request URL matches one of a given set of canonical CDN URLs.
markAsSafeRequest()
Mark this request as identified as being nullipotent even if it is a POST request.
getIntOrNull( $name)
Fetch an integer value from the input or return null if empty.
getLimitOffsetForUser(UserIdentity $user, $deflimit=50, $optionname='rclimit')
Check for limit and offset parameters on the input, and return sensible defaults if not given.
getValueNames( $exclude=[])
Returns the names of all input values excluding those in $exclude.
bool $markedAsSafe
Whether this HTTP request is "safe" (even if it is an HTTP post)
getUpload( $key)
Return a MediaWiki\Request\WebRequestUpload object corresponding to the key.
string $protocol
Cached URL protocol.
getArray( $name, $default=null)
Fetch an array from the input or return $default if it's not set.
interpolateTitle()
Check for title, action, and/or variant data in the URL and interpolate it into the GET variables.
getPostValues()
Get the values passed via POST.
static detectProtocol()
Detect the protocol from $_SERVER.
isSafeRequest()
Whether this request should be identified as being "safe".
getSession()
Return the session for this request.
getRawInput()
Return the raw request body, with no processing.
getValues(... $names)
Extracts the (given) named values into an array.
getRawQueryString()
Return the contents of the Query with no decoding.
getFileTempname( $key)
Return the path to the temporary file where PHP has stored the upload.
getVal( $name, $default=null)
Fetch a text string and partially normalized it.
getFloat( $name, $default=0.0)
Fetch a floating point value from the input or return $default if not set.
string string[][] $queryParams
The parameters from $_GET only.
getUploadError( $key)
Return the upload error or 0.
getAllHeaders()
Get an array containing all request headers.
getFuzzyBool( $name, $default=false)
Fetch a boolean value from the input or return $default if not set.
static getRequestId()
Get the current request ID.
getProtocol()
Get the current URL protocol (http or https)
getMethod()
Get the HTTP method used for this request.
initHeaders()
Initialise the header list.
getBool( $name, $default=false)
Fetch a boolean value from the input or return $default if not set.
static getRequestPathSuffix( $basePath)
If the request URL matches a given base path, extract the path part of the request URL after that bas...
string string[][] $queryAndPathParams
The parameters from $_GET.
static getGlobalRequestURL()
Return the path and query string portion of the main request URI.
setVal( $key, $value)
Set an arbitrary value into our get/post data.
getFullRequestURL()
Return the request URI with the canonical service and hostname, path, and query string.
getElapsedTime()
Get the number of seconds to have elapsed since request start, in fractional seconds,...
float $requestTime
The timestamp of the start of the request, with microsecond precision.
string[] $headers
Lazy-initialized request headers indexed by upper-case header name.
getCrossSiteCookie( $key, $prefix='', $default=null)
Get a cookie set with SameSite=None possibly with a legacy fallback cookie.
getCheck( $name)
Return true if the named value is set in the input, whatever that value is (even "0").
appendQueryArray( $array)
Appends or replaces value of query variables.
getSessionId()
Get the session id for this request, if any.
getAcceptLang()
Parse the Accept-Language header sent by the client into an array.
static canonicalizeIPv6LoopbackAddress( $ip)
Converts ::1 (IPv6 loopback address) to 127.0.0.1 (IPv4 loopback address); assists in matching truste...
getRawPostString()
Return the contents of the POST with no decoding.
getQueryValues()
Get the values passed in the query string and the path router parameters.
response()
Return a handle to WebResponse style object, for setting cookies, headers and other stuff,...
getIP()
Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of...
static detectServer( $assumeProxiesUseDefaultProtocolPorts=null)
Work out an appropriate URL prefix containing scheme and host, based on information detected from $_S...
getInt( $name, $default=0)
Fetch an integer value from the input or return $default if not set.
wasPosted()
Returns true if the present request was reached by a POST operation, false otherwise (GET,...
setSessionData( $key, $data)
getFileName( $key)
Return the original filename of the uploaded file, as reported by the submitting user agent.
const GETHEADER_LIST
Flag to make WebRequest::getHeader return an array of values.
hasSafeMethod()
Check if this request uses a "safe" HTTP method.
getRawVal( $name, $default=null)
Fetch a string WITHOUT any Unicode or line break normalization.
getIntArray( $name, $default=null)
Fetch an array of integers, or return $default if it's not set.
appendQueryValue( $key, $value)
normalizeUnicode( $data)
Recursively normalizes UTF-8 strings in the given array.
static overrideRequestId( $id)
Override the unique request ID.
unsetVal( $key)
Unset an arbitrary value from our get/post data.
static getPathInfo( $want='all')
Extract relevant query arguments from the http request uri's path to be merged with the normal php pr...
SessionId null $sessionId
Session ID to use for this request.
getRawIP()
Fetch the raw IP from the request.
setSessionId(SessionId $sessionId)
Set the session for this request.
getCookie( $key, $prefix=null, $default=null)
Get a cookie from the $_COOKIE jar.
array $data
The parameters from $_GET, $_POST and the path router.
static extractTitle( $path, $bases, $key=false)
URL rewriting function; tries to extract page title and, optionally, one other fixed parameter value ...
getText( $name, $default='')
Fetch a text string and return it in normalized form.
getRequestURL()
Return the path and query string portion of the request URI.
getHeader( $name, $flags=0)
Get a request header, or false if it isn't set.
getSessionData( $key)
Get data from the session.
getQueryValuesOnly()
Get the values passed in the query string only, not including the path router parameters.
$wgUsePathInfo
Config variable stub for the UsePathInfo setting, for use by phpdoc and IDEs.
$wgUseSameSiteLegacyCookies
Config variable stub for the UseSameSiteLegacyCookies setting, for use by phpdoc and IDEs.
$wgScript
Config variable stub for the Script setting, for use by phpdoc and IDEs.
$wgActionPaths
Config variable stub for the ActionPaths setting, for use by phpdoc and IDEs.
$wgArticlePath
Config variable stub for the ArticlePath setting, for use by phpdoc and IDEs.
$wgAllowExternalReqID
Config variable stub for the AllowExternalReqID setting, for use by phpdoc and IDEs.
$wgVariantArticlePath
Config variable stub for the VariantArticlePath setting, for use by phpdoc and IDEs.
$wgCookiePrefix
Config variable stub for the CookiePrefix setting, for use by phpdoc and IDEs.
$wgUsePrivateIPs
Config variable stub for the UsePrivateIPs setting, for use by phpdoc and IDEs.