-Quote = Struct.new("Quote", "num", "date", "source", "quote")
+#-- vim:sw=2:et
+#++
+#
+# :title: Quotes plugin
+#
+# TODO:: use message mapper instead of multiple ifs
+# TODO:: switch to db
+
+define_structure :Quote, :num, :date, :source, :quote
class QuotePlugin < Plugin
def initialize
super
@lists = Hash.new
+ @changed = Hash.new
Dir["#{@bot.botclass}/quotes/*"].each {|f|
+ next if File.directory?(f)
channel = File.basename(f)
@lists[channel] = Array.new if(!@lists.has_key?(channel))
IO.foreach(f) {|line|
@lists[channel][num] = Quote.new(num, $2, $3, $4)
end
}
+ @changed[channel] = false
}
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}"
- }
- }
+ begin
+ if @changed[channel]
+ debug "Writing new quotefile for channel #{channel} ..."
+ Utils.safe_save("#{@bot.botclass}/quotes/#{channel}") {|file|
+ quotes.compact.each {|q|
+ file.puts "#{q.num} | #{q.date} | #{q.source} | #{q.quote}"
+ }
+ }
+ @changed[channel] = false
+ else
+ debug "Not writing quotefile for channel #{channel} (unchanged)"
+ end
+ rescue => e
+ error "failed to write quotefile for channel #{channel}!\n#{$!}"
+ error "#{e.class}: #{e}"
+ error e.backtrace.join("\n")
+ 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
- @lists[channel][num] = Quote.new(num, Time.new, source, quote)
+ @lists[channel][num] = Quote.new(num, Time.new, source.fullform, quote)
+ @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)
else
# random quote
return @lists[channel].compact[rand(@lists[channel].nitems)],
- @lists[channel].length - 1
+ @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
+ @changed[channel] = true
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 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"
+ 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"
end
end
+
def listen(m)
return unless(m.kind_of? PrivMessage)
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})"
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}"
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}"
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}"
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}"
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}"
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}"
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
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}"
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}"
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)
+ 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))
- quote, total = getquote(m.source, m.target)
+ 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}"
else
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(@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}"
else
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(@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}"
else
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(@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}"
else
end
end
when (/^topicquote$/)
- if(@bot.auth.allow?("topicquote", m.source, m.replyto))
- quote, total = getquote(m.source, m.target)
+ 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}"
else
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(@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}"
else
end
when (/^delquote\s+(\d+)$/)
num = $1.to_i
- if(@bot.auth.allow?("delquote", m.source, m.replyto))
- if(delquote(m.target, num))
+ if(@bot.auth.allow?("quote::del", m.source, m.replyto))
+ if(delquote(m.target.to_s, num))
m.okay
else
m.reply "quote not found!"
end
when (/^searchquote\s+(.*)$/)
reg = $1
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- quote, total = searchquote(m.source, m.target, reg)
+ 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}"
else
end
when (/^countquote(?:\s+(.*))?$/)
reg = $1
- if(@bot.auth.allow?("getquote", m.source, m.replyto))
- total = countquote(m.source, m.target, reg)
+ 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}"
else
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
projects / user / henk / code / ruby / rbot.git / blobdiff