lib/httpclient.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Utility for doing HTTP-related things
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Action
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('GNUSOCIAL')) { exit(1); }
  31
  32 /**
  33  * Useful structure for HTTP responses
  34  *
  35  * We make HTTP calls in several places, and we have several different
  36  * ways of doing them. This class hides the specifics of what underlying
  37  * library (curl or PHP-HTTP or whatever) that's used.
  38  *
  39  * This extends the HTTP_Request2_Response class with methods to get info
  40  * about any followed redirects.
  41  *
  42  * Originally used the name 'HTTPResponse' to match earlier code, but
  43  * this conflicts with a class in in the PECL HTTP extension.
  44  *
  45  * @category HTTP
  46  * @package StatusNet
  47  * @author Evan Prodromou <evan@status.net>
  48  * @author Brion Vibber <brion@status.net>
  49  * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  50  * @link http://status.net/
  51  */
  52 class GNUsocial_HTTPResponse extends HTTP_Request2_Response
  53 {
  54     function __construct(HTTP_Request2_Response $response, $url, $redirects=0)
  55     {
  56         foreach (get_object_vars($response) as $key => $val) {
  57             $this->$key = $val;
  58         }
  59         $this->url = strval($url);
  60         $this->redirectCount = intval($redirects);
  61     }
  62
  63     /**
  64      * Get the count of redirects that have been followed, if any.
  65      * @return int
  66      */
  67     function getRedirectCount()
  68     {
  69         return $this->redirectCount;
  70     }
  71
  72     /**
  73      * Gets the target URL, before any redirects. Use getEffectiveUrl() for final target.
  74      * @return string URL
  75      */
  76     function getUrl()
  77     {
  78         return $this->url;
  79     }
  80
  81     /**
  82      * Check if the response is OK, generally a 200 or other 2xx status code.
  83      * @return bool
  84      */
  85     function isOk()
  86     {
  87         $status = $this->getStatus();
  88         return ($status >= 200 && $status < 300);
  89     }
  90 }
  91
  92 /**
  93  * Utility class for doing HTTP client stuff
  94  *
  95  * We make HTTP calls in several places, and we have several different
  96  * ways of doing them. This class hides the specifics of what underlying
  97  * library (curl or PHP-HTTP or whatever) that's used.
  98  *
  99  * This extends the PEAR HTTP_Request2 package:
 100  * - sends StatusNet-specific User-Agent header
 101  * - 'follow_redirects' config option, defaulting on
 102  * - 'max_redirs' config option, defaulting to 10
 103  * - extended response class adds getRedirectCount() and getUrl() methods
 104  * - get() and post() convenience functions return body content directly
 105  *
 106  * @category HTTP
 107  * @package  StatusNet
 108  * @author   Evan Prodromou <evan@status.net>
 109  * @author   Brion Vibber <brion@status.net>
 110  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 111  * @link     http://status.net/
 112  */
 113
 114 class HTTPClient extends HTTP_Request2
 115 {
 116
 117     function __construct($url=null, $method=self::METHOD_GET, $config=array())
 118     {
 119         $this->config['max_redirs'] = 10;
 120         $this->config['follow_redirects'] = true;
 121
 122         // We've had some issues with keepalive breaking with
 123         // HEAD requests, such as to youtube which seems to be
 124         // emitting chunked encoding info for an empty body
 125         // instead of not emitting anything. This may be a
 126         // bug on YouTube's end, but the upstream libray
 127         // ought to be investigated to see if we can handle
 128         // it gracefully in that case as well.
 129         $this->config['protocol_version'] = '1.0';
 130
 131         // Default state of OpenSSL seems to have no trusted
 132         // SSL certificate authorities, which breaks hostname
 133         // verification and means we have a hard time communicating
 134         // with other sites' HTTPS interfaces.
 135         //
 136         // Turn off verification unless we've configured a CA bundle.
 137         if (common_config('http', 'ssl_cafile')) {
 138             $this->config['ssl_cafile'] = common_config('http', 'ssl_cafile');
 139         } else {
 140             $this->config['ssl_verify_peer'] = false;
 141         }
 142
 143         // This means "verify the cert hostname against what we connect to", it does not
 144         // imply CA trust or anything like that. Just the hostname.
 145         $this->config['ssl_verify_host'] = common_config('http', 'ssl_verify_host');
 146
 147         if (common_config('http', 'curl') && extension_loaded('curl')) {
 148             $this->config['adapter'] = 'HTTP_Request2_Adapter_Curl';
 149         }
 150
 151         foreach (array('host', 'port', 'user', 'password', 'auth_scheme') as $cf) {
 152             $k = 'proxy_'.$cf;
 153             $v = common_config('http', $k);
 154             if (!empty($v)) {
 155                 $this->config[$k] = $v;
 156             }
 157         }
 158
 159         parent::__construct($url, $method, $config);
 160         $this->setHeader('User-Agent', self::userAgent());
 161     }
 162
 163     /**
 164      * Convenience/back-compat instantiator
 165      * @return HTTPClient
 166      */
 167     public static function start()
 168     {
 169         return new HTTPClient();
 170     }
 171
 172     /**
 173      * Quick static function to GET a URL
 174      */
 175     public static function quickGet($url, $accept=null, $params=array())
 176     {
 177         if (!empty($params)) {
 178             $params = http_build_query($params, null, '&');
 179             if (strpos($url, '?') === false) {
 180                 $url .= '?' . $params;
 181             } else {
 182                 $url .= '&' . $params;
 183             }
 184         }
 185
 186         $client = new HTTPClient();
 187         if (!is_null($accept)) {
 188             $client->setHeader('Accept', $accept);
 189         }
 190         $response = $client->get($url);
 191         if (!$response->isOk()) {
 192             // TRANS: Exception. %s is the URL we tried to GET.
 193             throw new Exception(sprintf(_m('Could not GET URL %s.'), $url), $response->getStatus());
 194         }
 195         return $response->getBody();
 196     }
 197
 198     public static function quickGetJson($url, $params=array())
 199     {
 200         $data = json_decode(self::quickGet($url, null, $params));
 201         if (is_null($data)) {
 202             common_debug('Could not decode JSON data from URL: '.$url);
 203             throw new ServerException('Could not decode JSON data from URL');
 204         }
 205         return $data;
 206     }
 207
 208     /**
 209      * Convenience function to run a GET request.
 210      *
 211      * @return GNUsocial_HTTPResponse
 212      * @throws HTTP_Request2_Exception
 213      */
 214     public function get($url, $headers=array())
 215     {
 216         return $this->doRequest($url, self::METHOD_GET, $headers);
 217     }
 218
 219     /**
 220      * Convenience function to run a HEAD request.
 221      *
 222      * NOTE: Will probably turn into a GET request if you let it follow redirects!
 223      *       That option is only there to be flexible and may be removed in the future!
 224      *
 225      * @return GNUsocial_HTTPResponse
 226      * @throws HTTP_Request2_Exception
 227      */
 228     public function head($url, $headers=array(), $follow_redirects=false)
 229     {
 230         // Save the configured value for follow_redirects
 231         $old_follow = $this->config['follow_redirects'];
 232         try {
 233             // Temporarily (possibly) override the follow_redirects setting
 234             $this->config['follow_redirects'] = $follow_redirects;
 235             return $this->doRequest($url, self::METHOD_HEAD, $headers);
 236         } catch (Exception $e) {
 237             // Let the exception go on its merry way.
 238             throw $e;
 239         } finally {
 240             // reset to the old value
 241             $this->config['follow_redirects'] = $old_follow;
 242         }
 243         //we've either returned or thrown exception here
 244     }
 245
 246     /**
 247      * Convenience function to POST form data.
 248      *
 249      * @param string $url
 250      * @param array $headers optional associative array of HTTP headers
 251      * @param array $data optional associative array or blob of form data to submit
 252      * @return GNUsocial_HTTPResponse
 253      * @throws HTTP_Request2_Exception
 254      */
 255     public function post($url, $headers=array(), $data=array())
 256     {
 257         if ($data) {
 258             $this->addPostParameter($data);
 259         }
 260         return $this->doRequest($url, self::METHOD_POST, $headers);
 261     }
 262
 263     /**
 264      * @return GNUsocial_HTTPResponse
 265      * @throws HTTP_Request2_Exception
 266      */
 267     protected function doRequest($url, $method, $headers)
 268     {
 269         $this->setUrl($url);
 270
 271         // Workaround for HTTP_Request2 not setting up SNI in socket contexts;
 272         // This fixes cert validation for SSL virtual hosts using SNI.
 273         // Requires PHP 5.3.2 or later and OpenSSL with SNI support.
 274         if ($this->url->getScheme() == 'https' && defined('OPENSSL_TLSEXT_SERVER_NAME')) {
 275             $this->config['ssl_SNI_enabled'] = true;
 276             $this->config['ssl_SNI_server_name'] = $this->url->getHost();
 277         }
 278
 279         $this->setMethod($method);
 280         if ($headers) {
 281             foreach ($headers as $header) {
 282                 $this->setHeader($header);
 283             }
 284         }
 285         $response = $this->send();
 286         if (is_null($response)) {
 287             // TRANS: Failed to retrieve a remote web resource, %s is the target URL.
 288             throw new NoHttpResponseException($url);
 289         }
 290         return $response;
 291     }
 292
 293     protected function log($level, $detail) {
 294         $method = $this->getMethod();
 295         $url = $this->getUrl();
 296         common_log($level, __CLASS__ . ": HTTP $method $url - $detail");
 297     }
 298
 299     /**
 300      * Pulls up GNU Social's customized user-agent string, so services
 301      * we hit can track down the responsible software.
 302      *
 303      * @return string
 304      */
 305     static public function userAgent()
 306     {
 307         return GNUSOCIAL_ENGINE . '/' . GNUSOCIAL_VERSION
 308                 . ' (' . GNUSOCIAL_CODENAME . ')';
 309     }
 310
 311     /**
 312      * Actually performs the HTTP request and returns a
 313      * GNUsocial_HTTPResponse object with response body and header info.
 314      *
 315      * Wraps around parent send() to add logging and redirection processing.
 316      *
 317      * @return GNUsocial_HTTPResponse
 318      * @throw HTTP_Request2_Exception
 319      */
 320     public function send()
 321     {
 322         $maxRedirs = intval($this->config['max_redirs']);
 323         if (empty($this->config['follow_redirects'])) {
 324             $maxRedirs = 0;
 325         }
 326         $redirs = 0;
 327         do {
 328             try {
 329                 $response = parent::send();
 330             } catch (Exception $e) {
 331                 $this->log(LOG_ERR, $e->getMessage());
 332                 throw $e;
 333             }
 334             $code = $response->getStatus();
 335             if ($code >= 200 && $code < 300) {
 336                 $reason = $response->getReasonPhrase();
 337                 $this->log(LOG_INFO, "$code $reason");
 338             } elseif ($code >= 300 && $code < 400) {
 339                 $url = $this->getUrl();
 340                 $target = $response->getHeader('Location');
 341
 342                 if (++$redirs >= $maxRedirs) {
 343                     common_log(LOG_ERR, __CLASS__ . ": Too many redirects: skipping $code redirect from $url to $target");
 344                     break;
 345                 }
 346                 try {
 347                     $this->setUrl($target);
 348                     $this->setHeader('Referer', $url);
 349                     common_log(LOG_INFO, __CLASS__ . ": Following $code redirect from $url to $target");
 350                     continue;
 351                 } catch (HTTP_Request2_Exception $e) {
 352                     common_log(LOG_ERR, __CLASS__ . ": Invalid $code redirect from $url to $target");
 353                 } catch (NoHttpResponseException $e) {
 354                     common_log(LOG_ERR, __CLASS__ . ": {$e->getMessage()}");
 355                 }
 356             } else {
 357                 $reason = $response->getReasonPhrase();
 358                 $this->log(LOG_ERR, "$code $reason");
 359             }
 360             break;
 361         } while ($maxRedirs);
 362         return new GNUsocial_HTTPResponse($response, $this->getUrl(), $redirs);
 363     }
 364 }