Limnoria/plugins/ChannelStats.py

442 lines
17 KiB
Python
Raw Normal View History

2003-03-12 07:26:59 +01:00
#!/usr/bin/env python
###
# Copyright (c) 2002, Jeremiah Fincher
# 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.
###
"""
Silently listens to every message received on a channel and keeps statistics
concerning joins, parts, and various other commands in addition to tracking
statistics about smileys, actions, characters, and words.
"""
2003-11-25 09:23:47 +01:00
__revision__ = "$Id$"
import plugins
2003-03-12 07:26:59 +01:00
import os
2003-03-12 07:26:59 +01:00
import re
2003-08-12 21:38:23 +02:00
import sets
2003-03-12 07:26:59 +01:00
import time
import getopt
import string
from itertools import imap, ifilter
2003-03-12 07:26:59 +01:00
2003-10-06 23:17:21 +02:00
import conf
2003-04-12 12:39:04 +02:00
import utils
import ircdb
import ircmsgs
import plugins
2003-03-12 07:26:59 +01:00
import ircutils
import privmsgs
import registry
2003-03-12 07:26:59 +01:00
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/>'
2004-01-08 01:48:30 +01:00
# I should write/copy a generalized proxy at some point.
class Smileys(registry.Value):
def set(self, s):
L = s.split()
self.setValue(L)
2004-01-08 01:48:30 +01:00
def setValue(self, v):
self.s = ' '.join(v)
self.value = re.compile('|'.join(imap(re.escape, v)))
2004-01-08 01:48:30 +01:00
def __str__(self):
return self.s
conf.registerPlugin('ChannelStats')
conf.registerChannelValue(conf.supybot.plugins.ChannelStats, 'selfStats',
registry.Boolean(True, """Determines whether the bot will keep channel
statistics on itself, possibly skewing the channel stats (especially in
cases where the bot is relaying between channels on a network)."""))
conf.registerChannelValue(conf.supybot.plugins.ChannelStats, 'smileys',
Smileys(':) ;) ;] :-) :-D :D :P :p (= =)'.split(), """Determines what
words (i.e., pieces of text with no spaces in them) are considered
'smileys' for the purposes of stats-keeping."""))
conf.registerChannelValue(conf.supybot.plugins.ChannelStats, 'frowns',
Smileys(':| :-/ :-\\ :\\ :/ :( :-( :\'('.split(), """Determines what words
(i.e., pieces of text with no spaces in them ) are considered 'frowns' for
the purposes of stats-keeping."""))
class ChannelStats(plugins.ChannelDBHandler, callbacks.Privmsg):
2003-11-11 00:39:44 +01:00
noIgnore = True
2003-03-12 07:26:59 +01:00
def __init__(self):
2003-11-04 09:42:11 +01:00
callbacks.Privmsg.__init__(self)
plugins.ChannelDBHandler.__init__(self)
2003-10-16 15:34:02 +02:00
self.lastmsg = None
self.laststate = None
2003-10-25 00:29:30 +02:00
self.outFiltering = False
2003-03-12 07:26:59 +01:00
2003-11-11 16:58:20 +01:00
def die(self):
callbacks.Privmsg.die(self)
plugins.ChannelDBHandler.die(self)
2003-03-26 11:04:26 +01:00
def makeDb(self, filename):
if os.path.exists(filename):
2003-10-09 08:43:58 +02:00
db = sqlite.connect(filename)
else:
db = sqlite.connect(filename)
cursor = db.cursor()
cursor.execute("""CREATE TABLE user_stats (
id INTEGER PRIMARY KEY,
2003-10-25 00:29:30 +02:00
user_id INTEGER UNIQUE ON CONFLICT IGNORE,
2003-10-09 08:43:58 +02:00
last_seen TIMESTAMP,
last_msg TEXT,
smileys INTEGER,
frowns INTEGER,
chars INTEGER,
words INTEGER,
msgs INTEGER,
actions INTEGER,
joins INTEGER,
parts INTEGER,
kicks INTEGER,
kicked INTEGER,
modes INTEGER,
2003-10-16 15:34:02 +02:00
topics INTEGER,
quits INTEGER
2003-10-09 08:43:58 +02:00
)""")
cursor.execute("""CREATE TABLE channel_stats (
smileys INTEGER,
frowns INTEGER,
chars INTEGER,
words INTEGER,
msgs INTEGER,
actions INTEGER,
joins INTEGER,
parts INTEGER,
kicks INTEGER,
modes INTEGER,
2003-10-16 15:34:02 +02:00
topics INTEGER,
quits INTEGER
2003-10-09 08:43:58 +02:00
)""")
cursor.execute("""CREATE TABLE nick_seen (
2003-11-11 00:39:44 +01:00
name TEXT,
normalized TEXT UNIQUE ON CONFLICT REPLACE,
2003-10-09 08:43:58 +02:00
last_seen TIMESTAMP,
last_msg TEXT
)""")
cursor.execute("""INSERT INTO channel_stats
2003-10-16 15:34:02 +02:00
VALUES (0, 0, 0, 0, 0, 0,
2003-10-09 08:43:58 +02:00
0, 0, 0, 0, 0, 0)""")
db.commit()
def p(s1, s2):
return int(ircutils.nickEqual(s1, s2))
db.create_function('nickeq', 2, p)
2003-03-26 11:04:26 +01:00
return db
2003-08-20 18:26:23 +02:00
2003-10-16 15:34:02 +02:00
def __call__(self, irc, msg):
try:
if self.lastmsg:
self.laststate.addMsg(irc, self.lastmsg)
else:
self.laststate = irc.state.copy()
finally:
self.lastmsg = msg
super(ChannelStats, self).__call__(irc, msg)
2003-10-16 15:34:02 +02:00
2003-03-12 07:26:59 +01:00
def doPrivmsg(self, irc, msg):
if not ircutils.isChannel(msg.args[0]):
return
else:
self._updatePrivmsgStats(msg)
def _updatePrivmsgStats(self, msg):
2003-10-25 00:29:30 +02:00
(channel, s) = msg.args
db = self.getDb(channel)
cursor = db.cursor()
chars = len(s)
words = len(s.split())
isAction = ircmsgs.isAction(msg)
frowns = len(self.registryValue('frowns', channel).findall(s))
smileys = len(self.registryValue('smileys', channel).findall(s))
2003-10-25 00:29:30 +02:00
s = ircmsgs.prettyPrint(msg)
cursor.execute("""UPDATE channel_stats
SET smileys=smileys+%s,
frowns=frowns+%s,
chars=chars+%s,
words=words+%s,
msgs=msgs+1,
actions=actions+%s""",
smileys, frowns, chars, words, int(isAction))
2003-11-11 00:39:44 +01:00
cursor.execute("""INSERT INTO nick_seen VALUES (%s, %s, %s, %s)""",
msg.nick,ircutils.toLower(msg.nick),int(time.time()),s)
2003-10-25 00:29:30 +02:00
try:
if self.outFiltering:
id = 0
2003-03-26 11:04:26 +01:00
else:
2003-10-25 00:29:30 +02:00
id = ircdb.users.getUserId(msg.prefix)
except KeyError:
return
cursor.execute("""INSERT INTO user_stats VALUES (
NULL, %s, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0)""", id)
2003-10-25 00:29:30 +02:00
cursor.execute("""UPDATE user_stats SET
last_seen=%s, last_msg=%s, chars=chars+%s,
words=words+%s, msgs=msgs+1,
actions=actions+%s, smileys=smileys+%s,
frowns=frowns+%s
WHERE user_id=%s""",
int(time.time()), s, chars, words, int(isAction),
smileys, frowns, id)
db.commit()
def outFilter(self, irc, msg):
if msg.command == 'PRIVMSG':
if ircutils.isChannel(msg.args[0]):
if self.registryValue('selfStats', msg.args[0]):
try:
self.outFiltering = True
self._updatePrivmsgStats(msg)
finally:
self.outFiltering = False
2003-10-25 00:29:30 +02:00
return msg
2003-03-12 07:26:59 +01:00
2003-03-26 11:04:26 +01:00
def doPart(self, irc, msg):
channel = msg.args[0]
db = self.getDb(channel)
cursor = db.cursor()
cursor.execute("""UPDATE channel_stats SET parts=parts+1""")
2003-03-26 11:04:26 +01:00
try:
id = ircdb.users.getUserId(msg.prefix)
2003-10-14 07:54:11 +02:00
cursor.execute("""UPDATE user_stats SET parts=parts+1
WHERE user_id=%s""", id)
2003-03-26 11:04:26 +01:00
except KeyError:
pass
db.commit()
2003-03-26 11:04:26 +01:00
def doTopic(self, irc, msg):
channel = msg.args[0]
2003-03-12 07:26:59 +01:00
db = self.getDb(channel)
2003-03-26 11:04:26 +01:00
cursor = db.cursor()
cursor.execute("""UPDATE channel_stats SET topics=topics+1""")
2003-03-12 07:26:59 +01:00
try:
id = ircdb.users.getUserId(msg.prefix)
cursor.execute("""UPDATE user_stats
SET topics=topics+1
WHERE user_id=%s""", id)
2003-03-12 07:26:59 +01:00
except KeyError:
pass
db.commit()
def doMode(self, irc, msg):
2003-03-26 11:04:26 +01:00
channel = msg.args[0]
db = self.getDb(channel)
cursor = db.cursor()
cursor.execute("""UPDATE channel_stats SET modes=modes+1""")
try:
id = ircdb.users.getUserId(msg.prefix)
cursor.execute("""UPDATE user_stats
SET modes=modes+1
WHERE user_id=%s""", id)
except KeyError:
pass
2003-03-26 11:04:26 +01:00
db.commit()
def doKick(self, irc, msg):
channel = msg.args[0]
db = self.getDb(channel)
2003-03-26 11:04:26 +01:00
cursor = db.cursor()
cursor.execute("""UPDATE channel_stats SET kicks=kicks+1""")
2003-03-26 11:04:26 +01:00
try:
id = ircdb.users.getUserId(msg.prefix)
cursor.execute("""UPDATE user_stats
SET kicks=kicks+1
WHERE user_id=%s""", id)
2003-03-26 11:04:26 +01:00
except KeyError:
pass
try:
kicked = msg.args[1]
id = ircdb.users.getUserId(irc.state.nickToHostmask(kicked))
cursor.execute("""UPDATE user_stats
SET kicked=kicked+1
WHERE user_id=%s""", id)
2003-03-26 11:04:26 +01:00
except KeyError:
pass
db.commit()
2003-10-16 15:34:02 +02:00
def doJoin(self, irc, msg):
channel = msg.args[0]
db = self.getDb(channel)
cursor = db.cursor()
cursor.execute("""UPDATE channel_stats SET joins=joins+1""")
try:
id = ircdb.users.getUserId(msg.prefix)
2003-10-16 15:34:02 +02:00
cursor.execute("""UPDATE user_stats
SET joins=joins+1
WHERE user_id=%s""", id)
2003-10-16 15:34:02 +02:00
except KeyError:
pass
db.commit()
def doQuit(self, irc, msg):
for (channel, c) in self.laststate.channels.iteritems():
if msg.nick in c.users:
db = self.getDb(channel)
cursor = db.cursor()
cursor.execute("""UPDATE channel_stats SET quits=quits+1""")
try:
id = ircdb.users.getUserId(msg.prefix)
2003-10-16 15:34:02 +02:00
cursor.execute("""UPDATE user_stats SET quits=quits+1
WHERE user_id=%s""", id)
2003-10-16 15:34:02 +02:00
except KeyError:
pass
db.commit()
2003-03-26 11:04:26 +01:00
def seen(self, irc, msg, args):
"""[<channel>] [--user] <name>
Returns the last time <name> was seen and what <name> was last seen
saying. --user will look for user <name> instead of using <name> as
a nick (registered users, remember, can be recognized under any number
of nicks) <channel> is only necessary if the message isn't sent on the
channel itself.
"""
2003-03-26 11:04:26 +01:00
channel = privmsgs.getChannel(msg, args)
db = self.getDb(channel)
cursor = db.cursor()
(optlist, rest) = getopt.getopt(args, '', ['user'])
name = privmsgs.getArgs(rest)
originalName = name
2003-10-02 02:42:26 +02:00
if ('--user', '') in optlist:
table = 'user_stats'
criterion = 'user_id=%s'
2003-12-05 13:08:24 +01:00
try:
name = ircdb.users.getUserId(name)
except KeyError:
try:
hostmask = irc.state.nickToHostmask(name)
2003-12-05 13:08:24 +01:00
name = ircdb.users.getUserId(hostmask)
except KeyError:
2004-01-08 16:47:38 +01:00
irc.errorNoUser()
return
else:
table = 'nick_seen'
2003-11-11 00:39:44 +01:00
criterion = 'normalized=%s'
name = ircutils.toLower(name)
sql = "SELECT last_seen,last_msg FROM %s WHERE %s" % (table,criterion)
cursor.execute(sql, name)
2003-03-26 11:04:26 +01:00
if cursor.rowcount == 0:
2004-01-25 18:24:35 +01:00
irc.reply('I have not seen %s.' % originalName)
2003-03-26 11:04:26 +01:00
else:
(seen, m) = cursor.fetchone()
seen = int(seen)
if isinstance(name, int):
name = ircdb.users.getUser(int(name)).name
2003-11-21 18:32:14 +01:00
s = '%s was last seen here %s ago saying: %s' % \
(originalName, utils.timeElapsed(time.time() - seen), m)
irc.reply(s)
2003-03-26 11:04:26 +01:00
def stats(self, irc, msg, args):
"""[<channel>] [<name>]
Returns the statistics for <name> on <channel>. <channel> is only
necessary if the message isn't sent on the channel itself. If <name>
isn't given, it defaults to the user sending the command.
"""
2003-03-26 11:04:26 +01:00
channel = privmsgs.getChannel(msg, args)
name = privmsgs.getArgs(args, required=0, optional=1)
if not name:
try:
id = ircdb.users.getUserId(msg.prefix)
2003-10-25 00:29:30 +02:00
name = ircdb.users.getUser(id).name
except KeyError:
irc.error('I couldn\'t find you in my user database.')
return
elif not ircdb.users.hasUser(name):
2003-03-26 11:04:26 +01:00
try:
2003-10-02 02:43:38 +02:00
hostmask = irc.state.nickToHostmask(name)
id = ircdb.users.getUserId(hostmask)
2003-03-26 11:04:26 +01:00
except KeyError:
2004-01-08 16:47:38 +01:00
irc.errorNoUser()
2003-03-26 11:04:26 +01:00
return
else:
id = ircdb.users.getUserId(name)
2003-03-26 11:04:26 +01:00
db = self.getDb(channel)
cursor = db.cursor()
cursor.execute("""SELECT * FROM user_stats WHERE user_id=%s""", id)
2003-03-26 11:04:26 +01:00
if cursor.rowcount == 0:
irc.error('I have no stats for that user.')
2003-03-26 11:04:26 +01:00
return
values = cursor.fetchone()
s = '%s has sent %s; a total of %s, %s, ' \
'%s, and %s; %s of those messages %s' \
'%s has joined %s, parted %s, quit %s, kicked someone %s, ' \
'been kicked %s, changed the topic %s, ' \
'and changed the mode %s.' % \
(name, utils.nItems('message', values.msgs),
utils.nItems('character', values.chars),
utils.nItems('word', values.words),
utils.nItems('smiley', values.smileys),
utils.nItems('frown', values.frowns),
values.actions, values.actions == 1 and 'was an ACTION. '
or 'were ACTIONs. ',
name,
utils.nItems('time', values.joins),
utils.nItems('time', values.parts),
utils.nItems('time', values.quits),
utils.nItems('time', values.kicks),
utils.nItems('time', values.kicked),
utils.nItems('time', values.topics),
utils.nItems('time', values.modes))
irc.reply(s)
2003-03-12 07:26:59 +01:00
def channelstats(self, irc, msg, args):
"""[<channel>]
Returns the statistics for <channel>. <channel> is only necessary if
the message isn't sent on the channel itself.
"""
channel = privmsgs.getChannel(msg, args)
db = self.getDb(channel)
cursor = db.cursor()
cursor.execute("""SELECT * FROM channel_stats""")
values = cursor.fetchone()
s = 'On %s there have been %s messages, containing %s characters, ' \
'%s words, %s smileys, and %s frowns; %s of those messages were ' \
2003-10-16 15:34:02 +02:00
'ACTIONs. There have been %s joins, %s parts, %s quits, ' \
'%s kicks, %s mode changes, and %s topic changes.' % \
(channel, values.msgs, values.chars,
values.words, values.smileys, values.frowns, values.actions,
2003-10-16 15:34:02 +02:00
values.joins, values.parts, values.quits,
values.kicks, values.modes, values.topics)
irc.reply(s)
Class = ChannelStats
2003-03-26 11:04:26 +01:00
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: