mirror of
https://github.com/nextcloud/spreed.git
synced 2025-12-18 05:20:50 +01:00
347 lines
9.4 KiB
PHP
347 lines
9.4 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/**
|
|
* SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
namespace OCA\Talk\Search;
|
|
|
|
use OCA\Talk\AppInfo\Application;
|
|
use OCA\Talk\Chat\ChatManager;
|
|
use OCA\Talk\Chat\MessageParser;
|
|
use OCA\Talk\Config;
|
|
use OCA\Talk\Exceptions\ParticipantNotFoundException;
|
|
use OCA\Talk\Exceptions\RoomNotFoundException;
|
|
use OCA\Talk\Exceptions\UnauthorizedException;
|
|
use OCA\Talk\Manager as RoomManager;
|
|
use OCA\Talk\Model\Attendee;
|
|
use OCA\Talk\Room;
|
|
use OCA\Talk\Service\ParticipantService;
|
|
use OCA\Talk\Service\ThreadService;
|
|
use OCA\Talk\Webinary;
|
|
use OCP\AppFramework\Db\DoesNotExistException;
|
|
use OCP\AppFramework\Utility\ITimeFactory;
|
|
use OCP\Comments\IComment;
|
|
use OCP\IL10N;
|
|
use OCP\IURLGenerator;
|
|
use OCP\IUser;
|
|
use OCP\IUserSession;
|
|
use OCP\Search\FilterDefinition;
|
|
use OCP\Search\IFilter;
|
|
use OCP\Search\IFilteringProvider;
|
|
use OCP\Search\IProvider;
|
|
use OCP\Search\ISearchQuery;
|
|
use OCP\Search\SearchResult;
|
|
use OCP\Search\SearchResultEntry;
|
|
|
|
class MessageSearch implements IProvider, IFilteringProvider {
|
|
|
|
public const CONVERSATION_FILTER = 'conversation';
|
|
|
|
protected bool $isConversationFiltered = false;
|
|
|
|
public function __construct(
|
|
protected RoomManager $roomManager,
|
|
protected ParticipantService $participantService,
|
|
protected ChatManager $chatManager,
|
|
protected MessageParser $messageParser,
|
|
protected ITimeFactory $timeFactory,
|
|
protected IURLGenerator $url,
|
|
protected IL10N $l,
|
|
protected Config $talkConfig,
|
|
protected IUserSession $userSession,
|
|
protected ThreadService $threadService,
|
|
) {
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
#[\Override]
|
|
public function getId(): string {
|
|
return 'talk-message';
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
#[\Override]
|
|
public function getName(): string {
|
|
return $this->l->t('Messages');
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
#[\Override]
|
|
public function getOrder(string $route, array $routeParameters): ?int {
|
|
$currentUser = $this->userSession->getUser();
|
|
if ($currentUser && $this->talkConfig->isDisabledForUser($currentUser)) {
|
|
return null;
|
|
}
|
|
|
|
if (str_starts_with($route, Application::APP_ID . '.')) {
|
|
// Active app, prefer Talk results
|
|
return -2;
|
|
}
|
|
|
|
return 15;
|
|
}
|
|
|
|
protected function getCurrentConversationToken(ISearchQuery $query): string {
|
|
if ($query->getRoute() === 'spreed.Page.showCall') {
|
|
return $query->getRouteParameters()['token'];
|
|
}
|
|
return '';
|
|
}
|
|
|
|
protected function getSublineTemplate(): string {
|
|
if ($this->isConversationFiltered) {
|
|
return $this->l->t('{user}');
|
|
}
|
|
return $this->l->t('{user} in {conversation}');
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
#[\Override]
|
|
public function search(IUser $user, ISearchQuery $query): SearchResult {
|
|
$title = $this->l->t('Messages');
|
|
$currentToken = $this->getCurrentConversationToken($query);
|
|
if ($currentToken !== '') {
|
|
$title = $this->l->t('Messages in other conversations');
|
|
}
|
|
|
|
$filter = $query->getFilter(self::CONVERSATION_FILTER);
|
|
if ($filter && $filter->get() !== $currentToken) {
|
|
$this->isConversationFiltered = true;
|
|
$title = $this->l->t('Messages');
|
|
|
|
try {
|
|
$rooms = [$this->roomManager->getRoomForUserByToken(
|
|
$filter->get(),
|
|
$user->getUID()
|
|
)];
|
|
} catch (RoomNotFoundException) {
|
|
return SearchResult::complete($title, []);
|
|
}
|
|
} elseif ($filter) {
|
|
// The filter is the "Current conversation" so the CurrentMessageSearch will handle it
|
|
return SearchResult::complete($title, []);
|
|
} else {
|
|
$rooms = $this->roomManager->getRoomsForUser($user->getUID());
|
|
}
|
|
|
|
return $this->performSearch($user, $query, $title, $rooms, $this->isConversationFiltered);
|
|
}
|
|
|
|
/**
|
|
* @param Room[] $rooms
|
|
*/
|
|
public function performSearch(IUser $user, ISearchQuery $query, string $title, array $rooms, bool $isCurrentMessageSearch = false): SearchResult {
|
|
$roomMap = [];
|
|
foreach ($rooms as $room) {
|
|
if (!$isCurrentMessageSearch
|
|
&& $room->getType() === Room::TYPE_CHANGELOG) {
|
|
continue;
|
|
}
|
|
|
|
if (!$isCurrentMessageSearch
|
|
&& $this->getCurrentConversationToken($query) === $room->getToken()) {
|
|
// No search result from current conversation
|
|
continue;
|
|
}
|
|
|
|
if ($room->getLobbyState() !== Webinary::LOBBY_NONE) {
|
|
$participant = $this->participantService->getParticipant($room, $user->getUID(), false);
|
|
if (!($participant->getPermissions() & Attendee::PERMISSIONS_LOBBY_IGNORE)) {
|
|
continue;
|
|
}
|
|
}
|
|
|
|
if ($room->isFederatedConversation()) {
|
|
continue;
|
|
}
|
|
|
|
$roomMap[(string)$room->getId()] = $room;
|
|
}
|
|
|
|
if (empty($roomMap)) {
|
|
return SearchResult::complete($title, []);
|
|
}
|
|
|
|
// Apply filters when available
|
|
$lowerTimeBoundary = $upperTimeBoundary = $actorType = $actorId = null;
|
|
if ($since = $query->getFilter(IFilter::BUILTIN_SINCE)?->get()) {
|
|
if ($since instanceof \DateTimeImmutable) {
|
|
$lowerTimeBoundary = $since;
|
|
}
|
|
}
|
|
|
|
if ($until = $query->getFilter(IFilter::BUILTIN_UNTIL)?->get()) {
|
|
if ($until instanceof \DateTimeImmutable) {
|
|
$upperTimeBoundary = $until;
|
|
}
|
|
}
|
|
|
|
if ($person = $query->getFilter(IFilter::BUILTIN_PERSON)?->get()) {
|
|
if ($person instanceof IUser) {
|
|
$actorType = Attendee::ACTOR_USERS;
|
|
$actorId = $person->getUID();
|
|
}
|
|
}
|
|
|
|
$offset = (int)$query->getCursor();
|
|
$comments = $this->chatManager->searchForObjectsWithFilters(
|
|
$query->getTerm(),
|
|
array_keys($roomMap),
|
|
[ChatManager::VERB_MESSAGE, ChatManager::VERB_OBJECT_SHARED],
|
|
$lowerTimeBoundary,
|
|
$upperTimeBoundary,
|
|
$actorType,
|
|
$actorId,
|
|
$offset,
|
|
$query->getLimit()
|
|
);
|
|
|
|
$result = [];
|
|
foreach ($comments as $comment) {
|
|
$room = $roomMap[$comment->getObjectId()];
|
|
try {
|
|
$result[] = $this->commentToSearchResultEntry($room, $user, $comment, $query);
|
|
} catch (UnauthorizedException|ParticipantNotFoundException) {
|
|
}
|
|
}
|
|
|
|
return SearchResult::paginated(
|
|
$title,
|
|
$result,
|
|
$offset + $query->getLimit()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @throws ParticipantNotFoundException
|
|
* @throws UnauthorizedException
|
|
*/
|
|
protected function commentToSearchResultEntry(Room $room, IUser $user, IComment $comment, ISearchQuery $query): SearchResultEntry {
|
|
$participant = $this->participantService->getParticipant($room, $user->getUID(), false);
|
|
|
|
$id = (int)$comment->getId();
|
|
$message = $this->messageParser->createMessage($room, $participant, $comment, $this->l);
|
|
$this->messageParser->parseMessage($message);
|
|
|
|
$messageStr = $message->getMessage();
|
|
$search = $replace = [];
|
|
foreach ($message->getMessageParameters() as $key => $parameter) {
|
|
$search[] = '{' . $key . '}';
|
|
if ($parameter['type'] === 'user') {
|
|
$replace[] = '@' . $parameter['name'];
|
|
} else {
|
|
$replace[] = $parameter['name'];
|
|
}
|
|
}
|
|
$messageStr = str_replace($search, $replace, $messageStr);
|
|
|
|
$matchPosition = mb_stripos($messageStr, $query->getTerm());
|
|
if ($matchPosition > 30 && mb_strlen($messageStr) > 40) {
|
|
// Mostlikely the result is not visible from the beginning,
|
|
// so we cut of the message a bit.
|
|
$messageStr = '…' . mb_substr($messageStr, $matchPosition - 10);
|
|
}
|
|
|
|
$now = $this->timeFactory->getDateTime();
|
|
$expireDate = $message->getComment()->getExpireDate();
|
|
if ($expireDate instanceof \DateTime && $expireDate < $now) {
|
|
throw new UnauthorizedException('Expired');
|
|
}
|
|
|
|
if (!$message->getVisibility()) {
|
|
throw new UnauthorizedException('Not visible');
|
|
}
|
|
|
|
$iconUrl = '';
|
|
if ($message->getActorType() === Attendee::ACTOR_USERS) {
|
|
$iconUrl = $this->url->linkToRouteAbsolute('core.avatar.getAvatar', [
|
|
'userId' => $message->getActorId(),
|
|
'size' => 512,
|
|
]);
|
|
}
|
|
|
|
$subline = $this->getSublineTemplate();
|
|
if ($room->getType() === Room::TYPE_ONE_TO_ONE || $room->getType() === Room::TYPE_ONE_TO_ONE_FORMER) {
|
|
$subline = '{user}';
|
|
}
|
|
|
|
$displayName = $message->getActorDisplayName();
|
|
if (in_array($message->getActorType(), [Attendee::ACTOR_GUESTS, Attendee::ACTOR_EMAILS], true)) {
|
|
if ($displayName === '') {
|
|
$displayName = $this->l->t('Guest');
|
|
} else {
|
|
$displayName = $this->l->t('%s (guest)', $displayName);
|
|
}
|
|
}
|
|
|
|
$urlParams = [
|
|
'token' => $room->getToken(),
|
|
'_fragment' => 'message_' . $id,
|
|
];
|
|
$threadId = (int)$comment->getTopmostParentId() ?: (int)$comment->getId();
|
|
try {
|
|
$thread = $this->threadService->findByThreadId($room->getId(), $threadId);
|
|
$urlParams['threadId'] = $thread->getId();
|
|
} catch (DoesNotExistException) {
|
|
$thread = null;
|
|
}
|
|
|
|
$entry = new SearchResultEntry(
|
|
$iconUrl,
|
|
str_replace(
|
|
['{user}', '{conversation}'],
|
|
[$displayName, $room->getDisplayName($user->getUID())],
|
|
$subline
|
|
),
|
|
$messageStr,
|
|
$this->url->linkToRouteAbsolute('spreed.Page.showCall', $urlParams),
|
|
'icon-talk', // $iconClass,
|
|
true
|
|
);
|
|
|
|
$entry->addAttribute('conversation', $room->getToken());
|
|
$entry->addAttribute('messageId', $comment->getId());
|
|
if ($thread !== null) {
|
|
$entry->addAttribute('threadId', (string)$thread->getId());
|
|
}
|
|
$entry->addAttribute('actorType', $comment->getActorType());
|
|
$entry->addAttribute('actorId', $comment->getActorId());
|
|
$entry->addAttribute('timestamp', '' . $comment->getCreationDateTime()->getTimestamp());
|
|
|
|
return $entry;
|
|
}
|
|
|
|
#[\Override]
|
|
public function getSupportedFilters(): array {
|
|
return [
|
|
IFilter::BUILTIN_TERM,
|
|
IFilter::BUILTIN_SINCE,
|
|
IFilter::BUILTIN_UNTIL,
|
|
IFilter::BUILTIN_PERSON,
|
|
self::CONVERSATION_FILTER,
|
|
];
|
|
}
|
|
|
|
#[\Override]
|
|
public function getAlternateIds(): array {
|
|
return ['talk-message'];
|
|
}
|
|
|
|
#[\Override]
|
|
public function getCustomFilters(): array {
|
|
return [
|
|
new FilterDefinition(self::CONVERSATION_FILTER)
|
|
];
|
|
}
|
|
}
|