Client::config() - Code Metrics - Inspection of "more methods moved to socket trait" - EvilFreelancer/routeros-api-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 93f92b...059c3f )

by Mr

created 2019-02-17 11:15 UTC

Client::config() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

namespace RouterOS;

use RouterOS\Exceptions\ClientException;
use RouterOS\Exceptions\ConfigException;
use RouterOS\Exceptions\QueryException;
use RouterOS\Helpers\ArrayHelper;

/**
 * Class Client for RouterOS management
 *
 * @package RouterOS
 * @since   0.1
 */
class Client implements Interfaces\ClientInterface
{
    use SocketTrait;

    /**
     * Socket resource
     *
     * @var resource|null
     */
    private $_socket;

    /**
     * Code of error
     *
     * @var int
     */
    private $_socket_err_num;

    /**
     * Description of socket error
     *
     * @var string
     */
    private $_socket_err_str;

    /**
     * Configuration of connection
     *
     * @var \RouterOS\Config
     */
    private $_config;

    /**
     * Client constructor.
     *
     * @param   array|\RouterOS\Config $config
     * @throws  \RouterOS\Exceptions\ClientException
     * @throws  \RouterOS\Exceptions\ConfigException
     * @throws  \RouterOS\Exceptions\QueryException
     */
    public function __construct($config)
    {
        // If array then need create object
        if (\is_array($config)) {
            $config = new Config($config);
        }

        // Check for important keys
        if (true !== $key = ArrayHelper::checkIfKeysNotExist(['host', 'user', 'pass'], $config->getParameters())) {
            throw new ConfigException("Parameter '$key' of Config is not set or empty");
        }

        // Save config if everything is okay
        $this->setConfig($config);

        // Throw error if cannot to connect
        if (false === $this->connect()) {
            throw new ClientException('Unable to connect to ' . $config->get('host') . ':' . $config->get('port'));
        }
    }

    /**
     * Get some parameter from config
     *
     * @param   string $parameter Name of required parameter
     * @return  mixed
     * @throws  \RouterOS\Exceptions\ConfigException
     */
    private function config(string $parameter)
    {
        return $this->_config->get($parameter);
    }

    /**
     * Return socket resource if is exist
     *
     * @return  \RouterOS\Config
     * @since   0.6
     */
    public function getConfig(): Config
    {
        return $this->_config;
    }

    /**
     * Set configuration of client
     *
     * @param   \RouterOS\Config $config
     * @since   0.7
     */
    public function setConfig(Config $config)
    {
        $this->_config = $config;
    }

    /**
     * Encode given length in RouterOS format
     *
     * @param   string $string
     * @return  string Encoded length
     * @throws  \RouterOS\Exceptions\ClientException
     */
    private function encodeLength(string $string): string
    {
        $length = \strlen($string);

        if ($length < 128) {
            $orig_length = $length;
            $offset      = -1;
        } elseif ($length < 16384) {
            $orig_length = $length | 0x8000;
            $offset      = -2;
        } elseif ($length < 2097152) {
            $orig_length = $length | 0xC00000;
            $offset      = -3;
        } elseif ($length < 268435456) {
            $orig_length = $length | 0xE0000000;
            $offset      = -4;
        } else {
            throw new ClientException("Unable to encode length of '$string'");
        }

        // Pack string to binary format
        $result = pack('I*', $orig_length);
        // Parse binary string to array
        $result = str_split($result);
        // Reverse array
        $result = array_reverse($result);
        // Extract values from offset to end of array
        $result = \array_slice($result, $offset);

        // Sew items into one line
        $output = null;
        foreach ($result as $item) {
            $output .= $item;
        }

        return $output;
    }

    /**
     * Read length of line
     *
     * @param   int $byte
     * @return  int
     */
    private function getLength(int $byte): int
    {
        // If the first bit is set then we need to remove the first four bits, shift left 8
        // and then read another byte in.
        // We repeat this for the second and third bits.
        // If the fourth bit is set, we need to remove anything left in the first byte
        // and then read in yet another byte.
        if ($byte & 128) {
            if (($byte & 192) === 128) {
                $length = (($byte & 63) << 8) + \ord(fread($this->_socket, 1));
            } elseif (($byte & 224) === 192) {
                $length = (($byte & 31) << 8) + \ord(fread($this->_socket, 1));
                $length = ($length << 8) + \ord(fread($this->_socket, 1));
            } elseif (($byte & 240) === 224) {
                $length = (($byte & 15) << 8) + \ord(fread($this->_socket, 1));
                $length = ($length << 8) + \ord(fread($this->_socket, 1));
                $length = ($length << 8) + \ord(fread($this->_socket, 1));
            } else {
                $length = \ord(fread($this->_socket, 1));
                $length = ($length << 8) + \ord(fread($this->_socket, 1)) * 3;
                $length = ($length << 8) + \ord(fread($this->_socket, 1));
                $length = ($length << 8) + \ord(fread($this->_socket, 1));
            }
        } else {
            $length = $byte;
        }
        return $length;
    }

    /**
     * Send write query to RouterOS (with or without tag)
     *
     * @param   string|array|\RouterOS\Query $query
     * @return  \RouterOS\Client
     * @throws  \RouterOS\Exceptions\ClientException
     * @throws  \RouterOS\Exceptions\QueryException
     */
    public function write($query): Client
    {
        if (\is_string($query)) {
            $query = new Query($query);
        } elseif (\is_array($query)) {
            $endpoint = array_shift($query);
            $query    = new Query($endpoint, $query);
        }

        if (!$query instanceof Query) {
            throw new QueryException('Parameters cannot be processed');
        }

        // Send commands via loop to router
        foreach ($query->getQuery() as $command) {
            $command = trim($command);
            fwrite($this->_socket, $this->encodeLength($command) . $command);
        }

        // Write zero-terminator
        fwrite($this->_socket, \chr(0));

        return $this;
    }

    /**
     * Read answer from server after query was executed
     *
     * @param   bool $parse
     * @return  array
     */
    public function read(bool $parse = true): array
    {
        // By default response is empty
        $response = [];

        // Read answer from socket in loop
        while (true) {
            // Read the first byte of input which gives us some or all of the length
            // of the remaining reply.
            $byte   = fread($this->_socket, 1);
            $length = $this->getLength(\ord($byte));

            // Save only non empty strings
            if ($length > 0) {
                // Save output line to response array
                $response[] = stream_get_contents($this->_socket, $length);
            }

            // If we get a !done line in response, change state of $isDone variable
            $isDone = ('!done' === end($response));

            // Get status about latest operation
            $status = stream_get_meta_data($this->_socket);

            // If we do not have unread bytes from socket or <-same and if done, then exit from loop
            if ((!$status['unread_bytes']) || (!$status['unread_bytes'] && $isDone)) {
                break;
            }
        }

        // Parse results and return
        return $parse ? $this->parseResponse($response) : $response;
    }

    /**
     * Alias for ->write() method
     *
     * @param   string|array|\RouterOS\Query $query
     * @return  \RouterOS\Client
     * @throws  \RouterOS\Exceptions\ClientException
     * @throws  \RouterOS\Exceptions\QueryException
     */
    public function w($query): Client
    {
        return $this->write($query);
    }

    /**
     * Alias for ->read() method
     *
     * @param   bool $parse
     * @return  array
     * @since   0.7
     */
    public function r(bool $parse = true): array
    {
        return $this->read($parse);
    }

    /**
     * Alias for ->write()->read() combination of methods
     *
     * @param   string|array|\RouterOS\Query $query
     * @param   bool                         $parse
     * @return  array
     * @throws  \RouterOS\Exceptions\ClientException
     * @throws  \RouterOS\Exceptions\QueryException
     * @since   0.6
     */
    public function wr($query, bool $parse = true): array
    {
        return $this->write($query)->read($parse);
    }

    /**
     * Parse response from Router OS
     *
     * @param   array $response Response data
     * @return  array Array with parsed data
     */
    private function parseResponse(array $response): array
    {
        $result = [];
        $i      = -1;
        $lines  = \count($response);
        foreach ($response as $key => $value) {
            switch ($value) {
                case '!re':
                    $i++;
                    break;
                case '!fatal':
                    $result = $response;
                    break 2;
                case '!trap':
                case '!done':
                    // Check for =ret=, .tag and any other following messages
                    for ($j = $key + 1; $j <= $lines; $j++) {
                        // If we have lines after current one
                        if (isset($response[$j])) {
                            $this->pregResponse($response[$j], $matches);
                            if (!empty($matches)) {
                                $result['after'][$matches[1][0]] = $matches[2][0];
                            }
                        }
                    }
                    break 2;
                default:
                    $this->pregResponse($value, $matches);
                    if (!empty($matches)) {
                        $result[$i][$matches[1][0]] = $matches[2][0];
                    }
                    break;
            }
        }
        return $result;
    }

    /**
     * Parse result from RouterOS by regular expression
     *
     * @param   string $value
     * @param   array  $matches
     */
    private function pregResponse(string $value, &$matches)
    {
        preg_match_all('/^[=|\.](.*)=(.*)/', $value, $matches);
    }

    /**
     * Authorization logic
     *
     * @return  bool
     * @throws  \RouterOS\Exceptions\ClientException
     * @throws  \RouterOS\Exceptions\ConfigException
     * @throws  \RouterOS\Exceptions\QueryException
     */
    private function login(): bool
    {
        // If legacy login scheme is enabled
        if ($this->config('legacy')) {
            // For the first we need get hash with salt
            $query    = new Query('/login');
            $response = $this->write($query)->read();

            // Now need use this hash for authorization
            $query = (new Query('/login'))
                ->add('=name=' . $this->config('user'))
                ->add('=response=00' . md5(\chr(0) . $this->config('pass') . pack('H*', $response['after']['ret'])));
        } else {
            // Just login with our credentials
            $query = (new Query('/login'))
                ->add('=name=' . $this->config('user'))
                ->add('=password=' . $this->config('pass'));
        }

        // Execute query and get response
        $response = $this->write($query)->read(false);

        // Return true if we have only one line from server and this line is !done
        return isset($response[0]) && $response[0] === '!done';
    }

    /**
     * Connect to socket server
     *
     * @return  bool
     * @throws  \RouterOS\Exceptions\ClientException
     * @throws  \RouterOS\Exceptions\ConfigException
     * @throws  \RouterOS\Exceptions\QueryException
     */
    private function connect(): bool
    {
        // By default we not connected
        $connected = false;

        // Few attempts in loop
        for ($attempt = 1; $attempt <= $this->config('attempts'); $attempt++) {

            // Initiate socket session
            $this->openSocket();

            // If socket is active
            if ($this->getSocket()) {

                // If we logged in then exit from loop
                if (true === $this->login()) {
                    $connected = true;
                    break;
                }

                // Else close socket and start from begin
                $this->closeSocket();
            }

            // Sleep some time between tries
            sleep($this->config('delay'));
        }

        // Return status of connection
        return $connected;
    }

}


1		<?php
2
3		namespace RouterOS;
4
5		use RouterOS\Exceptions\ClientException;
6		use RouterOS\Exceptions\ConfigException;
7		use RouterOS\Exceptions\QueryException;
8		use RouterOS\Helpers\ArrayHelper;
9
10		/**
11		* Class Client for RouterOS management
12		*
13		* @package RouterOS
14		* @since 0.1
15		*/
16		class Client implements Interfaces\ClientInterface
17		{
18		use SocketTrait;
19
20		/**
21		* Socket resource
22		*
23		* @var resource\|null
24		*/
25		private $_socket;
26
27		/**
28		* Code of error
29		*
30		* @var int
31		*/
32		private $_socket_err_num;
33
34		/**
35		* Description of socket error
36		*
37		* @var string
38		*/
39		private $_socket_err_str;
40
41		/**
42		* Configuration of connection
43		*
44		* @var \RouterOS\Config
45		*/
46		private $_config;
47
48		/**
49		* Client constructor.
50		*
51		* @param array\|\RouterOS\Config $config
52		* @throws \RouterOS\Exceptions\ClientException
53		* @throws \RouterOS\Exceptions\ConfigException
54		* @throws \RouterOS\Exceptions\QueryException
55		*/
56	7	public function __construct($config)
57		{
58		// If array then need create object
59	7	if (\is_array($config)) {
60	1	$config = new Config($config);
61		}
62
63		// Check for important keys
64	7	if (true !== $key = ArrayHelper::checkIfKeysNotExist(['host', 'user', 'pass'], $config->getParameters())) {
65		throw new ConfigException("Parameter '$key' of Config is not set or empty");
66		}
67
68		// Save config if everything is okay
69	7	$this->setConfig($config);
70
71		// Throw error if cannot to connect
72	7	if (false === $this->connect()) {
73	1	throw new ClientException('Unable to connect to ' . $config->get('host') . ':' . $config->get('port'));
74		}
75	5	}
76
77		/**
78		* Get some parameter from config
79		*
80		* @param string $parameter Name of required parameter
81		* @return mixed
82		* @throws \RouterOS\Exceptions\ConfigException
83		*/
84	7	private function config(string $parameter)
85		{
86	7	return $this->_config->get($parameter);
87		}
88
89		/**
90		* Return socket resource if is exist
91		*
92		* @return \RouterOS\Config
93		* @since 0.6
94		*/
95		public function getConfig(): Config
96		{
97		return $this->_config;
98		}
99
100		/**
101		* Set configuration of client
102		*
103		* @param \RouterOS\Config $config
104		* @since 0.7
105		*/
106	7	public function setConfig(Config $config)
107		{
108	7	$this->_config = $config;
109	7	}
110
111		/**
112		* Encode given length in RouterOS format
113		*
114		* @param string $string
115		* @return string Encoded length
116		* @throws \RouterOS\Exceptions\ClientException
117		*/
118	6	private function encodeLength(string $string): string
119		{
120	6	$length = \strlen($string);
121
122	6	if ($length < 128) {
123	6	$orig_length = $length;
124	6	$offset = -1;
125		} elseif ($length < 16384) {
126		$orig_length = $length \| 0x8000;
127		$offset = -2;
128		} elseif ($length < 2097152) {
129		$orig_length = $length \| 0xC00000;
130		$offset = -3;
131		} elseif ($length < 268435456) {
132		$orig_length = $length \| 0xE0000000;
133		$offset = -4;
134		} else {
135		throw new ClientException("Unable to encode length of '$string'");
136		}
137
138		// Pack string to binary format
139	6	$result = pack('I*', $orig_length);
140		// Parse binary string to array
141	6	$result = str_split($result);
142		// Reverse array
143	6	$result = array_reverse($result);
144		// Extract values from offset to end of array
145	6	$result = \array_slice($result, $offset);
146
147		// Sew items into one line
148	6	$output = null;
149	6	foreach ($result as $item) {
150	6	$output .= $item;
151		}
152
153	6	return $output;
154		}
155
156		/**
157		* Read length of line
158		*
159		* @param int $byte
160		* @return int
161		*/
162	6	private function getLength(int $byte): int
163		{
164		// If the first bit is set then we need to remove the first four bits, shift left 8
165		// and then read another byte in.
166		// We repeat this for the second and third bits.
167		// If the fourth bit is set, we need to remove anything left in the first byte
168		// and then read in yet another byte.
169	6	if ($byte & 128) {
170		if (($byte & 192) === 128) {
171		$length = (($byte & 63) << 8) + \ord(fread($this->_socket, 1));
172		} elseif (($byte & 224) === 192) {
173		$length = (($byte & 31) << 8) + \ord(fread($this->_socket, 1));
174		$length = ($length << 8) + \ord(fread($this->_socket, 1));
175		} elseif (($byte & 240) === 224) {
176		$length = (($byte & 15) << 8) + \ord(fread($this->_socket, 1));
177		$length = ($length << 8) + \ord(fread($this->_socket, 1));
178		$length = ($length << 8) + \ord(fread($this->_socket, 1));
179		} else {
180		$length = \ord(fread($this->_socket, 1));
181		$length = ($length << 8) + \ord(fread($this->_socket, 1)) * 3;
182		$length = ($length << 8) + \ord(fread($this->_socket, 1));
183		$length = ($length << 8) + \ord(fread($this->_socket, 1));
184		}
185		} else {
186	6	$length = $byte;
187		}
188	6	return $length;
189		}
190
191		/**
192		* Send write query to RouterOS (with or without tag)
193		*
194		* @param string\|array\|\RouterOS\Query $query
195		* @return \RouterOS\Client
196		* @throws \RouterOS\Exceptions\ClientException
197		* @throws \RouterOS\Exceptions\QueryException
198		*/
199	6	public function write($query): Client
200		{
201	6	if (\is_string($query)) {
202		$query = new Query($query);
203	6	} elseif (\is_array($query)) {
204		$endpoint = array_shift($query);
205		$query = new Query($endpoint, $query);
206		}
207
208	6	if (!$query instanceof Query) {
209		throw new QueryException('Parameters cannot be processed');
210		}
211
212		// Send commands via loop to router
213	6	foreach ($query->getQuery() as $command) {
214	6	$command = trim($command);
215	6	fwrite($this->_socket, $this->encodeLength($command) . $command);
216		}
217
218		// Write zero-terminator
219	6	fwrite($this->_socket, \chr(0));
220
221	6	return $this;
222		}
223
224		/**
225		* Read answer from server after query was executed
226		*
227		* @param bool $parse
228		* @return array
229		*/
230	6	public function read(bool $parse = true): array
231		{
232		// By default response is empty
233	6	$response = [];
234
235		// Read answer from socket in loop
236	6	while (true) {
237		// Read the first byte of input which gives us some or all of the length
238		// of the remaining reply.
239	6	$byte = fread($this->_socket, 1);
240	6	$length = $this->getLength(\ord($byte));
241
242		// Save only non empty strings
243	6	if ($length > 0) {
244		// Save output line to response array
245	6	$response[] = stream_get_contents($this->_socket, $length);
246		}
247
248		// If we get a !done line in response, change state of $isDone variable
249	6	$isDone = ('!done' === end($response));
250
251		// Get status about latest operation
252	6	$status = stream_get_meta_data($this->_socket);
253
254		// If we do not have unread bytes from socket or <-same and if done, then exit from loop
255	6	if ((!$status['unread_bytes']) \|\| (!$status['unread_bytes'] && $isDone)) {
256	6	break;
257		}
258		}
259
260		// Parse results and return
261	6	return $parse ? $this->parseResponse($response) : $response;
262		}
263
264		/**
265		* Alias for ->write() method
266		*
267		* @param string\|array\|\RouterOS\Query $query
268		* @return \RouterOS\Client
269		* @throws \RouterOS\Exceptions\ClientException
270		* @throws \RouterOS\Exceptions\QueryException
271		*/
272		public function w($query): Client
273		{
274		return $this->write($query);
275		}
276
277		/**
278		* Alias for ->read() method
279		*
280		* @param bool $parse
281		* @return array
282		* @since 0.7
283		*/
284		public function r(bool $parse = true): array
285		{
286		return $this->read($parse);
287		}
288
289		/**
290		* Alias for ->write()->read() combination of methods
291		*
292		* @param string\|array\|\RouterOS\Query $query
293		* @param bool $parse
294		* @return array
295		* @throws \RouterOS\Exceptions\ClientException
296		* @throws \RouterOS\Exceptions\QueryException
297		* @since 0.6
298		*/
299		public function wr($query, bool $parse = true): array
300		{
301		return $this->write($query)->read($parse);
302		}
303
304		/**
305		* Parse response from Router OS
306		*
307		* @param array $response Response data
308		* @return array Array with parsed data
309		*/
310	2	private function parseResponse(array $response): array
311		{
312	2	$result = [];
313	2	$i = -1;
314	2	$lines = \count($response);
315	2	foreach ($response as $key => $value) {
316		switch ($value) {
317	2	case '!re':
318	1	$i++;
319	1	break;
320	2	case '!fatal':
321		$result = $response;
322		break 2;
323	2	case '!trap':
324	2	case '!done':
325		// Check for =ret=, .tag and any other following messages
326	2	for ($j = $key + 1; $j <= $lines; $j++) {
327		// If we have lines after current one
328	2	if (isset($response[$j])) {
329	1	$this->pregResponse($response[$j], $matches);
330	1	if (!empty($matches)) {
331	1	$result['after'][$matches[1][0]] = $matches[2][0];
332		}
333		}
334		}
335	2	break 2;
336		default:
337	1	$this->pregResponse($value, $matches);
338	1	if (!empty($matches)) {
339	1	$result[$i][$matches[1][0]] = $matches[2][0];
340		}
341	1	break;
342		}
343		}
344	2	return $result;
345		}
346
347		/**
348		* Parse result from RouterOS by regular expression
349		*
350		* @param string $value
351		* @param array $matches
352		*/
353	2	private function pregResponse(string $value, &$matches)
354		{
355	2	preg_match_all('/^[=\|\.](.)=(.)/', $value, $matches);
356	2	}
357
358		/**
359		* Authorization logic
360		*
361		* @return bool
362		* @throws \RouterOS\Exceptions\ClientException
363		* @throws \RouterOS\Exceptions\ConfigException
364		* @throws \RouterOS\Exceptions\QueryException
365		*/
366	6	private function login(): bool
367		{
368		// If legacy login scheme is enabled
369	6	if ($this->config('legacy')) {
370		// For the first we need get hash with salt
371	1	$query = new Query('/login');
372	1	$response = $this->write($query)->read();
373
374		// Now need use this hash for authorization
375	1	$query = (new Query('/login'))
376	1	->add('=name=' . $this->config('user'))
377	1	->add('=response=00' . md5(\chr(0) . $this->config('pass') . pack('H*', $response['after']['ret'])));
378		} else {
379		// Just login with our credentials
380	5	$query = (new Query('/login'))
381	5	->add('=name=' . $this->config('user'))
382	5	->add('=password=' . $this->config('pass'));
383		}
384
385		// Execute query and get response
386	6	$response = $this->write($query)->read(false);
387
388		// Return true if we have only one line from server and this line is !done
389	6	return isset($response[0]) && $response[0] === '!done';
390		}
391
392		/**
393		* Connect to socket server
394		*
395		* @return bool
396		* @throws \RouterOS\Exceptions\ClientException
397		* @throws \RouterOS\Exceptions\ConfigException
398		* @throws \RouterOS\Exceptions\QueryException
399		*/
400	7	private function connect(): bool
401		{
402		// By default we not connected
403	7	$connected = false;
404
405		// Few attempts in loop
406	7	for ($attempt = 1; $attempt <= $this->config('attempts'); $attempt++) {
407
408		// Initiate socket session
409	7	$this->openSocket();
410
411		// If socket is active
412	6	if ($this->getSocket()) {
413
414		// If we logged in then exit from loop
415	6	if (true === $this->login()) {
416	5	$connected = true;
417	5	break;
418		}
419
420		// Else close socket and start from begin
421	1	$this->closeSocket();
422		}
423
424		// Sleep some time between tries
425	1	sleep($this->config('delay'));
426		}
427
428		// Return status of connection
429	6	return $connected;
430		}
431
432		}
433

EvilFreelancer / routeros-api-php

Push — master ( 93f92b...059c3f )

Client::config() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like