X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fhttpclient.php;h=819a5e6e0799140646ac01aa8c76cd6e0b058608;hb=586fb5a5175d7a10f5f78dd026434e48202e5451;hp=04e2b9ac6539c9b884b7f50f0a33d25e792081f2;hpb=98a0d7f538bad0b365adb1ec7eacb8c86c15384b;p=quix0rs-gnu-social.git diff --git a/lib/httpclient.php b/lib/httpclient.php index 04e2b9ac65..819a5e6e07 100644 --- a/lib/httpclient.php +++ b/lib/httpclient.php @@ -27,12 +27,7 @@ * @link http://status.net/ */ -if (!defined('STATUSNET')) { - exit(1); -} - -require_once 'HTTP/Request2.php'; -require_once 'HTTP/Request2/Response.php'; +if (!defined('GNUSOCIAL')) { exit(1); } /** * Useful structure for HTTP responses @@ -43,7 +38,7 @@ require_once 'HTTP/Request2/Response.php'; * * 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. * @@ -54,7 +49,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) { @@ -75,7 +70,7 @@ class StatusNet_HTTPResponse extends HTTP_Request2_Response } /** - * Gets the final target URL, after any redirects have been followed. + * Gets the target URL, before any redirects. Use getEffectiveUrl() for final target. * @return string URL */ function getUrl() @@ -103,7 +98,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 @@ -121,9 +116,21 @@ class HTTPClient extends HTTP_Request2 function __construct($url=null, $method=self::METHOD_GET, $config=array()) { + if (is_int(common_config('http', 'timeout'))) { + // Reasonably you shouldn't set http/timeout to 0 because of + // malicious remote servers that can cause infinitely long + // responses... But the default in HTTP_Request2 is 0 for + // some reason and should probably be considered a valid value. + $this->config['timeout'] = common_config('http', 'timeout'); + } else { + common_log(LOG_ERR, 'config option http/timeout is not an integer value: '._ve(common_config('http', 'timeout'))); + } + if (!empty(common_config('http', 'connect_timeout'))) { + $this->config['connect_timeout'] = common_config('http', 'connect_timeout'); + } $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 @@ -145,20 +152,24 @@ 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'; } foreach (array('host', 'port', 'user', 'password', 'auth_scheme') as $cf) { $k = 'proxy_'.$cf; - $v = common_config('http', $k); + $v = common_config('http', $k); if (!empty($v)) { $this->config[$k] = $v; } } parent::__construct($url, $method, $config); - $this->setHeader('User-Agent', $this->userAgent()); + $this->setHeader('User-Agent', self::userAgent()); } /** @@ -170,10 +181,69 @@ class HTTPClient extends HTTP_Request2 return new HTTPClient(); } + /** + * Quick static function to GET a URL + */ + public static function quickGet($url, $accept=null, array $params=array(), array $headers=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, $headers); + if (!$response->isOk()) { + // TRANS: Exception. %s is the URL we tried to GET. + 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; + } + + /** + * If you want an Accept header, put it in $headers + */ + public static function quickHead($url, array $params=array(), array $headers=array()) + { + if (!empty($params)) { + $params = http_build_query($params, null, '&'); + if (strpos($url, '?') === false) { + $url .= '?' . $params; + } else { + $url .= '&' . $params; + } + } + + $client = new HTTPClient(); + $response = $client->head($url, $headers); + if (!$response->isOk()) { + // TRANS: Exception. %s is the URL we tried to GET. + throw new Exception(sprintf(_m('Could not GET URL %s.'), $url), $response->getStatus()); + } + return $response->getHeader(); + } + /** * 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 +254,28 @@ 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) { + // 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 } /** @@ -198,7 +284,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,10 +296,16 @@ class HTTPClient extends HTTP_Request2 } /** - * @return StatusNet_HTTPResponse + * @param string $url The URL including possible querystring + * @param string $method The HTTP method to use + * @param array $headers List of already formatted strings + * (not an associative array, to allow + * multiple same-named headers) + * + * @return GNUsocial_HTTPResponse * @throws HTTP_Request2_Exception */ - protected function doRequest($url, $method, $headers) + protected function doRequest($url, $method, array $headers=array()) { $this->setUrl($url); @@ -226,15 +318,17 @@ class HTTPClient extends HTTP_Request2 } $this->setMethod($method); - if ($headers) { - foreach ($headers as $header) { - $this->setHeader($header); - } + foreach ($headers as $header) { + $this->setHeader($header); } $response = $this->send(); + if (is_null($response)) { + // TRANS: Failed to retrieve a remote web resource, %s is the target URL. + throw new NoHttpResponseException($url); + } return $response; } - + protected function log($level, $detail) { $method = $this->getMethod(); $url = $this->getUrl(); @@ -242,47 +336,52 @@ 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() { $maxRedirs = intval($this->config['max_redirs']); - if (empty($this->config['follow_redirects'])) { + if (empty($this->config['max_redirs'])) { $maxRedirs = 0; } $redirs = 0; + $redirUrls = array(); do { try { $response = parent::send(); - } catch (HTTP_Request2_Exception $e) { + } catch (Exception $e) { $this->log(LOG_ERR, $e->getMessage()); throw $e; } $code = $response->getStatus(); + $effectiveUrl = $response->getEffectiveUrl(); + $redirUrls[] = $effectiveUrl; + $response->redirUrls = $redirUrls; 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; @@ -301,6 +400,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); } }