mirror of
https://github.com/nextcloud/spreed.git
synced 2025-12-17 21:12:20 +01:00
198 lines
7.9 KiB
PHP
198 lines
7.9 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/**
|
|
* SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
namespace OCA\Talk\Controller;
|
|
|
|
use OCA\Talk\Chat\ReactionManager;
|
|
use OCA\Talk\Exceptions\ReactionAlreadyExistsException;
|
|
use OCA\Talk\Exceptions\ReactionNotSupportedException;
|
|
use OCA\Talk\Exceptions\ReactionOutOfContextException;
|
|
use OCA\Talk\Middleware\Attribute\FederationSupported;
|
|
use OCA\Talk\Middleware\Attribute\RequireModeratorOrNoLobby;
|
|
use OCA\Talk\Middleware\Attribute\RequireParticipant;
|
|
use OCA\Talk\Middleware\Attribute\RequirePermission;
|
|
use OCA\Talk\Middleware\Attribute\RequireReadWriteConversation;
|
|
use OCA\Talk\ResponseDefinitions;
|
|
use OCP\AppFramework\Http;
|
|
use OCP\AppFramework\Http\Attribute\ApiRoute;
|
|
use OCP\AppFramework\Http\Attribute\PublicPage;
|
|
use OCP\AppFramework\Http\Attribute\RequestHeader;
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
use OCP\Comments\NotFoundException;
|
|
use OCP\IRequest;
|
|
|
|
/**
|
|
* @psalm-import-type TalkReaction from ResponseDefinitions
|
|
*/
|
|
class ReactionController extends AEnvironmentAwareOCSController {
|
|
|
|
public function __construct(
|
|
string $appName,
|
|
IRequest $request,
|
|
private ReactionManager $reactionManager,
|
|
) {
|
|
parent::__construct($appName, $request);
|
|
}
|
|
|
|
/**
|
|
* Add a reaction to a message
|
|
*
|
|
* @param int $messageId ID of the message
|
|
* @psalm-param non-negative-int $messageId
|
|
* @param string $reaction Emoji to add
|
|
* @return DataResponse<Http::STATUS_OK|Http::STATUS_CREATED, array<string, list<TalkReaction>>|\stdClass, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND, null, array{}>
|
|
*
|
|
* 200: Reaction already existed
|
|
* 201: Reaction added successfully
|
|
* 400: Adding reaction is not possible
|
|
* 404: Message not found
|
|
*/
|
|
#[FederationSupported]
|
|
#[PublicPage]
|
|
#[RequireModeratorOrNoLobby]
|
|
#[RequireParticipant]
|
|
#[RequirePermission(permission: RequirePermission::CHAT)]
|
|
#[RequireReadWriteConversation]
|
|
#[RequestHeader(name: 'x-nextcloud-federation', description: 'Set to 1 when the request is performed by another Nextcloud Server to indicate a federation request', indirect: true)]
|
|
#[ApiRoute(verb: 'POST', url: '/api/{apiVersion}/reaction/{token}/{messageId}', requirements: [
|
|
'apiVersion' => '(v1)',
|
|
'token' => '[a-z0-9]{4,30}',
|
|
'messageId' => '[0-9]+',
|
|
])]
|
|
public function react(int $messageId, string $reaction): DataResponse {
|
|
if ($this->room->isFederatedConversation()) {
|
|
/** @var \OCA\Talk\Federation\Proxy\TalkV1\Controller\ReactionController $proxy */
|
|
$proxy = \OCP\Server::get(\OCA\Talk\Federation\Proxy\TalkV1\Controller\ReactionController::class);
|
|
return $proxy->react($this->room, $this->participant, $messageId, $reaction, $this->getResponseFormat());
|
|
}
|
|
|
|
try {
|
|
$this->reactionManager->addReactionMessage(
|
|
$this->getRoom(),
|
|
$this->getParticipant()->getAttendee()->getActorType(),
|
|
$this->getParticipant()->getAttendee()->getActorId(),
|
|
$this->getParticipant()->getAttendee()->getDisplayName(),
|
|
$messageId,
|
|
$reaction
|
|
);
|
|
$status = Http::STATUS_CREATED;
|
|
} catch (NotFoundException $e) {
|
|
return new DataResponse(null, Http::STATUS_NOT_FOUND);
|
|
} catch (ReactionAlreadyExistsException $e) {
|
|
$status = Http::STATUS_OK;
|
|
} catch (ReactionNotSupportedException|ReactionOutOfContextException|\Exception $e) {
|
|
return new DataResponse(null, Http::STATUS_BAD_REQUEST);
|
|
}
|
|
$reactions = $this->reactionManager->retrieveReactionMessages($this->getRoom(), $this->getParticipant(), $messageId);
|
|
return new DataResponse($this->formatReactions($reactions), $status);
|
|
}
|
|
|
|
/**
|
|
* Delete a reaction from a message
|
|
*
|
|
* @param int $messageId ID of the message
|
|
* @psalm-param non-negative-int $messageId
|
|
* @param string $reaction Emoji to remove
|
|
* @return DataResponse<Http::STATUS_OK, array<string, list<TalkReaction>>|\stdClass, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND, null, array{}>
|
|
*
|
|
* 200: Reaction deleted successfully
|
|
* 400: Deleting reaction is not possible
|
|
* 404: Message not found
|
|
*/
|
|
#[FederationSupported]
|
|
#[PublicPage]
|
|
#[RequireModeratorOrNoLobby]
|
|
#[RequireParticipant]
|
|
#[RequirePermission(permission: RequirePermission::CHAT)]
|
|
#[RequireReadWriteConversation]
|
|
#[RequestHeader(name: 'x-nextcloud-federation', description: 'Set to 1 when the request is performed by another Nextcloud Server to indicate a federation request', indirect: true)]
|
|
#[ApiRoute(verb: 'DELETE', url: '/api/{apiVersion}/reaction/{token}/{messageId}', requirements: [
|
|
'apiVersion' => '(v1)',
|
|
'token' => '[a-z0-9]{4,30}',
|
|
'messageId' => '[0-9]+',
|
|
])]
|
|
public function delete(int $messageId, string $reaction): DataResponse {
|
|
if ($this->room->isFederatedConversation()) {
|
|
/** @var \OCA\Talk\Federation\Proxy\TalkV1\Controller\ReactionController $proxy */
|
|
$proxy = \OCP\Server::get(\OCA\Talk\Federation\Proxy\TalkV1\Controller\ReactionController::class);
|
|
return $proxy->delete($this->room, $this->participant, $messageId, $reaction, $this->getResponseFormat());
|
|
}
|
|
|
|
try {
|
|
$this->reactionManager->deleteReactionMessage(
|
|
$this->getRoom(),
|
|
$this->getParticipant()->getAttendee()->getActorType(),
|
|
$this->getParticipant()->getAttendee()->getActorId(),
|
|
$this->getParticipant()->getAttendee()->getDisplayName(),
|
|
$messageId,
|
|
$reaction
|
|
);
|
|
$reactions = $this->reactionManager->retrieveReactionMessages($this->getRoom(), $this->getParticipant(), $messageId);
|
|
} catch (ReactionNotSupportedException|ReactionOutOfContextException|NotFoundException $e) {
|
|
return new DataResponse(null, Http::STATUS_NOT_FOUND);
|
|
} catch (\Exception $e) {
|
|
return new DataResponse(null, Http::STATUS_BAD_REQUEST);
|
|
}
|
|
|
|
return new DataResponse($this->formatReactions($reactions), Http::STATUS_OK);
|
|
}
|
|
|
|
/**
|
|
* Get a list of reactions for a message
|
|
*
|
|
* @param int $messageId ID of the message
|
|
* @psalm-param non-negative-int $messageId
|
|
* @param string|null $reaction Emoji to filter
|
|
* @return DataResponse<Http::STATUS_OK, array<string, list<TalkReaction>>|\stdClass, array{}>|DataResponse<Http::STATUS_NOT_FOUND, null, array{}>
|
|
*
|
|
* 200: Reactions returned
|
|
* 404: Message or reaction not found
|
|
*/
|
|
#[FederationSupported]
|
|
#[PublicPage]
|
|
#[RequireModeratorOrNoLobby]
|
|
#[RequireParticipant]
|
|
#[RequestHeader(name: 'x-nextcloud-federation', description: 'Set to 1 when the request is performed by another Nextcloud Server to indicate a federation request', indirect: true)]
|
|
#[ApiRoute(verb: 'GET', url: '/api/{apiVersion}/reaction/{token}/{messageId}', requirements: [
|
|
'apiVersion' => '(v1)',
|
|
'token' => '[a-z0-9]{4,30}',
|
|
'messageId' => '[0-9]+',
|
|
])]
|
|
public function getReactions(int $messageId, ?string $reaction): DataResponse {
|
|
if ($this->room->isFederatedConversation()) {
|
|
/** @var \OCA\Talk\Federation\Proxy\TalkV1\Controller\ReactionController $proxy */
|
|
$proxy = \OCP\Server::get(\OCA\Talk\Federation\Proxy\TalkV1\Controller\ReactionController::class);
|
|
return $proxy->getReactions($this->room, $this->participant, $messageId, $reaction, $this->getResponseFormat());
|
|
}
|
|
|
|
try {
|
|
// Verify that messageId is part of the room
|
|
$this->reactionManager->getCommentToReact($this->getRoom(), (string)$messageId);
|
|
} catch (ReactionNotSupportedException|ReactionOutOfContextException|NotFoundException $e) {
|
|
return new DataResponse(null, Http::STATUS_NOT_FOUND);
|
|
}
|
|
|
|
$reactions = $this->reactionManager->retrieveReactionMessages($this->getRoom(), $this->getParticipant(), $messageId, $reaction);
|
|
|
|
return new DataResponse($this->formatReactions($reactions), Http::STATUS_OK);
|
|
}
|
|
|
|
/**
|
|
* @param array<string, list<TalkReaction>> $reactions
|
|
* @return array<string, list<TalkReaction>>|\stdClass
|
|
*/
|
|
protected function formatReactions(array $reactions): array|\stdClass {
|
|
if ($this->getResponseFormat() === 'json' && empty($reactions)) {
|
|
// Cheating here to make sure the reactions array is always a
|
|
// JSON object on the API, even when there is no reaction at all.
|
|
return new \stdClass();
|
|
}
|
|
|
|
return $reactions;
|
|
}
|
|
}
|