feat(theming): Add checkbox for force enable / disable blurry background

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
nextcloud · Jul 10, 2024 · 513b75e · 513b75e
1 parent 8c01a51
commit 513b75e
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 12 deletions.
diff --git a/apps/theming/lib/Listener/BeforePreferenceListener.php b/apps/theming/lib/Listener/BeforePreferenceListener.php
@@ -34,6 +34,12 @@
 
 /** @template-implements IEventListener<BeforePreferenceDeletedEvent|BeforePreferenceSetEvent> */
 class BeforePreferenceListener implements IEventListener {
+
+	/**
+	 * @var string[]
+	 */
+	private const ALLOWED_KEYS = ['force_enable_blur_filter', 'shortcuts_disabled'];
+
 	public function __construct(
 		private IAppManager $appManager,
 	) {
@@ -55,13 +61,22 @@ public function handle(Event $event): void {
 	}
 
 	private function handleThemingValues(BeforePreferenceSetEvent|BeforePreferenceDeletedEvent $event): void {
-		if ($event->getConfigKey() !== 'shortcuts_disabled') {
+		if (!in_array($event->getConfigKey(), self::ALLOWED_KEYS)) {
 			// Not allowed config key
 			return;
 		}
 
 		if ($event instanceof BeforePreferenceSetEvent) {
-			$event->setValid($event->getConfigValue() === 'yes');
+			switch ($event->getConfigKey()) {
+				case 'force_enable_blur_filter':
+					$event->setValid($event->getConfigValue() === 'yes' || $event->getConfigValue() === 'no');
+					break;
+				case 'shortcuts_disabled':
+					$event->setValid($event->getConfigValue() === 'yes');
+					break;
+				default:
+					$event->setValid(false);
+			}
 			return;
 		}
 

diff --git a/apps/theming/lib/Settings/Personal.php b/apps/theming/lib/Settings/Personal.php
@@ -74,6 +74,7 @@ public function getForm(): TemplateResponse {
 		$this->initialStateService->provideInitialState('themes', array_values($themes));
 		$this->initialStateService->provideInitialState('enforceTheme', $enforcedTheme);
 		$this->initialStateService->provideInitialState('isUserThemingDisabled', $this->themingDefaults->isUserThemingDisabled());
+		$this->initialStateService->provideInitialState('enableBlurFilter', $this->config->getUserValue($this->userId, 'theming', 'force_enable_blur_filter', ''));
 		$this->initialStateService->provideInitialState('navigationBar', [
 			'userAppOrder' => json_decode($this->config->getUserValue($this->userId, 'core', 'apporder', '[]'), true, flags:JSON_THROW_ON_ERROR),
 			'enforcedDefaultApp' => $forcedDefaultApp

diff --git a/apps/theming/src/UserThemes.vue b/apps/theming/src/UserThemes.vue
@@ -51,6 +51,14 @@
 					type="font"
 					@change="changeFont" />
 			</div>
+
+			<h3>{{ t('theming', 'Misc accessibility options') }}</h3>
+			<NcCheckboxRadioSwitch type="checkbox"
+				:checked="enableBlurFilter === 'yes'"
+				:indeterminate="enableBlurFilter === ''"
+				@update:checked="changeEnableBlurFilter">
+				{{ t('theming', 'Enable blur background filter (may increase GPU load)') }}
+			</NcCheckboxRadioSwitch>
 		</NcSettingsSection>
 
 		<NcSettingsSection :name="t('theming', 'Background')"
@@ -93,6 +101,7 @@ import UserAppMenuSection from './components/UserAppMenuSection.vue'
 const availableThemes = loadState('theming', 'themes', [])
 const enforceTheme = loadState('theming', 'enforceTheme', '')
 const shortcutsDisabled = loadState('theming', 'shortcutsDisabled', false)
+const enableBlurFilter = loadState('theming', 'enableBlurFilter', '')
 
 const isUserThemingDisabled = loadState('theming', 'isUserThemingDisabled')
 
@@ -115,6 +124,8 @@ export default {
 			enforceTheme,
 			shortcutsDisabled,
 			isUserThemingDisabled,
+
+			enableBlurFilter,
 		}
 	},
 
@@ -240,6 +251,22 @@ export default {
 			}
 		},
 
+		async changeEnableBlurFilter() {
+			this.enableBlurFilter = this.enableBlurFilter === 'no' ? 'yes' : 'no'
+			await axios({
+				url: generateOcsUrl('apps/provisioning_api/api/v1/config/users/{appId}/{configKey}', {
+					appId: 'theming',
+					configKey: 'force_enable_blur_filter',
+				}),
+				data: {
+					configValue: this.enableBlurFilter,
+				},
+				method: 'POST',
+			})
+			// Refresh the styles
+			this.$emit('update:background')
+		},
+
 		updateBodyAttributes() {
 			const enabledThemesIDs = this.themes.filter(theme => theme.enabled === true).map(theme => theme.id)
 			const enabledFontsIDs = this.fonts.filter(font => font.enabled === true).map(font => font.id)

diff --git a/apps/theming/tests/Settings/PersonalTest.php b/apps/theming/tests/Settings/PersonalTest.php
@@ -47,14 +47,15 @@
 use OCP\IL10N;
 use OCP\IURLGenerator;
 use OCP\IUserSession;
+use PHPUnit\Framework\MockObject\MockObject;
 use Test\TestCase;
 
 class PersonalTest extends TestCase {
-	private IConfig $config;
-	private ThemesService $themesService;
-	private IInitialState $initialStateService;
-	private ThemingDefaults $themingDefaults;
-	private IAppManager $appManager;
+	private IConfig|MockObject $config;
+	private ThemesService|MockObject $themesService;
+	private IInitialState|MockObject $initialStateService;
+	private ThemingDefaults|MockObject $themingDefaults;
+	private IAppManager|MockObject $appManager;
 	private Personal $admin;
 
 	/** @var ITheme[] */
@@ -116,23 +117,26 @@ public function testGetForm(string $enforcedTheme, $themesState) {
 			->with('enforce_theme', '')
 			->willReturn($enforcedTheme);
 
-		$this->config->expects($this->once())
+		$this->config->expects($this->exactly(2))
 			->method('getUserValue')
-			->with('admin', 'core', 'apporder')
-			->willReturn('[]');
+			->willReturnMap([
+				['admin', 'core', 'apporder', '[]'],
+				['admin', 'theming', 'force_enable_blur_filter', ''],
+			]);
 
 		$this->appManager->expects($this->once())
 			->method('getDefaultAppForUser')
 			->willReturn('forcedapp');
 
 		$this->initialStateService->expects($this->exactly(4))
 			->method('provideInitialState')
-			->withConsecutive(
+			->willReturnMap([
 				['themes', $themesState],
+				['enableBlurFilter', ''],
 				['enforceTheme', $enforcedTheme],
 				['isUserThemingDisabled', false],
 				['navigationBar', ['userAppOrder' => [], 'enforcedDefaultApp' => 'forcedapp']],
-			);
+			]);
 
 		$expected = new TemplateResponse('theming', 'settings-personal');
 		$this->assertEquals($expected, $this->admin->getForm());
@@ -174,6 +178,7 @@ private function initThemes() {
 				$config,
 				$l10n,
 				$appManager,
+				null,
 			),
 			'light' => new LightTheme(
 				$util,
@@ -184,6 +189,7 @@ private function initThemes() {
 				$config,
 				$l10n,
 				$appManager,
+				null,
 			),
 			'dark' => new DarkTheme(
 				$util,
@@ -194,6 +200,7 @@ private function initThemes() {
 				$config,
 				$l10n,
 				$appManager,
+				null,
 			),
 			'light-highcontrast' => new HighContrastTheme(
 				$util,
@@ -204,6 +211,7 @@ private function initThemes() {
 				$config,
 				$l10n,
 				$appManager,
+				null,
 			),
 			'dark-highcontrast' => new DarkHighContrastTheme(
 				$util,
@@ -214,6 +222,7 @@ private function initThemes() {
 				$config,
 				$l10n,
 				$appManager,
+				null,
 			),
 			'opendyslexic' => new DyslexiaFont(
 				$util,
@@ -224,6 +233,7 @@ private function initThemes() {
 				$config,
 				$l10n,
 				$appManager,
+				null,
 			),
 		];
 	}