This wrapper class will call out to curl (if available) or fallback to regular PHP if necessary for handling internal HTTP requests. More...

Inheritance diagram for MWHttpRequest:

[legend]

Collaboration diagram for MWHttpRequest:

[legend]

Public Member Functions
	__construct ( $url, array $options=[], $caller=__METHOD__, Profiler $profiler=null)

	canFollowRedirects ()
	Returns true if the backend can follow redirects.

	execute ()
	Take care of whatever is necessary to perform the URI request.

	getContent ()
	Get the body, or content, of the response to the request.

	getCookieJar ()
	Returns the cookie jar in use.

	getFinalUrl ()
	Returns the final URL after all redirections.

	getResponseHeader ( $header)
	Returns the value of the given response header.

	getResponseHeaders ()
	Returns an associative array of response headers after the request has been executed.

	getStatus ()
	Get the integer value of the HTTP status code (e.g.

	isRedirect ()
	Returns true if the last status code was a redirect.

	read ( $fh, $content)
	A generic callback to read the body of the response from a remote server.

	setCallback ( $callback)
	Set a read callback to accept data read from the HTTP request.

	setCookie ( $name, $value, array $attr=[])
	Sets a cookie.

	setCookieJar (CookieJar $jar)
	Tells the MWHttpRequest object to use this pre-loaded CookieJar.

	setData (array $args)
	Set the parameters of the request.

	setHeader ( $name, $value)
	Set an arbitrary header.

	setLogger (LoggerInterface $logger)

	setOriginalRequest ( $originalRequest)
	Set information about the original request.

	setUserAgent ( $UA)

Static Public Member Functions
static	canMakeRequests ()
	Simple function to test if we can make any sort of requests at all, using cURL or fopen()

static	factory ( $url, array $options=null, $caller=__METHOD__)
	Generate a new request object.

static	isValidURI ( $uri)
	Check that the given URI is a valid one.

Public Attributes
const	SUPPORTS_FILE_POSTS = false

Protected Member Functions
	doSetCallback ( $callback)
	Worker function for setting callbacks.

	getHeaderList ()
	Get an array of the headers.

	parseCookies ()
	Parse the cookies in the response headers and store them in the cookie jar.

	parseHeader ()
	Parses the headers, including the HTTP status code and any Set-Cookie headers.

	prepare ()

	proxySetup ()
	Take care of setting up the proxy (do nothing if "noProxy" is set)

	setReverseProxy (string $proxy)
	Enable use of a reverse proxy in which the hostname is passed as a "Host" header, and the request is sent to the proxy's host:port instead.

	setStatus ()
	Sets HTTPRequest status member to a fatal value with the error message if the returned integer value of the status code was not successful (1-299) or a redirect (300-399).

Protected Attributes
	$caInfo = null

callable	$callback

	$connectTimeout

	$content

CookieJar	$cookieJar

	$followRedirects = false

	$headerList = []

	$headersOnly = null

LoggerInterface	$logger

	$maxRedirects = 5

	$method = "GET"

	$noProxy = false

	$parsedUrl

	$postData = null

string	$profileName

Profiler	$profiler

	$proxy = null

array	$reqHeaders = []

string[][]	$respHeaders = []

	$respStatus = "200 Ok"

	$respVersion = "0.9"

	$sslVerifyCert = true

	$sslVerifyHost = true

StatusValue	$status

int string	$timeout = 'default'

	$url

Detailed Description

This wrapper class will call out to curl (if available) or fallback to regular PHP if necessary for handling internal HTTP requests.

Renamed from HttpRequest to MWHttpRequest to avoid conflict with PHP's HTTP extension.

Definition at line 34 of file MWHttpRequest.php.

Constructor & Destructor Documentation

◆ __construct()

MWHttpRequest::__construct	(		$url,
		array	$options = [],
			$caller = __METHOD__,
		Profiler	$profiler = null )

Parameters

string	$url	Url to use. If protocol-relative, will be expanded to an http:// URL
array	$options	(optional) extra params to pass (see HttpRequestFactory::create()) @phpcs:ignore Generic.Files.LineLength
string	$caller	The method making this request, for profiling
Profiler \| null	$profiler	An instance of the profiler for profiling, or null

Exceptions

Exception

Reimplemented in GuzzleHttpRequest.

Definition at line 99 of file MWHttpRequest.php.

References $url, PROTO_HTTP, setHeader(), setOriginalRequest(), setUserAgent(), wfDeprecated(), wfExpandUrl(), and wfParseUrl().

Member Function Documentation

◆ canFollowRedirects()

MWHttpRequest::canFollowRedirects ( )

Returns true if the backend can follow redirects.

Overridden by the child classes.

Returns: bool

Definition at line 693 of file MWHttpRequest.php.

◆ canMakeRequests()

static MWHttpRequest::canMakeRequests ( )

static

Simple function to test if we can make any sort of requests at all, using cURL or fopen()

Returns: bool

Definition at line 184 of file MWHttpRequest.php.

References wfIniGetBool().

◆ doSetCallback()

MWHttpRequest::doSetCallback ( $callback )

protected

Worker function for setting callbacks.

Calls can originate both internally and externally via setCallback). Defaults to the internal read callback if $callback is null.

Parameters

callable | null $callback

Exceptions

InvalidArgumentException

Reimplemented in GuzzleHttpRequest.

Definition at line 397 of file MWHttpRequest.php.

Referenced by prepare(), and setCallback().

◆ execute()

MWHttpRequest::execute ( )

Take care of whatever is necessary to perform the URI request.

Returns: Status

Note: currently returns Status for B/C

Reimplemented in GuzzleHttpRequest.

Definition at line 427 of file MWHttpRequest.php.

◆ factory()

static MWHttpRequest::factory	(		$url,
		array	$options = null,
			$caller = __METHOD__ )

static

Generate a new request object.

Deprecated: since 1.34, use HttpRequestFactory instead

Parameters

string	$url	Url to use
array \| null	$options	(optional) extra params to pass (see HttpRequestFactory::create())
string	$caller	The method making this request, for profiling

Exceptions

DomainException

Returns: MWHttpRequest

See also: MWHttpRequest::__construct

Definition at line 198 of file MWHttpRequest.php.

References $url.

◆ getContent()

MWHttpRequest::getContent ( )

Get the body, or content, of the response to the request.

Returns: string

Definition at line 211 of file MWHttpRequest.php.

References $content.

◆ getCookieJar()

MWHttpRequest::getCookieJar ( )

Returns the cookie jar in use.

Returns: CookieJar

Definition at line 586 of file MWHttpRequest.php.

References parseHeader().

Referenced by GuzzleHttpRequest\execute().

◆ getFinalUrl()

MWHttpRequest::getFinalUrl ( )

Returns the final URL after all redirections.

Relative values of the "Location" header are incorrect as stated in RFC, however they do happen and modern browsers support them. This function loops backwards through all locations in order to build the proper absolute URI - Marooned at wikia-inc.com

Note that the multiple Location: headers are an artifact of CURL – they shouldn't actually get returned this way. Rewrite this when T31232 is taken care of (high-level redirect handling rewrite).

Returns: string

Definition at line 651 of file MWHttpRequest.php.

References $url, and getResponseHeaders().

Referenced by parseCookies().

◆ getHeaderList()

MWHttpRequest::getHeaderList ( )

protected

Get an array of the headers.

Returns: array

Definition at line 350 of file MWHttpRequest.php.

◆ getResponseHeader()

MWHttpRequest::getResponseHeader ( $header )

Returns the value of the given response header.

Parameters

string $header case-insensitive

Returns: string|null

Definition at line 557 of file MWHttpRequest.php.

References $header, and parseHeader().

◆ getResponseHeaders()

MWHttpRequest::getResponseHeaders ( )

Returns an associative array of response headers after the request has been executed.

Because some headers (e.g. Set-Cookie) can appear more than once the, each value of the associative array is an array of the values given. Header names are always in lowercase.

Returns: array

Definition at line 543 of file MWHttpRequest.php.

References parseHeader().

Referenced by getFinalUrl().

◆ getStatus()

MWHttpRequest::getStatus ( )

Get the integer value of the HTTP status code (e.g.

200 for "200 Ok") (see RFC2616, section 10, http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for a list of status codes.)

Returns: int

Definition at line 507 of file MWHttpRequest.php.

References parseHeader().

◆ isRedirect()

MWHttpRequest::isRedirect ( )

Returns true if the last status code was a redirect.

Returns: bool

Definition at line 520 of file MWHttpRequest.php.

References parseHeader().

◆ isValidURI()

static MWHttpRequest::isValidURI ( $uri )

static

Check that the given URI is a valid one.

This hardcodes a small set of protocols only, because we want to deterministically reject protocols not supported by all HTTP-transport methods.

"file://" specifically must not be allowed, for security reasons (see https://www.mediawiki.org/wiki/Special:Code/MediaWiki/r67684).

Todo: FIXME this is wildly inaccurate and fails to actually check most stuff

Since: 1.34

Parameters

string $uri URI to check for validity

Returns: bool

Definition at line 743 of file MWHttpRequest.php.

◆ parseCookies()

MWHttpRequest::parseCookies ( )

protected

Parse the cookies in the response headers and store them in the cookie jar.

Definition at line 618 of file MWHttpRequest.php.

References $url, and getFinalUrl().

Referenced by GuzzleHttpRequest\parseHeader(), and parseHeader().

◆ parseHeader()

MWHttpRequest::parseHeader ( )

protected

Parses the headers, including the HTTP status code and any Set-Cookie headers.

This function expects the headers to be found in an array in the member variable headerList.

Reimplemented in GuzzleHttpRequest.

Definition at line 455 of file MWHttpRequest.php.

References $header, and parseCookies().

Referenced by getCookieJar(), getResponseHeader(), getResponseHeaders(), getStatus(), isRedirect(), and setStatus().

◆ prepare()

MWHttpRequest::prepare ( )

protected

Reimplemented in GuzzleHttpRequest.

Definition at line 431 of file MWHttpRequest.php.

References doSetCallback(), proxySetup(), and setUserAgent().

◆ proxySetup()

MWHttpRequest::proxySetup ( )

protected

Take care of setting up the proxy (do nothing if "noProxy" is set)

Returns: void

Definition at line 230 of file MWHttpRequest.php.

References setReverseProxy().

Referenced by prepare().

◆ read()

MWHttpRequest::read	(		$fh,
			$content )

A generic callback to read the body of the response from a remote server.

Parameters

resource	$fh
string	$content

Returns: int

Access: internal

Definition at line 416 of file MWHttpRequest.php.

References $content.

◆ setCallback()

MWHttpRequest::setCallback ( $callback )

Set a read callback to accept data read from the HTTP request.

By default, data is appended to an internal buffer which can be retrieved through $req->getContent().

To handle data as it comes in – especially for large files that would not fit in memory – you can instead set your own callback, in the form function($resource, $buffer) where the first parameter is the low-level resource being read (implementation specific), and the second parameter is the data buffer.

You MUST return the number of bytes handled in the buffer; if fewer bytes are reported handled than were passed to you, the HTTP fetch will be aborted.

Parameters

callable | null $callback

Exceptions

InvalidArgumentException

Reimplemented in GuzzleHttpRequest.

Definition at line 386 of file MWHttpRequest.php.

References doSetCallback().

◆ setCookie()

MWHttpRequest::setCookie	(		$name,
			$value,
		array	$attr = [] )

Sets a cookie.

Used before a request to set up any individual cookies. Used internally after a request to parse the Set-Cookie headers.

See also: Cookie::set

Parameters

string	$name
string	$value
array	$attr

Definition at line 603 of file MWHttpRequest.php.

References CookieJar\setCookie().

◆ setCookieJar()

MWHttpRequest::setCookieJar ( CookieJar $jar )

Tells the MWHttpRequest object to use this pre-loaded CookieJar.

To read response cookies from the jar, getCookieJar must be called first.

Parameters

CookieJar $jar

Definition at line 577 of file MWHttpRequest.php.

◆ setData()

MWHttpRequest::setData ( array $args )

Set the parameters of the request.

Parameters

array $args

Todo: overload the args param

Definition at line 221 of file MWHttpRequest.php.

References $args.

◆ setHeader()

MWHttpRequest::setHeader	(		$name,
			$value )

Set an arbitrary header.

Parameters

string	$name
string	$value

Definition at line 341 of file MWHttpRequest.php.

Referenced by __construct(), setReverseProxy(), and setUserAgent().

◆ setLogger()

MWHttpRequest::setLogger ( LoggerInterface $logger )

Parameters

LoggerInterface $logger

Definition at line 175 of file MWHttpRequest.php.

◆ setOriginalRequest()

MWHttpRequest::setOriginalRequest ( $originalRequest )

Set information about the original request.

This can be useful for endpoints/API modules which act as a proxy for some service, and throttling etc. needs to happen in that service. Calling this will result in the X-Forwarded-For and X-Original-User-Agent headers being set.

Parameters

WebRequest | array $originalRequest When in array form, it's expected to have the keys 'ip' and 'userAgent'.

Note: IP/user agent is personally identifiable information, and should only be set when the privacy policy of the request target is compatible with that of the MediaWiki installation.

Definition at line 709 of file MWHttpRequest.php.

Referenced by __construct().

◆ setReverseProxy()

MWHttpRequest::setReverseProxy ( string $proxy )

protected

Enable use of a reverse proxy in which the hostname is passed as a "Host" header, and the request is sent to the proxy's host:port instead.

Note that any custom port in the request URL will be lost and cookies and redirects may not work properly.

Parameters

string $proxy URL of proxy

Definition at line 267 of file MWHttpRequest.php.

References setHeader(), wfAssembleUrl(), and wfParseUrl().

Referenced by proxySetup().

◆ setStatus()

MWHttpRequest::setStatus ( )

protected

Sets HTTPRequest status member to a fatal value with the error message if the returned integer value of the status code was not successful (1-299) or a redirect (300-399).

See RFC2616, section 10, http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for a list of status codes.

Definition at line 486 of file MWHttpRequest.php.

References parseHeader().

Referenced by GuzzleHttpRequest\execute().

◆ setUserAgent()

MWHttpRequest::setUserAgent ( $UA )

Parameters

string $UA

Definition at line 332 of file MWHttpRequest.php.

References setHeader().

Referenced by __construct(), and prepare().

Member Data Documentation

◆ $caInfo

MWHttpRequest::$caInfo = null

protected

Definition at line 49 of file MWHttpRequest.php.

◆ $callback

callable MWHttpRequest::$callback

protected

Definition at line 56 of file MWHttpRequest.php.

Referenced by GuzzleHttpRequest\doSetCallback(), and GuzzleHttpRequest\setCallback().

◆ $connectTimeout

MWHttpRequest::$connectTimeout

protected

Definition at line 59 of file MWHttpRequest.php.

◆ $content

MWHttpRequest::$content

protected

Definition at line 42 of file MWHttpRequest.php.

◆ $cookieJar

CookieJar MWHttpRequest::$cookieJar

protected

Definition at line 64 of file MWHttpRequest.php.

◆ $followRedirects

MWHttpRequest::$followRedirects = false

protected

Definition at line 58 of file MWHttpRequest.php.

◆ $headerList

MWHttpRequest::$headerList = []

protected

Definition at line 66 of file MWHttpRequest.php.

◆ $headersOnly

MWHttpRequest::$headersOnly = null

protected

Definition at line 43 of file MWHttpRequest.php.

◆ $logger

LoggerInterface MWHttpRequest::$logger

protected

Definition at line 88 of file MWHttpRequest.php.

◆ $maxRedirects

MWHttpRequest::$maxRedirects = 5

protected

Definition at line 57 of file MWHttpRequest.php.

◆ $method

MWHttpRequest::$method = "GET"

protected

Definition at line 50 of file MWHttpRequest.php.

◆ $noProxy

MWHttpRequest::$noProxy = false

protected

Definition at line 46 of file MWHttpRequest.php.

◆ $parsedUrl

MWHttpRequest::$parsedUrl

protected

Definition at line 54 of file MWHttpRequest.php.

◆ $postData

MWHttpRequest::$postData = null

protected

Definition at line 44 of file MWHttpRequest.php.

Referenced by GuzzleHttpRequest\execute().

◆ $profileName

string MWHttpRequest::$profileName

protected

Definition at line 83 of file MWHttpRequest.php.

◆ $profiler

Profiler MWHttpRequest::$profiler

protected

Definition at line 78 of file MWHttpRequest.php.

Referenced by GuzzleHttpRequest\__construct().

◆ $proxy

MWHttpRequest::$proxy = null

protected

Definition at line 45 of file MWHttpRequest.php.

◆ $reqHeaders

array MWHttpRequest::$reqHeaders = []

protected

Definition at line 52 of file MWHttpRequest.php.

◆ $respHeaders

string [][] MWHttpRequest::$respHeaders = []

protected

Definition at line 70 of file MWHttpRequest.php.

◆ $respStatus

MWHttpRequest::$respStatus = "200 Ok"

protected

Definition at line 68 of file MWHttpRequest.php.

◆ $respVersion

MWHttpRequest::$respVersion = "0.9"

protected

Definition at line 67 of file MWHttpRequest.php.

◆ $sslVerifyCert

MWHttpRequest::$sslVerifyCert = true

protected

Definition at line 48 of file MWHttpRequest.php.

◆ $sslVerifyHost

MWHttpRequest::$sslVerifyHost = true

protected

Definition at line 47 of file MWHttpRequest.php.

◆ $status

StatusValue MWHttpRequest::$status

protected

Definition at line 73 of file MWHttpRequest.php.

◆ $timeout

int string MWHttpRequest::$timeout = 'default'

protected

Definition at line 40 of file MWHttpRequest.php.

◆ $url

MWHttpRequest::$url

protected

Definition at line 53 of file MWHttpRequest.php.

Referenced by GuzzleHttpRequest\__construct(), __construct(), factory(), getFinalUrl(), and parseCookies().

◆ SUPPORTS_FILE_POSTS

const MWHttpRequest::SUPPORTS_FILE_POSTS = false

Definition at line 35 of file MWHttpRequest.php.

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

includes/http/MWHttpRequest.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canFollowRedirects()

◆ canMakeRequests()

◆ doSetCallback()

◆ execute()

◆ factory()

◆ getContent()

◆ getCookieJar()

◆ getFinalUrl()

◆ getHeaderList()

◆ getResponseHeader()

◆ getResponseHeaders()

◆ getStatus()

◆ isRedirect()

◆ isValidURI()

◆ parseCookies()

◆ parseHeader()

◆ prepare()

◆ proxySetup()

◆ read()

◆ setCallback()

◆ setCookie()

◆ setCookieJar()

◆ setData()

◆ setHeader()

◆ setLogger()

◆ setOriginalRequest()

◆ setReverseProxy()

◆ setStatus()

◆ setUserAgent()

Member Data Documentation

◆ $caInfo

◆ $callback

◆ $connectTimeout

◆ $content

◆ $cookieJar

◆ $followRedirects

◆ $headerList

◆ $headersOnly

◆ $logger

◆ $maxRedirects

◆ $method

◆ $noProxy

◆ $parsedUrl

◆ $postData

◆ $profileName

◆ $profiler

◆ $proxy

◆ $reqHeaders

◆ $respHeaders

◆ $respStatus

◆ $respVersion

◆ $sslVerifyCert

◆ $sslVerifyHost

◆ $status

◆ $timeout

◆ $url

◆ SUPPORTS_FILE_POSTS