Limnoria/plugins/Weather.py

491 lines
20 KiB
Python
Raw Normal View History

2004-01-07 16:17:53 +01:00
###
# Copyright (c) 2002-2004, Jeremiah Fincher
2004-01-07 16:17:53 +01:00
# 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.
###
"""
2004-02-23 10:05:12 +01:00
This plugin does weather-related stuff. It can't change the weather, though,
so don't get your hopes up. We just report it.
2004-01-07 16:17:53 +01:00
"""
import supybot
2004-03-19 17:58:54 +01:00
__revision__ = "$Id$"
__contributors__ = {
supybot.authors.jamessan: ['cnn', 'wunder',
'temperatureUnit configuration variable',
'convert configuration variable'],
supybot.authors.jemfinch: ['weather'],
supybot.authors.bwp: ['ham'],
}
2004-01-07 16:17:53 +01:00
import re
import sets
2004-02-23 10:05:12 +01:00
import urllib
2004-01-07 16:17:53 +01:00
import BeautifulSoup
2004-07-24 07:18:26 +02:00
import supybot.conf as conf
import supybot.utils as utils
2004-10-23 22:26:40 +02:00
from supybot.commands import *
import supybot.commands as commands
2004-07-24 07:18:26 +02:00
import supybot.ircutils as ircutils
import supybot.registry as registry
import supybot.webutils as webutils
2004-07-24 07:18:26 +02:00
import supybot.callbacks as callbacks
2004-01-07 16:17:53 +01:00
2004-02-23 12:08:22 +01:00
unitAbbrevs = utils.abbrev(['Fahrenheit', 'Celsius', 'Centigrade', 'Kelvin'])
unitAbbrevs['C'] = 'Celsius'
unitAbbrevs['Ce'] = 'Celsius'
noLocationError = 'No such location could be found.'
2004-10-09 06:39:10 +02:00
class NoLocation(callbacks.Error):
pass
class WeatherUnit(registry.String):
def setValue(self, s):
2004-02-23 12:08:22 +01:00
#print '***', repr(s)
s = s.capitalize()
if s not in unitAbbrevs:
raise registry.InvalidRegistryValue,\
2004-03-30 10:32:17 +02:00
'Unit must be one of Fahrenheit, Celsius, or Kelvin.'
2004-02-23 12:08:22 +01:00
s = unitAbbrevs[s]
registry.String.setValue(self, s)
class WeatherCommand(registry.String):
2004-02-23 10:05:12 +01:00
def setValue(self, s):
m = Weather.weatherCommands
if s not in m:
raise registry.InvalidRegistryValue,\
2004-03-30 10:32:17 +02:00
'Command must be one of %s' % utils.commaAndify(m)
2004-02-23 10:05:12 +01:00
else:
method = getattr(Weather, s)
2004-02-23 10:49:47 +01:00
Weather.weather.im_func.__doc__ = method.__doc__
2004-02-23 10:05:12 +01:00
registry.String.setValue(self, s)
2004-03-30 10:32:17 +02:00
# Registry variables moved to the bottom to use Weather.weatherCommands.
2004-01-07 16:17:53 +01:00
class Weather(callbacks.Privmsg):
2004-07-20 07:26:52 +02:00
"""This should never be seen, because this plugin defines a command by
the name of 'weather' which should override this help."""
2004-10-09 06:39:10 +02:00
weatherCommands = ['wunder', 'cnn', 'ham']
2004-01-07 16:17:53 +01:00
threaded = True
def __init__(self):
self.__parent = super(Weather, self)
self.__parent.__init__()
def callCommand(self, name, irc, msg, *L, **kwargs):
2004-01-07 16:17:53 +01:00
try:
self.__parent.callCommand(name, irc, msg, *L, **kwargs)
2004-01-07 16:17:53 +01:00
except webutils.WebError, e:
irc.error(str(e))
2004-10-09 06:39:10 +02:00
def _noLocation(self):
raise NoLocation, noLocationError
2004-10-23 22:26:40 +02:00
def weather(self, irc, msg, args, location):
2004-02-23 10:05:12 +01:00
# This specifically does not have a docstring.
channel = None
if ircutils.isChannel(msg.args[0]):
channel = msg.args[0]
if not location:
location = self.userValue('lastLocation', msg.prefix)
if not location:
raise callbacks.ArgumentError
2004-09-25 19:55:22 +02:00
self.setUserValue('lastLocation', msg.prefix,
location, ignoreNoUser=True)
args = [location]
2004-02-25 16:46:22 +01:00
realCommandName = self.registryValue('command', channel)
2004-02-23 10:05:12 +01:00
realCommand = getattr(self, realCommandName)
2004-10-09 06:39:10 +02:00
try:
realCommand(irc, msg, args[:])
2004-10-09 06:39:10 +02:00
except NoLocation:
self.log.info('%s lookup failed, Trying others.', realCommandName)
for command in self.weatherCommands:
if command != realCommandName:
self.log.info('Trying %s.', command)
try:
getattr(self, command)(irc, msg, args[:])
2004-10-09 06:39:10 +02:00
self.log.info('%s lookup succeeded.', command)
break
except NoLocation:
self.log.info('%s lookup failed as backup.', command)
weather = wrap(weather, [additional('text')])
2004-02-23 12:08:22 +01:00
def _toCelsius(self, temp, unit):
if unit == 'K':
return temp - 273.15
2004-02-23 12:35:06 +01:00
elif unit == 'F':
2004-02-23 12:08:22 +01:00
return (temp - 32) * 5 /9
2004-02-23 12:35:06 +01:00
else:
return temp
2004-02-23 12:08:22 +01:00
_temp = re.compile(r'(-?\d+)(.*?)(F|C)')
def _getTemp(self, temp, deg, unit, chan):
2004-02-23 12:08:22 +01:00
assert unit == unit.upper()
assert temp == int(temp)
default = self.registryValue('temperatureUnit', chan)
if unitAbbrevs[unit] == default:
2004-02-23 10:49:47 +01:00
# Short circuit if we're the same unit as the default.
2004-02-23 12:08:22 +01:00
return '%s%s%s' % (temp, deg, unit)
temp = self._toCelsius(temp, unit)
unit = 'C'
if default == 'Kelvin':
temp = temp + 273.15
unit = 'K'
deg = ' '
elif default == 'Fahrenheit':
temp = temp * 9 / 5 + 32
unit = 'F'
return '%s%s%s' % (temp, deg, unit)
_hamLoc = re.compile(
r'<td><font size="4" face="arial"><b>'
r'(.*?), (.*?),(.*?)</b></font></td>', re.I)
2004-01-07 16:17:53 +01:00
_interregex = re.compile(
r'<td><font size="4" face="arial"><b>'
r'([^,]+), ([^<]+)</b></font></td>', re.I)
_hamCond = re.compile(
r'<td width="100%" colspan="2" align="center"><strong>'
r'<font face="arial">([^<]+)</font></strong></td>', re.I)
_hamTemp = re.compile(
r'<td valign="top" align="right"><strong><font face="arial">'
2004-02-23 12:08:22 +01:00
r'(-?\d+)(.*?)(F|C)</font></strong></td>', re.I)
_hamChill = re.compile(
2004-02-23 12:08:22 +01:00
r'Wind Chill</font></strong>:</small></td>\s+<td align="right">'
r'<small><font face="arial">([^N][^<]+)</font></small></td>',
re.I | re.S)
_hamHeat = re.compile(
2004-02-23 12:08:22 +01:00
r'Heat Index</font></strong>:</small></td>\s+<td align="right">'
r'<small><font face="arial">([^N][^<]+)</font></small></td>',
re.I | re.S)
2004-01-07 16:17:53 +01:00
# States
_realStates = sets.Set(['ak', 'al', 'ar', 'az', 'ca', 'co', 'ct',
2004-01-11 15:47:44 +01:00
'dc', 'de', 'fl', 'ga', 'hi', 'ia', 'id',
'il', 'in', 'ks', 'ky', 'la', 'ma', 'md',
'me', 'mi', 'mn', 'mo', 'ms', 'mt', 'nc',
'nd', 'ne', 'nh', 'nj', 'nm', 'nv', 'ny',
'oh', 'ok', 'or', 'pa', 'ri', 'sc', 'sd',
'tn', 'tx', 'ut', 'va', 'vt', 'wa', 'wi',
'wv', 'wy'])
2004-01-07 16:17:53 +01:00
# Provinces. (Province being a metric state measurement mind you. :D)
_fakeStates = sets.Set(['ab', 'bc', 'mb', 'nb', 'nf', 'ns', 'nt',
'nu', 'on', 'pe', 'qc', 'sk', 'yk'])
# Certain countries are expected to use a standard abbreviation
# The weather we pull uses weird codes. Map obvious ones here.
_hamCountryMap = {'uk': 'gb'}
def ham(self, irc, msg, args, loc):
2004-02-17 07:29:19 +01:00
"""<US zip code | US/Canada city, state | Foreign city, country>
2004-01-07 16:17:53 +01:00
Returns the approximate weather conditions for a given city.
"""
2004-01-07 16:17:53 +01:00
#If we received more than one argument, then we have received
#a city and state argument that we need to process.
if ' ' in loc:
2004-01-07 16:17:53 +01:00
#If we received more than 1 argument, then we got a city with a
#multi-word name. ie ['Garden', 'City', 'KS'] instead of
#['Liberal', 'KS']. We join it together with a + to pass
#to our query
loc = rsplit(loc, None, 1)
state = loc.pop().lower()
city = '+'.join(loc)
city = city.rstrip(',').lower()
2004-01-07 16:17:53 +01:00
#We must break the States up into two sections. The US and
#Canada are the only countries that require a State argument.
2004-01-07 16:17:53 +01:00
if state in self._realStates:
country = 'us'
elif state in self._fakeStates:
country = 'ca'
else:
country = state
state = ''
if country in self._hamCountryMap.keys():
country = self._hamCountryMap[country]
url = 'http://www.hamweather.net/cgi-bin/hw3/hw3.cgi?' \
'pass=&dpp=&forecast=zandh&config=&' \
'place=%s&state=%s&country=%s' % (city, state, country)
2004-01-11 15:47:44 +01:00
html = webutils.getUrl(url)
if 'was not found' in html:
url = 'http://www.hamweather.net/cgi-bin/hw3/hw3.cgi?' \
'pass=&dpp=&forecast=zandh&config=&' \
'place=%s&state=&country=%s' % (city, state)
html = webutils.getUrl(url)
if 'was not found' in html: # Still.
2004-10-09 06:39:10 +02:00
self._noLocation()
2004-01-07 16:17:53 +01:00
#We received a single argument. Zipcode or station id.
else:
zip = loc.replace(',', '')
zip = zip.lower()
url = 'http://www.hamweather.net/cgi-bin/hw3/hw3.cgi?' \
'config=&forecast=zandh&pands=%s&Submit=GO' % zip
2004-01-07 16:17:53 +01:00
html = webutils.getUrl(url)
2004-01-11 15:47:44 +01:00
if 'was not found' in html:
2004-10-09 06:39:10 +02:00
self._noLocation()
headData = self._hamLoc.search(html)
2004-02-08 08:16:58 +01:00
if headData is not None:
2004-01-07 16:17:53 +01:00
(city, state, country) = headData.groups()
else:
headData = self._interregex.search(html)
2004-01-11 15:47:44 +01:00
if headData:
(city, state) = headData.groups()
else:
2004-10-09 06:39:10 +02:00
self._noLocation()
2004-01-07 16:17:53 +01:00
city = city.strip()
state = state.strip()
temp = self._hamTemp.search(html)
convert = self.registryValue('convert', msg.args[0])
2004-02-08 08:16:58 +01:00
if temp is not None:
2004-02-23 12:08:22 +01:00
(temp, deg, unit) = temp.groups()
if convert:
temp = self._getTemp(int(temp), deg, unit, msg.args[0])
else:
temp = deg.join((temp, unit))
conds = self._hamCond.search(html)
2004-02-08 08:16:58 +01:00
if conds is not None:
2004-01-07 16:17:53 +01:00
conds = conds.group(1)
index = ''
chill = self._hamChill.search(html)
2004-02-08 08:16:58 +01:00
if chill is not None:
2004-01-07 16:17:53 +01:00
chill = chill.group(1)
2004-02-23 12:08:22 +01:00
chill = utils.htmlToText(chill)
if convert:
tempsplit = self._temp.search(chill)
if tempsplit:
(chill, deg, unit) = tempsplit.groups()
chill = self._getTemp(int(chill), deg, unit,msg.args[0])
if float(chill[:-2]) < float(temp[:-2]):
index = ' (Wind Chill: %s)' % chill
heat = self._hamHeat.search(html)
2004-02-08 07:24:00 +01:00
if heat is not None:
2004-01-07 16:17:53 +01:00
heat = heat.group(1)
2004-02-23 12:08:22 +01:00
heat = utils.htmlToText(heat)
if convert:
tempsplit = self._temp.search(heat)
if tempsplit:
(heat, deg, unit) = tempsplit.groups()
if convert:
heat = self._getTemp(int(heat), deg, unit,msg.args[0])
if float(heat[:-2]) > float(temp[:-2]):
index = ' (Heat Index: %s)' % heat
2004-01-07 16:17:53 +01:00
if temp and conds and city and state:
2004-02-08 08:16:58 +01:00
conds = conds.replace('Tsra', 'Thunderstorms')
2004-06-06 23:21:15 +02:00
conds = conds.replace('Ts', 'Thunderstorms')
2004-07-29 20:36:45 +02:00
s = 'The current temperature in %s, %s is %s%s. Conditions: %s.'% \
2004-01-07 16:17:53 +01:00
(city, state, temp, index, conds)
irc.reply(s)
2004-01-07 16:17:53 +01:00
else:
2004-10-09 06:39:10 +02:00
irc.errorPossibleBug('The format of the page was odd.')
ham = commands.wrap(ham, ['text'])
2004-01-07 16:17:53 +01:00
_cnnUrl = 'http://weather.cnn.com/weather/search?wsearch='
_cnnFTemp = re.compile(r'(-?\d+)(&deg;)(F)</span>', re.I | re.S)
_cnnCond = re.compile(r'align="center"><b>([^<]+)</b></div></td>',
re.I | re.S)
_cnnHumid = re.compile(r'Rel. Humidity: <b>(\d+%)</b>', re.I | re.S)
_cnnWind = re.compile(r'Wind: <b>([^<]+)</b>', re.I | re.S)
_cnnLoc = re.compile(r'<title>([^<]+)</title>', re.I | re.S)
2004-10-11 14:09:59 +02:00
_cnnMultiLoc = re.compile(r'href="([^f]+forecast.jsp[^"]+)', re.I)
# Certain countries are expected to use a standard abbreviation
# The weather we pull uses weird codes. Map obvious ones here.
_cnnCountryMap = {'uk': 'en', 'de': 'ge'}
def cnn(self, irc, msg, args, loc):
"""<US zip code | US/Canada city, state | Foreign city, country>
Returns the approximate weather conditions for a given city.
"""
if ' ' in loc:
#If we received more than 1 argument, then we got a city with a
#multi-word name. ie ['Garden', 'City', 'KS'] instead of
#['Liberal', 'KS'].
loc = rsplit(loc, None, 1)
state = loc.pop().lower()
city = ' '.join(loc)
city = city.rstrip(',').lower()
if state in self._cnnCountryMap:
state = self._cnnCountryMap[state]
loc = ' '.join([city, state])
else:
#We received a single argument. Zipcode or station id.
loc = loc.replace(',', '')
url = '%s%s' % (self._cnnUrl, urllib.quote(loc))
text = webutils.getUrl(url) # Errors caught in callCommand.
2004-10-09 06:39:10 +02:00
if 'No search results' in text or \
2004-10-11 14:09:59 +02:00
'does not match a zip code' in text:
2004-10-09 06:39:10 +02:00
self._noLocation()
2004-10-11 14:09:59 +02:00
elif 'several matching locations for' in text:
m = self._cnnMultiLoc.search(text)
if m:
text = webutils.getUrl(m.group(1))
else:
self._noLocation()
location = self._cnnLoc.search(text)
temp = self._cnnFTemp.search(text)
conds = self._cnnCond.search(text)
humidity = self._cnnHumid.search(text)
wind = self._cnnWind.search(text)
convert = self.registryValue('convert', msg.args[0])
if location and temp:
location = location.group(1)
location = location.split('-')[-1].strip()
(temp, deg, unit) = temp.groups()
if convert:
temp = self._getTemp(int(temp), deg, unit, msg.args[0])
else:
temp = deg.join((temp, unit))
2004-07-29 20:36:45 +02:00
resp = ['The current temperature in %s is %s.' % (location, temp)]
if conds is not None:
resp.append('Conditions: %s.' % conds.group(1))
if humidity is not None:
resp.append('Humidity: %s.' % humidity.group(1))
if wind is not None:
resp.append('Wind: %s.' % wind.group(1))
resp = map(utils.htmlToText, resp)
irc.reply(' '.join(resp))
else:
2004-10-09 06:39:10 +02:00
irc.errorPossibleBug('Could not find weather information.')
cnn = commands.wrap(cnn, ['text'])
_wunderUrl = 'http://mobile.wunderground.com/cgi-bin/' \
'findweather/getForecast?query='
_wunderLoc = re.compile(r'Page (.+?) Forecast</title>', re.I | re.S)
_wunderMultiLoc = re.compile(r'<a href="([^"]+)', re.I | re.S)
def wunder(self, irc, msg, args, loc):
"""<US zip code | US/Canada city, state | Foreign city, country>
Returns the approximate weather conditions for a given city.
"""
url = '%s%s' % (self._wunderUrl, urllib.quote(loc))
text = webutils.getUrl(url)
if 'Search not found' in text:
2004-10-09 06:39:10 +02:00
self._noLocation()
if 'Click on a city name' in text:
soup = BeautifulSoup.BeautifulSoup()
soup.feed(text)
newloc = soup.first('a').get('href')
if newloc is None:
irc.error('Multiple locations found. '
'Please be more specific.', Raise=True)
url = 'http://mobile.wunderground.com%s' % newloc
text = webutils.getUrl(url)
soup.close()
soup = BeautifulSoup.BeautifulSoup()
soup.feed(text)
# Get the table with all the weather info
table = soup.first('table', {'border':'1'})
trs = table.fetch('tr')
try:
time = trs.pop(0).first('b').string
except AttributeError:
time = ''
info = {}
def isText(t):
return not isinstance(t,BeautifulSoup.NavigableText) and t.contents
def getText(t):
s = getattr(t, 'string', None)
if s is None:
t = t.contents
num = t[0].string
units = t[1].string
# htmlToText strips leading whitespace, so we have to handle
# strings with &nbsp; differently.
if units.startswith('&nbsp;'):
units = utils.htmlToText(units)
s = ' '.join((num, units))
else:
units = utils.htmlToText(units)
s = ' '.join((num, units[0], units[1:]))
return s
for tr in trs:
k = tr.first('td').string
v = filter(isText, tr.fetch('td')[1].contents)
value = map(getText, v)
info[k] = ' '.join(value)
location = self._wunderLoc.search(text)
temp = info['Temperature']
convert = self.registryValue('convert', msg.args[0])
if location and temp:
(temp, deg, unit) = temp.split()
if convert:
temp = self._getTemp(int(temp), deg, unit, msg.args[0])
else:
temp = deg.join((temp, unit))
resp = ['The current temperature in %s is %s (%s).' %\
(location.group(1), temp, time)]
conds = info['Conditions']
resp.append('Conditions: %s.' % info['Conditions'])
humidity = info['Humidity']
resp.append('Humidity: %s.' % info['Humidity'])
# Apparently, the "Dew Point" and "Wind" categories are occasionally
# set to "-" instead of an actual reading. So, we'll just catch
# the ValueError from trying to unpack a tuple of the wrong size.
try:
(dew, deg, unit) = info['Dew Point'].split()
if convert:
dew = self._getTemp(int(dew), deg, unit, msg.args[0])
else:
dew = deg.join((dew, unit))
resp.append('Dew Point: %s.' % dew)
except ValueError:
pass
try:
resp.append('Wind: %s at %s %s.' % tuple(info['Wind'].split()))
except ValueError:
pass
resp.append('Pressure: %s.' % info['Pressure'])
resp.append('Visibility: %s.' % info['Visibility'])
resp = map(utils.htmlToText, resp)
irc.reply(' '.join(resp))
else:
irc.error('Could not find weather information.')
wunder = commands.wrap(wunder, ['text'])
2004-01-07 16:17:53 +01:00
2004-02-23 10:49:47 +01:00
conf.registerPlugin('Weather')
2004-02-23 12:08:22 +01:00
conf.registerChannelValue(conf.supybot.plugins.Weather, 'temperatureUnit',
2004-02-23 10:49:47 +01:00
WeatherUnit('Fahrenheit', """Sets the default temperature unit to use when
reporting the weather."""))
2004-02-25 16:46:22 +01:00
conf.registerChannelValue(conf.supybot.plugins.Weather, 'command',
WeatherCommand('wunder', """Sets the default command to use when retrieving
2004-03-30 10:32:17 +02:00
the weather. Command must be one of %s.""" %
utils.commaAndify(Weather.weatherCommands, And='or')))
conf.registerChannelValue(conf.supybot.plugins.Weather, 'convert',
registry.Boolean(True, """Determines whether the weather commands will
automatically convert weather units to the unit specified in
supybot.plugins.Weather.temperatureUnit."""))
2004-02-23 10:49:47 +01:00
conf.registerUserValue(conf.users.plugins.Weather, 'lastLocation',
registry.String('', ''))
2004-01-07 16:17:53 +01:00
Class = Weather
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: