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('STATUSNET')) {
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.
49 * @author Evan Prodromou <evan@status.net>
50 * @author Brion Vibber <brion@status.net>
51 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
52 * @link http://status.net/
54 class HTTPResponse extends HTTP_Request2_Response
56 function __construct(HTTP_Request2_Response $response, $url, $redirects=0)
58 foreach (get_object_vars($response) as $key => $val) {
61 $this->url = strval($url);
62 $this->redirectCount = intval($redirects);
66 * Get the count of redirects that have been followed, if any.
69 function getRedirectCount()
71 return $this->redirectCount;
75 * Gets the final target URL, after any redirects have been followed.
84 * Check if the response is OK, generally a 200 or other 2xx status code.
89 $status = $this->getStatus();
90 return ($status >= 200 && $status < 300);
95 * Utility class for doing HTTP client stuff
97 * We make HTTP calls in several places, and we have several different
98 * ways of doing them. This class hides the specifics of what underlying
99 * library (curl or PHP-HTTP or whatever) that's used.
101 * This extends the PEAR HTTP_Request2 package:
102 * - sends StatusNet-specific User-Agent header
103 * - 'follow_redirects' config option, defaulting off
104 * - 'max_redirs' config option, defaulting to 10
105 * - extended response class adds getRedirectCount() and getUrl() methods
106 * - get() and post() convenience functions return body content directly
110 * @author Evan Prodromou <evan@status.net>
111 * @author Brion Vibber <brion@status.net>
112 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
113 * @link http://status.net/
116 class HTTPClient extends HTTP_Request2
119 function __construct($url=null, $method=self::METHOD_GET, $config=array())
121 $this->config['max_redirs'] = 10;
122 $this->config['follow_redirects'] = true;
123 parent::__construct($url, $method, $config);
124 $this->setHeader('User-Agent', $this->userAgent());
128 * Convenience/back-compat instantiator
131 public static function start()
133 return new HTTPClient();
137 * Convenience function to run a GET request.
139 * @return HTTPResponse
140 * @throws HTTP_Request2_Exception
142 public function get($url, $headers=array())
144 return $this->doRequest($url, self::METHOD_GET, $headers);
148 * Convenience function to run a HEAD request.
150 * @return HTTPResponse
151 * @throws HTTP_Request2_Exception
153 public function head($url, $headers=array())
155 return $this->doRequest($url, self::METHOD_HEAD, $headers);
159 * Convenience function to POST form data.
162 * @param array $headers optional associative array of HTTP headers
163 * @param array $data optional associative array or blob of form data to submit
164 * @return HTTPResponse
165 * @throws HTTP_Request2_Exception
167 public function post($url, $headers=array(), $data=array())
170 $this->addPostParameter($data);
172 return $this->doRequest($url, self::METHOD_POST, $headers);
176 * @return HTTPResponse
177 * @throws HTTP_Request2_Exception
179 protected function doRequest($url, $method, $headers)
182 $this->setMethod($method);
184 foreach ($headers as $header) {
185 $this->setHeader($header);
188 $response = $this->send();
192 protected function log($level, $detail) {
193 $method = $this->getMethod();
194 $url = $this->getUrl();
195 common_log($level, __CLASS__ . ": HTTP $method $url - $detail");
199 * Pulls up StatusNet's customized user-agent string, so services
200 * we hit can track down the responsible software.
206 return "StatusNet/".STATUSNET_VERSION." (".STATUSNET_CODENAME.")";
210 * Actually performs the HTTP request and returns an HTTPResponse object
211 * with response body and header info.
213 * Wraps around parent send() to add logging and redirection processing.
215 * @return HTTPResponse
216 * @throw HTTP_Request2_Exception
218 public function send()
220 $maxRedirs = intval($this->config['max_redirs']);
221 if (empty($this->config['follow_redirects'])) {
227 $response = parent::send();
228 } catch (HTTP_Request2_Exception $e) {
229 $this->log(LOG_ERR, $e->getMessage());
232 $code = $response->getStatus();
233 if ($code >= 200 && $code < 300) {
234 $reason = $response->getReasonPhrase();
235 $this->log(LOG_INFO, "$code $reason");
236 } elseif ($code >= 300 && $code < 400) {
237 $url = $this->getUrl();
238 $target = $response->getHeader('Location');
240 if (++$redirs >= $maxRedirs) {
241 common_log(LOG_ERR, __CLASS__ . ": Too many redirects: skipping $code redirect from $url to $target");
245 $this->setUrl($target);
246 $this->setHeader('Referer', $url);
247 common_log(LOG_INFO, __CLASS__ . ": Following $code redirect from $url to $target");
249 } catch (HTTP_Request2_Exception $e) {
250 common_log(LOG_ERR, __CLASS__ . ": Invalid $code redirect from $url to $target");
253 $reason = $response->getReasonPhrase();
254 $this->log(LOG_ERR, "$code $reason");
257 } while ($maxRedirs);
258 return new HTTPResponse($response, $this->getUrl(), $redirs);