Add Plugin Method to format a user highlight

SFTtech · Dec 6, 2022 · 4fe5dbc · 4fe5dbc
1 parent 32d7489
commit 4fe5dbc
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 5 deletions.
diff --git a/PLUGINS.md b/PLUGINS.md
@@ -32,7 +32,7 @@ must be awaited.
 
 Example:
 ```python
-HELP_DESC = ("!echo\t\t\t-\tEcho back the given string\n")
+HELP_DESC = "!echo\t\t\t-\tEcho back the given string\n"
 
 async def register_to(plugin):
 
@@ -41,7 +41,9 @@ async def register_to(plugin):
         args = plugin.extract_args(event)
         args.pop(0)
 
-        await plugin.send_text(event.source['sender'] + ': ' + ' '.join(args))
+        await plugin.send_html(
+            await plugin.format_user_highlight(event.sender) + ": " + " ".join(args)
+        )
 
     # Add a command handler waiting for the echo command
     echo_handler = plugin.CommandHandler("echo", echo_callback)

diff --git a/cyberbot/matrixroom.py b/cyberbot/matrixroom.py
@@ -112,7 +112,7 @@ async def add_plugin(self, pluginname):
         await plugin.load()
 
     async def remove_plugin(self, pluginname):
-        self.log.info(f"Removeing plugin {pluginname} from room")
+        self.log.info(f"Removing plugin {pluginname} from room")
         # no need for lock as only yielding point of control flow is await statement, which is last
         c = self.bot.conn.cursor()
         # we put this before the if block to be able to remove plugins that are left by accident

diff --git a/cyberbot/plugin.py b/cyberbot/plugin.py
@@ -429,6 +429,12 @@ async def stop_task(self, task):
     # =============================================
     # Plugin helper functions (misc)
     # ==============================================
+    async def format_user_highlight(self, user_id, display_name=None):
+        """Format a hightlight to reference a user in a room. This message needs to be sent as html"""
+        if display_name == None:
+            display_name = (await self.client.get_displayname(user_id)).displayname
+        return f'<a href="https://matrix.to/#/{user_id}">{display_name}</a>'
+
     @staticmethod
     def extract_args(event):
         return shlex.split(event.source["content"]["body"])

diff --git a/plugins_examples/echo_plugin.py b/plugins_examples/echo_plugin.py
@@ -8,7 +8,9 @@ async def echo_callback(room, event):
         args = plugin.extract_args(event)
         args.pop(0)
 
-        await plugin.send_text(event.source["sender"] + ": " + " ".join(args))
+        await plugin.send_html(
+            await plugin.format_user_highlight(event.sender) + ": " + " ".join(args)
+        )
 
     # Add a command handler waiting for the echo command
     echo_handler = plugin.CommandHandler("echo", echo_callback)

diff --git a/plugins_examples/invite_plugin.py b/plugins_examples/invite_plugin.py
@@ -120,7 +120,7 @@ async def invite_callback(room, event):
         elif args[0] == "new":
             args.pop(0)
             try:
-                invitor = (await room.client.get_displayname(event.sender)).displayname
+                invitor = await plugin.get_sender_name(event)
             except:
                 invitor = "Unknown Invitor"
             await handle_new(invitor, args)