Limnoria/plugins/Unix.py

285 lines
11 KiB
Python
Raw Normal View History

2003-03-12 07:26:59 +01:00
#!/usr/bin/env python
###
# Copyright (c) 2002-2004, Jeremiah Fincher
2003-03-12 07:26:59 +01:00
# 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.
###
"""
Provides commands available only on Unix.
"""
2003-11-25 09:23:47 +01:00
__revision__ = "$Id$"
2004-07-24 07:18:26 +02:00
import supybot.plugins as plugins
2003-03-12 07:26:59 +01:00
import os
import re
import pwd
import sys
2003-03-12 07:26:59 +01:00
import crypt
import errno
import popen2
2003-03-12 07:26:59 +01:00
import random
import select
import string
2003-03-12 07:26:59 +01:00
import struct
2004-07-24 07:18:26 +02:00
import supybot.conf as conf
import supybot.utils as utils
import supybot.privmsgs as privmsgs
2004-08-31 17:24:54 +02:00
import supybot.registry as registry
2004-07-24 07:18:26 +02:00
import supybot.callbacks as callbacks
2003-03-12 07:26:59 +01:00
2004-08-31 17:24:54 +02:00
def configure(advanced):
2004-09-01 19:47:32 +02:00
from supybot.questions import output, expect, anything, something, yn
output("""The "progstats" command can reveal potentially sensitive
information about your machine. Here's an example of its output:
%s\n""" % progstats())
if yn('Would you like to disable this command for non-owner users?',
default=True):
2004-08-31 17:24:54 +02:00
conf.supybot.commands.disabled().add('Unix.progstats')
2003-08-17 20:10:48 +02:00
def progstats():
pw = pwd.getpwuid(os.getuid())
2004-08-31 17:24:54 +02:00
response = 'Process ID %s running as user "%s" and as group "%s" ' \
'from directory "%s" with the command line "%s". ' \
'Running on Python %s.' % \
(os.getpid(), pw[0], pw[3],
2004-08-31 17:24:54 +02:00
os.getcwd(), ' '.join(sys.argv),
sys.version.translate(string.ascii, '\r\n'))
return response
2003-08-20 18:26:23 +02:00
class TimeoutError(IOError):
pass
2004-01-15 18:08:57 +01:00
def pipeReadline(fd, timeout=2):
(r, _, _) = select.select([fd], [], [], timeout)
if r:
return r[0].readline()
else:
raise TimeoutError
2004-07-21 21:36:35 +02:00
2004-08-31 17:24:54 +02:00
conf.registerPlugin('Unix')
conf.registerGroup(conf.supybot.plugins.Unix, 'fortune')
conf.registerGlobalValue(conf.supybot.plugins.Unix.fortune, 'command',
registry.String(utils.findBinaryInPath('fortune') or '', """Determines what
command will be called for the fortune command."""))
conf.registerGlobalValue(conf.supybot.plugins.Unix.fortune, 'short',
registry.Boolean(True, """Determines whether only short fortunes will be
used if possible. This sends the -s option to the fortune program."""))
conf.registerGlobalValue(conf.supybot.plugins.Unix.fortune, 'equal',
registry.Boolean(True, """Determines whether fortune will give equal
weight to the different fortune databases. If false, then larger
databases will be given more weight. This sends the -e option to the
fortune program."""))
conf.registerGlobalValue(conf.supybot.plugins.Unix.fortune, 'offensive',
registry.Boolean(False, """Determines whether fortune will retrieve
offensive fortunes along with the normal fortunes. This sends the -o
option to the fortune program."""))
2004-08-31 17:53:57 +02:00
conf.registerGlobalValue(conf.supybot.plugins.Unix.fortune, 'files',
registry.SpaceSeparatedListOfStrings([], """Determines what specific file
(if any) will be used with the fortune command; if none is given, the
system-wide default will be used. Do note that this fortune file must be
placed with the rest of your system's fortune files."""))
2004-08-31 17:24:54 +02:00
conf.registerGroup(conf.supybot.plugins.Unix, 'spell')
conf.registerGlobalValue(conf.supybot.plugins.Unix.spell, 'command',
registry.String(utils.findBinaryInPath('aspell') or \
utils.findBinaryInPath('ispell') or '', """Determines what
command will be called for the spell command."""))
2004-08-31 17:24:54 +02:00
conf.registerGroup(conf.supybot.plugins.Unix, 'wtf')
conf.registerGlobalValue(conf.supybot.plugins.Unix.wtf, 'command',
registry.String(utils.findBinaryInPath('wtf') or '', """Determines what
command will be called for the wtf command."""))
2003-08-17 20:10:48 +02:00
2004-08-31 17:24:54 +02:00
class Unix(callbacks.Privmsg):
2003-03-12 07:26:59 +01:00
def errno(self, irc, msg, args):
"""<error number or code>
Returns the number of an errno code, or the errno code of a number.
"""
2003-03-12 07:26:59 +01:00
s = privmsgs.getArgs(args)
try:
i = int(s)
name = errno.errorcode[i]
except ValueError:
name = s.upper()
try:
i = getattr(errno, name)
except AttributeError:
irc.reply('I can\'t find the errno number for that code.')
2003-03-12 07:26:59 +01:00
return
except KeyError:
name = '(unknown)'
irc.reply('%s (#%s): %s' % (name, i, os.strerror(i)))
2003-08-20 18:26:23 +02:00
2003-03-12 07:26:59 +01:00
def progstats(self, irc, msg, args):
"""takes no arguments
Returns various unix-y information on the running supybot process.
"""
irc.reply(progstats())
2003-03-12 07:26:59 +01:00
_cryptre = re.compile(r'[./0-9A-Za-z]')
def crypt(self, irc, msg, args):
"""<password> [<salt>]
Returns the resulting of doing a crypt() on <password> If <salt> is
2003-08-20 09:32:49 +02:00
not given, uses a random salt. If running on a glibc2 system,
prepending '$1$' to your salt will cause crypt to return an MD5sum
based crypt rather than the standard DES based crypt.
"""
2003-03-12 07:26:59 +01:00
def makeSalt():
s = '\x00'
while self._cryptre.sub('', s) != '':
s = struct.pack('<h', random.randrange(2**16))
return s
(password, salt) = privmsgs.getArgs(args, optional=1)
if salt == '':
salt = makeSalt()
irc.reply(crypt.crypt(password, salt))
2003-03-12 07:26:59 +01:00
2003-08-20 18:26:23 +02:00
def spell(self, irc, msg, args):
"""<word>
Returns the result of passing <word> to aspell/ispell. The results
shown are sorted from best to worst in terms of being a likely match
for the spelling of <word>.
"""
2003-08-17 20:10:48 +02:00
# We are only checking the first word
2004-08-31 17:24:54 +02:00
spellCmd = self.registryValue('spell.command')
if not spellCmd:
irc.error('A spell checking command doesn\'t seem to be '
2004-08-31 17:24:54 +02:00
'installed on this computer. If one is installed, '
'reconfigure supybot.plugins.Unix.spell.command '
'appropriately.', Raise=True)
word = privmsgs.getArgs(args)
if word and not word[0].isalpha():
irc.error('<word> must begin with an alphabet character.')
return
if ' ' in word:
irc.error('Spaces aren\'t allowed in the word.')
return
2004-08-31 17:24:54 +02:00
(r, w) = popen2.popen4([spellCmd, '-a'])
try:
s = r.readline() # Banner, hopefully.
if 'sorry' in s.lower():
irc.error(s)
return
w.write(word)
w.write('\n')
w.flush()
try:
line = pipeReadline(r)
# aspell puts extra whitespace, ignore it
while not line.strip('\r\n'):
line = pipeReadline(r)
except TimeoutError:
irc.error('The spell command timed out.')
return
finally:
r.close()
w.close()
2003-08-17 20:10:48 +02:00
# parse the output
if line[0] in '*+':
resp = '"%s" may be spelled correctly.' % word
2003-08-17 20:10:48 +02:00
elif line[0] == '#':
2004-04-05 11:25:33 +02:00
resp = 'I could not find an alternate spelling for "%s"' % word
2003-08-17 20:10:48 +02:00
elif line[0] == '&':
matches = line.split(':')[1].strip()
resp = 'Possible spellings for %r: %s.' % \
(word, utils.commaAndify(matches.split(', ')))
2003-08-17 20:10:48 +02:00
else:
resp = 'Something unexpected was seen in the [ai]spell output.'
irc.reply(resp)
2003-08-20 18:26:23 +02:00
def fortune(self, irc, msg, args):
"""takes no arguments
Returns a fortune from the *nix fortune program.
"""
2004-08-31 17:24:54 +02:00
fortuneCmd = self.registryValue('fortune.command')
if fortuneCmd:
args = [fortuneCmd]
if self.registryValue('fortune.short'):
args.append('-s')
if self.registryValue('fortune.equal'):
args.append('-e')
if self.registryValue('fortune.offensive'):
args.append('-a')
args.extend(self.registryValue('fortune.files'))
2004-08-31 17:24:54 +02:00
(r, w) = popen2.popen4(args)
try:
lines = r.readlines()
lines = map(str.rstrip, lines)
lines = filter(None, lines)
irc.replies(lines, joiner=' ')
finally:
w.close()
r.close()
2003-09-01 20:41:16 +02:00
else:
2004-08-31 17:24:54 +02:00
irc.error('I couldn\'t find the fortune command on this system. '
'If it is installed on this system, reconfigure the '
'supybot.plugins.Unix.fortune.command configuration '
'variable appropriately.')
2003-09-01 20:41:16 +02:00
def wtf(self, irc, msg, args):
"""[is] <something>
Returns wtf <something> is. 'wtf' is a *nix command that first
appeared in NetBSD 1.5. In most *nices, it's available in some sort
of 'bsdgames' package.
2003-09-01 20:41:16 +02:00
"""
2004-08-31 17:24:54 +02:00
wtfCmd = self.registryValue('wtf.command')
if wtfCmd:
2003-09-01 20:41:16 +02:00
if args and args[0] == 'is':
del args[0]
something = privmsgs.getArgs(args)
something = something.rstrip('?')
2004-08-31 17:24:54 +02:00
(r, w) = popen2.popen4([wtfCmd, something])
try:
response = utils.normalizeWhitespace(r.readline().strip())
irc.reply(response)
finally:
r.close()
w.close()
2003-09-01 20:41:16 +02:00
else:
2004-08-31 17:24:54 +02:00
irc.error('I couldn\'t find the wtf command on this system. '
'If it is installed on this system, reconfigure the '
'supybot.plugins.Unix.wtf.command configuration '
'variable appropriately.')
2003-03-12 07:26:59 +01:00
Class = Unix
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
2003-08-17 20:10:48 +02:00