CtcpNext: initial commit

CtcpNext/README.md

@@ -0,0 +1 @@
+Alternative to the official Ctcp plugin, with configurable replies.

CtcpNext/__init__.py

@@ -0,0 +1,69 @@
+###
+# Copyright (c) 2015, James Lu
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+###
+
+"""
+CtcpNext: Alternative to the official Ctcp plugin, with configurable replies.
+"""
+
+import supybot
+import supybot.world as world
+
+# Use this for the version of this plugin.  You may wish to put a CVS keyword
+# in here if you're keeping the plugin in CVS or some similar system.
+__version__ = ""
+
+# XXX Replace this with an appropriate author or supybot.Author instance.
+__author__ = supybot.Author('James Lu', 'GLolol',
+                            'GLolol@overdrive.pw')
+
+# 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__ = 'https://github.com/GLolol/SupyPlugins/'
+
+from . import config
+from . import plugin
+from imp import reload
+# In case we're being reloaded.
+reload(config)
+reload(plugin)
+# Add more reloads here if you add third-party modules and want them to be
+# reloaded when this plugin is reloaded.  Don't forget to import them as well!
+
+if world.testing:
+    from . import test
+
+Class = plugin.Class
+configure = config.configure
+
+
+# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

CtcpNext/config.py

@@ -0,0 +1,56 @@
+###
+# Copyright (c) 2015, James Lu
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+###
+
+import supybot.conf as conf
+import supybot.registry as registry
+try:
+    from supybot.i18n import PluginInternationalization
+    _ = PluginInternationalization('CtcpNext')
+except:
+    # Placeholder that allows to run the plugin on a bot
+    # without the i18n module
+    _ = lambda x:x
+
+def configure(advanced):
+    # This will be called by supybot to configure this module.  advanced is
+    # a bool that specifies whether the user identified themself as an advanced
+    # user or not.  You should effect your configuration by manipulating the
+    # registry as appropriate.
+    from supybot.questions import expect, anything, something, yn
+    conf.registerPlugin('CtcpNext', True)
+
+
+CtcpNext = conf.registerPlugin('CtcpNext')
+# This is where your configuration variables (if any) should go.  For example:
+# conf.registerGlobalValue(CtcpNext, 'someConfigVariableName',
+#     registry.Boolean(False, _("""Help for someConfigVariableName.""")))
+
+
+# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

CtcpNext/local/__init__.py

@@ -0,0 +1 @@
+# Stub so local is a module, used for third-party modules

CtcpNext/plugin.py

@@ -0,0 +1,148 @@
+###
+# Copyright (c) 2015, James Lu
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+###
+
+import pickle
+from time import ctime
+
+import supybot.utils as utils
+import supybot.world as world
+import supybot.ircmsgs as ircmsgs
+import supybot.conf as conf
+from supybot.commands import *
+import supybot.plugins as plugins
+import supybot.ircutils as ircutils
+import supybot.callbacks as callbacks
+try:
+    from supybot.i18n import PluginInternationalization
+    _ = PluginInternationalization('CtcpNext')
+except ImportError:
+    # Placeholder that allows to run the plugin on a bot
+    # without the i18n module
+    _ = lambda x:x
+
+filename = conf.supybot.directories.data.dirize("CtcpNext.db")
+
+class CtcpNext(callbacks.PluginRegexp):
+    """Alternative to the official Ctcp plugin, with configurable replies."""
+    regexps = ("ctcp", "ctcpPing")
+    
+    def loadDB(self):
+        try:
+            with open(filename, 'rb') as f:
+               self.db = pickle.load(f)
+        except Exception as e:
+            self.log.debug('CtcpNext: Unable to load pickled database: %s', e)
+
+    def exportDB(self):
+        try:
+            with open(filename, 'wb') as f:
+                pickle.dump(self.db, f, 2)
+        except Exception as e:
+             self.log.warning('CtcpNext: Unable to write pickled database: %s', e)
+    
+    def __init__(self, irc):
+        self.__parent = super(CtcpNext, self)
+        self.__parent.__init__(irc)
+        self.db = {'VERSION': 'Supybot %v', 'TIME': '%t'}
+        self.loadDB()
+        world.flushers.append(self.exportDB)
+        
+    def die(self):
+        self.exportDB()
+        world.flushers.remove(self.exportDB)
+        self.__parent.die()
+
+    def _reply(self, irc, msg, payload, s):
+        if s:
+            s = '\x01%s %s\x01' % (payload, s)
+        else:
+            s = '\x01%s\x01' % payload
+        irc.queueMsg(ircmsgs.notice(msg.nick, s))
+
+    def ctcpPing(self, irc, msg, match):
+        "^\x01PING(?: (.+))?\x01$"
+        self.log.info('CtcpNext: Received CTCP PING from %s', msg.prefix)
+        payload = match.group(1) or ''
+        self._reply(irc, msg, 'PING', payload)
+
+    def ctcp(self, irc, msg, match):
+        "^\x01(.*?)\x01$"
+        payload = match.group(1)
+        if payload:
+            payload = payload.split()[0].upper()
+            if payload in ('PING', 'ACTION'):
+                return
+            try:
+                response = self.db[payload]
+                response = response.replace("%v", conf.version)
+                response = response.replace("%t", ctime())
+                self._reply(irc, msg, payload, response)
+                self.log.info('CtcpNext: Received CTCP %s from %s', payload,
+                              msg.prefix)
+            except KeyError:
+                self.log.info('CtcpNext: Received unhandled CTCP %s from %s',
+                              payload, msg.prefix)
+
+    def set(self, irc, msg, args, ctcp, response):
+        """<ctcp> <response>
+        
+        Sets the response for <ctcp> to <response>. Exceptions include
+        ACTION and PING, which are handled accordingly. %v will be expanded
+        to the bot's version. %t expands to the current time.
+        """
+        self.db[ctcp.upper()] = response
+        irc.replySuccess()
+    set = wrap(set, ['somethingWithoutSpaces', 'text'])
+
+    def unset(self, irc, msg, args, ctcp):
+        """<ctcp>
+        
+        Unsets the response for <ctcp>.
+        """
+        ctcp = ctcp.upper()
+        try:
+            del self.db[ctcp]
+        except KeyError:
+            irc.error("No such CTCP '%s' exists." % ctcp, Raise=True)
+        else:
+            irc.replySuccess()
+    unset = wrap(unset, ['somethingWithoutSpaces'])
+    
+    def list(self, irc, msg, args):
+        """takes no arguments.
+        
+        Lists the CTCP responses currently configured."""
+        items = [format("%s: %s", k, ircutils.bold(v)) for (k, v) in self.db.items()]
+        irc.reply(format('%L', items))
+
+Class = CtcpNext
+
+
+# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:

CtcpNext/test.py

@@ -0,0 +1,37 @@
+###
+# Copyright (c) 2015, James Lu
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+###
+
+from supybot.test import *
+
+class CtcpNextTestCase(PluginTestCase):
+    plugins = ('CtcpNext',)
+
+
+# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

README.md

@@ -31,6 +31,9 @@ Please note that this list may not always be up to date; your best bet is to act
 
 Most of these plugins have their own READMEs in their folders; you can check them for a usage demonstration or further explanation of what they do.
 
+##### CtcpNext
+- Alternative to the official Ctcp plugin, with a database for configurable replies.
+
 ##### DDG
 - Provides an interface to DuckDuckGo's web search.
    - **Requires:** [Beautiful Soup 4](http://www.crummy.com/software/BeautifulSoup/bs4/doc/)