-Quote = Struct.new("Quote", "num", "date", "source", "quote")
+#-- vim:sw=2:et
+#++
+#
+# :title: Quotes plugin
+#
+# TODO:: switch to db
+
+define_structure :Quote, :num, :date, :source, :quote
class QuotePlugin < Plugin
+ def dirname
+ 'quotes'
+ end
+
def initialize
super
- @lists = Hash.new
- Dir["#{@bot.botclass}/quotes/*"].each {|f|
- channel = File.basename(f)
- @lists[channel] = Array.new if(!@lists.has_key?(channel))
- IO.foreach(f) {|line|
- if(line =~ /^(\d+) \| ([^|]+) \| (\S+) \| (.*)$/)
- num = $1.to_i
- @lists[channel][num] = Quote.new(num, $2, $3, $4)
+ @lists = @registry[:lists]
+ unless @lists
+ @lists = {}
+ # migrate quotes from existing quote files in data directory
+ Dir[datafile('*')].each do |f|
+ next if File.directory?(f)
+ channel = File.basename(f)
+ @lists[channel] = Array.new if not @lists.has_key?(channel)
+ IO.foreach(f) do |line|
+ if(line =~ /^(\d+) \| ([^|]+) \| (\S+) \| (.*)$/)
+ num = $1.to_i
+ @lists[channel][num] = Quote.new(num, $2, $3, $4)
+ end
end
- }
- }
+ end
+ end
end
+
def save
- Dir.mkdir("#{@bot.botclass}/quotes") if(!FileTest.directory?("#{@bot.botclass}/quotes"))
- @lists.each {|channel, quotes|
- File.open("#{@bot.botclass}/quotes/#{channel}", "w") {|file|
- quotes.compact.each {|q|
- file.puts "#{q.num} | #{q.date} | #{q.source} | #{q.quote}"
- }
- }
- }
+ @registry[:lists] = @lists
+ @registry.flush
+ end
+
+ def cleanup
+ @lists.clear
+ super
+ end
+
+ def lastquote(channel)
+ @lists[channel].length-1
end
+
def addquote(source, channel, quote)
@lists[channel] = Array.new if(!@lists.has_key?(channel))
- num = @lists[channel].length
- @lists[channel][num] = Quote.new(num, Time.new, source, quote)
+ num = @lists[channel].length
+ @lists[channel][num] = Quote.new(num, Time.new, source.fullform, quote)
return num
end
+
def getquote(source, channel, num=nil)
return nil unless(@lists.has_key?(channel))
return nil unless(@lists[channel].length > 0)
end
else
# random quote
- return @lists[channel].compact[rand(@lists[channel].nitems)],
- @lists[channel].length - 1
+ return @lists[channel].compact.pick_one,
+ @lists[channel].length - 1
end
end
+
def delquote(channel, num)
return false unless(@lists.has_key?(channel))
return false unless(@lists[channel].length > 0)
if(@lists[channel][num])
@lists[channel][num] = nil
+ @lists[channel].pop if num == @lists[channel].length - 1
return true
end
return false
end
+
def countquote(source, channel=nil, regexp=nil)
unless(channel)
total=0
end
return matches.length
end
+
def searchquote(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[rand(matches.length)], @lists[channel].length - 1
+ return matches[rand(matches.length)], @lists[channel].length - 1
else
return nil
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 topic
- when "addquote"
- return "addquote [<channel>] <quote> => Add quote <quote> for channel <channel>. You only need to supply <channel> if you are addressing #{@bot.nick} privately. Responds to !addquote without addressing if so configured"
- when "delquote"
- return "delquote [<channel>] <num> => delete quote from <channel> with number <num>. You only need to supply <channel> if you are addressing #{@bot.nick} privately. Responds to !delquote without addressing if so configured"
- when "getquote"
- return "getquote [<channel>] [<num>] => get quote from <channel> with number <num>. You only need to supply <channel> if you are addressing #{@bot.nick} privately. Without <num>, a random quote will be returned. Responds to !getquote without addressing if so configured"
- when "searchquote"
- return "searchquote [<channel>] <regexp> => search for quote from <channel> that matches <regexp>. You only need to supply <channel> if you are addressing #{@bot.nick} privately. Responds to !searchquote without addressing if so configured"
- when "topicquote"
- return "topicquote [<channel>] [<num>] => set topic to quote from <channel> with number <num>. You only need to supply <channel> if you are addressing #{@bot.nick} privately. Without <num>, a random quote will be set. Responds to !topicquote without addressing if so configured"
- when "countquote"
- return "countquote [<channel>] <regexp> => count quotes from <channel> that match <regexp>. You only need to supply <channel> if you are addressing #{@bot.nick} privately. Responds to !countquote without addressing if so configured"
- when "whoquote"
- return "whoquote [<channel>] <num> => show who added quote <num>. You only need to supply <channel> if you are addressing #{@bot.nick} privately"
- when "whenquote"
- return "whenquote [<channel>] <num> => show when quote <num> was added. You only need to supply <channel> if you are addressing #{@bot.nick} privately"
- else
- return "Quote module (Quote storage and retrieval) topics: addquote, delquote, getquote, searchquote, topicquote, countquote, whoquote, whenquote"
+ case plugin
+ when "addquote"
+ _("addquote [<channel>] <quote> => Add quote <quote> for channel <channel>. You only need to supply <channel> if you are addressing %{nick} privately.") % { :nick => @bot.nick }
+ when "delquote"
+ _("delquote [<channel>] <num> => delete quote from <channel> with number <num>. You only need to supply <channel> if you are addressing %{nick} privately.") % { :nick => @bot.nick }
+ when "getquote"
+ _("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"
+ _("countquote [<channel>] <regexp> => count quotes from <channel> that match <regexp>. You only need to supply <channel> if you are addressing %{nick} privately.") % { :nick => @bot.nick }
+ when "whoquote"
+ _("whoquote [<channel>] <num> => show who added quote <num>. You only need to supply <channel> if you are addressing %{nick} privately") % { :nick => @bot.nick }
+ when "whenquote"
+ _("whenquote [<channel>] <num> => show when quote <num> was added. You only need to supply <channel> if you are addressing %{nick} privately") % { :nick => @bot.nick }
+ 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, listquotes, topicquote, countquote, whoquote, whenquote, lastquote") % { :nick => @bot.nick }
end
end
- def listen(m)
- return unless(m.kind_of? PrivMessage)
- command = m.message.dup
- if(m.address? && m.private?)
- case command
- when (/^addquote\s+(#\S+)\s+(.*)/)
- channel = $1
- quote = $2
- if(@bot.auth.allow?("addquote", m.source, m.replyto))
- if(channel =~ /^#/)
- num = addquote(m.source, channel, quote)
- m.reply "added the quote (##{num})"
- end
- end
- when (/^getquote\s+(#\S+)$/)
- channel = $1
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = getquote(m.source, channel)
- if(quote)
- m.reply "[#{quote.num}] #{quote.quote}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^getquote\s+(#\S+)\s+(\d+)$/)
- channel = $1
- num = $2.to_i
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = getquote(m.source, channel, num)
- if(quote)
- m.reply "[#{quote.num}] #{quote.quote}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^whoquote\s+(#\S+)\s+(\d+)$/)
- channel = $1
- num = $2.to_i
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = getquote(m.source, channel, num)
- if(quote)
- m.reply "quote #{quote.num} added by #{quote.source}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^whenquote\s+(#\S+)\s+(\d+)$/)
- channel = $1
- num = $2.to_i
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = getquote(m.source, channel, num)
- if(quote)
- m.reply "quote #{quote.num} added on #{quote.date}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^topicquote\s+(#\S+)$/)
- channel = $1
- if(@bot.auth.allow?("topicquote", m.source, m.replyto))
- quote, total = getquote(m.source, channel)
- if(quote)
- @bot.topic channel, "[#{quote.num}] #{quote.quote}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^topicquote\s+(#\S+)\s+(\d+)$/)
- channel = $1
- num = $2.to_i
- if(@bot.auth.allow?("topicquote", m.source, m.replyto))
- quote, total = getquote(m.source, channel, num)
- if(quote)
- @bot.topic channel, "[#{quote.num}] #{quote.quote}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^delquote\s+(#\S+)\s+(\d+)$/)
- channel = $1
- num = $2.to_i
- if(@bot.auth.allow?("delquote", m.source, m.replyto))
- if(delquote(channel, num))
- m.okay
- else
- m.reply "quote not found!"
- end
- end
- when (/^searchquote\s+(#\S+)\s+(.*)$/)
- channel = $1
- reg = $2
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = searchquote(m.source, channel, reg)
- if(quote)
- m.reply "[#{quote.num}] #{quote.quote}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^countquote$/)
- if(@bot.auth.allow?("getquote", 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))
- total = countquote(m.source, channel, reg)
- if(reg.length > 0)
- m.reply "#{total} quotes match: #{reg}"
- else
- m.reply "#{total} quotes"
- end
- end
- end
- elsif (m.address? || (@bot.config["QUOTE_LISTEN"] && command.gsub!(/^!/, "")))
- case command
- when (/^addquote\s+(.+)/)
- if(@bot.auth.allow?("addquote", m.source, m.replyto))
- num = addquote(m.source, m.target, $1)
- m.reply "added the quote (##{num})"
- end
- when (/^getquote$/)
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = getquote(m.source, m.target)
- if(quote)
- m.reply "[#{quote.num}] #{quote.quote}"
- else
- m.reply "no quotes found!"
- end
- end
- when (/^getquote\s+(\d+)$/)
- num = $1.to_i
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = getquote(m.source, m.target, num)
- if(quote)
- m.reply "[#{quote.num}] #{quote.quote}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^whenquote\s+(\d+)$/)
- num = $1.to_i
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = getquote(m.source, m.target, num)
- if(quote)
- m.reply "quote #{quote.num} added on #{quote.date}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^whoquote\s+(\d+)$/)
- num = $1.to_i
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = getquote(m.source, m.target, num)
- if(quote)
- m.reply "quote #{quote.num} added by #{quote.source}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^topicquote$/)
- if(@bot.auth.allow?("topicquote", m.source, m.replyto))
- quote, total = getquote(m.source, m.target)
- if(quote)
- @bot.topic m.target, "[#{quote.num}] #{quote.quote}"
- else
- m.reply "no quotes found!"
- end
- end
- when (/^topicquote\s+(\d+)$/)
- num = $1.to_i
- if(@bot.auth.allow?("topicquote", m.source, m.replyto))
- quote, total = getquote(m.source, m.target, num)
- if(quote)
- @bot.topic m.target, "[#{quote.num}] #{quote.quote}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^delquote\s+(\d+)$/)
- num = $1.to_i
- if(@bot.auth.allow?("delquote", m.source, m.replyto))
- if(delquote(m.target, num))
- m.okay
- else
- m.reply "quote not found!"
- end
- end
- when (/^searchquote\s+(.*)$/)
- reg = $1
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = searchquote(m.source, m.target, reg)
- if(quote)
- m.reply "[#{quote.num}] #{quote.quote}"
- else
- m.reply "quote not found!"
- end
- end
- when (/^countquote(?:\s+(.*))?$/)
- reg = $1
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- total = countquote(m.source, m.target, reg)
- if(reg && reg.length > 0)
- m.reply "#{total} quotes match: #{reg}"
- else
- m.reply "#{total} quotes"
- end
- end
- end
+ def cmd_addquote(m, p)
+ channel = p[:channel] || m.channel.to_s
+ quote = p[:quote].to_s
+ num = addquote(m.source, channel, quote)
+ m.reply _("added the quote (#%{num})") % { :num => num }
+ end
+
+ def cmd_delquote(m, p)
+ channel = p[:channel] || m.channel.to_s
+ num = p[:num].to_i
+ if delquote(channel, num)
+ m.okay
+ else
+ m.reply _("quote not found!")
+ end
+ end
+
+ def cmd_getquote(m, p)
+ channel = p[:channel] || m.channel.to_s
+ num = p[:num] ? p[:num].to_i : nil
+ quote, total = getquote(m.source, channel, num)
+ if quote
+ m.reply _("[%{num}] %{quote}") % {
+ :num => quote.num,
+ :quote => quote.quote
+ }
+ else
+ m.reply _("quote not found!")
+ end
+ end
+
+ def cmd_whoquote(m, p)
+ channel = p[:channel] || m.channel.to_s
+ num = p[:num] ? p[:num].to_i : nil
+ quote, total = getquote(m.source, channel, num)
+ if quote
+ m.reply _("quote %{num} added by %{source}") % {
+ :num => quote.num,
+ :source => quote.source
+ }
+ else
+ m.reply _("quote not found!")
+ end
+ end
+
+ def cmd_whenquote(m, p)
+ channel = p[:channel] || m.channel.to_s
+ num = p[:num] ? p[:num].to_i : nil
+ quote, total = getquote(m.source, channel, num)
+ if quote
+ m.reply _("quote %{num} added on %{date}") % {
+ :num => quote.num,
+ :date => quote.date
+ }
+ else
+ m.reply _("quote not found!")
+ end
+ end
+
+ def cmd_searchquote(m, p)
+ channel = p[:channel] || m.channel.to_s
+ reg = p[:reg].to_s
+ quote, total = searchquote(m.source, channel, reg)
+ if quote
+ m.reply _("[%{num}] %{quote}") % {
+ :num => quote.num,
+ :quote => quote.quote
+ }
+ else
+ m.reply _("quote not found!")
+ 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
+ total = countquote(m.source, channel, reg)
+ if reg.length > 0
+ m.reply _("%{total} quotes matching %{reg}") % {
+ :total => total,
+ :reg => reg
+ }
+ else
+ m.reply _("%{total} quotes") % { :total => total }
+ end
+ end
+
+ def cmd_topicquote(m, p)
+ channel = p[:channel] || m.channel.to_s
+ num = p[:num] ? p[:num].to_i : nil
+ quote, total = getquote(m.source, channel, num)
+ if quote
+ @bot.topic channel, _("[%{num}] %{quote}") % {
+ :num => quote.num,
+ :quote => quote.quote
+ }
+ else
+ m.reply _("quote not found!")
+ end
+ end
+
+ def cmd_lastquote(m, p)
+ channel = p[:channel] || m.channel.to_s
+ quote, total = getquote(m.source, channel, lastquote(channel))
+ if quote
+ m.reply _("[%{num}] %{quote}") % {
+ :num => quote.num,
+ :quote => quote.quote
+ }
+ else
+ m.reply _("quote not found!")
end
end
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
+
+plugin.map "addquote *quote", :action => :cmd_addquote, :private => false, :auth_path => '!quote::edit::add!'
+plugin.map "delquote :num", :action => :cmd_delquote, :private => false, :requirements => { :num => /^\d+$/ }, :auth_path => '!quote::edit::del!'
+plugin.map "getquote [:num]", :action => :cmd_getquote, :private => false, :requirements => { :num => /^\d+$/ }, :auth_path => '!quote::view::get!'
+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!'
+
projects / user / henk / code / ruby / rbot.git / blobdiff