Limnoria/plugins/Utilities.py

171 lines
6.1 KiB
Python
Raw Normal View History

#!/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.
###
"""
Various utility commands, mostly useful for manipulating nested commands.
"""
2003-11-25 09:23:47 +01:00
__revision__ = "$Id$"
2004-04-28 08:30:55 +02:00
__author__ = 'Jeremy Fincher (jemfinch) <jemfinch@users.sf.net>'
2003-11-25 09:23:47 +01:00
2004-07-24 07:18:26 +02:00
import supybot.plugins as plugins
import string
2003-04-11 23:17:37 +02:00
2004-07-24 07:18:26 +02:00
import supybot.utils as utils
import supybot.ircmsgs as ircmsgs
import supybot.ircutils as ircutils
import supybot.privmsgs as privmsgs
import supybot.callbacks as callbacks
2003-03-31 17:55:38 +02:00
class Utilities(callbacks.Privmsg):
def ignore(self, irc, msg, args):
2004-04-13 03:49:56 +02:00
"""requires no arguments
2003-08-22 09:07:15 +02:00
2003-08-30 06:46:17 +02:00
Does nothing. Useful sometimes for sequencing commands when you don't
care about their non-error return values.
2003-08-22 09:07:15 +02:00
"""
pass
2003-08-20 18:26:23 +02:00
2004-04-30 08:12:20 +02:00
def reply(self, irc, msg, args):
"""<text>
Replies with <text>. Equivalent to the alias, 'echo $nick: $1'.
"""
text = privmsgs.getArgs(args)
irc.reply(text)
2004-07-21 21:36:35 +02:00
2004-04-13 03:49:56 +02:00
def success(self, irc, msg, args):
2004-04-30 08:12:20 +02:00
"""[<text>]
2004-04-13 03:49:56 +02:00
Does nothing except to reply with a success message. This is useful
when you want to run multiple commands as nested commands, and don't
care about their output as long as they're successful. An error, of
2004-04-30 08:12:20 +02:00
course, will break out of this command. <text>, if given, will be
appended to the end of the success message.
2004-04-13 03:49:56 +02:00
"""
text = privmsgs.getArgs(args, required=0, optional=1)
2004-04-30 08:12:20 +02:00
irc.replySuccess(text)
2004-04-13 03:49:56 +02:00
2004-04-22 05:39:38 +02:00
def last(self, irc, msg, args):
"""<text> [<text> ...]
Returns the last argument given. Useful when you'd like multiple
nested commands to run, but only the output of the last one to be
returned.
"""
if args:
irc.reply(args[-1])
else:
raise callbacks.Error
2004-07-21 21:36:35 +02:00
2003-08-23 13:34:13 +02:00
def strlen(self, irc, msg, args):
2003-08-30 06:46:17 +02:00
"""<text>
Returns the length of <text>.
"""
2003-08-23 13:34:13 +02:00
total = 0
for arg in args:
total += len(arg)
total += len(args)-1 # spaces between the arguments.
irc.reply(str(total))
2003-08-23 13:34:13 +02:00
2003-04-08 09:19:56 +02:00
def echo(self, irc, msg, args):
"""takes any number of arguments
2004-04-14 04:40:44 +02:00
Returns the arguments given it. Uses our standard substitute on the
string(s) given to it; $nick (or $who), $randomNick, $randomInt,
$botnick, $channel, $user, $host, $today, $now, and $randomDate are all
handled appropriately.
2003-04-08 09:19:56 +02:00
"""
if not args:
raise callbacks.ArgumentError
2004-02-26 16:53:45 +01:00
text = privmsgs.getArgs(args)
text = plugins.standardSubstitute(irc, msg, text)
irc.reply(text, prefixName=False)
2003-04-08 10:20:48 +02:00
2003-04-11 23:17:37 +02:00
def re(self, irc, msg, args):
"""<regexp> <text>
2003-08-30 06:46:17 +02:00
If <regexp> is of the form m/regexp/flags, returns the portion of
<text> that matches the regexp. If <regexp> is of the form
s/regexp/replacement/flags, returns the result of applying such a
regexp to <text>
2003-04-11 23:17:37 +02:00
"""
(regexp, text) = privmsgs.getArgs(args, required=2)
self.log.info('re command called with regexp %r from %s' %
(regexp, msg.prefix))
if len(regexp) > 512:
irc.error('Your regexp is just plain too long.')
return
f = None
try:
r = utils.perlReToPythonRe(regexp)
2003-10-21 00:24:08 +02:00
f = lambda s: r.search(s) and r.search(s).group(0) or ''
except ValueError, e:
try:
f = utils.perlReToReplacer(regexp)
2003-11-26 13:39:37 +01:00
except ValueError, e:
irc.error('Invalid regexp: %s' % e.args[0])
return
if f is None:
irc.error('Invalid regexp: %s' % e.args[0])
return
if f('') and len(f(' ')) > len(f(''))+1: # Matches the empty string.
2003-11-26 13:39:37 +01:00
s = 'You probably don\'t want to match the empty string.'
irc.error(s)
2003-11-26 13:39:37 +01:00
else:
irc.reply(f(text))
re = privmsgs.checkCapability(re, 'trusted')
2003-08-20 18:26:23 +02:00
def apply(self, irc, msg, args):
"""<command> <text>
Tokenizes <text> and calls <command> with the resulting arguments.
"""
if not args:
raise callbacks.ArgumentError
command = args.pop(0)
args = [token and token or '""' for token in args]
text = privmsgs.getArgs(args)
commands = command.split()
commands = map(callbacks.canonicalName, commands)
tokens = callbacks.tokenize(text)
allTokens = commands + tokens
print '***', allTokens
Owner = irc.getCallback('Owner')
Owner.processTokens(irc, msg, allTokens)
2004-07-21 21:36:35 +02:00
2003-08-20 18:26:23 +02:00
2003-03-31 17:55:38 +02:00
Class = Utilities
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: