* * @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 * */ namespace OCA\UserStatus\Controller; use OCA\UserStatus\Db\UserStatus; 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 OCA\UserStatus\Service\StatusService; use OCP\AppFramework\Db\DoesNotExistException; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\OCS\OCSBadRequestException; use OCP\AppFramework\OCS\OCSNotFoundException; use OCP\AppFramework\OCSController; use OCP\ILogger; use OCP\IRequest; class UserStatusController extends OCSController { /** @var string */ private $userId; /** @var ILogger */ private $logger; /** @var StatusService */ private $service; /** * StatusesController constructor. * * @param string $appName * @param IRequest $request * @param string $userId * @param ILogger $logger; * @param StatusService $service */ public function __construct(string $appName, IRequest $request, string $userId, ILogger $logger, StatusService $service) { parent::__construct($appName, $request); $this->userId = $userId; $this->logger = $logger; $this->service = $service; } /** * @NoAdminRequired * * @return DataResponse * @throws OCSNotFoundException */ public function getStatus(): DataResponse { try { $userStatus = $this->service->findByUserId($this->userId); } catch (DoesNotExistException $ex) { throw new OCSNotFoundException('No status for the current user'); } return new DataResponse($this->formatStatus($userStatus)); } /** * @NoAdminRequired * * @param string $statusType * @return DataResponse * @throws OCSBadRequestException */ public function setStatus(string $statusType): DataResponse { try { $status = $this->service->setStatus($this->userId, $statusType, null, true); return new DataResponse($this->formatStatus($status)); } catch (InvalidStatusTypeException $ex) { $this->logger->debug('New user-status for "' . $this->userId . '" was rejected due to an invalid status type "' . $statusType . '"'); throw new OCSBadRequestException($ex->getMessage(), $ex); } } /** * @NoAdminRequired * * @param string $messageId * @param int|null $clearAt * @return DataResponse * @throws OCSBadRequestException */ public function setPredefinedMessage(string $messageId, ?int $clearAt): DataResponse { try { $status = $this->service->setPredefinedMessage($this->userId, $messageId, $clearAt); return new DataResponse($this->formatStatus($status)); } catch (InvalidClearAtException $ex) { $this->logger->debug('New user-status for "' . $this->userId . '" was rejected due to an invalid clearAt value "' . $clearAt . '"'); throw new OCSBadRequestException($ex->getMessage(), $ex); } catch (InvalidMessageIdException $ex) { $this->logger->debug('New user-status for "' . $this->userId . '" was rejected due to an invalid message-id "' . $messageId . '"'); throw new OCSBadRequestException($ex->getMessage(), $ex); } } /** * @NoAdminRequired * * @param string|null $statusIcon * @param string $message * @param int|null $clearAt * @return DataResponse * @throws OCSBadRequestException */ public function setCustomMessage(?string $statusIcon, string $message, ?int $clearAt): DataResponse { try { $status = $this->service->setCustomMessage($this->userId, $statusIcon, $message, $clearAt); return new DataResponse($this->formatStatus($status)); } catch (InvalidClearAtException $ex) { $this->logger->debug('New user-status for "' . $this->userId . '" was rejected due to an invalid clearAt value "' . $clearAt . '"'); throw new OCSBadRequestException($ex->getMessage(), $ex); } catch (InvalidStatusIconException $ex) { $this->logger->debug('New user-status for "' . $this->userId . '" was rejected due to an invalid icon value "' . $statusIcon . '"'); throw new OCSBadRequestException($ex->getMessage(), $ex); } catch (StatusMessageTooLongException $ex) { $this->logger->debug('New user-status for "' . $this->userId . '" was rejected due to a too long status message.'); throw new OCSBadRequestException($ex->getMessage(), $ex); } } /** * @NoAdminRequired * * @return DataResponse */ public function clearStatus(): DataResponse { $this->service->clearStatus($this->userId); return new DataResponse([]); } /** * @NoAdminRequired * * @return DataResponse */ public function clearMessage(): DataResponse { $this->service->clearMessage($this->userId); return new DataResponse([]); } /** * @param UserStatus $status * @return array */ private function formatStatus(UserStatus $status): array { return [ 'userId' => $status->getUserId(), 'message' => $status->getCustomMessage(), 'messageId' => $status->getMessageId(), 'messageIsPredefined' => $status->getMessageId() !== null, 'icon' => $status->getCustomIcon(), 'clearAt' => $status->getClearAt(), 'status' => $status->getStatus(), 'statusIsUserDefined' => $status->getIsUserDefined(), ]; } }