NativeShare - Code Metrics - Inspection of "Implemented IShare::append()" - icewind1991/SMB - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#70)

by Raffael

created 2018-08-28 07:13 UTC

NativeShare A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	325
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

92.08%

Importance

Changes

Metric	Value
wmc	36
lcom	1
cbo	11
dl	0
loc	325
ccs	93
cts	101
cp	0.9208
rs	9.52
c	0
b	0
f	0

21 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	getState()	9	3
A	getName()	3	1
A	buildUrl()	10	2
A	stat()	3	1
A	dir()	17	4
A	getStat()	3	1
A	mkdir()	3	1
A	rmdir()	3	1
A	del()	3	1
A	rename()	3	1
A	put()	10	2
B	get()	27	6
A	read()	5	1
A	write()	5	1
A	append()	5	1
A	getAttribute()	3	1
A	setAttribute()	7	3
A	setMode()	3	1
A	notify()	9	2
A	__destruct()	3	1

<?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\Native;

use Icewind\SMB\AbstractShare;
use Icewind\SMB\Exception\DependencyException;
use Icewind\SMB\Exception\InvalidPathException;
use Icewind\SMB\Exception\InvalidResourceException;
use Icewind\SMB\INotifyHandler;
use Icewind\SMB\IServer;
use Icewind\SMB\Wrapped\Server;
use Icewind\SMB\Wrapped\Share;

class NativeShare extends AbstractShare {
	/**
	 * @var IServer $server
	 */
	private $server;

	/**
	 * @var string $name
	 */
	private $name;

	/**
	 * @var NativeState $state
	 */
	private $state;

	/**
	 * @param IServer $server
	 * @param string $name
	 */
	public function __construct($server, $name) {
		parent::__construct();
		$this->server = $server;
		$this->name = $name;
	}

	/**
	 * @throws \Icewind\SMB\Exception\ConnectionException
	 * @throws \Icewind\SMB\Exception\AuthenticationException
	 * @throws \Icewind\SMB\Exception\InvalidHostException
	 */
	protected function getState() {
		if ($this->state and $this->state instanceof NativeState) {
			return $this->state;
		}

		$this->state = new NativeState();
		$this->state->init($this->server->getAuth(), $this->server->getOptions());
		return $this->state;
	}

	/**
	 * Get the name of the share
	 *
	 * @return string
	 */
	public function getName() {
		return $this->name;
	}

	private function buildUrl($path) {
		$this->verifyPath($path);
		$url = sprintf('smb://%s/%s', $this->server->getHost(), $this->name);
		if ($path) {
			$path = trim($path, '/');
			$url .= '/';
			$url .= implode('/', array_map('rawurlencode', explode('/', $path)));
		}
		return $url;
	}

	/**
	 * List the content of a remote folder
	 *
	 * @param string $path
	 * @return \Icewind\SMB\IFileInfo[]
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\InvalidTypeException
	 */
	public function dir($path) {
		$files = [];

		$dh = $this->getState()->opendir($this->buildUrl($path));
		while ($file = $this->getState()->readdir($dh)) {
			$name = $file['name'];
			if ($name !== '.' and $name !== '..') {
				$fullPath = $path . '/' . $name;
				$files [] = new NativeFileInfo($this, $fullPath, $name, function () use ($fullPath) {
					return $this->getStat($fullPath);
				});
			}
		}

		$this->getState()->closedir($dh);
		return $files;
	}

	/**
	 * @param string $path
	 * @return \Icewind\SMB\IFileInfo
	 */
	public function stat($path) {
		return new NativeFileInfo($this, $path, basename($path), $this->getStat($path));
	}

	/**
	 * Get fstat
	 *
	 * @param string $path
	 * @return array
	 */
	private function getStat($path) {
		return $this->getState()->stat($this->buildUrl($path));
	}

	/**
	 * Create a folder on the share
	 *
	 * @param string $path
	 * @return bool
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\AlreadyExistsException
	 */
	public function mkdir($path) {
		return $this->getState()->mkdir($this->buildUrl($path));
	}

	/**
	 * Remove a folder on the share
	 *
	 * @param string $path
	 * @return bool
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\InvalidTypeException
	 */
	public function rmdir($path) {
		return $this->getState()->rmdir($this->buildUrl($path));
	}

	/**
	 * Delete a file on the share
	 *
	 * @param string $path
	 * @return bool
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\InvalidTypeException
	 */
	public function del($path) {
		return $this->getState()->unlink($this->buildUrl($path));
	}

	/**
	 * Rename a remote file
	 *
	 * @param string $from
	 * @param string $to
	 * @return bool
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\AlreadyExistsException
	 */
	public function rename($from, $to) {
		return $this->getState()->rename($this->buildUrl($from), $this->buildUrl($to));
	}

	/**
	 * Upload a local file
	 *
	 * @param string $source local file
	 * @param string $target remove file
	 * @return bool
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\InvalidTypeException
	 */
	public function put($source, $target) {
		$sourceHandle = fopen($source, 'rb');
		$targetHandle = $this->getState()->create($this->buildUrl($target));

		while ($data = fread($sourceHandle, NativeReadStream::CHUNK_SIZE)) {
			$this->getState()->write($targetHandle, $data);
		}
		$this->getState()->close($targetHandle);
		return true;
	}

	/**
	 * Download a remote file
	 *
	 * @param string $source remove file
	 * @param string $target local file
	 * @return bool
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\InvalidTypeException
	 * @throws \Icewind\SMB\Exception\InvalidPathException
	 * @throws \Icewind\SMB\Exception\InvalidResourceException
	 */
	public function get($source, $target) {
		if (!$target) {
			throw new InvalidPathException('Invalid target path: Filename cannot be empty');
		}
		$targetHandle = @fopen($target, 'wb');
		if (!$targetHandle) {
			$error = error_get_last();
			if (is_array($error)) {
				$reason = $error['message'];
			} else {
				$reason = 'Unknown error';
			}
			throw new InvalidResourceException('Failed opening local file "' . $target . '" for writing: ' . $reason);
		}

		$sourceHandle = $this->getState()->open($this->buildUrl($source), 'r');
		if (!$sourceHandle) {
			fclose($targetHandle);
			throw new InvalidResourceException('Failed opening remote file "' . $source . '" for reading');
		}

		while ($data = $this->getState()->read($sourceHandle, NativeReadStream::CHUNK_SIZE)) {
			fwrite($targetHandle, $data);
		}
		$this->getState()->close($sourceHandle);
		return true;
	}

	/**
	 * Open a readable stream to a remote file
	 *
	 * @param string $source
	 * @return resource a read only stream with the contents of the remote file
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\InvalidTypeException
	 */
	public function read($source) {
		$url = $this->buildUrl($source);
		$handle = $this->getState()->open($url, 'r');
		return NativeReadStream::wrap($this->getState(), $handle, 'r', $url);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * Open a writeable stream to a remote file
	 * Note: This method will truncate the file to 0bytes first
	 *
	 * @param string $source
	 * @return resource a writeable stream
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
	 * @throws \Icewind\SMB\Exception\InvalidTypeException
	 */
	public function write($source) {
		$url = $this->buildUrl($source);
		$handle = $this->getState()->create($url);
		return NativeWriteStream::wrap($this->getState(), $handle, 'w', $url);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * Open a writeable stream and set the cursor to the end of the stream
 	 *
 	 * @param string $source
	 * @return resource a writeable stream
	 *
	 * @throws \Icewind\SMB\Exception\NotFoundException
 	 * @throws \Icewind\SMB\Exception\InvalidTypeException
 	 */
	public function append($source) {
 		$url = $this->buildUrl($source);
 		$handle = $this->getState()->open($url, "a");
 		return NativeWriteStream::wrap($this->getState(), $handle, "a", $url);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	/**
	 * Get extended attributes for the path
	 *
	 * @param string $path
	 * @param string $attribute attribute to get the info
	 * @return string the attribute value
	 */
	public function getAttribute($path, $attribute) {
		return $this->getState()->getxattr($this->buildUrl($path), $attribute);
	}

	/**
	 * Set extended attributes for the given path
	 *
	 * @param string $path
	 * @param string $attribute attribute to get the info
	 * @param string|int $value
	 * @return mixed the attribute value
	 */
	public function setAttribute($path, $attribute, $value) {
		if ($attribute === 'system.dos_attr.mode' and is_int($value)) {
			$value = '0x' . dechex($value);
		}

		return $this->getState()->setxattr($this->buildUrl($path), $attribute, $value);
	}

	/**
	 * Set DOS comaptible node mode
	 *
	 * @param string $path
	 * @param int $mode a combination of FileInfo::MODE_READONLY, FileInfo::MODE_ARCHIVE, FileInfo::MODE_SYSTEM and FileInfo::MODE_HIDDEN, FileInfo::NORMAL
	 * @return mixed
	 */
	public function setMode($path, $mode) {
		return $this->setAttribute($path, 'system.dos_attr.mode', $mode);
	}

	/**
	 * Start smb notify listener
	 * Note: This is a blocking call
	 *
	 * @param string $path
	 * @return INotifyHandler
	 */
	public function notify($path) {
		// php-smbclient does not support notify (https://github.com/eduardok/libsmbclient-php/issues/29)
		// so we use the smbclient based backend for this
		if (!Server::available($this->server->getSystem())) {
			throw new DependencyException('smbclient not found in path for notify command');
		}
		$share = new Share($this->server, $this->getName(), $this->server->getSystem());
		return $share->notify($path);
	}

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


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\Native;
9
10		use Icewind\SMB\AbstractShare;
11		use Icewind\SMB\Exception\DependencyException;
12		use Icewind\SMB\Exception\InvalidPathException;
13		use Icewind\SMB\Exception\InvalidResourceException;
14		use Icewind\SMB\INotifyHandler;
15		use Icewind\SMB\IServer;
16		use Icewind\SMB\Wrapped\Server;
17		use Icewind\SMB\Wrapped\Share;
18
19		class NativeShare extends AbstractShare {
20		/**
21		* @var IServer $server
22		*/
23		private $server;
24
25		/**
26		* @var string $name
27		*/
28		private $name;
29
30		/**
31		* @var NativeState $state
32		*/
33		private $state;
34
35		/**
36		* @param IServer $server
37		* @param string $name
38		*/
39	510	public function __construct($server, $name) {
40	510	parent::__construct();
41	510	$this->server = $server;
42	510	$this->name = $name;
43	510	}
44
45		/**
46		* @throws \Icewind\SMB\Exception\ConnectionException
47		* @throws \Icewind\SMB\Exception\AuthenticationException
48		* @throws \Icewind\SMB\Exception\InvalidHostException
49		*/
50	510	protected function getState() {
51	510	if ($this->state and $this->state instanceof NativeState) {
52	510	return $this->state;
53		}
54
55	510	$this->state = new NativeState();
56	510	$this->state->init($this->server->getAuth(), $this->server->getOptions());
57	510	return $this->state;
58		}
59
60		/**
61		* Get the name of the share
62		*
63		* @return string
64		*/
65	2	public function getName() {
66	2	return $this->name;
67		}
68
69	510	private function buildUrl($path) {
70	510	$this->verifyPath($path);
71	510	$url = sprintf('smb://%s/%s', $this->server->getHost(), $this->name);
72	510	if ($path) {
73	510	$path = trim($path, '/');
74	510	$url .= '/';
75	510	$url .= implode('/', array_map('rawurlencode', explode('/', $path)));
76	255	}
77	510	return $url;
78		}
79
80		/**
81		* List the content of a remote folder
82		*
83		* @param string $path
84		* @return \Icewind\SMB\IFileInfo[]
85		*
86		* @throws \Icewind\SMB\Exception\NotFoundException
87		* @throws \Icewind\SMB\Exception\InvalidTypeException
88		*/
89	510	public function dir($path) {
90	510	$files = [];
91
92	510	$dh = $this->getState()->opendir($this->buildUrl($path));
93	510	while ($file = $this->getState()->readdir($dh)) {
94	510	$name = $file['name'];
95	510	if ($name !== '.' and $name !== '..') {
96	204	$fullPath = $path . '/' . $name;
97	204	$files [] = new NativeFileInfo($this, $fullPath, $name, function () use ($fullPath) {
98	204	return $this->getStat($fullPath);
99	204	});
100	102	}
101	255	}
102
103	510	$this->getState()->closedir($dh);
104	510	return $files;
105		}
106
107		/**
108		* @param string $path
109		* @return \Icewind\SMB\IFileInfo
110		*/
111	66	public function stat($path) {
112	66	return new NativeFileInfo($this, $path, basename($path), $this->getStat($path));
113		}
114
115	228	/**
116	228	* Get fstat
117		*
118		* @param string $path
119		* @return array
120		*/
121		private function getStat($path) {
122		return $this->getState()->stat($this->buildUrl($path));
123		}
124
125		/**
126		* Create a folder on the share
127		*
128	510	* @param string $path
129	510	* @return bool
130		*
131		* @throws \Icewind\SMB\Exception\NotFoundException
132		* @throws \Icewind\SMB\Exception\AlreadyExistsException
133		*/
134		public function mkdir($path) {
135		return $this->getState()->mkdir($this->buildUrl($path));
136		}
137
138		/**
139		* Remove a folder on the share
140		*
141	510	* @param string $path
142	510	* @return bool
143		*
144		* @throws \Icewind\SMB\Exception\NotFoundException
145		* @throws \Icewind\SMB\Exception\InvalidTypeException
146		*/
147		public function rmdir($path) {
148		return $this->getState()->rmdir($this->buildUrl($path));
149		}
150
151		/**
152		* Delete a file on the share
153		*
154	266	* @param string $path
155	266	* @return bool
156		*
157		* @throws \Icewind\SMB\Exception\NotFoundException
158		* @throws \Icewind\SMB\Exception\InvalidTypeException
159		*/
160		public function del($path) {
161		return $this->getState()->unlink($this->buildUrl($path));
162		}
163
164		/**
165		* Rename a remote file
166		*
167		* @param string $from
168	56	* @param string $to
169	56	* @return bool
170		*
171		* @throws \Icewind\SMB\Exception\NotFoundException
172		* @throws \Icewind\SMB\Exception\AlreadyExistsException
173		*/
174		public function rename($from, $to) {
175		return $this->getState()->rename($this->buildUrl($from), $this->buildUrl($to));
176		}
177
178		/**
179		* Upload a local file
180		*
181		* @param string $source local file
182	226	* @param string $target remove file
183	226	* @return bool
184	226	*
185		* @throws \Icewind\SMB\Exception\NotFoundException
186	204	* @throws \Icewind\SMB\Exception\InvalidTypeException
187	204	*/
188	102	public function put($source, $target) {
189	204	$sourceHandle = fopen($source, 'rb');
190	204	$targetHandle = $this->getState()->create($this->buildUrl($target));
191
192		while ($data = fread($sourceHandle, NativeReadStream::CHUNK_SIZE)) {
193		$this->getState()->write($targetHandle, $data);
194		}
195		$this->getState()->close($targetHandle);
196		return true;
197		}
198
199		/**
200		* Download a remote file
201		*
202		* @param string $source remove file
203		* @param string $target local file
204		* @return bool
205	88	*
206	88	* @throws \Icewind\SMB\Exception\NotFoundException
207	18	* @throws \Icewind\SMB\Exception\InvalidTypeException
208		* @throws \Icewind\SMB\Exception\InvalidPathException
209	70	* @throws \Icewind\SMB\Exception\InvalidResourceException
210	70	*/
211	2	public function get($source, $target) {
212	2	if (!$target) {
213	2	throw new InvalidPathException('Invalid target path: Filename cannot be empty');
214	1	}
215		$targetHandle = @fopen($target, 'wb');
216		if (!$targetHandle) {
217	2	$error = error_get_last();
218		if (is_array($error)) {
219		$reason = $error['message'];
220	68	} else {
221	64	$reason = 'Unknown error';
222		}
223		throw new InvalidResourceException('Failed opening local file "' . $target . '" for writing: ' . $reason);
224		}
225
226	64	$sourceHandle = $this->getState()->open($this->buildUrl($source), 'r');
227	64	if (!$sourceHandle) {
228	32	fclose($targetHandle);
229	64	throw new InvalidResourceException('Failed opening remote file "' . $source . '" for reading');
230	64	}
231
232		while ($data = $this->getState()->read($sourceHandle, NativeReadStream::CHUNK_SIZE)) {
233		fwrite($targetHandle, $data);
234		}
235		$this->getState()->close($sourceHandle);
236		return true;
237		}
238
239		/**
240		* Open a readable stream to a remote file
241		*
242	58	* @param string $source
243	58	* @return resource a read only stream with the contents of the remote file
244	40	*
245	40	* @throws \Icewind\SMB\Exception\NotFoundException
246		* @throws \Icewind\SMB\Exception\InvalidTypeException
247		*/
248		public function read($source) {
249		$url = $this->buildUrl($source);
250		$handle = $this->getState()->open($url, 'r');
251		return NativeReadStream::wrap($this->getState(), $handle, 'r', $url);
		0 ignored issues – show Documentation introduced 2018-03-13 17:17 UTC by Report Bug Copy Issue Report `$this->getState()` is of type `object<Icewind\SMB\Native\NativeState>`, but the function expects a `object<Icewind\SMB\NativeState>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
252		}
253
254		/**
255		* Open a writeable stream to a remote file
256		* Note: This method will truncate the file to 0bytes first
257	58	*
258	58	* @param string $source
259	40	* @return resource a writeable stream
260	40	*
261		* @throws \Icewind\SMB\Exception\NotFoundException
262		* @throws \Icewind\SMB\Exception\InvalidTypeException
263		*/
264		public function write($source) {
265		$url = $this->buildUrl($source);
266		$handle = $this->getState()->create($url);
267		return NativeWriteStream::wrap($this->getState(), $handle, 'w', $url);
		0 ignored issues – show Documentation introduced 2018-03-13 17:17 UTC by Report Bug Copy Issue Report `$this->getState()` is of type `object<Icewind\SMB\Native\NativeState>`, but the function expects a `object<Icewind\SMB\NativeState>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
268		}
269
270	28	/**
271	28	* Open a writeable stream and set the cursor to the end of the stream
272		*
273		* @param string $source
274		* @return resource a writeable stream
275		*
276		* @throws \Icewind\SMB\Exception\NotFoundException
277		* @throws \Icewind\SMB\Exception\InvalidTypeException
278		*/
279		public function append($source) {
280		$url = $this->buildUrl($source);
281		$handle = $this->getState()->open($url, "a");
282	16	return NativeWriteStream::wrap($this->getState(), $handle, "a", $url);
		0 ignored issues – show Documentation introduced 2018-08-24 14:55 UTC by Report Bug Copy Issue Report `$this->getState()` is of type `object<Icewind\SMB\Native\NativeState>`, but the function expects a `object<Icewind\SMB\NativeState>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
283	16	}
284	16
285	8	/**
286		* Get extended attributes for the path
287	16	*
288		* @param string $path
289		* @param string $attribute attribute to get the info
290		* @return string the attribute value
291		*/
292		public function getAttribute($path, $attribute) {
293		return $this->getState()->getxattr($this->buildUrl($path), $attribute);
294		}
295	16
296	16	/**
297		* Set extended attributes for the given path
298		*
299		* @param string $path
300		* @param string $attribute attribute to get the info
301		* @param string\|int $value
302		* @return mixed the attribute value
303		*/
304		public function setAttribute($path, $attribute, $value) {
305		if ($attribute === 'system.dos_attr.mode' and is_int($value)) {
306		$value = '0x' . dechex($value);
307		}
308
309		return $this->getState()->setxattr($this->buildUrl($path), $attribute, $value);
310		}
311
312		/**
313	510	* Set DOS comaptible node mode
314	510	*
315	510	* @param string $path
316		* @param int $mode a combination of FileInfo::MODE_READONLY, FileInfo::MODE_ARCHIVE, FileInfo::MODE_SYSTEM and FileInfo::MODE_HIDDEN, FileInfo::NORMAL
317		* @return mixed
318		*/
319		public function setMode($path, $mode) {
320		return $this->setAttribute($path, 'system.dos_attr.mode', $mode);
321		}
322
323		/**
324		* Start smb notify listener
325		* Note: This is a blocking call
326		*
327		* @param string $path
328		* @return INotifyHandler
329		*/
330		public function notify($path) {
331		// php-smbclient does not support notify (https://github.com/eduardok/libsmbclient-php/issues/29)
332		// so we use the smbclient based backend for this
333		if (!Server::available($this->server->getSystem())) {
334		throw new DependencyException('smbclient not found in path for notify command');
335		}
336		$share = new Share($this->server, $this->getName(), $this->server->getSystem());
337		return $share->notify($path);
338		}
339
340		public function __destruct() {
341		unset($this->state);
342		}
343		}
344

icewind1991 / SMB

Pull Request — master (#70)

NativeShare A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

21 Methods

Duplication Side-by-Side

Filter issues like