aboutsummaryrefslogtreecommitdiffstats
path: root/apps/dashboard/lib
diff options
context:
space:
mode:
Diffstat (limited to 'apps/dashboard/lib')
-rw-r--r--apps/dashboard/lib/Controller/DashboardApiController.php234
-rw-r--r--apps/dashboard/lib/Controller/DashboardController.php87
-rw-r--r--apps/dashboard/lib/ResponseDefinitions.php46
-rw-r--r--apps/dashboard/lib/Service/DashboardService.php71
4 files changed, 438 insertions, 0 deletions
diff --git a/apps/dashboard/lib/Controller/DashboardApiController.php b/apps/dashboard/lib/Controller/DashboardApiController.php
new file mode 100644
index 00000000000..d31cede85b7
--- /dev/null
+++ b/apps/dashboard/lib/Controller/DashboardApiController.php
@@ -0,0 +1,234 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Dashboard\Controller;
+
+use OCA\Dashboard\ResponseDefinitions;
+use OCA\Dashboard\Service\DashboardService;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\ApiRoute;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\OCSController;
+use OCP\Dashboard\IAPIWidget;
+use OCP\Dashboard\IAPIWidgetV2;
+use OCP\Dashboard\IButtonWidget;
+use OCP\Dashboard\IIconWidget;
+use OCP\Dashboard\IManager;
+use OCP\Dashboard\IOptionWidget;
+use OCP\Dashboard\IReloadableWidget;
+use OCP\Dashboard\IWidget;
+use OCP\Dashboard\Model\WidgetButton;
+use OCP\Dashboard\Model\WidgetItem;
+
+use OCP\Dashboard\Model\WidgetOptions;
+use OCP\IConfig;
+use OCP\IRequest;
+
+/**
+ * @psalm-import-type DashboardWidget from ResponseDefinitions
+ * @psalm-import-type DashboardWidgetItem from ResponseDefinitions
+ * @psalm-import-type DashboardWidgetItems from ResponseDefinitions
+ */
+class DashboardApiController extends OCSController {
+
+ public function __construct(
+ string $appName,
+ IRequest $request,
+ private IManager $dashboardManager,
+ 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->config->getAppValue('dashboard', '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]);
+ }
+}
diff --git a/apps/dashboard/lib/Controller/DashboardController.php b/apps/dashboard/lib/Controller/DashboardController.php
new file mode 100644
index 00000000000..da7e0901115
--- /dev/null
+++ b/apps/dashboard/lib/Controller/DashboardController.php
@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Dashboard\Controller;
+
+use OCA\Dashboard\Service\DashboardService;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http\Attribute\FrontpageRoute;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
+use OCP\AppFramework\Http\FeaturePolicy;
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\AppFramework\Services\IInitialState;
+use OCP\Dashboard\IIconWidget;
+use OCP\Dashboard\IManager;
+use OCP\Dashboard\IWidget;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\IRequest;
+use OCP\Util;
+
+#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)]
+class DashboardController extends Controller {
+
+ public function __construct(
+ string $appName,
+ IRequest $request,
+ private IInitialState $initialState,
+ private IEventDispatcher $eventDispatcher,
+ private IManager $dashboardManager,
+ private IConfig $config,
+ private IL10N $l10n,
+ private ?string $userId,
+ private DashboardService $service,
+ ) {
+ parent::__construct($appName, $request);
+ }
+
+ /**
+ * @return TemplateResponse
+ */
+ #[NoCSRFRequired]
+ #[NoAdminRequired]
+ #[FrontpageRoute(verb: 'GET', url: '/')]
+ public function index(): TemplateResponse {
+ Util::addStyle('dashboard', 'dashboard');
+ Util::addScript('dashboard', 'main', 'theming');
+
+ $widgets = array_map(function (IWidget $widget) {
+ return [
+ 'id' => $widget->getId(),
+ 'title' => $widget->getTitle(),
+ 'iconClass' => $widget->getIconClass(),
+ 'iconUrl' => $widget instanceof IIconWidget ? $widget->getIconUrl() : '',
+ 'url' => $widget->getUrl()
+ ];
+ }, $this->dashboardManager->getWidgets());
+
+ $this->initialState->provideInitialState('panels', $widgets);
+ $this->initialState->provideInitialState('statuses', $this->service->getStatuses());
+ $this->initialState->provideInitialState('layout', $this->service->getLayout());
+ $this->initialState->provideInitialState('appStoreEnabled', $this->config->getSystemValueBool('appstoreenabled', true));
+ $this->initialState->provideInitialState('firstRun', $this->config->getUserValue($this->userId, 'dashboard', 'firstRun', '1') === '1');
+ $this->initialState->provideInitialState('birthdate', $this->service->getBirthdate());
+ $this->config->setUserValue($this->userId, 'dashboard', 'firstRun', '0');
+
+ $response = new TemplateResponse('dashboard', 'index', [
+ 'id-app-content' => '#app-dashboard',
+ 'id-app-navigation' => null,
+ 'pageTitle' => $this->l10n->t('Dashboard'),
+ ]);
+
+ // For the weather widget we should allow the geolocation
+ $featurePolicy = new FeaturePolicy();
+ $featurePolicy->addAllowedGeoLocationDomain('\'self\'');
+ $response->setFeaturePolicy($featurePolicy);
+
+ return $response;
+ }
+}
diff --git a/apps/dashboard/lib/ResponseDefinitions.php b/apps/dashboard/lib/ResponseDefinitions.php
new file mode 100644
index 00000000000..be5a4d56883
--- /dev/null
+++ b/apps/dashboard/lib/ResponseDefinitions.php
@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Dashboard;
+
+/**
+ * @psalm-type DashboardWidget = array{
+ * id: string,
+ * title: string,
+ * order: int,
+ * icon_class: string,
+ * icon_url: string,
+ * widget_url: ?string,
+ * item_icons_round: bool,
+ * item_api_versions: list<int>,
+ * reload_interval: int,
+ * buttons?: list<array{
+ * type: string,
+ * text: string,
+ * link: string,
+ * }>,
+ * }
+ *
+ * @psalm-type DashboardWidgetItem = array{
+ * subtitle: string,
+ * title: string,
+ * link: string,
+ * iconUrl: string,
+ * overlayIconUrl: string,
+ * sinceId: string,
+ * }
+ *
+ * @psalm-type DashboardWidgetItems = array{
+ * items: list<DashboardWidgetItem>,
+ * emptyContentMessage: string,
+ * halfEmptyContentMessage: string,
+ * }
+ */
+class ResponseDefinitions {
+}
diff --git a/apps/dashboard/lib/Service/DashboardService.php b/apps/dashboard/lib/Service/DashboardService.php
new file mode 100644
index 00000000000..bb5333c2cc7
--- /dev/null
+++ b/apps/dashboard/lib/Service/DashboardService.php
@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Dashboard\Service;
+
+use JsonException;
+use OCP\Accounts\IAccountManager;
+use OCP\Accounts\PropertyDoesNotExistException;
+use OCP\IConfig;
+use OCP\IUserManager;
+
+class DashboardService {
+ public function __construct(
+ private IConfig $config,
+ private ?string $userId,
+ private IUserManager $userManager,
+ private IAccountManager $accountManager,
+ ) {
+
+ }
+
+ /**
+ * @return list<string>
+ */
+ public function getLayout(): array {
+ $systemDefault = $this->config->getAppValue('dashboard', '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 !== ''));
+ }
+ }
+
+ public function getBirthdate(): string {
+ if ($this->userId === null) {
+ return '';
+ }
+
+ $user = $this->userManager->get($this->userId);
+ if ($user === null) {
+ return '';
+ }
+
+ $account = $this->accountManager->getAccount($user);
+
+ try {
+ $birthdate = $account->getProperty(IAccountManager::PROPERTY_BIRTHDATE);
+ } catch (PropertyDoesNotExistException) {
+ return '';
+ }
+
+ return $birthdate->getValue();
+ }
+}