Skip to content
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

perf: use more optimized way to get user storage info in ocs user info #49476

Merged
merged 1 commit into from
Jan 16, 2025
Merged

perf: use more optimized way to get user storage info in ocs user info #49476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
81 changes: 55 additions & 26 deletions apps/provisioning_api/lib/Controller/AUserDataOCSController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@
use OC\Group\Manager as GroupManager;
use OC\User\Backend;
use OC\User\NoUserException;
use OC_Helper;
use OCA\Provisioning_API\ResponseDefinitions;
use OCP\Accounts\IAccountManager;
use OCP\Accounts\PropertyDoesNotExistException;
use OCP\AppFramework\Http;
use OCP\AppFramework\OCS\OCSException;
use OCP\AppFramework\OCS\OCSNotFoundException;
use OCP\AppFramework\OCSController;
use OCP\Files\FileInfo;
use OCP\Files\IRootFolder;
use OCP\Files\NotFoundException;
use OCP\Group\ISubAdmin;
use OCP\IConfig;
Expand All @@ -29,6 +30,7 @@
use OCP\L10N\IFactory;
use OCP\User\Backend\ISetDisplayNameBackend;
use OCP\User\Backend\ISetPasswordBackend;
use OCP\Util;

/**
* @psalm-import-type Provisioning_APIUserDetails from ResponseDefinitions
Expand Down Expand Up @@ -56,6 +58,7 @@ public function __construct(
protected IAccountManager $accountManager,
protected ISubAdmin $subAdminManager,
protected IFactory $l10nFactory,
protected IRootFolder $rootFolder,
) {
parent::__construct($appName, $request);
}
Expand Down Expand Up @@ -119,7 +122,7 @@ protected function getUserData(string $userId, bool $includeScopes = false): ?ar
$data['lastLogin'] = $targetUserObject->getLastLogin() * 1000;
$data['backend'] = $targetUserObject->getBackendClassName();
$data['subadmin'] = $this->getUserSubAdminGroupsData($targetUserObject->getUID());
$data[self::USER_FIELD_QUOTA] = $this->fillStorageInfo($targetUserObject->getUID());
$data[self::USER_FIELD_QUOTA] = $this->fillStorageInfo($targetUserObject);
$managers = $this->getManagers($targetUserObject);
$data[self::USER_FIELD_MANAGER] = empty($managers) ? '' : $managers[0];

Expand Down Expand Up @@ -243,34 +246,62 @@ protected function getUserSubAdminGroupsData(string $userId): array {
}

/**
* @param string $userId
* @param IUser $user
* @return Provisioning_APIUserDetailsQuota
* @throws OCSException
*/
protected function fillStorageInfo(string $userId): array {
try {
\OC_Util::tearDownFS();
\OC_Util::setupFS($userId);
$storage = OC_Helper::getStorageInfo('/', null, true, false);
$data = [
'free' => $storage['free'],
'used' => $storage['used'],
'total' => $storage['total'],
'relative' => $storage['relative'],
self::USER_FIELD_QUOTA => $storage['quota'],
];
} catch (NotFoundException $ex) {
// User fs is not setup yet
$user = $this->userManager->get($userId);
if ($user === null) {
throw new OCSException('User does not exist', 101);
protected function fillStorageInfo(IUser $user): array {
$includeExternal = $this->config->getSystemValueBool('quota_include_external_storage');
$userId = $user->getUID();

$quota = $user->getQuota();
if ($quota === 'none') {
$quota = FileInfo::SPACE_UNLIMITED;
} else {
$quota = Util::computerFileSize($quota);
if ($quota === false) {
$quota = FileInfo::SPACE_UNLIMITED;
}
$quota = $user->getQuota();
if ($quota !== 'none') {
$quota = OC_Helper::computerFileSize($quota);
}

try {
if ($includeExternal) {
\OC_Util::tearDownFS();
\OC_Util::setupFS($user->getUID());
$storage = \OC_Helper::getStorageInfo('/', null, true, false);
$data = [
'free' => $storage['free'],
'used' => $storage['used'],
'total' => $storage['total'],
'relative' => $storage['relative'],
self::USER_FIELD_QUOTA => $storage['quota'],
];
} else {
$userFileInfo = $this->rootFolder->getUserFolder($userId)->getStorage()->getCache()->get('');
$used = $userFileInfo->getSize();

if ($quota > 0) {
// prevent division by zero or error codes (negative values)
$relative = round(($used / $quota) * 10000) / 100;
$free = $quota - $used;
$total = $quota;
} else {
$relative = 0;
$free = FileInfo::SPACE_UNLIMITED;
$total = FileInfo::SPACE_UNLIMITED;
}

$data = [
'free' => $free,
'used' => $used,
'total' => $total,
'relative' => $relative,
self::USER_FIELD_QUOTA => $quota,
];
}
} catch (NotFoundException $ex) {
$data = [
self::USER_FIELD_QUOTA => $quota !== false ? $quota : 'none',
self::USER_FIELD_QUOTA => $quota >= 0 ? $quota : 'none',
'used' => 0
];
} catch (\Exception $e) {
Expand All @@ -282,8 +313,6 @@ protected function fillStorageInfo(string $userId): array {
'exception' => $e,
]
);
/* In case the Exception left things in a bad state */
\OC_Util::tearDownFS();
return [];
}
return $data;
Expand Down
5 changes: 4 additions & 1 deletion apps/provisioning_api/lib/Controller/GroupsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
use OCP\AppFramework\OCS\OCSForbiddenException;
use OCP\AppFramework\OCS\OCSNotFoundException;
use OCP\AppFramework\OCSController;
use OCP\Files\IRootFolder;
use OCP\Group\ISubAdmin;
use OCP\IConfig;
use OCP\IGroup;
Expand Down Expand Up @@ -48,6 +49,7 @@ public function __construct(
IAccountManager $accountManager,
ISubAdmin $subAdminManager,
IFactory $l10nFactory,
IRootFolder $rootFolder,
private LoggerInterface $logger,
) {
parent::__construct($appName,
Expand All @@ -58,7 +60,8 @@ public function __construct(
$userSession,
$accountManager,
$subAdminManager,
$l10nFactory
$l10nFactory,
$rootFolder,
);
}

Expand Down
5 changes: 4 additions & 1 deletion apps/provisioning_api/lib/Controller/UsersController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
use OCP\AppFramework\OCS\OCSNotFoundException;
use OCP\AppFramework\OCSController;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Files\IRootFolder;
use OCP\Group\ISubAdmin;
use OCP\HintException;
use OCP\IConfig;
Expand Down Expand Up @@ -67,6 +68,7 @@ public function __construct(
IAccountManager $accountManager,
ISubAdmin $subAdminManager,
IFactory $l10nFactory,
IRootFolder $rootFolder,
private IURLGenerator $urlGenerator,
private LoggerInterface $logger,
private NewUserMailHelper $newUserMailHelper,
Expand All @@ -85,7 +87,8 @@ public function __construct(
$userSession,
$accountManager,
$subAdminManager,
$l10nFactory
$l10nFactory,
$rootFolder,
);

$this->l10n = $l10nFactory->get($appName);
Expand Down
5 changes: 5 additions & 0 deletions apps/provisioning_api/tests/Controller/GroupsControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use OCA\Provisioning_API\Controller\GroupsController;
use OCP\Accounts\IAccountManager;
use OCP\AppFramework\OCS\OCSException;
use OCP\Files\IRootFolder;
use OCP\Group\ISubAdmin;
use OCP\IConfig;
use OCP\IGroup;
Expand Down Expand Up @@ -46,6 +47,8 @@ class GroupsControllerTest extends \Test\TestCase {
/** @var GroupsController|\PHPUnit\Framework\MockObject\MockObject */
protected $api;

private IRootFolder $rootFolder;


protected function setUp(): void {
parent::setUp();
Expand All @@ -59,6 +62,7 @@ protected function setUp(): void {
$this->subAdminManager = $this->createMock(ISubAdmin::class);
$this->l10nFactory = $this->createMock(IFactory::class);
$this->logger = $this->createMock(LoggerInterface::class);
$this->rootFolder = $this->createMock(IRootFolder::class);

$this->groupManager
->method('getSubAdmin')
Expand All @@ -75,6 +79,7 @@ protected function setUp(): void {
$this->accountManager,
$this->subAdminManager,
$this->l10nFactory,
$this->rootFolder,
$this->logger
])
->setMethods(['fillStorageInfo'])
Expand Down
13 changes: 10 additions & 3 deletions apps/provisioning_api/tests/Controller/UsersControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSException;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Files\IRootFolder;
use OCP\Group\ISubAdmin;
use OCP\IConfig;
use OCP\IGroup;
Expand Down Expand Up @@ -76,6 +77,7 @@ class UsersControllerTest extends TestCase {
private $knownUserService;
/** @var IEventDispatcher|MockObject */
private $eventDispatcher;
private IRootFolder $rootFolder;
/** @var IPhoneNumberUtil */
private $phoneNumberUtil;

Expand All @@ -98,6 +100,7 @@ protected function setUp(): void {
$this->knownUserService = $this->createMock(KnownUserService::class);
$this->eventDispatcher = $this->createMock(IEventDispatcher::class);
$this->phoneNumberUtil = new PhoneNumberUtil();
$this->rootFolder = $this->createMock(IRootFolder::class);

$l10n = $this->createMock(IL10N::class);
$l10n->method('t')->willReturnCallback(fn (string $txt, array $replacement = []) => sprintf($txt, ...$replacement));
Expand All @@ -114,6 +117,7 @@ protected function setUp(): void {
$this->accountManager,
$this->subAdminManager,
$this->l10nFactory,
$this->rootFolder,
$this->urlGenerator,
$this->logger,
$this->newUserMailHelper,
Expand Down Expand Up @@ -508,6 +512,7 @@ public function testAddUserSuccessfulWithDisplayName(): void {
$this->accountManager,
$this->subAdminManager,
$this->l10nFactory,
$this->rootFolder,
$this->urlGenerator,
$this->logger,
$this->newUserMailHelper,
Expand Down Expand Up @@ -1127,7 +1132,7 @@ public function testGetUserDataAsAdmin(): void {
$this->api
->expects($this->once())
->method('fillStorageInfo')
->with('UID')
->with($targetUser)
->willReturn(['DummyValue']);

$backend = $this->createMock(UserInterface::class);
Expand Down Expand Up @@ -1254,7 +1259,7 @@ public function testGetUserDataAsSubAdminAndUserIsAccessible(): void {
$this->api
->expects($this->once())
->method('fillStorageInfo')
->with('UID')
->with($targetUser)
->willReturn(['DummyValue']);

$backend = $this->createMock(UserInterface::class);
Expand Down Expand Up @@ -1429,7 +1434,7 @@ public function testGetUserDataAsSubAdminSelfLookup(): void {
$this->api
->expects($this->once())
->method('fillStorageInfo')
->with('UID')
->with($targetUser)
->willReturn(['DummyValue']);

$backend = $this->createMock(UserInterface::class);
Expand Down Expand Up @@ -3788,6 +3793,7 @@ public function testGetCurrentUserLoggedIn(): void {
$this->accountManager,
$this->subAdminManager,
$this->l10nFactory,
$this->rootFolder,
$this->urlGenerator,
$this->logger,
$this->newUserMailHelper,
Expand Down Expand Up @@ -3878,6 +3884,7 @@ public function testGetUser(): void {
$this->accountManager,
$this->subAdminManager,
$this->l10nFactory,
$this->rootFolder,
$this->urlGenerator,
$this->logger,
$this->newUserMailHelper,
Expand Down
Loading