AsterFix.py

"""
Created on Feb 17, 2015

@author: StarlitGhost
"""
from twisted.plugin import IPlugin
from desertbot.moduleinterface import IModule, BotModule, ignore
from zope.interface import implementer

import re

from pyxdameraulevenshtein import normalized_damerau_levenshtein_distance as ndld

from desertbot.message import IRCMessage
from desertbot.response import IRCResponse, ResponseType


@implementer(IPlugin, IModule)
class AsterFix(BotModule):
    def actions(self):
        return super(AsterFix, self).actions() + [('message-channel', 1, self.asterFix),
                                                  ('message-user', 1, self.asterFix),
                                                  ('action-channel', 1, self.storeMessage),
                                                  ('action-user', 1, self.storeMessage)]

    def help(self, query):
        return ('**<fix> - looks for similar text in your last message'
                ' and attempts to replace the most likely candidate')

    def onLoad(self):
        self.messages = {}

    @ignore
    def asterFix(self, message: IRCMessage):
        changeMatch = re.match(r"^(?P<change>(\*\*[^\s*]+)|([^\s*]+)\*\*)$", message.messageString)
        if changeMatch:
            change = changeMatch.group('change').strip('*')
        else:
            self.storeMessage(message)
            return

        lastMessage = self.messages[message.user.nick]
        lastmessageList = lastMessage.messageList

        # Skip 1-word messages, as it just leads to direct repetition
        if len(lastmessageList) <= 1:
            return

        likelyChanges = self._getCloseMatches(change, lastmessageList, 5, 0.5)
        likelyChanges = list(filter((lambda word: word != change), likelyChanges))

        if likelyChanges:
            target = likelyChanges[0]
            responseList = [change if word == target else word for word in lastmessageList]
            response = " ".join(responseList)

            # Store the modified message so it can be aster-fixed again
            self.messages[message.user.nick].messageList = responseList

            if lastMessage.type == 'ACTION':
                responseType = ResponseType.Do
            else:
                responseType = ResponseType.Say

            return IRCResponse(responseType, response, message.replyTo)

    def storeMessage(self, message):
        self.messages[message.user.nick] = message

    @staticmethod
    def _getCloseMatches(change, messageList, n, threshold):
        similarities = sorted([(ndld(change, part), part) for part in messageList])
        closeMatches = [word for (diff, word) in similarities if diff <= threshold]
        topN = closeMatches[:n]
        return topN


asterFix = AsterFix()