feat: ✨ trigger the bot by mentioning it

simplematrixbotlib/bot.py

@@ -39,7 +39,7 @@ async def main(self):
 
 
         resp = await self.async_client.sync(timeout=65536,
-                                     full_state=False)  #Ignore prior messages
+                                     full_state=True)  #Ignore prior messages
 
         if isinstance(resp, SyncResponse):
             print(f"Connected to {self.async_client.homeserver} as {self.async_client.user_id} ({self.async_client.device_id})")

simplematrixbotlib/match.py

@@ -82,6 +82,11 @@ def __init__(self, room, event, bot, prefix="") -> None:
         """
         super().__init__(room, event, bot)
         self._prefix = prefix
+        bot_user = self.room.users[self.room.own_user_id]
+        self._display_name = bot_user.display_name
+        self._disambiguated_name = bot_user.disambiguated_name
+        self._pill = f'<a href="https://matrix.to/#/{self.room.own_user_id}">'
+        self._body_without_prefix = None
 
     def command(self, command=None):
         """
@@ -99,18 +104,37 @@ def command(self, command=None):
             Returns the string after the prefix and before the first space if no arg is passed to this method.
         """
 
-        if self._prefix == self.event.body[0:len(self._prefix)]:
-            body_without_prefix = self.event.body[len(self._prefix):]
-        else:
-            body_without_prefix = self.event.body
-
-        if not body_without_prefix:
-            return []
+        # we cache this part
+        if not self._body_without_prefix:
+            if self._prefix == self.event.body[0:len(self._prefix)]:
+                self._body_without_prefix = self.event.body[len(self._prefix):]
+            elif self.mention():
+                # the order is important here!
+                # note: we assume that body and formatted_body, if present, match as a workaraound of cleaning html
+                id_matched = False
+                for id in (self._disambiguated_name, self._display_name, self.room.own_user_id):
+                    if self.event.body.startswith(id) and not id_matched:
+                        self._body_without_prefix = self.event.body[len(id):]
+                        id_matched = True
+
+                if self.event.formatted_body.startswith(self._pill) and not id_matched:
+                    name = self.event.formatted_body[len():self.event.formatted_body.index('</a>')]
+                    self._body_without_prefix = self.event.body[len(name):]
+
+                # mentioning may include a : (colon) as inserted by Element when clicking on a user
+                if self._body_without_prefix.startswith(':'):
+                    self._body_without_prefix = self._body_without_prefix[1:]
+
+                # trim leading whitespace after the mention
+                self._body_without_prefix = self._body_without_prefix.strip()
+
+            else:
+                self._body_without_prefix = self.event.body
 
         if command:
-            return body_without_prefix.split()[0] == command
+            return self._body_without_prefix.split()[0] == command
         else:
-            return body_without_prefix.split()[0]
+            return self._body_without_prefix.split()[0]
 
     def prefix(self):
         """
@@ -123,6 +147,22 @@ def prefix(self):
 
         return self.event.body.startswith(self._prefix)
 
+    def mention(self):
+        """
+
+        Returns
+        -------
+        boolean
+            Returns True if the message begins with the bot's username, MXID, or pill targeting the MXID, and False otherwise.
+        """
+
+        for body in (self.event.formatted_body, self.event.body):
+            for id in [self._display_name, self._disambiguated_name, self.room.own_user_id, self._pill]:
+                if body.startswith(id):
+                    return True
+
+        return False
+
     def args(self):
         """
 
@@ -132,7 +172,7 @@ def args(self):
             Returns a list of strings that are the "words" of the message, except for the first "word", which would be the command.
         """
 
-        return self.event.body.split()[1:]
+        return self._body_without_prefix.split()[1:]
 
     def contains(self, string):
         """