synapse-product/synapse/replication/http/membership.py

207 lines
6.4 KiB
Python
Raw Normal View History

2018-03-13 12:32:37 -04:00
# -*- coding: utf-8 -*-
# Copyright 2018 New Vector 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.
2018-03-14 10:19:23 -04:00
import logging
from typing import TYPE_CHECKING, Optional
2018-03-14 10:19:23 -04:00
from synapse.http.servlet import parse_json_object_from_request
from synapse.replication.http._base import ReplicationEndpoint
from synapse.types import JsonDict, Requester, UserID
2018-07-09 02:09:20 -04:00
from synapse.util.distributor import user_joined_room, user_left_room
2018-03-13 12:32:37 -04:00
if TYPE_CHECKING:
from synapse.server import HomeServer
2018-03-13 12:32:37 -04:00
logger = logging.getLogger(__name__)
class ReplicationRemoteJoinRestServlet(ReplicationEndpoint):
"""Does a remote join for the given user to the given room
2018-08-08 05:29:58 -04:00
Request format:
POST /_synapse/replication/remote_join/:room_id/:user_id
{
"requester": ...,
"remote_room_hosts": [...],
"content": { ... }
}
2018-03-13 12:32:37 -04:00
"""
NAME = "remote_join"
2019-06-20 05:32:02 -04:00
PATH_ARGS = ("room_id", "user_id")
2018-03-13 12:32:37 -04:00
def __init__(self, hs):
super(ReplicationRemoteJoinRestServlet, self).__init__(hs)
2018-03-13 12:32:37 -04:00
self.federation_handler = hs.get_handlers().federation_handler
self.store = hs.get_datastore()
self.clock = hs.get_clock()
@staticmethod
2019-06-20 05:32:02 -04:00
def _serialize_payload(requester, room_id, user_id, remote_room_hosts, content):
"""
Args:
requester(Requester)
room_id (str)
user_id (str)
remote_room_hosts (list[str]): Servers to try and join via
content(dict): The event content to use for the join event
"""
return {
"requester": requester.serialize(),
"remote_room_hosts": remote_room_hosts,
"content": content,
}
async def _handle_request(self, request, room_id, user_id):
2018-03-13 12:32:37 -04:00
content = parse_json_object_from_request(request)
remote_room_hosts = content["remote_room_hosts"]
event_content = content["content"]
requester = Requester.deserialize(self.store, content["requester"])
if requester.user:
request.authenticated_entity = requester.user.to_string()
2019-06-20 05:32:02 -04:00
logger.info("remote_join: %s into room: %s", user_id, room_id)
2018-03-13 12:32:37 -04:00
event_id, stream_id = await self.federation_handler.do_invite_join(
2019-06-20 05:32:02 -04:00
remote_room_hosts, room_id, user_id, event_content
2018-03-13 12:32:37 -04:00
)
return 200, {"event_id": event_id, "stream_id": stream_id}
2018-03-13 12:32:37 -04:00
class ReplicationRemoteRejectInviteRestServlet(ReplicationEndpoint):
"""Rejects an out-of-band invite we have received from a remote server
2018-08-08 05:29:58 -04:00
Request format:
POST /_synapse/replication/remote_reject_invite/:event_id
2018-08-08 05:29:58 -04:00
{
"txn_id": ...,
2018-08-08 05:29:58 -04:00
"requester": ...,
"content": { ... }
2018-08-08 05:29:58 -04:00
}
"""
NAME = "remote_reject_invite"
PATH_ARGS = ("invite_event_id",)
2018-03-13 12:32:37 -04:00
def __init__(self, hs: "HomeServer"):
super(ReplicationRemoteRejectInviteRestServlet, self).__init__(hs)
2018-03-13 12:32:37 -04:00
self.store = hs.get_datastore()
self.clock = hs.get_clock()
self.member_handler = hs.get_room_member_handler()
2018-03-13 12:32:37 -04:00
@staticmethod
def _serialize_payload( # type: ignore
invite_event_id: str,
txn_id: Optional[str],
requester: Requester,
content: JsonDict,
):
"""
Args:
invite_event_id: ID of the invite to be rejected
txn_id: optional transaction ID supplied by the client
requester: user making the rejection request, according to the access token
content: additional content to include in the rejection event.
Normally an empty dict.
"""
return {
"txn_id": txn_id,
"requester": requester.serialize(),
"content": content,
}
async def _handle_request(self, request, invite_event_id):
2018-03-13 12:32:37 -04:00
content = parse_json_object_from_request(request)
txn_id = content["txn_id"]
event_content = content["content"]
2018-03-13 12:32:37 -04:00
requester = Requester.deserialize(self.store, content["requester"])
if requester.user:
request.authenticated_entity = requester.user.to_string()
# hopefully we're now on the master, so this won't recurse!
event_id, stream_id = await self.member_handler.remote_reject_invite(
invite_event_id, txn_id, requester, event_content,
)
2018-03-13 12:32:37 -04:00
return 200, {"event_id": event_id, "stream_id": stream_id}
2018-03-13 12:32:37 -04:00
class ReplicationUserJoinedLeftRoomRestServlet(ReplicationEndpoint):
"""Notifies that a user has joined or left the room
2018-08-08 05:29:58 -04:00
Request format:
POST /_synapse/replication/membership_change/:room_id/:user_id/:change
{}
"""
NAME = "membership_change"
PATH_ARGS = ("room_id", "user_id", "change")
CACHE = False # No point caching as should return instantly.
2018-03-13 12:32:37 -04:00
def __init__(self, hs):
super(ReplicationUserJoinedLeftRoomRestServlet, self).__init__(hs)
2018-03-13 12:32:37 -04:00
self.registeration_handler = hs.get_registration_handler()
2018-03-13 12:32:37 -04:00
self.store = hs.get_datastore()
self.clock = hs.get_clock()
self.distributor = hs.get_distributor()
@staticmethod
def _serialize_payload(room_id, user_id, change):
"""
Args:
room_id (str)
user_id (str)
change (str): Either "joined" or "left"
"""
2019-06-20 05:32:02 -04:00
assert change in ("joined", "left")
2018-03-13 12:32:37 -04:00
return {}
2018-03-13 12:32:37 -04:00
def _handle_request(self, request, room_id, user_id, change):
2018-03-13 12:32:37 -04:00
logger.info("user membership change: %s in %s", user_id, room_id)
user = UserID.from_string(user_id)
if change == "joined":
2018-03-13 12:32:37 -04:00
user_joined_room(self.distributor, user, room_id)
elif change == "left":
user_left_room(self.distributor, user, room_id)
else:
raise Exception("Unrecognized change: %r", change)
return 200, {}
2018-03-13 12:32:37 -04:00
def register_servlets(hs, http_server):
ReplicationRemoteJoinRestServlet(hs).register(http_server)
ReplicationRemoteRejectInviteRestServlet(hs).register(http_server)
ReplicationUserJoinedLeftRoomRestServlet(hs).register(http_server)