feat: Add declarative settings

Signed-off-by: jld3103 <jld3103yt@gmail.com>
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
Signed-off-by: Andrey Borysenko <andrey18106x@gmail.com>

8 files changed, 326 insertions, 2 deletions

diff --git a/apps/testing/composer/composer/autoload_classmap.php b/apps/testing/composer/composer/autoload_classmap.php
index cd2a052bbac..079f8877881 100644
--- a/apps/testing/composer/composer/autoload_classmap.php
+++ b/apps/testing/composer/composer/autoload_classmap.php
@@ -12,9 +12,13 @@ return array(
     'OCA\\Testing\\Controller\\ConfigController' => $baseDir . '/../lib/Controller/ConfigController.php',
     'OCA\\Testing\\Controller\\LockingController' => $baseDir . '/../lib/Controller/LockingController.php',
     'OCA\\Testing\\Controller\\RateLimitTestController' => $baseDir . '/../lib/Controller/RateLimitTestController.php',
+    'OCA\\Testing\\Listener\\GetDeclarativeSettingsValueListener' => $baseDir . '/../lib/Listener/GetDeclarativeSettingsValueListener.php',
+    'OCA\\Testing\\Listener\\RegisterDeclarativeSettingsListener' => $baseDir . '/../lib/Listener/RegisterDeclarativeSettingsListener.php',
+    'OCA\\Testing\\Listener\\SetDeclarativeSettingsValueListener' => $baseDir . '/../lib/Listener/SetDeclarativeSettingsValueListener.php',
     'OCA\\Testing\\Locking\\FakeDBLockingProvider' => $baseDir . '/../lib/Locking/FakeDBLockingProvider.php',
     'OCA\\Testing\\Provider\\FakeText2ImageProvider' => $baseDir . '/../lib/Provider/FakeText2ImageProvider.php',
     'OCA\\Testing\\Provider\\FakeTextProcessingProvider' => $baseDir . '/../lib/Provider/FakeTextProcessingProvider.php',
     'OCA\\Testing\\Provider\\FakeTextProcessingProviderSync' => $baseDir . '/../lib/Provider/FakeTextProcessingProviderSync.php',
     'OCA\\Testing\\Provider\\FakeTranslationProvider' => $baseDir . '/../lib/Provider/FakeTranslationProvider.php',
+    'OCA\\Testing\\Settings\\DeclarativeSettingsForm' => $baseDir . '/../lib/Settings/DeclarativeSettingsForm.php',
 );
diff --git a/apps/testing/composer/composer/autoload_static.php b/apps/testing/composer/composer/autoload_static.php
index ce07262200a..2332da70da9 100644
--- a/apps/testing/composer/composer/autoload_static.php
+++ b/apps/testing/composer/composer/autoload_static.php
@@ -27,11 +27,15 @@ class ComposerStaticInitTesting
         'OCA\\Testing\\Controller\\ConfigController' => __DIR__ . '/..' . '/../lib/Controller/ConfigController.php',
         'OCA\\Testing\\Controller\\LockingController' => __DIR__ . '/..' . '/../lib/Controller/LockingController.php',
         'OCA\\Testing\\Controller\\RateLimitTestController' => __DIR__ . '/..' . '/../lib/Controller/RateLimitTestController.php',
+        'OCA\\Testing\\Listener\\GetDeclarativeSettingsValueListener' => __DIR__ . '/..' . '/../lib/Listener/GetDeclarativeSettingsValueListener.php',
+        'OCA\\Testing\\Listener\\RegisterDeclarativeSettingsListener' => __DIR__ . '/..' . '/../lib/Listener/RegisterDeclarativeSettingsListener.php',
+        'OCA\\Testing\\Listener\\SetDeclarativeSettingsValueListener' => __DIR__ . '/..' . '/../lib/Listener/SetDeclarativeSettingsValueListener.php',
         'OCA\\Testing\\Locking\\FakeDBLockingProvider' => __DIR__ . '/..' . '/../lib/Locking/FakeDBLockingProvider.php',
         'OCA\\Testing\\Provider\\FakeText2ImageProvider' => __DIR__ . '/..' . '/../lib/Provider/FakeText2ImageProvider.php',
         'OCA\\Testing\\Provider\\FakeTextProcessingProvider' => __DIR__ . '/..' . '/../lib/Provider/FakeTextProcessingProvider.php',
         'OCA\\Testing\\Provider\\FakeTextProcessingProviderSync' => __DIR__ . '/..' . '/../lib/Provider/FakeTextProcessingProviderSync.php',
         'OCA\\Testing\\Provider\\FakeTranslationProvider' => __DIR__ . '/..' . '/../lib/Provider/FakeTranslationProvider.php',
+        'OCA\\Testing\\Settings\\DeclarativeSettingsForm' => __DIR__ . '/..' . '/../lib/Settings/DeclarativeSettingsForm.php',
     );
 
     public static function getInitializer(ClassLoader $loader)
diff --git a/apps/testing/composer/composer/installed.php b/apps/testing/composer/composer/installed.php
index 1a66c7f2416..d2b87e1bdfd 100644
--- a/apps/testing/composer/composer/installed.php
+++ b/apps/testing/composer/composer/installed.php
@@ -3,7 +3,7 @@
         'name' => '__root__',
         'pretty_version' => 'dev-master',
         'version' => 'dev-master',
-        'reference' => 'b1797842784b250fb01ed5e3bf130705eb94751b',
+        'reference' => '4ff660ca2e0baa02440ba07296ed7e75fa544c0e',
         'type' => 'library',
         'install_path' => __DIR__ . '/../',
         'aliases' => array(),
@@ -13,7 +13,7 @@
         '__root__' => array(
             'pretty_version' => 'dev-master',
             'version' => 'dev-master',
-            'reference' => 'b1797842784b250fb01ed5e3bf130705eb94751b',
+            'reference' => '4ff660ca2e0baa02440ba07296ed7e75fa544c0e',
             'type' => 'library',
             'install_path' => __DIR__ . '/../',
             'aliases' => array(),
diff --git a/apps/testing/lib/AppInfo/Application.php b/apps/testing/lib/AppInfo/Application.php
index cbbbf6fc4ea..7b51a8469db 100644
--- a/apps/testing/lib/AppInfo/Application.php
+++ b/apps/testing/lib/AppInfo/Application.php
@@ -25,14 +25,21 @@
 namespace OCA\Testing\AppInfo;
 
 use OCA\Testing\AlternativeHomeUserBackend;
+use OCA\Testing\Listener\GetDeclarativeSettingsValueListener;
+use OCA\Testing\Listener\RegisterDeclarativeSettingsListener;
+use OCA\Testing\Listener\SetDeclarativeSettingsValueListener;
 use OCA\Testing\Provider\FakeText2ImageProvider;
 use OCA\Testing\Provider\FakeTextProcessingProvider;
 use OCA\Testing\Provider\FakeTextProcessingProviderSync;
 use OCA\Testing\Provider\FakeTranslationProvider;
+use OCA\Testing\Settings\DeclarativeSettingsForm;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
 use OCP\AppFramework\Bootstrap\IBootstrap;
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
+use OCP\Settings\Events\DeclarativeSettingsGetValueEvent;
+use OCP\Settings\Events\DeclarativeSettingsRegisterFormEvent;
+use OCP\Settings\Events\DeclarativeSettingsSetValueEvent;
 
 class Application extends App implements IBootstrap {
 	public function __construct(array $urlParams = []) {
@@ -44,6 +51,11 @@ class Application extends App implements IBootstrap {
 		$context->registerTextProcessingProvider(FakeTextProcessingProvider::class);
 		$context->registerTextProcessingProvider(FakeTextProcessingProviderSync::class);
 		$context->registerTextToImageProvider(FakeText2ImageProvider::class);
+
+		$context->registerDeclarativeSettings(DeclarativeSettingsForm::class);
+		$context->registerEventListener(DeclarativeSettingsRegisterFormEvent::class, RegisterDeclarativeSettingsListener::class);
+		$context->registerEventListener(DeclarativeSettingsGetValueEvent::class, GetDeclarativeSettingsValueListener::class);
+		$context->registerEventListener(DeclarativeSettingsSetValueEvent::class, SetDeclarativeSettingsValueListener::class);
 	}
 
 	public function boot(IBootContext $context): void {
diff --git a/apps/testing/lib/Listener/GetDeclarativeSettingsValueListener.php b/apps/testing/lib/Listener/GetDeclarativeSettingsValueListener.php
new file mode 100644
index 00000000000..ff55ba77104
--- /dev/null
+++ b/apps/testing/lib/Listener/GetDeclarativeSettingsValueListener.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\Testing\Listener;
+
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\IConfig;
+use OCP\Settings\Events\DeclarativeSettingsGetValueEvent;
+
+/**
+ * @template-implements IEventListener<DeclarativeSettingsGetValueEvent>
+ */
+class GetDeclarativeSettingsValueListener implements IEventListener {
+
+	public function __construct(private IConfig $config) {
+	}
+
+	public function handle(Event $event): void {
+		if (!$event instanceof DeclarativeSettingsGetValueEvent) {
+			return;
+		}
+
+		if ($event->getApp() !== 'testing') {
+			return;
+		}
+
+		$value = $this->config->getUserValue($event->getUser()->getUID(), $event->getApp(), $event->getFieldId());
+		$event->setValue($value);
+	}
+}
diff --git a/apps/testing/lib/Listener/RegisterDeclarativeSettingsListener.php b/apps/testing/lib/Listener/RegisterDeclarativeSettingsListener.php
new file mode 100644
index 00000000000..e11205904e7
--- /dev/null
+++ b/apps/testing/lib/Listener/RegisterDeclarativeSettingsListener.php
@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\Testing\Listener;
+
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\Settings\DeclarativeSettingsTypes;
+use OCP\Settings\Events\DeclarativeSettingsRegisterFormEvent;
+
+/**
+ * @template-implements IEventListener<DeclarativeSettingsRegisterFormEvent>
+ */
+class RegisterDeclarativeSettingsListener implements IEventListener {
+
+	public function __construct() {
+	}
+
+	public function handle(Event $event): void {
+		if (!($event instanceof DeclarativeSettingsRegisterFormEvent)) {
+			// Unrelated
+			return;
+		}
+
+		$event->registerSchema('testing', [
+			'id' => 'test_declarative_form_event',
+			'priority' => 20,
+			'section_type' => DeclarativeSettingsTypes::SECTION_TYPE_ADMIN,
+			'section_id' => 'additional',
+			'storage_type' => DeclarativeSettingsTypes::STORAGE_TYPE_INTERNAL,
+			'title' => 'Test declarative settings event', // NcSettingsSection name
+			'description' => 'This form is registered via the RegisterDeclarativeSettingsFormEvent', // NcSettingsSection description
+			'fields' => [
+				[
+					'id' => 'event_field_1',
+					'title' => 'Why is 42 this answer to all questions?',
+					'description' => 'Hint: It\'s not',
+					'type' => DeclarativeSettingsTypes::TEXT,
+					'placeholder' => 'Enter your answer',
+					'default' => 'Because it is',
+				],
+				[
+					'id' => 'feature_rating',
+					'title' => 'How would you rate this feature?',
+					'description' => 'Your vote is not anonymous',
+					'type' => DeclarativeSettingsTypes::RADIO, // radio, radio-button (NcCheckboxRadioSwitch button-variant)
+					'label' => 'Select single toggle',
+					'default' => '3',
+					'options' => [
+						[
+							'name' => 'Awesome', // NcCheckboxRadioSwitch display name
+							'value' => '1' // NcCheckboxRadioSwitch value
+						],
+						[
+							'name' => 'Very awesome',
+							'value' => '2'
+						],
+						[
+							'name' => 'Super awesome',
+							'value' => '3'
+						],
+					],
+				],
+			],
+		]);
+	}
+}
diff --git a/apps/testing/lib/Listener/SetDeclarativeSettingsValueListener.php b/apps/testing/lib/Listener/SetDeclarativeSettingsValueListener.php
new file mode 100644
index 00000000000..d9931455934
--- /dev/null
+++ b/apps/testing/lib/Listener/SetDeclarativeSettingsValueListener.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\Testing\Listener;
+
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\IConfig;
+use OCP\Settings\Events\DeclarativeSettingsSetValueEvent;
+
+/**
+ * @template-implements IEventListener<DeclarativeSettingsSetValueEvent>
+ */
+class SetDeclarativeSettingsValueListener implements IEventListener {
+
+	public function __construct(private IConfig $config) {
+	}
+
+	public function handle(Event $event): void {
+		if (!$event instanceof DeclarativeSettingsSetValueEvent) {
+			return;
+		}
+
+		if ($event->getApp() !== 'testing') {
+			return;
+		}
+
+		error_log('Testing app wants to store ' . $event->getValue() . ' for field ' . $event->getFieldId() . ' for user ' . $event->getUser()->getUID());
+		$this->config->setUserValue($event->getUser()->getUID(), $event->getApp(), $event->getFieldId(), $event->getValue());
+	}
+}
diff --git a/apps/testing/lib/Settings/DeclarativeSettingsForm.php b/apps/testing/lib/Settings/DeclarativeSettingsForm.php
new file mode 100644
index 00000000000..a717de59ea1
--- /dev/null
+++ b/apps/testing/lib/Settings/DeclarativeSettingsForm.php
@@ -0,0 +1,172 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\Testing\Settings;
+
+use OCP\Settings\DeclarativeSettingsTypes;
+use OCP\Settings\IDeclarativeSettingsForm;
+
+class DeclarativeSettingsForm implements IDeclarativeSettingsForm {
+	public function getSchema(): array {
+		return [
+			'id' => 'test_declarative_form',
+			'priority' => 10,
+			'section_type' => DeclarativeSettingsTypes::SECTION_TYPE_ADMIN, // admin, personal
+			'section_id' => 'additional',
+			'storage_type' => DeclarativeSettingsTypes::STORAGE_TYPE_INTERNAL, // external, internal (handled by core to store in appconfig and preferences)
+			'title' => 'Test declarative settings class', // NcSettingsSection name
+			'description' => 'This form is registered with a DeclarativeSettingsForm class', // NcSettingsSection description
+			'doc_url' => '', // NcSettingsSection doc_url for documentation or help page, empty string if not needed
+			'fields' => [
+				[
+					'id' => 'test_ex_app_field_7', // configkey
+					'title' => 'Multi-selection', // name or label
+					'description' => 'Select some option setting', // hint
+					'type' => DeclarativeSettingsTypes::MULTI_SELECT, // select, radio, multi-select
+					'options' => ['foo', 'bar', 'baz'], // simple options for select, radio, multi-select
+					'placeholder' => 'Select some multiple options', // input placeholder
+					'default' => ['foo', 'bar'],
+				],
+				[
+					'id' => 'some_real_setting',
+					'title' => 'Choose init status check background job interval',
+					'description' => 'How often AppAPI should check for initialization status',
+					'type' => DeclarativeSettingsTypes::RADIO, // radio (NcCheckboxRadioSwitch type radio)
+					'placeholder' => 'Choose init status check background job interval',
+					'default' => '40m',
+					'options' => [
+						[
+							'name' => 'Each 40 minutes', // NcCheckboxRadioSwitch display name
+							'value' => '40m' // NcCheckboxRadioSwitch value
+						],
+						[
+							'name' => 'Each 60 minutes',
+							'value' => '60m'
+						],
+						[
+							'name' => 'Each 120 minutes',
+							'value' => '120m'
+						],
+						[
+							'name' => 'Each day',
+							'value' => 60 * 24 . 'm'
+						],
+					],
+				],
+				[
+					'id' => 'test_ex_app_field_1', // configkey
+					'title' => 'Default text field', // label
+					'description' => 'Set some simple text setting', // hint
+					'type' => DeclarativeSettingsTypes::TEXT, // text, password, email, tel, url, number
+					'placeholder' => 'Enter text setting', // placeholder
+					'default' => 'foo',
+				],
+				[
+					'id' => 'test_ex_app_field_1_1',
+					'title' => 'Email field',
+					'description' => 'Set email config',
+					'type' => DeclarativeSettingsTypes::EMAIL,
+					'placeholder' => 'Enter email',
+					'default' => '',
+				],
+				[
+					'id' => 'test_ex_app_field_1_2',
+					'title' => 'Tel field',
+					'description' => 'Set tel config',
+					'type' => DeclarativeSettingsTypes::TEL,
+					'placeholder' => 'Enter your tel',
+					'default' => '',
+				],
+				[
+					'id' => 'test_ex_app_field_1_3',
+					'title' => 'Url (website) field',
+					'description' => 'Set url config',
+					'type' => 'url',
+					'placeholder' => 'Enter url',
+					'default' => '',
+				],
+				[
+					'id' => 'test_ex_app_field_1_4',
+					'title' => 'Number field',
+					'description' => 'Set number config',
+					'type' => DeclarativeSettingsTypes::NUMBER,
+					'placeholder' => 'Enter number value',
+					'default' => 0,
+				],
+				[
+					'id' => 'test_ex_app_field_2',
+					'title' => 'Password',
+					'description' => 'Set some secure value setting',
+					'type' => 'password',
+					'placeholder' => 'Set secure value',
+					'default' => '',
+				],
+				[
+					'id' => 'test_ex_app_field_3',
+					'title' => 'Selection',
+					'description' => 'Select some option setting',
+					'type' => DeclarativeSettingsTypes::SELECT, // select, radio, multi-select
+					'options' => ['foo', 'bar', 'baz'],
+					'placeholder' => 'Select some option setting',
+					'default' => 'foo',
+				],
+				[
+					'id' => 'test_ex_app_field_4',
+					'title' => 'Toggle something',
+					'description' => 'Select checkbox option setting',
+					'type' => DeclarativeSettingsTypes::CHECKBOX, // checkbox, multiple-checkbox
+					'label' => 'Verify something if enabled',
+					'default' => false,
+				],
+				[
+					'id' => 'test_ex_app_field_5',
+					'title' => 'Multiple checkbox toggles, describing one setting, checked options are saved as an JSON object {foo: true, bar: false}',
+					'description' => 'Select checkbox option setting',
+					'type' => DeclarativeSettingsTypes::MULTI_CHECKBOX, // checkbox, multi-checkbox
+					'default' => ['foo' => true, 'bar' => true, 'baz' => true],
+					'options' => [
+						[
+							'name' => 'Foo',
+							'value' => 'foo', // multiple-checkbox configkey
+						],
+						[
+							'name' => 'Bar',
+							'value' => 'bar',
+						],
+						[
+							'name' => 'Baz',
+							'value' => 'baz',
+						],
+						[
+							'name' => 'Qux',
+							'value' => 'qux',
+						],
+					],
+				],
+				[
+					'id' => 'test_ex_app_field_6',
+					'title' => 'Radio toggles, describing one setting like single select',
+					'description' => 'Select radio option setting',
+					'type' => DeclarativeSettingsTypes::RADIO, // radio (NcCheckboxRadioSwitch type radio)
+					'label' => 'Select single toggle',
+					'default' => 'foo',
+					'options' => [
+						[
+							'name' => 'First radio', // NcCheckboxRadioSwitch display name
+							'value' => 'foo' // NcCheckboxRadioSwitch value
+						],
+						[
+							'name' => 'Second radio',
+							'value' => 'bar'
+						],
+						[
+							'name' => 'Third radio',
+							'value' => 'baz'
+						],
+					],
+				],
+			],
+		];
+	}
+}