MediaWiki  master
WebRequest Class Reference

The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping illegal input characters and normalizing Unicode sequences. More...

Inheritance diagram for WebRequest:
Collaboration diagram for WebRequest:

Public Member Functions

 __construct ()
 
 appendQueryArray ( $array)
 Appends or replaces value of query variables. More...
 
 appendQueryValue ( $key, $value)
 
 getAcceptLang ()
 Parse the Accept-Language header sent by the client into an array. More...
 
 getAllHeaders ()
 Get an array containing all request headers. More...
 
 getArray ( $name, $default=null)
 Fetch an array from the input or return $default if it's not set. More...
 
 getBool ( $name, $default=false)
 Fetch a boolean value from the input or return $default if not set. More...
 
 getCheck ( $name)
 Return true if the named value is set in the input, whatever that value is (even "0"). More...
 
 getCookie ( $key, $prefix=null, $default=null)
 Get a cookie from the $_COOKIE jar. More...
 
 getCrossSiteCookie ( $key, $prefix='', $default=null)
 Get a cookie set with SameSite=None possibly with a legacy fallback cookie. More...
 
 getElapsedTime ()
 Get the number of seconds to have elapsed since request start, in fractional seconds, with microsecond resolution. More...
 
 getFileName ( $key)
 Return the original filename of the uploaded file, as reported by the submitting user agent. More...
 
 getFileTempname ( $key)
 Return the path to the temporary file where PHP has stored the upload. More...
 
 getFloat ( $name, $default=0.0)
 Fetch a floating point value from the input or return $default if not set. More...
 
 getFullRequestURL ()
 Return the request URI with the canonical service and hostname, path, and query string. More...
 
 getFuzzyBool ( $name, $default=false)
 Fetch a boolean value from the input or return $default if not set. More...
 
 getHeader ( $name, $flags=0)
 Get a request header, or false if it isn't set. More...
 
 getInt ( $name, $default=0)
 Fetch an integer value from the input or return $default if not set. More...
 
 getIntArray ( $name, $default=null)
 Fetch an array of integers, or return $default if it's not set. More...
 
 getIntOrNull ( $name)
 Fetch an integer value from the input or return null if empty. More...
 
 getIP ()
 Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of the chain) More...
 
 getLimitOffsetForUser (UserIdentity $user, $deflimit=50, $optionname='rclimit')
 Check for limit and offset parameters on the input, and return sensible defaults if not given. More...
 
 getMethod ()
 Get the HTTP method used for this request. More...
 
 getPostValues ()
 Get the values passed via POST. More...
 
 getProtocol ()
 Get the current URL protocol (http or https) More...
 
 getQueryValues ()
 Get the values passed in the query string and the path router parameters. More...
 
 getQueryValuesOnly ()
 Get the values passed in the query string only, not including the path router parameters. More...
 
 getRawInput ()
 Return the raw request body, with no processing. More...
 
 getRawPostString ()
 Return the contents of the POST with no decoding. More...
 
 getRawQueryString ()
 Return the contents of the Query with no decoding. More...
 
 getRawVal ( $name, $default=null)
 Fetch a string WITHOUT any Unicode or line break normalization. More...
 
 getRequestURL ()
 Return the path and query string portion of the request URI. More...
 
 getSession ()
 Return the session for this request. More...
 
 getSessionData ( $key)
 Get data from the session. More...
 
 getSessionId ()
 Get the session id for this request, if any. More...
 
 getText ( $name, $default='')
 Fetch a text string and return it in normalized form. More...
 
 getUpload ( $key)
 Return a WebRequestUpload object corresponding to the key. More...
 
 getUploadError ( $key)
 Return the upload error or 0. More...
 
 getVal ( $name, $default=null)
 Fetch a text string and partially normalized it. More...
 
 getValueNames ( $exclude=[])
 Returns the names of all input values excluding those in $exclude. More...
 
 getValues (... $names)
 Extracts the (given) named values into an array. More...
 
 hasSafeMethod ()
 Check if this request uses a "safe" HTTP method. More...
 
 interpolateTitle ()
 Check for title, action, and/or variant data in the URL and interpolate it into the GET variables. More...
 
 isSafeRequest ()
 Whether this request should be identified as being "safe". More...
 
 markAsSafeRequest ()
 Mark this request as identified as being nullipotent even if it is a POST request. More...
 
 matchURLForCDN (array $cdnUrls)
 Determine if the request URL matches one of a given set of canonical CDN URLs. More...
 
 normalizeUnicode ( $data)
 Recursively normalizes UTF-8 strings in the given array. More...
 
 response ()
 Return a handle to WebResponse style object, for setting cookies, headers and other stuff, for Request being worked on. More...
 
 setIP ( $ip)
 
 setSessionData ( $key, $data)
 
 setSessionId (SessionId $sessionId)
 Set the session for this request. More...
 
 setVal ( $key, $value)
 Set an arbitrary value into our get/post data. More...
 
 unsetVal ( $key)
 Unset an arbitrary value from our get/post data. More...
 
 wasPosted ()
 Returns true if the present request was reached by a POST operation, false otherwise (GET, HEAD, or command-line). More...
 

Static Public Member Functions

static canonicalizeIPv6LoopbackAddress ( $ip)
 Converts ::1 (IPv6 loopback address) to 127.0.0.1 (IPv4 loopback address); assists in matching trusted proxies. More...
 
static detectProtocol ()
 Detect the protocol from $_SERVER. More...
 
static detectServer ( $assumeProxiesUseDefaultProtocolPorts=null)
 Work out an appropriate URL prefix containing scheme and host, based on information detected from $_SERVER. More...
 
static extractTitle ( $path, $bases, $key=false)
 URL rewriting function; tries to extract page title and, optionally, one other fixed parameter value from a URL path. More...
 
static getGlobalRequestURL ()
 Return the path and query string portion of the main request URI. More...
 
static getRequestId ()
 Get the current request ID. More...
 
static getRequestPathSuffix ( $basePath)
 If the request URL matches a given base path, extract the path part of the request URL after that base, and decode escape sequences in it. More...
 
static overrideRequestId ( $id)
 Override the unique request ID. More...
 

Public Attributes

const GETHEADER_LIST = 1
 Flag to make WebRequest::getHeader return an array of values. More...
 

Protected Member Functions

 getRawIP ()
 Fetch the raw IP from the request. More...
 
 initHeaders ()
 Initialise the header list. More...
 

Static Protected Member Functions

static getPathInfo ( $want='all')
 Extract relevant query arguments from the http request uri's path to be merged with the normal php provided query arguments. More...
 

Protected Attributes

array $data
 The parameters from $_GET, $_POST and the path router. More...
 
string[] $headers = []
 Lazy-initialized request headers indexed by upper-case header name. More...
 
bool $markedAsSafe = false
 Whether this HTTP request is "safe" (even if it is an HTTP post) More...
 
string $protocol
 Cached URL protocol. More...
 
string[] $queryAndPathParams
 The parameters from $_GET. More...
 
string[] $queryParams
 The parameters from $_GET only. More...
 
float $requestTime
 The timestamp of the start of the request, with microsecond precision. More...
 
SessionId null $sessionId = null
 Session ID to use for this request. More...
 

Detailed Description

The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping illegal input characters and normalizing Unicode sequences.

Definition at line 44 of file WebRequest.php.

Constructor & Destructor Documentation

◆ __construct()

WebRequest::__construct ( )

Definition at line 122 of file WebRequest.php.

Member Function Documentation

◆ appendQueryArray()

WebRequest::appendQueryArray (   $array)

Appends or replaces value of query variables.

Parameters
array$arrayArray of values to replace/add to query
Returns
string

Definition at line 1010 of file WebRequest.php.

References getQueryValues(), and wfArrayToCgi().

Referenced by appendQueryValue().

◆ appendQueryValue()

WebRequest::appendQueryValue (   $key,
  $value 
)
Parameters
string$key
string$value
Returns
string

Definition at line 1000 of file WebRequest.php.

References appendQueryArray().

◆ canonicalizeIPv6LoopbackAddress()

static WebRequest::canonicalizeIPv6LoopbackAddress (   $ip)
static

Converts ::1 (IPv6 loopback address) to 127.0.0.1 (IPv4 loopback address); assists in matching trusted proxies.

Parameters
string$ip
Returns
string either '127.0.0.1' or $ip
Since
1.36

Definition at line 1352 of file WebRequest.php.

◆ detectProtocol()

static WebRequest::detectProtocol ( )
static

Detect the protocol from $_SERVER.

This is for use prior to Setup.php, when no WebRequest object is available. At other times, use the non-static function getProtocol().

Returns
string

Definition at line 313 of file WebRequest.php.

Referenced by detectServer(), and getProtocol().

◆ detectServer()

static WebRequest::detectServer (   $assumeProxiesUseDefaultProtocolPorts = null)
static

Work out an appropriate URL prefix containing scheme and host, based on information detected from $_SERVER.

Parameters
bool | null$assumeProxiesUseDefaultProtocolPortsWhen the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes the wiki on the standard ports (443 for https and 80 for http). Added in 1.38. Calls without this argument are supported for backwards compatibility but deprecated.
Returns
string

Definition at line 265 of file WebRequest.php.

References detectProtocol().

Referenced by WebInstaller\envGetDefaultServer().

◆ extractTitle()

static WebRequest::extractTitle (   $path,
  $bases,
  $key = false 
)
static

URL rewriting function; tries to extract page title and, optionally, one other fixed parameter value from a URL path.

Parameters
string$pathThe URL path given from the client
array$basesOne or more URLs, optionally with $1 at the end
string | false$keyIf provided, the matching key in $bases will be passed on as the value of this URL parameter
Returns
array Array of URL variables to interpolate; empty if no match

Definition at line 404 of file WebRequest.php.

References $base, $matches, and $path.

◆ getAcceptLang()

WebRequest::getAcceptLang ( )

Parse the Accept-Language header sent by the client into an array.

Returns
array [ languageCode => q-value ] sorted by q-value in descending order then appearing time in the header in ascending order. May contain the "language" '*', which applies to languages other than those explicitly listed.

This logic is aligned with RFC 7231 section 5 (previously RFC 2616 section 14), at https://tools.ietf.org/html/rfc7231#section-5.3.5.

Earlier languages in the list are preferred as per the RFC 23282 extension to HTTP/1.1, at https://tools.ietf.org/html/rfc3282.

Reimplemented in DerivativeRequest.

Definition at line 1192 of file WebRequest.php.

References $matches, and getHeader().

◆ getAllHeaders()

WebRequest::getAllHeaders ( )

Get an array containing all request headers.

Returns
string[] Mapping header name to its value

Reimplemented in DerivativeRequest.

Definition at line 1129 of file WebRequest.php.

References $headers, and initHeaders().

◆ getArray()

WebRequest::getArray (   $name,
  $default = null 
)

Fetch an array from the input or return $default if it's not set.

If source was scalar, will return an array with a single element. If no source and no default, returns null.

Parameters
string$name
array | null$defaultOptional default (or null)
Returns
array|null

Definition at line 583 of file WebRequest.php.

Referenced by FormOptions\fetchValuesFromRequest(), and getIntArray().

◆ getBool()

WebRequest::getBool (   $name,
  $default = false 
)

Fetch a boolean value from the input or return $default if not set.

Guaranteed to return true or false, with normal PHP semantics for boolean interpretation of strings.

Parameters
string$name
bool$default
Returns
bool

Definition at line 663 of file WebRequest.php.

References getRawVal().

Referenced by FormOptions\fetchValuesFromRequest(), and getFuzzyBool().

◆ getCheck()

WebRequest::getCheck (   $name)

Return true if the named value is set in the input, whatever that value is (even "0").

Return false if the named value is not set. Example use is checking for the presence of check boxes in forms.

Parameters
string$name
Returns
bool

Definition at line 690 of file WebRequest.php.

References getRawVal().

Referenced by HTMLFormField\isSubmitAttempt().

◆ getCookie()

WebRequest::getCookie (   $key,
  $prefix = null,
  $default = null 
)

Get a cookie from the $_COOKIE jar.

Parameters
string$keyThe name of the cookie
string | null$prefixA prefix to use for the cookie name, if not $wgCookiePrefix
mixed | null$defaultWhat to return if the value isn't found
Returns
mixed Cookie value or $default if the cookie not set

Reimplemented in FauxRequest, and DerivativeRequest.

Definition at line 876 of file WebRequest.php.

References $wgCookiePrefix.

Referenced by MediaWiki\Session\ImmutableSessionProviderWithCookie\getSessionIdFromCookie(), and MediaWiki\Block\BlockManager\trackBlockWithCookie().

◆ getCrossSiteCookie()

WebRequest::getCrossSiteCookie (   $key,
  $prefix = '',
  $default = null 
)

Get a cookie set with SameSite=None possibly with a legacy fallback cookie.

Parameters
string$keyThe name of the cookie
string$prefixA prefix to use, empty by default
mixed | null$defaultWhat to return if the value isn't found
Returns
mixed Cookie value or $default if the cookie is not set

Definition at line 899 of file WebRequest.php.

References $wgUseSameSiteLegacyCookies.

◆ getElapsedTime()

WebRequest::getElapsedTime ( )

Get the number of seconds to have elapsed since request start, in fractional seconds, with microsecond resolution.

Returns
float
Since
1.25

Reimplemented in DerivativeRequest.

Definition at line 330 of file WebRequest.php.

References $requestTime.

◆ getFileName()

WebRequest::getFileName (   $key)

Return the original filename of the uploaded file, as reported by the submitting user agent.

HTML-style character entities are interpreted and normalized to Unicode normalization form C, in part to deal with weird input from Safari with non-ASCII filenames.

Other than this the name is not verified for being a safe filename.

Parameters
string$key
Returns
string|null String or null if no such file.

Definition at line 1084 of file WebRequest.php.

References getUpload().

◆ getFileTempname()

WebRequest::getFileTempname (   $key)

Return the path to the temporary file where PHP has stored the upload.

Parameters
string$key
Returns
string|null String or null if no such file.

Definition at line 1059 of file WebRequest.php.

References getUpload().

◆ getFloat()

WebRequest::getFloat (   $name,
  $default = 0.0 
)

Fetch a floating point value from the input or return $default if not set.

Guaranteed to return a float; non-numeric input will typically return 0.

Since
1.23
Parameters
string$name
float$default
Returns
float

Definition at line 649 of file WebRequest.php.

References getRawVal().

Referenced by FormOptions\fetchValuesFromRequest().

◆ getFullRequestURL()

WebRequest::getFullRequestURL ( )

Return the request URI with the canonical service and hostname, path, and query string.

This will be suitable for use as an absolute link in HTML or other output.

If $wgServer is protocol-relative, this will return a fully qualified URL with the protocol of this request object.

Returns
string

Definition at line 984 of file WebRequest.php.

References getProtocol(), getRequestURL(), PROTO_HTTP, PROTO_HTTPS, and wfGetServerUrl().

◆ getFuzzyBool()

WebRequest::getFuzzyBool (   $name,
  $default = false 
)

Fetch a boolean value from the input or return $default if not set.

Unlike getBool, the string "false" will result in boolean false, which is useful when interpreting information sent from JavaScript.

Parameters
string$name
bool$default
Returns
bool

Definition at line 677 of file WebRequest.php.

References getBool(), and getRawVal().

Referenced by MediaWiki\ResourceLoader\Context\__construct().

◆ getGlobalRequestURL()

static WebRequest::getGlobalRequestURL ( )
static

Return the path and query string portion of the main request URI.

This will be suitable for use as a relative link in HTML output.

Exceptions
MWException
Returns
string

Definition at line 924 of file WebRequest.php.

References $base.

Referenced by MediaWiki\HeaderCallback\callback(), getRequestPathSuffix(), getRequestURL(), and MediaWiki\Rest\RequestFromGlobals\getUri().

◆ getHeader()

WebRequest::getHeader (   $name,
  $flags = 0 
)

Get a request header, or false if it isn't set.

Parameters
string$nameCase-insensitive header name
int$flagsBitwise combination of: WebRequest::GETHEADER_LIST Treat the header as a comma-separated list of values, as described in RFC 2616 ยง 4.2. (since 1.26).
Returns
string|string[]|false False if header is unset; otherwise the header value(s) as either a string (the default) or an array, if WebRequest::GETHEADER_LIST flag was set.

Reimplemented in DerivativeRequest.

Definition at line 1146 of file WebRequest.php.

References initHeaders().

Referenced by getAcceptLang(), getIP(), and PageDataRequestHandler\httpContentNegotiation().

◆ getInt()

WebRequest::getInt (   $name,
  $default = 0 
)

Fetch an integer value from the input or return $default if not set.

Guaranteed to return an integer; non-numeric input will typically return 0.

Parameters
string$name
int$default
Returns
int

Definition at line 619 of file WebRequest.php.

References getRawVal().

Referenced by FormOptions\fetchValuesFromRequest(), getLimitOffsetForUser(), and PageDataRequestHandler\handleRequest().

◆ getIntArray()

WebRequest::getIntArray (   $name,
  $default = null 
)

Fetch an array of integers, or return $default if it's not set.

If source was scalar, will return an array with a single element. If no source and no default, returns null. If an array is returned, contents are guaranteed to be integers.

Parameters
string$name
array | null$defaultOption default (or null)
Returns
int[]|null

Definition at line 602 of file WebRequest.php.

References getArray().

◆ getIntOrNull()

WebRequest::getIntOrNull (   $name)

Fetch an integer value from the input or return null if empty.

Guaranteed to return an integer or null; non-numeric input will typically return null.

Parameters
string$name
Returns
int|null

Definition at line 632 of file WebRequest.php.

References getRawVal().

Referenced by FormOptions\fetchValuesFromRequest(), and ImagePage\openShowImage().

◆ getIP()

WebRequest::getIP ( )

Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of the chain)

Since
1.19
Returns
string

Reimplemented in DerivativeRequest.

Definition at line 1264 of file WebRequest.php.

References $wgUsePrivateIPs, getHeader(), getRawIP(), Hooks\isRegistered(), and Hooks\runner().

Referenced by MWRestrictions\check(), FileCacheBase\incrMissesRecent(), and BotPassword\login().

◆ getLimitOffsetForUser()

WebRequest::getLimitOffsetForUser ( UserIdentity  $user,
  $deflimit = 50,
  $optionname = 'rclimit' 
)

Check for limit and offset parameters on the input, and return sensible defaults if not given.

The limit must be positive and is capped at 5000. Offset must be positive but is not capped.

Parameters
UserIdentity$userUserIdentity to get option for
int$deflimitLimit to use if no input and the user hasn't set the option.
string$optionnameTo specify an option other than rclimit to pull from.
Returns
int[] First element is limit, second is offset

Definition at line 1028 of file WebRequest.php.

References getInt().

◆ getMethod()

WebRequest::getMethod ( )

Get the HTTP method used for this request.

Returns
string

Reimplemented in FauxRequest.

Definition at line 808 of file WebRequest.php.

Referenced by wasPosted().

◆ getPathInfo()

static WebRequest::getPathInfo (   $want = 'all')
staticprotected

Extract relevant query arguments from the http request uri's path to be merged with the normal php provided query arguments.

Tries to use the REQUEST_URI data if available and parses it according to the wiki's configuration looking for any known pattern.

If the REQUEST_URI is not provided we'll fall back on the PATH_INFO provided by the server if any and use that to set a 'title' parameter.

This internal method handles many odd cases and is tailored specifically for used by WebRequest::interpolateTitle, for index.php requests. Consider using WebRequest::getRequestPathSuffix for other path-related use cases.

Parameters
string$wantIf this is not 'all', then the function will return an empty array if it determines that the URL is inside a rewrite path.
Returns
string[] Any query arguments found in path matches.
Exceptions
FatalErrorIf invalid routes are configured (T48998)

Definition at line 152 of file WebRequest.php.

References $matches, $path, $wgActionPaths, $wgArticlePath, $wgScript, $wgUsePathInfo, $wgVariantArticlePath, PathRouter\add(), PathRouter\getActionPaths(), and Hooks\runner().

Referenced by interpolateTitle().

◆ getPostValues()

WebRequest::getPostValues ( )

Get the values passed via POST.

No transformation is performed on the values.

Since
1.32
Returns
string[]

Reimplemented in FauxRequest.

Definition at line 760 of file WebRequest.php.

◆ getProtocol()

WebRequest::getProtocol ( )

Get the current URL protocol (http or https)

Returns
string

Reimplemented in FauxRequest, and DerivativeRequest.

Definition at line 373 of file WebRequest.php.

References $protocol, and detectProtocol().

Referenced by getFullRequestURL().

◆ getQueryValues()

WebRequest::getQueryValues ( )

Get the values passed in the query string and the path router parameters.

No transformation is performed on the values.

Returns
string[]

Reimplemented in FauxRequest.

Definition at line 735 of file WebRequest.php.

References $queryAndPathParams.

Referenced by appendQueryArray().

◆ getQueryValuesOnly()

WebRequest::getQueryValuesOnly ( )

Get the values passed in the query string only, not including the path router parameters.

This is less suitable for self-links to index.php but useful for other entry points. No transformation is performed on the values.

Since
1.34
Returns
string[]

Definition at line 748 of file WebRequest.php.

References $queryParams.

Referenced by ImagePage\openShowImage().

◆ getRawInput()

WebRequest::getRawInput ( )

Return the raw request body, with no processing.

Cached since some methods disallow reading the stream more than once. As stated in the php docs, this does not work with enctype="multipart/form-data".

Returns
string

Reimplemented in FauxRequest.

Definition at line 795 of file WebRequest.php.

Referenced by getRawPostString().

◆ getRawIP()

WebRequest::getRawIP ( )
protected

Fetch the raw IP from the request.

Since
1.19
Returns
string|null

Reimplemented in FauxRequest.

Definition at line 1245 of file WebRequest.php.

Referenced by getIP().

◆ getRawPostString()

WebRequest::getRawPostString ( )

Return the contents of the POST with no decoding.

Use when you need to know exactly what was sent, e.g. for an OAuth signature over the elements.

Returns
string

Reimplemented in FauxRequest.

Definition at line 781 of file WebRequest.php.

References getRawInput(), and wasPosted().

◆ getRawQueryString()

WebRequest::getRawQueryString ( )

Return the contents of the Query with no decoding.

Use when you need to know exactly what was sent, e.g. for an OAuth signature over the elements.

Returns
string

Reimplemented in FauxRequest.

Definition at line 771 of file WebRequest.php.

◆ getRawVal()

WebRequest::getRawVal (   $name,
  $default = null 
)

Fetch a string WITHOUT any Unicode or line break normalization.

This is a fast alternative for values that are known to be simple, e.g. pure ASCII. When reading user input, use {

See also
getText} instead.

Array values are discarded for security reasons. Use {

See also
getArray} or {
getIntArray}.
Since
1.28
Parameters
string$name
string | null$default
Returns
string|null The value, or $default if none set

Definition at line 488 of file WebRequest.php.

Referenced by MediaWiki\ResourceLoader\Context\__construct(), getBool(), getCheck(), getFloat(), getFuzzyBool(), getInt(), and getIntOrNull().

◆ getRequestId()

◆ getRequestPathSuffix()

static WebRequest::getRequestPathSuffix (   $basePath)
static

If the request URL matches a given base path, extract the path part of the request URL after that base, and decode escape sequences in it.

If the request URL does not match, false is returned.

Since
1.35
Parameters
string$basePathThe base URL path. Trailing slashes will be stripped.
Returns
string|false

Definition at line 239 of file WebRequest.php.

References getGlobalRequestURL().

Referenced by wfImageAuthMain(), and wfThumbHandle404().

◆ getRequestURL()

WebRequest::getRequestURL ( )

Return the path and query string portion of the request URI.

This will be suitable for use as a relative link in HTML output.

Exceptions
MWException
Returns
string

Reimplemented in FauxRequest.

Definition at line 970 of file WebRequest.php.

References getGlobalRequestURL().

Referenced by getFullRequestURL(), and matchURLForCDN().

◆ getSession()

WebRequest::getSession ( )

Return the session for this request.

This might unpersist an existing session if it was invalid.

Since
1.27
Note
For performance, keep the session locally if you will be making much use of it instead of calling this method repeatedly.
Returns
Session

Reimplemented in DerivativeRequest.

Definition at line 835 of file WebRequest.php.

Referenced by FauxRequest\getSessionArray(), getSessionData(), and setSessionData().

◆ getSessionData()

WebRequest::getSessionData (   $key)

Get data from the session.

Note
Prefer $this->getSession() instead if making multiple calls.
Parameters
string$keyName of key in the session
Returns
mixed

Reimplemented in DerivativeRequest.

Definition at line 1166 of file WebRequest.php.

References getSession().

◆ getSessionId()

WebRequest::getSessionId ( )

Get the session id for this request, if any.

Since
1.27
Access: internal
For use by MediaWiki\Session classes only
Returns
SessionId|null

Definition at line 864 of file WebRequest.php.

References $sessionId.

◆ getText()

WebRequest::getText (   $name,
  $default = '' 
)

Fetch a text string and return it in normalized form.

This normalizes Unicode sequences (via {

See also
getGPCVal}) and line breaks.

This should be used for all user input and form fields that are expected to contain non-ASCII characters, especially if the value will be stored or compared against stored values. Without normalization, logically identically values might not match when they are typed on different OS' or keyboards.

Array values are discarded for security reasons. Use {

See also
getArray} or {
getIntArray}.
Parameters
string$name
string$default
Returns
string The normalized input value, or $default if none set

Reimplemented in FauxRequest.

Definition at line 540 of file WebRequest.php.

References getVal().

Referenced by PageDataRequestHandler\canHandleRequest(), FormOptions\fetchValuesFromRequest(), and PageDataRequestHandler\handleRequest().

◆ getUpload()

WebRequest::getUpload (   $key)

Return a WebRequestUpload object corresponding to the key.

Parameters
string$key
Returns
WebRequestUpload

Reimplemented in FauxRequest, and DerivativeRequest.

Definition at line 1094 of file WebRequest.php.

Referenced by getFileName(), getFileTempname(), and getUploadError().

◆ getUploadError()

WebRequest::getUploadError (   $key)

Return the upload error or 0.

Parameters
string$key
Returns
int

Definition at line 1069 of file WebRequest.php.

References getUpload().

◆ getVal()

WebRequest::getVal (   $name,
  $default = null 
)

Fetch a text string and partially normalized it.

Use of this method is discouraged. It doesn't normalize line breaks and defaults to null instead of the empty string. Instead:

  • Use {
    See also
    getText} when reading user input or form fields that are expected to contain non-ASCII characters.
  • Use {
    See also
    getRawVal} when reading ASCII strings, such as parameters used to select predefined behaviour in the software.
    Array values are discarded for security reasons. Use {
    See also
    getArray} or {
    getIntArray}.
    Parameters
    string$name
    string | null$default
    Returns
    string|null The input value, or $default if none set

Definition at line 515 of file WebRequest.php.

Referenced by FauxRequest\getText(), and getText().

◆ getValueNames()

WebRequest::getValueNames (   $exclude = [])

Returns the names of all input values excluding those in $exclude.

Parameters
array$exclude
Returns
array

Definition at line 724 of file WebRequest.php.

References getValues().

◆ getValues()

WebRequest::getValues (   $names)

Extracts the (given) named values into an array.

No transformation is performed on the values.

Parameters
string...$names If no arguments are given, returns all input values
Returns
array

Definition at line 703 of file WebRequest.php.

Referenced by getValueNames().

◆ hasSafeMethod()

WebRequest::hasSafeMethod ( )

Check if this request uses a "safe" HTTP method.

Safe methods are verbs (e.g. GET/HEAD/OPTIONS) used for obtaining content. Such requests are not expected to mutate content, especially in ways attributable to the client. Verbs like POST and PUT are typical of non-safe requests which often change content.

Returns
bool
See also
https://tools.ietf.org/html/rfc7231#section-4.2.1
https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
Since
1.28

Definition at line 1382 of file WebRequest.php.

Referenced by isSafeRequest().

◆ initHeaders()

WebRequest::initHeaders ( )
protected

Initialise the header list.

Reimplemented in FauxRequest.

Definition at line 1116 of file WebRequest.php.

Referenced by getAllHeaders(), and getHeader().

◆ interpolateTitle()

WebRequest::interpolateTitle ( )

Check for title, action, and/or variant data in the URL and interpolate it into the GET variables.

This should only be run after the content language is available, as we may need the list of language variants to determine available variant URLs.

Definition at line 387 of file WebRequest.php.

References $matches, and getPathInfo().

◆ isSafeRequest()

WebRequest::isSafeRequest ( )

Whether this request should be identified as being "safe".

This means that the client is not requesting any state changes and that database writes are not inherently required. Ideally, no visible updates would happen at all. If they must, then they should not be publicly attributed to the end user.

In more detail:

  • Cache populations and refreshes MAY occur.
  • Private user session updates and private server logging MAY occur.
  • Updates to private viewing activity data MAY occur via DeferredUpdates.
  • Other updates SHOULD NOT occur (e.g. modifying content assets).
Returns
bool
See also
https://tools.ietf.org/html/rfc7231#section-4.2.1
https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
Since
1.28

Definition at line 1408 of file WebRequest.php.

References hasSafeMethod(), and wasPosted().

◆ markAsSafeRequest()

WebRequest::markAsSafeRequest ( )

Mark this request as identified as being nullipotent even if it is a POST request.

POST requests are often used due to the need for a client payload, even if the request is otherwise equivalent to a "safe method" request.

See also
https://tools.ietf.org/html/rfc7231#section-4.2.1
https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
Since
1.28

Definition at line 1426 of file WebRequest.php.

◆ matchURLForCDN()

WebRequest::matchURLForCDN ( array  $cdnUrls)

Determine if the request URL matches one of a given set of canonical CDN URLs.

MediaWiki uses this to determine whether to set a long 'Cache-Control: s-maxage=' header on the response. {

See also
MainConfigNames::CdnMatchParameterOrder} controls whether the matching is sensitive to the order of query parameters.
Parameters
string[]$cdnUrlsURLs to match against
Returns
bool
Since
1.39

Definition at line 1441 of file WebRequest.php.

References getRequestURL(), PROTO_INTERNAL, and wfExpandUrl().

◆ normalizeUnicode()

WebRequest::normalizeUnicode (   $data)

Recursively normalizes UTF-8 strings in the given array.

Parameters
string | array$data
Returns
array|string Cleaned-up version of the given
Access: internal

Definition at line 430 of file WebRequest.php.

References $data.

◆ overrideRequestId()

static WebRequest::overrideRequestId (   $id)
static

Override the unique request ID.

This is for sub-requests, such as jobs, that wish to use the same id but are not part of the same execution context.

Parameters
string$id
Since
1.27

Definition at line 365 of file WebRequest.php.

Referenced by JobRunner\executeJob().

◆ response()

◆ setIP()

WebRequest::setIP (   $ip)
Parameters
string$ip
Returns
void
Since
1.21

Reimplemented in DerivativeRequest.

Definition at line 1366 of file WebRequest.php.

◆ setSessionData()

WebRequest::setSessionData (   $key,
  $data 
)
Note
Prefer $this->getSession() instead if making multiple calls.
Parameters
string$keyName of key in the session
mixed$data

Reimplemented in DerivativeRequest.

Definition at line 1175 of file WebRequest.php.

References $data, and getSession().

◆ setSessionId()

WebRequest::setSessionId ( SessionId  $sessionId)

Set the session for this request.

Since
1.27
Access: internal
For use by MediaWiki\Session classes only
Parameters
SessionId$sessionId

Definition at line 854 of file WebRequest.php.

References $sessionId.

Referenced by MediaWiki\Session\SessionManager\getSessionFromInfo(), and MediaWiki\Session\Session\sessionWithRequest().

◆ setVal()

WebRequest::setVal (   $key,
  $value 
)

Set an arbitrary value into our get/post data.

Parameters
string$keyKey name to use
mixed$valueValue to set
Returns
mixed Old value if one was present, null otherwise

Definition at line 552 of file WebRequest.php.

◆ unsetVal()

WebRequest::unsetVal (   $key)

Unset an arbitrary value from our get/post data.

Parameters
string$keyKey name to use
Returns
mixed Old value if one was present, null otherwise

Definition at line 564 of file WebRequest.php.

◆ wasPosted()

WebRequest::wasPosted ( )

Returns true if the present request was reached by a POST operation, false otherwise (GET, HEAD, or command-line).

Note that values retrieved by the object may come from the GET URL etc even on a POST request.

Returns
bool

Reimplemented in FauxRequest.

Definition at line 821 of file WebRequest.php.

References getMethod().

Referenced by getRawPostString(), isSafeRequest(), and HTMLFormField\isSubmitAttempt().

Member Data Documentation

◆ $data

array WebRequest::$data
protected

◆ $headers

string [] WebRequest::$headers = []
protected

Lazy-initialized request headers indexed by upper-case header name.

Definition at line 68 of file WebRequest.php.

Referenced by getAllHeaders(), and FauxRequest\setHeaders().

◆ $markedAsSafe

bool WebRequest::$markedAsSafe = false
protected

Whether this HTTP request is "safe" (even if it is an HTTP post)

Definition at line 117 of file WebRequest.php.

◆ $protocol

string WebRequest::$protocol
protected

Cached URL protocol.

Definition at line 104 of file WebRequest.php.

Referenced by FauxRequest\__construct(), FauxRequest\getProtocol(), and getProtocol().

◆ $queryAndPathParams

string [] WebRequest::$queryAndPathParams
protected

The parameters from $_GET.

The parameters from the path router are added by interpolateTitle() during Setup.php.

Definition at line 56 of file WebRequest.php.

Referenced by getQueryValues().

◆ $queryParams

string [] WebRequest::$queryParams
protected

The parameters from $_GET only.

Definition at line 62 of file WebRequest.php.

Referenced by getQueryValuesOnly().

◆ $requestTime

float WebRequest::$requestTime
protected

The timestamp of the start of the request, with microsecond precision.

Definition at line 98 of file WebRequest.php.

Referenced by getElapsedTime().

◆ $sessionId

SessionId null WebRequest::$sessionId = null
protected

Session ID to use for this request.

We can't save the session directly due to reference cycles not working too well (slow GC).

TODO: Investigate whether this GC slowness concern (added in a73c5b7395 with regard to PHP 5.6) still applies in PHP 7.2+.

Definition at line 114 of file WebRequest.php.

Referenced by getSessionId(), and setSessionId().

◆ GETHEADER_LIST

const WebRequest::GETHEADER_LIST = 1

Flag to make WebRequest::getHeader return an array of values.

Since
1.26

Definition at line 74 of file WebRequest.php.

Referenced by ApiMain\checkConditionalRequestHeaders(), and MediaWiki\ResourceLoader\ResourceLoader\tryRespondNotModified().


The documentation for this class was generated from the following file: