Parser::parseListShares() - Code Metrics - Inspection of "improve error handling" - icewind1991/SMB - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 80a4ed...26ec76 )

by Robin

created 2021-03-02 18:06 UTC

Parser::parseListShares() A

↳ Parent: Parser

Complexity

Conditions	5
Paths	5

Size

Total Lines	15
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	5.5069

Importance

Changes

Metric	Value
cc	5
eloc	10
nc	5
nop	1
dl	0
loc	15
ccs	8
cts	11
cp	0.7272
crap	5.5069
rs	9.6111
c	0
b	0
f	0

<?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\AccessDeniedException;
use Icewind\SMB\Exception\AlreadyExistsException;
use Icewind\SMB\Exception\AuthenticationException;
use Icewind\SMB\Exception\Exception;
use Icewind\SMB\Exception\FileInUseException;
use Icewind\SMB\Exception\InvalidHostException;
use Icewind\SMB\Exception\InvalidParameterException;
use Icewind\SMB\Exception\InvalidResourceException;
use Icewind\SMB\Exception\InvalidTypeException;
use Icewind\SMB\Exception\NoLoginServerException;
use Icewind\SMB\Exception\NotEmptyException;
use Icewind\SMB\Exception\NotFoundException;

class Parser {
	const MSG_NOT_FOUND = 'Error opening local file ';

	/**
	 * @var string
	 */
	protected $timeZone;

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


	// see error.h
	const EXCEPTION_MAP = [
		ErrorCodes::LogonFailure      => AuthenticationException::class,
		ErrorCodes::PathNotFound      => NotFoundException::class,
		ErrorCodes::ObjectNotFound    => NotFoundException::class,
		ErrorCodes::NoSuchFile        => NotFoundException::class,
		ErrorCodes::NameCollision     => AlreadyExistsException::class,
		ErrorCodes::AccessDenied      => AccessDeniedException::class,
		ErrorCodes::DirectoryNotEmpty => NotEmptyException::class,
		ErrorCodes::FileIsADirectory  => InvalidTypeException::class,
		ErrorCodes::NotADirectory     => InvalidTypeException::class,
		ErrorCodes::SharingViolation  => FileInUseException::class,
		ErrorCodes::InvalidParameter  => InvalidParameterException::class
	];

	const MODE_STRINGS = [
		'R' => FileInfo::MODE_READONLY,
		'H' => FileInfo::MODE_HIDDEN,
		'S' => FileInfo::MODE_SYSTEM,
		'D' => FileInfo::MODE_DIRECTORY,
		'A' => FileInfo::MODE_ARCHIVE,
		'N' => FileInfo::MODE_NORMAL
	];

	/**
	 * @param string $timeZone
	 */
	public function __construct($timeZone) {
		$this->timeZone = $timeZone;
	}

	private function getErrorCode($line) {
		$parts = explode(' ', $line);
		foreach ($parts as $part) {
			if (substr($part, 0, 9) === 'NT_STATUS') {
				return $part;
			}
		}
		return false;
	}

	public function checkForError($output, $path) {
		if (strpos($output[0], 'does not exist')) {
			throw new NotFoundException($path);
		}
		$error = $this->getErrorCode($output[0]);

		if (substr($output[0], 0, strlen(self::MSG_NOT_FOUND)) === self::MSG_NOT_FOUND) {
			$localPath = substr($output[0], strlen(self::MSG_NOT_FOUND));
			throw new InvalidResourceException('Failed opening local file "' . $localPath . '" for writing');
		}

		throw Exception::fromMap(self::EXCEPTION_MAP, $error, $path);
	}

	/**
	 * check if the first line holds a connection failure
	 *
	 * @param $line
	 * @throws AuthenticationException
	 * @throws InvalidHostException
	 * @throws NoLoginServerException
	 * @throws AccessDeniedException
	 */
	public function checkConnectionError($line) {
		$line = rtrim($line, ')');
		if (substr($line, -23) === ErrorCodes::LogonFailure) {
			throw new AuthenticationException('Invalid login');
		}
		if (substr($line, -26) === ErrorCodes::BadHostName) {
			throw new InvalidHostException('Invalid hostname');
		}
		if (substr($line, -22) === ErrorCodes::Unsuccessful) {
			throw new InvalidHostException('Connection unsuccessful');
		}
		if (substr($line, -28) === ErrorCodes::ConnectionRefused) {
			throw new InvalidHostException('Connection refused');
		}
		if (substr($line, -26) === ErrorCodes::NoLogonServers) {
			throw new NoLoginServerException('No login server');
		}
		if (substr($line, -23) === ErrorCodes::AccessDenied) {
			throw new AccessDeniedException('Access denied');
		}
	}

	public function parseMode($mode) {
		$result = 0;
		foreach (self::MODE_STRINGS as $char => $val) {
			if (strpos($mode, $char) !== false) {
				$result |= $val;
			}
		}
		return $result;
	}

	public function parseStat($output) {
		$data = [];
		foreach ($output as $line) {
			// A line = explode statement may not fill all array elements
			// properly. May happen when accessing non Windows Fileservers
			$words = explode(':', $line, 2);
			$name = isset($words[0]) ? $words[0] : '';
			$value = isset($words[1]) ? $words[1] : '';
			$value = trim($value);

			if (!isset($data[$name])) {
				$data[$name] = $value;
			}
		}
		return [
			'mtime' => strtotime($data['write_time']),
			'mode'  => hexdec(substr($data['attributes'], strpos($data['attributes'], '(') + 1, -1)),
			'size'  => isset($data['stream']) ? (int)(explode(' ', $data['stream'])[1]) : 0
		];
	}

	public function parseDir($output, $basePath, callable $aclCallback) {
		//last line is used space
		array_pop($output);
		$regex = '/^\s*(.*?)\s\s\s\s+(?:([NDHARS]*)\s+)?([0-9]+)\s+(.*)$/';
		//2 spaces, filename, optional type, size, date
		$content = [];
		foreach ($output as $line) {
			if (preg_match($regex, $line, $matches)) {
				list(, $name, $mode, $size, $time) = $matches;
				if ($name !== '.' and $name !== '..') {
					$mode = $this->parseMode($mode);
					$time = strtotime($time . ' ' . $this->timeZone);
					$path = $basePath . '/' . $name;
					$content[] = new FileInfo($path, $name, $size, $time, $mode, function () use ($aclCallback, $path) {
						return $aclCallback($path);
					});
				}
			}
		}
		return $content;
	}

	public function parseListShares($output) {
		$shareNames = [];
		foreach ($output as $line) {
			if (strpos($line, '|')) {
				list($type, $name, $description) = explode('|', $line);
				if (strtolower($type) === 'disk') {
					$shareNames[$name] = $description;
				}
			} elseif (strpos($line, 'Disk')) {
				// new output format
				list($name, $description) = explode('Disk', $line);
				$shareNames[trim($name)] = trim($description);
			}
		}
		return $shareNames;
	}
}


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\AccessDeniedException;
11		use Icewind\SMB\Exception\AlreadyExistsException;
12		use Icewind\SMB\Exception\AuthenticationException;
13		use Icewind\SMB\Exception\Exception;
14		use Icewind\SMB\Exception\FileInUseException;
15		use Icewind\SMB\Exception\InvalidHostException;
16		use Icewind\SMB\Exception\InvalidParameterException;
17		use Icewind\SMB\Exception\InvalidResourceException;
18		use Icewind\SMB\Exception\InvalidTypeException;
19		use Icewind\SMB\Exception\NoLoginServerException;
20		use Icewind\SMB\Exception\NotEmptyException;
21		use Icewind\SMB\Exception\NotFoundException;
22
23		class Parser {
24		const MSG_NOT_FOUND = 'Error opening local file ';
25
26		/**
27		* @var string
28		*/
29		protected $timeZone;
30
31		/**
32		* @var string
33		*/
34		private $host;
		0 ignored issues – show introduced 2020-02-10 15:21 UTC by Report Bug Copy Issue Report The private property `$host` is not used, and could be removed. Loading history...
35
36		// see error.h
37		const EXCEPTION_MAP = [
38		ErrorCodes::LogonFailure => AuthenticationException::class,
39		ErrorCodes::PathNotFound => NotFoundException::class,
40		ErrorCodes::ObjectNotFound => NotFoundException::class,
41		ErrorCodes::NoSuchFile => NotFoundException::class,
42		ErrorCodes::NameCollision => AlreadyExistsException::class,
43		ErrorCodes::AccessDenied => AccessDeniedException::class,
44		ErrorCodes::DirectoryNotEmpty => NotEmptyException::class,
45		ErrorCodes::FileIsADirectory => InvalidTypeException::class,
46		ErrorCodes::NotADirectory => InvalidTypeException::class,
47		ErrorCodes::SharingViolation => FileInUseException::class,
48		ErrorCodes::InvalidParameter => InvalidParameterException::class
49		];
50
51		const MODE_STRINGS = [
52		'R' => FileInfo::MODE_READONLY,
53		'H' => FileInfo::MODE_HIDDEN,
54		'S' => FileInfo::MODE_SYSTEM,
55		'D' => FileInfo::MODE_DIRECTORY,
56		'A' => FileInfo::MODE_ARCHIVE,
57		'N' => FileInfo::MODE_NORMAL
58		];
59
60		/**
61		* @param string $timeZone
62		*/
63	542	public function __construct($timeZone) {
64	542	$this->timeZone = $timeZone;
65	542	}
66
67	38	private function getErrorCode($line) {
68	38	$parts = explode(' ', $line);
69	38	foreach ($parts as $part) {
70	38	if (substr($part, 0, 9) === 'NT_STATUS') {
71	38	return $part;
72		}
73		}
74	2	return false;
75		}
76
77	38	public function checkForError($output, $path) {
78	38	if (strpos($output[0], 'does not exist')) {
79		throw new NotFoundException($path);
80		}
81	38	$error = $this->getErrorCode($output[0]);
82
83	38	if (substr($output[0], 0, strlen(self::MSG_NOT_FOUND)) === self::MSG_NOT_FOUND) {
84	2	$localPath = substr($output[0], strlen(self::MSG_NOT_FOUND));
85	2	throw new InvalidResourceException('Failed opening local file "' . $localPath . '" for writing');
86		}
87
88	38	throw Exception::fromMap(self::EXCEPTION_MAP, $error, $path);
89		}
90
91		/**
92		* check if the first line holds a connection failure
93		*
94		* @param $line
95		* @throws AuthenticationException
96		* @throws InvalidHostException
97		* @throws NoLoginServerException
98		* @throws AccessDeniedException
99		*/
100	494	public function checkConnectionError($line) {
101	494	$line = rtrim($line, ')');
102	494	if (substr($line, -23) === ErrorCodes::LogonFailure) {
103	2	throw new AuthenticationException('Invalid login');
104		}
105	492	if (substr($line, -26) === ErrorCodes::BadHostName) {
106		throw new InvalidHostException('Invalid hostname');
107		}
108	492	if (substr($line, -22) === ErrorCodes::Unsuccessful) {
109	6	throw new InvalidHostException('Connection unsuccessful');
110		}
111	488	if (substr($line, -28) === ErrorCodes::ConnectionRefused) {
112		throw new InvalidHostException('Connection refused');
113		}
114	488	if (substr($line, -26) === ErrorCodes::NoLogonServers) {
115		throw new NoLoginServerException('No login server');
116		}
117	488	if (substr($line, -23) === ErrorCodes::AccessDenied) {
118		throw new AccessDeniedException('Access denied');
119		}
120	488	}
121
122	230	public function parseMode($mode) {
123	230	$result = 0;
124	230	foreach (self::MODE_STRINGS as $char => $val) {
125	230	if (strpos($mode, $char) !== false) {
126	230	$result \|= $val;
127		}
128		}
129	230	return $result;
130		}
131
132	14	public function parseStat($output) {
133	14	$data = [];
134	14	foreach ($output as $line) {
135		// A line = explode statement may not fill all array elements
136		// properly. May happen when accessing non Windows Fileservers
137	14	$words = explode(':', $line, 2);
138	14	$name = isset($words[0]) ? $words[0] : '';
139	14	$value = isset($words[1]) ? $words[1] : '';
140	14	$value = trim($value);
141
142	14	if (!isset($data[$name])) {
143	14	$data[$name] = $value;
144		}
145		}
146		return [
147	14	'mtime' => strtotime($data['write_time']),
148	14	'mode' => hexdec(substr($data['attributes'], strpos($data['attributes'], '(') + 1, -1)),
149	14	'size' => isset($data['stream']) ? (int)(explode(' ', $data['stream'])[1]) : 0
150		];
151		}
152
153	488	public function parseDir($output, $basePath, callable $aclCallback) {
154		//last line is used space
155	488	array_pop($output);
156	488	$regex = '/^\s(.?)\s\s\s\s+(?:([NDHARS])\s+)?([0-9]+)\s+(.)$/';
157		//2 spaces, filename, optional type, size, date
158	488	$content = [];
159	488	foreach ($output as $line) {
160	488	if (preg_match($regex, $line, $matches)) {
161	488	list(, $name, $mode, $size, $time) = $matches;
162	488	if ($name !== '.' and $name !== '..') {
163	198	$mode = $this->parseMode($mode);
164	198	$time = strtotime($time . ' ' . $this->timeZone);
165	198	$path = $basePath . '/' . $name;
166	198	$content[] = new FileInfo($path, $name, $size, $time, $mode, function () use ($aclCallback, $path) {
167		return $aclCallback($path);
168	198	});
169		}
170		}
171		}
172	488	return $content;
173		}
174
175	4	public function parseListShares($output) {
176	4	$shareNames = [];
177	4	foreach ($output as $line) {
178	4	if (strpos($line, '\|')) {
179		list($type, $name, $description) = explode('\|', $line);
180		if (strtolower($type) === 'disk') {
181		$shareNames[$name] = $description;
182		}
183	4	} elseif (strpos($line, 'Disk')) {
184		// new output format
185	4	list($name, $description) = explode('Disk', $line);
186	4	$shareNames[trim($name)] = trim($description);
187		}
188		}
189	4	return $shareNames;
190		}
191		}
192

icewind1991 / SMB

Push — master ( 80a4ed...26ec76 )

Parser::parseListShares() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like