MediaWiki master
MWHttpRequest Class Reference

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

Inherits LoggerAwareInterface.

Inherited by GuzzleHttpRequest.

Collaboration diagram for MWHttpRequest:

Public Member Functions

 __construct ( $url, array $options, $caller=__METHOD__, Profiler $profiler=null)
 
 addTelemetry (TelemetryHeadersInterface $telemetry)
 Add Telemetry information to the request.
 
 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 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

string null $caInfo = null
 
callable $callback
 
int $connectTimeout
 
string null $content
 
CookieJar $cookieJar
 
bool $followRedirects = false
 
array $headerList = []
 
bool null $headersOnly = null
 
LoggerInterface $logger
 
int $maxRedirects = 5
 
string $method = "GET"
 
bool $noProxy = false
 
array false $parsedUrl
 
array null $postData = null
 
string $profileName
 
Profiler $profiler
 
string null $proxy = null
 
array $reqHeaders = []
 
string[][] $respHeaders = []
 
string $respStatus = "200 Ok"
 
string $respVersion = "0.9"
 
bool $sslVerifyCert = true
 
bool $sslVerifyHost = true
 
StatusValue $status
 
int string $timeout = 'default'
 
string $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 38 of file MWHttpRequest.php.

Constructor & Destructor Documentation

◆ __construct()

MWHttpRequest::__construct ( $url,
array $options,
$caller = __METHOD__,
Profiler $profiler = null )
Parameters
string$urlUrl to use. If protocol-relative, will be expanded to an http:// URL
array$optionsextra params to pass (see HttpRequestFactory::create()) @phpcs:ignore Generic.Files.LineLength
string$callerThe method making this request, for profiling
Profiler | null$profilerAn instance of the profiler for profiling, or null
Exceptions
Exception

Reimplemented in GuzzleHttpRequest.

Definition at line 122 of file MWHttpRequest.php.

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

Member Function Documentation

◆ addTelemetry()

MWHttpRequest::addTelemetry ( TelemetryHeadersInterface $telemetry)

Add Telemetry information to the request.

Parameters
TelemetryHeadersInterface$telemetry
Returns
void

Definition at line 221 of file MWHttpRequest.php.

References $header, and setHeader().

◆ canFollowRedirects()

MWHttpRequest::canFollowRedirects ( )

Returns true if the backend can follow redirects.

Overridden by the child classes.

Returns
bool

Definition at line 694 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 192 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 398 of file MWHttpRequest.php.

◆ 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 428 of file MWHttpRequest.php.

◆ getContent()

MWHttpRequest::getContent ( )

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

Returns
string

Definition at line 201 of file MWHttpRequest.php.

◆ getCookieJar()

MWHttpRequest::getCookieJar ( )

Returns the cookie jar in use.

Returns
CookieJar

Definition at line 587 of file MWHttpRequest.php.

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 652 of file MWHttpRequest.php.

References $url.

◆ getHeaderList()

MWHttpRequest::getHeaderList ( )
protected

Get an array of the headers.

Returns
array

Definition at line 351 of file MWHttpRequest.php.

◆ getResponseHeader()

MWHttpRequest::getResponseHeader ( $header)

Returns the value of the given response header.

Parameters
string$headercase-insensitive
Returns
string|null

Definition at line 558 of file MWHttpRequest.php.

References $header.

◆ 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 544 of file MWHttpRequest.php.

◆ 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 508 of file MWHttpRequest.php.

◆ isRedirect()

MWHttpRequest::isRedirect ( )

Returns true if the last status code was a redirect.

Returns
bool

Definition at line 521 of file MWHttpRequest.php.

◆ 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$uriURI to check for validity
Returns
bool

Definition at line 744 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 619 of file MWHttpRequest.php.

References $url.

◆ 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 456 of file MWHttpRequest.php.

References $header.

◆ prepare()

MWHttpRequest::prepare ( )
protected

Reimplemented in GuzzleHttpRequest.

Definition at line 432 of file MWHttpRequest.php.

◆ proxySetup()

MWHttpRequest::proxySetup ( )
protected

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

Returns
void

Definition at line 232 of file MWHttpRequest.php.

◆ 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 417 of file MWHttpRequest.php.

◆ 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 387 of file MWHttpRequest.php.

◆ 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 604 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 578 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 211 of file MWHttpRequest.php.

◆ setHeader()

MWHttpRequest::setHeader ( $name,
$value )

Set an arbitrary header.

Parameters
string$name
string$value

Definition at line 342 of file MWHttpRequest.php.

Referenced by __construct(), and addTelemetry().

◆ setLogger()

MWHttpRequest::setLogger ( LoggerInterface $logger)
Parameters
LoggerInterface$logger

Definition at line 183 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$originalRequestWhen 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 710 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$proxyURL of proxy

Definition at line 269 of file MWHttpRequest.php.

◆ 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 487 of file MWHttpRequest.php.

Referenced by GuzzleHttpRequest\execute().

◆ setUserAgent()

MWHttpRequest::setUserAgent ( $UA)
Parameters
string$UA

Definition at line 333 of file MWHttpRequest.php.

Referenced by __construct().

Member Data Documentation

◆ $caInfo

string null MWHttpRequest::$caInfo = null
protected

Definition at line 61 of file MWHttpRequest.php.

◆ $callback

callable MWHttpRequest::$callback
protected

◆ $connectTimeout

int MWHttpRequest::$connectTimeout
protected

Definition at line 77 of file MWHttpRequest.php.

◆ $content

string null MWHttpRequest::$content
protected

Definition at line 47 of file MWHttpRequest.php.

◆ $cookieJar

CookieJar MWHttpRequest::$cookieJar
protected

Definition at line 82 of file MWHttpRequest.php.

◆ $followRedirects

bool MWHttpRequest::$followRedirects = false
protected

Definition at line 75 of file MWHttpRequest.php.

◆ $headerList

array MWHttpRequest::$headerList = []
protected

Definition at line 85 of file MWHttpRequest.php.

◆ $headersOnly

bool null MWHttpRequest::$headersOnly = null
protected

Definition at line 49 of file MWHttpRequest.php.

◆ $logger

LoggerInterface MWHttpRequest::$logger
protected

Definition at line 109 of file MWHttpRequest.php.

◆ $maxRedirects

int MWHttpRequest::$maxRedirects = 5
protected

Definition at line 73 of file MWHttpRequest.php.

◆ $method

string MWHttpRequest::$method = "GET"
protected

Definition at line 63 of file MWHttpRequest.php.

◆ $noProxy

bool MWHttpRequest::$noProxy = false
protected

Definition at line 55 of file MWHttpRequest.php.

◆ $parsedUrl

array false MWHttpRequest::$parsedUrl
protected

Definition at line 69 of file MWHttpRequest.php.

◆ $postData

array null MWHttpRequest::$postData = null
protected

Definition at line 51 of file MWHttpRequest.php.

Referenced by GuzzleHttpRequest\execute().

◆ $profileName

string MWHttpRequest::$profileName
protected

Definition at line 104 of file MWHttpRequest.php.

◆ $profiler

Profiler MWHttpRequest::$profiler
protected

Definition at line 99 of file MWHttpRequest.php.

Referenced by GuzzleHttpRequest\__construct().

◆ $proxy

string null MWHttpRequest::$proxy = null
protected

Definition at line 53 of file MWHttpRequest.php.

◆ $reqHeaders

array MWHttpRequest::$reqHeaders = []
protected

Definition at line 65 of file MWHttpRequest.php.

◆ $respHeaders

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

Definition at line 91 of file MWHttpRequest.php.

◆ $respStatus

string MWHttpRequest::$respStatus = "200 Ok"
protected

Definition at line 89 of file MWHttpRequest.php.

◆ $respVersion

string MWHttpRequest::$respVersion = "0.9"
protected

Definition at line 87 of file MWHttpRequest.php.

◆ $sslVerifyCert

bool MWHttpRequest::$sslVerifyCert = true
protected

Definition at line 59 of file MWHttpRequest.php.

◆ $sslVerifyHost

bool MWHttpRequest::$sslVerifyHost = true
protected

Definition at line 57 of file MWHttpRequest.php.

◆ $status

StatusValue MWHttpRequest::$status
protected

Definition at line 94 of file MWHttpRequest.php.

◆ $timeout

int string MWHttpRequest::$timeout = 'default'
protected

Definition at line 44 of file MWHttpRequest.php.

◆ $url

string MWHttpRequest::$url
protected

Definition at line 67 of file MWHttpRequest.php.

◆ SUPPORTS_FILE_POSTS

const MWHttpRequest::SUPPORTS_FILE_POSTS = false

Definition at line 39 of file MWHttpRequest.php.


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