Merge pull request #186 from TotallyNotRobots/accounttag

Add account-tag to chan_track

Author: linuxdaemon

cloudbot/clients/irc.py

@@ -622,6 +622,7 @@ def parse_line(self, line: str) -> Event:
             irc_command=command,
             irc_paramlist=command_params,
             irc_ctcp_text=ctcp_text,
+            irc_tags=message.tags,
         )
         return event
 

cloudbot/event.py

@@ -41,11 +41,32 @@ class Event(Mapping[str, Any]):
     :type irc_command: str
     :type irc_paramlist: list[str]
     :type irc_ctcp_text: str
+    :type irc_tags: irclib.parser.TagList
     """
 
-    def __init__(self, *, bot=None, hook=None, conn=None, base_event=None, event_type=EventType.other, content=None,
-                 content_raw=None, target=None, channel=None, nick=None, user=None, host=None, mask=None, irc_raw=None,
-                 irc_prefix=None, irc_command=None, irc_paramlist=None, irc_ctcp_text=None):
+    def __init__(
+        self,
+        *,
+        bot=None,
+        hook=None,
+        conn=None,
+        base_event=None,
+        event_type=EventType.other,
+        content=None,
+        content_raw=None,
+        target=None,
+        channel=None,
+        nick=None,
+        user=None,
+        host=None,
+        mask=None,
+        irc_raw=None,
+        irc_prefix=None,
+        irc_command=None,
+        irc_paramlist=None,
+        irc_ctcp_text=None,
+        irc_tags=None
+    ):
         """
         All of these parameters except for `bot` and `hook` are optional.
         The irc_* parameters should only be specified for IRC events.
@@ -87,6 +108,7 @@ def __init__(self, *, bot=None, hook=None, conn=None, base_event=None, event_typ
         :type irc_command: str
         :type irc_paramlist: list[str]
         :type irc_ctcp_text: str
+        :type irc_tags: irclib.parser.TagList
         """
         self.db = None
         self.db_executor = None
@@ -114,6 +136,7 @@ def __init__(self, *, bot=None, hook=None, conn=None, base_event=None, event_typ
             self.mask = base_event.mask
             # clients-specific parameters
             self.irc_raw = base_event.irc_raw
+            self.irc_tags = base_event.irc_tags
             self.irc_prefix = base_event.irc_prefix
             self.irc_command = base_event.irc_command
             self.irc_paramlist = base_event.irc_paramlist
@@ -131,6 +154,7 @@ def __init__(self, *, bot=None, hook=None, conn=None, base_event=None, event_typ
             self.mask = mask
             # clients-specific parameters
             self.irc_raw = irc_raw
+            self.irc_tags = irc_tags
             self.irc_prefix = irc_prefix
             self.irc_command = irc_command
             self.irc_paramlist = irc_paramlist
@@ -271,9 +295,7 @@ def reply(self, *messages, target=None):
         reply_ping = self.conn.config.get("reply_ping", True)
         if target is None:
             if self.chan is None:
-                raise ValueError(
-                    "Target must be specified when chan is not assigned"
-                )
+                raise ValueError("Target must be specified when chan is not assigned")
 
             target = self.chan
 
@@ -283,9 +305,9 @@ def reply(self, *messages, target=None):
         if target == self.nick or not reply_ping:
             self.conn.message(target, *messages)
         else:
-            self.conn.message(target, "({}) {}".format(
-                self.nick, messages[0]
-            ), *messages[1:])
+            self.conn.message(
+                target, "({}) {}".format(self.nick, messages[0]), *messages[1:]
+            )
 
     def action(self, message, target=None):
         """sends an action to the current channel/user
@@ -295,9 +317,7 @@ def action(self, message, target=None):
         """
         if target is None:
             if self.chan is None:
-                raise ValueError(
-                    "Target must be specified when chan is not assigned"
-                )
+                raise ValueError("Target must be specified when chan is not assigned")
 
             target = self.chan
 
@@ -311,9 +331,7 @@ def ctcp(self, message, ctcp_type, target=None):
         """
         if target is None:
             if self.chan is None:
-                raise ValueError(
-                    "Target must be specified when chan is not assigned"
-                )
+                raise ValueError("Target must be specified when chan is not assigned")
 
             target = self.chan
 
@@ -349,9 +367,7 @@ def has_permission(self, permission, notice=True):
         if not self.mask:
             raise ValueError("has_permission requires mask is not assigned")
 
-        return self.conn.permissions.has_perm_mask(
-            self.mask, permission, notice=notice
-        )
+        return self.conn.permissions.has_perm_mask(self.mask, permission, notice=notice)
 
     async def check_permission(self, permission, notice=True):
         """ returns whether or not the current user has a given permission
@@ -363,9 +379,7 @@ async def check_permission(self, permission, notice=True):
             return True
 
         for perm_hook in self.bot.plugin_manager.perm_hooks[permission]:
-            ok, res = await self.bot.plugin_manager.internal_launch(
-                perm_hook, self
-            )
+            ok, res = await self.bot.plugin_manager.internal_launch(perm_hook, self)
             if ok and res:
                 return True
 
@@ -404,23 +418,54 @@ class CommandEvent(Event):
     :type triggered_command: str
     """
 
-    def __init__(self, *, bot=None, hook, text, triggered_command, cmd_prefix,
-                 conn=None, base_event=None, event_type=None, content=None,
-                 content_raw=None, target=None, channel=None, nick=None,
-                 user=None, host=None, mask=None, irc_raw=None, irc_prefix=None,
-                 irc_command=None, irc_paramlist=None):
+    def __init__(
+        self,
+        *,
+        bot=None,
+        hook,
+        text,
+        triggered_command,
+        cmd_prefix,
+        conn=None,
+        base_event=None,
+        event_type=None,
+        content=None,
+        content_raw=None,
+        target=None,
+        channel=None,
+        nick=None,
+        user=None,
+        host=None,
+        mask=None,
+        irc_raw=None,
+        irc_prefix=None,
+        irc_command=None,
+        irc_paramlist=None
+    ):
         """
         :param text: The arguments for the command
         :param triggered_command: The command that was triggered
         :type text: str
         :type triggered_command: str
         """
         super().__init__(
-            bot=bot, hook=hook, conn=conn, base_event=base_event,
-            event_type=event_type, content=content, content_raw=content_raw,
-            target=target, channel=channel, nick=nick, user=user, host=host,
-            mask=mask, irc_raw=irc_raw, irc_prefix=irc_prefix,
-            irc_command=irc_command, irc_paramlist=irc_paramlist
+            bot=bot,
+            hook=hook,
+            conn=conn,
+            base_event=base_event,
+            event_type=event_type,
+            content=content,
+            content_raw=content_raw,
+            target=target,
+            channel=channel,
+            nick=nick,
+            user=user,
+            host=host,
+            mask=mask,
+            irc_raw=irc_raw,
+            irc_prefix=irc_prefix,
+            irc_command=irc_command,
+            irc_paramlist=irc_paramlist,
         )
         self.hook = hook
         self.text = text
@@ -455,21 +500,50 @@ class RegexEvent(Event):
     :type match: re.__Match
     """
 
-    def __init__(self, *, bot=None, hook, match, conn=None, base_event=None,
-                 event_type=None, content=None, content_raw=None, target=None,
-                 channel=None, nick=None, user=None, host=None, mask=None,
-                 irc_raw=None, irc_prefix=None, irc_command=None,
-                 irc_paramlist=None):
+    def __init__(
+        self,
+        *,
+        bot=None,
+        hook,
+        match,
+        conn=None,
+        base_event=None,
+        event_type=None,
+        content=None,
+        content_raw=None,
+        target=None,
+        channel=None,
+        nick=None,
+        user=None,
+        host=None,
+        mask=None,
+        irc_raw=None,
+        irc_prefix=None,
+        irc_command=None,
+        irc_paramlist=None
+    ):
         """
         :param: match: The match objected returned by the regex search method
         :type match: re.__Match
         """
         super().__init__(
-            bot=bot, conn=conn, hook=hook, base_event=base_event,
-            event_type=event_type, content=content, content_raw=content_raw,
-            target=target, channel=channel, nick=nick, user=user, host=host,
-            mask=mask, irc_raw=irc_raw, irc_prefix=irc_prefix,
-            irc_command=irc_command, irc_paramlist=irc_paramlist
+            bot=bot,
+            conn=conn,
+            hook=hook,
+            base_event=base_event,
+            event_type=event_type,
+            content=content,
+            content_raw=content_raw,
+            target=target,
+            channel=channel,
+            nick=nick,
+            user=user,
+            host=host,
+            mask=mask,
+            irc_raw=irc_raw,
+            irc_prefix=irc_prefix,
+            irc_command=irc_command,
+            irc_paramlist=irc_paramlist,
         )
         self.match = match
 
@@ -493,9 +567,7 @@ async def prepare(self):
             try:
                 self.parsed_line = Message.parse(self.line)
             except Exception:
-                logger.exception(
-                    "Unable to parse line requested by hook %s", self.hook
-                )
+                logger.exception("Unable to parse line requested by hook %s", self.hook)
                 self.parsed_line = None
 
     def prepare_threaded(self):
@@ -505,9 +577,7 @@ def prepare_threaded(self):
             try:
                 self.parsed_line = Message.parse(self.line)
             except Exception:
-                logger.exception(
-                    "Unable to parse line requested by hook %s", self.hook
-                )
+                logger.exception("Unable to parse line requested by hook %s", self.hook)
                 self.parsed_line = None
 
     @property
@@ -516,8 +586,15 @@ def line(self):
 
 
 class PostHookEvent(Event):
-    def __init__(self, *args, launched_hook=None, launched_event=None,
-                 result=None, error=None, **kwargs):
+    def __init__(
+        self,
+        *args,
+        launched_hook=None,
+        launched_event=None,
+        result=None,
+        error=None,
+        **kwargs
+    ):
         super().__init__(*args, **kwargs)
         self.launched_hook = launched_hook
         self.launched_event = launched_event

plugins/core/chan_track.py

@@ -15,25 +15,20 @@
 from operator import attrgetter
 from typing import Dict
 
-from irclib.parser import Prefix
+from irclib.parser import MessageTag, Prefix, TagList
 
 import cloudbot.bot
 from cloudbot import hook
 from cloudbot.client import Client
 from cloudbot.clients.irc import IrcClient
+from cloudbot.hook import Priority
 from cloudbot.util import web
 from cloudbot.util.irc import ChannelMode, StatusMode, parse_mode_string
 from cloudbot.util.mapping import KeyFoldDict, KeyFoldMixin
 
 logger = logging.getLogger("cloudbot")
 
 
-class WeakDict(dict):
-    """
-    A subclass of dict to allow it to be weakly referenced
-    """
-
-
 class MemberNotFoundException(KeyError):
     def __init__(self, name, chan):
         super().__init__("No such member '{}' in channel '{}'".format(name, chan.name))
@@ -361,6 +356,7 @@ def update_conn_data(conn):
         "account-notify",
         "away-notify",
         "chghost",
+        "account-tag",
     }
 )
 
@@ -678,9 +674,20 @@ def getdata_cmd(conn, chan, nick):
     return web.paste(MappingSerializer().serialize(memb, indent=2))
 
 
+@hook.irc_raw("*", priority=Priority.HIGHEST, do_sieve=False)
+def handle_tags(conn: IrcClient, nick: str, irc_tags: TagList) -> None:
+    users = get_users(conn)
+
+    if irc_tags:
+        account_tag = irc_tags.get("account")  # type: MessageTag
+        if account_tag:
+            user_data = users.getuser(nick)
+            user_data.account = account_tag.value
+
+
 @hook.irc_raw(["PRIVMSG", "NOTICE"], do_sieve=False)
 def on_msg(conn, nick, user, host, irc_paramlist):
-    chan, *other_data = irc_paramlist
+    chan = irc_paramlist[0]
 
     if chan.lower() != conn.nick.lower():
         return