Move background settings from dashboard app to Appearance and accessibility settings

Signed-off-by: greta <gretadoci@gmail.com>
Signed-off-by: Christopher Ng <chrng8@gmail.com>

5 files changed, 313 insertions, 30 deletions

diff --git a/apps/theming/lib/Controller/UserThemeController.php b/apps/theming/lib/Controller/UserThemeController.php
index 71d78db4b3d..327029b26cd 100644
--- a/apps/theming/lib/Controller/UserThemeController.php
+++ b/apps/theming/lib/Controller/UserThemeController.php
@@ -30,9 +30,15 @@ declare(strict_types=1);
  */
 namespace OCA\Theming\Controller;
 
+use OCA\Theming\AppInfo\Application;
 use OCA\Theming\ITheme;
+use OCA\Theming\Service\BackgroundService;
 use OCA\Theming\Service\ThemesService;
+use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\Http\FileDisplayResponse;
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\AppFramework\Http\NotFoundResponse;
 use OCP\AppFramework\OCS\OCSBadRequestException;
 use OCP\AppFramework\OCS\OCSForbiddenException;
 use OCP\AppFramework\OCSController;
@@ -47,6 +53,7 @@ class UserThemeController extends OCSController {
 	private IConfig $config;
 	private IUserSession $userSession;
 	private ThemesService $themesService;
+	private BackgroundService $backgroundService;
 
 	/**
 	 * Config constructor.
@@ -55,11 +62,13 @@ class UserThemeController extends OCSController {
 								IRequest $request,
 								IConfig $config,
 								IUserSession $userSession,
-								ThemesService $themesService) {
+								ThemesService $themesService,
+								BackgroundService $backgroundService) {
 		parent::__construct($appName, $request);
 		$this->config = $config;
 		$this->userSession = $userSession;
 		$this->themesService = $themesService;
+		$this->backgroundService = $backgroundService;
 		$this->userId = $userSession->getUser()->getUID();
 	}
 
@@ -91,7 +100,7 @@ class UserThemeController extends OCSController {
 	 */
 	public function disableTheme(string $themeId): DataResponse {
 		$theme = $this->validateTheme($themeId);
-		
+
 		// Enable selected theme
 		$this->themesService->disableTheme($theme);
 		return new DataResponse();
@@ -124,4 +133,54 @@ class UserThemeController extends OCSController {
 
 		return $themes[$themeId];
 	}
+
+	/**
+	 * @NoAdminRequired
+	 * @NoCSRFRequired
+	 */
+	public function getBackground(): Http\Response {
+		$file = $this->backgroundService->getBackground();
+		if ($file !== null) {
+			$response = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => $file->getMimeType()]);
+			$response->cacheFor(24 * 60 * 60, false, true);
+			return $response;
+		}
+		return new NotFoundResponse();
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function setBackground(string $type = 'default', string $value = ''): JSONResponse {
+		$currentVersion = (int)$this->config->getUserValue($this->userId, Application::APP_ID, 'backgroundVersion', '0');
+		try {
+			switch ($type) {
+				case 'shipped':
+					$this->backgroundService->setShippedBackground($value);
+					break;
+				case 'custom':
+					$this->backgroundService->setFileBackground($value);
+					break;
+				case 'color':
+					$this->backgroundService->setColorBackground($value);
+					break;
+				case 'default':
+					$this->backgroundService->setDefaultBackground();
+					break;
+				default:
+					return new JSONResponse(['error' => 'Invalid type provided'], Http::STATUS_BAD_REQUEST);
+			}
+		} catch (\InvalidArgumentException $e) {
+			return new JSONResponse(['error' => $e->getMessage()], Http::STATUS_BAD_REQUEST);
+		} catch (\Throwable $e) {
+			return new JSONResponse(['error' => $e->getMessage()], Http::STATUS_INTERNAL_SERVER_ERROR);
+		}
+		$currentVersion++;
+		$this->config->setUserValue($this->userId, Application::APP_ID, 'backgroundVersion', (string)$currentVersion);
+		return new JSONResponse([
+			'type' => $type,
+			'value' => $value,
+			'version' => $this->config->getUserValue($this->userId, Application::APP_ID, 'backgroundVersion', $currentVersion)
+		]);
+	}
 }
diff --git a/apps/theming/lib/Listener/BeforeTemplateRenderedListener.php b/apps/theming/lib/Listener/BeforeTemplateRenderedListener.php
index 185289f6ff8..d6e00b927ae 100644
--- a/apps/theming/lib/Listener/BeforeTemplateRenderedListener.php
+++ b/apps/theming/lib/Listener/BeforeTemplateRenderedListener.php
@@ -26,40 +26,72 @@ declare(strict_types=1);
 namespace OCA\Theming\Listener;
 
 use OCA\Theming\AppInfo\Application;
+use OCA\Theming\Service\BackgroundService;
 use OCA\Theming\Service\JSDataService;
 use OCA\Theming\Service\ThemeInjectionService;
-use OCA\Theming\Service\ThemesService;
+use OCP\AppFramework\Services\IInitialState;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 use OCP\IConfig;
-use OCP\IInitialStateService;
-use OCP\IServerContainer;
-use OCP\IURLGenerator;
+use OCP\IUserSession;
+use Psr\Container\ContainerInterface;
 
 class BeforeTemplateRenderedListener implements IEventListener {
 
-	private IInitialStateService $initialStateService;
-	private IServerContainer $serverContainer;
+	private IInitialState $initialState;
+	private ContainerInterface $container;
 	private ThemeInjectionService $themeInjectionService;
+	private IUserSession $userSession;
+	private IConfig $config;
 
 	public function __construct(
-		IInitialStateService $initialStateService,
-		IServerContainer $serverContainer,
-		ThemeInjectionService $themeInjectionService
+		IInitialState $initialState,
+		ContainerInterface $container,
+		ThemeInjectionService $themeInjectionService,
+		IUserSession $userSession,
+		IConfig $config
 	) {
-		$this->initialStateService = $initialStateService;
-		$this->serverContainer = $serverContainer;
+		$this->initialState = $initialState;
+		$this->container = $container;
 		$this->themeInjectionService = $themeInjectionService;
+		$this->userSession = $userSession;
+		$this->config = $config;
 	}
 
 	public function handle(Event $event): void {
-		$serverContainer = $this->serverContainer;
-		$this->initialStateService->provideLazyInitialState(Application::APP_ID, 'data', function () use ($serverContainer) {
-			return $serverContainer->query(JSDataService::class);
-		});
+		$this->initialState->provideLazyInitialState(
+			'data',
+			fn () => $this->container->get(JSDataService::class),
+		);
 
 		$this->themeInjectionService->injectHeaders();
 
+		$user = $this->userSession->getUser();
+
+		if (!empty($user)) {
+			$userId = $user->getUID();
+
+			$this->initialState->provideInitialState(
+				'background',
+				$this->config->getUserValue($userId, Application::APP_ID, 'background', 'default'),
+			);
+
+			$this->initialState->provideInitialState(
+				'backgroundVersion',
+				$this->config->getUserValue($userId, Application::APP_ID, 'backgroundVersion', 0),
+			);
+
+			$this->initialState->provideInitialState(
+				'themingDefaultBackground',
+				 $this->config->getAppValue('theming', 'backgroundMime', ''),
+			);
+
+			$this->initialState->provideInitialState(
+				'shippedBackgrounds',
+				 BackgroundService::SHIPPED_BACKGROUNDS,
+			);
+		}
+
 		// Making sure to inject just after core
 		\OCP\Util::addScript('theming', 'theming', 'core');
 	}
diff --git a/apps/theming/lib/Service/BackgroundService.php b/apps/theming/lib/Service/BackgroundService.php
new file mode 100644
index 00000000000..2223c1d2d0a
--- /dev/null
+++ b/apps/theming/lib/Service/BackgroundService.php
@@ -0,0 +1,195 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Jan C. Borchardt <hey@jancborchardt.net>
+ * @author Julius Härtl <jus@bitgrid.net>
+ * @author Christopher Ng <chrng8@gmail.com>
+ *
+ * @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 OCA\Theming\Service;
+
+use InvalidArgumentException;
+use OC\User\NoUserException;
+use OCA\Theming\AppInfo\Application;
+use OCP\Files\File;
+use OCP\Files\IAppData;
+use OCP\Files\IRootFolder;
+use OCP\Files\NotFoundException;
+use OCP\Files\NotPermittedException;
+use OCP\Files\SimpleFS\ISimpleFile;
+use OCP\Files\SimpleFS\ISimpleFolder;
+use OCP\IConfig;
+use OCP\Lock\LockedException;
+use OCP\PreConditionNotMetException;
+
+class BackgroundService {
+	// true when the background is bright and need dark icons
+	public const THEMING_MODE_DARK = 'dark';
+
+	public const SHIPPED_BACKGROUNDS = [
+		'anatoly-mikhaltsov-butterfly-wing-scale.jpg' => [
+			'attribution' => 'Butterfly wing scale (Anatoly Mikhaltsov, CC BY-SA)',
+			'attribution_url' => 'https://commons.wikimedia.org/wiki/File:%D0%A7%D0%B5%D1%88%D1%83%D0%B9%D0%BA%D0%B8_%D0%BA%D1%80%D1%8B%D0%BB%D0%B0_%D0%B1%D0%B0%D0%B1%D0%BE%D1%87%D0%BA%D0%B8.jpg',
+		],
+		'bernie-cetonia-aurata-take-off-composition.jpg' => [
+			'attribution' => 'Cetonia aurata take off composition (Bernie, Public Domain)',
+			'attribution_url' => 'https://commons.wikimedia.org/wiki/File:Cetonia_aurata_take_off_composition_05172009.jpg',
+			'theming' => self::THEMING_MODE_DARK,
+		],
+		'dejan-krsmanovic-ribbed-red-metal.jpg' => [
+			'attribution' => 'Ribbed red metal (Dejan Krsmanovic, CC BY)',
+			'attribution_url' => 'https://www.flickr.com/photos/dejankrsmanovic/42971456774/',
+		],
+		'eduardo-neves-pedra-azul.jpg' => [
+			'attribution' => 'Pedra azul milky way (Eduardo Neves, CC BY-SA)',
+			'attribution_url' => 'https://commons.wikimedia.org/wiki/File:Pedra_Azul_Milky_Way.jpg',
+		],
+		'european-space-agency-barents-bloom.jpg' => [
+			'attribution' => 'Barents bloom (European Space Agency, CC BY-SA)',
+			'attribution_url' => 'https://www.esa.int/ESA_Multimedia/Images/2016/08/Barents_bloom',
+		],
+		'hannes-fritz-flippity-floppity.jpg' => [
+			'attribution' => 'Flippity floppity (Hannes Fritz, CC BY-SA)',
+			'attribution_url' => 'http://hannes.photos/flippity-floppity',
+		],
+		'hannes-fritz-roulette.jpg' => [
+			'attribution' => 'Roulette (Hannes Fritz, CC BY-SA)',
+			'attribution_url' => 'http://hannes.photos/roulette',
+		],
+		'hannes-fritz-sea-spray.jpg' => [
+			'attribution' => 'Sea spray (Hannes Fritz, CC BY-SA)',
+			'attribution_url' => 'http://hannes.photos/sea-spray',
+		],
+		'kamil-porembinski-clouds.jpg' => [
+			'attribution' => 'Clouds (Kamil Porembiński, CC BY-SA)',
+			'attribution_url' => 'https://www.flickr.com/photos/paszczak000/8715851521/',
+		],
+		'bernard-spragg-new-zealand-fern.jpg' => [
+			'attribution' => 'New zealand fern (Bernard Spragg, CC0)',
+			'attribution_url' => 'https://commons.wikimedia.org/wiki/File:NZ_Fern.(Blechnum_chambersii)_(11263534936).jpg',
+		],
+		'rawpixel-pink-tapioca-bubbles.jpg' => [
+			'attribution' => 'Pink tapioca bubbles (Rawpixel, CC BY)',
+			'attribution_url' => 'https://www.flickr.com/photos/byrawpixel/27665140298/in/photostream/',
+			'theming' => self::THEMING_MODE_DARK,
+		],
+		'nasa-waxing-crescent-moon.jpg' => [
+			'attribution' => 'Waxing crescent moon (NASA, Public Domain)',
+			'attribution_url' => 'https://www.nasa.gov/image-feature/a-waxing-crescent-moon',
+		],
+		'tommy-chau-already.jpg' => [
+			'attribution' => 'Cityscape (Tommy Chau, CC BY)',
+			'attribution_url' => 'https://www.flickr.com/photos/90975693@N05/16910999368',
+		],
+		'tommy-chau-lion-rock-hill.jpg' => [
+			'attribution' => 'Lion rock hill (Tommy Chau, CC BY)',
+			'attribution_url' => 'https://www.flickr.com/photos/90975693@N05/17136440246',
+			'theming' => self::THEMING_MODE_DARK,
+		],
+		'lali-masriera-yellow-bricks.jpg' => [
+			'attribution' => 'Yellow bricks (Lali Masriera, CC BY)',
+			'attribution_url' => 'https://www.flickr.com/photos/visualpanic/3982464447',
+			'theming' => self::THEMING_MODE_DARK,
+		]
+	];
+
+	private IRootFolder $rootFolder;
+	private IAppData $appData;
+	private IConfig $config;
+	private string $userId;
+
+	public function __construct(
+		IRootFolder $rootFolder,
+		IAppData $appData,
+		IConfig $config,
+		?string $userId
+	) {
+		if ($userId === null) {
+			return;
+		}
+		$this->rootFolder = $rootFolder;
+		$this->appData = $appData;
+		$this->config = $config;
+		$this->userId = $userId;
+	}
+
+	public function setDefaultBackground(): void {
+		$this->config->deleteUserValue($this->userId, Application::APP_ID, 'background');
+	}
+
+	/**
+	 * @param $path
+	 * @throws NotFoundException
+	 * @throws NotPermittedException
+	 * @throws LockedException
+	 * @throws PreConditionNotMetException
+	 * @throws NoUserException
+	 */
+	public function setFileBackground($path): void {
+		$this->config->setUserValue($this->userId, Application::APP_ID, 'background', 'custom');
+		$userFolder = $this->rootFolder->getUserFolder($this->userId);
+		/** @var File $file */
+		$file = $userFolder->get($path);
+		$image = new \OCP\Image();
+		if ($image->loadFromFileHandle($file->fopen('r')) === false) {
+			throw new InvalidArgumentException('Invalid image file');
+		}
+		$this->getAppDataFolder()->newFile('background.jpg', $file->fopen('r'));
+	}
+
+	public function setShippedBackground($fileName): void {
+		if (!array_key_exists($fileName, self::SHIPPED_BACKGROUNDS)) {
+			throw new InvalidArgumentException('The given file name is invalid');
+		}
+		$this->config->setUserValue($this->userId, Application::APP_ID, 'background', $fileName);
+	}
+
+	public function setColorBackground(string $color): void {
+		if (!preg_match('/^#([0-9a-f]{3}|[0-9a-f]{6})$/i', $color)) {
+			throw new InvalidArgumentException('The given color is invalid');
+		}
+		$this->config->setUserValue($this->userId, Application::APP_ID, 'background', $color);
+	}
+
+	public function getBackground(): ?ISimpleFile {
+		$background = $this->config->getUserValue($this->userId, Application::APP_ID, 'background', 'default');
+		if ($background === 'custom') {
+			try {
+				return $this->getAppDataFolder()->getFile('background.jpg');
+			} catch (NotFoundException | NotPermittedException $e) {
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * @return ISimpleFolder
+	 * @throws NotPermittedException
+	 */
+	private function getAppDataFolder(): ISimpleFolder {
+		try {
+			return $this->appData->getFolder($this->userId);
+		} catch (NotFoundException $e) {
+			return $this->appData->newFolder($this->userId);
+		}
+	}
+}
diff --git a/apps/theming/lib/Settings/Personal.php b/apps/theming/lib/Settings/Personal.php
index 790c0fd7f39..5da72bf0158 100644
--- a/apps/theming/lib/Settings/Personal.php
+++ b/apps/theming/lib/Settings/Personal.php
@@ -30,7 +30,6 @@ use OCA\Theming\Service\ThemesService;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\AppFramework\Services\IInitialState;
 use OCP\IConfig;
-use OCP\IUserSession;
 use OCP\Settings\ISettings;
 use OCP\Util;
 
@@ -38,18 +37,15 @@ class Personal implements ISettings {
 
 	protected string $appName;
 	private IConfig $config;
-	private IUserSession $userSession;
 	private ThemesService $themesService;
 	private IInitialState $initialStateService;
 
 	public function __construct(string $appName,
 								IConfig $config,
-								IUserSession $userSession,
 								ThemesService $themesService,
 								IInitialState $initialStateService) {
 		$this->appName = $appName;
 		$this->config = $config;
-		$this->userSession = $userSession;
 		$this->themesService = $themesService;
 		$this->initialStateService = $initialStateService;
 	}
diff --git a/apps/theming/lib/Themes/DefaultTheme.php b/apps/theming/lib/Themes/DefaultTheme.php
index 986892a6b6c..0fe1e8ff691 100644
--- a/apps/theming/lib/Themes/DefaultTheme.php
+++ b/apps/theming/lib/Themes/DefaultTheme.php
@@ -24,10 +24,11 @@ declare(strict_types=1);
  */
 namespace OCA\Theming\Themes;
 
+use OCA\Theming\AppInfo\Application;
 use OCA\Theming\ImageManager;
+use OCA\Theming\ITheme;
 use OCA\Theming\ThemingDefaults;
 use OCA\Theming\Util;
-use OCA\Theming\ITheme;
 use OCP\App\IAppManager;
 use OCP\IConfig;
 use OCP\IL10N;
@@ -98,7 +99,7 @@ class DefaultTheme implements ITheme {
 		$colorPrimaryElementLight = $this->util->mix($colorPrimaryElement, $colorMainBackground, -80);
 
 		$hasCustomLogoHeader = $this->imageManager->hasImage('logo') || $this->imageManager->hasImage('logoheader');
-		$hasCustomPrimaryColour = !empty($this->config->getAppValue('theming', 'color'));
+		$hasCustomPrimaryColour = !empty($this->config->getAppValue(Application::APP_ID, 'color'));
 
 		$variables = [
 			'--color-main-background' => $colorMainBackground,
@@ -210,7 +211,7 @@ class DefaultTheme implements ITheme {
 			'--image-main-background' => "url('" . $this->urlGenerator->imagePath('core', 'app-background.jpg') . "')",
 		];
 
-		$backgroundDeleted = $this->config->getAppValue('theming', 'backgroundMime', '') === 'backgroundColor';
+		$backgroundDeleted = $this->config->getAppValue(Application::APP_ID, 'backgroundMime', '') === 'backgroundColor';
 		// If primary as background has been request or if we have a custom primary colour
 		// let's not define the background image
 		if ($backgroundDeleted || $hasCustomPrimaryColour) {
@@ -240,13 +241,13 @@ class DefaultTheme implements ITheme {
 		$appManager = Server::get(IAppManager::class);
 		$userSession = Server::get(IUserSession::class);
 		$user = $userSession->getUser();
-		if ($appManager->isEnabledForUser('dashboard') && $user !== null) {
-			$dashboardBackground = $this->config->getUserValue($user->getUID(), 'dashboard', 'background', 'default');
+		if ($appManager->isEnabledForUser(Application::APP_ID) && $user !== null) {
+			$themingBackground = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'background', 'default');
 
-			if ($dashboardBackground === 'custom') {
-				$variables['--image-main-background'] = "url('" . $this->urlGenerator->linkToRouteAbsolute('dashboard.dashboard.getBackground') . "')";
-			} elseif ($dashboardBackground !== 'default' && substr($dashboardBackground, 0, 1) !== '#') {
-				$variables['--image-main-background'] = "url('/apps/dashboard/img/" . $dashboardBackground . "')";
+			if ($themingBackground === 'custom') {
+				$variables['--image-main-background'] = "url('" . $this->urlGenerator->linkToRouteAbsolute('theming.theming.getBackground') . "')";
+			} elseif ($themingBackground !== 'default' && substr($themingBackground, 0, 1) !== '#') {
+				$variables['--image-main-background'] = "url('" . $this->urlGenerator->linkTo(Application::APP_ID, "/img/background/$themingBackground") . "')";
 			}
 		}