Zend_Http_Client_Adapter_Proxy Class Reference

Inheritance diagram for Zend_Http_Client_Adapter_Proxy:

Public Member Functions
	connect ($host, $port=80, $secure=false)
	write ( $method, $uri, $http_ver='1.1', $headers=array(), $body='')
	close ()
	__destruct ()
Public Member Functions inherited from Zend_Http_Client_Adapter_Socket
	__construct ()
	setConfig ($config=array())
	getConfig ()
	setStreamContext ($context)
	getStreamContext ()
	connect ($host, $port=80, $secure=false)
	write ($method, $uri, $http_ver='1.1', $headers=array(), $body='')
	read ()
	close ()
	setOutputStream ($stream)
	__destruct ()

Protected Member Functions
	connectHandshake ( $host, $port=443, $http_ver='1.1', array &$headers=array())
Protected Member Functions inherited from Zend_Http_Client_Adapter_Socket
	_checkSocketReadTimeout ()

Protected Attributes
	$config
	$negotiated = false
	$connectHandshakeRequest
Protected Attributes inherited from Zend_Http_Client_Adapter_Socket
	$socket = null
	$connected_to = array(null, null)
	$out_stream = null
	$config
	$method = null
	$_context = null

Detailed Description

Definition at line 52 of file Proxy.php.

Constructor & Destructor Documentation

__destruct()

__destruct

(

)

Destructor: make sure the socket is disconnected

Definition at line 335 of file Proxy.php.

    {
        if ($this->socket) {
            $this->close();
        }
    }

Member Function Documentation

close()

close

(

)

Close the connection to the server

Implements Zend_Http_Client_Adapter_Interface.

Definition at line 325 of file Proxy.php.

    {
        parent::close();
        $this->negotiated = false;
    }

connect()

connect	(		$host,
			$port = 80,
			$secure = false
	)

Connect to the remote server

Will try to connect to the proxy server. If no proxy was set, will fall back to the target server (behave like regular Socket adapter)

Parameters

string	$host
int	$port
boolean	$secure

Implements Zend_Http_Client_Adapter_Interface.

Definition at line 96 of file Proxy.php.

    {
        // If no proxy is set, fall back to Socket adapter
        if (!$this->config['proxy_host']) {
            return parent::connect($host, $port, $secure);
        }

        /* Url might require stream context even if proxy connection doesn't */
        if ($secure) {
            $this->config['sslusecontext'] = true;
        }

        // Connect (a non-secure connection) to the proxy server
        return parent::connect(
            $this->config['proxy_host'],
            $this->config['proxy_port'],
            false
        );
    }

connectHandshake()

connectHandshake (   $host,   $port = 443,   $http_ver = '1.1', array &  $headers = array()  )

protected

Preform handshaking with HTTPS proxy using CONNECT method

Parameters

string	$host
integer	$port
string	$http_ver
array	$headers

Returns

void

Exceptions

Zend_Http_Client_Adapter_Exception

Definition at line 242 of file Proxy.php.

    {
        $request = "CONNECT $host:$port HTTP/$http_ver\r\n" .
                   "Host: " . $host . "\r\n";

        // Process provided headers, including important ones to CONNECT request
        foreach ($headers as $k => $v) {
            switch (strtolower(substr($v,0,strpos($v,':')))) {
                case 'proxy-authorization':
                    // break intentionally omitted

                case 'user-agent':
                    $request .= $v . "\r\n";
                    break;

                default:
                    break;
            }
        }
        $request .= "\r\n";

        // @see ZF-3189
        $this->connectHandshakeRequest = $request;

        // Send the request
        if (!@fwrite($this->socket, $request)) {
            #require_once 'Zend/Http/Client/Adapter/Exception.php';
            throw new Zend_Http_Client_Adapter_Exception(
                'Error writing request to proxy server'
            );
        }

        // Read response headers only
        $response = '';
        $gotStatus = false;
        while ($line = @fgets($this->socket)) {
            $gotStatus = $gotStatus || (strpos($line, 'HTTP') !== false);
            if ($gotStatus) {
                $response .= $line;
                if (!chop($line)) {
                    break;
                }
            }
        }

        // Check that the response from the proxy is 200
        if (Zend_Http_Response::extractCode($response) != 200) {
            #require_once 'Zend/Http/Client/Adapter/Exception.php';
            throw new Zend_Http_Client_Adapter_Exception(
                'Unable to connect to HTTPS proxy. Server response: ' . $response
            );
        }

        // If all is good, switch socket to secure mode. We have to fall back
        // through the different modes
        $modes = array(
            // TODO: Add STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT in the future when it is supported by PHP
            STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT
        );

        $success = false;
        foreach($modes as $mode) {
            $success = stream_socket_enable_crypto($this->socket, true, $mode);
            if ($success) {
                break;
            }
        }

        if (!$success) {
            #require_once 'Zend/Http/Client/Adapter/Exception.php';
            throw new Zend_Http_Client_Adapter_Exception(
                'Unable to connect to HTTPS server through proxy: could not '
                . 'negotiate secure connection.'
            );
        }
    }

write()

write	(		$method,
			$uri,
			$http_ver = '1.1',
			$headers = array(),
			$body = ''
	)

Send request to the proxy server

Parameters

string	$method
Zend_Uri_Http	$uri
string	$http_ver
array	$headers
string	$body

Returns

string Request as string

Exceptions

Zend_Http_Client_Adapter_Exception

Implements Zend_Http_Client_Adapter_Interface.

Definition at line 127 of file Proxy.php.

    {
        // If no proxy is set, fall back to default Socket adapter
        if (!$this->config['proxy_host']) {
            return parent::write($method, $uri, $http_ver, $headers, $body);
        }

        // Make sure we're properly connected
        if (!$this->socket) {
            #require_once 'Zend/Http/Client/Adapter/Exception.php';
            throw new Zend_Http_Client_Adapter_Exception(
                'Trying to write but we are not connected'
            );
        }

        $host = $this->config['proxy_host'];
        $port = $this->config['proxy_port'];

        if ($this->connected_to[0] != "tcp://$host"
            || $this->connected_to[1] != $port
        ) {
            #require_once 'Zend/Http/Client/Adapter/Exception.php';
            throw new Zend_Http_Client_Adapter_Exception(
                'Trying to write but we are connected to the wrong proxy server'
            );
        }

        // Add Proxy-Authorization header
        if ($this->config['proxy_user']) {
            // Check to see if one already exists
            $hasProxyAuthHeader = false;
            foreach ($headers as $k => $v) {
                if ((string) $k == 'proxy-authorization'
                    || preg_match("/^proxy-authorization:/i", $v)
                ) {
                    $hasProxyAuthHeader = true;
                    break;
                }
            }
            if (!$hasProxyAuthHeader) {
                $headers[] = 'Proxy-authorization: '
                    . Zend_Http_Client::encodeAuthHeader(
                        $this->config['proxy_user'],
                        $this->config['proxy_pass'], $this->config['proxy_auth']
                    );
            }
        }

        // if we are proxying HTTPS, preform CONNECT handshake with the proxy
        if ($uri->getScheme() == 'https' && (!$this->negotiated)) {
            $this->connectHandshake(
                $uri->getHost(), $uri->getPort(), $http_ver, $headers
            );
            $this->negotiated = true;
        }

        // Save request method for later
        $this->method = $method;

        // Build request headers
        if ($this->negotiated) {
            $path = $uri->getPath();
            if ($uri->getQuery()) {
                $path .= '?' . $uri->getQuery();
            }
            $request = "$method $path HTTP/$http_ver\r\n";
        } else {
            $request = "$method $uri HTTP/$http_ver\r\n";
        }

        // Add all headers to the request string
        foreach ($headers as $k => $v) {
            if (is_string($k)) $v = "$k: $v";
            $request .= "$v\r\n";
        }

        if(is_resource($body)) {
            $request .= "\r\n";
        } else {
            // Add the request body
            $request .= "\r\n" . $body;
        }

        // Send the request
        if (!@fwrite($this->socket, $request)) {
            #require_once 'Zend/Http/Client/Adapter/Exception.php';
            throw new Zend_Http_Client_Adapter_Exception(
                'Error writing request to proxy server'
            );
        }

        if(is_resource($body)) {
            if(stream_copy_to_stream($body, $this->socket) == 0) {
                #require_once 'Zend/Http/Client/Adapter/Exception.php';
                throw new Zend_Http_Client_Adapter_Exception(
                    'Error writing request to server'
                );
            }
        }

        return $request;
    }

Field Documentation

$config

$config

protected

Initial value:

= array(
        'ssltransport'  => 'ssl',
        'sslcert'       => null,
        'sslpassphrase' => null,
        'sslusecontext' => false,
        'proxy_host'    => '',
        'proxy_port'    => 8080,
        'proxy_user'    => '',
        'proxy_pass'    => '',
        'proxy_auth'    => Zend_Http_Client::AUTH_BASIC,
        'persistent'    => false,
    )

Definition at line 59 of file Proxy.php.

$connectHandshakeRequest

$connectHandshakeRequest

protected

Definition at line 84 of file Proxy.php.

$negotiated

$negotiated = false

protected

Definition at line 77 of file Proxy.php.

---

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

• vendor/magento/zendframework1/library/Zend/Http/Client/Adapter/Proxy.php