2017-04-11 10:55:30 +00:00
|
|
|
#
|
2023-11-21 20:29:58 +00:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 11:26:48 +00:00
|
|
|
# Copyright 2017 Vector Creations Ltd
|
2023-11-21 20:29:58 +00:00
|
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# See the GNU Affero General Public License for more details:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2017-04-11 10:55:30 +00:00
|
|
|
#
|
|
|
|
#
|
|
|
|
|
2018-07-09 06:09:20 +00:00
|
|
|
import logging
|
2020-10-09 11:20:51 +00:00
|
|
|
from typing import TYPE_CHECKING
|
2017-04-11 10:55:30 +00:00
|
|
|
|
2023-05-09 11:23:27 +00:00
|
|
|
from synapse.api.constants import ReceiptTypes
|
2023-05-18 18:37:31 +00:00
|
|
|
from synapse.api.errors import SynapseError
|
2018-08-10 13:50:21 +00:00
|
|
|
from synapse.util.async_helpers import Linearizer
|
2017-04-11 10:55:30 +00:00
|
|
|
|
2020-10-09 11:20:51 +00:00
|
|
|
if TYPE_CHECKING:
|
2021-03-23 11:12:48 +00:00
|
|
|
from synapse.server import HomeServer
|
2020-10-09 11:20:51 +00:00
|
|
|
|
2017-04-11 10:55:30 +00:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
2017-04-11 16:07:07 +00:00
|
|
|
|
2021-10-08 11:44:43 +00:00
|
|
|
class ReadMarkerHandler:
|
2020-10-09 11:20:51 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2022-02-23 11:04:02 +00:00
|
|
|
self.store = hs.get_datastores().main
|
2021-01-18 15:47:59 +00:00
|
|
|
self.account_data_handler = hs.get_account_data_handler()
|
2017-04-11 14:01:39 +00:00
|
|
|
self.read_marker_linearizer = Linearizer(name="read_marker")
|
2017-04-11 10:55:30 +00:00
|
|
|
|
2020-10-09 11:20:51 +00:00
|
|
|
async def received_client_read_marker(
|
|
|
|
self, room_id: str, user_id: str, event_id: str
|
|
|
|
) -> None:
|
2017-04-11 14:01:39 +00:00
|
|
|
"""Updates the read marker for a given user in a given room if the event ID given
|
|
|
|
is ahead in the stream relative to the current read marker.
|
2017-04-11 10:55:30 +00:00
|
|
|
|
2017-04-11 14:01:39 +00:00
|
|
|
This uses a notifier to indicate that account data should be sent down /sync if
|
|
|
|
the read marker has changed.
|
|
|
|
"""
|
2017-04-11 10:55:30 +00:00
|
|
|
|
2022-04-05 14:43:52 +00:00
|
|
|
async with self.read_marker_linearizer.queue((room_id, user_id)):
|
2019-10-29 15:08:22 +00:00
|
|
|
existing_read_marker = await self.store.get_account_data_for_room_and_type(
|
2023-05-09 11:23:27 +00:00
|
|
|
user_id, room_id, ReceiptTypes.FULLY_READ
|
2018-03-01 15:53:04 +00:00
|
|
|
)
|
2017-04-11 10:55:30 +00:00
|
|
|
|
2017-04-11 14:01:39 +00:00
|
|
|
should_update = True
|
2023-05-18 18:37:31 +00:00
|
|
|
# Get event ordering, this also ensures we know about the event
|
2024-03-21 18:43:07 +00:00
|
|
|
event_ordering = await self.store.get_event_ordering(event_id, room_id)
|
2017-04-11 10:55:30 +00:00
|
|
|
|
2017-04-11 14:01:39 +00:00
|
|
|
if existing_read_marker:
|
2023-05-18 18:37:31 +00:00
|
|
|
try:
|
|
|
|
old_event_ordering = await self.store.get_event_ordering(
|
2024-03-21 18:43:07 +00:00
|
|
|
existing_read_marker["event_id"], room_id
|
2023-05-18 18:37:31 +00:00
|
|
|
)
|
|
|
|
except SynapseError:
|
|
|
|
# Old event no longer exists, assume new is ahead. This may
|
|
|
|
# happen if the old event was removed due to retention.
|
|
|
|
pass
|
|
|
|
else:
|
|
|
|
# Only update if the new marker is ahead in the stream
|
|
|
|
should_update = event_ordering > old_event_ordering
|
2017-04-11 14:01:39 +00:00
|
|
|
|
|
|
|
if should_update:
|
2017-04-18 16:46:15 +00:00
|
|
|
content = {"event_id": event_id}
|
2021-01-18 15:47:59 +00:00
|
|
|
await self.account_data_handler.add_account_data_to_room(
|
2023-05-09 11:23:27 +00:00
|
|
|
user_id, room_id, ReceiptTypes.FULLY_READ, content
|
2017-04-11 14:01:39 +00:00
|
|
|
)
|