NativeState::rmdir() - Code Metrics - Inspection of "use dir instead of allinfo where possible" - icewind1991/SMB - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — stable2 ( 10fadc...4d0e89 )

by Robin

created 2019-02-06 16:00 UTC

NativeState::rmdir() A

↳ Parent: NativeState

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

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

use Icewind\SMB\Exception\Exception;

/**
 * Low level wrapper for libsmbclient-php with error handling
 */
class NativeState {
	/**
	 * @var resource
	 */
	protected $state;

	protected $handlerSet = false;

	protected $connected = false;

	// todo replace with static once <5.6 support is dropped
	// see error.h
	private static $exceptionMap = [
		1   => '\Icewind\SMB\Exception\ForbiddenException',
		2   => '\Icewind\SMB\Exception\NotFoundException',
		13  => '\Icewind\SMB\Exception\ForbiddenException',
		16  => '\Icewind\SMB\Exception\FileInUseException',
		17  => '\Icewind\SMB\Exception\AlreadyExistsException',
		20  => '\Icewind\SMB\Exception\InvalidTypeException',
		21  => '\Icewind\SMB\Exception\InvalidTypeException',
		22  => '\Icewind\SMB\Exception\InvalidArgumentException',
		28  => '\Icewind\SMB\Exception\OutOfSpaceException',
		39  => '\Icewind\SMB\Exception\NotEmptyException',
		110 => '\Icewind\SMB\Exception\TimedOutException',
		111 => '\Icewind\SMB\Exception\ConnectionRefusedException',
		112 => '\Icewind\SMB\Exception\HostDownException',
		113 => '\Icewind\SMB\Exception\NoRouteToHostException'
	];

	protected function handleError($path) {
		$error = smbclient_state_errno($this->state);
		if ($error === 0) {
			return;
		}
		throw Exception::fromMap(self::$exceptionMap, $error, $path);
	}

	protected function testResult($result, $uri) {
		if ($result === false or $result === null) {
			// smb://host/share/path
			if (is_string($uri)) {
				list(, , , , $path) = explode('/', $uri, 5);
				$path = '/' . $path;
			} else {
				$path = null;
			}
			$this->handleError($path);
		}
	}

	/**
	 * @param string $workGroup
	 * @param string $user
	 * @param string $password
	 * @return bool
	 */
	public function init($workGroup, $user, $password) {
		if ($this->connected) {
			return true;
		}
		$this->state = smbclient_state_new();
		smbclient_option_set($this->state, SMBCLIENT_OPT_AUTO_ANONYMOUS_LOGIN, false);
		$result = @smbclient_state_init($this->state, $workGroup, $user, $password);

		$this->testResult($result, '');
		$this->connected = true;
		return $result;
	}

	/**
	 * @param string $uri
	 * @return resource
	 */
	public function opendir($uri) {
		$result = @smbclient_opendir($this->state, $uri);

		$this->testResult($result, $uri);
		return $result;
	}

	/**
	 * @param resource $dir
	 * @return array
	 */
	public function readdir($dir) {
		$result = @smbclient_readdir($this->state, $dir);

		$this->testResult($result, $dir);
		return $result;
	}

	/**
	 * @param $dir
	 * @return bool
	 */
	public function closedir($dir) {
		$result = smbclient_closedir($this->state, $dir);

		$this->testResult($result, $dir);
		return $result;
	}

	/**
	 * @param string $old
	 * @param string $new
	 * @return bool
	 */
	public function rename($old, $new) {
		$result = @smbclient_rename($this->state, $old, $this->state, $new);

		$this->testResult($result, $new);
		return $result;
	}

	/**
	 * @param string $uri
	 * @return bool
	 */
	public function unlink($uri) {
		$result = @smbclient_unlink($this->state, $uri);

		$this->testResult($result, $uri);
		return $result;
	}

	/**
	 * @param string $uri
	 * @param int $mask
	 * @return bool
	 */
	public function mkdir($uri, $mask = 0777) {
		$result = @smbclient_mkdir($this->state, $uri, $mask);

		$this->testResult($result, $uri);
		return $result;
	}

	/**
	 * @param string $uri
	 * @return bool
	 */
	public function rmdir($uri) {
		$result = @smbclient_rmdir($this->state, $uri);

		$this->testResult($result, $uri);
		return $result;
	}

	/**
	 * @param string $uri
	 * @return array
	 */
	public function stat($uri) {
		$result = @smbclient_stat($this->state, $uri);

		$this->testResult($result, $uri);
		return $result;
	}

	/**
	 * @param resource $file
	 * @return array
	 */
	public function fstat($file) {
		$result = @smbclient_fstat($this->state, $file);

		$this->testResult($result, $file);
		return $result;
	}

	/**
	 * @param string $uri
	 * @param string $mode
	 * @param int $mask
	 * @return resource
	 */
	public function open($uri, $mode, $mask = 0666) {
		$result = @smbclient_open($this->state, $uri, $mode, $mask);

		$this->testResult($result, $uri);
		return $result;
	}

	/**
	 * @param string $uri
	 * @param int $mask
	 * @return resource
	 */
	public function create($uri, $mask = 0666) {
		$result = @smbclient_creat($this->state, $uri, $mask);

		$this->testResult($result, $uri);
		return $result;
	}

	/**
	 * @param resource $file
	 * @param int $bytes
	 * @return string
	 */
	public function read($file, $bytes) {
		$result = @smbclient_read($this->state, $file, $bytes);

		$this->testResult($result, $file);
		return $result;
	}

	/**
	 * @param resource $file
	 * @param string $data
	 * @param int $length
	 * @return int
	 */
	public function write($file, $data, $length = null) {
		$result = @smbclient_write($this->state, $file, $data, $length);

		$this->testResult($result, $file);
		return $result;
	}

	/**
	 * @param resource $file
	 * @param int $offset
	 * @param int $whence SEEK_SET | SEEK_CUR | SEEK_END
	 * @return int|bool new file offset as measured from the start of the file on success, false on failure.
	 */
	public function lseek($file, $offset, $whence = SEEK_SET) {
		$result = @smbclient_lseek($this->state, $file, $offset, $whence);

		$this->testResult($result, $file);
		return $result;
	}

	/**
	 * @param resource $file
	 * @param int $size
	 * @return bool
	 */
	public function ftruncate($file, $size) {
		$result = @smbclient_ftruncate($this->state, $file, $size);

		$this->testResult($result, $file);
		return $result;
	}

	public function close($file) {
		$result = @smbclient_close($this->state, $file);

		$this->testResult($result, $file);
		return $result;
	}

	/**
	 * @param string $uri
	 * @param string $key
	 * @return string
	 */
	public function getxattr($uri, $key) {
		$result = @smbclient_getxattr($this->state, $uri, $key);

		$this->testResult($result, $uri);
		return $result;
	}

	/**
	 * @param string $uri
	 * @param string $key
	 * @param string $value
	 * @param int $flags
	 * @return mixed
	 */
	public function setxattr($uri, $key, $value, $flags = 0) {
		$result = @smbclient_setxattr($this->state, $uri, $key, $value, $flags);

		$this->testResult($result, $uri);
		return $result;
	}

	public function __destruct() {
		if ($this->connected) {
			smbclient_state_free($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;
9
10			use Icewind\SMB\Exception\Exception;
11
12			/**
13			* Low level wrapper for libsmbclient-php with error handling
14			*/
15			class NativeState {
16			/**
17			* @var resource
18			*/
19			protected $state;
20
21			protected $handlerSet = false;
22
23			protected $connected = false;
24
25			// todo replace with static once <5.6 support is dropped
26			// see error.h
27			private static $exceptionMap = [
28			1 => '\Icewind\SMB\Exception\ForbiddenException',
29			2 => '\Icewind\SMB\Exception\NotFoundException',
30			13 => '\Icewind\SMB\Exception\ForbiddenException',
31			16 => '\Icewind\SMB\Exception\FileInUseException',
32			17 => '\Icewind\SMB\Exception\AlreadyExistsException',
33			20 => '\Icewind\SMB\Exception\InvalidTypeException',
34			21 => '\Icewind\SMB\Exception\InvalidTypeException',
35			22 => '\Icewind\SMB\Exception\InvalidArgumentException',
36			28 => '\Icewind\SMB\Exception\OutOfSpaceException',
37			39 => '\Icewind\SMB\Exception\NotEmptyException',
38			110 => '\Icewind\SMB\Exception\TimedOutException',
39			111 => '\Icewind\SMB\Exception\ConnectionRefusedException',
40			112 => '\Icewind\SMB\Exception\HostDownException',
41			113 => '\Icewind\SMB\Exception\NoRouteToHostException'
42			];
43
44			protected function handleError($path) {
45			$error = smbclient_state_errno($this->state);
46			if ($error === 0) {
47			return;
48			}
49			throw Exception::fromMap(self::$exceptionMap, $error, $path);
50			}
51
52			protected function testResult($result, $uri) {
53			if ($result === false or $result === null) {
54			// smb://host/share/path
55			if (is_string($uri)) {
56			list(, , , , $path) = explode('/', $uri, 5);
57			$path = '/' . $path;
58			} else {
59			$path = null;
60			}
61			$this->handleError($path);
62			}
63			}
64
65			/**
66			* @param string $workGroup
67			* @param string $user
68			* @param string $password
69			* @return bool
70			*/
71			public function init($workGroup, $user, $password) {
72			if ($this->connected) {
73			return true;
74			}
75			$this->state = smbclient_state_new();
76			smbclient_option_set($this->state, SMBCLIENT_OPT_AUTO_ANONYMOUS_LOGIN, false);
77			$result = @smbclient_state_init($this->state, $workGroup, $user, $password);
78
79			$this->testResult($result, '');
80			$this->connected = true;
81			return $result;
82			}
83
84			/**
85			* @param string $uri
86			* @return resource
87			*/
88			public function opendir($uri) {
89			$result = @smbclient_opendir($this->state, $uri);
90
91			$this->testResult($result, $uri);
92			return $result;
93			}
94
95			/**
96			* @param resource $dir
97			* @return array
98			*/
99			public function readdir($dir) {
100			$result = @smbclient_readdir($this->state, $dir);
101
102			$this->testResult($result, $dir);
103			return $result;
104			}
105
106			/**
107			* @param $dir
108			* @return bool
109			*/
110			public function closedir($dir) {
111			$result = smbclient_closedir($this->state, $dir);
112
113			$this->testResult($result, $dir);
114			return $result;
115			}
116
117			/**
118			* @param string $old
119			* @param string $new
120			* @return bool
121			*/
122			public function rename($old, $new) {
123			$result = @smbclient_rename($this->state, $old, $this->state, $new);
124
125			$this->testResult($result, $new);
126			return $result;
127			}
128
129			/**
130			* @param string $uri
131			* @return bool
132			*/
133			public function unlink($uri) {
134			$result = @smbclient_unlink($this->state, $uri);
135
136			$this->testResult($result, $uri);
137			return $result;
138			}
139
140			/**
141			* @param string $uri
142			* @param int $mask
143			* @return bool
144			*/
145			public function mkdir($uri, $mask = 0777) {
146			$result = @smbclient_mkdir($this->state, $uri, $mask);
147
148			$this->testResult($result, $uri);
149			return $result;
150			}
151
152			/**
153			* @param string $uri
154			* @return bool
155			*/
156			public function rmdir($uri) {
157			$result = @smbclient_rmdir($this->state, $uri);
158
159			$this->testResult($result, $uri);
160			return $result;
161			}
162
163			/**
164			* @param string $uri
165			* @return array
166			*/
167			public function stat($uri) {
168			$result = @smbclient_stat($this->state, $uri);
169
170			$this->testResult($result, $uri);
171			return $result;
172			}
173
174			/**
175			* @param resource $file
176			* @return array
177			*/
178			public function fstat($file) {
179			$result = @smbclient_fstat($this->state, $file);
180
181			$this->testResult($result, $file);
182			return $result;
183			}
184
185			/**
186			* @param string $uri
187			* @param string $mode
188			* @param int $mask
189			* @return resource
190			*/
191			public function open($uri, $mode, $mask = 0666) {
192			$result = @smbclient_open($this->state, $uri, $mode, $mask);
193
194			$this->testResult($result, $uri);
195			return $result;
196			}
197
198			/**
199			* @param string $uri
200			* @param int $mask
201			* @return resource
202			*/
203			public function create($uri, $mask = 0666) {
204			$result = @smbclient_creat($this->state, $uri, $mask);
205
206			$this->testResult($result, $uri);
207			return $result;
208			}
209
210			/**
211			* @param resource $file
212			* @param int $bytes
213			* @return string
214			*/
215			public function read($file, $bytes) {
216			$result = @smbclient_read($this->state, $file, $bytes);
217
218			$this->testResult($result, $file);
219			return $result;
220			}
221
222			/**
223			* @param resource $file
224			* @param string $data
225			* @param int $length
226			* @return int
227			*/
228			public function write($file, $data, $length = null) {
229			$result = @smbclient_write($this->state, $file, $data, $length);
230
231			$this->testResult($result, $file);
232			return $result;
233			}
234
235			/**
236			* @param resource $file
237			* @param int $offset
238			* @param int $whence SEEK_SET \| SEEK_CUR \| SEEK_END
239			* @return int\|bool new file offset as measured from the start of the file on success, false on failure.
240			*/
241			public function lseek($file, $offset, $whence = SEEK_SET) {
242			$result = @smbclient_lseek($this->state, $file, $offset, $whence);
243
244			$this->testResult($result, $file);
245			return $result;
246			}
247
248			/**
249			* @param resource $file
250			* @param int $size
251			* @return bool
252			*/
253			public function ftruncate($file, $size) {
254			$result = @smbclient_ftruncate($this->state, $file, $size);
255
256			$this->testResult($result, $file);
257			return $result;
258			}
259
260			public function close($file) {
261			$result = @smbclient_close($this->state, $file);
262
263			$this->testResult($result, $file);
264			return $result;
265			}
266
267			/**
268			* @param string $uri
269			* @param string $key
270			* @return string
271			*/
272			public function getxattr($uri, $key) {
273			$result = @smbclient_getxattr($this->state, $uri, $key);
274
275			$this->testResult($result, $uri);
276			return $result;
277			}
278
279			/**
280			* @param string $uri
281			* @param string $key
282			* @param string $value
283			* @param int $flags
284			* @return mixed
285			*/
286			public function setxattr($uri, $key, $value, $flags = 0) {
287			$result = @smbclient_setxattr($this->state, $uri, $key, $value, $flags);
288
289			$this->testResult($result, $uri);
290			return $result;
291			}
292
293			public function __destruct() {
294			if ($this->connected) {
295			smbclient_state_free($this->state);
296			}
297			}
298			}
299

icewind1991 / SMB

Push — stable2 ( 10fadc...4d0e89 )

NativeState::rmdir() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like