Limnoria/plugins/Dict.py

#!/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

import sets
import random

import dictclient

import conf
import debug
import utils
import ircutils
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
    onStart.append('load Dict')
    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('dictserver %s' % server)

example = utils.wrapLines("""
<jemfinch> @dict socket
<supybot> jemfinch: foldoc, wn, and web1913 responded, 1 shown: wn: socket n 1: a bony hollow into which a structure fits 2: receptacle where something (a pipe or probe or end of a bone) is inserted 3: a receptacle into which an electric device can be inserted
<jemfinch> @dict foldoc socket
<supybot> jemfinch: foldoc: socket <networking> The {Berkeley Unix} mechansim for creating a virtual connection between processes. Sockets interface {Unix}'s {standard I/O} with its {network} communication facilities. They can be of two types, stream (bi-directional) or {datagram} (fixed length destination-addressed messages). The socket library function socket() creates a communications end-point or socket and ret <snip>
<jemfinch> @randomdictionary
<supybot> jemfinch: foldoc
""")

class Dict(callbacks.Privmsg):
    threaded = True
    dictServer = 'dict.org'
    def __init__(self):
        self.setDictServer(self.dictServer)
        callbacks.Privmsg.__init__(self)

    def setDictServer(self, server):
        conn = dictclient.Connection(server)
        self.dictdbs = sets.Set(conn.getdbdescs())
        self.dictServer = server
            
    def dictserver(self, irc, msg, args):
        """[<dictd server>]

        Sets the dictd server the plugin should use.
        """
        server = privmsgs.getArgs(args)
        try:
            self.setDictServer(server)
            irc.reply(msg, conf.replySuccess)
        except Exception, e:
            irc.error(msg, debug.exnToString(e))

    def dictionaries(self, irc, msg, args):
        """takes no arguments.

        Returns the dictionaries valid for the dict command.
        """
        irc.reply(msg, utils.commaAndify(self.dictdbs))

    def randomdictionary(self, irc, msg, args):
        """takes no arguments.

        Returns a random valid dictionary.
        """
        irc.reply(msg, random.choice(list(self.dictdbs)))

    def dict(self, irc, msg, args):
        """[<dictionary>] <word>

        Looks up the definition of <word> on dict.org's dictd server.  If a
        a dictionary is specified and the definition is too long, snips it to
        an appropriate length.
        """
        if not args:
            raise callbacks.ArgumentError
        if args[0] in self.dictdbs:
            dictionary = args.pop(0)
        else:
            dictionary = '*'
        word = privmsgs.getArgs(args)
        conn = dictclient.Connection(self.dictServer)
        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)))
            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)) 
        else:
            s = '; '.join(L)
        irc.reply(msg, s)


Class = Dict

# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: