opendev
/
meetbot
Code Issues Proposed changes
meetbot/meeting.py

563 lines
22 KiB
Python
Raw Blame History

# Richard Darst, May 2009
###
# Copyright (c) 2009, Richard Darst
# 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 time
import os
import re
import stat
import pygments
import writers
import items
reload(writers)
reload(items)
__version__ = "0.1.3"
class Config(object):
#
# Throw any overrides into meetingLocalConfig.py in this directory:
#
# Where to store files on disk
# Example: logFileDir = '/home/richard/meetbot/'
logFileDir = '.'
# The links to the logfiles are given this prefix
# Example: logUrlPrefix = 'http://rkd.zgib.net/meetbot/'
logUrlPrefix = ''
# Give the pattern to save files into here. Use %(channel)s for
# channel. This will be sent through strftime for substituting it
# times, howover, for strftime codes you must use doubled percent
# signs (%%). This will be joined with the directories above.
filenamePattern = '%(channel)s/%%Y/%(channel)s.%%F-%%H.%%M'
# Where to say to go for more information about MeetBot
MeetBotInfoURL = 'http://wiki.debian.org/MeetBot'
# This is used with the #restrict command to remove permissions from files.
RestrictPerm = stat.S_IRWXO|stat.S_IRWXG # g,o perm zeroed
# RestrictPerm = stat.S_IRWXU|stat.S_IRWXO|stat.S_IRWXG #u,g,o perm zeroed
# used to detect #link :
UrlProtocols = ('http:', 'https:', 'irc:', 'ftp:', 'mailto:', 'ssh:')
# regular expression for parsing commands. First group is the cmd name,
# second group is the rest of the line.
command_RE = re.compile(r'#([\w]+)[ \t]*(.*)')
# The channels which won't have date/time appended to the filename.
specialChannels = ("#meetbot-test", "#meetbot-test2")
specialChannelFilenamePattern = '%(channel)s/%(channel)s'
# HTML irc log highlighting style. `pygmentize -L styles` to list.
pygmentizeStyle = 'friendly'
# Timezone setting. You can use friendly names like 'US/Eastern', etc.
# Check /usr/share/zoneinfo/ . Or `man timezone`: this is the contents
# of the TZ environment variable.
timeZone = 'UTC'
# These are the start and end meeting messages, respectively.
# Some replacements are done before they are used, using the
# %(name)s syntax. Note that since one replacement is done below,
# you have to use doubled percent signs. Also, it gets split by
# '\n' and each part between newlines get said in a separate IRC
# message.
startMeetingMessage = ("Meeting started %(starttime)s %(timeZone)s. "
"The chair is %(chair)s. Information about MeetBot at "
"%(MeetBotInfoURL)s.\n"
"Useful Commands: #action #agreed #halp #info #idea #link "
"#topic.")
endMeetingMessage = ("Meeting ended %(endtime)s %(timeZone)s. "
"Information about MeetBot at %(MeetBotInfoURL)s . "
"(v %(__version__)s)\n"
"Minutes: %(urlBasename)s.html\n"
"Minutes (text): %(urlBasename)s.txt\n"
"Log: %(urlBasename)s.log.html")
input_codec = 'utf-8'
output_codec = 'utf-8'
update_realtime = True
def enc(self, text):
return text.encode(self.output_codec, 'replace')
def dec(self, text):
return text.decode(self.input_codec, 'replace')
writer_map = {
'.log.html':writers.HTMLlog,
#'.1.html': writers.HTML,
'.html': writers.HTML2,
#'.rst': writers.ReST,
'.txt': writers.Text,
#'.rst.html':writers.HTMLfromReST,
}
def __init__(self, M, writeRawLog=False):
self.M = M
self.writers = { }
if hasattr(self, "init_hook"):
self.init_hook()
if writeRawLog:
self.writers['.log.txt'] = writers.TextLog(self.M)
for extension, writer in self.writer_map.iteritems():
self.writers[extension] = writer(self.M)
def filename(self, url=False):
# provide a way to override the filename. If it is
# overridden, it must be a full path (and the URL-part may not
# work.):
if getattr(self.M, '_filename', None):
return self.M._filename
# names useful for pathname formatting.
# Certain test channels always get the same name - don't need
# file prolifiration for them
if self.M.channel in self.specialChannels:
pattern = self.specialChannelFilenamePattern
else:
pattern = self.filenamePattern
channel = self.M.channel.strip('# ').lower().replace('/', '')
if self.M._meetingname:
meetingname = self.M._meetingname.replace('/', '')
else:
meetingname = channel
path = pattern%locals()
path = time.strftime(path, self.M.starttime)
# If we want the URL name, append URL prefix and return
if url:
return os.path.join(self.logUrlPrefix, path)
path = os.path.join(self.logFileDir, path)
# make directory if it doesn't exist...
dirname = os.path.dirname(path)
if not url and dirname and not os.access(dirname, os.F_OK):
os.makedirs(dirname)
return path
@property
def basename(self):
return os.path.basename(self.M.config.filename())
def save(self, realtime_update=False):
"""Write all output files.
If `realtime_update` is true, then this isn't a complete save,
it will only update those writers with the update_realtime
attribute true. (default update_realtime=False for this method)"""
if realtime_update and not hasattr(self.M, 'starttime'):
return
rawname = self.filename()
# We want to write the rawlog (.log.txt) first in case the
# other methods break. That way, we have saved enough to
# replay.
writer_names = list(self.writers.keys())
if '.log.txt' in writer_names:
writer_names.remove('.log.txt')
writer_names = ['.log.txt'] + writer_names
for extension in writer_names:
writer = self.writers[extension]
# Why this? If this is a realtime (step-by-step) update,
# then we only want to update those writers which say they
# should be updated step-by-step.
if (realtime_update and
( not getattr(writer, 'update_realtime', False) or
getattr(self, '_filename', None) )
):
continue
text = writer.format(extension)
# If the writer returns a string or unicode object, then
# we should write it to a filename with that extension.
# If it doesn't, then it's assumed that the write took
# care of writing (or publishing or emailing or wikifying)
# it itself.
if isinstance(text, unicode):
text = self.enc(text)
if isinstance(text, (str, unicode)):
self.writeToFile(text, rawname+extension)
if hasattr(self, 'save_hook'):
self.save_hook(realtime_update=realtime_update)
def writeToFile(self, string, filename):
"""Write a given string to a file"""
# The reason we have this method just for this is to proxy
# through the _restrictPermissions logic.
f = open(filename, 'w')
if self.M._restrictlogs:
self.restrictPermissions(f)
f.write(string)
f.close()
def restrictPermissions(self, f):
"""Remove the permissions given in the variable RestrictPerm."""
f.flush()
newmode = os.stat(f.name).st_mode & (~self.RestrictPerm)
os.chmod(f.name, newmode)
# Set the timezone, using the variable above
os.environ['TZ'] = Config.timeZone
time.tzset()
# load custom local configurations
try:
import meetingLocalConfig
meetingLocalConfig = reload(meetingLocalConfig)
if hasattr(meetingLocalConfig, 'Config'):
Config = type('Config', (meetingLocalConfig.Config, Config), {})
except ImportError:
pass
class MeetingCommands(object):
# Command Definitions
# generic parameters to these functions:
# nick=
# line= <the payload of the line>
# linenum= <the line number, 1-based index (for logfile)>
# time_= <time it was said>
# Commands for Chairs:
def do_startmeeting(self, nick, time_, line, **kwargs):
"""Begin a meeting."""
starttime = time.asctime(time_)
self.starttime = time_
timeZone = self.config.timeZone
chair = self.owner
MeetBotInfoURL = self.config.MeetBotInfoURL
repl = locals()
repl['__version__'] = __version__
message = self.config.startMeetingMessage%repl
for messageline in message.split('\n'):
self.reply(messageline)
if line.strip():
self.do_meetingtopic(nick=nick, line=line, time_=time_, **kwargs)
def do_endmeeting(self, nick, time_, **kwargs):
"""End the meeting."""
if not self.isChair(nick): return
if self.oldtopic:
self.topic(self.oldtopic)
self.endtime = time_
self.config.save()
endtime = time.asctime(time_)
timeZone = self.config.timeZone
urlBasename = self.config.filename(url=True)
MeetBotInfoURL = self.config.MeetBotInfoURL
repl = locals()
repl['__version__'] = __version__
message = self.config.endMeetingMessage%repl
for messageline in message.split('\n'):
self.reply(messageline)
self._meetingIsOver = True
def do_topic(self, nick, line, **kwargs):
"""Set a new topic in the channel."""
if not self.isChair(nick): return
self.currenttopic = line
m = items.Topic(nick=nick, line=line, **kwargs)
self.additem(m)
self.settopic()
def do_meetingtopic(self, nick, line, **kwargs):
"""Set a meeting topic (included in all sub-topics)"""
if not self.isChair(nick): return
line = line.strip()
if line == '' or line.lower() == 'none' or line.lower() == 'unset':
self._meetingTopic = None
else:
self._meetingTopic = line
self.settopic()
def do_save(self, nick, time_, **kwargs):
"""Add a chair to the meeting."""
if not self.isChair(nick): return
self.endtime = time_
self.config.save()
def do_agreed(self, nick, **kwargs):
"""Add aggreement to the minutes - chairs only."""
if not self.isChair(nick): return
m = items.Agreed(nick, **kwargs)
self.additem(m)
do_agree = do_agreed
def do_accepted(self, nick, **kwargs):
"""Add aggreement to the minutes - chairs only."""
if not self.isChair(nick): return
m = items.Accepted(nick, **kwargs)
self.additem(m)
do_accept = do_accepted
def do_rejected(self, nick, **kwargs):
"""Add aggreement to the minutes - chairs only."""
if not self.isChair(nick): return
m = items.Rejected(nick, **kwargs)
self.additem(m)
do_rejected = do_rejected
def do_chair(self, nick, line, **kwargs):
"""Add a chair to the meeting."""
if not self.isChair(nick): return
for chair in re.split('[, ]+', line.strip()):
chair = chair.strip()
if not chair: continue
if chair not in self.chairs:
self.addnick(chair, lines=0)
self.chairs.setdefault(chair, True)
chairs = dict(self.chairs) # make a copy
chairs.setdefault(self.owner, True)
self.reply("Current chairs: %s"%(" ".join(sorted(chairs.keys()))))
def do_unchair(self, nick, line, **kwargs):
"""Remove a chair to the meeting (founder can not be removed)."""
if not self.isChair(nick): return
for chair in line.strip().split():
chair = chair.strip()
if chair in self.chairs:
del self.chairs[chair]
chairs = dict(self.chairs) # make a copy
chairs.setdefault(self.owner, True)
self.reply("Current chairs: %s"%(" ".join(sorted(chairs.keys()))))
def do_undo(self, nick, **kwargs):
"""Remove the last item from the minutes."""
if not self.isChair(nick): return
if len(self.minutes) == 0: return
self.reply("Removing item from minutes: %s"%str(self.minutes[-1]))
del self.minutes[-1]
def do_restrictlogs(self, nick, **kwargs):
"""When saved, remove permissions from the files."""
if not self.isChair(nick): return
self._restrictlogs = True
self.reply("Restricting permissions on minutes: -%s on next #save"%\
oct(RestrictPerm))
def do_lurk(self, nick, **kwargs):
"""Don't interact in the channel."""
if not self.isChair(nick): return
self._lurk = True
def do_unlurk(self, nick, **kwargs):
"""Do interact in the channel."""
if not self.isChair(nick): return
self._lurk = False
def do_meetingname(self, nick, time_, line, **kwargs):
"""Set the variable (meetingname) which can be used in save.
If this isn't set, it defaults to the channel name."""
meetingname = line.strip().lower().replace(" ", "")
meetingname = "_".join(line.strip().lower().split())
self._meetingname = meetingname
self.reply("The meeting name has been set to '%s'"%meetingname)
# Commands for Anyone:
def do_action(self, **kwargs):
"""Add action item to the minutes.
The line is searched for nicks, and a per-person action item
list is compiled after the meeting. Only nicks which have
been seen during the meeting will have an action item list
made for them, but you can use the #nick command to cause a
nick to be seen."""
m = items.Action(**kwargs)
self.additem(m)
def do_info(self, **kwargs):
"""Add informational item to the minutes."""
m = items.Info(**kwargs)
self.additem(m)
def do_idea(self, **kwargs):
"""Add informational item to the minutes."""
m = items.Idea(**kwargs)
self.additem(m)
def do_halp(self, **kwargs):
"""Add call for halp to the minutes."""
m = items.Halp(**kwargs)
self.additem(m)
do_help = do_halp
def do_nick(self, nick, line, **kwargs):
"""Make meetbot aware of a nick which hasn't said anything.
To see where this can be used, see #action command"""
nicks = re.split('[, ]+', line.strip())
for nick in nicks:
nick = nick.strip()
if not nick: continue
self.addnick(nick, lines=0)
def do_link(self, **kwargs):
"""Add informational item to the minutes."""
m = items.Link(**kwargs)
self.additem(m)
def do_commands(self, **kwargs):
commands = [ "#"+x[3:] for x in dir(self) if x[:3]=="do_" ]
commands.sort()
self.reply("Available commands: "+(" ".join(commands)))
class Meeting(MeetingCommands, object):
_lurk = False
_restrictlogs = False
def __init__(self, channel, owner, oldtopic=None,
filename=None, writeRawLog=False,
setTopic=None, sendReply=None, getRegistryValue=None):
self.config = Config(self, writeRawLog=writeRawLog)
if getRegistryValue is not None:
self._registryValue = getRegistryValue
if sendReply is not None:
self._sendReply = sendReply
if setTopic is not None:
self._setTopic = setTopic
self.owner = owner
self.channel = channel
self.currenttopic = ""
if oldtopic:
self.oldtopic = self.config.dec(oldtopic)
else:
self.oldtopic = None
self.lines = [ ]
self.minutes = [ ]
self.attendees = { }
self.chairs = { }
self._writeRawLog = writeRawLog
self._meetingTopic = None
self._meetingname = ""
self._meetingIsOver = False
if filename:
self._filename = filename
# These commands are callbacks to manipulate the IRC protocol.
# set self._sendReply and self._setTopic to an callback to do these things.
def reply(self, x):
"""Send a reply to the IRC channel."""
if hasattr(self, '_sendReply') and not self._lurk:
self._sendReply(self.config.enc(x))
else:
print "REPLY:", self.config.enc(x)
def topic(self, x):
"""Set the topic in the IRC channel."""
if hasattr(self, '_setTopic') and not self._lurk:
self._setTopic(self.config.enc(x))
else:
print "TOPIC:", self.config.enc(x)
def settopic(self):
"The actual code to set the topic"
if self._meetingTopic:
topic = '%s (Meeting topic: %s)'%(self.currenttopic,
self._meetingTopic)
else:
topic = self.currenttopic
self.topic(topic)
def addnick(self, nick, lines=1):
"""This person has spoken, lines=<how many lines>"""
self.attendees[nick] = self.attendees.get(nick, 0) + lines
def isChair(self, nick):
"""Is the nick a chair?"""
return (nick == self.owner or nick in self.chairs)
def save(self, **kwargs):
self.config.save(**kwargs)
# Primary enttry point for new lines in the log:
def addline(self, nick, line, time_=None):
"""This is the way to add lines to the Meeting object.
"""
linenum = self.addrawline(nick, line, time_)
if time_ is None: time_ = time.localtime()
nick = self.config.dec(nick)
line = self.config.dec(line)
# Handle any commands given in the line.
matchobj = self.config.command_RE.match(line)
if matchobj is not None:
command, line = matchobj.groups()
command = command.lower()
# to define new commands, define a method do_commandname .
if hasattr(self, "do_"+command):
getattr(self, "do_"+command)(nick=nick, line=line,
linenum=linenum, time_=time_)
else:
# Detect URLs automatically
if line.split('//')[0] in self.config.UrlProtocols:
self.do_link(nick=nick, line=line,
linenum=linenum, time_=time_)
self.save(realtime_update=True)
def addrawline(self, nick, line, time_=None):
"""This adds a line to the log, bypassing command execution.
"""
nick = self.config.dec(nick)
line = self.config.dec(line)
self.addnick(nick)
line = line.strip(' \x01') # \x01 is present in ACTIONs
# Setting a custom time is useful when replying logs,
# otherwise use our current time:
if time_ is None: time_ = time.localtime()
# Handle the logging of the line
if line[:6] == 'ACTION':
logline = "%s * %s %s"%(time.strftime("%H:%M:%S", time_),
nick, line[7:].strip())
else:
logline = "%s <%s> %s"%(time.strftime("%H:%M:%S", time_),
nick, line.strip())
self.lines.append(logline)
linenum = len(self.lines)
return linenum
def additem(self, m):
"""Add an item to the meeting minutes list.
"""
self.minutes.append(m)
def parse_time(time_):
try: return time.strptime(time_, "%H:%M:%S")
except ValueError: pass
try: return time.strptime(time_, "%H:%M")
except ValueError: pass
logline_re = re.compile(r'\[?([0-9: ]*)\]? *<[@+]?([^>]+)> *(.*)')
loglineAction_re = re.compile(r'\[?([0-9: ]*)\]? *\* *([^ ]+) *(.*)')
# None of this is very well refined.
if __name__ == '__main__':
import sys
if sys.argv[1] == 'replay':
fname = sys.argv[2]
m = re.match('(.*)\.log\.txt', fname)
if m:
filename = m.group(1)
else:
filename = os.path.splitext(fname)[0]
print 'Saving to:', filename
channel = '#'+os.path.basename(sys.argv[2]).split('.')[0]
M = Meeting(channel=channel, owner=None,
filename=filename, writeRawLog=False)
for line in file(sys.argv[2]):
# match regular spoken lines:
m = logline_re.match(line)
if m:
time_ = parse_time(m.group(1).strip())
nick = m.group(2).strip()
line = m.group(3).strip()
if M.owner is None:
M.owner = nick ; M.chairs = {nick:True}
M.addline(nick, line, time_=time_)
# match /me lines
m = loglineAction_re.match(line)
if m:
time_ = parse_time(m.group(1).strip())
nick = m.group(2).strip()
line = m.group(3).strip()
M.addline(nick, "ACTION "+line, time_=time_)
#M.save() # should be done by #endmeeting in the logs!
else:
print 'Command "%s" not found.'%sys.argv[1]
View Git Blame Copy Permalink