]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/weather.rb
remove whitespace
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / weather.rb
index 7a48ef2354181ccabafb2832151b1cf91e0ba8c3..d8f7579c95c45cda0ce9d93480b164f4e260d116 100644 (file)
@@ -1,12 +1,16 @@
-# Weather plugin for rbot
+#-- vim:sw=2:et
+#++
 #
-# NOAA National Weather Service support by MrChucho (mrchucho@mrchucho.net)
-# Copyright (C) 2006 Ralph M. Churchill
+# :title: Weather plugin for rbot
 #
-# Weather Undeground support by Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
-# Copyright (C) 2006 Giuseppe Bilotta
+# Author:: MrChucho (mrchucho@mrchucho.net): NOAA National Weather Service support
+# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
+#
+# Copyright:: (C) 2006 Ralph M. Churchill
+# Copyright:: (C) 2006-2007 Giuseppe Bilotta
+#
+# License:: GPL v2
 
-require 'uri'
 require 'rexml/document'
 
 # Wraps NOAA National Weather Service information
@@ -63,35 +67,40 @@ private
 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="")
     case topic
     when "nws"
       "weather nws <station> => display the current conditions at the location specified by the NOAA National Weather Service station code <station> ( lookup your station code at http://www.nws.noaa.gov/data/current_obs/ )"
     when "station", "wu"
-      "weather <location> => display the current conditions at the location specified, looking it up on the Weather Underground site; you can use 'station <code>' to look up data by station code ( lookup your station code at http://www.weatherunderground.com/ )" 
+      "weather [<units>] <location> => display the current conditions at the location specified, looking it up on the Weather Underground site; you can use 'station <code>' to look up data by station code ( lookup your station code at http://www.weatherunderground.com/ ); you can optionally set <units>  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
 
     @nws_cache = Hash.new
 
-    @wu_url="http://mobile.wunderground.com/cgi-bin/findweather/getForecast?brand=mobile&query=%s"
-    @wu_station_url="http://mobile.wunderground.com/global/stations/%s.html"
+    @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)
-    loc = nil
-    service = nil
     if params[:where].empty?
       if @registry.has_key?(m.sourcenick)
         where = @registry[m.sourcenick]
         debug "Loaded weather info #{where.inspect} for #{m.sourcenick}"
-        save = false
+
+        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"
@@ -99,29 +108,44 @@ class WeatherPlugin < Plugin
       end
     else
       where = params[:where]
-      save = true
-      unless ['nws','station'].include?(where.first)
-        loc = where.to_s
+      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
-    unless service
-      loc = where[1].to_s
-      service = where.first.to_sym
-    end
+
     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_station(m, loc, wu_units)
     when :wu
-      wu_weather(m, loc)
+      wu_weather(m, loc, wu_units)
     end
-    @registry[m.sourcenick] = [service, loc] if save
+
+    @registry[m.sourcenick] = [service, loc, units]
   end
 
   def nws_describe(m, where)
@@ -142,16 +166,20 @@ class WeatherPlugin < Plugin
     end
   end
 
-  def wu_station(m, where)
+  def wu_station(m, where, units)
     begin
-      xml = @bot.httputil.get_cached(@wu_station_url % URI.escape(where))
+      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 border.*?>(.*?)<\/table>/m
-        data = $1
+        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}..."
@@ -161,22 +189,27 @@ class WeatherPlugin < Plugin
     end
   end
 
-  def wu_weather(m, where)
+  def wu_weather(m, where, units)
     begin
-      xml = @bot.httputil.get_cached(@wu_url % URI.escape(where))
+      xml = @bot.httputil.get(@wu_url % [units, CGI.escape(where)])
       case xml
       when nil
         m.reply "couldn't retrieve weather information, sorry"
-        return
       when /City Not Found/
         m.reply "no such location found (#{where})"
-        return
-      when /<table border.*?>(.*?)<\/table>/m
-        data = $1
-        m.reply wu_weather_filter(data)
-      when /<a href="\/global\/stations\//
-        stations = xml.scan(/<a href="\/global\/stations\/(.*?)\.html">/)
-        m.reply "multiple stations available, use 'weather station <code>' where code is one of " + stations.join(", ")
+      when /Current<\/a>/
+        data = ""
+        xml.scan(/<table border.*?>(.*?)<\/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 /<a href="\/(?:global\/stations|US\/\w\w)\//
+        wu_weather_multi(m, xml)
       else
         debug xml
         m.reply "something went wrong with the data from #{where}..."
@@ -186,29 +219,87 @@ class WeatherPlugin < Plugin
     end
   end
 
-  def wu_weather_filter(stuff)
+  def wu_clean(stuff)
     txt = stuff
     txt.gsub!(/[\n\s]+/,' ')
-    data = Hash.new
     txt.gsub!(/&nbsp;/, ' ')
     txt.gsub!(/&#176;/, ' ') # degree sign
     txt.gsub!(/<\/?b>/,'')
     txt.gsub!(/<\/?span[^<>]*?>/,'')
     txt.gsub!(/<img\s*[^<>]*?>/,'')
     txt.gsub!(/<br\s?\/?>/,'')
+    txt
+  end
+
+  def wu_weather_multi(m, xml)
+    # debug xml
+    stations = xml.scan(/<td>\s*(?:<a href="([^?"]+\?feature=[^"]+)"\s*[^>]*><img [^>]+><\/a>\s*)?<a href="\/(?:global\/stations|US\/(\w\w))\/([^"]*?)\.html">(.*?)<\/a>\s*:\s*(.*?)<\/td>/m)
+    # debug stations
+    m.reply "multiple stations available, use 'weather station <code>' or 'weather <city, state>' 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{<a href="([^"]+\?[^"]*feature=warning#([^"]+))"[^>]*>([^<]+)</a>}) do
+      special = {
+        :url => "http://mobile.wunderground.com"+$1,
+        :type => $2.dup,
+        :special => $3.dup
+      }
+      spec_rx = Regexp.new("<a name=\"#{special[:type]}\">(?:.+?)<td align=\"left\">\\s+(.+?)\\s+</td>\\s+</tr>\\s+</table>", 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("%{underline}%{special}%{underline} @ %{url}" % special)
+      end
+    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(/<tr>\s*<td>\s*(.*?)\s*<\/td>\s*<td>\s*(.*?)\s*<\/td>\s*<\/tr>/) { |k, v|
-      unless v.empty? or v == "-" or k =="Raw METAR"
-        result << ("%s: %s" % [k, v])
-      end
+      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.map 'weather *where', :defaults => {:where => false}
+plugin.map 'weather :units *where', :defaults => {:where => false, :units => false}, :requirements => {:units => /metric|english|both/}