feat: ✨ trigger the bot by mentioning it #81

HarHarLinks · 2021-11-17T16:05:07Z

example:

    match = botlib.MessageMatch(room, message, bot, conf.prefix)

    if match.is_not_from_this_bot() and (match.prefix() or match.mention()):
        if match.command('help') or match.command('h') or (match.mention() and match.command('?')):
            me = await bot.async_client.get_displayname()
            me = me.displayname
            help = f"use `!help {me}` or `{me}: help` to display detailed help."
            if match.mention() or (len(match.args()) > 0 and match.args()[0].lower() == me.lower()):
                help += "\n"
                help += f"you can interact with me by sending a message prefixed with `{conf.prefix}`, my name (`{me}`), or my full matrix ID.\n"
            await bot.api.send_markdown_message(room.room_id, help, 'm.notice')

works with pills, displayname, disambiguated disaplyname, full matrix ID.

However as-is, it needs a full sync to be able to resolve this (users can be empty otherwise):
https://github.com/KrazyKirby99999/simple-matrix-bot-lib/blob/33776bad9855c4337557d3badfe3af74e9c9af1a/simplematrixbotlib/match.py#L85

I don't think that's optimal since a full sync on startup can take long when the account/room reached a certain lifetime. Is it possible to sync only the members list of the required room on demand?

todo

full sync?
doc
example on top of doc?
tests

ghost · 2021-11-25T00:19:19Z

I don't think that's optimal since a full sync on startup can take long when the account/room reached a certain lifetime. Is it possible to sync only the members list of the required room on demand?

Perhaps create a new issue for this?

ghost · 2021-11-25T00:48:27Z

Fixed messagematch.mention bug - e73f24b

"body" is now a tuple instead of a list

ghost · 2021-11-25T00:50:50Z

Accidentally included a change undescribed by commit message, fixed.

ghost · 2021-11-25T01:22:39Z

2d63cbe should improve readability. Please test if this broke anything.

HarHarLinks

introduces an exception, needs to be changed

simplematrixbotlib/match.py

HarHarLinks

smart idea using a loop, somehow I missed that.
however, some changes required

simplematrixbotlib/match.py

HarHarLinks · 2021-11-25T10:58:13Z

I don't think that's optimal since a full sync on startup can take long when the account/room reached a certain lifetime. Is it possible to sync only the members list of the required room on demand?

Perhaps create a new issue for this?

The trouble is that this is required for this PR, hence it's included.

HarHarLinks · 2021-11-25T11:00:31Z

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


seems to be required to reliably load self.room.own_user_id and self.room.users which may be empty otherwise from testing. I hope there is a better way to do it than just syncing everything.

Does self.room.own_user_id follow the structure of @username:homeserver ? If so, it would not be neccesary to do anything with self.room.users to obtain it.

self.room is a Dict[str, MatrixUser]. MatrixUser contains display_name and disambiguated_name which we need for mention() matches

maybe this https://matrix-nio.readthedocs.io/en/latest/nio.html#nio.rooms.MatrixRoom.user_name is good enough instead? I don't think so as it does the same: if room members haven't been synced yet, it just fails.

If we need the user_id, then whoami should solve that.

Lines 57-63 of api.py

async with aiohttp.ClientSession() as session: async with session.get(f'{self.creds.homeserver}/_matrix/client/r0/account/whoami?access_token={self.creds.access_token}') as response: device_id = ast.literal_eval((await response.text()).replace(":false,", ":\"false\","))['device_id'] user_id = ast.literal_eval((await response.text()).replace(":false,", ":\"false\","))['user_id'] self.async_client.device_id, self.creds.device_id = device_id, device_id self.async_client.user_id, self.creds.user_id = user_id, user_id

Would the user id not be stored in bot.async_client.user_id ?

it would. the issue is more about getting the displayname though

I think doing a full sync is actually ok if we enable storage in this PR (store is needed for #79)

https://github.com/poljar/matrix-nio/blob/a4fb83fd515568e269646d2111dc68e17cc251c6/nio/client/async_client.py#L368-L380

then only the very first time would be a "big" sync

That is acceptable.

ghost · 2021-11-25T17:02:48Z

57147ec looks good.

simplematrixbotlib/match.py

missing: mention when no prefix is set

simplematrixbotlib/match.py

happens when calling args before command

simplematrixbotlib/match.py

even when no prefix is given

Refactor MessageMatch class to use _body_without_mention and _split_body. No longer checks formatted_body for mention.

simplematrixbotlib/match.py

Fix messagematch tests. match9 and match10 in test_mention are disabled, but will need to be enabled to test switching between body and formatted_body

simplematrixbotlib/match.py

HarHarLinks · 2021-11-29T10:45:26Z

simplematrixbotlib/match.py

@@ -149,11 +155,12 @@ def mention(self):
            Returns True if the message begins with the bot's username, MXID, or pill targeting the MXID, and False otherwise.
        """

-        for id in [self._own_disambiguated_name, self._own_display_name, self._own_user_id]:
+        for id in [self._own_disambiguated_name, self._own_display_name, self._own_user_id, self._own_display_name_colon]:


this will always match _own_display_name and never _own_display_name_colon

Perhaps _own_display_name_colon could be removed.

HarHarLinks · 2021-11-30T16:52:30Z

simplematrixbotlib/match.py

+
+        self.mention() # Set self._mention_id_length
+        self._body_without_prefix = self.event.body[len(self._prefix):]
+        self._body_without_mention = self.event.body[self._mention_id_length:]


why initialize these here while it's unknown whether prefix or mention is used?
why create member variables that are only ever used 2 lines later?
mention() is executed twice unnecessarily

mention() sets ._mention_id_length, which is neccesary for calculating ._body_without_mention

I think it may be a good idea to look at bot libraries for other networks to see how they handle matching.

HarHarLinks · 2021-11-30T16:53:47Z

simplematrixbotlib/match.py

+        elif self.prefix():
+            body = self._body_without_prefix
+        else:
+            body = self.event.body


why use distinct member variables? they can't both apply at once

Can you reword this?

HarHarLinks · 2021-11-30T17:16:55Z

simplematrixbotlib/match.py

-
-        if not body_without_prefix:
-            return []
+        if not (self._body_without_prefix and self._body_without_mention):


use len(self._split_body) instead

simplematrixbotlib/match.py

…MessageMatch class

HarHarLinks added 2 commits November 17, 2021 16:55

add bot trigger: mention

33776ba

fix api.args() for mentions

d6a3a34

Fix messagemath.mention.

e73f24b

"body" is now a tuple instead of a list

ghost force-pushed the call-by-mention branch from f5ec850 to e73f24b Compare November 25, 2021 00:49

Refactor messagematch.command

2d63cbe

HarHarLinks commented Nov 25, 2021

View reviewed changes

simplematrixbotlib/match.py Outdated Show resolved Hide resolved

HarHarLinks commented Nov 25, 2021

View reviewed changes

simplematrixbotlib/match.py Outdated Show resolved Hide resolved

simplematrixbotlib/match.py Outdated Show resolved Hide resolved

simplematrixbotlib/match.py Outdated Show resolved Hide resolved

HarHarLinks commented Nov 25, 2021

View reviewed changes

HarHarLinks force-pushed the call-by-mention branch from 838be53 to 2d63cbe Compare November 25, 2021 15:51

docs: 📝 Add match.mention() docs

57147ec

HarHarLinks commented Nov 25, 2021

View reviewed changes

simplematrixbotlib/match.py Outdated Show resolved Hide resolved

HarHarLinks added 4 commits November 25, 2021 19:28

refactor MessageMatch.mention()

9a2e924

refactor command() into mention()

809186e

add tests for mention()

c2414d3

missing: mention when no prefix is set

add comments to mention related class privates

25c8ce8

HarHarLinks commented Nov 26, 2021

View reviewed changes

simplematrixbotlib/match.py Show resolved Hide resolved

fix None exception in args

45599af

happens when calling args before command

HarHarLinks commented Nov 26, 2021

View reviewed changes

simplematrixbotlib/match.py Outdated Show resolved Hide resolved

HarHarLinks and others added 3 commits November 26, 2021 15:39

correctly strip mention from command

3a5d621

even when no prefix is given

fix command() list index out of range

6b8a0d9

refactor: ♻️ Refactor MessageMatch class

2e380d5

Refactor MessageMatch class to use _body_without_mention and _split_body. No longer checks formatted_body for mention.

HarHarLinks commented Nov 28, 2021

View reviewed changes

simplematrixbotlib/match.py Outdated Show resolved Hide resolved

HarHarLinks commented Nov 28, 2021

View reviewed changes

simplematrixbotlib/match.py Outdated Show resolved Hide resolved

Fix errors introduced by commit 2e380d5

deecc36

test: ✅ Fix messagematch tests

cbd843d

Fix messagematch tests. match9 and match10 in test_mention are disabled, but will need to be enabled to test switching between body and formatted_body

HarHarLinks commented Nov 29, 2021

View reviewed changes

simplematrixbotlib/match.py Show resolved Hide resolved

HarHarLinks commented Nov 29, 2021

View reviewed changes

Enable failing tests

708eb2b

HarHarLinks commented Nov 30, 2021

View reviewed changes

simplematrixbotlib/match.py Show resolved Hide resolved

HarHarLinks changed the title ~~add bot trigger: mention~~ feature: ✨ trigger the bot by mentioning it Dec 1, 2021

HarHarLinks changed the title ~~feature: ✨ trigger the bot by mentioning it~~ feat: ✨ trigger the bot by mentioning it Dec 1, 2021

refactor: ♻️ Change order of if statements to improve readability in …

a2bde24

…MessageMatch class

ghost force-pushed the master branch 2 times, most recently from a711bef to e95148d Compare December 29, 2021 17:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ✨ trigger the bot by mentioning it #81

feat: ✨ trigger the bot by mentioning it #81

HarHarLinks commented Nov 17, 2021 •

edited

Loading

ghost commented Nov 25, 2021

ghost commented Nov 25, 2021 •

edited by ghost

Loading

ghost commented Nov 25, 2021

ghost commented Nov 25, 2021

HarHarLinks left a comment

HarHarLinks left a comment

HarHarLinks commented Nov 25, 2021

HarHarLinks Nov 25, 2021

ghost Nov 25, 2021 •

edited by ghost

Loading

HarHarLinks Nov 25, 2021

HarHarLinks Nov 25, 2021 •

edited

Loading

ghost Nov 25, 2021

ghost Nov 25, 2021 •

edited by ghost

Loading

ghost Nov 25, 2021 •

edited by ghost

Loading

HarHarLinks Nov 26, 2021

HarHarLinks Nov 28, 2021 •

edited

Loading

ghost Dec 28, 2021

ghost commented Nov 25, 2021

HarHarLinks Nov 29, 2021

ghost Dec 28, 2021

HarHarLinks Nov 30, 2021 •

edited

Loading

ghost Dec 28, 2021

ghost Dec 28, 2021 •

edited by ghost

Loading

HarHarLinks Nov 30, 2021

ghost Dec 28, 2021

HarHarLinks Nov 30, 2021

feat: ✨ trigger the bot by mentioning it #81

Are you sure you want to change the base?

feat: ✨ trigger the bot by mentioning it #81

Conversation

HarHarLinks commented Nov 17, 2021 • edited Loading

todo

ghost commented Nov 25, 2021

ghost commented Nov 25, 2021 • edited by ghost Loading

ghost commented Nov 25, 2021

ghost commented Nov 25, 2021

HarHarLinks left a comment

Choose a reason for hiding this comment

HarHarLinks left a comment

Choose a reason for hiding this comment

HarHarLinks commented Nov 25, 2021

Choose a reason for hiding this comment

ghost Nov 25, 2021 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HarHarLinks Nov 25, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost Nov 25, 2021 • edited by ghost Loading

Choose a reason for hiding this comment

ghost Nov 25, 2021 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HarHarLinks Nov 28, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Nov 25, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HarHarLinks Nov 30, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost Dec 28, 2021 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HarHarLinks commented Nov 17, 2021 •

edited

Loading

ghost commented Nov 25, 2021 •

edited by ghost

Loading

ghost Nov 25, 2021 •

edited by ghost

Loading

HarHarLinks Nov 25, 2021 •

edited

Loading

ghost Nov 25, 2021 •

edited by ghost

Loading

ghost Nov 25, 2021 •

edited by ghost

Loading

HarHarLinks Nov 28, 2021 •

edited

Loading

HarHarLinks Nov 30, 2021 •

edited

Loading

ghost Dec 28, 2021 •

edited by ghost

Loading