add join reasons

Author: maltee1

mautrix/appservice/api/intent.py

@@ -280,12 +280,16 @@ async def unban_user(
     async def join_room_by_id(
         self,
         room_id: RoomID,
+        reason: str | None = None,
         third_party_signed: JSON = None,
         extra_content: dict[str, JSON] | None = None,
     ) -> RoomID:
         extra_content = self._add_source_key(extra_content)
         return await super().join_room_by_id(
-            room_id, third_party_signed=third_party_signed, extra_content=extra_content
+            room_id,
+            reason=reason,
+            third_party_signed=third_party_signed,
+            extra_content=extra_content,
         )
 
     async def leave_room(

mautrix/client/api/rooms.py

@@ -247,6 +247,7 @@ async def get_joined_rooms(self) -> list[RoomID]:
     async def join_room_by_id(
         self,
         room_id: RoomID,
+        reason: str | None = None,
         third_party_signed: JSON = None,
         extra_content: dict[str, Any] | None = None,
     ) -> RoomID:
@@ -257,6 +258,8 @@ async def join_room_by_id(
 
         Args:
             room_id: The ID of the room to join.
+            reason: The reason the user joined. This will be supplied as the ``reason`` on
+                the `m.room.member`_ event.
             third_party_signed: A signature of an ``m.third_party_invite`` token to prove that this
                 user owns a third party identity which has been invited to the room.
             extra_content: Additional properties for the join event content.
@@ -266,6 +269,12 @@ async def join_room_by_id(
         Returns:
             The ID of the room the user joined.
         """
+        content = (
+            {"third_party_signed": third_party_signed} if third_party_signed is not None else None
+        )
+        if reason and not content:
+            content = {}
+        content["reason"] = reason
         if extra_content:
             await self.send_member_event(
                 room_id, self.mxid, Membership.JOIN, extra_content=extra_content
@@ -274,7 +283,7 @@ async def join_room_by_id(
         content = await self.api.request(
             Method.POST,
             Path.v3.rooms[room_id].join,
-            {"third_party_signed": third_party_signed} if third_party_signed is not None else None,
+            content if third_party_signed is not None else None,
         )
         try:
             return content["room_id"]
@@ -285,6 +294,7 @@ async def join_room(
         self,
         room_id_or_alias: RoomID | RoomAlias,
         servers: list[str] | None = None,
+        reason: str | None = None,
         third_party_signed: JSON = None,
         max_retries: int = 4,
     ) -> RoomID:
@@ -298,6 +308,8 @@ async def join_room(
             room_id_or_alias: The ID of the room to join, or an alias pointing to the room.
             servers: A list of servers to ask about the room ID to join. Not applicable for aliases,
                 as aliases already contain the necessary server information.
+            reason: The reason the user joined. This will be supplied as the ``reason`` on
+                the `m.room.member`_ event.
             third_party_signed: A signature of an ``m.third_party_invite`` token to prove that this
                 user owns a third party identity which has been invited to the room.
             max_retries: The maximum number of retries. Used to circumvent a Synapse bug with
@@ -312,6 +324,9 @@ async def join_room(
         content = (
             {"third_party_signed": third_party_signed} if third_party_signed is not None else None
         )
+        if reason and not content:
+            content = {}
+        content["reason"] = reason
         query_params = CIMultiDict()
         for server_name in servers or []:
             query_params.add("server_name", server_name)

mautrix/client/store_updater.py

@@ -42,11 +42,12 @@ def __init__(self, *args, state_store: StateStore | None = None, **kwargs) -> No
     async def join_room_by_id(
         self,
         room_id: RoomID,
+        reason: str | None = None,
         third_party_signed: JSON = None,
         extra_content: dict[str, JSON] | None = None,
     ) -> RoomID:
         room_id = await super().join_room_by_id(
-            room_id, third_party_signed=third_party_signed, extra_content=extra_content
+            room_id, reason, third_party_signed=third_party_signed, extra_content=extra_content
         )
         if room_id and not extra_content and self.state_store:
             await self.state_store.set_membership(room_id, self.mxid, Membership.JOIN)
@@ -56,11 +57,12 @@ async def join_room(
         self,
         room_id_or_alias: RoomID | RoomAlias,
         servers: list[str] | None = None,
+        reason: str | None = None,
         third_party_signed: JSON = None,
         max_retries: int = 4,
     ) -> RoomID:
         room_id = await super().join_room(
-            room_id_or_alias, servers, third_party_signed, max_retries
+            room_id_or_alias, servers, reason, third_party_signed, max_retries
         )
         if room_id and self.state_store:
             await self.state_store.set_membership(room_id, self.mxid, Membership.JOIN)