aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Settings
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Settings')
-rw-r--r--lib/private/Settings/AuthorizedGroup.php22
-rw-r--r--lib/private/Settings/AuthorizedGroupMapper.php26
-rw-r--r--lib/private/Settings/DeclarativeManager.php482
-rw-r--r--lib/private/Settings/Manager.php91
-rw-r--r--lib/private/Settings/Section.php34
5 files changed, 524 insertions, 131 deletions
diff --git a/lib/private/Settings/AuthorizedGroup.php b/lib/private/Settings/AuthorizedGroup.php
index 21b897b6787..0171e020171 100644
--- a/lib/private/Settings/AuthorizedGroup.php
+++ b/lib/private/Settings/AuthorizedGroup.php
@@ -1,27 +1,9 @@
<?php
/**
- * @copyright Copyright (c) 2021 Carl Schwan <carl@carlschwan.eu>
- *
- * @author Carl Schwan <carl@carlschwan.eu>
- *
- * @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 <https://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
-
namespace OC\Settings;
use OCP\AppFramework\Db\Entity;
diff --git a/lib/private/Settings/AuthorizedGroupMapper.php b/lib/private/Settings/AuthorizedGroupMapper.php
index 4313ce60580..b622459426b 100644
--- a/lib/private/Settings/AuthorizedGroupMapper.php
+++ b/lib/private/Settings/AuthorizedGroupMapper.php
@@ -1,26 +1,9 @@
<?php
+
/**
- * @copyright Copyright (c) 2021 Carl Schwan <carl@carlschwan.eu>
- *
- * @author Carl Schwan <carl@carlschwan.eu>
- *
- * @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 <https://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
-
namespace OC\Settings;
use OCP\AppFramework\Db\Entity;
@@ -32,6 +15,9 @@ use OCP\IGroup;
use OCP\IGroupManager;
use OCP\IUser;
+/**
+ * @template-extends QBMapper<AuthorizedGroup>
+ */
class AuthorizedGroupMapper extends QBMapper {
public function __construct(IDBConnection $db) {
parent::__construct($db, 'authorized_groups', AuthorizedGroup::class);
diff --git a/lib/private/Settings/DeclarativeManager.php b/lib/private/Settings/DeclarativeManager.php
new file mode 100644
index 00000000000..534b4b19984
--- /dev/null
+++ b/lib/private/Settings/DeclarativeManager.php
@@ -0,0 +1,482 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\Settings;
+
+use Exception;
+use OC\AppFramework\Bootstrap\Coordinator;
+use OC\AppFramework\Middleware\Security\Exceptions\NotAdminException;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IAppConfig;
+use OCP\IConfig;
+use OCP\IGroupManager;
+use OCP\IUser;
+use OCP\Security\ICrypto;
+use OCP\Server;
+use OCP\Settings\DeclarativeSettingsTypes;
+use OCP\Settings\Events\DeclarativeSettingsGetValueEvent;
+use OCP\Settings\Events\DeclarativeSettingsRegisterFormEvent;
+use OCP\Settings\Events\DeclarativeSettingsSetValueEvent;
+use OCP\Settings\IDeclarativeManager;
+use OCP\Settings\IDeclarativeSettingsForm;
+use OCP\Settings\IDeclarativeSettingsFormWithHandlers;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @psalm-import-type DeclarativeSettingsValueTypes from IDeclarativeSettingsForm
+ * @psalm-import-type DeclarativeSettingsStorageType from IDeclarativeSettingsForm
+ * @psalm-import-type DeclarativeSettingsSectionType from IDeclarativeSettingsForm
+ * @psalm-import-type DeclarativeSettingsFormSchemaWithValues from IDeclarativeSettingsForm
+ * @psalm-import-type DeclarativeSettingsFormSchemaWithoutValues from IDeclarativeSettingsForm
+ */
+class DeclarativeManager implements IDeclarativeManager {
+
+ /** @var array<string, list<IDeclarativeSettingsForm>> */
+ private array $declarativeForms = [];
+
+ /**
+ * @var array<string, list<DeclarativeSettingsFormSchemaWithoutValues>>
+ */
+ private array $appSchemas = [];
+
+ public function __construct(
+ private IEventDispatcher $eventDispatcher,
+ private IGroupManager $groupManager,
+ private Coordinator $coordinator,
+ private IConfig $config,
+ private IAppConfig $appConfig,
+ private LoggerInterface $logger,
+ private ICrypto $crypto,
+ ) {
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function registerSchema(string $app, array $schema): void {
+ $this->appSchemas[$app] ??= [];
+
+ if (!$this->validateSchema($app, $schema)) {
+ throw new Exception('Invalid schema. Please check the logs for more details.');
+ }
+
+ foreach ($this->appSchemas[$app] as $otherSchema) {
+ if ($otherSchema['id'] === $schema['id']) {
+ throw new Exception('Duplicate form IDs detected: ' . $schema['id']);
+ }
+ }
+
+ $fieldIDs = array_map(fn ($field) => $field['id'], $schema['fields']);
+ $otherFieldIDs = array_merge(...array_map(fn ($schema) => array_map(fn ($field) => $field['id'], $schema['fields']), $this->appSchemas[$app]));
+ $intersectionFieldIDs = array_intersect($fieldIDs, $otherFieldIDs);
+ if (count($intersectionFieldIDs) > 0) {
+ throw new Exception('Non unique field IDs detected: ' . join(', ', $intersectionFieldIDs));
+ }
+
+ $this->appSchemas[$app][] = $schema;
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function loadSchemas(): void {
+ if (empty($this->declarativeForms)) {
+ $declarativeSettings = $this->coordinator->getRegistrationContext()->getDeclarativeSettings();
+ foreach ($declarativeSettings as $declarativeSetting) {
+ $app = $declarativeSetting->getAppId();
+ /** @var IDeclarativeSettingsForm $declarativeForm */
+ $declarativeForm = Server::get($declarativeSetting->getService());
+ $this->registerSchema($app, $declarativeForm->getSchema());
+ $this->declarativeForms[$app][] = $declarativeForm;
+ }
+ }
+
+ $this->eventDispatcher->dispatchTyped(new DeclarativeSettingsRegisterFormEvent($this));
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function getFormIDs(IUser $user, string $type, string $section): array {
+ $isAdmin = $this->groupManager->isAdmin($user->getUID());
+ /** @var array<string, list<string>> $formIds */
+ $formIds = [];
+
+ foreach ($this->appSchemas as $app => $schemas) {
+ $ids = [];
+ usort($schemas, [$this, 'sortSchemasByPriorityCallback']);
+ foreach ($schemas as $schema) {
+ if ($schema['section_type'] === DeclarativeSettingsTypes::SECTION_TYPE_ADMIN && !$isAdmin) {
+ continue;
+ }
+ if ($schema['section_type'] === $type && $schema['section_id'] === $section) {
+ $ids[] = $schema['id'];
+ }
+ }
+
+ if (!empty($ids)) {
+ $formIds[$app] = array_merge($formIds[$app] ?? [], $ids);
+ }
+ }
+
+ return $formIds;
+ }
+
+ /**
+ * @inheritdoc
+ * @throws Exception
+ */
+ public function getFormsWithValues(IUser $user, ?string $type, ?string $section): array {
+ $isAdmin = $this->groupManager->isAdmin($user->getUID());
+ $forms = [];
+
+ foreach ($this->appSchemas as $app => $schemas) {
+ foreach ($schemas as $schema) {
+ if ($type !== null && $schema['section_type'] !== $type) {
+ continue;
+ }
+ if ($section !== null && $schema['section_id'] !== $section) {
+ continue;
+ }
+ // If listing all fields skip the admin fields which a non-admin user has no access to
+ if ($type === null && $schema['section_type'] === 'admin' && !$isAdmin) {
+ continue;
+ }
+
+ $s = $schema;
+ $s['app'] = $app;
+
+ foreach ($s['fields'] as &$field) {
+ $field['value'] = $this->getValue($user, $app, $schema['id'], $field['id']);
+ }
+ unset($field);
+
+ /** @var DeclarativeSettingsFormSchemaWithValues $s */
+ $forms[] = $s;
+ }
+ }
+
+ usort($forms, [$this, 'sortSchemasByPriorityCallback']);
+
+ return $forms;
+ }
+
+ private function sortSchemasByPriorityCallback(mixed $a, mixed $b): int {
+ if ($a['priority'] === $b['priority']) {
+ return 0;
+ }
+ return $a['priority'] > $b['priority'] ? -1 : 1;
+ }
+
+ /**
+ * @return DeclarativeSettingsStorageType
+ */
+ private function getStorageType(string $app, string $fieldId): string {
+ if (array_key_exists($app, $this->appSchemas)) {
+ foreach ($this->appSchemas[$app] as $schema) {
+ foreach ($schema['fields'] as $field) {
+ if ($field['id'] == $fieldId) {
+ if (array_key_exists('storage_type', $field)) {
+ return $field['storage_type'];
+ }
+ }
+ }
+
+ if (array_key_exists('storage_type', $schema)) {
+ return $schema['storage_type'];
+ }
+ }
+ }
+
+ return DeclarativeSettingsTypes::STORAGE_TYPE_INTERNAL;
+ }
+
+ /**
+ * @return DeclarativeSettingsSectionType
+ * @throws Exception
+ */
+ private function getSectionType(string $app, string $fieldId): string {
+ if (array_key_exists($app, $this->appSchemas)) {
+ foreach ($this->appSchemas[$app] as $schema) {
+ foreach ($schema['fields'] as $field) {
+ if ($field['id'] == $fieldId) {
+ return $schema['section_type'];
+ }
+ }
+ }
+ }
+
+ throw new Exception('Unknown fieldId "' . $fieldId . '"');
+ }
+
+ /**
+ * @psalm-param DeclarativeSettingsSectionType $sectionType
+ * @throws NotAdminException
+ */
+ private function assertAuthorized(IUser $user, string $sectionType): void {
+ if ($sectionType === 'admin' && !$this->groupManager->isAdmin($user->getUID())) {
+ throw new NotAdminException('Logged in user does not have permission to access these settings.');
+ }
+ }
+
+ /**
+ * @return DeclarativeSettingsValueTypes
+ * @throws Exception
+ * @throws NotAdminException
+ */
+ private function getValue(IUser $user, string $app, string $formId, string $fieldId): mixed {
+ $sectionType = $this->getSectionType($app, $fieldId);
+ $this->assertAuthorized($user, $sectionType);
+
+ $storageType = $this->getStorageType($app, $fieldId);
+ switch ($storageType) {
+ case DeclarativeSettingsTypes::STORAGE_TYPE_EXTERNAL:
+ $form = $this->getForm($app, $formId);
+ if ($form !== null && $form instanceof IDeclarativeSettingsFormWithHandlers) {
+ return $form->getValue($fieldId, $user);
+ }
+ $event = new DeclarativeSettingsGetValueEvent($user, $app, $formId, $fieldId);
+ $this->eventDispatcher->dispatchTyped($event);
+ return $event->getValue();
+ case DeclarativeSettingsTypes::STORAGE_TYPE_INTERNAL:
+ return $this->getInternalValue($user, $app, $formId, $fieldId);
+ default:
+ throw new Exception('Unknown storage type "' . $storageType . '"');
+ }
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function setValue(IUser $user, string $app, string $formId, string $fieldId, mixed $value): void {
+ $sectionType = $this->getSectionType($app, $fieldId);
+ $this->assertAuthorized($user, $sectionType);
+
+ $storageType = $this->getStorageType($app, $fieldId);
+ switch ($storageType) {
+ case DeclarativeSettingsTypes::STORAGE_TYPE_EXTERNAL:
+ $form = $this->getForm($app, $formId);
+ if ($form !== null && $form instanceof IDeclarativeSettingsFormWithHandlers) {
+ $form->setValue($fieldId, $value, $user);
+ break;
+ }
+ // fall back to event handling
+ $this->eventDispatcher->dispatchTyped(new DeclarativeSettingsSetValueEvent($user, $app, $formId, $fieldId, $value));
+ break;
+ case DeclarativeSettingsTypes::STORAGE_TYPE_INTERNAL:
+ $this->saveInternalValue($user, $app, $formId, $fieldId, $value);
+ break;
+ default:
+ throw new Exception('Unknown storage type "' . $storageType . '"');
+ }
+ }
+
+ /**
+ * If a declarative setting was registered as a form and not just a schema
+ * then this will yield the registering form.
+ */
+ private function getForm(string $app, string $formId): ?IDeclarativeSettingsForm {
+ $allForms = $this->declarativeForms[$app] ?? [];
+ foreach ($allForms as $form) {
+ if ($form->getSchema()['id'] === $formId) {
+ return $form;
+ }
+ }
+ return null;
+ }
+
+ private function getInternalValue(IUser $user, string $app, string $formId, string $fieldId): mixed {
+ $sectionType = $this->getSectionType($app, $fieldId);
+ $defaultValue = $this->getDefaultValue($app, $formId, $fieldId);
+
+ $field = $this->getSchemaField($app, $formId, $fieldId);
+ $isSensitive = $field !== null && isset($field['sensitive']) && $field['sensitive'] === true;
+
+ switch ($sectionType) {
+ case DeclarativeSettingsTypes::SECTION_TYPE_ADMIN:
+ $value = $this->config->getAppValue($app, $fieldId, $defaultValue);
+ break;
+ case DeclarativeSettingsTypes::SECTION_TYPE_PERSONAL:
+ $value = $this->config->getUserValue($user->getUID(), $app, $fieldId, $defaultValue);
+ break;
+ default:
+ throw new Exception('Unknown section type "' . $sectionType . '"');
+ }
+ if ($isSensitive && $value !== '') {
+ try {
+ $value = $this->crypto->decrypt($value);
+ } catch (Exception $e) {
+ $this->logger->warning('Failed to decrypt sensitive value for field {field} in app {app}: {message}', [
+ 'field' => $fieldId,
+ 'app' => $app,
+ 'message' => $e->getMessage(),
+ ]);
+ $value = $defaultValue;
+ }
+ }
+ return $value;
+ }
+
+ private function saveInternalValue(IUser $user, string $app, string $formId, string $fieldId, mixed $value): void {
+ $sectionType = $this->getSectionType($app, $fieldId);
+
+ $field = $this->getSchemaField($app, $formId, $fieldId);
+ if ($field !== null && isset($field['sensitive']) && $field['sensitive'] === true && $value !== '' && $value !== 'dummySecret') {
+ try {
+ $value = $this->crypto->encrypt($value);
+ } catch (Exception $e) {
+ $this->logger->warning('Failed to decrypt sensitive value for field {field} in app {app}: {message}', [
+ 'field' => $fieldId,
+ 'app' => $app,
+ 'message' => $e->getMessage()]
+ );
+ throw new Exception('Failed to encrypt sensitive value');
+ }
+ }
+
+ switch ($sectionType) {
+ case DeclarativeSettingsTypes::SECTION_TYPE_ADMIN:
+ $this->appConfig->setValueString($app, $fieldId, $value);
+ break;
+ case DeclarativeSettingsTypes::SECTION_TYPE_PERSONAL:
+ $this->config->setUserValue($user->getUID(), $app, $fieldId, $value);
+ break;
+ default:
+ throw new Exception('Unknown section type "' . $sectionType . '"');
+ }
+ }
+
+ private function getSchemaField(string $app, string $formId, string $fieldId): ?array {
+ $form = $this->getForm($app, $formId);
+ if ($form !== null) {
+ foreach ($form->getSchema()['fields'] as $field) {
+ if ($field['id'] === $fieldId) {
+ return $field;
+ }
+ }
+ }
+ foreach ($this->appSchemas[$app] ?? [] as $schema) {
+ if ($schema['id'] === $formId) {
+ foreach ($schema['fields'] as $field) {
+ if ($field['id'] === $fieldId) {
+ return $field;
+ }
+ }
+ }
+ }
+ return null;
+ }
+
+ private function getDefaultValue(string $app, string $formId, string $fieldId): mixed {
+ foreach ($this->appSchemas[$app] as $schema) {
+ if ($schema['id'] === $formId) {
+ foreach ($schema['fields'] as $field) {
+ if ($field['id'] === $fieldId) {
+ if (isset($field['default'])) {
+ if (is_array($field['default'])) {
+ return json_encode($field['default']);
+ }
+ return $field['default'];
+ }
+ }
+ }
+ }
+ }
+ return null;
+ }
+
+ private function validateSchema(string $appId, array $schema): bool {
+ if (!isset($schema['id'])) {
+ $this->logger->warning('Attempt to register a declarative settings schema with no id', ['app' => $appId]);
+ return false;
+ }
+ $formId = $schema['id'];
+ if (!isset($schema['section_type'])) {
+ $this->logger->warning('Declarative settings: missing section_type', ['app' => $appId, 'form_id' => $formId]);
+ return false;
+ }
+ if (!in_array($schema['section_type'], [DeclarativeSettingsTypes::SECTION_TYPE_ADMIN, DeclarativeSettingsTypes::SECTION_TYPE_PERSONAL])) {
+ $this->logger->warning('Declarative settings: invalid section_type', ['app' => $appId, 'form_id' => $formId, 'section_type' => $schema['section_type']]);
+ return false;
+ }
+ if (!isset($schema['section_id'])) {
+ $this->logger->warning('Declarative settings: missing section_id', ['app' => $appId, 'form_id' => $formId]);
+ return false;
+ }
+ if (!isset($schema['storage_type'])) {
+ $this->logger->warning('Declarative settings: missing storage_type', ['app' => $appId, 'form_id' => $formId]);
+ return false;
+ }
+ if (!in_array($schema['storage_type'], [DeclarativeSettingsTypes::STORAGE_TYPE_EXTERNAL, DeclarativeSettingsTypes::STORAGE_TYPE_INTERNAL])) {
+ $this->logger->warning('Declarative settings: invalid storage_type', ['app' => $appId, 'form_id' => $formId, 'storage_type' => $schema['storage_type']]);
+ return false;
+ }
+ if (!isset($schema['title'])) {
+ $this->logger->warning('Declarative settings: missing title', ['app' => $appId, 'form_id' => $formId]);
+ return false;
+ }
+ if (!isset($schema['fields']) || !is_array($schema['fields'])) {
+ $this->logger->warning('Declarative settings: missing or invalid fields', ['app' => $appId, 'form_id' => $formId]);
+ return false;
+ }
+ foreach ($schema['fields'] as $field) {
+ if (!isset($field['id'])) {
+ $this->logger->warning('Declarative settings: missing field id', ['app' => $appId, 'form_id' => $formId, 'field' => $field]);
+ return false;
+ }
+ $fieldId = $field['id'];
+ if (!isset($field['title'])) {
+ $this->logger->warning('Declarative settings: missing field title', ['app' => $appId, 'form_id' => $formId, 'field_id' => $fieldId]);
+ return false;
+ }
+ if (!isset($field['type'])) {
+ $this->logger->warning('Declarative settings: missing field type', ['app' => $appId, 'form_id' => $formId, 'field_id' => $fieldId]);
+ return false;
+ }
+ if (!in_array($field['type'], [
+ DeclarativeSettingsTypes::MULTI_SELECT, DeclarativeSettingsTypes::MULTI_CHECKBOX, DeclarativeSettingsTypes::RADIO,
+ DeclarativeSettingsTypes::SELECT, DeclarativeSettingsTypes::CHECKBOX,
+ DeclarativeSettingsTypes::URL, DeclarativeSettingsTypes::EMAIL, DeclarativeSettingsTypes::NUMBER,
+ DeclarativeSettingsTypes::TEL, DeclarativeSettingsTypes::TEXT, DeclarativeSettingsTypes::PASSWORD,
+ ])) {
+ $this->logger->warning('Declarative settings: invalid field type', [
+ 'app' => $appId, 'form_id' => $formId, 'field_id' => $fieldId, 'type' => $field['type'],
+ ]);
+ return false;
+ }
+ if (isset($field['sensitive']) && $field['sensitive'] === true && !in_array($field['type'], [DeclarativeSettingsTypes::TEXT, DeclarativeSettingsTypes::PASSWORD])) {
+ $this->logger->warning('Declarative settings: sensitive field type is supported only for TEXT and PASSWORD types ({app}, {form_id}, {field_id})', [
+ 'app' => $appId, 'form_id' => $formId, 'field_id' => $fieldId,
+ ]);
+ return false;
+ }
+ if (!$this->validateField($appId, $formId, $field)) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ private function validateField(string $appId, string $formId, array $field): bool {
+ $fieldId = $field['id'];
+ if (in_array($field['type'], [
+ DeclarativeSettingsTypes::MULTI_SELECT, DeclarativeSettingsTypes::MULTI_CHECKBOX, DeclarativeSettingsTypes::RADIO,
+ DeclarativeSettingsTypes::SELECT
+ ])) {
+ if (!isset($field['options'])) {
+ $this->logger->warning('Declarative settings: missing field options', ['app' => $appId, 'form_id' => $formId, 'field_id' => $fieldId]);
+ return false;
+ }
+ if (!is_array($field['options'])) {
+ $this->logger->warning('Declarative settings: field options should be an array', ['app' => $appId, 'form_id' => $formId, 'field_id' => $fieldId]);
+ return false;
+ }
+ }
+ return true;
+ }
+}
diff --git a/lib/private/Settings/Manager.php b/lib/private/Settings/Manager.php
index 2d44ac7d3df..78dc64c3c3f 100644
--- a/lib/private/Settings/Manager.php
+++ b/lib/private/Settings/Manager.php
@@ -1,33 +1,8 @@
<?php
+
/**
- * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Julius Härtl <jus@bitgrid.net>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author sualko <klaus@jsxc.org>
- * @author Carl Schwan <carl@carlschwan.eu>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Settings;
@@ -79,7 +54,7 @@ class Manager implements IManager {
IServerContainer $container,
AuthorizedGroupMapper $mapper,
IGroupManager $groupManager,
- ISubAdmin $subAdmin
+ ISubAdmin $subAdmin,
) {
$this->log = $log;
$this->l10nFactory = $l10nFactory;
@@ -90,17 +65,14 @@ class Manager implements IManager {
$this->subAdmin = $subAdmin;
}
- /** @var array */
+ /** @var array<self::SETTINGS_*, list<class-string<IIconSection>>> */
protected $sectionClasses = [];
- /** @var array */
+ /** @var array<self::SETTINGS_*, array<string, IIconSection>> */
protected $sections = [];
/**
- * @param string $type 'admin' or 'personal'
- * @param string $section Class must implement OCP\Settings\IIconSection
- *
- * @return void
+ * @inheritdoc
*/
public function registerSection(string $type, string $section) {
if (!isset($this->sectionClasses[$type])) {
@@ -111,7 +83,7 @@ class Manager implements IManager {
}
/**
- * @param string $type 'admin' or 'personal'
+ * @psalm-param self::SETTINGS_* $type
*
* @return IIconSection[]
*/
@@ -149,6 +121,9 @@ class Manager implements IManager {
return $this->sections[$type];
}
+ /**
+ * @inheritdoc
+ */
public function getSection(string $type, string $sectionId): ?IIconSection {
if (isset($this->sections[$type]) && isset($this->sections[$type][$sectionId])) {
return $this->sections[$type][$sectionId];
@@ -163,31 +138,27 @@ class Manager implements IManager {
], true);
}
- /** @var array */
+ /** @var array<class-string<ISettings>, self::SETTINGS_*> */
protected $settingClasses = [];
- /** @var array */
+ /** @var array<self::SETTINGS_*, array<string, list<ISettings>>> */
protected $settings = [];
/**
- * @psam-param 'admin'|'personal' $type The type of the setting.
- * @param string $setting Class must implement OCP\Settings\ISettings
- * @param bool $allowedDelegation
- *
- * @return void
+ * @inheritdoc
*/
public function registerSetting(string $type, string $setting) {
$this->settingClasses[$setting] = $type;
}
/**
- * @param string $type 'admin' or 'personal'
+ * @psalm-param self::SETTINGS_* $type The type of the setting.
* @param string $section
- * @param Closure $filter optional filter to apply on all loaded ISettings
+ * @param ?Closure $filter optional filter to apply on all loaded ISettings
*
* @return ISettings[]
*/
- protected function getSettings(string $type, string $section, Closure $filter = null): array {
+ protected function getSettings(string $type, string $section, ?Closure $filter = null): array {
if (!isset($this->settings[$type])) {
$this->settings[$type] = [];
}
@@ -258,7 +229,7 @@ class Manager implements IManager {
/**
* @inheritdoc
*/
- public function getAdminSettings($section, bool $subAdminOnly = false): array {
+ public function getAdminSettings(string $section, bool $subAdminOnly = false): array {
if ($subAdminOnly) {
$subAdminSettingsFilter = function (ISettings $settings) {
return $settings instanceof ISubAdminSettings;
@@ -290,9 +261,7 @@ class Manager implements IManager {
$sections = [];
- $legacyForms = \OC_App::getForms('personal');
- if ((!empty($legacyForms) && $this->hasLegacyPersonalSettingsToRender($legacyForms))
- || count($this->getPersonalSettings('additional')) > 1) {
+ if (count($this->getPersonalSettings('additional')) > 1) {
$sections[98] = [new Section('additional', $this->l->t('Additional settings'), 0, $this->url->imagePath('core', 'actions/settings-dark.svg'))];
}
@@ -313,23 +282,9 @@ class Manager implements IManager {
}
/**
- * @param string[] $forms
- *
- * @return bool
- */
- private function hasLegacyPersonalSettingsToRender(array $forms): bool {
- foreach ($forms as $form) {
- if (trim($form) !== '') {
- return true;
- }
- }
- return false;
- }
-
- /**
* @inheritdoc
*/
- public function getPersonalSettings($section): array {
+ public function getPersonalSettings(string $section): array {
$settings = [];
$appSettings = $this->getSettings('personal', $section);
@@ -344,6 +299,9 @@ class Manager implements IManager {
return $settings;
}
+ /**
+ * @inheritdoc
+ */
public function getAllowedAdminSettings(string $section, IUser $user): array {
$isAdmin = $this->groupManager->isAdmin($user->getUID());
if ($isAdmin) {
@@ -375,6 +333,9 @@ class Manager implements IManager {
return $settings;
}
+ /**
+ * @inheritdoc
+ */
public function getAllAllowedAdminSettings(IUser $user): array {
$this->getSettings('admin', ''); // Make sure all the settings are loaded
$settings = [];
diff --git a/lib/private/Settings/Section.php b/lib/private/Settings/Section.php
index ba94a38e874..6cd8885d2df 100644
--- a/lib/private/Settings/Section.php
+++ b/lib/private/Settings/Section.php
@@ -1,26 +1,8 @@
<?php
+
/**
- * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Settings;
@@ -51,7 +33,7 @@ class Section implements IIconSection {
/**
* @return string The ID of the section. It is supposed to be a lower case string,
- * e.g. 'ldap'
+ * e.g. 'ldap'
*/
public function getID() {
return $this->id;
@@ -59,7 +41,7 @@ class Section implements IIconSection {
/**
* @return string The translated name as it should be displayed, e.g. 'LDAP / AD
- * integration'. Use the L10N service to translate it.
+ * integration'. Use the L10N service to translate it.
*/
public function getName() {
return $this->name;
@@ -67,8 +49,8 @@ class Section implements IIconSection {
/**
* @return int whether the form should be rather on the top or bottom of
- * the settings navigation. The sections are arranged in ascending order of
- * the priority values. It is required to return a value between 0 and 99.
+ * the settings navigation. The sections are arranged in ascending order of
+ * the priority values. It is required to return a value between 0 and 99.
*
* E.g.: 70
*/
@@ -78,7 +60,7 @@ class Section implements IIconSection {
/**
* @return string The relative path to an 16*16 icon describing the section.
- * e.g. '/core/img/places/files.svg'
+ * e.g. '/core/img/places/files.svg'
*
* @since 12
*/
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 13:46:11 +0000