PEAR_Proxy Class Reference

Public Member Functions
	__construct ($config=null)
	_httpConnect ($fp, $host, $port)
	_parseProxyInfo ()
	getProxyAuth ()
	getProxyUser ()
	isProxyConfigured ()
	openSocket ($host, $port, $secure=false)

Data Fields
	$config = null
	$proxy_host
	$proxy_pass
	$proxy_port
	$proxy_schema
	$proxy_user

Detailed Description

Definition at line 15 of file Proxy.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$config = null

)

Definition at line 40 of file Proxy.php.

    {
        $this->config = $config;
        $this->_parseProxyInfo();
    }

References $config, and _parseProxyInfo().

Here is the call graph for this function:

Member Function Documentation

_httpConnect()

_httpConnect	(		$fp,
			$host,
			$port )

@access private

Definition at line 67 of file Proxy.php.

    {
        fwrite($fp, "CONNECT $host:$port HTTP/1.1\r\n");
        fwrite($fp, "Host: $host:$port\r\n");
        if ($this->getProxyAuth()) {
            fwrite($fp, 'Proxy-Authorization: Basic ' . $this->getProxyAuth() . "\r\n");
        }
        fwrite($fp, "\r\n");
 
        while ($line = trim(fgets($fp, 1024))) {
            if (preg_match('|^HTTP/1.[01] ([0-9]{3}) |', $line, $matches)) {
                $code = (int)$matches[1];
 
                /* as per RFC 2817 */
                if ($code < 200 || $code >= 300) {
                    return PEAR::raiseError("Establishing a CONNECT tunnel through proxy failed with response code $code");
                }
            }
        }
 
        // connection was successful -- establish SSL through
        // the tunnel
        $crypto_method = STREAM_CRYPTO_METHOD_TLS_CLIENT;
 
        if (defined('STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT')) {
            $crypto_method |= STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT;
            $crypto_method |= STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT;
        }
 
        // set the correct hostname for working hostname
        // verification
        stream_context_set_option($fp, 'ssl', 'peer_name', $host);
 
        // blocking socket needed for
        // stream_socket_enable_crypto()
        // see
        // <http://php.net/manual/en/function.stream-socket-enable-crypto.php>
        stream_set_blocking ($fp, true);
        $crypto_res = stream_socket_enable_crypto($fp, true, $crypto_method);
        if (!$crypto_res) {
            return PEAR::raiseError("Could not establish SSL connection through proxy: $crypto_res");
        }
 
        return true;
    }

References $port, and getProxyAuth().

Referenced by openSocket().

Here is the call graph for this function:

Here is the caller graph for this function:

_parseProxyInfo()

_parseProxyInfo

(

)

@access private

Definition at line 49 of file Proxy.php.

    {
        $this->proxy_host = $this->proxy_port = $this->proxy_user = $this->proxy_pass = '';
        if ($this->config->get('http_proxy')&&
              $proxy = parse_url($this->config->get('http_proxy'))
        ) {
            $this->proxy_host = isset($proxy['host']) ? $proxy['host'] : null;
 
            $this->proxy_port   = isset($proxy['port']) ? $proxy['port'] : 8080;
            $this->proxy_user   = isset($proxy['user']) ? urldecode($proxy['user']) : null;
            $this->proxy_pass   = isset($proxy['pass']) ? urldecode($proxy['pass']) : null;
            $this->proxy_schema = (isset($proxy['scheme']) && $proxy['scheme'] == 'https') ? 'https' : 'http';
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

getProxyAuth()

getProxyAuth

(

)

get the authorization information for the proxy, encoded to be passed in the Proxy-Authentication HTTP header.

Returns

null|string the encoded authentication information if a proxy and authentication is configured, null otherwise.

Definition at line 120 of file Proxy.php.

    {
        if ($this->isProxyConfigured() && $this->proxy_user != '') {
            return base64_encode($this->proxy_user . ':' . $this->proxy_pass);
        }
        return null;
    }

References isProxyConfigured().

Referenced by _httpConnect().

Here is the call graph for this function:

Here is the caller graph for this function:

getProxyUser()

getProxyUser

(

)

Definition at line 128 of file Proxy.php.

    {
        return $this->proxy_user;
    }

References $proxy_user.

isProxyConfigured()

isProxyConfigured

(

)

Check if we are configured to use a proxy.

Returns

boolean true if we are configured to use a proxy, false otherwise. @access public

Definition at line 140 of file Proxy.php.

    {
        return $this->proxy_host != '';
    }

Referenced by getProxyAuth(), and openSocket().

Here is the caller graph for this function:

openSocket()

openSocket	(		$host,
			$port,
			$secure = false )

Open a socket to a remote server, possibly involving a HTTP proxy.

If an HTTP proxy has been configured (http_proxy PEAR_Config setting), the proxy will be used.

Parameters

string	$host	the host to connect to
string	$port	the port to connect to
boolean	$secure	if true, establish a secure connection using TLS. @access public

Definition at line 158 of file Proxy.php.

    {
        if ($this->isProxyConfigured()) {
            $fp = @fsockopen(
                $this->proxy_host, $this->proxy_port, 
                $errno, $errstr, 15
            );
 
            if (!$fp) {
                return PEAR::raiseError("Connection to the proxy failed: $errstr", -9276);
            }
 
            /* HTTPS is to be used and we have a proxy, use CONNECT verb */
            if ($secure) {
                $res = $this->_httpConnect($fp, $host, $port);
 
                if (PEAR::isError($res)) {
                    return $res;
                }
            }
        } else {
            if ($secure) {
                $host = 'ssl://' . $host;
            }
 
            $fp = @fsockopen($host, $port, $errno, $errstr);
            if (!$fp) {
                return PEAR::raiseError("Connection to `$host:$port' failed: $errstr", $errno);
            }
        }
 
        return $fp;
    }

References $port, _httpConnect(), and isProxyConfigured().

Here is the call graph for this function:

Field Documentation

$config

$config = null

Definition at line 17 of file Proxy.php.

Referenced by __construct().

$proxy_host

$proxy_host

@access private

Definition at line 22 of file Proxy.php.

$proxy_pass

$proxy_pass

@access private

Definition at line 34 of file Proxy.php.

$proxy_port

$proxy_port

@access private

Definition at line 26 of file Proxy.php.

$proxy_schema

$proxy_schema

@access private

Definition at line 38 of file Proxy.php.

$proxy_user

$proxy_user

@access private

Definition at line 30 of file Proxy.php.

Referenced by getProxyUser().

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/PEAR/Proxy.php