# -*- coding: utf-8 -*- # 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. from twisted.internet import defer from synapse.http.servlet import RestServlet, parse_json_object_from_request from synapse.types import GroupID from ._base import client_v2_patterns import logging logger = logging.getLogger(__name__) class GroupServlet(RestServlet): """Get the group profile """ PATTERNS = client_v2_patterns("/groups/(?P[^/]*)/profile$") def __init__(self, hs): super(GroupServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() group_description = yield self.groups_handler.get_group_profile( group_id, requester_user_id, ) defer.returnValue((200, group_description)) @defer.inlineCallbacks def on_POST(self, request, group_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) yield self.groups_handler.update_group_profile( group_id, requester_user_id, content, ) defer.returnValue((200, {})) class GroupSummaryServlet(RestServlet): """Get the full group summary """ PATTERNS = client_v2_patterns("/groups/(?P[^/]*)/summary$") def __init__(self, hs): super(GroupSummaryServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() get_group_summary = yield self.groups_handler.get_group_summary( group_id, requester_user_id, ) defer.returnValue((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_v2_patterns( "/groups/(?P[^/]*)/summary" "(/categories/(?P[^/]+))?" "/rooms/(?P[^/]*)$" ) def __init__(self, hs): super(GroupSummaryRoomsCatServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id, category_id, room_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) resp = yield self.groups_handler.update_group_summary_room( group_id, requester_user_id, room_id=room_id, category_id=category_id, content=content, ) defer.returnValue((200, resp)) @defer.inlineCallbacks def on_DELETE(self, request, group_id, category_id, room_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() resp = yield self.groups_handler.delete_group_summary_room( group_id, requester_user_id, room_id=room_id, category_id=category_id, ) defer.returnValue((200, resp)) class GroupCategoryServlet(RestServlet): """Get/add/update/delete a group category """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/categories/(?P[^/]+)$" ) def __init__(self, hs): super(GroupCategoryServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id, category_id): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() category = yield self.groups_handler.get_group_category( group_id, requester_user_id, category_id=category_id, ) defer.returnValue((200, category)) @defer.inlineCallbacks def on_PUT(self, request, group_id, category_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) resp = yield self.groups_handler.update_group_category( group_id, requester_user_id, category_id=category_id, content=content, ) defer.returnValue((200, resp)) @defer.inlineCallbacks def on_DELETE(self, request, group_id, category_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() resp = yield self.groups_handler.delete_group_category( group_id, requester_user_id, category_id=category_id, ) defer.returnValue((200, resp)) class GroupCategoriesServlet(RestServlet): """Get all group categories """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/categories/$" ) def __init__(self, hs): super(GroupCategoriesServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() category = yield self.groups_handler.get_group_categories( group_id, requester_user_id, ) defer.returnValue((200, category)) class GroupRoleServlet(RestServlet): """Get/add/update/delete a group role """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/roles/(?P[^/]+)$" ) def __init__(self, hs): super(GroupRoleServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id, role_id): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() category = yield self.groups_handler.get_group_role( group_id, requester_user_id, role_id=role_id, ) defer.returnValue((200, category)) @defer.inlineCallbacks def on_PUT(self, request, group_id, role_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) resp = yield self.groups_handler.update_group_role( group_id, requester_user_id, role_id=role_id, content=content, ) defer.returnValue((200, resp)) @defer.inlineCallbacks def on_DELETE(self, request, group_id, role_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() resp = yield self.groups_handler.delete_group_role( group_id, requester_user_id, role_id=role_id, ) defer.returnValue((200, resp)) class GroupRolesServlet(RestServlet): """Get all group roles """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/roles/$" ) def __init__(self, hs): super(GroupRolesServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() category = yield self.groups_handler.get_group_roles( group_id, requester_user_id, ) defer.returnValue((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_v2_patterns( "/groups/(?P[^/]*)/summary" "(/roles/(?P[^/]+))?" "/users/(?P[^/]*)$" ) def __init__(self, hs): super(GroupSummaryUsersRoleServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id, role_id, user_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) resp = yield self.groups_handler.update_group_summary_user( group_id, requester_user_id, user_id=user_id, role_id=role_id, content=content, ) defer.returnValue((200, resp)) @defer.inlineCallbacks def on_DELETE(self, request, group_id, role_id, user_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() resp = yield self.groups_handler.delete_group_summary_user( group_id, requester_user_id, user_id=user_id, role_id=role_id, ) defer.returnValue((200, resp)) class GroupRoomServlet(RestServlet): """Get all rooms in a group """ PATTERNS = client_v2_patterns("/groups/(?P[^/]*)/rooms$") def __init__(self, hs): super(GroupRoomServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() result = yield self.groups_handler.get_rooms_in_group(group_id, requester_user_id) defer.returnValue((200, result)) class GroupUsersServlet(RestServlet): """Get all users in a group """ PATTERNS = client_v2_patterns("/groups/(?P[^/]*)/users$") def __init__(self, hs): super(GroupUsersServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() result = yield self.groups_handler.get_users_in_group(group_id, requester_user_id) defer.returnValue((200, result)) class GroupInvitedUsersServlet(RestServlet): """Get users invited to a group """ PATTERNS = client_v2_patterns("/groups/(?P[^/]*)/invited_users$") def __init__(self, hs): super(GroupInvitedUsersServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, group_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() result = yield self.groups_handler.get_invited_users_in_group( group_id, requester_user_id, ) defer.returnValue((200, result)) class GroupSettingJoinPolicyServlet(RestServlet): """Set group join policy """ PATTERNS = client_v2_patterns("/groups/(?P[^/]*)/settings/m.join_policy$") def __init__(self, hs): super(GroupSettingJoinPolicyServlet, self).__init__() self.auth = hs.get_auth() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) result = yield self.groups_handler.set_group_join_policy( group_id, requester_user_id, content, ) defer.returnValue((200, result)) class GroupCreateServlet(RestServlet): """Create a group """ PATTERNS = client_v2_patterns("/create_group$") def __init__(self, hs): super(GroupCreateServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() self.server_name = hs.hostname @defer.inlineCallbacks def on_POST(self, request): requester = yield 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() result = yield self.groups_handler.create_group( group_id, requester_user_id, content, ) defer.returnValue((200, result)) class GroupAdminRoomsServlet(RestServlet): """Add a room to the group """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/admin/rooms/(?P[^/]*)$" ) def __init__(self, hs): super(GroupAdminRoomsServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id, room_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) result = yield self.groups_handler.add_room_to_group( group_id, requester_user_id, room_id, content, ) defer.returnValue((200, result)) @defer.inlineCallbacks def on_DELETE(self, request, group_id, room_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() result = yield self.groups_handler.remove_room_from_group( group_id, requester_user_id, room_id, ) defer.returnValue((200, result)) class GroupAdminRoomsConfigServlet(RestServlet): """Update the config of a room in a group """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/admin/rooms/(?P[^/]*)" "/config/(?P[^/]*)$" ) def __init__(self, hs): super(GroupAdminRoomsConfigServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id, room_id, config_key): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) result = yield self.groups_handler.update_room_in_group( group_id, requester_user_id, room_id, config_key, content, ) defer.returnValue((200, result)) class GroupAdminUsersInviteServlet(RestServlet): """Invite a user to the group """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/admin/users/invite/(?P[^/]*)$" ) def __init__(self, hs): super(GroupAdminUsersInviteServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() self.store = hs.get_datastore() self.is_mine_id = hs.is_mine_id @defer.inlineCallbacks def on_PUT(self, request, group_id, user_id): requester = yield 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", {}) result = yield self.groups_handler.invite( group_id, user_id, requester_user_id, config, ) defer.returnValue((200, result)) class GroupAdminUsersKickServlet(RestServlet): """Kick a user from the group """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/admin/users/remove/(?P[^/]*)$" ) def __init__(self, hs): super(GroupAdminUsersKickServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id, user_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) result = yield self.groups_handler.remove_user_from_group( group_id, user_id, requester_user_id, content, ) defer.returnValue((200, result)) class GroupSelfLeaveServlet(RestServlet): """Leave a joined group """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/self/leave$" ) def __init__(self, hs): super(GroupSelfLeaveServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) result = yield self.groups_handler.remove_user_from_group( group_id, requester_user_id, requester_user_id, content, ) defer.returnValue((200, result)) class GroupSelfJoinServlet(RestServlet): """Attempt to join a group, or knock """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/self/join$" ) def __init__(self, hs): super(GroupSelfJoinServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) result = yield self.groups_handler.join_group( group_id, requester_user_id, content, ) defer.returnValue((200, result)) class GroupSelfAcceptInviteServlet(RestServlet): """Accept a group invite """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/self/accept_invite$" ) def __init__(self, hs): super(GroupSelfAcceptInviteServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_PUT(self, request, group_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) result = yield self.groups_handler.accept_invite( group_id, requester_user_id, content, ) defer.returnValue((200, result)) class GroupSelfUpdatePublicityServlet(RestServlet): """Update whether we publicise a users membership of a group """ PATTERNS = client_v2_patterns( "/groups/(?P[^/]*)/self/update_publicity$" ) def __init__(self, hs): super(GroupSelfUpdatePublicityServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.store = hs.get_datastore() @defer.inlineCallbacks def on_PUT(self, request, group_id): requester = yield self.auth.get_user_by_req(request) requester_user_id = requester.user.to_string() content = parse_json_object_from_request(request) publicise = content["publicise"] yield self.store.update_group_publicity( group_id, requester_user_id, publicise, ) defer.returnValue((200, {})) class PublicisedGroupsForUserServlet(RestServlet): """Get the list of groups a user is advertising """ PATTERNS = client_v2_patterns( "/publicised_groups/(?P[^/]*)$" ) def __init__(self, hs): super(PublicisedGroupsForUserServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.store = hs.get_datastore() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request, user_id): yield self.auth.get_user_by_req(request, allow_guest=True) result = yield self.groups_handler.get_publicised_groups_for_user( user_id ) defer.returnValue((200, result)) class PublicisedGroupsForUsersServlet(RestServlet): """Get the list of groups a user is advertising """ PATTERNS = client_v2_patterns( "/publicised_groups$" ) def __init__(self, hs): super(PublicisedGroupsForUsersServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.store = hs.get_datastore() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_POST(self, request): yield self.auth.get_user_by_req(request, allow_guest=True) content = parse_json_object_from_request(request) user_ids = content["user_ids"] result = yield self.groups_handler.bulk_get_publicised_groups( user_ids ) defer.returnValue((200, result)) class GroupsForUserServlet(RestServlet): """Get all groups the logged in user is joined to """ PATTERNS = client_v2_patterns( "/joined_groups$" ) def __init__(self, hs): super(GroupsForUserServlet, self).__init__() self.auth = hs.get_auth() self.clock = hs.get_clock() self.groups_handler = hs.get_groups_local_handler() @defer.inlineCallbacks def on_GET(self, request): requester = yield self.auth.get_user_by_req(request, allow_guest=True) requester_user_id = requester.user.to_string() result = yield self.groups_handler.get_joined_groups(requester_user_id) defer.returnValue((200, result)) def register_servlets(hs, http_server): 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)