aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_external/lib/Lib/Storage/SMB.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_external/lib/Lib/Storage/SMB.php')
-rw-r--r--apps/files_external/lib/Lib/Storage/SMB.php539
1 files changed, 367 insertions, 172 deletions
diff --git a/apps/files_external/lib/Lib/Storage/SMB.php b/apps/files_external/lib/Lib/Storage/SMB.php
index d8bbe8c4718..8f8750864e1 100644
--- a/apps/files_external/lib/Lib/Storage/SMB.php
+++ b/apps/files_external/lib/Lib/Storage/SMB.php
@@ -1,67 +1,55 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Jesús Macias <jmacias@solidgear.es>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Juan Pablo Villafañez <jvillafanez@solidgear.es>
- * @author Juan Pablo Villafáñez <jvillafanez@solidgear.es>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Michael Gapczynski <GapczynskiM@gmail.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Philipp Kapfer <philipp.kapfer@gmx.at>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCA\Files_External\Lib\Storage;
+use Icewind\SMB\ACL;
+use Icewind\SMB\BasicAuth;
use Icewind\SMB\Exception\AlreadyExistsException;
use Icewind\SMB\Exception\ConnectException;
use Icewind\SMB\Exception\Exception;
use Icewind\SMB\Exception\ForbiddenException;
+use Icewind\SMB\Exception\InvalidArgumentException;
+use Icewind\SMB\Exception\InvalidTypeException;
use Icewind\SMB\Exception\NotFoundException;
+use Icewind\SMB\Exception\OutOfSpaceException;
+use Icewind\SMB\Exception\TimedOutException;
use Icewind\SMB\IFileInfo;
-use Icewind\SMB\NativeServer;
-use Icewind\SMB\Server;
+use Icewind\SMB\Native\NativeServer;
+use Icewind\SMB\Options;
+use Icewind\SMB\ServerFactory;
+use Icewind\SMB\Wrapped\Server;
use Icewind\Streams\CallbackWrapper;
use Icewind\Streams\IteratorDirectory;
-use OC\Cache\CappedMemoryCache;
use OC\Files\Filesystem;
use OC\Files\Storage\Common;
use OCA\Files_External\Lib\Notify\SMBNotifyHandler;
+use OCP\Cache\CappedMemoryCache;
+use OCP\Constants;
+use OCP\Files\EntityTooLargeException;
+use OCP\Files\IMimeTypeDetector;
use OCP\Files\Notify\IChange;
use OCP\Files\Notify\IRenameChange;
+use OCP\Files\NotPermittedException;
use OCP\Files\Storage\INotifyStorage;
+use OCP\Files\StorageAuthException;
use OCP\Files\StorageNotAvailableException;
-use OCP\Util;
+use OCP\ITempManager;
+use Psr\Log\LoggerInterface;
class SMB extends Common implements INotifyStorage {
/**
- * @var \Icewind\SMB\Server
+ * @var \Icewind\SMB\IServer
*/
protected $server;
/**
- * @var \Icewind\SMB\Share
+ * @var \Icewind\SMB\IShare
*/
protected $share;
@@ -70,56 +58,96 @@ class SMB extends Common implements INotifyStorage {
*/
protected $root;
- /**
- * @var \Icewind\SMB\FileInfo[]
- */
- protected $statCache;
+ /** @var CappedMemoryCache<IFileInfo> */
+ protected CappedMemoryCache $statCache;
- public function __construct($params) {
- if (isset($params['host']) && isset($params['user']) && isset($params['password']) && isset($params['share'])) {
- if (Server::NativeAvailable()) {
- $this->server = new NativeServer($params['host'], $params['user'], $params['password']);
- } else {
- $this->server = new Server($params['host'], $params['user'], $params['password']);
- }
- $this->share = $this->server->getShare(trim($params['share'], '/'));
+ /** @var LoggerInterface */
+ protected $logger;
- $this->root = isset($params['root']) ? $params['root'] : '/';
- if (!$this->root || $this->root[0] !== '/') {
- $this->root = '/' . $this->root;
- }
- if (substr($this->root, -1, 1) !== '/') {
- $this->root .= '/';
+ /** @var bool */
+ protected $showHidden;
+
+ private bool $caseSensitive;
+
+ /** @var bool */
+ protected $checkAcl;
+
+ public function __construct(array $parameters) {
+ if (!isset($parameters['host'])) {
+ throw new \Exception('Invalid configuration, no host provided');
+ }
+
+ if (isset($parameters['auth'])) {
+ $auth = $parameters['auth'];
+ } elseif (isset($parameters['user']) && isset($parameters['password']) && isset($parameters['share'])) {
+ [$workgroup, $user] = $this->splitUser($parameters['user']);
+ $auth = new BasicAuth($user, $workgroup, $parameters['password']);
+ } else {
+ throw new \Exception('Invalid configuration, no credentials provided');
+ }
+
+ if (isset($parameters['logger'])) {
+ if (!$parameters['logger'] instanceof LoggerInterface) {
+ throw new \Exception(
+ 'Invalid logger. Got '
+ . get_class($parameters['logger'])
+ . ' Expected ' . LoggerInterface::class
+ );
}
+ $this->logger = $parameters['logger'];
} else {
- throw new \Exception('Invalid configuration');
+ $this->logger = \OCP\Server::get(LoggerInterface::class);
+ }
+
+ $options = new Options();
+ if (isset($parameters['timeout'])) {
+ $timeout = (int)$parameters['timeout'];
+ if ($timeout > 0) {
+ $options->setTimeout($timeout);
+ }
}
+ $system = \OCP\Server::get(SystemBridge::class);
+ $serverFactory = new ServerFactory($options, $system);
+ $this->server = $serverFactory->createServer($parameters['host'], $auth);
+ $this->share = $this->server->getShare(trim($parameters['share'], '/'));
+
+ $this->root = $parameters['root'] ?? '/';
+ $this->root = '/' . ltrim($this->root, '/');
+ $this->root = rtrim($this->root, '/') . '/';
+
+ $this->showHidden = isset($parameters['show_hidden']) && $parameters['show_hidden'];
+ $this->caseSensitive = (bool)($parameters['case_sensitive'] ?? true);
+ $this->checkAcl = isset($parameters['check_acl']) && $parameters['check_acl'];
+
$this->statCache = new CappedMemoryCache();
- parent::__construct($params);
+ parent::__construct($parameters);
}
- /**
- * @return string
- */
- public function getId() {
+ private function splitUser(string $user): array {
+ if (str_contains($user, '/')) {
+ return explode('/', $user, 2);
+ } elseif (str_contains($user, '\\')) {
+ return explode('\\', $user);
+ }
+
+ return [null, $user];
+ }
+
+ public function getId(): string {
// 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->getUser() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
+ return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
}
- /**
- * @param string $path
- * @return string
- */
- protected function buildPath($path) {
+ protected function buildPath(string $path): string {
return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
}
- protected function relativePath($fullPath) {
+ protected function relativePath(string $fullPath): ?string {
if ($fullPath === $this->root) {
return '';
- } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) {
+ } elseif (substr($fullPath, 0, strlen($this->root)) === $this->root) {
return substr($fullPath, strlen($this->root));
} else {
return null;
@@ -127,47 +155,119 @@ class SMB extends Common implements INotifyStorage {
}
/**
- * @param string $path
- * @return \Icewind\SMB\IFileInfo
- * @throws StorageNotAvailableException
+ * @throws StorageAuthException
+ * @throws \OCP\Files\NotFoundException
+ * @throws \OCP\Files\ForbiddenException
*/
- protected function getFileInfo($path) {
+ protected function getFileInfo(string $path): IFileInfo {
try {
$path = $this->buildPath($path);
- if (!isset($this->statCache[$path])) {
- $this->statCache[$path] = $this->share->stat($path);
+ $cached = $this->statCache[$path] ?? null;
+ if ($cached instanceof IFileInfo) {
+ return $cached;
+ } else {
+ $stat = $this->share->stat($path);
+ $this->statCache[$path] = $stat;
+ return $stat;
}
- return $this->statCache[$path];
} catch (ConnectException $e) {
- throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ $this->throwUnavailable($e);
+ } catch (NotFoundException $e) {
+ throw new \OCP\Files\NotFoundException($e->getMessage(), 0, $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 new \OCP\Files\ForbiddenException($e->getMessage(), false, $e);
+ }
+ }
+
+ /**
+ * @throws StorageAuthException
+ */
+ protected function throwUnavailable(\Exception $e): never {
+ $this->logger->error('Error while getting file info', ['exception' => $e]);
+ throw new StorageAuthException($e->getMessage(), $e);
+ }
+
+ /**
+ * get the acl from fileinfo that is relevant for the configured user
+ */
+ private function getACL(IFileInfo $file): ?ACL {
+ try {
+ $acls = $file->getAcls();
+ } catch (Exception $e) {
+ $this->logger->warning('Error while getting file acls', ['exception' => $e]);
+ return null;
+ }
+ 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 \Icewind\SMB\IFileInfo[]
+ * @return \Generator<IFileInfo>
* @throws StorageNotAvailableException
*/
- protected function getFolderContents($path) {
+ protected function getFolderContents(string $path): iterable {
try {
- $path = $this->buildPath($path);
- $files = $this->share->dir($path);
+ $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;
}
- return array_filter($files, function (IFileInfo $file) {
- return !$file->isHidden();
- });
+
+ 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->debug($e->getMessage(), ['exception' => $e]);
+ } catch (NotFoundException $e) {
+ $this->logger->debug('Hiding forbidden entry ' . $file->getName(), ['exception' => $e]);
+ }
+ }
} catch (ConnectException $e) {
- throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ $this->logger->error('Error while getting folder content', ['exception' => $e]);
+ throw new StorageNotAvailableException($e->getMessage(), (int)$e->getCode(), $e);
+ } catch (NotFoundException $e) {
+ throw new \OCP\Files\NotFoundException($e->getMessage(), 0, $e);
}
}
- /**
- * @param \Icewind\SMB\IFileInfo $info
- * @return array
- */
- protected function formatInfo($info) {
+ protected function formatInfo(IFileInfo $info): array {
$result = [
'size' => $info->getSize(),
'mtime' => $info->getMTime(),
@@ -185,35 +285,59 @@ class SMB extends Common implements INotifyStorage {
*
* @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) {
+ public function rename(string $source, string $target, bool $retry = true): bool {
if ($this->isRootDir($source) || $this->isRootDir($target)) {
return false;
}
+ if ($this->caseSensitive === false
+ && mb_strtolower($target) === mb_strtolower($source)
+ ) {
+ // Forbid changing case only on case-insensitive file system
+ return false;
+ }
$absoluteSource = $this->buildPath($source);
$absoluteTarget = $this->buildPath($target);
try {
$result = $this->share->rename($absoluteSource, $absoluteTarget);
} catch (AlreadyExistsException $e) {
- $this->remove($target);
- $result = $this->share->rename($absoluteSource, $absoluteTarget);
+ if ($retry) {
+ $this->remove($target);
+ $result = $this->share->rename($absoluteSource, $absoluteTarget);
+ } else {
+ $this->logger->warning($e->getMessage(), ['exception' => $e]);
+ return false;
+ }
+ } catch (InvalidArgumentException $e) {
+ if ($retry) {
+ $this->remove($target);
+ $result = $this->share->rename($absoluteSource, $absoluteTarget);
+ } else {
+ $this->logger->warning($e->getMessage(), ['exception' => $e]);
+ return false;
+ }
} catch (\Exception $e) {
- \OC::$server->getLogger()->logException($e, ['level' => Util::WARN]);
+ $this->logger->warning($e->getMessage(), ['exception' => $e]);
return false;
}
unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]);
return $result;
}
- public function stat($path) {
+ public function stat(string $path, bool $retry = true): array|false {
try {
$result = $this->formatInfo($this->getFileInfo($path));
- } catch (ForbiddenException $e) {
+ } catch (\OCP\Files\ForbiddenException $e) {
return false;
- } catch (NotFoundException $e) {
+ } catch (\OCP\Files\NotFoundException $e) {
return false;
+ } catch (TimedOutException $e) {
+ if ($retry) {
+ return $this->stat($path, false);
+ } else {
+ throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ }
}
if ($this->remoteIsShare() && $this->isRootDir($path)) {
$result['mtime'] = $this->shareMTime();
@@ -223,15 +347,19 @@ class SMB extends Common implements INotifyStorage {
/**
* get the best guess for the modification time of the share
- *
- * @return int
*/
- private function shareMTime() {
+ private function shareMTime(): int {
$highestMTime = 0;
$files = $this->share->dir($this->root);
foreach ($files as $fileInfo) {
- if ($fileInfo->getMTime() > $highestMTime) {
- $highestMTime = $fileInfo->getMTime();
+ 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;
@@ -239,28 +367,19 @@ class SMB extends Common implements INotifyStorage {
/**
* Check if the path is our root dir (not the smb one)
- *
- * @param string $path the path
- * @return bool
*/
- private function isRootDir($path) {
+ private function isRootDir(string $path): bool {
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() {
+ private function remoteIsShare(): bool {
return $this->share->getName() && (!$this->root || $this->root === '/');
}
- /**
- * @param string $path
- * @return bool
- */
- public function unlink($path) {
+ public function unlink(string $path): bool {
if ($this->isRootDir($path)) {
return false;
}
@@ -279,47 +398,43 @@ class SMB extends Common implements INotifyStorage {
} catch (ForbiddenException $e) {
return false;
} catch (ConnectException $e) {
- throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ $this->logger->error('Error while deleting file', ['exception' => $e]);
+ throw new StorageNotAvailableException($e->getMessage(), (int)$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) {
+ public function hasUpdated(string $path, int $time): bool {
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;
+ return $actualTime > $time || $actualTime === 0;
}
}
/**
- * @param string $path
- * @param string $mode
* @return resource|false
*/
- public function fopen($path, $mode) {
+ public function fopen(string $path, string $mode) {
$fullPath = $this->buildPath($path);
try {
switch ($mode) {
case 'r':
case 'rb':
if (!$this->file_exists($path)) {
+ $this->logger->warning('Failed to open ' . $path . ' on ' . $this->getId() . ', file doesn\'t exist.');
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) {
+ return CallBackWrapper::wrap($source, null, null, function () use ($fullPath): void {
unset($this->statCache[$fullPath]);
});
case 'a':
@@ -340,18 +455,20 @@ class SMB extends Common implements INotifyStorage {
}
if ($this->file_exists($path)) {
if (!$this->isUpdatable($path)) {
+ $this->logger->warning('Failed to open ' . $path . ' on ' . $this->getId() . ', file not updatable.');
return false;
}
$tmpFile = $this->getCachedFile($path);
} else {
if (!$this->isCreatable(dirname($path))) {
+ $this->logger->warning('Failed to open ' . $path . ' on ' . $this->getId() . ', parent directory not writable.');
return false;
}
- $tmpFile = \OCP\Files::tmpFile($ext);
+ $tmpFile = \OCP\Server::get(ITempManager::class)->getTemporaryFile($ext);
}
$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): void {
unset($this->statCache[$fullPath]);
$share->put($tmpFile, $fullPath);
unlink($tmpFile);
@@ -359,21 +476,27 @@ class SMB extends Common implements INotifyStorage {
}
return false;
} catch (NotFoundException $e) {
+ $this->logger->warning('Failed to open ' . $path . ' on ' . $this->getId() . ', not found.', ['exception' => $e]);
return false;
} catch (ForbiddenException $e) {
+ $this->logger->warning('Failed to open ' . $path . ' on ' . $this->getId() . ', forbidden.', ['exception' => $e]);
return false;
+ } catch (OutOfSpaceException $e) {
+ $this->logger->warning('Failed to open ' . $path . ' on ' . $this->getId() . ', out of space.', ['exception' => $e]);
+ throw new EntityTooLargeException('not enough available space to create file', 0, $e);
} catch (ConnectException $e) {
- throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ $this->logger->error('Error while opening file ' . $path . ' on ' . $this->getId(), ['exception' => $e]);
+ throw new StorageNotAvailableException($e->getMessage(), (int)$e->getCode(), $e);
}
}
- public function rmdir($path) {
+ public function rmdir(string $path): bool {
if ($this->isRootDir($path)) {
return false;
}
try {
- $this->statCache = array();
+ $this->statCache = new CappedMemoryCache();
$content = $this->share->dir($this->buildPath($path));
foreach ($content as $file) {
if ($file->isDirectory()) {
@@ -389,11 +512,12 @@ class SMB extends Common implements INotifyStorage {
} catch (ForbiddenException $e) {
return false;
} catch (ConnectException $e) {
- throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ $this->logger->error('Error while removing folder', ['exception' => $e]);
+ throw new StorageNotAvailableException($e->getMessage(), (int)$e->getCode(), $e);
}
}
- public function touch($path, $time = null) {
+ public function touch(string $path, ?int $mtime = null): bool {
try {
if (!$this->file_exists($path)) {
$fh = $this->share->write($this->buildPath($path));
@@ -401,92 +525,165 @@ class SMB extends Common implements INotifyStorage {
return true;
}
return false;
+ } catch (OutOfSpaceException $e) {
+ throw new EntityTooLargeException('not enough available space to create file', 0, $e);
} catch (ConnectException $e) {
- throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ $this->logger->error('Error while creating file', ['exception' => $e]);
+ throw new StorageNotAvailableException($e->getMessage(), (int)$e->getCode(), $e);
+ }
+ }
+
+ public function getMetaData(string $path): ?array {
+ try {
+ $fileInfo = $this->getFileInfo($path);
+ } catch (\OCP\Files\NotFoundException $e) {
+ return null;
+ } catch (\OCP\Files\ForbiddenException $e) {
+ return null;
+ }
+
+ return $this->getMetaDataFromFileInfo($fileInfo);
+ }
+
+ private function getMetaDataFromFileInfo(IFileInfo $fileInfo): array {
+ $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'] = \OCP\Server::get(IMimeTypeDetector::class)->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) {
+ public function opendir(string $path) {
try {
$files = $this->getFolderContents($path);
} catch (NotFoundException $e) {
return false;
- } catch (ForbiddenException $e) {
+ } catch (NotPermittedException $e) {
return false;
}
$names = array_map(function ($info) {
- /** @var \Icewind\SMB\IFileInfo $info */
+ /** @var IFileInfo $info */
return $info->getName();
- }, $files);
+ }, iterator_to_array($files));
return IteratorDirectory::wrap($names);
}
- public function filetype($path) {
+ public function getDirectoryContent(string $directory): \Traversable {
try {
- return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
+ $files = $this->getFolderContents($directory);
+ foreach ($files as $file) {
+ yield $this->getMetaDataFromFileInfo($file);
+ }
} catch (NotFoundException $e) {
+ return;
+ } catch (NotPermittedException $e) {
+ return;
+ }
+ }
+
+ public function filetype(string $path): string|false {
+ try {
+ return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
+ } catch (\OCP\Files\NotFoundException $e) {
return false;
- } catch (ForbiddenException $e) {
+ } catch (\OCP\Files\ForbiddenException $e) {
return false;
}
}
- public function mkdir($path) {
+ public function mkdir(string $path): bool {
$path = $this->buildPath($path);
try {
$this->share->mkdir($path);
return true;
} catch (ConnectException $e) {
- throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ $this->logger->error('Error while creating folder', ['exception' => $e]);
+ throw new StorageNotAvailableException($e->getMessage(), (int)$e->getCode(), $e);
} catch (Exception $e) {
return false;
}
}
- public function file_exists($path) {
+ public function file_exists(string $path): bool {
try {
+ // Case sensitive filesystem doesn't matter for root directory
+ if ($this->caseSensitive === false && $path !== '') {
+ $filename = basename($path);
+ $siblings = $this->getDirectoryContent(dirname($path));
+ foreach ($siblings as $sibling) {
+ if ($sibling['name'] === $filename) {
+ return true;
+ }
+ }
+ return false;
+ }
$this->getFileInfo($path);
return true;
- } catch (NotFoundException $e) {
+ } catch (\OCP\Files\NotFoundException $e) {
return false;
- } catch (ForbiddenException $e) {
+ } catch (\OCP\Files\ForbiddenException $e) {
return false;
} catch (ConnectException $e) {
- throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+ throw new StorageNotAvailableException($e->getMessage(), (int)$e->getCode(), $e);
}
}
- public function isReadable($path) {
+ public function isReadable(string $path): bool {
try {
$info = $this->getFileInfo($path);
- return !$info->isHidden();
- } catch (NotFoundException $e) {
+ return $this->showHidden || !$info->isHidden();
+ } catch (\OCP\Files\NotFoundException $e) {
return false;
- } catch (ForbiddenException $e) {
+ } catch (\OCP\Files\ForbiddenException $e) {
return false;
}
}
- public function isUpdatable($path) {
+ public function isUpdatable(string $path): bool {
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 !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path));
- } catch (NotFoundException $e) {
+ return ($this->showHidden || !$info->isHidden()) && (!$info->isReadOnly() || $info->isDirectory());
+ } catch (\OCP\Files\NotFoundException $e) {
return false;
- } catch (ForbiddenException $e) {
+ } catch (\OCP\Files\ForbiddenException $e) {
return false;
}
}
- public function isDeletable($path) {
+ public function isDeletable(string $path): bool {
try {
$info = $this->getFileInfo($path);
- return !$info->isHidden() && !$info->isReadOnly();
- } catch (NotFoundException $e) {
+ return ($this->showHidden || !$info->isHidden()) && !$info->isReadOnly();
+ } catch (\OCP\Files\NotFoundException $e) {
return false;
- } catch (ForbiddenException $e) {
+ } catch (\OCP\Files\ForbiddenException $e) {
return false;
}
}
@@ -494,27 +691,25 @@ class SMB extends Common implements INotifyStorage {
/**
* check if smbclient is installed
*/
- public static function checkDependencies() {
- return (
- (bool)\OC_Helper::findBinaryPath('smbclient')
- || Server::NativeAvailable()
- ) ? true : ['smbclient'];
+ public static function checkDependencies(): array|bool {
+ $system = \OCP\Server::get(SystemBridge::class);
+ return Server::available($system) || NativeServer::available($system) ?: ['smbclient'];
}
- /**
- * Test a storage for availability
- *
- * @return bool
- */
- public function test() {
+ public function test(): bool {
try {
return parent::test();
+ } catch (StorageAuthException $e) {
+ return false;
+ } catch (ForbiddenException $e) {
+ return false;
} catch (Exception $e) {
+ $this->logger->error($e->getMessage(), ['exception' => $e]);
return false;
}
}
- public function listen($path, callable $callback) {
+ public function listen(string $path, callable $callback): void {
$this->notify($path)->listen(function (IChange $change) use ($callback) {
if ($change instanceof IRenameChange) {
return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
@@ -524,7 +719,7 @@ class SMB extends Common implements INotifyStorage {
});
}
- public function notify($path) {
+ public function notify(string $path): SMBNotifyHandler {
$path = '/' . ltrim($path, '/');
$shareNotifyHandler = $this->share->notify($this->buildPath($path));
return new SMBNotifyHandler($shareNotifyHandler, $this->root);
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 17:14:54 +0000