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'] =
261 $this->cookieJar
->serializeToHttpRequest($this->parsedURL
['path'],
262 $this->parsedURL
['host']);
264 foreach($this->reqHeaders
as $name => $value) {
265 $list[] = "$name: $value";
272 * @param $callback callback
274 public function setCallback( $callback ) {
275 $this->callback
= $callback;
279 * A generic callback to read the body of the response from a remote
282 * @param $content string
284 public function read( $fh, $content ) {
285 $this->content
.= $content;
286 return strlen( $content );
290 * Take care of whatever is necessary to perform the URI request.
293 public function execute() {
296 if( strtoupper($this->method
) == "HEAD" ) {
297 $this->headersOnly
= true;
300 if ( is_array( $this->postData
) ) {
301 $this->postData
= wfArrayToCGI( $this->postData
);
304 if ( is_object( $wgTitle ) && !isset($this->reqHeaders
['Referer']) ) {
305 $this->setReferer( $wgTitle->getFullURL() );
308 if ( !$this->noProxy
) {
312 if ( !$this->callback
) {
313 $this->setCallback( array( $this, 'read' ) );
316 if ( !isset($this->reqHeaders
['User-Agent']) ) {
317 $this->setUserAgent(Http
::userAgent());
321 protected function parseHeader() {
323 foreach( $this->headerList
as $header ) {
324 if( preg_match( "#^HTTP/([0-9.]+) (.*)#", $header, $match ) ) {
325 $this->respVersion
= $match[1];
326 $this->respStatus
= $match[2];
327 } elseif( preg_match( "#^[ \t]#", $header ) ) {
328 $last = count($this->respHeaders
[$lastname]) - 1;
329 $this->respHeaders
[$lastname][$last] .= "\r\n$header";
330 } elseif( preg_match( "#^([^:]*):[\t ]*(.*)#", $header, $match ) ) {
331 $this->respHeaders
[strtolower( $match[1] )][] = $match[2];
332 $lastname = strtolower( $match[1] );
336 $this->parseCookies();
340 * Returns an associative array of response headers after the
341 * request has been executed. Because some headers
342 * (e.g. Set-Cookie) can appear more than once the, each value of
343 * the associative array is an array of the values given.
346 public function getResponseHeaders() {
347 if( !$this->respHeaders
) {
348 $this->parseHeader();
350 return $this->respHeaders
;
354 * Tells the HttpRequest object to use this pre-loaded CookieJar.
355 * @param $jar CookieJar
357 public function setCookieJar( $jar ) {
358 $this->cookieJar
= $jar;
362 * Returns the cookie jar in use.
365 public function getCookieJar() {
366 if( !$this->respHeaders
) {
367 $this->parseHeader();
369 return $this->cookieJar
;
373 * Sets a cookie. Used before a request to set up any individual
374 * cookies. Used internally after a request to parse the
375 * Set-Cookie headers.
378 public function setCookie( $name, $value = null, $attr = null) {
379 if( !$this->cookieJar
) {
380 $this->cookieJar
= new CookieJar
;
382 $this->cookieJar
->setCookie($name, $value, $attr);
386 * Parse the cookies in the response headers and store them in the cookie jar.
388 protected function parseCookies() {
389 if( !$this->cookieJar
) {
390 $this->cookieJar
= new CookieJar
;
392 if( isset( $this->respHeaders
['set-cookie'] ) ) {
393 $url = parse_url( $this->getFinalUrl() );
394 foreach( $this->respHeaders
['set-cookie'] as $cookie ) {
395 $this->cookieJar
->parseCookieResponseHeader( $cookie, $url['host'] );
401 * Returns the final URL after all redirections.
404 public function getFinalUrl() {
405 $finalUrl = $this->url
;
406 if ( isset( $this->respHeaders
['location'] ) ) {
407 $redir = $this->respHeaders
['location'];
408 $finalUrl = $redir[count($redir) - 1];
422 protected $isSessionKey = true;
423 // TO IMPLEMENT protected $secure
424 // TO IMPLEMENT? protected $maxAge (add onto expires)
425 // TO IMPLEMENT? protected $version
426 // TO IMPLEMENT? protected $comment
428 function __construct( $name, $value, $attr ) {
430 $this->set( $value, $attr );
434 * Sets a cookie. Used before a request to set up any individual
435 * cookies. Used internally after a request to parse the
436 * Set-Cookie headers.
437 * @param $name string the name of the cookie
438 * @param $value string the value of the cookie
439 * @param $attr array possible key/values:
440 * expires A date string
441 * path The path this cookie is used on
442 * domain Domain this cookie is used on
444 public function set( $value, $attr ) {
445 $this->value
= $value;
446 if( isset( $attr['expires'] ) ) {
447 $this->isSessionKey
= false;
448 $this->expires
= strtotime( $attr['expires'] );
450 if( isset( $attr['path'] ) ) {
451 $this->path
= $attr['path'];
455 if( isset( $attr['domain'] ) ) {
456 $this->domain
= self
::parseCookieDomain( $attr['domain'] );
458 throw new MWException("You must specify a domain.");
462 public static function parseCookieDomain( $domain ) {
463 /* If domain is given, it has to contain at least two dots */
464 if ( strrpos( $domain, '.' ) === false
465 ||
strrpos( $domain, '.' ) === strpos( $domain, '.' ) ) {
468 if ( substr( $domain, 0, 1 ) === '.' ) {
469 $domain = substr( $domain, 1 );
476 * Serialize the cookie jar into a format useful for HTTP Request headers.
477 * @param $path string the path that will be used. Required.
478 * @param $domain string the domain that will be used. Required.
481 public function serializeToHttpRequest( $path, $domain ) {
484 if( $this->canServeDomain( $domain )
485 && $this->canServePath( $path )
486 && $this->isUnExpired() ) {
487 $ret = $this->name
."=". $this->value
;
493 protected function canServeDomain( $domain ) {
494 if( $this->domain
&& substr_compare( $domain, $this->domain
, -strlen( $this->domain
),
495 strlen( $this->domain
), TRUE ) == 0 ) {
501 protected function canServePath( $path ) {
502 if( $this->path
&& substr_compare( $this->path
, $path, 0, strlen( $this->path
) ) == 0 ) {
508 protected function isUnExpired() {
509 if( $this->isSessionKey ||
$this->expires
> time() ) {
518 private $cookie = array();
521 * Set a cookie in the cookie jar. Make sure only one cookie per-name exists.
524 public function setCookie ($name, $value, $attr) {
525 /* cookies: case insensitive, so this should work.
526 * We'll still send the cookies back in the same case we got them, though.
528 $index = strtoupper($name);
529 if( isset( $this->cookie
[$index] ) ) {
530 $this->cookie
[$index]->set( $value, $attr );
532 $this->cookie
[$index] = new Cookie( $name, $value, $attr );
537 * @see Cookie::serializeToHttpRequest
539 public function serializeToHttpRequest( $path, $domain ) {
542 foreach( $this->cookie
as $c ) {
543 $serialized = $c->serializeToHttpRequest( $path, $domain );
544 if ( $serialized ) $cookies[] = $serialized;
547 return implode("; ", $cookies);
551 * Parse the content of an Set-Cookie HTTP Response header.
552 * @param $cookie string
554 public function parseCookieResponseHeader ( $cookie, $domain ) {
555 $len = strlen( "Set-Cookie:" );
556 if ( substr_compare( "Set-Cookie:", $cookie, 0, $len, TRUE ) === 0 ) {
557 $cookie = substr( $cookie, $len );
560 $bit = array_map( 'trim', explode( ";", $cookie ) );
561 if ( count($bit) >= 1 ) {
562 list($name, $value) = explode( "=", array_shift( $bit ), 2 );
564 foreach( $bit as $piece ) {
565 $parts = explode( "=", $piece );
566 if( count( $parts ) > 1 ) {
567 $attr[strtolower( $parts[0] )] = $parts[1];
569 $attr[strtolower( $parts[0] )] = true;
573 if( !isset( $attr['domain'] ) ) {
574 $attr['domain'] = $domain;
576 if ( strlen( $attr['domain'] ) < strlen( $domain )
577 && substr_compare( $domain, $attr['domain'], -strlen( $attr['domain'] ),
578 strlen( $attr['domain'] ), TRUE ) != 0 ) {
579 return; /* silently reject a bad cookie */
582 $this->setCookie( $name, $value, $attr );
589 * HttpRequest implemented using internal curl compiled into PHP
591 class CurlHttpRequest
extends HttpRequest
{
592 static $curlMessageMap = array(
593 6 => 'http-host-unreachable',
594 28 => 'http-timed-out'
597 protected $curlOptions = array();
598 protected $headerText = "";
600 protected function readHeader( $fh, $content ) {
601 $this->headerText
.= $content;
602 return strlen( $content );
605 public function execute() {
607 if ( !$this->status
->isOK() ) {
608 return $this->status
;
610 $this->curlOptions
[CURLOPT_PROXY
] = $this->proxy
;
611 $this->curlOptions
[CURLOPT_TIMEOUT
] = $this->timeout
;
612 $this->curlOptions
[CURLOPT_HTTP_VERSION
] = CURL_HTTP_VERSION_1_0
;
613 $this->curlOptions
[CURLOPT_WRITEFUNCTION
] = $this->callback
;
614 $this->curlOptions
[CURLOPT_HEADERFUNCTION
] = array($this, "readHeader");
615 $this->curlOptions
[CURLOPT_FOLLOWLOCATION
] = $this->followRedirects
;
616 $this->curlOptions
[CURLOPT_MAXREDIRS
] = $this->maxRedirects
;
618 /* not sure these two are actually necessary */
619 if(isset($this->reqHeaders
['Referer'])) {
620 $this->curlOptions
[CURLOPT_REFERER
] = $this->reqHeaders
['Referer'];
622 $this->curlOptions
[CURLOPT_USERAGENT
] = $this->reqHeaders
['User-Agent'];
624 if ( $this->sslVerifyHost
) {
625 $this->curlOptions
[CURLOPT_SSL_VERIFYHOST
] = $this->sslVerifyHost
;
628 if ( $this->caInfo
) {
629 $this->curlOptions
[CURLOPT_CAINFO
] = $this->caInfo
;
632 if ( $this->headersOnly
) {
633 $this->curlOptions
[CURLOPT_NOBODY
] = true;
634 $this->curlOptions
[CURLOPT_HEADER
] = true;
635 } elseif ( $this->method
== 'POST' ) {
636 $this->curlOptions
[CURLOPT_POST
] = true;
637 $this->curlOptions
[CURLOPT_POSTFIELDS
] = $this->postData
;
638 // Suppress 'Expect: 100-continue' header, as some servers
639 // will reject it with a 417 and Curl won't auto retry
640 // with HTTP 1.0 fallback
641 $this->reqHeaders
['Expect'] = '';
643 $this->curlOptions
[CURLOPT_CUSTOMREQUEST
] = $this->method
;
646 $this->curlOptions
[CURLOPT_HTTPHEADER
] = $this->getHeaderList();
648 $curlHandle = curl_init( $this->url
);
649 curl_setopt_array( $curlHandle, $this->curlOptions
);
651 if ( false === curl_exec( $curlHandle ) ) {
652 $code = curl_error( $curlHandle );
654 if ( isset( self
::$curlMessageMap[$code] ) ) {
655 $this->status
->fatal( self
::$curlMessageMap[$code] );
657 $this->status
->fatal( 'http-curl-error', curl_error( $curlHandle ) );
660 $this->headerList
= explode("\r\n", $this->headerText
);
663 curl_close( $curlHandle );
665 return $this->status
;
669 class PhpHttpRequest
extends HttpRequest
{
670 protected function urlToTcp( $url ) {
671 $parsedUrl = parse_url( $url );
673 return 'tcp://' . $parsedUrl['host'] . ':' . $parsedUrl['port'];
676 public function execute() {
677 if ( $this->parsedUrl
['scheme'] != 'http' ) {
678 $this->status
->fatal( 'http-invalid-scheme', $this->parsedURL
['scheme'] );
682 if ( !$this->status
->isOK() ) {
683 return $this->status
;
686 $this->reqHeaders
['Accept'] = "*/*";
687 if ( $this->method
== 'POST' ) {
688 // Required for HTTP 1.0 POSTs
689 $this->reqHeaders
['Content-Length'] = strlen( $this->postData
);
690 $this->reqHeaders
['Content-type'] = "application/x-www-form-urlencoded";
694 if ( $this->proxy
&& !$this->noProxy
) {
695 $options['proxy'] = $this->urlToTCP( $this->proxy
);
696 $options['request_fulluri'] = true;
699 if ( !$this->followRedirects
) {
700 $options['max_redirects'] = 0;
702 $options['max_redirects'] = $this->maxRedirects
;
705 $options['method'] = $this->method
;
706 $options['timeout'] = $this->timeout
;
707 $options['header'] = implode("\r\n", $this->getHeaderList());
708 // Note that at some future point we may want to support
709 // HTTP/1.1, but we'd have to write support for chunking
710 // in version of PHP < 5.3.1
711 $options['protocol_version'] = "1.0";
713 if ( $this->postData
) {
714 $options['content'] = $this->postData
;
718 if ( version_compare( '5.2.1', phpversion(), '>' ) ) {
719 $oldTimeout = ini_set('default_socket_timeout', $this->timeout
);
722 $context = stream_context_create( array( 'http' => $options ) );
723 wfSuppressWarnings();
724 $fh = fopen( $this->url
, "r", false, $context );
726 if ( $oldTimeout !== false ) {
727 ini_set('default_socket_timeout', $oldTimeout);
729 if ( $fh === false ) {
730 $this->status
->fatal( 'http-request-error' );
731 return $this->status
;
734 $result = stream_get_meta_data( $fh );
735 if ( $result['timed_out'] ) {
736 $this->status
->fatal( 'http-timed-out', $this->url
);
737 return $this->status
;
739 $this->headerList
= $result['wrapper_data'];
741 while ( !feof( $fh ) ) {
742 $buf = fread( $fh, 8192 );
743 if ( $buf === false ) {
744 $this->status
->fatal( 'http-read-error' );
747 if ( strlen( $buf ) ) {
748 call_user_func( $this->callback
, $fh, $buf );
753 return $this->status
;