2
# -*- coding: UTF-8 -*-
3
# Copyright (c) 2005, Jeremiah Fincher
6
# Redistribution and use in source and binary forms, with or without
7
# modification, are permitted provided that the following conditions are met:
9
# * Redistributions of source code must retain the above copyright notice,
10
# this list of conditions, and the following disclaimer.
11
# * Redistributions in binary form must reproduce the above copyright notice,
12
# this list of conditions, and the following disclaimer in the
13
# documentation and/or other materials provided with the distribution.
14
# * Neither the name of the author of this software nor the name of
15
# contributors to this software may be used to endorse or promote products
16
# derived from this software without specific prior written consent.
18
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28
# POSSIBILITY OF SUCH DAMAGE.
31
import supybot.conf as conf
32
import supybot.registry as registry
34
def configure(advanced):
35
# This will be called by supybot to configure this module. advanced is
36
# a bool that specifies whether the user identified himself as an advanced
37
# user or not. You should effect your configuration by manipulating the
38
# registry as appropriate.
39
from supybot.questions import expect, anything, something, yn
40
conf.registerPlugin('ChannelLogger', True)
42
ChannelLogger = conf.registerPlugin('ChannelLogger')
43
conf.registerChannelValue(ChannelLogger, 'enable',
44
registry.Boolean(False, """Разрешить ChannelLogger на канале"""))
45
conf.registerGlobalValue(ChannelLogger, 'flushImmediately',
46
registry.Boolean(False, """Determines whether channel logfiles will be
47
flushed anytime they're written to, rather than being buffered by the
48
operating system."""))
49
conf.registerChannelValue(ChannelLogger, 'stripFormatting',
50
registry.Boolean(True, """Determines whether formatting characters (such
51
as bolding, color, etc.) are removed when writing the logs to disk."""))
52
conf.registerChannelValue(ChannelLogger, 'timestamp',
53
registry.Boolean(True, """Determines whether the logs for this channel are
54
timestamped with the timestamp in supybot.log.timestampFormat."""))
55
conf.registerChannelValue(ChannelLogger, 'noLogPrefix',
56
registry.String('[nolog]', """Determines what string a message should be
57
prefixed with in order not to be logged. If you don't want any such
58
prefix, just set it to the empty string."""))
59
conf.registerChannelValue(ChannelLogger, 'rotateLogs',
60
registry.Boolean(False, """Determines whether the bot will automatically
61
rotate the logs for this channel. The bot will rotate logs when the
62
timestamp for the log changes. The timestamp is set according to
63
the 'filenameTimestamp' configuration variable."""))
64
conf.registerChannelValue(ChannelLogger, 'filenameTimestamp',
65
registry.String('%d-%a-%Y', """Determines how to represent the timestamp
66
used for the filename in rotated logs. When this timestamp changes, the
67
old logfiles will be closed and a new one started. The format characters
68
for the timestamp are in the time.strftime docs at python.org. In order
69
for your logs to be rotated, you'll also have to enable
70
supybot.plugins.ChannelLogger.rotateLogs."""))
72
conf.registerGlobalValue(ChannelLogger, 'directories',
73
registry.Boolean(True, """Determines whether the bot will partition its
74
channel logs into separate directories based on different criteria."""))
75
conf.registerGlobalValue(ChannelLogger.directories, 'network',
76
registry.Boolean(True, """Determines whether the bot will use a network
77
directory if using directories."""))
78
conf.registerGlobalValue(ChannelLogger.directories, 'channel',
79
registry.Boolean(True, """Determines whether the bot will use a channel
80
directory if using directories."""))
81
conf.registerGlobalValue(ChannelLogger.directories, 'timestamp',
82
registry.Boolean(False, """Determines whether the bot will use a timestamp
83
(determined by supybot.plugins.ChannelLogger.directories.timestamp.format)
84
if using directories."""))
85
conf.registerGlobalValue(ChannelLogger.directories.timestamp, 'format',
86
registry.String('%B', """Determines what timestamp format will be used in
87
the directory stucture for channel logs if
88
supybot.plugins.ChannelLogger.directories.timestamp is True."""))
90
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
added
removed
ubuntuhelp/ubuntubot/plugins/ChannelLogger/config.py
