nextcloud / server

apps/dashboard/lib/Controller/DashboardController.php

Indentation +162 added lines, -162 removed lines

@@ -46,166 +46,166 @@
 
 class DashboardController extends Controller {
 
-	/** @var IInitialStateService */
-	private $inititalStateService;
-	/** @var IEventDispatcher */
-	private $eventDispatcher;
-	/** @var IAppManager */
-	private $appManager;
-	/** @var IManager */
-	private $dashboardManager;
-	/** @var IConfig */
-	private $config;
-	/** @var string */
-	private $userId;
-	/**
-	 * @var BackgroundService
-	 */
-	private $backgroundService;
-
-	public function __construct(
-		string $appName,
-		IRequest $request,
-		IInitialStateService $initialStateService,
-		IEventDispatcher $eventDispatcher,
-		IAppManager $appManager,
-		IManager $dashboardManager,
-		IConfig $config,
-		BackgroundService $backgroundService,
-		$userId
-	) {
-		parent::__construct($appName, $request);
-
-		$this->inititalStateService = $initialStateService;
-		$this->eventDispatcher = $eventDispatcher;
-		$this->appManager = $appManager;
-		$this->dashboardManager = $dashboardManager;
-		$this->config = $config;
-		$this->backgroundService = $backgroundService;
-		$this->userId = $userId;
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @NoAdminRequired
-	 * @return TemplateResponse
-	 */
-	public function index(): TemplateResponse {
-		\OCP\Util::addStyle('dashboard', 'dashboard');
-		$this->eventDispatcher->dispatchTyped(new LoadSidebar());
-		if (class_exists(LoadViewer::class)) {
-			$this->eventDispatcher->dispatchTyped(new LoadViewer());
-		}
-
-		$this->eventDispatcher->dispatchTyped(new RegisterWidgetEvent($this->dashboardManager));
-
-		$systemDefault = $this->config->getAppValue('dashboard', 'layout', 'recommendations,spreed,mail,calendar');
-		$userLayout = explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault));
-		$widgets = array_map(function (IWidget $widget) {
-			return [
-				'id' => $widget->getId(),
-				'title' => $widget->getTitle(),
-				'iconClass' => $widget->getIconClass(),
-				'url' => $widget->getUrl()
-			];
-		}, $this->dashboardManager->getWidgets());
-		$configStatuses = $this->config->getUserValue($this->userId, 'dashboard', 'statuses', '');
-		$statuses = json_decode($configStatuses, true);
-		// We avoid getting an empty array as it will not produce an object in UI's JS
-		// It does not matter if some statuses are missing from the array, missing ones are considered enabled
-		$statuses = ($statuses && count($statuses) > 0) ? $statuses : ['weather' => true];
-
-		// if theming app is enabled and wants to override default, we pass it
-		$themingDefaultBackground = $this->appManager->isEnabledForUser('theming')
-			? $this->config->getAppValue('theming', 'backgroundMime', '')
-			: '';
-		$this->inititalStateService->provideInitialState('dashboard', 'themingDefaultBackground', $themingDefaultBackground);
-		$this->inititalStateService->provideInitialState('dashboard', 'panels', $widgets);
-		$this->inititalStateService->provideInitialState('dashboard', 'statuses', $statuses);
-		$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->inititalStateService->provideInitialState('dashboard', 'background', $this->config->getUserValue($this->userId, 'dashboard', 'background', 'default'));
-		$this->inititalStateService->provideInitialState('dashboard', 'version', $this->config->getUserValue($this->userId, 'dashboard', 'backgroundVersion', 0));
-		$this->config->setUserValue($this->userId, 'dashboard', 'firstRun', '0');
-
-		$response = new TemplateResponse('dashboard', 'index');
-
-		// For the weather widget we should allow the geolocation
-		$featurePolicy = new Http\FeaturePolicy();
-		$featurePolicy->addAllowedGeoLocationDomain('\'self\'');
-		$response->setFeaturePolicy($featurePolicy);
-
-		return $response;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @param string $layout
-	 * @return JSONResponse
-	 */
-	public function updateLayout(string $layout): JSONResponse {
-		$this->config->setUserValue($this->userId, 'dashboard', 'layout', $layout);
-		return new JSONResponse(['layout' => $layout]);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @param string $statuses
-	 * @return JSONResponse
-	 */
-	public function updateStatuses(string $statuses): JSONResponse {
-		$this->config->setUserValue($this->userId, 'dashboard', 'statuses', $statuses);
-		return new JSONResponse(['statuses' => $statuses]);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 */
-	public function setBackground(string $type = 'default', string $value = ''): JSONResponse {
-		$currentVersion = (int)$this->config->getUserValue($this->userId, 'dashboard', '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, 'dashboard', 'backgroundVersion', (string)$currentVersion);
-		return new JSONResponse([
-			'type' => $type,
-			'value' => $value,
-			'version' => $this->config->getUserValue($this->userId, 'dashboard', 'backgroundVersion', $currentVersion)
-		]);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @NoCSRFRequired
-	 */
-	public function getBackground() {
-		$file = $this->backgroundService->getBackground();
-		if ($file !== null) {
-			$response = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => $file->getMimeType()]);
-			$response->cacheFor(24 * 60 * 60);
-			return $response;
-		}
-		return new NotFoundResponse();
-	}
+    /** @var IInitialStateService */
+    private $inititalStateService;
+    /** @var IEventDispatcher */
+    private $eventDispatcher;
+    /** @var IAppManager */
+    private $appManager;
+    /** @var IManager */
+    private $dashboardManager;
+    /** @var IConfig */
+    private $config;
+    /** @var string */
+    private $userId;
+    /**
+     * @var BackgroundService
+     */
+    private $backgroundService;
+
+    public function __construct(
+        string $appName,
+        IRequest $request,
+        IInitialStateService $initialStateService,
+        IEventDispatcher $eventDispatcher,
+        IAppManager $appManager,
+        IManager $dashboardManager,
+        IConfig $config,
+        BackgroundService $backgroundService,
+        $userId
+    ) {
+        parent::__construct($appName, $request);
+
+        $this->inititalStateService = $initialStateService;
+        $this->eventDispatcher = $eventDispatcher;
+        $this->appManager = $appManager;
+        $this->dashboardManager = $dashboardManager;
+        $this->config = $config;
+        $this->backgroundService = $backgroundService;
+        $this->userId = $userId;
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @NoAdminRequired
+     * @return TemplateResponse
+     */
+    public function index(): TemplateResponse {
+        \OCP\Util::addStyle('dashboard', 'dashboard');
+        $this->eventDispatcher->dispatchTyped(new LoadSidebar());
+        if (class_exists(LoadViewer::class)) {
+            $this->eventDispatcher->dispatchTyped(new LoadViewer());
+        }
+
+        $this->eventDispatcher->dispatchTyped(new RegisterWidgetEvent($this->dashboardManager));
+
+        $systemDefault = $this->config->getAppValue('dashboard', 'layout', 'recommendations,spreed,mail,calendar');
+        $userLayout = explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault));
+        $widgets = array_map(function (IWidget $widget) {
+            return [
+                'id' => $widget->getId(),
+                'title' => $widget->getTitle(),
+                'iconClass' => $widget->getIconClass(),
+                'url' => $widget->getUrl()
+            ];
+        }, $this->dashboardManager->getWidgets());
+        $configStatuses = $this->config->getUserValue($this->userId, 'dashboard', 'statuses', '');
+        $statuses = json_decode($configStatuses, true);
+        // We avoid getting an empty array as it will not produce an object in UI's JS
+        // It does not matter if some statuses are missing from the array, missing ones are considered enabled
+        $statuses = ($statuses && count($statuses) > 0) ? $statuses : ['weather' => true];
+
+        // if theming app is enabled and wants to override default, we pass it
+        $themingDefaultBackground = $this->appManager->isEnabledForUser('theming')
+            ? $this->config->getAppValue('theming', 'backgroundMime', '')
+            : '';
+        $this->inititalStateService->provideInitialState('dashboard', 'themingDefaultBackground', $themingDefaultBackground);
+        $this->inititalStateService->provideInitialState('dashboard', 'panels', $widgets);
+        $this->inititalStateService->provideInitialState('dashboard', 'statuses', $statuses);
+        $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->inititalStateService->provideInitialState('dashboard', 'background', $this->config->getUserValue($this->userId, 'dashboard', 'background', 'default'));
+        $this->inititalStateService->provideInitialState('dashboard', 'version', $this->config->getUserValue($this->userId, 'dashboard', 'backgroundVersion', 0));
+        $this->config->setUserValue($this->userId, 'dashboard', 'firstRun', '0');
+
+        $response = new TemplateResponse('dashboard', 'index');
+
+        // For the weather widget we should allow the geolocation
+        $featurePolicy = new Http\FeaturePolicy();
+        $featurePolicy->addAllowedGeoLocationDomain('\'self\'');
+        $response->setFeaturePolicy($featurePolicy);
+
+        return $response;
+    }
+
+    /**
+     * @NoAdminRequired
+     * @param string $layout
+     * @return JSONResponse
+     */
+    public function updateLayout(string $layout): JSONResponse {
+        $this->config->setUserValue($this->userId, 'dashboard', 'layout', $layout);
+        return new JSONResponse(['layout' => $layout]);
+    }
+
+    /**
+     * @NoAdminRequired
+     * @param string $statuses
+     * @return JSONResponse
+     */
+    public function updateStatuses(string $statuses): JSONResponse {
+        $this->config->setUserValue($this->userId, 'dashboard', 'statuses', $statuses);
+        return new JSONResponse(['statuses' => $statuses]);
+    }
+
+    /**
+     * @NoAdminRequired
+     */
+    public function setBackground(string $type = 'default', string $value = ''): JSONResponse {
+        $currentVersion = (int)$this->config->getUserValue($this->userId, 'dashboard', '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, 'dashboard', 'backgroundVersion', (string)$currentVersion);
+        return new JSONResponse([
+            'type' => $type,
+            'value' => $value,
+            'version' => $this->config->getUserValue($this->userId, 'dashboard', 'backgroundVersion', $currentVersion)
+        ]);
+    }
+
+    /**
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     */
+    public function getBackground() {
+        $file = $this->backgroundService->getBackground();
+        if ($file !== null) {
+            $response = new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => $file->getMimeType()]);
+            $response->cacheFor(24 * 60 * 60);
+            return $response;
+        }
+        return new NotFoundResponse();
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -101,7 +101,7 @@ 
 
 		$systemDefault = $this->config->getAppValue('dashboard', 'layout', 'recommendations,spreed,mail,calendar');
 		$userLayout = explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault));
-		$widgets = array_map(function (IWidget $widget) {
+		$widgets = array_map(function(IWidget $widget) {
 			return [
 				'id' => $widget->getId(),
 				'title' => $widget->getTitle(),
@@ -163,7 +163,7 @@ 
 	 * @NoAdminRequired
 	 */
 	public function setBackground(string $type = 'default', string $value = ''): JSONResponse {
-		$currentVersion = (int)$this->config->getUserValue($this->userId, 'dashboard', 'backgroundVersion', '0');
+		$currentVersion = (int) $this->config->getUserValue($this->userId, 'dashboard', 'backgroundVersion', '0');
 		try {
 			switch ($type) {
 				case 'shipped':
@@ -187,7 +187,7 @@ 
 			return new JSONResponse(['error' => $e->getMessage()], Http::STATUS_INTERNAL_SERVER_ERROR);
 		}
 		$currentVersion++;
-		$this->config->setUserValue($this->userId, 'dashboard', 'backgroundVersion', (string)$currentVersion);
+		$this->config->setUserValue($this->userId, 'dashboard', 'backgroundVersion', (string) $currentVersion);
 		return new JSONResponse([
 			'type' => $type,
 			'value' => $value,