Limnoria/plugins/Dict/plugin.py
Valentin Lorentz 63eb6672ea Revert generic 'The Limnoria Contributors' in copyright notices
This commit reverts db7ef3f025
(though it keeps the year updates)

After discussion with several people, it seems better to mention
copyright owners explicitly. eg. https://reuse.software/faq/#vcs-copyright
explains the issue of using VCSs to track copyright.

As db7ef3f025 only replaced mentions
of my name with 'The Limnoria Contributors', this commit only needs
to undo that + add one person who contributed to setup.py.
2021-10-17 09:57:55 +02:00

167 lines
6.3 KiB
Python

###
# Copyright (c) 2002-2004, Jeremiah Fincher
# Copyright (c) 2008, James McCoy
# Copyright (c) 2010-2021, Valentin Lorentz
# 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.
###
import socket
import supybot.conf as conf
import supybot.utils as utils
from supybot.commands import *
import supybot.ircutils as ircutils
import supybot.callbacks as callbacks
from supybot.i18n import PluginInternationalization, internationalizeDocstring
_ = PluginInternationalization('Dict')
import random
from .local import dictclient
class Dict(callbacks.Plugin):
"""This plugin provides a function to look up words from different
dictionaries."""
threaded = True
@internationalizeDocstring
def dictionaries(self, irc, msg, args):
"""takes no arguments
Returns the dictionaries valid for the dict command.
"""
try:
server = conf.supybot.plugins.Dict.server()
conn = dictclient.Connection(server)
dbs = list(conn.getdbdescs().keys())
dbs.sort()
irc.reply(format('%L', dbs))
except socket.error as e:
irc.error(utils.web.strError(e))
dictionaries = wrap(dictionaries)
@internationalizeDocstring
def random(self, irc, msg, args):
"""takes no arguments
Returns a random valid dictionary.
"""
try:
server = conf.supybot.plugins.Dict.server()
conn = dictclient.Connection(server)
dbs = conn.getdbdescs().keys()
irc.reply(utils.iter.choice(dbs))
except socket.error as e:
irc.error(utils.web.strError(e))
random = wrap(random)
@internationalizeDocstring
def dict(self, irc, msg, args, words):
"""[<dictionary>] <word>
Looks up the definition of <word> on the dictd server specified by
the supybot.plugins.Dict.server config variable.
"""
try:
server = conf.supybot.plugins.Dict.server()
conn = dictclient.Connection(server)
except socket.error as e:
irc.error(utils.web.strError(e), Raise=True)
dbs = set(conn.getdbdescs())
if words[0] in dbs:
dictionary = words.pop(0)
else:
default = self.registryValue('default', msg.channel, irc.network)
if default in dbs:
dictionary = default
else:
if default:
self.log.info('Default dict for %s @ %s is not a supported '
'dictionary: %s.', msg.channel, irc.network, default)
dictionary = '*'
if not words:
irc.error(_('You must give a word to define.'), Raise=True)
word = ' '.join(words)
definitions = conn.define(dictionary, word)
dbs = set()
if not definitions:
if dictionary == '*':
irc.reply(format(_('No definition for %q could be found.'),
word))
else:
irc.reply(format(_('No definition for %q 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.str.normalizeWhitespace(s).rstrip(';.,')
L.append('%s: %s' % (db, s))
utils.sortBy(len, L)
if dictionary == '*' and len(dbs) > 1 and \
self.registryValue("showDictName", msg.channel, irc.network):
s = format(_('%L responded: %s'), list(dbs), '; '.join(L))
else:
s = '; '.join(L)
irc.reply(s)
dict = wrap(dict, [many('something')])
def synonym(self, irc, msg, args, words):
"""<word> [<word> ...]
Gets a random synonym from the Moby Thesaurus (moby-thesaurus) database.
If given many words, gets a random synonym for each of them.
Quote phrases to have them treated as one lookup word.
"""
try:
server = conf.supybot.plugins.Dict.server()
conn = dictclient.Connection(server)
except socket.error as e:
irc.error(utils.web.strError(e), Raise=True)
dictionary = 'moby-thesaurus'
response = []
for word in words:
definitions = conn.define(dictionary, word)
if not definitions:
asynonym = word
else:
defstr = definitions[0].getdefstr()
synlist = ' '.join(defstr.split('\n')).split(': ', 1)[1].split(',')
asynonym = random.choice(synlist).strip()
response.append(asynonym)
irc.reply(' '.join(response))
synonym = wrap(synonym, [many('something')])
Class = Dict
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: