earwigbot/earwigbot/irc/rc.py

# -*- coding: utf-8  -*-
#
# Copyright (C) 2009-2021 Ben Kurtovic <ben.kurtovic@gmail.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import re

__all__ = ["RC"]

class RC:
    """Store data from an event received from our IRC watcher."""
    re_color = re.compile("\x03([0-9]{1,2}(,[0-9]{1,2})?)?")
    re_edit = re.compile("\A\[\[(.*?)\]\]\s(.*?)\s(https?://.*?)\s\*\s(.*?)\s\*\s(.*?)\Z")
    re_log = re.compile("\A\[\[(.*?)\]\]\s(.*?)\s\s\*\s(.*?)\s\*\s(.*?)\Z")

    pretty_edit = "\x02New {0}\x0F: \x0314[[\x0307{1}\x0314]]\x0306 * \x0303{2}\x0306 * \x0302{3}\x0306 * \x0310{4}"
    pretty_log = "\x02New {0}\x0F: \x0303{1}\x0306 * \x0302{2}\x0306 * \x0310{3}"
    plain_edit = "New {0}: [[{1}]] * {2} * {3} * {4}"
    plain_log = "New {0}: {1} * {2} * {3}"

    def __init__(self, chan, msg):
        self.chan = chan
        self.msg = msg

    def __repr__(self):
        """Return the canonical string representation of the RC."""
        return "RC(chan={0!r}, msg={1!r})".format(self.chan, self.msg)

    def __str__(self):
        """Return a nice string representation of the RC."""
        return "<RC of {0!r} on {1}>".format(self.msg, self.chan)

    def parse(self):
        """Parse a recent change event into some variables."""
        # Strip IRC color codes; we don't want or need 'em:
        self.msg = self.re_color.sub("", self.msg).strip()
        msg = self.msg
        self.is_edit = True

        # Flags: 'M' for minor edit, 'B' for bot edit, 'create' for a user
        # creation log entry, etc:
        try:
            page, self.flags, url, user, comment = self.re_edit.findall(msg)[0]
        except IndexError:
            # We're probably missing the https:// part, because it's a log
            # entry, which lacks a URL:
            page, flags, user, comment = self.re_log.findall(msg)[0]
            url = "https://{0}.org/wiki/{1}".format(self.chan[1:], page)

            self.is_edit = False  # This is a log entry, not edit

            # Flags tends to have extra whitespace at the end when they're
            # log entries:
            self.flags = flags.strip()

        self.page, self.url, self.user, self.comment = page, url, user, comment

    def prettify(self, color=True):
        """Make a nice, colorful message to send back to the IRC front-end."""
        flags = self.flags
        if self.is_edit:
            if "N" in flags:
                event = "page"  # "New page:"
            else:
                event = "edit"  # "New edit:"
                if "B" in flags:
                    event = "bot edit"  # "New bot edit:"
                if "M" in flags:
                    event = "minor " + event  # "New minor (bot)? edit:"
            tmpl = self.pretty_edit if color else self.plain_edit
            return tmpl.format(event, self.page, self.user, self.url, self.comment)

        if flags == "delete":
            event = "deletion"  # "New deletion:"
        elif flags == "protect":
            event = "protection"  # "New protection:"
        elif flags == "create":
            event = "user"  # "New user:"
        else:
            event = flags  # Works for "move", "block", etc
        tmpl = self.pretty_log if color else self.plain_log
        return tmpl.format(event, self.user, self.url, self.comment)