From 4ec0afd0e76fbba82d4d5bff606d63810fb2caa0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Wed, 12 Aug 2020 10:02:33 +0200 Subject: [PATCH] Allow to set a custom background MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- apps/dashboard/appinfo/routes.php | 2 + .../lib/Controller/DashboardController.php | 36 +++++ .../lib/Controller/LayoutApiController.php | 63 +++++++++ .../lib/Service/BackgroundService.php | 99 ++++++++++++++ apps/dashboard/src/App.vue | 17 ++- .../src/components/BackgroundSettings.vue | 127 ++++++++++++++++++ 6 files changed, 343 insertions(+), 1 deletion(-) create mode 100644 apps/dashboard/lib/Controller/LayoutApiController.php create mode 100644 apps/dashboard/lib/Service/BackgroundService.php create mode 100644 apps/dashboard/src/components/BackgroundSettings.vue diff --git a/apps/dashboard/appinfo/routes.php b/apps/dashboard/appinfo/routes.php index 4edca1a3ec..704311bddf 100644 --- a/apps/dashboard/appinfo/routes.php +++ b/apps/dashboard/appinfo/routes.php @@ -28,5 +28,7 @@ return [ 'routes' => [ ['name' => 'dashboard#index', 'url' => '/', 'verb' => 'GET'], ['name' => 'dashboard#updateLayout', 'url' => '/layout', 'verb' => 'POST'], + ['name' => 'dashboard#getBackground', 'url' => '/background', 'verb' => 'GET'], + ['name' => 'dashboard#setBackground', 'url' => '/background', 'verb' => 'POST'], ] ]; diff --git a/apps/dashboard/lib/Controller/DashboardController.php b/apps/dashboard/lib/Controller/DashboardController.php index 305759fa6e..f6fea2aaf4 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 0000000000..31b796575e --- /dev/null +++ b/apps/dashboard/lib/Controller/LayoutApiController.php @@ -0,0 +1,63 @@ + + * + * @author Julius Härtl + * + * @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 . + * + */ + +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 0000000000..1247690a4f --- /dev/null +++ b/apps/dashboard/lib/Service/BackgroundService.php @@ -0,0 +1,99 @@ + + * + * @author Julius Härtl + * + * @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 . + * + */ + +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'); + } + +} diff --git a/apps/dashboard/src/App.vue b/apps/dashboard/src/App.vue index 9831f761e1..807a0e6f61 100644 --- a/apps/dashboard/src/App.vue +++ b/apps/dashboard/src/App.vue @@ -53,6 +53,9 @@ {{ t('dashboard', 'Get more widgets from the app store') }} +

{{ t('dashboard', 'Change the background image') }}

+ +

{{ t('dashboard', 'Credits') }}

{{ t('dashboard', 'Photos') }}: Clouds (Kamil Porembiński), Un beau soir dété (Tanguy Domenge).

@@ -69,15 +72,19 @@ import Draggable from 'vuedraggable' import axios from '@nextcloud/axios' import { generateUrl, generateFilePath } from '@nextcloud/router' import isMobile from './mixins/isMobile' +import BackgroundSettings from './components/BackgroundSettings' const panels = loadState('dashboard', 'panels') const firstRun = loadState('dashboard', 'firstRun') +const prefixWithBaseUrl = (url) => generateFilePath('dashboard', '', 'img/') + url + export default { name: 'App', components: { Modal, Draggable, + BackgroundSettings, }, mixins: [ isMobile, @@ -96,11 +103,14 @@ export default { modal: false, appStoreUrl: generateUrl('/settings/apps/dashboard'), statuses: {}, + backgroundTime: Date.now(), + defaultBackground: window.OCA.Accessibility.theme === 'dark' ? prefixWithBaseUrl('flickr-148302424@N05-36591009215.jpg?v=1') : prefixWithBaseUrl('flickr-paszczak000-8715851521.jpg?v=1'), } }, computed: { backgroundImage() { - const prefixWithBaseUrl = (url) => generateFilePath('dashboard', '', 'img/') + url + // FIXME: make this dependent if the default is set or not + return generateUrl('/apps/dashboard/background') + '?v=' + this.backgroundTime if (window.OCA.Accessibility.theme === 'dark') { return !isMobile ? prefixWithBaseUrl('flickr-148302424@N05-36591009215.jpg?v=1') : prefixWithBaseUrl('flickr-148302424@N05-36591009215-mobile.jpg?v=1') } @@ -244,6 +254,9 @@ export default { this.firstRun = false }, 1000) }, + updateBackground(date) { + this.backgroundTime = date + }, }, } @@ -411,6 +424,8 @@ export default { .modal__content { width: 30vw; margin: 20px; + max-height: 70vh; + overflow: auto; ol { display: flex; flex-direction: column; diff --git a/apps/dashboard/src/components/BackgroundSettings.vue b/apps/dashboard/src/components/BackgroundSettings.vue new file mode 100644 index 0000000000..7645d8fb83 --- /dev/null +++ b/apps/dashboard/src/components/BackgroundSettings.vue @@ -0,0 +1,127 @@ + + + + + + +