untested WIP but might actually work

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"

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

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

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

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",

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
+                    (s.user_id IS NOT NULL OR p.user_id IS NOT NULL %s)
-                     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)
@@ -677,8 +690,8 @@ class UserDirectoryStore(SQLBaseStore):
                     display_name IS NULL,
                     avatar_url IS NULL
                 LIMIT ?
-            """
+            """ % ( include_pattern_clause )
-            args = (user_id, include_pattern, full_query, exact_query, prefix_query, limit + 1,)
+            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
+                    (s.user_id IS NOT NULL OR p.user_id IS NOT NULL %s)
-                     p.user_id IS NOT NULL OR
-                     d.user_id LIKE ?)
                     AND value MATCH ?
                 ORDER BY
                     rank(matchinfo(user_directory_search)) DESC,
                     display_name IS NULL,
                     avatar_url IS NULL
                 LIMIT ?
-            """
+            """ % ( include_pattern_clause )
-            args = (user_id, include_pattern, search_query, limit + 1)
+            args = (user_id, search_query, limit + 1)
         else:
             # This should be unreachable.
             raise Exception("Unrecognized database engine")