lib/HttpClient.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3
   4 /**
   5    Version 0.9, 6th April 2003 - Simon Willison ( http://simon.incutio.com/ )
   6    Manual: http://scripts.incutio.com/httpclient/
   7
   8    Copyright © 2003 Incutio Limited
   9    License: http://www.opensource.org/licenses/artistic-license.php
  10
  11    File upload and xmlrpc support by Reini Urban for PhpWiki, 2006-12-28 18:12:47
  12    Todo: proxy support
  13 */
  14
  15 class HttpClient {
  16     // Request vars
  17     var $host;
  18     var $port;
  19     var $path;
  20     var $method;
  21     var $postdata = '';
  22     var $cookies = array();
  23     var $referer;
  24     var $accept = 'text/xml,application/xml,application/xhtml+xml,text/html,text/plain,image/png,image/jpeg,image/gif,*/*';
  25     var $accept_encoding = 'gzip';
  26     var $accept_language = 'en-us';
  27     var $user_agent = 'Incutio HttpClient v1.0';
  28     var $boundary = "xYzZY"; // FIXME: check if this string doesn't occur in the data
  29     // Options
  30     var $timeout = 10;
  31     var $use_gzip = true;
  32     var $persist_cookies = true;  // If true, received cookies are placed in the $this->cookies array ready for the next request
  33                                   // Note: This currently ignores the cookie path (and time) completely. Time is not important,
  34                                   //       but path could possibly lead to security problems.
  35     var $persist_referers = true; // For each request, sends path of last request as referer
  36     var $debug = false;
  37     var $handle_redirects = true; // Auaomtically redirect if Location or URI header is found
  38     var $max_redirects = 5;
  39     var $headers_only = false;    // If true, stops receiving once headers have been read.
  40     // Basic authorization variables
  41     var $username;
  42     var $password;
  43     // Response vars
  44     var $status;
  45     var $headers = array();
  46     var $content = '';
  47     var $errormsg;
  48     // Tracker variables
  49     var $redirect_count = 0;
  50     var $cookie_host = '';
  51
  52     function HttpClient($host='localhost', $port=80) {
  53         $this->host = $host;
  54         $this->port = $port;
  55     }
  56     function get($path, $data = false) {
  57         $this->path = $path;
  58         $this->method = 'GET';
  59         if ($data) {
  60             $this->path .= '?'.$this->buildQueryString($data);
  61         }
  62         return $this->doRequest();
  63     }
  64     function post($path, $data) {
  65         $this->path = $path;
  66         $this->method = 'POST';
  67         $this->postdata = $this->buildQueryString($data);
  68         return $this->doRequest();
  69     }
  70     function postfile($path, $filename) {
  71         $this->path = $path;
  72         $this->method = 'POST';
  73         $boundary = $this->boundary; //"httpclient_boundary";
  74         $headers[] = "Content-Type: multipart/form-data; boundary=\"$boundary\"";
  75         $basename = basename($filename);
  76         $this->postdata =
  77             "\r\n--$boundary\r\n"
  78             ."Content-Disposition: form-data; filename=\"$basename\"\r\n"
  79             ."Content-Type: application/octet-stream\r\n\r\n";
  80         $this->postdata .= join("",file($filename));
  81         $this->postdata .= "\r\n\r\n--$boundary--\r\n";
  82         return $this->doRequest();
  83     }
  84     function buildQueryString($data) {
  85         $querystring = '';
  86         if (is_array($data)) {
  87             // Change data in to postable data
  88             foreach ($data as $key => $val) {
  89                 if (is_array($val)) {
  90                     foreach ($val as $val2) {
  91                         $querystring .= urlencode($key).'='.urlencode($val2).'&';
  92                     }
  93                 } else {
  94                     $querystring .= urlencode($key).'='.urlencode($val).'&';
  95                 }
  96             }
  97             $querystring = substr($querystring, 0, -1); // Eliminate unnecessary &
  98         } else {
  99             $querystring = $data;
 100         }
 101         return $querystring;
 102     }
 103
 104     function doRequest() {
 105         // Performs the actual HTTP request, returning true or false depending on outcome
 106         // Ensure that the PHP timeout is longer than the socket timeout
 107         longer_timeout($this->timeout);
 108         if (!$fp = @fsockopen($this->host, $this->port, $errno, $errstr, $this->timeout)) {
 109             // Set error message
 110             switch($errno) {
 111             case -3:
 112                 $this->errormsg = 'Socket creation failed (-3)';
 113             case -4:
 114                 $this->errormsg = 'DNS lookup failure (-4)';
 115             case -5:
 116                 $this->errormsg = 'Connection refused or timed out (-5)';
 117             default:
 118                 $this->errormsg = 'Connection failed ('.$errno.')';
 119                 $this->errormsg .= ' '.$errstr;
 120                 $this->debug($this->errormsg);
 121             }
 122             return false;
 123         }
 124         if (check_php_version(4,3,0))
 125             socket_set_timeout($fp, $this->timeout);
 126         if ( $this->method == 'POST' and preg_match("/\<methodCall\>/", $this->postdata))
 127             $request = $this->buildRequest("text/xml"); //xmlrpc
 128         else if ( $this->method == 'POST' and strstr("\r\nContent-Disposition: form-data; filename=",
 129                                                      $this->postdata))
 130         {
 131             //file upload
 132             $boundary = $this->boundary;
 133             $request = $this->buildRequest("multipart/form-data; boundary=\"$boundary\"");
 134         } else
 135             $request = $this->buildRequest();
 136         $this->debug('Request', $request);
 137         fwrite($fp, $request);
 138         // Reset all the variables that should not persist between requests
 139         $this->headers = array();
 140         $this->content = '';
 141         $this->errormsg = '';
 142         // Set a couple of flags
 143         $inHeaders = true;
 144         $atStart = true;
 145         // Now start reading back the response
 146         while (!feof($fp)) {
 147             $line = fgets($fp, 4096);
 148             if ($atStart) {
 149                 // Deal with first line of returned data
 150                 $atStart = false;
 151                 if (!preg_match('/HTTP\/(\\d\\.\\d)\\s*(\\d+)\\s*(.*)/', $line, $m)) {
 152                     $this->errormsg = "Status code line invalid: ".htmlentities($line);
 153                     $this->debug($this->errormsg);
 154                     return false;
 155                 }
 156                 $http_version = $m[1]; // not used
 157                 $this->status = $m[2];
 158                 $status_string = $m[3]; // not used
 159                 $this->debug(trim($line));
 160                 continue;
 161             }
 162             if ($inHeaders) {
 163                 if (trim($line) == '') {
 164                     $inHeaders = false;
 165                     $this->debug('Received Headers', $this->headers);
 166                     if ($this->headers_only) {
 167                         break; // Skip the rest of the input
 168                     }
 169                     continue;
 170                 }
 171                 if (!preg_match('/([^:]+):\\s*(.*)/', $line, $m)) {
 172                     // Skip to the next header
 173                     continue;
 174                 }
 175                 $key = strtolower(trim($m[1]));
 176                 $val = trim($m[2]);
 177                 // Deal with the possibility of multiple headers of same name
 178                 if (isset($this->headers[$key])) {
 179                     if (is_array($this->headers[$key])) {
 180                         $this->headers[$key][] = $val;
 181                     } else {
 182                         $this->headers[$key] = array($this->headers[$key], $val);
 183                     }
 184                 } else {
 185                     $this->headers[$key] = $val;
 186                 }
 187                 continue;
 188             }
 189             // We're not in the headers, so append the line to the contents
 190             $this->content .= $line;
 191         }
 192         fclose($fp);
 193         // If data is compressed, uncompress it
 194         if (isset($this->headers['content-encoding']) && $this->headers['content-encoding'] == 'gzip') {
 195             $this->debug('Content is gzip encoded, unzipping it');
 196             $this->content = substr($this->content, 10); // See http://www.php.net/manual/en/function.gzencode.php
 197             $this->content = gzinflate($this->content);
 198         }
 199         // If $persist_cookies, deal with any cookies
 200         if ($this->persist_cookies && isset($this->headers['set-cookie']) && $this->host == $this->cookie_host) {
 201             $cookies = $this->headers['set-cookie'];
 202             if (!is_array($cookies)) {
 203                 $cookies = array($cookies);
 204             }
 205             foreach ($cookies as $cookie) {
 206                 if (preg_match('/([^=]+)=([^;]+);/', $cookie, $m)) {
 207                     $this->cookies[$m[1]] = $m[2];
 208                 }
 209             }
 210             // Record domain of cookies for security reasons
 211             $this->cookie_host = $this->host;
 212         }
 213         if ($this->status == '401') {
 214             $this->errormsg = '401 ' . $status_string;
 215             return false;
 216         }
 217         // If $persist_referers, set the referer ready for the next request
 218         if (isset($this->persist_referers)) {
 219             $this->debug('Persisting referer: '.$this->getRequestURL());
 220             $this->referer = $this->getRequestURL();
 221         }
 222         // Finally, if handle_redirects and a redirect is sent, do that
 223         if (isset($this->handle_redirects)) {
 224             if (++$this->redirect_count >= $this->max_redirects) {
 225                 $this->errormsg = 'Number of redirects exceeded maximum ('.$this->max_redirects.')';
 226                 $this->debug($this->errormsg);
 227                 $this->redirect_count = 0;
 228                 return false;
 229             }
 230             $location = isset($this->headers['location']) ? $this->headers['location'] : '';
 231             $uri = isset($this->headers['uri']) ? $this->headers['uri'] : '';
 232             if ($location || $uri) {
 233                 $url = parse_url($location.$uri);
 234                 if ($this->method == 'POST')
 235                     return $this->doRequest();
 236                 else
 237                     // This will FAIL if redirect is to a different site
 238                     return $this->get($url['path']);
 239             }
 240         }
 241         return true;
 242     }
 243
 244     function buildRequest($ContentType = 'application/x-www-form-urlencoded') {
 245         $headers = array();
 246         // Using 1.1 leads to all manner of problems, such as "chunked" encoding
 247         $headers[] = "{$this->method} {$this->path} HTTP/1.0";
 248         $headers[] = "Host: {$this->host}";
 249         $headers[] = "User-Agent: {$this->user_agent}";
 250         $headers[] = "Accept: {$this->accept}";
 251         if ($this->use_gzip) {
 252             $headers[] = "Accept-encoding: {$this->accept_encoding}";
 253         }
 254         $headers[] = "Accept-language: {$this->accept_language}";
 255         if (!empty($this->referer)) {
 256             $headers[] = "Referer: {$this->referer}";
 257         }
 258         // Cookies
 259         if (!empty($this->cookies)) {
 260             $cookie = 'Cookie: ';
 261             foreach ($this->cookies as $key => $value) {
 262                 $cookie .= "$key=$value; ";
 263             }
 264             $headers[] = $cookie;
 265         }
 266         // Basic authentication
 267         if (!empty($this->username) && !empty($this->password)) {
 268             $headers[] = 'Authorization: BASIC '.base64_encode($this->username.':'.$this->password);
 269         }
 270         // If this is a POST, set the content type and length
 271         if ($this->postdata) {
 272             $headers[] = 'Content-Type: ' . $ContentType;
 273             $headers[] = 'Content-Length: '.strlen($this->postdata);
 274         }
 275         $request = implode("\r\n", $headers)."\r\n\r\n".$this->postdata;
 276         return $request;
 277     }
 278     function getStatus() {
 279         return $this->status;
 280     }
 281     function getContent() {
 282         return $this->content;
 283     }
 284     function getHeaders() {
 285         return $this->headers;
 286     }
 287     function getHeader($header) {
 288         $header = strtolower($header);
 289         if (isset($this->headers[$header])) {
 290             return $this->headers[$header];
 291         } else {
 292             return false;
 293         }
 294     }
 295     function getError() {
 296         return $this->errormsg;
 297     }
 298     function getCookies() {
 299         return $this->cookies;
 300     }
 301     function getRequestURL() {
 302         $url = 'http://'.$this->host;
 303         if ($this->port != 80) {
 304             $url = 'https://'.$this->host;
 305             $url .= ':'.$this->port;
 306         }
 307         $url .= $this->path;
 308         return $url;
 309     }
 310     // Setter methods
 311     function setUserAgent($string) {
 312         $this->user_agent = $string;
 313     }
 314     function setAuthorization($username, $password) {
 315         $this->username = $username;
 316         $this->password = $password;
 317     }
 318     function setCookies($array) {
 319         $this->cookies = $array;
 320     }
 321     // Option setting methods
 322     function useGzip($boolean) {
 323         $this->use_gzip = $boolean;
 324     }
 325     function setPersistCookies($boolean) {
 326         $this->persist_cookies = $boolean;
 327     }
 328     function setPersistReferers($boolean) {
 329         $this->persist_referers = $boolean;
 330     }
 331     function setHandleRedirects($boolean) {
 332         $this->handle_redirects = $boolean;
 333     }
 334     function setMaxRedirects($num) {
 335         $this->max_redirects = $num;
 336     }
 337     function setHeadersOnly($boolean) {
 338         $this->headers_only = $boolean;
 339     }
 340     function setDebug($boolean) {
 341         $this->debug = $boolean;
 342     }
 343     // "Quick" static methods
 344     function quickGet($url) {
 345         $bits = parse_url($url);
 346         $host = $bits['host'];
 347         $port = isset($bits['port']) ? $bits['port'] : 80;
 348         $path = isset($bits['path']) ? $bits['path'] : '/';
 349         if (isset($bits['query'])) {
 350             $path .= '?'.$bits['query'];
 351         }
 352         $client = new HttpClient($host, $port);
 353         if (!$client->get($path)) {
 354             return false;
 355         } else {
 356             return $client->getContent();
 357         }
 358     }
 359     function quickPost($url, $data) {
 360         $bits = parse_url($url);
 361         $host = $bits['host'];
 362         $port = isset($bits['port']) ? $bits['port'] : 80;
 363         $path = isset($bits['path']) ? $bits['path'] : '/';
 364         $client = new HttpClient($host, $port);
 365         if (!$client->post($path, $data)) {
 366             return false;
 367         } else {
 368             return $client->getContent();
 369         }
 370     }
 371     function debug($msg, $object = false) {
 372         if ($this->debug) {
 373             print '<div style="border: 1px solid red; padding: 0.5em; margin: 0.5em;"><strong>HttpClient Debug:</strong> '.$msg;
 374             if ($object) {
 375                 ob_start();
 376                 print_r($object);
 377                 $content = htmlentities(ob_get_contents());
 378                 ob_end_clean();
 379                 print '<pre>'.$content.'</pre>';
 380             }
 381             print '</div>';
 382         }
 383     }
 384 }
 385
 386 // For emacs users
 387 // Local Variables:
 388 // mode: php
 389 // tab-width: 8
 390 // c-basic-offset: 4
 391 // c-hanging-comment-ender-p: nil
 392 // indent-tabs-mode: nil
 393 // End:
 394 ?>