feat: implementing Lexicon and Preset

lib/AppInfo/Application.php

@@ -9,6 +9,7 @@
 
 use OCA\Files\Event\LoadAdditionalScriptsEvent;
 use OCA\Guests\Capabilities;
+use OCA\Guests\ConfigLexicon;
 use OCA\Guests\GroupBackend;
 use OCA\Guests\Hooks;
 use OCA\Guests\Listener\BeforeUserManagementRenderedListener;
@@ -47,6 +48,7 @@
 		$context->registerEventListener(ShareCreatedEvent::class, ShareAutoAcceptListener::class);
 		$context->registerEventListener(BeforeTemplateRenderedEvent::class, TalkIntegrationListener::class);
 		$context->registerEventListener(BeforeUserManagementRenderedEvent::class, BeforeUserManagementRenderedListener::class);
+		$context->registerConfigLexicon(ConfigLexicon::class);
 	}
 
 	public function boot(IBootContext $context): void {

lib/Config.php

@@ -10,13 +10,15 @@
 
 use OCP\AppFramework\Services\IAppConfig;
 use OCP\Group\ISubAdmin;
+use OCP\IAppConfig as IGlobalAppConfig;
 use OCP\IConfig;
 use OCP\IGroupManager;
 use OCP\IUserSession;
 
 class Config {
 	public function __construct(
 		private IConfig $config,
+		private IGlobalAppConfig $globalAppConfig,
 		private IAppConfig $appConfig,
 		private ISubAdmin $subAdmin,
 		private IUserSession $userSession,
@@ -25,62 +27,46 @@
 	}
 
 	public function allowExternalStorage(): bool {
-		return $this->appConfig->getAppValueBool('allow_external_storage', false);
+		return $this->appConfig->getAppValueBool(ConfigLexicon::EXTERNAL_STORAGE_ENABLED);
 	}
 
-	/**
-	 * @param string|bool $allow
-	 */
-	public function setAllowExternalStorage($allow) {
-		$this->appConfig->setAppValueBool('allow_external_storage', $allow === true || $allow === 'true') ;
+	public function setAllowExternalStorage(bool $allow): void {
+		$this->appConfig->setAppValueBool(ConfigLexicon::EXTERNAL_STORAGE_ENABLED, $allow);
 	}
 
 	public function hideOtherUsers(): bool {
-		return $this->appConfig->getAppValueBool('hide_users', true);
+		return $this->appConfig->getAppValueBool(ConfigLexicon::HIDE_OTHER_ACCOUNTS);
 	}
 
-	/**
-	 * @param string|bool $hide
-	 */
-	public function setHideOtherUsers($hide): void {
-		$this->appConfig->setAppValueBool('hide_users', $hide === true || $hide === 'true') ;
+	public function setHideOtherUsers(bool $hide): void {
+		$this->appConfig->setAppValueBool(ConfigLexicon::HIDE_OTHER_ACCOUNTS, $hide);
 	}
 
 	public function getHome(string $uid): string {
 		return $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
 	}
 
 	public function useWhitelist(): bool {
-		return $this->appConfig->getAppValueBool('usewhitelist', true);
+		return $this->appConfig->getAppValueBool(ConfigLexicon::WHITE_LIST_ENABLED);
 	}
 
-	/**
-	 * @param string|bool $use
-	 */
-	public function setUseWhitelist($use) {
-		$this->appConfig->setAppValueBool('usewhitelist', $use === true || $use === 'true') ;
+	public function setUseWhitelist(bool $use): void {
+		$this->appConfig->setAppValueBool(ConfigLexicon::WHITE_LIST_ENABLED, $use);
 	}
 
 	/**
 	 * @return string[]
 	 */
 	public function getAppWhitelist(): array {
-		$whitelist = $this->appConfig->getAppValueString('whitelist', AppWhitelist::DEFAULT_WHITELIST);
-		return explode(',', $whitelist);
+		return explode(',', $this->appConfig->getAppValueString(ConfigLexicon::WHITE_LIST));
 	}
 
-	/**
-	 * @param array|string $whitelist
-	 */
-	public function setAppWhitelist($whitelist): void {
-		if (is_array($whitelist)) {
-			$whitelist = implode(',', $whitelist);
-		}
-		$this->appConfig->setAppValueString('whitelist', $whitelist);
+	public function setAppWhitelist(array $whitelist): void {
+		$this->appConfig->setAppValueString(ConfigLexicon::WHITE_LIST, implode(',', $whitelist));
 	}
 
 	public function isSharingRestrictedToGroup(): bool {
-		return $this->config->getAppValue('core', 'shareapi_only_share_with_group_members', 'no') === 'yes';
+		return $this->globalAppConfig->getValueBool('core', 'shareapi_only_share_with_group_members');
 	}
 
 	public function canCreateGuests(): bool {
@@ -114,7 +100,7 @@
 	 * @return string[]
 	 */
 	public function getCreateRestrictedToGroup(): array {
-		$groups = $this->appConfig->getAppValueArray('create_restricted_to_group', []);
+		$groups = $this->appConfig->getAppValueArray(ConfigLexicon::GROUP_LIMITATION);
 		// If empty, it means there is no restriction
 		if (empty($groups)) {
 			return [];
@@ -123,7 +109,7 @@
 		// It does not matter at this point if the admin
 		// group is in the list or not. We are checking it
 		// anyway in the canCreateGuests method.
-		return array_values(array_unique($this->appConfig->getAppValueArray('create_restricted_to_group', [])));
+		return array_values(array_unique($this->appConfig->getAppValueArray(ConfigLexicon::GROUP_LIMITATION)));
 	}
 
 	/**

lib/ConfigLexicon.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Guests;
+
+use OCP\Config\Lexicon\Entry;
+use OCP\Config\Lexicon\ILexicon;
+use OCP\Config\Lexicon\Preset;
+use OCP\Config\Lexicon\Strictness;
+use OCP\Config\ValueType;
+
+/**
+ * Config Lexicon for guests app.
+ *
+ * Please Add & Manage your Config Keys in that file and keep the Lexicon up to date!
+ *
+ * {@see ILexicon}
+ */
+class ConfigLexicon implements ILexicon {
+	public const HIDE_OTHER_ACCOUNTS = 'hide_users';
+	public const EXTERNAL_STORAGE_ENABLED = 'allow_external_storage';
+	public const WHITE_LIST_ENABLED = 'usewhitelist';
+	public const WHITE_LIST = 'whitelist';
+	public const GROUP_LIMITATION = 'create_restricted_to_group';
+	public const GUEST_DISK_QUOTA = 'guest_quota';
+	public const USER_CREATED_BY = 'created_by';
+
+	public function getStrictness(): Strictness {
+		return Strictness::NOTICE;
+	}
+
+	public function getAppConfigs(): array {
+		return [
+			new Entry(self::EXTERNAL_STORAGE_ENABLED, ValueType::BOOL, false, 'permit guests to access to external storage'),
+			new Entry(self::HIDE_OTHER_ACCOUNTS, ValueType::BOOL, true, 'hide other accounts to guests'),
+			new Entry(self::WHITE_LIST_ENABLED, ValueType::BOOL, true, 'enable a white listing of limited apps made available to guests'),
+			new Entry(self::WHITE_LIST, ValueType::STRING, AppWhitelist::DEFAULT_WHITELIST, 'list of white listed apps available to guests'),
+			new Entry(self::GUEST_DISK_QUOTA, ValueType::STRING, defaultRaw: fn (Preset $p): string => match ($p) {
+				Preset::PRIVATE, Preset::FAMILY => '1 GB',
+				Preset::SMALL, Preset::MEDIUM, Preset::LARGE => '10 GB',
+				default => '0 B',
+			}, definition: 'set default disk quota assigned to guest account at its creation'),
+			new Entry(self::GROUP_LIMITATION, ValueType::ARRAY, []),
+		];
+	}
+
+	public function getUserConfigs(): array {
+		return [
+			new Entry(self::USER_CREATED_BY, ValueType::STRING, null, 'user that generated this guest account'),
+		];
+	}
+}

lib/Controller/SettingsController.php

@@ -11,8 +11,10 @@
 use OCA\Guests\AppInfo\Application;
 use OCA\Guests\AppWhitelist;
 use OCA\Guests\Config;
+use OCA\Guests\ConfigLexicon;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\Services\IAppConfig;
 use OCP\IRequest;
 
 /**
@@ -22,11 +24,11 @@
  * @package OCA\Guests\Controller
  */
 class SettingsController extends Controller {
-
 	public function __construct(
 		IRequest $request,
-		private Config $config,
-		private AppWhitelist $appWhitelist,
+		private readonly Config $config,
+		private readonly IAppConfig $appConfig,
+		private readonly AppWhitelist $appWhitelist,
 	) {
 		parent::__construct(Application::APP_ID, $request);
 	}
@@ -94,9 +96,9 @@ public function getWhitelist(): DataResponse {
 	 * @return DataResponse with the reset whitelist
 	 */
 	public function resetWhitelist(): DataResponse {
-		$this->config->setAppWhitelist(AppWhitelist::DEFAULT_WHITELIST);
+		$this->appConfig->deleteAppValue(ConfigLexicon::WHITE_LIST);
 		return new DataResponse([
-			'whitelist' => explode(',', AppWhitelist::DEFAULT_WHITELIST),
+			'whitelist' => $this->config->getAppWhitelist(),
 		]);
 	}
 }

lib/GuestManager.php

@@ -7,6 +7,10 @@
 
 namespace OCA\Guests;
 
+use OCA\Guests\AppInfo\Application;
+use OCP\AppFramework\Services\IAppConfig;
+use OCP\Config\IUserConfig;
+use OCP\Config\ValueType;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IConfig;
@@ -23,6 +27,8 @@
 class GuestManager {
 	public function __construct(
 		private IConfig $config,
+		private readonly IAppConfig $appConfig,
+		private readonly IUserConfig $userConfig,
 		private UserBackend $userBackend,
 		private ISecureRandom $secureRandom,
 		private ICrypto $crypto,
@@ -69,7 +75,7 @@ public function createGuest(?IUser $createdBy, string $userId, string $email, st
 
 		$user->setSystemEMailAddress($email);
 		if ($createdBy) {
-			$this->config->setUserValue($userId, 'guests', 'created_by', $createdBy->getUID());
+			$this->userConfig->setValueString($userId, Application::APP_ID, ConfigLexicon::USER_CREATED_BY, $createdBy->getUID());
 		}
 
 		if ($displayName) {
@@ -101,7 +107,7 @@ public function createGuest(?IUser $createdBy, string $userId, string $email, st
 			);
 		}
 
-		$user->setQuota('0 B');
+		$user->setQuota($this->appConfig->getAppValueString(ConfigLexicon::GUEST_DISK_QUOTA));
 
 		return $user;
 	}
@@ -114,7 +120,8 @@ public function getGuestsInfo(): array {
 		$displayNames = $this->userBackend->getDisplayNames();
 		$guests = array_keys($displayNames);
 		$shareCounts = $this->getShareCountForUsers($guests);
-		$createdBy = $this->config->getUserValueForUsers('guests', 'created_by', $guests);
+		$createdBy = $this->userConfig->getValuesByUsers(Application::APP_ID, ConfigLexicon::USER_CREATED_BY, ValueType::STRING, $guests);
+
 		return array_map(function ($uid) use ($createdBy, $displayNames, $shareCounts) {
 			$allSharesCount = count(array_merge(
 				$this->shareManager->getSharedWith($uid, IShare::TYPE_USER, null, -1, 0),
@@ -127,7 +134,7 @@ public function getGuestsInfo(): array {
 				'email' => $uid,
 				'display_name' => $displayNames[$uid] ?? $uid,
 				'created_by' => $createdBy[$uid] ?? '',
-				'share_count' => isset($shareCounts[$uid]) ? $shareCounts[$uid] : 0,
+				'share_count' => $shareCounts[$uid] ?? 0,
 				'share_count_with_circles' => $allSharesCount,
 			];
 		}, $guests);