Client::active() - Code Metrics - Inspection of "Small fixes" - AfriCC/php-epp2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#84)

unknown

created 2019-10-29 15:35 UTC

Client::active() A

↳ Parent: Client

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	3
nc	4
nop	0

<?php

/**
 * This file is part of the php-epp2 library.
 *
 * (c) Gunter Grodotzki <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE file
 * that was distributed with this source code.
 */

namespace AfriCC\EPP;

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

/**
 * A high level TCP (SSL) based client for the Extensible Provisioning Protocol (EPP)
 *
 * @see http://tools.ietf.org/html/rfc5734
 *
 * As this class deals directly with sockets it's untestable
 * @codeCoverageIgnore
 */
class Client extends AbstractClient implements ClientInterface
{
    protected $socket;
    protected $chunk_size;
    protected $verify_peer_name;

    public function __construct(array $config, ObjectSpec $objectSpec = null)
    {
        parent::__construct($config, $objectSpec);

        if (!empty($config['chunk_size'])) {
            $this->chunk_size = (int) $config['chunk_size'];
        } else {
            $this->chunk_size = 1024;
        }

        if (isset($config['verify_peer_name'])) {
            $this->verify_peer_name = (bool) $config['verify_peer_name'];
        } else {
            $this->verify_peer_name = true;
        }

        if ($this->port === false) {
            // if not set, default port is 700
            $this->port = 700;
        }
    }

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

    /**
     * Setup context in case of ssl connection
     *
     * @return resource|null
     */
    private function setupContext()
    {
        if (!$this->ssl) {
            return null;
        }

        $context = stream_context_create();

        $options_array = [
            'verify_peer' => false,
            'verify_peer_name' => $this->verify_peer_name,
            'allow_self_signed' => true,
            'local_cert' => $this->local_cert,
            'passphrase' => $this->passphrase,
            'cafile' => $this->ca_cert,
            'local_pk' => $this->pk_cert,
        ];

        // filter out empty user provided values
        $options_array = array_filter(
            $options_array,
            function ($var) {
                return !is_null($var);
            }
        );

        $options = ['ssl' => $options_array];

        // stream_context_set_option accepts array of options in form of $arr['wrapper']['option'] = value
        stream_context_set_option($context, $options);

        return $context;
    }

    /**
     * Setup connection socket
     *
     * @param resource|null $context SSL context or null in case of tcp connection
     *
     * @throws Exception on socket errors
     */
    private function setupSocket($context = null)
    {
        $proto = $this->ssl ? 'ssl' : 'tcp';
        $target = sprintf('%s://%s:%d', $proto, $this->host, $this->port);

        $errno = 0;
        $errstr = '';

        $this->socket = @stream_socket_client($target, $errno, $errstr, $this->connect_timeout, STREAM_CLIENT_CONNECT, $context);

        if ($this->socket === false) {
            // Socket initialization may fail, before system call connect()
            // so the $errno is 0 and $errstr isn't populated .
            // see https://www.php.net/manual/en/function.stream-socket-client.php#refsect1-function.stream-socket-client-errors
            throw new Exception(sprintf('problem initializing socket: %s code: [%d]',$errstr, $errno), $errno);
        }

        // set stream time out
        if (!stream_set_timeout($this->socket, $this->timeout)) {
            throw new Exception('unable to set stream timeout');
        }

        // set to non-blocking
        if (!stream_set_blocking($this->socket, 0)) {
            throw new Exception('unable to set blocking');
        }
    }

    /**
     * {@inheritdoc}
     *
     * @see \AfriCC\EPP\ClientInterface::connect()
     */
    public function connect($newPassword = false)
    {
        $context = $this->setupContext();
        $this->setupSocket($context);

        // get greeting
        $greeting = $this->getFrame();

        // 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($this->objectSpec));

            return fclose($this->socket);
        }

        return false;
    }

    public function getFrame()
    {
        $hard_time_limit = time() + $this->timeout + 2;
        do {
            $header = $this->recv(4);
        } while (empty($header) && (time() < $hard_time_limit));

        if (time() >= $hard_time_limit) {
            throw new Exception('Timeout while reading header from EPP Server');
        }

        // Unpack first 4 bytes which is our length
        $unpacked = unpack('N', $header);
        $length = $unpacked[1];

        if ($length < 5) {
            throw new Exception(sprintf('Got a bad frame header length of %d bytes from peer', $length));
        } else {
            $length -= 4;

            return $this->recv($length);
        }
    }

    public function sendFrame(FrameInterface $frame)
    {
        $buffer = (string) $frame;
        $header = pack('N', mb_strlen($buffer, 'ASCII') + 4);

        return $this->send($header . $buffer);
    }

    protected function log($message, $color = '0;32')
    {
        if ($message === '' || !$this->debug) {
            return;
        }
        echo sprintf("\033[%sm%s\033[0m", $color, $message);
    }

    /**
     * check if socket is still active
     *
     * @return bool
     */
    private function active()
    {
        return !is_resource($this->socket) || feof($this->socket) ? false : true;
    }

    /**
     * receive socket data
     *
     * @param int $length
     *
     * @throws Exception
     *
     * @return string
     */
    private function recv($length)
    {
        $result = '';

        $info = stream_get_meta_data($this->socket);
        $hard_time_limit = time() + $this->timeout + 2;

        while (!$info['timed_out'] && !feof($this->socket)) {
            // Try read remaining data from socket
            $buffer = @fread($this->socket, $length - mb_strlen($result, 'ASCII'));

            // If the buffer actually contains something then add it to the result
            if ($buffer !== false) {
                $this->log($buffer);
                $result .= $buffer;

                // break if all data received
                if (mb_strlen($result, 'ASCII') === $length) {
                    break;
                }
            } else {
                // sleep 0.25s
                usleep(250000);
            }

            // update metadata
            $info = stream_get_meta_data($this->socket);
            if (time() >= $hard_time_limit) {
                throw new Exception('Timeout while reading from EPP Server');
            }
        }

        // check for timeout
        if ($info['timed_out']) {
            throw new Exception('Timeout while reading data from socket');
        }

        return $result;
    }

    /**
     * send data to socket
     *
     * @param string $buffer
     */
    private function send($buffer)
    {
        $info = stream_get_meta_data($this->socket);
        $hard_time_limit = time() + $this->timeout + 2;
        $length = mb_strlen($buffer, 'ASCII');

        $pos = 0;
        while (!$info['timed_out'] && !feof($this->socket)) {
            // Some servers don't like a lot of data, so keep it small per chunk
            $wlen = $length - $pos;

            if ($wlen > $this->chunk_size) {
                $wlen = $this->chunk_size;
            }

            // try write remaining data from socket
            $written = @fwrite($this->socket, mb_substr($buffer, $pos, $wlen, 'ASCII'), $wlen);

            // If we read something, bump up the position
            if ($written) {
                if ($this->debug) {
                    $this->log(mb_substr($buffer, $pos, $wlen, 'ASCII'), '1;31');
                }
                $pos += $written;

                // break if all written
                if ($pos === $length) {
                    break;
                }
            } else {
                // sleep 0.25s
                usleep(250000);
            }

            // update metadata
            $info = stream_get_meta_data($this->socket);
            if (time() >= $hard_time_limit) {
                throw new Exception('Timeout while writing to EPP Server');
            }
        }

        // check for timeout
        if ($info['timed_out']) {
            throw new Exception('Timeout while writing data to socket');
        }

        if ($pos !== $length) {
            throw new Exception('Writing short %d bytes', $length - $pos);
        }

        return $pos;
    }
}


1			<?php
2
3			/**
4			* This file is part of the php-epp2 library.
5			*
6			* (c) Gunter Grodotzki <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE file
9			* that was distributed with this source code.
10			*/
11
12			namespace AfriCC\EPP;
13
14			use AfriCC\EPP\Frame\Command\Logout as LogoutCommand;
15			use Exception;
16
17			/**
18			* A high level TCP (SSL) based client for the Extensible Provisioning Protocol (EPP)
19			*
20			* @see http://tools.ietf.org/html/rfc5734
21			*
22			* As this class deals directly with sockets it's untestable
23			* @codeCoverageIgnore
24			*/
25			class Client extends AbstractClient implements ClientInterface
26			{
27			protected $socket;
28			protected $chunk_size;
29			protected $verify_peer_name;
30
31			public function __construct(array $config, ObjectSpec $objectSpec = null)
32			{
33			parent::__construct($config, $objectSpec);
34
35			if (!empty($config['chunk_size'])) {
36			$this->chunk_size = (int) $config['chunk_size'];
37			} else {
38			$this->chunk_size = 1024;
39			}
40
41			if (isset($config['verify_peer_name'])) {
42			$this->verify_peer_name = (bool) $config['verify_peer_name'];
43			} else {
44			$this->verify_peer_name = true;
45			}
46
47			if ($this->port === false) {
48			// if not set, default port is 700
49			$this->port = 700;
50			}
51			}
52
53			public function __destruct()
54			{
55			$this->close();
56			}
57
58			/**
59			* Setup context in case of ssl connection
60			*
61			* @return resource\|null
62			*/
63			private function setupContext()
64			{
65			if (!$this->ssl) {
66			return null;
67			}
68
69			$context = stream_context_create();
70
71			$options_array = [
72			'verify_peer' => false,
73			'verify_peer_name' => $this->verify_peer_name,
74			'allow_self_signed' => true,
75			'local_cert' => $this->local_cert,
76			'passphrase' => $this->passphrase,
77			'cafile' => $this->ca_cert,
78			'local_pk' => $this->pk_cert,
79			];
80
81			// filter out empty user provided values
82			$options_array = array_filter(
83			$options_array,
84			function ($var) {
85			return !is_null($var);
86			}
87			);
88
89			$options = ['ssl' => $options_array];
90
91			// stream_context_set_option accepts array of options in form of $arr['wrapper']['option'] = value
92			stream_context_set_option($context, $options);
93
94			return $context;
95			}
96
97			/**
98			* Setup connection socket
99			*
100			* @param resource\|null $context SSL context or null in case of tcp connection
101			*
102			* @throws Exception on socket errors
103			*/
104			private function setupSocket($context = null)
105			{
106			$proto = $this->ssl ? 'ssl' : 'tcp';
107			$target = sprintf('%s://%s:%d', $proto, $this->host, $this->port);
108
109			$errno = 0;
110			$errstr = '';
111
112			$this->socket = @stream_socket_client($target, $errno, $errstr, $this->connect_timeout, STREAM_CLIENT_CONNECT, $context);
113
114			if ($this->socket === false) {
115			// Socket initialization may fail, before system call connect()
116			// so the $errno is 0 and $errstr isn't populated .
117			// see https://www.php.net/manual/en/function.stream-socket-client.php#refsect1-function.stream-socket-client-errors
118			throw new Exception(sprintf('problem initializing socket: %s code: [%d]',$errstr, $errno), $errno);
119			}
120
121			// set stream time out
122			if (!stream_set_timeout($this->socket, $this->timeout)) {
123			throw new Exception('unable to set stream timeout');
124			}
125
126			// set to non-blocking
127			if (!stream_set_blocking($this->socket, 0)) {
128			throw new Exception('unable to set blocking');
129			}
130			}
131
132			/**
133			* {@inheritdoc}
134			*
135			* @see \AfriCC\EPP\ClientInterface::connect()
136			*/
137			public function connect($newPassword = false)
138			{
139			$context = $this->setupContext();
140			$this->setupSocket($context);
141
142			// get greeting
143			$greeting = $this->getFrame();
144
145			// login
146			$this->login($newPassword);
147
148			// return greeting
149			return $greeting;
150			}
151
152			/**
153			* Closes a previously opened EPP connection
154			*/
155			public function close()
156			{
157			if ($this->active()) {
158			// send logout frame
159			$this->request(new LogoutCommand($this->objectSpec));
160
161			return fclose($this->socket);
162			}
163
164			return false;
165			}
166
167			public function getFrame()
168			{
169			$hard_time_limit = time() + $this->timeout + 2;
170			do {
171			$header = $this->recv(4);
172			} while (empty($header) && (time() < $hard_time_limit));
173
174			if (time() >= $hard_time_limit) {
175			throw new Exception('Timeout while reading header from EPP Server');
176			}
177
178			// Unpack first 4 bytes which is our length
179			$unpacked = unpack('N', $header);
180			$length = $unpacked[1];
181
182			if ($length < 5) {
183			throw new Exception(sprintf('Got a bad frame header length of %d bytes from peer', $length));
184			} else {
185			$length -= 4;
186
187			return $this->recv($length);
188			}
189			}
190
191			public function sendFrame(FrameInterface $frame)
192			{
193			$buffer = (string) $frame;
194			$header = pack('N', mb_strlen($buffer, 'ASCII') + 4);
195
196			return $this->send($header . $buffer);
197			}
198
199			protected function log($message, $color = '0;32')
200			{
201			if ($message === '' \|\| !$this->debug) {
202			return;
203			}
204			echo sprintf("\033[%sm%s\033[0m", $color, $message);
205			}
206
207			/**
208			* check if socket is still active
209			*
210			* @return bool
211			*/
212			private function active()
213			{
214			return !is_resource($this->socket) \|\| feof($this->socket) ? false : true;
215			}
216
217			/**
218			* receive socket data
219			*
220			* @param int $length
221			*
222			* @throws Exception
223			*
224			* @return string
225			*/
226			private function recv($length)
227			{
228			$result = '';
229
230			$info = stream_get_meta_data($this->socket);
231			$hard_time_limit = time() + $this->timeout + 2;
232
233			while (!$info['timed_out'] && !feof($this->socket)) {
234			// Try read remaining data from socket
235			$buffer = @fread($this->socket, $length - mb_strlen($result, 'ASCII'));
236
237			// If the buffer actually contains something then add it to the result
238			if ($buffer !== false) {
239			$this->log($buffer);
240			$result .= $buffer;
241
242			// break if all data received
243			if (mb_strlen($result, 'ASCII') === $length) {
244			break;
245			}
246			} else {
247			// sleep 0.25s
248			usleep(250000);
249			}
250
251			// update metadata
252			$info = stream_get_meta_data($this->socket);
253			if (time() >= $hard_time_limit) {
254			throw new Exception('Timeout while reading from EPP Server');
255			}
256			}
257
258			// check for timeout
259			if ($info['timed_out']) {
260			throw new Exception('Timeout while reading data from socket');
261			}
262
263			return $result;
264			}
265
266			/**
267			* send data to socket
268			*
269			* @param string $buffer
270			*/
271			private function send($buffer)
272			{
273			$info = stream_get_meta_data($this->socket);
274			$hard_time_limit = time() + $this->timeout + 2;
275			$length = mb_strlen($buffer, 'ASCII');
276
277			$pos = 0;
278			while (!$info['timed_out'] && !feof($this->socket)) {
279			// Some servers don't like a lot of data, so keep it small per chunk
280			$wlen = $length - $pos;
281
282			if ($wlen > $this->chunk_size) {
283			$wlen = $this->chunk_size;
284			}
285
286			// try write remaining data from socket
287			$written = @fwrite($this->socket, mb_substr($buffer, $pos, $wlen, 'ASCII'), $wlen);
288
289			// If we read something, bump up the position
290			if ($written) {
291			if ($this->debug) {
292			$this->log(mb_substr($buffer, $pos, $wlen, 'ASCII'), '1;31');
293			}
294			$pos += $written;
295
296			// break if all written
297			if ($pos === $length) {
298			break;
299			}
300			} else {
301			// sleep 0.25s
302			usleep(250000);
303			}
304
305			// update metadata
306			$info = stream_get_meta_data($this->socket);
307			if (time() >= $hard_time_limit) {
308			throw new Exception('Timeout while writing to EPP Server');
309			}
310			}
311
312			// check for timeout
313			if ($info['timed_out']) {
314			throw new Exception('Timeout while writing data to socket');
315			}
316
317			if ($pos !== $length) {
318			throw new Exception('Writing short %d bytes', $length - $pos);
319			}
320
321			return $pos;
322			}
323			}
324

AfriCC / php-epp2

Pull Request — master (#84)

Client::active() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like