rss plugin: rss watch improvements: can now specify the channel when creating or...

[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 acebda9cc0d030d48afee4ea63c7fda2dac8c13a..3dc343955bb3152902ce90dd075cd15b7d4de0ef 100644 (file)
--- a/data/rbot/plugins/rss.rb
+++ b/data/rbot/plugins/rss.rb
@@ -181,7 +181,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
@@ -193,9 +195,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
@@ -292,10 +294,11 @@ class RSSFeedsPlugin < Plugin
 \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?(m.replyto)\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
@@ -307,6 +310,23 @@ class RSSFeedsPlugin < Plugin
     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
+      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
+      reply = "no watched feeds"\r
+      reply << " matching #{wanted}" if wanted\r
+    end\r
+    m.reply reply\r
+  end\r
+\r
   def add_rss(m, params, force=false)\r
     handle = params[:handle]\r
     url = params[:url]\r
@@ -407,6 +427,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
@@ -414,11 +435,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
@@ -427,15 +448,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
@@ -658,10 +680,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
@@ -683,12 +708,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