RawConnection::close() - Code Metrics - Inspection of "smbclient wrapper not compatible with busybox" - icewind1991/SMB - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#79)

by Raffael

created 2019-03-28 14:23 UTC

RawConnection::close() A

↳ Parent: RawConnection

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	7
cts	7
cp	1
rs	9.9666
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	3

<?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\ConnectException;
use Icewind\SMB\Exception\ConnectionException;

class RawConnection {
	/**
	 * @var string
	 */
	private $command;

	/**
	 * @var string[]
	 */
	private $env;

	/**
	 * @var resource[] $pipes
	 *
	 * $pipes[0] holds STDIN for smbclient
	 * $pipes[1] holds STDOUT for smbclient
	 * $pipes[3] holds the authfile for smbclient
	 * $pipes[4] holds the stream for writing files
	 * $pipes[5] holds the stream for reading files
	 */
	private $pipes;

	/**
	 * @var resource $process
	 */
	private $process;

	/**
	 * @var resource|null $authStream
	 */
	private $authStream = null;

	private $connected = false;

	public function __construct($command, array $env = []) {
		$this->command = $command;
		$this->env = $env;
	}

	/**
	 * @throws ConnectException
	 */
	public function connect() {
		if (is_null($this->getAuthStream())) {
			throw new ConnectException('Authentication not set before connecting');
		}

		$descriptorSpec = [
			0 => ['pipe', 'r'], // child reads from stdin
			1 => ['pipe', 'w'], // child writes to stdout
			2 => ['pipe', 'w'], // child writes to stderr
			3 => $this->getAuthStream(), // child reads from fd#3
			4 => ['pipe', 'r'], // child reads from fd#4
			5 => ['pipe', 'w']  // child writes to fd#5
		];

		setlocale(LC_ALL, Server::LOCALE);
		$env = array_merge($this->env, [
			'CLI_FORCE_INTERACTIVE' => 'y', // Needed or the prompt isn't displayed!!
			'LC_ALL'                => Server::LOCALE,
			'LANG'                  => Server::LOCALE,
			'COLUMNS'               => 8192 // prevent smbclient from line-wrapping it's output
		]);
		$this->process = proc_open($this->command, $descriptorSpec, $this->pipes, '/', $env);
		if (!$this->isValid()) {
			throw new ConnectionException();
		}
		$this->connected = true;
	}

	/**
	 * check if the connection is still active
	 *
	 * @return bool
	 */
	public function isValid() {
		if (is_resource($this->process)) {
			$status = proc_get_status($this->process);
			return $status['running'];
		} else {
			return false;
		}
	}

	/**
	 * send input to the process
	 *
	 * @param string $input
	 */
	public function write($input) {
		fwrite($this->getInputStream(), $input);
		fflush($this->getInputStream());
	}

	/**
	 * read a line of output
	 *
	 * @return string|false
	 */
	public function readLine() {
		return stream_get_line($this->getOutputStream(), 4086, "\n");
	}

	/**
	 * read a line of output
	 *
	 * @return string
	 */
	public function readError() {
		return trim(stream_get_line($this->getErrorStream(), 4086));
	}

	/**
	 * get all output until the process closes
	 *
	 * @return array
	 */
	public function readAll() {
		$output = [];
		while ($line = $this->readLine()) {
			$output[] = $line;
		}
		return $output;
	}

	public function getInputStream() {
		return $this->pipes[0];
	}

	public function getOutputStream() {
		return $this->pipes[1];
	}

	public function getErrorStream() {
		return $this->pipes[2];
	}

	public function getAuthStream() {
		return $this->authStream;
	}

	public function getFileInputStream() {
		return $this->pipes[4];
	}

	public function getFileOutputStream() {
		return $this->pipes[5];
	}

	public function writeAuthentication($user, $password) {
		$auth = ($password === false)
			? "username=$user"
			: "username=$user\npassword=$password\n";

		$this->authStream = fopen('php://temp', 'w+');
		fwrite($this->getAuthStream(), $auth);
	}

	public function close($terminate = true) {
		if (!is_resource($this->process)) {
			return;
		}
		if ($terminate) {
			proc_terminate($this->process);
		}
		proc_close($this->process);
	}

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

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


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\ConnectException;
11		use Icewind\SMB\Exception\ConnectionException;
12
13		class RawConnection {
14		/**
15		* @var string
16		*/
17		private $command;
18
19		/**
20		* @var string[]
21		*/
22		private $env;
23
24		/**
25		* @var resource[] $pipes
26		*
27		* $pipes[0] holds STDIN for smbclient
28		* $pipes[1] holds STDOUT for smbclient
29		* $pipes[3] holds the authfile for smbclient
30		* $pipes[4] holds the stream for writing files
31		* $pipes[5] holds the stream for reading files
32		*/
33		private $pipes;
34
35		/**
36		* @var resource $process
37		*/
38		private $process;
39
40		/**
41		* @var resource\|null $authStream
42		*/
43		private $authStream = null;
44
45		private $connected = false;
46
47	1040	public function __construct($command, array $env = []) {
48	1040	$this->command = $command;
49	1040	$this->env = $env;
50	1040	}
51
52		/**
53		* @throws ConnectException
54		*/
55	1040	public function connect() {
56	1040	if (is_null($this->getAuthStream())) {
57		throw new ConnectException('Authentication not set before connecting');
58		}
59
60		$descriptorSpec = [
61	1040	0 => ['pipe', 'r'], // child reads from stdin
62	260	1 => ['pipe', 'w'], // child writes to stdout
63	260	2 => ['pipe', 'w'], // child writes to stderr
64	1040	3 => $this->getAuthStream(), // child reads from fd#3
65	260	4 => ['pipe', 'r'], // child reads from fd#4
66	260	5 => ['pipe', 'w'] // child writes to fd#5
67	260	];
68
69	1040	setlocale(LC_ALL, Server::LOCALE);
70	1040	$env = array_merge($this->env, [
71	1040	'CLI_FORCE_INTERACTIVE' => 'y', // Needed or the prompt isn't displayed!!
72	1040	'LC_ALL' => Server::LOCALE,
73	1040	'LANG' => Server::LOCALE,
74	780	'COLUMNS' => 8192 // prevent smbclient from line-wrapping it's output
75	260	]);
76	1040	$this->process = proc_open($this->command, $descriptorSpec, $this->pipes, '/', $env);
77	1040	if (!$this->isValid()) {
78		throw new ConnectionException();
79		}
80	1040	$this->connected = true;
81	1040	}
82
83		/**
84		* check if the connection is still active
85		*
86		* @return bool
87		*/
88	1040	public function isValid() {
89	1040	if (is_resource($this->process)) {
90	1040	$status = proc_get_status($this->process);
91	1040	return $status['running'];
92		} else {
93		return false;
94		}
95		}
96
97		/**
98		* send input to the process
99		*
100		* @param string $input
101		*/
102	1024	public function write($input) {
103	1024	fwrite($this->getInputStream(), $input);
104	1024	fflush($this->getInputStream());
105	1024	}
106
107		/**
108		* read a line of output
109		*
110		* @return string\|false
111		*/
112	1040	public function readLine() {
113	1040	return stream_get_line($this->getOutputStream(), 4086, "\n");
114		}
115
116		/**
117		* read a line of output
118		*
119		* @return string
120		*/
121		public function readError() {
122		return trim(stream_get_line($this->getErrorStream(), 4086));
123		}
124
125		/**
126		* get all output until the process closes
127		*
128		* @return array
129		*/
130	20	public function readAll() {
131	20	$output = [];
132	20	while ($line = $this->readLine()) {
133	20	$output[] = $line;
134	5	}
135	20	return $output;
136		}
137
138	1024	public function getInputStream() {
139	1024	return $this->pipes[0];
140		}
141
142	1040	public function getOutputStream() {
143	1040	return $this->pipes[1];
144		}
145
146		public function getErrorStream() {
147		return $this->pipes[2];
148		}
149
150	1040	public function getAuthStream() {
151	1040	return $this->authStream;
152		}
153
154	64	public function getFileInputStream() {
155	64	return $this->pipes[4];
156		}
157
158	64	public function getFileOutputStream() {
159	64	return $this->pipes[5];
160		}
161
162	1040	public function writeAuthentication($user, $password) {
163	1040	$auth = ($password === false)
164	260	? "username=$user"
165	1040	: "username=$user\npassword=$password\n";
166
167	1040	$this->authStream = fopen('php://temp', 'w+');
168	1040	fwrite($this->getAuthStream(), $auth);
169	1040	}
170
171	1040	public function close($terminate = true) {
172	1040	if (!is_resource($this->process)) {
173	84	return;
174		}
175	1040	if ($terminate) {
176		proc_terminate($this->process);
177	1040	}
178	1040	proc_close($this->process);
179	1040	}
180	1040
181	1040	public function reconnect() {
182	1040	$this->close();
183		$this->connect();
184	1032	}
185	256
186	260	public function __destruct() {
187	260	$this->close();
188	1040	}
189		}
190

icewind1991 / SMB

Pull Request — master (#79)

RawConnection::close() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like