Skip to content

refactor(SetupManager): user ID retrieval once #58349

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

Closed
solracsf wants to merge 4 commits into from
+49 −31
Closed

refactor(SetupManager): user ID retrieval once #58349

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d04922d
refactor(SetupManager): user ID retrieval once
solracsf Feb 14, 2026
c131d79
fix: typo
solracsf Feb 14, 2026
d9f3353
fix: TypeError
solracsf Feb 14, 2026
610ced9
fix: TypeError
solracsf Feb 14, 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
80 changes: 49 additions & 31 deletions lib/private/Files/SetupManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,14 +265,17 @@
if ($this->isSetupComplete($user)) {
return;
}
$this->setupUsersComplete[] = $user->getUID();

$userId = $user->getUID();

$this->setupUsersComplete[] = $userId;

$this->eventLogger->start('fs:setup:user:full', 'Setup full filesystem for user');

$this->dropPartialMountsForUser($user);

$this->setupUserMountProviders[$user->getUID()] ??= [];
$previouslySetupProviders = $this->setupUserMountProviders[$user->getUID()];
$this->setupUserMountProviders[$userId] ??= [];
$previouslySetupProviders = $this->setupUserMountProviders[$userId];

$this->setupForUserWith($user, function () use ($user): void {
$this->mountProviderCollection->addMountForUser($user, $this->mountManager, function (
Expand All @@ -292,7 +295,10 @@
if ($this->isSetupStarted($user)) {
return;
}
$this->setupUsers[] = $user->getUID();

$userId = $user->getUID();

$this->setupUsers[] = $userId;

$this->setupRoot();

Expand All @@ -303,14 +309,14 @@
$prevLogging = Filesystem::logWarningWhenAddingStorageWrapper(false);

// TODO remove hook
OC_Hook::emit('OC_Filesystem', 'preSetup', ['user' => $user->getUID()]);
OC_Hook::emit('OC_Filesystem', 'preSetup', ['user' => $userId]);

$event = new BeforeFileSystemSetupEvent($user);
$this->eventDispatcher->dispatchTyped($event);

Filesystem::logWarningWhenAddingStorageWrapper($prevLogging);

$userDir = '/' . $user->getUID() . '/files';
$userDir = '/' . $userId . '/files';

Filesystem::initInternal($userDir);

Expand All @@ -330,13 +336,13 @@
} else {
$this->mountManager->addMount(new MountPoint(
new NullStorage([]),
'/' . $user->getUID()
'/' . $userId
));
$this->mountManager->addMount(new MountPoint(
new NullStorage([]),
'/' . $user->getUID() . '/files'
'/' . $userId . '/files'
));
$this->setupUsersComplete[] = $user->getUID();
$this->setupUsersComplete[] = $userId;
}

$this->listenForNewMountProviders();
Expand Down Expand Up @@ -374,8 +380,9 @@
private function markUserMountsCached(IUser $user): void {
$cacheDuration = $this->config->getSystemValueInt('fs_mount_cache_duration', 5 * 60);
if ($cacheDuration > 0) {
$this->cache->set($user->getUID(), true, $cacheDuration);
$this->fullSetupRequired[$user->getUID()] = false;
$userId = $user->getUID();
$this->cache->set($userId, true, $cacheDuration);
$this->fullSetupRequired[$userId] = false;
}
}

Expand All @@ -393,21 +400,24 @@
if ($this->lockdownManager->canAccessFilesystem()) {
$mountCallback();
}

$userId = $user->getUID();

$this->eventLogger->start('fs:setup:user:post-init-mountpoint', 'post_initMountPoints legacy hook');
\OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', ['user' => $user->getUID()]);
\OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', ['user' => $userId]);
$this->eventLogger->end('fs:setup:user:post-init-mountpoint');

$userDir = '/' . $user->getUID() . '/files';
$userDir = '/' . $userId . '/files';
$this->eventLogger->start('fs:setup:user:setup-hook', 'setup legacy hook');
OC_Hook::emit('OC_Filesystem', 'setup', ['user' => $user->getUID(), 'user_dir' => $userDir]);
OC_Hook::emit('OC_Filesystem', 'setup', ['user' => $userId, 'user_dir' => $userDir]);
$this->eventLogger->end('fs:setup:user:setup-hook');
}

/**
* Set up the root filesystem
*/
public function setupRoot(): void {
//setting up the filesystem twice can only lead to trouble
// setting up the filesystem twice can only lead to trouble
if ($this->rootSetup) {
return;
}
Expand Down Expand Up @@ -440,9 +450,8 @@
} elseif (substr_count($path, '/') < 2) {
if ($user = $this->userSession->getUser()) {
return $user;
} else {
return null;
}
return null;
} elseif (str_starts_with($path, '/appdata_' . \OC_Util::getInstanceId()) || str_starts_with($path, '/files_external/')) {
return null;
} else {
Expand All @@ -455,7 +464,7 @@
#[Override]
public function setupForPath(string $path, bool $includeChildren = false): void {
$user = $this->getUserForPath($path, $includeChildren);
if (!$user) {
if ($user === null) {
$this->setupRoot();
return;
}
Expand All @@ -474,16 +483,18 @@
}
}

// for the user's home folder, and includes children we need everything always
if (rtrim($path) === '/' . $user->getUID() . '/files' && $includeChildren) {
$userId = $user->getUID();

// For user's home folder with children, always perform full setup
if (rtrim($path) === '/' . $userId . '/files' && $includeChildren) {
$this->setupForUser($user);
return;
}

if (!isset($this->setupUserMountProviders[$user->getUID()])) {
$this->setupUserMountProviders[$user->getUID()] = [];
if (!isset($this->setupUserMountProviders[$userId])) {
$this->setupUserMountProviders[$userId] = [];
}
$setupProviders = &$this->setupUserMountProviders[$user->getUID()];
$setupProviders = &$this->setupUserMountProviders[$userId];

Check failure on line 497 in lib/private/Files/SetupManager.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

UnsupportedPropertyReferenceUsage 

lib/private/Files/SetupManager.php:497:3: UnsupportedPropertyReferenceUsage: This reference cannot be analyzed by Psalm. (see https://psalm.dev/321)
$currentProviders = [];

try {
Expand Down Expand Up @@ -647,10 +658,11 @@
// we perform a "cached" setup only after having done the full setup recently
// this is also used to trigger a full setup after handling events that are likely
// to change the available mounts
if (!isset($this->fullSetupRequired[$user->getUID()])) {
$this->fullSetupRequired[$user->getUID()] = !$this->cache->get($user->getUID());
$userId = $user->getUID();
if (!isset($this->fullSetupRequired[$userId])) {
$this->fullSetupRequired[$userId] = !$this->cache->get($userId);
}
return $this->fullSetupRequired[$user->getUID()];
return $this->fullSetupRequired[$userId];
}

/**
Expand Down Expand Up @@ -697,7 +709,10 @@
$this->setupForUser($user);
return;
}
$setupProviders = $this->setupUserMountProviders[$user->getUID()] ?? [];

$userId = $user->getUID();

$setupProviders = $this->setupUserMountProviders[$userId] ?? [];

$providers = array_diff($providers, $setupProviders);
if (count($providers) === 0) {
Expand All @@ -708,7 +723,7 @@
return;
} else {
$this->dropPartialMountsForUser($user, $providers);
$this->setupUserMountProviders[$user->getUID()] = array_merge($setupProviders, $providers);
$this->setupUserMountProviders[$userId] = array_merge($setupProviders, $providers);
$mounts = $this->mountProviderCollection->getUserMountsForProviderClasses($user, $providers);
}

Expand Down Expand Up @@ -753,8 +768,8 @@
}

private function setupListeners() {
// note that this event handling is intentionally pessimistic
// clearing the cache to often is better than not enough
// Note that this event handling is intentionally pessimistic
// clearing the cache too often is better than not enough

$this->eventDispatcher->addListener(UserAddedEvent::class, function (UserAddedEvent $event): void {
$this->cache->remove($event->getUser()->getUID());
Expand Down Expand Up @@ -812,13 +827,16 @@
public function dropPartialMountsForUser(IUser $user, array $providers = []): void {
// mounts are cached by mount-point
$mounts = $this->mountManager->getAll();

$userDir = '/' . $user->getUID() . '/files';

$partialMounts = array_filter($this->setupMountProviderPaths,
static function (string $mountPoint) use (
$providers,
$user,
$mounts
) {
$isUserMount = str_starts_with($mountPoint, '/' . $user->getUID() . '/files');
$isUserMount = str_starts_with($mountPoint, $userDir);

Check failure on line 839 in lib/private/Files/SetupManager.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

UndefinedVariable 

lib/private/Files/SetupManager.php:839:49: UndefinedVariable: Cannot find referenced variable $userDir (see https://psalm.dev/024)

if (!$isUserMount) {
return false;
Expand Down
Loading