1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | <?php /** * HTTP REST Client for CouchDB API */ class SetteeRestClient { /** * HTTP Timeout in Milliseconds */ const HTTP_TIMEOUT = 2000; private $base_url; private $curl; private static $curl_workers = array(); /** * Singleton factory method */ static function get_instance($base_url) { if (empty(self::$curl_workers[$base_url])) { self::$curl_workers[$base_url] = new SetteeRestClient($base_url); } return self::$curl_workers[$base_url]; } /** * Class constructor */ private function __construct($base_url) { $this->base_url = $base_url; $curl = curl_init(); curl_setopt($curl, CURLOPT_USERAGENT, "Settee CouchDB Client/1.0"); curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json')); curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); curl_setopt($curl, CURLOPT_HEADER, 0); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1); curl_setopt($curl, CURLOPT_TIMEOUT_MS, self::HTTP_TIMEOUT); curl_setopt($curl, CURLOPT_FORBID_REUSE, false); // Connection-pool for CURL $this->curl = $curl; } /** * Class destructor cleans up any resources */ function __destruct() { curl_close($this->curl); } /** * HTTP HEAD * * @return * Raw HTTP Headers of the response. * * @see: http://www.php.net/manual/en/context.params.php * */ function http_head($uri) { curl_setopt($this->curl, CURLOPT_HEADER, 1); $full_url = $this->get_full_url($uri); curl_setopt($this->curl, CURLOPT_URL, $full_url); curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'HEAD'); curl_setopt($this->curl, CURLOPT_NOBODY, true); $response = curl_exec($this->curl); // Restore default values curl_setopt($this->curl, CURLOPT_NOBODY, false); curl_setopt($this->curl, CURLOPT_HEADER, false); $resp_code = curl_getinfo($this->curl, CURLINFO_HTTP_CODE); if ($resp_code == 404 ) { throw new SetteeRestClientException("Couch document not found at: '$full_url'"); } if (function_exists('http_parse_headers')) { $headers = http_parse_headers($response); } else { $headers = $this->_http_parse_headers($response); } return $headers; } /** * Backup PHP impl. for when PECL http_parse_headers() function is not available * * @param $header * @return array * @source http://www.php.net/manual/en/function.http-parse-headers.php#77241 */ private function _http_parse_headers( $header ) { $retVal = array(); $fields = explode("\r\n", preg_replace('/\x0D\x0A[\x09\x20]+/', ' ', $header)); foreach( $fields as $field ) { if( preg_match('/([^:]+): (.+)/m', $field, $match) ) { $match[1] = preg_replace('/(?<=^|[\x09\x20\x2D])./e', 'strtoupper("\0")', strtolower(trim($match[1]))); if( isset($retVal[$match[1]]) ) { $retVal[$match[1]] = array($retVal[$match[1]], $match[2]); } else { $retVal[$match[1]] = trim($match[2]); } } } return $retVal; } /** * HTTP GET */ function http_get($uri, $data = array()) { $data = (is_array($data)) ? http_build_query($data) : $data; if (!empty($data)) { $uri .= "?$data"; } return $this->http_request('GET', $uri); } /** * HTTP PUT */ function http_put($uri, $data = array()) { return $this->http_request('PUT', $uri, $data); } /** * HTTP DELETE */ function http_delete($uri, $data = array()) { return $this->http_request('DELETE', $uri, $data); } /** * Generic implementation of a HTTP Request. * * @param $http_method * @param $uri * @param array $data * @return * an array containing json and decoded versions of the response. */ private function http_request($http_method, $uri, $data = array()) { $data = (is_array($data)) ? http_build_query($data) : $data; if (!empty($data)) { curl_setopt($this->curl, CURLOPT_HTTPHEADER, array('Content-Length: ' . strlen($data))); curl_setopt($this->curl, CURLOPT_POSTFIELDS, $data); } curl_setopt($this->curl, CURLOPT_URL, $this->get_full_url($uri)); curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, $http_method); $response = curl_exec($this->curl); $response_decoded = $this->decode_response($response); $response = array('json' => $response, 'decoded'=>$response_decoded); $this->check_status($response,$uri); return $response; } /** * Check http status for safe return codes * * @throws SetteeRestClientException */ private function check_status($response,$uri) { $resp_code = curl_getinfo($this->curl, CURLINFO_HTTP_CODE); if ($resp_code < 199 || $resp_code > 399 || !empty($response['decoded']->error)) { $msg = "CouchDB returned: \"HTTP 1.1. $resp_code\". ERROR: " . $response['json'] . $uri; throw new SetteeRestClientException($msg); } } /** * @param $path * Full path to a file (e.g. as returned by PHP's realpath function). * @return void */ public function file_mime_type ($path) { $ftype = 'application/octet-stream'; if (function_exists("finfo_file")) { $finfo = new finfo(FILEINFO_MIME_TYPE | FILEINFO_SYMLINK); $fres = $finfo->file($path); if (is_string($fres) && !empty($fres)) { $ftype = $fres; } } return $ftype; } /** * @param $content * content of a file in a string buffer format. * @return void */ public function content_mime_type ($content) { $ftype = 'application/octet-stream'; if (function_exists("finfo_file")) { $finfo = new finfo(FILEINFO_MIME_TYPE | FILEINFO_SYMLINK); $fres = $finfo->buffer($content); if (is_string($fres) && !empty($fres)) { $ftype = $fres; } } return $ftype; } /** * * @param $json * json-encoded response from CouchDB * * @return * decoded PHP object */ private function decode_response($json) { return json_decode($json); } /** * Get full URL from a partial one */ private function get_full_url($uri) { // We do not want "/", "?", "&" and "=" separators to be encoded!!! $uri = str_replace(array('%2F', '%3F', '%3D', '%26'), array('/', '?', '=', '&'), urlencode($uri)); return $this->base_url . '/' . $uri; } } class SetteeRestClientException extends Exception {} |