Localisation updates for core and extension messages from translatewiki.net (2011...

[mediawiki.git] / includes / HttpFunctions.php

<?php
/**
 * @defgroup HTTP HTTP
 */

/**
 * Various HTTP related functions
 * @ingroup HTTP
 */
class Http {
        static $httpEngine = false;

        /**
         * Perform an HTTP request
         *
         * @param $method String: HTTP method. Usually GET/POST
         * @param $url String: full URL to act on
         * @param $options Array: options to pass to MWHttpRequest object.
         *      Possible keys for the array:
         *    - timeout             Timeout length in seconds
         *    - postData            An array of key-value pairs or a url-encoded form data
         *    - proxy               The proxy to use.
         *                          Will use $wgHTTPProxy (if set) otherwise.
         *    - noProxy             Override $wgHTTPProxy (if set) and don't use any proxy at all.
         *    - sslVerifyHost       (curl only) Verify hostname against certificate
         *    - sslVerifyCert       (curl only) Verify SSL certificate
         *    - caInfo              (curl only) 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.
         * @return Mixed: (bool)false on failure or a string on success
         */
        public static function request( $method, $url, $options = array() ) {
                $url = wfExpandUrl( $url );
                wfDebug( "HTTP: $method: $url\n" );
                $options['method'] = strtoupper( $method );

                if ( !isset( $options['timeout'] ) ) {
                        $options['timeout'] = 'default';
                }

                $req = MWHttpRequest::factory( $url, $options );
                $status = $req->execute();

                if ( $status->isOK() ) {
                        return $req->getContent();
                } else {
                        return false;
                }
        }

        /**
         * Simple wrapper for Http::request( 'GET' )
         * @see Http::request()
         */
        public static function get( $url, $timeout = 'default', $options = array() ) {
                $options['timeout'] = $timeout;
                return Http::request( 'GET', $url, $options );
        }

        /**
         * Simple wrapper for Http::request( 'POST' )
         * @see Http::request()
         */
        public static function post( $url, $options = array() ) {
                return Http::request( 'POST', $url, $options );
        }

        /**
         * Check if the URL can be served by localhost
         *
         * @param $url String: full url to check
         * @return Boolean
         */
        public static function isLocalURL( $url ) {
                global $wgCommandLineMode, $wgConf;

                if ( $wgCommandLineMode ) {
                        return false;
                }

                // Extract host part
                $matches = array();
                if ( preg_match( '!^http://([\w.-]+)[/:].*$!', $url, $matches ) ) {
                        $host = $matches[1];
                        // Split up dotwise
                        $domainParts = explode( '.', $host );
                        // Check if this domain or any superdomain is listed in $wgConf as a local virtual host
                        $domainParts = array_reverse( $domainParts );

                        $domain = '';
                        for ( $i = 0; $i < count( $domainParts ); $i++ ) {
                                $domainPart = $domainParts[$i];
                                if ( $i == 0 ) {
                                        $domain = $domainPart;
                                } else {
                                        $domain = $domainPart . '.' . $domain;
                                }

                                if ( $wgConf->isLocalVHost( $domain ) ) {
                                        return true;
                                }
                        }
                }

                return false;
        }

        /**
         * A standard user-agent we can use for external requests.
         * @return String
         */
        public static function userAgent() {
                global $wgVersion;
                return "MediaWiki/$wgVersion";
        }

        /**
         * Checks that the given URI is a valid one. Hardcoding the
         * protocols, because we only want protocols that both cURL
         * and php support.
         *
         * @param $uri Mixed: URI to check for validity
         * @returns Boolean
         */
        public static function isValidURI( $uri ) {
                return preg_match(
                        '/^(f|ht)tps?:\/\/[^\/\s]\S*$/D',
                        $uri
                );
        }
}

/**
 * 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.
 */
class MWHttpRequest {
        const SUPPORTS_FILE_POSTS = false;

        protected $content;
        protected $timeout = 'default';
        protected $headersOnly = null;
        protected $postData = null;
        protected $proxy = null;
        protected $noProxy = false;
        protected $sslVerifyHost = true;
        protected $sslVerifyCert = true;
        protected $caInfo = null;
        protected $method = "GET";
        protected $reqHeaders = array();
        protected $url;
        protected $parsedUrl;
        protected $callback;
        protected $maxRedirects = 5;
        protected $followRedirects = false;

        /**
         * @var  CookieJar
         */
        protected $cookieJar;

        protected $headerList = array();
        protected $respVersion = "0.9";
        protected $respStatus = "200 Ok";
        protected $respHeaders = array();

        public $status;

        /**
         * @param $url String: url to use
         * @param $options Array: (optional) extra params to pass (see Http::request())
         */
        function __construct( $url, $options = array() ) {
                global $wgHTTPTimeout;

                $this->url = $url;
                $this->parsedUrl = parse_url( $url );

                if ( !Http::isValidURI( $this->url ) ) {
                        $this->status = Status::newFatal( 'http-invalid-url' );
                } else {
                        $this->status = Status::newGood( 100 ); // continue
                }

                if ( isset( $options['timeout'] ) && $options['timeout'] != 'default' ) {
                        $this->timeout = $options['timeout'];
                } else {
                        $this->timeout = $wgHTTPTimeout;
                }

                $members = array( "postData", "proxy", "noProxy", "sslVerifyHost", "caInfo",
                                  "method", "followRedirects", "maxRedirects", "sslVerifyCert", "callback" );

                foreach ( $members as $o ) {
                        if ( isset( $options[$o] ) ) {
                                $this->$o = $options[$o];
                        }
                }
        }

        /**
         * Generate a new request object
         * @param $url String: url to use
         * @param $options Array: (optional) extra params to pass (see Http::request())
         * @see MWHttpRequest::__construct
         */
        public static function factory( $url, $options = null ) {
                if ( !Http::$httpEngine ) {
                        Http::$httpEngine = function_exists( 'curl_init' ) ? 'curl' : 'php';
                } elseif ( Http::$httpEngine == 'curl' && !function_exists( 'curl_init' ) ) {
                        throw new MWException( __METHOD__ . ': curl (http://php.net/curl) is not installed, but' .
                                                                   ' Http::$httpEngine is set to "curl"' );
                }

                switch( Http::$httpEngine ) {
                        case 'curl':
                                return new CurlHttpRequest( $url, $options );
                        case 'php':
                                if ( !wfIniGetBool( 'allow_url_fopen' ) ) {
                                        throw new MWException( __METHOD__ . ': allow_url_fopen needs to be enabled for pure PHP' .
                                                ' http requests to work. If possible, curl should be used instead. See http://php.net/curl.' );
                                }
                                return new PhpHttpRequest( $url, $options );
                        default:
                                throw new MWException( __METHOD__ . ': The setting of Http::$httpEngine is not valid.' );
                }
        }

        /**
         * Get the body, or content, of the response to the request
         *
         * @return String
         */
        public function getContent() {
                return $this->content;
        }

        /**
         * Set the parameters of the request

         * @param $args Array
         * @todo overload the args param
         */
        public function setData( $args ) {
                $this->postData = $args;
        }

        /**
         * Take care of setting up the proxy
         * (override in subclass)
         *
         * @return String
         */
        public function proxySetup() {
                global $wgHTTPProxy;

                if ( $this->proxy ) {
                        return;
                }

                if ( Http::isLocalURL( $this->url ) ) {
                        $this->proxy = 'http://localhost:80/';
                } elseif ( $wgHTTPProxy ) {
                        $this->proxy = $wgHTTPProxy ;
                } elseif ( getenv( "http_proxy" ) ) {
                        $this->proxy = getenv( "http_proxy" );
                }
        }

        /**
         * Set the refererer header
         */
        public function setReferer( $url ) {
                $this->setHeader( 'Referer', $url );
        }

        /**
         * Set the user agent
         */
        public function setUserAgent( $UA ) {
                $this->setHeader( 'User-Agent', $UA );
        }

        /**
         * Set an arbitrary header
         */
        public function setHeader( $name, $value ) {
                // I feel like I should normalize the case here...
                $this->reqHeaders[$name] = $value;
        }

        /**
         * Get an array of the headers
         */
        public function getHeaderList() {
                $list = array();

                if ( $this->cookieJar ) {
                        $this->reqHeaders['Cookie'] =
                                $this->cookieJar->serializeToHttpRequest(
                                        $this->parsedUrl['path'],
                                        $this->parsedUrl['host']
                                );
                }

                foreach ( $this->reqHeaders as $name => $value ) {
                        $list[] = "$name: $value";
                }

                return $list;
        }

        /**
         * Set the callback
         *
         * @param $callback Callback
         */
        public function setCallback( $callback ) {
                $this->callback = $callback;
        }

        /**
         * A generic callback to read the body of the response from a remote
         * server.
         *
         * @param $fh handle
         * @param $content String
         */
        public function read( $fh, $content ) {
                $this->content .= $content;
                return strlen( $content );
        }

        /**
         * Take care of whatever is necessary to perform the URI request.
         *
         * @return Status
         */
        public function execute() {
                global $wgTitle;

                $this->content = "";

                if ( strtoupper( $this->method ) == "HEAD" ) {
                        $this->headersOnly = true;
                }

                if ( is_object( $wgTitle ) && !isset( $this->reqHeaders['Referer'] ) ) {
                        $this->setReferer( $wgTitle->getFullURL() );
                }

                if ( !$this->noProxy ) {
                        $this->proxySetup();
                }

                if ( !$this->callback ) {
                        $this->setCallback( array( $this, 'read' ) );
                }

                if ( !isset( $this->reqHeaders['User-Agent'] ) ) {
                        $this->setUserAgent( Http::userAgent() );
                }
        }

        /**
         * Parses the headers, including the HTTP status code and any
         * Set-Cookie headers.  This function expectes the headers to be
         * found in an array in the member variable headerList.
         *
         * @return nothing
         */
        protected function parseHeader() {
                $lastname = "";

                foreach ( $this->headerList as $header ) {
                        if ( preg_match( "#^HTTP/([0-9.]+) (.*)#", $header, $match ) ) {
                                $this->respVersion = $match[1];
                                $this->respStatus = $match[2];
                        } elseif ( preg_match( "#^[ \t]#", $header ) ) {
                                $last = count( $this->respHeaders[$lastname] ) - 1;
                                $this->respHeaders[$lastname][$last] .= "\r\n$header";
                        } elseif ( preg_match( "#^([^:]*):[\t ]*(.*)#", $header, $match ) ) {
                                $this->respHeaders[strtolower( $match[1] )][] = $match[2];
                                $lastname = strtolower( $match[1] );
                        }
                }

                $this->parseCookies();
        }

        /**
         * 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.)
         *
         * @return nothing
         */
        protected function setStatus() {
                if ( !$this->respHeaders ) {
                        $this->parseHeader();
                }

                if ( (int)$this->respStatus > 399 ) {
                        list( $code, $message ) = explode( " ", $this->respStatus, 2 );
                        $this->status->fatal( "http-bad-status", $code, $message );
                }
        }

        /**
         * 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.)
         *
         * @return Integer
         */
        public function getStatus() {
                if ( !$this->respHeaders ) {
                        $this->parseHeader();
                }

                return (int)$this->respStatus;
        }


        /**
         * Returns true if the last status code was a redirect.
         *
         * @return Boolean
         */
        public function isRedirect() {
                if ( !$this->respHeaders ) {
                        $this->parseHeader();
                }

                $status = (int)$this->respStatus;

                if ( $status >= 300 && $status <= 303 ) {
                        return true;
                }

                return false;
        }

        /**
         * 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.
         *
         * @return Array
         */
        public function getResponseHeaders() {
                if ( !$this->respHeaders ) {
                        $this->parseHeader();
                }

                return $this->respHeaders;
        }

        /**
         * Returns the value of the given response header.
         *
         * @param $header String
         * @return String
         */
        public function getResponseHeader( $header ) {
                if ( !$this->respHeaders ) {
                        $this->parseHeader();
                }

                if ( isset( $this->respHeaders[strtolower ( $header ) ] ) ) {
                        $v = $this->respHeaders[strtolower ( $header ) ];
                        return $v[count( $v ) - 1];
                }

                return null;
        }

        /**
         * Tells the MWHttpRequest object to use this pre-loaded CookieJar.
         *
         * @param $jar CookieJar
         */
        public function setCookieJar( $jar ) {
                $this->cookieJar = $jar;
        }

        /**
         * Returns the cookie jar in use.
         *
         * @returns CookieJar
         */
        public function getCookieJar() {
                if ( !$this->respHeaders ) {
                        $this->parseHeader();
                }

                return $this->cookieJar;
        }

        /**
         * 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 Cookie::set
         */
        public function setCookie( $name, $value = null, $attr = null ) {
                if ( !$this->cookieJar ) {
                        $this->cookieJar = new CookieJar;
                }

                $this->cookieJar->setCookie( $name, $value, $attr );
        }

        /**
         * Parse the cookies in the response headers and store them in the cookie jar.
         */
        protected function parseCookies() {
                if ( !$this->cookieJar ) {
                        $this->cookieJar = new CookieJar;
                }

                if ( isset( $this->respHeaders['set-cookie'] ) ) {
                        $url = parse_url( $this->getFinalUrl() );
                        foreach ( $this->respHeaders['set-cookie'] as $cookie ) {
                                $this->cookieJar->parseCookieResponseHeader( $cookie, $url['host'] );
                        }
                }
        }

        /**
         * Returns the final URL after all redirections.
         *
         * @return String
         */
        public function getFinalUrl() {
                $location = $this->getResponseHeader( "Location" );

                if ( $location ) {
                        return $location;
                }

                return $this->url;
        }

        /**
         * Returns true if the backend can follow redirects. Overridden by the
         * child classes.
         */
        public function canFollowRedirects() {
                return true;
        }
}

/**
 * MWHttpRequest implemented using internal curl compiled into PHP
 */
class CurlHttpRequest extends MWHttpRequest {
        const SUPPORTS_FILE_POSTS = true;

        static $curlMessageMap = array(
                6 => 'http-host-unreachable',
                28 => 'http-timed-out'
        );

        protected $curlOptions = array();
        protected $headerText = "";

        protected function readHeader( $fh, $content ) {
                $this->headerText .= $content;
                return strlen( $content );
        }

        public function execute() {
                parent::execute();

                if ( !$this->status->isOK() ) {
                        return $this->status;
                }

                $this->curlOptions[CURLOPT_PROXY] = $this->proxy;
                $this->curlOptions[CURLOPT_TIMEOUT] = $this->timeout;
                $this->curlOptions[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_0;
                $this->curlOptions[CURLOPT_WRITEFUNCTION] = $this->callback;
                $this->curlOptions[CURLOPT_HEADERFUNCTION] = array( $this, "readHeader" );
                $this->curlOptions[CURLOPT_MAXREDIRS] = $this->maxRedirects;
                $this->curlOptions[CURLOPT_ENCODING] = ""; # Enable compression

                /* not sure these two are actually necessary */
                if ( isset( $this->reqHeaders['Referer'] ) ) {
                        $this->curlOptions[CURLOPT_REFERER] = $this->reqHeaders['Referer'];
                }
                $this->curlOptions[CURLOPT_USERAGENT] = $this->reqHeaders['User-Agent'];

                if ( isset( $this->sslVerifyHost ) ) {
                        $this->curlOptions[CURLOPT_SSL_VERIFYHOST] = $this->sslVerifyHost;
                }

                if ( isset( $this->sslVerifyCert ) ) {
                        $this->curlOptions[CURLOPT_SSL_VERIFYPEER] = $this->sslVerifyCert;
                }

                if ( $this->caInfo ) {
                        $this->curlOptions[CURLOPT_CAINFO] = $this->caInfo;
                }

                if ( $this->headersOnly ) {
                        $this->curlOptions[CURLOPT_NOBODY] = true;
                        $this->curlOptions[CURLOPT_HEADER] = true;
                } elseif ( $this->method == 'POST' ) {
                        $this->curlOptions[CURLOPT_POST] = true;
                        $this->curlOptions[CURLOPT_POSTFIELDS] = $this->postData;
                        // Suppress 'Expect: 100-continue' header, as some servers
                        // will reject it with a 417 and Curl won't auto retry
                        // with HTTP 1.0 fallback
                        $this->reqHeaders['Expect'] = '';
                } else {
                        $this->curlOptions[CURLOPT_CUSTOMREQUEST] = $this->method;
                }

                $this->curlOptions[CURLOPT_HTTPHEADER] = $this->getHeaderList();

                $curlHandle = curl_init( $this->url );

                if ( !curl_setopt_array( $curlHandle, $this->curlOptions ) ) {
                        throw new MWException( "Error setting curl options." );
                }

                if ( $this->followRedirects && $this->canFollowRedirects() ) {
                        wfSuppressWarnings();
                        if ( ! curl_setopt( $curlHandle, CURLOPT_FOLLOWLOCATION, true ) ) {
                                wfDebug( __METHOD__ . ": Couldn't set CURLOPT_FOLLOWLOCATION. " .
                                        "Probably safe_mode or open_basedir is set.\n" );
                                // Continue the processing. If it were in curl_setopt_array,
                                // processing would have halted on its entry
                        }
                        wfRestoreWarnings();
                }

                if ( false === curl_exec( $curlHandle ) ) {
                        $code = curl_error( $curlHandle );

                        if ( isset( self::$curlMessageMap[$code] ) ) {
                                $this->status->fatal( self::$curlMessageMap[$code] );
                        } else {
                                $this->status->fatal( 'http-curl-error', curl_error( $curlHandle ) );
                        }
                } else {
                        $this->headerList = explode( "\r\n", $this->headerText );
                }

                curl_close( $curlHandle );

                $this->parseHeader();
                $this->setStatus();

                return $this->status;
        }

        public function canFollowRedirects() {
                if ( strval( ini_get( 'open_basedir' ) ) !== '' || wfIniGetBool( 'safe_mode' ) ) {
                        wfDebug( "Cannot follow redirects in safe mode\n" );
                        return false;
                }

                if ( !defined( 'CURLOPT_REDIR_PROTOCOLS' ) ) {
                        wfDebug( "Cannot follow redirects with libcurl < 7.19.4 due to CVE-2009-0037\n" );
                        return false;
                }

                return true;
        }
}

class PhpHttpRequest extends MWHttpRequest {
        protected function urlToTcp( $url ) {
                $parsedUrl = parse_url( $url );

                return 'tcp://' . $parsedUrl['host'] . ':' . $parsedUrl['port'];
        }

        public function execute() {
                parent::execute();

                if ( is_array( $this->postData ) ) {
                        $this->postData = wfArrayToCGI( $this->postData );
                }

                if ( $this->parsedUrl['scheme'] != 'http' ) {
                        $this->status->fatal( 'http-invalid-scheme', $this->parsedUrl['scheme'] );
                }

                $this->reqHeaders['Accept'] = "*/*";
                if ( $this->method == 'POST' ) {
                        // Required for HTTP 1.0 POSTs
                        $this->reqHeaders['Content-Length'] = strlen( $this->postData );
                        $this->reqHeaders['Content-type'] = "application/x-www-form-urlencoded";
                }

                $options = array();
                if ( $this->proxy && !$this->noProxy ) {
                        $options['proxy'] = $this->urlToTCP( $this->proxy );
                        $options['request_fulluri'] = true;
                }

                if ( !$this->followRedirects ) {
                        $options['max_redirects'] = 0;
                } else {
                        $options['max_redirects'] = $this->maxRedirects;
                }

                $options['method'] = $this->method;
                $options['header'] = implode( "\r\n", $this->getHeaderList() );
                // Note that at some future point we may want to support
                // HTTP/1.1, but we'd have to write support for chunking
                // in version of PHP < 5.3.1
                $options['protocol_version'] = "1.0";

                // This is how we tell PHP we want to deal with 404s (for example) ourselves.
                // Only works on 5.2.10+
                $options['ignore_errors'] = true;

                if ( $this->postData ) {
                        $options['content'] = $this->postData;
                }

                $options['timeout'] = $this->timeout;

                $context = stream_context_create( array( 'http' => $options ) );

                $this->headerList = array();
                $reqCount = 0;
                $url = $this->url;

                $result = array();

                do {
                        $reqCount++;
                        wfSuppressWarnings();
                        $fh = fopen( $url, "r", false, $context );
                        wfRestoreWarnings();

                        if ( !$fh ) {
                                break;
                        }

                        $result = stream_get_meta_data( $fh );
                        $this->headerList = $result['wrapper_data'];
                        $this->parseHeader();

                        if ( !$this->followRedirects ) {
                                break;
                        }

                        # Handle manual redirection
                        if ( !$this->isRedirect() || $reqCount > $this->maxRedirects ) {
                                break;
                        }
                        # Check security of URL
                        $url = $this->getResponseHeader( "Location" );

                        if ( substr( $url, 0, 7 ) !== 'http://' ) {
                                wfDebug( __METHOD__ . ": insecure redirection\n" );
                                break;
                        }
                } while ( true );

                $this->setStatus();

                if ( $fh === false ) {
                        $this->status->fatal( 'http-request-error' );
                        return $this->status;
                }

                if ( $result['timed_out'] ) {
                        $this->status->fatal( 'http-timed-out', $this->url );
                        return $this->status;
                }

                // If everything went OK, or we recieved some error code
                // get the response body content.
                if ( $this->status->isOK()
                                || (int)$this->respStatus >= 300) {
                        while ( !feof( $fh ) ) {
                                $buf = fread( $fh, 8192 );

                                if ( $buf === false ) {
                                        $this->status->fatal( 'http-read-error' );
                                        break;
                                }

                                if ( strlen( $buf ) ) {
                                        call_user_func( $this->callback, $fh, $buf );
                                }
                        }
                }
                fclose( $fh );

                return $this->status;
        }
}