1
0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-23 19:22:45 +01:00
Limnoria/plugins/Later.py

193 lines
7.3 KiB
Python
Raw Normal View History

2004-07-31 14:06:22 +02:00
###
# 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.
###
"""
Informal notes, mostly for compatibility with other bots. Based entirely on
2004-08-03 07:10:47 +02:00
nicks, it's an easy way to tell users who refuse to register notes when they
arrive later.
2004-07-31 14:06:22 +02:00
"""
import supybot
2004-07-31 14:06:22 +02:00
__revision__ = "$Id$"
__author__ = supybot.authors.jemfinch
2004-07-31 14:06:22 +02:00
import supybot.plugins as plugins
2004-08-03 07:10:47 +02:00
import csv
2004-07-31 14:06:22 +02:00
import time
import supybot.log as log
import supybot.conf as conf
import supybot.utils as utils
from supybot.commands import *
2004-07-31 14:06:22 +02:00
import supybot.ircutils as ircutils
import supybot.registry as registry
import supybot.callbacks as callbacks
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)
conf.registerPlugin('Later')
conf.registerGlobalValue(conf.supybot.plugins.Later, 'maximum',
registry.NonNegativeInteger(0, """Determines the maximum number of messages
2004-09-10 08:25:38 +02:00
to be queued for a user. If this value is 0, there is no maximum."""))
2004-08-03 07:10:47 +02:00
conf.registerGlobalValue(conf.supybot.plugins.Later, 'private',
2004-09-30 07:39:23 +02:00
registry.Boolean(True, """Determines whether users will be notified in the
2004-08-03 07:10:47 +02:00
first place in which they're seen, or in private."""))
2004-07-31 14:06:22 +02:00
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."""
2004-07-31 14:06:22 +02:00
def __init__(self):
callbacks.Privmsg.__init__(self)
2004-11-26 09:00:51 +01:00
self._notes = ircutils.IrcDict()
2004-08-17 22:59:42 +02:00
self.wildcards = []
2004-08-03 07:10:47 +02:00
self.filename = conf.supybot.directories.data.dirize('Later.db')
self._openNotes()
def die(self):
2004-08-11 06:57:55 +02:00
self._flushNotes()
2004-08-03 07:10:47 +02:00
2004-08-11 06:57:55 +02:00
def _flushNotes(self):
2004-08-03 07:10:47 +02:00
fd = utils.transactionalFile(self.filename)
writer = csv.writer(fd)
2004-11-26 09:00:51 +01:00
for (nick, notes) in self._notes.iteritems():
2004-08-03 07:10:47 +02:00
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()
2004-07-31 14:06:22 +02:00
def _timestamp(self, when):
#format = conf.supybot.reply.format.time()
2004-07-31 14:06:22 +02:00
diff = time.time() - when
try:
return utils.timeElapsed(diff, seconds=False) + ' ago'
except ValueError:
return 'just now'
2004-08-03 07:10:47 +02:00
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')
2004-07-31 14:06:22 +02:00
try:
2004-11-26 09:00:51 +01:00
notes = self._notes[nick]
2004-08-03 07:10:47 +02:00
if maximum and len(notes) >= maximum:
2004-07-31 14:06:22 +02:00
raise ValueError
else:
2004-08-27 17:01:28 +02:00
notes.append((at, whence, text))
2004-07-31 14:06:22 +02:00
except KeyError:
2004-11-26 09:00:51 +01:00
self._notes[nick] = [(at, whence, text)]
2004-08-17 22:59:42 +02:00
if '?' in nick or '*' in nick and nick not in self.wildcards:
self.wildcards.append(nick)
2004-08-11 06:57:55 +02:00
self._flushNotes()
2004-07-31 14:06:22 +02:00
def tell(self, irc, msg, args, nick, text):
2004-07-31 14:06:22 +02:00
"""<nick> <text>
2004-08-18 20:42:01 +02:00
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.
2004-07-31 14:06:22 +02:00
"""
2004-08-12 09:40:11 +02:00
if ircutils.strEqual(nick, irc.nick):
irc.error('I can\'t send notes to myself.')
return
2004-07-31 14:06:22 +02:00
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'])
2004-07-31 14:06:22 +02:00
def notes(self, irc, msg, args, nick):
"""[<nick>]
2004-11-26 09:00:51 +01:00
If <nick> is given, replies with what notes are waiting on <nick>,
otherwise, replies with the nicks that have notes waiting for them.
2004-11-26 09:00:51 +01:00
"""
if nick:
if nick in self._notes:
notes = [self._formatNote(when, whence, note)
for (when, whence, note) in self._notes[nick]]
irc.reply(utils.commaAndify(notes))
else:
irc.error('I have no notes for that nick.')
else:
nicks = self._notes.keys()
utils.sortBy(ircutils.toLower, nicks)
irc.reply('I currently have notes waiting for %s.' %
utils.commaAndify(nicks))
notes = wrap(notes, [additional('something')])
2004-11-26 09:00:51 +01:00
2004-07-31 14:06:22 +02:00
def doPrivmsg(self, irc, msg):
2004-11-26 09:00:51 +01:00
notes = self._notes.pop(msg.nick, [])
2004-08-17 22:59:42 +02:00
# Let's try wildcards.
removals = []
for wildcard in self.wildcards:
if ircutils.hostmaskPatternEqual(wildcard, msg.nick):
removals.append(wildcard)
2004-11-26 09:00:51 +01:00
notes.extend(self._notes.pop(wildcard))
2004-08-17 22:59:42 +02:00
for removal in removals:
self.wildcards.remove(removal)
if notes:
2004-07-31 14:06:22 +02:00
irc = callbacks.SimpleProxy(irc, msg)
2004-08-03 07:10:47 +02:00
private = self.registryValue('private')
2004-07-31 14:06:22 +02:00
for (when, whence, note) in notes:
s = self._formatNote(when, whence, note)
2004-08-03 07:10:47 +02:00
irc.reply(s, private=private)
2004-08-11 06:57:55 +02:00
self._flushNotes()
def _formatNote(self, when, whence, note):
return 'Sent %s: <%s> %s' % (self._timestamp(when), whence, note)
2004-07-31 14:06:22 +02:00
Class = Later
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: