[WIP] allow configuring multiple object store backends #35523
Next
Next commit
move primary object store configuration to a single place
Signed-off-by: Robin Appelman <[email protected]>
- Loading branch information
commit 7c8a53d6c3f881284a051fe41b5a125415d22ae7
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2022 Robin Appelman <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OC\Files\ObjectStore; | ||
|
|
||
| use OCP\Files\ObjectStore\IObjectStore; | ||
| use OCP\IConfig; | ||
| use OCP\IUser; | ||
| use Psr\Log\LoggerInterface; | ||
|
|
||
| class PrimaryObjectStoreConfig { | ||
| private IConfig $config; | ||
| private LoggerInterface $logger; | ||
|
|
||
| public function __construct(IConfig $config, LoggerInterface $logger) { | ||
| $this->config = $config; | ||
| $this->logger = $logger; | ||
| } | ||
|
|
||
| public function getObjectStoreForRoot(): ?IObjectStore { | ||
| $config = $this->getObjectStoreConfig(); | ||
| if (!$config) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($config['multibucket']) { | ||
| if (!isset($config['arguments']['bucket'])) { | ||
| $config['arguments']['bucket'] = ''; | ||
| } | ||
|
|
||
| // put the root FS always in first bucket for multibucket configuration | ||
| $config['arguments']['bucket'] .= '0'; | ||
| } | ||
|
|
||
| return new $config['class']($config['arguments']); | ||
| } | ||
|
|
||
| public function getObjectStoreForUser(IUser $user): ?IObjectStore { | ||
| $config = $this->getObjectStoreConfig(); | ||
| if (!$config) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($config['multibucket']) { | ||
| $config['arguments']['bucket'] = $this->getBucketForUser($user, $config); | ||
| } | ||
|
|
||
| // instantiate object store implementation | ||
| return new $config['class']($config['arguments']); | ||
| } | ||
|
|
||
| public function getObjectStoreArguments(): array { | ||
| $config = $this->getObjectStoreConfig(); | ||
| if ($config === null) { | ||
| return []; | ||
| } | ||
| return $config['arguments'] ?? []; | ||
| } | ||
|
|
||
| private function getObjectStoreConfig(): ?array { | ||
| $objectStore = $this->config->getSystemValue('objectstore', null); | ||
| $objectStoreMultiBucket = $this->config->getSystemValue('objectstore_multibucket', null); | ||
|
|
||
| // new-style multibucket config uses the same 'objectstore' key but sets `'multibucket' => true`, transparently upgrade older style config | ||
| if ($objectStoreMultiBucket) { | ||
| $objectStoreMultiBucket['multibucket'] = true; | ||
| $objectStore = $objectStoreMultiBucket; | ||
| } | ||
| if ($objectStore === null) { | ||
| return null; | ||
| } | ||
| if (!isset($objectStore['multibucket'])) { | ||
| $objectStore['multibucket'] = false; | ||
| } | ||
| $this->validateObjectStoreConfig($objectStore); | ||
| return $objectStore; | ||
Check failureCode scanning / Psalm InvalidReturnStatement |
||
| } | ||
|
|
||
| private function validateObjectStoreConfig(array &$config) { | ||
| if (empty($config['class'])) { | ||
| $this->logger->error('No class given for objectstore', ['app' => 'files']); | ||
| } | ||
| if (!isset($config['arguments'])) { | ||
| $config['arguments'] = []; | ||
| } | ||
|
|
||
| // instantiate object store implementation | ||
| $name = $config['class']; | ||
| if (strpos($name, 'OCA\\') === 0 && substr_count($name, '\\') >= 2) { | ||
| $segments = explode('\\', $name); | ||
| \OC_App::loadApp(strtolower($segments[1])); | ||
| } | ||
| } | ||
|
|
||
| private function getBucketForUser(IUser $user, array $config): string { | ||
| $bucket = $this->config->getUserValue($user->getUID(), 'homeobjectstore', 'bucket', null); | ||
|
|
||
| if ($bucket === null) { | ||
| /* | ||
| * Use any provided bucket argument as prefix | ||
| * and add the mapping from username => bucket | ||
| */ | ||
| if (!isset($config['arguments']['bucket'])) { | ||
| $config['arguments']['bucket'] = ''; | ||
| } | ||
| $mapper = new Mapper($user, $this->config); | ||
| $numBuckets = isset($config['arguments']['num_buckets']) ? $config['arguments']['num_buckets'] : 64; | ||
| $bucket = $config['arguments']['bucket'] . $mapper->getBucket($numBuckets); | ||
|
|
||
| $this->config->setUserValue($user->getUID(), 'homeobjectstore', 'bucket', $bucket); | ||
| } | ||
|
|
||
| return $bucket; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check failure
Code scanning / Psalm
InvalidReturnType