Update Cobe plugin.

Cobe/__init__.py

@@ -40,14 +40,16 @@ import supybot.world as world
 __version__ = ""
 
 # XXX Replace this with an appropriate author or supybot.Author instance.
-__author__ = supybot.authors.unknown
+__author__ = supybot.Author('waratte', 'waratte', '')
+__maintainer__ = getattr(supybot.authors, 'oddluck',
+                         supybot.Author('oddluck', 'oddluck', 'oddluck@riseup.net'))
 
 # This is a dictionary mapping supybot.Author instances to lists of
 # contributions.
 __contributors__ = {}
 
 # This is a url where the most recent plugin package can be downloaded.
-__url__ = '' # 'http://supybot.com/Members/yourname/Cobe/download'
+__url__ = 'https://github.com/oddluck/limnoria-plugins/'
 
 from . import config
 from . import plugin

Cobe/config.py

@@ -51,14 +51,30 @@ Cobe = conf.registerPlugin('Cobe')
 # conf.registerGlobalValue(Cobe, 'someConfigVariableName',
 #     registry.Boolean(False, _("""Help for someConfigVariableName.""")))
 
-conf.registerGlobalValue(Cobe, 'ignoreRegex', registry.String('^[.@!$%]', _("""Regex to ignore when learning text. Perfect for ignoring commands!.""")))
+conf.registerChannelValue(Cobe, 'enable',
-conf.registerGlobalValue(Cobe, 'stripUrls', registry.Boolean(True, _("""Keep the bot from learning URLs?""")))
+    registry.Boolean(False, _("""Determines whether the plugin is enabled on a channel. This defaults to False to avoid useless resources consumption.""")))
-conf.registerGlobalValue(Cobe, 'stripNicks', registry.Boolean(False, _("""Strip all nicks, including the bots, when learning? This replaces a nick with the keyword MAGIC_NICK to use for random highlighting.""")))
+conf.registerChannelValue(Cobe, 'stripRelayedNick',
-conf.registerChannelValue(Cobe, 'probability', registry.NonNegativeInteger(0, _("""Determines the percent of messages the bot will answer.""")))
+    registry.Boolean(True, _("""Determines whether the bot will strip strings like <XXX> at the beginning of messages.""")))
-conf.registerChannelValue(Cobe, 'probabilityWhenAddressed', registry.NonNegativeInteger(10000, _("""Determines the percent of messages adressed to the bot the bot will answer, to the 0.01%. The maximum is 10000/10000""")))
+conf.registerChannelValue(Cobe, 'stripURL',
-conf.registerChannelValue(Cobe, 'waitTimeBetweenSpeaking', registry.NonNegativeInteger(10, _("""Seconds to wait in a channel before speaking again.""")))
+    registry.Boolean(True, _("""Determines whether the bot will strip URLs from messages.""")))
-conf.registerChannelValue(Cobe, 'ignoreWaitTimeIfAddressed', registry.Boolean(True, _("""If directly addressed, should we ignore the wait time?""")))
+conf.registerChannelValue(Cobe, 'ignoreNicks',
-conf.registerChannelValue(Cobe, 'responseDelay', registry.Boolean(False, _("""Delay responding for 2 to 4 seconds in order to seem more human?""")))
+    registry.SpaceSeparatedListOfStrings([], _("""A list of nicks to be ignored by the bot""")))
+conf.registerChannelValue(Cobe, 'ignorePattern',
+    registry.Regexp("", _("""Mesages matching this pattern will be ignored.""")))
+conf.registerChannelValue(Cobe, 'stripPattern',
+    registry.Regexp("", _("""Text matching this pattern will be stripped.""")))
+conf.registerChannelValue(Cobe, 'stripNicks',
+    registry.Boolean(False, _("""Strip all nicks, including the bots, when learning? This replaces a nick with the keyword MAGIC_NICK to use for random highlighting.""")))
+conf.registerChannelValue(Cobe, 'probability',
+    registry.NonNegativeInteger(0, _("""Determines the percent of messages the bot will answer.""")))
+conf.registerChannelValue(Cobe, 'probabilityWhenAddressed',
+    registry.NonNegativeInteger(10000, _("""Determines the percent of messages adressed to the bot the bot will answer, to the 0.01%. The maximum is 10000/10000""")))
+conf.registerChannelValue(Cobe, 'waitTimeBetweenSpeaking',
+    registry.NonNegativeInteger(10, _("""Seconds to wait in a channel before speaking again.""")))
+conf.registerChannelValue(Cobe, 'ignoreWaitTimeIfAddressed',
+    registry.Boolean(True, _("""If directly addressed, should we ignore the wait time?""")))
+conf.registerChannelValue(Cobe, 'responseDelay',
+    registry.Boolean(False, _("""Delay responding for 2 to 4 seconds in order to seem more human?""")))
 
 
 # vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

Cobe/plugin.py

@@ -51,29 +51,28 @@ except ImportError:
 import supybot.ircmsgs as ircmsgs
 import supybot.conf as conf
 import supybot.schedule as schedule
+import supybot.log as log
 
-# Custom modules imported    
+# Custom modules imported
 try:
-    from cobe.brain import Brain
+    from cobe_hubbot.brain import Brain
 except ImportError:
     raise callbacks.Error('You need to install cobe for this plugin to work!')
-try:
+
-    import chardet
+MATCH_MESSAGE_STRIPNICK = re.compile('^(<[^ ]+> )?(?P<message>.*)$')
-except ImportError:
+
-    raise callbacks.Error('You need to install chardet for this plugin to work!')
-    
 class Cobe(callbacks.Plugin):
     """
     Cobe is frontend to the cobe markov-chain bot for Limnoria/supybot. Use "list Cobe" to list possible
     commands and "help Cobe <command>" to read their docs.
     """
     threaded = True
-    magicnick = 'PLZREPLACEMENICKUNKNOWNWORDSHAHAH'
+    magicnick = '<&#@!%~>'
-    
+
     def __init__(self, irc):
         self.__parent = super(Cobe, self)
         self.__parent.__init__(irc)
-        
+
     def _strip_nick(self, irc, msg, text):
         for user in irc.state.channels[msg.args[0]].users:
             if len(user) <= 4: # Do not replace short nicks, as they might very
@@ -83,109 +82,63 @@ class Cobe(callbacks.Plugin):
             text = text.replace(user.lower(), self.magicnick)
             text = text.replace(user.capitalize(), self.magicnick)
         return text
-        
+
     def _getBrainDirectoryForChannel(self, channel):
-        """Internal method for retrieving the directory of a brainfile for a channel""" 
+        """Internal method for retrieving the directory of a brainfile for a channel"""
-    
         directory = conf.supybot.directories.data
         directory = directory.dirize(channel.lower() + "/cobe.brain")
-        
         return directory
-        
+
     def _doCommand(self, channel):
         """Internal method for accessing a cobe brain."""
-        
         dataDirectory = conf.supybot.directories.data
         dataDirectory = dataDirectory.dirize(channel.lower() + "/cobe.brain")
-        
         return 'cobe --brain %s' % dataDirectory
-        
-    def _decodeIRCMessage(self, raw, preferred_encs = ["UTF-8", "CP1252", "ISO-8859-1"]):
-        """Internal method for decoding IRC messages."""
-
-        changed = False
-        for enc in preferred_encs:
-            try:
-                res = raw.decode(enc)
-                changed = True
-                break
-            except:
-                pass
-        if not changed:
-            try:
-                enc = chardet.detect(raw)['encoding']
-                res = raw.decode(enc)
-            except:
-                res = raw.decode(enc, 'ignore')
-                
-        return res
 
     def _cleanText(self, text):
         """Internal method for cleaning text of imperfections."""
-        
-        text = self._decodeIRCMessage(text)         # Decode the string.
         text = ircutils.stripFormatting(text)       # Strip IRC formatting from the string.
         text = text.strip()                         # Strip whitespace from beginning and the end of the string.
         if len(text) > 1:
             # So we don't get an error if the text is too small
-            
             text = text[0].upper() + text[1:]       # Capitalize first letter of the string.
-            
         text = utils.str.normalizeWhitespace(text)  # Normalize the whitespace in the string.
-        
         return text
-        
+
     def _learn(self, irc, msg, channel, text, probability):
         """Internal method for learning phrases."""
-        
         if os.path.exists(self._getBrainDirectoryForChannel(channel)):
             # Does this channel have a directory for the brain file stored and does this file exist?
-            
             text = self._cleanText(text)
-            
             if text and len(text) > 1 and not text.isspace():
-        
                 self.log.debug("Learning: {0}".format(text))
                 cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
                 cobeBrain.learn(text)
-                
                 if random.randint(0, 10000) <= probability:
                     self._reply(irc, msg, channel, text)
-                
         else: # Nope, let's make it!
-                        
             subprocess.getoutput('{0} {1}'.format(self._doCommand(channel), 'init'))
-            
             text = self._cleanText(text)
-            
             if text and len(text) > 1 and not text.isspace():
-        
                 self.log.debug("Learning: {0}".format(text))
                 cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
                 cobeBrain.learn(text)
-                
                 if random.randint(0, 10000) <= probability:
                     self._reply(irc, msg, channel, text)
-                
+
     def _reply(self, irc, msg, channel, text):
         """Send a response to text"""
-        
         cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
-        response = cobeBrain.reply(text).encode('utf-8')
+        response = cobeBrain.reply(text)
         response = self._strip_nick(irc, msg, response)
-        
         for i in range(response.lower().count(self.magicnick.lower())):
             # If first word is nick, switch with the callers nick.
             if self.magicnick in response:
                 response = response.replace(self.magicnick, random.choice(list(irc.state.channels[msg.args[0]].users)))
             if self.magicnick.lower() in response:
                 response = response.replace(self.magicnick.lower(), random.choice(list(irc.state.channels[msg.args[0]].users)))
-
-        
         cobeBrain.learn(response) # Let's have the bot learn the wacky things it says
-        
         self.log.info("Attempting to respond in {0} with message: {1}".format(channel, response))
-        
         # delay the response here so we look real?
         if self.registryValue('responseDelay', channel):
             self.log.info("Delayed the response in %s." % channel)
@@ -193,49 +146,50 @@ class Cobe(callbacks.Plugin):
             schedule.addEvent(irc.queueMsg(ircmsgs.privmsg(channel, response)), delayseconds)
         else:
             irc.queueMsg(ircmsgs.privmsg(channel, response))
-            
-    def doPrivmsg(self, irc, msg):
-        
-        (channel, text) = msg.args
-        
-        if (callbacks.addressed(irc.nick, msg) 
-           or ircmsgs.isCtcp(msg) 
-           or not irc.isChannel(channel) 
-           or not (None == re.match(self.registryValue('ignoreRegex'), text))): 
-            # Was the message a CTCP command, a command to the bot, is this message supposed to be ignored, or are we not in a channel??
-        
-            self.log.debug("The method 'callbacks.addressed(irc.nick, msg)' returns {0}!".format(True == callbacks.addressed(irc.nick, msg)))
-            self.log.debug("The method 'ircmsgs.isCtcp(msg)' returns {0}!".format(True == ircmsgs.isCtcp(msg)))
-            self.log.debug("The method 'irc.isChannel(channel)' returns {0}!".format(False == irc.isChannel(channel)))
-            self.log.debug("The method 're.match(self.registryValue('ignoreRegex'), text)' returns {0}!".format(False == (None == re.match(self.registryValue('ignoreRegex'), text))))
 
+    def doPrivmsg(self, irc, msg):
+        (channel, message) = msg.args
+        if callbacks.addressed(irc.nick, msg) or ircmsgs.isCtcp(msg) or not irc.isChannel(channel) or not self.registryValue('enable', channel):
+            return
+        match = False
+        ignore = self.registryValue("ignorePattern", channel)
+        strip = self.registryValue("stripPattern", channel)
+        if ignore:
+            match = re.search(ignore, message)
+            if match:
+                log.debug("Cobe: %s matches ignorePattern for %s" % (message, channel))
+                return
+        if msg.nick.lower() in self.registryValue('ignoreNicks', channel):
+            log.debug("Cobe: nick %s in ignoreNicks for %s" % (msg.nick, channel))
             return
-            
-        
         if ircmsgs.isAction(msg):
             # If the message was an action...we'll learn it anyways!
-        
+            message = ircmsgs.unAction(msg)
-            text = ircmsgs.unAction(msg)
+        if self.registryValue('stripRelayedNick', channel):
-                    
+            message = MATCH_MESSAGE_STRIPNICK.match(message).group('message')
-        if self.registryValue('stripUrls'): # strip URLs
+        if strip:
-            text = re.sub(r'(http[^\s]*)', '', text)
+            match = re.findall(strip, message)
-        
+            if match:
-        if irc.nick.lower() in text.lower():
+                for x in match:
+                    message = message.replace(x, '')
+                    message = re.sub('\s+', ' ', message)
+                    log.debug("Cobe: %s matches stripPattern for %s. New message text: %s" % (x, channel, message))
+        if self.registryValue('stripURL', channel):
+            new_message = re.sub(r'(?i)\b((?:[a-z][\w-]+:(?:/{1,3}|[a-z0-9%])|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}/)(?:[^\s()<>]+|\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()<>]+\)))*\)|[^\s`!()\[\]{};:\'".,<>?«»“”‘’]))', '', message)
+            if new_message != message:
+                log.debug("Cobe: url(s) stripped from message for %s. New message text: %s" % (channel, new_message))
+                message = new_message
+        if irc.nick.lower() in message.lower():
             # Were we addressed in the channel?
-            
             probability = self.registryValue('probabilityWhenAddressed', channel)
-            
         else:
             # Okay, we were not addressed, but what's the probability we should reply?
-            
             probability = self.registryValue('probability', channel)
-
         #if self.registryValue('stripNicks'):
         #    removenicks = '|'.join(item + '\W.*?\s' for item in irc.state.channels[channel].users)
         #    text = re.sub(r'' + removenicks + '', 'MAGIC_NICK', text)
-        
+        self._learn(irc, msg, channel, message, probability) # Now we can pass this to our learn function!
-        self._learn(irc, msg, channel, text, probability) # Now we can pass this to our learn function!
+
-            
     def _makeSizePretty(self, size):
         """Internal command for making the size pretty!"""
         suffixes = [("Bytes",2**10), ("kibibytes",2**20), ("mebibytes",2**30), ("gibibytes",2**40), ("tebibytes",2**50)]
@@ -244,192 +198,133 @@ class Cobe(callbacks.Plugin):
                 continue
             else:
                 return round(size/float(lim/2**10),2).__str__()+suf
-            
+
     def brainsize(self, irc, msg, args, channel):
         """[<channel>]
-        
         Prints the size of the brain on disk. If <channel> is not given, then the current channel is used.
         """
-
         if not channel: # Did the user enter in a channel? If not, set the currect channel
             channel = msg.args[0]
-
         if not irc.isChannel(channel): # Are we in a channel?
             if os.path.exists(self._getBrainDirectoryForChannel(channel)):
                 # Does this channel have a brain file?
-                
                 size = float(os.path.getsize(self._getBrainDirectoryForChannel(channel)))
                 irc.reply("The brain file for the channel {0} is {1}.".format(channel, self._makeSizePretty(size)))
-                
             else: # Nope, raise error msg!
                 irc.error(_("I am missing a brainfile in {0}!".format(channel)), Raise=True)
-                
         elif os.path.exists(self._getBrainDirectoryForChannel(channel)): # We are in a channel! Does the brain file exist?
-        
             size = float(os.path.getsize(self._getBrainDirectoryForChannel(channel)))
             irc.reply("The brain file for the channel {0} is {1}.".format(channel, self._makeSizePretty(size)))
-            
         else:
-            
             irc.error(_("I am missing a brainfile in {0}!".format(channel)), Raise=True)
-
     brainsize = wrap(brainsize, [additional('channel')])
-    
+
     def teach(self, irc, msg, args, channel, text):
         """[<channel>] <text>
-
         Teaches the bot <text>. If the channel is not given, the current channel is used.
         """
         if not channel: # Did the user enter in a channel? If not, set the current channel
             channel = msg.args[0]
-
+        if not irc.isChannel(msg.args[0]) and irc.isChannel(channel):
-        if not irc.isChannel(msg.args[0]) and irc.isChannel(channel): 
             # Are we in a channel and is the channel supplied a channel?
-            
             if os.path.exists(self._getBrainDirectoryForChannel(channel)):
                 # Does this channel have a brain file?
-               
                 text = self._cleanText(text)
                 if text and len(text) > 1 and not text.isspace():
-            
                     irc.reply("Learning text: {0}".format(text))
                     cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
                     cobeBrain.learn(text)
-                    
                 else:
-        
                     irc.error(_("No text to learn!"), Raise=True)
-                    
+            else:
-            else: 
                 # Nope, create one!
-            
                 self.log.info("Non-existent brainfile in {0}!".format(channel))
                 self.log.info("Creating a brainfile now in {0}".format(self._getBrainDirectoryForChannel(channel)))
-                
                 subprocess.getoutput('{0} {1}'.format(self._doCommand(channel), 'init'))
-                
                 text = self._cleanText(text)
                 if text and len(text) > 1 and not text.isspace():
-            
                     irc.reply("Learning text: {0}".format(text))
                     cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
                     cobeBrain.learn(text)
-                
-                
         elif os.path.exists(self._getBrainDirectoryForChannel(channel)) and irc.isChannel(channel): 
             # We are in a channel! Does the brain file exist and are we supplied a channel?
-    
             text = self._cleanText(text)
             if text and len(text) > 1 and not text.isspace():
-        
                 irc.reply("Learning text: {0}".format(text))
                 cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
                 cobeBrain.learn(text)
-        
             else:
-        
                 irc.error(_("No text to learn!"), Raise=True)
-                
         elif not os.path.exists(self._getBrainDirectoryForChannel(channel)) and irc.isChannel(channel):
             # Nope, create one!
-        
             self.log.info("Non-existent brainfile in {0}!".format(channel))
             self.log.info("Creating a brainfile now in {0}".format(self._getBrainDirectoryForChannel(channel)))
-            
             subprocess.getoutput('{0} {1}'.format(self._doCommand(channel), 'init'))
-            
             text = self._cleanText(text)
             if text and len(text) > 1 and not text.isspace():
-        
                 irc.reply("Learning text: {0}".format(text))
                 cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
                 cobeBrain.learn(text)
-                
         else:
             irc.error(_("Improper channel given!"), Raise=True)
-            
     teach = wrap(teach, [('checkCapability', 'admin'), additional('channel'), 'text'])
 
     def respond(self, irc, msg, args, channel, text):
         """[<channel>] <text>
-
         Replies to <text>. If the channel is not given, the current channel is used.
         """
         if not channel: # Did the user enter in a channel? If not, set the current channel
             channel = msg.args[0]
-
+        if not irc.isChannel(msg.args[0]) and irc.isChannel(channel):
-        if not irc.isChannel(msg.args[0]) and irc.isChannel(channel): 
             # Are we in a channel and is the channel supplied a channel?
-            
             if os.path.exists(self._getBrainDirectoryForChannel(channel)):
                 # Does this channel have a brain file?
-                
                     text = self._cleanText(text)
                     if text and len(text) > 1 and not text.isspace():
-                
                         cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
-                        response = cobeBrain.reply(text).encode('utf-8')
+                        response = cobeBrain.reply(text)
                         irc.reply(response)
-
                     else:
-            
                         irc.error(_("No text to reply to!"), Raise=True)
-                    
+            else:
-            else: 
                 # Nope, create one!
-            
                 self.log.info("Non-existent brainfile in {0}!".format(channel))
                 self.log.info("Creating a brainfile now in {0}".format(self._getBrainDirectoryForChannel(channel)))
-                
                 subprocess.getoutput('{0} {1}'.format(self._doCommand(channel), 'init'))
-                
                 text = self._cleanText(text)
                 if text and len(text) > 1 and not text.isspace():
-            
                     cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
-                    response = cobeBrain.reply(text).encode('utf-8')
+                    response = cobeBrain.reply(text)
                     irc.reply(response)
-                    
                 else:
                     irc.error(_("No text to reply to!"), Raise=True)
-                
+        elif os.path.exists(self._getBrainDirectoryForChannel(channel)) and irc.isChannel(channel):
-        elif os.path.exists(self._getBrainDirectoryForChannel(channel)) and irc.isChannel(channel): 
             # We are in a channel! Does the brain file exist and is this a channel?
-    
             text = self._cleanText(text)
             if text and len(text) > 1 and not text.isspace():
 
                 cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
-                response = cobeBrain.reply(text).encode('utf-8')
+                response = cobeBrain.reply(text)
                 irc.reply(response)
 
             else:
                 irc.error(_("No text to reply to!"), Raise=True)
-
         elif not os.path.exists(self._getBrainDirectoryForChannel(channel)) and irc.isChannel(channel):
             # Nope, create one!
-        
             self.log.info("Non-existent brainfile in {0}!".format(channel))
             self.log.info("Creating a brainfile now in {0}".format(self._getBrainDirectoryForChannel(channel)))
-            
             subprocess.getoutput('{0} {1}'.format(self._doCommand(channel), 'init'))
-            
             text = self._cleanText(text)
             if text and len(text) > 1 and not text.isspace():
-        
                 irc.reply("Learning text: {0}".format(text))
                 cobeBrain = Brain(self._getBrainDirectoryForChannel(channel))
                 cobeBrain.learn(text)
-                
             else:
                 irc.error(_("No text to reply to!"), Raise=True)
-                
         else:
             irc.error(_("Improper channel given!"), Raise=True)
-            
     respond = wrap(respond, [('checkCapability', 'admin'), additional('channel'), 'text'])
-    
+
 Class = Cobe
 
-
 # vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: