Http Class Reference

Various HTTP related functions. More...

Inheritance diagram for Http:

Static Public Member Functions
static	createMultiClient (array $options=[])
	Get a configured MultiHttpClient.
static	get ( $url, array $options=[], $caller=__METHOD__)
	Simple wrapper for Http::request( 'GET' )
static	getProxy ()
	Gets the relevant proxy from $wgHTTPProxy.
static	isValidURI ( $uri)
	Check that the given URI is a valid one.
static	post ( $url, array $options=[], $caller=__METHOD__)
	Simple wrapper for Http::request( 'POST' )
static	request ( $method, $url, array $options=[], $caller=__METHOD__)
	Perform an HTTP request.
static	userAgent ()
	A standard user-agent we can use for external requests.

Static Public Attributes
static	$httpEngine = false

Detailed Description

Various HTTP related functions.

Definition at line 27 of file Http.php.

Member Function Documentation

createMultiClient()

static Http::createMultiClient ( array  $options = [] )

static

Get a configured MultiHttpClient.

Parameters

array

$options

Returns

MultiHttpClient

Definition at line 176 of file Http.php.

References $options, $wgHTTPConnectTimeout, $wgHTTPProxy, and $wgHTTPTimeout.

get()

static Http::get (   $url, array  $options = [],   $caller = __METHOD__  )

static

Simple wrapper for Http::request( 'GET' )

See also

Http::request()

Since

1.25 Second parameter $timeout removed. Second parameter is now $options which can be given a 'timeout'

Parameters

string	$url
array	$options
string	$caller	The method making this request, for profiling

Returns

string|bool false on error

Reimplemented in MediaWikiPageNameNormalizerTestMockHttp.

Definition at line 98 of file Http.php.

References $args, $options, and wfWarn().

Referenced by Installer\dirIsExecutable(), BenchHttpHttps\doRequest(), ImportableUploadRevisionImporter\downloadSource(), ImportSiteScripts\execute(), ExternalStoreHttp\fetchFromURL(), PopulateInterwiki\fetchLinks(), ImportSiteScripts\fetchScriptList(), File\getDescriptionText(), ForeignDBFile\getDescriptionText(), ImportImages\getFileCommentFromSourceWiki(), ImportImages\getFileUserFromSourceWiki(), and FindHooks\getHooksFromOnlineDocCategory().

getProxy()

static Http::getProxy ( )

static

Gets the relevant proxy from $wgHTTPProxy.

Returns

mixed The proxy address or an empty string if not set.

Definition at line 161 of file Http.php.

References $wgHTTPProxy.

Referenced by MWHttpRequest\proxySetup(), and HttpTest\testGetProxy().

isValidURI()

static Http::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 purpose (see https://www.mediawiki.org/wiki/Special:Code/MediaWiki/r67684).

Todo:

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

Parameters

string

$uri

URI to check for validity

Returns

bool

Definition at line 149 of file Http.php.

Referenced by MWHttpRequest\__construct(), PhpHttpRequest\execute(), UploadFromUrl\fetchFile(), SideBarTest\initMessagesHref(), and HttpTest\testIsValidUri().

post()

static Http::post (   $url, array  $options = [],   $caller = __METHOD__  )

static

Simple wrapper for Http::request( 'POST' )

See also

Http::request()

Parameters

string	$url
array	$options
string	$caller	The method making this request, for profiling

Returns

string|bool false on error

Definition at line 121 of file Http.php.

References $options.

Referenced by Pingback\postPingback().

request()

static Http::request (   $method,   $url, array  $options = [],   $caller = __METHOD__  )

static

Perform an HTTP request.

Parameters

string	$method	HTTP method. Usually GET/POST
string	$url	Full URL to act on. If protocol-relative, will be expanded to an http:// URL
array	$options	Options to pass to MWHttpRequest object. Possible keys for the array: timeout Timeout length in seconds connectTimeout Timeout for connection, in seconds (curl only) postData An array of key-value pairs or a url-encoded form data proxy The proxy to use. Otherwise it will use $wgHTTPProxy (if set) Otherwise it will use the environment variable "http_proxy" (if set) noProxy Don't use any proxy at all. Takes precedence over proxy value(s). sslVerifyHost Verify hostname against certificate sslVerifyCert Verify SSL certificate caInfo Provide CA information maxRedirects Maximum number of redirects to follow (defaults to 5) followRedirects Whether to follow redirects (defaults to false). Note: this should only be used when the target URL is trusted, to avoid attacks on intranet services accessible by HTTP. userAgent A user agent, if you want to override the default MediaWiki/$wgVersion logger A \Psr\Logger\LoggerInterface instance for debug logging username Username for HTTP Basic Authentication password Password for HTTP Basic Authentication originalRequest Information about the original request (as a WebRequest object or an associative array with 'ip' and 'userAgent').
string	$caller	The method making this request, for profiling

Returns

string|bool (bool)false on failure or a string on success

Definition at line 61 of file Http.php.

References $options, and $req.

Referenced by FileBackendTest\doTestGetFileHttpUrl(), and ImportStreamSource\newFromURL().

userAgent()

static Http::userAgent ( )

static

A standard user-agent we can use for external requests.

Returns

string

Definition at line 129 of file Http.php.

References $wgVersion.

Referenced by MediaWiki\Sparql\SparqlClient\__construct(), ForeignAPIRepo\getUserAgent(), MediaWiki\Sparql\SparqlClientTest\optionsProvider(), MWHttpRequest\prepare(), and SquidPurgeClient\queuePurge().

Member Data Documentation

$httpEngine

Http::$httpEngine = false

static

Definition at line 28 of file Http.php.

Referenced by MediaWiki\Http\HttpRequestFactory\create(), MWHttpRequestTester\factory(), MWHttpRequestTestCase\setUp(), and MWHttpRequestTestCase\tearDown().

---

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

• includes/http/Http.php