First little bit of cleaning out the Augean stables of SpecialBlockip.php: spin out...
[lhc/web/wiklou.git] / includes / HttpFunctions.php
index ad1f30a..4a56f89 100644 (file)
@@ -15,7 +15,7 @@ class Http {
         *
         * @param $method String: HTTP method. Usually GET/POST
         * @param $url String: full URL to act on
-        * @param $options Array: options to pass to HttpRequest object.
+        * @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
@@ -40,7 +40,7 @@ class Http {
                        $options['timeout'] = 'default';
                }
 
-               $req = HttpRequest::factory( $url, $options );
+               $req = MWHttpRequest::factory( $url, $options );
                $status = $req->execute();
 
                if ( $status->isOK() ) {
@@ -89,6 +89,7 @@ class Http {
                        // 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 ) {
@@ -116,16 +117,17 @@ class Http {
        }
 
        /**
-        * Checks that the given URI is a valid one
+        * 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(
-                       '/(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/',
-                       $uri,
-                       $matches
+                       '/^(f|ht)tps?:\/\/[^\/\s]\S*$/D',
+                       $uri
                );
        }
 }
@@ -133,8 +135,13 @@ class Http {
 /**
  * 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 HttpRequest {
+class MWHttpRequest {
+       const SUPPORTS_FILE_POSTS = false;
+
        protected $content;
        protected $timeout = 'default';
        protected $headersOnly = null;
@@ -152,6 +159,9 @@ class HttpRequest {
        protected $maxRedirects = 5;
        protected $followRedirects = false;
 
+       /**
+        * @var  CookieJar
+        */
        protected $cookieJar;
 
        protected $headerList = array();
@@ -184,7 +194,7 @@ class HttpRequest {
                }
 
                $members = array( "postData", "proxy", "noProxy", "sslVerifyHost", "caInfo",
-                                 "method", "followRedirects", "maxRedirects", "sslVerifyCert" );
+                                 "method", "followRedirects", "maxRedirects", "sslVerifyCert", "callback" );
 
                foreach ( $members as $o ) {
                        if ( isset( $options[$o] ) ) {
@@ -195,7 +205,9 @@ class HttpRequest {
 
        /**
         * Generate a new request object
-        * @see HttpRequest::__construct
+        * @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 ) {
@@ -338,10 +350,6 @@ class HttpRequest {
                        $this->headersOnly = true;
                }
 
-               if ( is_array( $this->postData ) ) {
-                       $this->postData = wfArrayToCGI( $this->postData );
-               }
-
                if ( is_object( $wgTitle ) && !isset( $this->reqHeaders['Referer'] ) ) {
                        $this->setReferer( $wgTitle->getFullURL() );
                }
@@ -477,7 +485,7 @@ class HttpRequest {
        }
 
        /**
-        * Tells the HttpRequest object to use this pre-loaded CookieJar.
+        * Tells the MWHttpRequest object to use this pre-loaded CookieJar.
         *
         * @param $jar CookieJar
         */
@@ -552,249 +560,12 @@ class HttpRequest {
        }
 }
 
-
-class Cookie {
-       protected $name;
-       protected $value;
-       protected $expires;
-       protected $path;
-       protected $domain;
-       protected $isSessionKey = true;
-       // TO IMPLEMENT  protected $secure
-       // TO IMPLEMENT? protected $maxAge (add onto expires)
-       // TO IMPLEMENT? protected $version
-       // TO IMPLEMENT? protected $comment
-
-       function __construct( $name, $value, $attr ) {
-               $this->name = $name;
-               $this->set( $value, $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.
-        *
-        * @param $value String: the value of the cookie
-        * @param $attr Array: possible key/values:
-        *              expires  A date string
-        *              path     The path this cookie is used on
-        *              domain   Domain this cookie is used on
-        */
-       public function set( $value, $attr ) {
-               $this->value = $value;
-
-               if ( isset( $attr['expires'] ) ) {
-                       $this->isSessionKey = false;
-                       $this->expires = strtotime( $attr['expires'] );
-               }
-
-               if ( isset( $attr['path'] ) ) {
-                       $this->path = $attr['path'];
-               } else {
-                       $this->path = "/";
-               }
-
-               if ( isset( $attr['domain'] ) ) {
-                       if ( self::validateCookieDomain( $attr['domain'] ) ) {
-                               $this->domain = $attr['domain'];
-                       }
-               } else {
-                       throw new MWException( "You must specify a domain." );
-               }
-       }
-
-       /**
-        * Return the true if the cookie is valid is valid.  Otherwise,
-        * false.  The uses a method similar to IE cookie security
-        * described here:
-        * http://kuza55.blogspot.com/2008/02/understanding-cookie-security.html
-        * A better method might be to use a blacklist like
-        * http://publicsuffix.org/
-        *
-        * @param $domain String: the domain to validate
-        * @param $originDomain String: (optional) the domain the cookie originates from
-        * @return Boolean
-        */
-       public static function validateCookieDomain( $domain, $originDomain = null ) {
-               // Don't allow a trailing dot
-               if ( substr( $domain, -1 ) == "." ) {
-                       return false;
-               }
-
-               $dc = explode( ".", $domain );
-
-               // Only allow full, valid IP addresses
-               if ( preg_match( '/^[0-9.]+$/', $domain ) ) {
-                       if ( count( $dc ) != 4 ) {
-                               return false;
-                       }
-
-                       if ( ip2long( $domain ) === false ) {
-                               return false;
-                       }
-
-                       if ( $originDomain == null || $originDomain == $domain ) {
-                               return true;
-                       }
-
-               }
-
-               // Don't allow cookies for "co.uk" or "gov.uk", etc, but allow "supermarket.uk"
-               if ( strrpos( $domain, "." ) - strlen( $domain )  == -3 ) {
-                       if ( ( count( $dc ) == 2 && strlen( $dc[0] ) <= 2 )
-                               || ( count( $dc ) == 3 && strlen( $dc[0] ) == "" && strlen( $dc[1] ) <= 2 ) ) {
-                               return false;
-                       }
-                       if ( ( count( $dc ) == 2 || ( count( $dc ) == 3 && $dc[0] == "" ) )
-                               && preg_match( '/(com|net|org|gov|edu)\...$/', $domain ) ) {
-                               return false;
-                       }
-               }
-
-               if ( $originDomain != null ) {
-                       if ( substr( $domain, 0, 1 ) != "." && $domain != $originDomain ) {
-                               return false;
-                       }
-
-                       if ( substr( $domain, 0, 1 ) == "."
-                               && substr_compare( $originDomain, $domain, -strlen( $domain ),
-                                                                  strlen( $domain ), TRUE ) != 0 ) {
-                               return false;
-                       }
-               }
-
-               return true;
-       }
-
-       /**
-        * Serialize the cookie jar into a format useful for HTTP Request headers.
-        *
-        * @param $path String: the path that will be used. Required.
-        * @param $domain String: the domain that will be used. Required.
-        * @return String
-        */
-       public function serializeToHttpRequest( $path, $domain ) {
-               $ret = "";
-
-               if ( $this->canServeDomain( $domain )
-                               && $this->canServePath( $path )
-                               && $this->isUnExpired() ) {
-                       $ret = $this->name . "=" . $this->value;
-               }
-
-               return $ret;
-       }
-
-       protected function canServeDomain( $domain ) {
-               if ( $domain == $this->domain
-                       || ( strlen( $domain ) > strlen( $this->domain )
-                                && substr( $this->domain, 0, 1 ) == "."
-                                && substr_compare( $domain, $this->domain, -strlen( $this->domain ),
-                                                                       strlen( $this->domain ), TRUE ) == 0 ) ) {
-                       return true;
-               }
-
-               return false;
-       }
-
-       protected function canServePath( $path ) {
-               if ( $this->path && substr_compare( $this->path, $path, 0, strlen( $this->path ) ) == 0 ) {
-                       return true;
-               }
-
-               return false;
-       }
-
-       protected function isUnExpired() {
-               if ( $this->isSessionKey || $this->expires > time() ) {
-                       return true;
-               }
-
-               return false;
-       }
-}
-
-class CookieJar {
-       private $cookie = array();
-
-       /**
-        * Set a cookie in the cookie jar.      Make sure only one cookie per-name exists.
-        * @see Cookie::set()
-        */
-       public function setCookie ( $name, $value, $attr ) {
-               /* cookies: case insensitive, so this should work.
-                * We'll still send the cookies back in the same case we got them, though.
-                */
-               $index = strtoupper( $name );
-
-               if ( isset( $this->cookie[$index] ) ) {
-                       $this->cookie[$index]->set( $value, $attr );
-               } else {
-                       $this->cookie[$index] = new Cookie( $name, $value, $attr );
-               }
-       }
-
-       /**
-        * @see Cookie::serializeToHttpRequest
-        */
-       public function serializeToHttpRequest( $path, $domain ) {
-               $cookies = array();
-
-               foreach ( $this->cookie as $c ) {
-                       $serialized = $c->serializeToHttpRequest( $path, $domain );
-
-                       if ( $serialized ) {
-                               $cookies[] = $serialized;
-                       }
-               }
-
-               return implode( "; ", $cookies );
-       }
-
-       /**
-        * Parse the content of an Set-Cookie HTTP Response header.
-        *
-        * @param $cookie String
-        * @param $domain String: cookie's domain
-        */
-       public function parseCookieResponseHeader ( $cookie, $domain ) {
-               $len = strlen( "Set-Cookie:" );
-
-               if ( substr_compare( "Set-Cookie:", $cookie, 0, $len, TRUE ) === 0 ) {
-                       $cookie = substr( $cookie, $len );
-               }
-
-               $bit = array_map( 'trim', explode( ";", $cookie ) );
-
-               if ( count( $bit ) >= 1 ) {
-                       list( $name, $value ) = explode( "=", array_shift( $bit ), 2 );
-                       $attr = array();
-
-                       foreach ( $bit as $piece ) {
-                               $parts = explode( "=", $piece );
-                               if ( count( $parts ) > 1 ) {
-                                       $attr[strtolower( $parts[0] )] = $parts[1];
-                               } else {
-                                       $attr[strtolower( $parts[0] )] = true;
-                               }
-                       }
-
-                       if ( !isset( $attr['domain'] ) ) {
-                               $attr['domain'] = $domain;
-                       } elseif ( !Cookie::validateCookieDomain( $attr['domain'], $domain ) ) {
-                               return null;
-                       }
-
-                       $this->setCookie( $name, $value, $attr );
-               }
-       }
-}
-
 /**
- * HttpRequest implemented using internal curl compiled into PHP
+ * MWHttpRequest implemented using internal curl compiled into PHP
  */
-class CurlHttpRequest extends HttpRequest {
+class CurlHttpRequest extends MWHttpRequest {
+       const SUPPORTS_FILE_POSTS = true;
+
        static $curlMessageMap = array(
                6 => 'http-host-unreachable',
                28 => 'http-timed-out'
@@ -864,12 +635,14 @@ class CurlHttpRequest extends HttpRequest {
                }
 
                if ( $this->followRedirects && $this->canFollowRedirects() ) {
-                       if ( ! @curl_setopt( $curlHandle, CURLOPT_FOLLOWLOCATION, true ) ) {
+                       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 ) ) {
@@ -907,7 +680,7 @@ class CurlHttpRequest extends HttpRequest {
        }
 }
 
-class PhpHttpRequest extends HttpRequest {
+class PhpHttpRequest extends MWHttpRequest {
        protected function urlToTcp( $url ) {
                $parsedUrl = parse_url( $url );
 
@@ -917,6 +690,10 @@ class PhpHttpRequest extends HttpRequest {
        public function execute() {
                parent::execute();
 
+               if ( is_array( $this->postData ) ) {
+                       $this->postData = wfArrayToCGI( $this->postData );
+               }
+
                // At least on Centos 4.8 with PHP 5.1.6, using max_redirects to follow redirects
                // causes a segfault
                $manuallyRedirect = version_compare( phpversion(), '5.1.7', '<' );
@@ -972,6 +749,8 @@ class PhpHttpRequest extends HttpRequest {
                $reqCount = 0;
                $url = $this->url;
 
+               $result = array();
+
                do {
                        $reqCount++;
                        wfSuppressWarnings();