nextcloud / server

apps/user_status/lib/Connector/UserStatusProvider.php

Indentation +30 added lines, -30 removed lines

@@ -31,41 +31,41 @@
 
 class UserStatusProvider implements IProvider, ISettableProvider {
 
-	/** @var StatusService */
-	private $service;
+    /** @var StatusService */
+    private $service;
 
-	/**
-	 * UserStatusProvider constructor.
-	 *
-	 * @param StatusService $service
-	 */
-	public function __construct(StatusService $service) {
-		$this->service = $service;
-	}
+    /**
+     * UserStatusProvider constructor.
+     *
+     * @param StatusService $service
+     */
+    public function __construct(StatusService $service) {
+        $this->service = $service;
+    }
 
-	/**
-	 * @inheritDoc
-	 */
-	public function getUserStatuses(array $userIds): array {
-		$statuses = $this->service->findByUserIds($userIds);
+    /**
+     * @inheritDoc
+     */
+    public function getUserStatuses(array $userIds): array {
+        $statuses = $this->service->findByUserIds($userIds);
 
-		$userStatuses = [];
-		foreach ($statuses as $status) {
-			$userStatuses[$status->getUserId()] = new UserStatus($status);
-		}
+        $userStatuses = [];
+        foreach ($statuses as $status) {
+            $userStatuses[$status->getUserId()] = new UserStatus($status);
+        }
 
-		return $userStatuses;
-	}
+        return $userStatuses;
+    }
 
-	public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup): void {
-		$this->service->setUserStatus($userId, $status, $messageId, $createBackup);
-	}
+    public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup): void {
+        $this->service->setUserStatus($userId, $status, $messageId, $createBackup);
+    }
 
-	public function revertUserStatus(string $userId, string $messageId, string $status): void {
-		$this->service->revertUserStatus($userId, $messageId, $status);
-	}
+    public function revertUserStatus(string $userId, string $messageId, string $status): void {
+        $this->service->revertUserStatus($userId, $messageId, $status);
+    }
 
-	public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void {
-		$this->service->revertMultipleUserStatus($userIds, $messageId, $status);
-	}
+    public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void {
+        $this->service->revertMultipleUserStatus($userIds, $messageId, $status);
+    }
 }

apps/user_status/lib/Service/StatusService.php

Indentation +511 added lines, -511 removed lines

@@ -47,515 +47,515 @@
  */
 class StatusService {
 
-	/** @var UserStatusMapper */
-	private $mapper;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/** @var PredefinedStatusService */
-	private $predefinedStatusService;
-
-	/** @var EmojiService */
-	private $emojiService;
-
-	/** @var bool */
-	private $shareeEnumeration;
-
-	/** @var bool */
-	private $shareeEnumerationInGroupOnly;
-
-	/** @var bool */
-	private $shareeEnumerationPhone;
-
-	/**
-	 * List of priorities ordered by their priority
-	 */
-	public const PRIORITY_ORDERED_STATUSES = [
-		IUserStatus::ONLINE,
-		IUserStatus::AWAY,
-		IUserStatus::DND,
-		IUserStatus::INVISIBLE,
-		IUserStatus::OFFLINE,
-	];
-
-	/**
-	 * List of statuses that persist the clear-up
-	 * or UserLiveStatusEvents
-	 */
-	public const PERSISTENT_STATUSES = [
-		IUserStatus::AWAY,
-		IUserStatus::DND,
-		IUserStatus::INVISIBLE,
-	];
-
-	/** @var int */
-	public const INVALIDATE_STATUS_THRESHOLD = 15 /* minutes */ * 60 /* seconds */;
-
-	/** @var int */
-	public const MAXIMUM_MESSAGE_LENGTH = 80;
-
-	/**
-	 * StatusService constructor.
-	 *
-	 * @param UserStatusMapper $mapper
-	 * @param ITimeFactory $timeFactory
-	 * @param PredefinedStatusService $defaultStatusService
-	 * @param EmojiService $emojiService
-	 * @param IConfig $config
-	 */
-	public function __construct(UserStatusMapper $mapper,
-								ITimeFactory $timeFactory,
-								PredefinedStatusService $defaultStatusService,
-								EmojiService $emojiService,
-								IConfig $config) {
-		$this->mapper = $mapper;
-		$this->timeFactory = $timeFactory;
-		$this->predefinedStatusService = $defaultStatusService;
-		$this->emojiService = $emojiService;
-		$this->shareeEnumeration = $config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
-		$this->shareeEnumerationInGroupOnly = $this->shareeEnumeration && $config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
-		$this->shareeEnumerationPhone = $this->shareeEnumeration && $config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_phone', 'no') === 'yes';
-	}
-
-	/**
-	 * @param int|null $limit
-	 * @param int|null $offset
-	 * @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));
-	}
-
-	/**
-	 * @param int|null $limit
-	 * @param int|null $offset
-	 * @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));
-	}
-
-	/**
-	 * @param string $userId
-	 * @return UserStatus
-	 * @throws DoesNotExistException
-	 */
-	public function findByUserId(string $userId):UserStatus {
-		return $this->processStatus($this->mapper->findByUserId($userId));
-	}
-
-	/**
-	 * @param array $userIds
-	 * @return UserStatus[]
-	 */
-	public function findByUserIds(array $userIds):array {
-		return array_map(function ($status) {
-			return $this->processStatus($status);
-		}, $this->mapper->findByUserIds($userIds));
-	}
-
-	/**
-	 * @param string $userId
-	 * @param string $status
-	 * @param int|null $statusTimestamp
-	 * @param bool $isUserDefined
-	 * @return UserStatus
-	 * @throws InvalidStatusTypeException
-	 */
-	public function setStatus(string $userId,
-							  string $status,
-							  ?int $statusTimestamp,
-							  bool $isUserDefined): UserStatus {
-		try {
-			$userStatus = $this->mapper->findByUserId($userId);
-		} catch (DoesNotExistException $ex) {
-			$userStatus = new UserStatus();
-			$userStatus->setUserId($userId);
-		}
-
-		// 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 ($statusTimestamp === null) {
-			$statusTimestamp = $this->timeFactory->getTime();
-		}
-
-		$userStatus->setStatus($status);
-		$userStatus->setStatusTimestamp($statusTimestamp);
-		$userStatus->setIsUserDefined($isUserDefined);
-		$userStatus->setIsBackup(false);
-
-		if ($userStatus->getId() === null) {
-			return $this->mapper->insert($userStatus);
-		}
-
-		return $this->mapper->update($userStatus);
-	}
-
-	/**
-	 * @param string $userId
-	 * @param string $messageId
-	 * @param int|null $clearAt
-	 * @return UserStatus
-	 * @throws InvalidMessageIdException
-	 * @throws InvalidClearAtException
-	 */
-	public function setPredefinedMessage(string $userId,
-										 string $messageId,
-										 ?int $clearAt): UserStatus {
-		try {
-			$userStatus = $this->mapper->findByUserId($userId);
-		} catch (DoesNotExistException $ex) {
-			$userStatus = new UserStatus();
-			$userStatus->setUserId($userId);
-			$userStatus->setStatus(IUserStatus::OFFLINE);
-			$userStatus->setStatusTimestamp(0);
-			$userStatus->setIsUserDefined(false);
-			$userStatus->setIsBackup(false);
-		}
-
-		if (!$this->predefinedStatusService->isValidId($messageId)) {
-			throw new InvalidMessageIdException('Message-Id "' . $messageId . '" is not supported');
-		}
-
-		// Check that clearAt is in the future
-		if ($clearAt !== null && $clearAt < $this->timeFactory->getTime()) {
-			throw new InvalidClearAtException('ClearAt is in the past');
-		}
-
-		$userStatus->setMessageId($messageId);
-		$userStatus->setCustomIcon(null);
-		$userStatus->setCustomMessage(null);
-		$userStatus->setClearAt($clearAt);
-
-		if ($userStatus->getId() === null) {
-			return $this->mapper->insert($userStatus);
-		}
-
-		return $this->mapper->update($userStatus);
-	}
-
-	/**
-	 * @param string $userId
-	 * @param string $status
-	 * @param string $messageId
-	 * @param bool $createBackup
-	 * @throws InvalidStatusTypeException
-	 * @throws InvalidMessageIdException
-	 */
-	public function setUserStatus(string $userId,
-										 string $status,
-										 string $messageId,
-										 bool $createBackup): void {
-		// 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');
-		}
-
-		if ($createBackup) {
-			if ($this->backupCurrentStatus($userId) === false) {
-				return; // Already a status set automatically => abort.
-			}
-
-			// If we just created the backup
-			$userStatus = new UserStatus();
-			$userStatus->setUserId($userId);
-		} else {
-			try {
-				$userStatus = $this->mapper->findByUserId($userId);
-			} catch (DoesNotExistException $ex) {
-				$userStatus = new UserStatus();
-				$userStatus->setUserId($userId);
-			}
-		}
-
-		$userStatus->setStatus($status);
-		$userStatus->setStatusTimestamp($this->timeFactory->getTime());
-		$userStatus->setIsUserDefined(false);
-		$userStatus->setIsBackup(false);
-		$userStatus->setMessageId($messageId);
-		$userStatus->setCustomIcon(null);
-		$userStatus->setCustomMessage(null);
-		$userStatus->setClearAt(null);
-
-		if ($userStatus->getId() !== null) {
-			$this->mapper->update($userStatus);
-			return;
-		}
-		$this->mapper->insert($userStatus);
-	}
-
-	/**
-	 * @param string $userId
-	 * @param string|null $statusIcon
-	 * @param string $message
-	 * @param int|null $clearAt
-	 * @return UserStatus
-	 * @throws InvalidClearAtException
-	 * @throws InvalidStatusIconException
-	 * @throws StatusMessageTooLongException
-	 */
-	public function setCustomMessage(string $userId,
-									 ?string $statusIcon,
-									 string $message,
-									 ?int $clearAt): UserStatus {
-		try {
-			$userStatus = $this->mapper->findByUserId($userId);
-		} catch (DoesNotExistException $ex) {
-			$userStatus = new UserStatus();
-			$userStatus->setUserId($userId);
-			$userStatus->setStatus(IUserStatus::OFFLINE);
-			$userStatus->setStatusTimestamp(0);
-			$userStatus->setIsUserDefined(false);
-		}
-
-		// Check if statusIcon contains only one character
-		if ($statusIcon !== null && !$this->emojiService->isValidEmoji($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) {
-			throw new StatusMessageTooLongException('Message is longer than supported length of ' . self::MAXIMUM_MESSAGE_LENGTH . ' characters');
-		}
-		// Check that clearAt is in the future
-		if ($clearAt !== null && $clearAt < $this->timeFactory->getTime()) {
-			throw new InvalidClearAtException('ClearAt is in the past');
-		}
-
-		$userStatus->setMessageId(null);
-		$userStatus->setCustomIcon($statusIcon);
-		$userStatus->setCustomMessage($message);
-		$userStatus->setClearAt($clearAt);
-
-		if ($userStatus->getId() === null) {
-			return $this->mapper->insert($userStatus);
-		}
-
-		return $this->mapper->update($userStatus);
-	}
-
-	/**
-	 * @param string $userId
-	 * @return bool
-	 */
-	public function clearStatus(string $userId): bool {
-		try {
-			$userStatus = $this->mapper->findByUserId($userId);
-		} catch (DoesNotExistException $ex) {
-			// if there is no status to remove, just return
-			return false;
-		}
-
-		$userStatus->setStatus(IUserStatus::OFFLINE);
-		$userStatus->setStatusTimestamp(0);
-		$userStatus->setIsUserDefined(false);
-
-		$this->mapper->update($userStatus);
-		return true;
-	}
-
-	/**
-	 * @param string $userId
-	 * @return bool
-	 */
-	public function clearMessage(string $userId): bool {
-		try {
-			$userStatus = $this->mapper->findByUserId($userId);
-		} catch (DoesNotExistException $ex) {
-			// if there is no status to remove, just return
-			return false;
-		}
-
-		$userStatus->setMessageId(null);
-		$userStatus->setCustomMessage(null);
-		$userStatus->setCustomIcon(null);
-		$userStatus->setClearAt(null);
-
-		$this->mapper->update($userStatus);
-		return true;
-	}
-
-	/**
-	 * @param string $userId
-	 * @return bool
-	 */
-	public function removeUserStatus(string $userId): bool {
-		try {
-			$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;
-		}
-
-		$this->mapper->delete($userStatus);
-		return true;
-	}
-
-	/**
-	 * Processes a status to check if custom message is still
-	 * up to date and provides translated default status if needed
-	 *
-	 * @param UserStatus $status
-	 * @return UserStatus
-	 */
-	private function processStatus(UserStatus $status): UserStatus {
-		$clearAt = $status->getClearAt();
-
-		if ($status->getStatusTimestamp() < $this->timeFactory->getTime() - self::INVALIDATE_STATUS_THRESHOLD
-			&& (!$status->getIsUserDefined() || $status->getStatus() === IUserStatus::ONLINE)) {
-			$this->cleanStatus($status);
-		}
-		if ($clearAt !== null && $clearAt < $this->timeFactory->getTime()) {
-			$this->cleanStatusMessage($status);
-		}
-		if ($status->getMessageId() !== null) {
-			$this->addDefaultMessage($status);
-		}
-
-		return $status;
-	}
-
-	/**
-	 * @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);
-
-		$this->mapper->update($status);
-	}
-
-	/**
-	 * @param UserStatus $status
-	 */
-	private function cleanStatusMessage(UserStatus $status): void {
-		$status->setMessageId(null);
-		$status->setCustomIcon(null);
-		$status->setCustomMessage(null);
-		$status->setClearAt(null);
-
-		$this->mapper->update($status);
-	}
-
-	/**
-	 * @param UserStatus $status
-	 */
-	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) {
-			$status->setCustomMessage($predefinedMessage['message']);
-			$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, string $status): void {
-		try {
-			/** @var UserStatus $userStatus */
-			$backupUserStatus = $this->mapper->findByUserId($userId, true);
-		} catch (DoesNotExistException $ex) {
-			// No user status to revert, do nothing
-			return;
-		}
-
-		$deleted = $this->mapper->deleteCurrentStatusToRestoreBackup($userId, $messageId, $status);
-		if (!$deleted) {
-			// Another status is set automatically or no status, do nothing
-			return;
-		}
-
-		$backupUserStatus->setIsBackup(false);
-		// Remove the underscore prefix added when creating the backup
-		$backupUserStatus->setUserId(substr($backupUserStatus->getUserId(), 1));
-		$this->mapper->update($backupUserStatus);
-	}
-
-	public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): 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
-				&& $userStatus->getStatus() === $status) {
-				$statuesToDelete[$userStatus->getUserId()] = $userStatus->getId();
-			} else if ($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);
-	}
+    /** @var UserStatusMapper */
+    private $mapper;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    /** @var PredefinedStatusService */
+    private $predefinedStatusService;
+
+    /** @var EmojiService */
+    private $emojiService;
+
+    /** @var bool */
+    private $shareeEnumeration;
+
+    /** @var bool */
+    private $shareeEnumerationInGroupOnly;
+
+    /** @var bool */
+    private $shareeEnumerationPhone;
+
+    /**
+     * List of priorities ordered by their priority
+     */
+    public const PRIORITY_ORDERED_STATUSES = [
+        IUserStatus::ONLINE,
+        IUserStatus::AWAY,
+        IUserStatus::DND,
+        IUserStatus::INVISIBLE,
+        IUserStatus::OFFLINE,
+    ];
+
+    /**
+     * List of statuses that persist the clear-up
+     * or UserLiveStatusEvents
+     */
+    public const PERSISTENT_STATUSES = [
+        IUserStatus::AWAY,
+        IUserStatus::DND,
+        IUserStatus::INVISIBLE,
+    ];
+
+    /** @var int */
+    public const INVALIDATE_STATUS_THRESHOLD = 15 /* minutes */ * 60 /* seconds */;
+
+    /** @var int */
+    public const MAXIMUM_MESSAGE_LENGTH = 80;
+
+    /**
+     * StatusService constructor.
+     *
+     * @param UserStatusMapper $mapper
+     * @param ITimeFactory $timeFactory
+     * @param PredefinedStatusService $defaultStatusService
+     * @param EmojiService $emojiService
+     * @param IConfig $config
+     */
+    public function __construct(UserStatusMapper $mapper,
+                                ITimeFactory $timeFactory,
+                                PredefinedStatusService $defaultStatusService,
+                                EmojiService $emojiService,
+                                IConfig $config) {
+        $this->mapper = $mapper;
+        $this->timeFactory = $timeFactory;
+        $this->predefinedStatusService = $defaultStatusService;
+        $this->emojiService = $emojiService;
+        $this->shareeEnumeration = $config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes') === 'yes';
+        $this->shareeEnumerationInGroupOnly = $this->shareeEnumeration && $config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_group', 'no') === 'yes';
+        $this->shareeEnumerationPhone = $this->shareeEnumeration && $config->getAppValue('core', 'shareapi_restrict_user_enumeration_to_phone', 'no') === 'yes';
+    }
+
+    /**
+     * @param int|null $limit
+     * @param int|null $offset
+     * @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));
+    }
+
+    /**
+     * @param int|null $limit
+     * @param int|null $offset
+     * @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));
+    }
+
+    /**
+     * @param string $userId
+     * @return UserStatus
+     * @throws DoesNotExistException
+     */
+    public function findByUserId(string $userId):UserStatus {
+        return $this->processStatus($this->mapper->findByUserId($userId));
+    }
+
+    /**
+     * @param array $userIds
+     * @return UserStatus[]
+     */
+    public function findByUserIds(array $userIds):array {
+        return array_map(function ($status) {
+            return $this->processStatus($status);
+        }, $this->mapper->findByUserIds($userIds));
+    }
+
+    /**
+     * @param string $userId
+     * @param string $status
+     * @param int|null $statusTimestamp
+     * @param bool $isUserDefined
+     * @return UserStatus
+     * @throws InvalidStatusTypeException
+     */
+    public function setStatus(string $userId,
+                                string $status,
+                              ?int $statusTimestamp,
+                                bool $isUserDefined): UserStatus {
+        try {
+            $userStatus = $this->mapper->findByUserId($userId);
+        } catch (DoesNotExistException $ex) {
+            $userStatus = new UserStatus();
+            $userStatus->setUserId($userId);
+        }
+
+        // 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 ($statusTimestamp === null) {
+            $statusTimestamp = $this->timeFactory->getTime();
+        }
+
+        $userStatus->setStatus($status);
+        $userStatus->setStatusTimestamp($statusTimestamp);
+        $userStatus->setIsUserDefined($isUserDefined);
+        $userStatus->setIsBackup(false);
+
+        if ($userStatus->getId() === null) {
+            return $this->mapper->insert($userStatus);
+        }
+
+        return $this->mapper->update($userStatus);
+    }
+
+    /**
+     * @param string $userId
+     * @param string $messageId
+     * @param int|null $clearAt
+     * @return UserStatus
+     * @throws InvalidMessageIdException
+     * @throws InvalidClearAtException
+     */
+    public function setPredefinedMessage(string $userId,
+                                            string $messageId,
+                                         ?int $clearAt): UserStatus {
+        try {
+            $userStatus = $this->mapper->findByUserId($userId);
+        } catch (DoesNotExistException $ex) {
+            $userStatus = new UserStatus();
+            $userStatus->setUserId($userId);
+            $userStatus->setStatus(IUserStatus::OFFLINE);
+            $userStatus->setStatusTimestamp(0);
+            $userStatus->setIsUserDefined(false);
+            $userStatus->setIsBackup(false);
+        }
+
+        if (!$this->predefinedStatusService->isValidId($messageId)) {
+            throw new InvalidMessageIdException('Message-Id "' . $messageId . '" is not supported');
+        }
+
+        // Check that clearAt is in the future
+        if ($clearAt !== null && $clearAt < $this->timeFactory->getTime()) {
+            throw new InvalidClearAtException('ClearAt is in the past');
+        }
+
+        $userStatus->setMessageId($messageId);
+        $userStatus->setCustomIcon(null);
+        $userStatus->setCustomMessage(null);
+        $userStatus->setClearAt($clearAt);
+
+        if ($userStatus->getId() === null) {
+            return $this->mapper->insert($userStatus);
+        }
+
+        return $this->mapper->update($userStatus);
+    }
+
+    /**
+     * @param string $userId
+     * @param string $status
+     * @param string $messageId
+     * @param bool $createBackup
+     * @throws InvalidStatusTypeException
+     * @throws InvalidMessageIdException
+     */
+    public function setUserStatus(string $userId,
+                                            string $status,
+                                            string $messageId,
+                                            bool $createBackup): void {
+        // 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');
+        }
+
+        if ($createBackup) {
+            if ($this->backupCurrentStatus($userId) === false) {
+                return; // Already a status set automatically => abort.
+            }
+
+            // If we just created the backup
+            $userStatus = new UserStatus();
+            $userStatus->setUserId($userId);
+        } else {
+            try {
+                $userStatus = $this->mapper->findByUserId($userId);
+            } catch (DoesNotExistException $ex) {
+                $userStatus = new UserStatus();
+                $userStatus->setUserId($userId);
+            }
+        }
+
+        $userStatus->setStatus($status);
+        $userStatus->setStatusTimestamp($this->timeFactory->getTime());
+        $userStatus->setIsUserDefined(false);
+        $userStatus->setIsBackup(false);
+        $userStatus->setMessageId($messageId);
+        $userStatus->setCustomIcon(null);
+        $userStatus->setCustomMessage(null);
+        $userStatus->setClearAt(null);
+
+        if ($userStatus->getId() !== null) {
+            $this->mapper->update($userStatus);
+            return;
+        }
+        $this->mapper->insert($userStatus);
+    }
+
+    /**
+     * @param string $userId
+     * @param string|null $statusIcon
+     * @param string $message
+     * @param int|null $clearAt
+     * @return UserStatus
+     * @throws InvalidClearAtException
+     * @throws InvalidStatusIconException
+     * @throws StatusMessageTooLongException
+     */
+    public function setCustomMessage(string $userId,
+                                     ?string $statusIcon,
+                                        string $message,
+                                     ?int $clearAt): UserStatus {
+        try {
+            $userStatus = $this->mapper->findByUserId($userId);
+        } catch (DoesNotExistException $ex) {
+            $userStatus = new UserStatus();
+            $userStatus->setUserId($userId);
+            $userStatus->setStatus(IUserStatus::OFFLINE);
+            $userStatus->setStatusTimestamp(0);
+            $userStatus->setIsUserDefined(false);
+        }
+
+        // Check if statusIcon contains only one character
+        if ($statusIcon !== null && !$this->emojiService->isValidEmoji($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) {
+            throw new StatusMessageTooLongException('Message is longer than supported length of ' . self::MAXIMUM_MESSAGE_LENGTH . ' characters');
+        }
+        // Check that clearAt is in the future
+        if ($clearAt !== null && $clearAt < $this->timeFactory->getTime()) {
+            throw new InvalidClearAtException('ClearAt is in the past');
+        }
+
+        $userStatus->setMessageId(null);
+        $userStatus->setCustomIcon($statusIcon);
+        $userStatus->setCustomMessage($message);
+        $userStatus->setClearAt($clearAt);
+
+        if ($userStatus->getId() === null) {
+            return $this->mapper->insert($userStatus);
+        }
+
+        return $this->mapper->update($userStatus);
+    }
+
+    /**
+     * @param string $userId
+     * @return bool
+     */
+    public function clearStatus(string $userId): bool {
+        try {
+            $userStatus = $this->mapper->findByUserId($userId);
+        } catch (DoesNotExistException $ex) {
+            // if there is no status to remove, just return
+            return false;
+        }
+
+        $userStatus->setStatus(IUserStatus::OFFLINE);
+        $userStatus->setStatusTimestamp(0);
+        $userStatus->setIsUserDefined(false);
+
+        $this->mapper->update($userStatus);
+        return true;
+    }
+
+    /**
+     * @param string $userId
+     * @return bool
+     */
+    public function clearMessage(string $userId): bool {
+        try {
+            $userStatus = $this->mapper->findByUserId($userId);
+        } catch (DoesNotExistException $ex) {
+            // if there is no status to remove, just return
+            return false;
+        }
+
+        $userStatus->setMessageId(null);
+        $userStatus->setCustomMessage(null);
+        $userStatus->setCustomIcon(null);
+        $userStatus->setClearAt(null);
+
+        $this->mapper->update($userStatus);
+        return true;
+    }
+
+    /**
+     * @param string $userId
+     * @return bool
+     */
+    public function removeUserStatus(string $userId): bool {
+        try {
+            $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;
+        }
+
+        $this->mapper->delete($userStatus);
+        return true;
+    }
+
+    /**
+     * Processes a status to check if custom message is still
+     * up to date and provides translated default status if needed
+     *
+     * @param UserStatus $status
+     * @return UserStatus
+     */
+    private function processStatus(UserStatus $status): UserStatus {
+        $clearAt = $status->getClearAt();
+
+        if ($status->getStatusTimestamp() < $this->timeFactory->getTime() - self::INVALIDATE_STATUS_THRESHOLD
+            && (!$status->getIsUserDefined() || $status->getStatus() === IUserStatus::ONLINE)) {
+            $this->cleanStatus($status);
+        }
+        if ($clearAt !== null && $clearAt < $this->timeFactory->getTime()) {
+            $this->cleanStatusMessage($status);
+        }
+        if ($status->getMessageId() !== null) {
+            $this->addDefaultMessage($status);
+        }
+
+        return $status;
+    }
+
+    /**
+     * @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);
+
+        $this->mapper->update($status);
+    }
+
+    /**
+     * @param UserStatus $status
+     */
+    private function cleanStatusMessage(UserStatus $status): void {
+        $status->setMessageId(null);
+        $status->setCustomIcon(null);
+        $status->setCustomMessage(null);
+        $status->setClearAt(null);
+
+        $this->mapper->update($status);
+    }
+
+    /**
+     * @param UserStatus $status
+     */
+    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) {
+            $status->setCustomMessage($predefinedMessage['message']);
+            $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, string $status): void {
+        try {
+            /** @var UserStatus $userStatus */
+            $backupUserStatus = $this->mapper->findByUserId($userId, true);
+        } catch (DoesNotExistException $ex) {
+            // No user status to revert, do nothing
+            return;
+        }
+
+        $deleted = $this->mapper->deleteCurrentStatusToRestoreBackup($userId, $messageId, $status);
+        if (!$deleted) {
+            // Another status is set automatically or no status, do nothing
+            return;
+        }
+
+        $backupUserStatus->setIsBackup(false);
+        // Remove the underscore prefix added when creating the backup
+        $backupUserStatus->setUserId(substr($backupUserStatus->getUserId(), 1));
+        $this->mapper->update($backupUserStatus);
+    }
+
+    public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): 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
+                && $userStatus->getStatus() === $status) {
+                $statuesToDelete[$userStatus->getUserId()] = $userStatus->getId();
+            } else if ($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);
+    }
 }

apps/user_status/lib/Db/UserStatusMapper.php

Indentation +174 added lines, -174 removed lines

@@ -36,178 +36,178 @@
  */
 class UserStatusMapper extends QBMapper {
 
-	/**
-	 * @param IDBConnection $db
-	 */
-	public function __construct(IDBConnection $db) {
-		parent::__construct($db, 'user_status');
-	}
-
-	/**
-	 * @param int|null $limit
-	 * @param int|null $offset
-	 * @return UserStatus[]
-	 */
-	public function findAll(?int $limit = null, ?int $offset = null):array {
-		$qb = $this->db->getQueryBuilder();
-		$qb
-			->select('*')
-			->from($this->tableName);
-
-		if ($limit !== null) {
-			$qb->setMaxResults($limit);
-		}
-		if ($offset !== null) {
-			$qb->setFirstResult($offset);
-		}
-
-		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([IUserStatus::ONLINE, IUserStatus::AWAY, IUserStatus::OFFLINE], 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
-	 * @throws \OCP\AppFramework\Db\DoesNotExistException
-	 */
-	public function findByUserId(string $userId, bool $isBackup = false):UserStatus {
-		$qb = $this->db->getQueryBuilder();
-		$qb
-			->select('*')
-			->from($this->tableName)
-			->where($qb->expr()->eq('user_id', $qb->createNamedParameter($isBackup ? '_' . $userId : $userId, IQueryBuilder::PARAM_STR)));
-
-		return $this->findEntity($qb);
-	}
-
-	/**
-	 * @param array $userIds
-	 * @return array
-	 */
-	public function findByUserIds(array $userIds): array {
-		$qb = $this->db->getQueryBuilder();
-		$qb
-			->select('*')
-			->from($this->tableName)
-			->where($qb->expr()->in('user_id', $qb->createNamedParameter($userIds, IQueryBuilder::PARAM_STR_ARRAY)));
-
-		return $this->findEntities($qb);
-	}
-
-	/**
-	 * @param int $olderThan
-	 * @param int $now
-	 */
-	public function clearStatusesOlderThan(int $olderThan, int $now): void {
-		$qb = $this->db->getQueryBuilder();
-		$qb->update($this->tableName)
-			->set('status', $qb->createNamedParameter(IUserStatus::OFFLINE))
-			->set('is_user_defined', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL))
-			->set('status_timestamp', $qb->createNamedParameter($now, IQueryBuilder::PARAM_INT))
-			->where($qb->expr()->lte('status_timestamp', $qb->createNamedParameter($olderThan, IQueryBuilder::PARAM_INT)))
-			->andWhere($qb->expr()->neq('status', $qb->createNamedParameter(IUserStatus::OFFLINE)))
-			->andWhere($qb->expr()->orX(
-				$qb->expr()->eq('is_user_defined', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL), IQueryBuilder::PARAM_BOOL),
-				$qb->expr()->eq('status', $qb->createNamedParameter(IUserStatus::ONLINE))
-			));
-
-		$qb->execute();
-	}
-
-	/**
-	 * Clear all statuses older than a given timestamp
-	 *
-	 * @param int $timestamp
-	 */
-	public function clearMessagesOlderThan(int $timestamp): void {
-		$qb = $this->db->getQueryBuilder();
-		$qb->update($this->tableName)
-			->set('message_id', $qb->createNamedParameter(null))
-			->set('custom_icon', $qb->createNamedParameter(null))
-			->set('custom_message', $qb->createNamedParameter(null))
-			->set('clear_at', $qb->createNamedParameter(null))
-			->where($qb->expr()->isNotNull('clear_at'))
-			->andWhere($qb->expr()->lte('clear_at', $qb->createNamedParameter($timestamp, IQueryBuilder::PARAM_INT)));
-
-		$qb->execute();
-	}
-
-
-	/**
-	 * Deletes a user status so we can restore the backup
-	 *
-	 * @param string $userId
-	 * @param string $messageId
-	 * @param string $status
-	 * @return bool True if an entry was deleted
-	 */
-	public function deleteCurrentStatusToRestoreBackup(string $userId, string $messageId, string $status): bool {
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete($this->tableName)
-			->where($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)))
-			->andWhere($qb->expr()->eq('message_id', $qb->createNamedParameter($messageId)))
-			->andWhere($qb->expr()->eq('status', $qb->createNamedParameter($status)))
-			->andWhere($qb->expr()->eq('is_backup', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)));
-		return $qb->executeStatement() > 0;
-	}
-
-	public function deleteByIds(array $ids): void {
-		$qb = $this->db->getQueryBuilder();
-		$qb->delete($this->tableName)
-			->where($qb->expr()->in('id', $qb->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY)));
-		$qb->executeStatement();
-	}
-
-	/**
-	 * @param string $userId
-	 * @return bool
-	 * @throws \OCP\DB\Exception
-	 */
-	public function createBackupStatus(string $userId): bool {
-		// Prefix user account with an underscore because user_id is marked as unique
-		// in the table. Starting a username with an underscore is not allowed so this
-		// shouldn't create any trouble.
-		$qb = $this->db->getQueryBuilder();
-		$qb->update($this->tableName)
-			->set('is_backup', $qb->createNamedParameter(true, IQueryBuilder::PARAM_BOOL))
-			->set('user_id', $qb->createNamedParameter('_' . $userId))
-			->where($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)));
-		return $qb->executeStatement() > 0;
-	}
-
-	public function restoreBackupStatuses(array $ids): void {
-		$qb = $this->db->getQueryBuilder();
-		$qb->update($this->tableName)
-			->set('is_backup', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL))
-			->set('user_id', $qb->func()->substring('user_id', $qb->createNamedParameter(2, IQueryBuilder::PARAM_INT)))
-			->where($qb->expr()->in('id', $qb->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY)));
-
-		$qb->executeStatement();
-	}
+    /**
+     * @param IDBConnection $db
+     */
+    public function __construct(IDBConnection $db) {
+        parent::__construct($db, 'user_status');
+    }
+
+    /**
+     * @param int|null $limit
+     * @param int|null $offset
+     * @return UserStatus[]
+     */
+    public function findAll(?int $limit = null, ?int $offset = null):array {
+        $qb = $this->db->getQueryBuilder();
+        $qb
+            ->select('*')
+            ->from($this->tableName);
+
+        if ($limit !== null) {
+            $qb->setMaxResults($limit);
+        }
+        if ($offset !== null) {
+            $qb->setFirstResult($offset);
+        }
+
+        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([IUserStatus::ONLINE, IUserStatus::AWAY, IUserStatus::OFFLINE], 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
+     * @throws \OCP\AppFramework\Db\DoesNotExistException
+     */
+    public function findByUserId(string $userId, bool $isBackup = false):UserStatus {
+        $qb = $this->db->getQueryBuilder();
+        $qb
+            ->select('*')
+            ->from($this->tableName)
+            ->where($qb->expr()->eq('user_id', $qb->createNamedParameter($isBackup ? '_' . $userId : $userId, IQueryBuilder::PARAM_STR)));
+
+        return $this->findEntity($qb);
+    }
+
+    /**
+     * @param array $userIds
+     * @return array
+     */
+    public function findByUserIds(array $userIds): array {
+        $qb = $this->db->getQueryBuilder();
+        $qb
+            ->select('*')
+            ->from($this->tableName)
+            ->where($qb->expr()->in('user_id', $qb->createNamedParameter($userIds, IQueryBuilder::PARAM_STR_ARRAY)));
+
+        return $this->findEntities($qb);
+    }
+
+    /**
+     * @param int $olderThan
+     * @param int $now
+     */
+    public function clearStatusesOlderThan(int $olderThan, int $now): void {
+        $qb = $this->db->getQueryBuilder();
+        $qb->update($this->tableName)
+            ->set('status', $qb->createNamedParameter(IUserStatus::OFFLINE))
+            ->set('is_user_defined', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL))
+            ->set('status_timestamp', $qb->createNamedParameter($now, IQueryBuilder::PARAM_INT))
+            ->where($qb->expr()->lte('status_timestamp', $qb->createNamedParameter($olderThan, IQueryBuilder::PARAM_INT)))
+            ->andWhere($qb->expr()->neq('status', $qb->createNamedParameter(IUserStatus::OFFLINE)))
+            ->andWhere($qb->expr()->orX(
+                $qb->expr()->eq('is_user_defined', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL), IQueryBuilder::PARAM_BOOL),
+                $qb->expr()->eq('status', $qb->createNamedParameter(IUserStatus::ONLINE))
+            ));
+
+        $qb->execute();
+    }
+
+    /**
+     * Clear all statuses older than a given timestamp
+     *
+     * @param int $timestamp
+     */
+    public function clearMessagesOlderThan(int $timestamp): void {
+        $qb = $this->db->getQueryBuilder();
+        $qb->update($this->tableName)
+            ->set('message_id', $qb->createNamedParameter(null))
+            ->set('custom_icon', $qb->createNamedParameter(null))
+            ->set('custom_message', $qb->createNamedParameter(null))
+            ->set('clear_at', $qb->createNamedParameter(null))
+            ->where($qb->expr()->isNotNull('clear_at'))
+            ->andWhere($qb->expr()->lte('clear_at', $qb->createNamedParameter($timestamp, IQueryBuilder::PARAM_INT)));
+
+        $qb->execute();
+    }
+
+
+    /**
+     * Deletes a user status so we can restore the backup
+     *
+     * @param string $userId
+     * @param string $messageId
+     * @param string $status
+     * @return bool True if an entry was deleted
+     */
+    public function deleteCurrentStatusToRestoreBackup(string $userId, string $messageId, string $status): bool {
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete($this->tableName)
+            ->where($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)))
+            ->andWhere($qb->expr()->eq('message_id', $qb->createNamedParameter($messageId)))
+            ->andWhere($qb->expr()->eq('status', $qb->createNamedParameter($status)))
+            ->andWhere($qb->expr()->eq('is_backup', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)));
+        return $qb->executeStatement() > 0;
+    }
+
+    public function deleteByIds(array $ids): void {
+        $qb = $this->db->getQueryBuilder();
+        $qb->delete($this->tableName)
+            ->where($qb->expr()->in('id', $qb->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY)));
+        $qb->executeStatement();
+    }
+
+    /**
+     * @param string $userId
+     * @return bool
+     * @throws \OCP\DB\Exception
+     */
+    public function createBackupStatus(string $userId): bool {
+        // Prefix user account with an underscore because user_id is marked as unique
+        // in the table. Starting a username with an underscore is not allowed so this
+        // shouldn't create any trouble.
+        $qb = $this->db->getQueryBuilder();
+        $qb->update($this->tableName)
+            ->set('is_backup', $qb->createNamedParameter(true, IQueryBuilder::PARAM_BOOL))
+            ->set('user_id', $qb->createNamedParameter('_' . $userId))
+            ->where($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)));
+        return $qb->executeStatement() > 0;
+    }
+
+    public function restoreBackupStatuses(array $ids): void {
+        $qb = $this->db->getQueryBuilder();
+        $qb->update($this->tableName)
+            ->set('is_backup', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL))
+            ->set('user_id', $qb->func()->substring('user_id', $qb->createNamedParameter(2, IQueryBuilder::PARAM_INT)))
+            ->where($qb->expr()->in('id', $qb->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY)));
+
+        $qb->executeStatement();
+    }
 }

lib/private/UserStatus/Manager.php

Indentation +96 added lines, -96 removed lines

@@ -33,100 +33,100 @@
 
 class Manager implements IManager {
 
-	/** @var IServerContainer */
-	private $container;
-
-	/** @var LoggerInterface */
-	private $logger;
-
-	/** @var class-string */
-	private $providerClass;
-
-	/** @var IProvider */
-	private $provider;
-
-	/**
-	 * Manager constructor.
-	 *
-	 * @param IServerContainer $container
-	 * @param LoggerInterface $logger
-	 */
-	public function __construct(IServerContainer $container,
-								LoggerInterface $logger) {
-		$this->container = $container;
-		$this->logger = $logger;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getUserStatuses(array $userIds): array {
-		$this->setupProvider();
-		if (!$this->provider) {
-			return [];
-		}
-
-		return $this->provider->getUserStatuses($userIds);
-	}
-
-	/**
-	 * @param string $class
-	 * @since 20.0.0
-	 * @internal
-	 */
-	public function registerProvider(string $class): void {
-		$this->providerClass = $class;
-		$this->provider = null;
-	}
-
-	/**
-	 * Lazily set up provider
-	 */
-	private function setupProvider(): void {
-		if ($this->provider !== null) {
-			return;
-		}
-		if ($this->providerClass === null) {
-			return;
-		}
-
-		/**
-		 * @psalm-suppress InvalidCatch
-		 */
-		try {
-			$provider = $this->container->get($this->providerClass);
-		} catch (ContainerExceptionInterface $e) {
-			$this->logger->error('Could not load user-status "' . $this->providerClass . '" provider dynamically: ' . $e->getMessage(), [
-				'exception' => $e,
-			]);
-			return;
-		}
-
-		$this->provider = $provider;
-	}
-
-	public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false): void {
-		$this->setupProvider();
-		if (!$this->provider || !($this->provider instanceof ISettableProvider)) {
-			return;
-		}
-
-		$this->provider->setUserStatus($userId, $messageId, $status, $createBackup);
-	}
-
-	public function revertUserStatus(string $userId, string $messageId, string $status): void {
-		$this->setupProvider();
-		if (!$this->provider || !($this->provider instanceof ISettableProvider)) {
-			return;
-		}
-		$this->provider->revertUserStatus($userId, $messageId, $status);
-	}
-
-	public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void {
-		$this->setupProvider();
-		if (!$this->provider || !($this->provider instanceof ISettableProvider)) {
-			return;
-		}
-		$this->provider->revertMultipleUserStatus($userIds, $messageId, $status);
-	}
+    /** @var IServerContainer */
+    private $container;
+
+    /** @var LoggerInterface */
+    private $logger;
+
+    /** @var class-string */
+    private $providerClass;
+
+    /** @var IProvider */
+    private $provider;
+
+    /**
+     * Manager constructor.
+     *
+     * @param IServerContainer $container
+     * @param LoggerInterface $logger
+     */
+    public function __construct(IServerContainer $container,
+                                LoggerInterface $logger) {
+        $this->container = $container;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getUserStatuses(array $userIds): array {
+        $this->setupProvider();
+        if (!$this->provider) {
+            return [];
+        }
+
+        return $this->provider->getUserStatuses($userIds);
+    }
+
+    /**
+     * @param string $class
+     * @since 20.0.0
+     * @internal
+     */
+    public function registerProvider(string $class): void {
+        $this->providerClass = $class;
+        $this->provider = null;
+    }
+
+    /**
+     * Lazily set up provider
+     */
+    private function setupProvider(): void {
+        if ($this->provider !== null) {
+            return;
+        }
+        if ($this->providerClass === null) {
+            return;
+        }
+
+        /**
+         * @psalm-suppress InvalidCatch
+         */
+        try {
+            $provider = $this->container->get($this->providerClass);
+        } catch (ContainerExceptionInterface $e) {
+            $this->logger->error('Could not load user-status "' . $this->providerClass . '" provider dynamically: ' . $e->getMessage(), [
+                'exception' => $e,
+            ]);
+            return;
+        }
+
+        $this->provider = $provider;
+    }
+
+    public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false): void {
+        $this->setupProvider();
+        if (!$this->provider || !($this->provider instanceof ISettableProvider)) {
+            return;
+        }
+
+        $this->provider->setUserStatus($userId, $messageId, $status, $createBackup);
+    }
+
+    public function revertUserStatus(string $userId, string $messageId, string $status): void {
+        $this->setupProvider();
+        if (!$this->provider || !($this->provider instanceof ISettableProvider)) {
+            return;
+        }
+        $this->provider->revertUserStatus($userId, $messageId, $status);
+    }
+
+    public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void {
+        $this->setupProvider();
+        if (!$this->provider || !($this->provider instanceof ISettableProvider)) {
+            return;
+        }
+        $this->provider->revertMultipleUserStatus($userIds, $messageId, $status);
+    }
 }

lib/private/UserStatus/ISettableProvider.php

Indentation +29 added lines, -29 removed lines

@@ -32,35 +32,35 @@
  * @package OC\UserStatus
  */
 interface ISettableProvider extends IProvider {
-	/**
-	 * Set a new status for the selected user.
-	 *
-	 * @param string $userId The user for which we want to update the status.
-	 * @param string $messageId The new message id.
-	 * @param string $status The new status.
-	 * @param bool $createBackup If true, this will store the old status so that it is possible to revert it later (e.g. after a call).
-	 */
-	public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup): void;
+    /**
+     * Set a new status for the selected user.
+     *
+     * @param string $userId The user for which we want to update the status.
+     * @param string $messageId The new message id.
+     * @param string $status The new status.
+     * @param bool $createBackup If true, this will store the old status so that it is possible to revert it later (e.g. after a call).
+     */
+    public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup): void;
 
-	/**
-	 * Revert an automatically set user status. For example after leaving a call,
-	 * change back to the previously set status. If the user has already updated
-	 * their status, this method does nothing.
-	 *
-	 * @param string $userId The user for which we want to update the status.
-	 * @param string $messageId The expected current messageId.
-	 * @param string $status The expected current status.
-	 */
-	public function revertUserStatus(string $userId, string $messageId, string $status): void;
+    /**
+     * Revert an automatically set user status. For example after leaving a call,
+     * change back to the previously set status. If the user has already updated
+     * their status, this method does nothing.
+     *
+     * @param string $userId The user for which we want to update the status.
+     * @param string $messageId The expected current messageId.
+     * @param string $status The expected current status.
+     */
+    public function revertUserStatus(string $userId, string $messageId, string $status): void;
 
-	/**
-	 * Revert an automatically set user status. For example after leaving a call,
-	 * change back to the previously set status. If the user has already updated
-	 * their status, this method does nothing.
-	 *
-	 * @param string[] $userIds The users for which we want to update the status.
-	 * @param string $messageId The expected current messageId.
-	 * @param string $status The expected current status.
-	 */
-	public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void;
+    /**
+     * Revert an automatically set user status. For example after leaving a call,
+     * change back to the previously set status. If the user has already updated
+     * their status, this method does nothing.
+     *
+     * @param string[] $userIds The users for which we want to update the status.
+     * @param string $messageId The expected current messageId.
+     * @param string $status The expected current status.
+     */
+    public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void;
 }

lib/public/UserStatus/IManager.php

Indentation +38 added lines, -38 removed lines

@@ -32,46 +32,46 @@
  */
 interface IManager {
 
-	/**
-	 * Gets the statuses for all users in $users
-	 *
-	 * @param string[] $userIds
-	 * @return IUserStatus[]
-	 * @since 20.0.0
-	 */
-	public function getUserStatuses(array $userIds): array;
+    /**
+     * Gets the statuses for all users in $users
+     *
+     * @param string[] $userIds
+     * @return IUserStatus[]
+     * @since 20.0.0
+     */
+    public function getUserStatuses(array $userIds): array;
 
 
-	/**
-	 * Set a new status for the selected user.
-	 *
-	 * @param string $userId The user for which we want to update the status.
-	 * @param string $messageId The id of the predefined message.
-	 * @param string $status The status to assign
-	 * @param bool $createBackup If true, this will store the old status so that it is possible to revert it later (e.g. after a call).
-	 * @since 23.0.0
-	 */
-	public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false): void;
+    /**
+     * Set a new status for the selected user.
+     *
+     * @param string $userId The user for which we want to update the status.
+     * @param string $messageId The id of the predefined message.
+     * @param string $status The status to assign
+     * @param bool $createBackup If true, this will store the old status so that it is possible to revert it later (e.g. after a call).
+     * @since 23.0.0
+     */
+    public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false): void;
 
-	/**
-	 * Revert an automatically set user status. For example after leaving a call,
-	 * change back to the previously set status.
-	 *
-	 * @param string $userId The user for which we want to update the status.
-	 * @param string $messageId The expected current messageId. If the user has already updated their status, this method does nothing.
-	 * @param string $status The expected current status. If the user has already updated their status, this method does nothing.
-	 * @since 23.0.0
-	 */
-	public function revertUserStatus(string $userId, string $messageId, string $status): void;
+    /**
+     * Revert an automatically set user status. For example after leaving a call,
+     * change back to the previously set status.
+     *
+     * @param string $userId The user for which we want to update the status.
+     * @param string $messageId The expected current messageId. If the user has already updated their status, this method does nothing.
+     * @param string $status The expected current status. If the user has already updated their status, this method does nothing.
+     * @since 23.0.0
+     */
+    public function revertUserStatus(string $userId, string $messageId, string $status): void;
 
-	/**
-	 * Revert an automatically set user status. For example after leaving a call,
-	 * change back to the previously set status.
-	 *
-	 * @param string[] $userIds The user for which we want to update the status.
-	 * @param string $messageId The expected current messageId. If the user has already updated their status, this method does nothing.
-	 * @param string $status The expected current status. If the user has already updated their status, this method does nothing.
-	 * @since 23.0.0
-	 */
-	public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void;
+    /**
+     * Revert an automatically set user status. For example after leaving a call,
+     * change back to the previously set status.
+     *
+     * @param string[] $userIds The user for which we want to update the status.
+     * @param string $messageId The expected current messageId. If the user has already updated their status, this method does nothing.
+     * @param string $status The expected current status. If the user has already updated their status, this method does nothing.
+     * @since 23.0.0
+     */
+    public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void;
 }