1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243 |
- # Copyright 2014-2016 OpenMarket Ltd
- # 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.
- """ This module contains REST servlets to do with rooms: /rooms/<paths> """
- import logging
- import re
- from typing import TYPE_CHECKING, Awaitable, Dict, List, Optional, Tuple
- from urllib import parse as urlparse
- from twisted.web.server import Request
- from synapse.api.constants import EventTypes, Membership
- from synapse.api.errors import (
- AuthError,
- Codes,
- InvalidClientCredentialsError,
- MissingClientTokenError,
- ShadowBanError,
- SynapseError,
- )
- from synapse.api.filtering import Filter
- from synapse.events.utils import format_event_for_client_v2
- from synapse.http.server import HttpServer
- from synapse.http.servlet import (
- ResolveRoomIdMixin,
- RestServlet,
- assert_params_in_dict,
- parse_boolean,
- parse_integer,
- parse_json_object_from_request,
- parse_string,
- parse_strings_from_args,
- )
- from synapse.http.site import SynapseRequest
- from synapse.logging.opentracing import set_tag
- from synapse.rest.client._base import client_patterns
- from synapse.rest.client.transactions import HttpTransactionCache
- from synapse.storage.state import StateFilter
- from synapse.streams.config import PaginationConfig
- from synapse.types import JsonDict, StreamToken, ThirdPartyInstanceID, UserID
- from synapse.util import json_decoder
- from synapse.util.stringutils import parse_and_validate_server_name, random_string
- if TYPE_CHECKING:
- from synapse.server import HomeServer
- logger = logging.getLogger(__name__)
- class TransactionRestServlet(RestServlet):
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.txns = HttpTransactionCache(hs)
- class RoomCreateRestServlet(TransactionRestServlet):
- # No PATTERN; we have custom dispatch rules here
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self._room_creation_handler = hs.get_room_creation_handler()
- self.auth = hs.get_auth()
- def register(self, http_server: HttpServer) -> None:
- PATTERNS = "/createRoom"
- register_txn_path(self, PATTERNS, http_server)
- def on_PUT(
- self, request: SynapseRequest, txn_id: str
- ) -> Awaitable[Tuple[int, JsonDict]]:
- set_tag("txn_id", txn_id)
- return self.txns.fetch_or_execute_request(request, self.on_POST, request)
- async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- info, _ = await self._room_creation_handler.create_room(
- requester, self.get_room_config(request)
- )
- return 200, info
- def get_room_config(self, request: Request) -> JsonDict:
- user_supplied_config = parse_json_object_from_request(request)
- return user_supplied_config
- # TODO: Needs unit testing for generic events
- class RoomStateEventRestServlet(TransactionRestServlet):
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self.event_creation_handler = hs.get_event_creation_handler()
- self.room_member_handler = hs.get_room_member_handler()
- self.message_handler = hs.get_message_handler()
- self.auth = hs.get_auth()
- def register(self, http_server: HttpServer) -> None:
- # /room/$roomid/state/$eventtype
- no_state_key = "/rooms/(?P<room_id>[^/]*)/state/(?P<event_type>[^/]*)$"
- # /room/$roomid/state/$eventtype/$statekey
- state_key = (
- "/rooms/(?P<room_id>[^/]*)/state/"
- "(?P<event_type>[^/]*)/(?P<state_key>[^/]*)$"
- )
- http_server.register_paths(
- "GET",
- client_patterns(state_key, v1=True),
- self.on_GET,
- self.__class__.__name__,
- )
- http_server.register_paths(
- "PUT",
- client_patterns(state_key, v1=True),
- self.on_PUT,
- self.__class__.__name__,
- )
- http_server.register_paths(
- "GET",
- client_patterns(no_state_key, v1=True),
- self.on_GET_no_state_key,
- self.__class__.__name__,
- )
- http_server.register_paths(
- "PUT",
- client_patterns(no_state_key, v1=True),
- self.on_PUT_no_state_key,
- self.__class__.__name__,
- )
- def on_GET_no_state_key(
- self, request: SynapseRequest, room_id: str, event_type: str
- ) -> Awaitable[Tuple[int, JsonDict]]:
- return self.on_GET(request, room_id, event_type, "")
- def on_PUT_no_state_key(
- self, request: SynapseRequest, room_id: str, event_type: str
- ) -> Awaitable[Tuple[int, JsonDict]]:
- return self.on_PUT(request, room_id, event_type, "")
- async def on_GET(
- self, request: SynapseRequest, room_id: str, event_type: str, state_key: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- format = parse_string(
- request, "format", default="content", allowed_values=["content", "event"]
- )
- msg_handler = self.message_handler
- data = await msg_handler.get_room_data(
- user_id=requester.user.to_string(),
- room_id=room_id,
- event_type=event_type,
- state_key=state_key,
- )
- if not data:
- raise SynapseError(404, "Event not found.", errcode=Codes.NOT_FOUND)
- if format == "event":
- event = format_event_for_client_v2(data.get_dict())
- return 200, event
- elif format == "content":
- return 200, data.get_dict()["content"]
- # Format must be event or content, per the parse_string call above.
- raise RuntimeError(f"Unknown format: {format:r}.")
- async def on_PUT(
- self,
- request: SynapseRequest,
- room_id: str,
- event_type: str,
- state_key: str,
- txn_id: Optional[str] = None,
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- if txn_id:
- set_tag("txn_id", txn_id)
- content = parse_json_object_from_request(request)
- event_dict = {
- "type": event_type,
- "content": content,
- "room_id": room_id,
- "sender": requester.user.to_string(),
- }
- if state_key is not None:
- event_dict["state_key"] = state_key
- try:
- if event_type == EventTypes.Member:
- 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,
- )
- 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)
- set_tag("event_id", event_id)
- ret = {"event_id": event_id}
- return 200, ret
- # TODO: Needs unit testing for generic events + feedback
- class RoomSendEventRestServlet(TransactionRestServlet):
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self.event_creation_handler = hs.get_event_creation_handler()
- self.auth = hs.get_auth()
- def register(self, http_server: HttpServer) -> None:
- # /rooms/$roomid/send/$event_type[/$txn_id]
- PATTERNS = "/rooms/(?P<room_id>[^/]*)/send/(?P<event_type>[^/]*)"
- register_txn_path(self, PATTERNS, http_server, with_get=True)
- async def on_POST(
- self,
- request: SynapseRequest,
- room_id: str,
- event_type: str,
- txn_id: Optional[str] = None,
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- content = parse_json_object_from_request(request)
- event_dict: JsonDict = {
- "type": event_type,
- "content": content,
- "room_id": room_id,
- "sender": requester.user.to_string(),
- }
- # Twisted will have processed the args by now.
- assert request.args is not None
- if b"ts" in request.args and requester.app_service:
- event_dict["origin_server_ts"] = parse_integer(request, "ts", 0)
- 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)
- set_tag("event_id", event_id)
- return 200, {"event_id": event_id}
- def on_GET(
- self, request: SynapseRequest, room_id: str, event_type: str, txn_id: str
- ) -> Tuple[int, str]:
- return 200, "Not implemented"
- def on_PUT(
- self, request: SynapseRequest, room_id: str, event_type: str, txn_id: str
- ) -> Awaitable[Tuple[int, JsonDict]]:
- set_tag("txn_id", txn_id)
- return self.txns.fetch_or_execute_request(
- request, self.on_POST, request, room_id, event_type, txn_id
- )
- # TODO: Needs unit testing for room ID + alias joins
- class JoinRoomAliasServlet(ResolveRoomIdMixin, TransactionRestServlet):
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- super(ResolveRoomIdMixin, self).__init__(hs) # ensure the Mixin is set up
- self.auth = hs.get_auth()
- def register(self, http_server: HttpServer) -> None:
- # /join/$room_identifier[/$txn_id]
- PATTERNS = "/join/(?P<room_identifier>[^/]*)"
- register_txn_path(self, PATTERNS, http_server)
- async def on_POST(
- self,
- request: SynapseRequest,
- room_identifier: str,
- txn_id: Optional[str] = None,
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- try:
- content = parse_json_object_from_request(request)
- except Exception:
- # Turns out we used to ignore the body entirely, and some clients
- # cheekily send invalid bodies.
- content = {}
- # 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)
- room_id, remote_room_hosts = await self.resolve_room_id(
- room_identifier,
- remote_room_hosts,
- )
- await self.room_member_handler.update_membership(
- requester=requester,
- target=requester.user,
- room_id=room_id,
- action="join",
- txn_id=txn_id,
- remote_room_hosts=remote_room_hosts,
- content=content,
- third_party_signed=content.get("third_party_signed", None),
- )
- return 200, {"room_id": room_id}
- def on_PUT(
- self, request: SynapseRequest, room_identifier: str, txn_id: str
- ) -> Awaitable[Tuple[int, JsonDict]]:
- set_tag("txn_id", txn_id)
- return self.txns.fetch_or_execute_request(
- request, self.on_POST, request, room_identifier, txn_id
- )
- # TODO: Needs unit testing
- class PublicRoomListRestServlet(TransactionRestServlet):
- PATTERNS = client_patterns("/publicRooms$", v1=True)
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self.hs = hs
- self.auth = hs.get_auth()
- async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- server = parse_string(request, "server")
- try:
- await self.auth.get_user_by_req(request, allow_guest=True)
- except InvalidClientCredentialsError as e:
- # Option to allow servers to require auth when accessing
- # /publicRooms via CS API. This is especially helpful in private
- # federations.
- if not self.hs.config.server.allow_public_rooms_without_auth:
- raise
- # 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
- limit: Optional[int] = parse_integer(request, "limit", 0)
- since_token = parse_string(request, "since")
- if limit == 0:
- # zero is a special value which corresponds to no limit.
- limit = None
- handler = self.hs.get_room_list_handler()
- if server and server != self.hs.config.server.server_name:
- # 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,
- )
- data = await handler.get_remote_public_room_list(
- server, limit=limit, since_token=since_token
- )
- else:
- data = await handler.get_local_public_room_list(
- limit=limit, since_token=since_token
- )
- return 200, data
- async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- await self.auth.get_user_by_req(request, allow_guest=True)
- server = parse_string(request, "server")
- content = parse_json_object_from_request(request)
- limit: Optional[int] = int(content.get("limit", 100))
- since_token = content.get("since", None)
- search_filter = content.get("filter", None)
- 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)
- if limit == 0:
- # zero is a special value which corresponds to no limit.
- limit = None
- handler = self.hs.get_room_list_handler()
- if server and server != self.hs.config.server.server_name:
- # 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,
- )
- 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,
- )
- else:
- data = await handler.get_local_public_room_list(
- limit=limit,
- since_token=since_token,
- search_filter=search_filter,
- network_tuple=network_tuple,
- )
- return 200, data
- # TODO: Needs unit testing
- class RoomMemberListRestServlet(RestServlet):
- PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/members$", v1=True)
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.message_handler = hs.get_message_handler()
- self.auth = hs.get_auth()
- self.store = hs.get_datastore()
- async def on_GET(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, JsonDict]:
- # TODO support Pagination stream API (limit/tokens)
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- 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:
- at_token = await StreamToken.from_string(self.store, at_token_string)
- # 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")
- events = await handler.get_state_events(
- room_id=room_id,
- user_id=requester.user.to_string(),
- at_token=at_token,
- state_filter=StateFilter.from_types([(EventTypes.Member, None)]),
- )
- chunk = []
- for event in events:
- if (membership and event["content"].get("membership") != membership) or (
- not_membership and event["content"].get("membership") == not_membership
- ):
- continue
- chunk.append(event)
- return 200, {"chunk": chunk}
- # deprecated in favour of /members?membership=join?
- # except it does custom AS logic and has a simpler return format
- class JoinedRoomMemberListRestServlet(RestServlet):
- PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/joined_members$", v1=True)
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.message_handler = hs.get_message_handler()
- self.auth = hs.get_auth()
- async def on_GET(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- users_with_profile = await self.message_handler.get_joined_members(
- requester, room_id
- )
- return 200, {"joined": users_with_profile}
- # TODO: Needs better unit testing
- class RoomMessageListRestServlet(RestServlet):
- PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/messages$", v1=True)
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.pagination_handler = hs.get_pagination_handler()
- self.auth = hs.get_auth()
- self.store = hs.get_datastore()
- async def on_GET(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- pagination_config = await PaginationConfig.from_request(
- self.store, request, default_limit=10
- )
- # Twisted will have processed the args by now.
- assert request.args is not None
- as_client_event = b"raw" not in request.args
- filter_str = parse_string(request, "filter", encoding="utf-8")
- if filter_str:
- filter_json = urlparse.unquote(filter_str)
- event_filter: Optional[Filter] = Filter(json_decoder.decode(filter_json))
- if (
- event_filter
- and event_filter.filter_json.get("event_format", "client")
- == "federation"
- ):
- as_client_event = False
- else:
- event_filter = None
- msgs = await self.pagination_handler.get_messages(
- room_id=room_id,
- requester=requester,
- pagin_config=pagination_config,
- as_client_event=as_client_event,
- event_filter=event_filter,
- )
- return 200, msgs
- # TODO: Needs unit testing
- class RoomStateRestServlet(RestServlet):
- PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/state$", v1=True)
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.message_handler = hs.get_message_handler()
- self.auth = hs.get_auth()
- async def on_GET(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, List[JsonDict]]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- # Get all the current state for this room
- events = await self.message_handler.get_state_events(
- room_id=room_id,
- user_id=requester.user.to_string(),
- is_guest=requester.is_guest,
- )
- return 200, events
- # TODO: Needs unit testing
- class RoomInitialSyncRestServlet(RestServlet):
- PATTERNS = client_patterns("/rooms/(?P<room_id>[^/]*)/initialSync$", v1=True)
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.initial_sync_handler = hs.get_initial_sync_handler()
- self.auth = hs.get_auth()
- self.store = hs.get_datastore()
- async def on_GET(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- pagination_config = await PaginationConfig.from_request(self.store, request)
- content = await self.initial_sync_handler.room_initial_sync(
- room_id=room_id, requester=requester, pagin_config=pagination_config
- )
- return 200, content
- class RoomEventServlet(RestServlet):
- PATTERNS = client_patterns(
- "/rooms/(?P<room_id>[^/]*)/event/(?P<event_id>[^/]*)$", v1=True
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.clock = hs.get_clock()
- self.event_handler = hs.get_event_handler()
- self._event_serializer = hs.get_event_client_serializer()
- self.auth = hs.get_auth()
- async def on_GET(
- self, request: SynapseRequest, room_id: str, event_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- try:
- event = await self.event_handler.get_event(
- 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)
- time_now = self.clock.time_msec()
- if event:
- event_dict = await self._event_serializer.serialize_event(event, time_now)
- return 200, event_dict
- raise SynapseError(404, "Event not found.", errcode=Codes.NOT_FOUND)
- class RoomEventContextServlet(RestServlet):
- PATTERNS = client_patterns(
- "/rooms/(?P<room_id>[^/]*)/context/(?P<event_id>[^/]*)$", v1=True
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.clock = hs.get_clock()
- self.room_context_handler = hs.get_room_context_handler()
- self._event_serializer = hs.get_event_client_serializer()
- self.auth = hs.get_auth()
- async def on_GET(
- self, request: SynapseRequest, room_id: str, event_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- limit = parse_integer(request, "limit", default=10)
- # picking the API shape for symmetry with /messages
- filter_str = parse_string(request, "filter", encoding="utf-8")
- if filter_str:
- filter_json = urlparse.unquote(filter_str)
- event_filter: Optional[Filter] = Filter(json_decoder.decode(filter_json))
- else:
- event_filter = None
- results = await self.room_context_handler.get_event_context(
- requester, room_id, event_id, limit, event_filter
- )
- if not results:
- raise SynapseError(404, "Event not found.", errcode=Codes.NOT_FOUND)
- time_now = self.clock.time_msec()
- results["events_before"] = await self._event_serializer.serialize_events(
- results["events_before"], time_now
- )
- results["event"] = await self._event_serializer.serialize_event(
- results["event"], time_now
- )
- results["events_after"] = await self._event_serializer.serialize_events(
- results["events_after"], time_now
- )
- results["state"] = await self._event_serializer.serialize_events(
- results["state"],
- time_now,
- # No need to bundle aggregations for state events
- bundle_aggregations=False,
- )
- return 200, results
- class RoomForgetRestServlet(TransactionRestServlet):
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self.room_member_handler = hs.get_room_member_handler()
- self.auth = hs.get_auth()
- def register(self, http_server: HttpServer) -> None:
- PATTERNS = "/rooms/(?P<room_id>[^/]*)/forget"
- register_txn_path(self, PATTERNS, http_server)
- async def on_POST(
- self, request: SynapseRequest, room_id: str, txn_id: Optional[str] = None
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=False)
- await self.room_member_handler.forget(user=requester.user, room_id=room_id)
- return 200, {}
- def on_PUT(
- self, request: SynapseRequest, room_id: str, txn_id: str
- ) -> Awaitable[Tuple[int, JsonDict]]:
- set_tag("txn_id", txn_id)
- return self.txns.fetch_or_execute_request(
- request, self.on_POST, request, room_id, txn_id
- )
- # TODO: Needs unit testing
- class RoomMembershipRestServlet(TransactionRestServlet):
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self.room_member_handler = hs.get_room_member_handler()
- self.auth = hs.get_auth()
- def register(self, http_server: HttpServer) -> None:
- # /rooms/$roomid/[invite|join|leave]
- PATTERNS = (
- "/rooms/(?P<room_id>[^/]*)/"
- "(?P<membership_action>join|invite|leave|ban|unban|kick)"
- )
- register_txn_path(self, PATTERNS, http_server)
- async def on_POST(
- self,
- request: SynapseRequest,
- room_id: str,
- membership_action: str,
- txn_id: Optional[str] = None,
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- if requester.is_guest and membership_action not in {
- Membership.JOIN,
- Membership.LEAVE,
- }:
- raise AuthError(403, "Guest access not allowed")
- try:
- content = parse_json_object_from_request(request)
- except Exception:
- # Turns out we used to ignore the body entirely, and some clients
- # cheekily send invalid bodies.
- content = {}
- if membership_action == "invite" and self._has_3pid_invite_keys(content):
- 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
- return 200, {}
- target = requester.user
- if membership_action in ["invite", "ban", "unban", "kick"]:
- assert_params_in_dict(content, ["user_id"])
- target = UserID.from_string(content["user_id"])
- event_content = None
- if "reason" in content:
- event_content = {"reason": content["reason"]}
- 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
- return_value = {}
- if membership_action == "join":
- return_value["room_id"] = room_id
- return 200, return_value
- def _has_3pid_invite_keys(self, content: JsonDict) -> bool:
- for key in {"id_server", "medium", "address"}:
- if key not in content:
- return False
- return True
- def on_PUT(
- self, request: SynapseRequest, room_id: str, membership_action: str, txn_id: str
- ) -> Awaitable[Tuple[int, JsonDict]]:
- set_tag("txn_id", txn_id)
- return self.txns.fetch_or_execute_request(
- request, self.on_POST, request, room_id, membership_action, txn_id
- )
- class RoomRedactEventRestServlet(TransactionRestServlet):
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self.event_creation_handler = hs.get_event_creation_handler()
- self.auth = hs.get_auth()
- def register(self, http_server: HttpServer) -> None:
- PATTERNS = "/rooms/(?P<room_id>[^/]*)/redact/(?P<event_id>[^/]*)"
- register_txn_path(self, PATTERNS, http_server)
- async def on_POST(
- self,
- request: SynapseRequest,
- room_id: str,
- event_id: str,
- txn_id: Optional[str] = None,
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- content = parse_json_object_from_request(request)
- 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)
- set_tag("event_id", event_id)
- return 200, {"event_id": event_id}
- def on_PUT(
- self, request: SynapseRequest, room_id: str, event_id: str, txn_id: str
- ) -> Awaitable[Tuple[int, JsonDict]]:
- set_tag("txn_id", txn_id)
- return self.txns.fetch_or_execute_request(
- request, self.on_POST, request, room_id, event_id, txn_id
- )
- class RoomTypingRestServlet(RestServlet):
- PATTERNS = client_patterns(
- "/rooms/(?P<room_id>[^/]*)/typing/(?P<user_id>[^/]*)$", v1=True
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.hs = hs
- self.presence_handler = hs.get_presence_handler()
- self.auth = hs.get_auth()
- # If we're not on the typing writer instance we should scream if we get
- # requests.
- self._is_typing_writer = (
- hs.get_instance_name() in hs.config.worker.writers.typing
- )
- async def on_PUT(
- self, request: SynapseRequest, room_id: str, user_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- if not self._is_typing_writer:
- raise Exception("Got /typing request on instance that is not typing writer")
- room_id = urlparse.unquote(room_id)
- target_user = UserID.from_string(urlparse.unquote(user_id))
- content = parse_json_object_from_request(request)
- await self.presence_handler.bump_presence_active_time(requester.user)
- # Limit timeout to stop people from setting silly typing timeouts.
- timeout = min(content.get("timeout", 30000), 120000)
- # Defer getting the typing handler since it will raise on workers.
- typing_handler = self.hs.get_typing_writer_handler()
- try:
- if content["typing"]:
- await typing_handler.started_typing(
- target_user=target_user,
- requester=requester,
- room_id=room_id,
- timeout=timeout,
- )
- else:
- await typing_handler.stopped_typing(
- target_user=target_user, requester=requester, room_id=room_id
- )
- except ShadowBanError:
- # Pretend this worked without error.
- pass
- return 200, {}
- class RoomAliasListServlet(RestServlet):
- PATTERNS = [
- re.compile(
- r"^/_matrix/client/unstable/org\.matrix\.msc2432"
- r"/rooms/(?P<room_id>[^/]*)/aliases"
- ),
- ] + list(client_patterns("/rooms/(?P<room_id>[^/]*)/aliases$", unstable=False))
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.directory_handler = hs.get_directory_handler()
- async def on_GET(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, JsonDict]:
- 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}
- class SearchRestServlet(RestServlet):
- PATTERNS = client_patterns("/search$", v1=True)
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.search_handler = hs.get_search_handler()
- self.auth = hs.get_auth()
- async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- content = parse_json_object_from_request(request)
- batch = parse_string(request, "next_batch")
- results = await self.search_handler.search(requester.user, content, batch)
- return 200, results
- class JoinedRoomsRestServlet(RestServlet):
- PATTERNS = client_patterns("/joined_rooms$", v1=True)
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.store = hs.get_datastore()
- self.auth = hs.get_auth()
- async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- room_ids = await self.store.get_rooms_for_user(requester.user.to_string())
- return 200, {"joined_rooms": list(room_ids)}
- def register_txn_path(
- servlet: RestServlet,
- regex_string: str,
- http_server: HttpServer,
- with_get: bool = False,
- ) -> None:
- """Registers a transaction-based path.
- This registers two paths:
- PUT regex_string/$txnid
- POST regex_string
- Args:
- regex_string: 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.
- with_get: True to also register respective GET paths for the PUTs.
- """
- on_POST = getattr(servlet, "on_POST", None)
- on_PUT = getattr(servlet, "on_PUT", None)
- if on_POST is None or on_PUT is None:
- raise RuntimeError("on_POST and on_PUT must exist when using register_txn_path")
- http_server.register_paths(
- "POST",
- client_patterns(regex_string + "$", v1=True),
- on_POST,
- servlet.__class__.__name__,
- )
- http_server.register_paths(
- "PUT",
- client_patterns(regex_string + "/(?P<txn_id>[^/]*)$", v1=True),
- on_PUT,
- servlet.__class__.__name__,
- )
- on_GET = getattr(servlet, "on_GET", None)
- if with_get:
- if on_GET is None:
- raise RuntimeError(
- "register_txn_path called with with_get = True, but no on_GET method exists"
- )
- http_server.register_paths(
- "GET",
- client_patterns(regex_string + "/(?P<txn_id>[^/]*)$", v1=True),
- on_GET,
- servlet.__class__.__name__,
- )
- class RoomSpaceSummaryRestServlet(RestServlet):
- PATTERNS = (
- re.compile(
- "^/_matrix/client/unstable/org.matrix.msc2946"
- "/rooms/(?P<room_id>[^/]*)/spaces$"
- ),
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self._auth = hs.get_auth()
- self._room_summary_handler = hs.get_room_summary_handler()
- async def on_GET(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self._auth.get_user_by_req(request, allow_guest=True)
- max_rooms_per_space = parse_integer(request, "max_rooms_per_space")
- if max_rooms_per_space is not None and max_rooms_per_space < 0:
- raise SynapseError(
- 400,
- "Value for 'max_rooms_per_space' must be a non-negative integer",
- Codes.BAD_JSON,
- )
- return 200, await self._room_summary_handler.get_space_summary(
- requester.user.to_string(),
- room_id,
- suggested_only=parse_boolean(request, "suggested_only", default=False),
- max_rooms_per_space=max_rooms_per_space,
- )
- # TODO When switching to the stable endpoint, remove the POST handler.
- async def on_POST(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, JsonDict]:
- 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:
- if not isinstance(max_rooms_per_space, int):
- raise SynapseError(
- 400, "'max_rooms_per_space' must be an integer", Codes.BAD_JSON
- )
- if max_rooms_per_space < 0:
- raise SynapseError(
- 400,
- "Value for 'max_rooms_per_space' must be a non-negative integer",
- Codes.BAD_JSON,
- )
- return 200, await self._room_summary_handler.get_space_summary(
- requester.user.to_string(),
- room_id,
- suggested_only=suggested_only,
- max_rooms_per_space=max_rooms_per_space,
- )
- class RoomHierarchyRestServlet(RestServlet):
- PATTERNS = (
- re.compile(
- "^/_matrix/client/unstable/org.matrix.msc2946"
- "/rooms/(?P<room_id>[^/]*)/hierarchy$"
- ),
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self._auth = hs.get_auth()
- self._room_summary_handler = hs.get_room_summary_handler()
- async def on_GET(
- self, request: SynapseRequest, room_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self._auth.get_user_by_req(request, allow_guest=True)
- max_depth = parse_integer(request, "max_depth")
- if max_depth is not None and max_depth < 0:
- raise SynapseError(
- 400, "'max_depth' must be a non-negative integer", Codes.BAD_JSON
- )
- limit = parse_integer(request, "limit")
- if limit is not None and limit <= 0:
- raise SynapseError(
- 400, "'limit' must be a positive integer", Codes.BAD_JSON
- )
- return 200, await self._room_summary_handler.get_room_hierarchy(
- requester.user.to_string(),
- room_id,
- suggested_only=parse_boolean(request, "suggested_only", default=False),
- max_depth=max_depth,
- limit=limit,
- from_token=parse_string(request, "from"),
- )
- class RoomSummaryRestServlet(ResolveRoomIdMixin, RestServlet):
- PATTERNS = (
- re.compile(
- "^/_matrix/client/unstable/im.nheko.summary"
- "/rooms/(?P<room_identifier>[^/]*)/summary$"
- ),
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self._auth = hs.get_auth()
- self._room_summary_handler = hs.get_room_summary_handler()
- async def on_GET(
- self, request: SynapseRequest, room_identifier: str
- ) -> Tuple[int, JsonDict]:
- try:
- requester = await self._auth.get_user_by_req(request, allow_guest=True)
- requester_user_id: Optional[str] = requester.user.to_string()
- except MissingClientTokenError:
- # auth is optional
- requester_user_id = None
- # 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, "via", required=False)
- room_id, remote_room_hosts = await self.resolve_room_id(
- room_identifier,
- remote_room_hosts,
- )
- return 200, await self._room_summary_handler.get_room_summary(
- requester_user_id,
- room_id,
- remote_room_hosts,
- )
- def register_servlets(
- hs: "HomeServer", http_server: HttpServer, is_worker: bool = False
- ) -> None:
- RoomStateEventRestServlet(hs).register(http_server)
- RoomMemberListRestServlet(hs).register(http_server)
- JoinedRoomMemberListRestServlet(hs).register(http_server)
- RoomMessageListRestServlet(hs).register(http_server)
- JoinRoomAliasServlet(hs).register(http_server)
- RoomMembershipRestServlet(hs).register(http_server)
- RoomSendEventRestServlet(hs).register(http_server)
- PublicRoomListRestServlet(hs).register(http_server)
- RoomStateRestServlet(hs).register(http_server)
- RoomRedactEventRestServlet(hs).register(http_server)
- RoomTypingRestServlet(hs).register(http_server)
- RoomEventContextServlet(hs).register(http_server)
- RoomSpaceSummaryRestServlet(hs).register(http_server)
- RoomHierarchyRestServlet(hs).register(http_server)
- if hs.config.experimental.msc3266_enabled:
- RoomSummaryRestServlet(hs).register(http_server)
- RoomEventServlet(hs).register(http_server)
- JoinedRoomsRestServlet(hs).register(http_server)
- RoomAliasListServlet(hs).register(http_server)
- SearchRestServlet(hs).register(http_server)
- RoomCreateRestServlet(hs).register(http_server)
- # Some servlets only get registered for the main process.
- if not is_worker:
- RoomForgetRestServlet(hs).register(http_server)
- def register_deprecated_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
- RoomInitialSyncRestServlet(hs).register(http_server)
|