### # Copyright (c) 2002-2005, Jeremiah Fincher # Copyright (c) 2009-2010, James Vega # 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 os import time import string import supybot.conf as conf import supybot.ircdb as ircdb import supybot.utils as utils from supybot.commands import * import supybot.plugins as plugins import supybot.ircutils as ircutils import supybot.callbacks as callbacks from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Factoids') #try: #import sqlite3 as sqlite #except ImportError: #raise callbacks.Error, 'You need to have PySQLite installed to use this ' \ #'plugin. Download it at ' \ #'' try: import sqlite3 except ImportError: from pysqlite2 import dbapi2 as sqlite3 # for python2.4 import re from supybot.utils.seq import dameraulevenshtein # these are needed cuz we are overriding getdb import threading import supybot.world as world def getFactoid(irc, msg, args, state): assert not state.channel callConverter('channel', irc, msg, args, state) separator = state.cb.registryValue('learnSeparator', state.channel) try: i = args.index(separator) except ValueError: raise callbacks.ArgumentError args.pop(i) key = [] value = [] for (j, s) in enumerate(args[:]): if j < i: key.append(args.pop(0)) else: value.append(args.pop(0)) if not key or not value: raise callbacks.ArgumentError state.args.append(' '.join(key)) state.args.append(' '.join(value)) def getFactoidId(irc, msg, args, state): Type = 'key id' p = lambda i: i > 0 callConverter('int', irc, msg, args, state, Type, p) addConverter('factoid', getFactoid) addConverter('factoidId', getFactoidId) class Factoids(callbacks.Plugin, plugins.ChannelDBHandler): def __init__(self, irc): callbacks.Plugin.__init__(self, irc) plugins.ChannelDBHandler.__init__(self) def makeDb(self, filename): if os.path.exists(filename): db = sqlite3.connect(filename) db.text_factory = str return db db = sqlite3.connect(filename) db.text_factory = str cursor = db.cursor() cursor.execute("""CREATE TABLE keys ( id INTEGER PRIMARY KEY, key TEXT UNIQUE ON CONFLICT REPLACE )""") cursor.execute("""CREATE TABLE factoids ( id INTEGER PRIMARY KEY, added_by TEXT, added_at TIMESTAMP, fact TEXT UNIQUE ON CONFLICT REPLACE, locked BOOLEAN )""") cursor.execute("""CREATE TABLE relations ( id INTEGER PRIMARY KEY, key_id INTEGER, fact_id INTEGER, usage_count INTEGER )""") db.commit() return db # override this because sqlite3 doesn't have autocommit # use isolation_level instead. def getDb(self, channel): """Use this to get a database for a specific channel.""" currentThread = threading.currentThread() if channel not in self.dbCache and currentThread == world.mainThread: self.dbCache[channel] = self.makeDb(self.makeFilename(channel)) if currentThread != world.mainThread: db = self.makeDb(self.makeFilename(channel)) else: db = self.dbCache[channel] db.isolation_level = None return db def getCommandHelp(self, command, simpleSyntax=None): method = self.getCommandMethod(command) if method.im_func.func_name == 'learn': chan = None if dynamic.msg is not None: chan = dynamic.msg.args[0] s = self.registryValue('learnSeparator', chan) help = callbacks.getHelp if simpleSyntax is None: simpleSyntax = conf.get(conf.supybot.reply.showSimpleSyntax, chan) if simpleSyntax: help = callbacks.getSyntax return help(method, doc=method._fake__doc__ % (s, s), name=callbacks.formatCommand(command)) return super(Factoids, self).getCommandHelp(command, simpleSyntax) def _getKeyAndFactId(self, channel, key, factoid): db = self.getDb(channel) cursor = db.cursor() cursor.execute("SELECT id FROM keys WHERE key=?", (key,)) keyresults = cursor.fetchall() cursor.execute("SELECT id FROM factoids WHERE fact=?", (factoid,)) factresults = cursor.fetchall() return (keyresults, factresults,) def learn(self, irc, msg, args, channel, key, factoid): # if neither key nor factoid exist, add them. # if key exists but factoid doesn't, add factoid, link it to existing key # if factoid exists but key doesn't, add key, link it to existing factoid # if both key and factoid already exist, and are linked, do nothing, print nice message db = self.getDb(channel) cursor = db.cursor() (keyid, factid) = self._getKeyAndFactId(channel, key, factoid) if len(keyid) == 0: cursor.execute("""INSERT INTO keys VALUES (NULL, ?)""", (key,)) db.commit() if len(factid) == 0: if ircdb.users.hasUser(msg.prefix): name = ircdb.users.getUser(msg.prefix).name else: name = msg.nick cursor.execute("""INSERT INTO factoids VALUES (NULL, ?, ?, ?, ?)""", (name, int(time.time()), factoid, 0)) db.commit() (keyid, factid) = self._getKeyAndFactId(channel, key, factoid) cursor.execute("""SELECT id, key_id, fact_id from relations WHERE key_id=? AND fact_id=?""", (keyid[0][0], factid[0][0],)) existingrelation = cursor.fetchall() if len(existingrelation) == 0: cursor.execute("""INSERT INTO relations VALUES (NULL, ?, ?, ?)""", (keyid[0][0],factid[0][0],0,)) db.commit() irc.replySuccess() else: irc.error("This key-factoid relationship already exists.") learn = wrap(learn, ['factoid']) learn._fake__doc__ = _("""[] %s Associates with . is only necessary if the message isn't sent on the channel itself. The word '%s' is necessary to separate the key from the value. It can be changed to another word via the learnSeparator registry value. """) def _lookupFactoid(self, channel, key): db = self.getDb(channel) cursor = db.cursor() cursor.execute("""SELECT factoids.fact, factoids.id, relations.id FROM factoids, keys, relations WHERE keys.key LIKE ? AND relations.key_id=keys.id AND relations.fact_id=factoids.id ORDER BY factoids.id LIMIT 20""", (key,)) return cursor.fetchall() #return [t[0] for t in cursor.fetchall()] def _searchFactoid(self, channel, key): """Try to typo-match input to possible factoids. Assume first letter is correct, to reduce processing time. First, try a simple wildcard search. If that fails, use the Damerau-Levenshtein edit-distance metric. """ # if you made a typo in a two-character key, boo on you. if len(key) < 3: return [] db = self.getDb(channel) cursor = db.cursor() cursor.execute("""SELECT key FROM keys WHERE key LIKE ?""", ('%' + key + '%',)) wildcardkeys = cursor.fetchall() if len(wildcardkeys) > 0: return [line[0] for line in wildcardkeys] cursor.execute("""SELECT key FROM keys WHERE key LIKE ?""", (key[0] + '%',)) flkeys = cursor.fetchall() if len(flkeys) == 0: return [] flkeys = [line[0] for line in flkeys] dl_metrics = [dameraulevenshtein(key, sourcekey) for sourcekey in flkeys] dict_metrics = dict(zip(flkeys, dl_metrics)) if min(dl_metrics) <= 2: return [key for key,item in dict_metrics.iteritems() if item <= 2] if min(dl_metrics) <= 3: return [key for key,item in dict_metrics.iteritems() if item <= 3] return [] def _updateRank(self, channel, factoids): if self.registryValue('keepRankInfo', channel): db = self.getDb(channel) cursor = db.cursor() for (fact,factid,relationid) in factoids: cursor.execute("""SELECT relations.usage_count FROM relations WHERE relations.id=?""", (relationid,)) old_count = cursor.fetchall()[0][0] cursor.execute("UPDATE relations SET usage_count=? WHERE id=?", (old_count + 1, relationid,)) db.commit() def _replyFactoids(self, irc, msg, key, channel, factoids, number=0, error=True): if factoids: if number: try: irc.reply(factoids[number-1][0]) self._updateRank(channel, [factoids[number-1]]) except IndexError: irc.error(_('That\'s not a valid number for that key.')) return else: env = {'key': key} def prefixer(v): env['value'] = v formatter = self.registryValue('format', msg.args[0]) return ircutils.standardSubstitute(irc, msg, formatter, env) if len(factoids) == 1: irc.reply(prefixer(factoids[0][0])) else: factoidsS = [] counter = 1 for factoid in factoids: factoidsS.append(format('(#%i) %s', counter, factoid[0])) counter += 1 irc.replies(factoidsS, prefixer=prefixer, joiner=', or ', onlyPrefixFirst=True) self._updateRank(channel, factoids) elif error: irc.error(_('No factoid matches that key.')) def invalidCommand(self, irc, msg, tokens): if irc.isChannel(msg.args[0]): channel = msg.args[0] if self.registryValue('replyWhenInvalidCommand', channel): key = ' '.join(tokens) factoids = self._lookupFactoid(channel, key) if factoids: self._replyFactoids(irc, msg, key, channel, factoids, error=False) else: if self.registryValue('replyWhenInvalidCommandSearchKeys'): factoids = self._searchFactoid(channel, key) if factoids: keylist = ["'%s'" % (fact,) for fact in factoids] keylist = ', '.join(keylist) irc.reply("I do not know about '%s', but I do know about these similar topics: %s" % (key, keylist)) @internationalizeDocstring def whatis(self, irc, msg, args, channel, words): """[] [] Looks up the value of in the factoid database. If given a number, will return only that exact factoid. is only necessary if the message isn't sent in the channel itself. """ number = None if len(words) > 1: if words[-1].isdigit(): number = int(words.pop()) if number <= 0: irc.errorInvalid(_('key id')) key = ' '.join(words) factoids = self._lookupFactoid(channel, key) self._replyFactoids(irc, msg, key, channel, factoids, number) whatis = wrap(whatis, ['channel', many('something')]) @internationalizeDocstring def alias(self, irc, msg, args, channel, oldkey, newkey, number): """[] [] Adds a new key for factoid associated with . is only necessary if there's more than one factoid associated with . The same action can be accomplished by using the 'learn' function with a new key but an existing (verbatim) factoid content. """ def _getNewKey(channel, newkey, arelation): db = self.getDb(channel) cursor = db.cursor() cursor.execute("""SELECT id FROM keys WHERE key=?""", (newkey,)) newkey_info = cursor.fetchall() if len(newkey_info) == 1: # check if we already have the requested relation cursor.execute("""SELECT id FROM relations WHERE key_id=? and fact_id=?""", (arelation[1], arelation[2])) existentrelation = cursor.fetchall() if len(existentrelation) != 0: newkey_info = False if len(newkey_info) == 0: cursor.execute("""INSERT INTO keys VALUES (NULL, ?)""", (newkey,)) db.commit() cursor.execute("""SELECT id FROM keys WHERE key=?""", (newkey,)) newkey_info = cursor.fetchall() return newkey_info db = self.getDb(channel) cursor = db.cursor() cursor.execute("""SELECT relations.id, relations.key_id, relations.fact_id FROM keys, relations WHERE keys.key=? AND relations.key_id=keys.id""", (oldkey,)) results = cursor.fetchall() if len(results) == 0: irc.error(_('No factoid matches that key.')) return elif len(results) == 1: newkey_info = _getNewKey(channel, newkey, results[0]) if newkey_info is not False: cursor.execute("""INSERT INTO relations VALUES(NULL, ?, ?, ?)""", (newkey_info[0][0], results[0][2], 0,)) irc.replySuccess() else: irc.error(_('This key-factoid relationship already exists.')) elif len(results) > 1: try: arelation = results[number-1] except IndexError: irc.error(_("That's not a valid number for that key.")) return except TypeError: irc.error(_("This key has more than one factoid associated " "with it, but you have not provided a number.")) return newkey_info = _getNewKey(channel, newkey, arelation) if newkey_info is not False: cursor.execute("""INSERT INTO relations VALUES(NULL, ?, ?, ?)""", (newkey_info[0][0], arelation[2], 0,)) irc.replySuccess() else: irc.error(_('This key-factoid relationship already exists.')) alias = wrap(alias, ['channel', 'something', 'something', optional('int')]) @internationalizeDocstring def rank(self, irc, msg, args, channel): """[] Returns a list of top-ranked factoid keys, sorted by usage count (rank). The number of factoid keys returned is set by the rankListLength registry value. is only necessary if the message isn't sent in the channel itself. """ numfacts = self.registryValue('rankListLength', channel) db = self.getDb(channel) cursor = db.cursor() cursor.execute("""SELECT keys.key, relations.usage_count FROM keys, relations WHERE relations.key_id=keys.id ORDER BY relations.usage_count DESC LIMIT ?""", (numfacts,)) factkeys = cursor.fetchall() s = [ "#%d %s (%d)" % (i+1, key[0], key[1]) for i, key in enumerate(factkeys) ] irc.reply(", ".join(s)) rank = wrap(rank, ['channel']) @internationalizeDocstring def lock(self, irc, msg, args, channel, key): """[] Locks the factoid(s) associated with so that they cannot be removed or added to. is only necessary if the message isn't sent in the channel itself. """ db = self.getDb(channel) cursor = db.cursor() cursor.execute("UPDATE factoids, keys, relations " "SET factoids.locked=1 WHERE key LIKE ? AND " "factoids.id=relations.fact_id AND " "keys.id=relations.key_id", (key,)) db.commit() irc.replySuccess() lock = wrap(lock, ['channel', 'text']) @internationalizeDocstring def unlock(self, irc, msg, args, channel, key): """[] Unlocks the factoid(s) associated with so that they can be removed or added to. is only necessary if the message isn't sent in the channel itself. """ db = self.getDb(channel) cursor = db.cursor() cursor.execute("""UPDATE factoids, keys, relations SET factoids.locked=1 WHERE key LIKE ? AND factoids.id=relations.fact_id AND keys.id=relations.key_id""", (key,)) db.commit() irc.replySuccess() unlock = wrap(unlock, ['channel', 'text']) def _deleteRelation(self, channel, relationlist): db = self.getDb(channel) cursor = db.cursor() for (keyid, factid, relationid) in relationlist: cursor.execute("""DELETE FROM relations where relations.id=?""", (relationid,)) db.commit() cursor.execute("""SELECT id FROM relations WHERE relations.key_id=?""", (keyid,)) remaining_key_relations = cursor.fetchall() if len(remaining_key_relations) == 0: cursor.execute("""DELETE FROM keys where id=?""", (keyid,)) cursor.execute("""SELECT id FROM relations WHERE relations.fact_id=?""", (factid,)) remaining_fact_relations = cursor.fetchall() if len(remaining_fact_relations) == 0: cursor.execute("""DELETE FROM factoids where id=?""", (factid,)) db.commit() @internationalizeDocstring def forget(self, irc, msg, args, channel, words): """[] [|*] Removes a key-fact relationship for key from the factoids database. If there is more than one such relationship for this key, a number is necessary to determine which one should be removed. A * can be used to remove all relationships for . If as a result, the key (factoid) remains without any relationships to a factoid (key), it shall be removed from the database. is only necessary if the message isn't sent in the channel itself. """ number = None if len(words) > 1: if words[-1].isdigit(): number = int(words.pop()) if number <= 0: irc.errorInvalid(_('key id')) elif words[-1] == '*': words.pop() number = True key = ' '.join(words) db = self.getDb(channel) cursor = db.cursor() cursor.execute("""SELECT keys.id, factoids.id, relations.id FROM keys, factoids, relations WHERE key LIKE ? AND relations.key_id=keys.id AND relations.fact_id=factoids.id""", (key,)) results = cursor.fetchall() if len(results) == 0: irc.error(_('There is no such factoid.')) elif len(results) == 1 or number is True: self._deleteRelation(channel, results) irc.replySuccess() else: if number is not None: #results = cursor.fetchall() try: arelation = results[number-1] except IndexError: irc.error(_('Invalid factoid number.')) return self._deleteRelation(channel, [arelation,]) irc.replySuccess() else: irc.error(_('%s factoids have that key. ' 'Please specify which one to remove, ' 'or use * to designate all of them.') % len(results)) forget = wrap(forget, ['channel', many('something')]) @internationalizeDocstring def random(self, irc, msg, args, channel): """[] Returns a random factoid from the database for . is only necessary if the message isn't sent in the channel itself. """ db = self.getDb(channel) cursor = db.cursor() cursor.execute("""SELECT id, key_id, fact_id FROM relations ORDER BY random() LIMIT 3""") results = cursor.fetchall() if len(results) != 0: L = [] for (relationid, keyid, factid) in results: cursor.execute("""SELECT keys.key, factoids.fact FROM keys, factoids WHERE factoids.id=? AND keys.id=?""", (factid,keyid,)) (key,factoid) = cursor.fetchall()[0] L.append('"%s": %s' % (ircutils.bold(key), factoid)) irc.reply('; '.join(L)) else: irc.error(_('I couldn\'t find a factoid.')) random = wrap(random, ['channel']) @internationalizeDocstring def info(self, irc, msg, args, channel, key): """[] Gives information about the factoid(s) associated with . is only necessary if the message isn't sent in the channel itself. """ db = self.getDb(channel) cursor = db.cursor() cursor.execute("SELECT id FROM keys WHERE key LIKE ?", (key,)) results = cursor.fetchall() if len(results) == 0: irc.error(_('No factoid matches that key.')) return id = results[0][0] cursor.execute("""SELECT factoids.added_by, factoids.added_at, factoids.locked, relations.usage_count FROM factoids, relations WHERE relations.key_id=? AND relations.fact_id=factoids.id ORDER BY relations.id""", (id,)) factoids = cursor.fetchall() L = [] counter = 0 for (added_by, added_at, locked, usage_count) in factoids: counter += 1 added_at = time.strftime(conf.supybot.reply.format.time(), time.localtime(int(added_at))) L.append(format(_('#%i was added by %s at %s, and has been ' 'recalled %n'), counter, added_by, added_at, (usage_count, 'time'))) factoids = '; '.join(L) s = format('Key %q is %s and has %n associated with it: %s', key, locked and 'locked' or 'not locked', (counter, 'factoid'), factoids) irc.reply(s) info = wrap(info, ['channel', 'text']) @internationalizeDocstring def change(self, irc, msg, args, channel, key, number, replacer): """[] Changes the factoid # associated with according to . """ db = self.getDb(channel) cursor = db.cursor() cursor.execute("""SELECT factoids.id, factoids.fact FROM keys, factoids, relations WHERE keys.key LIKE ? AND keys.id=relations.key_id AND factoids.id=relations.fact_id""", (key,)) results = cursor.fetchall() if len(results) == 0: irc.error(format(_('I couldn\'t find any key %q'), key)) return elif len(results) < number: irc.errorInvalid('key id') (id, fact) = results[number-1] newfact = replacer(fact) cursor.execute("UPDATE factoids SET fact=? WHERE id=?", (newfact, id)) db.commit() irc.replySuccess() change = wrap(change, ['channel', 'something', 'factoidId', 'regexpReplacer']) _sqlTrans = string.maketrans('*?', '%_') @internationalizeDocstring def search(self, irc, msg, args, channel, optlist, globs): """[] [--values] [--{regexp} ] [ ...] Searches the keyspace for keys matching . If --regexp is given, it associated value is taken as a regexp and matched against the keys. If --values is given, search the value space instead of the keyspace. """ if not optlist and not globs: raise callbacks.ArgumentError tables = ['keys'] formats = [] criteria = [] target = 'keys.key' predicateName = 'p' db = self.getDb(channel) for (option, arg) in optlist: if option == 'values': target = 'factoids.fact' if 'factoids' not in tables: tables.append('factoids') tables.append('relations') criteria.append('factoids.id=relations.fact_id AND keys.id=relations.key_id') elif option == 'regexp': criteria.append('%s(TARGET)' % predicateName) def p(s, r=arg): return int(bool(r.search(s))) db.create_function(predicateName, 1, p) predicateName += 'p' for glob in globs: criteria.append('TARGET LIKE ?') formats.append(glob.translate(self._sqlTrans)) cursor = db.cursor() sql = """SELECT keys.key FROM %s WHERE %s""" % \ (', '.join(tables), ' AND '.join(criteria)) sql = sql + " ORDER BY keys.key" sql = sql.replace('TARGET', target) cursor.execute(sql, formats) if cursor.rowcount == 0: irc.reply(_('No keys matched that query.')) elif cursor.rowcount == 1 and \ self.registryValue('showFactoidIfOnlyOneMatch', channel): self.whatis(irc, msg, [channel, cursor.fetchone()[0]]) elif cursor.rowcount > 100: irc.reply(_('More than 100 keys matched that query; ' 'please narrow your query.')) results = cursor.fetchall() if len(results) == 0: irc.reply(_('No keys matched that query.')) elif len(results) == 1 and \ self.registryValue('showFactoidIfOnlyOneMatch', channel): self.whatis(irc, msg, [results[0][0]]) elif len(results) > 100: irc.reply(_('More than 100 keys matched that query; ' 'please narrow your query.')) else: keys = [repr(t[0]) for t in results] s = format('%L', keys) irc.reply(s) search = wrap(search, ['channel', getopts({'values': '', 'regexp': 'regexpMatcher'}), any('glob')]) Class = Factoids # vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: