Add Status Dashboard

Signed-off-by: Georg Ehrke <[email protected]>

apps/user_status/composer/composer/autoload_classmap.php

@@ -15,6 +15,7 @@
     'OCA\\UserStatus\\Controller\\PredefinedStatusController' => $baseDir . '/../lib/Controller/PredefinedStatusController.php',
     'OCA\\UserStatus\\Controller\\StatusesController' => $baseDir . '/../lib/Controller/StatusesController.php',
     'OCA\\UserStatus\\Controller\\UserStatusController' => $baseDir . '/../lib/Controller/UserStatusController.php',
+    'OCA\\UserStatus\\Dashboard\\UserStatusWidget' => $baseDir . '/../lib/Dashboard/UserStatusWidget.php',
     'OCA\\UserStatus\\Db\\UserStatus' => $baseDir . '/../lib/Db/UserStatus.php',
     'OCA\\UserStatus\\Db\\UserStatusMapper' => $baseDir . '/../lib/Db/UserStatusMapper.php',
     'OCA\\UserStatus\\Exception\\InvalidClearAtException' => $baseDir . '/../lib/Exception/InvalidClearAtException.php',

apps/user_status/composer/composer/autoload_static.php

@@ -30,6 +30,7 @@ class ComposerStaticInitUserStatus
         'OCA\\UserStatus\\Controller\\PredefinedStatusController' => __DIR__ . '/..' . '/../lib/Controller/PredefinedStatusController.php',
         'OCA\\UserStatus\\Controller\\StatusesController' => __DIR__ . '/..' . '/../lib/Controller/StatusesController.php',
         'OCA\\UserStatus\\Controller\\UserStatusController' => __DIR__ . '/..' . '/../lib/Controller/UserStatusController.php',
+        'OCA\\UserStatus\\Dashboard\\UserStatusWidget' => __DIR__ . '/..' . '/../lib/Dashboard/UserStatusWidget.php',
         'OCA\\UserStatus\\Db\\UserStatus' => __DIR__ . '/..' . '/../lib/Db/UserStatus.php',
         'OCA\\UserStatus\\Db\\UserStatusMapper' => __DIR__ . '/..' . '/../lib/Db/UserStatusMapper.php',
         'OCA\\UserStatus\\Exception\\InvalidClearAtException' => __DIR__ . '/..' . '/../lib/Exception/InvalidClearAtException.php',

apps/user_status/css/user-status-menu.scss

@@ -20,6 +20,10 @@
  *
  */
 
+.icon-user-status {
+	@include icon-color('app', 'user_status', $color-black, 1);
+}
+
 .icon-user-status-away {
 	@include icon-color('user-status-away', 'user_status', '#F4A331', 2);
 }

apps/user_status/lib/AppInfo/Application.php

@@ -30,6 +30,7 @@
 use OCA\UserStatus\Listener\BeforeTemplateRenderedListener;
 use OCA\UserStatus\Listener\UserDeletedListener;
 use OCA\UserStatus\Listener\UserLiveStatusListener;
+use OCA\UserStatus\Dashboard\UserStatusWidget;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
 use OCP\AppFramework\Bootstrap\IBootstrap;
@@ -69,6 +70,9 @@ public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
 		$context->registerEventListener(UserLiveStatusEvent::class, UserLiveStatusListener::class);
 		$context->registerEventListener(BeforeTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class);
+
+		// Register the Dashboard panel
+		$context->registerDashboardWidget(UserStatusWidget::class);
 	}
 
 	public function boot(IBootContext $context): void {

apps/user_status/lib/Dashboard/UserStatusWidget.php

@@ -0,0 +1,156 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020, Georg Ehrke
+ *
+ * @author Georg Ehrke <[email protected]>
+ *
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+namespace OCA\UserStatus\Dashboard;
+
+use OCA\UserStatus\AppInfo\Application;
+use OCA\UserStatus\Db\UserStatus;
+use OCA\UserStatus\Service\StatusService;
+use OCP\Dashboard\IWidget;
+use OCP\IInitialStateService;
+use OCP\IL10N;
+use OCP\IUserManager;
+use OCP\IUserSession;
+
+/**
+ * Class UserStatusWidget
+ *
+ * @package OCA\UserStatus
+ */
+class UserStatusWidget implements IWidget {
+
+	/** @var IL10N */
+	private $l10n;
+
+	/** @var IInitialStateService */
+	private $initialStateService;
+
+	/** @var IUserManager */
+	private $userManager;
+
+	/** @var IUserSession */
+	private $userSession;
+
+	/** @var StatusService */
+	private $service;
+
+	/**
+	 * UserStatusWidget constructor
+	 *
+	 * @param IL10N $l10n
+	 * @param IInitialStateService $initialStateService
+	 * @param IUserManager $userManager
+	 * @param IUserSession $userSession
+	 * @param StatusService $service
+	 */
+	public function __construct(IL10N $l10n,
+								IInitialStateService $initialStateService,
+								IUserManager $userManager,
+								IUserSession $userSession,
+								StatusService $service) {
+		$this->l10n = $l10n;
+		$this->initialStateService = $initialStateService;
+		$this->userManager = $userManager;
+		$this->userSession = $userSession;
+		$this->service = $service;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getId(): string {
+		return Application::APP_ID;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getTitle(): string {
+		return $this->l10n->t('Recent statuses');
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getOrder(): int {
+		return 5;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getIconClass(): string {
+		return 'icon-user-status';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getUrl(): ?string {
+		return null;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function load(): void {
+		\OCP\Util::addScript(Application::APP_ID, 'dashboard');
+
+		$currentUser = $this->userSession->getUser();
+		if ($currentUser === null) {
+			$this->initialStateService->provideInitialState(Application::APP_ID, 'dashboard_data', []);
+			return;
+		}
+		$currentUserId = $currentUser->getUID();
+
+		// Fetch status updates and filter current user
+		$recentStatusUpdates = array_slice(
+			array_filter(
+				$this->service->findAllRecentStatusChanges(8, 0),
+				static function (UserStatus $status) use ($currentUserId): bool {
+					return $status->getUserId() !== $currentUserId;
+				}
+			),
+			0,
+			7
+		);
+
+		$this->initialStateService->provideInitialState(Application::APP_ID, 'dashboard_data', array_map(function (UserStatus $status): array {
+			$user = $this->userManager->get($status->getUserId());
+			$displayName = $status->getUserId();
+			if ($user !== null) {
+				$displayName = $user->getDisplayName();
+			}
+
+			return [
+				'userId' => $status->getUserId(),
+				'displayName' => $displayName,
+				'status' => $status->getStatus() === 'invisible' ? 'offline' : $status->getStatus(),
+				'icon' => $status->getCustomIcon(),
+				'message' => $status->getCustomMessage(),
+				'timestamp' => $status->getStatusTimestamp(),
+			];
+		}, $recentStatusUpdates));
+	}
+}

apps/user_status/lib/Db/UserStatusMapper.php

@@ -69,6 +69,33 @@ public function findAll(?int $limit = null, ?int $offset = null):array {
 		return $this->findEntities($qb);
 	}
 
+	/**
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return array
+	 */
+	public function findAllRecent(?int $limit = null, ?int $offset = null): array {
+		$qb = $this->db->getQueryBuilder();
+
+		$qb
+			->select('*')
+			->from($this->tableName)
+			->orderBy('status_timestamp', 'DESC')
+			->where($qb->expr()->notIn('status', $qb->createNamedParameter(['online', 'away'], IQueryBuilder::PARAM_STR_ARRAY)))
+			->orWhere($qb->expr()->isNotNull('message_id'))
+			->orWhere($qb->expr()->isNotNull('custom_icon'))
+			->orWhere($qb->expr()->isNotNull('custom_message'));
+
+		if ($limit !== null) {
+			$qb->setMaxResults($limit);
+		}
+		if ($offset !== null) {
+			$qb->setFirstResult($offset);
+		}
+
+		return $this->findEntities($qb);
+	}
+
 	/**
 	 * @param string $userId
 	 * @return UserStatus

apps/user_status/lib/Service/StatusService.php

@@ -95,6 +95,17 @@ public function findAll(?int $limit = null, ?int $offset = null): array {
 		}, $this->mapper->findAll($limit, $offset));
 	}
 
+	/**
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return array
+	 */
+	public function findAllRecentStatusChanges(?int $limit = null, ?int $offset = null): array {
+		return array_map(function ($status) {
+			return $this->processStatus($status);
+		}, $this->mapper->findAllRecent($limit, $offset));
+	}
+
 	/**
 	 * @param string $userId
 	 * @return UserStatus

apps/user_status/src/dashboard.js

@@ -0,0 +1,48 @@
+/**
+ * @copyright Copyright (c) 2020 Georg Ehrke
+ *
+ * @author Georg Ehrke <[email protected]>
+ *
+ * @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/>.
+ *
+ */
+
+import Vue from 'vue'
+import { generateFilePath } from '@nextcloud/router'
+import { getRequestToken } from '@nextcloud/auth'
+import { translate, translatePlural } from '@nextcloud/l10n'
+import Dashboard from './views/Dashboard'
+
+// eslint-disable-next-line
+__webpack_nonce__ = btoa(getRequestToken())
+
+// eslint-disable-next-line
+__webpack_public_path__ = generateFilePath('user_status', '', 'js/')
+
+Vue.prototype.t = translate
+Vue.prototype.n = translatePlural
+Vue.prototype.OC = OC
+Vue.prototype.OCA = OCA
+
+document.addEventListener('DOMContentLoaded', function() {
+	OCA.Dashboard.register('user_status', (el) => {
+		const View = Vue.extend(Dashboard)
+		new View({
+			propsData: {},
+		}).$mount(el)
+	})
+
+})

apps/user_status/src/main-user-status-menu.js

@@ -1,3 +1,24 @@
+/**
+ * @copyright Copyright (c) 2020 Georg Ehrke
+ *
+ * @author Georg Ehrke <[email protected]>
+ *
+ * @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/>.
+ *
+ */
 import Vue from 'vue'
 import { getRequestToken } from '@nextcloud/auth'
 import App from './App'