Limnoria/plugins/Dunno.py

215 lines
8.0 KiB
Python
Raw Normal View History

###
# Copyright (c) 2003, Daniel DiPaolo
# 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.
###
"""
2004-07-20 07:36:59 +02:00
The Dunno module is used to spice up the 'replyWhenNotCommand' behavior with
random 'I dunno'-like responses. If you want something spicier than '<x> is
not a valid command'-like responses, use this plugin.
"""
import supybot
2003-11-25 09:23:47 +01:00
__revision__ = "$Id$"
__author__ = supybot.authors.strike
__contributors__ = {
supybot.authors.jemfinch: ['Flatfile DB implementation.'],
}
2003-11-25 09:23:47 +01:00
import os
import csv
2004-08-05 07:32:18 +02:00
import sets
import time
2004-08-05 05:59:40 +02:00
import random
import itertools
2004-08-11 07:48:28 +02:00
import supybot.dbi as dbi
2004-07-24 07:18:26 +02:00
import supybot.conf as conf
import supybot.utils as utils
import supybot.ircdb as ircdb
import supybot.plugins as plugins
2004-10-02 02:48:29 +02:00
from supybot.commands import wrap
2004-08-03 09:28:14 +02:00
import supybot.registry as registry
2004-08-05 05:59:40 +02:00
import supybot.ircutils as ircutils
2004-07-24 07:18:26 +02:00
import supybot.callbacks as callbacks
2004-08-03 09:28:14 +02:00
conf.registerPlugin('Dunno')
conf.registerChannelValue(conf.supybot.plugins.Dunno, 'prefixNick',
registry.Boolean(True, """Determines whether the bot will prefix the nick
of the user giving an invalid command to the "dunno" response."""))
class DbiDunnoDB(plugins.DbiChannelDB):
class DB(dbi.DB):
class Record(dbi.Record):
__fields__ = [
'at',
'by',
'text',
]
def __init__(self, filename):
# We use self.__class__ here because apparently DB isn't in our
# scope. python--
self.__parent = super(self.__class__, self)
self.__parent.__init__(filename)
def add(self, text, by, at):
return self.__parent.add(self.Record(at=at, by=by, text=text))
def change(self, id, f):
dunno = self.get(id)
dunno.text = f(dunno.text)
self.set(id, dunno)
DunnoDB = plugins.DB('Dunno', {'flat': DbiDunnoDB})
class Dunno(callbacks.Privmsg):
2004-07-20 07:36:59 +02:00
"""This plugin was written initially to work with MoobotFactoids, the two
of them to provide a similar-to-moobot-and-blootbot interface for factoids.
Basically, it replaces the standard 'Error: <X> is not a valid command.'
messages with messages kept in a database, able to give more personable
responses."""
callAfter = ['MoobotFactoids']
def __init__(self):
2004-09-20 01:51:21 +02:00
self.__parent = super(Dunno, self)
self.__parent.__init__()
2004-08-05 05:59:40 +02:00
self.db = DunnoDB()
2004-07-21 21:36:35 +02:00
2004-08-05 05:59:40 +02:00
def die(self):
self.db.close()
2004-09-20 01:51:21 +02:00
self.__parent.die()
2004-07-21 21:36:35 +02:00
def invalidCommand(self, irc, msg, tokens):
2004-08-05 05:59:40 +02:00
channel = msg.args[0]
if ircutils.isChannel(channel):
dunno = self.db.random(channel)
2004-08-05 05:59:40 +02:00
if dunno is not None:
2004-08-11 07:48:28 +02:00
dunno = dunno.text
2004-08-05 05:59:40 +02:00
prefixName = self.registryValue('prefixNick', channel)
dunno = plugins.standardSubstitute(irc, msg, dunno)
irc.reply(dunno, prefixName=prefixName)
2004-10-02 02:48:29 +02:00
def add(self, irc, msg, args, user, at, channel, dunno):
2004-08-05 05:59:40 +02:00
"""[<channel>] <text>
Adds <text> as a "dunno" to be used as a random response when no
command or factoid key matches. Can optionally contain '$who', which
will be replaced by the user's name when the dunno is displayed.
2004-08-05 05:59:40 +02:00
<channel> is only necessary if the message isn't sent in the channel
itself.
"""
2004-10-02 02:48:29 +02:00
id = self.db.add(channel, dunno, user.id, at)
irc.replySuccess('Dunno #%s added.' % id)
2004-10-02 02:48:29 +02:00
add = wrap(add, ['user', 'now', 'channeldb', 'text'])
2004-10-02 02:48:29 +02:00
def remove(self, irc, msg, args, user, channel, id):
2004-08-05 05:59:40 +02:00
"""[<channel>] <id>
2004-08-05 05:59:40 +02:00
Removes dunno with the given <id>. <channel> is only necessary if the
message isn't sent in the channel itself.
"""
# Must be registered to use this
2004-08-05 05:59:40 +02:00
try:
2004-10-02 02:48:29 +02:00
dunno = self.db.get(channel, id)
if user.id != dunno.by:
cap = ircdb.makeChannelCapability(channel, 'op')
if not ircdb.users.checkCapability(cap):
irc.errorNoCapability(cap)
2004-08-05 05:59:40 +02:00
self.db.remove(channel, id)
irc.replySuccess()
except KeyError:
irc.error('No dunno has id #%s.' % id)
2004-10-02 02:48:29 +02:00
remove = wrap(remove, ['user', 'channeldb', ('id', 'dunno')])
2004-10-02 02:48:29 +02:00
def search(self, irc, msg, args, channel, text):
2004-08-05 05:59:40 +02:00
"""[<channel>] <text>
Search for dunno containing the given text. Returns the ids of the
2004-08-05 05:59:40 +02:00
dunnos with the text in them. <channel> is only necessary if the
message isn't sent in the channel itself.
"""
2004-08-11 07:48:28 +02:00
def p(dunno):
return text.lower() in dunno.text.lower()
ids = [str(dunno.id) for dunno in self.db.select(channel, p)]
2004-08-05 05:59:40 +02:00
if ids:
s = 'Dunno search for %r (%s found): %s.' % \
(text, len(ids), utils.commaAndify(ids))
irc.reply(s)
else:
irc.reply('No dunnos found matching that search criteria.')
2004-10-02 02:48:29 +02:00
search = wrap(search, ['channeldb', 'text'])
2004-10-02 02:48:29 +02:00
def get(self, irc, msg, args, channel, id):
2004-08-05 05:59:40 +02:00
"""[<channel>] <id>
2004-08-05 05:59:40 +02:00
Display the text of the dunno with the given id. <channel> is only
necessary if the message isn't sent in the channel itself.
"""
2004-08-05 05:59:40 +02:00
try:
2004-08-11 07:48:28 +02:00
dunno = self.db.get(channel, id)
name = ircdb.users.getUser(dunno.by).name
at = time.localtime(dunno.at)
timeStr = time.strftime(conf.supybot.humanTimestampFormat(), at)
irc.reply("Dunno #%s: %r (added by %s at %s)" % \
2004-08-11 07:48:28 +02:00
(id, dunno.text, name, timeStr))
2004-08-05 05:59:40 +02:00
except KeyError:
irc.error('No dunno found with that id.')
2004-10-02 02:48:29 +02:00
get = wrap(get, ['channeldb', ('id', 'dunno')])
2004-10-02 02:48:29 +02:00
def change(self, irc, msg, args, channel, id, replacer):
2004-08-05 05:59:40 +02:00
"""[<channel>] <id> <regexp>
2004-01-26 22:19:07 +01:00
Alters the dunno with the given id according to the provided regexp.
2004-08-05 05:59:40 +02:00
<channel> is only necessary if the message isn't sent in the channel
itself.
2004-01-26 22:19:07 +01:00
"""
try:
2004-10-02 02:48:29 +02:00
self.db.change(channel, id, replacer)
2004-08-05 05:59:40 +02:00
except KeyError:
irc.error('There is no dunno #%s.' % id)
2004-09-17 07:09:14 +02:00
return
irc.replySuccess()
2004-10-02 02:48:29 +02:00
change = wrap(change, ['channeldb', ('id', 'dunno'), 'regexpReplacer'])
2004-07-20 07:36:59 +02:00
2004-10-02 02:48:29 +02:00
def stats(self, irc, msg, args, channel):
2004-08-05 05:59:40 +02:00
"""[<channel>]
Returns the number of dunnos in the dunno database. <channel> is only
necessary if the message isn't sent in the channel itself.
"""
num = self.db.size(channel)
2004-08-03 09:28:14 +02:00
irc.reply('There %s %s in my database.' %
(utils.be(num), utils.nItems('dunno', num)))
2004-10-02 02:48:29 +02:00
stats = wrap(stats, ['channeldb'])
2004-07-21 21:36:35 +02:00
2004-01-26 22:19:07 +01:00
Class = Dunno
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: