Skip to content

refactor(files_external/SMB): modernize constructor + start unifying caching #58704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
joshtrichards wants to merge 6 commits into
base: master
Choose a base branch
from
+59 −60
Draft

refactor(files_external/SMB): modernize constructor + start unifying caching #58704

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fe2fa96
refactor(files_external/SMB): modernize properties
joshtrichards Mar 3, 2026
7ef939b
refactor(Storage/SMB): variable naming
joshtrichards Mar 3, 2026
d97ffa5
refactor(Storage/SMB): unify instance cache management w/ S3
joshtrichards Mar 3, 2026
c4dcf72
refactor(Storage/SMB): drop unused logger via $parameters code
joshtrichards Mar 3, 2026
2a9591b
refactor(Storage/SMB): move SMB auth resolution to helper
joshtrichards Mar 3, 2026
9b76209
refactor(Storage/SMB): move SMB client options building to helper
joshtrichards Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 59 additions & 60 deletions apps/files_external/lib/Lib/Storage/SMB.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php

/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016-2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
Expand Down Expand Up @@ -43,84 +43,83 @@
use Psr\Log\LoggerInterface;

class SMB extends Common implements INotifyStorage {
/**
* @var \Icewind\SMB\IServer
*/
protected $server;

/**
* @var \Icewind\SMB\IShare
*/
protected $share;

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

protected \Icewind\SMB\IServer $server;
protected \Icewind\SMB\IShare $share;
protected string $root;
/** @var CappedMemoryCache<IFileInfo> */
protected CappedMemoryCache $statCache;

/** @var LoggerInterface */
protected $logger;

/** @var bool */
protected $showHidden;

protected LoggerInterface $logger;
protected bool $showHidden;
private bool $caseSensitive;

/** @var bool */
protected $checkAcl;
protected bool $checkAcl;

public function __construct(array $parameters) {
// Validate required connection target
if (!isset($parameters['host'])) {
throw new \Exception('Invalid configuration, no host provided');
}
// SMB auth
$auth = $this->resolveAuth($parameters);
// SMB client options
$options = $this->buildSmbOptions($parameters);
$this->logger = \OCP\Server::get(LoggerInterface::class);
// Create server + share handles used by all subsequent filesystem operations.
$systemBridge = \OCP\Server::get(SystemBridge::class);
$serverFactory = new ServerFactory($options, $systemBridge);
$this->server = $serverFactory->createServer($parameters['host'], $auth);
$this->share = $this->server->getShare(trim($parameters['share'], '/'));
// Normalize root to canonical internal form: leading slash, trailing slash.
$this->root = $parameters['root'] ?? '/';
$this->root = '/' . ltrim($this->root, '/');
$this->root = rtrim($this->root, '/') . '/';
// Normalize root to canonical internal form: leading slash, trailing slash.
$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->initCaches();
// Call parent last: SMB-specific dependencies/state must be initialized first.
parent::__construct($parameters);
}

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 {
$this->logger = \OCP\Server::get(LoggerInterface::class);
}

private function buildSmbOptions(array $parameters): Options {
$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, '/') . '/';
return $options;
}

$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'];
/**
* Resolve SMB authentication from config.
*
* Prefer prebuilt auth, otherwise build from user/password.
*
* @throws \Exception when credentials are missing/invalid
*/
private function resolveAuth(array $parameters) {
if (isset($parameters['auth'])) {
return $parameters['auth'];
}

if (isset($parameters['user']) && isset($parameters['password']) && isset($parameters['share'])) {
[$workgroup, $username] = $this->splitUser($parameters['user']);
return new BasicAuth($username, $workgroup, $parameters['password']);
}

throw new \Exception('Invalid configuration, no credentials provided');
}

private function initCaches(): void {
$this->statCache = new CappedMemoryCache();
parent::__construct($parameters);
}

private function clearCaches(): void {
$this->statCache->clear();
}

private function splitUser(string $user): array {
Expand Down Expand Up @@ -504,7 +503,7 @@ public function rmdir(string $path): bool {
}

try {
$this->statCache = new CappedMemoryCache();
$this->clearCaches();
$content = $this->share->dir($this->buildPath($path));
foreach ($content as $file) {
if ($file->isDirectory()) {
Expand Down
Loading