Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-23 02:49:27 +01:00
Code Issues Projects Releases Wiki Activity

Seperated logging to channels to it's own plugin.

Browse Source 
(...and a couple of smaller changes to log itself)
This commit is contained in:
Stéphan Kochen 2004-04-12 16:08:23 +00:00
parent 9c2611328f
commit 1541f051fd
3 changed files with 175 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

167
plugins/LogToChannel.py Normal file
View File

@ -0,0 +1,167 @@
#!/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.
###
"""
Allows for sending the bot's logging output to channels.
"""
__revision__ = "$Id$"
import plugins
import logging
import log
import conf
import utils
import world
import ircutils
import privmsgs
import registry
import callbacks
class IrcHandler(logging.Handler):
def __init__(self, irc=None):
logging.Handler.__init__(self)
self._irc = irc
def emit(self, record):
try:
if not self._irc.driver.connected:
return
except AttributeError:
return
from ircmsgs import privmsg
for channel in conf.supybot.plugins.LogToChannel.channels():
try:
msg = self.format(record).split('\n')
msg = [line.strip() for line in msg]
msg = ' '.join(msg)
self._irc.queueMsg(privmsg(channel, msg))
except:
self.handleError(record)
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):
if conf.supybot.plugins.LogToChannel.colorized():
fmt = '%s'
if record.levelno == logging.CRITICAL:
fmt = ircutils.bold(ircutils.mircColor('%s', fg='red'))
elif record.levelno == logging.ERROR:
fmt = ircutils.mircColor('%s', fg='red')
elif record.levelno == logging.WARNING:
fmt = ircutils.mircColor('%s', fg='orange')
return fmt % IrcFormatter.format(self, record, *args, **kwargs)
else:
return IrcFormatter.format(self, record, *args, **kwargs)
_ircHandler = IrcHandler(irc=world.ircs[0])
_formatString = '%(name)s: %(levelname)s %(message)s'
_ircFormatter = ColorizedIrcFormatter(_formatString)
_ircHandler.setFormatter(_ircFormatter)
conf.registerPlugin('LogToChannel')
conf.registerGlobalValue(conf.supybot.plugins.LogToChannel, 'level',
log.LogLevel(_ircHandler, logging.WARNING, """Determines what the minimum
priority level logged will be to IRC. See supybot.log.level for possible
values. (NEVER set this to DEBUG!)"""))
conf.supybot.plugins.LogToChannel.level._target = _ircHandler
_ircHandler.setLevel(conf.supybot.plugins.LogToChannel.level())
conf.registerGlobalValue(conf.supybot.plugins.LogToChannel, 'channels',
conf.SpaceSeparatedSetOfChannels('', """Determines which channels 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
channels = ''
while not channels:
try:
channels = anything('Which channels would you like to send log '
'messages too?')
conf.supybot.plugins.LogToChannel.channels.set(channels)
except registry.InvalidRegistryValue, e:
output(str(e))
channels = ''
colorized = yn('Would you like these messages to be colored?')
conf.supybot.plugins.LogToChannel.colorized.setValue(colorized)
if advanced:
level = ''
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)
Class = LogToChannel
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:

1
scripts/supybot
View File

@ -325,7 +325,6 @@ if __name__ == '__main__':
conf.strictRfc = options.strictRfc
irc = irclib.Irc(nick, user, ident, password)
log._ircHandler._irc = irc # This is nasty
callback = Owner.Class()
irc.addCallback(callback)
driver = drivers.newDriver(server, irc)

90
src/log.py
View File

@ -107,28 +107,6 @@ class BetterFileHandler(logging.FileHandler):
self.flush()
class IrcHandler(logging.Handler):
def __init__(self, irc=None):
logging.Handler.__init__(self)
self._irc = irc
def emit(self, record):
try:
if not self._irc.driver.connected:
return
except AttributeError:
return
if ircutils.isChannel(conf.supybot.log.channel()):
from ircmsgs import privmsg
try:
msg = self.format(record).split('\n')
msg = [line.strip() for line in msg]
msg = ' '.join(msg)
self._irc.queueMsg(privmsg(conf.supybot.log.channel(), msg))
except:
self.handleError(record)
class ColorizedFormatter(Formatter):
def formatException(self, (E, e, tb)):
if conf.supybot.log.stdout.colorized():
@ -154,42 +132,6 @@ class ColorizedFormatter(Formatter):
return Formatter.format(self, record, *args, **kwargs)
class IrcFormatter(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.log.channel.colorized():
return ''.join(['\x02\x034',
IrcFormatter.formatException(self, (E, e, tb)),
'\x0F'])
else:
return IrcFormatter.formatException(self, (E, e, tb))
def format(self, record, *args, **kwargs):
if conf.supybot.log.channel.colorized():
color = ''
if record.levelno == logging.CRITICAL:
color = '\x02\x0304'
elif record.levelno == logging.ERROR:
color = '\x0304'
elif record.levelno == logging.WARNING:
color = '\x0307'
return ''.join([color,
IrcFormatter.format(self, record, *args, **kwargs),
'\x0F'])
else:
return IrcFormatter.format(self, record, *args, **kwargs)
# These are public.
formatter = Formatter('%(levelname)s %(asctime)s %(message)s')
pluginFormatter = Formatter('%(levelname)s %(asctime)s %(name)s %(message)s')
@ -281,12 +223,12 @@ class LogLevel(registry.Value):
private=False, showDefault=True, **kwargs):
registry.Value.__init__(self, default, help, private=private,
showDefault=showDefault, **kwargs)
self.target = target
self._target = target
def set(self, s):
s = s.upper()
try:
self.value = getattr(logging, s)
self.target.setLevel(self.value) # _logger defined later.
self._target.setLevel(self.value) # _logger defined later.
except AttributeError:
s = 'Invalid log level: should be one of ' \
'DEBUG, INFO, WARNING, ERROR, or CRITICAL.'
@ -299,15 +241,12 @@ what directory the bot will store its logfiles in."""))
conf.supybot.register('log')
conf.supybot.log.register('level', LogLevel(_logger, logging.INFO,
"""Determines what the minimum priority level logged will be. Valid values are
DEBUG, INFO, WARNING, ERROR, and CRITICAL, in order of increasing
priority."""))
"""Determines what the minimum priority level logged will be to log files.
Valid values are DEBUG, INFO, WARNING, ERROR, and CRITICAL, in order of
increasing priority."""))
conf.supybot.log.register('stdout',
registry.Boolean(True, """Determines whether the bot will log to
stdout."""))
conf.supybot.log.register('channel',
registry.String('', """Determines which channel the bot should
log to or empty if none at all."""))
class BooleanRequiredFalseOnWindows(registry.Boolean):
def set(self, s):
@ -318,9 +257,6 @@ class BooleanRequiredFalseOnWindows(registry.Boolean):
conf.supybot.log.stdout.register('colorized',
BooleanRequiredFalseOnWindows(False, """Determines whether the bot's logs to
stdout (if enabled) will be colorized with ANSI color."""))
conf.supybot.log.channel.register('colorized',
BooleanRequiredFalseOnWindows(False, """Determines whether the bot's logs to
irc (if enabled) will be colorized with mIRC colors."""))
conf.supybot.log.register('timestampFormat',
registry.String('[%d-%b-%Y %H:%M:%S]',
@ -334,12 +270,13 @@ pluginLogDir = os.path.join(conf.supybot.directories.log(), 'plugins')
if not os.path.exists(pluginLogDir):
os.mkdir(pluginLogDir, 0755)
_logger.setLevel(-1)
_handler = BetterFileHandler(os.path.join(conf.supybot.directories.log(),
'misc.log'))
_handler.setFormatter(formatter)
_handler.setLevel(-1)
_handler.setLevel(conf.supybot.log.level())
_logger.addHandler(_handler)
_logger.setLevel(conf.supybot.log.level())
_stdoutHandler = StdoutStreamHandler(sys.stdout)
_formatString = '%(name)s: %(levelname)s %(message)s'
@ -352,16 +289,5 @@ conf.supybot.log.stdout.register('level', LogLevel(_stdoutHandler,
logging.DEBUG, """Determines what the minimum priority level logged will be to
stdout. See supybot.log.level for possible values"""))
_ircHandler = IrcHandler()
_ircFormatter = ColorizedIrcFormatter(_formatString)
_ircHandler.setFormatter(_ircFormatter)
_ircHandler.setLevel(logging.WARNING)
_logger.addHandler(_ircHandler)
conf.supybot.log.channel.register('level', LogLevel(_ircHandler,
logging.WARNING, """Determines what the minimum priority level logged will be
to IRC. See supybot.log.level for possible values.
(NEVER set this to DEBUG!)"""))
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: