nextcloud / server

apps/files_external/lib/Lib/Storage/SMB.php

Indentation +675 added lines, -675 removed lines

@@ -69,679 +69,679 @@
 use OCP\ILogger;
 
 class SMB extends Common implements INotifyStorage {
-	/**
-	 * @var \Icewind\SMB\IServer
-	 */
-	protected $server;
-
-	/**
-	 * @var \Icewind\SMB\IShare
-	 */
-	protected $share;
-
-	/**
-	 * @var string
-	 */
-	protected $root;
-
-	/**
-	 * @var IFileInfo[]
-	 */
-	protected $statCache;
-
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var bool */
-	protected $showHidden;
-
-	/** @var bool */
-	protected $checkAcl;
-
-	public function __construct($params) {
-		if (!isset($params['host'])) {
-			throw new \Exception('Invalid configuration, no host provided');
-		}
-
-		if (isset($params['auth'])) {
-			$auth = $params['auth'];
-		} elseif (isset($params['user']) && isset($params['password']) && isset($params['share'])) {
-			[$workgroup, $user] = $this->splitUser($params['user']);
-			$auth = new BasicAuth($user, $workgroup, $params['password']);
-		} else {
-			throw new \Exception('Invalid configuration, no credentials provided');
-		}
-
-		if (isset($params['logger'])) {
-			$this->logger = $params['logger'];
-		} else {
-			$this->logger = \OC::$server->getLogger();
-		}
-
-		$options = new Options();
-		if (isset($params['timeout'])) {
-			$timeout = (int)$params['timeout'];
-			if ($timeout > 0) {
-				$options->setTimeout($timeout);
-			}
-		}
-		$serverFactory = new ServerFactory($options);
-		$this->server = $serverFactory->createServer($params['host'], $auth);
-		$this->share = $this->server->getShare(trim($params['share'], '/'));
-
-		$this->root = $params['root'] ?? '/';
-		$this->root = '/' . ltrim($this->root, '/');
-		$this->root = rtrim($this->root, '/') . '/';
-
-		$this->showHidden = isset($params['show_hidden']) && $params['show_hidden'];
-		$this->checkAcl = isset($params['check_acl']) && $params['check_acl'];
-
-		$this->statCache = new CappedMemoryCache();
-		parent::__construct($params);
-	}
-
-	private function splitUser($user) {
-		if (strpos($user, '/')) {
-			return explode('/', $user, 2);
-		} elseif (strpos($user, '\\')) {
-			return explode('\\', $user);
-		} else {
-			return [null, $user];
-		}
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getId() {
-		// FIXME: double slash to keep compatible with the old storage ids,
-		// failure to do so will lead to creation of a new storage id and
-		// loss of shares from the storage
-		return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	protected function buildPath($path) {
-		return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
-	}
-
-	protected function relativePath($fullPath) {
-		if ($fullPath === $this->root) {
-			return '';
-		} elseif (substr($fullPath, 0, strlen($this->root)) === $this->root) {
-			return substr($fullPath, strlen($this->root));
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return IFileInfo
-	 * @throws StorageAuthException
-	 */
-	protected function getFileInfo($path) {
-		try {
-			$path = $this->buildPath($path);
-			$cached = $this->statCache[$path] ?? null;
-			if ($cached instanceof IFileInfo) {
-				return $cached;
-			} else {
-				$stat = $this->share->stat($path);
-				$this->statCache[$path] = $stat;
-				return $stat;
-			}
-		} catch (ConnectException $e) {
-			$this->throwUnavailable($e);
-		} catch (ForbiddenException $e) {
-			// with php-smbclient, this exception is thrown when the provided password is invalid.
-			// Possible is also ForbiddenException with a different error code, so we check it.
-			if ($e->getCode() === 1) {
-				$this->throwUnavailable($e);
-			}
-			throw $e;
-		}
-	}
-
-	/**
-	 * @param \Exception $e
-	 * @return never
-	 * @throws StorageAuthException
-	 */
-	protected function throwUnavailable(\Exception $e) {
-		$this->logger->logException($e, ['message' => 'Error while getting file info']);
-		throw new StorageAuthException($e->getMessage(), $e);
-	}
-
-	/**
-	 * get the acl from fileinfo that is relevant for the configured user
-	 *
-	 * @param IFileInfo $file
-	 * @return ACL|null
-	 */
-	private function getACL(IFileInfo $file): ?ACL {
-		$acls = $file->getAcls();
-		foreach ($acls as $user => $acl) {
-			[, $user] = $this->splitUser($user); // strip domain
-			if ($user === $this->server->getAuth()->getUsername()) {
-				return $acl;
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * @param string $path
-	 * @return \Generator<IFileInfo>
-	 * @throws StorageNotAvailableException
-	 */
-	protected function getFolderContents($path): iterable {
-		try {
-			$path = ltrim($this->buildPath($path), '/');
-			try {
-				$files = $this->share->dir($path);
-			} catch (ForbiddenException $e) {
-				$this->logger->critical($e->getMessage(), ['exception' => $e]);
-				throw new NotPermittedException();
-			} catch (InvalidTypeException $e) {
-				return;
-			}
-			foreach ($files as $file) {
-				$this->statCache[$path . '/' . $file->getName()] = $file;
-			}
-
-			foreach ($files as $file) {
-				try {
-					// the isHidden check is done before checking the config boolean to ensure that the metadata is always fetch
-					// so we trigger the below exceptions where applicable
-					$hide = $file->isHidden() && !$this->showHidden;
-
-					if ($this->checkAcl && $acl = $this->getACL($file)) {
-						// if there is no explicit deny, we assume it's allowed
-						// this doesn't take inheritance fully into account but if read permissions is denied for a parent we wouldn't be in this folder
-						// additionally, it's better to have false negatives here then false positives
-						if ($acl->denies(ACL::MASK_READ) || $acl->denies(ACL::MASK_EXECUTE)) {
-							$this->logger->debug('Hiding non readable entry ' . $file->getName());
-							continue;
-						}
-					}
-
-					if ($hide) {
-						$this->logger->debug('hiding hidden file ' . $file->getName());
-					}
-					if (!$hide) {
-						yield $file;
-					}
-				} catch (ForbiddenException $e) {
-					$this->logger->logException($e, ['level' => ILogger::DEBUG, 'message' => 'Hiding forbidden entry ' . $file->getName()]);
-				} catch (NotFoundException $e) {
-					$this->logger->logException($e, ['level' => ILogger::DEBUG, 'message' => 'Hiding not found entry ' . $file->getName()]);
-				}
-			}
-		} catch (ConnectException $e) {
-			$this->logger->logException($e, ['message' => 'Error while getting folder content']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * @param IFileInfo $info
-	 * @return array
-	 */
-	protected function formatInfo($info) {
-		$result = [
-			'size' => $info->getSize(),
-			'mtime' => $info->getMTime(),
-		];
-		if ($info->isDirectory()) {
-			$result['type'] = 'dir';
-		} else {
-			$result['type'] = 'file';
-		}
-		return $result;
-	}
-
-	/**
-	 * Rename the files. If the source or the target is the root, the rename won't happen.
-	 *
-	 * @param string $source the old name of the path
-	 * @param string $target the new name of the path
-	 * @return bool true if the rename is successful, false otherwise
-	 */
-	public function rename($source, $target, $retry = true) {
-		if ($this->isRootDir($source) || $this->isRootDir($target)) {
-			return false;
-		}
-
-		$absoluteSource = $this->buildPath($source);
-		$absoluteTarget = $this->buildPath($target);
-		try {
-			$result = $this->share->rename($absoluteSource, $absoluteTarget);
-		} catch (AlreadyExistsException $e) {
-			if ($retry) {
-				$this->remove($target);
-				$result = $this->share->rename($absoluteSource, $absoluteTarget, false);
-			} else {
-				$this->logger->logException($e, ['level' => ILogger::WARN]);
-				return false;
-			}
-		} catch (InvalidArgumentException $e) {
-			if ($retry) {
-				$this->remove($target);
-				$result = $this->share->rename($absoluteSource, $absoluteTarget, false);
-			} else {
-				$this->logger->logException($e, ['level' => ILogger::WARN]);
-				return false;
-			}
-		} catch (\Exception $e) {
-			$this->logger->logException($e, ['level' => ILogger::WARN]);
-			return false;
-		}
-		unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]);
-		return $result;
-	}
-
-	public function stat($path, $retry = true) {
-		try {
-			$result = $this->formatInfo($this->getFileInfo($path));
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (TimedOutException $e) {
-			if ($retry) {
-				return $this->stat($path, false);
-			} else {
-				throw $e;
-			}
-		}
-		if ($this->remoteIsShare() && $this->isRootDir($path)) {
-			$result['mtime'] = $this->shareMTime();
-		}
-		return $result;
-	}
-
-	/**
-	 * get the best guess for the modification time of the share
-	 *
-	 * @return int
-	 */
-	private function shareMTime() {
-		$highestMTime = 0;
-		$files = $this->share->dir($this->root);
-		foreach ($files as $fileInfo) {
-			try {
-				if ($fileInfo->getMTime() > $highestMTime) {
-					$highestMTime = $fileInfo->getMTime();
-				}
-			} catch (NotFoundException $e) {
-				// Ignore this, can happen on unavailable DFS shares
-			} catch (ForbiddenException $e) {
-				// Ignore this too - it's a symlink
-			}
-		}
-		return $highestMTime;
-	}
-
-	/**
-	 * Check if the path is our root dir (not the smb one)
-	 *
-	 * @param string $path the path
-	 * @return bool
-	 */
-	private function isRootDir($path) {
-		return $path === '' || $path === '/' || $path === '.';
-	}
-
-	/**
-	 * Check if our root points to a smb share
-	 *
-	 * @return bool true if our root points to a share false otherwise
-	 */
-	private function remoteIsShare() {
-		return $this->share->getName() && (!$this->root || $this->root === '/');
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		if ($this->isRootDir($path)) {
-			return false;
-		}
-
-		try {
-			if ($this->is_dir($path)) {
-				return $this->rmdir($path);
-			} else {
-				$path = $this->buildPath($path);
-				unset($this->statCache[$path]);
-				$this->share->del($path);
-				return true;
-			}
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (ConnectException $e) {
-			$this->logger->logException($e, ['message' => 'Error while deleting file']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 */
-	public function hasUpdated($path, $time) {
-		if (!$path and $this->root === '/') {
-			// mtime doesn't work for shares, but giving the nature of the backend,
-			// doing a full update is still just fast enough
-			return true;
-		} else {
-			$actualTime = $this->filemtime($path);
-			return $actualTime > $time;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|bool
-	 */
-	public function fopen($path, $mode) {
-		$fullPath = $this->buildPath($path);
-		try {
-			switch ($mode) {
-				case 'r':
-				case 'rb':
-					if (!$this->file_exists($path)) {
-						return false;
-					}
-					return $this->share->read($fullPath);
-				case 'w':
-				case 'wb':
-					$source = $this->share->write($fullPath);
-					return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
-						unset($this->statCache[$fullPath]);
-					});
-				case 'a':
-				case 'ab':
-				case 'r+':
-				case 'w+':
-				case 'wb+':
-				case 'a+':
-				case 'x':
-				case 'x+':
-				case 'c':
-				case 'c+':
-					//emulate these
-					if (strrpos($path, '.') !== false) {
-						$ext = substr($path, strrpos($path, '.'));
-					} else {
-						$ext = '';
-					}
-					if ($this->file_exists($path)) {
-						if (!$this->isUpdatable($path)) {
-							return false;
-						}
-						$tmpFile = $this->getCachedFile($path);
-					} else {
-						if (!$this->isCreatable(dirname($path))) {
-							return false;
-						}
-						$tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
-					}
-					$source = fopen($tmpFile, $mode);
-					$share = $this->share;
-					return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
-						unset($this->statCache[$fullPath]);
-						$share->put($tmpFile, $fullPath);
-						unlink($tmpFile);
-					});
-			}
-			return false;
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (OutOfSpaceException $e) {
-			throw new EntityTooLargeException("not enough available space to create file", 0, $e);
-		} catch (ConnectException $e) {
-			$this->logger->logException($e, ['message' => 'Error while opening file']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	public function rmdir($path) {
-		if ($this->isRootDir($path)) {
-			return false;
-		}
-
-		try {
-			$this->statCache = [];
-			$content = $this->share->dir($this->buildPath($path));
-			foreach ($content as $file) {
-				if ($file->isDirectory()) {
-					$this->rmdir($path . '/' . $file->getName());
-				} else {
-					$this->share->del($file->getPath());
-				}
-			}
-			$this->share->rmdir($this->buildPath($path));
-			return true;
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (ConnectException $e) {
-			$this->logger->logException($e, ['message' => 'Error while removing folder']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	public function touch($path, $mtime = null) {
-		try {
-			if (!$this->file_exists($path)) {
-				$fh = $this->share->write($this->buildPath($path));
-				fclose($fh);
-				return true;
-			}
-			return false;
-		} catch (OutOfSpaceException $e) {
-			throw new EntityTooLargeException("not enough available space to create file", 0, $e);
-		} catch (ConnectException $e) {
-			$this->logger->logException($e, ['message' => 'Error while creating file']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	public function getMetaData($path) {
-		try {
-			$fileInfo = $this->getFileInfo($path);
-		} catch (NotFoundException $e) {
-			return null;
-		} catch (ForbiddenException $e) {
-			return null;
-		}
-		if (!$fileInfo) {
-			return null;
-		}
-
-		return $this->getMetaDataFromFileInfo($fileInfo);
-	}
-
-	private function getMetaDataFromFileInfo(IFileInfo $fileInfo) {
-		$permissions = Constants::PERMISSION_READ + Constants::PERMISSION_SHARE;
-
-		if (
-			!$fileInfo->isReadOnly() || $fileInfo->isDirectory()
-		) {
-			$permissions += Constants::PERMISSION_DELETE;
-			$permissions += Constants::PERMISSION_UPDATE;
-			if ($fileInfo->isDirectory()) {
-				$permissions += Constants::PERMISSION_CREATE;
-			}
-		}
-
-		$data = [];
-		if ($fileInfo->isDirectory()) {
-			$data['mimetype'] = 'httpd/unix-directory';
-		} else {
-			$data['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($fileInfo->getPath());
-		}
-		$data['mtime'] = $fileInfo->getMTime();
-		if ($fileInfo->isDirectory()) {
-			$data['size'] = -1; //unknown
-		} else {
-			$data['size'] = $fileInfo->getSize();
-		}
-		$data['etag'] = $this->getETag($fileInfo->getPath());
-		$data['storage_mtime'] = $data['mtime'];
-		$data['permissions'] = $permissions;
-		$data['name'] = $fileInfo->getName();
-
-		return $data;
-	}
-
-	public function opendir($path) {
-		try {
-			$files = $this->getFolderContents($path);
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (NotPermittedException $e) {
-			return false;
-		}
-		$names = array_map(function ($info) {
-			/** @var IFileInfo $info */
-			return $info->getName();
-		}, iterator_to_array($files));
-		return IteratorDirectory::wrap($names);
-	}
-
-	public function getDirectoryContent($directory): \Traversable {
-		$files = $this->getFolderContents($directory);
-		foreach ($files as $file) {
-			yield $this->getMetaDataFromFileInfo($file);
-		}
-	}
-
-	public function filetype($path) {
-		try {
-			return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-	}
-
-	public function mkdir($path) {
-		$path = $this->buildPath($path);
-		try {
-			$this->share->mkdir($path);
-			return true;
-		} catch (ConnectException $e) {
-			$this->logger->logException($e, ['message' => 'Error while creating folder']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		} catch (Exception $e) {
-			return false;
-		}
-	}
-
-	public function file_exists($path) {
-		try {
-			$this->getFileInfo($path);
-			return true;
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (ConnectException $e) {
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	public function isReadable($path) {
-		try {
-			$info = $this->getFileInfo($path);
-			return $this->showHidden || !$info->isHidden();
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-	}
-
-	public function isUpdatable($path) {
-		try {
-			$info = $this->getFileInfo($path);
-			// following windows behaviour for read-only folders: they can be written into
-			// (https://support.microsoft.com/en-us/kb/326549 - "cause" section)
-			return ($this->showHidden || !$info->isHidden()) && (!$info->isReadOnly() || $info->isDirectory());
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-	}
-
-	public function isDeletable($path) {
-		try {
-			$info = $this->getFileInfo($path);
-			return ($this->showHidden || !$info->isHidden()) && !$info->isReadOnly();
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * check if smbclient is installed
-	 */
-	public static function checkDependencies() {
-		return (
-			(bool)\OC_Helper::findBinaryPath('smbclient')
-			|| NativeServer::available(new System())
-		) ? true : ['smbclient'];
-	}
-
-	/**
-	 * Test a storage for availability
-	 *
-	 * @return bool
-	 */
-	public function test() {
-		try {
-			return parent::test();
-		} catch (Exception $e) {
-			$this->logger->logException($e);
-			return false;
-		}
-	}
-
-	public function listen($path, callable $callback) {
-		$this->notify($path)->listen(function (IChange $change) use ($callback) {
-			if ($change instanceof IRenameChange) {
-				return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
-			} else {
-				return $callback($change->getType(), $change->getPath());
-			}
-		});
-	}
-
-	public function notify($path) {
-		$path = '/' . ltrim($path, '/');
-		$shareNotifyHandler = $this->share->notify($this->buildPath($path));
-		return new SMBNotifyHandler($shareNotifyHandler, $this->root);
-	}
+    /**
+     * @var \Icewind\SMB\IServer
+     */
+    protected $server;
+
+    /**
+     * @var \Icewind\SMB\IShare
+     */
+    protected $share;
+
+    /**
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * @var IFileInfo[]
+     */
+    protected $statCache;
+
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var bool */
+    protected $showHidden;
+
+    /** @var bool */
+    protected $checkAcl;
+
+    public function __construct($params) {
+        if (!isset($params['host'])) {
+            throw new \Exception('Invalid configuration, no host provided');
+        }
+
+        if (isset($params['auth'])) {
+            $auth = $params['auth'];
+        } elseif (isset($params['user']) && isset($params['password']) && isset($params['share'])) {
+            [$workgroup, $user] = $this->splitUser($params['user']);
+            $auth = new BasicAuth($user, $workgroup, $params['password']);
+        } else {
+            throw new \Exception('Invalid configuration, no credentials provided');
+        }
+
+        if (isset($params['logger'])) {
+            $this->logger = $params['logger'];
+        } else {
+            $this->logger = \OC::$server->getLogger();
+        }
+
+        $options = new Options();
+        if (isset($params['timeout'])) {
+            $timeout = (int)$params['timeout'];
+            if ($timeout > 0) {
+                $options->setTimeout($timeout);
+            }
+        }
+        $serverFactory = new ServerFactory($options);
+        $this->server = $serverFactory->createServer($params['host'], $auth);
+        $this->share = $this->server->getShare(trim($params['share'], '/'));
+
+        $this->root = $params['root'] ?? '/';
+        $this->root = '/' . ltrim($this->root, '/');
+        $this->root = rtrim($this->root, '/') . '/';
+
+        $this->showHidden = isset($params['show_hidden']) && $params['show_hidden'];
+        $this->checkAcl = isset($params['check_acl']) && $params['check_acl'];
+
+        $this->statCache = new CappedMemoryCache();
+        parent::__construct($params);
+    }
+
+    private function splitUser($user) {
+        if (strpos($user, '/')) {
+            return explode('/', $user, 2);
+        } elseif (strpos($user, '\\')) {
+            return explode('\\', $user);
+        } else {
+            return [null, $user];
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getId() {
+        // FIXME: double slash to keep compatible with the old storage ids,
+        // failure to do so will lead to creation of a new storage id and
+        // loss of shares from the storage
+        return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    protected function buildPath($path) {
+        return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
+    }
+
+    protected function relativePath($fullPath) {
+        if ($fullPath === $this->root) {
+            return '';
+        } elseif (substr($fullPath, 0, strlen($this->root)) === $this->root) {
+            return substr($fullPath, strlen($this->root));
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return IFileInfo
+     * @throws StorageAuthException
+     */
+    protected function getFileInfo($path) {
+        try {
+            $path = $this->buildPath($path);
+            $cached = $this->statCache[$path] ?? null;
+            if ($cached instanceof IFileInfo) {
+                return $cached;
+            } else {
+                $stat = $this->share->stat($path);
+                $this->statCache[$path] = $stat;
+                return $stat;
+            }
+        } catch (ConnectException $e) {
+            $this->throwUnavailable($e);
+        } catch (ForbiddenException $e) {
+            // with php-smbclient, this exception is thrown when the provided password is invalid.
+            // Possible is also ForbiddenException with a different error code, so we check it.
+            if ($e->getCode() === 1) {
+                $this->throwUnavailable($e);
+            }
+            throw $e;
+        }
+    }
+
+    /**
+     * @param \Exception $e
+     * @return never
+     * @throws StorageAuthException
+     */
+    protected function throwUnavailable(\Exception $e) {
+        $this->logger->logException($e, ['message' => 'Error while getting file info']);
+        throw new StorageAuthException($e->getMessage(), $e);
+    }
+
+    /**
+     * get the acl from fileinfo that is relevant for the configured user
+     *
+     * @param IFileInfo $file
+     * @return ACL|null
+     */
+    private function getACL(IFileInfo $file): ?ACL {
+        $acls = $file->getAcls();
+        foreach ($acls as $user => $acl) {
+            [, $user] = $this->splitUser($user); // strip domain
+            if ($user === $this->server->getAuth()->getUsername()) {
+                return $acl;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @param string $path
+     * @return \Generator<IFileInfo>
+     * @throws StorageNotAvailableException
+     */
+    protected function getFolderContents($path): iterable {
+        try {
+            $path = ltrim($this->buildPath($path), '/');
+            try {
+                $files = $this->share->dir($path);
+            } catch (ForbiddenException $e) {
+                $this->logger->critical($e->getMessage(), ['exception' => $e]);
+                throw new NotPermittedException();
+            } catch (InvalidTypeException $e) {
+                return;
+            }
+            foreach ($files as $file) {
+                $this->statCache[$path . '/' . $file->getName()] = $file;
+            }
+
+            foreach ($files as $file) {
+                try {
+                    // the isHidden check is done before checking the config boolean to ensure that the metadata is always fetch
+                    // so we trigger the below exceptions where applicable
+                    $hide = $file->isHidden() && !$this->showHidden;
+
+                    if ($this->checkAcl && $acl = $this->getACL($file)) {
+                        // if there is no explicit deny, we assume it's allowed
+                        // this doesn't take inheritance fully into account but if read permissions is denied for a parent we wouldn't be in this folder
+                        // additionally, it's better to have false negatives here then false positives
+                        if ($acl->denies(ACL::MASK_READ) || $acl->denies(ACL::MASK_EXECUTE)) {
+                            $this->logger->debug('Hiding non readable entry ' . $file->getName());
+                            continue;
+                        }
+                    }
+
+                    if ($hide) {
+                        $this->logger->debug('hiding hidden file ' . $file->getName());
+                    }
+                    if (!$hide) {
+                        yield $file;
+                    }
+                } catch (ForbiddenException $e) {
+                    $this->logger->logException($e, ['level' => ILogger::DEBUG, 'message' => 'Hiding forbidden entry ' . $file->getName()]);
+                } catch (NotFoundException $e) {
+                    $this->logger->logException($e, ['level' => ILogger::DEBUG, 'message' => 'Hiding not found entry ' . $file->getName()]);
+                }
+            }
+        } catch (ConnectException $e) {
+            $this->logger->logException($e, ['message' => 'Error while getting folder content']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * @param IFileInfo $info
+     * @return array
+     */
+    protected function formatInfo($info) {
+        $result = [
+            'size' => $info->getSize(),
+            'mtime' => $info->getMTime(),
+        ];
+        if ($info->isDirectory()) {
+            $result['type'] = 'dir';
+        } else {
+            $result['type'] = 'file';
+        }
+        return $result;
+    }
+
+    /**
+     * Rename the files. If the source or the target is the root, the rename won't happen.
+     *
+     * @param string $source the old name of the path
+     * @param string $target the new name of the path
+     * @return bool true if the rename is successful, false otherwise
+     */
+    public function rename($source, $target, $retry = true) {
+        if ($this->isRootDir($source) || $this->isRootDir($target)) {
+            return false;
+        }
+
+        $absoluteSource = $this->buildPath($source);
+        $absoluteTarget = $this->buildPath($target);
+        try {
+            $result = $this->share->rename($absoluteSource, $absoluteTarget);
+        } catch (AlreadyExistsException $e) {
+            if ($retry) {
+                $this->remove($target);
+                $result = $this->share->rename($absoluteSource, $absoluteTarget, false);
+            } else {
+                $this->logger->logException($e, ['level' => ILogger::WARN]);
+                return false;
+            }
+        } catch (InvalidArgumentException $e) {
+            if ($retry) {
+                $this->remove($target);
+                $result = $this->share->rename($absoluteSource, $absoluteTarget, false);
+            } else {
+                $this->logger->logException($e, ['level' => ILogger::WARN]);
+                return false;
+            }
+        } catch (\Exception $e) {
+            $this->logger->logException($e, ['level' => ILogger::WARN]);
+            return false;
+        }
+        unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]);
+        return $result;
+    }
+
+    public function stat($path, $retry = true) {
+        try {
+            $result = $this->formatInfo($this->getFileInfo($path));
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (TimedOutException $e) {
+            if ($retry) {
+                return $this->stat($path, false);
+            } else {
+                throw $e;
+            }
+        }
+        if ($this->remoteIsShare() && $this->isRootDir($path)) {
+            $result['mtime'] = $this->shareMTime();
+        }
+        return $result;
+    }
+
+    /**
+     * get the best guess for the modification time of the share
+     *
+     * @return int
+     */
+    private function shareMTime() {
+        $highestMTime = 0;
+        $files = $this->share->dir($this->root);
+        foreach ($files as $fileInfo) {
+            try {
+                if ($fileInfo->getMTime() > $highestMTime) {
+                    $highestMTime = $fileInfo->getMTime();
+                }
+            } catch (NotFoundException $e) {
+                // Ignore this, can happen on unavailable DFS shares
+            } catch (ForbiddenException $e) {
+                // Ignore this too - it's a symlink
+            }
+        }
+        return $highestMTime;
+    }
+
+    /**
+     * Check if the path is our root dir (not the smb one)
+     *
+     * @param string $path the path
+     * @return bool
+     */
+    private function isRootDir($path) {
+        return $path === '' || $path === '/' || $path === '.';
+    }
+
+    /**
+     * Check if our root points to a smb share
+     *
+     * @return bool true if our root points to a share false otherwise
+     */
+    private function remoteIsShare() {
+        return $this->share->getName() && (!$this->root || $this->root === '/');
+    }
+
+    /**
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        if ($this->isRootDir($path)) {
+            return false;
+        }
+
+        try {
+            if ($this->is_dir($path)) {
+                return $this->rmdir($path);
+            } else {
+                $path = $this->buildPath($path);
+                unset($this->statCache[$path]);
+                $this->share->del($path);
+                return true;
+            }
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (ConnectException $e) {
+            $this->logger->logException($e, ['message' => 'Error while deleting file']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     */
+    public function hasUpdated($path, $time) {
+        if (!$path and $this->root === '/') {
+            // mtime doesn't work for shares, but giving the nature of the backend,
+            // doing a full update is still just fast enough
+            return true;
+        } else {
+            $actualTime = $this->filemtime($path);
+            return $actualTime > $time;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param string $mode
+     * @return resource|bool
+     */
+    public function fopen($path, $mode) {
+        $fullPath = $this->buildPath($path);
+        try {
+            switch ($mode) {
+                case 'r':
+                case 'rb':
+                    if (!$this->file_exists($path)) {
+                        return false;
+                    }
+                    return $this->share->read($fullPath);
+                case 'w':
+                case 'wb':
+                    $source = $this->share->write($fullPath);
+                    return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
+                        unset($this->statCache[$fullPath]);
+                    });
+                case 'a':
+                case 'ab':
+                case 'r+':
+                case 'w+':
+                case 'wb+':
+                case 'a+':
+                case 'x':
+                case 'x+':
+                case 'c':
+                case 'c+':
+                    //emulate these
+                    if (strrpos($path, '.') !== false) {
+                        $ext = substr($path, strrpos($path, '.'));
+                    } else {
+                        $ext = '';
+                    }
+                    if ($this->file_exists($path)) {
+                        if (!$this->isUpdatable($path)) {
+                            return false;
+                        }
+                        $tmpFile = $this->getCachedFile($path);
+                    } else {
+                        if (!$this->isCreatable(dirname($path))) {
+                            return false;
+                        }
+                        $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
+                    }
+                    $source = fopen($tmpFile, $mode);
+                    $share = $this->share;
+                    return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
+                        unset($this->statCache[$fullPath]);
+                        $share->put($tmpFile, $fullPath);
+                        unlink($tmpFile);
+                    });
+            }
+            return false;
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (OutOfSpaceException $e) {
+            throw new EntityTooLargeException("not enough available space to create file", 0, $e);
+        } catch (ConnectException $e) {
+            $this->logger->logException($e, ['message' => 'Error while opening file']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function rmdir($path) {
+        if ($this->isRootDir($path)) {
+            return false;
+        }
+
+        try {
+            $this->statCache = [];
+            $content = $this->share->dir($this->buildPath($path));
+            foreach ($content as $file) {
+                if ($file->isDirectory()) {
+                    $this->rmdir($path . '/' . $file->getName());
+                } else {
+                    $this->share->del($file->getPath());
+                }
+            }
+            $this->share->rmdir($this->buildPath($path));
+            return true;
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (ConnectException $e) {
+            $this->logger->logException($e, ['message' => 'Error while removing folder']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function touch($path, $mtime = null) {
+        try {
+            if (!$this->file_exists($path)) {
+                $fh = $this->share->write($this->buildPath($path));
+                fclose($fh);
+                return true;
+            }
+            return false;
+        } catch (OutOfSpaceException $e) {
+            throw new EntityTooLargeException("not enough available space to create file", 0, $e);
+        } catch (ConnectException $e) {
+            $this->logger->logException($e, ['message' => 'Error while creating file']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function getMetaData($path) {
+        try {
+            $fileInfo = $this->getFileInfo($path);
+        } catch (NotFoundException $e) {
+            return null;
+        } catch (ForbiddenException $e) {
+            return null;
+        }
+        if (!$fileInfo) {
+            return null;
+        }
+
+        return $this->getMetaDataFromFileInfo($fileInfo);
+    }
+
+    private function getMetaDataFromFileInfo(IFileInfo $fileInfo) {
+        $permissions = Constants::PERMISSION_READ + Constants::PERMISSION_SHARE;
+
+        if (
+            !$fileInfo->isReadOnly() || $fileInfo->isDirectory()
+        ) {
+            $permissions += Constants::PERMISSION_DELETE;
+            $permissions += Constants::PERMISSION_UPDATE;
+            if ($fileInfo->isDirectory()) {
+                $permissions += Constants::PERMISSION_CREATE;
+            }
+        }
+
+        $data = [];
+        if ($fileInfo->isDirectory()) {
+            $data['mimetype'] = 'httpd/unix-directory';
+        } else {
+            $data['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($fileInfo->getPath());
+        }
+        $data['mtime'] = $fileInfo->getMTime();
+        if ($fileInfo->isDirectory()) {
+            $data['size'] = -1; //unknown
+        } else {
+            $data['size'] = $fileInfo->getSize();
+        }
+        $data['etag'] = $this->getETag($fileInfo->getPath());
+        $data['storage_mtime'] = $data['mtime'];
+        $data['permissions'] = $permissions;
+        $data['name'] = $fileInfo->getName();
+
+        return $data;
+    }
+
+    public function opendir($path) {
+        try {
+            $files = $this->getFolderContents($path);
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (NotPermittedException $e) {
+            return false;
+        }
+        $names = array_map(function ($info) {
+            /** @var IFileInfo $info */
+            return $info->getName();
+        }, iterator_to_array($files));
+        return IteratorDirectory::wrap($names);
+    }
+
+    public function getDirectoryContent($directory): \Traversable {
+        $files = $this->getFolderContents($directory);
+        foreach ($files as $file) {
+            yield $this->getMetaDataFromFileInfo($file);
+        }
+    }
+
+    public function filetype($path) {
+        try {
+            return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+    }
+
+    public function mkdir($path) {
+        $path = $this->buildPath($path);
+        try {
+            $this->share->mkdir($path);
+            return true;
+        } catch (ConnectException $e) {
+            $this->logger->logException($e, ['message' => 'Error while creating folder']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        } catch (Exception $e) {
+            return false;
+        }
+    }
+
+    public function file_exists($path) {
+        try {
+            $this->getFileInfo($path);
+            return true;
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (ConnectException $e) {
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function isReadable($path) {
+        try {
+            $info = $this->getFileInfo($path);
+            return $this->showHidden || !$info->isHidden();
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+    }
+
+    public function isUpdatable($path) {
+        try {
+            $info = $this->getFileInfo($path);
+            // following windows behaviour for read-only folders: they can be written into
+            // (https://support.microsoft.com/en-us/kb/326549 - "cause" section)
+            return ($this->showHidden || !$info->isHidden()) && (!$info->isReadOnly() || $info->isDirectory());
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+    }
+
+    public function isDeletable($path) {
+        try {
+            $info = $this->getFileInfo($path);
+            return ($this->showHidden || !$info->isHidden()) && !$info->isReadOnly();
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * check if smbclient is installed
+     */
+    public static function checkDependencies() {
+        return (
+            (bool)\OC_Helper::findBinaryPath('smbclient')
+            || NativeServer::available(new System())
+        ) ? true : ['smbclient'];
+    }
+
+    /**
+     * Test a storage for availability
+     *
+     * @return bool
+     */
+    public function test() {
+        try {
+            return parent::test();
+        } catch (Exception $e) {
+            $this->logger->logException($e);
+            return false;
+        }
+    }
+
+    public function listen($path, callable $callback) {
+        $this->notify($path)->listen(function (IChange $change) use ($callback) {
+            if ($change instanceof IRenameChange) {
+                return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
+            } else {
+                return $callback($change->getType(), $change->getPath());
+            }
+        });
+    }
+
+    public function notify($path) {
+        $path = '/' . ltrim($path, '/');
+        $shareNotifyHandler = $this->share->notify($this->buildPath($path));
+        return new SMBNotifyHandler($shareNotifyHandler, $this->root);
+    }
 }

Spacing +17 added lines, -17 removed lines

@@ -120,7 +120,7 @@ 
 
 		$options = new Options();
 		if (isset($params['timeout'])) {
-			$timeout = (int)$params['timeout'];
+			$timeout = (int) $params['timeout'];
 			if ($timeout > 0) {
 				$options->setTimeout($timeout);
 			}
@@ -130,8 +130,8 @@ 
 		$this->share = $this->server->getShare(trim($params['share'], '/'));
 
 		$this->root = $params['root'] ?? '/';
-		$this->root = '/' . ltrim($this->root, '/');
-		$this->root = rtrim($this->root, '/') . '/';
+		$this->root = '/'.ltrim($this->root, '/');
+		$this->root = rtrim($this->root, '/').'/';
 
 		$this->showHidden = isset($params['show_hidden']) && $params['show_hidden'];
 		$this->checkAcl = isset($params['check_acl']) && $params['check_acl'];
@@ -157,7 +157,7 @@ 
 		// FIXME: double slash to keep compatible with the old storage ids,
 		// failure to do so will lead to creation of a new storage id and
 		// loss of shares from the storage
-		return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
+		return 'smb::'.$this->server->getAuth()->getUsername().'@'.$this->server->getHost().'//'.$this->share->getName().'/'.$this->root;
 	}
 
 	/**
@@ -165,7 +165,7 @@ 
 	 * @return string
 	 */
 	protected function buildPath($path) {
-		return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
+		return Filesystem::normalizePath($this->root.'/'.$path, true, false, true);
 	}
 
 	protected function relativePath($fullPath) {
@@ -251,7 +251,7 @@ 
 				return;
 			}
 			foreach ($files as $file) {
-				$this->statCache[$path . '/' . $file->getName()] = $file;
+				$this->statCache[$path.'/'.$file->getName()] = $file;
 			}
 
 			foreach ($files as $file) {
@@ -265,21 +265,21 @@ 
 						// this doesn't take inheritance fully into account but if read permissions is denied for a parent we wouldn't be in this folder
 						// additionally, it's better to have false negatives here then false positives
 						if ($acl->denies(ACL::MASK_READ) || $acl->denies(ACL::MASK_EXECUTE)) {
-							$this->logger->debug('Hiding non readable entry ' . $file->getName());
+							$this->logger->debug('Hiding non readable entry '.$file->getName());
 							continue;
 						}
 					}
 
 					if ($hide) {
-						$this->logger->debug('hiding hidden file ' . $file->getName());
+						$this->logger->debug('hiding hidden file '.$file->getName());
 					}
 					if (!$hide) {
 						yield $file;
 					}
 				} catch (ForbiddenException $e) {
-					$this->logger->logException($e, ['level' => ILogger::DEBUG, 'message' => 'Hiding forbidden entry ' . $file->getName()]);
+					$this->logger->logException($e, ['level' => ILogger::DEBUG, 'message' => 'Hiding forbidden entry '.$file->getName()]);
 				} catch (NotFoundException $e) {
-					$this->logger->logException($e, ['level' => ILogger::DEBUG, 'message' => 'Hiding not found entry ' . $file->getName()]);
+					$this->logger->logException($e, ['level' => ILogger::DEBUG, 'message' => 'Hiding not found entry '.$file->getName()]);
 				}
 			}
 		} catch (ConnectException $e) {
@@ -470,7 +470,7 @@ 
 				case 'w':
 				case 'wb':
 					$source = $this->share->write($fullPath);
-					return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
+					return CallBackWrapper::wrap($source, null, null, function() use ($fullPath) {
 						unset($this->statCache[$fullPath]);
 					});
 				case 'a':
@@ -502,7 +502,7 @@ 
 					}
 					$source = fopen($tmpFile, $mode);
 					$share = $this->share;
-					return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
+					return CallbackWrapper::wrap($source, null, null, function() use ($tmpFile, $fullPath, $share) {
 						unset($this->statCache[$fullPath]);
 						$share->put($tmpFile, $fullPath);
 						unlink($tmpFile);
@@ -531,7 +531,7 @@ 
 			$content = $this->share->dir($this->buildPath($path));
 			foreach ($content as $file) {
 				if ($file->isDirectory()) {
-					$this->rmdir($path . '/' . $file->getName());
+					$this->rmdir($path.'/'.$file->getName());
 				} else {
 					$this->share->del($file->getPath());
 				}
@@ -620,7 +620,7 @@ 
 		} catch (NotPermittedException $e) {
 			return false;
 		}
-		$names = array_map(function ($info) {
+		$names = array_map(function($info) {
 			/** @var IFileInfo $info */
 			return $info->getName();
 		}, iterator_to_array($files));
@@ -710,7 +710,7 @@ 
 	 */
 	public static function checkDependencies() {
 		return (
-			(bool)\OC_Helper::findBinaryPath('smbclient')
+			(bool) \OC_Helper::findBinaryPath('smbclient')
 			|| NativeServer::available(new System())
 		) ? true : ['smbclient'];
 	}
@@ -730,7 +730,7 @@ 
 	}
 
 	public function listen($path, callable $callback) {
-		$this->notify($path)->listen(function (IChange $change) use ($callback) {
+		$this->notify($path)->listen(function(IChange $change) use ($callback) {
 			if ($change instanceof IRenameChange) {
 				return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
 			} else {
@@ -740,7 +740,7 @@ 
 	}
 
 	public function notify($path) {
-		$path = '/' . ltrim($path, '/');
+		$path = '/'.ltrim($path, '/');
 		$shareNotifyHandler = $this->share->notify($this->buildPath($path));
 		return new SMBNotifyHandler($shareNotifyHandler, $this->root);
 	}