Limnoria/plugins/MoobotFactoids.py
2003-10-24 06:11:16 +00:00

630 lines
24 KiB
Python

#!/usr/bin/env python
###
# 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.
###
"""
Moobot factoid compatibility module. Overrides the replyWhenNotCommand
behavior so that when someone addresses the bot with anything other than a
command, it checks the factoid database for a key that matches what was said
and if nothing is found, responds with an entry from the "dunno" database.
"""
import plugins
import os
import sets
import time
import shlex
import string
import random
import sqlite
from cStringIO import StringIO
import conf
import debug
import ircdb
import utils
import ircmsgs
import ircutils
import privmsgs
import callbacks
import Owner
dbfilename = os.path.join(conf.dataDir, 'MoobotFactoids.db')
def configure(onStart, afterConnect, advanced):
# This will be called by setup.py to configure this module. onStart and
# afterConnect are both lists. Append to onStart the commands you would
# like to be run when the bot is started; append to afterConnect the
# commands you would like to be run when the bot has finished connecting.
from questions import expect, anything, something, yn
onStart.append('load MoobotFactoids')
example = utils.wrapLines("""
Add an example IRC session using this module here.
""")
allchars = string.maketrans('', '')
class OptionList(object):
validChars = allchars.translate(allchars, '|()')
def _insideParens(self, lexer):
ret = []
while True:
token = lexer.get_token()
if not token:
raise SyntaxError, 'Missing ")"'
elif token == ')':
return ret
elif token == '(':
ret.append(self._insideParens(lexer))
elif token == '|':
continue
else:
ret.append(token)
def tokenize(self, s):
lexer = shlex.shlex(StringIO(s))
lexer.commenters = ''
lexer.quotes = ''
lexer.whitespace = ''
lexer.wordchars = self.validChars
ret = []
while True:
token = lexer.get_token()
if not token:
break
elif token == '(':
ret.append(self._insideParens(lexer))
elif token == ')':
raise SyntaxError, 'Spurious ")"'
else:
ret.append(token)
return ret
def tokenize(s):
return OptionList().tokenize(s)
def pick(L, recursed=False):
L = L[:]
for (i, elt) in enumerate(L):
if isinstance(elt, list):
L[i] = pick(elt, recursed=True)
if recursed:
return random.choice(L)
else:
return L
class MoobotFactoids(callbacks.PrivmsgCommandAndRegexp):
priority = 1000
addressedRegexps = ['changeFactoid', 'augmentFactoid',
'replaceFactoid', 'addFactoid']
def __init__(self):
callbacks.PrivmsgCommandAndRegexp.__init__(self)
self.makeDb(dbfilename)
# Set up the "reply when not command" behavior
Misc = Owner.loadPluginModule('Misc')
# Gotta make sure we restore this when we unload
self.originalReplyWhenNotCommand = Misc.replyWhenNotCommand
self.originalConfReplyWhenNotCommand = conf.replyWhenNotCommand
conf.replyWhenNotCommand = True
Misc.replyWhenNotCommand = self._checkFactoids
def makeDb(self, filename):
"""create MoobotFactoids database and tables"""
if os.path.exists(filename):
self.db = sqlite.connect(filename)
return
self.db = sqlite.connect(filename, converters={'bool': bool})
cursor = self.db.cursor()
cursor.execute("""CREATE TABLE factoids (
key TEXT PRIMARY KEY,
created_by INTEGER,
created_at TIMESTAMP,
modified_by INTEGER,
modified_at TIMESTAMP,
locked_at TIMESTAMP,
locked_by INTEGER,
last_requested_by TEXT,
last_requested_at TIMESTAMP,
fact TEXT,
requested_count INTEGER
)""")
cursor.execute("""CREATE TABLE dunnos (
id INTEGER PRIMARY KEY,
added_by INTEGER,
added_at TIMESTAMP,
dunno TEXT
)""")
self.db.commit()
def die(self):
# Handle DB stuff
self.db.commit()
self.db.close()
del self.db
# Recover from clobbering this command earlier
Misc = Owner.loadPluginModule('Misc')
Misc.replyWhenNotCommand = self.originalReplyWhenNotCommand
conf.replyWhenNotCommand = self.originalConfReplyWhenNotCommand
def parseFactoid(self, fact):
type = "define" # Default is to just spit the factoid back as a
# definition of what the key is (i.e., "foo is bar")
newfact = ''.join(pick(tokenize(fact)))
if newfact.startswith("<reply>"):
newfact = newfact.replace("<reply>", "", 1)
type = "reply"
elif newfact.startswith("<action>"):
newfact = newfact.replace("<action>", "", 1)
type = "action"
return (type, newfact)
def updateFactoidRequest(self, key, hostmask):
"""Updates the last_requested_* fields of a factoid row"""
cursor = self.db.cursor()
cursor.execute("""UPDATE factoids SET
last_requested_by = %s,
last_requested_at = %s,
requested_count = requested_count +1
WHERE key = %s""",
hostmask, int(time.time()), key)
self.db.commit()
def _checkFactoids(self, irc, msg, _):
# Strip the bot name
key = callbacks.addressed(irc.nick, msg)
if key.startswith('\x01'):
return
# Check the factoid db for an appropriate reply
cursor = self.db.cursor()
cursor.execute("""SELECT fact FROM factoids WHERE key LIKE %s""", key)
if cursor.rowcount == 0:
text = self._getDunno(msg.nick)
irc.reply(msg, text, prefixName=False)
else:
fact = cursor.fetchone()[0]
# Update the requested count/requested by for this key
hostmask = msg.prefix
self.updateFactoidRequest(key, hostmask)
# Now actually get the factoid and respond accordingly
(type, text) = self.parseFactoid(fact)
if type == "action":
irc.queueMsg(ircmsgs.action(ircutils.replyTo(msg), text))
elif type == "reply":
irc.reply(msg, text, prefixName=False)
elif type == "define":
irc.reply(msg, "%s is %s" % (key, text), prefixName=False)
else:
irc.error(msg, "Spurious type from parseFactoid.")
def _getDunno(self, nick):
"""Retrieves a "dunno" from the database."""
cursor = self.db.cursor()
cursor.execute("""SELECT dunno
FROM dunnos
ORDER BY random()
LIMIT 1""")
if cursor.rowcount == 0:
return "No dunno's available, add some with dunnoadd."
dunno = cursor.fetchone()[0]
dunno = dunno.replace('$who', nick)
return dunno
def addFactoid(self, irc, msg, match):
r"^(?!no\s+)(.+)\s+is\s+(?!also)(.+)"
# Must be registered!
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
key, fact = match.groups()
cursor = self.db.cursor()
# Check and make sure it's not in the DB already
cursor.execute("""SELECT * FROM factoids WHERE key LIKE %s""", key)
if cursor.rowcount != 0:
irc.error(msg, "Factoid %r already exists." % key)
return
# Otherwise,
cursor.execute("""INSERT INTO factoids VALUES
(%s, %s, %s, NULL, NULL, NULL, NULL, NULL,
%s, 0)""",
key, id, int(time.time()), fact)
self.db.commit()
irc.reply(msg, conf.replySuccess)
def changeFactoid(self, irc, msg, match):
r"(.+)\s+=~\s+(.+)"
# Must be registered!
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
key, regexp = match.groups()
cursor = self.db.cursor()
# Check and make sure it's in the DB
cursor.execute("""SELECT locked_at, fact FROM factoids
WHERE key LIKE %s""", key)
if cursor.rowcount == 0:
irc.error(msg, "Factoid %r not found." % key)
return
# No dice if it's locked, no matter who it is
(locked_at, fact) = cursor.fetchone()
if locked_at is not None:
irc.error(msg, "Factoid %r is locked." % key)
return
# It's fair game if we get to here
try:
r = utils.perlReToReplacer(regexp)
except ValueError, e:
irc.error(msg, "Invalid regexp: %r" % regexp)
return
new_fact = r(fact)
cursor.execute("""UPDATE factoids
SET fact = %s, modified_by = %s,
modified_at = %s WHERE key = %s""",
new_fact, id, int(time.time()), key)
self.db.commit()
irc.reply(msg, conf.replySuccess)
def augmentFactoid(self, irc, msg, match):
r"(.+) is also (.+)"
# Must be registered!
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
key, new_text = match.groups()
cursor = self.db.cursor()
# Check and make sure it's in the DB
cursor.execute("""SELECT locked_at, fact FROM factoids
WHERE key LIKE %s""", key)
if cursor.rowcount == 0:
irc.error(msg, "Factoid %r not found." % key)
return
# No dice if it's locked, no matter who it is
(locked_at, fact) = cursor.fetchone()
if locked_at is not None:
irc.error(msg, "Factoid %r is locked." % key)
return
# It's fair game if we get to here
new_fact = "%s, or %s" % (fact, new_text)
cursor.execute("""UPDATE factoids
SET fact = %s, modified_by = %s,
modified_at = %s WHERE key = %s""",
new_fact, id, int(time.time()), key)
self.db.commit()
irc.reply(msg, conf.replySuccess)
def replaceFactoid(self, irc, msg, match):
r"^no,?\s+(.+)\s+is\s+(.+)"
# Must be registered!
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
key, new_fact = match.groups()
cursor = self.db.cursor()
# Check and make sure it's in the DB
cursor.execute("""SELECT locked_at, fact FROM factoids
WHERE key LIKE %s""", key)
if cursor.rowcount == 0:
irc.error(msg, "Factoid %r not found." % key)
return
# No dice if it's locked, no matter who it is
(locked_at, _) = cursor.fetchone()
if locked_at is not None:
irc.error(msg, "Factoid %r is locked." % key)
return
# It's fair game if we get to here
cursor.execute("""UPDATE factoids
SET fact = %s, created_by = %s,
created_at = %s, modified_by = NULL,
modified_at = NULL, requested_count = 0,
last_requested_by = NULL, last_requested_at = NULL,
locked_at = NULL
WHERE key = %s""",
new_fact, id, int(time.time()), key)
self.db.commit()
irc.reply(msg, conf.replySuccess)
def literal(self, irc, msg, args):
"""<factoid key>
Returns the literal factoid for the given factoid key. No parsing of
the factoid value is done as it is with normal retrieval.
"""
key = privmsgs.getArgs(args, needed=1)
cursor = self.db.cursor()
cursor.execute("""SELECT fact FROM factoids WHERE key LIKE %s""", key)
if cursor.rowcount == 0:
irc.error(msg, "No such factoid: %r" % key)
return
else:
fact = cursor.fetchone()[0]
irc.reply(msg, fact)
def factinfo(self, irc, msg, args):
"""<factoid key>
Returns the various bits of info on the factoid for the given key.
"""
key = privmsgs.getArgs(args, needed=1)
# Start building the response string
s = key + ": "
# Next, get all the info and build the response piece by piece
cursor = self.db.cursor()
cursor.execute("""SELECT created_by, created_at, modified_by,
modified_at, last_requested_by, last_requested_at,
requested_count, locked_by, locked_at FROM
factoids WHERE key LIKE %s""", key)
if cursor.rowcount == 0:
irc.error(msg, "No such factoid: %r" % key)
return
(created_by, created_at, modified_by, modified_at, last_requested_by,
last_requested_at, requested_count, locked_by,
locked_at) = cursor.fetchone()
# First, creation info.
# Map the integer created_by to the username
creat_by = ircdb.users.getUser(created_by).name
creat_at = time.strftime(conf.humanTimestampFormat,
time.localtime(int(created_at)))
s += "Created by %s on %s." % (creat_by, creat_at)
# Next, modification info, if any.
if modified_by is not None:
mod_by = ircdb.users.getUser(modified_by).name
mod_at = time.strftime(conf.humanTimestampFormat,
time.localtime(int(modified_at)))
s += " Last modified by %s on %s." % (mod_by, mod_at)
# Next, last requested info, if any
if last_requested_by is not None:
last_by = last_requested_by # not an int user id
last_at = time.strftime(conf.humanTimestampFormat,
time.localtime(int(last_requested_at)))
req_count = requested_count
times_str = utils.nItems(requested_count, 'time')
s += " Last requested by %s on %s, requested %s." % \
(last_by, last_at, times_str)
# Last, locked info
if locked_at is not None:
lock_at = time.strftime(conf.humanTimestampFormat,
time.localtime(int(locked_at)))
lock_by = ircdb.users.getUser(locked_by).name
s += " Locked by %s on %s." % (lock_by, lock_at)
irc.reply(msg, s)
def _lock(self, irc, msg, args, lock=True):
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
key = privmsgs.getArgs(args, needed=1)
cursor = self.db.cursor()
cursor.execute("""SELECT created_by, locked_by FROM factoids
WHERE key LIKE %s""", key)
if cursor.rowcount == 0:
irc.error(msg, "No such factoid: %r" % key)
return
(created_by, locked_by) = cursor.fetchone()
# Don't perform redundant operations
if lock:
if locked_by is not None:
irc.error(msg, "Factoid %r is already locked." % key)
return
else:
if locked_by is None:
irc.error(msg, "Factoid '%r is not locked." % key)
return
# Can only lock/unlock own factoids
if not (ircdb.checkCapability(id, 'admin') or created_by == id):
s = "unlock"
if lock:
s = "lock"
irc.error(msg, "Cannot %s someone else's factoid unless you "
"are an admin." % s)
return
# Okay, we're done, ready to lock/unlock
if lock:
locked_at = int(time.time())
else:
locked_at = None
id = None
cursor.execute("""UPDATE factoids SET locked_at = %s, locked_by = %s
WHERE key = %s""", locked_at, id, key)
self.db.commit()
irc.reply(msg, conf.replySuccess)
def lock(self, irc, msg, args):
"""<factoid key>
Locks the factoid with the given factoid key. Requires that the user
be registered and have created the factoid originally.
"""
self._lock(irc, msg, args, True)
def unlock(self, irc, msg, args):
"""<factoid key>
Unlocks the factoid with the given factoid key. Requires that the
user be registered and have locked the factoid.
"""
self._lock(irc, msg, args, False)
def listauth(self, irc, msg, args):
"""<author name>
Lists the keys of the factoids with the given author. Note that if an
author has an integer name, you'll have to use that author's id to use
this function (so don't use integer usernames!).
"""
author = privmsgs.getArgs(args, needed=1)
try:
id = ircdb.users.getUserId(author)
except KeyError:
irc.error(msg, "No such user: %r" % author)
return
cursor = self.db.cursor()
cursor.execute("""SELECT key FROM factoids
WHERE created_by = %s
ORDER BY key""", id)
if cursor.rowcount == 0:
irc.reply(msg, "No factoids by %r found." % author)
return
keys = [repr(tup[0]) for tup in cursor.fetchall()]
s = "Author search for %r (%d found): %s" % \
(author, len(keys), utils.commaAndify(keys))
irc.reply(msg, s)
def listkeys(self, irc, msg, args):
"""<text>
Lists the keys of the factoids whose key contains the provided text.
"""
search = privmsgs.getArgs(args, needed=1)
glob = '%' + search + '%'
cursor = self.db.cursor()
cursor.execute("""SELECT key FROM factoids
WHERE key LIKE %s
ORDER BY key""",
glob)
if cursor.rowcount == 0:
irc.reply(msg, "No keys matching %r found." % search)
return
keys = [repr(tup[0]) for tup in cursor.fetchall()]
s = "Key search for %r (%d found): %s" % \
(search, len(keys), utils.commaAndify(keys))
irc.reply(msg, s)
def listvalues(self, irc, msg, args):
"""<text>
Lists the keys of the factoids whose value contains the provided text.
"""
search = privmsgs.getArgs(args, needed=1)
glob = '%' + search + '%'
cursor = self.db.cursor()
cursor.execute("""SELECT key FROM factoids
WHERE fact LIKE %s
ORDER BY key""",
glob)
if cursor.rowcount == 0:
irc.reply(msg, "No values matching %r found." % search)
return
keys = [repr(tup[0]) for tup in cursor.fetchall()]
s = "Value search for %r (%d found): %s" % \
(search, len(keys), utils.commaAndify(keys))
irc.reply(msg, s)
def delete(self, irc, msg, args):
"""<factoid key>
Deletes the factoid with the given key.
"""
# Must be registered to use this
try:
ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
key = privmsgs.getArgs(args, needed=1)
cursor = self.db.cursor()
cursor.execute("""SELECT key, locked_at FROM factoids
WHERE key LIKE %s""", key)
if cursor.rowcount == 0:
irc.error(msg, "No such factoid: %r" % key)
return
(_, locked_at) = cursor.fetchone()
if locked_at is not None:
irc.error(msg, "Factoid is locked, cannot remove.")
return
cursor.execute("""DELETE FROM factoids WHERE key = %s""", key)
self.db.commit()
irc.reply(msg, conf.replySuccess)
def dunnoadd(self, irc, msg, args):
"""<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.
"""
# Must be registered to use this
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
text = privmsgs.getArgs(args, needed=1)
cursor = self.db.cursor()
cursor.execute("""INSERT INTO dunnos
VALUES(NULL, %s, %s, %s)""",
id, int(time.time()), text)
self.db.commit()
irc.reply(msg, conf.replySuccess)
def dunnoremove(self, irc, msg, args):
"""<id>
Removes dunno with the given <id>.
"""
# Must be registered to use this
try:
user_id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
dunno_id = privmsgs.getArgs(args, needed=1)
cursor = self.db.cursor()
cursor.execute("""SELECT added_by, dunno
FROM dunnos
WHERE id = %s""" % dunno_id)
if cursor.rowcount == 0:
irc.error(msg, 'No dunno with id: %d' % dunno_id)
return
(added_by, dunno) = cursor.fetchone()
if not (ircdb.checkCapability(user_id, 'admin') or \
added_by == user_id):
irc.error(msg, 'Only admins and the dunno creator may delete a '
'dunno.')
return
cursor.execute("""DELETE FROM dunnos WHERE id = %s""" % dunno_id)
self.db.commit()
irc.reply(msg, conf.replySuccess)
Class = MoobotFactoids
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: