Limnoria/src/commands.py

796 lines
26 KiB
Python
Raw Normal View History

###
# Copyright (c) 2002-2004, 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.
###
"""
Includes wrappers for commands.
"""
__revision__ = "$Id$"
import supybot.fix as fix
import time
import types
2004-10-19 18:43:09 +02:00
import getopt
import threading
2004-09-28 09:10:27 +02:00
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.webutils as webutils
import supybot.callbacks as callbacks
import supybot.structures as structures
###
# Non-arg wrappers -- these just change the behavior of a command without
# changing the arguments given to it.
###
# Thread has to be a non-arg wrapper because by the time we're parsing and
# validating arguments, we're inside the function we'd want to thread.
def thread(f):
"""Makes sure a command spawns a thread when called."""
def newf(self, irc, msg, args, *L, **kwargs):
2004-09-30 06:14:44 +02:00
if world.isMainThread():
t = callbacks.CommandThread(target=irc._callCommand,
args=(f.func_name, self),
kwargs=kwargs)
t.start()
else:
f(self, irc, msg, args, *L, **kwargs)
return utils.changeFunctionName(newf, f.func_name, f.__doc__)
2004-09-30 06:14:44 +02:00
class UrlSnarfThread(world.SupyThread):
def __init__(self, *args, **kwargs):
assert 'url' in kwargs
kwargs['name'] = 'Thread #%s (for snarfing %s)' % \
(world.threadsSpawned, kwargs.pop('url'))
2004-09-30 06:14:44 +02:00
super(UrlSnarfThread, self).__init__(*args, **kwargs)
self.setDaemon(True)
def run(self):
try:
super(UrlSnarfThread, self).run()
except webutils.WebError, e:
log.debug('Exception in urlSnarfer: %s' % utils.exnToString(e))
class SnarfQueue(ircutils.FloodQueue):
timeout = conf.supybot.snarfThrottle
def key(self, channel):
return channel
_snarfed = SnarfQueue()
class SnarfIrc(object):
def __init__(self, irc, channel, url):
self.irc = irc
self.url = url
self.channel = channel
def __getattr__(self, attr):
return getattr(self.irc, attr)
def reply(self, *args, **kwargs):
_snarfed.enqueue(self.channel, self.url)
return self.irc.reply(*args, **kwargs)
# This lock is used to serialize the calls to snarfers, so
# earlier snarfers are guaranteed to beat out later snarfers.
_snarfLock = threading.Lock()
def urlSnarfer(f):
"""Protects the snarfer from loops (with other bots) and whatnot."""
def newf(self, irc, msg, match, *L, **kwargs):
url = match.group(0)
channel = msg.args[0]
2004-10-15 13:18:55 +02:00
if not irc.isChannel(channel):
return
if ircdb.channels.getChannel(channel).lobotomized:
self.log.info('Not snarfing in %s: lobotomized.', channel)
return
if _snarfed.has(channel, url):
self.log.info('Throttling snarf of %s in %s.', url, channel)
return
irc = SnarfIrc(irc, channel, url)
def doSnarf():
_snarfLock.acquire()
try:
if msg.repliedTo:
self.log.debug('Not snarfing, msg is already repliedTo.')
return
f(self, irc, msg, match, *L, **kwargs)
finally:
_snarfLock.release()
if threading.currentThread() is not world.mainThread:
doSnarf()
else:
L = list(L)
t = UrlSnarfThread(target=doSnarf, url=url)
t.start()
newf = utils.changeFunctionName(newf, f.func_name, f.__doc__)
return newf
###
# Converters, which take irc, msg, args, and a state object, and build up the
# validated and converted args for the method in state.args.
###
2004-09-28 09:10:27 +02:00
# This is just so we can centralize this, since it may change.
def _int(s):
2004-10-02 19:31:58 +02:00
base = 10
if s.startswith('0x'):
base = 16
s = s[2:]
elif s.startswith('0b'):
base = 2
s = s[2:]
elif s.startswith('0') and len(s) > 1:
base = 8
s = s[1:]
try:
return int(s, base)
except ValueError:
if base == 10:
return int(float(s))
else:
raise
2004-09-28 09:10:27 +02:00
2004-09-30 06:14:44 +02:00
def getInt(irc, msg, args, state, type='integer', p=None):
try:
2004-09-28 09:10:27 +02:00
i = _int(args[0])
2004-10-19 14:13:41 +02:00
if p is not None:
if not p(i):
irc.errorInvalid(type, args[0])
state.args.append(i)
2004-09-28 09:10:27 +02:00
del args[0]
except ValueError:
2004-09-30 06:14:44 +02:00
irc.errorInvalid(type, args[0])
2004-09-30 09:43:24 +02:00
def getNonInt(irc, msg, args, state, type='non-integer value'):
try:
i = _int(args[0])
irc.errorInvalid(type, args[0])
except ValueError:
state.args.append(args.pop(0))
def getFloat(irc, msg, args, state, type='floating point number'):
2004-09-30 09:43:24 +02:00
try:
2004-10-03 11:03:34 +02:00
state.args.append(float(args[0]))
2004-09-30 09:43:24 +02:00
del args[0]
except ValueError:
irc.errorInvalid(type, args[0])
2004-09-30 09:43:24 +02:00
2004-09-28 09:10:27 +02:00
def getPositiveInt(irc, msg, args, state, *L):
getInt(irc, msg, args, state,
p=lambda i: i>0, type='positive integer', *L)
2004-09-28 09:10:27 +02:00
def getNonNegativeInt(irc, msg, args, state, *L):
getInt(irc, msg, args, state,
p=lambda i: i>=0, type='non-negative integer', *L)
2004-09-28 09:10:27 +02:00
def getIndex(irc, msg, args, state):
getInt(irc, msg, args, state, type='index')
if state.args[-1] > 0:
state.args[-1] -= 1
2004-10-01 23:27:22 +02:00
def getId(irc, msg, args, state, kind=None):
type = 'id'
2004-10-23 22:32:29 +02:00
if kind is not None and not kind.endswith('id'):
2004-10-01 23:27:22 +02:00
type = kind + ' id'
2004-10-24 09:35:45 +02:00
original = args[0]
2004-10-23 22:32:29 +02:00
try:
args[0] = args[0].lstrip('#')
getInt(irc, msg, args, state, type=type)
except Exception, e:
args[0] = original
2004-09-28 09:10:27 +02:00
2004-09-30 06:14:44 +02:00
def getExpiry(irc, msg, args, state):
2004-09-28 09:10:27 +02:00
now = int(time.time())
try:
2004-09-28 09:10:27 +02:00
expires = _int(args[0])
if expires:
expires += now
state.args.append(expires)
del args[0]
except ValueError:
2004-09-30 06:14:44 +02:00
irc.errorInvalid('number of seconds', args[0])
2004-09-30 06:14:44 +02:00
def getBoolean(irc, msg, args, state):
2004-09-28 09:10:27 +02:00
try:
state.args.append(utils.toBool(args[0]))
del args[0]
except ValueError:
2004-09-30 06:14:44 +02:00
irc.errorInvalid('boolean', args[0])
2004-09-28 09:10:27 +02:00
def getChannelDb(irc, msg, args, state, **kwargs):
if not conf.supybot.databases.plugins.channelSpecific():
2004-09-28 09:10:27 +02:00
state.args.append(None)
state.channel = None
else:
2004-09-28 09:10:27 +02:00
getChannel(irc, msg, args, state, **kwargs)
2004-09-28 09:10:27 +02:00
def getHaveOp(irc, msg, args, state, action='do that'):
if state.channel not in irc.state.channels:
irc.error('I\'m not even in %s.' % state.channel, Raise=True)
if irc.nick not in irc.state.channels[state.channel].ops:
irc.error('I need to be opped to %s.' % action, Raise=True)
2004-09-28 09:10:27 +02:00
def validChannel(irc, msg, args, state):
2004-10-15 13:18:55 +02:00
if irc.isChannel(args[0]):
2004-09-28 09:10:27 +02:00
state.args.append(args.pop(0))
else:
2004-09-28 09:10:27 +02:00
irc.errorInvalid('channel', args[0])
2004-09-28 09:10:27 +02:00
def getHostmask(irc, msg, args, state):
if ircutils.isUserHostmask(args[0]):
2004-09-28 09:10:27 +02:00
state.args.append(args.pop(0))
else:
try:
2004-09-28 09:10:27 +02:00
hostmask = irc.state.nickToHostmask(args[0])
state.args.append(hostmask)
del args[0]
except KeyError:
2004-09-28 09:10:27 +02:00
irc.errorInvalid('nick or hostmask', args[0])
2004-09-28 09:10:27 +02:00
def getBanmask(irc, msg, args, state):
getHostmask(irc, msg, args, state)
# XXX Channel-specific stuff.
state.args[-1] = ircutils.banmask(state.args[-1])
def getUser(irc, msg, args, state):
try:
2004-09-28 09:10:27 +02:00
state.args.append(ircdb.users.getUser(msg.prefix))
except KeyError:
irc.errorNotRegistered(Raise=True)
2004-09-28 09:10:27 +02:00
def getOtherUser(irc, msg, args, state):
try:
2004-09-28 09:10:27 +02:00
state.args.append(ircdb.users.getUser(args[0]))
del args[0]
except KeyError:
try:
2004-09-28 09:10:27 +02:00
getHostmask(irc, msg, args, state)
hostmask = state.args.pop()
state.args.append(ircdb.users.getUser(hostmask))
except (KeyError, IndexError, callbacks.Error):
2004-10-19 18:43:09 +02:00
# XXX We should eventually give the user here.
irc.errorNoUser()
def _getRe(f):
2004-09-28 09:10:27 +02:00
def get(irc, msg, args, state):
original = args[:]
s = args.pop(0)
def isRe(s):
try:
_ = f(s)
return True
except ValueError:
return False
2004-09-28 09:10:27 +02:00
try:
2004-10-19 18:43:09 +02:00
while len(s) < 512 and not isRe(s):
2004-09-28 09:10:27 +02:00
s += ' ' + args.pop(0)
2004-10-19 18:43:09 +02:00
if len(s) < 512:
state.args.append(f(s))
else:
2004-10-22 21:50:32 +02:00
irc.errorInvalid('regular expression', s)
2004-09-28 09:10:27 +02:00
except IndexError:
args[:] = original
2004-10-22 21:50:32 +02:00
irc.errorInvalid('regular expression', s)
return get
getMatcher = _getRe(utils.perlReToPythonRe)
getReplacer = _getRe(utils.perlReToReplacer)
2004-09-28 09:10:27 +02:00
def getNick(irc, msg, args, state):
if ircutils.isNick(args[0]):
if 'nicklen' in irc.state.supported:
2004-09-28 09:10:27 +02:00
if len(args[0]) > irc.state.supported['nicklen']:
2004-10-19 14:01:33 +02:00
irc.errorInvalid('nick', args[0],
2004-09-28 09:10:27 +02:00
'That nick is too long for this server.')
state.args.append(args.pop(0))
else:
2004-09-28 09:10:27 +02:00
irc.errorInvalid('nick', s)
2004-10-02 22:12:48 +02:00
def getSeenNick(irc, msg, args, state, errmsg=None):
try:
_ = irc.state.nickToHostmask(args[0])
state.args.append(args.pop(0))
except KeyError:
if errmsg is None:
errmsg = 'I haven\'t seen %s.' % args[0]
irc.error(errmsg)
2004-10-02 22:12:48 +02:00
2004-09-28 09:10:27 +02:00
def getChannel(irc, msg, args, state):
2004-10-15 13:18:55 +02:00
if args and irc.isChannel(args[0]):
channel = args.pop(0)
2004-10-15 13:18:55 +02:00
elif irc.isChannel(msg.args[0]):
channel = msg.args[0]
else:
2004-09-28 09:10:27 +02:00
state.log.debug('Raising ArgumentError because there is no channel.')
raise callbacks.ArgumentError
2004-09-28 09:10:27 +02:00
state.channel = channel
state.args.append(channel)
2004-10-02 04:21:26 +02:00
def inChannel(irc, msg, args, state):
if not state.channel:
getChannel(irc, msg, args, state)
2004-10-02 04:21:26 +02:00
if state.channel not in irc.state.channels:
irc.error('I\'m not in %s.' % state.channel, Raise=True)
2004-10-15 13:18:55 +02:00
def onlyInChannel(irc, msg, args, state):
if not (irc.isChannel(msg.args[0]) and msg.args[0] in irc.state.channels):
irc.error('This command may only be given in a channel that I am in.',
Raise=True)
else:
state.channel = msg.args[0]
state.args.append(state.channel)
def callerInGivenChannel(irc, msg, args, state):
2004-10-02 22:12:48 +02:00
channel = args[0]
2004-10-15 13:18:55 +02:00
if irc.isChannel(channel):
2004-10-02 22:12:48 +02:00
if channel in irc.state.channels:
if msg.nick in irc.state.channels[channel].users:
state.args.append(args.pop(0))
else:
irc.error('You must be in %s.' % channel, Raise=True)
else:
irc.error('I\'m not in %s.' % channel, Raise=True)
else:
irc.errorInvalid('channel', args[0])
def nickInChannel(irc, msg, args, state):
inChannel(irc, msg, args, state)
if args[0] not in irc.state.channels[state.channel].users:
irc.error('%s is not in %s.' % (args[0], state.channel), Raise=True)
state.args.append(args.pop(0))
2004-09-30 09:43:24 +02:00
def getChannelOrNone(irc, msg, args, state):
try:
getChannel(irc, msg, args, state)
except callbacks.ArgumentError:
state.args.append(None)
2004-09-28 09:10:27 +02:00
def checkChannelCapability(irc, msg, args, state, cap):
if not state.channel:
getChannel(irc, msg, args, state)
2004-09-28 09:10:27 +02:00
cap = ircdb.canonicalCapability(cap)
cap = ircdb.makeChannelCapability(state.channel, cap)
if not ircdb.checkCapability(msg.prefix, cap):
irc.errorNoCapability(cap, Raise=True)
2004-09-28 09:10:27 +02:00
def getLowered(irc, msg, args, state):
state.args.append(ircutils.toLower(args.pop(0)))
def getSomething(irc, msg, args, state, errorMsg=None, p=None):
if p is None:
p = lambda _: True
if not args[0] or not p(args[0]):
if errorMsg is None:
errorMsg = 'You must not give the empty string as an argument.'
irc.error(errorMsg, Raise=True)
else:
state.args.append(args.pop(0))
def getSomethingNoSpaces(irc, msg, args, state, *L):
def p(s):
return len(s.split(None, 1)) == 1
getSomething(irc, msg, args, state, p=p, *L)
2004-09-28 09:10:27 +02:00
def private(irc, msg, args, state):
2004-10-15 13:18:55 +02:00
if irc.isChannel(msg.args[0]):
2004-09-28 09:10:27 +02:00
irc.errorRequiresPrivacy(Raise=True)
2004-10-02 19:31:58 +02:00
def public(irc, msg, args, state, errmsg=None):
2004-10-15 13:18:55 +02:00
if not irc.isChannel(msg.args[0]):
2004-10-02 19:31:58 +02:00
if errmsg is None:
errmsg = 'This message must be sent in a channel.'
irc.error(errmsg, Raise=True)
2004-09-28 09:10:27 +02:00
def checkCapability(irc, msg, args, state, cap):
cap = ircdb.canonicalCapability(cap)
if not ircdb.checkCapability(msg.prefix, cap):
irc.errorNoCapability(cap, Raise=True)
2004-09-28 09:10:27 +02:00
def anything(irc, msg, args, state):
state.args.append(args.pop(0))
def getGlob(irc, msg, args, state):
glob = args.pop(0)
if '*' not in glob and '?' not in glob:
glob = '*%s*' % glob
state.args.append(glob)
def getUrl(irc, msg, args, state):
if webutils.urlRe.match(args[0]):
state.args.append(args.pop(0))
else:
irc.errorInvalid('url', args[0])
2004-10-01 23:27:22 +02:00
2004-10-23 22:54:28 +02:00
def getHttpUrl(irc, msg, args, state):
if webutils.urlRe.match(args[0]) and args[0].startswith('http://'):
state.args.append(args.pop(0))
else:
irc.errorInvalid('http url', args[0])
2004-10-01 23:27:22 +02:00
def getNow(irc, msg, args, state):
state.args.append(int(time.time()))
def getCommandName(irc, msg, args, state):
state.args.append(callbacks.canonicalName(args.pop(0)))
2004-10-02 19:31:58 +02:00
def getIp(irc, msg, args, state):
if utils.isIP(args[0]):
state.args.append(args.pop(0))
else:
irc.errorInvalid('ip', args[0])
def getLetter(irc, msg, args, state):
if len(args[0]) == 1:
state.args.append(args.pop(0))
else:
irc.errorInvalid('letter', args[0])
def getMatch(irc, msg, args, state, regexp, errmsg):
m = regexp.search(args[0])
if m is not None:
state.args.append(m)
del args[0]
else:
irc.error(errmsg, Raise=True)
def getLiteral(irc, msg, args, state, literals, errmsg=None):
if isinstance(literals, basestring):
literals = (literals,)
if args[0] in literals:
state.args.append(args.pop(0))
elif errmsg is not None:
irc.error(errmsg, Raise=True)
else:
raise callbacks.ArgumentError
2004-10-02 22:12:48 +02:00
def getPlugin(irc, msg, args, state, require=True):
cb = irc.getCallback(args[0])
if cb is not None:
state.args.append(cb)
del args[0]
elif require:
irc.errorInvalid('plugin', args[0])
else:
state.args.append(None)
def getIrcColor(irc, msg, args, state):
if args[0] in ircutils.mircColors:
state.args.append(ircutils.mircColors[args.pop(0)])
else:
irc.errorInvalid('irc color')
2004-09-28 09:10:27 +02:00
wrappers = ircutils.IrcDict({
'id': getId,
2004-10-02 19:31:58 +02:00
'ip': getIp,
'int': getInt,
'index': getIndex,
'color': getIrcColor,
2004-10-01 23:27:22 +02:00
'now': getNow,
'url': getUrl,
2004-10-23 22:54:28 +02:00
'httpUrl': getHttpUrl,
2004-09-30 09:43:24 +02:00
'float': getFloat,
'nonInt': getNonInt,
2004-09-28 09:10:27 +02:00
'positiveInt': getPositiveInt,
'nonNegativeInt': getNonNegativeInt,
2004-10-02 19:31:58 +02:00
'letter': getLetter,
2004-09-28 09:10:27 +02:00
'haveOp': getHaveOp,
'expiry': getExpiry,
2004-10-02 19:31:58 +02:00
'literal': getLiteral,
'nick': getNick,
2004-10-02 22:12:48 +02:00
'seenNick': getSeenNick,
2004-09-23 00:43:23 +02:00
'channel': getChannel,
2004-10-02 04:21:26 +02:00
'inChannel': inChannel,
2004-10-15 13:18:55 +02:00
'onlyInChannel': onlyInChannel,
'nickInChannel': nickInChannel,
'callerInGivenChannel': callerInGivenChannel,
'plugin': getPlugin,
'boolean': getBoolean,
'lowered': getLowered,
2004-09-28 09:10:27 +02:00
'anything': anything,
'something': getSomething,
'filename': getSomething, # XXX Check for validity.
'commandName': getCommandName,
'glob': getGlob,
2004-10-01 23:27:22 +02:00
'text': anything,
2004-09-28 09:10:27 +02:00
'somethingWithoutSpaces': getSomethingNoSpaces,
'capability': getSomethingNoSpaces,
2004-09-23 00:43:23 +02:00
'channelDb': getChannelDb,
'hostmask': getHostmask,
'banmask': getBanmask,
'user': getUser,
'matches': getMatch,
2004-10-02 19:31:58 +02:00
'public': public,
2004-09-28 09:10:27 +02:00
'private': private,
'otherUser': getOtherUser,
'regexpMatcher': getMatcher,
'validChannel': validChannel,
'regexpReplacer': getReplacer,
2004-09-28 09:10:27 +02:00
'checkCapability': checkCapability,
'checkChannelCapability': checkChannelCapability,
})
2004-10-03 11:03:34 +02:00
def addConverter(name, wrapper):
2004-10-02 04:21:26 +02:00
wrappers[name] = wrapper
class UnknownConverter(KeyError):
pass
2004-10-03 11:03:34 +02:00
def getConverter(name):
try:
return wrappers[name]
except KeyError, e:
raise UnknownConverter, str(e)
2004-10-03 11:03:34 +02:00
def callConverter(name, irc, msg, args, state, *L):
getConverter(name)(irc, msg, args, state, *L)
###
# Contexts. These determine what the nature of conversions is; whether they're
# defaulted, or many of them are allowed, etc. Contexts should be reusable;
# i.e., they should not maintain state between calls.
###
def contextify(spec):
if not isinstance(spec, context):
spec = context(spec)
return spec
2004-10-02 22:12:48 +02:00
def setDefault(state, default):
if callable(default):
state.args.append(default())
else:
state.args.append(default)
2004-10-03 11:03:34 +02:00
class context(object):
def __init__(self, spec):
self.args = ()
2004-10-12 13:58:08 +02:00
self.spec = spec # for repr
2004-10-03 11:03:34 +02:00
if isinstance(spec, tuple):
assert spec, 'tuple spec must not be empty.'
self.args = spec[1:]
self.converter = getConverter(spec[0])
elif spec is None:
self.converter = getConverter('anything')
else:
assert isinstance(spec, basestring)
self.args = ()
self.converter = getConverter(spec)
def __call__(self, irc, msg, args, state):
if args and not (state.types or state.allowExtra):
# We're the last context/type, we should combine the remaining
# arguments into one string.
args[:] = [' '.join(args)]
2004-10-12 13:58:08 +02:00
log.debug('args before %r: %r', self, args)
2004-10-03 11:03:34 +02:00
self.converter(irc, msg, args, state, *self.args)
2004-10-12 13:58:08 +02:00
log.debug('args after %r: %r', self, args)
def __repr__(self):
return '<%s for %s>' % (self.__class__.__name__, self.spec)
2004-10-03 11:03:34 +02:00
# additional means: Look for this (and make sure it's of this type). If
# there are no arguments for us to check, then use our default.
2004-10-04 00:38:10 +02:00
class additional(context):
# XXX We should allow contexts as well as specs.
2004-10-04 00:38:10 +02:00
def __init__(self, spec, default=None):
self.__parent = super(additional, self)
self.__parent.__init__(spec)
self.default = default
def __call__(self, irc, msg, args, state):
try:
self.__parent.__call__(irc, msg, args, state)
except IndexError:
log.debug('Got IndexError, returning default.')
setDefault(state, self.default)
2004-10-04 00:38:10 +02:00
# optional means: Look for this, but if it's not the type I'm expecting or
# there are no arguments for us to check, then use the default value.
2004-10-04 00:38:10 +02:00
class optional(additional):
def __call__(self, irc, msg, args, state):
try:
super(optional, self).__call__(irc, msg, args, state)
2004-10-04 00:38:10 +02:00
except (callbacks.ArgumentError, callbacks.Error), e:
log.debug('Got %s, returning default.', utils.exnToString(e))
setDefault(state, self.default)
2004-10-04 00:38:10 +02:00
class any(context):
def __call__(self, irc, msg, args, state):
st = state.essence()
st.types = ["something so context.__call__ won't combineRest."]
2004-10-04 00:38:10 +02:00
try:
while args:
super(any, self).__call__(irc, msg, args, st)
except IndexError:
pass
state.args.append(st.args)
2004-10-04 00:38:10 +02:00
class many(any):
def __call__(self, irc, msg, args, state):
super(many, self).__call__(irc, msg, args, state)
if not state.args[-1]:
state.args.pop()
raise callbacks.ArgumentError
2004-10-19 18:43:09 +02:00
class first(context):
def __init__(self, *specs, **kw):
if 'default' in kw:
self.default = kw.pop('default')
assert not kw, 'Bad kwargs for first.__init__'
self.specs = map(contextify, specs)
def __call__(self, irc, msg, args, state):
for spec in self.specs:
try:
spec(irc, msg, args, state)
return
except Exception, e:
continue
if hasattr(self, 'default'):
state.args.append(self.default)
else:
raise e
2004-10-24 05:53:56 +02:00
class reverse(context):
def __call__(self, irc, msg, args, state):
args[:] = args[::-1]
2004-10-24 05:53:56 +02:00
super(reverse, self).__call__(irc, msg, args, state)
args[:] = args[::-1]
2004-10-19 18:43:09 +02:00
class getopts(context):
"""The empty string indicates that no argument is taken; None indicates
that there is no converter for the argument."""
def __init__(self, getopts):
2004-10-12 13:58:08 +02:00
self.spec = getopts # for repr
self.getopts = {}
self.getoptL = []
for (name, spec) in getopts.iteritems():
if spec == '':
self.getoptL.append(name)
self.getopts[name] = None
2004-09-28 09:10:27 +02:00
else:
self.getoptL.append(name + '=')
self.getopts[name] = contextify(spec)
2004-10-12 13:58:08 +02:00
log.debug('getopts: %r', self.getopts)
log.debug('getoptL: %r', self.getoptL)
def __call__(self, irc, msg, args, state):
2004-10-12 13:58:08 +02:00
log.debug('args before %r: %r', self, args)
(optlist, rest) = getopt.getopt(args, '', self.getoptL)
getopts = []
for (opt, arg) in optlist:
opt = opt[2:] # Strip --
2004-10-12 13:58:08 +02:00
log.debug('opt: %r, arg: %r', opt, arg)
context = self.getopts[opt]
if context is not None:
st = state.essence()
2004-10-12 13:58:08 +02:00
context(irc, msg, [arg], st)
assert len(st.args) == 1
getopts.append((opt, st.args[0]))
else:
getopts.append((opt, True))
state.args.append(getopts)
2004-10-12 13:58:08 +02:00
args[:] = rest
log.debug('args after %r: %r', self, args)
# XXX Not ready.
class compose(context):
def __init__(self, *specs):
self.spec = specs
self.specs = list(specs)
utils.mapinto(contextify, self.specs)
def __call__(self, irc, msg, args, state):
st = state.essence()
for context in self.specs:
context(irc, msg, args, st)
args = st.args
state.args.extend(st.args)
###
# This is our state object, passed to converters along with irc, msg, and args.
###
class State(object):
log = log
def __init__(self, types):
self.args = []
self.kwargs = {}
self.types = types
self.channel = None
def essence(self):
st = State(self.types)
for (attr, value) in self.__dict__.iteritems():
if attr not in ('args', 'kwargs', 'channel'):
setattr(st, attr, value)
return st
def __repr__(self):
return '%s(args=%r, kwargs=%r, channel=%r)' % (self.__class__.__name__,
self.args, self.kwargs,
self.channel)
###
# This is a compiled Spec object.
###
class Spec(object):
def _state(self, types, attrs={}):
st = State(types)
st.__dict__.update(attrs)
st.allowExtra = self.allowExtra
return st
def __init__(self, types, allowExtra=False):
self.types = types
self.allowExtra = allowExtra
utils.mapinto(contextify, self.types)
def __call__(self, irc, msg, args, stateAttrs={}):
2004-10-15 13:18:55 +02:00
state = self._state(self.types[:], stateAttrs)
while state.types:
context = state.types.pop(0)
try:
context(irc, msg, args, state)
except IndexError:
raise callbacks.ArgumentError
if args and not state.allowExtra:
log.debug('args and not self.allowExtra: %r', args)
raise callbacks.ArgumentError
return state
# This is used below, but we need to rename it so its name isn't
# shadowed by our locals.
def wrap(f, specList=[], **kw):
spec = Spec(specList, **kw)
def newf(self, irc, msg, args, **kwargs):
state = spec(irc, msg, args, stateAttrs={'cb': self, 'log': self.log})
f(self, irc, msg, args, *state.args, **state.kwargs)
return utils.changeFunctionName(newf, f.func_name, f.__doc__)
2004-10-19 18:43:09 +02:00
__all__ = ['wrap', 'context', 'additional', 'optional', 'any', 'compose',
2004-10-24 05:53:56 +02:00
'Spec', 'first', 'urlSnarfer', 'thread', 'reverse',
'many', 'getopts', 'getConverter', 'addConverter', 'callConverter']
if world.testing:
__all__.append('Spec')
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: