Limnoria/plugins/Note.py

291 lines
10 KiB
Python

#!/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.
"""
__revision__ = "$Id$"
import plugins
import time
import os.path
from itertools import imap
import conf
import utils
import ircdb
import ircmsgs
import plugins
import privmsgs
import ircutils
import callbacks
try:
import sqlite
except ImportError:
raise callbacks.Error, 'You need to have PySQLite installed to use this ' \
'plugin. Download it at <http://pysqlite.sf.net/>'
dbfilename = os.path.join(conf.dataDir, 'Notes.db')
class NoteDb(plugins.DBHandler):
def makeDb(self, filename):
"create Notes database and tables"
if os.path.exists(filename):
db = sqlite.connect(filename)
else:
db = sqlite.connect(filename, converters={'bool': bool})
cursor = db.cursor()
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
)""")
db.commit()
return db
class Note(callbacks.Privmsg):
def __init__(self):
callbacks.Privmsg.__init__(self)
self.dbHandler = NoteDb(name=os.path.join(conf.dataDir, 'Notes'))
def setAsRead(self, id):
db = self.dbHandler.getDb()
cursor = db.cursor()
cursor.execute("""UPDATE notes
SET read=1, notified=1
WHERE id=%s""", id)
db.commit()
def die(self):
self.dbHandler.die()
def doPrivmsg(self, irc, msg):
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
return
db = self.dbHandler.getDb()
cursor = db.cursor()
cursor.execute("""SELECT COUNT(*) FROM notes
WHERE notes.to_id=%s AND notified=0""", id)
unnotified = int(cursor.fetchone()[0])
if unnotified != 0:
cursor.execute("""SELECT COUNT(*) FROM notes
WHERE notes.to_id=%s AND read=0""", id)
unread = int(cursor.fetchone()[0])
s = 'You have %s; ' \
'%s that I haven\'t told you about before now..' % \
(utils.nItems('note', unread, 'unread'), unnotified)
irc.queueMsg(ircmsgs.privmsg(msg.nick, s))
cursor.execute("""UPDATE notes SET notified=1
WHERE notes.to_id=%s""", id)
db.commit()
def send(self, irc, msg, args):
"""<recipient> <text>
Sends a new note to the user specified.
"""
(name, note) = privmsgs.getArgs(args, required=2)
if ircdb.users.hasUser(name):
toId = ircdb.users.getUserId(name)
else:
# name must be a nick, we'll try that.
try:
hostmask = irc.state.nickToHostmask(name)
toId = ircdb.users.getUserId(hostmask)
except KeyError:
irc.error(msg, conf.replyNoUser)
return
try:
fromId = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
if ircutils.isChannel(msg.args[0]):
public = 1
else:
public = 0
db = self.dbHandler.getDb()
cursor = db.cursor()
now = int(time.time())
cursor.execute("""INSERT INTO notes VALUES
(NULL, %s, %s, %s, 0, 0, %s, %s)""",
fromId, toId, now, public, note)
db.commit()
cursor.execute("""SELECT id FROM notes WHERE
from_id=%s AND to_id=%s AND added_at=%s""",
fromId, toId, now)
id = cursor.fetchone()[0]
irc.reply(msg, 'Note #%s sent to %s.' % (id, name))
def unsend(self, irc, msg, args):
"""<id>
Unsends the note with the id given. You must be the
author of the note, and it must be unread.
"""
id = privmsgs.getArgs(args)
try:
userid = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
db = self.dbHandler.getDb()
cursor = db.cursor()
cursor.execute("""SELECT from_id, read FROM notes WHERE id=%s""", id)
if cursor.rowcount == 0:
irc.error(msg, 'That\'s not a valid note id.')
return
(from_id, read) = map(int, cursor.fetchone())
if from_id == userid:
if not read:
cursor.execute("""DELETE FROM notes WHERE id=%s""", id)
db.commit()
irc.reply(msg, conf.replySuccess)
else:
irc.error(msg, 'That note has been read already.')
else:
irc.error(msg, 'That note wasn\'t sent by you.')
def note(self, irc, msg, args):
"""<note id>
Retrieves a single note by its unique note id.
"""
noteid = privmsgs.getArgs(args)
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
try:
noteid = int(noteid)
except ValueError:
irc.error(msg, '%r is not a valid note id.' % noteid)
return
db = self.dbHandler.getDb()
cursor = db.cursor()
cursor.execute("""SELECT note, to_id, from_id, added_at, public
FROM notes
WHERE (to_id=%s OR from_id=%s) AND id=%s""",
id, id, noteid)
if cursor.rowcount == 0:
s = 'You may only retrieve notes you\'ve sent or received.'
irc.error(msg, s)
return
(note, toId, fromId, addedAt, public) = cursor.fetchone()
(toId,fromId,addedAt,public) = imap(int, (toId,fromId,addedAt,public))
elapsed = utils.timeElapsed(time.time() - addedAt)
if toId == id:
author = ircdb.users.getUser(fromId).name
newnote = '%s (Sent by %s %s ago)' % (note, author, elapsed)
elif fromId == id:
recipient = ircdb.users.getUser(toId).name
newnote = '%s (Sent to %s %s ago)' % (note, recipient, elapsed)
irc.reply(msg, newnote, private=(not public))
self.setAsRead(noteid)
def _formatNoteData(self, msg, id, fromId, public):
(id, fromId, public) = imap(int, (id, fromId, public))
if public or not ircutils.isChannel(msg.args[0]):
sender = ircdb.users.getUser(fromId).name
return '#%s from %s' % (id, sender)
else:
return '#%s (private)' % id
def list(self, irc, msg, args):
"""[--old]
Retrieves the ids of all your unread notes. If --old is given, list
read notes.
"""
if '--old' in args:
while '--old' in args:
args.remove('--old')
return self._oldnotes(irc, msg, args)
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
db = self.dbHandler.getDb()
cursor = db.cursor()
cursor.execute("""SELECT id, from_id, public
FROM notes
WHERE notes.to_id=%s AND notes.read=0""", id)
count = cursor.rowcount
L = []
if count == 0:
irc.reply(msg, 'You have no unread notes.')
else:
L = [self._formatNoteData(msg, *t) for t in cursor.fetchall()]
irc.reply(msg, utils.commaAndify(L))
def _oldnotes(self, irc, msg, args):
"""takes no arguments
Returns a list of your most recent old notes.
"""
try:
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
irc.error(msg, conf.replyNotRegistered)
return
db = self.dbHandler.getDb()
cursor = db.cursor()
cursor.execute("""SELECT id, from_id, public
FROM notes
WHERE notes.to_id=%s AND notes.read=1""", id)
if cursor.rowcount == 0:
irc.reply(msg, 'I couldn\'t find any read notes for your user.')
else:
ids = [self._formatNoteData(msg, *t) for t in cursor.fetchall()]
ids.reverse()
irc.reply(msg, utils.commaAndify(ids))
Class = Note
# vim: shiftwidth=4 tabstop=8 expandtab textwidth=78: