]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/rss.rb
Move extensions to standard classes into a specific extends.rb util module
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / rss.rb
index 3607f8c50d7c31879e92a9c488af5a92d754ced0..acebda9cc0d030d48afee4ea63c7fda2dac8c13a 100644 (file)
@@ -19,19 +19,18 @@ require 'rss/dublincore'
 #   warning "Unable to load RSS libraries, RSS plugin functionality crippled"\r
 # end\r
 \r
-class ::String\r
-  def riphtml\r
-    self.gsub(/<[^>]+>/, '').gsub(/&amp;/,'&').gsub(/&quot;/,'"').gsub(/&lt;/,'<').gsub(/&gt;/,'>').gsub(/&ellip;/,'...').gsub(/&apos;/, "'").gsub("\n",'')\r
-  end\r
-end\r
-\r
 class ::RssBlob\r
-  attr :url\r
-  attr :handle\r
-  attr :type\r
+  attr_accessor :url\r
+  attr_accessor :handle\r
+  attr_accessor :type\r
   attr :watchers\r
+  attr_accessor :refresh_rate\r
+  attr_accessor :xml\r
+  attr_accessor :title\r
+  attr_accessor :items\r
+  attr_accessor :mutex\r
 \r
-  def initialize(url,handle=nil,type=nil,watchers=[])\r
+  def initialize(url,handle=nil,type=nil,watchers=[], xml=nil)\r
     @url = url\r
     if handle\r
       @handle = handle\r
@@ -40,9 +39,22 @@ class ::RssBlob
     end\r
     @type = type\r
     @watchers=[]\r
+    @refresh_rate = nil\r
+    @xml = xml\r
+    @title = nil\r
+    @items = nil\r
+    @mutex = Mutex.new\r
     sanitize_watchers(watchers)\r
   end\r
 \r
+  def dup\r
+    self.class.new(@url,\r
+                   @handle,\r
+                   @type ? @type.dup : nil,\r
+                   @watchers.dup,\r
+                   @xml ? @xml.dup : nil)\r
+  end\r
+\r
   # Downcase all watchers, possibly turning them into Strings if they weren't\r
   def sanitize_watchers(list=@watchers)\r
     ls = list.dup\r
@@ -73,7 +85,7 @@ class ::RssBlob
   end\r
 \r
   def to_a\r
-    [@handle,@url,@type,@watchers]\r
+    [@handle,@url,@type,@refresh_rate,@watchers]\r
   end\r
 \r
   def to_s(watchers=false)\r
@@ -108,7 +120,9 @@ class RSSFeedsPlugin < Plugin
         @feeds.delete(k)\r
       }\r
       @feeds.each { |k, f|\r
+        f.mutex = Mutex.new unless f.mutex\r
         f.sanitize_watchers\r
+        parseRss(f) if f.xml\r
       }\r
     else\r
       @feeds = Hash.new\r
@@ -130,7 +144,16 @@ class RSSFeedsPlugin < Plugin
   end\r
 \r
   def save\r
-    @registry[:feeds] = @feeds\r
+    unparsed = Hash.new()\r
+    @feeds.each { |k, f|\r
+      f.mutex.synchronize do\r
+        unparsed[k] = f.dup\r
+      end\r
+    }\r
+    unparsed.each { |k, f|\r
+      debug f.inspect\r
+    }\r
+    @registry[:feeds] = unparsed\r
   end\r
 \r
   def stop_watch(handle)\r
@@ -161,6 +184,8 @@ class RSSFeedsPlugin < Plugin
       "rss watched [#{Bold}handle#{Bold}] : list all watched rss feeds (matching #{Bold}handle#{Bold})"\r
     when "add"\r
       "rss add #{Bold}handle#{Bold} #{Bold}url#{Bold} [#{Bold}type#{Bold}] : add a new rss called #{Bold}handle#{Bold} from url #{Bold}url#{Bold} (of type #{Bold}type#{Bold})"\r
+    when "change"\r
+      "rss change #{Bold}what#{Bold} of #{Bold}handle#{Bold} to #{Bold}new#{Bold} : change the #{Underline}handle#{Underline}, #{Underline}url#{Underline}, #{Underline}type#{Underline} or #{Underline}refresh#{Underline} rate of rss called #{Bold}handle#{Bold} to value #{Bold}new#{Bold}"\r
     when /^(del(ete)?|rm)$/\r
       "rss del(ete)|rm #{Bold}handle#{Bold} : delete rss feed #{Bold}handle#{Bold}"\r
     when "replace"\r
@@ -174,7 +199,7 @@ class RSSFeedsPlugin < Plugin
     when "rewatch"\r
       "rss rewatch : restart threads that watch for changes in watched rss"\r
     else\r
-      "manage RSS feeds: rss show|list|watched|add|del(ete)|rm|(force)replace|watch|unwatch|rmwatch|rewatch"\r
+      "manage RSS feeds: rss show|list|watched|add|change|del(ete)|rm|(force)replace|watch|unwatch|rmwatch|rewatch"\r
     end\r
   end\r
 \r
@@ -212,8 +237,17 @@ class RSSFeedsPlugin < Plugin
 \r
     m.reply "lemme fetch it..."\r
     title = items = nil\r
-    title, items = fetchRss(feed, m)\r
-    return unless items\r
+    fetched = fetchRss(feed, m)\r
+    return unless fetched or feed.xml\r
+    if not fetched and feed.items\r
+      m.reply "using old data"\r
+    else\r
+      parsed = parseRss(feed, m)\r
+      m.reply "using old data" unless parsed\r
+    end\r
+    return unless feed.items\r
+    title = feed.title\r
+    items = feed.items\r
 \r
     # We sort the feeds in freshness order (newer ones first)\r
     items = freshness_sort(items)\r
@@ -245,6 +279,7 @@ class RSSFeedsPlugin < Plugin
     @feeds.each { |handle, feed|\r
       next if wanted and !handle.match(/#{wanted}/i)\r
       reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
+      (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
       (reply << " (watched)") if feed.watched_by?(m.replyto)\r
       reply << "\n"\r
     }\r
@@ -261,7 +296,9 @@ class RSSFeedsPlugin < Plugin
     watchlist.each { |handle, feed|\r
       next if wanted and !handle.match(/#{wanted}/i)\r
       next unless feed.watched_by?(m.replyto)\r
-      reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})\n"\r
+      reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
+      (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
+      reply << "\n"\r
     }\r
     if reply.empty?\r
       reply = "no watched feeds"\r
@@ -295,6 +332,52 @@ class RSSFeedsPlugin < Plugin
     return handle\r
   end\r
 \r
+  def change_rss(m, params)\r
+    handle = params[:handle].downcase\r
+    feed = @feeds.fetch(handle, nil)\r
+    unless feed\r
+      m.reply "No such feed with handle #{handle}"\r
+      return\r
+    end\r
+    case params[:what].intern\r
+    when :handle\r
+      new = params[:new].downcase\r
+      if @feeds.key?(new) and @feeds[new]\r
+        m.reply "There already is a feed with handle #{new}"\r
+        return\r
+      else\r
+        feed.mutex.synchronize do\r
+          @feeds[new] = feed\r
+          @feeds.delete(handle)\r
+          feed.handle = new\r
+        end\r
+        handle = new\r
+      end\r
+    when :url\r
+      new = params[:new]\r
+      feed.mutex.synchronize do\r
+        feed.url = new\r
+      end\r
+    when :format, :type\r
+      new = params[:new]\r
+      new = nil if new == 'default'\r
+      feed.mutex.synchronize do\r
+        feed.type = new\r
+      end\r
+    when :refresh\r
+      new = params[:new].to_i\r
+      new = nil if new == 0\r
+      feed.mutex.synchronize do\r
+        feed.refresh_rate = new\r
+      end\r
+    else\r
+      m.reply "Don't know how to change #{params[:what]} for feeds"\r
+      return\r
+    end\r
+    m.reply "Feed changed:"\r
+    list_rss(m, {:handle => handle})\r
+  end\r
+\r
   def del_rss(m, params, pass=false)\r
     feed = unwatch_rss(m, params, true)\r
     if feed.watched?\r
@@ -377,42 +460,47 @@ class RSSFeedsPlugin < Plugin
       return\r
     end\r
     status = Hash.new\r
-    status[:oldItems] = []\r
-    status[:firstRun] = true\r
     status[:failures] = 0\r
     @watch[feed.handle] = @bot.timer.add(0, status) {\r
       debug "watcher for #{feed} started"\r
-      oldItems = status[:oldItems]\r
-      firstRun = status[:firstRun]\r
       failures = status[:failures]\r
       begin\r
         debug "fetching #{feed}"\r
-        title = newItems = nil\r
-        title, newItems = fetchRss(feed)\r
-        unless newItems\r
-          debug "no items in feed #{feed}"\r
-          failures +=1\r
+        oldxml = feed.xml ? feed.xml.dup : nil\r
+        unless fetchRss(feed)\r
+          failures += 1\r
         else\r
-          debug "Checking if new items are available for #{feed}"\r
-          if firstRun\r
-            debug "First run, we'll see next time"\r
-            firstRun = false\r
+          if oldxml and oldxml == feed.xml\r
+            debug "xml for #{feed} didn't change"\r
+            failures -= 1 if failures > 0\r
           else\r
-            otxt = oldItems.map { |item| item.to_s }\r
-            dispItems = newItems.reject { |item|\r
-              otxt.include?(item.to_s)\r
-            }\r
-            if dispItems.length > 0\r
-              debug "Found #{dispItems.length} new items in #{feed}"\r
-              # When displaying watched feeds, publish them from older to newer\r
-              dispItems.reverse.each { |item|\r
-                printFormattedRss(feed, item)\r
-              }\r
+            if not feed.items\r
+              debug "no previous items in feed #{feed}"\r
+              parseRss(feed)\r
+              failures -= 1 if failures > 0\r
             else\r
-              debug "No new items found in #{feed}"\r
+              otxt = feed.items.map { |item| item.to_s }\r
+              unless parseRss(feed)\r
+                debug "no items in feed #{feed}"\r
+                failures += 1\r
+              else\r
+                debug "Checking if new items are available for #{feed}"\r
+                failures -= 1 if failures > 0\r
+                dispItems = feed.items.reject { |item|\r
+                  otxt.include?(item.to_s)\r
+                }\r
+                if dispItems.length > 0\r
+                  debug "Found #{dispItems.length} new items in #{feed}"\r
+                  # When displaying watched feeds, publish them from older to newer\r
+                  dispItems.reverse.each { |item|\r
+                    printFormattedRss(feed, item)\r
+                  }\r
+                else\r
+                  debug "No new items found in #{feed}"\r
+                end\r
+              end\r
             end\r
           end\r
-          oldItems = newItems.dup\r
         end\r
       rescue Exception => e\r
         error "Error watching #{feed}: #{e.inspect}"\r
@@ -420,14 +508,14 @@ class RSSFeedsPlugin < Plugin
         failures += 1\r
       end\r
 \r
-      status[:oldItems] = oldItems\r
-      status[:firstRun] = firstRun\r
       status[:failures] = failures\r
 \r
-      seconds = @bot.config['rss.thread_sleep'] * (failures + 1)\r
-      seconds += seconds * (rand(100)-50)/100\r
-      debug "watcher for #{feed} going to sleep #{seconds} seconds.."\r
-      @bot.timer.reschedule(@watch[feed.handle], seconds)\r
+      feed.mutex.synchronize do\r
+        seconds = (feed.refresh_rate || @bot.config['rss.thread_sleep']) * (failures + 1)\r
+        seconds += seconds * (rand(100)-50)/100\r
+        debug "watcher for #{feed} going to sleep #{seconds} seconds.."\r
+        @bot.timer.reschedule(@watch[feed.handle], seconds)\r
+      end\r
     }\r
     debug "watcher for #{feed} added"\r
   end\r
@@ -471,7 +559,7 @@ class RSSFeedsPlugin < Plugin
       line1 = "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link}"\r
     when 'wiki'\r
       line1 = "#{handle}#{date}#{title}#{' @ ' if item.title && item.link}#{link} has been edited by #{item.dc_creator}. #{desc}"\r
-    when 'gmame'\r
+    when 'gmane'\r
       line1 = "#{handle}#{date}Message #{title} sent by #{item.dc_creator}. #{desc}"\r
     when 'trac'\r
       line1 = "#{handle}#{date}#{title} @ #{link}"\r
@@ -494,59 +582,71 @@ class RSSFeedsPlugin < Plugin
       xml = @bot.httputil.get_cached(feed.url, 60, 60)\r
     rescue URI::InvalidURIError, URI::BadURIError => e\r
       report_problem("invalid rss feed #{feed.url}", e, m)\r
-      return\r
+      return nil\r
     rescue => e\r
       report_problem("error getting #{feed.url}", e, m)\r
-      return\r
+      return nil\r
     end\r
     debug "fetched #{feed}"\r
     unless xml\r
       report_problem("reading feed #{feed} failed", nil, m)\r
-      return\r
+      return nil\r
     end\r
+    feed.mutex.synchronize do\r
+      feed.xml = xml\r
+    end\r
+    return true\r
+  end\r
 \r
-    begin\r
-      ## do validate parse\r
-      rss = RSS::Parser.parse(xml)\r
-      debug "parsed #{feed}"\r
-    rescue RSS::InvalidRSSError\r
-      ## do non validate parse for invalid RSS 1.0\r
+  def parseRss(feed, m=nil)\r
+    return nil unless feed.xml\r
+    feed.mutex.synchronize do\r
+      xml = feed.xml\r
       begin\r
-        rss = RSS::Parser.parse(xml, false)\r
+        ## do validate parse\r
+        rss = RSS::Parser.parse(xml)\r
+        debug "parsed #{feed}"\r
+      rescue RSS::InvalidRSSError\r
+        ## do non validate parse for invalid RSS 1.0\r
+        begin\r
+          rss = RSS::Parser.parse(xml, false)\r
+        rescue RSS::Error => e\r
+          report_problem("parsing rss stream failed, whoops =(", e, m)\r
+          return nil\r
+        end\r
       rescue RSS::Error => e\r
-        report_problem("parsing rss stream failed, whoops =(", e, m)\r
-        return\r
-      end\r
-    rescue RSS::Error => e\r
-      report_problem("parsing rss stream failed, oioi", e, m)\r
-      return\r
-    rescue => e\r
-      report_problem("processing error occured, sorry =(", e, m)\r
-      return\r
-    end\r
-    items = []\r
-    if rss.nil?\r
-      report_problem("#{feed} does not include RSS 1.0 or 0.9x/2.0", nil, m)\r
-    else\r
-      begin\r
-        rss.output_encoding = 'UTF-8'\r
-      rescue RSS::UnknownConvertMethod => e\r
-        report_problem("bah! something went wrong =(", e, m)\r
-        return\r
+        report_problem("parsing rss stream failed, oioi", e, m)\r
+        return nil\r
+      rescue => e\r
+        report_problem("processing error occured, sorry =(", e, m)\r
+        return nil\r
       end\r
-      rss.channel.title ||= "Unknown"\r
-      title = rss.channel.title\r
-      rss.items.each do |item|\r
-        item.title ||= "Unknown"\r
-        items << item\r
+      items = []\r
+      if rss.nil?\r
+        report_problem("#{feed} does not include RSS 1.0 or 0.9x/2.0", nil, m)\r
+      else\r
+        begin\r
+          rss.output_encoding = 'UTF-8'\r
+        rescue RSS::UnknownConvertMethod => e\r
+          report_problem("bah! something went wrong =(", e, m)\r
+          return nil\r
+        end\r
+        rss.channel.title ||= "Unknown"\r
+        title = rss.channel.title\r
+        rss.items.each do |item|\r
+          item.title ||= "Unknown"\r
+          items << item\r
+        end\r
       end\r
-    end\r
 \r
-    if items.empty?\r
-      report_problem("no items found in the feed, maybe try weed?", e, m)\r
-      return\r
+      if items.empty?\r
+        report_problem("no items found in the feed, maybe try weed?", e, m)\r
+        return nil\r
+      end\r
+      feed.title = title\r
+      feed.items = items\r
+      return true\r
     end\r
-    return [title, items]\r
   end\r
 end\r
 \r
@@ -565,6 +665,12 @@ plugin.map 'rss watched :handle',
 plugin.map 'rss add :handle :url :type',\r
   :action => 'add_rss',\r
   :defaults => {:type => nil}\r
+plugin.map 'rss change :what of :handle to :new',\r
+  :action => 'change_rss',\r
+  :requirements => { :what => /handle|url|format|type|refresh/ }\r
+plugin.map 'rss change :what for :handle to :new',\r
+  :action => 'change_rss',\r
+  :requirements => { :what => /handle|url|format|type|refesh/ }\r
 plugin.map 'rss del :handle',\r
   :action => 'del_rss'\r
 plugin.map 'rss delete :handle',\r