38 use Wikimedia\IPUtils;
86 private static $reqId;
129 $this->requestTime = $_SERVER[
'REQUEST_TIME_FLOAT'];
133 $this->data = $_POST + $_GET;
135 $this->queryAndPathParams = $this->queryParams = $_GET;
162 if ( isset( $_SERVER[
'REQUEST_URI'] ) ) {
164 $url = $_SERVER[
'REQUEST_URI'];
165 if ( !preg_match(
'!^https?://!', $url ) ) {
166 $url =
'http://unused' . $url;
168 $a = parse_url( $url );
172 $path = $a[
'path'] ??
'';
184 $router->
add(
"$wgScript/$1" );
194 if ( $articlePaths ) {
195 $router->add( $articlePaths, [
'action' =>
'$key' ] );
198 $services = MediaWikiServices::getInstance();
203 [
'variant' =>
'$2' ],
204 [
'$2' => $services->getLanguageConverterFactory()
205 ->getLanguageConverter( $services->getContentLanguage() )
210 (
new HookRunner( $services->getHookContainer() ) )->onWebRequestPathInfoRouter( $router );
217 if ( !empty( $_SERVER[
'ORIG_PATH_INFO'] ) ) {
221 $matches[
'title'] = substr( $_SERVER[
'ORIG_PATH_INFO'], 1 );
222 } elseif ( !empty( $_SERVER[
'PATH_INFO'] ) ) {
224 $matches[
'title'] = substr( $_SERVER[
'PATH_INFO'], 1 );
244 $basePath = rtrim( $basePath,
'/' ) .
'/';
246 $qpos = strpos( $requestUrl,
'?' );
247 if ( $qpos !==
false ) {
248 $requestPath = substr( $requestUrl, 0, $qpos );
250 $requestPath = $requestUrl;
252 if ( !str_starts_with( $requestPath, $basePath ) ) {
255 return rawurldecode( substr( $requestPath, strlen( $basePath ) ) );
269 public static function detectServer( $assumeProxiesUseDefaultProtocolPorts =
null ) {
270 $assumeProxiesUseDefaultProtocolPorts ??= $GLOBALS[
'wgAssumeProxiesUseDefaultProtocolPorts'];
273 $stdPort = $proto ===
'https' ? 443 : 80;
275 $varNames = [
'HTTP_HOST',
'SERVER_NAME',
'HOSTNAME',
'SERVER_ADDR' ];
278 foreach ( $varNames as $varName ) {
279 if ( !isset( $_SERVER[$varName] ) ) {
283 $parts = IPUtils::splitHostAndPort( $_SERVER[$varName] );
290 if ( $assumeProxiesUseDefaultProtocolPorts && isset( $_SERVER[
'HTTP_X_FORWARDED_PROTO'] ) ) {
295 } elseif ( $parts[1] ===
false ) {
296 if ( isset( $_SERVER[
'SERVER_PORT'] ) ) {
297 $port = $_SERVER[
'SERVER_PORT'];
305 return $proto .
'://' . IPUtils::combineHostAndPort( $host, $port, $stdPort );
316 if ( ( !empty( $_SERVER[
'HTTPS'] ) && $_SERVER[
'HTTPS'] !==
'off' ) ||
317 ( isset( $_SERVER[
'HTTP_X_FORWARDED_PROTO'] ) &&
318 $_SERVER[
'HTTP_X_FORWARDED_PROTO'] ===
'https' ) ) {
347 if ( !self::$reqId ) {
350 $id = $_SERVER[
'HTTP_X_REQUEST_ID'] ?? $_SERVER[
'UNIQUE_ID'] ??
wfRandomString( 24 );
389 foreach (
$matches as $key => $val ) {
390 $this->data[$key] = $this->queryAndPathParams[$key] = $val;
405 foreach ( (array)$bases as $keyValue => $base ) {
407 $base = str_replace(
'$1',
'', $base );
408 $baseLen = strlen( $base );
409 if ( substr(
$path, 0, $baseLen ) == $base ) {
410 $raw = substr(
$path, $baseLen );
412 $matches = [
'title' => rawurldecode( $raw ) ];
431 if ( is_array(
$data ) ) {
432 foreach (
$data as $key => $val ) {
436 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
450 private function getGPCVal( $arr, $name, $default ) {
451 # PHP is so nice to not touch input data, except sometimes:
453 # Work around PHP *feature* to avoid *bugs* elsewhere.
454 $name = strtr( $name,
'.',
'_' );
456 if ( !isset( $arr[$name] ) ) {
461 # Optimisation: Skip UTF-8 normalization and legacy transcoding for simple ASCII strings.
462 $isAsciiStr = ( is_string(
$data ) && preg_match(
'/[^\x20-\x7E]/',
$data ) === 0 );
463 if ( !$isAsciiStr ) {
464 if ( isset( $_GET[$name] ) && is_string(
$data ) ) {
465 # Check for alternate/legacy character encoding.
466 $data = MediaWikiServices::getInstance()
467 ->getContentLanguage()
468 ->checkTitleEncoding(
$data );
489 $name = strtr( $name,
'.',
'_' );
490 if ( isset( $this->data[$name] ) && !is_array( $this->data[$name] ) ) {
491 $val = $this->data[$name];
496 return $val ===
null ? null : (string)$val;
515 public function getVal( $name, $default =
null ) {
516 $val = $this->getGPCVal( $this->data, $name, $default );
517 if ( is_array( $val ) ) {
521 return $val ===
null ? null : (string)$val;
540 public function getText( $name, $default =
'' ) {
541 $val = $this->
getVal( $name, $default );
542 return str_replace(
"\r\n",
"\n", $val );
553 $ret = $this->data[$key] ??
null;
554 $this->data[$key] = $value;
565 if ( !isset( $this->data[$key] ) ) {
568 $ret = $this->data[$key];
569 unset( $this->data[$key] );
583 public function getArray( $name, $default =
null ) {
584 $val = $this->getGPCVal( $this->data, $name, $default );
585 if ( $val ===
null ) {
603 $val = $this->
getArray( $name, $default );
604 if ( is_array( $val ) ) {
605 $val = array_map(
'intval', $val );
619 public function getInt( $name, $default = 0 ) {
621 return intval( $this->
getRawVal( $name, $default ) );
634 return is_numeric( $val )
649 public function getFloat( $name, $default = 0.0 ) {
651 return floatval( $this->
getRawVal( $name, $default ) );
663 public function getBool( $name, $default =
false ) {
665 return (
bool)$this->
getRawVal( $name, $default );
678 return $this->
getBool( $name, $default )
679 && strcasecmp( $this->
getRawVal( $name ),
'false' ) !== 0;
691 # Checkboxes and buttons are only present when clicked
692 # Presence connotes truth, absence false
693 return $this->
getRawVal( $name,
null ) !==
null;
704 if ( $names === [] ) {
705 $names = array_keys( $this->data );
709 foreach ( $names as $name ) {
710 $value = $this->getGPCVal( $this->data, $name,
null );
711 if ( $value !==
null ) {
712 $retVal[$name] = $value;
725 return array_diff( array_keys( $this->
getValues() ), $exclude );
772 return $_SERVER[
'QUERY_STRING'];
796 static $input =
null;
797 $input ??= file_get_contents(
'php://input' );
807 return $_SERVER[
'REQUEST_METHOD'] ??
'GET';
834 if ( $this->sessionId !==
null ) {
835 $session = SessionManager::singleton()->getSessionById( (
string)$this->sessionId,
true, $this );
841 $session = SessionManager::singleton()->getSessionForRequest( $this );
842 $this->sessionId = $session->getSessionId();
874 public function getCookie( $key, $prefix =
null, $default =
null ) {
875 if ( $prefix ===
null ) {
879 $name = $prefix . $key;
881 $name = strtr( $name,
'.',
'_' );
882 if ( isset( $_COOKIE[$name] ) ) {
883 return $_COOKIE[$name];
899 $name = $prefix . $key;
901 $name = strtr( $name,
'.',
'_' );
902 if ( isset( $_COOKIE[$name] ) ) {
903 return $_COOKIE[$name];
906 $legacyName = $prefix .
"ss0-" . $key;
907 $legacyName = strtr( $legacyName,
'.',
'_' );
908 if ( isset( $_COOKIE[$legacyName] ) ) {
909 return $_COOKIE[$legacyName];
925 if ( isset( $_SERVER[
'REQUEST_URI'] ) && strlen( $_SERVER[
'REQUEST_URI'] ) ) {
926 $base = $_SERVER[
'REQUEST_URI'];
927 } elseif ( isset( $_SERVER[
'HTTP_X_ORIGINAL_URL'] )
928 && strlen( $_SERVER[
'HTTP_X_ORIGINAL_URL'] )
931 $base = $_SERVER[
'HTTP_X_ORIGINAL_URL'];
932 } elseif ( isset( $_SERVER[
'SCRIPT_NAME'] ) ) {
933 $base = $_SERVER[
'SCRIPT_NAME'];
934 if ( isset( $_SERVER[
'QUERY_STRING'] ) && $_SERVER[
'QUERY_STRING'] !=
'' ) {
935 $base .=
'?' . $_SERVER[
'QUERY_STRING'];
939 throw new MWException(
"Web server doesn't provide either " .
940 "REQUEST_URI, HTTP_X_ORIGINAL_URL or SCRIPT_NAME. Report details " .
941 "of your web server configuration to https://phabricator.wikimedia.org/" );
947 $hash = strpos( $base,
'#' );
948 if ( $hash !==
false ) {
949 $base = substr( $base, 0, $hash );
952 if ( $base[0] ==
'/' ) {
954 return preg_replace(
'!^/+!',
'/', $base );
957 return preg_replace(
'!^[^:]+://[^/]+/+!',
'/', $base );
1010 unset( $newquery[
'title'] );
1011 $newquery = array_merge( $newquery, $array );
1027 $limit = $this->
getInt(
'limit', 0 );
1031 if ( ( $limit == 0 ) && ( $optionname !=
'' ) ) {
1032 $limit = MediaWikiServices::getInstance()
1033 ->getUserOptionsLookup()
1034 ->getIntOption( $user, $optionname );
1036 if ( $limit <= 0 ) {
1039 if ( $limit > 5000 ) {
1040 $limit = 5000; # We have *some* limits...
1043 $offset = $this->
getInt(
'offset', 0 );
1044 if ( $offset < 0 ) {
1048 return [ $limit, $offset ];
1058 return $this->
getUpload( $key )->getTempName();
1068 return $this->
getUpload( $key )->getError();
1083 return $this->
getUpload( $key )->getName();
1104 if ( !is_object( $this->
response ) ) {
1105 $class = ( $this instanceof
FauxRequest ) ? FauxResponse::class : WebResponse::class;
1108 return $this->response;
1115 if ( count( $this->headers ) ) {
1119 $this->headers = array_change_key_case( getallheaders(), CASE_UPPER );
1146 $name = strtoupper( $name );
1147 if ( !isset( $this->headers[$name] ) ) {
1150 $value = $this->headers[$name];
1151 if ( $flags & self::GETHEADER_LIST ) {
1152 $value = array_map(
'trim', explode(
',', $value ) );
1193 $acceptLang = $this->
getHeader(
'Accept-Language' );
1194 if ( !$acceptLang ) {
1199 $acceptLang = strtolower( $acceptLang );
1202 if ( !preg_match_all(
1204 # a language code or a star is required
1205 ([a-z]{1,8}(?:-[a-z]{1,8})*|\*)
1206 # from here everything is optional
1209 # this accepts only numbers in the range ;q=0.000 to ;q=1.000
1211 (1(?:\.0{0,3})?|0(?:\.\d{0,3})?)?
1224 $languageCode = $match[1];
1226 $qValue = (float)( $match[2] ?? 1.0 );
1228 $langs[$languageCode] = $qValue;
1233 arsort( $langs, SORT_NUMERIC );
1244 $remoteAddr = $_SERVER[
'REMOTE_ADDR'] ??
null;
1245 if ( !$remoteAddr ) {
1248 if ( is_array( $remoteAddr ) || str_contains( $remoteAddr,
',' ) ) {
1249 throw new MWException(
'Remote IP must not contain multiple values' );
1252 return IPUtils::canonicalize( $remoteAddr );
1265 # Return cached result
1266 if ( $this->ip !==
null ) {
1270 # collect the originating IPs
1273 throw new MWException(
'Unable to determine IP.' );
1276 $services = MediaWikiServices::getInstance();
1278 $forwardedFor = $this->
getHeader(
'X-Forwarded-For' );
1279 if ( $forwardedFor !==
false ) {
1280 $proxyLookup = $services->getProxyLookup();
1281 $isConfigured = $proxyLookup->isConfiguredProxy( $ip );
1282 $ipchain = array_map(
'trim', explode(
',', $forwardedFor ) );
1283 $ipchain = array_reverse( $ipchain );
1284 array_unshift( $ipchain, $ip );
1286 # Step through XFF list and find the last address in the list which is a
1287 # trusted server. Set $ip to the IP address given by that trusted server,
1288 # unless the address is not sensible (e.g. private). However, prefer private
1289 # IP addresses over proxy servers controlled by this site (more sensible).
1290 # Note that some XFF values might be "unknown" with Squid/Varnish.
1291 foreach ( $ipchain as $i => $curIP ) {
1292 $curIP = IPUtils::sanitizeIP(
1293 IPUtils::canonicalize(
1294 self::canonicalizeIPv6LoopbackAddress( $curIP )
1297 if ( !$curIP || !isset( $ipchain[$i + 1] ) || $ipchain[$i + 1] ===
'unknown'
1298 || !$proxyLookup->isTrustedProxy( $curIP )
1303 IPUtils::isPublic( $ipchain[$i + 1] ) ||
1306 $proxyLookup->isConfiguredProxy( $curIP )
1308 $nextIP = $ipchain[$i + 1];
1311 $nextIP = IPUtils::canonicalize(
1312 self::canonicalizeIPv6LoopbackAddress( $nextIP )
1314 if ( !$nextIP && $isConfigured ) {
1317 throw new MWException(
"Invalid IP given in XFF '$forwardedFor'." );
1329 $hookContainer = $services->getHookContainer();
1331 if ( $hookContainer->isRegistered(
'GetIP' ) ) {
1333 (
new HookRunner( $hookContainer ) )->onGetIP( $ip );
1337 throw new MWException(
'Unable to determine IP.' );
1354 if ( preg_match(
'/^0*' . IPUtils::RE_IPV6_GAP .
'1$/', $ip ) ) {
1382 if ( !isset( $_SERVER[
'REQUEST_METHOD'] ) ) {
1386 return in_array( $_SERVER[
'REQUEST_METHOD'], [
'GET',
'HEAD',
'OPTIONS',
'TRACE' ] );
1408 if ( $this->markedAsSafe && $this->
wasPosted() ) {
1426 $this->markedAsSafe =
true;
1442 $config = MediaWikiServices::getInstance()->getMainConfig();
1443 if ( $config->get( MainConfigNames::CdnMatchParameterOrder ) ) {
1445 return in_array( $reqUrl, $cdnUrls,
true );
1449 $reqUrlParts = explode(
'?', $reqUrl, 2 );
1450 $reqUrlBase = $reqUrlParts[0];
1451 $reqUrlParams = count( $reqUrlParts ) === 2 ? explode(
'&', $reqUrlParts[1] ) : [];
1456 sort( $reqUrlParams );
1457 foreach ( $cdnUrls as $cdnUrl ) {
1458 if ( strlen( $reqUrl ) !== strlen( $cdnUrl ) ) {
1461 $cdnUrlParts = explode(
'?', $cdnUrl, 2 );
1462 $cdnUrlBase = $cdnUrlParts[0];
1463 if ( $reqUrlBase !== $cdnUrlBase ) {
1466 $cdnUrlParams = count( $cdnUrlParts ) === 2 ? explode(
'&', $cdnUrlParts[1] ) : [];
1467 sort( $cdnUrlParams );
1468 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 using $wgServer (or one of its alternatives).
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.