X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fhttpclient.php;h=b386ce39875e991d08ed5fc0db4deaf2a5b7039b;hb=2c5460eb0e140655c30639c5bc909ddb80732a91;hp=c8c8ae5b261d3c946b5d49e7679f76f8b57af75f;hpb=a68663588ee95915153ad1f927cf510e3d41a299;p=quix0rs-gnu-social.git

diff --git a/lib/httpclient.php b/lib/httpclient.php
index c8c8ae5b26..b386ce3987 100644
--- a/lib/httpclient.php
+++ b/lib/httpclient.php
@@ -27,10 +27,13 @@
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET')) {
+if (!defined('GNUSOCIAL')) {
     exit(1);
 }
 
+require_once 'HTTP/Request2.php';
+require_once 'HTTP/Request2/Response.php';
+
 /**
  * Useful structure for HTTP responses
  *
@@ -38,18 +41,57 @@ if (!defined('STATUSNET')) {
  * ways of doing them. This class hides the specifics of what underlying
  * library (curl or PHP-HTTP or whatever) that's used.
  *
+ * This extends the HTTP_Request2_Response class with methods to get info
+ * about any followed redirects.
+ * 
+ * Originally used the name 'HTTPResponse' to match earlier code, but
+ * this conflicts with a class in in the PECL HTTP extension.
+ *
  * @category HTTP
- * @package  StatusNet
- * @author   Evan Prodromou <evan@status.net>
- * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link     http://status.net/
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @author Brion Vibber <brion@status.net>
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://status.net/
  */
-
-class HTTPResponse
+class GNUsocial_HTTPResponse extends HTTP_Request2_Response
 {
-    public $code = null;
-    public $headers = null;
-    public $body = null;
+    function __construct(HTTP_Request2_Response $response, $url, $redirects=0)
+    {
+        foreach (get_object_vars($response) as $key => $val) {
+            $this->$key = $val;
+        }
+        $this->url = strval($url);
+        $this->redirectCount = intval($redirects);
+    }
+
+    /**
+     * Get the count of redirects that have been followed, if any.
+     * @return int
+     */
+    function getRedirectCount()
+    {
+        return $this->redirectCount;
+    }
+
+    /**
+     * Gets the final target URL, after any redirects have been followed.
+     * @return string URL
+     */
+    function getUrl()
+    {
+        return $this->effectiveUrl;
+    }
+
+    /**
+     * Check if the response is OK, generally a 200 or other 2xx status code.
+     * @return bool
+     */
+    function isOk()
+    {
+        $status = $this->getStatus();
+        return ($status >= 200 && $status < 300);
+    }
 }
 
 /**
@@ -59,64 +101,263 @@ class HTTPResponse
  * ways of doing them. This class hides the specifics of what underlying
  * library (curl or PHP-HTTP or whatever) that's used.
  *
+ * This extends the PEAR HTTP_Request2 package:
+ * - sends StatusNet-specific User-Agent header
+ * - 'follow_redirects' config option, defaulting on
+ * - 'max_redirs' config option, defaulting to 10
+ * - extended response class adds getRedirectCount() and getUrl() methods
+ * - get() and post() convenience functions return body content directly
+ *
  * @category HTTP
  * @package  StatusNet
  * @author   Evan Prodromou <evan@status.net>
+ * @author   Brion Vibber <brion@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://status.net/
  */
 
-class HTTPClient
+class HTTPClient extends HTTP_Request2
 {
-    static $_client = null;
 
-    static function start()
+    function __construct($url=null, $method=self::METHOD_GET, $config=array())
     {
-        if (!is_null(self::$_client)) {
-            return self::$_client;
+        $this->config['max_redirs'] = 10;
+        $this->config['follow_redirects'] = true;
+        
+        // We've had some issues with keepalive breaking with
+        // HEAD requests, such as to youtube which seems to be
+        // emitting chunked encoding info for an empty body
+        // instead of not emitting anything. This may be a
+        // bug on YouTube's end, but the upstream libray
+        // ought to be investigated to see if we can handle
+        // it gracefully in that case as well.
+        $this->config['protocol_version'] = '1.0';
+
+        // Default state of OpenSSL seems to have no trusted
+        // SSL certificate authorities, which breaks hostname
+        // verification and means we have a hard time communicating
+        // with other sites' HTTPS interfaces.
+        //
+        // Turn off verification unless we've configured a CA bundle.
+        if (common_config('http', 'ssl_cafile')) {
+            $this->config['ssl_cafile'] = common_config('http', 'ssl_cafile');
+        } else {
+            $this->config['ssl_verify_peer'] = false;
         }
 
-        $type = common_config('http', 'client');
+        // This means "verify the cert hostname against what we connect to", it does not
+        // imply CA trust or anything like that. Just the hostname.
+        $this->config['ssl_verify_host'] = common_config('http', 'ssl_verify_host');
 
-        switch ($type) {
-         case 'curl':
-            self::$_client = new CurlClient();
-            break;
-         default:
-            throw new Exception("Unknown HTTP client type '$type'");
-            break;
+        if (common_config('http', 'curl') && extension_loaded('curl')) {
+            $this->config['adapter'] = 'HTTP_Request2_Adapter_Curl';
+        }
+
+        foreach (array('host', 'port', 'user', 'password', 'auth_scheme') as $cf) {
+            $k = 'proxy_'.$cf;
+            $v = common_config('http', $k); 
+            if (!empty($v)) {
+                $this->config[$k] = $v;
+            }
         }
 
-        return self::$_client;
+        parent::__construct($url, $method, $config);
+        $this->setHeader('User-Agent', self::userAgent());
     }
 
-    function head($url, $headers)
+    /**
+     * Convenience/back-compat instantiator
+     * @return HTTPClient
+     */
+    public static function start()
     {
-        throw new Exception("HEAD method unimplemented");
+        return new HTTPClient();
     }
 
-    function get($url, $headers)
+    /**
+     * Quick static function to GET a URL
+     */
+    public static function quickGet($url, $accept=null, $params=array())
     {
-        throw new Exception("GET method unimplemented");
+        if (!empty($params)) {
+            $params = http_build_query($params, null, '&');
+            if (strpos($url, '?') === false) {
+                $url .= '?' . $params;
+            } else {
+                $url .= '&' . $params;
+            }
+        }
+
+        $client = new HTTPClient();
+        if (!is_null($accept)) {
+            $client->setHeader('Accept', $accept);
+        }
+        $response = $client->get($url);
+        if (!$response->isOk()) {
+            // TRANS: Exception. %s is a profile URL.
+            throw new Exception(sprintf(_m('Could not GET URL %s.'), $url), $response->getStatus());
+        }
+        return $response->getBody();
     }
 
-    function post($url, $headers, $body)
+    public static function quickGetJson($url, $params=array())
     {
-        throw new Exception("POST method unimplemented");
+        $data = json_decode(self::quickGet($url, null, $params));
+        if (is_null($data)) {
+            common_debug('Could not decode JSON data from URL: '.$url);
+            throw new ServerException('Could not decode JSON data from URL');
+        }
+        return $data;
     }
 
-    function put($url, $headers, $body)
+    /**
+     * Convenience function to run a GET request.
+     *
+     * @return GNUsocial_HTTPResponse
+     * @throws HTTP_Request2_Exception
+     */
+    public function get($url, $headers=array())
     {
-        throw new Exception("PUT method unimplemented");
+        return $this->doRequest($url, self::METHOD_GET, $headers);
     }
 
-    function delete($url, $headers)
+    /**
+     * Convenience function to run a HEAD request.
+     *
+     * NOTE: Will probably turn into a GET request if you let it follow redirects!
+     *       That option is only there to be flexible and may be removed in the future!
+     *
+     * @return GNUsocial_HTTPResponse
+     * @throws HTTP_Request2_Exception
+     */
+    public function head($url, $headers=array(), $follow_redirects=false)
     {
-        throw new Exception("DELETE method unimplemented");
+        // Save the configured value for follow_redirects
+        $old_follow = $this->config['follow_redirects'];
+        try {
+            // Temporarily (possibly) override the follow_redirects setting
+            $this->config['follow_redirects'] = $follow_redirects;
+            return $this->doRequest($url, self::METHOD_HEAD, $headers);
+        } catch (Exception $e) {
+            // Let the exception go on its merry way.
+            throw $e;
+        } finally {
+            // reset to the old value
+            $this->config['follow_redirects'] = $old_follow;
+        }
+        //we've either returned or thrown exception here
     }
 
-    function userAgent()
+    /**
+     * Convenience function to POST form data.
+     *
+     * @param string $url
+     * @param array $headers optional associative array of HTTP headers
+     * @param array $data optional associative array or blob of form data to submit
+     * @return GNUsocial_HTTPResponse
+     * @throws HTTP_Request2_Exception
+     */
+    public function post($url, $headers=array(), $data=array())
     {
-        return "StatusNet/".STATUSNET_VERSION." (".STATUSNET_CODENAME.")";
+        if ($data) {
+            $this->addPostParameter($data);
+        }
+        return $this->doRequest($url, self::METHOD_POST, $headers);
     }
-}
+
+    /**
+     * @return GNUsocial_HTTPResponse
+     * @throws HTTP_Request2_Exception
+     */
+    protected function doRequest($url, $method, $headers)
+    {
+        $this->setUrl($url);
+
+        // Workaround for HTTP_Request2 not setting up SNI in socket contexts;
+        // This fixes cert validation for SSL virtual hosts using SNI.
+        // Requires PHP 5.3.2 or later and OpenSSL with SNI support.
+        if ($this->url->getScheme() == 'https' && defined('OPENSSL_TLSEXT_SERVER_NAME')) {
+            $this->config['ssl_SNI_enabled'] = true;
+            $this->config['ssl_SNI_server_name'] = $this->url->getHost();
+        }
+
+        $this->setMethod($method);
+        if ($headers) {
+            foreach ($headers as $header) {
+                $this->setHeader($header);
+            }
+        }
+        $response = $this->send();
+        return $response;
+    }
+    
+    protected function log($level, $detail) {
+        $method = $this->getMethod();
+        $url = $this->getUrl();
+        common_log($level, __CLASS__ . ": HTTP $method $url - $detail");
+    }
+
+    /**
+     * Pulls up GNU Social's customized user-agent string, so services
+     * we hit can track down the responsible software.
+     *
+     * @return string
+     */
+    static public function userAgent()
+    {
+        return GNUSOCIAL_ENGINE . '/' . GNUSOCIAL_VERSION
+                . ' (' . GNUSOCIAL_CODENAME . ')';
+    }
+
+    /**
+     * Actually performs the HTTP request and returns a
+     * GNUsocial_HTTPResponse object with response body and header info.
+     *
+     * Wraps around parent send() to add logging and redirection processing.
+     *
+     * @return GNUsocial_HTTPResponse
+     * @throw HTTP_Request2_Exception
+     */
+    public function send()
+    {
+        $maxRedirs = intval($this->config['max_redirs']);
+        if (empty($this->config['follow_redirects'])) {
+            $maxRedirs = 0;
+        }
+        $redirs = 0;
+        do {
+            try {
+                $response = parent::send();
+            } catch (HTTP_Request2_Exception $e) {
+                $this->log(LOG_ERR, $e->getMessage());
+                throw $e;
+            }
+            $code = $response->getStatus();
+            if ($code >= 200 && $code < 300) {
+                $reason = $response->getReasonPhrase();
+                $this->log(LOG_INFO, "$code $reason");
+            } elseif ($code >= 300 && $code < 400) {
+                $url = $this->getUrl();
+                $target = $response->getHeader('Location');
+                
+                if (++$redirs >= $maxRedirs) {
+                    common_log(LOG_ERR, __CLASS__ . ": Too many redirects: skipping $code redirect from $url to $target");
+                    break;
+                }
+                try {
+                    $this->setUrl($target);
+                    $this->setHeader('Referer', $url);
+                    common_log(LOG_INFO, __CLASS__ . ": Following $code redirect from $url to $target");
+                    continue;
+                } catch (HTTP_Request2_Exception $e) {
+                    common_log(LOG_ERR, __CLASS__ . ": Invalid $code redirect from $url to $target");
+                }
+            } else {
+                $reason = $response->getReasonPhrase();
+                $this->log(LOG_ERR, "$code $reason");
+            }
+            break;
+        } while ($maxRedirs);
+        return new GNUsocial_HTTPResponse($response, $this->getUrl(), $redirs);
+    }
+}
\ No newline at end of file