-
Notifications
You must be signed in to change notification settings - Fork 428
/
ChatManager.php
1025 lines (891 loc) · 35.1 KB
/
ChatManager.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Talk\Chat;
use DateInterval;
use OC\Memcache\ArrayCache;
use OC\Memcache\NullCache;
use OCA\Talk\CachePrefix;
use OCA\Talk\Events\BeforeChatMessageSentEvent;
use OCA\Talk\Events\BeforeSystemMessageSentEvent;
use OCA\Talk\Events\ChatMessageSentEvent;
use OCA\Talk\Events\SystemMessageSentEvent;
use OCA\Talk\Exceptions\MessagingNotAllowedException;
use OCA\Talk\Exceptions\ParticipantNotFoundException;
use OCA\Talk\Model\Attendee;
use OCA\Talk\Model\Message;
use OCA\Talk\Model\Poll;
use OCA\Talk\Participant;
use OCA\Talk\Room;
use OCA\Talk\Service\AttachmentService;
use OCA\Talk\Service\ParticipantService;
use OCA\Talk\Service\PollService;
use OCA\Talk\Service\RoomService;
use OCA\Talk\Share\RoomShareProvider;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Collaboration\Reference\IReferenceManager;
use OCP\Comments\IComment;
use OCP\Comments\MessageTooLongException;
use OCP\Comments\NotFoundException;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\ICache;
use OCP\ICacheFactory;
use OCP\IDBConnection;
use OCP\IRequest;
use OCP\IUser;
use OCP\Notification\IManager as INotificationManager;
use OCP\Security\RateLimiting\ILimiter;
use OCP\Security\RateLimiting\IRateLimitExceededException;
use OCP\Share\Exceptions\ShareNotFound;
use OCP\Share\IManager;
use OCP\Share\IShare;
use Psr\Log\LoggerInterface;
/**
* Basic polling chat manager.
*
* sendMessage() saves a comment using the ICommentsManager, while
* receiveMessages() tries to read comments from ICommentsManager (with a little
* wait between reads) until comments are found or until the timeout expires.
*
* When a message is saved the mentioned users are notified as needed, and
* pending notifications are removed if the messages are deleted.
*/
class ChatManager {
public const MAX_CHAT_LENGTH = 32000;
public const RATE_LIMIT_GUEST_MENTIONS_LIMIT = 50;
public const RATE_LIMIT_GUEST_MENTIONS_PERIOD = 24 * 60 * 60;
public const GEO_LOCATION_VALIDATOR = '/^geo:-?\d{1,2}(\.\d+)?,-?\d{1,3}(\.\d+)?(,-?\d+(\.\d+)?)?(;crs=wgs84)?(;u=\d+(\.\d+)?)?$/i';
public const VERB_MESSAGE = 'comment';
public const VERB_SYSTEM = 'system';
public const VERB_OBJECT_SHARED = 'object_shared';
public const VERB_COMMAND = 'command';
public const VERB_MESSAGE_DELETED = 'comment_deleted';
public const VERB_REACTION = 'reaction';
public const VERB_REACTION_DELETED = 'reaction_deleted';
public const VERB_VOICE_MESSAGE = 'voice-message';
public const VERB_RECORD_AUDIO = 'record-audio';
public const VERB_RECORD_VIDEO = 'record-video';
protected ICache $cache;
protected ICache $unreadCountCache;
public function __construct(
private CommentsManager $commentsManager,
private IEventDispatcher $dispatcher,
private IDBConnection $connection,
private INotificationManager $notificationManager,
private IManager $shareManager,
private RoomShareProvider $shareProvider,
private ParticipantService $participantService,
private RoomService $roomService,
private PollService $pollService,
private Notifier $notifier,
ICacheFactory $cacheFactory,
protected ITimeFactory $timeFactory,
protected AttachmentService $attachmentService,
protected IReferenceManager $referenceManager,
protected ILimiter $rateLimiter,
protected IRequest $request,
protected LoggerInterface $logger,
) {
$this->cache = $cacheFactory->createDistributed(CachePrefix::CHAT_LAST_MESSAGE_ID);
$this->unreadCountCache = $cacheFactory->createDistributed(CachePrefix::CHAT_UNREAD_COUNT);
}
/**
* Sends a new message to the given chat.
*
* @param bool $shouldSkipLastMessageUpdate If multiple messages will be posted
* (e.g. when adding multiple users to a room) we can skip the last
* message and last activity update until the last entry was created
* and then update with those values.
* This will replace O(n) with 1 database update.
* @throws MessagingNotAllowedException
*/
public function addSystemMessage(
Room $chat,
string $actorType,
string $actorId,
string $message,
\DateTime $creationDateTime,
bool $sendNotifications,
?string $referenceId = null,
?IComment $replyTo = null,
bool $shouldSkipLastMessageUpdate = false,
bool $silent = false,
): IComment {
if ($chat->isFederatedConversation()) {
$e = new MessagingNotAllowedException();
$this->logger->error('Attempt to post system message into proxy conversation', ['exception' => $e]);
throw $e;
}
$comment = $this->commentsManager->create($actorType, $actorId, 'chat', (string) $chat->getId());
$comment->setMessage($message, self::MAX_CHAT_LENGTH);
$comment->setCreationDateTime($creationDateTime);
if ($referenceId !== null) {
$referenceId = trim(substr($referenceId, 0, 64));
if ($referenceId !== '') {
$comment->setReferenceId($referenceId);
}
}
if ($replyTo !== null) {
$comment->setParentId($replyTo->getId());
}
$messageDecoded = json_decode($message, true);
$messageType = $messageDecoded['message'] ?? '';
if ($messageType === 'object_shared' || $messageType === 'file_shared') {
$comment->setVerb(self::VERB_OBJECT_SHARED);
} else {
$comment->setVerb(self::VERB_SYSTEM);
}
if ($silent) {
$comment->setMetaData([
Message::METADATA_SILENT => true,
]);
}
$this->setMessageExpiration($chat, $comment);
$shouldFlush = $this->notificationManager->defer();
$event = new BeforeSystemMessageSentEvent($chat, $comment, silent: $silent, parent: $replyTo, skipLastActivityUpdate: $shouldSkipLastMessageUpdate);
$this->dispatcher->dispatchTyped($event);
try {
$this->commentsManager->save($comment);
if (!$shouldSkipLastMessageUpdate) {
// Update last_message
$this->roomService->setLastMessage($chat, $comment);
$this->unreadCountCache->clear($chat->getId() . '-');
}
if ($sendNotifications) {
/** @var ?IComment $captionComment */
$captionComment = null;
$alreadyNotifiedUsers = $usersDirectlyMentioned = $federatedUsersDirectlyMentioned = [];
if ($messageType === 'file_shared') {
if (isset($messageDecoded['parameters']['metaData']['caption'])) {
$captionComment = clone $comment;
$captionComment->setMessage($messageDecoded['parameters']['metaData']['caption'], self::MAX_CHAT_LENGTH);
$usersDirectlyMentioned = $this->notifier->getMentionedUserIds($captionComment);
$federatedUsersDirectlyMentioned = $this->notifier->getMentionedCloudIds($captionComment);
}
if ($replyTo instanceof IComment) {
$alreadyNotifiedUsers = $this->notifier->notifyReplyToAuthor($chat, $comment, $replyTo, $silent);
if ($replyTo->getActorType() === Attendee::ACTOR_USERS) {
$usersDirectlyMentioned[] = $replyTo->getActorId();
} elseif ($replyTo->getActorType() === Attendee::ACTOR_FEDERATED_USERS) {
$federatedUsersDirectlyMentioned[] = $replyTo->getActorId();
}
}
}
$alreadyNotifiedUsers = $this->notifier->notifyMentionedUsers($chat, $captionComment ?? $comment, $alreadyNotifiedUsers, $silent);
if (!empty($alreadyNotifiedUsers)) {
$userIds = array_column($alreadyNotifiedUsers, 'id');
$this->participantService->markUsersAsMentioned($chat, Attendee::ACTOR_USERS, $userIds, (int) $comment->getId(), $usersDirectlyMentioned);
}
if (!empty($federatedUsersDirectlyMentioned)) {
$this->participantService->markUsersAsMentioned($chat, Attendee::ACTOR_FEDERATED_USERS, $federatedUsersDirectlyMentioned, (int) $comment->getId(), $federatedUsersDirectlyMentioned);
}
$this->notifier->notifyOtherParticipant($chat, $comment, [], $silent);
}
if (!$shouldSkipLastMessageUpdate && $sendNotifications) {
// Update the read-marker for the author when it is a "relevant" system message,
// e.g. sharing an item to the chat
try {
$participant = $this->participantService->getParticipantByActor($chat, $actorType, $actorId);
$this->participantService->updateLastReadMessage($participant, (int) $comment->getId());
} catch (ParticipantNotFoundException) {
// Participant not found => No read-marker update needed
}
}
$event = new SystemMessageSentEvent($chat, $comment, silent: $silent, parent: $replyTo, skipLastActivityUpdate: $shouldSkipLastMessageUpdate);
$this->dispatcher->dispatchTyped($event);
} catch (NotFoundException $e) {
}
$this->cache->remove($chat->getToken());
if ($shouldFlush) {
$this->notificationManager->flush();
}
if ($messageType === 'object_shared' || $messageType === 'file_shared') {
$this->attachmentService->createAttachmentEntry($chat, $comment, $messageType, $messageDecoded['parameters'] ?? []);
}
return $comment;
}
/**
* Sends a new message to the given chat.
*
* @param Room $chat
* @param string $message
* @return IComment
*/
public function addChangelogMessage(Room $chat, string $message): IComment {
$comment = $this->commentsManager->create(Attendee::ACTOR_GUESTS, Attendee::ACTOR_ID_CHANGELOG, 'chat', (string) $chat->getId());
$comment->setMessage($message, self::MAX_CHAT_LENGTH);
$comment->setCreationDateTime($this->timeFactory->getDateTime());
$comment->setVerb(self::VERB_MESSAGE); // Has to be 'comment', so it counts as unread message
$event = new BeforeSystemMessageSentEvent($chat, $comment);
$this->dispatcher->dispatchTyped($event);
try {
$this->commentsManager->save($comment);
// Update last_message
$this->roomService->setLastMessage($chat, $comment);
$this->unreadCountCache->clear($chat->getId() . '-');
$event = new SystemMessageSentEvent($chat, $comment);
$this->dispatcher->dispatchTyped($event);
} catch (NotFoundException $e) {
}
$this->cache->remove($chat->getToken());
return $comment;
}
/**
* Sends a new message to the given chat.
*
* @throws IRateLimitExceededException Only when $rateLimitGuestMentions is true and the author is a guest participant
* @throws MessageTooLongException
* @throws MessagingNotAllowedException
*/
public function sendMessage(
Room $chat,
?Participant $participant,
string $actorType,
string $actorId,
string $message,
\DateTime $creationDateTime,
?IComment $replyTo = null,
string $referenceId = '',
bool $silent = false,
bool $rateLimitGuestMentions = true,
): IComment {
if ($chat->isFederatedConversation()) {
$e = new MessagingNotAllowedException();
$this->logger->error('Attempt to post system message into proxy conversation', ['exception' => $e]);
throw $e;
}
$comment = $this->commentsManager->create($actorType, $actorId, 'chat', (string) $chat->getId());
$comment->setMessage($message, self::MAX_CHAT_LENGTH);
$comment->setCreationDateTime($creationDateTime);
// A verb ('comment', 'like'...) must be provided to be able to save a
// comment
$comment->setVerb(self::VERB_MESSAGE);
if ($replyTo instanceof IComment) {
$comment->setParentId($replyTo->getId());
}
$referenceId = trim(substr($referenceId, 0, 64));
if ($referenceId !== '') {
$comment->setReferenceId($referenceId);
}
$this->setMessageExpiration($chat, $comment);
if ($rateLimitGuestMentions && $participant instanceof Participant && $participant->isGuest()) {
$mentions = $comment->getMentions();
if (!empty($mentions)) {
$this->rateLimiter->registerAnonRequest(
'talk-mentions',
self::RATE_LIMIT_GUEST_MENTIONS_LIMIT,
self::RATE_LIMIT_GUEST_MENTIONS_PERIOD,
$this->request->getRemoteAddress(),
);
}
}
if ($silent) {
$comment->setMetaData([
Message::METADATA_SILENT => true,
]);
}
$event = new BeforeChatMessageSentEvent($chat, $comment, $participant, $silent, $replyTo);
$this->dispatcher->dispatchTyped($event);
$shouldFlush = $this->notificationManager->defer();
try {
$this->commentsManager->save($comment);
if ($participant instanceof Participant) {
$this->participantService->updateLastReadMessage($participant, (int) $comment->getId());
}
// Update last_message
if ($comment->getActorType() !== Attendee::ACTOR_BOTS
|| $comment->getActorId() === Attendee::ACTOR_ID_CHANGELOG
|| str_starts_with($comment->getActorId(), Attendee::ACTOR_BOT_PREFIX)) {
$this->roomService->setLastMessage($chat, $comment);
$this->unreadCountCache->clear($chat->getId() . '-');
} else {
$this->roomService->setLastActivity($chat, $comment->getCreationDateTime());
}
$alreadyNotifiedUsers = [];
$usersDirectlyMentioned = $this->notifier->getMentionedUserIds($comment);
$federatedUsersDirectlyMentioned = $this->notifier->getMentionedCloudIds($comment);
if ($replyTo instanceof IComment) {
$alreadyNotifiedUsers = $this->notifier->notifyReplyToAuthor($chat, $comment, $replyTo, $silent);
if ($replyTo->getActorType() === Attendee::ACTOR_USERS) {
$usersDirectlyMentioned[] = $replyTo->getActorId();
} elseif ($replyTo->getActorType() === Attendee::ACTOR_FEDERATED_USERS) {
$federatedUsersDirectlyMentioned[] = $replyTo->getActorId();
}
}
$alreadyNotifiedUsers = $this->notifier->notifyMentionedUsers($chat, $comment, $alreadyNotifiedUsers, $silent);
if (!empty($alreadyNotifiedUsers)) {
$userIds = array_column($alreadyNotifiedUsers, 'id');
$this->participantService->markUsersAsMentioned($chat, Attendee::ACTOR_USERS, $userIds, (int) $comment->getId(), $usersDirectlyMentioned);
}
if (!empty($federatedUsersDirectlyMentioned)) {
$this->participantService->markUsersAsMentioned($chat, Attendee::ACTOR_FEDERATED_USERS, $federatedUsersDirectlyMentioned, (int) $comment->getId(), $federatedUsersDirectlyMentioned);
}
// User was not mentioned, send a normal notification
$this->notifier->notifyOtherParticipant($chat, $comment, $alreadyNotifiedUsers, $silent);
$event = new ChatMessageSentEvent($chat, $comment, $participant, $silent, $replyTo);
$this->dispatcher->dispatchTyped($event);
} catch (NotFoundException $e) {
}
$this->cache->remove($chat->getToken());
if ($shouldFlush) {
$this->notificationManager->flush();
}
return $comment;
}
private function setMessageExpiration(Room $room, IComment $comment): void {
$messageExpiration = $room->getMessageExpiration();
if (!$messageExpiration) {
return;
}
$dateTime = $this->timeFactory->getDateTime();
$dateTime->add(DateInterval::createFromDateString($messageExpiration . ' seconds'));
$comment->setExpireDate($dateTime);
}
/**
* @param Room $room
* @param Participant $participant
* @param array $messageData
* @throws ShareNotFound
*/
public function unshareFileOnMessageDelete(Room $room, Participant $participant, array $messageData): void {
if (!isset($messageData['message'], $messageData['parameters']['share']) || $messageData['message'] !== 'file_shared') {
// Not a file share
return;
}
$share = $this->shareManager->getShareById('ocRoomShare:' . $messageData['parameters']['share']);
if ($share->getShareType() !== IShare::TYPE_ROOM || $share->getSharedWith() !== $room->getToken()) {
// Share does not match the correct room
throw new ShareNotFound();
}
$attendee = $participant->getAttendee();
if (!$participant->hasModeratorPermissions(false) &&
!($attendee->getActorType() === Attendee::ACTOR_USERS && $attendee->getActorId() === $share->getShareOwner())) {
// Only moderators or the share owner can delete the share
return;
}
$this->shareManager->deleteShare($share);
}
/**
* @throws ShareNotFound
*/
public function removePollOnMessageDelete(Room $room, Participant $participant, array $messageData, \DateTime $deletionTime): void {
if (!isset($messageData['message'], $messageData['parameters']['objectType'], $messageData['parameters']['objectId'])
|| $messageData['message'] !== 'object_shared'
|| $messageData['parameters']['objectType'] !== 'talk-poll') {
// Not a poll share
return;
}
try {
$poll = $this->pollService->getPoll($room->getId(), (int)$messageData['parameters']['objectId']);
} catch (DoesNotExistException $e) {
return;
}
if ($poll->getStatus() === Poll::STATUS_CLOSED) {
$closingMessages = $this->commentsManager->searchForObjects(
json_encode([
'message' => 'poll_closed',
'parameters' => [
'poll' => [
'type' => 'talk-poll',
'id' => $poll->getId(),
'name' => $poll->getQuestion(),
],
],
], JSON_THROW_ON_ERROR),
'chat',
[(string) $room->getId()],
'system',
0
);
foreach ($closingMessages as $closingMessage) {
$this->deleteMessage($room, $closingMessage, $participant, $deletionTime);
}
}
if (!$participant->hasModeratorPermissions(false)) {
$attendee = $participant->getAttendee();
if (!($attendee->getActorType() === $poll->getActorType()
&& $attendee->getActorId() === $poll->getActorId())) {
// Only moderators or the poll creator can delete it
return;
}
}
$this->pollService->deleteByPollId($poll->getId());
}
/**
* @param Room $chat
* @param IComment $comment
* @param Participant $participant
* @param \DateTime $deletionTime
* @return IComment
* @throws ShareNotFound
*/
public function deleteMessage(Room $chat, IComment $comment, Participant $participant, \DateTime $deletionTime): IComment {
if ($comment->getVerb() === self::VERB_OBJECT_SHARED) {
$messageData = json_decode($comment->getMessage(), true);
$this->unshareFileOnMessageDelete($chat, $participant, $messageData);
$this->removePollOnMessageDelete($chat, $participant, $messageData, $deletionTime);
}
$comment->setMessage(
json_encode([
'deleted_by_type' => $participant->getAttendee()->getActorType(),
'deleted_by_id' => $participant->getAttendee()->getActorId(),
'deleted_on' => $deletionTime->getTimestamp(),
])
);
$comment->setVerb(self::VERB_MESSAGE_DELETED);
$metaData = $comment->getMetaData() ?? [];
if (isset($metaData[Message::METADATA_LAST_EDITED_BY_TYPE])) {
unset(
$metaData[Message::METADATA_LAST_EDITED_BY_TYPE],
$metaData[Message::METADATA_LAST_EDITED_BY_ID],
$metaData[Message::METADATA_LAST_EDITED_TIME],
);
$comment->setMetaData($metaData);
}
$this->commentsManager->save($comment);
$this->attachmentService->deleteAttachmentByMessageId((int) $comment->getId());
$this->referenceManager->invalidateCache($chat->getToken());
return $this->addSystemMessage(
$chat,
$participant->getAttendee()->getActorType(),
$participant->getAttendee()->getActorId(),
json_encode(['message' => 'message_deleted', 'parameters' => ['message' => $comment->getId()]]),
$this->timeFactory->getDateTime(),
false,
null,
$comment,
true
);
}
/**
* @param Room $chat
* @param IComment $comment
* @param Participant $participant
* @param \DateTime $editTime
* @param string $message
* @return IComment
* @throws MessageTooLongException
* @throws \InvalidArgumentException When the message is empty or the shared object is not a file share with caption
*/
public function editMessage(Room $chat, IComment $comment, Participant $participant, \DateTime $editTime, string $message): IComment {
if (trim($message) === '') {
throw new \InvalidArgumentException('message');
}
if ($comment->getVerb() === ChatManager::VERB_OBJECT_SHARED) {
$messageData = json_decode($comment->getMessage(), true);
if (!isset($messageData['message']) || $messageData['message'] !== 'file_shared') {
// Not a file share
throw new \InvalidArgumentException('object_share');
}
$messageData['parameters'] ??= [];
$messageData['parameters']['metaData'] ??= [];
$messageData['parameters']['metaData']['caption'] = $message;
$message = json_encode($messageData);
}
$metaData = $comment->getMetaData() ?? [];
$metaData[Message::METADATA_LAST_EDITED_BY_TYPE] = $participant->getAttendee()->getActorType();
$metaData[Message::METADATA_LAST_EDITED_BY_ID] = $participant->getAttendee()->getActorId();
$metaData[Message::METADATA_LAST_EDITED_TIME] = $editTime->getTimestamp();
$comment->setMetaData($metaData);
$wasSilent = $metaData[Message::METADATA_SILENT] ?? false;
if (!$wasSilent) {
$mentionsBefore = $comment->getMentions();
$usersDirectlyMentionedBefore = $this->notifier->getMentionedUserIds($comment);
$usersToNotifyBefore = $this->notifier->getUsersToNotify($chat, $comment, []);
}
$comment->setMessage($message, self::MAX_CHAT_LENGTH);
if (!$wasSilent) {
$mentionsAfter = $comment->getMentions();
}
$this->commentsManager->save($comment);
$this->referenceManager->invalidateCache($chat->getToken());
if (!$wasSilent) {
$removedMentions = empty($mentionsAfter) ? $mentionsBefore : array_udiff($mentionsBefore, $mentionsAfter, [$this, 'compareMention']);
$addedMentions = empty($mentionsBefore) ? $mentionsAfter : array_udiff($mentionsAfter, $mentionsBefore, [$this, 'compareMention']);
if (!empty($removedMentions)) {
$usersToNotifyAfter = $this->notifier->getUsersToNotify($chat, $comment, []);
$removedUsersMentioned = array_udiff($usersToNotifyBefore, $usersToNotifyAfter, [$this, 'compareMention']);
$userIds = array_column($removedUsersMentioned, 'id');
$this->notifier->removeMentionNotificationAfterEdit($chat, $comment, $userIds);
}
if (!empty($addedMentions)) {
$usersDirectlyMentionedAfter = $this->notifier->getMentionedUserIds($comment);
$federatedUsersDirectlyMentionedAfter = $this->notifier->getMentionedCloudIds($comment);
$addedUsersDirectMentioned = array_diff($usersDirectlyMentionedAfter, $usersDirectlyMentionedBefore);
$alreadyNotifiedUsers = $this->notifier->notifyMentionedUsers($chat, $comment, $usersToNotifyBefore, silent: false);
if (!empty($alreadyNotifiedUsers)) {
$userIds = array_column($alreadyNotifiedUsers, 'id');
$this->participantService->markUsersAsMentioned($chat, Attendee::ACTOR_USERS, $userIds, (int) $comment->getId(), $addedUsersDirectMentioned);
}
if (!empty($federatedUsersDirectlyMentionedAfter)) {
$this->participantService->markUsersAsMentioned($chat, Attendee::ACTOR_FEDERATED_USERS, $federatedUsersDirectlyMentionedAfter, (int) $comment->getId(), $federatedUsersDirectlyMentionedAfter);
}
}
}
return $this->addSystemMessage(
$chat,
$participant->getAttendee()->getActorType(),
$participant->getAttendee()->getActorId(),
json_encode(['message' => 'message_edited', 'parameters' => ['message' => $comment->getId()]]),
$this->timeFactory->getDateTime(),
false,
null,
$comment,
true
);
}
protected static function compareMention(array $mention1, array $mention2): int {
if ($mention1['type'] === $mention2['type']) {
return $mention1['id'] <=> $mention2['id'];
}
return $mention1['type'] <=> $mention2['type'];
}
public function clearHistory(Room $chat, string $actorType, string $actorId): IComment {
$this->commentsManager->deleteCommentsAtObject('chat', (string) $chat->getId());
$this->shareProvider->deleteInRoom($chat->getToken());
$this->notifier->removePendingNotificationsForRoom($chat, true);
$this->participantService->resetChatDetails($chat);
$this->pollService->deleteByRoomId($chat->getId());
return $this->addSystemMessage(
$chat,
$actorType,
$actorId,
json_encode(['message' => 'history_cleared', 'parameters' => []]),
$this->timeFactory->getDateTime(),
false
);
}
/**
* @param Room $chat
* @param string $parentId
* @return IComment
* @throws NotFoundException
*/
public function getParentComment(Room $chat, string $parentId): IComment {
$comment = $this->commentsManager->get($parentId);
if ($comment->getObjectType() !== 'chat' || $comment->getObjectId() !== (string) $chat->getId()) {
throw new NotFoundException('Parent not found in the right context');
}
return $comment;
}
/**
* @param Room $chat
* @param string $messageId
* @return IComment
* @throws NotFoundException
*/
public function getComment(Room $chat, string $messageId): IComment {
$comment = $this->commentsManager->get($messageId);
if ($comment->getObjectType() !== 'chat' || $comment->getObjectId() !== (string) $chat->getId()) {
throw new NotFoundException('Message not found in the right context');
}
return $comment;
}
public function getLastReadMessageFromLegacy(Room $chat, IUser $user): int {
$marker = $this->commentsManager->getReadMark('chat', (string) $chat->getId(), $user);
if ($marker === null) {
return 0;
}
return $this->commentsManager->getLastCommentBeforeDate('chat', (string) $chat->getId(), $marker, self::VERB_MESSAGE);
}
public function getUnreadCount(Room $chat, int $lastReadMessage): int {
/**
* for a given message id $lastReadMessage we cache the number of messages
* that exist past that message, which happen to also be the number of
* unread messages, because this is expensive to query per room and user repeatedly
*/
$key = $chat->getId() . '-' . $lastReadMessage;
$unreadCount = $this->unreadCountCache->get($key);
if ($unreadCount === null) {
$unreadCount = $this->commentsManager->getNumberOfCommentsWithVerbsForObjectSinceComment('chat', (string) $chat->getId(), $lastReadMessage, [self::VERB_MESSAGE, 'object_shared']);
$this->unreadCountCache->set($key, $unreadCount, 1800);
}
return $unreadCount;
}
/**
* Returns the ID of the last chat message, that was read by everyone
* sharing their read status.
*
* @param Room $chat
* @return int
*/
public function getLastCommonReadMessage(Room $chat): int {
return $this->participantService->getLastCommonReadChatMessage($chat);
}
/**
* Receive the history of a chat
*
* @param Room $chat
* @param int $offset Last known message id
* @param int $limit
* @param bool $includeLastKnown
* @return IComment[] the messages found (only the id, actor type and id,
* creation date and message are relevant), or an empty array if the
* timeout expired.
*/
public function getHistory(Room $chat, int $offset, int $limit, bool $includeLastKnown): array {
return $this->commentsManager->getForObjectSince('chat', (string) $chat->getId(), $offset, 'desc', $limit, $includeLastKnown);
}
/**
* @param Room $chat
* @param int $offset Last known message id
* @param array $verbs
* @param bool $offsetIsVerbMatch
* @return IComment
* @throws NotFoundException
*/
public function getPreviousMessageWithVerb(Room $chat, int $offset, array $verbs, bool $offsetIsVerbMatch): IComment {
$messages = $this->commentsManager->getCommentsWithVerbForObjectSinceComment(
'chat',
(string) $chat->getId(),
$verbs,
$offset,
'desc',
!$offsetIsVerbMatch ? 2 : 1
);
if (empty($messages)) {
throw new NotFoundException('No comment with verb found');
}
return array_pop($messages);
}
/**
* If there are currently no messages the response will not be sent
* immediately. Instead, HTTP connection will be kept open waiting for new
* messages to arrive and, when they do, then the response will be sent. The
* connection will not be kept open indefinitely, though; the number of
* seconds to wait for new messages to arrive can be set using the timeout
* parameter; the default timeout is 30 seconds, maximum timeout is 60
* seconds. If the timeout ends a successful but empty response will be
* sent.
*
* @param Room $chat
* @param int $offset Last known message id
* @param int $limit
* @param int $timeout
* @param IUser|null $user
* @param bool $includeLastKnown
* @param bool $markNotificationsAsRead (defaults to true)
* @return IComment[] the messages found (only the id, actor type and id,
* creation date and message are relevant), or an empty array if the
* timeout expired.
*/
public function waitForNewMessages(Room $chat, int $offset, int $limit, int $timeout, ?IUser $user, bool $includeLastKnown, bool $markNotificationsAsRead = true): array {
if ($markNotificationsAsRead && $user instanceof IUser) {
$this->notifier->markMentionNotificationsRead($chat, $user->getUID());
}
if ($this->cache instanceof NullCache
|| $this->cache instanceof ArrayCache) {
return $this->waitForNewMessagesWithDatabase($chat, $offset, $limit, $timeout, $includeLastKnown);
}
return $this->waitForNewMessagesWithCache($chat, $offset, $limit, $timeout, $includeLastKnown);
}
/**
* Check the cache until we found new messages, or the timeout was reached
*
* @param Room $chat
* @param int $offset
* @param int $limit
* @param int $timeout
* @param bool $includeLastKnown
* @return IComment[]
*/
protected function waitForNewMessagesWithCache(Room $chat, int $offset, int $limit, int $timeout, bool $includeLastKnown): array {
$elapsedTime = 0;
$comments = $this->checkCacheOrDatabase($chat, $offset, $limit, $includeLastKnown);
while (empty($comments) && $elapsedTime < $timeout) {
$this->connection->close();
sleep(1);
$elapsedTime++;
$comments = $this->checkCacheOrDatabase($chat, $offset, $limit, $includeLastKnown);
}
return $comments;
}
/**
* Check the cache for the last message id or check the database for updates
*
* @param Room $chat
* @param int $offset
* @param int $limit
* @param bool $includeLastKnown
* @return IComment[]
*/
protected function checkCacheOrDatabase(Room $chat, int $offset, int $limit, bool $includeLastKnown): array {
$cachedId = $this->cache->get($chat->getToken());
if ($offset === $cachedId) {
// Cache hit, nothing new ¯\_(ツ)_/¯
return [];
}
// Load data from the database
$comments = $this->commentsManager->getForObjectSince('chat', (string) $chat->getId(), $offset, 'asc', $limit, $includeLastKnown);
if (empty($comments)) {
// We only write the cache when there were no new comments,
// otherwise it could happen that this is not the last message,
// but the last within $limit
$this->cache->set($chat->getToken(), $offset, 30);
return [];
}
return $comments;
}
/**
* Check the database for new messages until there a new messages or we exceeded the timeout
*
* @param Room $chat
* @param int $offset
* @param int $limit
* @param int $timeout
* @param bool $includeLastKnown
* @return array
*/
protected function waitForNewMessagesWithDatabase(Room $chat, int $offset, int $limit, int $timeout, bool $includeLastKnown): array {
$elapsedTime = 0;
$comments = $this->commentsManager->getForObjectSince('chat', (string) $chat->getId(), $offset, 'asc', $limit, $includeLastKnown);
while (empty($comments) && $elapsedTime < $timeout) {
sleep(1);
$elapsedTime++;
$comments = $this->commentsManager->getForObjectSince('chat', (string) $chat->getId(), $offset, 'asc', $limit, $includeLastKnown);
}
return $comments;
}
/**
* Deletes all the messages for the given chat.
*
* @param Room $chat
*/
public function deleteMessages(Room $chat): void {
$this->commentsManager->deleteCommentsAtObject('chat', (string) $chat->getId());
$this->shareProvider->deleteInRoom($chat->getToken());
$this->notifier->removePendingNotificationsForRoom($chat);
$this->attachmentService->deleteAttachmentsForRoom($chat);
$this->pollService->deleteByRoomId($chat->getId());
}
/**
* Get messages for the given chat by ID
*
* @param Room $chat
* @param int[] $commentIds
* @return IComment[]
*/
public function getMessagesForRoomById(Room $chat, array $commentIds): array {
$comments = $this->commentsManager->getCommentsById(array_map('strval', $commentIds));
$comments = array_filter($comments, static function (IComment $comment) use ($chat) {
return $comment->getObjectType() === 'chat'
&& (int)$comment->getObjectId() === $chat->getId();
});
return $comments;
}
/**
* Get messages by ID
*
* @param int[] $commentIds
* @return IComment[] Key is the message id
*/
public function getMessagesById(array $commentIds): array {
return $this->commentsManager->getCommentsById(array_map('strval', $commentIds));
}
/**
* Search for comments with a given content
*
* @param string $search content to search for
* @param array $objectIds Limit the search by object ids
* @param string $verb Limit the verb of the comment
* @param int $offset
* @param int $limit
* @return IComment[]
*/
public function searchForObjects(string $search, array $objectIds, string $verb = '', int $offset = 0, int $limit = 50): array {
return $this->commentsManager->searchForObjects($search, 'chat', $objectIds, $verb, $offset, $limit);
}
/**
* Search for comments on one or more objects with a given content
*
* @param string $search content to search for
* @param string[] $objectIds Limit the search by object ids
* @param string $verb Limit the verb of the comment
* @return list<IComment>
*/
public function searchForObjectsWithFilters(string $search, array $objectIds, string $verb, ?\DateTimeImmutable $since, ?\DateTimeImmutable $until, ?string $actorType, ?string $actorId, int $offset, int $limit = 50): array {
return $this->commentsManager->searchForObjectsWithFilters($search, 'chat', $objectIds, $verb, $since, $until, $actorType, $actorId, $offset, $limit);
}
public function addConversationNotify(array $results, string $search, Room $room, Participant $participant): array {
if ($room->getType() === Room::TYPE_ONE_TO_ONE) {
return $results;
}
$attendee = $participant->getAttendee();
if ($attendee->getActorType() === Attendee::ACTOR_USERS) {
$roomDisplayName = $room->getDisplayName($attendee->getActorId());
} else {
$roomDisplayName = $room->getDisplayName('');
}
if ($search === '' || $this->searchIsPartOfConversationNameOrAtAll($search, $roomDisplayName)) {
array_unshift($results, [
'id' => 'all',
'label' => $roomDisplayName,
'source' => 'calls',
'mentionId' => 'all',
]);
}
return $results;
}
private function searchIsPartOfConversationNameOrAtAll(string $search, string $roomDisplayName): bool {
if (stripos($roomDisplayName, $search) !== false) {
return true;
}
/**
* @psalm-suppress InvalidLiteralArgument
*/
if (str_starts_with('all', $search)) {
return true;
}
/**
* @psalm-suppress InvalidLiteralArgument
*/
if (str_starts_with('here', $search)) {
return true;
}
return false;
}
public function deleteExpiredMessages(): void {
$this->commentsManager->deleteCommentsExpiredAtObject('chat', '');
}
public function fileOfMessageExists(string $message): bool {
$parameters = $this->getParametersFromMessage($message);
try {
$this->shareProvider->getShareById($parameters['share']);
} catch (ShareNotFound $e) {
return false;
}
return true;
}
public function isSharedFile(string $message): bool {
$parameters = $this->getParametersFromMessage($message);
return !empty($parameters['share']);
}
protected function getParametersFromMessage(string $message): array {