2016-01-07 04:26:29 +00:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2018-02-06 16:40:38 +00:00
|
|
|
# Copyright 2018 New Vector Ltd
|
2014-08-12 14:10:52 +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.
|
2014-08-13 02:14:34 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
""" This module contains REST servlets to do with rooms: /rooms/<paths> """
|
2018-07-09 06:09:20 +00:00
|
|
|
import logging
|
2020-02-19 10:40:27 +00:00
|
|
|
import re
|
2021-06-09 18:39:51 +00:00
|
|
|
from typing import TYPE_CHECKING, Dict, List, Optional, Tuple
|
2020-06-16 12:51:47 +00:00
|
|
|
from urllib import parse as urlparse
|
2018-07-09 06:09:20 +00:00
|
|
|
|
2021-06-22 09:02:53 +00:00
|
|
|
from synapse.api.constants import EventContentFields, EventTypes, Membership
|
2019-07-11 10:06:23 +00:00
|
|
|
from synapse.api.errors import (
|
|
|
|
AuthError,
|
|
|
|
Codes,
|
2020-04-06 11:35:30 +00:00
|
|
|
HttpResponseException,
|
2019-07-11 10:06:23 +00:00
|
|
|
InvalidClientCredentialsError,
|
2020-08-20 19:07:42 +00:00
|
|
|
ShadowBanError,
|
2019-07-11 10:06:23 +00:00
|
|
|
SynapseError,
|
|
|
|
)
|
2016-07-14 14:59:25 +00:00
|
|
|
from synapse.api.filtering import Filter
|
2021-07-13 19:12:33 +00:00
|
|
|
from synapse.appservice import ApplicationService
|
2019-05-09 12:21:57 +00:00
|
|
|
from synapse.events.utils import format_event_for_client_v2
|
2016-09-15 09:15:37 +00:00
|
|
|
from synapse.http.servlet import (
|
2019-06-03 11:28:59 +00:00
|
|
|
RestServlet,
|
2018-07-13 19:53:01 +00:00
|
|
|
assert_params_in_dict,
|
2021-03-18 18:24:16 +00:00
|
|
|
parse_boolean,
|
2018-07-09 06:09:20 +00:00
|
|
|
parse_integer,
|
|
|
|
parse_json_object_from_request,
|
|
|
|
parse_string,
|
2021-06-09 18:39:51 +00:00
|
|
|
parse_strings_from_args,
|
2016-09-15 09:15:37 +00:00
|
|
|
)
|
2021-03-19 12:20:11 +00:00
|
|
|
from synapse.http.site import SynapseRequest
|
2019-09-25 10:59:05 +00:00
|
|
|
from synapse.logging.opentracing import set_tag
|
2019-06-03 11:28:59 +00:00
|
|
|
from synapse.rest.client.transactions import HttpTransactionCache
|
|
|
|
from synapse.rest.client.v2_alpha._base import client_patterns
|
2018-10-25 16:49:55 +00:00
|
|
|
from synapse.storage.state import StateFilter
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.streams.config import PaginationConfig
|
2021-03-18 18:24:16 +00:00
|
|
|
from synapse.types import (
|
|
|
|
JsonDict,
|
2021-07-13 19:12:33 +00:00
|
|
|
Requester,
|
2021-03-18 18:24:16 +00:00
|
|
|
RoomAlias,
|
|
|
|
RoomID,
|
|
|
|
StreamToken,
|
|
|
|
ThirdPartyInstanceID,
|
|
|
|
UserID,
|
2021-07-13 19:12:33 +00:00
|
|
|
create_requester,
|
2021-03-18 18:24:16 +00:00
|
|
|
)
|
2020-08-19 11:26:03 +00:00
|
|
|
from synapse.util import json_decoder
|
2021-01-20 13:15:14 +00:00
|
|
|
from synapse.util.stringutils import parse_and_validate_server_name, random_string
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2020-11-17 14:09:40 +00:00
|
|
|
if TYPE_CHECKING:
|
2021-03-23 11:12:48 +00:00
|
|
|
from synapse.server import HomeServer
|
2020-02-18 16:23:25 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class TransactionRestServlet(RestServlet):
|
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.txns = HttpTransactionCache(hs)
|
|
|
|
|
|
|
|
|
|
|
|
class RoomCreateRestServlet(TransactionRestServlet):
|
2014-08-12 14:10:52 +00:00
|
|
|
# No PATTERN; we have custom dispatch rules here
|
|
|
|
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__(hs)
|
2018-05-17 08:01:09 +00:00
|
|
|
self._room_creation_handler = hs.get_room_creation_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
def register(self, http_server):
|
2015-12-01 17:34:32 +00:00
|
|
|
PATTERNS = "/createRoom"
|
|
|
|
register_txn_path(self, PATTERNS, http_server)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2014-08-27 10:33:56 +00:00
|
|
|
def on_PUT(self, request, txn_id):
|
2019-09-25 10:39:15 +00:00
|
|
|
set_tag("txn_id", txn_id)
|
2016-11-14 09:52:41 +00:00
|
|
|
return self.txns.fetch_or_execute_request(request, self.on_POST, request)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_POST(self, request):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2020-05-22 13:21:54 +00:00
|
|
|
info, _ = await self._room_creation_handler.create_room(
|
2016-02-15 18:13:10 +00:00
|
|
|
requester, self.get_room_config(request)
|
2014-08-12 14:10:52 +00:00
|
|
|
)
|
2016-02-15 18:13:10 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, info
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
def get_room_config(self, request):
|
2016-03-11 16:41:03 +00:00
|
|
|
user_supplied_config = parse_json_object_from_request(request)
|
|
|
|
return user_supplied_config
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
2014-08-26 16:54:18 +00:00
|
|
|
# TODO: Needs unit testing for generic events
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomStateEventRestServlet(TransactionRestServlet):
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__(hs)
|
2019-01-18 15:27:11 +00:00
|
|
|
self.event_creation_handler = hs.get_event_creation_handler()
|
2018-03-01 10:54:37 +00:00
|
|
|
self.room_member_handler = hs.get_room_member_handler()
|
2018-07-18 14:22:02 +00:00
|
|
|
self.message_handler = hs.get_message_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2014-08-22 14:59:15 +00:00
|
|
|
def register(self, http_server):
|
|
|
|
# /room/$roomid/state/$eventtype
|
|
|
|
no_state_key = "/rooms/(?P<room_id>[^/]*)/state/(?P<event_type>[^/]*)$"
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2014-08-22 14:59:15 +00:00
|
|
|
# /room/$roomid/state/$eventtype/$statekey
|
2014-10-30 11:10:17 +00:00
|
|
|
state_key = (
|
|
|
|
"/rooms/(?P<room_id>[^/]*)/state/"
|
|
|
|
"(?P<event_type>[^/]*)/(?P<state_key>[^/]*)$"
|
|
|
|
)
|
2019-06-20 09:32:02 +00:00
|
|
|
|
2015-12-01 17:34:32 +00:00
|
|
|
http_server.register_paths(
|
2019-07-24 12:07:35 +00:00
|
|
|
"GET",
|
|
|
|
client_patterns(state_key, v1=True),
|
|
|
|
self.on_GET,
|
|
|
|
self.__class__.__name__,
|
2015-12-01 17:34:32 +00:00
|
|
|
)
|
|
|
|
http_server.register_paths(
|
2019-07-24 12:07:35 +00:00
|
|
|
"PUT",
|
|
|
|
client_patterns(state_key, v1=True),
|
|
|
|
self.on_PUT,
|
|
|
|
self.__class__.__name__,
|
2015-12-01 17:34:32 +00:00
|
|
|
)
|
|
|
|
http_server.register_paths(
|
2019-07-24 12:07:35 +00:00
|
|
|
"GET",
|
|
|
|
client_patterns(no_state_key, v1=True),
|
|
|
|
self.on_GET_no_state_key,
|
|
|
|
self.__class__.__name__,
|
2015-12-01 17:34:32 +00:00
|
|
|
)
|
|
|
|
http_server.register_paths(
|
2019-07-24 12:07:35 +00:00
|
|
|
"PUT",
|
|
|
|
client_patterns(no_state_key, v1=True),
|
|
|
|
self.on_PUT_no_state_key,
|
|
|
|
self.__class__.__name__,
|
2015-12-01 17:34:32 +00:00
|
|
|
)
|
2014-08-22 14:59:15 +00:00
|
|
|
|
|
|
|
def on_GET_no_state_key(self, request, room_id, event_type):
|
2014-12-10 14:49:52 +00:00
|
|
|
return self.on_GET(request, room_id, event_type, "")
|
2014-08-22 14:59:15 +00:00
|
|
|
|
|
|
|
def on_PUT_no_state_key(self, request, room_id, event_type):
|
2014-12-10 14:49:52 +00:00
|
|
|
return self.on_PUT(request, room_id, event_type, "")
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request, room_id, event_type, state_key):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2016-09-09 13:34:29 +00:00
|
|
|
format = parse_string(
|
|
|
|
request, "format", default="content", allowed_values=["content", "event"]
|
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2018-07-18 14:22:02 +00:00
|
|
|
msg_handler = self.message_handler
|
2019-10-29 13:09:24 +00:00
|
|
|
data = await msg_handler.get_room_data(
|
2016-01-11 15:29:57 +00:00
|
|
|
user_id=requester.user.to_string(),
|
2014-12-12 15:05:37 +00:00
|
|
|
room_id=room_id,
|
|
|
|
event_type=event_type,
|
|
|
|
state_key=state_key,
|
2014-08-12 14:10:52 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
if not data:
|
2014-10-30 11:10:17 +00:00
|
|
|
raise SynapseError(404, "Event not found.", errcode=Codes.NOT_FOUND)
|
2016-09-09 13:34:29 +00:00
|
|
|
|
|
|
|
if format == "event":
|
2016-09-09 13:40:15 +00:00
|
|
|
event = format_event_for_client_v2(data.get_dict())
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, event
|
2016-09-09 13:34:29 +00:00
|
|
|
elif format == "content":
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, data.get_dict()["content"]
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_PUT(self, request, room_id, event_type, state_key, txn_id=None):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-09-25 10:39:15 +00:00
|
|
|
if txn_id:
|
|
|
|
set_tag("txn_id", txn_id)
|
|
|
|
|
2016-03-09 11:26:26 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2014-12-10 14:02:48 +00:00
|
|
|
event_dict = {
|
|
|
|
"type": event_type,
|
|
|
|
"content": content,
|
2014-12-12 15:05:37 +00:00
|
|
|
"room_id": room_id,
|
2016-01-11 15:29:57 +00:00
|
|
|
"sender": requester.user.to_string(),
|
2014-12-10 14:02:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if state_key is not None:
|
2014-12-12 15:05:37 +00:00
|
|
|
event_dict["state_key"] = state_key
|
2014-12-10 14:02:48 +00:00
|
|
|
|
2020-08-24 17:58:56 +00:00
|
|
|
try:
|
|
|
|
if event_type == EventTypes.Member:
|
2020-08-20 19:07:42 +00:00
|
|
|
membership = content.get("membership", None)
|
|
|
|
event_id, _ = await self.room_member_handler.update_membership(
|
|
|
|
requester,
|
|
|
|
target=UserID.from_string(state_key),
|
|
|
|
room_id=room_id,
|
|
|
|
action=membership,
|
|
|
|
content=content,
|
|
|
|
)
|
2020-08-24 17:58:56 +00:00
|
|
|
else:
|
|
|
|
(
|
|
|
|
event,
|
|
|
|
_,
|
|
|
|
) = await self.event_creation_handler.create_and_send_nonmember_event(
|
|
|
|
requester, event_dict, txn_id=txn_id
|
|
|
|
)
|
|
|
|
event_id = event.event_id
|
|
|
|
except ShadowBanError:
|
|
|
|
event_id = "$" + random_string(43)
|
2017-01-09 18:25:13 +00:00
|
|
|
|
2020-07-09 12:01:42 +00:00
|
|
|
set_tag("event_id", event_id)
|
|
|
|
ret = {"event_id": event_id}
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, ret
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
2014-08-26 16:54:18 +00:00
|
|
|
# TODO: Needs unit testing for generic events + feedback
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomSendEventRestServlet(TransactionRestServlet):
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__(hs)
|
2019-01-18 15:27:11 +00:00
|
|
|
self.event_creation_handler = hs.get_event_creation_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2014-08-26 16:00:24 +00:00
|
|
|
def register(self, http_server):
|
|
|
|
# /rooms/$roomid/send/$event_type[/$txn_id]
|
2015-12-01 17:34:32 +00:00
|
|
|
PATTERNS = "/rooms/(?P<room_id>[^/]*)/send/(?P<event_type>[^/]*)"
|
|
|
|
register_txn_path(self, PATTERNS, http_server, with_get=True)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_POST(self, request, room_id, event_type, txn_id=None):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2016-03-09 11:26:26 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2018-01-23 08:59:06 +00:00
|
|
|
event_dict = {
|
|
|
|
"type": event_type,
|
|
|
|
"content": content,
|
|
|
|
"room_id": room_id,
|
|
|
|
"sender": requester.user.to_string(),
|
|
|
|
}
|
|
|
|
|
2018-09-12 10:41:31 +00:00
|
|
|
if b"ts" in request.args and requester.app_service:
|
2018-01-23 08:59:06 +00:00
|
|
|
event_dict["origin_server_ts"] = parse_integer(request, "ts", 0)
|
|
|
|
|
2020-08-24 17:58:56 +00:00
|
|
|
try:
|
|
|
|
(
|
|
|
|
event,
|
|
|
|
_,
|
|
|
|
) = await self.event_creation_handler.create_and_send_nonmember_event(
|
|
|
|
requester, event_dict, txn_id=txn_id
|
|
|
|
)
|
|
|
|
event_id = event.event_id
|
|
|
|
except ShadowBanError:
|
|
|
|
event_id = "$" + random_string(43)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2020-08-24 17:58:56 +00:00
|
|
|
set_tag("event_id", event_id)
|
|
|
|
return 200, {"event_id": event_id}
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2014-08-26 16:00:24 +00:00
|
|
|
def on_GET(self, request, room_id, event_type, txn_id):
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, "Not implemented"
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2014-08-26 16:00:24 +00:00
|
|
|
def on_PUT(self, request, room_id, event_type, txn_id):
|
2019-09-25 10:39:15 +00:00
|
|
|
set_tag("txn_id", txn_id)
|
|
|
|
|
2016-11-14 09:52:41 +00:00
|
|
|
return self.txns.fetch_or_execute_request(
|
2016-11-11 17:47:03 +00:00
|
|
|
request, self.on_POST, request, room_id, event_type, txn_id
|
2016-11-11 15:02:29 +00:00
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
2021-06-22 09:02:53 +00:00
|
|
|
class RoomBatchSendEventRestServlet(TransactionRestServlet):
|
|
|
|
"""
|
|
|
|
API endpoint which can insert a chunk of events historically back in time
|
|
|
|
next to the given `prev_event`.
|
|
|
|
|
|
|
|
`chunk_id` comes from `next_chunk_id `in the response of the batch send
|
|
|
|
endpoint and is derived from the "insertion" events added to each chunk.
|
|
|
|
It's not required for the first batch send.
|
|
|
|
|
|
|
|
`state_events_at_start` is used to define the historical state events
|
|
|
|
needed to auth the events like join events. These events will float
|
|
|
|
outside of the normal DAG as outlier's and won't be visible in the chat
|
|
|
|
history which also allows us to insert multiple chunks without having a bunch
|
|
|
|
of `@mxid joined the room` noise between each chunk.
|
|
|
|
|
|
|
|
`events` is chronological chunk/list of events you want to insert.
|
|
|
|
There is a reverse-chronological constraint on chunks so once you insert
|
|
|
|
some messages, you can only insert older ones after that.
|
|
|
|
tldr; Insert chunks from your most recent history -> oldest history.
|
|
|
|
|
|
|
|
POST /_matrix/client/unstable/org.matrix.msc2716/rooms/<roomID>/batch_send?prev_event=<eventID>&chunk_id=<chunkID>
|
|
|
|
{
|
|
|
|
"events": [ ... ],
|
|
|
|
"state_events_at_start": [ ... ]
|
|
|
|
}
|
|
|
|
"""
|
|
|
|
|
|
|
|
PATTERNS = (
|
|
|
|
re.compile(
|
|
|
|
"^/_matrix/client/unstable/org.matrix.msc2716"
|
|
|
|
"/rooms/(?P<room_id>[^/]*)/batch_send$"
|
|
|
|
),
|
|
|
|
)
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
super().__init__(hs)
|
|
|
|
self.hs = hs
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.state_store = hs.get_storage().state
|
|
|
|
self.event_creation_handler = hs.get_event_creation_handler()
|
|
|
|
self.room_member_handler = hs.get_room_member_handler()
|
|
|
|
self.auth = hs.get_auth()
|
|
|
|
|
2021-07-13 19:12:33 +00:00
|
|
|
async def _inherit_depth_from_prev_ids(self, prev_event_ids) -> int:
|
2021-06-22 09:02:53 +00:00
|
|
|
(
|
|
|
|
most_recent_prev_event_id,
|
|
|
|
most_recent_prev_event_depth,
|
|
|
|
) = await self.store.get_max_depth_of(prev_event_ids)
|
|
|
|
|
|
|
|
# We want to insert the historical event after the `prev_event` but before the successor event
|
|
|
|
#
|
|
|
|
# We inherit depth from the successor event instead of the `prev_event`
|
|
|
|
# because events returned from `/messages` are first sorted by `topological_ordering`
|
|
|
|
# which is just the `depth` and then tie-break with `stream_ordering`.
|
|
|
|
#
|
|
|
|
# We mark these inserted historical events as "backfilled" which gives them a
|
|
|
|
# negative `stream_ordering`. If we use the same depth as the `prev_event`,
|
|
|
|
# then our historical event will tie-break and be sorted before the `prev_event`
|
|
|
|
# when it should come after.
|
|
|
|
#
|
|
|
|
# We want to use the successor event depth so they appear after `prev_event` because
|
|
|
|
# it has a larger `depth` but before the successor event because the `stream_ordering`
|
|
|
|
# is negative before the successor event.
|
|
|
|
successor_event_ids = await self.store.get_successor_events(
|
|
|
|
[most_recent_prev_event_id]
|
|
|
|
)
|
|
|
|
|
|
|
|
# If we can't find any successor events, then it's a forward extremity of
|
|
|
|
# historical messages and we can just inherit from the previous historical
|
|
|
|
# event which we can already assume has the correct depth where we want
|
|
|
|
# to insert into.
|
|
|
|
if not successor_event_ids:
|
|
|
|
depth = most_recent_prev_event_depth
|
|
|
|
else:
|
|
|
|
(
|
|
|
|
_,
|
|
|
|
oldest_successor_depth,
|
|
|
|
) = await self.store.get_min_depth_of(successor_event_ids)
|
|
|
|
|
|
|
|
depth = oldest_successor_depth
|
|
|
|
|
|
|
|
return depth
|
|
|
|
|
2021-07-09 01:25:59 +00:00
|
|
|
def _create_insertion_event_dict(
|
|
|
|
self, sender: str, room_id: str, origin_server_ts: int
|
|
|
|
):
|
|
|
|
"""Creates an event dict for an "insertion" event with the proper fields
|
|
|
|
and a random chunk ID.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
sender: The event author MXID
|
|
|
|
room_id: The room ID that the event belongs to
|
|
|
|
origin_server_ts: Timestamp when the event was sent
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
Tuple of event ID and stream ordering position
|
|
|
|
"""
|
|
|
|
|
|
|
|
next_chunk_id = random_string(8)
|
|
|
|
insertion_event = {
|
|
|
|
"type": EventTypes.MSC2716_INSERTION,
|
|
|
|
"sender": sender,
|
|
|
|
"room_id": room_id,
|
|
|
|
"content": {
|
|
|
|
EventContentFields.MSC2716_NEXT_CHUNK_ID: next_chunk_id,
|
|
|
|
EventContentFields.MSC2716_HISTORICAL: True,
|
|
|
|
},
|
|
|
|
"origin_server_ts": origin_server_ts,
|
|
|
|
}
|
|
|
|
|
|
|
|
return insertion_event
|
|
|
|
|
2021-07-13 19:12:33 +00:00
|
|
|
async def _create_requester_for_user_id_from_app_service(
|
|
|
|
self, user_id: str, app_service: ApplicationService
|
|
|
|
) -> Requester:
|
|
|
|
"""Creates a new requester for the given user_id
|
|
|
|
and validates that the app service is allowed to control
|
|
|
|
the given user.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
user_id: The author MXID that the app service is controlling
|
|
|
|
app_service: The app service that controls the user
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
Requester object
|
|
|
|
"""
|
|
|
|
|
|
|
|
await self.auth.validate_appservice_can_control_user_id(app_service, user_id)
|
|
|
|
|
|
|
|
return create_requester(user_id, app_service=app_service)
|
|
|
|
|
2021-06-22 09:02:53 +00:00
|
|
|
async def on_POST(self, request, room_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=False)
|
|
|
|
|
|
|
|
if not requester.app_service:
|
|
|
|
raise AuthError(
|
|
|
|
403,
|
|
|
|
"Only application services can use the /batchsend endpoint",
|
|
|
|
)
|
|
|
|
|
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
assert_params_in_dict(body, ["state_events_at_start", "events"])
|
|
|
|
|
|
|
|
prev_events_from_query = parse_strings_from_args(request.args, "prev_event")
|
2021-07-21 13:47:56 +00:00
|
|
|
chunk_id_from_query = parse_string(request, "chunk_id")
|
2021-06-22 09:02:53 +00:00
|
|
|
|
|
|
|
if prev_events_from_query is None:
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"prev_event query parameter is required when inserting historical messages back in time",
|
|
|
|
errcode=Codes.MISSING_PARAM,
|
|
|
|
)
|
|
|
|
|
|
|
|
# For the event we are inserting next to (`prev_events_from_query`),
|
|
|
|
# find the most recent auth events (derived from state events) that
|
|
|
|
# allowed that message to be sent. We will use that as a base
|
|
|
|
# to auth our historical messages against.
|
|
|
|
(
|
|
|
|
most_recent_prev_event_id,
|
|
|
|
_,
|
|
|
|
) = await self.store.get_max_depth_of(prev_events_from_query)
|
|
|
|
# mapping from (type, state_key) -> state_event_id
|
|
|
|
prev_state_map = await self.state_store.get_state_ids_for_event(
|
|
|
|
most_recent_prev_event_id
|
|
|
|
)
|
|
|
|
# List of state event ID's
|
|
|
|
prev_state_ids = list(prev_state_map.values())
|
|
|
|
auth_event_ids = prev_state_ids
|
|
|
|
|
|
|
|
for state_event in body["state_events_at_start"]:
|
|
|
|
assert_params_in_dict(
|
|
|
|
state_event, ["type", "origin_server_ts", "content", "sender"]
|
|
|
|
)
|
|
|
|
|
|
|
|
logger.debug(
|
|
|
|
"RoomBatchSendEventRestServlet inserting state_event=%s, auth_event_ids=%s",
|
|
|
|
state_event,
|
|
|
|
auth_event_ids,
|
|
|
|
)
|
|
|
|
|
|
|
|
event_dict = {
|
|
|
|
"type": state_event["type"],
|
|
|
|
"origin_server_ts": state_event["origin_server_ts"],
|
|
|
|
"content": state_event["content"],
|
|
|
|
"room_id": room_id,
|
|
|
|
"sender": state_event["sender"],
|
|
|
|
"state_key": state_event["state_key"],
|
|
|
|
}
|
|
|
|
|
|
|
|
# Make the state events float off on their own
|
|
|
|
fake_prev_event_id = "$" + random_string(43)
|
|
|
|
|
|
|
|
# TODO: This is pretty much the same as some other code to handle inserting state in this file
|
|
|
|
if event_dict["type"] == EventTypes.Member:
|
|
|
|
membership = event_dict["content"].get("membership", None)
|
|
|
|
event_id, _ = await self.room_member_handler.update_membership(
|
2021-07-13 19:12:33 +00:00
|
|
|
await self._create_requester_for_user_id_from_app_service(
|
|
|
|
state_event["sender"], requester.app_service
|
|
|
|
),
|
2021-06-22 09:02:53 +00:00
|
|
|
target=UserID.from_string(event_dict["state_key"]),
|
|
|
|
room_id=room_id,
|
|
|
|
action=membership,
|
|
|
|
content=event_dict["content"],
|
|
|
|
outlier=True,
|
|
|
|
prev_event_ids=[fake_prev_event_id],
|
|
|
|
# Make sure to use a copy of this list because we modify it
|
|
|
|
# later in the loop here. Otherwise it will be the same
|
|
|
|
# reference and also update in the event when we append later.
|
|
|
|
auth_event_ids=auth_event_ids.copy(),
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
# TODO: Add some complement tests that adds state that is not member joins
|
|
|
|
# and will use this code path. Maybe we only want to support join state events
|
|
|
|
# and can get rid of this `else`?
|
|
|
|
(
|
|
|
|
event,
|
|
|
|
_,
|
|
|
|
) = await self.event_creation_handler.create_and_send_nonmember_event(
|
2021-07-13 19:12:33 +00:00
|
|
|
await self._create_requester_for_user_id_from_app_service(
|
|
|
|
state_event["sender"], requester.app_service
|
|
|
|
),
|
2021-06-22 09:02:53 +00:00
|
|
|
event_dict,
|
|
|
|
outlier=True,
|
|
|
|
prev_event_ids=[fake_prev_event_id],
|
|
|
|
# Make sure to use a copy of this list because we modify it
|
|
|
|
# later in the loop here. Otherwise it will be the same
|
|
|
|
# reference and also update in the event when we append later.
|
|
|
|
auth_event_ids=auth_event_ids.copy(),
|
|
|
|
)
|
|
|
|
event_id = event.event_id
|
|
|
|
|
|
|
|
auth_event_ids.append(event_id)
|
|
|
|
|
|
|
|
events_to_create = body["events"]
|
|
|
|
|
2021-07-09 01:25:59 +00:00
|
|
|
prev_event_ids = prev_events_from_query
|
2021-07-13 19:12:33 +00:00
|
|
|
inherited_depth = await self._inherit_depth_from_prev_ids(
|
|
|
|
prev_events_from_query
|
|
|
|
)
|
2021-07-09 01:25:59 +00:00
|
|
|
|
|
|
|
# Figure out which chunk to connect to. If they passed in
|
|
|
|
# chunk_id_from_query let's use it. The chunk ID passed in comes
|
|
|
|
# from the chunk_id in the "insertion" event from the previous chunk.
|
|
|
|
last_event_in_chunk = events_to_create[-1]
|
|
|
|
chunk_id_to_connect_to = chunk_id_from_query
|
|
|
|
base_insertion_event = None
|
2021-06-22 09:02:53 +00:00
|
|
|
if chunk_id_from_query:
|
2021-07-09 01:25:59 +00:00
|
|
|
# TODO: Verify the chunk_id_from_query corresponds to an insertion event
|
|
|
|
pass
|
|
|
|
# Otherwise, create an insertion event to act as a starting point.
|
|
|
|
#
|
|
|
|
# We don't always have an insertion event to start hanging more history
|
|
|
|
# off of (ideally there would be one in the main DAG, but that's not the
|
|
|
|
# case if we're wanting to add history to e.g. existing rooms without
|
|
|
|
# an insertion event), in which case we just create a new insertion event
|
|
|
|
# that can then get pointed to by a "marker" event later.
|
|
|
|
else:
|
|
|
|
base_insertion_event_dict = self._create_insertion_event_dict(
|
|
|
|
sender=requester.user.to_string(),
|
|
|
|
room_id=room_id,
|
|
|
|
origin_server_ts=last_event_in_chunk["origin_server_ts"],
|
|
|
|
)
|
|
|
|
base_insertion_event_dict["prev_events"] = prev_event_ids.copy()
|
2021-06-22 09:02:53 +00:00
|
|
|
|
2021-07-09 01:25:59 +00:00
|
|
|
(
|
|
|
|
base_insertion_event,
|
|
|
|
_,
|
|
|
|
) = await self.event_creation_handler.create_and_send_nonmember_event(
|
2021-07-13 19:12:33 +00:00
|
|
|
await self._create_requester_for_user_id_from_app_service(
|
|
|
|
base_insertion_event_dict["sender"],
|
|
|
|
requester.app_service,
|
|
|
|
),
|
2021-07-09 01:25:59 +00:00
|
|
|
base_insertion_event_dict,
|
|
|
|
prev_event_ids=base_insertion_event_dict.get("prev_events"),
|
|
|
|
auth_event_ids=auth_event_ids,
|
|
|
|
historical=True,
|
|
|
|
depth=inherited_depth,
|
|
|
|
)
|
|
|
|
|
|
|
|
chunk_id_to_connect_to = base_insertion_event["content"][
|
|
|
|
EventContentFields.MSC2716_NEXT_CHUNK_ID
|
|
|
|
]
|
|
|
|
|
|
|
|
# Connect this current chunk to the insertion event from the previous chunk
|
2021-07-21 10:29:57 +00:00
|
|
|
chunk_event = {
|
|
|
|
"type": EventTypes.MSC2716_CHUNK,
|
|
|
|
"sender": requester.user.to_string(),
|
|
|
|
"room_id": room_id,
|
|
|
|
"content": {EventContentFields.MSC2716_CHUNK_ID: chunk_id_to_connect_to},
|
|
|
|
# Since the chunk event is put at the end of the chunk,
|
|
|
|
# where the newest-in-time event is, copy the origin_server_ts from
|
|
|
|
# the last event we're inserting
|
|
|
|
"origin_server_ts": last_event_in_chunk["origin_server_ts"],
|
|
|
|
}
|
|
|
|
# Add the chunk event to the end of the chunk (newest-in-time)
|
|
|
|
events_to_create.append(chunk_event)
|
2021-07-09 01:25:59 +00:00
|
|
|
|
|
|
|
# Add an "insertion" event to the start of each chunk (next to the oldest-in-time
|
2021-06-22 09:02:53 +00:00
|
|
|
# event in the chunk) so the next chunk can be connected to this one.
|
2021-07-09 01:25:59 +00:00
|
|
|
insertion_event = self._create_insertion_event_dict(
|
|
|
|
sender=requester.user.to_string(),
|
|
|
|
room_id=room_id,
|
2021-06-22 09:02:53 +00:00
|
|
|
# Since the insertion event is put at the start of the chunk,
|
2021-07-09 01:25:59 +00:00
|
|
|
# where the oldest-in-time event is, copy the origin_server_ts from
|
2021-06-22 09:02:53 +00:00
|
|
|
# the first event we're inserting
|
2021-07-09 01:25:59 +00:00
|
|
|
origin_server_ts=events_to_create[0]["origin_server_ts"],
|
|
|
|
)
|
2021-07-21 10:29:57 +00:00
|
|
|
# Prepend the insertion event to the start of the chunk (oldest-in-time)
|
2021-06-22 09:02:53 +00:00
|
|
|
events_to_create = [insertion_event] + events_to_create
|
|
|
|
|
|
|
|
event_ids = []
|
|
|
|
events_to_persist = []
|
|
|
|
for ev in events_to_create:
|
|
|
|
assert_params_in_dict(ev, ["type", "origin_server_ts", "content", "sender"])
|
|
|
|
|
|
|
|
# Mark all events as historical
|
|
|
|
# This has important semantics within the Synapse internals to backfill properly
|
|
|
|
ev["content"][EventContentFields.MSC2716_HISTORICAL] = True
|
|
|
|
|
|
|
|
event_dict = {
|
|
|
|
"type": ev["type"],
|
|
|
|
"origin_server_ts": ev["origin_server_ts"],
|
|
|
|
"content": ev["content"],
|
|
|
|
"room_id": room_id,
|
|
|
|
"sender": ev["sender"], # requester.user.to_string(),
|
|
|
|
"prev_events": prev_event_ids.copy(),
|
|
|
|
}
|
|
|
|
|
|
|
|
event, context = await self.event_creation_handler.create_event(
|
2021-07-13 19:12:33 +00:00
|
|
|
await self._create_requester_for_user_id_from_app_service(
|
|
|
|
ev["sender"], requester.app_service
|
|
|
|
),
|
2021-06-22 09:02:53 +00:00
|
|
|
event_dict,
|
|
|
|
prev_event_ids=event_dict.get("prev_events"),
|
|
|
|
auth_event_ids=auth_event_ids,
|
|
|
|
historical=True,
|
|
|
|
depth=inherited_depth,
|
|
|
|
)
|
|
|
|
logger.debug(
|
|
|
|
"RoomBatchSendEventRestServlet inserting event=%s, prev_event_ids=%s, auth_event_ids=%s",
|
|
|
|
event,
|
|
|
|
prev_event_ids,
|
|
|
|
auth_event_ids,
|
|
|
|
)
|
|
|
|
|
|
|
|
assert self.hs.is_mine_id(event.sender), "User must be our own: %s" % (
|
|
|
|
event.sender,
|
|
|
|
)
|
|
|
|
|
|
|
|
events_to_persist.append((event, context))
|
|
|
|
event_id = event.event_id
|
|
|
|
|
|
|
|
event_ids.append(event_id)
|
|
|
|
prev_event_ids = [event_id]
|
|
|
|
|
|
|
|
# Persist events in reverse-chronological order so they have the
|
|
|
|
# correct stream_ordering as they are backfilled (which decrements).
|
|
|
|
# Events are sorted by (topological_ordering, stream_ordering)
|
|
|
|
# where topological_ordering is just depth.
|
|
|
|
for (event, context) in reversed(events_to_persist):
|
|
|
|
ev = await self.event_creation_handler.handle_new_client_event(
|
2021-07-13 19:12:33 +00:00
|
|
|
await self._create_requester_for_user_id_from_app_service(
|
|
|
|
event["sender"], requester.app_service
|
|
|
|
),
|
2021-06-22 09:02:53 +00:00
|
|
|
event=event,
|
|
|
|
context=context,
|
|
|
|
)
|
|
|
|
|
2021-07-09 01:25:59 +00:00
|
|
|
# Add the base_insertion_event to the bottom of the list we return
|
|
|
|
if base_insertion_event is not None:
|
|
|
|
event_ids.append(base_insertion_event.event_id)
|
|
|
|
|
2021-06-22 09:02:53 +00:00
|
|
|
return 200, {
|
|
|
|
"state_events": auth_event_ids,
|
|
|
|
"events": event_ids,
|
2021-07-09 01:25:59 +00:00
|
|
|
"next_chunk_id": insertion_event["content"][
|
|
|
|
EventContentFields.MSC2716_NEXT_CHUNK_ID
|
|
|
|
],
|
2021-06-22 09:02:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
def on_GET(self, request, room_id):
|
|
|
|
return 501, "Not implemented"
|
|
|
|
|
|
|
|
def on_PUT(self, request, room_id):
|
|
|
|
return self.txns.fetch_or_execute_request(
|
|
|
|
request, self.on_POST, request, room_id
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2014-08-27 08:43:42 +00:00
|
|
|
# TODO: Needs unit testing for room ID + alias joins
|
2019-06-03 11:28:59 +00:00
|
|
|
class JoinRoomAliasServlet(TransactionRestServlet):
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__(hs)
|
2018-03-01 10:54:37 +00:00
|
|
|
self.room_member_handler = hs.get_room_member_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-02-12 16:17:24 +00:00
|
|
|
|
|
|
|
def register(self, http_server):
|
|
|
|
# /join/$room_identifier[/$txn_id]
|
|
|
|
PATTERNS = "/join/(?P<room_identifier>[^/]*)"
|
|
|
|
register_txn_path(self, PATTERNS, http_server)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2021-06-09 18:39:51 +00:00
|
|
|
async def on_POST(
|
|
|
|
self,
|
|
|
|
request: SynapseRequest,
|
|
|
|
room_identifier: str,
|
|
|
|
txn_id: Optional[str] = None,
|
|
|
|
):
|
2019-10-29 13:09:24 +00:00
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2016-02-24 08:50:28 +00:00
|
|
|
try:
|
2016-03-09 11:26:26 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
2017-10-23 14:52:32 +00:00
|
|
|
except Exception:
|
2016-02-24 08:50:28 +00:00
|
|
|
# Turns out we used to ignore the body entirely, and some clients
|
|
|
|
# cheekily send invalid bodies.
|
|
|
|
content = {}
|
2016-02-23 15:11:25 +00:00
|
|
|
|
2016-02-15 15:39:16 +00:00
|
|
|
if RoomID.is_valid(room_identifier):
|
|
|
|
room_id = room_identifier
|
2021-06-09 18:39:51 +00:00
|
|
|
|
|
|
|
# twisted.web.server.Request.args is incorrectly defined as Optional[Any]
|
|
|
|
args: Dict[bytes, List[bytes]] = request.args # type: ignore
|
|
|
|
|
|
|
|
remote_room_hosts = parse_strings_from_args(
|
|
|
|
args, "server_name", required=False
|
|
|
|
)
|
2016-02-15 15:39:16 +00:00
|
|
|
elif RoomAlias.is_valid(room_identifier):
|
2018-03-01 10:54:37 +00:00
|
|
|
handler = self.room_member_handler
|
2016-02-15 15:39:16 +00:00
|
|
|
room_alias = RoomAlias.from_string(room_identifier)
|
2021-06-09 18:39:51 +00:00
|
|
|
room_id_obj, remote_room_hosts = await handler.lookup_room_alias(room_alias)
|
|
|
|
room_id = room_id_obj.to_string()
|
2016-02-15 15:39:16 +00:00
|
|
|
else:
|
|
|
|
raise SynapseError(
|
|
|
|
400, "%s was not legal room ID or room alias" % (room_identifier,)
|
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
await self.room_member_handler.update_membership(
|
2016-02-15 16:16:03 +00:00
|
|
|
requester=requester,
|
|
|
|
target=requester.user,
|
|
|
|
room_id=room_id,
|
|
|
|
action="join",
|
2016-02-15 15:39:16 +00:00
|
|
|
txn_id=txn_id,
|
2016-02-17 15:50:13 +00:00
|
|
|
remote_room_hosts=remote_room_hosts,
|
2016-08-23 15:32:04 +00:00
|
|
|
content=content,
|
2016-02-23 15:11:25 +00:00
|
|
|
third_party_signed=content.get("third_party_signed", None),
|
2016-02-15 15:39:16 +00:00
|
|
|
)
|
2016-02-12 16:17:24 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {"room_id": room_id}
|
2016-02-12 16:17:24 +00:00
|
|
|
|
|
|
|
def on_PUT(self, request, room_identifier, txn_id):
|
2019-09-25 10:39:15 +00:00
|
|
|
set_tag("txn_id", txn_id)
|
|
|
|
|
2016-11-14 09:52:41 +00:00
|
|
|
return self.txns.fetch_or_execute_request(
|
2016-11-11 17:47:03 +00:00
|
|
|
request, self.on_POST, request, room_identifier, txn_id
|
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
2014-08-27 13:51:59 +00:00
|
|
|
# TODO: Needs unit testing
|
2019-06-03 11:28:59 +00:00
|
|
|
class PublicRoomListRestServlet(TransactionRestServlet):
|
|
|
|
PATTERNS = client_patterns("/publicRooms$", v1=True)
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__(hs)
|
2019-06-03 11:28:59 +00:00
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2014-08-27 13:51:59 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request):
|
2021-07-21 13:47:56 +00:00
|
|
|
server = parse_string(request, "server")
|
2016-09-08 10:53:05 +00:00
|
|
|
|
2016-06-08 13:23:15 +00:00
|
|
|
try:
|
2019-10-29 13:09:24 +00:00
|
|
|
await self.auth.get_user_by_req(request, allow_guest=True)
|
2019-07-11 10:06:23 +00:00
|
|
|
except InvalidClientCredentialsError as e:
|
2019-05-08 17:26:56 +00:00
|
|
|
# Option to allow servers to require auth when accessing
|
|
|
|
# /publicRooms via CS API. This is especially helpful in private
|
|
|
|
# federations.
|
2019-06-24 10:45:11 +00:00
|
|
|
if not self.hs.config.allow_public_rooms_without_auth:
|
2019-05-08 17:26:56 +00:00
|
|
|
raise
|
|
|
|
|
2016-09-08 10:53:05 +00:00
|
|
|
# We allow people to not be authed if they're just looking at our
|
|
|
|
# room list, but require auth when we proxy the request.
|
|
|
|
# In both cases we call the auth function, as that has the side
|
|
|
|
# effect of logging who issued this request if an access token was
|
|
|
|
# provided.
|
|
|
|
if server:
|
|
|
|
raise e
|
2016-06-08 13:23:15 +00:00
|
|
|
|
2016-09-15 12:56:20 +00:00
|
|
|
limit = parse_integer(request, "limit", 0)
|
2021-07-21 13:47:56 +00:00
|
|
|
since_token = parse_string(request, "since")
|
2016-09-15 09:15:37 +00:00
|
|
|
|
2019-10-02 13:08:35 +00:00
|
|
|
if limit == 0:
|
|
|
|
# zero is a special value which corresponds to no limit.
|
|
|
|
limit = None
|
|
|
|
|
2016-05-31 10:05:16 +00:00
|
|
|
handler = self.hs.get_room_list_handler()
|
2020-04-06 11:35:30 +00:00
|
|
|
if server and server != self.hs.config.server_name:
|
2021-01-19 19:21:59 +00:00
|
|
|
# Ensure the server is valid.
|
|
|
|
try:
|
|
|
|
parse_and_validate_server_name(server)
|
|
|
|
except ValueError:
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"Invalid server name: %s" % (server,),
|
|
|
|
Codes.INVALID_PARAM,
|
|
|
|
)
|
|
|
|
|
2020-04-06 11:35:30 +00:00
|
|
|
try:
|
|
|
|
data = await handler.get_remote_public_room_list(
|
|
|
|
server, limit=limit, since_token=since_token
|
|
|
|
)
|
|
|
|
except HttpResponseException as e:
|
|
|
|
raise e.to_synapse_error()
|
2016-09-08 10:53:05 +00:00
|
|
|
else:
|
2019-10-29 13:09:24 +00:00
|
|
|
data = await handler.get_local_public_room_list(
|
2016-09-15 09:36:19 +00:00
|
|
|
limit=limit, since_token=since_token
|
2016-09-15 09:15:37 +00:00
|
|
|
)
|
2016-05-31 16:20:07 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, data
|
2014-08-27 13:51:59 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_POST(self, request):
|
|
|
|
await self.auth.get_user_by_req(request, allow_guest=True)
|
2016-09-15 16:35:20 +00:00
|
|
|
|
2021-07-21 13:47:56 +00:00
|
|
|
server = parse_string(request, "server")
|
2016-09-15 16:35:20 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
|
|
|
|
2021-07-16 17:22:36 +00:00
|
|
|
limit: Optional[int] = int(content.get("limit", 100))
|
2016-09-15 16:35:20 +00:00
|
|
|
since_token = content.get("since", None)
|
|
|
|
search_filter = content.get("filter", None)
|
|
|
|
|
2016-12-06 10:43:48 +00:00
|
|
|
include_all_networks = content.get("include_all_networks", False)
|
|
|
|
third_party_instance_id = content.get("third_party_instance_id", None)
|
|
|
|
|
|
|
|
if include_all_networks:
|
|
|
|
network_tuple = None
|
|
|
|
if third_party_instance_id is not None:
|
|
|
|
raise SynapseError(
|
|
|
|
400, "Can't use include_all_networks with an explicit network"
|
|
|
|
)
|
|
|
|
elif third_party_instance_id is None:
|
|
|
|
network_tuple = ThirdPartyInstanceID(None, None)
|
|
|
|
else:
|
|
|
|
network_tuple = ThirdPartyInstanceID.from_string(third_party_instance_id)
|
|
|
|
|
2019-10-02 13:08:35 +00:00
|
|
|
if limit == 0:
|
|
|
|
# zero is a special value which corresponds to no limit.
|
|
|
|
limit = None
|
|
|
|
|
2016-09-15 16:35:20 +00:00
|
|
|
handler = self.hs.get_room_list_handler()
|
2020-04-06 11:35:30 +00:00
|
|
|
if server and server != self.hs.config.server_name:
|
2021-01-19 19:21:59 +00:00
|
|
|
# Ensure the server is valid.
|
|
|
|
try:
|
|
|
|
parse_and_validate_server_name(server)
|
|
|
|
except ValueError:
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"Invalid server name: %s" % (server,),
|
|
|
|
Codes.INVALID_PARAM,
|
|
|
|
)
|
|
|
|
|
2020-04-06 11:35:30 +00:00
|
|
|
try:
|
|
|
|
data = await handler.get_remote_public_room_list(
|
|
|
|
server,
|
|
|
|
limit=limit,
|
|
|
|
since_token=since_token,
|
|
|
|
search_filter=search_filter,
|
|
|
|
include_all_networks=include_all_networks,
|
|
|
|
third_party_instance_id=third_party_instance_id,
|
|
|
|
)
|
|
|
|
except HttpResponseException as e:
|
|
|
|
raise e.to_synapse_error()
|
2016-09-15 16:35:20 +00:00
|
|
|
else:
|
2019-10-29 13:09:24 +00:00
|
|
|
data = await handler.get_local_public_room_list(
|
2016-09-15 16:35:20 +00:00
|
|
|
limit=limit,
|
|
|
|
since_token=since_token,
|
|
|
|
search_filter=search_filter,
|
2016-12-06 10:43:48 +00:00
|
|
|
network_tuple=network_tuple,
|
2016-09-15 16:35:20 +00:00
|
|
|
)
|
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, data
|
2016-09-15 16:35:20 +00:00
|
|
|
|
2014-08-27 13:51:59 +00:00
|
|
|
|
2014-08-26 16:54:18 +00:00
|
|
|
# TODO: Needs unit testing
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomMemberListRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/members$", v1=True)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2018-07-18 14:22:02 +00:00
|
|
|
self.message_handler = hs.get_message_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2020-09-30 19:29:19 +00:00
|
|
|
self.store = hs.get_datastore()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request, room_id):
|
2014-08-12 14:10:52 +00:00
|
|
|
# TODO support Pagination stream API (limit/tokens)
|
2020-08-03 11:13:49 +00:00
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2018-08-15 15:35:22 +00:00
|
|
|
handler = self.message_handler
|
|
|
|
|
|
|
|
# request the state as of a given event, as identified by a stream token,
|
|
|
|
# for consistency with /messages etc.
|
|
|
|
# useful for getting the membership in retrospect as of a given /sync
|
|
|
|
# response.
|
|
|
|
at_token_string = parse_string(request, "at")
|
|
|
|
if at_token_string is None:
|
|
|
|
at_token = None
|
|
|
|
else:
|
2020-09-30 19:29:19 +00:00
|
|
|
at_token = await StreamToken.from_string(self.store, at_token_string)
|
2018-08-15 15:35:22 +00:00
|
|
|
|
|
|
|
# let you filter down on particular memberships.
|
|
|
|
# XXX: this may not be the best shape for this API - we could pass in a filter
|
|
|
|
# instead, except filters aren't currently aware of memberships.
|
|
|
|
# See https://github.com/matrix-org/matrix-doc/issues/1337 for more details.
|
|
|
|
membership = parse_string(request, "membership")
|
|
|
|
not_membership = parse_string(request, "not_membership")
|
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
events = await handler.get_state_events(
|
2014-12-12 15:05:37 +00:00
|
|
|
room_id=room_id,
|
2016-01-11 15:29:57 +00:00
|
|
|
user_id=requester.user.to_string(),
|
2018-08-15 15:35:22 +00:00
|
|
|
at_token=at_token,
|
2018-10-25 16:49:55 +00:00
|
|
|
state_filter=StateFilter.from_types([(EventTypes.Member, None)]),
|
2015-09-09 14:42:16 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
chunk = []
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2015-09-09 14:42:16 +00:00
|
|
|
for event in events:
|
2018-08-15 15:35:22 +00:00
|
|
|
if (membership and event["content"].get("membership") != membership) or (
|
|
|
|
not_membership and event["content"].get("membership") == not_membership
|
|
|
|
):
|
2015-09-09 14:42:16 +00:00
|
|
|
continue
|
|
|
|
chunk.append(event)
|
2014-08-15 15:47:50 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {"chunk": chunk}
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
2018-08-15 15:35:22 +00:00
|
|
|
# deprecated in favour of /members?membership=join?
|
|
|
|
# except it does custom AS logic and has a simpler return format
|
2019-06-03 11:28:59 +00:00
|
|
|
class JoinedRoomMemberListRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/joined_members$", v1=True)
|
2016-12-08 13:32:05 +00:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2018-07-18 14:22:02 +00:00
|
|
|
self.message_handler = hs.get_message_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-12-08 13:32:05 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request, room_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2016-12-08 13:32:05 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
users_with_profile = await self.message_handler.get_joined_members(
|
2017-09-28 09:09:32 +00:00
|
|
|
requester, room_id
|
2017-09-27 14:01:25 +00:00
|
|
|
)
|
2016-12-08 13:32:05 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {"joined": users_with_profile}
|
2016-12-08 13:32:05 +00:00
|
|
|
|
|
|
|
|
2015-11-05 16:56:40 +00:00
|
|
|
# TODO: Needs better unit testing
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomMessageListRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/messages$", v1=True)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2018-07-18 14:22:02 +00:00
|
|
|
self.pagination_handler = hs.get_pagination_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2020-09-30 19:29:19 +00:00
|
|
|
self.store = hs.get_datastore()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request, room_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2020-09-30 19:29:19 +00:00
|
|
|
pagination_config = await PaginationConfig.from_request(
|
|
|
|
self.store, request, default_limit=10
|
|
|
|
)
|
2018-09-12 10:41:31 +00:00
|
|
|
as_client_event = b"raw" not in request.args
|
2021-06-08 12:30:48 +00:00
|
|
|
filter_str = parse_string(request, "filter", encoding="utf-8")
|
2020-07-15 17:40:54 +00:00
|
|
|
if filter_str:
|
|
|
|
filter_json = urlparse.unquote(filter_str)
|
2021-07-16 17:22:36 +00:00
|
|
|
event_filter: Optional[Filter] = Filter(json_decoder.decode(filter_json))
|
2020-01-20 17:38:21 +00:00
|
|
|
if (
|
|
|
|
event_filter
|
|
|
|
and event_filter.filter_json.get("event_format", "client")
|
|
|
|
== "federation"
|
|
|
|
):
|
2019-05-30 14:58:53 +00:00
|
|
|
as_client_event = False
|
2016-07-14 14:59:25 +00:00
|
|
|
else:
|
|
|
|
event_filter = None
|
2020-01-20 17:38:21 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
msgs = await self.pagination_handler.get_messages(
|
2014-12-12 15:05:37 +00:00
|
|
|
room_id=room_id,
|
2016-01-20 15:34:07 +00:00
|
|
|
requester=requester,
|
2014-08-12 14:10:52 +00:00
|
|
|
pagin_config=pagination_config,
|
2016-07-14 14:59:25 +00:00
|
|
|
as_client_event=as_client_event,
|
|
|
|
event_filter=event_filter,
|
2015-01-08 14:36:33 +00:00
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, msgs
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
2014-08-27 15:42:33 +00:00
|
|
|
# TODO: Needs unit testing
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomStateRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/state$", v1=True)
|
2014-08-27 15:42:33 +00:00
|
|
|
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2018-07-18 14:22:02 +00:00
|
|
|
self.message_handler = hs.get_message_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request, room_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2014-09-23 14:35:58 +00:00
|
|
|
# Get all the current state for this room
|
2019-10-29 13:09:24 +00:00
|
|
|
events = await self.message_handler.get_state_events(
|
2014-12-12 15:05:37 +00:00
|
|
|
room_id=room_id,
|
2016-01-11 15:29:57 +00:00
|
|
|
user_id=requester.user.to_string(),
|
|
|
|
is_guest=requester.is_guest,
|
2014-09-23 14:35:58 +00:00
|
|
|
)
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, events
|
2014-08-27 15:42:33 +00:00
|
|
|
|
|
|
|
|
2014-08-27 15:49:01 +00:00
|
|
|
# TODO: Needs unit testing
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomInitialSyncRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/initialSync$", v1=True)
|
2014-08-27 15:49:01 +00:00
|
|
|
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2016-09-21 10:46:28 +00:00
|
|
|
self.initial_sync_handler = hs.get_initial_sync_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2020-09-30 19:29:19 +00:00
|
|
|
self.store = hs.get_datastore()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request, room_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2020-09-30 19:29:19 +00:00
|
|
|
pagination_config = await PaginationConfig.from_request(self.store, request)
|
2019-10-29 13:09:24 +00:00
|
|
|
content = await self.initial_sync_handler.room_initial_sync(
|
2014-11-18 16:34:43 +00:00
|
|
|
room_id=room_id, requester=requester, pagin_config=pagination_config
|
2014-11-10 19:02:19 +00:00
|
|
|
)
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, content
|
2014-08-27 15:49:01 +00:00
|
|
|
|
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomEventServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns(
|
|
|
|
"/rooms/(?P<room_id>[^/]*)/event/(?P<event_id>[^/]*)$", v1=True
|
2018-01-09 14:39:12 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2018-01-09 14:39:12 +00:00
|
|
|
self.clock = hs.get_clock()
|
|
|
|
self.event_handler = hs.get_event_handler()
|
2019-05-09 12:21:57 +00:00
|
|
|
self._event_serializer = hs.get_event_client_serializer()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2018-01-09 14:39:12 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request, room_id, event_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2019-08-06 12:33:55 +00:00
|
|
|
try:
|
2019-10-29 13:09:24 +00:00
|
|
|
event = await self.event_handler.get_event(
|
2019-08-06 12:33:55 +00:00
|
|
|
requester.user, room_id, event_id
|
|
|
|
)
|
|
|
|
except AuthError:
|
|
|
|
# This endpoint is supposed to return a 404 when the requester does
|
|
|
|
# not have permission to access the event
|
|
|
|
# https://matrix.org/docs/spec/client_server/r0.5.0#get-matrix-client-r0-rooms-roomid-event-eventid
|
|
|
|
raise SynapseError(404, "Event not found.", errcode=Codes.NOT_FOUND)
|
2018-01-09 14:39:12 +00:00
|
|
|
|
|
|
|
time_now = self.clock.time_msec()
|
|
|
|
if event:
|
2019-10-29 13:09:24 +00:00
|
|
|
event = await self._event_serializer.serialize_event(event, time_now)
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, event
|
2019-08-06 12:33:55 +00:00
|
|
|
|
|
|
|
return SynapseError(404, "Event not found.", errcode=Codes.NOT_FOUND)
|
2018-01-09 14:39:12 +00:00
|
|
|
|
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomEventContextServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns(
|
|
|
|
"/rooms/(?P<room_id>[^/]*)/context/(?P<event_id>[^/]*)$", v1=True
|
2015-10-28 13:45:56 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2015-10-28 13:45:56 +00:00
|
|
|
self.clock = hs.get_clock()
|
2018-07-18 14:29:45 +00:00
|
|
|
self.room_context_handler = hs.get_room_context_handler()
|
2019-05-09 12:21:57 +00:00
|
|
|
self._event_serializer = hs.get_event_client_serializer()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2015-10-28 13:45:56 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request, room_id, event_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2015-10-28 13:45:56 +00:00
|
|
|
|
2018-07-13 19:40:14 +00:00
|
|
|
limit = parse_integer(request, "limit", default=10)
|
2015-10-28 13:45:56 +00:00
|
|
|
|
2018-07-27 14:12:50 +00:00
|
|
|
# picking the API shape for symmetry with /messages
|
2021-06-08 12:30:48 +00:00
|
|
|
filter_str = parse_string(request, "filter", encoding="utf-8")
|
2020-07-15 17:40:54 +00:00
|
|
|
if filter_str:
|
|
|
|
filter_json = urlparse.unquote(filter_str)
|
2021-07-16 17:22:36 +00:00
|
|
|
event_filter: Optional[Filter] = Filter(json_decoder.decode(filter_json))
|
2018-07-27 14:12:50 +00:00
|
|
|
else:
|
|
|
|
event_filter = None
|
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
results = await self.room_context_handler.get_event_context(
|
2021-01-28 11:27:30 +00:00
|
|
|
requester, room_id, event_id, limit, event_filter
|
2015-10-28 13:45:56 +00:00
|
|
|
)
|
|
|
|
|
2016-01-13 14:19:22 +00:00
|
|
|
if not results:
|
|
|
|
raise SynapseError(404, "Event not found.", errcode=Codes.NOT_FOUND)
|
|
|
|
|
2015-10-28 13:45:56 +00:00
|
|
|
time_now = self.clock.time_msec()
|
2019-10-29 13:09:24 +00:00
|
|
|
results["events_before"] = await self._event_serializer.serialize_events(
|
2019-05-09 12:21:57 +00:00
|
|
|
results["events_before"], time_now
|
|
|
|
)
|
2019-10-29 13:09:24 +00:00
|
|
|
results["event"] = await self._event_serializer.serialize_event(
|
2019-05-09 12:21:57 +00:00
|
|
|
results["event"], time_now
|
|
|
|
)
|
2019-10-29 13:09:24 +00:00
|
|
|
results["events_after"] = await self._event_serializer.serialize_events(
|
2019-05-09 12:21:57 +00:00
|
|
|
results["events_after"], time_now
|
|
|
|
)
|
2019-10-29 13:09:24 +00:00
|
|
|
results["state"] = await self._event_serializer.serialize_events(
|
2021-03-16 10:27:51 +00:00
|
|
|
results["state"],
|
|
|
|
time_now,
|
|
|
|
# No need to bundle aggregations for state events
|
|
|
|
bundle_aggregations=False,
|
2019-05-09 12:21:57 +00:00
|
|
|
)
|
2015-10-28 13:45:56 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, results
|
2015-10-28 13:45:56 +00:00
|
|
|
|
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomForgetRestServlet(TransactionRestServlet):
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__(hs)
|
2018-03-01 10:54:37 +00:00
|
|
|
self.room_member_handler = hs.get_room_member_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2016-03-30 09:54:01 +00:00
|
|
|
def register(self, http_server):
|
|
|
|
PATTERNS = "/rooms/(?P<room_id>[^/]*)/forget"
|
|
|
|
register_txn_path(self, PATTERNS, http_server)
|
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_POST(self, request, room_id, txn_id=None):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=False)
|
2016-03-30 09:54:01 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
await self.room_member_handler.forget(user=requester.user, room_id=room_id)
|
2016-03-30 09:54:01 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {}
|
2016-03-30 09:54:01 +00:00
|
|
|
|
|
|
|
def on_PUT(self, request, room_id, txn_id):
|
2019-09-25 10:39:15 +00:00
|
|
|
set_tag("txn_id", txn_id)
|
|
|
|
|
2016-11-14 09:52:41 +00:00
|
|
|
return self.txns.fetch_or_execute_request(
|
2016-11-11 17:47:03 +00:00
|
|
|
request, self.on_POST, request, room_id, txn_id
|
|
|
|
)
|
2016-03-30 09:54:01 +00:00
|
|
|
|
|
|
|
|
2014-08-26 16:54:18 +00:00
|
|
|
# TODO: Needs unit testing
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomMembershipRestServlet(TransactionRestServlet):
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__(hs)
|
2018-03-01 10:54:37 +00:00
|
|
|
self.room_member_handler = hs.get_room_member_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2014-08-26 11:54:43 +00:00
|
|
|
def register(self, http_server):
|
|
|
|
# /rooms/$roomid/[invite|join|leave]
|
2015-12-01 17:34:32 +00:00
|
|
|
PATTERNS = (
|
|
|
|
"/rooms/(?P<room_id>[^/]*)/"
|
2018-03-13 12:12:55 +00:00
|
|
|
"(?P<membership_action>join|invite|leave|ban|unban|kick)"
|
|
|
|
)
|
2015-12-01 17:34:32 +00:00
|
|
|
register_txn_path(self, PATTERNS, http_server)
|
2014-08-26 11:54:43 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_POST(self, request, room_id, membership_action, txn_id=None):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2015-11-17 22:17:30 +00:00
|
|
|
|
2016-01-11 15:29:57 +00:00
|
|
|
if requester.is_guest and membership_action not in {
|
|
|
|
Membership.JOIN,
|
|
|
|
Membership.LEAVE,
|
|
|
|
}:
|
2015-11-13 11:56:58 +00:00
|
|
|
raise AuthError(403, "Guest access not allowed")
|
2014-08-26 13:49:44 +00:00
|
|
|
|
2016-02-24 08:50:28 +00:00
|
|
|
try:
|
2016-03-09 11:26:26 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
2017-10-23 14:52:32 +00:00
|
|
|
except Exception:
|
2016-02-24 08:50:28 +00:00
|
|
|
# Turns out we used to ignore the body entirely, and some clients
|
|
|
|
# cheekily send invalid bodies.
|
|
|
|
content = {}
|
2014-08-26 11:54:43 +00:00
|
|
|
|
2015-11-05 16:43:19 +00:00
|
|
|
if membership_action == "invite" and self._has_3pid_invite_keys(content):
|
2020-08-20 19:07:42 +00:00
|
|
|
try:
|
|
|
|
await self.room_member_handler.do_3pid_invite(
|
|
|
|
room_id,
|
|
|
|
requester.user,
|
|
|
|
content["medium"],
|
|
|
|
content["address"],
|
|
|
|
content["id_server"],
|
|
|
|
requester,
|
|
|
|
txn_id,
|
|
|
|
content.get("id_access_token"),
|
|
|
|
)
|
|
|
|
except ShadowBanError:
|
|
|
|
# Pretend the request succeeded.
|
|
|
|
pass
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {}
|
2014-08-26 13:49:44 +00:00
|
|
|
|
2016-01-15 16:27:26 +00:00
|
|
|
target = requester.user
|
|
|
|
if membership_action in ["invite", "ban", "unban", "kick"]:
|
2018-07-13 19:53:01 +00:00
|
|
|
assert_params_in_dict(content, ["user_id"])
|
2016-01-15 16:27:26 +00:00
|
|
|
target = UserID.from_string(content["user_id"])
|
2015-11-13 11:56:58 +00:00
|
|
|
|
2017-02-14 15:10:55 +00:00
|
|
|
event_content = None
|
2019-11-28 11:02:04 +00:00
|
|
|
if "reason" in content:
|
2017-02-14 15:10:55 +00:00
|
|
|
event_content = {"reason": content["reason"]}
|
|
|
|
|
2020-08-20 19:07:42 +00:00
|
|
|
try:
|
|
|
|
await self.room_member_handler.update_membership(
|
|
|
|
requester=requester,
|
|
|
|
target=target,
|
|
|
|
room_id=room_id,
|
|
|
|
action=membership_action,
|
|
|
|
txn_id=txn_id,
|
|
|
|
third_party_signed=content.get("third_party_signed", None),
|
|
|
|
content=event_content,
|
|
|
|
)
|
|
|
|
except ShadowBanError:
|
|
|
|
# Pretend the request succeeded.
|
|
|
|
pass
|
2014-11-10 18:24:43 +00:00
|
|
|
|
2018-03-13 13:10:07 +00:00
|
|
|
return_value = {}
|
|
|
|
|
|
|
|
if membership_action == "join":
|
|
|
|
return_value["room_id"] = room_id
|
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, return_value
|
2014-08-26 13:49:44 +00:00
|
|
|
|
2015-11-05 16:43:19 +00:00
|
|
|
def _has_3pid_invite_keys(self, content):
|
2015-11-09 17:26:43 +00:00
|
|
|
for key in {"id_server", "medium", "address"}:
|
2015-11-05 16:43:19 +00:00
|
|
|
if key not in content:
|
|
|
|
return False
|
|
|
|
return True
|
|
|
|
|
2014-08-26 11:54:43 +00:00
|
|
|
def on_PUT(self, request, room_id, membership_action, txn_id):
|
2019-09-25 10:39:15 +00:00
|
|
|
set_tag("txn_id", txn_id)
|
|
|
|
|
2016-11-14 09:52:41 +00:00
|
|
|
return self.txns.fetch_or_execute_request(
|
2016-11-11 17:47:03 +00:00
|
|
|
request, self.on_POST, request, room_id, membership_action, txn_id
|
2016-11-11 15:08:24 +00:00
|
|
|
)
|
2014-08-26 11:54:43 +00:00
|
|
|
|
2014-10-30 11:10:17 +00:00
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomRedactEventRestServlet(TransactionRestServlet):
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__(hs)
|
2018-01-15 16:52:07 +00:00
|
|
|
self.event_creation_handler = hs.get_event_creation_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2014-09-23 14:28:32 +00:00
|
|
|
def register(self, http_server):
|
2015-12-01 17:34:32 +00:00
|
|
|
PATTERNS = "/rooms/(?P<room_id>[^/]*)/redact/(?P<event_id>[^/]*)"
|
|
|
|
register_txn_path(self, PATTERNS, http_server)
|
2014-09-23 14:28:32 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_POST(self, request, room_id, event_id, txn_id=None):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2016-03-09 11:26:26 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
2014-09-23 14:28:32 +00:00
|
|
|
|
2020-08-24 17:58:56 +00:00
|
|
|
try:
|
|
|
|
(
|
|
|
|
event,
|
|
|
|
_,
|
|
|
|
) = await self.event_creation_handler.create_and_send_nonmember_event(
|
|
|
|
requester,
|
|
|
|
{
|
|
|
|
"type": EventTypes.Redaction,
|
|
|
|
"content": content,
|
|
|
|
"room_id": room_id,
|
|
|
|
"sender": requester.user.to_string(),
|
|
|
|
"redacts": event_id,
|
|
|
|
},
|
|
|
|
txn_id=txn_id,
|
|
|
|
)
|
|
|
|
event_id = event.event_id
|
|
|
|
except ShadowBanError:
|
|
|
|
event_id = "$" + random_string(43)
|
2014-09-23 14:28:32 +00:00
|
|
|
|
2020-08-24 17:58:56 +00:00
|
|
|
set_tag("event_id", event_id)
|
|
|
|
return 200, {"event_id": event_id}
|
2014-09-23 14:28:32 +00:00
|
|
|
|
|
|
|
def on_PUT(self, request, room_id, event_id, txn_id):
|
2019-09-25 10:39:15 +00:00
|
|
|
set_tag("txn_id", txn_id)
|
|
|
|
|
2016-11-14 09:52:41 +00:00
|
|
|
return self.txns.fetch_or_execute_request(
|
2016-11-11 17:47:03 +00:00
|
|
|
request, self.on_POST, request, room_id, event_id, txn_id
|
2016-11-11 15:02:29 +00:00
|
|
|
)
|
2014-09-23 14:28:32 +00:00
|
|
|
|
2014-08-26 11:54:43 +00:00
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class RoomTypingRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns(
|
|
|
|
"/rooms/(?P<room_id>[^/]*)/typing/(?P<user_id>[^/]*)$", v1=True
|
2014-12-16 15:24:03 +00:00
|
|
|
)
|
2014-12-11 10:55:36 +00:00
|
|
|
|
2021-03-17 15:30:21 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2021-03-17 15:30:21 +00:00
|
|
|
self.hs = hs
|
2016-05-16 17:56:37 +00:00
|
|
|
self.presence_handler = hs.get_presence_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-02-15 17:10:40 +00:00
|
|
|
|
2020-07-16 14:12:54 +00:00
|
|
|
# If we're not on the typing writer instance we should scream if we get
|
|
|
|
# requests.
|
|
|
|
self._is_typing_writer = (
|
|
|
|
hs.config.worker.writers.typing == hs.get_instance_name()
|
|
|
|
)
|
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_PUT(self, request, room_id, user_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2014-12-11 10:55:36 +00:00
|
|
|
|
2020-07-16 14:12:54 +00:00
|
|
|
if not self._is_typing_writer:
|
|
|
|
raise Exception("Got /typing request on instance that is not typing writer")
|
|
|
|
|
2018-04-15 15:15:16 +00:00
|
|
|
room_id = urlparse.unquote(room_id)
|
|
|
|
target_user = UserID.from_string(urlparse.unquote(user_id))
|
2014-12-11 10:55:36 +00:00
|
|
|
|
2016-03-09 11:26:26 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
2014-12-11 10:55:36 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
await self.presence_handler.bump_presence_active_time(requester.user)
|
2016-02-15 17:10:40 +00:00
|
|
|
|
2016-09-23 12:56:14 +00:00
|
|
|
# Limit timeout to stop people from setting silly typing timeouts.
|
|
|
|
timeout = min(content.get("timeout", 30000), 120000)
|
|
|
|
|
2021-03-17 15:30:21 +00:00
|
|
|
# Defer getting the typing handler since it will raise on workers.
|
|
|
|
typing_handler = self.hs.get_typing_writer_handler()
|
|
|
|
|
2020-08-26 16:05:36 +00:00
|
|
|
try:
|
|
|
|
if content["typing"]:
|
2021-03-17 15:30:21 +00:00
|
|
|
await typing_handler.started_typing(
|
2020-08-26 16:05:36 +00:00
|
|
|
target_user=target_user,
|
|
|
|
requester=requester,
|
|
|
|
room_id=room_id,
|
|
|
|
timeout=timeout,
|
|
|
|
)
|
|
|
|
else:
|
2021-03-17 15:30:21 +00:00
|
|
|
await typing_handler.stopped_typing(
|
2020-08-26 16:05:36 +00:00
|
|
|
target_user=target_user, requester=requester, room_id=room_id
|
|
|
|
)
|
|
|
|
except ShadowBanError:
|
|
|
|
# Pretend this worked without error.
|
|
|
|
pass
|
2014-12-11 10:55:36 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {}
|
2014-12-11 10:55:36 +00:00
|
|
|
|
|
|
|
|
2020-02-18 16:23:25 +00:00
|
|
|
class RoomAliasListServlet(RestServlet):
|
2020-02-19 10:40:27 +00:00
|
|
|
PATTERNS = [
|
|
|
|
re.compile(
|
|
|
|
r"^/_matrix/client/unstable/org\.matrix\.msc2432"
|
|
|
|
r"/rooms/(?P<room_id>[^/]*)/aliases"
|
|
|
|
),
|
2021-06-03 12:50:49 +00:00
|
|
|
] + list(client_patterns("/rooms/(?P<room_id>[^/]*)/aliases$", unstable=False))
|
2020-02-18 16:23:25 +00:00
|
|
|
|
2021-03-17 15:30:21 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-02-18 16:23:25 +00:00
|
|
|
super().__init__()
|
|
|
|
self.auth = hs.get_auth()
|
2020-10-09 11:24:34 +00:00
|
|
|
self.directory_handler = hs.get_directory_handler()
|
2020-02-18 16:23:25 +00:00
|
|
|
|
|
|
|
async def on_GET(self, request, room_id):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
|
|
|
|
|
|
|
alias_list = await self.directory_handler.get_aliases_for_room(
|
|
|
|
requester, room_id
|
|
|
|
)
|
|
|
|
|
|
|
|
return 200, {"aliases": alias_list}
|
|
|
|
|
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class SearchRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/search$", v1=True)
|
2015-10-09 14:48:31 +00:00
|
|
|
|
2016-08-12 09:03:19 +00:00
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2020-10-09 11:24:34 +00:00
|
|
|
self.search_handler = hs.get_search_handler()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 09:03:19 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_POST(self, request):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2015-10-09 14:48:31 +00:00
|
|
|
|
2016-03-09 11:26:26 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
2015-10-09 14:48:31 +00:00
|
|
|
|
2018-07-13 19:40:14 +00:00
|
|
|
batch = parse_string(request, "next_batch")
|
2020-10-09 11:24:34 +00:00
|
|
|
results = await self.search_handler.search(requester.user, content, batch)
|
2015-10-09 14:48:31 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, results
|
2015-10-09 14:48:31 +00:00
|
|
|
|
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class JoinedRoomsRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/joined_rooms$", v1=True)
|
2016-12-08 11:39:03 +00:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2016-12-08 11:39:03 +00:00
|
|
|
self.store = hs.get_datastore()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-12-08 11:39:03 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
async def on_GET(self, request):
|
|
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
2016-12-08 11:39:03 +00:00
|
|
|
|
2019-10-29 13:09:24 +00:00
|
|
|
room_ids = await self.store.get_rooms_for_user(requester.user.to_string())
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {"joined_rooms": list(room_ids)}
|
2016-12-08 11:39:03 +00:00
|
|
|
|
|
|
|
|
2014-08-26 16:00:24 +00:00
|
|
|
def register_txn_path(servlet, regex_string, http_server, with_get=False):
|
2014-08-26 11:54:43 +00:00
|
|
|
"""Registers a transaction-based path.
|
|
|
|
|
|
|
|
This registers two paths:
|
|
|
|
PUT regex_string/$txnid
|
|
|
|
POST regex_string
|
|
|
|
|
|
|
|
Args:
|
|
|
|
regex_string (str): The regex string to register. Must NOT have a
|
|
|
|
trailing $ as this string will be appended to.
|
|
|
|
http_server : The http_server to register paths with.
|
2014-08-26 16:00:24 +00:00
|
|
|
with_get: True to also register respective GET paths for the PUTs.
|
2014-08-26 11:54:43 +00:00
|
|
|
"""
|
2015-12-01 17:34:32 +00:00
|
|
|
http_server.register_paths(
|
2019-07-24 12:07:35 +00:00
|
|
|
"POST",
|
|
|
|
client_patterns(regex_string + "$", v1=True),
|
|
|
|
servlet.on_POST,
|
|
|
|
servlet.__class__.__name__,
|
2014-08-26 11:54:43 +00:00
|
|
|
)
|
2015-12-01 17:34:32 +00:00
|
|
|
http_server.register_paths(
|
2014-08-26 11:54:43 +00:00
|
|
|
"PUT",
|
2019-06-03 11:28:59 +00:00
|
|
|
client_patterns(regex_string + "/(?P<txn_id>[^/]*)$", v1=True),
|
2014-08-26 11:54:43 +00:00
|
|
|
servlet.on_PUT,
|
2019-07-24 12:07:35 +00:00
|
|
|
servlet.__class__.__name__,
|
2014-08-26 11:54:43 +00:00
|
|
|
)
|
2014-08-26 16:00:24 +00:00
|
|
|
if with_get:
|
2015-12-01 17:34:32 +00:00
|
|
|
http_server.register_paths(
|
2014-10-30 11:10:17 +00:00
|
|
|
"GET",
|
2019-06-03 11:28:59 +00:00
|
|
|
client_patterns(regex_string + "/(?P<txn_id>[^/]*)$", v1=True),
|
2014-10-30 11:10:17 +00:00
|
|
|
servlet.on_GET,
|
2019-07-24 12:07:35 +00:00
|
|
|
servlet.__class__.__name__,
|
2014-10-30 11:10:17 +00:00
|
|
|
)
|
2014-08-26 11:54:43 +00:00
|
|
|
|
|
|
|
|
2021-03-18 18:24:16 +00:00
|
|
|
class RoomSpaceSummaryRestServlet(RestServlet):
|
|
|
|
PATTERNS = (
|
|
|
|
re.compile(
|
|
|
|
"^/_matrix/client/unstable/org.matrix.msc2946"
|
|
|
|
"/rooms/(?P<room_id>[^/]*)/spaces$"
|
|
|
|
),
|
|
|
|
)
|
|
|
|
|
2021-03-18 18:39:05 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2021-03-18 18:24:16 +00:00
|
|
|
super().__init__()
|
|
|
|
self._auth = hs.get_auth()
|
|
|
|
self._space_summary_handler = hs.get_space_summary_handler()
|
|
|
|
|
2021-03-19 12:20:11 +00:00
|
|
|
async def on_GET(
|
|
|
|
self, request: SynapseRequest, room_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2021-03-18 18:24:16 +00:00
|
|
|
requester = await self._auth.get_user_by_req(request, allow_guest=True)
|
|
|
|
|
|
|
|
return 200, await self._space_summary_handler.get_space_summary(
|
|
|
|
requester.user.to_string(),
|
|
|
|
room_id,
|
|
|
|
suggested_only=parse_boolean(request, "suggested_only", default=False),
|
|
|
|
max_rooms_per_space=parse_integer(request, "max_rooms_per_space"),
|
|
|
|
)
|
|
|
|
|
2021-05-11 16:21:43 +00:00
|
|
|
# TODO When switching to the stable endpoint, remove the POST handler.
|
2021-03-19 12:20:11 +00:00
|
|
|
async def on_POST(
|
|
|
|
self, request: SynapseRequest, room_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2021-03-18 18:24:16 +00:00
|
|
|
requester = await self._auth.get_user_by_req(request, allow_guest=True)
|
|
|
|
content = parse_json_object_from_request(request)
|
|
|
|
|
|
|
|
suggested_only = content.get("suggested_only", False)
|
|
|
|
if not isinstance(suggested_only, bool):
|
|
|
|
raise SynapseError(
|
|
|
|
400, "'suggested_only' must be a boolean", Codes.BAD_JSON
|
|
|
|
)
|
|
|
|
|
|
|
|
max_rooms_per_space = content.get("max_rooms_per_space")
|
|
|
|
if max_rooms_per_space is not None and not isinstance(max_rooms_per_space, int):
|
|
|
|
raise SynapseError(
|
|
|
|
400, "'max_rooms_per_space' must be an integer", Codes.BAD_JSON
|
|
|
|
)
|
|
|
|
|
|
|
|
return 200, await self._space_summary_handler.get_space_summary(
|
|
|
|
requester.user.to_string(),
|
|
|
|
room_id,
|
|
|
|
suggested_only=suggested_only,
|
|
|
|
max_rooms_per_space=max_rooms_per_space,
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2021-03-18 18:39:05 +00:00
|
|
|
def register_servlets(hs: "HomeServer", http_server, is_worker=False):
|
2021-06-22 09:02:53 +00:00
|
|
|
msc2716_enabled = hs.config.experimental.msc2716_enabled
|
|
|
|
|
2014-08-22 14:59:15 +00:00
|
|
|
RoomStateEventRestServlet(hs).register(http_server)
|
2014-08-12 14:10:52 +00:00
|
|
|
RoomMemberListRestServlet(hs).register(http_server)
|
2016-12-08 13:32:05 +00:00
|
|
|
JoinedRoomMemberListRestServlet(hs).register(http_server)
|
2014-08-12 14:10:52 +00:00
|
|
|
RoomMessageListRestServlet(hs).register(http_server)
|
|
|
|
JoinRoomAliasServlet(hs).register(http_server)
|
2014-08-26 11:54:43 +00:00
|
|
|
RoomMembershipRestServlet(hs).register(http_server)
|
2014-08-26 16:00:24 +00:00
|
|
|
RoomSendEventRestServlet(hs).register(http_server)
|
2021-06-22 09:02:53 +00:00
|
|
|
if msc2716_enabled:
|
|
|
|
RoomBatchSendEventRestServlet(hs).register(http_server)
|
2014-08-27 13:51:59 +00:00
|
|
|
PublicRoomListRestServlet(hs).register(http_server)
|
2014-08-27 15:42:33 +00:00
|
|
|
RoomStateRestServlet(hs).register(http_server)
|
2014-09-24 14:27:59 +00:00
|
|
|
RoomRedactEventRestServlet(hs).register(http_server)
|
2014-12-11 10:55:36 +00:00
|
|
|
RoomTypingRestServlet(hs).register(http_server)
|
2018-01-09 14:39:12 +00:00
|
|
|
RoomEventContextServlet(hs).register(http_server)
|
2021-05-26 18:35:16 +00:00
|
|
|
RoomSpaceSummaryRestServlet(hs).register(http_server)
|
2021-05-27 21:45:43 +00:00
|
|
|
RoomEventServlet(hs).register(http_server)
|
|
|
|
JoinedRoomsRestServlet(hs).register(http_server)
|
|
|
|
RoomAliasListServlet(hs).register(http_server)
|
|
|
|
SearchRestServlet(hs).register(http_server)
|
2021-03-18 18:24:16 +00:00
|
|
|
|
2020-12-29 12:40:12 +00:00
|
|
|
# Some servlets only get registered for the main process.
|
|
|
|
if not is_worker:
|
|
|
|
RoomCreateRestServlet(hs).register(http_server)
|
|
|
|
RoomForgetRestServlet(hs).register(http_server)
|
2018-07-19 10:03:33 +00:00
|
|
|
|
|
|
|
|
|
|
|
def register_deprecated_servlets(hs, http_server):
|
|
|
|
RoomInitialSyncRestServlet(hs).register(http_server)
|