3 * StatusNet, the distributed open-source microblogging tool
5 * Utility for doing HTTP-related things
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.
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.
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/>.
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/
30 if (!defined('GNUSOCIAL')) {
34 require_once 'HTTP/Request2.php';
35 require_once 'HTTP/Request2/Response.php';
38 * Useful structure for HTTP responses
40 * We make HTTP calls in several places, and we have several different
41 * ways of doing them. This class hides the specifics of what underlying
42 * library (curl or PHP-HTTP or whatever) that's used.
44 * This extends the HTTP_Request2_Response class with methods to get info
45 * about any followed redirects.
47 * Originally used the name 'HTTPResponse' to match earlier code, but
48 * this conflicts with a class in in the PECL HTTP extension.
52 * @author Evan Prodromou <evan@status.net>
53 * @author Brion Vibber <brion@status.net>
54 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
55 * @link http://status.net/
57 class GNUsocial_HTTPResponse extends HTTP_Request2_Response
59 function __construct(HTTP_Request2_Response $response, $url, $redirects=0)
61 foreach (get_object_vars($response) as $key => $val) {
64 $this->url = strval($url);
65 $this->redirectCount = intval($redirects);
69 * Get the count of redirects that have been followed, if any.
72 function getRedirectCount()
74 return $this->redirectCount;
78 * Gets the target URL, before any redirects. Use getEffectiveUrl() for final target.
87 * Check if the response is OK, generally a 200 or other 2xx status code.
92 $status = $this->getStatus();
93 return ($status >= 200 && $status < 300);
98 * Utility class for doing HTTP client stuff
100 * We make HTTP calls in several places, and we have several different
101 * ways of doing them. This class hides the specifics of what underlying
102 * library (curl or PHP-HTTP or whatever) that's used.
104 * This extends the PEAR HTTP_Request2 package:
105 * - sends StatusNet-specific User-Agent header
106 * - 'follow_redirects' config option, defaulting on
107 * - 'max_redirs' config option, defaulting to 10
108 * - extended response class adds getRedirectCount() and getUrl() methods
109 * - get() and post() convenience functions return body content directly
113 * @author Evan Prodromou <evan@status.net>
114 * @author Brion Vibber <brion@status.net>
115 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
116 * @link http://status.net/
119 class HTTPClient extends HTTP_Request2
122 function __construct($url=null, $method=self::METHOD_GET, $config=array())
124 $this->config['max_redirs'] = 10;
125 $this->config['follow_redirects'] = true;
127 // We've had some issues with keepalive breaking with
128 // HEAD requests, such as to youtube which seems to be
129 // emitting chunked encoding info for an empty body
130 // instead of not emitting anything. This may be a
131 // bug on YouTube's end, but the upstream libray
132 // ought to be investigated to see if we can handle
133 // it gracefully in that case as well.
134 $this->config['protocol_version'] = '1.0';
136 // Default state of OpenSSL seems to have no trusted
137 // SSL certificate authorities, which breaks hostname
138 // verification and means we have a hard time communicating
139 // with other sites' HTTPS interfaces.
141 // Turn off verification unless we've configured a CA bundle.
142 if (common_config('http', 'ssl_cafile')) {
143 $this->config['ssl_cafile'] = common_config('http', 'ssl_cafile');
145 $this->config['ssl_verify_peer'] = false;
148 // This means "verify the cert hostname against what we connect to", it does not
149 // imply CA trust or anything like that. Just the hostname.
150 $this->config['ssl_verify_host'] = common_config('http', 'ssl_verify_host');
152 if (common_config('http', 'curl') && extension_loaded('curl')) {
153 $this->config['adapter'] = 'HTTP_Request2_Adapter_Curl';
156 foreach (array('host', 'port', 'user', 'password', 'auth_scheme') as $cf) {
158 $v = common_config('http', $k);
160 $this->config[$k] = $v;
164 parent::__construct($url, $method, $config);
165 $this->setHeader('User-Agent', self::userAgent());
169 * Convenience/back-compat instantiator
172 public static function start()
174 return new HTTPClient();
178 * Quick static function to GET a URL
180 public static function quickGet($url, $accept=null, $params=array())
182 if (!empty($params)) {
183 $params = http_build_query($params, null, '&');
184 if (strpos($url, '?') === false) {
185 $url .= '?' . $params;
187 $url .= '&' . $params;
191 $client = new HTTPClient();
192 if (!is_null($accept)) {
193 $client->setHeader('Accept', $accept);
195 $response = $client->get($url);
196 if (!$response->isOk()) {
197 // TRANS: Exception. %s is the URL we tried to GET.
198 throw new Exception(sprintf(_m('Could not GET URL %s.'), $url), $response->getStatus());
200 return $response->getBody();
203 public static function quickGetJson($url, $params=array())
205 $data = json_decode(self::quickGet($url, null, $params));
206 if (is_null($data)) {
207 common_debug('Could not decode JSON data from URL: '.$url);
208 throw new ServerException('Could not decode JSON data from URL');
214 * Convenience function to run a GET request.
216 * @return GNUsocial_HTTPResponse
217 * @throws HTTP_Request2_Exception
219 public function get($url, $headers=array())
221 return $this->doRequest($url, self::METHOD_GET, $headers);
225 * Convenience function to run a HEAD request.
227 * NOTE: Will probably turn into a GET request if you let it follow redirects!
228 * That option is only there to be flexible and may be removed in the future!
230 * @return GNUsocial_HTTPResponse
231 * @throws HTTP_Request2_Exception
233 public function head($url, $headers=array(), $follow_redirects=false)
235 // Save the configured value for follow_redirects
236 $old_follow = $this->config['follow_redirects'];
238 // Temporarily (possibly) override the follow_redirects setting
239 $this->config['follow_redirects'] = $follow_redirects;
240 return $this->doRequest($url, self::METHOD_HEAD, $headers);
241 } catch (Exception $e) {
242 // Let the exception go on its merry way.
245 // reset to the old value
246 $this->config['follow_redirects'] = $old_follow;
248 //we've either returned or thrown exception here
252 * Convenience function to POST form data.
255 * @param array $headers optional associative array of HTTP headers
256 * @param array $data optional associative array or blob of form data to submit
257 * @return GNUsocial_HTTPResponse
258 * @throws HTTP_Request2_Exception
260 public function post($url, $headers=array(), $data=array())
263 $this->addPostParameter($data);
265 return $this->doRequest($url, self::METHOD_POST, $headers);
269 * @return GNUsocial_HTTPResponse
270 * @throws HTTP_Request2_Exception
272 protected function doRequest($url, $method, $headers)
276 // Workaround for HTTP_Request2 not setting up SNI in socket contexts;
277 // This fixes cert validation for SSL virtual hosts using SNI.
278 // Requires PHP 5.3.2 or later and OpenSSL with SNI support.
279 if ($this->url->getScheme() == 'https' && defined('OPENSSL_TLSEXT_SERVER_NAME')) {
280 $this->config['ssl_SNI_enabled'] = true;
281 $this->config['ssl_SNI_server_name'] = $this->url->getHost();
284 $this->setMethod($method);
286 foreach ($headers as $header) {
287 $this->setHeader($header);
290 $response = $this->send();
291 if (is_null($response)) {
292 // TRANS: Failed to retrieve a remote web resource, %s is the target URL.
293 throw new NoHttpResponseException($url);
298 protected function log($level, $detail) {
299 $method = $this->getMethod();
300 $url = $this->getUrl();
301 common_log($level, __CLASS__ . ": HTTP $method $url - $detail");
305 * Pulls up GNU Social's customized user-agent string, so services
306 * we hit can track down the responsible software.
310 static public function userAgent()
312 return GNUSOCIAL_ENGINE . '/' . GNUSOCIAL_VERSION
313 . ' (' . GNUSOCIAL_CODENAME . ')';
317 * Actually performs the HTTP request and returns a
318 * GNUsocial_HTTPResponse object with response body and header info.
320 * Wraps around parent send() to add logging and redirection processing.
322 * @return GNUsocial_HTTPResponse
323 * @throw HTTP_Request2_Exception
325 public function send()
327 $maxRedirs = intval($this->config['max_redirs']);
328 if (empty($this->config['follow_redirects'])) {
334 $response = parent::send();
335 } catch (HTTP_Request2_Exception $e) {
336 $this->log(LOG_ERR, $e->getMessage());
339 $code = $response->getStatus();
340 if ($code >= 200 && $code < 300) {
341 $reason = $response->getReasonPhrase();
342 $this->log(LOG_INFO, "$code $reason");
343 } elseif ($code >= 300 && $code < 400) {
344 $url = $this->getUrl();
345 $target = $response->getHeader('Location');
347 if (++$redirs >= $maxRedirs) {
348 common_log(LOG_ERR, __CLASS__ . ": Too many redirects: skipping $code redirect from $url to $target");
352 $this->setUrl($target);
353 $this->setHeader('Referer', $url);
354 common_log(LOG_INFO, __CLASS__ . ": Following $code redirect from $url to $target");
356 } catch (HTTP_Request2_Exception $e) {
357 common_log(LOG_ERR, __CLASS__ . ": Invalid $code redirect from $url to $target");
360 $reason = $response->getReasonPhrase();
361 $this->log(LOG_ERR, "$code $reason");
364 } while ($maxRedirs);
365 return new GNUsocial_HTTPResponse($response, $this->getUrl(), $redirs);