mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-16 14:23:51 +01:00
Finish implementing RM endpoint
- This change causes a 405 to be sent if "m.read_marker" is set via /account_data - This also fixes-up the RM endpoint so that it actually Works.
This commit is contained in:
parent
e263c26690
commit
d892079844
5 changed files with 65 additions and 46 deletions
|
@ -18,65 +18,74 @@ from ._base import BaseHandler
|
||||||
from twisted.internet import defer
|
from twisted.internet import defer
|
||||||
|
|
||||||
from synapse.util.logcontext import PreserveLoggingContext
|
from synapse.util.logcontext import PreserveLoggingContext
|
||||||
|
from synapse.util.async import Linearizer
|
||||||
from synapse.types import get_domain_from_id
|
from synapse.types import get_domain_from_id
|
||||||
|
from synapse.api.errors import SynapseError
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class ReadMarkerHandler(BaseHandler):
|
class ReadMarkerHandler(BaseHandler):
|
||||||
def __init__(self, hs):
|
def __init__(self, hs):
|
||||||
super(ReadMarkerHandler, self).__init__(hs)
|
super(ReadMarkerHandler, self).__init__(hs)
|
||||||
|
|
||||||
self.server_name = hs.config.server_name
|
self.server_name = hs.config.server_name
|
||||||
self.store = hs.get_datastore()
|
self.store = hs.get_datastore()
|
||||||
|
self.read_marker_linearizer = Linearizer(name="read_marker")
|
||||||
|
self.notifier = hs.get_notifier()
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def received_client_read_marker(self, room_id, user_id, event_id):
|
def received_client_read_marker(self, room_id, user_id, event_id):
|
||||||
"""NEEDS DOC
|
"""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.
|
||||||
|
|
||||||
|
This uses a notifier to indicate that account data should be sent down /sync if
|
||||||
|
the read marker has changed.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
room_id = read_marker["room_id"]
|
|
||||||
user_id = read_marker["user_id"]
|
|
||||||
event_id = read_marker["event_id"]
|
|
||||||
|
|
||||||
# Get ordering for existing read marker
|
# Get ordering for existing read marker
|
||||||
|
with (yield self.read_marker_linearizer.queue(room_id + "_" + user_id)):
|
||||||
account_data = yield self.store.get_account_data_for_room(user_id, room_id)
|
account_data = yield self.store.get_account_data_for_room(user_id, room_id)
|
||||||
existing_read_marker = account_data["m.read_marker"]
|
existing_read_marker = account_data["m.read_marker"]
|
||||||
|
|
||||||
if existing_read_marker:
|
should_update = True
|
||||||
# Get ordering for new read marker
|
|
||||||
res = self.store._simple_select_one_txn(
|
res = yield self.store._simple_select_one(
|
||||||
txn,
|
|
||||||
table="events",
|
table="events",
|
||||||
retcols=["topological_ordering", "stream_ordering"],
|
retcols=["topological_ordering", "stream_ordering"],
|
||||||
keyvalues={"event_id": event_id},
|
keyvalues={"event_id": event_id},
|
||||||
allow_none=True
|
allow_none=True
|
||||||
)
|
)
|
||||||
new_to = int(res["topological_ordering"]) if res else None
|
|
||||||
new_so = int(res["stream_ordering"]) if res else None
|
|
||||||
|
|
||||||
res = self.store._simple_select_one_txn(
|
if not res:
|
||||||
txn,
|
raise SynapseError(404, 'Event does not exist')
|
||||||
|
|
||||||
|
if existing_read_marker:
|
||||||
|
new_to = int(res["topological_ordering"])
|
||||||
|
new_so = int(res["stream_ordering"])
|
||||||
|
|
||||||
|
# Get ordering for existing read marker
|
||||||
|
res = yield self.store._simple_select_one(
|
||||||
table="events",
|
table="events",
|
||||||
retcols=["topological_ordering", "stream_ordering"],
|
retcols=["topological_ordering", "stream_ordering"],
|
||||||
keyvalues={"event_id": existing_read_marker.content.marker},
|
keyvalues={"event_id": existing_read_marker['marker']},
|
||||||
allow_none=True
|
allow_none=True
|
||||||
)
|
)
|
||||||
existing_to = int(res["topological_ordering"]) if res else None
|
existing_to = int(res["topological_ordering"]) if res else None
|
||||||
existing_so = int(res["stream_ordering"]) if res else None
|
existing_so = int(res["stream_ordering"]) if res else None
|
||||||
|
|
||||||
if new_to > existing_to:
|
# Prevent updating if the existing marker is ahead in the stream
|
||||||
return False
|
if existing_to > new_to:
|
||||||
elif new_to == existing_to and new_so >= existing_so:
|
should_update = False
|
||||||
return False
|
elif existing_to == new_to and existing_so >= new_so:
|
||||||
|
should_update = False
|
||||||
|
|
||||||
# Update account data
|
if should_update:
|
||||||
content = {
|
content = {
|
||||||
"marker": event_id
|
"marker": event_id
|
||||||
}
|
}
|
||||||
yield self.store.add_account_data_to_room(
|
max_id = yield self.store.add_account_data_to_room(
|
||||||
user_id, room_id, "m.read_marker", content
|
user_id, room_id, "m.read_marker", content
|
||||||
)
|
)
|
||||||
|
self.notifier.on_new_event(
|
||||||
|
"account_data_key", max_id, users=[user_id], rooms=[room_id]
|
||||||
|
)
|
||||||
|
|
|
@ -40,6 +40,7 @@ from synapse.rest.client.v2_alpha import (
|
||||||
register,
|
register,
|
||||||
auth,
|
auth,
|
||||||
receipts,
|
receipts,
|
||||||
|
read_marker,
|
||||||
keys,
|
keys,
|
||||||
tokenrefresh,
|
tokenrefresh,
|
||||||
tags,
|
tags,
|
||||||
|
@ -88,6 +89,7 @@ class ClientRestResource(JsonResource):
|
||||||
register.register_servlets(hs, client_resource)
|
register.register_servlets(hs, client_resource)
|
||||||
auth.register_servlets(hs, client_resource)
|
auth.register_servlets(hs, client_resource)
|
||||||
receipts.register_servlets(hs, client_resource)
|
receipts.register_servlets(hs, client_resource)
|
||||||
|
read_marker.register_servlets(hs, client_resource)
|
||||||
keys.register_servlets(hs, client_resource)
|
keys.register_servlets(hs, client_resource)
|
||||||
tokenrefresh.register_servlets(hs, client_resource)
|
tokenrefresh.register_servlets(hs, client_resource)
|
||||||
tags.register_servlets(hs, client_resource)
|
tags.register_servlets(hs, client_resource)
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
from ._base import client_v2_patterns
|
from ._base import client_v2_patterns
|
||||||
|
|
||||||
from synapse.http.servlet import RestServlet, parse_json_object_from_request
|
from synapse.http.servlet import RestServlet, parse_json_object_from_request
|
||||||
from synapse.api.errors import AuthError
|
from synapse.api.errors import AuthError, SynapseError
|
||||||
|
|
||||||
from twisted.internet import defer
|
from twisted.internet import defer
|
||||||
|
|
||||||
|
@ -82,6 +82,12 @@ class RoomAccountDataServlet(RestServlet):
|
||||||
|
|
||||||
body = parse_json_object_from_request(request)
|
body = parse_json_object_from_request(request)
|
||||||
|
|
||||||
|
if account_data_type == "m.read_marker":
|
||||||
|
raise SynapseError(405,
|
||||||
|
"Cannot set m.read_marker through this API. "
|
||||||
|
"Use /rooms/!roomId:server.name/read_marker"
|
||||||
|
)
|
||||||
|
|
||||||
max_id = yield self.store.add_account_data_to_room(
|
max_id = yield self.store.add_account_data_to_room(
|
||||||
user_id, room_id, account_data_type, body
|
user_id, room_id, account_data_type, body
|
||||||
)
|
)
|
||||||
|
|
|
@ -25,14 +25,11 @@ import logging
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class ReceiptRestServlet(RestServlet):
|
class ReadMarkerRestServlet(RestServlet):
|
||||||
PATTERNS = client_v2_patterns(
|
PATTERNS = client_v2_patterns("/rooms/(?P<room_id>[^/]*)/read_marker$")
|
||||||
"/rooms/(?P<room_id>[^/]*)"
|
|
||||||
"/read_marker$"
|
|
||||||
)
|
|
||||||
|
|
||||||
def __init__(self, hs):
|
def __init__(self, hs):
|
||||||
super(ReceiptRestServlet, self).__init__()
|
super(ReadMarkerRestServlet, self).__init__()
|
||||||
self.hs = hs
|
self.hs = hs
|
||||||
self.auth = hs.get_auth()
|
self.auth = hs.get_auth()
|
||||||
self.receipts_handler = hs.get_receipts_handler()
|
self.receipts_handler = hs.get_receipts_handler()
|
||||||
|
@ -40,7 +37,7 @@ class ReceiptRestServlet(RestServlet):
|
||||||
self.presence_handler = hs.get_presence_handler()
|
self.presence_handler = hs.get_presence_handler()
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def on_POST(self, request, room_id, receipt_type, event_id):
|
def on_POST(self, request, room_id):
|
||||||
requester = yield self.auth.get_user_by_req(request)
|
requester = yield self.auth.get_user_by_req(request)
|
||||||
|
|
||||||
yield self.presence_handler.bump_presence_active_time(requester.user)
|
yield self.presence_handler.bump_presence_active_time(requester.user)
|
||||||
|
@ -68,4 +65,4 @@ class ReceiptRestServlet(RestServlet):
|
||||||
|
|
||||||
|
|
||||||
def register_servlets(hs, http_server):
|
def register_servlets(hs, http_server):
|
||||||
ReceiptRestServlet(hs).register(http_server)
|
ReadMarkerRestServlet(hs).register(http_server)
|
||||||
|
|
|
@ -48,6 +48,7 @@ from synapse.handlers.typing import TypingHandler
|
||||||
from synapse.handlers.events import EventHandler, EventStreamHandler
|
from synapse.handlers.events import EventHandler, EventStreamHandler
|
||||||
from synapse.handlers.initial_sync import InitialSyncHandler
|
from synapse.handlers.initial_sync import InitialSyncHandler
|
||||||
from synapse.handlers.receipts import ReceiptsHandler
|
from synapse.handlers.receipts import ReceiptsHandler
|
||||||
|
from synapse.handlers.read_marker import ReadMarkerHandler
|
||||||
from synapse.http.client import SimpleHttpClient, InsecureInterceptableContextFactory
|
from synapse.http.client import SimpleHttpClient, InsecureInterceptableContextFactory
|
||||||
from synapse.http.matrixfederationclient import MatrixFederationHttpClient
|
from synapse.http.matrixfederationclient import MatrixFederationHttpClient
|
||||||
from synapse.notifier import Notifier
|
from synapse.notifier import Notifier
|
||||||
|
@ -133,6 +134,7 @@ class HomeServer(object):
|
||||||
'receipts_handler',
|
'receipts_handler',
|
||||||
'macaroon_generator',
|
'macaroon_generator',
|
||||||
'tcp_replication',
|
'tcp_replication',
|
||||||
|
'read_marker_handler',
|
||||||
]
|
]
|
||||||
|
|
||||||
def __init__(self, hostname, **kwargs):
|
def __init__(self, hostname, **kwargs):
|
||||||
|
@ -291,6 +293,9 @@ class HomeServer(object):
|
||||||
def build_receipts_handler(self):
|
def build_receipts_handler(self):
|
||||||
return ReceiptsHandler(self)
|
return ReceiptsHandler(self)
|
||||||
|
|
||||||
|
def build_read_marker_handler(self):
|
||||||
|
return ReadMarkerHandler(self)
|
||||||
|
|
||||||
def build_tcp_replication(self):
|
def build_tcp_replication(self):
|
||||||
raise NotImplementedError()
|
raise NotImplementedError()
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue