Add user_directory_include_pattern config param to expand search results to additional users

Initial commit; this doesn't work yet - the LIKE filtering seems too aggressive.
It also needs _do_initial_spam to be aware of prepopulating the whole user_directory_search table with all users...
...and it needs a handle_user_signup() or something to be added so that new signups get incrementally added to the table too.

Committing it here as a WIP
This commit is contained in:
Matthew Hodgson 2017-11-29 16:46:45 +00:00
parent 3ab2cfec47
commit 47d99a20d5
5 changed files with 58 additions and 9 deletions

View file

@ -36,6 +36,7 @@ from .workers import WorkerConfig
from .push import PushConfig
from .spam_checker import SpamCheckerConfig
from .groups import GroupsConfig
from .user_directory import UserDirectoryConfig
class HomeServerConfig(TlsConfig, ServerConfig, DatabaseConfig, LoggingConfig,
@ -44,7 +45,7 @@ class HomeServerConfig(TlsConfig, ServerConfig, DatabaseConfig, LoggingConfig,
AppServiceConfig, KeyConfig, SAML2Config, CasConfig,
JWTConfig, PasswordConfig, EmailConfig,
WorkerConfig, PasswordAuthProviderConfig, PushConfig,
SpamCheckerConfig, GroupsConfig,):
SpamCheckerConfig, GroupsConfig, UserDirectoryConfig,):
pass

View file

@ -0,0 +1,40 @@
# -*- coding: utf-8 -*-
# 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
"""
def read_config(self, config):
self.user_directory_include_pattern = "%"
user_directory_config = config.get("user_directory", None)
if user_directory_config:
self.user_directory_include_pattern = (
user_directory_config.get("include_pattern", "%")
)
def default_config(self, config_dir_path, server_name, **kwargs):
return """
# User Directory configuration
# 'include_pattern' defines an optional SQL LIKE pattern when querying the
# user directory in addition to publicly visible users. Defaults to "%%"
#
#user_directory:
# include_pattern: "%%:%s"
""" % (server_name)

View file

@ -25,7 +25,7 @@ from synapse.util.async import sleep
logger = logging.getLogger(__name__)
class UserDirectoyHandler(object):
class UserDirectoryHandler(object):
"""Handles querying of and keeping updated the user_directory.
N.B.: ASSUMES IT IS THE ONLY THING THAT MODIFIES THE USER DIRECTORY
@ -389,7 +389,7 @@ class UserDirectoyHandler(object):
"""Called when we might need to add user to directory
Args:
room_id (str): room_id that user joined or started being public that
room_id (str): room_id that user joined or started being public
user_id (str)
"""
logger.debug("Adding user to dir, %r", user_id)

View file

@ -50,7 +50,7 @@ from synapse.handlers.events import EventHandler, EventStreamHandler
from synapse.handlers.initial_sync import InitialSyncHandler
from synapse.handlers.receipts import ReceiptsHandler
from synapse.handlers.read_marker import ReadMarkerHandler
from synapse.handlers.user_directory import UserDirectoyHandler
from synapse.handlers.user_directory import UserDirectoryHandler
from synapse.handlers.groups_local import GroupsLocalHandler
from synapse.handlers.profile import ProfileHandler
from synapse.groups.groups_server import GroupsServerHandler
@ -321,7 +321,7 @@ class HomeServer(object):
return ActionGenerator(self)
def build_user_directory_handler(self):
return UserDirectoyHandler(self)
return UserDirectoryHandler(self)
def build_groups_local_handler(self):
return GroupsLocalHandler(self)

View file

@ -629,6 +629,10 @@ class UserDirectoryStore(SQLBaseStore):
]
}
"""
include_pattern = self.hs.config.user_directory_include_pattern or "%";
logger.error("include pattern is %s" % (include_pattern))
if isinstance(self.database_engine, PostgresEngine):
full_query, exact_query, prefix_query = _parse_query_postgres(search_term)
@ -647,7 +651,9 @@ class UserDirectoryStore(SQLBaseStore):
WHERE user_id = ? AND share_private
) AS s USING (user_id)
WHERE
(s.user_id IS NOT NULL OR p.user_id IS NOT NULL)
(s.user_id IS NOT NULL OR
p.user_id IS NOT NULL OR
d.user_id LIKE ?)
AND vector @@ to_tsquery('english', ?)
ORDER BY
(CASE WHEN s.user_id IS NOT NULL THEN 4.0 ELSE 1.0 END)
@ -672,7 +678,7 @@ class UserDirectoryStore(SQLBaseStore):
avatar_url IS NULL
LIMIT ?
"""
args = (user_id, full_query, exact_query, prefix_query, limit + 1,)
args = (user_id, include_pattern, full_query, exact_query, prefix_query, limit + 1,)
elif isinstance(self.database_engine, Sqlite3Engine):
search_query = _parse_query_sqlite(search_term)
@ -686,7 +692,9 @@ class UserDirectoryStore(SQLBaseStore):
WHERE user_id = ? AND share_private
) AS s USING (user_id)
WHERE
(s.user_id IS NOT NULL OR p.user_id IS NOT NULL)
(s.user_id IS NOT NULL OR
p.user_id IS NOT NULL OR
d.user_id LIKE ?)
AND value MATCH ?
ORDER BY
rank(matchinfo(user_directory_search)) DESC,
@ -694,7 +702,7 @@ class UserDirectoryStore(SQLBaseStore):
avatar_url IS NULL
LIMIT ?
"""
args = (user_id, search_query, limit + 1)
args = (user_id, include_pattern, search_query, limit + 1)
else:
# This should be unreachable.
raise Exception("Unrecognized database engine")