Allow to set a custom background

Signed-off-by: Julius Härtl <jus@bitgrid.net>

3 files changed, 198 insertions, 0 deletions

diff --git a/apps/dashboard/lib/Controller/DashboardController.php b/apps/dashboard/lib/Controller/DashboardController.php
index 305759fa6e8..f6fea2aaf45 100644
--- a/apps/dashboard/lib/Controller/DashboardController.php
+++ b/apps/dashboard/lib/Controller/DashboardController.php
@@ -26,9 +26,12 @@ declare(strict_types=1);
 
 namespace OCA\Dashboard\Controller;
 
+use OCA\Dashboard\Service\BackgroundService;
 use OCA\Files\Event\LoadSidebar;
 use OCA\Viewer\Event\LoadViewer;
 use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\FileDisplayResponse;
 use OCP\AppFramework\Http\JSONResponse;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\Dashboard\IManager;
@@ -51,6 +54,10 @@ class DashboardController extends Controller {
 	private $config;
 	/** @var string */
 	private $userId;
+	/**
+	 * @var BackgroundService
+	 */
+	private $backgroundService;
 
 	public function __construct(
 		string $appName,
@@ -59,6 +66,7 @@ class DashboardController extends Controller {
 		IEventDispatcher $eventDispatcher,
 		IManager $dashboardManager,
 		IConfig $config,
+		BackgroundService $backgroundService,
 		$userId
 	) {
 		parent::__construct($appName, $request);
@@ -67,6 +75,7 @@ class DashboardController extends Controller {
 		$this->eventDispatcher = $eventDispatcher;
 		$this->dashboardManager = $dashboardManager;
 		$this->config = $config;
+		$this->backgroundService = $backgroundService;
 		$this->userId = $userId;
 	}
 
@@ -95,6 +104,7 @@ class DashboardController extends Controller {
 		$this->inititalStateService->provideInitialState('dashboard', 'panels', $widgets);
 		$this->inititalStateService->provideInitialState('dashboard', 'layout', $userLayout);
 		$this->inititalStateService->provideInitialState('dashboard', 'firstRun', $this->config->getUserValue($this->userId, 'dashboard', 'firstRun', '1') === '1');
+		$this->inititalStateService->provideInitialState('dashboard', 'shippedBackgrounds', BackgroundService::SHIPPED_BACKGROUNDS);
 		$this->config->setUserValue($this->userId, 'dashboard', 'firstRun', '0');
 
 		return new TemplateResponse('dashboard', 'index');
@@ -109,4 +119,30 @@ class DashboardController extends Controller {
 		$this->config->setUserValue($this->userId, 'dashboard', 'layout', $layout);
 		return new JSONResponse(['layout' => $layout]);
 	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function setBackground($path = null, $url = null): JSONResponse {
+		// FIXME: store current version of the background and return the result
+		// FIXME: handle shipped backgrounds  avoid file duplication
+		// FIXME: allow to reset to default ones
+		if ($path !== null) {
+			$this->backgroundService->setFileBackground($path);
+		}
+		if ($url !== null) {
+			$this->backgroundService->setUrlBackground($url);
+		}
+		return new JSONResponse([]);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @NoCSRFRequired
+	 */
+	public function getBackground(): FileDisplayResponse {
+		$file = $this->backgroundService->getBackground();
+		$response = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => $file->getMimeType()]);
+		return $response;
+	}
 }
diff --git a/apps/dashboard/lib/Controller/LayoutApiController.php b/apps/dashboard/lib/Controller/LayoutApiController.php
new file mode 100644
index 00000000000..31b796575e0
--- /dev/null
+++ b/apps/dashboard/lib/Controller/LayoutApiController.php
@@ -0,0 +1,63 @@
+<?php
+/**
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Dashboard\Controller;
+
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\AppFramework\OCSController;
+use OCP\IConfig;
+use OCP\IRequest;
+
+class LayoutApiController extends OCSController {
+
+	/** @var IConfig */
+	private $config;
+	/** @var string */
+	private $userId;
+
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		IConfig $config,
+		$userId
+	) {
+		parent::__construct($appName, $request);
+
+		$this->config = $config;
+		$this->userId = $userId;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @param string $layout
+	 * @return JSONResponse
+	 */
+	public function create(string $layout): JSONResponse {
+		$this->config->setUserValue($this->userId, 'dashboard', 'layout', $layout);
+		return new JSONResponse(['layout' => $layout]);
+	}
+}
diff --git a/apps/dashboard/lib/Service/BackgroundService.php b/apps/dashboard/lib/Service/BackgroundService.php
new file mode 100644
index 00000000000..1247690a4f9
--- /dev/null
+++ b/apps/dashboard/lib/Service/BackgroundService.php
@@ -0,0 +1,99 @@
+<?php
+/**
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @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/>.
+ *
+ */
+
+declare(strict_types=1);
+
+
+namespace OCA\Dashboard\Service;
+
+
+use OCP\Files\File;
+use OCP\Files\IAppData;
+use OCP\Files\IRootFolder;
+use OCP\Files\NotFoundException;
+use OCP\Files\SimpleFS\ISimpleFile;
+
+class BackgroundService {
+
+	const SHIPPED_BACKGROUNDS = [
+		'anatoly-mikhaltsov-butterfly-wing-scale-5k.jpg',
+		'bernie-cetonia-aurata-take-off-composition-8k.jpg',
+		'eduardo-neves-pedra-azul-5k.jpg',
+		'europeanspaceagency-baltic-blooms-6k.jpg',
+		'europeanspaceagency-barents-bloom-2k.jpg',
+		'europeanspaceagency-colourful-queensland-6k.jpg',
+		'europeanspaceagency-namib-desert-6k.jpg',
+		'europeanspaceagency-peruvian-andes-6k.jpg',
+		'flickr-148302424@N05-36591009215.jpg',
+		'flickr-andymag-26451722126.jpg',
+		'flickr-angietrenz-24259359268.jpg',
+		'flickr-coconut-cove-mixed-2k.jpg',
+		'flickr-dejankrsmanovic-42971456774.jpg',
+		'flickr-paszczak000-8715851521.jpg',
+		'flickr-xomeox-sewage-3k.jpg',
+		'flickr-zalexandra-7948897538.jpg',
+		'hannes-fritz-flippity-floppity-4k.jpg',
+		'hannes-fritz-parkour-4k.jpg',
+		'hannes-fritz-roulette-4k.jpg',
+		'hannes-fritz-sea-spray-6k.jpg',
+		'insa-wulf-radial-4k.jpg',
+		'microcosmos-lab-microcrystals-5k.jpg',
+		'nasa-goddard-antarctica-melts-6k.jpg',
+		'nasa-goddard-iceberg-greenland-4k.jpg',
+		'pexels-snapwire-forest-4k-cc0.jpg',
+		'yana-sichikova-sergey-ovachev-stone-flower-2k.jpg',
+	];
+
+	public function __construct(IRootFolder $rootFolder, IAppData $appData, $userId) {
+		$this->userFolder = $rootFolder->getUserFolder($userId);
+		try {
+			$this->dashboardUserFolder = $appData->getFolder($userId);
+		} catch (NotFoundException $e) {
+			$this->dashboardUserFolder = $appData->newFolder($userId);
+		}
+	}
+
+	public function setFileBackground($path) {
+		$file = $this->userFolder->get($path);
+		$newFile = $this->dashboardUserFolder->newFile('background.jpg', $file->fopen('r'));
+	}
+
+	public function setUrlBackground($url) {
+		if (substr($url, 0, 1) === '/') {
+			$url = \OC::$server->getURLGenerator()->getAbsoluteURL($url);
+		}
+
+		$client = \OC::$server->getHTTPClientService()->newClient();
+		$response = $client->get($url);
+		$content = $response->getBody();
+		$newFile = $this->dashboardUserFolder->newFile('background.jpg', $content);
+	}
+
+	/**
+	 * @throws NotFoundException
+	 */
+	public function getBackground(): ISimpleFile {
+		return $this->dashboardUserFolder->getFile('background.jpg');
+	}
+
+}