|
| 1 | +<?php |
| 2 | + |
| 3 | +/** |
| 4 | + * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors |
| 5 | + * SPDX-License-Identifier: AGPL-3.0-only |
| 6 | + */ |
| 7 | +declare(strict_types=1); |
| 8 | + |
| 9 | +namespace OC\Files\ObjectStore; |
| 10 | + |
| 11 | +use OCP\Files\ObjectStore\IObjectStore; |
| 12 | +use OCP\IConfig; |
| 13 | +use OCP\IUser; |
| 14 | + |
| 15 | +/** |
| 16 | + * @psalm-type ObjectStoreConfig array{class: class-string<IObjectStore>, arguments: array{multibucket: bool, ...}} |
| 17 | + */ |
| 18 | +class PrimaryObjectStoreConfig { |
| 19 | + private IConfig $config; |
| 20 | + |
| 21 | + public function __construct(IConfig $config) { |
| 22 | + $this->config = $config; |
| 23 | + } |
| 24 | + |
| 25 | + /** |
| 26 | + * @param ObjectStoreConfig $config |
| 27 | + */ |
| 28 | + public function buildObjectStore(array $config): IObjectStore { |
| 29 | + return new $config['class']($config['arguments']); |
| 30 | + } |
| 31 | + |
| 32 | + /** |
| 33 | + * @return ?ObjectStoreConfig |
| 34 | + */ |
| 35 | + public function getObjectStoreConfigForRoot(): ?array { |
| 36 | + $config = $this->getObjectStoreConfig(); |
| 37 | + |
| 38 | + if ($config && $config['arguments']['multibucket']) { |
| 39 | + if (!isset($config['arguments']['bucket'])) { |
| 40 | + $config['arguments']['bucket'] = ''; |
| 41 | + } |
| 42 | + |
| 43 | + // put the root FS always in first bucket for multibucket configuration |
| 44 | + $config['arguments']['bucket'] .= '0'; |
| 45 | + } |
| 46 | + return $config; |
| 47 | + } |
| 48 | + |
| 49 | + /** |
| 50 | + * @return ?ObjectStoreConfig |
| 51 | + */ |
| 52 | + public function getObjectStoreConfigForUser(IUser $user): ?array { |
| 53 | + $config = $this->getObjectStoreConfig(); |
| 54 | + |
| 55 | + if ($config && $config['arguments']['multibucket']) { |
| 56 | + $config['arguments']['bucket'] = $this->getBucketForUser($user, $config); |
| 57 | + } |
| 58 | + return $config; |
| 59 | + } |
| 60 | + |
| 61 | + /** |
| 62 | + * @return ?ObjectStoreConfig |
| 63 | + */ |
| 64 | + private function getObjectStoreConfig(): ?array { |
| 65 | + $objectStore = $this->config->getSystemValue('objectstore', null); |
| 66 | + $objectStoreMultiBucket = $this->config->getSystemValue('objectstore_multibucket', null); |
| 67 | + |
| 68 | + // new-style multibucket config uses the same 'objectstore' key but sets `'multibucket' => true`, transparently upgrade older style config |
| 69 | + if ($objectStoreMultiBucket) { |
| 70 | + $objectStoreMultiBucket['arguments']['multibucket'] = true; |
| 71 | + return $this->validateObjectStoreConfig($objectStoreMultiBucket); |
| 72 | + } elseif ($objectStore) { |
| 73 | + return $this->validateObjectStoreConfig($objectStore); |
| 74 | + } else { |
| 75 | + return null; |
| 76 | + } |
| 77 | + } |
| 78 | + |
| 79 | + /** |
| 80 | + * @return ObjectStoreConfig |
| 81 | + */ |
| 82 | + private function validateObjectStoreConfig(array $config) { |
| 83 | + if (!isset($config['class'])) { |
| 84 | + throw new \Exception('No class configured for object store'); |
| 85 | + } |
| 86 | + if (!isset($config['arguments'])) { |
| 87 | + $config['arguments'] = []; |
| 88 | + } |
| 89 | + $class = $config['class']; |
| 90 | + $arguments = $config['arguments']; |
| 91 | + if (!is_array($arguments)) { |
| 92 | + throw new \Exception('Configured object store arguments are not an array'); |
| 93 | + } |
| 94 | + if (!isset($arguments['multibucket'])) { |
| 95 | + $arguments['multibucket'] = false; |
| 96 | + } |
| 97 | + if (!is_bool($arguments['multibucket'])) { |
| 98 | + throw new \Exception('arguments.multibucket must be a boolean in object store configuration'); |
| 99 | + } |
| 100 | + |
| 101 | + if (!is_string($class)) { |
| 102 | + throw new \Exception('Configured class for object store is not a string'); |
| 103 | + } |
| 104 | + |
| 105 | + if (str_starts_with($class, 'OCA\\') && substr_count($class, '\\') >= 2) { |
| 106 | + [$appId] = explode('\\', $class); |
| 107 | + \OC_App::loadApp(strtolower($appId)); |
| 108 | + } |
| 109 | + |
| 110 | + if (!is_a($class, IObjectStore::class, true)) { |
| 111 | + throw new \Exception('Configured class for object store is not an object store'); |
| 112 | + } |
| 113 | + return [ |
| 114 | + 'class' => $class, |
| 115 | + 'arguments' => $arguments, |
| 116 | + ]; |
| 117 | + } |
| 118 | + |
| 119 | + private function getBucketForUser(IUser $user, array $config): string { |
| 120 | + $bucket = $this->config->getUserValue($user->getUID(), 'homeobjectstore', 'bucket', null); |
| 121 | + |
| 122 | + if ($bucket === null) { |
| 123 | + /* |
| 124 | + * Use any provided bucket argument as prefix |
| 125 | + * and add the mapping from username => bucket |
| 126 | + */ |
| 127 | + if (!isset($config['arguments']['bucket'])) { |
| 128 | + $config['arguments']['bucket'] = ''; |
| 129 | + } |
| 130 | + $mapper = new Mapper($user, $this->config); |
| 131 | + $numBuckets = isset($config['arguments']['num_buckets']) ? $config['arguments']['num_buckets'] : 64; |
| 132 | + $bucket = $config['arguments']['bucket'] . $mapper->getBucket($numBuckets); |
| 133 | + |
| 134 | + $this->config->setUserValue($user->getUID(), 'homeobjectstore', 'bucket', $bucket); |
| 135 | + } |
| 136 | + |
| 137 | + return $bucket; |
| 138 | + } |
| 139 | +} |
0 commit comments