mirror of
https://mau.dev/maunium/synapse.git
synced 2024-09-07 18:36:48 +02:00
Merge pull request #4746 from matrix-org/anoa/public_rooms_federate_develop
Prevent showing non-fed rooms in fed /publicRooms v2
This commit is contained in:
commit
4dc945ba30
4 changed files with 65 additions and 13 deletions
1
changelog.d/4746.feature
Normal file
1
changelog.d/4746.feature
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Prevent showing rooms to other servers that were set to not federate.
|
|
@ -736,7 +736,8 @@ class PublicRoomList(BaseFederationServlet):
|
||||||
|
|
||||||
data = yield self.handler.get_local_public_room_list(
|
data = yield self.handler.get_local_public_room_list(
|
||||||
limit, since_token,
|
limit, since_token,
|
||||||
network_tuple=network_tuple
|
network_tuple=network_tuple,
|
||||||
|
from_federation=True,
|
||||||
)
|
)
|
||||||
defer.returnValue((200, data))
|
defer.returnValue((200, data))
|
||||||
|
|
||||||
|
|
|
@ -113,8 +113,7 @@ class GroupsServerHandler(object):
|
||||||
room_id = room_entry["room_id"]
|
room_id = room_entry["room_id"]
|
||||||
joined_users = yield self.store.get_users_in_room(room_id)
|
joined_users = yield self.store.get_users_in_room(room_id)
|
||||||
entry = yield self.room_list_handler.generate_room_entry(
|
entry = yield self.room_list_handler.generate_room_entry(
|
||||||
room_id, len(joined_users),
|
room_id, len(joined_users), with_alias=False, allow_private=True,
|
||||||
with_alias=False, allow_private=True,
|
|
||||||
)
|
)
|
||||||
entry = dict(entry) # so we don't change whats cached
|
entry = dict(entry) # so we don't change whats cached
|
||||||
entry.pop("room_id", None)
|
entry.pop("room_id", None)
|
||||||
|
@ -544,8 +543,7 @@ class GroupsServerHandler(object):
|
||||||
|
|
||||||
joined_users = yield self.store.get_users_in_room(room_id)
|
joined_users = yield self.store.get_users_in_room(room_id)
|
||||||
entry = yield self.room_list_handler.generate_room_entry(
|
entry = yield self.room_list_handler.generate_room_entry(
|
||||||
room_id, len(joined_users),
|
room_id, len(joined_users), with_alias=False, allow_private=True,
|
||||||
with_alias=False, allow_private=True,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
if not entry:
|
if not entry:
|
||||||
|
|
|
@ -50,16 +50,17 @@ class RoomListHandler(BaseHandler):
|
||||||
|
|
||||||
def get_local_public_room_list(self, limit=None, since_token=None,
|
def get_local_public_room_list(self, limit=None, since_token=None,
|
||||||
search_filter=None,
|
search_filter=None,
|
||||||
network_tuple=EMPTY_THIRD_PARTY_ID,):
|
network_tuple=EMPTY_THIRD_PARTY_ID,
|
||||||
|
from_federation=False):
|
||||||
"""Generate a local public room list.
|
"""Generate a local public room list.
|
||||||
|
|
||||||
There are multiple different lists: the main one plus one per third
|
There are multiple different lists: the main one plus one per third
|
||||||
party network. A client can ask for a specific list or to return all.
|
party network. A client can ask for a specific list or to return all.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
limit (int)
|
limit (int|None)
|
||||||
since_token (str)
|
since_token (str|None)
|
||||||
search_filter (dict)
|
search_filter (dict|None)
|
||||||
network_tuple (ThirdPartyInstanceID): Which public list to use.
|
network_tuple (ThirdPartyInstanceID): Which public list to use.
|
||||||
This can be (None, None) to indicate the main list, or a particular
|
This can be (None, None) to indicate the main list, or a particular
|
||||||
appservice and network id to use an appservice specific one.
|
appservice and network id to use an appservice specific one.
|
||||||
|
@ -87,14 +88,30 @@ class RoomListHandler(BaseHandler):
|
||||||
return self.response_cache.wrap(
|
return self.response_cache.wrap(
|
||||||
key,
|
key,
|
||||||
self._get_public_room_list,
|
self._get_public_room_list,
|
||||||
limit, since_token, network_tuple=network_tuple,
|
limit, since_token,
|
||||||
|
network_tuple=network_tuple, from_federation=from_federation,
|
||||||
)
|
)
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def _get_public_room_list(self, limit=None, since_token=None,
|
def _get_public_room_list(self, limit=None, since_token=None,
|
||||||
search_filter=None,
|
search_filter=None,
|
||||||
network_tuple=EMPTY_THIRD_PARTY_ID,
|
network_tuple=EMPTY_THIRD_PARTY_ID,
|
||||||
|
from_federation=False,
|
||||||
timeout=None,):
|
timeout=None,):
|
||||||
|
"""Generate a public room list.
|
||||||
|
Args:
|
||||||
|
limit (int|None): Maximum amount of rooms to return.
|
||||||
|
since_token (str|None)
|
||||||
|
search_filter (dict|None): Dictionary to filter rooms by.
|
||||||
|
network_tuple (ThirdPartyInstanceID): Which public list to use.
|
||||||
|
This can be (None, None) to indicate the main list, or a particular
|
||||||
|
appservice and network id to use an appservice specific one.
|
||||||
|
Setting to None returns all public rooms across all lists.
|
||||||
|
from_federation (bool): Whether this request originated from a
|
||||||
|
federating server or a client. Used for room filtering.
|
||||||
|
timeout (int|None): Amount of seconds to wait for a response before
|
||||||
|
timing out.
|
||||||
|
"""
|
||||||
if since_token and since_token != "END":
|
if since_token and since_token != "END":
|
||||||
since_token = RoomListNextBatch.from_token(since_token)
|
since_token = RoomListNextBatch.from_token(since_token)
|
||||||
else:
|
else:
|
||||||
|
@ -217,7 +234,8 @@ class RoomListHandler(BaseHandler):
|
||||||
yield concurrently_execute(
|
yield concurrently_execute(
|
||||||
lambda r: self._append_room_entry_to_chunk(
|
lambda r: self._append_room_entry_to_chunk(
|
||||||
r, rooms_to_num_joined[r],
|
r, rooms_to_num_joined[r],
|
||||||
chunk, limit, search_filter
|
chunk, limit, search_filter,
|
||||||
|
from_federation=from_federation,
|
||||||
),
|
),
|
||||||
batch, 5,
|
batch, 5,
|
||||||
)
|
)
|
||||||
|
@ -288,23 +306,51 @@ class RoomListHandler(BaseHandler):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def _append_room_entry_to_chunk(self, room_id, num_joined_users, chunk, limit,
|
def _append_room_entry_to_chunk(self, room_id, num_joined_users, chunk, limit,
|
||||||
search_filter):
|
search_filter, from_federation=False):
|
||||||
"""Generate the entry for a room in the public room list and append it
|
"""Generate the entry for a room in the public room list and append it
|
||||||
to the `chunk` if it matches the search filter
|
to the `chunk` if it matches the search filter
|
||||||
|
|
||||||
|
Args:
|
||||||
|
room_id (str): The ID of the room.
|
||||||
|
num_joined_users (int): The number of joined users in the room.
|
||||||
|
chunk (list)
|
||||||
|
limit (int|None): Maximum amount of rooms to display. Function will
|
||||||
|
return if length of chunk is greater than limit + 1.
|
||||||
|
search_filter (dict|None)
|
||||||
|
from_federation (bool): Whether this request originated from a
|
||||||
|
federating server or a client. Used for room filtering.
|
||||||
"""
|
"""
|
||||||
if limit and len(chunk) > limit + 1:
|
if limit and len(chunk) > limit + 1:
|
||||||
# We've already got enough, so lets just drop it.
|
# We've already got enough, so lets just drop it.
|
||||||
return
|
return
|
||||||
|
|
||||||
result = yield self.generate_room_entry(room_id, num_joined_users)
|
result = yield self.generate_room_entry(room_id, num_joined_users)
|
||||||
|
if not result:
|
||||||
|
return
|
||||||
|
|
||||||
if result and _matches_room_entry(result, search_filter):
|
if from_federation and not result.get("m.federate", True):
|
||||||
|
# This is a room that other servers cannot join. Do not show them
|
||||||
|
# this room.
|
||||||
|
return
|
||||||
|
|
||||||
|
if _matches_room_entry(result, search_filter):
|
||||||
chunk.append(result)
|
chunk.append(result)
|
||||||
|
|
||||||
@cachedInlineCallbacks(num_args=1, cache_context=True)
|
@cachedInlineCallbacks(num_args=1, cache_context=True)
|
||||||
def generate_room_entry(self, room_id, num_joined_users, cache_context,
|
def generate_room_entry(self, room_id, num_joined_users, cache_context,
|
||||||
with_alias=True, allow_private=False):
|
with_alias=True, allow_private=False):
|
||||||
"""Returns the entry for a room
|
"""Returns the entry for a room
|
||||||
|
|
||||||
|
Args:
|
||||||
|
room_id (str): The room's ID.
|
||||||
|
num_joined_users (int): Number of users in the room.
|
||||||
|
cache_context: Information for cached responses.
|
||||||
|
with_alias (bool): Whether to return the room's aliases in the result.
|
||||||
|
allow_private (bool): Whether invite-only rooms should be shown.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Deferred[dict|None]: Returns a room entry as a dictionary, or None if this
|
||||||
|
room was determined not to be shown publicly.
|
||||||
"""
|
"""
|
||||||
result = {
|
result = {
|
||||||
"room_id": room_id,
|
"room_id": room_id,
|
||||||
|
@ -318,6 +364,7 @@ class RoomListHandler(BaseHandler):
|
||||||
event_map = yield self.store.get_events([
|
event_map = yield self.store.get_events([
|
||||||
event_id for key, event_id in iteritems(current_state_ids)
|
event_id for key, event_id in iteritems(current_state_ids)
|
||||||
if key[0] in (
|
if key[0] in (
|
||||||
|
EventTypes.Create,
|
||||||
EventTypes.JoinRules,
|
EventTypes.JoinRules,
|
||||||
EventTypes.Name,
|
EventTypes.Name,
|
||||||
EventTypes.Topic,
|
EventTypes.Topic,
|
||||||
|
@ -334,12 +381,17 @@ class RoomListHandler(BaseHandler):
|
||||||
}
|
}
|
||||||
|
|
||||||
# Double check that this is actually a public room.
|
# Double check that this is actually a public room.
|
||||||
|
|
||||||
join_rules_event = current_state.get((EventTypes.JoinRules, ""))
|
join_rules_event = current_state.get((EventTypes.JoinRules, ""))
|
||||||
if join_rules_event:
|
if join_rules_event:
|
||||||
join_rule = join_rules_event.content.get("join_rule", None)
|
join_rule = join_rules_event.content.get("join_rule", None)
|
||||||
if not allow_private and join_rule and join_rule != JoinRules.PUBLIC:
|
if not allow_private and join_rule and join_rule != JoinRules.PUBLIC:
|
||||||
defer.returnValue(None)
|
defer.returnValue(None)
|
||||||
|
|
||||||
|
# Return whether this room is open to federation users or not
|
||||||
|
create_event = current_state.get((EventTypes.Create, ""))
|
||||||
|
result["m.federate"] = create_event.content.get("m.federate", True)
|
||||||
|
|
||||||
if with_alias:
|
if with_alias:
|
||||||
aliases = yield self.store.get_aliases_for_room(
|
aliases = yield self.store.get_aliases_for_room(
|
||||||
room_id, on_invalidate=cache_context.invalidate
|
room_id, on_invalidate=cache_context.invalidate
|
||||||
|
|
Loading…
Reference in a new issue