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         if (is_int(common_config('http', 'timeout'))) {
 120             // Reasonably you shouldn't set http/timeout to 0 because of
 121             // malicious remote servers that can cause infinitely long
 122             // responses... But the default in HTTP_Request2 is 0 for
 123             // some reason and should probably be considered a valid value.
 124             $this->config['timeout'] = common_config('http', 'timeout');
 125         } else {
 126             common_log(LOG_ERR, 'config option http/timeout is not an integer value: '._ve(common_config('http', 'timeout')));
 127         }
 128         if (!empty(common_config('http', 'connect_timeout'))) {
 129             $this->config['connect_timeout'] = common_config('http', 'connect_timeout');
 130         }
 131         $this->config['max_redirs'] = 10;
 132         $this->config['follow_redirects'] = true;
 133
 134         // We've had some issues with keepalive breaking with
 135         // HEAD requests, such as to youtube which seems to be
 136         // emitting chunked encoding info for an empty body
 137         // instead of not emitting anything. This may be a
 138         // bug on YouTube's end, but the upstream libray
 139         // ought to be investigated to see if we can handle
 140         // it gracefully in that case as well.
 141         $this->config['protocol_version'] = '1.0';
 142
 143         // Default state of OpenSSL seems to have no trusted
 144         // SSL certificate authorities, which breaks hostname
 145         // verification and means we have a hard time communicating
 146         // with other sites' HTTPS interfaces.
 147         //
 148         // Turn off verification unless we've configured a CA bundle.
 149         if (common_config('http', 'ssl_cafile')) {
 150             $this->config['ssl_cafile'] = common_config('http', 'ssl_cafile');
 151         } else {
 152             $this->config['ssl_verify_peer'] = false;
 153         }
 154
 155         // This means "verify the cert hostname against what we connect to", it does not
 156         // imply CA trust or anything like that. Just the hostname.
 157         $this->config['ssl_verify_host'] = common_config('http', 'ssl_verify_host');
 158
 159         if (common_config('http', 'curl') && extension_loaded('curl')) {
 160             $this->config['adapter'] = 'HTTP_Request2_Adapter_Curl';
 161         }
 162
 163         foreach (array('host', 'port', 'user', 'password', 'auth_scheme') as $cf) {
 164             $k = 'proxy_'.$cf;
 165             $v = common_config('http', $k);
 166             if (!empty($v)) {
 167                 $this->config[$k] = $v;
 168             }
 169         }
 170
 171         parent::__construct($url, $method, $config);
 172         $this->setHeader('User-Agent', self::userAgent());
 173     }
 174
 175     /**
 176      * Convenience/back-compat instantiator
 177      * @return HTTPClient
 178      */
 179     public static function start()
 180     {
 181         return new HTTPClient();
 182     }
 183
 184     /**
 185      * Quick static function to GET a URL
 186      */
 187     public static function quickGet($url, $accept=null, array $params=array(), array $headers=array())
 188     {
 189         if (!empty($params)) {
 190             $params = http_build_query($params, null, '&');
 191             if (strpos($url, '?') === false) {
 192                 $url .= '?' . $params;
 193             } else {
 194                 $url .= '&' . $params;
 195             }
 196         }
 197
 198         $client = new HTTPClient();
 199         if (!is_null($accept)) {
 200             $client->setHeader('Accept', $accept);
 201         }
 202         $response = $client->get($url, $headers);
 203         if (!$response->isOk()) {
 204             // TRANS: Exception. %s is the URL we tried to GET.
 205             throw new Exception(sprintf(_m('Could not GET URL %s.'), $url), $response->getStatus());
 206         }
 207         return $response->getBody();
 208     }
 209
 210     public static function quickGetJson($url, $params=array())
 211     {
 212         $data = json_decode(self::quickGet($url, null, $params));
 213         if (is_null($data)) {
 214             common_debug('Could not decode JSON data from URL: '.$url);
 215             throw new ServerException('Could not decode JSON data from URL');
 216         }
 217         return $data;
 218     }
 219
 220     /**
 221      * If you want an Accept header, put it in $headers
 222      */
 223     public static function quickHead($url, array $params=array(), array $headers=array())
 224     {
 225         if (!empty($params)) {
 226             $params = http_build_query($params, null, '&');
 227             if (strpos($url, '?') === false) {
 228                 $url .= '?' . $params;
 229             } else {
 230                 $url .= '&' . $params;
 231             }
 232         }
 233
 234         $client = new HTTPClient();
 235         $response = $client->head($url, $headers);
 236         if (!$response->isOk()) {
 237             // TRANS: Exception. %s is the URL we tried to GET.
 238             throw new Exception(sprintf(_m('Could not GET URL %s.'), $url), $response->getStatus());
 239         }
 240         return $response->getHeader();
 241     }
 242
 243     /**
 244      * Convenience function to run a GET request.
 245      *
 246      * @return GNUsocial_HTTPResponse
 247      * @throws HTTP_Request2_Exception
 248      */
 249     public function get($url, $headers=array())
 250     {
 251         return $this->doRequest($url, self::METHOD_GET, $headers);
 252     }
 253
 254     /**
 255      * Convenience function to run a HEAD request.
 256      *
 257      * NOTE: Will probably turn into a GET request if you let it follow redirects!
 258      *       That option is only there to be flexible and may be removed in the future!
 259      *
 260      * @return GNUsocial_HTTPResponse
 261      * @throws HTTP_Request2_Exception
 262      */
 263     public function head($url, $headers=array(), $follow_redirects=false)
 264     {
 265         // Save the configured value for follow_redirects
 266         $old_follow = $this->config['follow_redirects'];
 267         try {
 268             // Temporarily (possibly) override the follow_redirects setting
 269             $this->config['follow_redirects'] = $follow_redirects;
 270             return $this->doRequest($url, self::METHOD_HEAD, $headers);
 271         } catch (Exception $e) {
 272             // Let the exception go on its merry way.
 273             throw $e;
 274         } finally {
 275             // reset to the old value
 276             $this->config['follow_redirects'] = $old_follow;
 277         }
 278         //we've either returned or thrown exception here
 279     }
 280
 281     /**
 282      * Convenience function to POST form data.
 283      *
 284      * @param string $url
 285      * @param array $headers optional associative array of HTTP headers
 286      * @param array $data optional associative array or blob of form data to submit
 287      * @return GNUsocial_HTTPResponse
 288      * @throws HTTP_Request2_Exception
 289      */
 290     public function post($url, $headers=array(), $data=array())
 291     {
 292         if ($data) {
 293             $this->addPostParameter($data);
 294         }
 295         return $this->doRequest($url, self::METHOD_POST, $headers);
 296     }
 297
 298     /**
 299      * @param  string   $url        The URL including possible querystring
 300      * @param  string   $method     The HTTP method to use
 301      * @param  array    $headers    List of already formatted strings
 302      *                              (not an associative array, to allow
 303      *                              multiple same-named headers)
 304      *
 305      * @return GNUsocial_HTTPResponse
 306      * @throws HTTP_Request2_Exception
 307      */
 308     protected function doRequest($url, $method, array $headers=array())
 309     {
 310         $this->setUrl($url);
 311
 312         // Workaround for HTTP_Request2 not setting up SNI in socket contexts;
 313         // This fixes cert validation for SSL virtual hosts using SNI.
 314         // Requires PHP 5.3.2 or later and OpenSSL with SNI support.
 315         if ($this->url->getScheme() == 'https' && defined('OPENSSL_TLSEXT_SERVER_NAME')) {
 316             $this->config['ssl_SNI_enabled'] = true;
 317             $this->config['ssl_SNI_server_name'] = $this->url->getHost();
 318         }
 319
 320         $this->setMethod($method);
 321         foreach ($headers as $header) {
 322             $this->setHeader($header);
 323         }
 324         $response = $this->send();
 325         if (is_null($response)) {
 326             // TRANS: Failed to retrieve a remote web resource, %s is the target URL.
 327             throw new NoHttpResponseException($url);
 328         }
 329         return $response;
 330     }
 331
 332     protected function log($level, $detail) {
 333         $method = $this->getMethod();
 334         $url = $this->getUrl();
 335         common_log($level, __CLASS__ . ": HTTP $method $url - $detail");
 336     }
 337
 338     /**
 339      * Pulls up GNU Social's customized user-agent string, so services
 340      * we hit can track down the responsible software.
 341      *
 342      * @return string
 343      */
 344     static public function userAgent()
 345     {
 346         return GNUSOCIAL_ENGINE . '/' . GNUSOCIAL_VERSION
 347                 . ' (' . GNUSOCIAL_CODENAME . ')';
 348     }
 349
 350     /**
 351      * Actually performs the HTTP request and returns a
 352      * GNUsocial_HTTPResponse object with response body and header info.
 353      *
 354      * Wraps around parent send() to add logging and redirection processing.
 355      *
 356      * @return GNUsocial_HTTPResponse
 357      * @throw HTTP_Request2_Exception
 358      */
 359     public function send()
 360     {
 361         $maxRedirs = intval($this->config['max_redirs']);
 362         if (empty($this->config['max_redirs'])) {
 363             $maxRedirs = 0;
 364         }
 365         $redirs = 0;
 366         $redirUrls = array();
 367         do {
 368             try {
 369                 $response = parent::send();
 370             } catch (Exception $e) {
 371                 $this->log(LOG_ERR, $e->getMessage());
 372                 throw $e;
 373             }
 374             $code = $response->getStatus();
 375             $effectiveUrl = $response->getEffectiveUrl();
 376             $redirUrls[] = $effectiveUrl;
 377             $response->redirUrls = $redirUrls;
 378             if ($code >= 200 && $code < 300) {
 379                 $reason = $response->getReasonPhrase();
 380                 $this->log(LOG_INFO, "$code $reason");
 381             } elseif ($code >= 300 && $code < 400) {
 382                 $url = $this->getUrl();
 383                 $target = $response->getHeader('Location');
 384
 385                 if (++$redirs >= $maxRedirs) {
 386                     common_log(LOG_ERR, __CLASS__ . ": Too many redirects: skipping $code redirect from $url to $target");
 387                     break;
 388                 }
 389                 try {
 390                     $this->setUrl($target);
 391                     $this->setHeader('Referer', $url);
 392                     common_log(LOG_INFO, __CLASS__ . ": Following $code redirect from $url to $target");
 393                     continue;
 394                 } catch (HTTP_Request2_Exception $e) {
 395                     common_log(LOG_ERR, __CLASS__ . ": Invalid $code redirect from $url to $target");
 396                 }
 397             } else {
 398                 $reason = $response->getReasonPhrase();
 399                 $this->log(LOG_ERR, "$code $reason");
 400             }
 401             break;
 402         } while ($maxRedirs);
 403         return new GNUsocial_HTTPResponse($response, $this->getUrl(), $redirs);
 404     }
 405 }