mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-12-11 20:59:42 +01:00
366 lines
14 KiB
Python
366 lines
14 KiB
Python
#!/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.
|
|
###
|
|
|
|
"""
|
|
Acceses Google for various things.
|
|
"""
|
|
|
|
__revision__ = "$Id$"
|
|
|
|
import plugins
|
|
|
|
import re
|
|
import sets
|
|
import time
|
|
import getopt
|
|
import socket
|
|
import urllib2
|
|
import xml.sax
|
|
|
|
import SOAP
|
|
import google
|
|
|
|
import registry
|
|
|
|
import conf
|
|
import utils
|
|
import ircmsgs
|
|
import plugins
|
|
import ircutils
|
|
import privmsgs
|
|
import callbacks
|
|
import structures
|
|
|
|
def configure(onStart, afterConnect, advanced):
|
|
from questions import expect, anything, something, yn
|
|
print 'To use Google\'t Web Services, you must have a license key.'
|
|
if yn('Do you have a license key?') == 'y':
|
|
key = something('What is it?')
|
|
while len(key) != 32:
|
|
print 'That\'s not a valid Google license key.'
|
|
if yn('Are you sure you have a valid Google license key?') == 'y':
|
|
key = something('What is it?')
|
|
else:
|
|
key = ''
|
|
break
|
|
if key:
|
|
onStart.append('load Google')
|
|
conf.supybot.plugins.Google.licenseKey.setValue(key)
|
|
print 'The Google plugin has the functionality to watch for URLs'
|
|
print 'that match a specific pattern (we call this a snarfer).'
|
|
print 'When supybot sees such a URL, he will parse the web page'
|
|
print 'for information and reply with the results.'
|
|
print
|
|
print 'Google has two available snarfers: Google Groups link'
|
|
print 'snarfing and a google search snarfer.'
|
|
print
|
|
if yn('Do you want the Google Groups link snarfer enabled by '
|
|
'default?') == 'y':
|
|
conf.supybot.plugins.Google.groupsSnarfer.setValue(True)
|
|
if yn('Do you want the Google search snarfer enabled by default?') \
|
|
== 'y':
|
|
conf.supybot.plugins.Google.searchSnarfer.setValue(True)
|
|
if 'load Alias' not in onStart:
|
|
print 'Google depends on the Alias module for some extra commands.'
|
|
if yn('Would you like to load the Alias module now?') == 'y':
|
|
onStart.append('load Alias')
|
|
else:
|
|
print 'You can still use the Google module, but you won\'t ' \
|
|
'have these extra commands enabled.'
|
|
return
|
|
onStart.append('alias add googlelinux "google --restrict=linux $1"')
|
|
onStart.append('alias add googlebsd "google --restrict=bsd $1"')
|
|
onStart.append('alias add googlemac "google --restrict=mac $1"')
|
|
else:
|
|
print 'You\'ll need to get a key before you can use this plugin.'
|
|
print 'You can apply for a key at http://www.google.com/apis/'
|
|
|
|
|
|
totalSearches = 0
|
|
totalTime = 0
|
|
last24hours = structures.queue()
|
|
|
|
def search(log, *args, **kwargs):
|
|
try:
|
|
global totalSearches, totalTime, last24hours
|
|
data = google.doGoogleSearch(*args, **kwargs)
|
|
now = time.time()
|
|
totalSearches += 1
|
|
totalTime += data.meta.searchTime
|
|
last24hours.enqueue(now)
|
|
while last24hours and now - last24hours.peek() > 86400:
|
|
last24hours.dequeue()
|
|
return data
|
|
except socket.error, e:
|
|
if e.args[0] == 110:
|
|
return 'Connection timed out to Google.com.'
|
|
else:
|
|
raise
|
|
except SOAP.faultType, e:
|
|
log.exception('Uncaught SOAP error:')
|
|
raise callbacks.Error, 'Invalid Google license key.'
|
|
except xml.sax.SAXException, e:
|
|
log.exception('Uncaught SAX error:')
|
|
raise callbacks.Error, 'Google returned an unparseable response. ' \
|
|
'The full traceback has been logged.'
|
|
|
|
class LicenseKey(registry.String):
|
|
def set(self, s):
|
|
original = getattr(self, 'value', self.default)
|
|
registry.String.set(self, s)
|
|
if self.value and len(self.value) != 32:
|
|
setattr(self, 'value', original)
|
|
google.setLicense(self.value)
|
|
raise registry.InvalidRegistryValue, 'Invalid Google license key.'
|
|
if self.value:
|
|
google.setLicense(self.value)
|
|
|
|
conf.registerPlugin('Google')
|
|
conf.registerChannelValue(conf.supybot.plugins.Google, 'groupsSnarfer',
|
|
registry.Boolean(False, """Determines whether the groups snarfer is
|
|
enabled. If so, URLs at groups.google.com will be snarfed and their
|
|
group/title messaged to the channel."""))
|
|
conf.registerChannelValue(conf.supybot.plugins.Google, 'searchSnarfer',
|
|
registry.Boolean(False, """Determines whether the search snarfer is
|
|
enabled. If so, messages (even unaddressed ones) beginning with the word
|
|
'google' will result in the first URL Google returns being sent to the
|
|
channel."""))
|
|
conf.registerChannelValue(conf.supybot.plugins.Google, 'bold',
|
|
registry.Boolean(True, """Determines whether results are bolded."""))
|
|
conf.registerChannelValue(conf.supybot.plugins.Google, 'maximumResults',
|
|
registry.PositiveInteger(10, """Determines the maximum number of results
|
|
returned from the google command."""))
|
|
conf.registerGlobalValue(conf.supybot.plugins.Google, 'licenseKey',
|
|
LicenseKey('', """Sets the Google license key for using Google's Web
|
|
Services API. This is necessary before you can do any searching with this
|
|
module."""))
|
|
|
|
class Google(callbacks.PrivmsgCommandAndRegexp):
|
|
threaded = True
|
|
regexps = sets.Set(['googleSnarfer', 'googleGroups'])
|
|
def __init__(self):
|
|
callbacks.PrivmsgCommandAndRegexp.__init__(self)
|
|
self.total = 0
|
|
self.totalTime = 0
|
|
self.last24hours = structures.queue()
|
|
|
|
def die(self):
|
|
callbacks.PrivmsgCommandAndRegexp.die(self)
|
|
|
|
def formatData(self, data, bold=True, max=0):
|
|
if isinstance(data, basestring):
|
|
return data
|
|
time = 'Search took %s seconds' % data.meta.searchTime
|
|
results = []
|
|
if max:
|
|
data.results = data.results[:max]
|
|
for result in data.results:
|
|
title = utils.htmlToText(result.title.encode('utf-8'))
|
|
url = result.URL
|
|
if title:
|
|
if bold:
|
|
title = ircutils.bold(title)
|
|
results.append('%s: <%s>' % (title, url))
|
|
else:
|
|
results.append(url)
|
|
if not results:
|
|
return 'No matches found (%s)' % time
|
|
else:
|
|
return '%s: %s' % (time, '; '.join(results))
|
|
|
|
def google(self, irc, msg, args):
|
|
"""<search> [--{language,restrict}=<value>] [--{notsafe,similar}]
|
|
|
|
Searches google.com for the given string. As many results as can fit
|
|
are included. --language accepts a language abbreviation; --restrict
|
|
restricts the results to certain classes of things; --similar tells
|
|
Google not to filter similar results. --notsafe allows possibly
|
|
work-unsafe results.
|
|
"""
|
|
(optlist, rest) = getopt.getopt(args, '', ['language=', 'restrict=',
|
|
'notsafe', 'similar'])
|
|
kwargs = {'language': 'lang_en', 'safeSearch': 1}
|
|
for (option, argument) in optlist:
|
|
if option == '--notsafe':
|
|
kwargs['safeSearch'] = False
|
|
elif option == '--similar':
|
|
kwargs['filter'] = False
|
|
else:
|
|
kwargs[option[2:]] = argument
|
|
searchString = privmsgs.getArgs(rest)
|
|
try:
|
|
data = search(self.log, searchString, **kwargs)
|
|
except google.NoLicenseKey, e:
|
|
irc.error(str(e))
|
|
return
|
|
bold = conf.supybot.plugins.Google.bold()
|
|
max = conf.supybot.plugins.Google.maximumResults()
|
|
irc.reply(self.formatData(data, bold=bold, max=max))
|
|
|
|
def metagoogle(self, irc, msg, args):
|
|
"""<search> [--(language,restrict)=<value>] [--{similar,notsafe}]
|
|
|
|
Searches google and gives all the interesting meta information about
|
|
the search. See the help for the google command for a detailed
|
|
description of the parameters.
|
|
"""
|
|
(optlist, rest) = getopt.getopt(args, '', ['language=', 'restrict=',
|
|
'notsafe', 'similar'])
|
|
kwargs = {'language': 'lang_en', 'safeSearch': 1}
|
|
for option, argument in optlist:
|
|
if option == '--notsafe':
|
|
kwargs['safeSearch'] = False
|
|
elif option == '--similar':
|
|
kwargs['filter'] = False
|
|
else:
|
|
kwargs[option[2:]] = argument
|
|
searchString = privmsgs.getArgs(rest)
|
|
data = search(self.log, searchString, **kwargs)
|
|
meta = data.meta
|
|
categories = [d['fullViewableName'] for d in meta.directoryCategories]
|
|
categories = [utils.dqrepr(s.replace('_', ' ')) for s in categories]
|
|
if categories:
|
|
categories = utils.commaAndify(categories)
|
|
else:
|
|
categories = ''
|
|
s = 'Search for %r returned %s %s results in %s seconds.%s' % \
|
|
(meta.searchQuery,
|
|
meta.estimateIsExact and 'exactly' or 'approximately',
|
|
meta.estimatedTotalResultsCount,
|
|
meta.searchTime,
|
|
categories and ' Categories include %s.' % categories)
|
|
irc.reply(s)
|
|
|
|
def fight(self, irc, msg, args):
|
|
"""<search string> <search string> [<search string> ...]
|
|
|
|
Returns the results of each search, in order, from greatest number
|
|
of results to least.
|
|
"""
|
|
|
|
results = []
|
|
for arg in args:
|
|
data = search(self.log, arg)
|
|
results.append((data.meta.estimatedTotalResultsCount, arg))
|
|
results.sort()
|
|
results.reverse()
|
|
s = ', '.join(['%r: %s' % (s, i) for (i, s) in results])
|
|
irc.reply(s)
|
|
|
|
def spell(self, irc, msg, args):
|
|
"""<word>
|
|
|
|
Returns Google's spelling recommendation for <word>.
|
|
"""
|
|
word = privmsgs.getArgs(args)
|
|
result = google.doSpellingSuggestion(word)
|
|
if result:
|
|
irc.reply(result)
|
|
else:
|
|
irc.reply('No spelling suggestion made.')
|
|
|
|
def info(self, irc, msg, args):
|
|
"""takes no arguments
|
|
|
|
Returns interesting information about this Google module. Mostly
|
|
useful for making sure you don't go over your 1000 requests/day limit.
|
|
"""
|
|
recent = len(last24hours)
|
|
irc.reply('This google module has been called %s total; '
|
|
'%s in the past 24 hours. '
|
|
'Google has spent %s seconds searching for me.' %
|
|
(utils.nItems('time', totalSearches),
|
|
utils.nItems('time', recent), totalTime))
|
|
|
|
def googleSnarfer(self, irc, msg, match):
|
|
r"^google\s+(.*)$"
|
|
if not conf.supybot.plugins.Google.searchSnarfer():
|
|
return
|
|
searchString = match.group(1)
|
|
try:
|
|
data = search(self.log, searchString, safeSearch=1)
|
|
except google.NoLicenseKey:
|
|
return
|
|
if data.results:
|
|
url = data.results[0].URL
|
|
irc.reply(url)
|
|
else:
|
|
irc.reply('No results for "%s"' % searchString)
|
|
googleSnarfer = privmsgs.urlSnarfer(googleSnarfer)
|
|
|
|
_ggThread = re.compile(r'<br>Subject: ([^<]+)<br>')
|
|
_ggPlainThread = re.compile(r'Subject: (.*)')
|
|
_ggGroup = re.compile(r'Newsgroups: (?:<a[^>]+>)?([^<]+)(?:</a>)?')
|
|
_ggPlainGroup = re.compile(r'Newsgroups: (.*)')
|
|
def googleGroups(self, irc, msg, match):
|
|
r"http://groups.google.com/[^\s]+"
|
|
if not conf.supybot.plugins.Google.groupsSnarfer():
|
|
return
|
|
request = urllib2.Request(match.group(0), headers= \
|
|
{'User-agent': 'Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 4.0)'})
|
|
fd = urllib2.urlopen(request)
|
|
text = fd.read()
|
|
fd.close()
|
|
mThread = None
|
|
mGroup = None
|
|
if '&prev=/' in match.group(0):
|
|
path = re.search('view the <a href=([^>]+)>no',text)
|
|
if path is None:
|
|
return
|
|
url = 'http://groups.google.com'
|
|
request = urllib2.Request('%s%s' % (url,path.group(1)),
|
|
headers={'User-agent': 'Mozilla/4.0 (compatible; MSIE 5.5;'
|
|
'Windows NT 4.0)'})
|
|
fd = urllib2.urlopen(request)
|
|
text = fd.read()
|
|
fd.close()
|
|
mThread = self._ggThread.search(text)
|
|
mGroup = self._ggGroup.search(text)
|
|
elif '&output=gplain' in match.group(0):
|
|
mThread = self._ggPlainThread.search(text)
|
|
mGroup = self._ggPlainGroup.search(text)
|
|
else:
|
|
mThread = self._ggThread.search(text)
|
|
mGroup = self._ggGroup.search(text)
|
|
if mThread and mGroup:
|
|
irc.reply('Google Groups: %s, %s' % (mGroup.group(1),
|
|
mThread.group(1)), prefixName = False)
|
|
else:
|
|
irc.errorPossibleBug('That doesn\'t appear to be a proper '
|
|
'Google Groups page.')
|
|
googleGroups = privmsgs.urlSnarfer(googleGroups)
|
|
|
|
|
|
Class = Google
|
|
|
|
|
|
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
|