Store full membership events in state store and bump version to 0.2.0

This allows efficient get_displayname and get_avatar_url methods

Author: tulir

mautrix_appservice/__init__.py

@@ -1,5 +1,5 @@
 from .appservice import AppService
 from .errors import MatrixError, MatrixRequestError, IntentError
 
-__version__ = "0.1.5"
+__version__ = "0.2.0"
 __author__ = "Tulir Asokan <[email protected]>"

mautrix_appservice/appservice.py

@@ -51,7 +51,10 @@ async def default_query_handler(_):
         self.app.router.add_route("GET", "/rooms/{alias}", self._http_query_alias)
         self.app.router.add_route("GET", "/users/{user_id}", self._http_query_user)
 
-        self.matrix_event_handler(self.update_state_store)
+        async def update_state(event):
+            self.state_store.update_state(event)
+
+        self.matrix_event_handler(update_state)
 
     @property
     def http_session(self) -> aiohttp.ClientSession:
@@ -156,14 +159,6 @@ async def _http_handle_transaction(self, request: web.Request) -> web.Response:
 
         return web.json_response({})
 
-    async def update_state_store(self, event: dict):
-        event_type = event["type"]
-        if event_type == "m.room.power_levels":
-            self.state_store.set_power_levels(event["room_id"], event["content"])
-        elif event_type == "m.room.member":
-            self.state_store.set_membership(event["room_id"], event["state_key"],
-                                            event["content"]["membership"])
-
     def handle_matrix_event(self, event: dict):
         async def try_handle(handler_func: HandlerFunc):
             try:

mautrix_appservice/intent_api.py

@@ -360,6 +360,19 @@ async def set_join_rule(self, room_id: str, join_rule: str, **kwargs):
             "join_rule": join_rule,
         }, **kwargs)
 
+    async def get_displayname(self, room_id: str, user_id: str, ignore_cache=False) -> str:
+        return (await self.get_member_info(room_id, user_id, ignore_cache)).get("displayname", None)
+
+    async def get_avatar_url(self, room_id: str, user_id: str, ignore_cache=False) -> str:
+        return (await self.get_member_info(room_id, user_id, ignore_cache)).get("avatar_url", None)
+
+    async def get_member_info(self, room_id: str, user_id: str, ignore_cache=False) -> dict:
+        member = self.state_store.get_member(room_id, user_id)
+        if len(member) == 0 or ignore_cache:
+            event = await self.get_state_event(room_id, "m.room.member", user_id)
+            member = event.get("content", {})
+        return member
+
     async def get_event(self, room_id: str, event_id: str) -> dict:
         await self.ensure_joined(room_id)
         return await self.client.request("GET", f"/rooms/{room_id}/event/{event_id}")
@@ -532,7 +545,14 @@ async def get_state_event(self, room_id: str, event_type: str, state_key: Option
             raise ValueError("Event type not given")
         await self.ensure_joined(room_id)
         url = self._get_state_url(room_id, event_type, state_key)
-        return await self.client.request("GET", url)
+        content = await self.client.request("GET", url)
+        self.state_store.update_state({
+            "type": event_type,
+            "room_id": room_id,
+            "state_key": state_key,
+            "content": content,
+        })
+        return content
 
     def join_room(self, room_id: str):
         if not room_id:

mautrix_appservice/state_store.py

@@ -10,7 +10,7 @@ def __init__(self, autosave_file: str = None):
 
         # Persistent storage
         self.registrations = set()
-        self.memberships = {}
+        self.members = {}
         self.power_levels = {}
 
         # Non-persistent storage
@@ -25,7 +25,7 @@ def save(self, file: str):
 
         json.dump({
             "registrations": list(self.registrations),
-            "memberships": self.memberships,
+            "members": self.members,
             "power_levels": self.power_levels,
         }, output)
 
@@ -44,8 +44,8 @@ def load(self, file: str):
         data = json.load(input_source)
         if "registrations" in data:
             self.registrations = set(data["registrations"])
-        if "memberships" in data:
-            self.memberships = data["memberships"]
+        if "members" in data:
+            self.members = data["members"]
         if "power_levels" in data:
             self.power_levels = data["power_levels"]
 
@@ -86,18 +86,42 @@ def registered(self, user: str):
         self.registrations.add(user)
         self._autosave()
 
+    def update_state(self, event: dict):
+        event_type = event["type"]
+        if event_type == "m.room.power_levels":
+            self.set_power_levels(event["room_id"], event["content"])
+        elif event_type == "m.room.member":
+            self.set_member(event["room_id"], event["state_key"], event["content"])
+
+    def get_member(self, room: str, user: str) -> dict:
+        return self.members.get(room, {}).get(user, {})
+
+    def set_member(self, room: str, user: str, member: dict):
+        if room not in self.members:
+            self.members[room] = {}
+        self.members[room][user] = member
+        self._autosave()
+
+    def set_membership(self, room: str, user: str, membership: str):
+        if room not in self.members:
+            self.members[room] = {
+                user: {
+                    "membership": membership
+                }
+            }
+        elif user not in self.members[room]:
+            self.members[room][user] = {
+                "membership": membership
+            }
+        else:
+            self.members[room][user]["membership"] = membership
+
     def get_membership(self, room: str, user: str) -> str:
-        return self.memberships.get(room, {}).get(user, "left")
+        return self.get_member(room, user).get("membership", "left")
 
     def is_joined(self, room: str, user: str) -> bool:
         return self.get_membership(room, user) == "join"
 
-    def set_membership(self, room: str, user: str, membership: str):
-        if room not in self.memberships:
-            self.memberships[room] = {}
-        self.memberships[room][user] = membership
-        self._autosave()
-
     def joined(self, room: str, user: str):
         return self.set_membership(room, user, "join")
 

setup.py

@@ -2,7 +2,7 @@
 
 setuptools.setup(
     name="mautrix-appservice",
-    version="0.1.5",
+    version="0.2.0",
     url="https://github.com/tulir/mautrix-appservice-python",
 
     author="Tulir Asokan",