<?php
    
/**
    * o------------------------------------------------------------------------------o
    * | This package is licensed under the Phpguru license 2008. A quick summary is  |
    * | that the code is free to use for non-commercial purposes. For commercial     |
    * | purposes of any kind there is a small license fee to pay. You can read more  |
    * | at:                                                                          |
    * |                  http://www.phpguru.org/static/license.html                  |
    * o------------------------------------------------------------------------------o
    *
    * © Copyright 2008 Richard Heyes
    */

/**
 * Class for performing HTTP requests
 *
 * PHP versions 4 and 5
 */

/**
 * PEAR and PEAR_Error classes (for error handling)
 */
require_once 'PEAR.php';
/**
 * Socket class
 */
require_once 'Net/Socket.php';
/**
 * URL handling class
 */ 
require_once 'Net/URL.php';

/**#@+
 * Constants for HTTP request methods
 */ 
define('HTTP_REQUEST_METHOD_GET',     'GET',     true);
define('HTTP_REQUEST_METHOD_HEAD',    'HEAD',    true);
define('HTTP_REQUEST_METHOD_POST',    'POST',    true);
define('HTTP_REQUEST_METHOD_PUT',     'PUT',     true);
define('HTTP_REQUEST_METHOD_DELETE',  'DELETE',  true);
define('HTTP_REQUEST_METHOD_OPTIONS''OPTIONS'true);
define('HTTP_REQUEST_METHOD_TRACE',   'TRACE',   true);
/**#@-*/

/**#@+
 * Constants for HTTP request error codes
 */ 
define('HTTP_REQUEST_ERROR_FILE',             1);
define('HTTP_REQUEST_ERROR_URL',              2);
define('HTTP_REQUEST_ERROR_PROXY',            4);
define('HTTP_REQUEST_ERROR_REDIRECTS',        8);
define('HTTP_REQUEST_ERROR_RESPONSE',        16);  
define('HTTP_REQUEST_ERROR_GZIP_METHOD',     32);
define('HTTP_REQUEST_ERROR_GZIP_READ',       64);
define('HTTP_REQUEST_ERROR_GZIP_DATA',      128);
define('HTTP_REQUEST_ERROR_GZIP_CRC',       256);
/**#@-*/

/**#@+
 * Constants for HTTP protocol versions
 */
define('HTTP_REQUEST_HTTP_VER_1_0''1.0'true);
define('HTTP_REQUEST_HTTP_VER_1_1''1.1'true);
/**#@-*/

if (extension_loaded('mbstring') && (ini_get('mbstring.func_overload'))) {
   
/**
    * Whether string functions are overloaded by their mbstring equivalents 
    */
    
define('HTTP_REQUEST_MBSTRING'true);
} else {
   
/**
    * @ignore
    */
    
define('HTTP_REQUEST_MBSTRING'false);
}

/**
 * Class for performing HTTP requests
 *
 * Simple example (fetches yahoo.com and displays it):
 * <code>
 * $a = &new HTTP_Request('http://www.yahoo.com/');
 * $a->sendRequest();
 * echo $a->getResponseBody();
 * </code>
 *
 * @category    HTTP
 * @package     HTTP_Request
 * @author      Richard Heyes <richard@phpguru.org>
 * @author      Alexey Borzov <avb@php.net>
 * @version     Release: 1.4.2
 */
class HTTP_Request
{
   
/**#@+
    * @access private
    */
    /**
    * Instance of Net_URL
    * @var Net_URL
    */
    
var $_url;

    
/**
    * Type of request
    * @var string
    */
    
var $_method;

    
/**
    * HTTP Version
    * @var string
    */
    
var $_http;

    
/**
    * Request headers
    * @var array
    */
    
var $_requestHeaders;

    
/**
    * Basic Auth Username
    * @var string
    */
    
var $_user;
    
    
/**
    * Basic Auth Password
    * @var string
    */
    
var $_pass;

    
/**
    * Socket object
    * @var Net_Socket
    */
    
var $_sock;
    
    
/**
    * Proxy server
    * @var string
    */
    
var $_proxy_host;
    
    
/**
    * Proxy port
    * @var integer
    */
    
var $_proxy_port;
    
    
/**
    * Proxy username
    * @var string
    */
    
var $_proxy_user;
    
    
/**
    * Proxy password
    * @var string
    */
    
var $_proxy_pass;

    
/**
    * Post data
    * @var array
    */
    
var $_postData;

   
/**
    * Request body  
    * @var string
    */
    
var $_body;

   
/**
    * A list of methods that MUST NOT have a request body, per RFC 2616
    * @var array
    */
    
var $_bodyDisallowed = array('TRACE');

   
/**
    * Files to post 
    * @var array
    */
    
var $_postFiles = array();

    
/**
    * Connection timeout.
    * @var float
    */
    
var $_timeout;
    
    
/**
    * HTTP_Response object
    * @var HTTP_Response
    */
    
var $_response;
    
    
/**
    * Whether to allow redirects
    * @var boolean
    */
    
var $_allowRedirects;
    
    
/**
    * Maximum redirects allowed
    * @var integer
    */
    
var $_maxRedirects;
    
    
/**
    * Current number of redirects
    * @var integer
    */
    
var $_redirects;

   
/**
    * Whether to append brackets [] to array variables
    * @var bool
    */
    
var $_useBrackets true;

   
/**
    * Attached listeners
    * @var array
    */
    
var $_listeners = array();

   
/**
    * Whether to save response body in response object property  
    * @var bool
    */
    
var $_saveBody true;

   
/**
    * Timeout for reading from socket (array(seconds, microseconds))
    * @var array
    */
    
var $_readTimeout null;

   
/**
    * Options to pass to Net_Socket::connect. See stream_context_create
    * @var array
    */
    
var $_socketOptions null;
   
/**#@-*/

    /**
    * Constructor
    *
    * Sets up the object
    * @param    string  The url to fetch/access
    * @param    array   Associative array of parameters which can have the following keys:
    * <ul>
    *   <li>method         - Method to use, GET, POST etc (string)</li>
    *   <li>http           - HTTP Version to use, 1.0 or 1.1 (string)</li>
    *   <li>user           - Basic Auth username (string)</li>
    *   <li>pass           - Basic Auth password (string)</li>
    *   <li>proxy_host     - Proxy server host (string)</li>
    *   <li>proxy_port     - Proxy server port (integer)</li>
    *   <li>proxy_user     - Proxy auth username (string)</li>
    *   <li>proxy_pass     - Proxy auth password (string)</li>
    *   <li>timeout        - Connection timeout in seconds (float)</li>
    *   <li>allowRedirects - Whether to follow redirects or not (bool)</li>
    *   <li>maxRedirects   - Max number of redirects to follow (integer)</li>
    *   <li>useBrackets    - Whether to append [] to array variable names (bool)</li>
    *   <li>saveBody       - Whether to save response body in response object property (bool)</li>
    *   <li>readTimeout    - Timeout for reading / writing data over the socket (array (seconds, microseconds))</li>
    *   <li>socketOptions  - Options to pass to Net_Socket object (array)</li>
    * </ul>
    * @access public
    */
    
function HTTP_Request($url ''$params = array())
    {
        
$this->_method         =  HTTP_REQUEST_METHOD_GET;
        
$this->_http           =  HTTP_REQUEST_HTTP_VER_1_1;
        
$this->_requestHeaders = array();
        
$this->_postData       = array();
        
$this->_body           null;

        
$this->_user null;
        
$this->_pass null;

        
$this->_proxy_host null;
        
$this->_proxy_port null;
        
$this->_proxy_user null;
        
$this->_proxy_pass null;

        
$this->_allowRedirects false;
        
$this->_maxRedirects   3;
        
$this->_redirects      0;

        
$this->_timeout  null;
        
$this->_response null;

        foreach (
$params as $key => $value) {
            
$this->{'_' $key} = $value;
        }

        if (!empty(
$url)) {
            
$this->setURL($url);
        }

        
// Default useragent
        
$this->addHeader('User-Agent''PEAR HTTP_Request class ( http://pear.php.net/ )');

        
// We don't do keep-alives by default
        
$this->addHeader('Connection''close');

        
// Basic authentication
        
if (!empty($this->_user)) {
            
$this->addHeader('Authorization''Basic ' base64_encode($this->_user ':' $this->_pass));
        }

        
// Proxy authentication (see bug #5913)
        
if (!empty($this->_proxy_user)) {
            
$this->addHeader('Proxy-Authorization''Basic ' base64_encode($this->_proxy_user ':' $this->_proxy_pass));
        }

        
// Use gzip encoding if possible
        
if (HTTP_REQUEST_HTTP_VER_1_1 == $this->_http && extension_loaded('zlib')) {
            
$this->addHeader('Accept-Encoding''gzip');
        }
    }
    
    
/**
    * Generates a Host header for HTTP/1.1 requests
    *
    * @access private
    * @return string
    */
    
function _generateHostHeader()
    {
        if (
$this->_url->port != 80 AND strcasecmp($this->_url->protocol'http') == 0) {
            
$host $this->_url->host ':' $this->_url->port;

        } elseif (
$this->_url->port != 443 AND strcasecmp($this->_url->protocol'https') == 0) {
            
$host $this->_url->host ':' $this->_url->port;

        } elseif (
$this->_url->port == 443 AND strcasecmp($this->_url->protocol'https') == AND strpos($this->_url->url':443') !== false) {
            
$host $this->_url->host ':' $this->_url->port;
        
        } else {
            
$host $this->_url->host;
        }

        return 
$host;
    }
    
    
/**
    * Resets the object to its initial state (DEPRECATED).
    * Takes the same parameters as the constructor.
    *
    * @param  string $url    The url to be requested
    * @param  array  $params Associative array of parameters
    *                        (see constructor for details)
    * @access public
    * @deprecated deprecated since 1.2, call the constructor if this is necessary
    */
    
function reset($url$params = array())
    {
        
$this->HTTP_Request($url$params);
    }

    
/**
    * Sets the URL to be requested
    *
    * @param  string The url to be requested
    * @access public
    */
    
function setURL($url)
    {
        
$this->_url = &new Net_URL($url$this->_useBrackets);

        if (!empty(
$this->_url->user) || !empty($this->_url->pass)) {
            
$this->setBasicAuth($this->_url->user$this->_url->pass);
        }

        if (
HTTP_REQUEST_HTTP_VER_1_1 == $this->_http) {
            
$this->addHeader('Host'$this->_generateHostHeader());
        }

        
// set '/' instead of empty path rather than check later (see bug #8662)
        
if (empty($this->_url->path)) {
            
$this->_url->path '/';
        } 
    }
    
   
/**
    * Returns the current request URL  
    *
    * @return   string  Current request URL
    * @access   public
    */
    
function getUrl()
    {
        return empty(
$this->_url)? ''$this->_url->getUrl();
    }

    
/**
    * Sets a proxy to be used
    *
    * @param string     Proxy host
    * @param int        Proxy port
    * @param string     Proxy username
    * @param string     Proxy password
    * @access public
    */
    
function setProxy($host$port 8080$user null$pass null)
    {
        
$this->_proxy_host $host;
        
$this->_proxy_port $port;
        
$this->_proxy_user $user;
        
$this->_proxy_pass $pass;

        if (!empty(
$user)) {
            
$this->addHeader('Proxy-Authorization''Basic ' base64_encode($user ':' $pass));
        }
    }

    
/**
    * Sets basic authentication parameters
    *
    * @param string     Username
    * @param string     Password
    */
    
function setBasicAuth($user$pass)
    {
        
$this->_user $user;
        
$this->_pass $pass;

        
$this->addHeader('Authorization''Basic ' base64_encode($user ':' $pass));
    }

    
/**
    * Sets the method to be used, GET, POST etc.
    *
    * @param string     Method to use. Use the defined constants for this
    * @access public
    */
    
function setMethod($method)
    {
        
$this->_method $method;
    }

    
/**
    * Sets the HTTP version to use, 1.0 or 1.1
    *
    * @param string     Version to use. Use the defined constants for this
    * @access public
    */
    
function setHttpVer($http)
    {
        
$this->_http $http;
    }

    
/**
    * Adds a request header
    *
    * @param string     Header name
    * @param string     Header value
    * @access public
    */
    
function addHeader($name$value)
    {
        
$this->_requestHeaders[strtolower($name)] = $value;
    }

    
/**
    * Removes a request header
    *
    * @param string     Header name to remove
    * @access public
    */
    
function removeHeader($name)
    {
        if (isset(
$this->_requestHeaders[strtolower($name)])) {
            unset(
$this->_requestHeaders[strtolower($name)]);
        }
    }

    
/**
    * Adds a querystring parameter
    *
    * @param string     Querystring parameter name
    * @param string     Querystring parameter value
    * @param bool       Whether the value is already urlencoded or not, default = not
    * @access public
    */
    
function addQueryString($name$value$preencoded false)
    {
        
$this->_url->addQueryString($name$value$preencoded);
    }    
    
    
/**
    * Sets the querystring to literally what you supply
    *
    * @param string     The querystring data. Should be of the format foo=bar&x=y etc
    * @param bool       Whether data is already urlencoded or not, default = already encoded
    * @access public
    */
    
function addRawQueryString($querystring$preencoded true)
    {
        
$this->_url->addRawQueryString($querystring$preencoded);
    }

    
/**
    * Adds postdata items
    *
    * @param string     Post data name
    * @param string     Post data value
    * @param bool       Whether data is already urlencoded or not, default = not
    * @access public
    */
    
function addPostData($name$value$preencoded false)
    {
        if (
$preencoded) {
            
$this->_postData[$name] = $value;
        } else {
            
$this->_postData[$name] = $this->_arrayMapRecursive('urlencode'$value);
        }
    }

   
/**
    * Recursively applies the callback function to the value
    * 
    * @param    mixed   Callback function
    * @param    mixed   Value to process
    * @access   private
    * @return   mixed   Processed value
    */
    
function _arrayMapRecursive($callback$value)
    {
        if (!
is_array($value)) {
            return 
call_user_func($callback$value);
        } else {
            
$map = array();
            foreach (
$value as $k => $v) {
                
$map[$k] = $this->_arrayMapRecursive($callback$v);
            }
            return 
$map;
        }
    }

   
/**
    * Adds a file to upload
    * 
    * This also changes content-type to 'multipart/form-data' for proper upload
    * 
    * @access public
    * @param  string    name of file-upload field
    * @param  mixed     file name(s)
    * @param  mixed     content-type(s) of file(s) being uploaded
    * @return bool      true on success
    * @throws PEAR_Error
    */
    
function addFile($inputName$fileName$contentType 'application/octet-stream')
    {
        if (!
is_array($fileName) && !is_readable($fileName)) {
            return 
PEAR::raiseError("File '{$fileName}' is not readable"HTTP_REQUEST_ERROR_FILE);
        } elseif (
is_array($fileName)) {
            foreach (
$fileName as $name) {
                if (!
is_readable($name)) {
                    return 
PEAR::raiseError("File '{$name}' is not readable"HTTP_REQUEST_ERROR_FILE);
                }
            }
        }
        
$this->addHeader('Content-Type''multipart/form-data');
        
$this->_postFiles[$inputName] = array(
            
'name' => $fileName,
            
'type' => $contentType
        
);
        return 
true;
    }

    
/**
    * Adds raw postdata (DEPRECATED)
    *
    * @param string     The data
    * @param bool       Whether data is preencoded or not, default = already encoded
    * @access public
    * @deprecated       deprecated since 1.3.0, method setBody() should be used instead
    */
    
function addRawPostData($postdata$preencoded true)
    {
        
$this->_body $preencoded $postdata urlencode($postdata);
    }

   
/**
    * Sets the request body (for POST, PUT and similar requests)
    *
    * @param    string  Request body
    * @access   public
    */
    
function setBody($body)
    {
        
$this->_body $body;
    }

    
/**
    * Clears any postdata that has been added (DEPRECATED). 
    * 
    * Useful for multiple request scenarios.
    *
    * @access public
    * @deprecated deprecated since 1.2
    */
    
function clearPostData()
    {
        
$this->_postData null;
    }

    
/**
    * Appends a cookie to "Cookie:" header
    * 
    * @param string $name cookie name
    * @param string $value cookie value
    * @access public
    */
    
function addCookie($name$value)
    {
        
$cookies = isset($this->_requestHeaders['cookie']) ? $this->_requestHeaders['cookie']. '; ' '';
        
$this->addHeader('Cookie'$cookies $name '=' $value);
    }
    
    
/**
    * Clears any cookies that have been added (DEPRECATED). 
    * 
    * Useful for multiple request scenarios
    *
    * @access public
    * @deprecated deprecated since 1.2
    */
    
function clearCookies()
    {
        
$this->removeHeader('Cookie');
    }

    
/**
    * Sends the request
    *
    * @access public
    * @param  bool   Whether to store response body in Response object property,
    *                set this to false if downloading a LARGE file and using a Listener
    * @return mixed  PEAR error on error, true otherwise
    */
    
function sendRequest($saveBody true)
    {
        if (!
is_a($this->_url'Net_URL')) {
            return 
PEAR::raiseError('No URL given'HTTP_REQUEST_ERROR_URL);
        }

        
$host = isset($this->_proxy_host) ? $this->_proxy_host $this->_url->host;
        
$port = isset($this->_proxy_port) ? $this->_proxy_port $this->_url->port;

        
// 4.3.0 supports SSL connections using OpenSSL. The function test determines
        // we running on at least 4.3.0
        
if (strcasecmp($this->_url->protocol'https') == AND function_exists('file_get_contents') AND extension_loaded('openssl')) {
            if (isset(
$this->_proxy_host)) {
                return 
PEAR::raiseError('HTTPS proxies are not supported'HTTP_REQUEST_ERROR_PROXY);
            }
            
$host 'ssl://' $host;
        }

        
// magic quotes may fuck up file uploads and chunked response processing
        
$magicQuotes ini_get('magic_quotes_runtime');
        
ini_set('magic_quotes_runtime'false);

        
// RFC 2068, section 19.7.1: A client MUST NOT send the Keep-Alive 
        // connection token to a proxy server...
        
if (isset($this->_proxy_host) && !empty($this->_requestHeaders['connection']) &&
            
'Keep-Alive' == $this->_requestHeaders['connection'])
        {
            
$this->removeHeader('connection');
        }

        
$keepAlive = (HTTP_REQUEST_HTTP_VER_1_1 == $this->_http && empty($this->_requestHeaders['connection'])) ||
                     (!empty(
$this->_requestHeaders['connection']) && 'Keep-Alive' == $this->_requestHeaders['connection']);
        
$sockets   = &PEAR::getStaticProperty('HTTP_Request''sockets');
        
$sockKey   $host ':' $port;
        unset(
$this->_sock);

        
// There is a connected socket in the "static" property?
        
if ($keepAlive && !empty($sockets[$sockKey]) &&
            !empty(
$sockets[$sockKey]->fp)) 
        {
            
$this->_sock =& $sockets[$sockKey];
            
$err null;
        } else {
            
$this->_notify('connect');
            
$this->_sock =& new Net_Socket();
            
$err $this->_sock->connect($host$portnull$this->_timeout$this->_socketOptions);
        }
        
PEAR::isError($err) or $err $this->_sock->write($this->_buildRequest());

        if (!
PEAR::isError($err)) {
            if (!empty(
$this->_readTimeout)) {
                
$this->_sock->setTimeout($this->_readTimeout[0], $this->_readTimeout[1]);
            }

            
$this->_notify('sentRequest');

            
// Read the response
            
$this->_response = &new HTTP_Response($this->_sock$this->_listeners);
            
$err $this->_response->process(
                
$this->_saveBody && $saveBody,
                
HTTP_REQUEST_METHOD_HEAD != $this->_method
            
);

            if (
$keepAlive) {
                
$keepAlive = (isset($this->_response->_headers['content-length'])
                              || (isset(
$this->_response->_headers['transfer-encoding'])
                                  && 
strtolower($this->_response->_headers['transfer-encoding']) == 'chunked'));
                if (
$keepAlive) {
                    if (isset(
$this->_response->_headers['connection'])) {
                        
$keepAlive strtolower($this->_response->_headers['connection']) == 'keep-alive';
                    } else {
                        
$keepAlive 'HTTP/'.HTTP_REQUEST_HTTP_VER_1_1 == $this->_response->_protocol;
                    }
                }
            }
        }

        
ini_set('magic_quotes_runtime'$magicQuotes);

        if (
PEAR::isError($err)) {
            return 
$err;
        }

        if (!
$keepAlive) {
            
$this->disconnect();
        
// Store the connected socket in "static" property
        
} elseif (empty($sockets[$sockKey]) || empty($sockets[$sockKey]->fp)) {
            
$sockets[$sockKey] =& $this->_sock;
        }

        
// Check for redirection
        
if (    $this->_allowRedirects
            
AND $this->_redirects <= $this->_maxRedirects
            
AND $this->getResponseCode() > 300
            
AND $this->getResponseCode() < 399
            
AND !empty($this->_response->_headers['location'])) {

            
            
$redirect $this->_response->_headers['location'];

            
// Absolute URL
            
if (preg_match('/^https?:\/\//i'$redirect)) {
                
$this->_url = &new Net_URL($redirect);
                
$this->addHeader('Host'$this->_generateHostHeader());
            
// Absolute path
            
} elseif ($redirect{0} == '/') {
                
$this->_url->path $redirect;
            
            
// Relative path
            
} elseif (substr($redirect03) == '../' OR substr($redirect02) == './') {
                if (
substr($this->_url->path, -1) == '/') {
                    
$redirect $this->_url->path $redirect;
                } else {
                    
$redirect dirname($this->_url->path) . '/' $redirect;
                }
                
$redirect Net_URL::resolvePath($redirect);
                
$this->_url->path $redirect;
                
            
// Filename, no path
            
} else {
                if (
substr($this->_url->path, -1) == '/') {
                    
$redirect $this->_url->path $redirect;
                } else {
                    
$redirect dirname($this->_url->path) . '/' $redirect;
                }
                
$this->_url->path $redirect;
            }

            
$this->_redirects++;
            return 
$this->sendRequest($saveBody);

        
// Too many redirects
        
} elseif ($this->_allowRedirects AND $this->_redirects $this->_maxRedirects) {
            return 
PEAR::raiseError('Too many redirects'HTTP_REQUEST_ERROR_REDIRECTS);
        }

        return 
true;
    }

    
/**
     * Disconnect the socket, if connected. Only useful if using Keep-Alive.
     *
     * @access public
     */
    
function disconnect()
    {
        if (!empty(
$this->_sock) && !empty($this->_sock->fp)) {
            
$this->_notify('disconnect');
            
$this->_sock->disconnect();
        }
    }

    
/**
    * Returns the response code
    *
    * @access public
    * @return mixed     Response code, false if not set
    */
    
function getResponseCode()
    {
        return isset(
$this->_response->_code) ? $this->_response->_code false;
    }

 &nb