mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-23 11:09:23 +01:00
Added Later in the new plugin format.
This commit is contained in:
parent
94bfb279e6
commit
a93db7df32
1
plugins/Later/README.txt
Normal file
1
plugins/Later/README.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
Insert a description of your plugin here, with any notes, etc. about using it.
|
62
plugins/Later/__init__.py
Normal file
62
plugins/Later/__init__.py
Normal file
@ -0,0 +1,62 @@
|
|||||||
|
###
|
||||||
|
# Copyright (c) 2005, Jeremiah Fincher
|
||||||
|
# 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.
|
||||||
|
###
|
||||||
|
|
||||||
|
"""
|
||||||
|
Informal notes, mostly for compatibility with other bots. Based entirely on
|
||||||
|
nicks, it's an easy way to tell users who refuse to register notes when they
|
||||||
|
arrive later.
|
||||||
|
"""
|
||||||
|
|
||||||
|
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__ = "%%VERSION%%"
|
||||||
|
|
||||||
|
__author__ = supybot.authors.jemfinch
|
||||||
|
|
||||||
|
# This is a dictionary mapping supybot.Author instances to lists of
|
||||||
|
# contributions.
|
||||||
|
__contributors__ = {}
|
||||||
|
|
||||||
|
import config
|
||||||
|
import plugin
|
||||||
|
reload(plugin) # In case we're being reloaded.
|
||||||
|
# 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:
|
||||||
|
import test
|
||||||
|
|
||||||
|
Class = plugin.Class
|
||||||
|
configure = config.configure
|
||||||
|
|
||||||
|
|
||||||
|
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
|
49
plugins/Later/config.py
Normal file
49
plugins/Later/config.py
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
###
|
||||||
|
# Copyright (c) 2005, Jeremiah Fincher
|
||||||
|
# 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
|
||||||
|
|
||||||
|
def configure(advanced):
|
||||||
|
# This will be called by setup.py to configure this module. Advanced is
|
||||||
|
# a bool that specifies whether the user identified himself 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('Later', True)
|
||||||
|
|
||||||
|
Later = conf.registerPlugin('Later')
|
||||||
|
conf.registerGlobalValue(Later, 'maximum',
|
||||||
|
registry.NonNegativeInteger(0, """Determines the maximum number of messages
|
||||||
|
to be queued for a user. If this value is 0, there is no maximum."""))
|
||||||
|
conf.registerGlobalValue(Later, 'private',
|
||||||
|
registry.Boolean(True, """Determines whether users will be notified in the
|
||||||
|
first place in which they're seen, or in private."""))
|
||||||
|
|
||||||
|
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78
|
162
plugins/Later/plugin.py
Normal file
162
plugins/Later/plugin.py
Normal file
@ -0,0 +1,162 @@
|
|||||||
|
###
|
||||||
|
# Copyright (c) 2004, Jeremiah Fincher
|
||||||
|
# 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 csv
|
||||||
|
import time
|
||||||
|
|
||||||
|
import supybot.log as log
|
||||||
|
import supybot.conf as conf
|
||||||
|
import supybot.utils as utils
|
||||||
|
from supybot.commands import *
|
||||||
|
import supybot.ircutils as ircutils
|
||||||
|
import supybot.callbacks as callbacks
|
||||||
|
|
||||||
|
|
||||||
|
class Later(callbacks.Privmsg):
|
||||||
|
"""Used to do things later; currently, it only allows the sending of
|
||||||
|
nick-based notes. Do note (haha!) that these notes are *not* private
|
||||||
|
and don't even pretend to be; if you want such features, consider using the
|
||||||
|
Note plugin."""
|
||||||
|
def __init__(self, irc):
|
||||||
|
self.__parent = super(Later, self)
|
||||||
|
self.__parent.__init__(irc)
|
||||||
|
self._notes = ircutils.IrcDict()
|
||||||
|
self.wildcards = []
|
||||||
|
self.filename = conf.supybot.directories.data.dirize('Later.db')
|
||||||
|
self._openNotes()
|
||||||
|
|
||||||
|
def die(self):
|
||||||
|
self._flushNotes()
|
||||||
|
|
||||||
|
def _flushNotes(self):
|
||||||
|
fd = utils.file.AtomicFile(self.filename)
|
||||||
|
writer = csv.writer(fd)
|
||||||
|
for (nick, notes) in self._notes.iteritems():
|
||||||
|
for (time, whence, text) in notes:
|
||||||
|
writer.writerow([nick, time, whence, text])
|
||||||
|
fd.close()
|
||||||
|
|
||||||
|
def _openNotes(self):
|
||||||
|
try:
|
||||||
|
fd = file(self.filename)
|
||||||
|
except EnvironmentError, e:
|
||||||
|
self.log.warning('Couldn\'t open %s: %s', self.filename, e)
|
||||||
|
return
|
||||||
|
reader = csv.reader(fd)
|
||||||
|
for (nick, time, whence, text) in reader:
|
||||||
|
self._addNote(nick, whence, text, at=float(time), maximum=0)
|
||||||
|
fd.close()
|
||||||
|
|
||||||
|
def _timestamp(self, when):
|
||||||
|
#format = conf.supybot.reply.format.time()
|
||||||
|
diff = time.time() - when
|
||||||
|
try:
|
||||||
|
return utils.timeElapsed(diff, seconds=False) + ' ago'
|
||||||
|
except ValueError:
|
||||||
|
return 'just now'
|
||||||
|
|
||||||
|
def _addNote(self, nick, whence, text, at=None, maximum=None):
|
||||||
|
if at is None:
|
||||||
|
at = time.time()
|
||||||
|
if maximum is None:
|
||||||
|
maximum = self.registryValue('maximum')
|
||||||
|
try:
|
||||||
|
notes = self._notes[nick]
|
||||||
|
if maximum and len(notes) >= maximum:
|
||||||
|
raise ValueError
|
||||||
|
else:
|
||||||
|
notes.append((at, whence, text))
|
||||||
|
except KeyError:
|
||||||
|
self._notes[nick] = [(at, whence, text)]
|
||||||
|
if '?' in nick or '*' in nick and nick not in self.wildcards:
|
||||||
|
self.wildcards.append(nick)
|
||||||
|
self._flushNotes()
|
||||||
|
|
||||||
|
def tell(self, irc, msg, args, nick, text):
|
||||||
|
"""<nick> <text>
|
||||||
|
|
||||||
|
Tells <nick> <text> the next time <nick> is in seen. <nick> can
|
||||||
|
contain wildcard characters, and the first matching nick will be
|
||||||
|
given the note.
|
||||||
|
"""
|
||||||
|
if ircutils.strEqual(nick, irc.nick):
|
||||||
|
irc.error('I can\'t send notes to myself.')
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
self._addNote(nick, msg.nick, text)
|
||||||
|
irc.replySuccess()
|
||||||
|
except ValueError:
|
||||||
|
irc.error('That person\'s message queue is already full.')
|
||||||
|
tell = wrap(tell, ['nick', 'text'])
|
||||||
|
|
||||||
|
def notes(self, irc, msg, args, nick):
|
||||||
|
"""[<nick>]
|
||||||
|
|
||||||
|
If <nick> is given, replies with what notes are waiting on <nick>,
|
||||||
|
otherwise, replies with the nicks that have notes waiting for them.
|
||||||
|
"""
|
||||||
|
if nick:
|
||||||
|
if nick in self._notes:
|
||||||
|
notes = [self._formatNote(when, whence, note)
|
||||||
|
for (when, whence, note) in self._notes[nick]]
|
||||||
|
irc.reply(format('%L', notes))
|
||||||
|
else:
|
||||||
|
irc.error('I have no notes for that nick.')
|
||||||
|
else:
|
||||||
|
nicks = self._notes.keys()
|
||||||
|
utils.sortBy(ircutils.toLower, nicks)
|
||||||
|
irc.reply(format('I currently have notes waiting for %L.', nicks))
|
||||||
|
notes = wrap(notes, [additional('something')])
|
||||||
|
|
||||||
|
def doPrivmsg(self, irc, msg):
|
||||||
|
notes = self._notes.pop(msg.nick, [])
|
||||||
|
# Let's try wildcards.
|
||||||
|
removals = []
|
||||||
|
for wildcard in self.wildcards:
|
||||||
|
if ircutils.hostmaskPatternEqual(wildcard, msg.nick):
|
||||||
|
removals.append(wildcard)
|
||||||
|
notes.extend(self._notes.pop(wildcard))
|
||||||
|
for removal in removals:
|
||||||
|
self.wildcards.remove(removal)
|
||||||
|
if notes:
|
||||||
|
irc = callbacks.SimpleProxy(irc, msg)
|
||||||
|
private = self.registryValue('private')
|
||||||
|
for (when, whence, note) in notes:
|
||||||
|
s = self._formatNote(when, whence, note)
|
||||||
|
irc.reply(s, private=private)
|
||||||
|
self._flushNotes()
|
||||||
|
|
||||||
|
def _formatNote(self, when, whence, note):
|
||||||
|
return 'Sent %s: <%s> %s' % (self._timestamp(when), whence, note)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Class = Later
|
||||||
|
|
||||||
|
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
|
40
plugins/Later/test.py
Normal file
40
plugins/Later/test.py
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
###
|
||||||
|
# Copyright (c) 2002-2004, Jeremiah Fincher
|
||||||
|
# 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 LaterTestCase(PluginTestCase):
|
||||||
|
plugins = ('Later',)
|
||||||
|
def testLaterWorksTwice(self):
|
||||||
|
self.assertNotError('later tell foo bar')
|
||||||
|
self.assertNotError('later tell foo baz')
|
||||||
|
|
||||||
|
|
||||||
|
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
|
||||||
|
|
Loading…
Reference in New Issue
Block a user