From 47d99a20d5b4ae58ece15be8a43e96e39a9b943e Mon Sep 17 00:00:00 2001
From: Matthew Hodgson <matthew@matrix.org>
Date: Wed, 29 Nov 2017 16:46:45 +0000
Subject: 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
---
 synapse/config/homeserver.py     |  3 ++-
 synapse/config/user_directory.py | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+), 1 deletion(-)
 create mode 100644 synapse/config/user_directory.py

(limited to 'synapse/config')

diff --git a/synapse/config/homeserver.py b/synapse/config/homeserver.py
index 05e242aef6..bf19cfee29 100644
--- a/synapse/config/homeserver.py
+++ b/synapse/config/homeserver.py
@@ -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
 
 
diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py
new file mode 100644
index 0000000000..03fb2090c7
--- /dev/null
+++ b/synapse/config/user_directory.py
@@ -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)
-- 
cgit 1.4.1


From 3241c7aac3dc114a6abce46e5d241f42ed35a7fe Mon Sep 17 00:00:00 2001
From: Matthew Hodgson <matthew@matrix.org>
Date: Wed, 29 Nov 2017 18:27:05 +0000
Subject: untested WIP but might actually work

---
 synapse/config/user_directory.py   |  5 ++---
 synapse/handlers/profile.py        | 14 ++++++++++++
 synapse/handlers/user_directory.py | 46 ++++++++++++++++++++++++++++++++++----
 synapse/storage/_base.py           |  2 +-
 synapse/storage/profile.py         | 14 ++++++++++++
 synapse/storage/user_directory.py  | 35 +++++++++++++++++++----------
 6 files changed, 96 insertions(+), 20 deletions(-)

(limited to 'synapse/config')

diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py
index 03fb2090c7..86177da401 100644
--- a/synapse/config/user_directory.py
+++ b/synapse/config/user_directory.py
@@ -22,18 +22,17 @@ class UserDirectoryConfig(Config):
     """
 
     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", "%")
+                user_directory_config.get("include_pattern", None)
             )
 
     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 in addition to publicly visible users. Defaults to None.
         #
         #user_directory:
         #   include_pattern: "%%:%s"
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 5e5b1952dd..0a394a10b2 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -36,6 +36,8 @@ class ProfileHandler(BaseHandler):
             "profile", self.on_profile_query
         )
 
+        self.user_directory_handler = hs.get_user_directory_handler()
+
         self.clock.looping_call(self._update_remote_profile_cache, self.PROFILE_UPDATE_MS)
 
     @defer.inlineCallbacks
@@ -139,6 +141,12 @@ class ProfileHandler(BaseHandler):
             target_user.localpart, new_displayname
         )
 
+        if self.hs.config.user_directory_include_pattern:
+            profile = yield self.store.get_profileinfo(target_user.localpart)
+            yield self.user_directory_handler.handle_local_profile_change(
+                target_user.to_string(), profile
+            )
+
         yield self._update_join_states(requester, target_user)
 
     @defer.inlineCallbacks
@@ -183,6 +191,12 @@ class ProfileHandler(BaseHandler):
             target_user.localpart, new_avatar_url
         )
 
+        if self.hs.config.user_directory_include_pattern:
+            profile = yield self.store.get_profileinfo(target_user.localpart)
+            yield self.user_directory_handler.handle_local_profile_change(
+                target_user.user_id, profile
+            )
+
         yield self._update_join_states(requester, target_user)
 
     @defer.inlineCallbacks
diff --git a/synapse/handlers/user_directory.py b/synapse/handlers/user_directory.py
index 51f8340df5..1769e84698 100644
--- a/synapse/handlers/user_directory.py
+++ b/synapse/handlers/user_directory.py
@@ -110,6 +110,15 @@ class UserDirectoryHandler(object):
         finally:
             self._is_processing = False
 
+    @defer.inlineCallbacks
+    def handle_local_profile_change(self, user_id, profile):
+        """Called to update index of our local user profiles when they change
+        irrespective of any rooms the user may be in.
+        """
+        yield self.store.update_profile_in_user_dir(
+            user_id, profile.display_name, profile.avatar_url,
+        )
+
     @defer.inlineCallbacks
     def _unsafe_process(self):
         # If self.pos is None then means we haven't fetched it from DB
@@ -148,16 +157,30 @@ class UserDirectoryHandler(object):
         room_ids = yield self.store.get_all_rooms()
 
         logger.info("Doing initial update of user directory. %d rooms", len(room_ids))
-        num_processed_rooms = 1
+        num_processed_rooms = 0
 
         for room_id in room_ids:
-            logger.info("Handling room %d/%d", num_processed_rooms, len(room_ids))
+            logger.info("Handling room %d/%d", num_processed_rooms+1, len(room_ids))
             yield self._handle_initial_room(room_id)
             num_processed_rooms += 1
             yield sleep(self.INITIAL_SLEEP_MS / 1000.)
 
         logger.info("Processed all rooms.")
 
+        if self.hs.config.user_directory_include_pattern:
+            logger.info("Doing initial update of user directory. %d users", len(user_ids))
+            num_processed_users = 0
+            user_ids = yield self.store.get_all_local_users()
+            for user_id in user_ids:
+                # We add profiles for all users even if they don't match the
+                # include pattern, just in case we want to change it in future
+                logger.info("Handling user %d/%d", num_processed_users+1, len(user_ids))
+                yield self._handle_local_user(user_id)
+                num_processed_users += 1
+                yield sleep(self.INITIAL_SLEEP_MS / 1000.)
+
+            logger.info("Processed all users")
+
         self.initially_handled_users = None
         self.initially_handled_users_in_public = None
         self.initially_handled_users_share = None
@@ -384,6 +407,21 @@ class UserDirectoryHandler(object):
             for user_id in users:
                 yield self._handle_remove_user(room_id, user_id)
 
+    @defer.inlineCallbacks
+    def _handle_local_user(self, user_id):
+        """Adds a new local roomless user into the user_directory_search table.
+        Used to populate up the user index when we have an
+        user_directory_include_pattern specified.
+        """
+        logger.debug("Adding new local user to dir, %r", user_id)
+
+        profile = yield self.store.get_profileinfo(user_id)
+
+        row = yield self.store.get_user_in_directory(user_id)
+        if not row:
+            yield self.store.add_profiles_to_user_dir(None, {user_id: profile})
+
+
     @defer.inlineCallbacks
     def _handle_new_user(self, room_id, user_id, profile):
         """Called when we might need to add user to directory
@@ -392,7 +430,7 @@ class UserDirectoryHandler(object):
             room_id (str): room_id that user joined or started being public
             user_id (str)
         """
-        logger.debug("Adding user to dir, %r", user_id)
+        logger.debug("Adding new user to dir, %r", user_id)
 
         row = yield self.store.get_user_in_directory(user_id)
         if not row:
@@ -407,7 +445,7 @@ class UserDirectoryHandler(object):
             if not row:
                 yield self.store.add_users_to_public_room(room_id, [user_id])
         else:
-            logger.debug("Not adding user to public dir, %r", user_id)
+            logger.debug("Not adding new user to public dir, %r", user_id)
 
         # Now we update users who share rooms with users. We do this by getting
         # all the current users in the room and seeing which aren't already
diff --git a/synapse/storage/_base.py b/synapse/storage/_base.py
index e6eefdd6fe..0fdf49a2fd 100644
--- a/synapse/storage/_base.py
+++ b/synapse/storage/_base.py
@@ -547,7 +547,7 @@ class SQLBaseStore(object):
     def _simple_select_one(self, table, keyvalues, retcols,
                            allow_none=False, desc="_simple_select_one"):
         """Executes a SELECT query on the named table, which is expected to
-        return a single row, returning a single column from it.
+        return a single row, returning multiple columns from it.
 
         Args:
             table : string giving the table name
diff --git a/synapse/storage/profile.py b/synapse/storage/profile.py
index beea3102fc..484ad59b62 100644
--- a/synapse/storage/profile.py
+++ b/synapse/storage/profile.py
@@ -15,6 +15,8 @@
 
 from twisted.internet import defer
 
+from synapse.storage.roommember import ProfileInfo
+
 from ._base import SQLBaseStore
 
 
@@ -26,6 +28,18 @@ class ProfileStore(SQLBaseStore):
             desc="create_profile",
         )
 
+    def get_profileinfo(self, user_localpart):
+        profile = self._simple_select_one(
+            table="profiles",
+            keyvalues={"user_id": user_localpart},
+            retcols=("displayname", "avatar_url"),
+            desc="get_profileinfo",
+        )
+        return ProfileInfo(
+            avatar_url=profile.avatar_url,
+            displayname=profile.displayname,
+        )
+
     def get_profile_displayname(self, user_localpart):
         return self._simple_select_one_onecol(
             table="profiles",
diff --git a/synapse/storage/user_directory.py b/synapse/storage/user_directory.py
index 1022cdf7d0..1cc73e3878 100644
--- a/synapse/storage/user_directory.py
+++ b/synapse/storage/user_directory.py
@@ -164,7 +164,7 @@ class UserDirectoryStore(SQLBaseStore):
             )
 
             if isinstance(self.database_engine, PostgresEngine):
-                # We weight the loclpart most highly, then display name and finally
+                # We weight the localpart most highly, then display name and finally
                 # server name
                 if new_entry:
                     sql = """
@@ -317,6 +317,16 @@ class UserDirectoryStore(SQLBaseStore):
         rows = yield self._execute("get_all_rooms", None, sql)
         defer.returnValue([room_id for room_id, in rows])
 
+    @defer.inlineCallbacks
+    def get_all_local_users(self):
+        """Get all local users
+        """
+        sql = """
+            SELECT name FROM users
+        """
+        rows = yield self._execute("get_all_local_users", None, sql)
+        defer.returnValue([name for name, in rows])
+
     def add_users_who_share_room(self, room_id, share_private, user_id_tuples):
         """Insert entries into the users_who_share_rooms table. The first
         user should be a local user.
@@ -630,7 +640,12 @@ class UserDirectoryStore(SQLBaseStore):
                 }
         """
 
-        include_pattern = self.hs.config.user_directory_include_pattern or "%";
+        include_pattern_clause = ""
+        if self.hs.config.user_directory_include_pattern:
+            include_pattern_clause = "OR d.user_id LIKE '%s'" % (
+                self.hs.config.user_directory_include_pattern
+            )
+
         logger.error("include pattern is %s" % (include_pattern))
 
         if isinstance(self.database_engine, PostgresEngine):
@@ -651,9 +666,7 @@ 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 OR
-                     d.user_id LIKE ?)
+                    (s.user_id IS NOT NULL OR p.user_id IS NOT NULL %s)
                     AND vector @@ to_tsquery('english', ?)
                 ORDER BY
                     (CASE WHEN s.user_id IS NOT NULL THEN 4.0 ELSE 1.0 END)
@@ -677,8 +690,8 @@ class UserDirectoryStore(SQLBaseStore):
                     display_name IS NULL,
                     avatar_url IS NULL
                 LIMIT ?
-            """
-            args = (user_id, include_pattern, full_query, exact_query, prefix_query, limit + 1,)
+            """ % ( include_pattern_clause )
+            args = (user_id, full_query, exact_query, prefix_query, limit + 1,)
         elif isinstance(self.database_engine, Sqlite3Engine):
             search_query = _parse_query_sqlite(search_term)
 
@@ -692,17 +705,15 @@ 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 OR
-                     d.user_id LIKE ?)
+                    (s.user_id IS NOT NULL OR p.user_id IS NOT NULL %s)
                     AND value MATCH ?
                 ORDER BY
                     rank(matchinfo(user_directory_search)) DESC,
                     display_name IS NULL,
                     avatar_url IS NULL
                 LIMIT ?
-            """
-            args = (user_id, include_pattern, search_query, limit + 1)
+            """ % ( include_pattern_clause )
+            args = (user_id, search_query, limit + 1)
         else:
             # This should be unreachable.
             raise Exception("Unrecognized database engine")
-- 
cgit 1.4.1


From 5406392f8b4790e36bb60758436b18594ae7a8e0 Mon Sep 17 00:00:00 2001
From: Matthew Hodgson <matthew@matrix.org>
Date: Thu, 30 Nov 2017 01:45:34 +0000
Subject: specify default user_directory_include_pattern

---
 synapse/config/user_directory.py | 1 +
 1 file changed, 1 insertion(+)

(limited to 'synapse/config')

diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py
index 86177da401..cf358fe8a9 100644
--- a/synapse/config/user_directory.py
+++ b/synapse/config/user_directory.py
@@ -22,6 +22,7 @@ class UserDirectoryConfig(Config):
     """
 
     def read_config(self, config):
+        self.user_directory_include_pattern = None
         user_directory_config = config.get("user_directory", None)
         if user_directory_config:
             self.user_directory_include_pattern = (
-- 
cgit 1.4.1


From 1bd40ca73e1a6dc83d0a6c96f52071553960b3a8 Mon Sep 17 00:00:00 2001
From: Matthew Hodgson <matthew@matrix.org>
Date: Mon, 4 Dec 2017 14:58:39 +0000
Subject: switch to a simpler 'search_all_users' button as per review feedback

---
 synapse/config/user_directory.py   | 15 +++++++-------
 synapse/handlers/profile.py        |  4 ++--
 synapse/handlers/register.py       |  2 +-
 synapse/handlers/user_directory.py |  6 +++---
 synapse/storage/user_directory.py  | 40 +++++++++++++++-----------------------
 5 files changed, 30 insertions(+), 37 deletions(-)

(limited to 'synapse/config')

diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py
index cf358fe8a9..55b4e553ee 100644
--- a/synapse/config/user_directory.py
+++ b/synapse/config/user_directory.py
@@ -22,19 +22,20 @@ class UserDirectoryConfig(Config):
     """
 
     def read_config(self, config):
-        self.user_directory_include_pattern = None
+        self.user_directory_search_all_users = False
         user_directory_config = config.get("user_directory", None)
         if user_directory_config:
-            self.user_directory_include_pattern = (
-                user_directory_config.get("include_pattern", None)
+            self.user_directory_search_all_users = (
+                user_directory_config.get("search_all_users", False)
             )
 
     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 None.
+        # 'search_all_users' defines whether to search all users visible to your HS
+        # when searching the user directory, rather than limiting to users visible
+        # in public rooms. Defaults to false.
         #
         #user_directory:
-        #   include_pattern: "%%:%s"
-        """ % (server_name)
+        #   search_all_users: false
+        """
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 0a394a10b2..50e81a20e4 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -141,7 +141,7 @@ class ProfileHandler(BaseHandler):
             target_user.localpart, new_displayname
         )
 
-        if self.hs.config.user_directory_include_pattern:
+        if self.hs.config.user_directory_search_all_users:
             profile = yield self.store.get_profileinfo(target_user.localpart)
             yield self.user_directory_handler.handle_local_profile_change(
                 target_user.to_string(), profile
@@ -191,7 +191,7 @@ class ProfileHandler(BaseHandler):
             target_user.localpart, new_avatar_url
         )
 
-        if self.hs.config.user_directory_include_pattern:
+        if self.hs.config.user_directory_search_all_users:
             profile = yield self.store.get_profileinfo(target_user.localpart)
             yield self.user_directory_handler.handle_local_profile_change(
                 target_user.user_id, profile
diff --git a/synapse/handlers/register.py b/synapse/handlers/register.py
index 5db106dfca..4bc6ef51fe 100644
--- a/synapse/handlers/register.py
+++ b/synapse/handlers/register.py
@@ -167,7 +167,7 @@ class RegistrationHandler(BaseHandler):
                 admin=admin,
             )
 
-            if self.hs.config.user_directory_include_pattern:
+            if self.hs.config.user_directory_search_all_users:
                 profile = yield self.store.get_profileinfo(localpart)
                 yield self.user_directory_handler.handle_local_profile_change(
                     user_id, profile
diff --git a/synapse/handlers/user_directory.py b/synapse/handlers/user_directory.py
index b902f5d4e6..c1f8e20bfd 100644
--- a/synapse/handlers/user_directory.py
+++ b/synapse/handlers/user_directory.py
@@ -54,7 +54,7 @@ class UserDirectoryHandler(object):
         self.notifier = hs.get_notifier()
         self.is_mine_id = hs.is_mine_id
         self.update_user_directory = hs.config.update_user_directory
-        self.include_pattern = hs.config.user_directory_include_pattern
+        self.search_all_users = hs.config.user_directory_search_all_users
 
         # When start up for the first time we need to populate the user_directory.
         # This is a set of user_id's we've inserted already
@@ -169,7 +169,7 @@ class UserDirectoryHandler(object):
 
         logger.info("Processed all rooms.")
 
-        if self.include_pattern:
+        if self.search_all_users:
             num_processed_users = 0
             user_ids = yield self.store.get_all_local_users()
             logger.info("Doing initial update of user directory. %d users", len(user_ids))
@@ -413,7 +413,7 @@ class UserDirectoryHandler(object):
     def _handle_local_user(self, user_id):
         """Adds a new local roomless user into the user_directory_search table.
         Used to populate up the user index when we have an
-        user_directory_include_pattern specified.
+        user_directory_search_all_users specified.
         """
         logger.debug("Adding new local user to dir, %r", user_id)
 
diff --git a/synapse/storage/user_directory.py b/synapse/storage/user_directory.py
index 44b7d8906a..f9d2f8e60d 100644
--- a/synapse/storage/user_directory.py
+++ b/synapse/storage/user_directory.py
@@ -640,17 +640,19 @@ class UserDirectoryStore(SQLBaseStore):
                 }
         """
 
-        include_pattern_join = ""
-        include_pattern_where_clause = ""
-        if self.hs.config.user_directory_include_pattern:
-            include_pattern_join = """
-                LEFT JOIN (
-                    SELECT user_id FROM user_directory
-                    WHERE user_id LIKE '%s'
-                ) AS ld USING (user_id)
-            """ % ( self.hs.config.user_directory_include_pattern )
 
-            include_pattern_where_clause = "OR ld.user_id IS NOT NULL"
+        if self.hs.config.user_directory_search_all_users:
+            join_clause = ""
+            where_clause = "?<>''" # naughty hack to keep the same number of binds
+        else:
+            join_clause = """
+                LEFT JOIN users_in_public_rooms AS p USING (user_id)
+                LEFT JOIN (
+                    SELECT other_user_id AS user_id FROM users_who_share_rooms
+                    WHERE user_id = ? AND share_private
+                ) AS s USING (user_id)
+            """
+            where_clause = "(s.user_id IS NOT NULL OR p.user_id IS NOT NULL)"
 
         if isinstance(self.database_engine, PostgresEngine):
             full_query, exact_query, prefix_query = _parse_query_postgres(search_term)
@@ -664,14 +666,9 @@ class UserDirectoryStore(SQLBaseStore):
                 SELECT d.user_id, display_name, avatar_url
                 FROM user_directory_search
                 INNER JOIN user_directory AS d USING (user_id)
-                LEFT JOIN users_in_public_rooms AS p USING (user_id)
-                LEFT JOIN (
-                    SELECT other_user_id AS user_id FROM users_who_share_rooms
-                    WHERE user_id = ? AND share_private
-                ) AS s USING (user_id)
                 %s
                 WHERE
-                    (s.user_id IS NOT NULL OR p.user_id IS NOT NULL %s)
+                    %s
                     AND vector @@ to_tsquery('english', ?)
                 ORDER BY
                     (CASE WHEN s.user_id IS NOT NULL THEN 4.0 ELSE 1.0 END)
@@ -695,7 +692,7 @@ class UserDirectoryStore(SQLBaseStore):
                     display_name IS NULL,
                     avatar_url IS NULL
                 LIMIT ?
-            """ % ( include_pattern_join, include_pattern_where_clause )
+            """ % ( join_clause, where_clause )
             args = (user_id, full_query, exact_query, prefix_query, limit + 1,)
         elif isinstance(self.database_engine, Sqlite3Engine):
             search_query = _parse_query_sqlite(search_term)
@@ -704,21 +701,16 @@ class UserDirectoryStore(SQLBaseStore):
                 SELECT d.user_id, display_name, avatar_url
                 FROM user_directory_search
                 INNER JOIN user_directory AS d USING (user_id)
-                LEFT JOIN users_in_public_rooms AS p USING (user_id)
-                LEFT JOIN (
-                    SELECT other_user_id AS user_id FROM users_who_share_rooms
-                    WHERE user_id = ? AND share_private
-                ) AS s USING (user_id)
                 %s
                 WHERE
-                    (s.user_id IS NOT NULL OR p.user_id IS NOT NULL %s)
+                    %s
                     AND value MATCH ?
                 ORDER BY
                     rank(matchinfo(user_directory_search)) DESC,
                     display_name IS NULL,
                     avatar_url IS NULL
                 LIMIT ?
-            """ % ( include_pattern_join, include_pattern_where_clause )
+            """ % ( join_clause, where_clause )
             args = (user_id, search_query, limit + 1)
         else:
             # This should be unreachable.
-- 
cgit 1.4.1


From b11dca20252af94cfad900bf7aa1915844cb07b1 Mon Sep 17 00:00:00 2001
From: Matthew Hodgson <matthew@matrix.org>
Date: Mon, 4 Dec 2017 17:51:33 +0000
Subject: better doc

---
 synapse/config/user_directory.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'synapse/config')

diff --git a/synapse/config/user_directory.py b/synapse/config/user_directory.py
index 55b4e553ee..38e8947843 100644
--- a/synapse/config/user_directory.py
+++ b/synapse/config/user_directory.py
@@ -32,9 +32,12 @@ class UserDirectoryConfig(Config):
     def default_config(self, config_dir_path, server_name, **kwargs):
         return """
         # User Directory configuration
+        #
         # 'search_all_users' defines whether to search all users visible to your HS
         # when searching the user directory, rather than limiting to users visible
-        # in public rooms. Defaults to false.
+        # in public rooms.  Defaults to false.  If you set it True, you'll have to run
+        # UPDATE user_directory_stream_pos SET stream_id = NULL;
+        # on your database to tell it to rebuild the user_directory search indexes.
         #
         #user_directory:
         #   search_all_users: false
-- 
cgit 1.4.1