Limnoria/plugins/LogToChannel.py

183 lines
6.5 KiB
Python
Raw Normal View History

#!/usr/bin/python
# -*- coding:utf-8 -*-
###
# Copyright (c) 2004, Stéphan Kochen
# 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.
###
"""
2004-04-13 07:18:17 +02:00
Allows for sending the bot's logging output to a channel.
"""
__revision__ = "$Id$"
import plugins
import logging
import log
import conf
import utils
import world
2004-04-13 07:18:17 +02:00
import ircmsgs
import ircutils
import privmsgs
import registry
import callbacks
class IrcHandler(logging.Handler):
def emit(self, record):
2004-04-13 07:18:17 +02:00
channel = conf.supybot.plugins.LogToChannel.channel()
try:
2004-04-13 07:18:17 +02:00
s = utils.normalizeWhitespace(self.format(record))
except:
self.handleError(record)
msg = ircmsgs.privmsg(channel, s)
if channel:
for irc in world.ircs:
try:
if not irc.driver.connected:
continue
except AttributeError, e:
print '*** AttributeError, shouldn\'t happen: %s' % e
continue
if channel in irc.state.channels:
irc.queueMsg(msg)
class IrcFormatter(log.Formatter):
def formatException(self, ei):
import cStringIO
import traceback
sio = cStringIO.StringIO()
traceback.print_exception(ei[0], ei[1], None, None, sio)
s = sio.getvalue()
sio.close()
return s
class ColorizedIrcFormatter(IrcFormatter):
def formatException(self, (E, e, tb)):
if conf.supybot.plugins.LogToChannel.colorized():
return ircutils.bold(ircutils.mircColor(
IrcFormatter.formatException(self, (E, e, tb)),
fg='red'))
else:
return IrcFormatter.formatException(self, (E, e, tb))
def format(self, record, *args, **kwargs):
2004-04-13 07:18:17 +02:00
s = IrcFormatter.format(self, record, *args, **kwargs)
if conf.supybot.plugins.LogToChannel.colorized():
if record.levelno == logging.CRITICAL:
2004-04-13 07:18:17 +02:00
s = ircutils.bold(ircutils.mircColor(s, fg='red'))
elif record.levelno == logging.ERROR:
2004-04-13 07:18:17 +02:00
s = ircutils.mircColor(s, fg='orange')
elif record.levelno == logging.WARNING:
2004-04-13 07:18:17 +02:00
s = ircutils.mircColor(s, fg='yellow')
return s
2004-04-13 07:18:17 +02:00
_ircHandler = IrcHandler()
_formatString = '%(name)s: %(levelname)s %(message)s'
_ircFormatter = ColorizedIrcFormatter(_formatString)
_ircHandler.setFormatter(_ircFormatter)
2004-04-13 07:18:17 +02:00
class ChannelLogLevel(log.LogLevel):
"""Invalid log level. Value must be either INFO, WARNING, ERROR,
or CRITICAL."""
def setValue(self, v):
if v <= logging.DEBUG:
self.error()
else:
log.LogLevel.setValue(self, v)
_ircHandler.setLevel(v)
class ValidChannelOrNot(conf.ValidChannel):
def setValue(self, v):
if v:
conf.ValidChannel.setValue(self, v)
else:
registry.Value.setValue(self, '')
conf.registerPlugin('LogToChannel')
conf.registerGlobalValue(conf.supybot.plugins.LogToChannel, 'level',
2004-04-13 07:18:17 +02:00
ChannelLogLevel(logging.WARNING, """Determines what the minimum priority
level logged will be to IRC. See supybot.log.level for possible
values. DEBUG is disabled due to the large quantity of output."""))
conf.registerGlobalValue(conf.supybot.plugins.LogToChannel, 'channel',
ValidChannelOrNot('', """Determines which channel the bot should log to or
empty if none at all."""))
conf.registerGlobalValue(conf.supybot.plugins.LogToChannel, 'colorized',
registry.Boolean(False, """Determines whether the bot's logs
to IRC will be colorized with mIRC colors."""))
def configure(advanced):
from questions import something, anything, yn, output
2004-04-13 07:18:17 +02:00
channel = ''
while not channel:
try:
2004-04-13 07:18:17 +02:00
channel = anything('Which channel would you like to send log '
'messages too?')
2004-04-13 07:18:17 +02:00
conf.supybot.plugins.LogToChannel.channel.set(channel)
except registry.InvalidRegistryValue, e:
output(str(e))
2004-04-13 07:18:17 +02:00
channel = ''
colorized = yn('Would you like these messages to be colored?')
conf.supybot.plugins.LogToChannel.colorized.setValue(colorized)
if advanced:
level = ''
2004-04-13 02:59:35 +02:00
while not level:
try:
level = something('What would you like the minimum priority '
'level to be which will be logged to IRC?')
conf.supybot.plugins.LogToChannel.level.set(level)
except registry.InvalidRegistryValue, e:
output(str(e))
level = ''
class LogToChannel(callbacks.Privmsg):
threaded = True
def __init__(self):
callbacks.Privmsg.__init__(self)
log._logger.addHandler(_ircHandler)
def die(self):
log._logger.removeHandler(_ircHandler)
2004-04-13 07:18:17 +02:00
def do376(self, irc, msg):
channel = self.registryValue('channel')
if channel:
irc.queueMsg(ircmsgs.join(channel))
Class = LogToChannel
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: