Limnoria/src/Misc.py

545 lines
21 KiB
Python
Raw Normal View History

2003-03-27 07:34:48 +01:00
#!/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.
###
"""
Miscellaneous commands.
"""
2003-11-25 09:38:19 +01:00
__revision__ = "$Id$"
2004-04-28 08:30:55 +02:00
__author__ = 'Jeremy Fincher (jemfinch) <jemfinch@users.sf.net>'
2003-11-25 09:38:19 +01:00
import fix
2003-03-27 07:34:48 +01:00
import os
import sys
import getopt
from itertools import imap, ifilter
2003-03-27 07:34:48 +01:00
import conf
import utils
2004-01-18 09:16:15 +01:00
import ircdb
import irclib
import ircmsgs
import ircutils
2003-03-27 07:34:48 +01:00
import privmsgs
2004-02-07 13:35:58 +01:00
import webutils
2003-03-27 07:34:48 +01:00
import callbacks
2003-10-21 08:03:57 +02:00
class Misc(callbacks.Privmsg):
priority = sys.maxint
def invalidCommand(self, irc, msg, tokens):
2004-01-01 21:18:13 +01:00
self.log.debug('Misc.invalidCommand called (tokens %s)', tokens)
2004-01-18 08:58:26 +01:00
if conf.supybot.reply.whenNotCommand():
command = tokens and tokens[0] or ''
irc.error('%r is not a valid command.' % command)
else:
2004-04-27 19:14:31 +02:00
if tokens:
# echo [] will get us an empty token set, but there's no need
# to log this in that case anyway, it being a nested command.
self.log.info('Not replying to %s, not a command.' % tokens[0])
if not isinstance(irc.irc, irclib.Irc):
irc.reply('[%s]' % ' '.join(tokens))
2003-03-27 07:34:48 +01:00
def list(self, irc, msg, args):
"""[--private] [<module name>]
2003-03-27 07:34:48 +01:00
2003-09-07 06:05:34 +02:00
Lists the commands available in the given plugin. If no plugin is
given, lists the public plugins available. If --private is given,
lists all commands, not just the public ones.
2003-03-27 07:34:48 +01:00
"""
(optlist, rest) = getopt.getopt(args, '', ['private'])
evenPrivate = False
for (option, argument) in optlist:
if option == '--private':
evenPrivate = True
name = privmsgs.getArgs(rest, required=0, optional=1)
2003-12-07 01:13:56 +01:00
name = callbacks.canonicalName(name)
2003-03-27 07:34:48 +01:00
if not name:
2004-04-28 10:42:01 +02:00
def isPublic(cb):
name = cb.name()
return conf.supybot.plugins.get(name).public() or evenPrivate
names = [cb.name() for cb in irc.callbacks if isPublic(cb)]
2003-03-28 08:23:12 +01:00
names.sort()
2004-02-12 05:17:20 +01:00
irc.reply(utils.commaAndify(names))
2003-03-27 07:34:48 +01:00
else:
2003-12-07 01:13:56 +01:00
cb = irc.getCallback(name)
if cb is None:
irc.error('No such plugin %r exists.' % name)
2003-12-07 01:13:56 +01:00
elif isinstance(cb, callbacks.PrivmsgRegexp) or \
not isinstance(cb, callbacks.Privmsg):
irc.error('That plugin exists, but it has no commands. '
'You may wish to check if it has any useful '
'configuration variables with the command '
'"config list supybot.plugins.%s".' % name)
2003-12-07 01:13:56 +01:00
else:
commands = []
for s in dir(cb):
if cb.isCommand(s) and \
2003-12-09 22:32:55 +01:00
(s != name or cb._original) and \
2003-12-07 01:13:56 +01:00
s == callbacks.canonicalName(s):
method = getattr(cb, s)
if hasattr(method, '__doc__') and method.__doc__:
commands.append(s)
if commands:
2003-03-28 08:23:12 +01:00
commands.sort()
2004-02-12 05:17:20 +01:00
irc.reply(utils.commaAndify(commands))
2003-12-07 01:13:56 +01:00
else:
irc.error('That plugin exists, but it has no '
2003-12-07 01:13:56 +01:00
'commands with help.')
2003-10-22 06:32:29 +02:00
def apropos(self, irc, msg, args):
"""<string>
Searches for <string> in the commands currently offered by the bot,
returning a list of the commands containing that string.
"""
s = privmsgs.getArgs(args)
commands = {}
2003-10-22 06:32:29 +02:00
L = []
for cb in irc.callbacks:
if isinstance(cb, callbacks.Privmsg) and \
not isinstance(cb, callbacks.PrivmsgRegexp):
for attr in dir(cb):
if s in attr and cb.isCommand(attr):
if attr == callbacks.canonicalName(attr):
commands.setdefault(attr, []).append(cb.name())
for (key, names) in commands.iteritems():
if len(names) == 1:
L.append(key)
else:
for name in names:
L.append('%s %s' % (name, key))
if L:
L.sort()
irc.reply(utils.commaAndify(L))
else:
irc.error('No appropriate commands were found.')
2003-10-22 06:32:29 +02:00
def help(self, irc, msg, args):
"""[<plugin>] <command>
2003-03-27 07:34:48 +01:00
2003-10-22 20:49:51 +02:00
This command gives a useful description of what <command> does.
<plugin> is only necessary if the command is in more than one plugin.
2003-03-27 07:34:48 +01:00
"""
def getHelp(method, name=None):
if hasattr(method, '__doc__') and method.__doc__:
irc.reply(callbacks.getHelp(method, name=name))
else:
irc.error('%s has no help.' % name)
if len(args) > 1:
cb = irc.getCallback(args[0])
if cb is not None:
command = callbacks.canonicalName(privmsgs.getArgs(args[1:]))
2004-01-18 08:58:26 +01:00
command = command.lstrip(conf.supybot.prefixChars())
name = ' '.join(args)
if hasattr(cb, 'isCommand') and cb.isCommand(command):
method = getattr(cb, command)
getHelp(method, name)
else:
irc.error('There is no such command %s.' % name)
2003-03-27 07:34:48 +01:00
else:
2004-04-30 06:23:51 +02:00
irc.error('There is no such plugin %s.' % args[0])
return
2003-03-27 07:34:48 +01:00
command = callbacks.canonicalName(privmsgs.getArgs(args))
# Users might expect "@help @list" to work.
2004-01-18 08:58:26 +01:00
command = command.lstrip(conf.supybot.prefixChars())
cbs = callbacks.findCallbackForCommand(irc, command)
if len(cbs) > 1:
tokens = [command]
ambiguous = {}
Owner = irc.getCallback('Owner')
Owner.disambiguate(irc, tokens, ambiguous)
if ambiguous:
names = [cb.name() for cb in cbs]
names.sort()
irc.error('That command exists in the %s plugins. '
'Please specify exactly which plugin command '
'you want help with.'% utils.commaAndify(names))
return
else:
assert len(tokens) == 2
cb = irc.getCallback(tokens[0])
method = getattr(cb, tokens[1])
getHelp(method)
elif not cbs:
irc.error('There is no such command %s.' % command)
else:
cb = cbs[0]
2003-03-27 07:34:48 +01:00
method = getattr(cb, command)
getHelp(method)
2003-08-20 18:26:23 +02:00
2003-09-12 23:16:59 +02:00
def hostmask(self, irc, msg, args):
"""[<nick>]
2003-09-12 23:16:59 +02:00
Returns the hostmask of <nick>. If <nick> isn't given, return the
hostmask of the person giving the command.
2003-09-12 23:16:59 +02:00
"""
nick = privmsgs.getArgs(args, required=0, optional=1)
if nick:
try:
irc.reply(irc.state.nickToHostmask(nick))
except KeyError:
irc.error('I haven\'t seen anyone named %r' % nick)
else:
irc.reply(msg.prefix)
2003-09-12 23:16:59 +02:00
2003-03-27 07:34:48 +01:00
def version(self, irc, msg, args):
"""takes no arguments
Returns the version of the current bot.
"""
try:
newest = webutils.getUrl('http://supybot.sf.net/version.txt')
2004-02-07 13:35:58 +01:00
newest ='The newest version available online is %s.'%newest.strip()
except webutils.WebError, e:
self.log.warning('Couldn\'t get website version: %r', e)
newest = 'I could\'t fetch the newest version ' \
'from the Supybot website.'
s = 'The current (running) version of this Supybot is %s. %s' % \
(conf.version, newest)
irc.reply(s)
version = privmsgs.thread(version)
2003-03-27 07:34:48 +01:00
def revision(self, irc, msg, args):
"""[<module>]
Gives the latest revision of <module>. If <module> isn't given, gives
2004-01-21 21:19:38 +01:00
the revision of all Supybot modules.
"""
name = privmsgs.getArgs(args, required=0, optional=1)
if name:
if name.endswith('.py'):
name = name[:-3]
try:
2004-02-17 19:54:35 +01:00
def startsWithPluginsDir(filename):
for dir in conf.supybot.directories.plugins():
if filename.startswith(dir):
return True
return False
2003-12-02 12:06:39 +01:00
modules = {}
2004-02-16 04:01:20 +01:00
for (moduleName, module) in sys.modules.iteritems():
if hasattr(module, '__file__'):
2004-02-17 19:54:35 +01:00
if startsWithPluginsDir(module.__file__):
2004-02-16 04:01:20 +01:00
modules[moduleName.lower()] = moduleName
try:
module = sys.modules[name]
2004-02-17 19:54:35 +01:00
if not startsWithPluginsDir(module.__file__):
2004-02-16 04:01:20 +01:00
raise KeyError
except KeyError:
try:
module = sys.modules[modules[name.lower()]]
2004-02-17 19:54:35 +01:00
if not startsWithPluginsDir(module.__file__):
2004-02-16 04:01:20 +01:00
raise KeyError
except KeyError:
module = sys.modules[name.lower()]
2004-02-17 19:54:35 +01:00
if not startsWithPluginsDir(module.__file__):
2004-02-16 04:01:20 +01:00
raise KeyError
except KeyError:
2004-04-14 20:50:38 +02:00
irc.error('I couldn\'t find a Supybot module named %s.' % name)
return
if hasattr(module, '__revision__'):
irc.reply(module.__revision__)
else:
2004-02-17 19:54:35 +01:00
irc.error('Module %s has no __revision__ string.' % name)
else:
def getVersion(s):
try:
return s.split(None, 3)[2]
except:
self.log.exception('Couldn\'t get id string: %r', s)
names = {}
2004-01-18 08:58:26 +01:00
dirs = map(os.path.abspath, conf.supybot.directories.plugins())
for (name, module) in sys.modules.items(): # Don't use iteritems.
if hasattr(module, '__revision__'):
if 'supybot' in module.__file__:
names[name] = getVersion(module.__revision__)
else:
for dir in conf.supybot.directories.plugins():
if module.__file__.startswith(dir):
names[name] = getVersion(module.__revision__)
break
2004-02-16 04:01:20 +01:00
L = ['%s: %s' % (k, v) for (k, v) in names.items() if v]
irc.reply(utils.commaAndify(L))
2003-03-28 09:41:11 +01:00
def source(self, irc, msg, args):
"""takes no arguments
Returns a URL saying where to get SupyBot.
"""
irc.reply('My source is at http://supybot.sf.net/')
2003-03-28 09:41:11 +01:00
2003-03-27 07:34:48 +01:00
def logfilesize(self, irc, msg, args):
"""[<logfile>]
2003-03-27 07:34:48 +01:00
Returns the size of the various logfiles in use. If given a specific
logfile, returns only the size of that logfile.
2003-03-27 07:34:48 +01:00
"""
2003-11-26 20:24:28 +01:00
filenameArg = privmsgs.getArgs(args, required=0, optional=1)
if filenameArg:
if not filenameArg.endswith('.log'):
irc.error('That filename doesn\'t appear to be a log.')
return
2003-11-26 20:24:28 +01:00
filenameArg = os.path.basename(filenameArg)
ret = []
2004-01-18 08:58:26 +01:00
dirname = conf.supybot.directories.log()
for (dirname,_,filenames) in os.walk(dirname):
2003-11-26 20:24:28 +01:00
if filenameArg:
if filenameArg in filenames:
filename = os.path.join(dirname, filenameArg)
stats = os.stat(filename)
ret.append('%s: %s' % (filename, stats.st_size))
else:
for filename in filenames:
stats = os.stat(os.path.join(dirname, filename))
ret.append('%s: %s' % (filename, stats.st_size))
if ret:
ret.sort()
irc.reply(utils.commaAndify(ret))
else:
irc.error('I couldn\'t find any logfiles.')
2003-03-27 07:34:48 +01:00
2003-09-07 06:05:34 +02:00
def plugin(self, irc, msg, args):
2003-04-14 07:54:33 +02:00
"""<command>
2003-09-07 06:05:34 +02:00
Returns the plugin <command> is in.
2003-04-14 07:54:33 +02:00
"""
command = callbacks.canonicalName(privmsgs.getArgs(args))
cbs = callbacks.findCallbackForCommand(irc, command)
if cbs:
2004-02-12 14:31:52 +01:00
names = [cb.name() for cb in cbs]
names.sort()
irc.reply(utils.commaAndify(names))
2003-04-14 07:54:33 +02:00
else:
irc.error('There is no such command %s' % command)
2003-04-14 07:54:33 +02:00
2004-04-28 08:30:55 +02:00
def author(self, irc, msg, args):
"""<plugin>
Returns the author of <plugin>. This is the person you should talk to
if you have ideas, suggestions, or other comments about a given plugin.
"""
plugin = privmsgs.getArgs(args)
cb = irc.getCallback(plugin)
if cb is None:
irc.error('That plugin does not seem to be loaded.')
return
module = sys.modules[cb.__class__.__module__]
if hasattr(module, '__author__') and module.__author__:
2004-04-30 20:24:35 +02:00
irc.reply(utils.mungeEmailForWeb(module.__author__))
2004-04-28 08:30:55 +02:00
else:
irc.reply('That plugin doesn\'t have an author that claims it.')
2003-09-07 06:05:34 +02:00
def more(self, irc, msg, args):
"""[<nick>]
2003-09-07 06:05:34 +02:00
If the last command was truncated due to IRC message length
limitations, returns the next chunk of the result of the last command.
2003-09-12 00:21:56 +02:00
If <nick> is given, it takes the continuation of the last command from
<nick> instead of the person sending this message.
2003-09-07 06:05:34 +02:00
"""
nick = privmsgs.getArgs(args, required=0, optional=1)
userHostmask = msg.prefix.split('!', 1)[1]
if nick:
try:
(private, L) = self._mores[nick]
if not private:
self._mores[userHostmask] = L[:]
else:
irc.error('%s has no public mores.' % nick)
return
except KeyError:
irc.error('Sorry, I can\'t find a hostmask for %s' % nick)
return
2003-09-07 06:05:34 +02:00
try:
L = self._mores[userHostmask]
chunk = L.pop()
if L:
chunk += ' \x02(%s)\x0F' % \
utils.nItems('message', len(L), 'more')
irc.reply(chunk, True)
2003-09-07 06:05:34 +02:00
except KeyError:
irc.error('You haven\'t asked me a command!')
2003-09-07 06:05:34 +02:00
except IndexError:
irc.error('That\'s all, there is no more.')
2003-09-07 06:05:34 +02:00
def _validLastMsg(self, msg):
return msg.prefix and \
msg.command == 'PRIVMSG' and \
ircutils.isChannel(msg.args[0])
def last(self, irc, msg, args):
"""[--{from,in,to,with,regexp}] <args>
Returns the last message matching the given criteria. --from requires
a nick from whom the message came; --in and --to require a channel the
message was sent to; --with requires some string that had to be in the
message; --regexp requires a regular expression the message must
match. By default, the current channel is searched.
"""
(optlist, rest) = getopt.getopt(args, '', ['from=', 'in=', 'to=',
'with=', 'regexp='])
predicates = {}
if ircutils.isChannel(msg.args[0]):
predicates['in'] = lambda m: m.args[0] == msg.args[0]
for (option, arg) in optlist:
if option == '--from':
def f(m, arg=arg):
return ircutils.hostmaskPatternEqual(arg, m.nick)
predicates['from'] = f
elif option == '--in' or option == 'to':
def f(m, arg=arg):
return m.args[0] == arg
predicates['in'] = f
elif option == '--with':
def f(m, arg=arg):
return arg in m.args[1]
predicates.setdefault('with', []).append(f)
elif option == '--regexp':
try:
r = utils.perlReToPythonRe(arg)
def f(m, r=r):
2004-03-25 13:08:01 +01:00
if ircmsgs.isAction(m):
return r.search(ircmsgs.unAction(m))
else:
return r.search(m.args[1])
predicates.setdefault('regexp', []).append(f)
except ValueError, e:
irc.error(str(e))
return
2004-04-20 11:51:20 +02:00
iterable = ifilter(self._validLastMsg, reversed(irc.state.history))
iterable.next() # Drop the first message.
predicates = list(utils.flatten(predicates.itervalues()))
for m in iterable:
for predicate in predicates:
if not predicate(m):
break
else:
irc.reply(ircmsgs.prettyPrint(m))
return
irc.error('I couldn\'t find a message matching that criteria in '
2004-04-30 20:24:35 +02:00
'my history of %s messages.' % len(irc.state.history))
def seconds(self, irc, msg, args):
2004-01-15 18:34:05 +01:00
"""[<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s]
2004-01-15 18:34:05 +01:00
Returns the number of seconds in the number of <years>, <weeks>,
<days>, <hours>, <minutes>, and <seconds> given. An example usage is
"seconds 2h 30m", which would return 9000, which is 3600*2 + 30*60.
Useful for scheduling events at a given number of seconds in the
future.
"""
if not args:
raise callbacks.ArgumentError
seconds = 0
for arg in args:
2004-01-15 18:34:05 +01:00
if not arg or arg[-1] not in 'ywdhms':
raise callbacks.ArgumentError
(s, kind) = arg[:-1], arg[-1]
try:
i = int(s)
except ValueError:
irc.error('Invalid argument: %s' % arg)
return
2004-01-15 18:34:05 +01:00
if kind == 'y':
seconds += i*31536000
elif kind == 'w':
seconds += i*604800
elif kind == 'd':
seconds += i*86400
elif kind == 'h':
seconds += i*3600
elif kind == 'm':
seconds += i*60
elif kind == 's':
seconds += i
irc.reply(str(seconds))
def tell(self, irc, msg, args):
"""<nick|channel> <text>
Tells the <nick|channel> whatever <text> is. Use nested commands to
your benefit here.
"""
(target, text) = privmsgs.getArgs(args, required=2)
2004-01-15 18:21:06 +01:00
if target.lower() == 'me':
target = msg.nick
2004-04-30 04:21:17 +02:00
if ircutils.isChannel(target):
irc.error('Dude, just give the command. No need for the tell.')
return
if not ircutils.isNick(target):
irc.error('%s is not a valid nick or channel.' % target)
return
if ircutils.isChannel(target):
c = ircdb.channels.getChannel(target)
if c.lobotomized:
irc.error('I\'m lobotomized in %s.' % target)
return
if irc.action:
irc.action = False
text = '* %s %s' % (irc.nick, text)
s = '%s wants me to tell you: %s' % (msg.nick, text)
irc.reply(s, to=target, private=True)
def private(self, irc, msg, args):
"""<text>
Replies with <text> in private. Use nested commands to your benefit
here.
"""
text = privmsgs.getArgs(args)
irc.reply(text, private=True)
2003-11-11 12:32:09 +01:00
def action(self, irc, msg, args):
"""<text>
2003-11-11 12:32:09 +01:00
Returns the arguments given it, but as an action.
"""
text = privmsgs.getArgs(args)
if text:
irc.reply(text, action=True)
else:
raise callbacks.ArgumentError
2003-11-11 12:32:09 +01:00
def notice(self, irc, msg, args):
"""<text>
2004-04-09 17:30:55 +02:00
Replies with <text> in a notice. Use nested commands to your benefit
here. If you want a private notice, nest the private command.
"""
text = privmsgs.getArgs(args)
irc.reply(text, notice=True)
2003-03-27 07:34:48 +01:00
2003-10-21 08:03:57 +02:00
Class = Misc
2003-03-27 07:34:48 +01:00
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: