feat(user_status): Allow to manually revert an automated status

Signed-off-by: Joas Schilling <coding@schilljs.com>

Author: nickvergessen

apps/user_status/appinfo/routes.php

@@ -34,6 +34,7 @@
 		['name' => 'UserStatus#setPredefinedMessage', 'url' => '/api/v1/user_status/message/predefined', 'verb' => 'PUT'],
 		['name' => 'UserStatus#setCustomMessage', 'url' => '/api/v1/user_status/message/custom', 'verb' => 'PUT'],
 		['name' => 'UserStatus#clearMessage', 'url' => '/api/v1/user_status/message', 'verb' => 'DELETE'],
+		['name' => 'UserStatus#revertStatus', 'url' => '/api/v1/user_status/revert/{messageId}', 'verb' => 'DELETE'],
 		// Routes for listing default routes
 		['name' => 'PredefinedStatus#findAll', 'url' => '/api/v1/predefined_statuses/', 'verb' => 'GET'],
 		// Route for doing heartbeats

apps/user_status/lib/Controller/UserStatusController.php

@@ -184,6 +184,19 @@ public function clearMessage(): DataResponse {
 		return new DataResponse([]);
 	}
 
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @return DataResponse
+	 */
+	public function revertStatus(string $messageId): DataResponse {
+		$backupStatus = $this->service->revertUserStatus($this->userId, $messageId);
+		if ($backupStatus) {
+			return new DataResponse($this->formatStatus($backupStatus));
+		}
+		return new DataResponse([]);
+	}
+
 	/**
 	 * @param UserStatus $status
 	 * @return array

apps/user_status/lib/Service/StatusService.php

@@ -496,25 +496,27 @@ public function backupCurrentStatus(string $userId): bool {
 		}
 	}
 
-	public function revertUserStatus(string $userId, string $messageId): void {
+	public function revertUserStatus(string $userId, string $messageId): ?UserStatus {
 		try {
 			/** @var UserStatus $userStatus */
 			$backupUserStatus = $this->mapper->findByUserId($userId, true);
 		} catch (DoesNotExistException $ex) {
 			// No user status to revert, do nothing
-			return;
+			return null;
 		}
 
 		$deleted = $this->mapper->deleteCurrentStatusToRestoreBackup($userId, $messageId);
 		if (!$deleted) {
 			// Another status is set automatically or no status, do nothing
-			return;
+			return null;
 		}
 
 		$backupUserStatus->setIsBackup(false);
 		// Remove the underscore prefix added when creating the backup
 		$backupUserStatus->setUserId(substr($backupUserStatus->getUserId(), 1));
 		$this->mapper->update($backupUserStatus);
+
+		return $backupUserStatus;
 	}
 
 	public function revertMultipleUserStatus(array $userIds, string $messageId): void {

apps/user_status/src/components/SetStatusModal.vue

@@ -24,6 +24,25 @@
 		:title="$t('user_status', 'Set status')"
 		@close="closeModal">
 		<div class="set-status-modal">
+			<!-- Automatic status -->
+			<template v-if="messageId">
+				<div class="set-status-modal__header">
+					<h2>{{ $t('user_status', 'Automated status') }}</h2>
+				</div>
+				<div class="set-status-modal__online-status">
+					{{ $t('user_status', 'Your user status was set automatically') }}
+				</div>
+				<div class="status-buttons">
+					<NcButton :wide="true"
+						type="secondary"
+						:text="resetButtonText"
+						:disabled="isSavingStatus"
+						@click="revertBackupFromServer">
+						{{ resetButtonText }}
+					</NcButton>
+				</div>
+			</template>
+
 			<!-- Status selector -->
 			<div class="set-status-modal__header">
 				<h2>{{ $t('user_status', 'Online status') }}</h2>
@@ -98,21 +117,53 @@ export default {
 	data() {
 		return {
 			clearAt: null,
-			icon: null,
-			message: '',
-			messageId: '',
 			isSavingStatus: false,
 			statuses: getAllStatusOptions(),
 		}
 	},
 
+	computed: {
+		messageId() {
+			return this.$store.state.userStatus.messageId
+		},
+		icon() {
+			return this.$store.state.userStatus.icon
+		},
+		message() {
+			return this.$store.state.userStatus.message || ''
+		},
+		backupIcon() {
+			return this.$store.state.userBackupStatus.icon
+		},
+		backupMessage() {
+			return this.$store.state.userBackupStatus.message
+		},
+
+		resetButtonText() {
+			if (this.backupIcon && this.backupMessage) {
+				return this.$t('user_status', 'Reset status to "{icon} {message}"', {
+					icon: this.backupIcon,
+					message: this.backupMessage,
+				})
+			} else if (this.backupMessage) {
+				return this.$t('user_status', 'Reset status to "{message}"', {
+					message: this.backupMessage,
+				})
+			} else if (this.backupIcon) {
+				return this.$t('user_status', 'Reset status to "{icon}"', {
+					icon: this.backupIcon,
+				})
+			}
+
+			return this.$t('user_status', 'Reset status')
+		},
+	},
+
 	/**
 	 * Loads the current status when a user opens dialog
 	 */
 	mounted() {
-		this.messageId = this.$store.state.userStatus.messageId
-		this.icon = this.$store.state.userStatus.icon
-		this.message = this.$store.state.userStatus.message || ''
+		this.$store.dispatch('fetchBackupFromServer')
 
 		if (this.$store.state.userStatus.clearAt !== null) {
 			this.clearAt = {
@@ -219,6 +270,27 @@ export default {
 				return
 			}
 
+			this.isSavingStatus = false
+			this.closeModal()
+		},
+		/**
+		 *
+		 * @return {Promise<void>}
+		 */
+		async revertBackupFromServer() {
+			try {
+				this.isSavingStatus = true
+
+				await this.$store.dispatch('revertBackupFromServer', {
+					messageId: this.messageId,
+				})
+			} catch (err) {
+				showError(this.$t('user_status', 'There was an error reverting the status'))
+				console.debug(err)
+				this.isSavingStatus = false
+				return
+			}
+
 			this.isSavingStatus = false
 			this.closeModal()
 		},

apps/user_status/src/services/statusService.js

@@ -35,6 +35,19 @@ const fetchCurrentStatus = async () => {
 	return response.data.ocs.data
 }
 
+/**
+ * Fetches the current user-status
+ *
+ * @param {string} userId
+ * @return {Promise<object>}
+ */
+const fetchBackupStatus = async (userId) => {
+	const url = generateOcsUrl('apps/user_status/api/v1/statuses/{userId}', { userId: '_' + userId })
+	const response = await HttpClient.get(url)
+
+	return response.data.ocs.data
+}
+
 /**
  * Sets the status
  *
@@ -90,10 +103,25 @@ const clearMessage = async () => {
 	await HttpClient.delete(url)
 }
 
+/**
+ * Revert the automated status
+ *
+ * @param {string} messageId
+ * @return {Promise<object>}
+ */
+const revertToBackupStatus = async (messageId) => {
+	const url = generateOcsUrl('apps/user_status/api/v1/user_status/revert/{messageId}', { messageId })
+	const response = await HttpClient.delete(url)
+
+	return response.data.ocs.data
+}
+
 export {
 	fetchCurrentStatus,
+	fetchBackupStatus,
 	setStatus,
 	setCustomMessage,
 	setPredefinedMessage,
 	clearMessage,
+	revertToBackupStatus,
 }

apps/user_status/src/store/index.js

@@ -24,13 +24,15 @@ import Vue from 'vue'
 import Vuex, { Store } from 'vuex'
 import predefinedStatuses from './predefinedStatuses'
 import userStatus from './userStatus'
+import userBackupStatus from './userBackupStatus'
 
 Vue.use(Vuex)
 
 export default new Store({
 	modules: {
 		predefinedStatuses,
 		userStatus,
+		userBackupStatus,
 	},
 	strict: true,
 })

apps/user_status/src/store/userBackupStatus.js

@@ -0,0 +1,117 @@
+/**
+ * @copyright Copyright (c) 2020 Georg Ehrke
+ * @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ * @author Joas Schilling <coding@schilljs.com>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * 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 {
+	fetchBackupStatus,
+	revertToBackupStatus,
+} from '../services/statusService'
+import { getCurrentUser } from '@nextcloud/auth'
+import { emit } from '@nextcloud/event-bus'
+
+const state = {
+	// Status (online / away / dnd / invisible / offline)
+	status: null,
+	// Whether the status is user-defined
+	statusIsUserDefined: null,
+	// A custom message set by the user
+	message: null,
+	// The icon selected by the user
+	icon: null,
+	// When to automatically clean the status
+	clearAt: null,
+	// Whether the message is predefined
+	// (and can automatically be translated by Nextcloud)
+	messageIsPredefined: null,
+	// The id of the message in case it's predefined
+	messageId: null,
+}
+
+const mutations = {
+	/**
+	 * Loads the status from initial state
+	 *
+	 * @param {object} state The Vuex state
+	 * @param {object} data The destructuring object
+	 * @param {string} data.status The status type
+	 * @param {boolean} data.statusIsUserDefined Whether or not this status is user-defined
+	 * @param {string} data.message The message
+	 * @param {string} data.icon The icon
+	 * @param {number} data.clearAt When to automatically clear the status
+	 * @param {boolean} data.messageIsPredefined Whether or not the message is predefined
+	 * @param {string} data.messageId The id of the predefined message
+	 */
+	loadBackupStatusFromServer(state, { status, statusIsUserDefined, message, icon, clearAt, messageIsPredefined, messageId }) {
+		state.status = status
+		state.message = message
+		state.icon = icon
+
+		// Don't overwrite certain values if the refreshing comes in via short updates
+		// E.g. from talk participant list which only has the status, message and icon
+		if (typeof statusIsUserDefined !== 'undefined') {
+			state.statusIsUserDefined = statusIsUserDefined
+		}
+		if (typeof clearAt !== 'undefined') {
+			state.clearAt = clearAt
+		}
+		if (typeof messageIsPredefined !== 'undefined') {
+			state.messageIsPredefined = messageIsPredefined
+		}
+		if (typeof messageId !== 'undefined') {
+			state.messageId = messageId
+		}
+	},
+}
+
+const getters = {}
+
+const actions = {
+	/**
+	 * Re-fetches the status from the server
+	 *
+	 * @param {object} vuex The Vuex destructuring object
+	 * @param {Function} vuex.commit The Vuex commit function
+	 * @return {Promise<void>}
+	 */
+	async fetchBackupFromServer({ commit }) {
+		const status = await fetchBackupStatus(getCurrentUser()?.uid)
+		commit('loadBackupStatusFromServer', status)
+	},
+
+	async revertBackupFromServer({ commit }, { messageId }) {
+		const status = await revertToBackupStatus(messageId)
+		if (status) {
+			commit('loadBackupStatusFromServer', {})
+			commit('loadStatusFromServer', status)
+			emit('user_status:status.updated', {
+				status: status.status,
+				message: status.message,
+				icon: status.icon,
+				clearAt: status.clearAt,
+				userId: getCurrentUser()?.uid,
+			})
+		}
+	},
+}
+
+export default { state, mutations, getters, actions }

apps/user_status/src/store/userStatus.js

@@ -35,15 +35,15 @@ import { emit } from '@nextcloud/event-bus'
 const state = {
 	// Status (online / away / dnd / invisible / offline)
 	status: null,
-	// Whether or not the status is user-defined
+	// Whether the status is user-defined
 	statusIsUserDefined: null,
 	// A custom message set by the user
 	message: null,
 	// The icon selected by the user
 	icon: null,
 	// When to automatically clean the status
 	clearAt: null,
-	// Whether or not the message is predefined
+	// Whether the message is predefined
 	// (and can automatically be translated by Nextcloud)
 	messageIsPredefined: null,
 	// The id of the message in case it's predefined