mirror of https://github.com/Mikaela/Limnoria.git
104 lines
5.9 KiB
Python
104 lines
5.9 KiB
Python
###
|
|
# Copyright (c) 2005, Jeremiah Fincher
|
|
# Copyright (c) 2009, James McCoy
|
|
# Copyright (c) 2010-2021, Valentin Lorentz
|
|
# 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 supybot.conf as conf
|
|
import supybot.registry as registry
|
|
from supybot.i18n import PluginInternationalization, internationalizeDocstring
|
|
_ = PluginInternationalization('ChannelLogger')
|
|
|
|
def configure(advanced):
|
|
# This will be called by supybot to configure this module. advanced is
|
|
# a bool that specifies whether the user identified themself as an advanced
|
|
# user or not. You should effect your configuration by manipulating the
|
|
# registry as appropriate.
|
|
from supybot.questions import expect, anything, something, yn
|
|
conf.registerPlugin('ChannelLogger', True)
|
|
|
|
ChannelLogger = conf.registerPlugin('ChannelLogger')
|
|
conf.registerChannelValue(ChannelLogger, 'enable',
|
|
registry.Boolean(True, _("""Determines whether logging is enabled.""")))
|
|
conf.registerGlobalValue(ChannelLogger, 'flushImmediately',
|
|
registry.Boolean(True, _("""Determines whether channel logfiles will be
|
|
flushed anytime they're written to, rather than being buffered by the
|
|
operating system.""")))
|
|
conf.registerChannelValue(ChannelLogger, 'showJoinParts',
|
|
registry.Boolean(True, _("""Determines whether joins and parts are logged""")))
|
|
conf.registerChannelValue(ChannelLogger, 'showAway',
|
|
registry.Boolean(True, _("""Determines whether users going away and coming
|
|
back should be logged. This is only supported on networks implementing the
|
|
'away-notify' IRCv3 capability.""")))
|
|
conf.registerChannelValue(ChannelLogger, 'stripFormatting',
|
|
registry.Boolean(True, _("""Determines whether formatting characters (such
|
|
as bolding, color, etc.) are removed when writing the logs to disk.""")))
|
|
conf.registerChannelValue(ChannelLogger, 'timestamp',
|
|
registry.Boolean(True, _("""Determines whether the logs for this channel are
|
|
timestamped with the timestamp in supybot.log.timestampFormat.""")))
|
|
conf.registerChannelValue(ChannelLogger, 'noLogPrefix',
|
|
registry.String('[nolog]', _("""Determines what string a message should be
|
|
prefixed with in order not to be logged. If you don't want any such
|
|
prefix, just set it to the empty string.""")))
|
|
conf.registerChannelValue(ChannelLogger, 'rotateLogs',
|
|
registry.Boolean(False, _("""Determines whether the bot will automatically
|
|
rotate the logs for this channel. The bot will rotate logs when the
|
|
timestamp for the log changes. The timestamp is set according to
|
|
the 'filenameTimestamp' configuration variable.""")))
|
|
conf.registerChannelValue(ChannelLogger, 'filenameTimestamp',
|
|
registry.String('%Y-%m-%d', _("""Determines how to represent the timestamp
|
|
used for the filename in rotated logs. When this timestamp changes, the
|
|
old logfiles will be closed and a new one started. The format characters
|
|
for the timestamp are in the time.strftime docs at python.org. In order
|
|
for your logs to be rotated, you'll also have to enable
|
|
supybot.plugins.ChannelLogger.rotateLogs.""")))
|
|
conf.registerChannelValue(ChannelLogger, 'rewriteRelayed',
|
|
registry.Boolean(False, _("""Determines whether the bot will rewrite
|
|
outgoing relayed messages (eg. from the Relay plugin) to use the original
|
|
nick instead of the bot's nick.""")))
|
|
|
|
conf.registerGlobalValue(ChannelLogger, 'directories',
|
|
registry.Boolean(True, _("""Determines whether the bot will partition its
|
|
channel logs into separate directories based on different criteria.""")))
|
|
conf.registerGlobalValue(ChannelLogger.directories, 'network',
|
|
registry.Boolean(True, _("""Determines whether the bot will use a network
|
|
directory if using directories.""")))
|
|
conf.registerGlobalValue(ChannelLogger.directories, 'channel',
|
|
registry.Boolean(True, _("""Determines whether the bot will use a channel
|
|
directory if using directories.""")))
|
|
conf.registerGlobalValue(ChannelLogger.directories, 'timestamp',
|
|
registry.Boolean(False, _("""Determines whether the bot will use a timestamp
|
|
(determined by supybot.plugins.ChannelLogger.directories.timestamp.format)
|
|
if using directories.""")))
|
|
conf.registerGlobalValue(ChannelLogger.directories.timestamp, 'format',
|
|
registry.String('%B', _("""Determines what timestamp format will be used in
|
|
the directory structure for channel logs if
|
|
supybot.plugins.ChannelLogger.directories.timestamp is True.""")))
|
|
|
|
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
|