Limnoria/plugins/Utilities.py

182 lines
6.0 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.
"""
import plugins
import string
2003-04-11 23:17:37 +02:00
import utils
import ircmsgs
import ircutils
import privmsgs
import callbacks
def configure(onStart, afterConnect, advanced):
from questions import expect, anything, yn
onStart.append('load Utilities')
2003-08-27 20:06:26 +02:00
example = utils.wrapLines("""
<jemfinch> @list Utilities
<supybot> echo, ignore, re, repr, strconcat, strjoin, strlen, strlower, strtranslate, strupper
2003-08-27 20:06:26 +02:00
<jemfinch> @echo foo bar baz
<supybot> foo bar baz
<jemfinch> @ignore foo bar baz
<jemfinch> (he just ignores them; it's useful to run commands in sequence without caring about 'The operation succeeded' responses.)
<jemfinch> @repr "\n"
<supybot> "\n"
<jemfinch> @strjoin + foo bar baz
<supybot> foo+bar+baz
<jemfinch> @strlower FOO BAR BAZ
<supybot> foo bar baz
<jemfinch> @strupper FOO bar baz
<supybot> FOO BAR BAZ
<jemfinch> @strtranslate abc def "abc is easy as 123"
<supybot> def is edsy ds 123
<jemfinch> @strconcat foo bar
""")
2003-03-31 17:55:38 +02:00
class Utilities(callbacks.Privmsg):
def ignore(self, irc, msg, args):
2003-08-22 09:07:15 +02:00
"""takes no arguments
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
def strjoin(self, irc, msg, args):
2003-08-30 06:46:17 +02:00
"""<separator> <string 1> [<string> ...]
Joins all the arguments together with <separator>.
"""
sep = args.pop(0)
irc.reply(msg, sep.join(args))
def strtranslate(self, irc, msg, args):
"""<chars to translate> <chars to replace those with> <text>
Replaces <chars to translate> with <chars to replace those with> in
<text>. The first and second arguments must necessarily be the same
length.
"""
(bad, good, text) = privmsgs.getArgs(args, needed=3)
irc.reply(msg, text.translate(string.maketrans(bad, good)))
def strupper(self, irc, msg, args):
"""<text>
Returns <text> uppercased.
"""
irc.reply(msg, privmsgs.getArgs(args).upper())
def strlower(self, irc, msg, args):
"""<text>
Returns <text> lowercased.
"""
irc.reply(msg, privmsgs.getArgs(args).lower())
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.
2003-08-23 13:34:13 +02:00
irc.reply(msg, str(total))
2003-04-15 17:59:40 +02:00
def repr(self, irc, msg, args):
"""<text>
Returns the text surrounded by double quotes.
"""
text = privmsgs.getArgs(args)
irc.reply(msg, utils.dqrepr(text))
def strconcat(self, irc, msg, args):
2003-08-30 06:46:17 +02:00
"""<string 1> <string 2>
Concatenates two strings. Do keep in mind that this is *not* the same
thing as strjoin "", since if <string 2> contains spaces, they won't be
removed by strconcat.
"""
(first, second) = privmsgs.getArgs(args, needed=2)
irc.reply(msg, first+second)
2003-04-08 09:19:56 +02:00
def echo(self, irc, msg, args):
"""takes any number of arguments
Returns the arguments given it.
"""
2003-09-19 19:25:38 +02:00
irc.reply(msg, ' '.join(args), prefixName=False)
2003-04-08 10:20:48 +02:00
def action(self, irc, msg, args):
"""takes any number of arguments
Returns the arguments given it, but as an action.
"""
irc.queueMsg(ircmsgs.action(ircutils.replyTo(msg), ' '.join(args)))
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
"""
2003-04-11 23:18:55 +02:00
(regexp, text) = privmsgs.getArgs(args, needed=2)
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)
substitution = True
except ValueError:
irc.error(msg, 'Invalid regexp: %s' % e.args[0])
return
if f is None:
irc.error(msg, 'Invalid regexp: %s' % e.args[0])
return
irc.reply(msg, f(text))
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: