mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-12-25 04:02:46 +01:00
LogToIrc: Split into modules, like modern plugins
This commit is contained in:
Valentin Lorentz
parent
d08dd24e43
commit
e9ef8b22c0
59
plugins/LogToIrc/__init__.py
Normal file
59
plugins/LogToIrc/__init__.py
Normal file
@ -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
|
||||
114
plugins/LogToIrc/config.py
Normal file
114
plugins/LogToIrc/config.py
Normal file
@ -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 = ''
|
||||
@ -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
|
||||
36
plugins/LogToIrc/test.py
Normal file
36
plugins/LogToIrc/test.py
Normal file
@ -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:
|
||||
Loading…
Reference in New Issue
Block a user