]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/quotes.rb
plugin(oxford): moved to lexico.com, closes #13
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / quotes.rb
index 055c9bad239b535ce755e701b5b0deb733395855..c10666899b0024369f04f2610b87d6e358d6b90b 100644 (file)
@@ -8,11 +8,15 @@
 define_structure :Quote, :num, :date, :source, :quote
 
 class QuotePlugin < Plugin
+  def dirname
+    'quotes'
+  end
+
   def initialize
     super
     @lists = Hash.new
     @changed = Hash.new
-    Dir["#{@bot.botclass}/quotes/*"].each {|f|
+    Dir[datafile('*')].each {|f|
       next if File.directory?(f)
       channel = File.basename(f)
       @lists[channel] = Array.new if(!@lists.has_key?(channel))
@@ -27,13 +31,13 @@ class QuotePlugin < Plugin
   end
 
   def save
-    Dir.mkdir("#{@bot.botclass}/quotes") if(!FileTest.directory?("#{@bot.botclass}/quotes"))
+    Dir.mkdir(datafile) unless FileTest.directory? datafile
     @lists.each {|channel, quotes|
       begin
         if @changed[channel]
           debug "Writing new quotefile for channel #{channel} ..."
-          Utils.safe_save("#{@bot.botclass}/quotes/#{channel}") {|file|
-            quotes.compact.each {|q| 
+          Utils.safe_save(datafile(channel)) {|file|
+            quotes.compact.each {|q|
               file.puts "#{q.num} | #{q.date} | #{q.source} | #{q.quote}"
             }
           }
@@ -61,7 +65,7 @@ class QuotePlugin < Plugin
 
   def addquote(source, channel, quote)
     @lists[channel] = Array.new if(!@lists.has_key?(channel))
-    num = @lists[channel].length 
+    num = @lists[channel].length
     @lists[channel][num] = Quote.new(num, Time.new, source.fullform, quote)
     @changed[channel] = true
     return num
@@ -76,7 +80,7 @@ class QuotePlugin < Plugin
       end
     else
       # random quote
-      return @lists[channel].compact[rand(@lists[channel].nitems)],
+      return @lists[channel].compact.pick_one,
       @lists[channel].length - 1
     end
   end
@@ -122,6 +126,17 @@ class QuotePlugin < Plugin
     end
   end
 
+  def listquotes(source, channel, regexp)
+    return nil unless(@lists.has_key?(channel))
+    return nil unless(@lists[channel].length > 0)
+    matches = @lists[channel].compact.find_all {|a| a.quote =~ /#{regexp}/i }
+    if matches.length > 0
+      return matches
+    else
+      return nil
+    end
+  end
+
   def help(plugin, topic="")
     case plugin
     when "addquote"
@@ -132,6 +147,8 @@ class QuotePlugin < Plugin
       _("getquote [<channel>] [<num>] => get quote from <channel> with number <num>. You only need to supply <channel> if you are addressing %{nick} privately. Without <num>, a random quote will be returned.") % { :nick => @bot.nick }
     when "searchquote"
       _("searchquote [<channel>] <regexp> => search for quote from <channel> that matches <regexp>. You only need to supply <channel> if you are addressing %{nick} privately.") % { :nick => @bot.nick }
+    when "listquotes"
+      _("listquotes [<channel>] <regexp> => list the quotes from <channel> that match <regexp>. You only need to supply <channel> if you are addressing %{nick} privately.") % { :nick => @bot.nick }
     when "topicquote"
       _("topicquote [<channel>] [<num>] => set topic to quote from <channel> with number <num>. You only need to supply <channel> if you are addressing %{nick} privately. Without <num>, a random quote will be set.") % { :nick => @bot.nick }
     when "countquote"
@@ -143,7 +160,7 @@ class QuotePlugin < Plugin
     when "lastquote"
       _("lastquote [<channel>] => show the last quote in a given channel. You only need to supply <channel> if you are addressing %{nick} privately") % { :nick => @bot.nick }
     else
-      _("Quote module (Quote storage and retrieval) topics: addquote, delquote, getquote, searchquote, topicquote, countquote, whoquote, whenquote, lastquote") % { :nick => @bot.nick }
+      _("Quote module (Quote storage and retrieval) topics: addquote, delquote, getquote, searchquote, listquotes, topicquote, countquote, whoquote, whenquote, lastquote") % { :nick => @bot.nick }
     end
   end
 
@@ -220,6 +237,20 @@ class QuotePlugin < Plugin
     end
   end
 
+  def cmd_listquotes(m, p)
+    channel = p[:channel] || m.channel.to_s
+    reg = p[:reg].to_s
+    if quotes = listquotes(m.source, channel, reg)
+      m.reply _("%{total} quotes matching %{reg} found: %{list}") % {
+        :total => quotes.size,
+        :reg => reg,
+        :list => quotes.map {|q| q.num }.join(', ')
+      }
+    else
+      m.reply _("quote not found!")
+    end
+  end
+
   def cmd_countquote(m, p)
     channel = p[:channel] || m.channel.to_s
     reg = p[:reg] ? p[:reg].to_s : nil
@@ -265,6 +296,20 @@ end
 plugin = QuotePlugin.new
 plugin.register("quotes")
 
+plugin.default_auth('other::edit', false) # Prevent random people from editing other channels quote lists by default
+plugin.default_auth('other::view', true) # But allow them to view them
+
+plugin.map "addquote :channel *quote", :action => :cmd_addquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN }, :auth_path => '!quote::other::edit::add!'
+plugin.map "delquote :channel :num", :action => :cmd_delquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::edit::del!'
+plugin.map "getquote :channel [:num]", :action => :cmd_getquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::view::get!'
+plugin.map "whoquote :channel :num", :action => :cmd_whoquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::view::who!'
+plugin.map "whenquote :channel :num", :action => :cmd_whenquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::view::when!'
+plugin.map "searchquote :channel *reg", :action => :cmd_searchquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN }, :auth_path => '!quote::other::view::search!'
+plugin.map "listquotes :channel *reg", :action => :cmd_listquotes, :requirements => { :channel => Regexp::Irc::GEN_CHAN }, :auth_path => '!quote::other::view::list!'
+plugin.map "countquote :channel [*reg]", :action => :cmd_countquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN }, :auth_path => '!quote::other::view::count!'
+plugin.map "topicquote :channel [:num]", :action => :cmd_topicquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::topic!'
+plugin.map "lastquote :channel", :action => :cmd_lastquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN }, :auth_path => '!quote::other::view::last!'
+
 plugin.default_auth('edit', false) # Prevent random people from removing quotes
 plugin.default_auth('edit::add', true) # But allow them to add them
 
@@ -274,18 +319,8 @@ plugin.map "getquote [:num]", :action => :cmd_getquote, :private => false, :requ
 plugin.map "whoquote :num", :action => :cmd_whoquote, :private => false, :requirements => { :num => /^\d+$/ }, :auth_path => '!quote::view::who!'
 plugin.map "whenquote :num", :action => :cmd_whenquote, :private => false, :requirements => { :num => /^\d+$/ }, :auth_path => '!quote::view::when!'
 plugin.map "searchquote *reg", :action => :cmd_searchquote, :private => false, :auth_path => '!quote::view::search!'
+plugin.map "listquotes *reg", :action => :cmd_listquotes, :private => false, :auth_path => '!quote::view::list!'
 plugin.map "countquote [*reg]", :action => :cmd_countquote, :private => false, :auth_path => '!quote::view::count!'
 plugin.map "topicquote [:num]", :action => :cmd_topicquote, :private => false, :requirements => { :num => /^\d+$/ }, :auth_path => '!quote::topic!'
 plugin.map "lastquote", :action => :cmd_lastquote, :private => false, :auth_path => '!quote::view::last!'
 
-plugin.default_auth('other::edit', false) # Prevent random people from editing other channels quote lists by default
-plugin.default_auth('other::view', true) # But allow them to view them
-
-plugin.map "addquote :channel *quote", :action => :cmd_addquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN }, :auth_path => '!quote::other::edit::add!'
-plugin.map "delquote :channel :num", :action => :cmd_delquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::edit::del!'
-plugin.map "getquote :channel [:num]", :action => :cmd_getquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::view::get!'
-plugin.map "whoquote :channel :num", :action => :cmd_whoquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::view::who!'
-plugin.map "whenquote :channel :num", :action => :cmd_whenquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::view::when!'
-plugin.map "searchquote :channel *reg", :action => :cmd_searchquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN }, :auth_path => '!quote::other::view::search!'
-plugin.map "countquote [:channel] [*reg]", :action => :cmd_countquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN }, :auth_path => '!quote::other::view::count!'
-plugin.map "topicquote :channel [:num]", :action => :cmd_topicquote, :requirements => { :channel => Regexp::Irc::GEN_CHAN, :num => /^\d+$/ }, :auth_path => '!quote::other::topic!'