From d08dd24e43ea262fd45001ea4cfba0f095442188 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Wed, 10 Mar 2021 22:24:12 +0100 Subject: [PATCH 1/7] LogToIrc: Resurect from from before the Darcs migration. Last commit: da614f55615f5afbda54df378825de12a420eece --- plugins/LogToIrc.py | 237 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 237 insertions(+) create mode 100644 plugins/LogToIrc.py diff --git a/plugins/LogToIrc.py b/plugins/LogToIrc.py new file mode 100644 index 000000000..ce5499298 --- /dev/null +++ b/plugins/LogToIrc.py @@ -0,0 +1,237 @@ +# -*- 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 or users. +""" + +__revision__ = "$Id$" + +import supybot.plugins as plugins + +import logging +import os.path +from itertools import imap + +import supybot.log as log +import supybot.conf as conf +import supybot.utils as utils +import supybot.world as world +import supybot.ircdb as ircdb +import supybot.ircmsgs as ircmsgs +import supybot.ircutils as ircutils +import supybot.privmsgs as privmsgs +import supybot.registry as registry +import supybot.callbacks as callbacks + + +class IrcHandler(logging.Handler): + def emit(self, record): + config = conf.supybot.plugins.LogToIrc + try: + s = utils.normalizeWhitespace(self.format(record)) + except: + self.handleError(record) + return + for target in config.targets(): + msgmaker = ircmsgs.privmsg + if config.notice() and not ircutils.isChannel(target): + msgmaker = ircmsgs.notice + msg = msgmaker(target, s) + for irc in world.ircs: + try: + if not irc.driver.connected: + continue + except AttributeError, e: + print '*** AttributeError, shouldn\'t happen: %s' % e + continue + networks = conf.supybot.plugins.LogToIrc.networks() + if networks and irc.network not in networks: + continue + msgOk = True + if target in irc.state.channels: + channel = irc.state.channels[target] + for modeChar in config.channelModesRequired(): + if modeChar not in channel.modes: + msgOk = False + else: + capability = config.userCapabilityRequired() + if capability: + try: + hostmask = irc.state.nicksToHostmasks[target] + except KeyError: + msgOk = False + continue + if not ircdb.checkCapability(hostmask, capability): + msgOk = False + if msgOk: + # We use sendMsg here because queueMsg can cause some + # WARNING logs, which might be sent here, which might + # cause some more WARNING logs, etc. and that would be + # baaaaaad. + irc.sendMsg(msg) + else: + print '*** Not sending to %s' % utils.quoted(target) + + +class IrcFormatter(log.Formatter): + def formatException(self, (E, e, tb)): + L = [utils.exnToString(e), '::'] + frames = utils.stackTrace(frame=tb.tb_frame).split() + L.extend(frames) + del tb + while sum(imap(len, L)) > 350: + L.pop() + return ' '.join(L) + + +class ColorizedIrcFormatter(IrcFormatter): + def formatException(self, (E, e, tb)): + if conf.supybot.plugins.LogToIrc.color(): + s = IrcFormatter.formatException(self, (E, e, tb)) + return ircutils.mircColor(s, fg='red') + else: + return IrcFormatter.formatException(self, (E, e, tb)) + + def format(self, record, *args, **kwargs): + s = IrcFormatter.format(self, record, *args, **kwargs) + if conf.supybot.plugins.LogToIrc.color(): + if record.levelno == logging.CRITICAL: + s = ircutils.bold(ircutils.bold(s)) + elif record.levelno == logging.ERROR: + s = ircutils.mircColor(s, fg='red') + elif record.levelno == logging.WARNING: + s = ircutils.mircColor(s, fg='yellow') + return s + + +_ircHandler = IrcHandler() +_formatString = '%(name)s: %(levelname)s %(message)s' +_ircFormatter = ColorizedIrcFormatter(_formatString) +_ircHandler.setFormatter(_ircFormatter) + +class IrcLogLevel(log.ValidLogLevel): + """Value must be one of INFO, WARNING, ERROR, or CRITICAL.""" + minimumLevel = logging.INFO + def setValue(self, v): + log.ValidLogLevel.setValue(self, v) + _ircHandler.setLevel(self.value) + +class ValidChannelOrNick(registry.String): + """Value must be a valid channel or a valid nick.""" + def setValue(self, v): + if not (ircutils.isNick(v) or ircutils.isChannel(v)): + self.error() + registry.String.setValue(self, v) + +class Targets(registry.SpaceSeparatedListOfStrings): + Value = ValidChannelOrNick + +conf.registerPlugin('LogToIrc') +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'level', + IrcLogLevel(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.LogToIrc, 'targets', + Targets([], """Determines which channels/nicks the bot should + log to. If no channels/nicks are set, this plugin will effectively be + turned off.""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'networks', + registry.SpaceSeparatedSetOfStrings([], """Determines what networks the + bot should log to. If no networks are set, the bot will log on one network + (whichever happens to be around at the time it feels like logging).""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'channelModesRequired', + registry.String('s', """Determines what channel modes a channel will be + required to have for the bot to log to the channel. If this string is + empty, no modes will be checked.""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, + 'userCapabilityRequired', registry.String('owner', """Determines what + capability is required for the bot to log to in private messages to the + user. If this is empty, there will be no capability that's checked.""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'color', + registry.Boolean(False, """Determines whether the bot's logs to IRC will be + colorized with mIRC colors.""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'notice', + registry.Boolean(False, """Determines whether the bot's logs to IRC will be + sent via NOTICE instead of PRIVMSG. Channels will always be PRIVMSGed, + regardless of this variable; NOTICEs will only be used if this variable is + True and the target is a nick, not a channel.""")) + +def configure(advanced): + from supybot.questions import something, anything, yn, output + output("""Here you can set which channels and who the bot has to send log + messages to. Note that by default in order to log to a channel + the channel has to have mode +s set. Logging to a user requires + the user to have the Owner capability.""") + targets = '' + while not targets: + try: + targets = anything('Which channels or users would you like to ' + 'send log messages to?') + conf.supybot.plugins.LogToIrc.targets.set(targets) + except registry.InvalidRegistryValue, e: + output(str(e)) + targets = '' + colorized = yn('Would you like these messages to be colored?') + conf.supybot.plugins.LogToIrc.color.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.LogToIrc.level.set(level) + except registry.InvalidRegistryValue, e: + output(str(e)) + level = '' + + +class LogToIrc(callbacks.Privmsg): + threaded = True + def __init__(self): + callbacks.Privmsg.__init__(self) + log._logger.addHandler(_ircHandler) + + def die(self): + log._logger.removeHandler(_ircHandler) + + def do376(self, irc, msg): + targets = self.registryValue('targets') + for target in targets: + if irc.isChannel(target): + networkGroup = conf.supybot.networks.get(irc.network) + irc.queueMsg(networkGroup.channels.join(target)) + do377 = do422 = do376 + + +Class = LogToIrc + +# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: From e9ef8b22c084ac990f8a5ab2d0c611f7dd142dc3 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Wed, 10 Mar 2021 22:35:35 +0100 Subject: [PATCH 2/7] LogToIrc: Split into modules, like modern plugins --- plugins/LogToIrc/__init__.py | 59 ++++++++++ plugins/LogToIrc/config.py | 114 ++++++++++++++++++++ plugins/{LogToIrc.py => LogToIrc/plugin.py} | 78 -------------- plugins/LogToIrc/test.py | 36 +++++++ 4 files changed, 209 insertions(+), 78 deletions(-) create mode 100644 plugins/LogToIrc/__init__.py create mode 100644 plugins/LogToIrc/config.py rename plugins/{LogToIrc.py => LogToIrc/plugin.py} (61%) create mode 100644 plugins/LogToIrc/test.py diff --git a/plugins/LogToIrc/__init__.py b/plugins/LogToIrc/__init__.py new file mode 100644 index 000000000..d3467667c --- /dev/null +++ b/plugins/LogToIrc/__init__.py @@ -0,0 +1,59 @@ +# -*- 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 or users. +""" + +import supybot +import supybot.world as world + +__author__ = supybot.authors.jemfinch +__maintainer__ = supybot.authors.limnoria_core + +# Use this for the version of this plugin. You may wish to put a CVS keyword +# in here if you\'re keeping the plugin in CVS or some similar system. +__version__ = "%%VERSION%%" + +# This is a dictionary mapping supybot.Author instances to lists of +# contributions. +__contributors__ = {} + +from . import config +from . import plugin +from importlib import reload +reload(plugin) # In case we're being reloaded. + +if world.testing: + from . import test + +Class = plugin.Class +configure = config.configure diff --git a/plugins/LogToIrc/config.py b/plugins/LogToIrc/config.py new file mode 100644 index 000000000..4f4ceed9e --- /dev/null +++ b/plugins/LogToIrc/config.py @@ -0,0 +1,114 @@ +### +# 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. +### + +import logging +from itertools import imap + +import supybot.log as log +import supybot.conf as conf +import supybot.ircutils as ircutils +import supybot.registry as registry + +from .plugin import _ircHandler + + +class IrcLogLevel(log.ValidLogLevel): + """Value must be one of INFO, WARNING, ERROR, or CRITICAL.""" + minimumLevel = logging.INFO + def setValue(self, v): + log.ValidLogLevel.setValue(self, v) + _ircHandler.setLevel(self.value) + +class ValidChannelOrNick(registry.String): + """Value must be a valid channel or a valid nick.""" + def setValue(self, v): + if not (ircutils.isNick(v) or ircutils.isChannel(v)): + self.error() + registry.String.setValue(self, v) + +class Targets(registry.SpaceSeparatedListOfStrings): + Value = ValidChannelOrNick + +conf.registerPlugin('LogToIrc') +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'level', + IrcLogLevel(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.LogToIrc, 'targets', + Targets([], """Determines which channels/nicks the bot should + log to. If no channels/nicks are set, this plugin will effectively be + turned off.""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'networks', + registry.SpaceSeparatedSetOfStrings([], """Determines what networks the + bot should log to. If no networks are set, the bot will log on one network + (whichever happens to be around at the time it feels like logging).""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'channelModesRequired', + registry.String('s', """Determines what channel modes a channel will be + required to have for the bot to log to the channel. If this string is + empty, no modes will be checked.""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, + 'userCapabilityRequired', registry.String('owner', """Determines what + capability is required for the bot to log to in private messages to the + user. If this is empty, there will be no capability that's checked.""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'color', + registry.Boolean(False, """Determines whether the bot's logs to IRC will be + colorized with mIRC colors.""")) +conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'notice', + registry.Boolean(False, """Determines whether the bot's logs to IRC will be + sent via NOTICE instead of PRIVMSG. Channels will always be PRIVMSGed, + regardless of this variable; NOTICEs will only be used if this variable is + True and the target is a nick, not a channel.""")) + +def configure(advanced): + from supybot.questions import something, anything, yn, output + output("""Here you can set which channels and who the bot has to send log + messages to. Note that by default in order to log to a channel + the channel has to have mode +s set. Logging to a user requires + the user to have the Owner capability.""") + targets = '' + while not targets: + try: + targets = anything('Which channels or users would you like to ' + 'send log messages to?') + conf.supybot.plugins.LogToIrc.targets.set(targets) + except registry.InvalidRegistryValue, e: + output(str(e)) + targets = '' + colorized = yn('Would you like these messages to be colored?') + conf.supybot.plugins.LogToIrc.color.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.LogToIrc.level.set(level) + except registry.InvalidRegistryValue, e: + output(str(e)) + level = '' diff --git a/plugins/LogToIrc.py b/plugins/LogToIrc/plugin.py similarity index 61% rename from plugins/LogToIrc.py rename to plugins/LogToIrc/plugin.py index ce5499298..4a5d36ab5 100644 --- a/plugins/LogToIrc.py +++ b/plugins/LogToIrc/plugin.py @@ -33,13 +33,10 @@ Allows for sending the bot's logging output to channels or users. """ -__revision__ = "$Id$" - import supybot.plugins as plugins import logging import os.path -from itertools import imap import supybot.log as log import supybot.conf as conf @@ -138,81 +135,6 @@ _formatString = '%(name)s: %(levelname)s %(message)s' _ircFormatter = ColorizedIrcFormatter(_formatString) _ircHandler.setFormatter(_ircFormatter) -class IrcLogLevel(log.ValidLogLevel): - """Value must be one of INFO, WARNING, ERROR, or CRITICAL.""" - minimumLevel = logging.INFO - def setValue(self, v): - log.ValidLogLevel.setValue(self, v) - _ircHandler.setLevel(self.value) - -class ValidChannelOrNick(registry.String): - """Value must be a valid channel or a valid nick.""" - def setValue(self, v): - if not (ircutils.isNick(v) or ircutils.isChannel(v)): - self.error() - registry.String.setValue(self, v) - -class Targets(registry.SpaceSeparatedListOfStrings): - Value = ValidChannelOrNick - -conf.registerPlugin('LogToIrc') -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'level', - IrcLogLevel(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.LogToIrc, 'targets', - Targets([], """Determines which channels/nicks the bot should - log to. If no channels/nicks are set, this plugin will effectively be - turned off.""")) -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'networks', - registry.SpaceSeparatedSetOfStrings([], """Determines what networks the - bot should log to. If no networks are set, the bot will log on one network - (whichever happens to be around at the time it feels like logging).""")) -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'channelModesRequired', - registry.String('s', """Determines what channel modes a channel will be - required to have for the bot to log to the channel. If this string is - empty, no modes will be checked.""")) -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, - 'userCapabilityRequired', registry.String('owner', """Determines what - capability is required for the bot to log to in private messages to the - user. If this is empty, there will be no capability that's checked.""")) -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'color', - registry.Boolean(False, """Determines whether the bot's logs to IRC will be - colorized with mIRC colors.""")) -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'notice', - registry.Boolean(False, """Determines whether the bot's logs to IRC will be - sent via NOTICE instead of PRIVMSG. Channels will always be PRIVMSGed, - regardless of this variable; NOTICEs will only be used if this variable is - True and the target is a nick, not a channel.""")) - -def configure(advanced): - from supybot.questions import something, anything, yn, output - output("""Here you can set which channels and who the bot has to send log - messages to. Note that by default in order to log to a channel - the channel has to have mode +s set. Logging to a user requires - the user to have the Owner capability.""") - targets = '' - while not targets: - try: - targets = anything('Which channels or users would you like to ' - 'send log messages to?') - conf.supybot.plugins.LogToIrc.targets.set(targets) - except registry.InvalidRegistryValue, e: - output(str(e)) - targets = '' - colorized = yn('Would you like these messages to be colored?') - conf.supybot.plugins.LogToIrc.color.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.LogToIrc.level.set(level) - except registry.InvalidRegistryValue, e: - output(str(e)) - level = '' - class LogToIrc(callbacks.Privmsg): threaded = True diff --git a/plugins/LogToIrc/test.py b/plugins/LogToIrc/test.py new file mode 100644 index 000000000..718612c9b --- /dev/null +++ b/plugins/LogToIrc/test.py @@ -0,0 +1,36 @@ +### +# 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. +### + +from supybot.test import * + +class LogToIrcTestCase(PluginTestCase): + plugins = ('LogToIrc',) + + +# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: From 436277a9edcbdc952eada4a40bda3de5514a158b Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Wed, 10 Mar 2021 22:35:59 +0100 Subject: [PATCH 3/7] LogToIrc: Run 2to3 --- plugins/LogToIrc/__init__.py | 3 ++- plugins/LogToIrc/config.py | 6 +++--- plugins/LogToIrc/plugin.py | 14 ++++++++------ 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/plugins/LogToIrc/__init__.py b/plugins/LogToIrc/__init__.py index d3467667c..88d827376 100644 --- a/plugins/LogToIrc/__init__.py +++ b/plugins/LogToIrc/__init__.py @@ -35,6 +35,7 @@ Allows for sending the bot's logging output to channels or users. import supybot import supybot.world as world +import importlib __author__ = supybot.authors.jemfinch __maintainer__ = supybot.authors.limnoria_core @@ -50,7 +51,7 @@ __contributors__ = {} from . import config from . import plugin from importlib import reload -reload(plugin) # In case we're being reloaded. +importlib.reload(plugin) # In case we're being reloaded. if world.testing: from . import test diff --git a/plugins/LogToIrc/config.py b/plugins/LogToIrc/config.py index 4f4ceed9e..8ded7cbd5 100644 --- a/plugins/LogToIrc/config.py +++ b/plugins/LogToIrc/config.py @@ -28,7 +28,7 @@ ### import logging -from itertools import imap + import supybot.log as log import supybot.conf as conf @@ -97,7 +97,7 @@ def configure(advanced): targets = anything('Which channels or users would you like to ' 'send log messages to?') conf.supybot.plugins.LogToIrc.targets.set(targets) - except registry.InvalidRegistryValue, e: + except registry.InvalidRegistryValue as e: output(str(e)) targets = '' colorized = yn('Would you like these messages to be colored?') @@ -109,6 +109,6 @@ def configure(advanced): level = something('What would you like the minimum priority ' 'level to be which will be logged to IRC?') conf.supybot.plugins.LogToIrc.level.set(level) - except registry.InvalidRegistryValue, e: + except registry.InvalidRegistryValue as e: output(str(e)) level = '' diff --git a/plugins/LogToIrc/plugin.py b/plugins/LogToIrc/plugin.py index 4a5d36ab5..1f9f417ca 100644 --- a/plugins/LogToIrc/plugin.py +++ b/plugins/LogToIrc/plugin.py @@ -67,8 +67,8 @@ class IrcHandler(logging.Handler): try: if not irc.driver.connected: continue - except AttributeError, e: - print '*** AttributeError, shouldn\'t happen: %s' % e + except AttributeError as e: + print('*** AttributeError, shouldn\'t happen: %s' % e) continue networks = conf.supybot.plugins.LogToIrc.networks() if networks and irc.network not in networks: @@ -96,22 +96,24 @@ class IrcHandler(logging.Handler): # baaaaaad. irc.sendMsg(msg) else: - print '*** Not sending to %s' % utils.quoted(target) + print('*** Not sending to %s' % utils.quoted(target)) class IrcFormatter(log.Formatter): - def formatException(self, (E, e, tb)): + def formatException(self, xxx_todo_changeme): + (E, e, tb) = xxx_todo_changeme L = [utils.exnToString(e), '::'] frames = utils.stackTrace(frame=tb.tb_frame).split() L.extend(frames) del tb - while sum(imap(len, L)) > 350: + while sum(map(len, L)) > 350: L.pop() return ' '.join(L) class ColorizedIrcFormatter(IrcFormatter): - def formatException(self, (E, e, tb)): + def formatException(self, xxx_todo_changeme1): + (E, e, tb) = xxx_todo_changeme1 if conf.supybot.plugins.LogToIrc.color(): s = IrcFormatter.formatException(self, (E, e, tb)) return ircutils.mircColor(s, fg='red') From 6d880c9a6f8bb7f84e002b5ef4027b9830bc62a2 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Thu, 11 Mar 2021 00:38:37 +0100 Subject: [PATCH 4/7] LogToIrc: Move IrcHandler to its own module, it shouldn't be reloaded. --- plugins/LogToIrc/config.py | 3 +- plugins/LogToIrc/handler.py | 135 ++++++++++++++++++++++++++++++++++++ plugins/LogToIrc/plugin.py | 91 +----------------------- 3 files changed, 137 insertions(+), 92 deletions(-) create mode 100644 plugins/LogToIrc/handler.py diff --git a/plugins/LogToIrc/config.py b/plugins/LogToIrc/config.py index 8ded7cbd5..39c2afd18 100644 --- a/plugins/LogToIrc/config.py +++ b/plugins/LogToIrc/config.py @@ -29,13 +29,12 @@ import logging - import supybot.log as log import supybot.conf as conf import supybot.ircutils as ircutils import supybot.registry as registry -from .plugin import _ircHandler +from .handler import _ircHandler class IrcLogLevel(log.ValidLogLevel): diff --git a/plugins/LogToIrc/handler.py b/plugins/LogToIrc/handler.py new file mode 100644 index 000000000..814c126dc --- /dev/null +++ b/plugins/LogToIrc/handler.py @@ -0,0 +1,135 @@ +### +# 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. +### + +"""This module MUST NOT be reloaded after config.py, because it would cause +the log level to be unset, ie. to log EVERYTHING, and that's bad +""" + +import logging + + +import supybot.log as log +import supybot.conf as conf +import supybot.utils as utils +import supybot.world as world +import supybot.ircmsgs as ircmsgs +import supybot.ircutils as ircutils +import supybot.registry as registry + + +class IrcHandler(logging.Handler): + def emit(self, record): + config = conf.supybot.plugins.LogToIrc + try: + s = utils.str.normalizeWhitespace(self.format(record)) + except: + self.handleError(record) + return + for target in config.targets(): + msgmaker = ircmsgs.privmsg + if config.notice() and not ircutils.isChannel(target): + msgmaker = ircmsgs.notice + msg = msgmaker(target, s) + for irc in world.ircs: + try: + if not irc.driver.connected: + continue + except AttributeError as e: + print('*** AttributeError, shouldn\'t happen: %s' % e) + continue + networks = conf.supybot.plugins.LogToIrc.networks() + if networks and irc.network not in networks: + continue + msgOk = True + if target in irc.state.channels: + channel = irc.state.channels[target] + for modeChar in config.channelModesRequired(): + if modeChar not in channel.modes: + msgOk = False + else: + capability = config.userCapabilityRequired() + if capability: + try: + hostmask = irc.state.nicksToHostmasks[target] + except KeyError: + msgOk = False + continue + if not ircdb.checkCapability(hostmask, capability): + msgOk = False + if msgOk: + # We use sendMsg here because queueMsg can cause some + # WARNING logs, which might be sent here, which might + # cause some more WARNING logs, etc. and that would be + # baaaaaad. + irc.sendMsg(msg) + else: + print('*** Not sending to %s @ %s' % + (utils.str.quoted(target), irc.network)) + + +class IrcFormatter(log.Formatter): + def formatException(self, xxx_todo_changeme): + (E, e, tb) = xxx_todo_changeme + L = [utils.exnToString(e), '::'] + frames = utils.stackTrace(frame=tb.tb_frame).split() + L.extend(frames) + del tb + while sum(map(len, L)) > 350: + L.pop() + return ' '.join(L) + + +class ColorizedIrcFormatter(IrcFormatter): + def formatException(self, xxx_todo_changeme1): + (E, e, tb) = xxx_todo_changeme1 + if conf.supybot.plugins.LogToIrc.color(): + s = IrcFormatter.formatException(self, (E, e, tb)) + return ircutils.mircColor(s, fg='red') + else: + return IrcFormatter.formatException(self, (E, e, tb)) + + def format(self, record, *args, **kwargs): + s = IrcFormatter.format(self, record, *args, **kwargs) + if conf.supybot.plugins.LogToIrc.color(): + if record.levelno == logging.CRITICAL: + s = ircutils.bold(ircutils.bold(s)) + elif record.levelno == logging.ERROR: + s = ircutils.mircColor(s, fg='red') + elif record.levelno == logging.WARNING: + s = ircutils.mircColor(s, fg='yellow') + return s + + +_ircHandler = IrcHandler() +_formatString = '%(name)s: %(levelname)s %(message)s' +_ircFormatter = ColorizedIrcFormatter(_formatString) +_ircHandler.setFormatter(_ircFormatter) + + + diff --git a/plugins/LogToIrc/plugin.py b/plugins/LogToIrc/plugin.py index 1f9f417ca..4729cc962 100644 --- a/plugins/LogToIrc/plugin.py +++ b/plugins/LogToIrc/plugin.py @@ -40,102 +40,13 @@ import os.path import supybot.log as log import supybot.conf as conf -import supybot.utils as utils -import supybot.world as world import supybot.ircdb as ircdb -import supybot.ircmsgs as ircmsgs import supybot.ircutils as ircutils -import supybot.privmsgs as privmsgs import supybot.registry as registry import supybot.callbacks as callbacks -class IrcHandler(logging.Handler): - def emit(self, record): - config = conf.supybot.plugins.LogToIrc - try: - s = utils.normalizeWhitespace(self.format(record)) - except: - self.handleError(record) - return - for target in config.targets(): - msgmaker = ircmsgs.privmsg - if config.notice() and not ircutils.isChannel(target): - msgmaker = ircmsgs.notice - msg = msgmaker(target, s) - for irc in world.ircs: - try: - if not irc.driver.connected: - continue - except AttributeError as e: - print('*** AttributeError, shouldn\'t happen: %s' % e) - continue - networks = conf.supybot.plugins.LogToIrc.networks() - if networks and irc.network not in networks: - continue - msgOk = True - if target in irc.state.channels: - channel = irc.state.channels[target] - for modeChar in config.channelModesRequired(): - if modeChar not in channel.modes: - msgOk = False - else: - capability = config.userCapabilityRequired() - if capability: - try: - hostmask = irc.state.nicksToHostmasks[target] - except KeyError: - msgOk = False - continue - if not ircdb.checkCapability(hostmask, capability): - msgOk = False - if msgOk: - # We use sendMsg here because queueMsg can cause some - # WARNING logs, which might be sent here, which might - # cause some more WARNING logs, etc. and that would be - # baaaaaad. - irc.sendMsg(msg) - else: - print('*** Not sending to %s' % utils.quoted(target)) - - -class IrcFormatter(log.Formatter): - def formatException(self, xxx_todo_changeme): - (E, e, tb) = xxx_todo_changeme - L = [utils.exnToString(e), '::'] - frames = utils.stackTrace(frame=tb.tb_frame).split() - L.extend(frames) - del tb - while sum(map(len, L)) > 350: - L.pop() - return ' '.join(L) - - -class ColorizedIrcFormatter(IrcFormatter): - def formatException(self, xxx_todo_changeme1): - (E, e, tb) = xxx_todo_changeme1 - if conf.supybot.plugins.LogToIrc.color(): - s = IrcFormatter.formatException(self, (E, e, tb)) - return ircutils.mircColor(s, fg='red') - else: - return IrcFormatter.formatException(self, (E, e, tb)) - - def format(self, record, *args, **kwargs): - s = IrcFormatter.format(self, record, *args, **kwargs) - if conf.supybot.plugins.LogToIrc.color(): - if record.levelno == logging.CRITICAL: - s = ircutils.bold(ircutils.bold(s)) - elif record.levelno == logging.ERROR: - s = ircutils.mircColor(s, fg='red') - elif record.levelno == logging.WARNING: - s = ircutils.mircColor(s, fg='yellow') - return s - - -_ircHandler = IrcHandler() -_formatString = '%(name)s: %(levelname)s %(message)s' -_ircFormatter = ColorizedIrcFormatter(_formatString) -_ircHandler.setFormatter(_ircFormatter) +from .handler import _ircHandler class LogToIrc(callbacks.Privmsg): From f0b43329088287d7a4da6c267a98d0e5d28ae898 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Thu, 11 Mar 2021 00:39:50 +0100 Subject: [PATCH 5/7] LogToIrc: Update __init__/die signatures. --- plugins/LogToIrc/plugin.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/plugins/LogToIrc/plugin.py b/plugins/LogToIrc/plugin.py index 4729cc962..53360246d 100644 --- a/plugins/LogToIrc/plugin.py +++ b/plugins/LogToIrc/plugin.py @@ -51,11 +51,13 @@ from .handler import _ircHandler class LogToIrc(callbacks.Privmsg): threaded = True - def __init__(self): - callbacks.Privmsg.__init__(self) + def __init__(self, irc): + self.__parent = super(LogToIrc, self) + self.__parent.__init__(irc) log._logger.addHandler(_ircHandler) def die(self): + self.__parent.die() log._logger.removeHandler(_ircHandler) def do376(self, irc, msg): From 7359ddce90e9fd5ed8572f57879c7b48caf96f8e Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Thu, 11 Mar 2021 00:40:28 +0100 Subject: [PATCH 6/7] LogToIrc: better error handling --- plugins/LogToIrc/handler.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/plugins/LogToIrc/handler.py b/plugins/LogToIrc/handler.py index 814c126dc..f6843eab3 100644 --- a/plugins/LogToIrc/handler.py +++ b/plugins/LogToIrc/handler.py @@ -1,5 +1,6 @@ ### # Copyright (c) 2004, Stéphan Kochen +# Copyright (c) 2021, Valentin Lorentz # All rights reserved. # # Redistribution and use in source and binary forms, with or without @@ -57,11 +58,14 @@ class IrcHandler(logging.Handler): msgmaker = ircmsgs.notice msg = msgmaker(target, s) for irc in world.ircs: + if irc.driver is None: + continue try: if not irc.driver.connected: continue except AttributeError as e: - print('*** AttributeError, shouldn\'t happen: %s' % e) + import traceback + traceback.print_exc() continue networks = conf.supybot.plugins.LogToIrc.networks() if networks and irc.network not in networks: From 54342765cd44a4abd3f4ef4becc6f14343f486d3 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Thu, 11 Mar 2021 20:20:53 +0100 Subject: [PATCH 7/7] LogToIrc: Make variables channel- and network-specific when relevant --- plugins/LogToIrc/config.py | 13 +++++++------ plugins/LogToIrc/handler.py | 24 ++++++++++++++---------- 2 files changed, 21 insertions(+), 16 deletions(-) diff --git a/plugins/LogToIrc/config.py b/plugins/LogToIrc/config.py index 39c2afd18..b39af6189 100644 --- a/plugins/LogToIrc/config.py +++ b/plugins/LogToIrc/config.py @@ -55,11 +55,12 @@ class Targets(registry.SpaceSeparatedListOfStrings): Value = ValidChannelOrNick conf.registerPlugin('LogToIrc') -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'level', +conf.registerChannelValue(conf.supybot.plugins.LogToIrc, 'level', IrcLogLevel(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.LogToIrc, 'targets', + values. DEBUG is disabled due to the large quantity of output."""), + opSettable=False) +conf.registerNetworkValue(conf.supybot.plugins.LogToIrc, 'targets', Targets([], """Determines which channels/nicks the bot should log to. If no channels/nicks are set, this plugin will effectively be turned off.""")) @@ -67,7 +68,7 @@ conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'networks', registry.SpaceSeparatedSetOfStrings([], """Determines what networks the bot should log to. If no networks are set, the bot will log on one network (whichever happens to be around at the time it feels like logging).""")) -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'channelModesRequired', +conf.registerNetworkValue(conf.supybot.plugins.LogToIrc, 'channelModesRequired', registry.String('s', """Determines what channel modes a channel will be required to have for the bot to log to the channel. If this string is empty, no modes will be checked.""")) @@ -75,10 +76,10 @@ conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'userCapabilityRequired', registry.String('owner', """Determines what capability is required for the bot to log to in private messages to the user. If this is empty, there will be no capability that's checked.""")) -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'color', +conf.registerChannelValue(conf.supybot.plugins.LogToIrc, 'color', registry.Boolean(False, """Determines whether the bot's logs to IRC will be colorized with mIRC colors.""")) -conf.registerGlobalValue(conf.supybot.plugins.LogToIrc, 'notice', +conf.registerChannelValue(conf.supybot.plugins.LogToIrc, 'notice', registry.Boolean(False, """Determines whether the bot's logs to IRC will be sent via NOTICE instead of PRIVMSG. Channels will always be PRIVMSGed, regardless of this variable; NOTICEs will only be used if this variable is diff --git a/plugins/LogToIrc/handler.py b/plugins/LogToIrc/handler.py index f6843eab3..d0137d8c4 100644 --- a/plugins/LogToIrc/handler.py +++ b/plugins/LogToIrc/handler.py @@ -52,14 +52,16 @@ class IrcHandler(logging.Handler): except: self.handleError(record) return - for target in config.targets(): - msgmaker = ircmsgs.privmsg - if config.notice() and not ircutils.isChannel(target): - msgmaker = ircmsgs.notice - msg = msgmaker(target, s) - for irc in world.ircs: - if irc.driver is None: - continue + for irc in world.ircs: + network = irc.network + if irc.driver is None: + continue + for target in config.targets.getSpecific(network=irc.network)(): + msgmaker = ircmsgs.privmsg + if config.notice.getSpecific(target, network)() \ + and not irc.isChannel(target): + msgmaker = ircmsgs.notice + msg = msgmaker(target, s) try: if not irc.driver.connected: continue @@ -73,11 +75,13 @@ class IrcHandler(logging.Handler): msgOk = True if target in irc.state.channels: channel = irc.state.channels[target] - for modeChar in config.channelModesRequired(): + modes = config.channelModesRequired.getSpecific( + network=network)() + for modeChar in modes: if modeChar not in channel.modes: msgOk = False else: - capability = config.userCapabilityRequired() + capability = config.userCapabilityRequired.getSpecific() if capability: try: hostmask = irc.state.nicksToHostmasks[target]