287 lines
8.8 KiB
PHP
287 lines
8.8 KiB
PHP
|
<?php // -*- c-basic-offset: 2 -*-
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pest is a REST client for PHP.
|
||
|
|
*
|
||
|
|
* See http://github.com/educoder/pest for details.
|
||
|
|
*
|
||
|
|
* This code is licensed for use, modification, and distribution
|
||
|
|
* under the terms of the MIT License (see http://en.wikipedia.org/wiki/MIT_License)
|
||
|
|
*/
|
||
|
|
class Pest {
|
||
|
|
public $curl_opts = array(
|
||
|
|
CURLOPT_RETURNTRANSFER => true, // return result instead of echoing
|
||
|
|
CURLOPT_SSL_VERIFYPEER => false, // stop cURL from verifying the peer's certificate
|
||
|
|
CURLOPT_FOLLOWLOCATION => false, // follow redirects, Location: headers
|
||
|
|
CURLOPT_MAXREDIRS => 10 // but dont redirect more than 10 times
|
||
|
|
);
|
||
|
|
|
||
|
|
public $base_url;
|
||
|
|
|
||
|
|
public $last_response;
|
||
|
|
public $last_request;
|
||
|
|
public $last_headers;
|
||
|
|
|
||
|
|
public $throw_exceptions = true;
|
||
|
|
|
||
|
|
public function __construct($base_url) {
|
||
|
|
if (!function_exists('curl_init')) {
|
||
|
|
throw new Exception('CURL module not available! Pest requires CURL. See http://php.net/manual/en/book.curl.php');
|
||
|
|
}
|
||
|
|
|
||
|
|
// only enable CURLOPT_FOLLOWLOCATION if safe_mode and open_base_dir are not in use
|
||
|
|
if(ini_get('open_basedir') == '' && strtolower(ini_get('safe_mode')) == 'off') {
|
||
|
|
$this->curl_opts['CURLOPT_FOLLOWLOCATION'] = true;
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->base_url = $base_url;
|
||
|
|
|
||
|
|
// The callback to handle return headers
|
||
|
|
// Using PHP 5.2, it cannot be initialised in the static context
|
||
|
|
$this->curl_opts[CURLOPT_HEADERFUNCTION] = array($this, 'handle_header');
|
||
|
|
}
|
||
|
|
|
||
|
|
// $auth can be 'basic' or 'digest'
|
||
|
|
public function setupAuth($user, $pass, $auth = 'basic') {
|
||
|
|
$this->curl_opts[CURLOPT_HTTPAUTH] = constant('CURLAUTH_'.strtoupper($auth));
|
||
|
|
$this->curl_opts[CURLOPT_USERPWD] = $user . ":" . $pass;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Enable a proxy
|
||
|
|
public function setupProxy($host, $port, $user = NULL, $pass = NULL) {
|
||
|
|
$this->curl_opts[CURLOPT_PROXYTYPE] = 'HTTP';
|
||
|
|
$this->curl_opts[CURLOPT_PROXY] = $host;
|
||
|
|
$this->curl_opts[CURLOPT_PROXYPORT] = $port;
|
||
|
|
if ($user && $pass) {
|
||
|
|
$this->curl_opts[CURLOPT_PROXYUSERPWD] = $user . ":" . $pass;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public function get($url) {
|
||
|
|
$curl = $this->prepRequest($this->curl_opts, $url);
|
||
|
|
$body = $this->doRequest($curl);
|
||
|
|
|
||
|
|
$body = $this->processBody($body);
|
||
|
|
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function post($url, $data, $headers=array()) {
|
||
|
|
$data = (is_array($data)) ? http_build_query($data) : $data;
|
||
|
|
|
||
|
|
$curl_opts = $this->curl_opts;
|
||
|
|
$curl_opts[CURLOPT_CUSTOMREQUEST] = 'POST';
|
||
|
|
$headers[] = 'Content-Length: '.strlen($data);
|
||
|
|
$curl_opts[CURLOPT_HTTPHEADER] = $headers;
|
||
|
|
$curl_opts[CURLOPT_POSTFIELDS] = $data;
|
||
|
|
$curl_opts[CURLINFO_HEADER_OUT] = true;
|
||
|
|
|
||
|
|
$curl = $this->prepRequest($curl_opts, $url);
|
||
|
|
$body = $this->doRequest($curl);
|
||
|
|
|
||
|
|
$body = $this->processBody($body);
|
||
|
|
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function put($url, $data, $headers=array()) {
|
||
|
|
$data = (is_array($data)) ? http_build_query($data) : $data;
|
||
|
|
|
||
|
|
$curl_opts = $this->curl_opts;
|
||
|
|
$curl_opts[CURLOPT_CUSTOMREQUEST] = 'PUT';
|
||
|
|
$headers[] = 'Content-Length: '.strlen($data);
|
||
|
|
$curl_opts[CURLOPT_HTTPHEADER] = $headers;
|
||
|
|
$curl_opts[CURLOPT_POSTFIELDS] = $data;
|
||
|
|
|
||
|
|
$curl = $this->prepRequest($curl_opts, $url);
|
||
|
|
$body = $this->doRequest($curl);
|
||
|
|
|
||
|
|
$body = $this->processBody($body);
|
||
|
|
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function patch($url, $data, $headers=array()) {
|
||
|
|
$data = (is_array($data)) ? http_build_query($data) : $data;
|
||
|
|
|
||
|
|
$curl_opts = $this->curl_opts;
|
||
|
|
$curl_opts[CURLOPT_CUSTOMREQUEST] = 'PATCH';
|
||
|
|
$headers[] = 'Content-Length: '.strlen($data);
|
||
|
|
$curl_opts[CURLOPT_HTTPHEADER] = $headers;
|
||
|
|
$curl_opts[CURLOPT_POSTFIELDS] = $data;
|
||
|
|
|
||
|
|
$curl = $this->prepRequest($curl_opts, $url);
|
||
|
|
$body = $this->doRequest($curl);
|
||
|
|
|
||
|
|
$body = $this->processBody($body);
|
||
|
|
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function delete($url) {
|
||
|
|
$curl_opts = $this->curl_opts;
|
||
|
|
$curl_opts[CURLOPT_CUSTOMREQUEST] = 'DELETE';
|
||
|
|
|
||
|
|
$curl = $this->prepRequest($curl_opts, $url);
|
||
|
|
$body = $this->doRequest($curl);
|
||
|
|
|
||
|
|
$body = $this->processBody($body);
|
||
|
|
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function lastBody() {
|
||
|
|
return $this->last_response['body'];
|
||
|
|
}
|
||
|
|
|
||
|
|
public function lastStatus() {
|
||
|
|
return $this->last_response['meta']['http_code'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return the last response header (case insensitive) or NULL if not present.
|
||
|
|
* HTTP allows empty headers (e.g. RFC 2616, Section 14.23), thus is_null()
|
||
|
|
* and not negation or empty() should be used.
|
||
|
|
*/
|
||
|
|
public function lastHeader($header) {
|
||
|
|
if (empty($this->last_headers[strtolower($header)])) {
|
||
|
|
return NULL;
|
||
|
|
}
|
||
|
|
return $this->last_headers[strtolower($header)];
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function processBody($body) {
|
||
|
|
// Override this in classes that extend Pest.
|
||
|
|
// The body of every GET/POST/PUT/DELETE response goes through
|
||
|
|
// here prior to being returned.
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function processError($body) {
|
||
|
|
// Override this in classes that extend Pest.
|
||
|
|
// The body of every erroneous (non-2xx/3xx) GET/POST/PUT/DELETE
|
||
|
|
// response goes through here prior to being used as the 'message'
|
||
|
|
// of the resulting Pest_Exception
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
protected function prepRequest($opts, $url) {
|
||
|
|
if (strncmp($url, $this->base_url, strlen($this->base_url)) != 0) {
|
||
|
|
$url = $this->base_url . $url;
|
||
|
|
}
|
||
|
|
$curl = curl_init($url);
|
||
|
|
|
||
|
|
foreach ($opts as $opt => $val)
|
||
|
|
curl_setopt($curl, $opt, $val);
|
||
|
|
|
||
|
|
$this->last_request = array(
|
||
|
|
'url' => $url
|
||
|
|
);
|
||
|
|
|
||
|
|
if (isset($opts[CURLOPT_CUSTOMREQUEST]))
|
||
|
|
$this->last_request['method'] = $opts[CURLOPT_CUSTOMREQUEST];
|
||
|
|
else
|
||
|
|
$this->last_request['method'] = 'GET';
|
||
|
|
|
||
|
|
if (isset($opts[CURLOPT_POSTFIELDS]))
|
||
|
|
$this->last_request['data'] = $opts[CURLOPT_POSTFIELDS];
|
||
|
|
|
||
|
|
return $curl;
|
||
|
|
}
|
||
|
|
|
||
|
|
private function handle_header($ch, $str) {
|
||
|
|
if (preg_match('/([^:]+):\s(.+)/m', $str, $match) ) {
|
||
|
|
$this->last_headers[strtolower($match[1])] = trim($match[2]);
|
||
|
|
}
|
||
|
|
return strlen($str);
|
||
|
|
}
|
||
|
|
|
||
|
|
private function doRequest($curl) {
|
||
|
|
$this->last_headers = array();
|
||
|
|
|
||
|
|
$body = curl_exec($curl);
|
||
|
|
$meta = curl_getinfo($curl);
|
||
|
|
|
||
|
|
$this->last_response = array(
|
||
|
|
'body' => $body,
|
||
|
|
'meta' => $meta
|
||
|
|
);
|
||
|
|
|
||
|
|
curl_close($curl);
|
||
|
|
|
||
|
|
$this->checkLastResponseForError();
|
||
|
|
|
||
|
|
return $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
protected function checkLastResponseForError() {
|
||
|
|
if ( !$this->throw_exceptions)
|
||
|
|
return;
|
||
|
|
|
||
|
|
$meta = $this->last_response['meta'];
|
||
|
|
$body = $this->last_response['body'];
|
||
|
|
|
||
|
|
if (!$meta)
|
||
|
|
return;
|
||
|
|
|
||
|
|
$err = null;
|
||
|
|
switch ($meta['http_code']) {
|
||
|
|
case 400:
|
||
|
|
throw new Pest_BadRequest($this->processError($body));
|
||
|
|
break;
|
||
|
|
case 401:
|
||
|
|
throw new Pest_Unauthorized($this->processError($body));
|
||
|
|
break;
|
||
|
|
case 403:
|
||
|
|
throw new Pest_Forbidden($this->processError($body));
|
||
|
|
break;
|
||
|
|
case 404:
|
||
|
|
throw new Pest_NotFound($this->processError($body));
|
||
|
|
break;
|
||
|
|
case 405:
|
||
|
|
throw new Pest_MethodNotAllowed($this->processError($body));
|
||
|
|
break;
|
||
|
|
case 409:
|
||
|
|
throw new Pest_Conflict($this->processError($body));
|
||
|
|
break;
|
||
|
|
case 410:
|
||
|
|
throw new Pest_Gone($this->processError($body));
|
||
|
|
break;
|
||
|
|
case 422:
|
||
|
|
// Unprocessable Entity -- see http://www.iana.org/assignments/http-status-codes
|
||
|
|
// This is now commonly used (in Rails, at least) to indicate
|
||
|
|
// a response to a request that is syntactically correct,
|
||
|
|
// but semantically invalid (for example, when trying to
|
||
|
|
// create a resource with some required fields missing)
|
||
|
|
throw new Pest_InvalidRecord($this->processError($body));
|
||
|
|
break;
|
||
|
|
default:
|
||
|
|
if ($meta['http_code'] >= 400 && $meta['http_code'] <= 499)
|
||
|
|
throw new Pest_ClientError($this->processError($body));
|
||
|
|
elseif ($meta['http_code'] >= 500 && $meta['http_code'] <= 599)
|
||
|
|
throw new Pest_ServerError($this->processError($body));
|
||
|
|
elseif (!$meta['http_code'] || $meta['http_code'] >= 600) {
|
||
|
|
throw new Pest_UnknownResponse($this->processError($body));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
class Pest_Exception extends Exception { }
|
||
|
|
class Pest_UnknownResponse extends Pest_Exception { }
|
||
|
|
|
||
|
|
/* 401-499 */ class Pest_ClientError extends Pest_Exception {}
|
||
|
|
/* 400 */ class Pest_BadRequest extends Pest_ClientError {}
|
||
|
|
/* 401 */ class Pest_Unauthorized extends Pest_ClientError {}
|
||
|
|
/* 403 */ class Pest_Forbidden extends Pest_ClientError {}
|
||
|
|
/* 404 */ class Pest_NotFound extends Pest_ClientError {}
|
||
|
|
/* 405 */ class Pest_MethodNotAllowed extends Pest_ClientError {}
|
||
|
|
/* 409 */ class Pest_Conflict extends Pest_ClientError {}
|
||
|
|
/* 410 */ class Pest_Gone extends Pest_ClientError {}
|
||
|
|
/* 422 */ class Pest_InvalidRecord extends Pest_ClientError {}
|
||
|
|
|
||
|
|
/* 500-599 */ class Pest_ServerError extends Pest_Exception {}
|
||
|
|
|
||
|
|
?>
|