160 lines
5.3 KiB
Python
160 lines
5.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
|
#
|
|
# 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.
|
|
import logging
|
|
|
|
from synapse.handlers._base import BaseHandler
|
|
from synapse.types import ReadReceipt, get_domain_from_id
|
|
from synapse.util.async_helpers import maybe_awaitable
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class ReceiptsHandler(BaseHandler):
|
|
def __init__(self, hs):
|
|
super(ReceiptsHandler, self).__init__(hs)
|
|
|
|
self.server_name = hs.config.server_name
|
|
self.store = hs.get_datastore()
|
|
self.hs = hs
|
|
self.federation = hs.get_federation_sender()
|
|
hs.get_federation_registry().register_edu_handler(
|
|
"m.receipt", self._received_remote_receipt
|
|
)
|
|
self.clock = self.hs.get_clock()
|
|
self.state = hs.get_state_handler()
|
|
|
|
async def _received_remote_receipt(self, origin, content):
|
|
"""Called when we receive an EDU of type m.receipt from a remote HS.
|
|
"""
|
|
receipts = []
|
|
for room_id, room_values in content.items():
|
|
for receipt_type, users in room_values.items():
|
|
for user_id, user_values in users.items():
|
|
if get_domain_from_id(user_id) != origin:
|
|
logger.info(
|
|
"Received receipt for user %r from server %s, ignoring",
|
|
user_id,
|
|
origin,
|
|
)
|
|
continue
|
|
|
|
receipts.append(
|
|
ReadReceipt(
|
|
room_id=room_id,
|
|
receipt_type=receipt_type,
|
|
user_id=user_id,
|
|
event_ids=user_values["event_ids"],
|
|
data=user_values.get("data", {}),
|
|
)
|
|
)
|
|
|
|
await self._handle_new_receipts(receipts)
|
|
|
|
async def _handle_new_receipts(self, receipts):
|
|
"""Takes a list of receipts, stores them and informs the notifier.
|
|
"""
|
|
min_batch_id = None
|
|
max_batch_id = None
|
|
|
|
for receipt in receipts:
|
|
res = await self.store.insert_receipt(
|
|
receipt.room_id,
|
|
receipt.receipt_type,
|
|
receipt.user_id,
|
|
receipt.event_ids,
|
|
receipt.data,
|
|
)
|
|
|
|
if not res:
|
|
# res will be None if this read receipt is 'old'
|
|
continue
|
|
|
|
stream_id, max_persisted_id = res
|
|
|
|
if min_batch_id is None or stream_id < min_batch_id:
|
|
min_batch_id = stream_id
|
|
if max_batch_id is None or max_persisted_id > max_batch_id:
|
|
max_batch_id = max_persisted_id
|
|
|
|
if min_batch_id is None:
|
|
# no new receipts
|
|
return False
|
|
|
|
affected_room_ids = list({r.room_id for r in receipts})
|
|
|
|
self.notifier.on_new_event("receipt_key", max_batch_id, rooms=affected_room_ids)
|
|
# Note that the min here shouldn't be relied upon to be accurate.
|
|
await maybe_awaitable(
|
|
self.hs.get_pusherpool().on_new_receipts(
|
|
min_batch_id, max_batch_id, affected_room_ids
|
|
)
|
|
)
|
|
|
|
return True
|
|
|
|
async def received_client_receipt(self, room_id, receipt_type, user_id, event_id):
|
|
"""Called when a client tells us a local user has read up to the given
|
|
event_id in the room.
|
|
"""
|
|
receipt = ReadReceipt(
|
|
room_id=room_id,
|
|
receipt_type=receipt_type,
|
|
user_id=user_id,
|
|
event_ids=[event_id],
|
|
data={"ts": int(self.clock.time_msec())},
|
|
)
|
|
|
|
is_new = await self._handle_new_receipts([receipt])
|
|
if not is_new:
|
|
return
|
|
|
|
await self.federation.send_read_receipt(receipt)
|
|
|
|
|
|
class ReceiptEventSource(object):
|
|
def __init__(self, hs):
|
|
self.store = hs.get_datastore()
|
|
|
|
async def get_new_events(self, from_key, room_ids, **kwargs):
|
|
from_key = int(from_key)
|
|
to_key = self.get_current_key()
|
|
|
|
if from_key == to_key:
|
|
return [], to_key
|
|
|
|
events = await self.store.get_linearized_receipts_for_rooms(
|
|
room_ids, from_key=from_key, to_key=to_key
|
|
)
|
|
|
|
return (events, to_key)
|
|
|
|
def get_current_key(self, direction="f"):
|
|
return self.store.get_max_receipt_stream_id()
|
|
|
|
async def get_pagination_rows(self, user, config, key):
|
|
to_key = int(config.from_key)
|
|
|
|
if config.to_key:
|
|
from_key = int(config.to_key)
|
|
else:
|
|
from_key = None
|
|
|
|
room_ids = await self.store.get_rooms_for_user(user.to_string())
|
|
events = await self.store.get_linearized_receipts_for_rooms(
|
|
room_ids, from_key=from_key, to_key=to_key
|
|
)
|
|
|
|
return (events, to_key)
|