From e2fe83e21702a0fb951c4a15e4b41f2070280e68 Mon Sep 17 00:00:00 2001 From: Eevee Date: Mon, 8 Mar 2010 20:23:40 -0800 Subject: [PATCH] Threw together a WWWJDIC client. --- plugins/WWWJDIC/README.txt | 1 + plugins/WWWJDIC/__init__.py | 65 ++++++++++++++++++++++++ plugins/WWWJDIC/config.py | 49 +++++++++++++++++++ plugins/WWWJDIC/plugin.py | 117 ++++++++++++++++++++++++++++++++++++++++++++ plugins/WWWJDIC/test.py | 37 ++++++++++++++ 5 files changed, 269 insertions(+) create mode 100644 plugins/WWWJDIC/README.txt create mode 100644 plugins/WWWJDIC/__init__.py create mode 100644 plugins/WWWJDIC/config.py create mode 100644 plugins/WWWJDIC/plugin.py create mode 100644 plugins/WWWJDIC/test.py diff --git a/plugins/WWWJDIC/README.txt b/plugins/WWWJDIC/README.txt new file mode 100644 index 0000000..d60b47a --- /dev/null +++ b/plugins/WWWJDIC/README.txt @@ -0,0 +1 @@ +Insert a description of your plugin here, with any notes, etc. about using it. diff --git a/plugins/WWWJDIC/__init__.py b/plugins/WWWJDIC/__init__.py new file mode 100644 index 0000000..77a1946 --- /dev/null +++ b/plugins/WWWJDIC/__init__.py @@ -0,0 +1,65 @@ +### +# Copyright (c) 2010, Alex Munroe +# 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. + +### + +""" +Performs simple lookups to WWWJDIC, via its Web interface. +""" + +import supybot +import supybot.world as world + +# Use this for the version of this plugin. You may wish to put a CVS keyword +# in here if you're keeping the plugin in CVS or some similar system. +__version__ = "0.1" + +# XXX Replace this with an appropriate author or supybot.Author instance. +__author__ = supybot.Author('Alex Munroe', 'Eevee', 'git@veekun.com') + +# This is a dictionary mapping supybot.Author instances to lists of +# contributions. +__contributors__ = {} + +# This is a url where the most recent plugin package can be downloaded. +__url__ = 'http://git.veekun.com/?p=dywypi.git;a=summary' + +import config +import plugin +reload(plugin) # In case we're being reloaded. +# Add more reloads here if you add third-party modules and want them to be +# reloaded when this plugin is reloaded. Don't forget to import them as well! + +if world.testing: + import test + +Class = plugin.Class +configure = config.configure + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/plugins/WWWJDIC/config.py b/plugins/WWWJDIC/config.py new file mode 100644 index 0000000..eb09f2a --- /dev/null +++ b/plugins/WWWJDIC/config.py @@ -0,0 +1,49 @@ +### +# Copyright (c) 2010, Alex Munroe +# 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 supybot.conf as conf +import supybot.registry as registry + +def configure(advanced): + # This will be called by supybot to configure this module. advanced is + # a bool that specifies whether the user identified himself as an advanced + # user or not. You should effect your configuration by manipulating the + # registry as appropriate. + from supybot.questions import expect, anything, something, yn + conf.registerPlugin('WWWJDIC', True) + + +WWWJDIC = conf.registerPlugin('WWWJDIC') +# This is where your configuration variables (if any) should go. For example: +# conf.registerGlobalValue(WWWJDIC, 'someConfigVariableName', +# registry.Boolean(False, """Help for someConfigVariableName.""")) + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/plugins/WWWJDIC/plugin.py b/plugins/WWWJDIC/plugin.py new file mode 100644 index 0000000..cefd09b --- /dev/null +++ b/plugins/WWWJDIC/plugin.py @@ -0,0 +1,117 @@ +### +# Copyright (c) 2010, Alex Munroe +# 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 supybot.utils as utils +from supybot.commands import * +import supybot.plugins as plugins +import supybot.ircutils as ircutils +import supybot.callbacks as callbacks + +import urllib +import urllib2 +from BeautifulSoup import BeautifulSoup, NavigableString + + +class WWWJDIC(callbacks.Plugin): + """Add the help for "@plugin help WWWJDIC" here + This should describe *how* to use this plugin.""" + threaded = True + + def jdic(self, irc, msg, args, thing): + """ + + Looks up in the EDICT Japanese dictionary. + To use roomaji, prefix with @ for hiragana or # for katakana.""" + + # Fix encoding. Sigh. Stolen from Pokedex.plugin. + if not isinstance(thing, unicode): + ascii_thing = thing + try: + thing = ascii_thing.decode('utf8') + except UnicodeDecodeError: + thing = ascii_thing.decode('latin1') + + + # Unnngh this is horrendous. urllib doesn't understand unicode at all; + # manually encode as bytes and then urlencode + url_thing = urllib.quote(thing.encode('utf8')) + + # Hit up wwwjdic + # 1 = edict; Z = raw results; U = utf8 input; R = exact + common + res = urllib2.urlopen( + u"http://www.csse.monash.edu.au/~jwb/cgi-bin/wwwjdic.cgi?1ZUR" + + url_thing + ) + + # Even the raw results come wrapped in minimal HTML. This sucks. + # They're just in this form though: + #

+ #
entry 1 + #
entry 2 + # So grab everything from that paragraph that isn't a tag (
) or + # blank space and spit it back out. + soup = BeautifulSoup(res) + thing_ct = 0 + for thing in soup.p: + if not isinstance(thing, NavigableString): + continue + + # Everything ends with a newline, bleh! + entry = unicode(thing).strip() + if entry == '': + continue + + self._reply(irc, entry) + + # Don't send back more than three; that's probably plenty + thing_ct += 1 + if thing_ct >= 3: + break + + jdic = wrap(jdic, [rest('something')]) + + + def _reply(self, irc, response): + """Wraps irc.reply() to do some Unicode decoding. + + Also stolen from Pokedex.plugin. + """ + if isinstance(response, str): + irc.reply(response) + else: + irc.reply(response.encode('utf8')) + + + + +Class = WWWJDIC + + +# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: diff --git a/plugins/WWWJDIC/test.py b/plugins/WWWJDIC/test.py new file mode 100644 index 0000000..ea3f52d --- /dev/null +++ b/plugins/WWWJDIC/test.py @@ -0,0 +1,37 @@ +### +# Copyright (c) 2010, Alex Munroe +# 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. + +### + +from supybot.test import * + +class WWWJDICTestCase(PluginTestCase): + plugins = ('WWWJDIC',) + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: -- 2.7.4