X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=data%2Frbot%2Fplugins%2Fweather.rb;h=d8f7579c95c45cda0ce9d93480b164f4e260d116;hb=783ffa4235330029d661752b1023db635b26f2b3;hp=3e4134e4b4c70c88531337ff316976f1f29e35aa;hpb=21949774b91eaec6ecde4eaa8ad121e2c0a36b87;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/data/rbot/plugins/weather.rb b/data/rbot/plugins/weather.rb index 3e4134e4..d8f7579c 100644 --- a/data/rbot/plugins/weather.rb +++ b/data/rbot/plugins/weather.rb @@ -1,55 +1,305 @@ +#-- vim:sw=2:et +#++ +# +# :title: Weather plugin for rbot +# +# Author:: MrChucho (mrchucho@mrchucho.net): NOAA National Weather Service support +# Author:: Giuseppe "Oblomov" Bilotta +# +# Copyright:: (C) 2006 Ralph M. Churchill +# Copyright:: (C) 2006-2007 Giuseppe Bilotta +# +# License:: GPL v2 + +require 'rexml/document' + +# Wraps NOAA National Weather Service information +class CurrentConditions + def initialize(station) + @station = station + @url = "http://www.nws.noaa.gov/data/current_obs/#{@station.upcase}.xml" + @etag = String.new + @mtime = Time.mktime(0) + @current_conditions = String.new + @iscached = false + end + def update + begin + open(@url,"If-Modified-Since" => @mtime.rfc2822) do |feed| + # open(@url,"If-None-Match"=>@etag) do |feed| + @etag = feed.meta['etag'] + @mtime = feed.last_modified + cc_doc = (REXML::Document.new feed).root + @iscached = false + @current_conditions = parse(cc_doc) + end + rescue OpenURI::HTTPError => e + case e + when /304/: + @iscached = true + when /404/: + raise "Data for #{@station} not found" + else + raise "Error retrieving data: #{e}" + end + end + @current_conditions # +" Cached? "+ ((@iscached) ? "Y" : "N") + end + def parse(cc_doc) + cc = Hash.new + cc_doc.elements.each do |c| + cc[c.name.to_sym] = c.text + end + "At #{cc[:observation_time_rfc822]}, the wind was #{cc[:wind_string]} at #{cc[:location]} (#{cc[:station_id]}). The temperature was #{cc[:temperature_string]}#{heat_index_or_wind_chill(cc)}, and the pressure was #{cc[:pressure_string]}. The relative humidity was #{cc[:relative_humidity]}%. Current conditions are #{cc[:weather]} with #{cc[:visibility_mi]}mi visibility." + end +private + def heat_index_or_wind_chill(cc) + hi = cc[:heat_index_string] + wc = cc[:windchill_string] + if hi != 'NA' then + " with a heat index of #{hi}" + elsif wc != 'NA' then + " with a windchill of #{wc}" + else + "" + end + end +end + class WeatherPlugin < Plugin - + + Config.register Config::BooleanValue.new('weather.advisory', + :default => true, + :desc => "Should the bot report special weather advisories when any is present?") + def help(plugin, topic="") - "weather => display the current weather at the location specified by the ICAO code [Lookup your ICAO code at http://www.nws.noaa.gov/oso/siteloc.shtml] - this will also store the ICAO against your nick, so you can later just say \"weather\", weather => display the current weather at the location you last asked for" + case topic + when "nws" + "weather nws => display the current conditions at the location specified by the NOAA National Weather Service station code ( lookup your station code at http://www.nws.noaa.gov/data/current_obs/ )" + when "station", "wu" + "weather [] => display the current conditions at the location specified, looking it up on the Weather Underground site; you can use 'station ' to look up data by station code ( lookup your station code at http://www.weatherunderground.com/ ); you can optionally set to 'metric' or 'english' if you only want data with the units; use 'both' for units to go back to having both." + else + "weather information lookup. Looks up weather information for the last location you specified. See topics 'nws' and 'wu' for more information" + end end - + def initialize super - # this plugin only wants to store strings - class << @registry - def store(val) - val + + @nws_cache = Hash.new + + @wu_url = "http://mobile.wunderground.com/cgi-bin/findweather/getForecast?brand=mobile%s&query=%s" + @wu_station_url = "http://mobile.wunderground.com/auto/mobile%s/global/stations/%s.html" + end + + def weather(m, params) + if params[:where].empty? + if @registry.has_key?(m.sourcenick) + where = @registry[m.sourcenick] + debug "Loaded weather info #{where.inspect} for #{m.sourcenick}" + + service = where.first.to_sym + loc = where[1].to_s + units = params[:units] || where[2] rescue nil + else + debug "No weather info for #{m.sourcenick}" + m.reply "I don't know where you are yet, #{m.sourcenick}. See 'help weather nws' or 'help weather wu' for additional help" + return end - def restore(val) - val + else + where = params[:where] + if ['nws','station'].include?(where.first) + service = where.first.to_sym + loc = where[1].to_s + else + service = :wu + loc = where.to_s end + units = params[:units] end - @metar_cache = Hash.new + + if loc.empty? + debug "No weather location found for #{m.sourcenick}" + m.reply "I don't know where you are yet, #{m.sourcenick}. See 'help weather nws' or 'help weather wu' for additional help" + return + end + + wu_units = String.new + if units + case units.to_sym + when :english, :metric + wu_units = "_#{units}" + when :both + else + m.reply "Ignoring unknown units #{units}" + wu_units = String.new + end + end + + case service + when :nws + nws_describe(m, loc) + when :station + wu_station(m, loc, wu_units) + when :wu + wu_weather(m, loc, wu_units) + end + + @registry[m.sourcenick] = [service, loc, units] end - - def describe(m, where) - if @metar_cache.has_key?(where) && - Time.now - @metar_cache[where].date < 3600 - met = @metar_cache[where] + + def nws_describe(m, where) + if @nws_cache.has_key?(where) then + met = @nws_cache[where] else - met = Utils.get_metar(where) + met = CurrentConditions.new(where) end - if met - m.reply met.pretty_print - @metar_cache[where] = met + begin + m.reply met.update + @nws_cache[where] = met + rescue => e + m.reply e.message + end else m.reply "couldn't find weather data for #{where}" end end - - def privmsg(m) - case m.params - when nil - if @registry.has_key?(m.sourcenick) - where = @registry[m.sourcenick] - describe(m,where) + + def wu_station(m, where, units) + begin + xml = @bot.httputil.get(@wu_station_url % [units, CGI.escape(where)]) + case xml + when nil + m.reply "couldn't retrieve weather information, sorry" + return + when /Search not found:/ + m.reply "no such station found (#{where})" + return + when /(.*?)<\/table>/m + data = $1.dup + m.reply wu_weather_filter(data) + wu_out_special(m, xml) + else + debug xml + m.reply "something went wrong with the data for #{where}..." + end + rescue => e + m.reply "retrieving info about '#{where}' failed (#{e})" + end + end + + def wu_weather(m, where, units) + begin + xml = @bot.httputil.get(@wu_url % [units, CGI.escape(where)]) + case xml + when nil + m.reply "couldn't retrieve weather information, sorry" + when /City Not Found/ + m.reply "no such location found (#{where})" + when /Current<\/a>/ + data = "" + xml.scan(/
(.*?)<\/table>/m).each do |match| + data += wu_weather_filter(match.first) + end + if data.length > 0 + m.reply data + else + m.reply "couldn't parse weather data from #{where}" + end + wu_out_special(m, xml) + when / e + m.reply "retrieving info about '#{where}' failed (#{e})" + end + end + + def wu_clean(stuff) + txt = stuff + txt.gsub!(/[\n\s]+/,' ') + txt.gsub!(/ /, ' ') + txt.gsub!(/°/, ' ') # degree sign + txt.gsub!(/<\/?b>/,'') + txt.gsub!(/<\/?span[^<>]*?>/,'') + txt.gsub!(/]*?>/,'') + txt.gsub!(//,'') + txt + end + + def wu_weather_multi(m, xml) + # debug xml + stations = xml.scan(/\\s+\\s+
\s*(?:]*>]+><\/a>\s*)?(.*?)<\/a>\s*:\s*(.*?)<\/td>/m) + # debug stations + m.reply "multiple stations available, use 'weather station ' or 'weather ' as appropriate, for one of the following (current temp shown):" + stations.map! { |ar| + warning = ar[0] + loc = ar[2] + state = ar[1] + par = ar[3] + w = ar[4] + if state # US station + (warning ? "*" : "") + ("%s, %s (%s): %s" % [loc, state, par, wu_clean(w)]) + else # non-US station + (warning ? "*" : "") + ("station %s (%s): %s" % [loc, par, wu_clean(w)]) + end + } + m.reply stations.join("; ") + end + + def wu_check_special(xml) + specials = [] + # We only scan the first half to prevent getting the advisories twice + xml[0,xml.length/2].scan(%r{]*>([^<]+)}) do + special = { + :url => "http://mobile.wunderground.com"+$1, + :type => $2.dup, + :special => $3.dup + } + spec_rx = Regexp.new("(?:.+?)\\s+(.+?)\\s+
", Regexp::MULTILINE) + spec_xml = @bot.httputil.get(special[:url]) + if spec_xml and spec_td = spec_xml.match(spec_rx) + special.merge!(:text => spec_td.captures.first.ircify_html) + end + specials << special + end + return specials + end + + def wu_out_special(m, xml) + return unless @bot.config['weather.advisory'] + specials = wu_check_special(xml) + debug specials + specials.each do |special| + special.merge!(:underline => Underline) + if special[:text] + m.reply("%{underline}%{special}%{underline}: %{text}" % special) else - m.reply "I don't know where #{m.sourcenick} is!" + m.reply("%{underline}%{special}%{underline} @ %{url}" % special) end - when (/^(\S{4})$/) - where = $1 - @registry[m.sourcenick] = where - describe(m,where) end end - + + def wu_weather_filter(stuff) + txt = wu_clean(stuff) + + result = Array.new + if txt.match(/<\/a>\s*Updated:\s*(.*?)\s*Observed at\s*(.*?)\s*<\/td>/) + result << ("Weather info for %s (updated on %s)" % [$2, $1]) + end + txt.scan(/\s*\s*(.*?)\s*<\/td>\s*\s*(.*?)\s*<\/td>\s*<\/tr>/) { |k, v| + next if v.empty? + next if ["-", "- approx.", "N/A", "N/A approx."].include?(v) + next if k == "Raw METAR" + result << ("%s: %s" % [k, v]) + } + return result.join('; ') + end end + plugin = WeatherPlugin.new -plugin.register("weather") +plugin.map 'weather :units *where', :defaults => {:where => false, :units => false}, :requirements => {:units => /metric|english|both/}