Limnoria/src/MiscCommands.py

392 lines
15 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.
"""
from fix import *
2003-03-27 07:34:48 +01:00
import os
import time
import getopt
2003-03-27 07:34:48 +01:00
import pprint
import smtplib
import textwrap
from itertools import ifilter
2003-03-27 07:34:48 +01:00
import conf
import debug
import utils
import world
import ircmsgs
import ircutils
2003-03-27 07:34:48 +01:00
import privmsgs
import callbacks
class MiscCommands(callbacks.Privmsg):
def doPrivmsg(self, irc, msg):
# This exists to be able to respond to attempts to command the bot
# with a "That's not a command!" if the proper conf.variable is set.
callbacks.Privmsg.doPrivmsg(self, irc, msg)
if conf.replyWhenNotCommand and msg.nick != irc.nick:
s = callbacks.addressed(irc.nick, msg)
if s:
for cb in irc.callbacks:
if isinstance(cb, callbacks.PrivmsgRegexp) or \
isinstance(cb, callbacks.PrivmsgCommandAndRegexp):
for (r, _) in cb.res:
if r.search(msg.args[1]):
return
notCommands = []
tokens = callbacks.tokenize(s)
for command in callbacks.getCommands(tokens):
command = callbacks.canonicalName(command)
if not callbacks.findCallbackForCommand(irc, command):
notCommands.append(repr(command))
if notCommands:
if len(notCommands) == 1:
s = '%s is not a command.' % notCommands[0]
else:
s = '%s are not commands' % \
utils.commaAndify(notCommands)
irc.queueMsg(callbacks.reply(msg, s))
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, needed=0, optional=1)
2003-03-27 07:34:48 +01:00
name = name.lower()
if not name:
names = [cb.name() for cb in irc.callbacks
if evenPrivate or (hasattr(cb, 'public') and cb.public)]
2003-03-28 08:23:12 +01:00
names.sort()
2003-03-27 07:34:48 +01:00
irc.reply(msg, ', '.join(names))
else:
for cb in irc.callbacks:
cls = cb.__class__
2003-04-20 03:02:29 +02:00
if cb.name().lower().startswith(name) and \
2003-03-27 07:34:48 +01:00
not issubclass(cls, callbacks.PrivmsgRegexp) and \
issubclass(cls, callbacks.Privmsg):
commands = [x for x in dir(cls)
2003-03-27 07:34:48 +01:00
if cb.isCommand(x) and \
hasattr(getattr(cb, x), '__doc__')]
2003-03-28 08:23:12 +01:00
commands.sort()
2003-03-27 07:34:48 +01:00
irc.reply(msg, ', '.join(commands))
return
2003-09-07 06:05:34 +02:00
irc.error(msg, 'There is no plugin named %s, ' \
'or that plugin has no commands.' % name)
2003-03-27 07:34:48 +01:00
def help(self, irc, msg, args):
"""<command>
Gives the help for a specific command. To find commands,
2003-09-07 06:05:34 +02:00
use the 'list' command to go see the commands offered by a plugin.
The 'list' command by itself will show you what plugins have commands.
2003-03-27 07:34:48 +01:00
"""
command = privmsgs.getArgs(args, needed=0, optional=1)
if not command:
command = 'help'
command = callbacks.canonicalName(command)
cb = irc.findCallback(command)
if cb:
method = getattr(cb, command)
2003-04-08 09:20:42 +02:00
if hasattr(method, '__doc__') and method.__doc__ is not None:
2003-08-30 21:52:56 +02:00
doclines = method.__doc__.strip().splitlines()
2003-03-27 07:34:48 +01:00
help = doclines.pop(0)
if doclines:
s = '%s %s (for more help use the morehelp command)'
else:
s = '%s %s'
irc.reply(msg, s % (command, help))
else:
irc.reply(msg, 'That command exists, but has no help.')
else:
2003-08-30 21:52:56 +02:00
cb = irc.getCallback(command)
if cb:
if hasattr(cb, '__doc__') and cb.__doc__ is not None:
doclines = cb.__doc__.strip().splitlines()
help = ' '.join(map(str.strip, doclines))
2003-09-07 06:05:34 +02:00
if not help.endswith('.'):
help += '.'
help += ' Use the list command to see what commands ' \
'this plugin supports.'
2003-08-30 21:52:56 +02:00
irc.reply(msg, help)
else:
module = __import__(cb.__module__)
if hasattr(module, '__doc__') and module.__doc__:
doclines = module.__doc__.strip().splitlines()
2003-03-27 07:34:48 +01:00
help = ' '.join(map(str.strip, doclines))
2003-09-07 06:05:34 +02:00
if not help.endswith('.'):
help += '.'
help += ' Use the list command to see what ' \
'commands this plugin supports.'
2003-03-27 07:34:48 +01:00
irc.reply(msg, help)
else:
2003-09-07 06:05:34 +02:00
irc.error(msg, 'That plugin has no help.')
2003-03-27 07:34:48 +01:00
else:
2003-09-07 06:05:34 +02:00
irc.error(msg, 'There is no such command or plugin.')
2003-03-27 07:34:48 +01:00
def morehelp(self, irc, msg, args):
"""<command>
This command gives more help than is provided by the simple argument
list given by the command 'help'.
"""
command = callbacks.canonicalName(privmsgs.getArgs(args))
cb = irc.findCallback(command)
if cb:
method = getattr(cb, command)
if hasattr(method, '__doc__') and method.__doc__ is not None:
2003-03-27 07:34:48 +01:00
doclines = method.__doc__.splitlines()
simplehelp = doclines.pop(0)
if doclines:
doclines = filter(None, doclines)
doclines = map(str.strip, doclines)
help = ' '.join(doclines)
irc.reply(msg, help)
else:
irc.reply(msg, 'That command has no more help. '\
'The original help is this: %s %s' % \
(command, simplehelp))
else:
irc.error(msg, 'That command has no help at all.')
else:
irc.error(msg, 'There is no such command %s.' % command)
2003-08-20 18:26:23 +02:00
2003-03-27 07:34:48 +01:00
def bug(self, irc, msg, args):
"""<description>
2003-03-27 07:34:48 +01:00
Reports a bug to a private mailing list supybot-bugs. <description>
will be the subject of the email. The most recent 10 or so messages
the bot receives will be sent in the body of the email.
2003-03-27 07:34:48 +01:00
"""
description = privmsgs.getArgs(args)
messages = pprint.pformat(irc.state.history[-10:])
email = textwrap.dedent("""
Subject: %s
From: jemfinch@users.sourceforge.net
To: supybot-bugs@lists.sourceforge.net
Date: %s
Bug report for Supybot %s.
%s
""") % (description, time.ctime(), conf.version, messages)
email = email.strip()
email = email.replace('\n', '\r\n')
debug.printf(`email`)
smtp = smtplib.SMTP('mail.sourceforge.net', 25)
smtp.sendmail('jemfinch@users.sf.net',
['supybot-bugs@lists.sourceforge.net'],
email)
smtp.quit()
2003-03-27 07:34:48 +01:00
irc.reply(msg, conf.replySuccess)
bug = privmsgs.thread(bug)
2003-03-27 07:34:48 +01:00
2003-09-12 23:16:59 +02:00
def hostmask(self, irc, msg, args):
"""<nick>
Returns the hostmask of <nick>.
"""
nick = privmsgs.getArgs(args)
try:
irc.reply(msg, irc.state.nickToHostmask(nick))
except KeyError:
irc.error(msg, 'I haven\'t seen anyone named %r' % nick)
2003-03-27 07:34:48 +01:00
def version(self, irc, msg, args):
"""takes no arguments
Returns the version of the current bot.
"""
2003-08-28 15:59:07 +02:00
irc.reply(msg, conf.version)
2003-03-27 07:34:48 +01:00
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.
"""
2003-04-08 09:20:42 +02:00
irc.reply(msg, 'My source is at http://www.sf.net/projects/supybot/')
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
"""
filename = privmsgs.getArgs(args, needed=0, optional=1)
if filename:
2003-04-14 16:55:28 +02:00
if not filename.endswith('.log'):
irc.error(msg, 'That filename doesn\'t appear to be a log.')
return
filenames = [filename]
else:
filenames = os.listdir(conf.logDir)
2003-03-27 07:34:48 +01:00
result = []
2003-04-14 16:56:59 +02:00
for file in filenames:
2003-03-27 07:34:48 +01:00
if file.endswith('.log'):
stats = os.stat(os.path.join(conf.logDir, file))
result.append((file, str(stats.st_size)))
irc.reply(msg, ', '.join(map(': '.join, result)))
2003-03-27 22:34:50 +01:00
def getprefixchar(self, irc, msg, args):
"""takes no arguments
Returns the prefix character(s) the bot is currently using.
"""
irc.reply(msg, repr(conf.prefixChars))
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))
cb = irc.findCallback(command)
if cb is not None:
irc.reply(msg, cb.name())
2003-04-14 07:54:33 +02:00
else:
irc.error(msg, 'There is no such command %s' % command)
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, needed=0, optional=1)
userHostmask = msg.prefix.split('!', 1)[1]
if nick:
try:
(public, L) = self._mores[nick]
if public:
self._mores[userHostmask] = L[:]
else:
irc.error(msg, '%s has no public mores.' % nick)
return
except KeyError:
irc.error(msg, '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(len(L), 'message', 'more')
2003-09-07 06:56:26 +02:00
irc.reply(msg, chunk, True)
2003-09-07 06:05:34 +02:00
except KeyError:
irc.error(msg, 'You haven\'t asked me a command!')
except IndexError:
irc.error(msg, 'That\'s all, there is no more.')
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,fancy}] <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
--fancy determines whether or not to show the nick; the default is not
"""
(optlist, rest) = getopt.getopt(args, '', ['from=', 'in=', 'to=',
'with=', 'regexp=',
'fancy'])
fancy = False
predicates = []
for (option, arg) in optlist:
option = option.strip('-')
if option == 'fancy':
fancy = True
elif option == 'from':
predicates.append(lambda m, arg=arg: m.nick == arg)
elif option == 'in' or option == 'to':
if not ircutils.isChannel(arg):
irc.error(msg, 'Argument to --%s must be a channel.' % arg)
return
predicates.append(lambda m, arg=arg: m.args[0] == arg)
elif option == 'with':
predicates.append(lambda m, arg=arg: arg in m.args[1])
elif option == 'regexp':
try:
r = utils.perlReToPythonRe(arg)
except ValueError, e:
irc.error(msg, str(e))
return
predicates.append(lambda m: r.search(m.args[1]))
first = True
for m in ifilter(self._validLastMsg, reviter(irc.state.history)):
if first:
first = False
continue
for predicate in predicates:
if not predicate(m):
break
else:
if fancy:
irc.reply(msg, ircmsgs.prettyPrint(m))
else:
irc.reply(msg, m.args[1])
return
irc.error(msg, 'I couldn\'t find a message matching that criteria.')
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, needed=2)
s = '%s wants me to tell you: %s' % (msg.nick, text)
irc.queueMsg(ircmsgs.privmsg(target, s))
raise callbacks.CannotNest
2003-03-27 07:34:48 +01:00
Class = MiscCommands
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: