mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-26 20:59:22 -05:00
60453315bd
It's a simplification, but one that'll help make the user directory logic easier to follow with the other changes upcoming. It's not strictly required for those changes, but this will help simplify the resulting logic that listens for `m.room.member` events and generally make the logic easier to follow. This means the config option `search_all_users` ends up controlling the search query only, and not the data we store. The cost of doing so is an extra row in the `user_directory` and `user_directory_search` tables for each local user which - belongs to no public rooms - belongs to no private rooms of size ≥ 2 I think the cost of this will be marginal (since they'll already have entries in `users` and `profiles` anyway). As a small upside, a homeserver whose directory was built with this change can toggle `search_all_users` without having to rebuild their directory. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
73 lines
3.0 KiB
Python
73 lines
3.0 KiB
Python
# Copyright 2017 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 ._base import Config
|
|
|
|
|
|
class UserDirectoryConfig(Config):
|
|
"""User Directory Configuration
|
|
Configuration for the behaviour of the /user_directory API
|
|
"""
|
|
|
|
section = "userdirectory"
|
|
|
|
def read_config(self, config, **kwargs):
|
|
user_directory_config = config.get("user_directory") or {}
|
|
self.user_directory_search_enabled = user_directory_config.get("enabled", True)
|
|
self.user_directory_search_all_users = user_directory_config.get(
|
|
"search_all_users", False
|
|
)
|
|
self.user_directory_search_prefer_local_users = user_directory_config.get(
|
|
"prefer_local_users", False
|
|
)
|
|
|
|
def generate_config_section(self, config_dir_path, server_name, **kwargs):
|
|
return """
|
|
# User Directory configuration
|
|
#
|
|
user_directory:
|
|
# Defines whether users can search the user directory. If false then
|
|
# empty responses are returned to all queries. Defaults to true.
|
|
#
|
|
# Uncomment to disable the user directory.
|
|
#
|
|
#enabled: false
|
|
|
|
# Defines whether to search all users visible to your HS when searching
|
|
# the user directory. If false, search results will only contain users
|
|
# visible in public rooms and users sharing a room with the requester.
|
|
# Defaults to false.
|
|
#
|
|
# NB. If you set this to true, and the last time the user_directory search
|
|
# indexes were (re)built was before Synapse 1.44, you'll have to
|
|
# rebuild the indexes in order to search through all known users.
|
|
# These indexes are built the first time Synapse starts; admins can
|
|
# manually trigger a rebuild following the instructions at
|
|
# https://matrix-org.github.io/synapse/latest/user_directory.html
|
|
#
|
|
# Uncomment to return search results containing all known users, even if that
|
|
# user does not share a room with the requester.
|
|
#
|
|
#search_all_users: true
|
|
|
|
# Defines whether to prefer local users in search query results.
|
|
# If True, local users are more likely to appear above remote users
|
|
# when searching the user directory. Defaults to false.
|
|
#
|
|
# Uncomment to prefer local over remote users in user directory search
|
|
# results.
|
|
#
|
|
#prefer_local_users: true
|
|
"""
|