Merge pull request #143 from TotallyNotRobots/handle-colons

Don't rely on colons in the irc parser

Author: linuxdaemon

CHANGELOG.md

@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix grammatical error in food sentence (beer)
 - Update youtube plugin to use proper contentRating API
 - Update mylife.py for website changes
+- Fixed handling of colons in core IRC parser
 ### Removed
 - twitch.py removed due to outdated API and lack of maintainer
 

cloudbot/clients/irc.py

@@ -7,6 +7,7 @@
 import traceback
 from functools import partial
 from pathlib import Path
+from typing import Mapping, Optional
 
 from irclib.parser import Message
 
@@ -34,6 +35,36 @@ def irc_clean(dirty):
     "NOTICE": EventType.notice
 }
 
+content_params = {
+    "PRIVMSG": 1,
+    "NOTICE": 1,
+    "PART": 1,
+    "KICK": 2,
+    "TOPIC": 1,
+    "NICK": 0,
+    "QUIT": 0,
+}
+
+chan_params = {
+    "PRIVMSG": 0,
+    "NOTICE": 0,
+    "JOIN": 0,
+    "PART": 0,
+    "TOPIC": 0,
+    "MODE": 0,
+    "KICK": 0,
+    "INVITE": 1,
+    "353": 2,
+    "366": 1,
+    "324": 1,
+}
+
+target_params = {
+    "KICK": 1,
+    "INVITE": 0,
+    "MODE": 0,
+}
+
 
 def decode(bytestring):
     """
@@ -47,6 +78,15 @@ def decode(bytestring):
     return bytestring.decode('utf-8', errors='ignore')
 
 
+def _get_param(msg: Message, index_map: Mapping[str, int]) -> Optional[str]:
+    if msg.command in index_map:
+        idx = index_map[msg.command]
+        if idx < len(msg.parameters):
+            return msg.parameters[idx]
+
+    return None
+
+
 @client("irc")
 class IrcClient(Client):
     """
@@ -417,114 +457,97 @@ def data_received(self, data):
             line = decode(line_data)
 
             try:
-                message = Message.parse(line)
+                event = self.parse_line(line)
             except Exception:
                 logger.exception(
                     "[%s] Error occurred while parsing IRC line '%s' from %s",
                     self.conn.name, line, self.conn.describe_server()
                 )
-                continue
-
-            command = message.command
-            command_params = message.parameters
-
-            # Reply to pings immediately
-
-            if command == "PING":
-                self.conn.send("PONG " + command_params[-1], log=False)
-
-            # Parse the command and params
-
-            # Content
-            if command_params.has_trail:
-                content_raw = command_params[-1]
-                content = irc_clean(content_raw)
             else:
-                content_raw = None
-                content = None
-
-            # Event type
-            event_type = irc_command_to_event_type.get(
-                command, EventType.other
-            )
+                # handle the message, async
+                async_util.wrap_future(self.bot.process(event), loop=self.loop)
+
+    def parse_line(self, line: str) -> Event:
+        message = Message.parse(line)
+        command = message.command
+        command_params = message.parameters
+
+        # Reply to pings immediately
+        if command == "PING":
+            self.conn.send("PONG " + command_params[-1], log=False)
+
+        # Parse the command and params
+        # Content
+        content_raw = _get_param(message, content_params)
+        if content_raw is not None:
+            content = irc_clean(content_raw)
+        else:
+            content = None
 
-            # Target (for KICK, INVITE)
-            if event_type is EventType.kick:
-                target = command_params[1]
-            elif command in ("INVITE", "MODE"):
-                target = command_params[0]
-            else:
-                # TODO: Find more commands which give a target
-                target = None
-
-            # Parse for CTCP
-            if event_type is EventType.message and content_raw.startswith("\x01"):
-                possible_ctcp = content_raw[1:]
-                if content_raw.endswith('\x01'):
-                    possible_ctcp = possible_ctcp[:-1]
-
-                if '\x01' in possible_ctcp:
-                    logger.debug(
-                        "[%s] Invalid CTCP message received, "
-                        "treating it as a mornal message",
-                        self.conn.name
-                    )
-                    ctcp_text = None
-                else:
-                    ctcp_text = possible_ctcp
-                    ctcp_text_split = ctcp_text.split(None, 1)
-                    if ctcp_text_split[0] == "ACTION":
-                        # this is a CTCP ACTION, set event_type and content accordingly
-                        event_type = EventType.action
-                        content = irc_clean(ctcp_text_split[1])
-                    else:
-                        # this shouldn't be considered a regular message
-                        event_type = EventType.other
-            else:
+        # Event type
+        event_type = irc_command_to_event_type.get(
+            command, EventType.other
+        )
+        target = _get_param(message, target_params)
+
+        # Parse for CTCP
+        if event_type is EventType.message and content_raw.startswith("\x01"):
+            possible_ctcp = content_raw[1:]
+            if content_raw.endswith('\x01'):
+                possible_ctcp = possible_ctcp[:-1]
+
+            if '\x01' in possible_ctcp:
+                logger.debug(
+                    "[%s] Invalid CTCP message received, "
+                    "treating it as a mornal message",
+                    self.conn.name
+                )
                 ctcp_text = None
-
-            # Channel
-            channel = None
-            if command_params:
-                if command in ["NOTICE", "PRIVMSG", "KICK", "JOIN", "PART", "MODE"]:
-                    channel = command_params[0]
-                elif command == "INVITE":
-                    channel = command_params[1]
-                elif len(command_params) > 2 or not (command_params.has_trail and len(command_params) == 1):
-                    channel = command_params[0]
-
-            prefix = message.prefix
-
-            if prefix is None:
-                nick = None
-                user = None
-                host = None
-                mask = None
             else:
-                nick = prefix.nick
-                user = prefix.user
-                host = prefix.host
-                mask = prefix.mask
-
-            if channel:
-                # TODO Migrate plugins to accept the original case of the channel
-                channel = channel.lower()
-
-                channel = channel.split()[0]  # Just in case there is more data
-
-                if channel == self.conn.nick.lower():
-                    channel = nick.lower()
-
-            # Set up parsed message
-            # TODO: Do we really want to send the raw `prefix` and `command_params` here?
-            event = Event(
-                bot=self.bot, conn=self.conn, event_type=event_type, content_raw=content_raw, content=content,
-                target=target, channel=channel, nick=nick, user=user, host=host, mask=mask, irc_raw=line,
-                irc_prefix=mask, irc_command=command, irc_paramlist=command_params, irc_ctcp_text=ctcp_text
-            )
-
-            # handle the message, async
-            async_util.wrap_future(self.bot.process(event), loop=self.loop)
+                ctcp_text = possible_ctcp
+                ctcp_text_split = ctcp_text.split(None, 1)
+                if ctcp_text_split[0] == "ACTION":
+                    # this is a CTCP ACTION, set event_type and content accordingly
+                    event_type = EventType.action
+                    content = irc_clean(ctcp_text_split[1])
+                else:
+                    # this shouldn't be considered a regular message
+                    event_type = EventType.other
+        else:
+            ctcp_text = None
+
+        # Channel
+        channel = _get_param(message, chan_params)
+        prefix = message.prefix
+        if prefix is None:
+            nick = None
+            user = None
+            host = None
+            mask = None
+        else:
+            nick = prefix.nick
+            user = prefix.user
+            host = prefix.host
+            mask = prefix.mask
+
+        if channel:
+            # TODO Migrate plugins to accept the original case of the channel
+            channel = channel.lower()
+
+            channel = channel.split()[0]  # Just in case there is more data
+
+            # Channel for a PM is the sending user
+            if channel == self.conn.nick.lower():
+                channel = nick.lower()
+
+        # Set up parsed message
+        # TODO: Do we really want to send the raw `prefix` and `command_params` here?
+        event = Event(
+            bot=self.bot, conn=self.conn, event_type=event_type, content_raw=content_raw, content=content,
+            target=target, channel=channel, nick=nick, user=user, host=host, mask=mask, irc_raw=line,
+            irc_prefix=mask, irc_command=command, irc_paramlist=command_params, irc_ctcp_text=ctcp_text
+        )
+        return event
 
     @property
     def connected(self):

cloudbot/event.py

@@ -2,6 +2,7 @@
 import enum
 import logging
 from functools import partial
+from typing import Any, Iterator, Mapping
 
 from irclib.parser import Message
 
@@ -20,7 +21,7 @@ class EventType(enum.Enum):
     other = 6
 
 
-class Event:
+class Event(Mapping[str, Any]):
     """
     :type bot: cloudbot.bot.CloudBot
     :type conn: cloudbot.client.Client
@@ -38,7 +39,7 @@ class Event:
     :type irc_raw: str
     :type irc_prefix: str
     :type irc_command: str
-    :type irc_paramlist: str
+    :type irc_paramlist: list[str]
     :type irc_ctcp_text: str
     """
 
@@ -135,6 +136,18 @@ def __init__(self, *, bot=None, hook=None, conn=None, base_event=None, event_typ
             self.irc_paramlist = irc_paramlist
             self.irc_ctcp_text = irc_ctcp_text
 
+    def __len__(self) -> int:
+        return len(self.__dict__)
+
+    def __iter__(self) -> Iterator[str]:
+        return iter(self.__dict__)
+
+    def __getitem__(self, item: str) -> Any:
+        try:
+            return getattr(self, item)
+        except AttributeError:
+            raise KeyError(item)
+
     async def prepare(self):
         """
         Initializes this event to be run through it's hook
@@ -383,12 +396,6 @@ def is_nick_valid(self, nick):
         """
         return self.conn.is_nick_valid(nick)
 
-    def __getitem__(self, item):
-        try:
-            return getattr(self, item)
-        except AttributeError:
-            raise KeyError(item)
-
 
 class CommandEvent(Event):
     """