123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753 |
- # Copyright 2021 The Matrix.org Foundation C.I.C.
- #
- # 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.
- from typing import Dict, List, Tuple, Type
- from typing_extensions import Literal
- from synapse.api.constants import MAX_GROUP_CATEGORYID_LENGTH, MAX_GROUP_ROLEID_LENGTH
- from synapse.api.errors import Codes, SynapseError
- from synapse.federation.transport.server._base import (
- Authenticator,
- BaseFederationServlet,
- )
- from synapse.http.servlet import parse_string_from_args
- from synapse.server import HomeServer
- from synapse.types import JsonDict, get_domain_from_id
- from synapse.util.ratelimitutils import FederationRateLimiter
- class BaseGroupsServerServlet(BaseFederationServlet):
- """Abstract base class for federation servlet classes which provides a groups server handler.
- See BaseFederationServlet for more information.
- """
- def __init__(
- self,
- hs: HomeServer,
- authenticator: Authenticator,
- ratelimiter: FederationRateLimiter,
- server_name: str,
- ):
- super().__init__(hs, authenticator, ratelimiter, server_name)
- self.handler = hs.get_groups_server_handler()
- class FederationGroupsProfileServlet(BaseGroupsServerServlet):
- """Get/set the basic profile of a group on behalf of a user"""
- PATH = "/groups/(?P<group_id>[^/]*)/profile"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.get_group_profile(group_id, requester_user_id)
- return 200, new_content
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.update_group_profile(
- group_id, requester_user_id, content
- )
- return 200, new_content
- class FederationGroupsSummaryServlet(BaseGroupsServerServlet):
- PATH = "/groups/(?P<group_id>[^/]*)/summary"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.get_group_summary(group_id, requester_user_id)
- return 200, new_content
- class FederationGroupsRoomsServlet(BaseGroupsServerServlet):
- """Get the rooms in a group on behalf of a user"""
- PATH = "/groups/(?P<group_id>[^/]*)/rooms"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.get_rooms_in_group(group_id, requester_user_id)
- return 200, new_content
- class FederationGroupsAddRoomsServlet(BaseGroupsServerServlet):
- """Add/remove room from group"""
- PATH = "/groups/(?P<group_id>[^/]*)/room/(?P<room_id>[^/]*)"
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- room_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.add_room_to_group(
- group_id, requester_user_id, room_id, content
- )
- return 200, new_content
- async def on_DELETE(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- room_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.remove_room_from_group(
- group_id, requester_user_id, room_id
- )
- return 200, new_content
- class FederationGroupsAddRoomsConfigServlet(BaseGroupsServerServlet):
- """Update room config in group"""
- PATH = (
- "/groups/(?P<group_id>[^/]*)/room/(?P<room_id>[^/]*)"
- "/config/(?P<config_key>[^/]*)"
- )
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- room_id: str,
- config_key: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- result = await self.handler.update_room_in_group(
- group_id, requester_user_id, room_id, config_key, content
- )
- return 200, result
- class FederationGroupsUsersServlet(BaseGroupsServerServlet):
- """Get the users in a group on behalf of a user"""
- PATH = "/groups/(?P<group_id>[^/]*)/users"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.get_users_in_group(group_id, requester_user_id)
- return 200, new_content
- class FederationGroupsInvitedUsersServlet(BaseGroupsServerServlet):
- """Get the users that have been invited to a group"""
- PATH = "/groups/(?P<group_id>[^/]*)/invited_users"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.get_invited_users_in_group(
- group_id, requester_user_id
- )
- return 200, new_content
- class FederationGroupsInviteServlet(BaseGroupsServerServlet):
- """Ask a group server to invite someone to the group"""
- PATH = "/groups/(?P<group_id>[^/]*)/users/(?P<user_id>[^/]*)/invite"
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- user_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.invite_to_group(
- group_id, user_id, requester_user_id, content
- )
- return 200, new_content
- class FederationGroupsAcceptInviteServlet(BaseGroupsServerServlet):
- """Accept an invitation from the group server"""
- PATH = "/groups/(?P<group_id>[^/]*)/users/(?P<user_id>[^/]*)/accept_invite"
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- user_id: str,
- ) -> Tuple[int, JsonDict]:
- if get_domain_from_id(user_id) != origin:
- raise SynapseError(403, "user_id doesn't match origin")
- new_content = await self.handler.accept_invite(group_id, user_id, content)
- return 200, new_content
- class FederationGroupsJoinServlet(BaseGroupsServerServlet):
- """Attempt to join a group"""
- PATH = "/groups/(?P<group_id>[^/]*)/users/(?P<user_id>[^/]*)/join"
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- user_id: str,
- ) -> Tuple[int, JsonDict]:
- if get_domain_from_id(user_id) != origin:
- raise SynapseError(403, "user_id doesn't match origin")
- new_content = await self.handler.join_group(group_id, user_id, content)
- return 200, new_content
- class FederationGroupsRemoveUserServlet(BaseGroupsServerServlet):
- """Leave or kick a user from the group"""
- PATH = "/groups/(?P<group_id>[^/]*)/users/(?P<user_id>[^/]*)/remove"
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- user_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.remove_user_from_group(
- group_id, user_id, requester_user_id, content
- )
- return 200, new_content
- class FederationGroupsSummaryRoomsServlet(BaseGroupsServerServlet):
- """Add/remove a room from the group summary, with optional category.
- Matches both:
- - /groups/:group/summary/rooms/:room_id
- - /groups/:group/summary/categories/:category/rooms/:room_id
- """
- PATH = (
- "/groups/(?P<group_id>[^/]*)/summary"
- "(/categories/(?P<category_id>[^/]+))?"
- "/rooms/(?P<room_id>[^/]*)"
- )
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- category_id: str,
- room_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- if category_id == "":
- raise SynapseError(
- 400, "category_id cannot be empty string", Codes.INVALID_PARAM
- )
- if len(category_id) > MAX_GROUP_CATEGORYID_LENGTH:
- raise SynapseError(
- 400,
- "category_id may not be longer than %s characters"
- % (MAX_GROUP_CATEGORYID_LENGTH,),
- Codes.INVALID_PARAM,
- )
- resp = await self.handler.update_group_summary_room(
- group_id,
- requester_user_id,
- room_id=room_id,
- category_id=category_id,
- content=content,
- )
- return 200, resp
- async def on_DELETE(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- category_id: str,
- room_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- if category_id == "":
- raise SynapseError(400, "category_id cannot be empty string")
- resp = await self.handler.delete_group_summary_room(
- group_id, requester_user_id, room_id=room_id, category_id=category_id
- )
- return 200, resp
- class FederationGroupsCategoriesServlet(BaseGroupsServerServlet):
- """Get all categories for a group"""
- PATH = "/groups/(?P<group_id>[^/]*)/categories/?"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- resp = await self.handler.get_group_categories(group_id, requester_user_id)
- return 200, resp
- class FederationGroupsCategoryServlet(BaseGroupsServerServlet):
- """Add/remove/get a category in a group"""
- PATH = "/groups/(?P<group_id>[^/]*)/categories/(?P<category_id>[^/]+)"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- category_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- resp = await self.handler.get_group_category(
- group_id, requester_user_id, category_id
- )
- return 200, resp
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- category_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- if category_id == "":
- raise SynapseError(400, "category_id cannot be empty string")
- if len(category_id) > MAX_GROUP_CATEGORYID_LENGTH:
- raise SynapseError(
- 400,
- "category_id may not be longer than %s characters"
- % (MAX_GROUP_CATEGORYID_LENGTH,),
- Codes.INVALID_PARAM,
- )
- resp = await self.handler.upsert_group_category(
- group_id, requester_user_id, category_id, content
- )
- return 200, resp
- async def on_DELETE(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- category_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- if category_id == "":
- raise SynapseError(400, "category_id cannot be empty string")
- resp = await self.handler.delete_group_category(
- group_id, requester_user_id, category_id
- )
- return 200, resp
- class FederationGroupsRolesServlet(BaseGroupsServerServlet):
- """Get roles in a group"""
- PATH = "/groups/(?P<group_id>[^/]*)/roles/?"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- resp = await self.handler.get_group_roles(group_id, requester_user_id)
- return 200, resp
- class FederationGroupsRoleServlet(BaseGroupsServerServlet):
- """Add/remove/get a role in a group"""
- PATH = "/groups/(?P<group_id>[^/]*)/roles/(?P<role_id>[^/]+)"
- async def on_GET(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- role_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- resp = await self.handler.get_group_role(group_id, requester_user_id, role_id)
- return 200, resp
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- role_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- if role_id == "":
- raise SynapseError(
- 400, "role_id cannot be empty string", Codes.INVALID_PARAM
- )
- if len(role_id) > MAX_GROUP_ROLEID_LENGTH:
- raise SynapseError(
- 400,
- "role_id may not be longer than %s characters"
- % (MAX_GROUP_ROLEID_LENGTH,),
- Codes.INVALID_PARAM,
- )
- resp = await self.handler.update_group_role(
- group_id, requester_user_id, role_id, content
- )
- return 200, resp
- async def on_DELETE(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- role_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- if role_id == "":
- raise SynapseError(400, "role_id cannot be empty string")
- resp = await self.handler.delete_group_role(
- group_id, requester_user_id, role_id
- )
- return 200, resp
- class FederationGroupsSummaryUsersServlet(BaseGroupsServerServlet):
- """Add/remove a user from the group summary, with optional role.
- Matches both:
- - /groups/:group/summary/users/:user_id
- - /groups/:group/summary/roles/:role/users/:user_id
- """
- PATH = (
- "/groups/(?P<group_id>[^/]*)/summary"
- "(/roles/(?P<role_id>[^/]+))?"
- "/users/(?P<user_id>[^/]*)"
- )
- async def on_POST(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- role_id: str,
- user_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- if role_id == "":
- raise SynapseError(400, "role_id cannot be empty string")
- if len(role_id) > MAX_GROUP_ROLEID_LENGTH:
- raise SynapseError(
- 400,
- "role_id may not be longer than %s characters"
- % (MAX_GROUP_ROLEID_LENGTH,),
- Codes.INVALID_PARAM,
- )
- resp = await self.handler.update_group_summary_user(
- group_id,
- requester_user_id,
- user_id=user_id,
- role_id=role_id,
- content=content,
- )
- return 200, resp
- async def on_DELETE(
- self,
- origin: str,
- content: Literal[None],
- query: Dict[bytes, List[bytes]],
- group_id: str,
- role_id: str,
- user_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- if role_id == "":
- raise SynapseError(400, "role_id cannot be empty string")
- resp = await self.handler.delete_group_summary_user(
- group_id, requester_user_id, user_id=user_id, role_id=role_id
- )
- return 200, resp
- class FederationGroupsSettingJoinPolicyServlet(BaseGroupsServerServlet):
- """Sets whether a group is joinable without an invite or knock"""
- PATH = "/groups/(?P<group_id>[^/]*)/settings/m.join_policy"
- async def on_PUT(
- self,
- origin: str,
- content: JsonDict,
- query: Dict[bytes, List[bytes]],
- group_id: str,
- ) -> Tuple[int, JsonDict]:
- requester_user_id = parse_string_from_args(
- query, "requester_user_id", required=True
- )
- if get_domain_from_id(requester_user_id) != origin:
- raise SynapseError(403, "requester_user_id doesn't match origin")
- new_content = await self.handler.set_group_join_policy(
- group_id, requester_user_id, content
- )
- return 200, new_content
- GROUP_SERVER_SERVLET_CLASSES: Tuple[Type[BaseFederationServlet], ...] = (
- FederationGroupsProfileServlet,
- FederationGroupsSummaryServlet,
- FederationGroupsRoomsServlet,
- FederationGroupsUsersServlet,
- FederationGroupsInvitedUsersServlet,
- FederationGroupsInviteServlet,
- FederationGroupsAcceptInviteServlet,
- FederationGroupsJoinServlet,
- FederationGroupsRemoveUserServlet,
- FederationGroupsSummaryRoomsServlet,
- FederationGroupsCategoriesServlet,
- FederationGroupsCategoryServlet,
- FederationGroupsRolesServlet,
- FederationGroupsRoleServlet,
- FederationGroupsSummaryUsersServlet,
- FederationGroupsAddRoomsServlet,
- FederationGroupsAddRoomsConfigServlet,
- FederationGroupsSettingJoinPolicyServlet,
- )
|