2015-12-04 16:20:05 +00:00
|
|
|
/*
|
2021-06-22 16:23:13 +00:00
|
|
|
Copyright 2015 - 2021 The Matrix.org Foundation C.I.C.
|
2015-12-04 16:20:05 +00:00
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2021-06-22 16:23:13 +00:00
|
|
|
import { Room } from "matrix-js-sdk/src/models/room";
|
|
|
|
import { MatrixEvent } from "matrix-js-sdk/src/models/event";
|
2021-06-28 18:07:58 +00:00
|
|
|
import { EventType } from "matrix-js-sdk/src/@types/event";
|
2021-06-22 16:23:13 +00:00
|
|
|
|
|
|
|
import { MatrixClientPeg } from "./MatrixClientPeg";
|
2017-07-21 18:51:13 +00:00
|
|
|
import shouldHideEvent from './shouldHideEvent';
|
2022-03-23 05:16:25 +00:00
|
|
|
import { haveRendererForEvent } from "./events/EventTileFactory";
|
2016-01-06 18:07:24 +00:00
|
|
|
|
2019-12-20 00:45:24 +00:00
|
|
|
/**
|
2022-03-11 18:59:49 +00:00
|
|
|
* Returns true if this event arriving in a room should affect the room's
|
2019-12-20 00:45:24 +00:00
|
|
|
* count of unread messages
|
2020-10-30 18:40:19 +00:00
|
|
|
*
|
|
|
|
* @param {Object} ev The event
|
|
|
|
* @returns {boolean} True if the given event should affect the unread message count
|
2019-12-20 00:45:24 +00:00
|
|
|
*/
|
2021-06-22 16:23:13 +00:00
|
|
|
export function eventTriggersUnreadCount(ev: MatrixEvent): boolean {
|
2021-07-15 16:43:24 +00:00
|
|
|
if (ev.getSender() === MatrixClientPeg.get().credentials.userId) {
|
2019-12-20 00:45:24 +00:00
|
|
|
return false;
|
|
|
|
}
|
2021-06-22 16:23:13 +00:00
|
|
|
|
|
|
|
switch (ev.getType()) {
|
|
|
|
case EventType.RoomMember:
|
|
|
|
case EventType.RoomThirdPartyInvite:
|
|
|
|
case EventType.CallAnswer:
|
|
|
|
case EventType.CallHangup:
|
|
|
|
case EventType.RoomAliases:
|
|
|
|
case EventType.RoomCanonicalAlias:
|
|
|
|
case EventType.RoomServerAcl:
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (ev.isRedacted()) return false;
|
2022-03-23 05:16:25 +00:00
|
|
|
return haveRendererForEvent(ev);
|
2019-12-20 00:45:24 +00:00
|
|
|
}
|
2016-01-06 18:07:24 +00:00
|
|
|
|
2021-06-22 16:23:13 +00:00
|
|
|
export function doesRoomHaveUnreadMessages(room: Room): boolean {
|
2021-04-23 11:19:08 +00:00
|
|
|
const myUserId = MatrixClientPeg.get().getUserId();
|
2017-06-26 13:28:56 +00:00
|
|
|
|
2019-12-20 00:45:24 +00:00
|
|
|
// get the most recent read receipt sent by our account.
|
|
|
|
// N.B. this is NOT a read marker (RM, aka "read up to marker"),
|
|
|
|
// despite the name of the method :((
|
|
|
|
const readUpToId = room.getEventReadUpTo(myUserId);
|
2017-06-26 13:28:56 +00:00
|
|
|
|
2019-12-20 00:45:24 +00:00
|
|
|
// as we don't send RRs for our own messages, make sure we special case that
|
|
|
|
// if *we* sent the last message into the room, we consider it not unread!
|
2020-08-03 15:02:26 +00:00
|
|
|
// Should fix: https://github.com/vector-im/element-web/issues/3263
|
|
|
|
// https://github.com/vector-im/element-web/issues/2427
|
2019-12-20 00:45:24 +00:00
|
|
|
// ...and possibly some of the others at
|
2020-08-03 15:02:26 +00:00
|
|
|
// https://github.com/vector-im/element-web/issues/3363
|
2021-07-15 16:43:24 +00:00
|
|
|
if (room.timeline.length && room.timeline[room.timeline.length - 1].getSender() === myUserId) {
|
2019-12-20 00:45:24 +00:00
|
|
|
return false;
|
|
|
|
}
|
2017-06-26 13:28:56 +00:00
|
|
|
|
2021-12-17 07:32:10 +00:00
|
|
|
// if the read receipt relates to an event is that part of a thread
|
|
|
|
// we consider that there are no unread messages
|
|
|
|
// This might be a false negative, but probably the best we can do until
|
|
|
|
// the read receipts have evolved to cater for threads
|
|
|
|
const event = room.findEventById(readUpToId);
|
|
|
|
if (event?.getThread()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2019-12-20 00:45:24 +00:00
|
|
|
// this just looks at whatever history we have, which if we've only just started
|
|
|
|
// up probably won't be very much, so if the last couple of events are ones that
|
|
|
|
// don't count, we don't know if there are any events that do count between where
|
|
|
|
// we have and the read receipt. We could fetch more history to try & find out,
|
|
|
|
// but currently we just guess.
|
2016-01-21 13:22:13 +00:00
|
|
|
|
2019-12-20 00:45:24 +00:00
|
|
|
// Loop through messages, starting with the most recent...
|
|
|
|
for (let i = room.timeline.length - 1; i >= 0; --i) {
|
|
|
|
const ev = room.timeline[i];
|
2016-01-06 18:07:24 +00:00
|
|
|
|
2019-12-20 00:45:24 +00:00
|
|
|
if (ev.getId() == readUpToId) {
|
|
|
|
// If we've read up to this event, there's nothing more recent
|
|
|
|
// that counts and we can stop looking because the user's read
|
|
|
|
// this and everything before.
|
|
|
|
return false;
|
2020-01-03 19:32:29 +00:00
|
|
|
} else if (!shouldHideEvent(ev) && eventTriggersUnreadCount(ev)) {
|
2019-12-20 00:45:24 +00:00
|
|
|
// We've found a message that counts before we hit
|
|
|
|
// the user's read receipt, so this room is definitely unread.
|
|
|
|
return true;
|
2016-01-06 18:07:24 +00:00
|
|
|
}
|
2019-12-20 00:45:24 +00:00
|
|
|
}
|
|
|
|
// If we got here, we didn't find a message that counted but didn't find
|
|
|
|
// the user's read receipt either, so we guess and say that the room is
|
|
|
|
// unread on the theory that false positives are better than false
|
|
|
|
// negatives here.
|
|
|
|
return true;
|
|
|
|
}
|