AfriCC\EPP\HTTPClient

Complexity

Total Complexity

26

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	2
A	prepareCookieJar()	0	17	4
A	__destruct()	0	4	1
A	setupCurl()	0	15	3
A	setupCurlOpts()	0	19	1
A	setupCurlSSL()	0	18	5
A	connect()	0	13	1
A	close()	0	11	2
A	send()	0	7	1
A	request()	0	18	3
A	log()	0	6	2
A	active()	0	4	1

<?php

namespace AfriCC\EPP;

use AfriCC\EPP\Frame\Command\Logout as LogoutCommand;
use AfriCC\EPP\Frame\ResponseFactory;

/**
 * A high level HTTP(S) based client for the Extensible Provisioning Protocol (EPP)
 *
 * @see http://tools.ietf.org/html/rfc5734
 *
 * As this class deals directly with cURL it's untestable
 * @codeCoverageIgnore
 */
class HTTPClient extends AbstractClient implements ClientInterface
{
    protected $curl;
    protected $cookiejar;

    public function __construct(array $config)
    {
        parent::__construct($config);

        $proto = \parse_url($this->host, PHP_URL_SCHEME);
        if ($proto == 'https') {
            $this->ssl = true;
        } else {
            $this->ssl = false;
        }

        $this->prepareCookieJar($config);
    }

    protected function prepareCookieJar(array $config)
    {
        if (!empty($config['cookiejar'])) {
            $this->cookiejar = $config['cookiejar'];
        } else {
            $this->cookiejar = tempnam(sys_get_temp_dir(), 'ehc');
        }

        if (!is_readable($this->cookiejar) || !is_writable($this->cookiejar)) {
            throw new \Exception(
                sprintf(
                    'unable to read/write cookiejar: %s',
                    $this->cookiejar
                    )
                );
        }
    }

    public function __destruct()
    {
        $this->close();
    }

    private function setupCurl()
    {
        $this->curl = curl_init($this->host);

        if ($this->curl === false) {
            throw new \Exception('Cannot initialize cURL extension');
        }

        $this->setupCurlOpts();

        // certs
        if ($this->ssl) {
            $this->setupCurlSSL();
        }
    }

    private function setupCurlOpts()
    {
        // set stream time out
        curl_setopt($this->curl, CURLOPT_TIMEOUT, $this->timeout);
        curl_setopt(
            $this->curl,
            CURLOPT_CONNECTTIMEOUT,
            $this->connect_timeout
            );

        // set necessary options
        curl_setopt($this->curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($this->curl, CURLOPT_FOLLOWLOCATION, true);
        curl_setopt($this->curl, CURLOPT_HEADER, false);

        // cookies
        curl_setopt($this->curl, CURLOPT_COOKIEFILE, $this->cookiejar);
        curl_setopt($this->curl, CURLOPT_COOKIEJAR, $this->cookiejar);
    }

    private function setupCurlSSL()
    {
        curl_setopt($this->curl, CURLOPT_SSL_VERIFYPEER, true);
        curl_setopt($this->curl, CURLOPT_SSLKEYTYPE, 'PEM');

        if ($this->ca_cert) {
            curl_setopt($this->curl, CURLOPT_CAINFO, $this->ca_cert);
        }
        if ($this->pk_cert) {
            curl_setopt($this->curl, CURLOPT_SSLKEY, $this->pk_cert);
        }
        if ($this->local_cert) {
            curl_setopt($this->curl, CURLOPT_SSLCERT, $this->local_cert);
        }
        if ($this->passphrase) {
            curl_setopt($this->curl, CURLOPT_SSLCERTPASSWD, $this->passphrase);
        }
    }

    /**
     * Open a new connection to the EPP server
     *
     * @param bool|string $newPassword String with new password to set upon login, false if no password
     */
    public function connect($newPassword = false)
    {
        $this->setupCurl();

        // get greeting
        $greeting = $this->request(new \AfriCC\EPP\Frame\Hello());

        // login
        $this->login($newPassword);

        // return greeting
        return $greeting;
    }

    /**
     * Closes a previously opened EPP connection
     */
    public function close()
    {
        if ($this->active()) {
            // send logout frame
            $this->request(new LogoutCommand());

            return curl_close($this->curl);
        }

        return false;
    }

    /**
     * sends a XML-based frame to the server
     *
     * @param FrameInterface $frame the frame to send to the server
     *
     * @return string
     */
    public function send(FrameInterface $frame)
    {
        $content = (string) $frame;
        curl_setopt($this->curl, CURLOPT_POSTFIELDS, $content);

        return curl_exec($this->curl);
    }

    /**
     * request via EPP
     *
     * @param FrameInterface $frame Request frame to server
     *
     * @return string|\AfriCC\EPP\Frame\Response\MessageQueue|\AfriCC\EPP\Frame\Response Response from server
     */
    public function request(FrameInterface $frame)
    {
        if ($frame instanceof TransactionAwareInterface) {
            $frame->setClientTransactionId(
                $this->generateClientTransactionId()
                );
        }

        $return = $this->send($frame);

        if ($return === false) {
            $code = curl_errno($this->curl);
            $msg = curl_error($this->curl);
            throw new \Exception($msg, $code);
        }

        return ResponseFactory::build($return);
    }

    protected function log($message)
    {
        if ($this->debug) {
            \error_log($message);
        }
    }

    /**
     * Check if curl session is still active
     *
     * @return bool
     */
    private function active()
    {
        return is_resource($this->curl);
    }
}