7 * Various HTTP related functions
11 static $httpEngine = false;
14 * Perform an HTTP request
15 * @param $method string HTTP method. Usually GET/POST
16 * @param $url string Full URL to act on
17 * @param $options options to pass to HttpRequest object
18 * Possible keys for the array:
19 * timeout Timeout length in seconds
20 * postData An array of key-value pairs or a url-encoded form data
21 * proxy The proxy to use. Will use $wgHTTPProxy (if set) otherwise.
22 * noProxy Override $wgHTTPProxy (if set) and don't use any proxy at all.
23 * sslVerifyHost (curl only) Verify the SSL certificate
24 * caInfo (curl only) Provide CA information
25 * maxRedirects Maximum number of redirects to follow (defaults to 5)
26 * followRedirects Whether to follow redirects (defaults to true)
27 * @returns mixed (bool)false on failure or a string on success
29 public static function request( $method, $url, $options = array() ) {
30 wfDebug( "HTTP: $method: $url" );
31 $options['method'] = strtoupper( $method );
32 if ( !isset( $options['timeout'] ) ) {
33 $options['timeout'] = 'default';
35 $req = HttpRequest
::factory( $url, $options );
36 $status = $req->execute();
37 if ( $status->isOK() ) {
38 return $req->getContent();
45 * Simple wrapper for Http::request( 'GET' )
46 * @see Http::request()
48 public static function get( $url, $timeout = 'default', $options = array() ) {
49 $options['timeout'] = $timeout;
50 return Http
::request( 'GET', $url, $options );
54 * Simple wrapper for Http::request( 'POST' )
55 * @see Http::request()
57 public static function post( $url, $options = array() ) {
58 return Http
::request( 'POST', $url, $options );
62 * Check if the URL can be served by localhost
63 * @param $url string Full url to check
66 public static function isLocalURL( $url ) {
67 global $wgCommandLineMode, $wgConf;
68 if ( $wgCommandLineMode ) {
74 if ( preg_match( '!^http://([\w.-]+)[/:].*$!', $url, $matches ) ) {
77 $domainParts = explode( '.', $host );
78 // Check if this domain or any superdomain is listed in $wgConf as a local virtual host
79 $domainParts = array_reverse( $domainParts );
80 for ( $i = 0; $i < count( $domainParts ); $i++
) {
81 $domainPart = $domainParts[$i];
83 $domain = $domainPart;
85 $domain = $domainPart . '.' . $domain;
87 if ( $wgConf->isLocalVHost( $domain ) ) {
96 * A standard user-agent we can use for external requests.
99 public static function userAgent() {
101 return "MediaWiki/$wgVersion";
105 * Checks that the given URI is a valid one
106 * @param $uri Mixed: URI to check for validity
109 public static function isValidURI( $uri ) {
111 '/(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/',
119 * This wrapper class will call out to curl (if available) or fallback
120 * to regular PHP if necessary for handling internal HTTP requests.
124 protected $timeout = 'default';
125 protected $headersOnly = null;
126 protected $postData = null;
127 protected $proxy = null;
128 protected $noProxy = false;
129 protected $sslVerifyHost = true;
130 protected $caInfo = null;
131 protected $method = "GET";
132 protected $reqHeaders = array();
134 protected $parsedUrl;
136 protected $maxRedirects = 5;
137 protected $followRedirects = true;
139 protected $cookieJar;
141 protected $headerList = array();
142 protected $respVersion = "0.9";
143 protected $respStatus = "0.1";
144 protected $respHeaders = array();
149 * @param $url string url to use
150 * @param $options array (optional) extra params to pass (see Http::request())
152 function __construct( $url, $options = array() ) {
153 global $wgHTTPTimeout;
156 $this->parsedUrl
= parse_url( $url );
158 if ( !Http
::isValidURI( $this->url
) ) {
159 $this->status
= Status
::newFromFatal('http-invalid-url');
161 $this->status
= Status
::newGood( 100 ); // continue
164 if ( isset($options['timeout']) && $options['timeout'] != 'default' ) {
165 $this->timeout
= $options['timeout'];
167 $this->timeout
= $wgHTTPTimeout;
170 $members = array( "postData", "proxy", "noProxy", "sslVerifyHost", "caInfo",
171 "method", "followRedirects", "maxRedirects" );
172 foreach ( $members as $o ) {
173 if ( isset($options[$o]) ) {
174 $this->$o = $options[$o];
180 * Generate a new request object
181 * @see HttpRequest::__construct
183 public static function factory( $url, $options = null ) {
184 if ( !Http
::$httpEngine ) {
185 Http
::$httpEngine = function_exists( 'curl_init' ) ?
'curl' : 'php';
186 } elseif ( Http
::$httpEngine == 'curl' && !function_exists( 'curl_init' ) ) {
187 throw new MWException( __METHOD__
.': curl (http://php.net/curl) is not installed, but'.
188 ' Http::$httpEngine is set to "curl"' );
191 switch( Http
::$httpEngine ) {
193 return new CurlHttpRequest( $url, $options );
195 if ( !wfIniGetBool( 'allow_url_fopen' ) ) {
196 throw new MWException( __METHOD__
.': allow_url_fopen needs to be enabled for pure PHP'.
197 ' http requests to work. If possible, curl should be used instead. See http://php.net/curl.' );
199 return new PhpHttpRequest( $url, $options );
201 throw new MWException( __METHOD__
.': The setting of Http::$httpEngine is not valid.' );
206 * Get the body, or content, of the response to the request
209 public function getContent() {
210 return $this->content
;
214 * Take care of setting up the proxy
215 * (override in subclass)
218 public function proxySetup() {
221 if ( $this->proxy
) {
224 if ( Http
::isLocalURL( $this->url
) ) {
225 $this->proxy
= 'http://localhost:80/';
226 } elseif ( $wgHTTPProxy ) {
227 $this->proxy
= $wgHTTPProxy ;
232 * Set the refererer header
234 public function setReferer( $url ) {
235 $this->setHeader('Referer', $url);
241 public function setUserAgent( $UA ) {
242 $this->setHeader('User-Agent', $UA);
246 * Set an arbitrary header
248 public function setHeader($name, $value) {
249 // I feel like I should normalize the case here...
250 $this->reqHeaders
[$name] = $value;
254 * Get an array of the headers
256 public function getHeaderList() {
259 if( $this->cookieJar
) {
260 $this->reqHeaders
['Cookie'] = $this->cookieJar
->serializeToHttpRequest();
262 foreach($this->reqHeaders
as $name => $value) {
263 $list[] = "$name: $value";
270 * @param $callback callback
272 public function setCallback( $callback ) {
273 $this->callback
= $callback;
277 * A generic callback to read the body of the response from a remote
280 * @param $content string
282 public function read( $fh, $content ) {
283 $this->content
.= $content;
284 return strlen( $content );
288 * Take care of whatever is necessary to perform the URI request.
291 public function execute() {
294 if( strtoupper($this->method
) == "HEAD" ) {
295 $this->headersOnly
= true;
298 if ( is_array( $this->postData
) ) {
299 $this->postData
= wfArrayToCGI( $this->postData
);
302 if ( is_object( $wgTitle ) && !isset($this->reqHeaders
['Referer']) ) {
303 $this->setReferer( $wgTitle->getFullURL() );
306 if ( !$this->noProxy
) {
310 if ( !$this->callback
) {
311 $this->setCallback( array( $this, 'read' ) );
314 if ( !isset($this->reqHeaders
['User-Agent']) ) {
315 $this->setUserAgent(Http
::userAgent());
319 protected function parseHeader() {
321 foreach( $this->headerList
as $header ) {
322 if( preg_match( "#^HTTP/([0-9.]+) (.*)#", $header, $match ) ) {
323 $this->respVersion
= $match[1];
324 $this->respStatus
= $match[2];
325 } elseif( preg_match( "#^[ \t]#", $header ) ) {
326 $last = count($this->respHeaders
[$lastname]) - 1;
327 $this->respHeaders
[$lastname][$last] .= "\r\n$header";
328 } elseif( preg_match( "#^([^:]*):[\t ]*(.*)#", $header, $match ) ) {
329 $this->respHeaders
[strtolower( $match[1] )][] = $match[2];
330 $lastname = strtolower( $match[1] );
334 $this->parseCookies();
338 * Returns an associative array of response headers after the
339 * request has been executed. Because some headers
340 * (e.g. Set-Cookie) can appear more than once the, each value of
341 * the associative array is an array of the values given.
344 public function getResponseHeaders() {
345 if( !$this->respHeaders
) {
346 $this->parseHeader();
348 return $this->respHeaders
;
352 * Tells the HttpRequest object to use this pre-loaded CookieJar.
353 * @param $jar CookieJar
355 public function setCookieJar( $jar ) {
356 $this->cookieJar
= $jar;
360 * Returns the cookie jar in use.
363 public function getCookieJar() {
364 if( !$this->respHeaders
) {
365 $this->parseHeader();
367 return $this->cookieJar
;
371 * Sets a cookie. Used before a request to set up any individual
372 * cookies. Used internally after a request to parse the
373 * Set-Cookie headers.
376 public function setCookie( $name, $value = null, $attr = null) {
377 if( !$this->cookieJar
) {
378 $this->cookieJar
= new CookieJar
;
380 $this->cookieJar
->setCookie($name, $value, $attr);
384 * Parse the cookies in the response headers and store them in the cookie jar.
386 protected function parseCookies() {
387 if( isset( $this->respHeaders
['set-cookie'] ) ) {
388 if( !$this->cookieJar
) {
389 $this->cookieJar
= new CookieJar
;
391 $url = parse_url( $this->getFinalUrl() );
392 foreach( $this->respHeaders
['set-cookie'] as $cookie ) {
393 $this->cookieJar
->parseCookieResponseHeader( $cookie, $url['host'] );
399 * Returns the final URL after all redirections.
402 public function getFinalUrl() {
403 $finalUrl = $this->url
;
404 if ( isset( $this->respHeaders
['location'] ) ) {
405 $redir = $this->respHeaders
['location'];
406 $finalUrl = $redir[count($redir) - 1];
420 protected $isSessionKey = true;
421 // TO IMPLEMENT protected $secure
422 // TO IMPLEMENT? protected $maxAge (add onto expires)
423 // TO IMPLEMENT? protected $version
424 // TO IMPLEMENT? protected $comment
426 function __construct( $name, $value, $attr ) {
428 $this->set( $value, $attr );
432 * Sets a cookie. Used before a request to set up any individual
433 * cookies. Used internally after a request to parse the
434 * Set-Cookie headers.
435 * @param $name string the name of the cookie
436 * @param $value string the value of the cookie
437 * @param $attr array possible key/values:
438 * expires A date string
439 * path The path this cookie is used on
440 * domain Domain this cookie is used on
442 public function set( $value, $attr ) {
443 $this->value
= $value;
444 if( isset( $attr['expires'] ) ) {
445 $this->isSessionKey
= false;
446 $this->expires
= strtotime( $attr['expires'] );
448 if( isset( $attr['path'] ) ) {
449 $this->path
= $attr['path'];
453 if( isset( $attr['domain'] ) ) {
454 $this->domain
= $attr['domain'];
456 throw new MWException("You must specify a domain.");
461 * Serialize the cookie jar into a format useful for HTTP Request headers.
462 * @param $path string the path that will be used. Required.
463 * @param $domain string the domain that will be used. Required.
466 public function serializeToHttpRequest( $path, $domain ) {
469 if( $this->canServeDomain( $domain )
470 && $this->canServePath( $path )
471 && $this->isUnExpired() ) {
472 $ret = $this->name
."=". $this->value
;
478 protected function canServeDomain( $domain ) {
479 if( $this->domain
&& substr_compare( $domain, $this->domain
, -strlen( $this->domain
),
480 strlen( $this->domain
), TRUE ) == 0 ) {
486 protected function canServePath( $path ) {
487 if( $this->path
&& substr_compare( $this->path
, $path, 0, strlen( $this->path
) ) == 0 ) {
493 protected function isUnExpired() {
494 if( $this->isSessionKey ||
$this->expires
> time() ) {
506 * Set a cookie in the cookie jar. Make sure only one cookie per-name exists.
509 public function setCookie ($name, $value, $attr) {
510 /* cookies: case insensitive, so this should work.
511 * We'll still send the cookies back in the same case we got them, though.
513 $index = strtoupper($name);
514 if( isset( $this->cookie
[$index] ) ) {
515 $this->cookie
[$index]->set( $value, $attr );
517 $this->cookie
[$index] = new Cookie( $name, $value, $attr );
522 * @see Cookie::serializeToHttpRequest
524 public function serializeToHttpRequest( $path, $domain ) {
527 foreach( $this->cookie
as $c ) {
528 $serialized = $c->serializeToHttpRequest( $path, $domain );
529 if ( $serialized ) $cookies[] = $serialized;
532 return implode("; ", $cookies);
536 * Parse the content of an Set-Cookie HTTP Response header.
537 * @param $cookie string
539 public function parseCookieResponseHeader ( $cookie, $domain = null ) {
540 $len = strlen( "Set-Cookie:" );
541 if ( substr_compare( "Set-Cookie:", $cookie, 0, $len, TRUE ) === 0 ) {
542 $cookie = substr( $cookie, $len );
545 $bit = array_map( 'trim', explode( ";", $cookie ) );
546 list($name, $value) = explode( "=", array_shift( $bit ), 2 );
548 foreach( $bit as $piece ) {
549 $parts = explode( "=", $piece );
550 if( count( $parts ) > 1 ) {
551 $attr[strtolower( $parts[0] )] = $parts[1];
553 $attr[strtolower( $parts[0] )] = true;
556 $this->setCookie( $name, $value, $attr );
562 * HttpRequest implemented using internal curl compiled into PHP
564 class CurlHttpRequest
extends HttpRequest
{
565 static $curlMessageMap = array(
566 6 => 'http-host-unreachable',
567 28 => 'http-timed-out'
570 protected $curlOptions = array();
571 protected $headerText = "";
573 protected function readHeader( $fh, $content ) {
574 $this->headerText
.= $content;
575 return strlen( $content );
578 public function execute() {
580 if ( !$this->status
->isOK() ) {
581 return $this->status
;
583 $this->curlOptions
[CURLOPT_PROXY
] = $this->proxy
;
584 $this->curlOptions
[CURLOPT_TIMEOUT
] = $this->timeout
;
585 $this->curlOptions
[CURLOPT_HTTP_VERSION
] = CURL_HTTP_VERSION_1_0
;
586 $this->curlOptions
[CURLOPT_WRITEFUNCTION
] = $this->callback
;
587 $this->curlOptions
[CURLOPT_HEADERFUNCTION
] = array($this, "readHeader");
588 $this->curlOptions
[CURLOPT_FOLLOWLOCATION
] = $this->followRedirects
;
589 $this->curlOptions
[CURLOPT_MAXREDIRS
] = $this->maxRedirects
;
591 /* not sure these two are actually necessary */
592 if(isset($this->reqHeaders
['Referer'])) {
593 $this->curlOptions
[CURLOPT_REFERER
] = $this->reqHeaders
['Referer'];
595 $this->curlOptions
[CURLOPT_USERAGENT
] = $this->reqHeaders
['User-Agent'];
597 if ( $this->sslVerifyHost
) {
598 $this->curlOptions
[CURLOPT_SSL_VERIFYHOST
] = $this->sslVerifyHost
;
601 if ( $this->caInfo
) {
602 $this->curlOptions
[CURLOPT_CAINFO
] = $this->caInfo
;
605 if ( $this->headersOnly
) {
606 $this->curlOptions
[CURLOPT_NOBODY
] = true;
607 $this->curlOptions
[CURLOPT_HEADER
] = true;
608 } elseif ( $this->method
== 'POST' ) {
609 $this->curlOptions
[CURLOPT_POST
] = true;
610 $this->curlOptions
[CURLOPT_POSTFIELDS
] = $this->postData
;
611 // Suppress 'Expect: 100-continue' header, as some servers
612 // will reject it with a 417 and Curl won't auto retry
613 // with HTTP 1.0 fallback
614 $this->reqHeaders
['Expect'] = '';
616 $this->curlOptions
[CURLOPT_CUSTOMREQUEST
] = $this->method
;
619 $this->curlOptions
[CURLOPT_HTTPHEADER
] = $this->getHeaderList();
621 $curlHandle = curl_init( $this->url
);
622 curl_setopt_array( $curlHandle, $this->curlOptions
);
624 if ( false === curl_exec( $curlHandle ) ) {
625 $code = curl_error( $curlHandle );
627 if ( isset( self
::$curlMessageMap[$code] ) ) {
628 $this->status
->fatal( self
::$curlMessageMap[$code] );
630 $this->status
->fatal( 'http-curl-error', curl_error( $curlHandle ) );
633 $this->headerList
= explode("\r\n", $this->headerText
);
636 curl_close( $curlHandle );
638 return $this->status
;
642 class PhpHttpRequest
extends HttpRequest
{
643 protected function urlToTcp( $url ) {
644 $parsedUrl = parse_url( $url );
646 return 'tcp://' . $parsedUrl['host'] . ':' . $parsedUrl['port'];
649 public function execute() {
650 if ( $this->parsedUrl
['scheme'] != 'http' ) {
651 $this->status
->fatal( 'http-invalid-scheme', $this->parsedURL
['scheme'] );
655 if ( !$this->status
->isOK() ) {
656 return $this->status
;
659 $this->reqHeaders
['Accept'] = "*/*";
660 if ( $this->method
== 'POST' ) {
661 // Required for HTTP 1.0 POSTs
662 $this->reqHeaders
['Content-Length'] = strlen( $this->postData
);
663 $this->reqHeaders
['Content-type'] = "application/x-www-form-urlencoded";
667 if ( $this->proxy
&& !$this->noProxy
) {
668 $options['proxy'] = $this->urlToTCP( $this->proxy
);
669 $options['request_fulluri'] = true;
672 if ( !$this->followRedirects
) {
673 $options['max_redirects'] = 0;
675 $options['max_redirects'] = $this->maxRedirects
;
678 $options['method'] = $this->method
;
679 $options['timeout'] = $this->timeout
;
680 $options['header'] = implode("\r\n", $this->getHeaderList());
681 // Note that at some future point we may want to support
682 // HTTP/1.1, but we'd have to write support for chunking
683 // in version of PHP < 5.3.1
684 $options['protocol_version'] = "1.0";
686 if ( $this->postData
) {
687 $options['content'] = $this->postData
;
691 if ( version_compare( '5.2.1', phpversion(), '>' ) ) {
692 $oldTimeout = ini_set('default_socket_timeout', $this->timeout
);
695 $context = stream_context_create( array( 'http' => $options ) );
696 wfSuppressWarnings();
697 $fh = fopen( $this->url
, "r", false, $context );
699 if ( $oldTimeout !== false ) {
700 ini_set('default_socket_timeout', $oldTimeout);
702 if ( $fh === false ) {
703 $this->status
->fatal( 'http-request-error' );
704 return $this->status
;
707 $result = stream_get_meta_data( $fh );
708 if ( $result['timed_out'] ) {
709 $this->status
->fatal( 'http-timed-out', $this->url
);
710 return $this->status
;
712 $this->headerList
= $result['wrapper_data'];
714 while ( !feof( $fh ) ) {
715 $buf = fread( $fh, 8192 );
716 if ( $buf === false ) {
717 $this->status
->fatal( 'http-read-error' );
720 if ( strlen( $buf ) ) {
721 call_user_func( $this->callback
, $fh, $buf );
726 return $this->status
;