*
* 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.
*
* @category HTTP
* @package StatusNet
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
-class HTTPResponse extends HTTP_Request2_Response
+class StatusNet_HTTPResponse extends HTTP_Request2_Response
{
function __construct(HTTP_Request2_Response $response, $url, $redirects=0)
{
* Get the count of redirects that have been followed, if any.
* @return int
*/
- function getRedirectCount() {
+ function getRedirectCount()
+ {
return $this->redirectCount;
}
* Gets the final target URL, after any redirects have been followed.
* @return string URL
*/
- function getUrl() {
+ function getUrl()
+ {
return $this->url;
}
+
+ /**
+ * Check if the response is OK, generally a 200 or other 2xx status code.
+ * @return bool
+ */
+ function isOk()
+ {
+ $status = $this->getStatus();
+ return ($status >= 200 && $status < 300);
+ }
}
/**
function __construct($url=null, $method=self::METHOD_GET, $config=array())
{
$this->config['max_redirs'] = 10;
- $this->config['follow_redirects'] = false;
+ $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
+ // instead of not emitting anything. This may be a
+ // bug on YouTube's end, but the upstream libray
+ // ought to be investigated to see if we can handle
+ // it gracefully in that case as well.
+ $this->config['protocol_version'] = '1.0';
+
+ // Default state of OpenSSL seems to have no trusted
+ // SSL certificate authorities, which breaks hostname
+ // verification and means we have a hard time communicating
+ // with other sites' HTTPS interfaces.
+ //
+ // Turn off verification unless we've configured a CA bundle.
+ if (common_config('http', 'ssl_cafile')) {
+ $this->config['ssl_cafile'] = common_config('http', 'ssl_cafile');
+ } else {
+ $this->config['ssl_verify_peer'] = false;
+ }
+
parent::__construct($url, $method, $config);
$this->setHeader('User-Agent', $this->userAgent());
}
/**
- * Convenience function to run a get request and return the response body.
- * Use when you don't need to get into details of the response.
+ * Convenience/back-compat instantiator
+ * @return HTTPClient
+ */
+ public static function start()
+ {
+ return new HTTPClient();
+ }
+
+ /**
+ * Convenience function to run a GET request.
+ *
+ * @return StatusNet_HTTPResponse
+ * @throws HTTP_Request2_Exception
+ */
+ public function get($url, $headers=array())
+ {
+ return $this->doRequest($url, self::METHOD_GET, $headers);
+ }
+
+ /**
+ * Convenience function to run a HEAD request.
*
- * @return mixed string on success, false on failure
+ * @return StatusNet_HTTPResponse
+ * @throws HTTP_Request2_Exception
*/
- function get()
+ public function head($url, $headers=array())
{
- $this->setMethod(self::METHOD_GET);
- return $this->doRequest();
+ return $this->doRequest($url, self::METHOD_HEAD, $headers);
}
/**
- * Convenience function to post form data and return the response body.
- * Use when you don't need to get into details of the response.
+ * Convenience function to POST form data.
*
- * @param array associative array of form data to submit
- * @return mixed string on success, false on failure
+ * @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
+ * @throws HTTP_Request2_Exception
*/
- public function post($data=array())
+ public function post($url, $headers=array(), $data=array())
{
- $this->setMethod(self::METHOD_POST);
if ($data) {
$this->addPostParameter($data);
}
- return $this->doRequest();
+ return $this->doRequest($url, self::METHOD_POST, $headers);
}
/**
- * @return mixed string on success, false on failure
+ * @return StatusNet_HTTPResponse
+ * @throws HTTP_Request2_Exception
*/
- protected function doRequest()
+ protected function doRequest($url, $method, $headers)
{
- try {
- $response = $this->send();
- $code = $response->getStatus();
- if (($code < 200) || ($code >= 400)) {
- return false;
+ $this->setUrl($url);
+ $this->setMethod($method);
+ if ($headers) {
+ foreach ($headers as $header) {
+ $this->setHeader($header);
}
- return $response->getBody();
- } catch (HTTP_Request2_Exception $e) {
- $this->log(LOG_ERR, $e->getMessage());
- return false;
}
+ $response = $this->send();
+ return $response;
}
protected function log($level, $detail) {
/**
* Pulls up StatusNet's customized user-agent string, so services
* we hit can track down the responsible software.
+ *
+ * @return string
*/
function userAgent()
{
return "StatusNet/".STATUSNET_VERSION." (".STATUSNET_CODENAME.")";
}
- function send()
+ /**
+ * Actually performs the HTTP request and returns a
+ * StatusNet_HTTPResponse object with response body and header info.
+ *
+ * Wraps around parent send() to add logging and redirection processing.
+ *
+ * @return StatusNet_HTTPResponse
+ * @throw HTTP_Request2_Exception
+ */
+ public function send()
{
$maxRedirs = intval($this->config['max_redirs']);
if (empty($this->config['follow_redirects'])) {
}
break;
} while ($maxRedirs);
- return new HTTPResponse($response, $this->getUrl(), $redirs);
+ return new StatusNet_HTTPResponse($response, $this->getUrl(), $redirs);
}
}
projects / quix0rs-gnu-social.git / blobdiff