123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335 |
- <?php
-
- 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/>
- *
- */
-
- namespace OCA\UserStatus\Service;
-
- use OCA\UserStatus\Db\UserStatus;
- use OCA\UserStatus\Db\UserStatusMapper;
- use OCA\UserStatus\Exception\InvalidClearAtException;
- use OCA\UserStatus\Exception\InvalidMessageIdException;
- use OCA\UserStatus\Exception\InvalidStatusIconException;
- use OCA\UserStatus\Exception\InvalidStatusTypeException;
- use OCA\UserStatus\Exception\StatusMessageTooLongException;
- use OCP\AppFramework\Db\DoesNotExistException;
- use OCP\AppFramework\Utility\ITimeFactory;
-
- /**
- * Class StatusService
- *
- * @package OCA\UserStatus\Service
- */
- class StatusService {
-
- /** @var UserStatusMapper */
- private $mapper;
-
- /** @var ITimeFactory */
- private $timeFactory;
-
- /** @var PredefinedStatusService */
- private $predefinedStatusService;
-
- /** @var EmojiService */
- private $emojiService;
-
- /** @var string[] */
- private $allowedStatusTypes = [
- 'online',
- 'away',
- 'dnd',
- 'invisible',
- 'offline'
- ];
-
- /** @var int */
- private $maximumMessageLength = 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;
- }
-
- /**
- * @param int|null $limit
- * @param int|null $offset
- * @return UserStatus[]
- */
- public function findAll(?int $limit = null, ?int $offset = null): array {
- return array_map(function ($status) {
- return $this->processStatus($status);
- }, $this->mapper->findAll($limit, $offset));
- }
-
- /**
- * @param string $userId
- * @return UserStatus
- * @throws DoesNotExistException
- */
- public function findByUserId(string $userId):UserStatus {
- return $this->processStatus($this->mapper->findByUserId($userId));
- }
-
- /**
- * @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, $this->allowedStatusTypes, 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);
-
- 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('offline');
- $userStatus->setStatusTimestamp(0);
- $userStatus->setIsUserDefined(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|null $statusIcon
- * @param string|null $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('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) > $this->maximumMessageLength) {
- throw new StatusMessageTooLongException('Message is longer than supported length of ' . $this->maximumMessageLength . ' 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('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);
- } 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
- * @returns UserStatus
- */
- private function processStatus(UserStatus $status): UserStatus {
- $clearAt = $status->getClearAt();
- if ($clearAt !== null && $clearAt < $this->timeFactory->getTime()) {
- $this->cleanStatus($status);
- }
- if ($status->getMessageId() !== null) {
- $this->addDefaultMessage($status);
- }
-
- return $status;
- }
-
- /**
- * @param UserStatus $status
- */
- private function cleanStatus(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']);
- }
- }
- }
|