123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962 |
- # Copyright 2017 Vector Creations 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.
- import logging
- from functools import wraps
- from typing import TYPE_CHECKING, Any, Awaitable, Callable, Optional, Tuple
- from twisted.web.server import Request
- from synapse.api.constants import (
- MAX_GROUP_CATEGORYID_LENGTH,
- MAX_GROUP_ROLEID_LENGTH,
- MAX_GROUPID_LENGTH,
- )
- from synapse.api.errors import Codes, SynapseError
- from synapse.handlers.groups_local import GroupsLocalHandler
- from synapse.http.server import HttpServer
- from synapse.http.servlet import (
- RestServlet,
- assert_params_in_dict,
- parse_json_object_from_request,
- )
- from synapse.http.site import SynapseRequest
- from synapse.types import GroupID, JsonDict
- from ._base import client_patterns
- if TYPE_CHECKING:
- from synapse.server import HomeServer
- logger = logging.getLogger(__name__)
- def _validate_group_id(
- f: Callable[..., Awaitable[Tuple[int, JsonDict]]]
- ) -> Callable[..., Awaitable[Tuple[int, JsonDict]]]:
- """Wrapper to validate the form of the group ID.
- Can be applied to any on_FOO methods that accepts a group ID as a URL parameter.
- """
- @wraps(f)
- def wrapper(
- self: RestServlet, request: Request, group_id: str, *args: Any, **kwargs: Any
- ) -> Awaitable[Tuple[int, JsonDict]]:
- if not GroupID.is_valid(group_id):
- raise SynapseError(400, "%s is not a legal group ID" % (group_id,))
- return f(self, request, group_id, *args, **kwargs)
- return wrapper
- class GroupServlet(RestServlet):
- """Get the group profile"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/profile$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- group_description = await self.groups_handler.get_group_profile(
- group_id, requester_user_id
- )
- return 200, group_description
- @_validate_group_id
- async def on_POST(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- assert_params_in_dict(
- content, ("name", "avatar_url", "short_description", "long_description")
- )
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot create group profiles."
- await self.groups_handler.update_group_profile(
- group_id, requester_user_id, content
- )
- return 200, {}
- class GroupSummaryServlet(RestServlet):
- """Get the full group summary"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/summary$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- get_group_summary = await self.groups_handler.get_group_summary(
- group_id, requester_user_id
- )
- return 200, get_group_summary
- class GroupSummaryRoomsCatServlet(RestServlet):
- """Update/delete a rooms entry in the summary.
- Matches both:
- - /groups/:group/summary/rooms/:room_id
- - /groups/:group/summary/categories/:category/rooms/:room_id
- """
- PATTERNS = client_patterns(
- "/groups/(?P<group_id>[^/]*)/summary"
- "(/categories/(?P<category_id>[^/]+))?"
- "/rooms/(?P<room_id>[^/]*)$"
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self,
- request: SynapseRequest,
- group_id: str,
- category_id: Optional[str],
- room_id: str,
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- if category_id == "":
- raise SynapseError(400, "category_id cannot be empty", Codes.INVALID_PARAM)
- if category_id and 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,
- )
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group summaries."
- resp = await self.groups_handler.update_group_summary_room(
- group_id,
- requester_user_id,
- room_id=room_id,
- category_id=category_id,
- content=content,
- )
- return 200, resp
- @_validate_group_id
- async def on_DELETE(
- self, request: SynapseRequest, group_id: str, category_id: str, room_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group profiles."
- resp = await self.groups_handler.delete_group_summary_room(
- group_id, requester_user_id, room_id=room_id, category_id=category_id
- )
- return 200, resp
- class GroupCategoryServlet(RestServlet):
- """Get/add/update/delete a group category"""
- PATTERNS = client_patterns(
- "/groups/(?P<group_id>[^/]*)/categories/(?P<category_id>[^/]+)$"
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str, category_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- category = await self.groups_handler.get_group_category(
- group_id, requester_user_id, category_id=category_id
- )
- return 200, category
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str, category_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- if not category_id:
- raise SynapseError(400, "category_id cannot be empty", 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,
- )
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group categories."
- resp = await self.groups_handler.update_group_category(
- group_id, requester_user_id, category_id=category_id, content=content
- )
- return 200, resp
- @_validate_group_id
- async def on_DELETE(
- self, request: SynapseRequest, group_id: str, category_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group categories."
- resp = await self.groups_handler.delete_group_category(
- group_id, requester_user_id, category_id=category_id
- )
- return 200, resp
- class GroupCategoriesServlet(RestServlet):
- """Get all group categories"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/categories/$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- category = await self.groups_handler.get_group_categories(
- group_id, requester_user_id
- )
- return 200, category
- class GroupRoleServlet(RestServlet):
- """Get/add/update/delete a group role"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/roles/(?P<role_id>[^/]+)$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str, role_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- category = await self.groups_handler.get_group_role(
- group_id, requester_user_id, role_id=role_id
- )
- return 200, category
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str, role_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- if not role_id:
- raise SynapseError(400, "role_id cannot be empty", 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,
- )
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group roles."
- resp = await self.groups_handler.update_group_role(
- group_id, requester_user_id, role_id=role_id, content=content
- )
- return 200, resp
- @_validate_group_id
- async def on_DELETE(
- self, request: SynapseRequest, group_id: str, role_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group roles."
- resp = await self.groups_handler.delete_group_role(
- group_id, requester_user_id, role_id=role_id
- )
- return 200, resp
- class GroupRolesServlet(RestServlet):
- """Get all group roles"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/roles/$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- category = await self.groups_handler.get_group_roles(
- group_id, requester_user_id
- )
- return 200, category
- class GroupSummaryUsersRoleServlet(RestServlet):
- """Update/delete a user's entry in the summary.
- Matches both:
- - /groups/:group/summary/users/:room_id
- - /groups/:group/summary/roles/:role/users/:user_id
- """
- PATTERNS = client_patterns(
- "/groups/(?P<group_id>[^/]*)/summary"
- "(/roles/(?P<role_id>[^/]+))?"
- "/users/(?P<user_id>[^/]*)$"
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self,
- request: SynapseRequest,
- group_id: str,
- role_id: Optional[str],
- user_id: str,
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- if role_id == "":
- raise SynapseError(400, "role_id cannot be empty", Codes.INVALID_PARAM)
- if role_id and 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,
- )
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group summaries."
- resp = await self.groups_handler.update_group_summary_user(
- group_id,
- requester_user_id,
- user_id=user_id,
- role_id=role_id,
- content=content,
- )
- return 200, resp
- @_validate_group_id
- async def on_DELETE(
- self, request: SynapseRequest, group_id: str, role_id: str, user_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group summaries."
- resp = await self.groups_handler.delete_group_summary_user(
- group_id, requester_user_id, user_id=user_id, role_id=role_id
- )
- return 200, resp
- class GroupRoomServlet(RestServlet):
- """Get all rooms in a group"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/rooms$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- result = await self.groups_handler.get_rooms_in_group(
- group_id, requester_user_id
- )
- return 200, result
- class GroupUsersServlet(RestServlet):
- """Get all users in a group"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/users$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- result = await self.groups_handler.get_users_in_group(
- group_id, requester_user_id
- )
- return 200, result
- class GroupInvitedUsersServlet(RestServlet):
- """Get users invited to a group"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/invited_users$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_GET(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- result = await self.groups_handler.get_invited_users_in_group(
- group_id, requester_user_id
- )
- return 200, result
- class GroupSettingJoinPolicyServlet(RestServlet):
- """Set group join policy"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/settings/m.join_policy$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group join policy."
- result = await self.groups_handler.set_group_join_policy(
- group_id, requester_user_id, content
- )
- return 200, result
- class GroupCreateServlet(RestServlet):
- """Create a group"""
- PATTERNS = client_patterns("/create_group$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- self.server_name = hs.hostname
- async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- # TODO: Create group on remote server
- content = parse_json_object_from_request(request)
- localpart = content.pop("localpart")
- group_id = GroupID(localpart, self.server_name).to_string()
- if not localpart:
- raise SynapseError(400, "Group ID cannot be empty", Codes.INVALID_PARAM)
- if len(group_id) > MAX_GROUPID_LENGTH:
- raise SynapseError(
- 400,
- "Group ID may not be longer than %s characters" % (MAX_GROUPID_LENGTH,),
- Codes.INVALID_PARAM,
- )
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot create groups."
- result = await self.groups_handler.create_group(
- group_id, requester_user_id, content
- )
- return 200, result
- class GroupAdminRoomsServlet(RestServlet):
- """Add a room to the group"""
- PATTERNS = client_patterns(
- "/groups/(?P<group_id>[^/]*)/admin/rooms/(?P<room_id>[^/]*)$"
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str, room_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify rooms in a group."
- result = await self.groups_handler.add_room_to_group(
- group_id, requester_user_id, room_id, content
- )
- return 200, result
- @_validate_group_id
- async def on_DELETE(
- self, request: SynapseRequest, group_id: str, room_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group categories."
- result = await self.groups_handler.remove_room_from_group(
- group_id, requester_user_id, room_id
- )
- return 200, result
- class GroupAdminRoomsConfigServlet(RestServlet):
- """Update the config of a room in a group"""
- PATTERNS = client_patterns(
- "/groups/(?P<group_id>[^/]*)/admin/rooms/(?P<room_id>[^/]*)"
- "/config/(?P<config_key>[^/]*)$"
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str, room_id: str, config_key: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot modify group categories."
- result = await self.groups_handler.update_room_in_group(
- group_id, requester_user_id, room_id, config_key, content
- )
- return 200, result
- class GroupAdminUsersInviteServlet(RestServlet):
- """Invite a user to the group"""
- PATTERNS = client_patterns(
- "/groups/(?P<group_id>[^/]*)/admin/users/invite/(?P<user_id>[^/]*)$"
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- self.store = hs.get_datastores().main
- self.is_mine_id = hs.is_mine_id
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str, user_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- config = content.get("config", {})
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot invite users to a group."
- result = await self.groups_handler.invite(
- group_id, user_id, requester_user_id, config
- )
- return 200, result
- class GroupAdminUsersKickServlet(RestServlet):
- """Kick a user from the group"""
- PATTERNS = client_patterns(
- "/groups/(?P<group_id>[^/]*)/admin/users/remove/(?P<user_id>[^/]*)$"
- )
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str, user_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot kick users from a group."
- result = await self.groups_handler.remove_user_from_group(
- group_id, user_id, requester_user_id, content
- )
- return 200, result
- class GroupSelfLeaveServlet(RestServlet):
- """Leave a joined group"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/self/leave$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot leave a group for a users."
- result = await self.groups_handler.remove_user_from_group(
- group_id, requester_user_id, requester_user_id, content
- )
- return 200, result
- class GroupSelfJoinServlet(RestServlet):
- """Attempt to join a group, or knock"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/self/join$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot join a user to a group."
- result = await self.groups_handler.join_group(
- group_id, requester_user_id, content
- )
- return 200, result
- class GroupSelfAcceptInviteServlet(RestServlet):
- """Accept a group invite"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/self/accept_invite$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- assert isinstance(
- self.groups_handler, GroupsLocalHandler
- ), "Workers cannot accept an invite to a group."
- result = await self.groups_handler.accept_invite(
- group_id, requester_user_id, content
- )
- return 200, result
- class GroupSelfUpdatePublicityServlet(RestServlet):
- """Update whether we publicise a users membership of a group"""
- PATTERNS = client_patterns("/groups/(?P<group_id>[^/]*)/self/update_publicity$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.store = hs.get_datastores().main
- @_validate_group_id
- async def on_PUT(
- self, request: SynapseRequest, group_id: str
- ) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request)
- requester_user_id = requester.user.to_string()
- content = parse_json_object_from_request(request)
- publicise = content["publicise"]
- await self.store.update_group_publicity(group_id, requester_user_id, publicise)
- return 200, {}
- class PublicisedGroupsForUserServlet(RestServlet):
- """Get the list of groups a user is advertising"""
- PATTERNS = client_patterns("/publicised_groups/(?P<user_id>[^/]*)$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.store = hs.get_datastores().main
- self.groups_handler = hs.get_groups_local_handler()
- async def on_GET(
- self, request: SynapseRequest, user_id: str
- ) -> Tuple[int, JsonDict]:
- await self.auth.get_user_by_req(request, allow_guest=True)
- result = await self.groups_handler.get_publicised_groups_for_user(user_id)
- return 200, result
- class PublicisedGroupsForUsersServlet(RestServlet):
- """Get the list of groups a user is advertising"""
- PATTERNS = client_patterns("/publicised_groups$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.store = hs.get_datastores().main
- self.groups_handler = hs.get_groups_local_handler()
- async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- await self.auth.get_user_by_req(request, allow_guest=True)
- content = parse_json_object_from_request(request)
- user_ids = content["user_ids"]
- result = await self.groups_handler.bulk_get_publicised_groups(user_ids)
- return 200, result
- class GroupsForUserServlet(RestServlet):
- """Get all groups the logged in user is joined to"""
- PATTERNS = client_patterns("/joined_groups$")
- def __init__(self, hs: "HomeServer"):
- super().__init__()
- self.auth = hs.get_auth()
- self.clock = hs.get_clock()
- self.groups_handler = hs.get_groups_local_handler()
- async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
- requester = await self.auth.get_user_by_req(request, allow_guest=True)
- requester_user_id = requester.user.to_string()
- result = await self.groups_handler.get_joined_groups(requester_user_id)
- return 200, result
- def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
- GroupServlet(hs).register(http_server)
- GroupSummaryServlet(hs).register(http_server)
- GroupInvitedUsersServlet(hs).register(http_server)
- GroupUsersServlet(hs).register(http_server)
- GroupRoomServlet(hs).register(http_server)
- GroupSettingJoinPolicyServlet(hs).register(http_server)
- GroupCreateServlet(hs).register(http_server)
- GroupAdminRoomsServlet(hs).register(http_server)
- GroupAdminRoomsConfigServlet(hs).register(http_server)
- GroupAdminUsersInviteServlet(hs).register(http_server)
- GroupAdminUsersKickServlet(hs).register(http_server)
- GroupSelfLeaveServlet(hs).register(http_server)
- GroupSelfJoinServlet(hs).register(http_server)
- GroupSelfAcceptInviteServlet(hs).register(http_server)
- GroupsForUserServlet(hs).register(http_server)
- GroupCategoryServlet(hs).register(http_server)
- GroupCategoriesServlet(hs).register(http_server)
- GroupSummaryRoomsCatServlet(hs).register(http_server)
- GroupRoleServlet(hs).register(http_server)
- GroupRolesServlet(hs).register(http_server)
- GroupSelfUpdatePublicityServlet(hs).register(http_server)
- GroupSummaryUsersRoleServlet(hs).register(http_server)
- PublicisedGroupsForUserServlet(hs).register(http_server)
- PublicisedGroupsForUsersServlet(hs).register(http_server)
|