#!/usr/bin/env python ### # Copyright (c) 2003, Brett Kelly # 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. ### """ A complete messaging system that allows users to leave 'notes' for other users that can be retrieved later. """ from baseplugin import * import time import os.path import operator import sqlite import conf import debug import utils import ircdb import ircmsgs import privmsgs import callbacks import ircutils dbfilename = os.path.join(conf.dataDir, 'Notes.db') class Notes(callbacks.Privmsg): def __init__(self): callbacks.Privmsg.__init__(self) self.makeDB(dbfilename) def makeDB(self, filename): "create Notes database and tables" if os.path.exists(filename): self.db = sqlite.connect(filename) self.cursor = self.db.cursor() return self.db = sqlite.connect(filename, converters={'bool': bool}) self.cursor = self.db.cursor() self.cursor.execute("""CREATE TABLE users ( id INTEGER PRIMARY KEY, name TEXT UNIQUE ON CONFLICT IGNORE )""") self.cursor.execute("""CREATE TABLE notes ( id INTEGER PRIMARY KEY, from_id INTEGER, to_id INTEGER, added_at TIMESTAMP, notified BOOLEAN, read BOOLEAN, public BOOLEAN, note TEXT )""") self.db.commit() def _addUser(self, username): "Not callable from channel, used to add users to database." self.cursor.execute('INSERT INTO users VALUES (NULL, %s)', username) self.db.commit() def getUserId(self, username): "Returns the user id matching the given username from the users table." self.cursor.execute('SELECT id FROM users where name=%s', username) if self.cursor.rowcount != 0: return self.cursor.fetchone()[0] else: raise KeyError, username def getUserName(self, userid): "Returns the username matching the given user id from the users table." self.cursor.execute('SELECT name FROM users WHERE id=%s', userid) if self.cursor.rowcount != 0: return self.cursor.fetchone()[0] else: raise KeyError, userid def setAsRead(self, noteid): "Changes a message's 'read' value to true in the notes table." self.cursor.execute("""UPDATE notes SET read=1, notified=1 WHERE id=%s""", noteid) self.db.commit() def die(self): "Called when module is unloaded/reloaded." self.db.close() def doJoin(self, irc, msg): try: name = ircdb.users.getUserName(msg.prefix) except KeyError: return cursor = self.db.cursor() cursor.execute("""SELECT COUNT(*) FROM notes, users WHERE users.name=%s AND notes.to_id=users.id AND notified=0""", name) unnotified = int(cursor.fetchone()[0]) if unnotified == 0: return cursor.execute("""SELECT COUNT(*) FROM notes, users WHERE users.name=%s AND notes.to_id=users.id AND read=0""", name) unread = int(cursor.fetchone()[0]) s = 'You have %s unread note%s ' \ '%s that I haven\'t told you about before now..' % \ (unread, unread == 1 and ';' or 's;', unnotified) irc.queueMsg(ircmsgs.privmsg(msg.nick, s)) cursor.execute("""UPDATE notes SET notified=1 WHERE notes.to_id=(SELECT id FROM users WHERE name=%s)""", name) def sendnote(self, irc, msg, args): """ Sends a new note to the user specified. """ (name, note) = privmsgs.getArgs(args, needed=2) sender = msg.nick if ircdb.users.hasUser(name): recipient = name else: n = irc.state.nickToHostmask(name) recipient = ircdb.users.getUserName(n) self._addUser(sender) self._addUser(recipient) senderId = self.getUserId(sender) recipId = self.getUserId(recipient) if ircutils.isChannel(msg.args[0]): public = 1 else: public = 0 self.cursor.execute("""INSERT INTO notes VALUES (NULL, %s, %s, %s, 0, 0, %s, %s)""", senderId, recipId, int(time.time()), public, note) self.db.commit() irc.reply(msg, conf.replySuccess) def note(self, irc, msg, args): """ Retrieves a single note by unique note id. """ noteid = privmsgs.getArgs(args) try: sender = ircdb.users.getUserName(msg.prefix) senderId = self.getUserId(sender) except KeyError: irc.error(msg, conf.replyNoUser) return self.cursor.execute("""SELECT notes.note, notes.to_id, notes.from_id, notes.added_at, notes.public FROM users, notes WHERE users.name=%s AND notes.to_id=users.id AND notes.id=%s LIMIT 1""", sender, noteid) if self.cursor.rowcount == 0: irc.error(msg, 'That\'s not a valid note id.') return note, to_id, from_id, added_at, public = self.cursor.fetchone() author = self.getUserName(from_id) if senderId != to_id: irc.error(msg, 'You are not the recipient of note %s.' % noteid) return public = int(public) elapsed = utils.timeElapsed(time.time(), int(added_at)) newnote = "%s (Sent by %s %s ago)" % (note, author, elapsed) if public: irc.reply(msg, newnote) else: irc.queueMsg(ircmsgs.privmsg(msg.nick, newnote)) self.setAsRead(noteid) def notes(self, irc, msg, args): """takes no arguments Retrieves all your unread notes. """ try: sender = ircdb.users.getUserName(msg.prefix) except KeyError: irc.error(msg, conf.replyNoUser) return self.cursor.execute("""SELECT notes.id, notes.from_id, notes.public, notes.read FROM users, notes WHERE users.name=%s AND notes.to_id=users.id AND notes.read=0""", sender) count = self.cursor.rowcount notes = self.cursor.fetchall() L = [] more = False if count == 0: irc.reply(msg, 'You have no unread notes.') else: for (id, from_id, public, read) in notes: if not int(read): sender = self.getUserName(from_id) if int(public): L.append(r'#%s from %s' % (id, sender)) else: L.append(r'#%s (private)' % id) if more: ircutils.shrinkList(L, ', ', 400) L.append('and even more notes.') else: ircutils.shrinkList(L, ', ', 450) irc.reply(msg, ', '.join(L)) def oldnotes(self, irc, msg, args): """takes no arguments Returns a list of your most recent old notes. """ try: sender = ircdb.users.getUserName(msg.prefix) except KeyError: irc.error(msg, conf.replyNoUser) return cursor = self.db.cursor() cursor.execute("""SELECT notes.id FROM users, notes WHERE notes.to_id=users.id AND users.name=%s AND notes.read=1""", sender) if cursor.rowcount == 0: irc.reply(msg, 'I could find no notes for your user.') else: ids = [str(t[0]) for t in cursor.fetchall()] ids.reverse() ircutils.shrinkList(ids, ', ', 425) ids.reverse() irc.reply(msg, ', '.join(ids)) Class = Notes # vim: shiftwidth=4 tabstop=8 expandtab textwidth=78: