1 files changed, 277 insertions, 66 deletions

diff --git a/apps/user_status/lib/Service/StatusService.php b/apps/user_status/lib/Service/StatusService.php
index 39edad35850..188eb26d1d7 100644
--- a/apps/user_status/lib/Service/StatusService.php
+++ b/apps/user_status/lib/Service/StatusService.php
@@ -3,26 +3,9 @@
 declare(strict_types=1);
 
 /**
- * @copyright Copyright (c) 2020, Georg Ehrke
- *
- * @author Georg Ehrke <oc.list@georgehrke.com>
- *
- * @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/>
- *
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-
 namespace OCA\UserStatus\Service;
 
 use OCA\UserStatus\Db\UserStatus;
@@ -34,7 +17,13 @@ use OCA\UserStatus\Exception\InvalidStatusTypeException;
 use OCA\UserStatus\Exception\StatusMessageTooLongException;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\DB\Exception;
+use OCP\IConfig;
+use OCP\IEmojiHelper;
+use OCP\IUserManager;
 use OCP\UserStatus\IUserStatus;
+use Psr\Log\LoggerInterface;
+use function in_array;
 
 /**
  * Class StatusService
@@ -42,18 +31,9 @@ use OCP\UserStatus\IUserStatus;
  * @package OCA\UserStatus\Service
  */
 class StatusService {
-
-	/** @var UserStatusMapper */
-	private $mapper;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/** @var PredefinedStatusService */
-	private $predefinedStatusService;
-
-	/** @var EmojiService */
-	private $emojiService;
+	private bool $shareeEnumeration;
+	private bool $shareeEnumerationInGroupOnly;
+	private bool $shareeEnumerationPhone;
 
 	/**
 	 * List of priorities ordered by their priority
@@ -62,8 +42,9 @@ class StatusService {
 		IUserStatus::ONLINE,
 		IUserStatus::AWAY,
 		IUserStatus::DND,
+		IUserStatus::BUSY,
 		IUserStatus::INVISIBLE,
-		IUserStatus::OFFLINE
+		IUserStatus::OFFLINE,
 	];
 
 	/**
@@ -72,6 +53,7 @@ class StatusService {
 	 */
 	public const PERSISTENT_STATUSES = [
 		IUserStatus::AWAY,
+		IUserStatus::BUSY,
 		IUserStatus::DND,
 		IUserStatus::INVISIBLE,
 	];
@@ -82,22 +64,18 @@ class StatusService {
 	/** @var int */
 	public const MAXIMUM_MESSAGE_LENGTH = 80;
 
-	/**
-	 * StatusService constructor.
-	 *
-	 * @param UserStatusMapper $mapper
-	 * @param ITimeFactory $timeFactory
-	 * @param PredefinedStatusService $defaultStatusService,
-	 * @param EmojiService $emojiService
-	 */
-	public function __construct(UserStatusMapper $mapper,
-								ITimeFactory $timeFactory,
-								PredefinedStatusService $defaultStatusService,
-								EmojiService $emojiService) {
-		$this->mapper = $mapper;
-		$this->timeFactory = $timeFactory;
-		$this->predefinedStatusService = $defaultStatusService;
-		$this->emojiService = $emojiService;
+	public function __construct(
+		private UserStatusMapper $mapper,
+		private ITimeFactory $timeFactory,
+		private PredefinedStatusService $predefinedStatusService,
+		private IEmojiHelper $emojiHelper,
+		private IConfig $config,
+		private IUserManager $userManager,
+		private LoggerInterface $logger,
+	) {
+		$this->shareeEnumeration = $this->config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
+		$this->shareeEnumerationInGroupOnly = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
+		$this->shareeEnumerationPhone = $this->shareeEnumeration && $this->config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_phone', 'no') === 'yes';
 	}
 
 	/**
@@ -106,6 +84,13 @@ class StatusService {
 	 * @return UserStatus[]
 	 */
 	public function findAll(?int $limit = null, ?int $offset = null): array {
+		// Return empty array if user enumeration is disabled or limited to groups
+		// TODO: find a solution that scales to get only users from common groups if user enumeration is limited to
+		//       groups. See discussion at https://github.com/nextcloud/server/pull/27879#discussion_r729715936
+		if (!$this->shareeEnumeration || $this->shareeEnumerationInGroupOnly || $this->shareeEnumerationPhone) {
+			return [];
+		}
+
 		return array_map(function ($status) {
 			return $this->processStatus($status);
 		}, $this->mapper->findAll($limit, $offset));
@@ -117,6 +102,13 @@ class StatusService {
 	 * @return array
 	 */
 	public function findAllRecentStatusChanges(?int $limit = null, ?int $offset = null): array {
+		// Return empty array if user enumeration is disabled or limited to groups
+		// TODO: find a solution that scales to get only users from common groups if user enumeration is limited to
+		//       groups. See discussion at https://github.com/nextcloud/server/pull/27879#discussion_r729715936
+		if (!$this->shareeEnumeration || $this->shareeEnumerationInGroupOnly || $this->shareeEnumerationPhone) {
+			return [];
+		}
+
 		return array_map(function ($status) {
 			return $this->processStatus($status);
 		}, $this->mapper->findAllRecent($limit, $offset));
@@ -127,7 +119,7 @@ class StatusService {
 	 * @return UserStatus
 	 * @throws DoesNotExistException
 	 */
-	public function findByUserId(string $userId):UserStatus {
+	public function findByUserId(string $userId): UserStatus {
 		return $this->processStatus($this->mapper->findByUserId($userId));
 	}
 
@@ -150,9 +142,9 @@ class StatusService {
 	 * @throws InvalidStatusTypeException
 	 */
 	public function setStatus(string $userId,
-							  string $status,
-							  ?int $statusTimestamp,
-							  bool $isUserDefined): UserStatus {
+		string $status,
+		?int $statusTimestamp,
+		bool $isUserDefined): UserStatus {
 		try {
 			$userStatus = $this->mapper->findByUserId($userId);
 		} catch (DoesNotExistException $ex) {
@@ -161,9 +153,10 @@ class StatusService {
 		}
 
 		// Check if status-type is valid
-		if (!\in_array($status, self::PRIORITY_ORDERED_STATUSES, true)) {
+		if (!in_array($status, self::PRIORITY_ORDERED_STATUSES, true)) {
 			throw new InvalidStatusTypeException('Status-type "' . $status . '" is not supported');
 		}
+
 		if ($statusTimestamp === null) {
 			$statusTimestamp = $this->timeFactory->getTime();
 		}
@@ -171,9 +164,10 @@ class StatusService {
 		$userStatus->setStatus($status);
 		$userStatus->setStatusTimestamp($statusTimestamp);
 		$userStatus->setIsUserDefined($isUserDefined);
+		$userStatus->setIsBackup(false);
 
 		if ($userStatus->getId() === null) {
-			return $this->mapper->insert($userStatus);
+			return $this->insertWithoutThrowingUniqueConstrain($userStatus);
 		}
 
 		return $this->mapper->update($userStatus);
@@ -188,8 +182,8 @@ class StatusService {
 	 * @throws InvalidClearAtException
 	 */
 	public function setPredefinedMessage(string $userId,
-										 string $messageId,
-										 ?int $clearAt): UserStatus {
+		string $messageId,
+		?int $clearAt): UserStatus {
 		try {
 			$userStatus = $this->mapper->findByUserId($userId);
 		} catch (DoesNotExistException $ex) {
@@ -198,6 +192,7 @@ class StatusService {
 			$userStatus->setStatus(IUserStatus::OFFLINE);
 			$userStatus->setStatusTimestamp(0);
 			$userStatus->setIsUserDefined(false);
+			$userStatus->setIsBackup(false);
 		}
 
 		if (!$this->predefinedStatusService->isValidId($messageId)) {
@@ -213,9 +208,10 @@ class StatusService {
 		$userStatus->setCustomIcon(null);
 		$userStatus->setCustomMessage(null);
 		$userStatus->setClearAt($clearAt);
+		$userStatus->setStatusMessageTimestamp($this->timeFactory->now()->getTimestamp());
 
 		if ($userStatus->getId() === null) {
-			return $this->mapper->insert($userStatus);
+			return $this->insertWithoutThrowingUniqueConstrain($userStatus);
 		}
 
 		return $this->mapper->update($userStatus);
@@ -223,6 +219,105 @@ class StatusService {
 
 	/**
 	 * @param string $userId
+	 * @param string $status
+	 * @param string $messageId
+	 * @param bool $createBackup
+	 * @param string|null $customMessage
+	 * @throws InvalidStatusTypeException
+	 * @throws InvalidMessageIdException
+	 */
+	public function setUserStatus(string $userId,
+		string $status,
+		string $messageId,
+		bool $createBackup,
+		?string $customMessage = null): ?UserStatus {
+		// Check if status-type is valid
+		if (!in_array($status, self::PRIORITY_ORDERED_STATUSES, true)) {
+			throw new InvalidStatusTypeException('Status-type "' . $status . '" is not supported');
+		}
+
+		if (!$this->predefinedStatusService->isValidId($messageId)) {
+			throw new InvalidMessageIdException('Message-Id "' . $messageId . '" is not supported');
+		}
+
+		try {
+			$userStatus = $this->mapper->findByUserId($userId);
+		} catch (DoesNotExistException $e) {
+			// We don't need to do anything
+			$userStatus = new UserStatus();
+			$userStatus->setUserId($userId);
+		}
+
+		$updateStatus = false;
+		if ($messageId === IUserStatus::MESSAGE_OUT_OF_OFFICE) {
+			// OUT_OF_OFFICE trumps AVAILABILITY, CALL and CALENDAR status
+			$updateStatus = $userStatus->getMessageId() === IUserStatus::MESSAGE_AVAILABILITY || $userStatus->getMessageId() === IUserStatus::MESSAGE_CALL || $userStatus->getMessageId() === IUserStatus::MESSAGE_CALENDAR_BUSY;
+		} elseif ($messageId === IUserStatus::MESSAGE_AVAILABILITY) {
+			// AVAILABILITY trumps CALL and CALENDAR status
+			$updateStatus = $userStatus->getMessageId() === IUserStatus::MESSAGE_CALL || $userStatus->getMessageId() === IUserStatus::MESSAGE_CALENDAR_BUSY;
+		} elseif ($messageId === IUserStatus::MESSAGE_CALL) {
+			// CALL trumps CALENDAR status
+			$updateStatus = $userStatus->getMessageId() === IUserStatus::MESSAGE_CALENDAR_BUSY;
+		}
+
+		if ($messageId === IUserStatus::MESSAGE_OUT_OF_OFFICE || $messageId === IUserStatus::MESSAGE_AVAILABILITY || $messageId === IUserStatus::MESSAGE_CALL || $messageId === IUserStatus::MESSAGE_CALENDAR_BUSY) {
+			if ($updateStatus) {
+				$this->logger->debug('User ' . $userId . ' is currently NOT available, overwriting status [status: ' . $userStatus->getStatus() . ', messageId: ' . json_encode($userStatus->getMessageId()) . ']', ['app' => 'dav']);
+			} else {
+				$this->logger->debug('User ' . $userId . ' is currently NOT available, but we are NOT overwriting status [status: ' . $userStatus->getStatus() . ', messageId: ' . json_encode($userStatus->getMessageId()) . ']', ['app' => 'dav']);
+			}
+		}
+
+		// There should be a backup already or none is needed. So we take a shortcut.
+		if ($updateStatus) {
+			$userStatus->setStatus($status);
+			$userStatus->setStatusTimestamp($this->timeFactory->getTime());
+			$userStatus->setIsUserDefined(true);
+			$userStatus->setIsBackup(false);
+			$userStatus->setMessageId($messageId);
+			$userStatus->setCustomIcon(null);
+			$userStatus->setCustomMessage($customMessage);
+			$userStatus->setClearAt(null);
+			$userStatus->setStatusMessageTimestamp($this->timeFactory->now()->getTimestamp());
+			return $this->mapper->update($userStatus);
+		}
+
+		if ($createBackup) {
+			if ($this->backupCurrentStatus($userId) === false) {
+				return null; // Already a status set automatically => abort.
+			}
+
+			// If we just created the backup
+			// we need to create a new status to insert
+			// Unfortunately there's no way to unset the DB ID on an Entity
+			$userStatus = new UserStatus();
+			$userStatus->setUserId($userId);
+		}
+
+		$userStatus->setStatus($status);
+		$userStatus->setStatusTimestamp($this->timeFactory->getTime());
+		$userStatus->setIsUserDefined(true);
+		$userStatus->setIsBackup(false);
+		$userStatus->setMessageId($messageId);
+		$userStatus->setCustomIcon(null);
+		$userStatus->setCustomMessage($customMessage);
+		$userStatus->setClearAt(null);
+		if ($this->predefinedStatusService->getTranslatedStatusForId($messageId) !== null
+			|| ($customMessage !== null && $customMessage !== '')) {
+			// Only track status message ID if there is one
+			$userStatus->setStatusMessageTimestamp($this->timeFactory->now()->getTimestamp());
+		} else {
+			$userStatus->setStatusMessageTimestamp(0);
+		}
+
+		if ($userStatus->getId() !== null) {
+			return $this->mapper->update($userStatus);
+		}
+		return $this->insertWithoutThrowingUniqueConstrain($userStatus);
+	}
+
+	/**
+	 * @param string $userId
 	 * @param string|null $statusIcon
 	 * @param string|null $message
 	 * @param int|null $clearAt
@@ -232,9 +327,9 @@ class StatusService {
 	 * @throws StatusMessageTooLongException
 	 */
 	public function setCustomMessage(string $userId,
-									 ?string $statusIcon,
-									 string $message,
-									 ?int $clearAt): UserStatus {
+		?string $statusIcon,
+		?string $message,
+		?int $clearAt): UserStatus {
 		try {
 			$userStatus = $this->mapper->findByUserId($userId);
 		} catch (DoesNotExistException $ex) {
@@ -246,11 +341,11 @@ class StatusService {
 		}
 
 		// Check if statusIcon contains only one character
-		if ($statusIcon !== null && !$this->emojiService->isValidEmoji($statusIcon)) {
+		if ($statusIcon !== null && !$this->emojiHelper->isValidSingleEmoji($statusIcon)) {
 			throw new InvalidStatusIconException('Status-Icon is longer than one character');
 		}
 		// Check for maximum length of custom message
-		if (\mb_strlen($message) > self::MAXIMUM_MESSAGE_LENGTH) {
+		if ($message !== null && \mb_strlen($message) > self::MAXIMUM_MESSAGE_LENGTH) {
 			throw new StatusMessageTooLongException('Message is longer than supported length of ' . self::MAXIMUM_MESSAGE_LENGTH . ' characters');
 		}
 		// Check that clearAt is in the future
@@ -262,9 +357,10 @@ class StatusService {
 		$userStatus->setCustomIcon($statusIcon);
 		$userStatus->setCustomMessage($message);
 		$userStatus->setClearAt($clearAt);
+		$userStatus->setStatusMessageTimestamp($this->timeFactory->now()->getTimestamp());
 
 		if ($userStatus->getId() === null) {
-			return $this->mapper->insert($userStatus);
+			return $this->insertWithoutThrowingUniqueConstrain($userStatus);
 		}
 
 		return $this->mapper->update($userStatus);
@@ -306,6 +402,7 @@ class StatusService {
 		$userStatus->setCustomMessage(null);
 		$userStatus->setCustomIcon(null);
 		$userStatus->setClearAt(null);
+		$userStatus->setStatusMessageTimestamp(0);
 
 		$this->mapper->update($userStatus);
 		return true;
@@ -317,7 +414,19 @@ class StatusService {
 	 */
 	public function removeUserStatus(string $userId): bool {
 		try {
-			$userStatus = $this->mapper->findByUserId($userId);
+			$userStatus = $this->mapper->findByUserId($userId, false);
+		} catch (DoesNotExistException $ex) {
+			// if there is no status to remove, just return
+			return false;
+		}
+
+		$this->mapper->delete($userStatus);
+		return true;
+	}
+
+	public function removeBackupUserStatus(string $userId): bool {
+		try {
+			$userStatus = $this->mapper->findByUserId($userId, true);
 		} catch (DoesNotExistException $ex) {
 			// if there is no status to remove, just return
 			return false;
@@ -332,7 +441,7 @@ class StatusService {
 	 * up to date and provides translated default status if needed
 	 *
 	 * @param UserStatus $status
-	 * @returns UserStatus
+	 * @return UserStatus
 	 */
 	private function processStatus(UserStatus $status): UserStatus {
 		$clearAt = $status->getClearAt();
@@ -342,6 +451,7 @@ class StatusService {
 			$this->cleanStatus($status);
 		}
 		if ($clearAt !== null && $clearAt < $this->timeFactory->getTime()) {
+			$this->cleanStatus($status);
 			$this->cleanStatusMessage($status);
 		}
 		if ($status->getMessageId() !== null) {
@@ -355,6 +465,10 @@ class StatusService {
 	 * @param UserStatus $status
 	 */
 	private function cleanStatus(UserStatus $status): void {
+		if ($status->getStatus() === IUserStatus::OFFLINE && !$status->getIsUserDefined()) {
+			return;
+		}
+
 		$status->setStatus(IUserStatus::OFFLINE);
 		$status->setStatusTimestamp($this->timeFactory->getTime());
 		$status->setIsUserDefined(false);
@@ -370,6 +484,7 @@ class StatusService {
 		$status->setCustomIcon(null);
 		$status->setCustomMessage(null);
 		$status->setClearAt(null);
+		$status->setStatusMessageTimestamp(0);
 
 		$this->mapper->update($status);
 	}
@@ -380,9 +495,105 @@ class StatusService {
 	private function addDefaultMessage(UserStatus $status): void {
 		// If the message is predefined, insert the translated message and icon
 		$predefinedMessage = $this->predefinedStatusService->getDefaultStatusById($status->getMessageId());
-		if ($predefinedMessage !== null) {
+		if ($predefinedMessage === null) {
+			return;
+		}
+		// If there is a custom message, don't overwrite it
+		if (empty($status->getCustomMessage())) {
 			$status->setCustomMessage($predefinedMessage['message']);
+		}
+		if (empty($status->getCustomIcon())) {
 			$status->setCustomIcon($predefinedMessage['icon']);
 		}
 	}
+
+	/**
+	 * @return bool false if there is already a backup. In this case abort the procedure.
+	 */
+	public function backupCurrentStatus(string $userId): bool {
+		try {
+			$this->mapper->createBackupStatus($userId);
+			return true;
+		} catch (Exception $ex) {
+			if ($ex->getReason() === Exception::REASON_UNIQUE_CONSTRAINT_VIOLATION) {
+				return false;
+			}
+			throw $ex;
+		}
+	}
+
+	public function revertUserStatus(string $userId, string $messageId, bool $revertedManually = false): ?UserStatus {
+		try {
+			/** @var UserStatus $userStatus */
+			$backupUserStatus = $this->mapper->findByUserId($userId, true);
+		} catch (DoesNotExistException $ex) {
+			// No user status to revert, do nothing
+			return null;
+		}
+
+		$deleted = $this->mapper->deleteCurrentStatusToRestoreBackup($userId, $messageId);
+		if (!$deleted) {
+			// Another status is set automatically or no status, do nothing
+			return null;
+		}
+
+		if ($revertedManually) {
+			if ($backupUserStatus->getStatus() === IUserStatus::OFFLINE) {
+				// When the user reverts the status manually they are online
+				$backupUserStatus->setStatus(IUserStatus::ONLINE);
+			}
+			$backupUserStatus->setStatusTimestamp($this->timeFactory->getTime());
+		}
+
+		$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 {
+		// Get all user statuses and the backups
+		$findById = $userIds;
+		foreach ($userIds as $userId) {
+			$findById[] = '_' . $userId;
+		}
+		$userStatuses = $this->mapper->findByUserIds($findById);
+
+		$backups = $restoreIds = $statuesToDelete = [];
+		foreach ($userStatuses as $userStatus) {
+			if (!$userStatus->getIsBackup()
+				&& $userStatus->getMessageId() === $messageId) {
+				$statuesToDelete[$userStatus->getUserId()] = $userStatus->getId();
+			} elseif ($userStatus->getIsBackup()) {
+				$backups[$userStatus->getUserId()] = $userStatus->getId();
+			}
+		}
+
+		// For users with both (normal and backup) delete the status when matching
+		foreach ($statuesToDelete as $userId => $statusId) {
+			$backupUserId = '_' . $userId;
+			if (isset($backups[$backupUserId])) {
+				$restoreIds[] = $backups[$backupUserId];
+			}
+		}
+
+		$this->mapper->deleteByIds(array_values($statuesToDelete));
+
+		// For users that matched restore the previous status
+		$this->mapper->restoreBackupStatuses($restoreIds);
+	}
+
+	protected function insertWithoutThrowingUniqueConstrain(UserStatus $userStatus): UserStatus {
+		try {
+			return $this->mapper->insert($userStatus);
+		} catch (Exception $e) {
+			// Ignore if a parallel request already set the status
+			if ($e->getReason() !== Exception::REASON_UNIQUE_CONSTRAINT_VIOLATION) {
+				throw $e;
+			}
+		}
+		return $userStatus;
+	}
 }