Connection::read() - Code Metrics - Inspection of "add support for anonymous auth" - icewind1991/SMB - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 89f47c...f4d8bc )

by Robin

created 2018-03-27 15:59 UTC

Connection::read() B

↳ Parent: Connection

Complexity

Conditions	6
Paths	9

Size

Total Lines	26
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	6.4859

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	26
ccs	16
cts	21
cp	0.7619
rs	8.439
cc	6
eloc	19
nc	9
nop	1
crap	6.4859

<?php
/**
 * Copyright (c) 2014 Robin Appelman <[email protected]>
 * This file is licensed under the Licensed under the MIT license:
 * http://opensource.org/licenses/MIT
 */

namespace Icewind\SMB\Wrapped;

use Icewind\SMB\Exception\AuthenticationException;
use Icewind\SMB\Exception\ConnectException;
use Icewind\SMB\Exception\ConnectionException;
use Icewind\SMB\Exception\InvalidHostException;
use Icewind\SMB\Exception\NoLoginServerException;

class Connection extends RawConnection {
	const DELIMITER = 'smb:';
	const DELIMITER_LENGTH = 4;

	/** @var Parser */
	private $parser;

	public function __construct($command, Parser $parser, $env = array()) {
		parent::__construct($command, $env);
		$this->parser = $parser;
	}

	/**
	 * send input to smbclient
	 *
	 * @param string $input
	 */
	public function write($input) {
		parent::write($input . PHP_EOL);
	}

	/**
	 * @throws ConnectException
	 */
	public function clearTillPrompt() {
		$this->write('');
		do {
			$promptLine = $this->readLine();
			$this->parser->checkConnectionError($promptLine);
		} while (!$this->isPrompt($promptLine));
		$this->write('');
		$this->readLine();
	}

	/**
	 * get all unprocessed output from smbclient until the next prompt
	 *
	 * @param callable $callback (optional) callback to call for every line read
	 * @return string[]
	 * @throws AuthenticationException
	 * @throws ConnectException
	 * @throws ConnectionException
	 * @throws InvalidHostException
	 * @throws NoLoginServerException
	 */
	public function read(callable $callback = null) {
		if (!$this->isValid()) {
			throw new ConnectionException('Connection not valid');
		}
		$promptLine = $this->readLine(); //first line is prompt
		$this->parser->checkConnectionError($promptLine);

		$output = array();
		$line = $this->readLine();
		if ($line === false) {
			$this->unknownError($promptLine);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
		}
		while (!$this->isPrompt($line)) { //next prompt functions as delimiter
			if (is_callable($callback)) {
				$result = $callback($line);
				if ($result === false) { // allow the callback to close the connection for infinite running commands
					$this->close(true);
					break;
				}
			} else {
				$output[] .= $line;
			}
			$line = $this->readLine();
		}
		return $output;
	}

	/**
	 * Check
	 *
	 * @param $line
	 * @return bool
	 */
	private function isPrompt($line) {
		return mb_substr($line, 0, self::DELIMITER_LENGTH) === self::DELIMITER || $line === false;
	}

	/**
	 * @param string $promptLine (optional) prompt line that might contain some info about the error
	 * @throws ConnectException
	 */
	private function unknownError($promptLine = '') {
		if ($promptLine) { //maybe we have some error we missed on the previous line
			throw new ConnectException('Unknown error (' . $promptLine . ')');
		} else {
			$error = $this->readError(); // maybe something on stderr
			if ($error) {
				throw new ConnectException('Unknown error (' . $error . ')');
			} else {
				throw new ConnectException('Unknown error');
			}
		}
	}

	public function close($terminate = true) {
		if (is_resource($this->getInputStream())) {
			$this->write('close' . PHP_EOL);
		}
		parent::close($terminate);
	}
}


1		<?php
2		/**
3		* Copyright (c) 2014 Robin Appelman <[email protected]>
4		* This file is licensed under the Licensed under the MIT license:
5		* http://opensource.org/licenses/MIT
6		*/
7
8		namespace Icewind\SMB\Wrapped;
9
10		use Icewind\SMB\Exception\AuthenticationException;
11		use Icewind\SMB\Exception\ConnectException;
12		use Icewind\SMB\Exception\ConnectionException;
13		use Icewind\SMB\Exception\InvalidHostException;
14		use Icewind\SMB\Exception\NoLoginServerException;
15
16		class Connection extends RawConnection {
17		const DELIMITER = 'smb:';
18		const DELIMITER_LENGTH = 4;
19
20		/** @var Parser */
21		private $parser;
22
23	510	public function __construct($command, Parser $parser, $env = array()) {
24	510	parent::__construct($command, $env);
25	510	$this->parser = $parser;
26	510	}
27
28		/**
29		* send input to smbclient
30		*
31		* @param string $input
32		*/
33	510	public function write($input) {
34	510	parent::write($input . PHP_EOL);
35	510	}
36
37		/**
38		* @throws ConnectException
39		*/
40	510	public function clearTillPrompt() {
41	510	$this->write('');
42		do {
43	510	$promptLine = $this->readLine();
44	510	$this->parser->checkConnectionError($promptLine);
45	510	} while (!$this->isPrompt($promptLine));
46	510	$this->write('');
47	510	$this->readLine();
48	510	}
49
50		/**
51		* get all unprocessed output from smbclient until the next prompt
52		*
53		* @param callable $callback (optional) callback to call for every line read
54		* @return string[]
55		* @throws AuthenticationException
56		* @throws ConnectException
57		* @throws ConnectionException
58		* @throws InvalidHostException
59		* @throws NoLoginServerException
60		*/
61	508	public function read(callable $callback = null) {
62	508	if (!$this->isValid()) {
63		throw new ConnectionException('Connection not valid');
64		}
65	508	$promptLine = $this->readLine(); //first line is prompt
66	508	$this->parser->checkConnectionError($promptLine);
67
68	508	$output = array();
69	508	$line = $this->readLine();
70	508	if ($line === false) {
71		$this->unknownError($promptLine);
		0 ignored issues – show Security Bug introduced 2018-03-13 17:17 UTC by Report Bug Copy Issue Report It seems like `$promptLine` defined by `$this->readLine()` on line `65` can also be of type `false`; however, `Icewind\SMB\Wrapped\Connection::unknownError()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
72		}
73	508	while (!$this->isPrompt($line)) { //next prompt functions as delimiter
74	504	if (is_callable($callback)) {
75	4	$result = $callback($line);
76	4	if ($result === false) { // allow the callback to close the connection for infinite running commands
77	4	$this->close(true);
78	4	break;
79		}
80		} else {
81	500	$output[] .= $line;
82		}
83	500	$line = $this->readLine();
84		}
85	508	return $output;
86		}
87
88		/**
89		* Check
90		*
91		* @param $line
92		* @return bool
93		*/
94	510	private function isPrompt($line) {
95	510	return mb_substr($line, 0, self::DELIMITER_LENGTH) === self::DELIMITER \|\| $line === false;
96		}
97
98		/**
99		* @param string $promptLine (optional) prompt line that might contain some info about the error
100		* @throws ConnectException
101		*/
102		private function unknownError($promptLine = '') {
103		if ($promptLine) { //maybe we have some error we missed on the previous line
104		throw new ConnectException('Unknown error (' . $promptLine . ')');
105		} else {
106		$error = $this->readError(); // maybe something on stderr
107		if ($error) {
108		throw new ConnectException('Unknown error (' . $error . ')');
109		} else {
110		throw new ConnectException('Unknown error');
111		}
112		}
113		}
114
115	510	public function close($terminate = true) {
116	510	if (is_resource($this->getInputStream())) {
117	510	$this->write('close' . PHP_EOL);
118		}
119	510	parent::close($terminate);
120	510	}
121		}
122

icewind1991 / SMB

Push — master ( 89f47c...f4d8bc )

Connection::read() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like