plugins/keywords: add method that was missing from commit 7cac523563de6473d2f93fd2d05 ...

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

diff --git a/data/rbot/plugins/quotes.rb b/data/rbot/plugins/quotes.rb
index 6851b65f2f2c0ff83b463482d5450a300ad2f728..73f1b9e7f7c9e397d4a32f35c080966328d87af3 100644 (file)
--- a/data/rbot/plugins/quotes.rb
+++ b/data/rbot/plugins/quotes.rb
@@ -1,6 +1,12 @@
-# GB: Ok, we *really* need to switch to db for this plugin too
+#-- vim:sw=2:et
+#++
+#
+# :title: Quotes plugin
+#
+# TODO:: use message mapper instead of multiple ifs
+# TODO:: switch to db
 
-Quote = Struct.new("Quote", :num, :date, :source, :quote)
+define_structure :Quote, :num, :date, :source, :quote
 
 class QuotePlugin < Plugin
   def initialize
@@ -20,6 +26,7 @@ class QuotePlugin < Plugin
       @changed[channel] = false
     }
   end
+
   def save
     Dir.mkdir("#{@bot.botclass}/quotes") if(!FileTest.directory?("#{@bot.botclass}/quotes"))
     @lists.each {|channel, quotes|
@@ -42,10 +49,13 @@ class QuotePlugin < Plugin
       end
     }
   end
+
   def cleanup
     @lists.clear
     @changed.clear
+    super
   end
+
   def addquote(source, channel, quote)
     @lists[channel] = Array.new if(!@lists.has_key?(channel))
     num = @lists[channel].length 
@@ -53,6 +63,7 @@ class QuotePlugin < Plugin
     @changed[channel] = true
     return num
   end
+
   def getquote(source, channel, num=nil)
     return nil unless(@lists.has_key?(channel))
     return nil unless(@lists[channel].length > 0)
@@ -66,6 +77,7 @@ class QuotePlugin < Plugin
       @lists[channel].length - 1
     end
   end
+
   def delquote(channel, num)
     return false unless(@lists.has_key?(channel))
     return false unless(@lists[channel].length > 0)
@@ -77,6 +89,7 @@ class QuotePlugin < Plugin
     end
     return false
   end
+
   def countquote(source, channel=nil, regexp=nil)
     unless(channel)
       total=0
@@ -94,6 +107,7 @@ class QuotePlugin < Plugin
     end
     return matches.length
   end
+
   def searchquote(source, channel, regexp)
     return nil unless(@lists.has_key?(channel))
     return nil unless(@lists[channel].length > 0)
@@ -104,6 +118,7 @@ class QuotePlugin < Plugin
       return nil
     end
   end
+
   def help(plugin, topic="")
     case topic
     when "addquote"
@@ -126,6 +141,7 @@ class QuotePlugin < Plugin
       return "Quote module (Quote storage and retrieval) topics: addquote, delquote, getquote, searchquote, topicquote, countquote, whoquote, whenquote"
     end
   end
+
   def listen(m)
     return unless(m.kind_of? PrivMessage)
 
@@ -135,7 +151,7 @@ class QuotePlugin < Plugin
         when (/^addquote\s+(#\S+)\s+(.*)/)
           channel = $1
           quote = $2
-          if(@bot.auth.allow?("addquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::add", m.source, m.replyto))
             if(channel =~ /^#/)
               num = addquote(m.source, channel, quote)
               m.reply "added the quote (##{num})"
@@ -143,7 +159,7 @@ class QuotePlugin < Plugin
           end
         when (/^getquote\s+(#\S+)$/)
           channel = $1
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::get", m.source, m.replyto))
             quote, total = getquote(m.source, channel)
             if(quote)
               m.reply "[#{quote.num}] #{quote.quote}"
@@ -154,7 +170,7 @@ class QuotePlugin < Plugin
         when (/^getquote\s+(#\S+)\s+(\d+)$/)
           channel = $1
           num = $2.to_i
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::get", m.source, m.replyto))
             quote, total = getquote(m.source, channel, num)
             if(quote)
               m.reply "[#{quote.num}] #{quote.quote}"
@@ -165,7 +181,7 @@ class QuotePlugin < Plugin
         when (/^whoquote\s+(#\S+)\s+(\d+)$/)
           channel = $1
           num = $2.to_i
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::get", m.source, m.replyto))
             quote, total = getquote(m.source, channel, num)
             if(quote)
               m.reply "quote #{quote.num} added by #{quote.source}"
@@ -176,7 +192,7 @@ class QuotePlugin < Plugin
         when (/^whenquote\s+(#\S+)\s+(\d+)$/)
           channel = $1
           num = $2.to_i
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::get", m.source, m.replyto))
             quote, total = getquote(m.source, channel, num)
             if(quote)
               m.reply "quote #{quote.num} added on #{quote.date}"
@@ -186,7 +202,7 @@ class QuotePlugin < Plugin
           end
         when (/^topicquote\s+(#\S+)$/)
           channel = $1
-          if(@bot.auth.allow?("topicquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::topic", m.source, m.replyto))
             quote, total = getquote(m.source, channel)
             if(quote)
               @bot.topic channel, "[#{quote.num}] #{quote.quote}"
@@ -197,7 +213,7 @@ class QuotePlugin < Plugin
         when (/^topicquote\s+(#\S+)\s+(\d+)$/)
           channel = $1
           num = $2.to_i
-          if(@bot.auth.allow?("topicquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::topic", m.source, m.replyto))
             quote, total = getquote(m.source, channel, num)
             if(quote)
               @bot.topic channel, "[#{quote.num}] #{quote.quote}"
@@ -208,7 +224,7 @@ class QuotePlugin < Plugin
         when (/^delquote\s+(#\S+)\s+(\d+)$/)
           channel = $1
           num = $2.to_i
-          if(@bot.auth.allow?("delquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::del", m.source, m.replyto))
             if(delquote(channel, num))
               m.okay
             else
@@ -218,7 +234,7 @@ class QuotePlugin < Plugin
         when (/^searchquote\s+(#\S+)\s+(.*)$/)
           channel = $1
           reg = $2
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::get", m.source, m.replyto))
             quote, total = searchquote(m.source, channel, reg)
             if(quote)
               m.reply "[#{quote.num}] #{quote.quote}"
@@ -227,14 +243,14 @@ class QuotePlugin < Plugin
             end
           end
         when (/^countquote$/)
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::get::count", m.source, m.replyto))
             total = countquote(m.source)
             m.reply "#{total} quotes"
           end
         when (/^countquote\s+(#\S+)\s*(.*)$/)
           channel = $1
           reg = $2
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::other::get::count", m.source, m.replyto))
             total = countquote(m.source, channel, reg)
             if(reg.length > 0)
               m.reply "#{total} quotes match: #{reg}"
@@ -246,12 +262,12 @@ class QuotePlugin < Plugin
     elsif (m.address? || (@bot.config["QUOTE_LISTEN"] && command.gsub!(/^!/, "")))
       case command
         when (/^addquote\s+(.+)/)
-          if(@bot.auth.allow?("addquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::add", m.source, m.replyto))
             num = addquote(m.source, m.target.to_s, $1)
             m.reply "added the quote (##{num})"
           end
         when (/^getquote$/)
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::get", m.source, m.replyto))
             quote, total = getquote(m.source, m.target.to_s)
             if(quote)
               m.reply "[#{quote.num}] #{quote.quote}"
@@ -261,7 +277,7 @@ class QuotePlugin < Plugin
           end
         when (/^getquote\s+(\d+)$/)
           num = $1.to_i
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::get", m.source, m.replyto))
             quote, total = getquote(m.source, m.target.to_s, num)
             if(quote)
               m.reply "[#{quote.num}] #{quote.quote}"
@@ -271,7 +287,7 @@ class QuotePlugin < Plugin
           end
         when (/^whenquote\s+(\d+)$/)
           num = $1.to_i
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::get", m.source, m.replyto))
             quote, total = getquote(m.source, m.target.to_s, num)
             if(quote)
               m.reply "quote #{quote.num} added on #{quote.date}"
@@ -281,7 +297,7 @@ class QuotePlugin < Plugin
           end
         when (/^whoquote\s+(\d+)$/)
           num = $1.to_i
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::get", m.source, m.replyto))
             quote, total = getquote(m.source, m.target.to_s, num)
             if(quote)
               m.reply "quote #{quote.num} added by #{quote.source}"
@@ -290,7 +306,7 @@ class QuotePlugin < Plugin
             end
           end
         when (/^topicquote$/)
-          if(@bot.auth.allow?("topicquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::topic", m.source, m.replyto))
             quote, total = getquote(m.source, m.target.to_s)
             if(quote)
               @bot.topic m.target, "[#{quote.num}] #{quote.quote}"
@@ -300,7 +316,7 @@ class QuotePlugin < Plugin
           end
         when (/^topicquote\s+(\d+)$/)
           num = $1.to_i
-          if(@bot.auth.allow?("topicquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::topic", m.source, m.replyto))
             quote, total = getquote(m.source, m.target.to_s, num)
             if(quote)
               @bot.topic m.target, "[#{quote.num}] #{quote.quote}"
@@ -310,7 +326,7 @@ class QuotePlugin < Plugin
           end
         when (/^delquote\s+(\d+)$/)
           num = $1.to_i
-          if(@bot.auth.allow?("delquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::del", m.source, m.replyto))
             if(delquote(m.target.to_s, num))
               m.okay
             else
@@ -319,7 +335,7 @@ class QuotePlugin < Plugin
           end
         when (/^searchquote\s+(.*)$/)
           reg = $1
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::get", m.source, m.replyto))
             quote, total = searchquote(m.source, m.target.to_s, reg)
             if(quote)
               m.reply "[#{quote.num}] #{quote.quote}"
@@ -329,7 +345,7 @@ class QuotePlugin < Plugin
           end
         when (/^countquote(?:\s+(.*))?$/)
           reg = $1
-          if(@bot.auth.allow?("getquote", m.source, m.replyto))
+          if(@bot.auth.allow?("quote::get::count", m.source, m.replyto))
             total = countquote(m.source, m.target.to_s, reg)
             if(reg && reg.length > 0)
               m.reply "#{total} quotes match: #{reg}"
@@ -341,5 +357,9 @@ class QuotePlugin < Plugin
     end
   end
 end
+
 plugin = QuotePlugin.new
 plugin.register("quotes")
+plugin.default_auth('other', false) # Prevent random people from editing other channels quote lists by default
+plugin.default_auth('other::get', true) # But allow them to view them
+plugin.default_auth('del', false) # Prevent random people from removing quotes