MediaWiki
1.23.15
|
This wrapper class will call out to curl (if available) or fallback to regular PHP if necessary for handling internal HTTP requests. More...
Public Member Functions | |
canFollowRedirects () | |
Returns true if the backend can follow redirects. More... | |
execute () | |
Take care of whatever is necessary to perform the URI request. More... | |
getContent () | |
Get the body, or content, of the response to the request. More... | |
getCookieJar () | |
Returns the cookie jar in use. More... | |
getFinalUrl () | |
Returns the final URL after all redirections. More... | |
getHeaderList () | |
Get an array of the headers. More... | |
getResponseHeader ( $header) | |
Returns the value of the given response header. More... | |
getResponseHeaders () | |
Returns an associative array of response headers after the request has been executed. More... | |
getStatus () | |
Get the integer value of the HTTP status code (e.g. More... | |
isRedirect () | |
Returns true if the last status code was a redirect. More... | |
proxySetup () | |
Take care of setting up the proxy (do nothing if "noProxy" is set) More... | |
read ( $fh, $content) | |
A generic callback to read the body of the response from a remote server. More... | |
setCallback ( $callback) | |
Set a read callback to accept data read from the HTTP request. More... | |
setCookie ( $name, $value=null, $attr=null) | |
Sets a cookie. More... | |
setCookieJar ( $jar) | |
Tells the MWHttpRequest object to use this pre-loaded CookieJar. More... | |
setData ( $args) | |
Set the parameters of the request. More... | |
setHeader ( $name, $value) | |
Set an arbitrary header. More... | |
setUserAgent ( $UA) | |
Set the user agent. More... | |
Static Public Member Functions | |
static | canMakeRequests () |
Simple function to test if we can make any sort of requests at all, using cURL or fopen() More... | |
static | factory ( $url, $options=null) |
Generate a new request object. More... | |
Public Attributes | |
$status | |
const | SUPPORTS_FILE_POSTS = false |
Protected Member Functions | |
__construct ( $url, $options=array()) | |
parseCookies () | |
Parse the cookies in the response headers and store them in the cookie jar. More... | |
parseHeader () | |
Parses the headers, including the HTTP status code and any Set-Cookie headers. More... | |
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 (< 300) or a redirect (>=300 and < 400). More... | |
Protected Attributes | |
$caInfo = null | |
$callback | |
$content | |
CookieJar | $cookieJar |
$followRedirects = false | |
$headerList = array() | |
$headersOnly = null | |
$maxRedirects = 5 | |
$method = "GET" | |
$noProxy = false | |
$parsedUrl | |
$postData = null | |
$proxy = null | |
$reqHeaders = array() | |
$respHeaders = array() | |
$respStatus = "200 Ok" | |
$respVersion = "0.9" | |
$sslVerifyCert = true | |
$sslVerifyHost = true | |
$timeout = 'default' | |
$url | |
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 192 of file HttpFunctions.php.
|
protected |
string | $url | url to use. If protocol-relative, will be expanded to an http:// URL |
array | $options | (optional) extra params to pass (see Http::request()) |
Definition at line 227 of file HttpFunctions.php.
References $options, $url, array(), as, global, Http\isValidURI(), Status\newFatal(), Status\newGood(), PROTO_HTTP, setUserAgent(), wfExpandUrl(), and wfParseUrl().
MWHttpRequest::canFollowRedirects | ( | ) |
Returns true if the backend can follow redirects.
Overridden by the child classes.
Reimplemented in CurlHttpRequest.
Definition at line 695 of file HttpFunctions.php.
|
static |
Simple function to test if we can make any sort of requests at all, using cURL or fopen()
Definition at line 277 of file HttpFunctions.php.
References wfIniGetBool().
Referenced by Installer\subscribeToMediaWikiAnnounce().
MWHttpRequest::execute | ( | ) |
Take care of whatever is necessary to perform the URI request.
Reimplemented in PhpHttpRequest, and CurlHttpRequest.
Definition at line 438 of file HttpFunctions.php.
References array(), content, proxySetup(), setCallback(), setUserAgent(), Http\userAgent(), wfProfileIn(), and wfProfileOut().
|
static |
Generate a new request object.
string | $url | url to use |
array | $options | (optional) extra params to pass (see Http::request()) |
MWException |
Reimplemented in MWHttpRequestTester.
Definition at line 289 of file HttpFunctions.php.
References Http\$httpEngine, $options, $url, and wfIniGetBool().
Referenced by ForeignAPIRepo\httpGet(), SpecialUploadStash\outputRemoteScaledThumb(), UploadFromUrl\reallyFetchFile(), Http\request(), Installer\subscribeToMediaWikiAnnounce(), and ApiLoginTest\testApiLoginGotCookie().
MWHttpRequest::getContent | ( | ) |
Get the body, or content, of the response to the request.
Definition at line 319 of file HttpFunctions.php.
References $content.
MWHttpRequest::getCookieJar | ( | ) |
Returns the cookie jar in use.
Definition at line 590 of file HttpFunctions.php.
References $cookieJar, and parseHeader().
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 bug 29232 is taken care of (high-level redirect handling rewrite).
Definition at line 651 of file HttpFunctions.php.
References $url, and getResponseHeaders().
Referenced by parseCookies().
MWHttpRequest::getHeaderList | ( | ) |
Get an array of the headers.
Definition at line 377 of file HttpFunctions.php.
References $name, $value, array(), and as.
Referenced by CurlHttpRequest\execute(), and PhpHttpRequest\execute().
MWHttpRequest::getResponseHeader | ( | $header | ) |
Returns the value of the given response header.
$header | String |
Definition at line 563 of file HttpFunctions.php.
References parseHeader().
Referenced by PhpHttpRequest\execute().
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.
Definition at line 549 of file HttpFunctions.php.
References $respHeaders, and parseHeader().
Referenced by getFinalUrl().
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.)
Definition at line 514 of file HttpFunctions.php.
References $respStatus, and parseHeader().
MWHttpRequest::isRedirect | ( | ) |
Returns true if the last status code was a redirect.
Definition at line 527 of file HttpFunctions.php.
References $status, and parseHeader().
Referenced by PhpHttpRequest\execute().
|
protected |
Parse the cookies in the response headers and store them in the cookie jar.
Definition at line 618 of file HttpFunctions.php.
References $url, as, getFinalUrl(), wfProfileIn(), and wfProfileOut().
Referenced by 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.
Definition at line 465 of file HttpFunctions.php.
References $last, as, parseCookies(), wfProfileIn(), and wfProfileOut().
Referenced by CurlHttpRequest\execute(), PhpHttpRequest\execute(), getCookieJar(), getResponseHeader(), getResponseHeaders(), getStatus(), isRedirect(), and setStatus().
MWHttpRequest::proxySetup | ( | ) |
Take care of setting up the proxy (do nothing if "noProxy" is set)
Definition at line 338 of file HttpFunctions.php.
References global, and Http\isLocalURL().
Referenced by execute().
MWHttpRequest::read | ( | $fh, | |
$content | |||
) |
A generic callback to read the body of the response from a remote server.
$fh | handle |
$content | String |
Definition at line 428 of file HttpFunctions.php.
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.
$callback | Callback |
MWException |
Definition at line 413 of file HttpFunctions.php.
References $callback.
Referenced by execute().
MWHttpRequest::setCookie | ( | $name, | |
$value = null , |
|||
$attr = null |
|||
) |
Sets a cookie.
Used before a request to set up any individual cookies. Used internally after a request to parse the Set-Cookie headers.
$name | |
$value | null |
$attr | null |
Definition at line 607 of file HttpFunctions.php.
References $name, $value, and CookieJar\setCookie().
MWHttpRequest::setCookieJar | ( | $jar | ) |
Tells the MWHttpRequest object to use this pre-loaded CookieJar.
$jar | CookieJar |
Definition at line 581 of file HttpFunctions.php.
MWHttpRequest::setData | ( | $args | ) |
Set the parameters of the request.
$args | Array |
Definition at line 329 of file HttpFunctions.php.
References $args.
MWHttpRequest::setHeader | ( | $name, | |
$value | |||
) |
Set an arbitrary header.
$name | |
$value |
Definition at line 368 of file HttpFunctions.php.
Referenced by setUserAgent().
|
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 (< 300) or a redirect (>=300 and < 400).
(see RFC2616, section 10, http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for a list of status codes.)
Definition at line 496 of file HttpFunctions.php.
References list, and parseHeader().
Referenced by CurlHttpRequest\execute(), and PhpHttpRequest\execute().
MWHttpRequest::setUserAgent | ( | $UA | ) |
Set the user agent.
$UA | string |
Definition at line 359 of file HttpFunctions.php.
References setHeader().
Referenced by __construct(), and execute().
|
protected |
Definition at line 203 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute().
|
protected |
Definition at line 208 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute(), and setCallback().
|
protected |
Definition at line 195 of file HttpFunctions.php.
Referenced by getContent(), read(), and CurlHttpRequest\readHeader().
|
protected |
Definition at line 214 of file HttpFunctions.php.
Referenced by getCookieJar().
|
protected |
Definition at line 210 of file HttpFunctions.php.
|
protected |
Definition at line 216 of file HttpFunctions.php.
|
protected |
Definition at line 197 of file HttpFunctions.php.
|
protected |
Definition at line 209 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute().
|
protected |
Definition at line 204 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute().
|
protected |
Definition at line 200 of file HttpFunctions.php.
|
protected |
Definition at line 207 of file HttpFunctions.php.
Referenced by PhpHttpRequest\urlToTcp().
|
protected |
Definition at line 198 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute(), and PhpHttpRequest\execute().
|
protected |
Definition at line 199 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute().
|
protected |
Definition at line 205 of file HttpFunctions.php.
|
protected |
Definition at line 219 of file HttpFunctions.php.
Referenced by getResponseHeaders().
|
protected |
Definition at line 218 of file HttpFunctions.php.
Referenced by getStatus().
|
protected |
Definition at line 217 of file HttpFunctions.php.
|
protected |
Definition at line 202 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute().
|
protected |
Definition at line 201 of file HttpFunctions.php.
MWHttpRequest::$status |
Definition at line 221 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute(), PhpHttpRequest\execute(), and isRedirect().
|
protected |
Definition at line 196 of file HttpFunctions.php.
Referenced by CurlHttpRequest\execute().
|
protected |
Definition at line 206 of file HttpFunctions.php.
Referenced by __construct(), PhpHttpRequest\execute(), MWHttpRequestTester\factory(), factory(), getFinalUrl(), parseCookies(), and PhpHttpRequest\urlToTcp().
const MWHttpRequest::SUPPORTS_FILE_POSTS = false |
Definition at line 193 of file HttpFunctions.php.