Merge remote-tracking branch 'upstream/master' into social-master

[quix0rs-gnu-social.git] / lib / httpclient.php

diff --git a/lib/httpclient.php b/lib/httpclient.php
index 04e2b9ac6539c9b884b7f50f0a33d25e792081f2..4990d5ba844e192e3e11295270341e78a528f44d 100644 (file)
--- a/lib/httpclient.php
+++ b/lib/httpclient.php
@@ -27,7 +27,7 @@
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET')) {
+if (!defined('GNUSOCIAL')) {
     exit(1);
 }
 
@@ -54,7 +54,7 @@ require_once 'HTTP/Request2/Response.php';
  * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link http://status.net/
  */
-class StatusNet_HTTPResponse extends HTTP_Request2_Response
+class GNUsocial_HTTPResponse extends HTTP_Request2_Response
 {
     function __construct(HTTP_Request2_Response $response, $url, $redirects=0)
     {
@@ -103,7 +103,7 @@ class StatusNet_HTTPResponse extends HTTP_Request2_Response
  *
  * This extends the PEAR HTTP_Request2 package:
  * - sends StatusNet-specific User-Agent header
- * - 'follow_redirects' config option, defaulting off
+ * - '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
@@ -145,6 +145,10 @@ class HTTPClient extends HTTP_Request2
             $this->config['ssl_verify_peer'] = false;
         }
 
+        // 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');
+
         if (common_config('http', 'curl') && extension_loaded('curl')) {
             $this->config['adapter'] = 'HTTP_Request2_Adapter_Curl';
         }
@@ -158,7 +162,7 @@ class HTTPClient extends HTTP_Request2
         }
 
         parent::__construct($url, $method, $config);
-        $this->setHeader('User-Agent', $this->userAgent());
+        $this->setHeader('User-Agent', self::userAgent());
     }
 
     /**
@@ -170,10 +174,46 @@ class HTTPClient extends HTTP_Request2
         return new HTTPClient();
     }
 
+    /**
+     * Quick static function to GET a URL
+     */
+    public static function quickGet($url, $accept=null, $params=array())
+    {
+        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();
+    }
+
+    public static function quickGetJson($url, $params=array())
+    {
+        $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;
+    }
+
     /**
      * Convenience function to run a GET request.
      *
-     * @return StatusNet_HTTPResponse
+     * @return GNUsocial_HTTPResponse
      * @throws HTTP_Request2_Exception
      */
     public function get($url, $headers=array())
@@ -184,12 +224,31 @@ class HTTPClient extends HTTP_Request2
     /**
      * Convenience function to run a HEAD request.
      *
-     * @return StatusNet_HTTPResponse
+     * 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())
+    public function head($url, $headers=array(), $follow_redirects=false)
     {
-        return $this->doRequest($url, self::METHOD_HEAD, $headers);
+        // 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) {
+            // reset to the old value
+            $this->config['follow_redirects'] = $old_follow;
+
+            // Let the exception go on its merry way.
+            throw $e;
+        }
+        //we've either returned or thrown exception here
+
+        // reset to the old value
+        $this->config['follow_redirects'] = $old_follow;
     }
 
     /**
@@ -198,7 +257,7 @@ class HTTPClient extends HTTP_Request2
      * @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 StatusNet_HTTPResponse
+     * @return GNUsocial_HTTPResponse
      * @throws HTTP_Request2_Exception
      */
     public function post($url, $headers=array(), $data=array())
@@ -210,7 +269,7 @@ class HTTPClient extends HTTP_Request2
     }
 
     /**
-     * @return StatusNet_HTTPResponse
+     * @return GNUsocial_HTTPResponse
      * @throws HTTP_Request2_Exception
      */
     protected function doRequest($url, $method, $headers)
@@ -242,23 +301,24 @@ class HTTPClient extends HTTP_Request2
     }
 
     /**
-     * Pulls up StatusNet's customized user-agent string, so services
+     * Pulls up GNU Social's customized user-agent string, so services
      * we hit can track down the responsible software.
      *
      * @return string
      */
-    function userAgent()
+    static public function userAgent()
     {
-        return "StatusNet/".STATUSNET_VERSION." (".STATUSNET_CODENAME.")";
+        return GNUSOCIAL_ENGINE . '/' . GNUSOCIAL_VERSION
+                . ' (' . GNUSOCIAL_CODENAME . ')';
     }
 
     /**
      * Actually performs the HTTP request and returns a
-     * StatusNet_HTTPResponse object with response body and header info.
+     * GNUsocial_HTTPResponse object with response body and header info.
      *
      * Wraps around parent send() to add logging and redirection processing.
      *
-     * @return StatusNet_HTTPResponse
+     * @return GNUsocial_HTTPResponse
      * @throw HTTP_Request2_Exception
      */
     public function send()
@@ -301,6 +361,6 @@ class HTTPClient extends HTTP_Request2
             }
             break;
         } while ($maxRedirs);
-        return new StatusNet_HTTPResponse($response, $this->getUrl(), $redirs);
+        return new GNUsocial_HTTPResponse($response, $this->getUrl(), $redirs);
     }
 }