1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
# 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.
import logging
from http import HTTPStatus
from typing import TYPE_CHECKING, Dict, List, Tuple
from synapse.api.constants import EventTypes, JoinRules, Membership
from synapse.api.errors import SynapseError
from synapse.http.servlet import (
ResolveRoomIdMixin,
RestServlet,
parse_json_object_from_request,
)
from synapse.http.site import SynapseRequest
from synapse.rest.admin._base import admin_patterns, assert_user_is_admin
from synapse.storage.state import StateFilter
from synapse.types import JsonDict, UserID, create_requester
if TYPE_CHECKING:
from synapse.server import HomeServer
logger = logging.getLogger(__name__)
class RemoveSpaceMemberRestServlet(ResolveRoomIdMixin, RestServlet):
"""
Puppets a local user to remove them from all rooms in a space.
"""
PATTERNS = admin_patterns(
"/rooms/(?P<space_id>[^/]+)/hierarchy/members/(?P<user_id>[^/]+)$"
)
def __init__(self, hs: "HomeServer"):
super().__init__(hs)
self._hs = hs
self._auth = hs.get_auth()
self._store = hs.get_datastore()
self._room_member_handler = hs.get_room_member_handler()
self._space_hierarchy_handler = hs.get_space_hierarchy_handler()
async def on_DELETE(
self, request: SynapseRequest, space_id: str, user_id: str
) -> Tuple[int, JsonDict]:
"""Forces a local user to leave all non-public rooms in a space.
The space itself is always left, regardless of whether it is public.
May succeed partially if the user fails to leave some rooms.
Returns:
A tuple containing the HTTP status code and a JSON dictionary containing:
* `left_rooms`: A list of rooms that the user has been made to leave.
* `inaccessible_rooms`: A list of rooms and spaces that the local
homeserver is not in, and may have not been fully processed. Rooms may
appear here if:
* The room is a space that the local homeserver is not in, and so its
full list of child rooms could not be determined.
* The room is inaccessible to the local homeserver, and it is not known
whether the room is a subspace containing further rooms.
* `failed_rooms`: A dictionary of errors encountered when leaving rooms.
The keys of the dictionary are room IDs and the values of the dictionary
are error messages.
"""
requester = await self._auth.get_user_by_req(request)
await assert_user_is_admin(self._auth, requester.user)
content = parse_json_object_from_request(request, allow_empty_body=True)
include_remote_spaces = content.get("include_remote_spaces", True)
if not isinstance(include_remote_spaces, bool):
raise SynapseError(
HTTPStatus.BAD_REQUEST,
"'include_remote_spaces' parameter must be a boolean",
)
space_id, _ = await self.resolve_room_id(space_id)
target_user = UserID.from_string(user_id)
if not self._hs.is_mine(target_user):
raise SynapseError(
HTTPStatus.BAD_REQUEST,
"This endpoint can only be used with local users",
)
# Fetch the list of rooms the target user is currently in
user_rooms = await self._store.get_rooms_for_local_user_where_membership_is(
user_id, [Membership.INVITE, Membership.JOIN, Membership.KNOCK]
)
user_room_ids = {room.room_id for room in user_rooms}
# Fetch the list of rooms in the space hierarchy
(
descendants,
inaccessible_room_ids,
) = await self._space_hierarchy_handler.get_space_descendants(
space_id, enable_federation=include_remote_spaces
)
# Determine which rooms to leave by checking join rules
rooms_to_leave: List[str] = []
state_filter = StateFilter.from_types([(EventTypes.JoinRules, "")])
for room_id, _via in descendants:
if room_id not in user_room_ids:
# The user is not in this room. There is nothing to do here.
continue
current_state_ids = await self._store.get_filtered_current_state_ids(
room_id, state_filter
)
join_rules_event_id = current_state_ids.get((EventTypes.JoinRules, ""))
if join_rules_event_id is not None:
join_rules_event = await self._store.get_event(join_rules_event_id)
join_rules = join_rules_event.content.get("join_rule")
else:
# The user is invited to or has knocked on a room that is not known
# locally. Assume that such rooms are not public and should be left.
# If it turns out that the room is actually public, then we've not
# actually prevented the user from joining it.
join_rules = None
# Leave the room if it is not public, or it is the root space.
if join_rules != JoinRules.PUBLIC or room_id == space_id:
rooms_to_leave.append(room_id)
# Now start leaving rooms
failures: Dict[str, str] = {}
left_rooms: List[str] = []
fake_requester = create_requester(
target_user, authenticated_entity=requester.user.to_string()
)
for room_id in rooms_to_leave:
# There is a race condition here where the user may have left or been kicked
# from a room since their list of memberships was fetched.
# `update_membership` will raise if the user is no longer in the room,
# but it's tricky to distinguish from other failure modes.
try:
await self._room_member_handler.update_membership(
requester=fake_requester,
target=target_user,
room_id=room_id,
action=Membership.LEAVE,
content={},
ratelimit=False,
require_consent=False,
)
left_rooms.append(room_id)
except Exception as e:
failures[room_id] = str(e)
return 200, {
"left_rooms": left_rooms,
"inaccessible_rooms": inaccessible_room_ids,
"failed_rooms": failures,
}
|
