Add initial Timer plugin

Timer/README.md

@@ -0,0 +1 @@
+Command based scheduling for triggers

Timer/__init__.py

@@ -0,0 +1,68 @@
+###
+# Copyright (c) 2016, Toni Fadjukoff
+# 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.
+
+###
+
+"""
+Timer: Command based scheduling for triggers
+"""
+
+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.authors.unknown
+
+# 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__ = ''
+
+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:

Timer/config.py

@@ -0,0 +1,57 @@
+###
+# Copyright (c) 2016, Toni Fadjukoff
+# 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('Timer')
+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('Timer', True)
+
+
+Timer = conf.registerPlugin('Timer')
+# This is where your configuration variables (if any) should go.  For example:
+# conf.registerGlobalValue(Timer, 'someConfigVariableName',
+#     registry.Boolean(False, _("""Help for someConfigVariableName.""")))
+
+
+# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

Timer/local/__init__.py

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

Timer/plugin.py

@@ -0,0 +1,172 @@
+# encoding: UTF-8
+###
+# Copyright (c) 2016, Toni Fadjukoff
+# 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 time
+from dateutil.rrule import *
+
+import supybot.utils as utils
+from supybot.commands import *
+import supybot.plugins as plugins
+import supybot.ircutils as ircutils
+import supybot.schedule as schedule
+import supybot.callbacks as callbacks
+try:
+    from supybot.i18n import PluginInternationalization
+    _ = PluginInternationalization('Timer')
+except ImportError:
+    # Placeholder that allows to run the plugin on a bot
+    # without the i18n module
+    _ = lambda x: x
+
+
+class Timer(callbacks.Plugin):
+    """Command based scheduling for triggers"""
+
+    def __init__(self, irc):
+        self.__parent = super(Timer, self)
+        self.__parent.__init__(irc)
+        self.events = {}
+
+    def _makeCommandFunction(self, irc, msg, message):
+        nickprefix = msg.prefix.split("!")[0] + ": " if ircutils.isChannel(msg.args[0]) else ""
+        message = format("echo %s%s", nickprefix, message)
+        tokens = callbacks.tokenize(message)
+        def f():
+            del self.events[str(f.eventId)]
+            self.Proxy(irc.irc, msg, tokens)
+        return f
+
+    @staticmethod
+    def _parseDate(arg):
+        day = 0
+        month = 0
+        if len(arg) == 6 and arg[2] == arg[5] == "." and arg[0:2].isdigit() and arg[3:5].isdigit():
+                day = int(arg[0:2])
+                month = int(arg[3:5])
+        elif len(arg) == 5 and arg[2] == arg[4] == "." and arg[0:2].isdigit() and arg[3:4].isdigit():
+                day = int(arg[0:2])
+                month = int(arg[3:4])
+        elif len(arg) == 5 and arg[1] == arg[4] == "." and arg[0:1].isdigit() and arg[2:4].isdigit():
+                day = int(arg[0:1])
+                month = int(arg[2:4])
+        elif len(arg) == 4 and arg[1] == arg[3] == "." and arg[0:1].isdigit() and arg[2:3].isdigit():
+                day = int(arg[0:1])
+                month = int(arg[2:3])
+        if 0 < day < 32 and 0 < month < 13:
+                return month, day
+        return None
+
+    @staticmethod
+    def _parseTime(arg):
+        if ":" in arg:
+            hours, minutes = arg.split(":")
+        elif "." in arg:
+            hours, minutes = arg.split(".")
+        elif len(arg) == 4:
+            hours = arg[0:2]
+            minutes = arg[2:4]
+        elif len(arg) == 3:
+            hours = arg[0]
+            minutes = arg[1:3]
+        elif len(arg) in (1,2):
+            hours = arg
+            minutes = "0"
+        else:
+            hours = None
+            minutes = None
+        if hours == None or len(hours) not in (1,2) or len(minutes) not in (1,2):
+            return
+
+        try:
+            hours = int(hours)
+        except ValueError as e:
+            return
+        try:
+            minutes = int(minutes)
+        except ValueError as e:
+            return
+
+        if minutes >= 60:
+            hours += int(minutes / 60)
+            minutes = minutes % 60
+        if hours >= 24:
+            hours = hours % 24
+
+        return hours, minutes 
+
+    def _resolveTime(self, irc, dateArg, timeArg):
+        month = mday = hours = minutes = None
+        if dateArg != None:
+            (month, mday) = self._parseDate(dateArg)
+
+        (hours, minutes) = self._parseTime(timeArg)
+
+        return list(rrule(MINUTELY, count = 1, bymonth = month, bymonthday = mday,
+                byhour = hours, byminute = minutes))[0]
+
+    def _testDate(date):
+        return Timer._parseDate(date) != None
+
+    def _testTime(time):
+        return Timer._parseTime(time) != None
+
+    def _scheduleOnce(self, irc, msg, message, scheduleTime):
+        #irc.reply(format("Scheduled at %s", scheduleTime))
+        f = self._makeCommandFunction(irc, msg, message)
+        id = schedule.addEvent(f, scheduleTime)
+        f.eventId = id
+        self.events[str(id)] = f
+
+    def timer(self, irc, msg, args, dateArg, timeArg, message):
+        """[date] <time> <message>
+
+        Set a message to be played back later.
+        """
+        scheduleTime = self._resolveTime(irc, dateArg, timeArg).timestamp()
+        self._scheduleOnce(irc, msg, message, scheduleTime)
+
+    timer = wrap(timer, [optional(('something', None, _testDate)), ('something', None, _testTime), 'text'])
+
+    def food(self, irc, msg, args, minutes, message):
+        """[minuutit] [viesti]
+
+        Huomauta viestillä muutaman minuutin päästä.
+        Pikakomennot: pizza 12 minuuttia, makaronilaatikko 60 minuuttia, ranskalaiset 30 minuuttia
+        """
+        irc.reply(format('Meikä kiekaisee sitten %i minuutin päästä %s', minutes, message))
+        scheduleTime = time.time() + minutes * 60
+        self._scheduleOnce(irc, msg, message, scheduleTime)
+    food = wrap(food, ['positiveInt', 'text'])
+
+Class = Timer
+
+
+# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:

Timer/test.py

@@ -0,0 +1,55 @@
+###
+# Copyright (c) 2016, Toni Fadjukoff
+# 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 TimerTestCase(PluginTestCase):
+    plugins = ('Timer',)
+
+    def testTimer(self):
+        self.assertNoResponse("timer 1.1. 00:00 Happy New Year")
+
+    def testTimerWithTime(self):
+        self.assertNoResponse("timer 18:30 Hejssan")
+
+    def testTimerWithDateAndTime(self):
+        self.assertNoResponse("timer 22.8. 18:30 Hejssan")
+
+    def testFoodWithPremade(self):
+        self.assertResponse("pizza", "Meikä kiekaisee sitten 12 minuutin päästä Pizza")
+
+    def testFoodWithArgs(self):
+        self.assertResponse("food 15 whatever", "Meikä kiekaisee sitten 15 minuutin päästä whatever")
+
+    def testFoodWithArgs(self):
+        self.assertResponse("ruoka 15 pyykit", "Meikä kiekaisee sitten 15 minuutin päästä pyykit")
+
+# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: