Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -2257,6 +2257,7 @@
'OC\\User\\LazyUser' => $baseDir . '/lib/private/User/LazyUser.php',
'OC\\User\\Listeners\\BeforeUserDeletedListener' => $baseDir . '/lib/private/User/Listeners/BeforeUserDeletedListener.php',
'OC\\User\\Listeners\\UserChangedListener' => $baseDir . '/lib/private/User/Listeners/UserChangedListener.php',
'OC\\User\\Listeners\\UserQuotaChangedListener' => $baseDir . '/lib/private/User/Listeners/UserQuotaChangedListener.php',
'OC\\User\\LoginException' => $baseDir . '/lib/private/User/LoginException.php',
'OC\\User\\Manager' => $baseDir . '/lib/private/User/Manager.php',
'OC\\User\\NoUserException' => $baseDir . '/lib/private/User/NoUserException.php',
Expand Down
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -2298,6 +2298,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\User\\LazyUser' => __DIR__ . '/../../..' . '/lib/private/User/LazyUser.php',
'OC\\User\\Listeners\\BeforeUserDeletedListener' => __DIR__ . '/../../..' . '/lib/private/User/Listeners/BeforeUserDeletedListener.php',
'OC\\User\\Listeners\\UserChangedListener' => __DIR__ . '/../../..' . '/lib/private/User/Listeners/UserChangedListener.php',
'OC\\User\\Listeners\\UserQuotaChangedListener' => __DIR__ . '/../../..' . '/lib/private/User/Listeners/UserQuotaChangedListener.php',
'OC\\User\\LoginException' => __DIR__ . '/../../..' . '/lib/private/User/LoginException.php',
'OC\\User\\Manager' => __DIR__ . '/../../..' . '/lib/private/User/Manager.php',
'OC\\User\\NoUserException' => __DIR__ . '/../../..' . '/lib/private/User/NoUserException.php',
Expand Down
2 changes: 2 additions & 0 deletions lib/private/Server.php
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@
use OC\User\DisplayNameCache;
use OC\User\Listeners\BeforeUserDeletedListener;
use OC\User\Listeners\UserChangedListener;
use OC\User\Listeners\UserQuotaChangedListener;
use OC\User\Session;
use OC\User\User;
use OCA\Theming\ImageManager;
Expand Down Expand Up @@ -1342,6 +1343,7 @@ private function connectDispatcher(): void {
$eventDispatcher->addServiceListener(LoginFailed::class, LoginFailedListener::class);
$eventDispatcher->addServiceListener(PostLoginEvent::class, UserLoggedInListener::class);
$eventDispatcher->addServiceListener(UserChangedEvent::class, UserChangedListener::class);
$eventDispatcher->addServiceListener(UserChangedEvent::class, UserQuotaChangedListener::class);
$eventDispatcher->addServiceListener(BeforeUserDeletedEvent::class, BeforeUserDeletedListener::class);

FilesMetadataManager::loadListeners($eventDispatcher);
Expand Down
53 changes: 53 additions & 0 deletions lib/private/User/Listeners/UserQuotaChangedListener.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace OC\User\Listeners;

use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventListener;
use OCP\Files\IRootFolder;
use OCP\User\Events\UserChangedEvent;
use Psr\Log\LoggerInterface;

/**
* @template-implements IEventListener<UserChangedEvent>
*/
class UserQuotaChangedListener implements IEventListener {
public function __construct(
private IRootFolder $rootFolder,
private LoggerInterface $logger,
) {
}

#[\Override]
public function handle(Event $event): void {
if (!$event instanceof UserChangedEvent) {
return;
}

if ($event->getFeature() !== 'quota') {
return;
}

try {
$userFolder = $this->rootFolder->getUserFolder($event->getUser()->getUID());
$userFolder->getStorage()->getCache()->update(
$userFolder->getId(),
['etag' => uniqid()]
);
} catch (\Throwable $e) {
// Non-fatal: best-effort ETag invalidation.
// Stale quota corrects itself on the client's next full sync.
$this->logger->warning('Failed to invalidate user root etag after quota change', [
'user' => $event->getUser()->getUID(),
'exception' => $e,
]);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace Test\User\Listeners;

use OCP\Files\IRootFolder;
use OCP\IUserManager;
use OCP\Server;
use PHPUnit\Framework\Attributes\Group;
use Test\TestCase;

/**
* End-to-end coverage for the quota change etag invalidation: unlike the
* mock-based unit test this proves the listener is actually registered in
* the server container, by going through the real setQuota() event chain.
*/
#[Group('DB')]
class UserQuotaChangedListenerIntegrationTest extends TestCase {
private const TEST_USER = 'quota_etag_listener_test_user';

#[\Override]
protected function tearDown(): void {
Server::get(IUserManager::class)->get(self::TEST_USER)?->delete();
parent::tearDown();
}

public function testSetQuotaInvalidatesUserRootEtag(): void {
$userManager = Server::get(IUserManager::class);
$userManager->get(self::TEST_USER)?->delete();
$user = $userManager->createUser(self::TEST_USER, 'correct-Horse-battery1!');
$this->assertNotFalse($user);

$userFolder = Server::get(IRootFolder::class)->getUserFolder(self::TEST_USER);
$cache = $userFolder->getStorage()->getCache();
$etagBefore = $cache->get($userFolder->getInternalPath())->getEtag();

$user->setQuota('5 GB');

$etagAfter = $cache->get($userFolder->getInternalPath())->getEtag();
$this->assertNotEquals(
$etagBefore,
$etagAfter,
'User root etag must change when the quota changes so clients re-fetch quota-available-bytes',
);
}
}
90 changes: 90 additions & 0 deletions tests/lib/User/Listeners/UserQuotaChangedListenerTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/

namespace Test\User\Listeners;

use OC\User\Listeners\UserQuotaChangedListener;
use OCP\EventDispatcher\Event;
use OCP\Files\Cache\ICache;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\Storage\IStorage;
use OCP\IUser;
use OCP\User\Events\UserChangedEvent;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use Test\TestCase;

class UserQuotaChangedListenerTest extends TestCase {
private IRootFolder&MockObject $rootFolder;
private LoggerInterface&MockObject $logger;
private UserQuotaChangedListener $listener;

protected function setUp(): void {
parent::setUp();
$this->rootFolder = $this->createMock(IRootFolder::class);
$this->logger = $this->createMock(LoggerInterface::class);
$this->listener = new UserQuotaChangedListener($this->rootFolder, $this->logger);
}

public function testIgnoresNonUserChangedEvent(): void {
$this->rootFolder->expects($this->never())->method('getUserFolder');
$this->listener->handle($this->createMock(Event::class));
}

public function testIgnoresNonQuotaFeature(): void {
$user = $this->createMock(IUser::class);
$event = new UserChangedEvent($user, 'displayName', 'Alice', 'Bob');

$this->rootFolder->expects($this->never())->method('getUserFolder');
$this->listener->handle($event);
}

public function testInvalidatesEtagOnQuotaChange(): void {
$user = $this->createMock(IUser::class);
$user->method('getUID')->willReturn('alice');

$cache = $this->createMock(ICache::class);
$cache->expects($this->once())
->method('update')
->with($this->isInt(), $this->callback(
fn (array $data) => isset($data['etag']) && $data['etag'] !== ''
));

$storage = $this->createMock(IStorage::class);
$storage->method('getCache')->willReturn($cache);

$userFolder = $this->createMock(Folder::class);
$userFolder->method('getStorage')->willReturn($storage);
$userFolder->method('getId')->willReturn(42);

$this->rootFolder->method('getUserFolder')->with('alice')->willReturn($userFolder);

$event = new UserChangedEvent($user, 'quota', '5 GB', '1 GB');
$this->listener->handle($event);
}

public function testSwallowsExceptionButLogsWarning(): void {
$user = $this->createMock(IUser::class);
$user->method('getUID')->willReturn('alice');

$this->rootFolder->method('getUserFolder')
->willThrowException(new \Exception('Storage unavailable'));

$this->logger->expects($this->once())
->method('warning')
->with($this->isString(), $this->callback(
fn (array $context) => $context['user'] === 'alice' && $context['exception'] instanceof \Exception
));

// Must not throw
$event = new UserChangedEvent($user, 'quota', '5 GB', '1 GB');
$this->listener->handle($event);
}
}
Loading