nextcloud / server

apps/dashboard/lib/Service/DashboardService.php

Indentation +46 added lines, -46 removed lines

@@ -16,58 +16,58 @@
 use OCP\IUserManager;
 
 class DashboardService {
-	public function __construct(
-		private IConfig $config,
-		private IAppConfig $appConfig,
-		private ?string $userId,
-		private IUserManager $userManager,
-		private IAccountManager $accountManager,
-	) {
+    public function __construct(
+        private IConfig $config,
+        private IAppConfig $appConfig,
+        private ?string $userId,
+        private IUserManager $userManager,
+        private IAccountManager $accountManager,
+    ) {
 
-	}
+    }
 
-	/**
-	 * @return list<string>
-	 */
-	public function getLayout(): array {
-		$systemDefault = $this->appConfig->getAppValueString('layout', 'recommendations,spreed,mail,calendar');
-		return array_values(array_filter(explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault)), fn (string $value) => $value !== ''));
-	}
+    /**
+     * @return list<string>
+     */
+    public function getLayout(): array {
+        $systemDefault = $this->appConfig->getAppValueString('layout', 'recommendations,spreed,mail,calendar');
+        return array_values(array_filter(explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault)), fn (string $value) => $value !== ''));
+    }
 
-	/**
-	 * @return list<string>
-	 */
-	public function getStatuses() {
-		$configStatuses = $this->config->getUserValue($this->userId, 'dashboard', 'statuses', '');
-		try {
-			// Parse the old format
-			/** @var array<string, bool> $statuses */
-			$statuses = json_decode($configStatuses, true, 512, JSON_THROW_ON_ERROR);
-			// We avoid getting an empty array as it will not produce an object in UI's JS
-			return array_keys(array_filter($statuses, static fn (bool $value) => $value));
-		} catch (JsonException $e) {
-			return array_values(array_filter(explode(',', $configStatuses), fn (string $value) => $value !== ''));
-		}
-	}
+    /**
+     * @return list<string>
+     */
+    public function getStatuses() {
+        $configStatuses = $this->config->getUserValue($this->userId, 'dashboard', 'statuses', '');
+        try {
+            // Parse the old format
+            /** @var array<string, bool> $statuses */
+            $statuses = json_decode($configStatuses, true, 512, JSON_THROW_ON_ERROR);
+            // We avoid getting an empty array as it will not produce an object in UI's JS
+            return array_keys(array_filter($statuses, static fn (bool $value) => $value));
+        } catch (JsonException $e) {
+            return array_values(array_filter(explode(',', $configStatuses), fn (string $value) => $value !== ''));
+        }
+    }
 
-	public function getBirthdate(): string {
-		if ($this->userId === null) {
-			return '';
-		}
+    public function getBirthdate(): string {
+        if ($this->userId === null) {
+            return '';
+        }
 
-		$user = $this->userManager->get($this->userId);
-		if ($user === null) {
-			return '';
-		}
+        $user = $this->userManager->get($this->userId);
+        if ($user === null) {
+            return '';
+        }
 
-		$account = $this->accountManager->getAccount($user);
+        $account = $this->accountManager->getAccount($user);
 
-		try {
-			$birthdate = $account->getProperty(IAccountManager::PROPERTY_BIRTHDATE);
-		} catch (PropertyDoesNotExistException) {
-			return '';
-		}
+        try {
+            $birthdate = $account->getProperty(IAccountManager::PROPERTY_BIRTHDATE);
+        } catch (PropertyDoesNotExistException) {
+            return '';
+        }
 
-		return $birthdate->getValue();
-	}
+        return $birthdate->getValue();
+    }
 }

apps/dashboard/lib/Controller/DashboardApiController.php

Indentation +193 added lines, -193 removed lines

@@ -40,197 +40,197 @@
  */
 class DashboardApiController extends OCSController {
 
-	public function __construct(
-		string $appName,
-		IRequest $request,
-		private IManager $dashboardManager,
-		private IAppConfig $appConfig,
-		private IConfig $config,
-		private ?string $userId,
-		private DashboardService $service,
-	) {
-		parent::__construct($appName, $request);
-	}
-
-	/**
-	 * @param string[] $widgetIds Limit widgets to given ids
-	 * @return IWidget[]
-	 */
-	private function getShownWidgets(array $widgetIds): array {
-		if (empty($widgetIds)) {
-			$systemDefault = $this->appConfig->getAppValueString('layout', 'recommendations,spreed,mail,calendar');
-			$widgetIds = explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault));
-		}
-
-		return array_filter(
-			$this->dashboardManager->getWidgets(),
-			static function (IWidget $widget) use ($widgetIds) {
-				return in_array($widget->getId(), $widgetIds);
-			},
-		);
-	}
-
-	/**
-	 * Get the items for the widgets
-	 *
-	 * @param array<string, string> $sinceIds Array indexed by widget Ids, contains date/id from which we want the new items
-	 * @param int $limit Limit number of result items per widget
-	 * @psalm-param int<1, 30> $limit
-	 * @param list<string> $widgets Limit results to specific widgets
-	 * @return DataResponse<Http::STATUS_OK, array<string, list<DashboardWidgetItem>>, array{}>
-	 *
-	 * 200: Widget items returned
-	 */
-	#[NoAdminRequired]
-	#[NoCSRFRequired]
-	#[ApiRoute(verb: 'GET', url: '/api/v1/widget-items')]
-	public function getWidgetItems(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
-		$items = [];
-		$widgets = $this->getShownWidgets($widgets);
-		foreach ($widgets as $widget) {
-			if ($widget instanceof IAPIWidget) {
-				$items[$widget->getId()] = array_map(static function (WidgetItem $item) {
-					return $item->jsonSerialize();
-				}, $widget->getItems($this->userId, $sinceIds[$widget->getId()] ?? null, $limit));
-			}
-		}
-
-		return new DataResponse($items);
-	}
-
-	/**
-	 * Get the items for the widgets
-	 *
-	 * @param array<string, string> $sinceIds Array indexed by widget Ids, contains date/id from which we want the new items
-	 * @param int $limit Limit number of result items per widget, not more than 30 are allowed
-	 * @psalm-param int<1, 30> $limit
-	 * @param list<string> $widgets Limit results to specific widgets
-	 * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItems>, array{}>
-	 *
-	 * 200: Widget items returned
-	 */
-	#[NoAdminRequired]
-	#[NoCSRFRequired]
-	#[ApiRoute(verb: 'GET', url: '/api/v2/widget-items')]
-	public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
-		$items = [];
-		$widgets = $this->getShownWidgets($widgets);
-		foreach ($widgets as $widget) {
-			if ($widget instanceof IAPIWidgetV2) {
-				$items[$widget->getId()] = $widget
-					->getItemsV2($this->userId, $sinceIds[$widget->getId()] ?? null, $limit)
-					->jsonSerialize();
-			}
-		}
-
-		return new DataResponse($items);
-	}
-
-	/**
-	 * Get the widgets
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidget>, array{}>
-	 *
-	 * 200: Widgets returned
-	 */
-	#[NoAdminRequired]
-	#[NoCSRFRequired]
-	#[ApiRoute(verb: 'GET', url: '/api/v1/widgets')]
-	public function getWidgets(): DataResponse {
-		$widgets = $this->dashboardManager->getWidgets();
-
-		$items = array_map(function (IWidget $widget) {
-			$options = ($widget instanceof IOptionWidget) ? $widget->getWidgetOptions() : WidgetOptions::getDefault();
-			$data = [
-				'id' => $widget->getId(),
-				'title' => $widget->getTitle(),
-				'order' => $widget->getOrder(),
-				'icon_class' => $widget->getIconClass(),
-				'icon_url' => ($widget instanceof IIconWidget) ? $widget->getIconUrl() : '',
-				'widget_url' => $widget->getUrl(),
-				'item_icons_round' => $options->withRoundItemIcons(),
-				'item_api_versions' => [],
-				'reload_interval' => 0,
-			];
-			if ($widget instanceof IButtonWidget) {
-				$data += [
-					'buttons' => array_map(function (WidgetButton $button) {
-						return [
-							'type' => $button->getType(),
-							'text' => $button->getText(),
-							'link' => $button->getLink(),
-						];
-					}, $widget->getWidgetButtons($this->userId)),
-				];
-			}
-			if ($widget instanceof IReloadableWidget) {
-				$data['reload_interval'] = $widget->getReloadInterval();
-			}
-			if ($widget instanceof IAPIWidget) {
-				$data['item_api_versions'][] = 1;
-			}
-			if ($widget instanceof IAPIWidgetV2) {
-				$data['item_api_versions'][] = 2;
-			}
-			return $data;
-		}, $widgets);
-
-		return new DataResponse($items);
-	}
-
-	/**
-	 * Get the layout
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array{layout: list<string>}, array{}>
-	 *
-	 * 200: Layout returned
-	 */
-	#[NoAdminRequired]
-	#[ApiRoute(verb: 'GET', url: '/api/v3/layout')]
-	public function getLayout(): DataResponse {
-		return new DataResponse(['layout' => $this->service->getLayout()]);
-	}
-
-	/**
-	 * Update the layout
-	 *
-	 * @param list<string> $layout The new layout
-	 * @return DataResponse<Http::STATUS_OK, array{layout: list<string>}, array{}>
-	 *
-	 * 200: Statuses updated successfully
-	 */
-	#[NoAdminRequired]
-	#[ApiRoute(verb: 'POST', url: '/api/v3/layout')]
-	public function updateLayout(array $layout): DataResponse {
-		$this->config->setUserValue($this->userId, 'dashboard', 'layout', implode(',', $layout));
-		return new DataResponse(['layout' => $layout]);
-	}
-
-	/**
-	 * Get the statuses
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array{statuses: list<string>}, array{}>
-	 *
-	 * 200: Statuses returned
-	 */
-	#[NoAdminRequired]
-	#[ApiRoute(verb: 'GET', url: '/api/v3/statuses')]
-	public function getStatuses(): DataResponse {
-		return new DataResponse(['statuses' => $this->service->getStatuses()]);
-	}
-
-	/**
-	 * Update the statuses
-	 *
-	 * @param list<string> $statuses The new statuses
-	 * @return DataResponse<Http::STATUS_OK, array{statuses: list<string>}, array{}>
-	 *
-	 * 200: Statuses updated successfully
-	 */
-	#[NoAdminRequired]
-	#[ApiRoute(verb: 'POST', url: '/api/v3/statuses')]
-	public function updateStatuses(array $statuses): DataResponse {
-		$this->config->setUserValue($this->userId, 'dashboard', 'statuses', implode(',', $statuses));
-		return new DataResponse(['statuses' => $statuses]);
-	}
+    public function __construct(
+        string $appName,
+        IRequest $request,
+        private IManager $dashboardManager,
+        private IAppConfig $appConfig,
+        private IConfig $config,
+        private ?string $userId,
+        private DashboardService $service,
+    ) {
+        parent::__construct($appName, $request);
+    }
+
+    /**
+     * @param string[] $widgetIds Limit widgets to given ids
+     * @return IWidget[]
+     */
+    private function getShownWidgets(array $widgetIds): array {
+        if (empty($widgetIds)) {
+            $systemDefault = $this->appConfig->getAppValueString('layout', 'recommendations,spreed,mail,calendar');
+            $widgetIds = explode(',', $this->config->getUserValue($this->userId, 'dashboard', 'layout', $systemDefault));
+        }
+
+        return array_filter(
+            $this->dashboardManager->getWidgets(),
+            static function (IWidget $widget) use ($widgetIds) {
+                return in_array($widget->getId(), $widgetIds);
+            },
+        );
+    }
+
+    /**
+     * Get the items for the widgets
+     *
+     * @param array<string, string> $sinceIds Array indexed by widget Ids, contains date/id from which we want the new items
+     * @param int $limit Limit number of result items per widget
+     * @psalm-param int<1, 30> $limit
+     * @param list<string> $widgets Limit results to specific widgets
+     * @return DataResponse<Http::STATUS_OK, array<string, list<DashboardWidgetItem>>, array{}>
+     *
+     * 200: Widget items returned
+     */
+    #[NoAdminRequired]
+    #[NoCSRFRequired]
+    #[ApiRoute(verb: 'GET', url: '/api/v1/widget-items')]
+    public function getWidgetItems(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
+        $items = [];
+        $widgets = $this->getShownWidgets($widgets);
+        foreach ($widgets as $widget) {
+            if ($widget instanceof IAPIWidget) {
+                $items[$widget->getId()] = array_map(static function (WidgetItem $item) {
+                    return $item->jsonSerialize();
+                }, $widget->getItems($this->userId, $sinceIds[$widget->getId()] ?? null, $limit));
+            }
+        }
+
+        return new DataResponse($items);
+    }
+
+    /**
+     * Get the items for the widgets
+     *
+     * @param array<string, string> $sinceIds Array indexed by widget Ids, contains date/id from which we want the new items
+     * @param int $limit Limit number of result items per widget, not more than 30 are allowed
+     * @psalm-param int<1, 30> $limit
+     * @param list<string> $widgets Limit results to specific widgets
+     * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItems>, array{}>
+     *
+     * 200: Widget items returned
+     */
+    #[NoAdminRequired]
+    #[NoCSRFRequired]
+    #[ApiRoute(verb: 'GET', url: '/api/v2/widget-items')]
+    public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
+        $items = [];
+        $widgets = $this->getShownWidgets($widgets);
+        foreach ($widgets as $widget) {
+            if ($widget instanceof IAPIWidgetV2) {
+                $items[$widget->getId()] = $widget
+                    ->getItemsV2($this->userId, $sinceIds[$widget->getId()] ?? null, $limit)
+                    ->jsonSerialize();
+            }
+        }
+
+        return new DataResponse($items);
+    }
+
+    /**
+     * Get the widgets
+     *
+     * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidget>, array{}>
+     *
+     * 200: Widgets returned
+     */
+    #[NoAdminRequired]
+    #[NoCSRFRequired]
+    #[ApiRoute(verb: 'GET', url: '/api/v1/widgets')]
+    public function getWidgets(): DataResponse {
+        $widgets = $this->dashboardManager->getWidgets();
+
+        $items = array_map(function (IWidget $widget) {
+            $options = ($widget instanceof IOptionWidget) ? $widget->getWidgetOptions() : WidgetOptions::getDefault();
+            $data = [
+                'id' => $widget->getId(),
+                'title' => $widget->getTitle(),
+                'order' => $widget->getOrder(),
+                'icon_class' => $widget->getIconClass(),
+                'icon_url' => ($widget instanceof IIconWidget) ? $widget->getIconUrl() : '',
+                'widget_url' => $widget->getUrl(),
+                'item_icons_round' => $options->withRoundItemIcons(),
+                'item_api_versions' => [],
+                'reload_interval' => 0,
+            ];
+            if ($widget instanceof IButtonWidget) {
+                $data += [
+                    'buttons' => array_map(function (WidgetButton $button) {
+                        return [
+                            'type' => $button->getType(),
+                            'text' => $button->getText(),
+                            'link' => $button->getLink(),
+                        ];
+                    }, $widget->getWidgetButtons($this->userId)),
+                ];
+            }
+            if ($widget instanceof IReloadableWidget) {
+                $data['reload_interval'] = $widget->getReloadInterval();
+            }
+            if ($widget instanceof IAPIWidget) {
+                $data['item_api_versions'][] = 1;
+            }
+            if ($widget instanceof IAPIWidgetV2) {
+                $data['item_api_versions'][] = 2;
+            }
+            return $data;
+        }, $widgets);
+
+        return new DataResponse($items);
+    }
+
+    /**
+     * Get the layout
+     *
+     * @return DataResponse<Http::STATUS_OK, array{layout: list<string>}, array{}>
+     *
+     * 200: Layout returned
+     */
+    #[NoAdminRequired]
+    #[ApiRoute(verb: 'GET', url: '/api/v3/layout')]
+    public function getLayout(): DataResponse {
+        return new DataResponse(['layout' => $this->service->getLayout()]);
+    }
+
+    /**
+     * Update the layout
+     *
+     * @param list<string> $layout The new layout
+     * @return DataResponse<Http::STATUS_OK, array{layout: list<string>}, array{}>
+     *
+     * 200: Statuses updated successfully
+     */
+    #[NoAdminRequired]
+    #[ApiRoute(verb: 'POST', url: '/api/v3/layout')]
+    public function updateLayout(array $layout): DataResponse {
+        $this->config->setUserValue($this->userId, 'dashboard', 'layout', implode(',', $layout));
+        return new DataResponse(['layout' => $layout]);
+    }
+
+    /**
+     * Get the statuses
+     *
+     * @return DataResponse<Http::STATUS_OK, array{statuses: list<string>}, array{}>
+     *
+     * 200: Statuses returned
+     */
+    #[NoAdminRequired]
+    #[ApiRoute(verb: 'GET', url: '/api/v3/statuses')]
+    public function getStatuses(): DataResponse {
+        return new DataResponse(['statuses' => $this->service->getStatuses()]);
+    }
+
+    /**
+     * Update the statuses
+     *
+     * @param list<string> $statuses The new statuses
+     * @return DataResponse<Http::STATUS_OK, array{statuses: list<string>}, array{}>
+     *
+     * 200: Statuses updated successfully
+     */
+    #[NoAdminRequired]
+    #[ApiRoute(verb: 'POST', url: '/api/v3/statuses')]
+    public function updateStatuses(array $statuses): DataResponse {
+        $this->config->setUserValue($this->userId, 'dashboard', 'statuses', implode(',', $statuses));
+        return new DataResponse(['statuses' => $statuses]);
+    }
 }

apps/dashboard/tests/DashboardServiceTest.php

Indentation +80 added lines, -80 removed lines

@@ -21,85 +21,85 @@
 
 class DashboardServiceTest extends TestCase {
 
-	private IConfig&MockObject $config;
-	private IAppConfig&MockObject $appConfig;
-	private IUserManager&MockObject $userManager;
-	private IAccountManager&MockObject $accountManager;
-	private DashboardService $service;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		$this->config = $this->createMock(IConfig::class);
-		$this->appConfig = $this->createMock(IAppConfig::class);
-		$this->userManager = $this->createMock(IUserManager::class);
-		$this->accountManager = $this->createMock(IAccountManager::class);
-
-		$this->service = new DashboardService(
-			$this->config,
-			$this->appConfig,
-			'alice',
-			$this->userManager,
-			$this->accountManager,
-		);
-	}
-
-	public function testGetBirthdate(): void {
-		$user = $this->createMock(IUser::class);
-		$this->userManager->method('get')
-			->willReturn($user);
-
-		$account = new Account($user);
-		$account->setProperty(
-			IAccountManager::PROPERTY_BIRTHDATE,
-			'2024-12-10T00:00:00.000Z',
-			IAccountManager::SCOPE_LOCAL,
-			IAccountManager::VERIFIED,
-		);
-
-		$this->accountManager->method('getAccount')
-			->willReturn($account);
-
-		$birthdate = $this->service->getBirthdate();
-
-		$this->assertEquals('2024-12-10T00:00:00.000Z', $birthdate);
-	}
-
-	public function testGetBirthdatePropertyDoesNotExist(): void {
-		$user = $this->createMock(IUser::class);
-		$this->userManager->method('get')
-			->willReturn($user);
-
-		$account = new Account($user);
-		$this->accountManager->method('getAccount')
-			->willReturn($account);
-
-		$birthdate = $this->service->getBirthdate();
-
-		$this->assertEquals('', $birthdate);
-	}
-
-	public function testGetBirthdateUserNotFound(): void {
-		$this->userManager->method('get')
-			->willReturn(null);
-
-		$birthdate = $this->service->getBirthdate();
-
-		$this->assertEquals('', $birthdate);
-	}
-
-	public function testGetBirthdateNoUserId(): void {
-		$service = new DashboardService(
-			$this->config,
-			$this->appConfig,
-			null,
-			$this->userManager,
-			$this->accountManager,
-		);
-
-		$birthdate = $service->getBirthdate();
-
-		$this->assertEquals('', $birthdate);
-	}
+    private IConfig&MockObject $config;
+    private IAppConfig&MockObject $appConfig;
+    private IUserManager&MockObject $userManager;
+    private IAccountManager&MockObject $accountManager;
+    private DashboardService $service;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        $this->config = $this->createMock(IConfig::class);
+        $this->appConfig = $this->createMock(IAppConfig::class);
+        $this->userManager = $this->createMock(IUserManager::class);
+        $this->accountManager = $this->createMock(IAccountManager::class);
+
+        $this->service = new DashboardService(
+            $this->config,
+            $this->appConfig,
+            'alice',
+            $this->userManager,
+            $this->accountManager,
+        );
+    }
+
+    public function testGetBirthdate(): void {
+        $user = $this->createMock(IUser::class);
+        $this->userManager->method('get')
+            ->willReturn($user);
+
+        $account = new Account($user);
+        $account->setProperty(
+            IAccountManager::PROPERTY_BIRTHDATE,
+            '2024-12-10T00:00:00.000Z',
+            IAccountManager::SCOPE_LOCAL,
+            IAccountManager::VERIFIED,
+        );
+
+        $this->accountManager->method('getAccount')
+            ->willReturn($account);
+
+        $birthdate = $this->service->getBirthdate();
+
+        $this->assertEquals('2024-12-10T00:00:00.000Z', $birthdate);
+    }
+
+    public function testGetBirthdatePropertyDoesNotExist(): void {
+        $user = $this->createMock(IUser::class);
+        $this->userManager->method('get')
+            ->willReturn($user);
+
+        $account = new Account($user);
+        $this->accountManager->method('getAccount')
+            ->willReturn($account);
+
+        $birthdate = $this->service->getBirthdate();
+
+        $this->assertEquals('', $birthdate);
+    }
+
+    public function testGetBirthdateUserNotFound(): void {
+        $this->userManager->method('get')
+            ->willReturn(null);
+
+        $birthdate = $this->service->getBirthdate();
+
+        $this->assertEquals('', $birthdate);
+    }
+
+    public function testGetBirthdateNoUserId(): void {
+        $service = new DashboardService(
+            $this->config,
+            $this->appConfig,
+            null,
+            $this->userManager,
+            $this->accountManager,
+        );
+
+        $birthdate = $service->getBirthdate();
+
+        $this->assertEquals('', $birthdate);
+    }
 
 }