Plugin header boilerplating.

[user/henk/code/ruby/rbot.git] / data / rbot / plugins / rss.rb

diff --git a/data/rbot/plugins/rss.rb b/data/rbot/plugins/rss.rb
index 08b2c775761571136807e28067f54b0b729b0557..caebc3fc6795465671dd3cbd62c547cbbab2f181 100644 (file)
--- a/data/rbot/plugins/rss.rb
+++ b/data/rbot/plugins/rss.rb
@@ -1,13 +1,18 @@
 #-- 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
+# :title: RSS feed plugin for rbot\r
 #\r
-# Licensed under MIT License.\r
+# Author:: Stanislav Karchebny <berkus@madfire.net>\r
+# Author:: Ian Monroe <ian@monroe.nu>\r
+# Author:: Mark Kretschmann <markey@web.de>\r
+# Author:: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>\r
+#\r
+# Copyright:: (C) 2004 Stanislav Karchebny\r
+# Copyright:: (C) 2005 Ian Monroe, Mark Kretschmann\r
+# Copyright:: (C) 2006-2007 Giuseppe Bilotta\r
+#\r
+# License:: MIT license\r
 \r
 require 'rss/parser'\r
 require 'rss/1.0'\r
@@ -19,12 +24,6 @@ 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_accessor :url\r
   attr_accessor :handle\r
@@ -156,9 +155,6 @@ class RSSFeedsPlugin < Plugin
         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
@@ -187,7 +183,9 @@ class RSSFeedsPlugin < Plugin
     when "list"\r
       "rss list [#{Bold}handle#{Bold}] : list all rss feeds (matching #{Bold}handle#{Bold})"\r
     when "watched"\r
-      "rss watched [#{Bold}handle#{Bold}] : list all watched rss feeds (matching #{Bold}handle#{Bold})"\r
+      "rss watched [#{Bold}handle#{Bold}] [in #{Bold}chan#{Bold}]: list all watched rss feeds (matching #{Bold}handle#{Bold}) (in channel #{Bold}chan#{Bold})"\r
+    when "who", "watches", "who watches"\r
+      "rss who watches [#{Bold}handle#{Bold}]]: list all watchers for 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
@@ -199,9 +197,9 @@ class RSSFeedsPlugin < Plugin
     when "forcereplace"\r
       "rss forcereplace #{Bold}handle#{Bold} #{Bold}url#{Bold} [#{Bold}type#{Bold}] : replace the url of rss called #{Bold}handle#{Bold} with #{Bold}url#{Bold} (of type #{Bold}type#{Bold})"\r
     when "watch"\r
-      "rss watch #{Bold}handle#{Bold} [#{Bold}url#{Bold} [#{Bold}type#{Bold}]] : watch rss #{Bold}handle#{Bold} for changes; when the other parameters are present, it will be created if it doesn't exist yet"\r
+      "rss watch #{Bold}handle#{Bold} [#{Bold}url#{Bold} [#{Bold}type#{Bold}]]  [in #{Bold}chan#{Bold}]: watch rss #{Bold}handle#{Bold} for changes (in channel #{Bold}chan#{Bold}); when the other parameters are present, the feed will be created if it doesn't exist yet"\r
     when /(un|rm)watch/\r
-      "rss unwatch|rmwatch #{Bold}handle#{Bold} : stop watching rss #{Bold}handle#{Bold} for changes"\r
+      "rss unwatch|rmwatch #{Bold}handle#{Bold} [in #{Bold}chan#{Bold}]: stop watching rss #{Bold}handle#{Bold} (in channel #{Bold}chan#{Bold}) for changes"\r
     when "rewatch"\r
       "rss rewatch : restart threads that watch for changes in watched rss"\r
     else\r
@@ -297,13 +295,31 @@ class RSSFeedsPlugin < Plugin
   end\r
 \r
   def watched_rss(m, params)\r
+    wanted = params[:handle]\r
+    chan = params[:chan] || m.replyto\r
+    reply = String.new\r
+    watchlist.each { |handle, feed|\r
+      next if wanted and !handle.match(/#{wanted}/i)\r
+      next unless feed.watched_by?(chan)\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
+      reply << " matching #{wanted}" if wanted\r
+    end\r
+    m.reply reply\r
+  end\r
+\r
+  def who_watches(m, params)\r
     wanted = params[:handle]\r
     reply = String.new\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'})"\r
       (reply << " refreshing every #{Utils.secs_to_string(feed.refresh_rate)}") if feed.refresh_rate\r
+      reply << ": watched by #{feed.watchers.join(', ')}"\r
       reply << "\n"\r
     }\r
     if reply.empty?\r
@@ -413,6 +429,7 @@ class RSSFeedsPlugin < Plugin
 \r
   def watch_rss(m, params)\r
     handle = params[:handle]\r
+    chan = params[:chan] || m.replyto\r
     url = params[:url]\r
     type = params[:type]\r
     if url\r
@@ -420,11 +437,11 @@ class RSSFeedsPlugin < Plugin
     end\r
     feed = @feeds.fetch(handle.downcase, nil)\r
     if feed\r
-      if feed.add_watch(m.replyto)\r
+      if feed.add_watch(chan)\r
         watchRss(feed, m)\r
         m.okay\r
       else\r
-        m.reply "Already watching #{feed.handle}"\r
+        m.reply "Already watching #{feed.handle} in #{chan}"\r
       end\r
     else\r
       m.reply "Couldn't watch feed #{handle} (no such feed found)"\r
@@ -433,15 +450,16 @@ class RSSFeedsPlugin < Plugin
 \r
   def unwatch_rss(m, params, pass=false)\r
     handle = params[:handle].downcase\r
+    chan = params[:chan] || m.replyto\r
     unless @feeds.has_key?(handle)\r
       m.reply("dunno that feed")\r
       return\r
     end\r
     feed = @feeds[handle]\r
-    if feed.rm_watch(m.replyto)\r
-      m.reply "#{m.replyto} has been removed from the watchlist for #{feed.handle}"\r
+    if feed.rm_watch(chan)\r
+      m.reply "#{chan} has been removed from the watchlist for #{feed.handle}"\r
     else\r
-      m.reply("#{m.replyto} wasn't watching #{feed.handle}") unless pass\r
+      m.reply("#{chan} wasn't watching #{feed.handle}") unless pass\r
     end\r
     if !feed.watched?\r
       stop_watch(handle)\r
@@ -664,10 +682,13 @@ plugin.map 'rss show :handle :limit',
   :defaults => {:limit => 5}\r
 plugin.map 'rss list :handle',\r
   :action => 'list_rss',\r
-  :defaults =>  {:handle => nil}\r
-plugin.map 'rss watched :handle',\r
+  :defaults => {:handle => nil}\r
+plugin.map 'rss watched :handle [in :chan]',\r
   :action => 'watched_rss',\r
-  :defaults =>  {:handle => nil}\r
+  :defaults => {:handle => nil}\r
+plugin.map 'rss who watches :handle',\r
+  :action => 'who_watches',\r
+  :defaults => {:handle => nil}\r
 plugin.map 'rss add :handle :url :type',\r
   :action => 'add_rss',\r
   :defaults => {:type => nil}\r
@@ -689,12 +710,12 @@ plugin.map 'rss replace :handle :url :type',
 plugin.map 'rss forcereplace :handle :url :type',\r
   :action => 'forcereplace_rss',\r
   :defaults => {:type => nil}\r
-plugin.map 'rss watch :handle :url :type',\r
+plugin.map 'rss watch :handle :url :type [in :chan]',\r
   :action => 'watch_rss',\r
   :defaults => {:url => nil, :type => nil}\r
-plugin.map 'rss unwatch :handle',\r
+plugin.map 'rss unwatch :handle [in :chan]',\r
   :action => 'unwatch_rss'\r
-plugin.map 'rss rmwatch :handle',\r
+plugin.map 'rss rmwatch :handle [in :chan]',\r
   :action => 'unwatch_rss'\r
 plugin.map 'rss rewatch',\r
   :action => 'rewatch_rss'\r