migrate therinaldos.com data

wedding-pics/apps/dashboard/lib/Controller/DashboardApiController.php

@@ -0,0 +1,201 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Julien Veyssier <eneiluj@posteo.net>
+ *
+ * @author Julien Veyssier <eneiluj@posteo.net>
+ * @author Kate Döen <kate.doeen@nextcloud.com>
+ * @author Richard Steinmetz <richard@steinmetz.cloud>
+ *
+ * @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/>.
+ *
+ */
+
+namespace OCA\Dashboard\Controller;
+
+use OCA\Dashboard\ResponseDefinitions;
+use OCP\AppFramework\Http;
+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 {
+
+	/** @var IManager */
+	private $dashboardManager;
+	/** @var IConfig */
+	private $config;
+	/** @var string|null */
+	private $userId;
+
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		IManager $dashboardManager,
+		IConfig $config,
+		?string $userId
+	) {
+		parent::__construct($appName, $request);
+
+		$this->dashboardManager = $dashboardManager;
+		$this->config = $config;
+		$this->userId = $userId;
+	}
+
+	/**
+	 * @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);
+			},
+		);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @NoCSRFRequired
+	 *
+	 * 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
+	 * @param string[] $widgets Limit results to specific widgets
+	 * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItem[]>, array{}>
+	 *
+	 * 200: Widget items returned
+	 */
+	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);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @NoCSRFRequired
+	 *
+	 * 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
+	 * @param string[] $widgets Limit results to specific widgets
+	 * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItems>, array{}>
+	 *
+	 * 200: Widget items returned
+	 */
+	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
+	 *
+	 * @NoAdminRequired
+	 * @NoCSRFRequired
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidget>, array{}>
+	 *
+	 * 200: Widgets returned
+	 */
+	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);
+	}
+}

wedding-pics/apps/dashboard/lib/Controller/DashboardController.php

@@ -0,0 +1,156 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julien Veyssier <eneiluj@posteo.net>
+ * @author Julius Härtl <jus@bitgrid.net>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ * @author Kate Döen <kate.doeen@nextcloud.com>
+ * @author Eduardo Morales <eduardo.morales@nextcloud.com>
+ *
+ * @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/>.
+ *
+ */
+namespace OCA\Dashboard\Controller;
+
+use OCA\Files\Event\LoadSidebar;
+use OCA\Viewer\Event\LoadViewer;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\AppFramework\Services\IInitialState;
+use OCP\Dashboard\IManager;
+use OCP\Dashboard\IWidget;
+use OCP\Dashboard\RegisterWidgetEvent;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\IRequest;
+
+#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)]
+class DashboardController extends Controller {
+
+	/** @var IInitialState */
+	private $initialState;
+	/** @var IEventDispatcher */
+	private $eventDispatcher;
+	/** @var IManager */
+	private $dashboardManager;
+	/** @var IConfig */
+	private $config;
+	/** @var IL10N */
+	private $l10n;
+	/** @var string */
+	private $userId;
+
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		IInitialState $initialState,
+		IEventDispatcher $eventDispatcher,
+		IManager $dashboardManager,
+		IConfig $config,
+		IL10N $l10n,
+		$userId
+	) {
+		parent::__construct($appName, $request);
+
+		$this->initialState = $initialState;
+		$this->eventDispatcher = $eventDispatcher;
+		$this->dashboardManager = $dashboardManager;
+		$this->config = $config;
+		$this->l10n = $l10n;
+		$this->userId = $userId;
+	}
+
+	/**
+	 * @NoCSRFRequired
+	 * @NoAdminRequired
+	 * @return TemplateResponse
+	 */
+	public function index(): TemplateResponse {
+		\OCP\Util::addStyle('dashboard', 'dashboard');
+		\OCP\Util::addScript('dashboard', 'main', 'theming');
+
+		$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];
+
+		$this->initialState->provideInitialState('panels', $widgets);
+		$this->initialState->provideInitialState('statuses', $statuses);
+		$this->initialState->provideInitialState('layout', $userLayout);
+		$this->initialState->provideInitialState('firstRun', $this->config->getUserValue($this->userId, 'dashboard', 'firstRun', '1') === '1');
+		$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 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]);
+	}
+}

wedding-pics/apps/dashboard/lib/Controller/LayoutApiController.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @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/>.
+ *
+ */
+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 {
+		$layout = htmlspecialchars($layout);
+		$this->config->setUserValue($this->userId, 'dashboard', 'layout', $layout);
+		return new JSONResponse(['layout' => $layout]);
+	}
+}

wedding-pics/apps/dashboard/lib/ResponseDefinitions.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
+ *
+ * @author Kate Döen <kate.doeen@nextcloud.com>
+ * @author Richard Steinmetz <richard@steinmetz.cloud>
+ *
+ * @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/>.
+ *
+ */
+
+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: int[],
+ *     reload_interval: int,
+ *     buttons?: 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: DashboardWidgetItem[],
+ *     emptyContentMessage: string,
+ *     halfEmptyContentMessage: string,
+ *  }
+ */
+class ResponseDefinitions {
+}