Limnoria/plugins/Dict.py

152 lines
5.3 KiB
Python
Raw Normal View History

2003-09-05 22:22:43 +02: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.
###
"""
Commands that use the dictd protocol to snag stuff off a server.
"""
import plugins
2003-09-05 22:22:43 +02:00
2003-10-04 16:56:54 +02:00
import sets
2003-09-05 22:22:43 +02:00
import random
import socket
2003-09-05 22:22:43 +02:00
import dictclient
import conf
import debug
import utils
2003-11-12 02:12:57 +01:00
import plugins
import ircutils
2003-09-05 22:22:43 +02:00
import privmsgs
import callbacks
def configure(onStart, afterConnect, advanced):
# This will be called by setup.py to configure this module. onStart and
# afterConnect are both lists. Append to onStart the commands you would
# like to be run when the bot is started; append to afterConnect the
# commands you would like to be run when the bot has finished connecting.
from questions import expect, anything, something, yn
2003-10-19 16:58:08 +02:00
onStart.append('load Dictionary')
2003-09-05 22:22:43 +02:00
print 'The default dictd server is dict.org.'
if yn('Would you like to specify a dictd server?') == 'y':
server = something('What server?')
onStart.append('dict config server %s' % server)
2003-09-05 22:22:43 +02:00
2003-11-12 02:12:57 +01:00
replyTimeout = 'Timeout on the dictd server.'
class Dict(callbacks.Privmsg, plugins.Configurable):
2003-09-05 22:22:43 +02:00
threaded = True
2003-11-12 02:12:57 +01:00
configurables = plugins.ConfigurableDictionary(
[('server', plugins.ConfigurableStrType, 'dict.org',
"""Determines what server the bot will connect to to receive
definitions from."""),]
)
2003-09-05 22:22:43 +02:00
def __init__(self):
callbacks.Privmsg.__init__(self)
2003-11-12 02:12:57 +01:00
plugins.Configurable.__init__(self)
2003-09-05 22:22:43 +02:00
2003-11-12 02:12:57 +01:00
def die(self):
callbacks.Privmsg.die(self)
plugins.Configurable.die(self)
2003-09-05 22:22:43 +02:00
def dictionaries(self, irc, msg, args):
"""takes no arguments.
Returns the dictionaries valid for the dict command.
"""
2003-11-12 02:12:57 +01:00
try:
conn = dictclient.Connection(self.configurables.get('server'))
dbs = conf.getdbdescs()
dbs.sort()
irc.reply(msg, utils.commaAndify(dbs))
except socket.timeout:
irc.error(msg, replyTimeout)
2003-09-05 22:22:43 +02:00
def random(self, irc, msg, args):
2003-09-05 22:22:43 +02:00
"""takes no arguments.
Returns a random valid dictionary.
"""
2003-11-12 02:12:57 +01:00
try:
conn = dictclient.Connection(self.configurables.get('server'))
dbs = conf.getdbdescs()
irc.reply(msg, random.choice(dbs))
except socket.timeout:
irc.error(msg, replyTimeout)
2003-09-05 22:22:43 +02:00
def dict(self, irc, msg, args):
"""[<dictionary>] <word>
Looks up the definition of <word> on dict.org's dictd server.
2003-09-05 22:22:43 +02:00
"""
if not args:
raise callbacks.ArgumentError
try:
2003-11-12 02:12:57 +01:00
conn = dictclient.Connection(self.configurables.get('server'))
except socket.timeout:
irc.error(msg, 'Timeout on the dict server.')
return
2003-11-12 02:12:57 +01:00
dbs = sets.Set(conn.getdbdescs())
if args[0] in dbs:
2003-09-05 22:22:43 +02:00
dictionary = args.pop(0)
else:
dictionary = '*'
word = privmsgs.getArgs(args)
definitions = conn.define(dictionary, word)
dbs = sets.Set()
if not definitions:
if dictionary == '*':
irc.reply(msg, 'No definition for %r could be found.' % word)
else:
irc.reply(msg, 'No definition for %r could be found in %s' % \
(word, ircutils.bold(dictionary)))
2003-09-05 22:22:43 +02:00
return
L = []
for d in definitions:
dbs.add(ircutils.bold(d.getdb().getname()))
(db, s) = (d.getdb().getname(), d.getdefstr())
db = ircutils.bold(db)
s = utils.normalizeWhitespace(s).rstrip(';.,')
L.append('%s: %s' % (db, s))
utils.sortBy(len, L)
if dictionary == '*' and len(dbs) > 1:
s = '%s responded: %s' % (utils.commaAndify(dbs), '; '.join(L))
2003-09-05 22:22:43 +02:00
else:
s = '; '.join(L)
irc.reply(msg, s)
2003-09-05 22:22:43 +02:00
Class = Dict
2003-09-05 22:22:43 +02:00
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: