init

my_project_name/chat_functions.py

@@ -0,0 +1,154 @@
+import logging
+from typing import Optional, Union
+
+from markdown import markdown
+from nio import (
+    AsyncClient,
+    ErrorResponse,
+    MatrixRoom,
+    MegolmEvent,
+    Response,
+    RoomSendResponse,
+    SendRetryError,
+)
+
+logger = logging.getLogger(__name__)
+
+
+async def send_text_to_room(
+    client: AsyncClient,
+    room_id: str,
+    message: str,
+    notice: bool = True,
+    markdown_convert: bool = True,
+    reply_to_event_id: Optional[str] = None,
+) -> Union[RoomSendResponse, ErrorResponse]:
+    """Send text to a matrix room.
+
+    Args:
+        client: The client to communicate to matrix with.
+
+        room_id: The ID of the room to send the message to.
+
+        message: The message content.
+
+        notice: Whether the message should be sent with an "m.notice" message type
+            (will not ping users).
+
+        markdown_convert: Whether to convert the message content to markdown.
+            Defaults to true.
+
+        reply_to_event_id: Whether this message is a reply to another event. The event
+            ID this is message is a reply to.
+
+    Returns:
+        A RoomSendResponse if the request was successful, else an ErrorResponse.
+    """
+    # Determine whether to ping room members or not
+    msgtype = "m.notice" if notice else "m.text"
+
+    content = {
+        "msgtype": msgtype,
+        "format": "org.matrix.custom.html",
+        "body": message,
+    }
+
+    if markdown_convert:
+        content["formatted_body"] = markdown(message)
+
+    if reply_to_event_id:
+        content["m.relates_to"] = {"m.in_reply_to": {"event_id": reply_to_event_id}}
+
+    try:
+        return await client.room_send(
+            room_id,
+            "m.room.message",
+            content,
+            ignore_unverified_devices=True,
+        )
+    except SendRetryError:
+        logger.exception(f"Unable to send message response to {room_id}")
+
+
+def make_pill(user_id: str, displayname: str = None) -> str:
+    """Convert a user ID (and optionally a display name) to a formatted user 'pill'
+
+    Args:
+        user_id: The MXID of the user.
+
+        displayname: An optional displayname. Clients like Element will figure out the
+            correct display name no matter what, but other clients may not. If not
+            provided, the MXID will be used instead.
+
+    Returns:
+        The formatted user pill.
+    """
+    if not displayname:
+        # Use the user ID as the displayname if not provided
+        displayname = user_id
+
+    return f'<a href="https://matrix.to/#/{user_id}">{displayname}</a>'
+
+
+async def react_to_event(
+    client: AsyncClient,
+    room_id: str,
+    event_id: str,
+    reaction_text: str,
+) -> Union[Response, ErrorResponse]:
+    """Reacts to a given event in a room with the given reaction text
+
+    Args:
+        client: The client to communicate to matrix with.
+
+        room_id: The ID of the room to send the message to.
+
+        event_id: The ID of the event to react to.
+
+        reaction_text: The string to react with. Can also be (one or more) emoji characters.
+
+    Returns:
+        A nio.Response or nio.ErrorResponse if an error occurred.
+
+    Raises:
+        SendRetryError: If the reaction was unable to be sent.
+    """
+    content = {
+        "m.relates_to": {
+            "rel_type": "m.annotation",
+            "event_id": event_id,
+            "key": reaction_text,
+        }
+    }
+
+    return await client.room_send(
+        room_id,
+        "m.reaction",
+        content,
+        ignore_unverified_devices=True,
+    )
+
+
+async def decryption_failure(self, room: MatrixRoom, event: MegolmEvent) -> None:
+    """Callback for when an event fails to decrypt. Inform the user"""
+    logger.error(
+        f"Failed to decrypt event '{event.event_id}' in room '{room.room_id}'!"
+        f"\n\n"
+        f"Tip: try using a different device ID in your config file and restart."
+        f"\n\n"
+        f"If all else fails, delete your store directory and let the bot recreate "
+        f"it (your reminders will NOT be deleted, but the bot may respond to existing "
+        f"commands a second time)."
+    )
+
+    user_msg = (
+        "Unable to decrypt this message. "
+        "Check whether you've chosen to only encrypt to trusted devices."
+    )
+
+    await send_text_to_room(
+        self.client,
+        room.room_id,
+        user_msg,
+        reply_to_event_id=event.event_id,
+    )