]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/rss.rb
When adding a feed watcher, let it fire instantly so that it can do the initial rss...
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / rss.rb
index 8f5420c5ea73d228ee759fcb17f6bb62cc0388a0..13689bf14efdfeb63136de3a437ecbd64a71a6a3 100644 (file)
@@ -1,7 +1,12 @@
+#-- vim:sw=2:et\r
+#++\r
+#\r
 # RSS feed plugin for RubyBot\r
 # (c) 2004 Stanislav Karchebny <berkus@madfire.net>\r
 # (c) 2005 Ian Monroe <ian@monroe.nu>\r
 # (c) 2005 Mark Kretschmann <markey@web.de>\r
+# (c) 2006 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>\r
+#\r
 # Licensed under MIT License.\r
 \r
 require 'rss/parser'\r
@@ -26,10 +31,6 @@ class ::String
   def riphtml\r
     self.gsub(/<[^>]+>/, '').gsub(/&amp;/,'&').gsub(/&quot;/,'"').gsub(/&lt;/,'<').gsub(/&gt;/,'>').gsub(/&ellip;/,'...').gsub(/&apos;/, "'").gsub("\n",'')\r
   end\r
-\r
-  def mysqlize\r
-    self.gsub(/'/, "''")\r
-  end\r
 end\r
 \r
 class ::RssBlob\r
@@ -46,7 +47,17 @@ class ::RssBlob
       @handle = url\r
     end\r
     @type = type\r
-    @watchers = watchers\r
+    @watchers=[]\r
+    sanitize_watchers(watchers)\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
+    @watchers.clear\r
+    ls.each { |w|\r
+      add_watch(w)\r
+    }\r
   end\r
 \r
   def watched?\r
@@ -54,19 +65,19 @@ class ::RssBlob
   end\r
 \r
   def watched_by?(who)\r
-    @watchers.include?(who)\r
+    @watchers.include?(who.downcase)\r
   end\r
 \r
   def add_watch(who)\r
     if watched_by?(who)\r
       return nil\r
     end\r
-    @watchers << who unless watched_by?(who)\r
+    @watchers << who.downcase\r
     return who\r
   end\r
 \r
   def rm_watch(who)\r
-    @watchers.delete(who)\r
+    @watchers.delete(who.downcase)\r
   end\r
 \r
   def to_a\r
@@ -79,7 +90,7 @@ class ::RssBlob
     else\r
       a = self.to_a[0,3]\r
     end\r
-    a.join(" | ")\r
+    a.compact.join(" | ")\r
   end\r
 end\r
 \r
@@ -94,42 +105,57 @@ class RSSFeedsPlugin < Plugin
 \r
   BotConfig.register BotConfigIntegerValue.new('rss.thread_sleep',\r
     :default => 300, :validate => Proc.new{|v| v > 30},\r
-    :desc => "How many characters to use of a RSS item text")\r
-\r
-  @@watchThreads = Hash.new\r
-  @@mutex = Mutex.new\r
+    :desc => "How many seconds to sleep before checking RSS feeds again")\r
 \r
   def initialize\r
     super\r
-    kill_threads\r
     if @registry.has_key?(:feeds)\r
       @feeds = @registry[:feeds]\r
+      @feeds.keys.grep(/[A-Z]/) { |k|\r
+        @feeds[k.downcase] = @feeds[k]\r
+        @feeds.delete(k)\r
+      }\r
+      @feeds.each { |k, f|\r
+        f.sanitize_watchers\r
+      }\r
     else\r
       @feeds = Hash.new\r
     end\r
+    @watch = Hash.new\r
     rewatch_rss\r
   end\r
 \r
+  def name\r
+    "rss"\r
+  end\r
+\r
   def watchlist\r
     @feeds.select { |h, f| f.watched? }\r
   end\r
 \r
   def cleanup\r
-    kill_threads\r
+    stop_watches\r
   end\r
 \r
   def save\r
     @registry[:feeds] = @feeds\r
   end\r
 \r
-  def kill_threads\r
-    @@mutex.synchronize {\r
-      # Abort all running threads.\r
-      @@watchThreads.each { |url, thread|\r
-        debug "Killing thread for #{url}"\r
-        thread.kill\r
-      }\r
-      @@watchThreads = Hash.new\r
+  def stop_watch(handle)\r
+    if @watch.has_key?(handle)\r
+      begin\r
+        debug "Stopping watch #{handle}"\r
+        @bot.timer.remove(@watch[handle])\r
+        @watch.delete(handle)\r
+      rescue => e\r
+        report_problem("Failed to stop watch for #{handle}", e, nil)\r
+      end\r
+    end\r
+  end\r
+\r
+  def stop_watches\r
+    @watch.each_key { |k|\r
+      stop_watch(k)\r
     }\r
   end\r
 \r
@@ -182,11 +208,11 @@ class RSSFeedsPlugin < Plugin
       rev = lims[1].to_i > lims[2].to_i\r
     else\r
       ll = 0\r
-      ul = [[lims[1].to_i-1, 1].max, 14].min\r
+      ul = [[lims[1].to_i-1, 0].max, 14].min\r
       rev = false\r
     end\r
 \r
-    feed = @feeds.fetch(handle, nil)\r
+    feed = @feeds.fetch(handle.downcase, nil)\r
     unless feed\r
       m.reply "I don't know any feeds named #{handle}"\r
       return\r
@@ -194,9 +220,7 @@ class RSSFeedsPlugin < Plugin
 \r
     m.reply "lemme fetch it..."\r
     title = items = nil\r
-    @@mutex.synchronize {\r
-      title, items = fetchRss(feed, m)\r
-    }\r
+    title, items = fetchRss(feed, m)\r
     return unless items\r
 \r
     # We sort the feeds in freshness order (newer ones first)\r
@@ -211,8 +235,8 @@ class RSSFeedsPlugin < Plugin
   end\r
 \r
   def itemDate(item,ex=nil)\r
-    return item.pubDate if item.respond_to?(:pubDate)\r
-    return item.date if item.respond_to?(:date)\r
+    return item.pubDate if item.respond_to?(:pubDate) and item.pubDate\r
+    return item.date if item.respond_to?(:date) and item.date\r
     return ex\r
   end\r
 \r
@@ -226,13 +250,11 @@ class RSSFeedsPlugin < Plugin
   def list_rss(m, params)\r
     wanted = params[:handle]\r
     reply = String.new\r
-    @@mutex.synchronize {\r
-      @feeds.each { |handle, feed|\r
-        next if wanted and !handle.match(wanted)\r
-        reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})"\r
-        (reply << " (watched)") if feed.watched_by?(m.replyto)\r
-        reply << "\n"\r
-      }\r
+    @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 << " (watched)") if feed.watched_by?(m.replyto)\r
+      reply << "\n"\r
     }\r
     if reply.empty?\r
       reply = "no feeds found"\r
@@ -244,12 +266,10 @@ class RSSFeedsPlugin < Plugin
   def watched_rss(m, params)\r
     wanted = params[:handle]\r
     reply = String.new\r
-    @@mutex.synchronize {\r
-      watchlist.each { |handle, feed|\r
-        next if wanted and !handle.match(wanted)\r
-        next unless feed.watched_by?(m.replyto)\r
-        reply << "#{feed.handle}: #{feed.url} (in format: #{feed.type ? feed.type : 'default'})\n"\r
-      }\r
+    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
     }\r
     if reply.empty?\r
       reply = "no watched feeds"\r
@@ -266,17 +286,15 @@ class RSSFeedsPlugin < Plugin
       return\r
     end\r
     type = params[:type]\r
-    if @feeds.fetch(handle, nil) && !force\r
-      m.reply "There is already a feed named #{handle} (URL: #{@feeds[handle].url})"\r
+    if @feeds.fetch(handle.downcase, nil) && !force\r
+      m.reply "There is already a feed named #{handle} (URL: #{@feeds[handle.downcase].url})"\r
       return\r
     end\r
     unless url\r
       m.reply "You must specify both a handle and an url to add an RSS feed"\r
       return\r
     end\r
-    @@mutex.synchronize {\r
-      @feeds[handle] = RssBlob.new(url,handle,type)\r
-    }\r
+    @feeds[handle.downcase] = RssBlob.new(url,handle,type)\r
     reply = "Added RSS #{url} named #{handle}"\r
     if type\r
       reply << " (format: #{type})"\r
@@ -291,19 +309,17 @@ class RSSFeedsPlugin < Plugin
       m.reply "someone else is watching #{feed.handle}, I won't remove it from my list"\r
       return\r
     end\r
-    @@mutex.synchronize {\r
-      @feeds.delete(feed.handle)\r
-    }\r
+    @feeds.delete(feed.handle.downcase)\r
     m.okay unless pass\r
     return\r
   end\r
 \r
   def replace_rss(m, params)\r
     handle = params[:handle]\r
-    if @feeds.key?(handle)\r
+    if @feeds.key?(handle.downcase)\r
       del_rss(m, {:handle => handle}, true)\r
     end\r
-    if @feeds.key?(handle)\r
+    if @feeds.key?(handle.downcase)\r
       m.reply "can't replace #{feed.handle}"\r
     else\r
       add_rss(m, params, true)\r
@@ -321,26 +337,21 @@ class RSSFeedsPlugin < Plugin
     if url\r
       add_rss(m, params)\r
     end\r
-    feed = nil\r
-    @@mutex.synchronize {\r
-      feed = @feeds.fetch(handle, nil)\r
-    }\r
+    feed = @feeds.fetch(handle.downcase, nil)\r
     if feed\r
-      @@mutex.synchronize {\r
-        if feed.add_watch(m.replyto)\r
-          watchRss(feed, m)\r
-          m.okay\r
-        else\r
-          m.reply "Already watching #{feed.handle}"\r
-        end\r
-      }\r
+      if feed.add_watch(m.replyto)\r
+        watchRss(feed, m)\r
+        m.okay\r
+      else\r
+        m.reply "Already watching #{feed.handle}"\r
+      end\r
     else\r
       m.reply "Couldn't watch feed #{handle} (no such feed found)"\r
     end\r
   end\r
 \r
   def unwatch_rss(m, params, pass=false)\r
-    handle = params[:handle]\r
+    handle = params[:handle].downcase\r
     unless @feeds.has_key?(handle)\r
       m.reply("dunno that feed")\r
       return\r
@@ -352,19 +363,13 @@ class RSSFeedsPlugin < Plugin
       m.reply("#{m.replyto} wasn't watching #{feed.handle}") unless pass\r
     end\r
     if !feed.watched?\r
-      @@mutex.synchronize {\r
-        if @@watchThreads[handle].kind_of? Thread\r
-          @@watchThreads[handle].kill\r
-          debug "rmwatch: Killed thread for #{handle}"\r
-          @@watchThreads.delete(handle)\r
-        end\r
-      }\r
+      stop_watch(handle)\r
     end\r
     return feed\r
   end\r
 \r
-  def rewatch_rss(m=nil)\r
-    kill_threads\r
+  def rewatch_rss(m=nil, params=nil)\r
+    stop_watches\r
 \r
     # Read watches from list.\r
     watchlist.each{ |handle, feed|\r
@@ -375,60 +380,64 @@ class RSSFeedsPlugin < Plugin
 \r
   private\r
   def watchRss(feed, m=nil)\r
-    if @@watchThreads.has_key?(feed.handle)\r
+    if @watch.has_key?(feed.handle)\r
       report_problem("watcher thread for #{feed.handle} is already running", nil, m)\r
       return\r
     end\r
-    @@watchThreads[feed.handle] = Thread.new do\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 = []\r
-      firstRun = true\r
-      failures = 0\r
-      loop do\r
-        begin\r
-          debug "fetching #{feed}"\r
-          title = newItems = nil\r
-          @@mutex.synchronize {\r
-            title, newItems = fetchRss(feed)\r
-          }\r
-          unless newItems\r
-            debug "no items in feed #{feed}"\r
-            failures +=1\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
+        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
           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
-            else\r
-              otxt = oldItems.map { |item| item.to_s }\r
-              dispItems = newItems.reject { |item|\r
-                otxt.include?(item.to_s)\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 dispItems.length > 0\r
-                debug "Found #{dispItems.length} new items in #{feed}"\r
-                dispItems.each { |item|\r
-                  @@mutex.synchronize {\r
-                    printFormattedRss(feed, item)\r
-                  }\r
-                }\r
-              else\r
-                debug "No new items found in #{feed}"\r
-              end\r
+            else\r
+              debug "No new items found in #{feed}"\r
             end\r
-            oldItems = newItems.dup\r
           end\r
-        rescue Exception => e\r
-          error "Error watching #{feed}: #{e.inspect}"\r
-          debug e.backtrace.join("\n")\r
-          failures += 1\r
+          oldItems = newItems.dup\r
         end\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
-        sleep seconds\r
+      rescue Exception => e\r
+        error "Error watching #{feed}: #{e.inspect}"\r
+        debug e.backtrace.join("\n")\r
+        failures += 1\r
       end\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
+    }\r
+    debug "watcher for #{feed} added"\r
   end\r
 \r
   def printFormattedRss(feed, item, opts=nil)\r
@@ -485,7 +494,7 @@ class RSSFeedsPlugin < Plugin
   def fetchRss(feed, m=nil)\r
     begin\r
       # Use 60 sec timeout, cause the default is too low\r
-      xml = @bot.httputil.get_cached(feed.url,60,60)\r
+      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
@@ -578,6 +587,6 @@ plugin.map 'rss unwatch :handle',
   :action => 'unwatch_rss'\r
 plugin.map 'rss rmwatch :handle',\r
   :action => 'unwatch_rss'\r
-plugin.map 'rss rewatch :handle',\r
+plugin.map 'rss rewatch',\r
   :action => 'rewatch_rss'\r
 \r