nextcloud/lib/private/Files/Storage/StorageFactory.php
Carl Schwan 33402a991b
perf: Only sort wrappers when adding them
Instead of doing that each time a new mount point is created (e.g. for
the 7000 shares we have in production).

Signed-off-by: Carl Schwan <carlschwan@kde.org>
2026-06-30 15:18:42 +02:00

76 lines
2.6 KiB
PHP

<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Files\Storage;
use OCP\Files\Mount\IMountPoint;
use OCP\Files\Storage\IConstructableStorage;
use OCP\Files\Storage\IStorage;
use OCP\Files\Storage\IStorageFactory;
use OCP\Server;
use Psr\Log\LoggerInterface;
class StorageFactory implements IStorageFactory {
/** @var array<string, array{wrapper: callable(string $mountPoint, IStorage $storage): IStorage, priority: int}> $storageWrappers */
private array $storageWrappers = [];
/** @var bool $dirty Whether the list of storage wrappers is sorted */
private bool $dirty = true;
#[\Override]
public function addStorageWrapper(string $wrapperName, callable $callback, int $priority = 50, array $existingMounts = []): bool {
if (isset($this->storageWrappers[$wrapperName])) {
return false;
}
// apply to existing mounts before registering it to prevent applying it double in MountPoint::createStorage
foreach ($existingMounts as $mount) {
$mount->wrapStorage($callback);
}
$this->storageWrappers[$wrapperName] = ['wrapper' => $callback, 'priority' => $priority];
$this->dirty = true;
return true;
}
/**
* Remove a storage wrapper by name.
* Note: internal method only to be used for cleanup
*
* @internal
*/
public function removeStorageWrapper(string $wrapperName): void {
unset($this->storageWrappers[$wrapperName]);
}
/**
* Create an instance of a storage and apply the registered storage wrappers
*/
#[\Override]
public function getInstance(IMountPoint $mountPoint, string $class, array $arguments): IStorage {
if (!is_a($class, IConstructableStorage::class, true)) {
Server::get(LoggerInterface::class)->warning('Building a storage not implementing IConstructableStorage is deprecated since 31.0.0', ['class' => $class]);
}
return $this->wrap($mountPoint, new $class($arguments));
}
public function wrap(IMountPoint $mountPoint, IStorage $storage): IStorage {
if ($this->dirty) {
uasort($this->storageWrappers, static fn (array $a, array $b) => $b['priority'] - $a['priority']);
$this->dirty = false;
}
foreach ($this->storageWrappers as $wrapper) {
/** @var callable(string, IStorage, IMountPoint): IStorage $wrapperCallable */
$wrapperCallable = $wrapper['wrapper'];
$storage = $wrapperCallable($mountPoint->getMountPoint(), $storage, $mountPoint);
if (!($storage instanceof IStorage)) {
throw new \Exception('Invalid result from storage wrapper');
}
}
return $storage;
}
}