Limnoria/plugins/Alias.py

258 lines
9.2 KiB
Python

#!/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.
###
"""
Allows 'aliases' for other commands.
"""
import plugins
import re
import sets
import types
import conf
import debug
import utils
import privmsgs
import callbacks
def configure(onStart, afterConnect, advanced):
# This will be called by setup.py to configure this module. onStart and
# afterConnect are both lists. Append to onStart the commands you would
# like to be run when the bot is started; append to afterConnect the
# commands you would like to be run when the bot has finished connecting.
from questions import expect, anything, something, yn
onStart.append('load Alias')
example = utils.wrapLines("""
<jemfinch> @list Alias
<supybot> jemfinch: advogato, alias, debplanet, devshed, freeze, gnome, googlebsd, googlelinux, googlemac, k5, kde, kt, lambda, linuxmag, lj, lwn, nyttech, osnews, pypi, python, slashdot, unalias, unfreeze
<jemfinch> (just pay attention to the freeze/unfreeze and alias/unalias)
<jemfinch> @alias rot26 "rot13 [rot13 $1]"
<supybot> jemfinch: The operation succeeded.
<jemfinch> @rot26 jemfinch
<supybot> jemfinch: jemfinch
<jemfinch> @unalias rot26
<supybot> jemfinch: The operation succeeded.
<jemfinch> @rot26 jemfinch
<jemfinch> (look, Ma! No rot26!)
<Cerlyn> ooohh
<jemfinch> @alias rot26 "rot13 [rot13 $1]"
<supybot> jemfinch: The operation succeeded.
<jemfinch> @freeze rot26
<supybot> jemfinch: The operation succeeded.
<jemfinch> (now's your queue :))
<Cerlyn> @unalias rot26
<supybot> Cerlyn: Error: That alias is frozen.
<Cerlyn> @unalias rot26nothere
<supybot> Cerlyn: Error: There is no such alias.
<Cerlyn> @unfreeze rot26
<supybot> Cerlyn: Error: You don't have the "admin" capability.
<jemfinch> @unfreeze rot26
<supybot> jemfinch: The operation succeeded.
<jemfinch> (now try to remove it :))
<Cerlyn> @unalias rot26
<supybot> Cerlyn: The operation succeeded.
<jemfinch> @rot26 blah blah blah
<jemfinch> (note that it did nothing)
<jemfinch> @help slashdot
<supybot> jemfinch: slashdot <an alias, 0 arguments> (for more help use the morehelp command)
<jemfinch> @morehelp slashdot
<supybot> jemfinch: Alias for 'rsstitles http://slashdot.org/slashdot.rss'
""")
class AliasError(Exception):
pass
class RecursiveAlias(AliasError):
pass
def findAliasCommand(s, alias):
s = re.escape(s)
r = re.compile(r'(?:(^|\[)\s*%s|\|\s*%s)' % (s, s))
return bool(r.search(alias))
dollarRe = re.compile(r'\$(\d+)')
def findBiggestDollar(alias):
dollars = dollarRe.findall(alias)
dollars = map(int, dollars)
dollars.sort()
if dollars:
return dollars[-1]
else:
return 0
atRe = re.compile(r'@(\d+)')
def findBiggestAt(alias):
ats = atRe.findall(alias)
ats = map(int, ats)
ats.sort()
if ats:
return ats[-1]
else:
return 0
def makeNewAlias(name, alias):
if findAliasCommand(name, alias):
raise RecursiveAlias
biggestDollar = findBiggestDollar(alias)
biggestAt = findBiggestAt(alias)
wildcard = '$*' in alias
if biggestAt and wildcard:
raise AliasError, 'Can\'t use $* and optional args (@1, etc.)'
def f(self, irc, msg, args):
alias_ = alias.replace('$nick', msg.nick)
if '$channel' in alias:
channel = privmsgs.getChannel(msg, args)
alias_ = alias_.replace('$channel', channel)
if not wildcard and biggestDollar or biggestAt:
args = privmsgs.getArgs(args, needed=biggestDollar,
optional=biggestAt)
# Gotta have a tuple.
if biggestDollar + biggestAt == 1 and not wildcard:
args = (args,)
def replace(m):
idx = int(m.group(1))
return utils.dqrepr(args[idx-1])
alias_ = dollarRe.sub(replace, alias_)
args = args[biggestDollar:]
alias_ = atRe.sub(replace, alias_)
alias_ = alias_.replace('$*', ' '.join(map(utils.dqrepr, args)))
self.Proxy(irc.irc, msg, callbacks.tokenize(alias_))
f = types.FunctionType(f.func_code, f.func_globals,
name, closure=f.func_closure)
f.__doc__ ='<an alias, %s>\n\nAlias for %r' % \
(utils.nItems(biggestDollar, 'argument'), alias)
return f
class Alias(callbacks.Privmsg):
def __init__(self):
callbacks.Privmsg.__init__(self)
self.frozen = sets.Set()
def freeze(self, irc, msg, args):
"""<alias>
'Freezes' an alias so that no one else can change it.
"""
name = privmsgs.getArgs(args)
name = callbacks.canonicalName(name)
if hasattr(self, name) and self.isCommand(name):
self.frozen.add(name)
irc.reply(msg, conf.replySuccess)
else:
irc.error(msg, 'There is no such alias.')
freeze = privmsgs.checkCapability(freeze, 'admin')
def unfreeze(self, irc, msg, args):
"""<alias>
'Unfreezes' an alias so that people can define new aliases over it.
"""
name = privmsgs.getArgs(args)
name = callbacks.canonicalName(name)
if hasattr(self, name) and self.isCommand(name):
self.frozen.discard(name)
irc.reply(msg, conf.replySuccess)
else:
irc.error(msg, 'There is no such alias.')
unfreeze = privmsgs.checkCapability(unfreeze, 'admin')
_invalidCharsRe = re.compile(r'[\[\]\s]')
def addAlias(self, irc, name, alias, freeze=False):
if self._invalidCharsRe.search(name):
raise AliasError, 'Names cannot contain spaces or square brackets.'
if conf.enablePipeSyntax and '|' in name:
raise AliasError, 'Names cannot contain pipes.'
realName = callbacks.canonicalName(name)
if name != realName:
s = 'That name isn\'t valid. Try %r instead.' % realName
raise AliasError, s
name = realName
cbs = callbacks.findCallbackForCommand(irc, name)
if [cb for cb in cbs if cb != self]:
s = 'A command with the name %r already exists.' % name
raise AliasError, s
if name in self.frozen:
raise AliasError, 'Alias %r is frozen.' % name
try:
f = makeNewAlias(name, alias)
except RecursiveAlias:
raise AliasError, 'You can\'t define a recursive alias.'
setattr(self.__class__, name, f)
if freeze:
self.frozen.add(name)
def removeAlias(self, name, evenIfFrozen=False):
name = callbacks.canonicalName(name)
if hasattr(self, name) and self.isCommand(name):
if evenIfFrozen or name not in self.frozen:
delattr(self.__class__, name)
self.frozen.discard(name)
else:
raise AliasError, 'That alias is frozen.'
else:
raise AliasError, 'There is no such alias.'
def add(self, irc, msg, args):
"""<name> <alias commands>
Defines an alias <name> for the commands <commands>. The <commands>
should be in the standard [command argument [nestedcommand argument]]
format. Underscores can be used to represent arguments to the alias
itself; for instance ...
"""
(name, alias) = privmsgs.getArgs(args, needed=2)
try:
self.addAlias(irc, name, alias)
irc.reply(msg, conf.replySuccess)
except AliasError, e:
irc.error(msg, str(e))
def remove(self, irc, msg, args):
"""<name>
Removes the given alias, if unfrozen.
"""
name = privmsgs.getArgs(args)
try:
self.removeAlias(name)
irc.reply(msg, conf.replySuccess)
except AliasError, e:
irc.error(msg, str(e))
Class = Alias
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: