mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-12-25 12:12:54 +01:00
Removed! Bwahahaha! LONG LIVE THE REGISTRYcvs remove src/configurable.pycvs remove src/configurable.py
This commit is contained in:
Jeremy Fincher
parent
9cf39dfca4
commit
ca06e32f53
@ -1,322 +0,0 @@
|
|||||||
#!/usr/bin/env python
|
|
||||||
|
|
||||||
###
|
|
||||||
# Copyright (c) 2002, Jeremiah Fincher
|
|
||||||
# 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.
|
|
||||||
###
|
|
||||||
|
|
||||||
__revision__ = "$Id$"
|
|
||||||
|
|
||||||
import os
|
|
||||||
|
|
||||||
import conf
|
|
||||||
import utils
|
|
||||||
import ircdb
|
|
||||||
import ircutils
|
|
||||||
import privmsgs
|
|
||||||
import callbacks
|
|
||||||
|
|
||||||
class Dictionary(object):
|
|
||||||
"""This is a dictionary to handle configuration for individual channels,
|
|
||||||
including a default configuration for channels that haven't modified their
|
|
||||||
configuration from the default.
|
|
||||||
"""
|
|
||||||
def __init__(self, seq):
|
|
||||||
self.helps = {}
|
|
||||||
self.types = {}
|
|
||||||
self.defaults = {}
|
|
||||||
self.originalNames = {}
|
|
||||||
self.unparsedValues = {}
|
|
||||||
self.channels = ircutils.IrcDict()
|
|
||||||
for (name, type, default, help) in seq:
|
|
||||||
if ',' in name:
|
|
||||||
raise ValueError, 'There can be no commas in the name.'
|
|
||||||
original = name
|
|
||||||
name = callbacks.canonicalName(name)
|
|
||||||
self.originalNames[name] = original
|
|
||||||
self.helps[name] = utils.normalizeWhitespace(help)
|
|
||||||
self.types[name] = type
|
|
||||||
self.defaults[name] = default
|
|
||||||
|
|
||||||
def __contains__(self, name):
|
|
||||||
name = callbacks.canonicalName(name)
|
|
||||||
return name in self.defaults
|
|
||||||
|
|
||||||
def get(self, name, channel=None):
|
|
||||||
name = callbacks.canonicalName(name)
|
|
||||||
if channel is not None:
|
|
||||||
try:
|
|
||||||
return self.channels[channel][name]
|
|
||||||
except KeyError:
|
|
||||||
return self.defaults[name]
|
|
||||||
else:
|
|
||||||
return self.defaults[name]
|
|
||||||
|
|
||||||
def getDefault(self, name):
|
|
||||||
name = callbacks.canonicalName(name)
|
|
||||||
return self.defaults[name]
|
|
||||||
|
|
||||||
def getChannels(self, name):
|
|
||||||
name = callbacks.canonicalName(name)
|
|
||||||
d = ircutils.IrcDict()
|
|
||||||
for (channel, names) in self.channels.iteritems():
|
|
||||||
if name in names:
|
|
||||||
d[channel] = names[name]
|
|
||||||
return d
|
|
||||||
|
|
||||||
def set(self, name, value, channel=None):
|
|
||||||
name = callbacks.canonicalName(name)
|
|
||||||
if name not in self.originalNames:
|
|
||||||
raise KeyError, name
|
|
||||||
if ',' in name:
|
|
||||||
raise ValueError, 'There can be no commas in the name.'
|
|
||||||
self.unparsedValues[(channel, name)] = value
|
|
||||||
if channel is not None:
|
|
||||||
d = self.channels.setdefault(channel, {})
|
|
||||||
d[name] = self.types[name](value)
|
|
||||||
else:
|
|
||||||
self.defaults[name] = self.types[name](value)
|
|
||||||
|
|
||||||
def help(self, name):
|
|
||||||
return self.helps[callbacks.canonicalName(name)]
|
|
||||||
|
|
||||||
def names(self):
|
|
||||||
L = self.originalNames.values()
|
|
||||||
L.sort()
|
|
||||||
return L
|
|
||||||
|
|
||||||
class Error(TypeError):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def BoolType(s):
|
|
||||||
s = s.lower()
|
|
||||||
if s in ('true', 'enable', 'on'):
|
|
||||||
return True
|
|
||||||
elif s in ('false', 'disable', 'off'):
|
|
||||||
return False
|
|
||||||
else:
|
|
||||||
s = 'Value must be one of on/off/true/false/enable/disable.'
|
|
||||||
raise Error, s
|
|
||||||
|
|
||||||
def StrType(s):
|
|
||||||
if s and s[0] not in '\'"' and s[-1] not in '\'"':
|
|
||||||
s = repr(s)
|
|
||||||
try:
|
|
||||||
v = utils.safeEval(s)
|
|
||||||
if type(v) is not str:
|
|
||||||
raise ValueError
|
|
||||||
except ValueError: # This catches the utils.safeEval(s) errors too.
|
|
||||||
raise Error, 'Value must be a string.'
|
|
||||||
return v
|
|
||||||
|
|
||||||
def NoSpacesStrType(s):
|
|
||||||
try:
|
|
||||||
s = StrType(s)
|
|
||||||
if len(s.split(None, 1)) > 1:
|
|
||||||
raise Error
|
|
||||||
return s
|
|
||||||
except Error:
|
|
||||||
raise Error, 'Value must be a string with no space characters.'
|
|
||||||
|
|
||||||
def SpaceSurroundedStrType(s):
|
|
||||||
s = StrType(s)
|
|
||||||
if s.lstrip() == s:
|
|
||||||
s = ' ' + s
|
|
||||||
if s.rstrip() == s:
|
|
||||||
s += ' '
|
|
||||||
return s
|
|
||||||
|
|
||||||
def RegexpStrType(s):
|
|
||||||
try:
|
|
||||||
s = StrType(s)
|
|
||||||
r = utils.perlReToPythonRe(s)
|
|
||||||
return r
|
|
||||||
except ValueError, e:
|
|
||||||
raise Error, 'Value must be a valid regular expression: %s' % e
|
|
||||||
except Error:
|
|
||||||
raise Error, 'Value must be a valid regular expression.'
|
|
||||||
|
|
||||||
def RegexpOrNoneStrType(s):
|
|
||||||
try:
|
|
||||||
if not s:
|
|
||||||
return None
|
|
||||||
else:
|
|
||||||
return RegexpStrType(s)
|
|
||||||
except Error:
|
|
||||||
raise Error, 'Value must be a valid regular expression or the ' \
|
|
||||||
'empty string, representing nothing.'
|
|
||||||
|
|
||||||
def IntType(s):
|
|
||||||
try:
|
|
||||||
return int(s)
|
|
||||||
except ValueError:
|
|
||||||
raise Error, 'Value must be an integer.'
|
|
||||||
|
|
||||||
def PositiveIntType(s):
|
|
||||||
try:
|
|
||||||
i = IntType(s)
|
|
||||||
if i > 0:
|
|
||||||
return i
|
|
||||||
else:
|
|
||||||
raise Error
|
|
||||||
except Error:
|
|
||||||
raise Error, 'Value must be a positive integer.'
|
|
||||||
|
|
||||||
def SpaceSeparatedStrListType(s):
|
|
||||||
try:
|
|
||||||
L = []
|
|
||||||
for s in s.split():
|
|
||||||
L.append(StrType(s))
|
|
||||||
return L
|
|
||||||
except Error:
|
|
||||||
raise Error, 'Value must be a space-separated list of strings.'
|
|
||||||
|
|
||||||
|
|
||||||
class Mixin(object):
|
|
||||||
"""A mixin class to provide a "config" command that can be consistent
|
|
||||||
across all plugins, in order to unify the configuration for each plugin.
|
|
||||||
|
|
||||||
Plugins subclassing this should have a "configurables" attribute which is
|
|
||||||
a ConfigurableDictionary initialized with a list of 4-tuples of
|
|
||||||
(name, type, default, help). Name is the string name of the config
|
|
||||||
variable; type is a function taking a string and returning some value of
|
|
||||||
the type the variable is supposed to be; default is the default value the
|
|
||||||
variable should take on; help is a string that'll be returned to describe
|
|
||||||
the purpose of the config variable.
|
|
||||||
"""
|
|
||||||
def __init__(self):
|
|
||||||
className = self.__class__.__name__
|
|
||||||
self.filename = os.path.join(conf.supybot.directories.conf(),
|
|
||||||
'%s-configurable'%className)
|
|
||||||
if os.path.exists(self.filename):
|
|
||||||
fd = file(self.filename)
|
|
||||||
for line in fd:
|
|
||||||
line = line.rstrip()
|
|
||||||
(channel, name, value) = line.split(',', 2)
|
|
||||||
try:
|
|
||||||
# The eval here is to turn from "'foo'" to 'foo'.
|
|
||||||
value = eval(value)
|
|
||||||
except Exception, e:
|
|
||||||
self.log.error('Invalid configurable line: %r', line)
|
|
||||||
continue
|
|
||||||
try:
|
|
||||||
if channel == 'global':
|
|
||||||
try:
|
|
||||||
self.globalConfigurables.set(name, value)
|
|
||||||
except AttributeError:
|
|
||||||
s = 'Attempt to set non-existent global ' \
|
|
||||||
'configurable %s' % value
|
|
||||||
self.log.warning(s, name)
|
|
||||||
else:
|
|
||||||
if channel == 'default':
|
|
||||||
channel = None
|
|
||||||
else:
|
|
||||||
assert ircutils.isChannel(channel)
|
|
||||||
self.configurables.set(name, value, channel)
|
|
||||||
except Error, e: # Type error conversion.
|
|
||||||
s = 'Couldn\'t type-convert configurable %s: %s'
|
|
||||||
self.log.warning(s, name, e)
|
|
||||||
except KeyError, e:
|
|
||||||
s = 'Configurable variable %s doesn\'t exist anymore.'
|
|
||||||
self.log.warning(s, name)
|
|
||||||
|
|
||||||
def die(self):
|
|
||||||
fd = file(self.filename, 'w')
|
|
||||||
def flushDictionary(d):
|
|
||||||
L = d.unparsedValues.items()
|
|
||||||
L.sort()
|
|
||||||
for ((channel, name), value) in L:
|
|
||||||
if channel is None:
|
|
||||||
channel = 'default'
|
|
||||||
name = d.originalNames[name]
|
|
||||||
fd.write('%s,%s,%r\n' % (channel, name, value))
|
|
||||||
if hasattr(self, 'globalConfigurables'):
|
|
||||||
flushDictionary(self.globalConfigurables)
|
|
||||||
flushDictionary(self.configurables)
|
|
||||||
fd.close()
|
|
||||||
|
|
||||||
def configurableishnessify(self, irc, msg, args):
|
|
||||||
"""[<channel>] [<name>] [<value>]
|
|
||||||
|
|
||||||
Sets the value of config variable <name> to <value> on <channel>. If
|
|
||||||
<name> is given but <value> is not, returns the help and current value
|
|
||||||
for <name>. If neither <name> nor <value> is given, returns the valid
|
|
||||||
config variables for this plugin. <channel> is only necessary if the
|
|
||||||
message isn't sent in the channel itself.
|
|
||||||
"""
|
|
||||||
if not args: # They want a list of the configurables.
|
|
||||||
names = self.configurables.names()
|
|
||||||
if hasattr(self, 'globalConfigurables'):
|
|
||||||
names.extend(self.globalConfigurables.names())
|
|
||||||
names.sort()
|
|
||||||
irc.reply(utils.commaAndify(names))
|
|
||||||
else:
|
|
||||||
try:
|
|
||||||
channel = privmsgs.getChannel(msg, args)
|
|
||||||
capability = ircdb.makeChannelCapability(channel, 'op')
|
|
||||||
except callbacks.Error:
|
|
||||||
channel = None
|
|
||||||
capability = 'admin'
|
|
||||||
(name, value) = privmsgs.getArgs(args, required=1, optional=1)
|
|
||||||
def help(configurables):
|
|
||||||
s = configurables.help(name)
|
|
||||||
value = configurables.get(name, channel)
|
|
||||||
s = '%s (Current value: %r)' % (s, value)
|
|
||||||
irc.reply(s)
|
|
||||||
if name in self.configurables:
|
|
||||||
if value:
|
|
||||||
if ircdb.checkCapability(msg.prefix, capability):
|
|
||||||
try:
|
|
||||||
self.configurables.set(name, value, channel)
|
|
||||||
irc.replySuccess()
|
|
||||||
except Error, e:
|
|
||||||
irc.error(str(e))
|
|
||||||
else:
|
|
||||||
irc.errorNoCapability(capability)
|
|
||||||
else:
|
|
||||||
help(self.configurables)
|
|
||||||
elif hasattr(self, 'globalConfigurables') and \
|
|
||||||
name in self.globalConfigurables:
|
|
||||||
if value:
|
|
||||||
if ircdb.checkCapability(msg.prefix, 'admin'):
|
|
||||||
try:
|
|
||||||
self.globalConfigurables.set(name, value, channel)
|
|
||||||
irc.replySuccess()
|
|
||||||
except Error, e:
|
|
||||||
irc.error(str(e))
|
|
||||||
else:
|
|
||||||
s = '%s is a global capability, and requires ' \
|
|
||||||
'the "admin" capability.'
|
|
||||||
irc.error(s)
|
|
||||||
else:
|
|
||||||
help(self.globalConfigurables)
|
|
||||||
else:
|
|
||||||
irc.error('There is no config variable %r' % name)
|
|
||||||
|
|
||||||
|
|
||||||
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user