1 # Plugin for the Ruby IRC bot (http://linuxbrit.co.uk/rbot/)
3 # A trivia quiz game. Fast paced, featureful and fun.
5 # (c) 2006 Mark Kretschmann <markey@web.de>
6 # (c) 2006 Jocke Andersson <ajocke@gmail.com>
7 # (c) 2006 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
8 # Licensed under GPL V2.
10 # FIXME interesting fact: in the Quiz class, @registry.has_key? seems to be
11 # case insensitive. Although this is all right for us, this leads to rank vs
12 # registry mismatches. So we have to make the @rank_table comparisons case
13 # insensitive as well. For the moment, redefine everything to downcase before
16 # TODO define a class for the rank table. We might also need it for scoring in
19 # Class for storing question/answer pairs
20 QuizBundle = Struct.new( "QuizBundle", :question, :answer )
22 # Class for storing player stats
23 PlayerStats = Struct.new( "PlayerStats", :score, :jokers, :jokers_time )
24 # Why do we still need jokers_time? //Firetech
26 # Maximum number of jokers a player can gain
34 #######################################################################
36 # One Quiz instance per channel, contains channel specific data
37 #######################################################################
39 attr_accessor :registry, :registry_conf, :questions, :question, :answer, :answer_core,
40 :first_try, :hint, :hintrange, :rank_table, :hinted, :has_errors
42 def initialize( channel, registry )
44 @registry = registry.sub_registry( 'private' )
46 @registry = registry.sub_registry( channel.downcase )
49 @registry.each_key { |k|
50 unless @registry.has_key?(k)
52 error "Data for #{k} is NOT ACCESSIBLE! Database corrupt?"
56 debug @registry.to_a.map { |a| a.join(", ")}.join("\n")
59 @registry_conf = @registry.sub_registry( "config" )
61 # Per-channel copy of the global questions table. Acts like a shuffled queue
62 # from which questions are taken, until empty. Then we refill it with questions
63 # from the global table.
64 @registry_conf["questions"] = [] unless @registry_conf.has_key?( "questions" )
66 # Autoask defaults to true
67 @registry_conf["autoask"] = true unless @registry_conf.has_key?( "autoask" )
69 # Autoask delay defaults to 0 (instantly)
70 @registry_conf["autoask_delay"] = 0 unless @registry_conf.has_key?( "autoask_delay" )
72 @questions = @registry_conf["questions"]
81 # We keep this array of player stats for performance reasons. It's sorted by score
82 # and always synced with the registry player stats hash. This way we can do fast
83 # rank lookups, without extra sorting.
84 @rank_table = @registry.to_a.sort { |a,b| b[1].score<=>a[1].score }
89 #######################################################################
91 #######################################################################
92 class QuizPlugin < Plugin
96 @questions = Array.new
99 @ask_mutex = Mutex.new
102 # Function that returns whether a char is a "separator", used for hints
118 # Fetches questions from a file on the server and from the wiki, then merges
119 # and transforms the questions and fills the global question table.
122 # Read the winning messages file
123 @win_messages = Array.new
124 if File.exists? "#{@bot.botclass}/quiz/win_messages"
125 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
127 warning( "win_messages file not found!" )
128 # Fill the array with a least one message or code accessing it would fail
129 @win_messages << "<who> guessed right! The answer was <answer>"
132 # TODO: Make this configurable, and add support for more than one file (there's a size limit in linux too ;) )
133 path = "#{@bot.botclass}/quiz/quiz.rbot"
134 debug "Fetching from #{path}"
136 m.reply "Fetching questions from local database and wiki.."
140 datafile = File.new( path, File::RDONLY )
141 localdata = datafile.read
143 m.reply "Failed to read local database file. oioi."
149 serverdata = @bot.httputil.get_cached( URI.parse( "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz" ) )
150 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
151 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
152 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
154 m.reply "Failed to download wiki questions. oioi."
156 m.reply "No questions loaded, aborting."
163 # Fuse together and remove comments, then split
164 data = "\n\n#{localdata}\n\n#{serverdata}".gsub( /^#.*$/, "" )
165 entries = data.split( "\nQuestion: " )
166 #First entry will be empty.
171 # We'll need at least two lines of data
173 # Check if question isn't empty
175 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
176 # Delete all lines between the question and the answer
179 p[1] = p[1].gsub( /Answer: /, "" ).strip
180 # If the answer was found
182 # Add the data to the array
183 b = QuizBundle.new( p[0], p[1] )
190 m.reply "done, #{@questions.length} questions loaded."
194 # Returns new Quiz instance for channel, or existing one
196 def create_quiz( channel )
197 unless @quizzes.has_key?( channel )
198 @quizzes[channel] = Quiz.new( channel, @registry )
201 if @quizzes[channel].has_errors
204 return @quizzes[channel]
209 def say_score( m, nick )
211 q = create_quiz( chan )
213 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
217 if q.registry.has_key?( nick )
218 score = q.registry[nick].score
219 jokers = q.registry[nick].jokers
222 q.rank_table.each_index { |rank| break if nick.downcase == q.rank_table[rank][0].downcase }
225 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
227 m.reply "#{nick} does not have a score yet. Lamer."
232 def help( plugin, topic="" )
234 "Quiz game aministration commands (requires authentication): 'quiz autoask <on/off>' => enable/disable autoask mode. 'quiz autoask delay <secs>' => delay next quiz by <secs> seconds when in autoask mode. 'quiz transfer <source> <dest> [score] [jokers]' => transfer [score] points and [jokers] jokers from <source> to <dest> (default is entire score and all jokers). 'quiz setscore <player> <score>' => set <player>'s score to <score>. 'quiz setjokers <player> <jokers>' => set <player>'s number of jokers to <jokers>. 'quiz deleteplayer <player>' => delete one player from the rank table (only works when score and jokers are set to 0)."
236 "A multiplayer trivia quiz. 'quiz' => ask a question. 'quiz hint' => get a hint. 'quiz solve' => solve this question. 'quiz skip' => skip to next question. 'quiz joker' => draw a joker to win this round. 'quiz score [player]' => show score for [player] (default is yourself). 'quiz top5' => show top 5 players. 'quiz top <number>' => show top <number> players (max 50). 'quiz stats' => show some statistics. 'quiz fetch' => refetch questions from databases.\nYou can add new questions at http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz"
241 # Updates the per-channel rank table, which is kept for performance reasons.
242 # This table contains all players sorted by rank.
244 def calculate_ranks( m, q, nick )
245 if q.registry.has_key?( nick )
246 stats = q.registry[nick]
248 # Find player in table
251 q.rank_table.each_index do |i|
252 if nick.downcase == q.rank_table[i][0].downcase
258 # Remove player from old position
261 q.rank_table.delete_at( i )
266 # Insert player at new position
268 q.rank_table.each_index do |i|
269 if stats.score > q.rank_table[i][1].score
270 q.rank_table[i,0] = [[nick, stats]]
276 # If less than all other players' scores, append to table
278 i += 1 unless q.rank_table.empty?
279 q.rank_table << [nick, stats]
282 # Print congratulations/condolences if the player's rank has changed
285 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
287 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
291 q.rank_table << [[nick, PlayerStats.new( 1 )]]
296 # Reimplemented from Plugin
299 return unless m.kind_of?(PrivMessage)
302 return unless @quizzes.has_key?( chan )
305 return if q.question == nil
307 message = m.message.downcase.strip
309 nick = m.sourcenick.to_s
311 if message == q.answer.downcase or message == q.answer_core.downcase
315 reply = "WHOPEEE! #{nick} got it on the first try! That's worth an extra point. Answer was: #{q.answer}"
316 elsif q.rank_table.length >= 1 and nick.downcase == q.rank_table[0][0].downcase
317 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{nick} is invicible! Answer was: #{q.answer}"
318 elsif q.rank_table.length >= 2 and nick.downcase == q.rank_table[1][0].downcase
319 reply = "THE SECOND CHAMPION is on the way up! Hurry up #{nick}, you only need #{q.rank_table[0][1].score - q.rank_table[1][1].score - 1} points to beat the king! Answer was: #{q.answer}"
320 elsif q.rank_table.length >= 3 and nick.downcase == q.rank_table[2][0].downcase
321 reply = "THE THIRD CHAMPION strikes again! Give it all #{nick}, with #{q.rank_table[1][1].score - q.rank_table[2][1].score - 1} more points you'll reach the 2nd place! Answer was: #{q.answer}"
323 reply = @win_messages[rand( @win_messages.length )].dup
324 reply.gsub!( "<who>", nick )
325 reply.gsub!( "<answer>", q.answer )
331 if q.registry.has_key?(nick)
332 player = q.registry[nick]
334 player = PlayerStats.new( 0, 0, 0 )
337 player.score = player.score + points
339 # Reward player with a joker every X points
340 if player.score % 15 == 0 and player.jokers < Max_Jokers
342 m.reply "#{nick} gains a new joker. Rejoice :)"
345 q.registry[nick] = player
346 calculate_ranks( m, q, nick)
349 if q.registry_conf["autoask"]
350 delay = q.registry_conf["autoask_delay"]
352 m.reply "#{Bold}#{Color}03Next question in #{Bold}#{delay}#{Bold} seconds"
353 timer = @bot.timer.add_once(delay) {
354 @ask_mutex.synchronize do
355 @waiting.delete(chan)
359 @waiting[chan] = timer
365 # First try is used, and it wasn't the answer.
371 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
372 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
374 def unhilight_nick( nick )
377 0.upto( nick.length - 1 ) do |i|
378 new_nick += nick[i, 1]
379 new_nick += "." unless i == nick.length - 1
386 #######################################################################
388 #######################################################################
389 def cmd_quiz( m, params )
390 fetch_data( m ) if @questions.empty?
393 @ask_mutex.synchronize do
394 if @waiting.has_key?(chan)
395 m.reply "Next quiz question will be automatically asked soon, have patience"
400 q = create_quiz( chan )
402 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
407 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
408 m.reply "Hint: #{q.hint}" if q.hinted
412 # Fill per-channel questions buffer
413 if q.questions.empty?
414 temp = @questions.dup
417 i = rand( temp.length )
418 q.questions << temp[i]
423 i = rand( q.questions.length )
424 q.question = q.questions[i].question
425 q.answer = q.questions[i].answer.gsub( "#", "" )
428 q.answer_core = /(#)(.*)(#)/.match( q.questions[i].answer )[2]
432 q.answer_core = q.answer.dup if q.answer_core == nil
434 # Check if core answer is numerical and tell the players so, if that's the case
435 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
436 q.question += "#{Color}07 (Numerical answer)#{Color}" if q.answer_core.to_i.to_s == q.answer_core or q.answer_core.to_f.to_s == q.answer_core
438 q.questions.delete_at( i )
443 (0..q.answer_core.length-1).each do |index|
444 if is_sep(q.answer_core[index,1])
445 q.hint << q.answer_core[index]
452 # Generate array of unique random range
453 q.hintrange = (0..q.answer_core.length-1).sort_by{rand}
455 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
459 def cmd_solve( m, params )
462 return unless @quizzes.has_key?( chan )
465 m.reply "The correct answer was: #{q.answer}"
469 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
473 def cmd_hint( m, params )
475 nick = m.sourcenick.to_s
477 return unless @quizzes.has_key?(chan)
481 m.reply "#{nick}: Get a question first!"
483 num_chars = case q.hintrange.length # Number of characters to reveal
495 index = q.hintrange.pop
496 # New hint char until the char isn't a "separator" (space etc.)
497 end while is_sep(q.answer_core[index,1])
498 q.hint[index] = q.answer_core[index]
500 m.reply "Hint: #{q.hint}"
503 if q.hint == q.answer_core
504 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{nick}#{Color}."
507 if q.registry.has_key?( nick )
508 stats = q.registry[nick]
510 stats = PlayerStats.new( 0, 0, 0 )
513 stats["score"] = stats.score - 1
514 q.registry[nick] = stats
516 calculate_ranks( m, q, nick)
519 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
525 def cmd_skip( m, params )
527 return unless @quizzes.has_key?(chan)
531 cmd_quiz( m, params )
535 def cmd_joker( m, params )
537 nick = m.sourcenick.to_s
538 q = create_quiz(chan)
540 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
545 m.reply "#{nick}: There is no open question."
549 if q.registry[nick].jokers > 0
550 player = q.registry[nick]
553 q.registry[nick] = player
555 calculate_ranks( m, q, nick )
557 if player.jokers != 1
562 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{nick} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
563 m.reply "The answer was: #{q.answer}."
566 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
568 m.reply "#{nick}: You don't have any jokers left ;("
573 def cmd_fetch( m, params )
578 def cmd_top5( m, params )
580 q = create_quiz( chan )
582 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
586 if q.rank_table.empty?
587 m.reply "There are no scores known yet!"
591 m.reply "* Top 5 Players for #{chan}:"
593 [5, q.rank_table.length].min.times do |i|
594 player = q.rank_table[i]
596 score = player[1].score
597 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
602 def cmd_top_number( m, params )
603 num = params[:number].to_i
604 return if num < 1 or num > 50
606 q = create_quiz( chan )
608 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
612 if q.rank_table.empty?
613 m.reply "There are no scores known yet!"
618 m.reply "* Top #{num} Players for #{chan}:"
619 n = [ num, q.rank_table.length ].min
621 player = q.rank_table[i]
623 score = player[1].score
624 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
626 m.reply ar.join(" | ")
630 def cmd_stats( m, params )
631 fetch_data( m ) if @questions.empty?
633 m.reply "* Total Number of Questions:"
634 m.reply " #{@questions.length}"
638 def cmd_score( m, params )
639 nick = m.sourcenick.to_s
644 def cmd_score_player( m, params )
645 say_score( m, params[:player] )
649 def cmd_autoask( m, params )
651 q = create_quiz( chan )
653 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
657 case params[:enable].downcase
659 q.registry_conf["autoask"] = true
660 m.reply "Enabled autoask mode."
661 cmd_quiz( m, nil ) if q.question == nil
663 q.registry_conf["autoask"] = false
664 m.reply "Disabled autoask mode."
666 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
670 def cmd_autoask_delay( m, params )
672 q = create_quiz( chan )
674 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
678 delay = params[:time].to_i
679 q.registry_conf["autoask_delay"] = delay
680 m.reply "Autoask delay now #{q.registry_conf['autoask_delay']} seconds"
684 def cmd_transfer( m, params )
686 q = create_quiz( chan )
688 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
692 debug q.rank_table.inspect
694 source = params[:source]
696 transscore = params[:score].to_i
697 transjokers = params[:jokers].to_i
698 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
700 if q.registry.has_key?(source)
701 sourceplayer = q.registry[source]
702 score = sourceplayer.score
706 if score < transscore
707 m.reply "#{source} only has #{score} points!"
710 jokers = sourceplayer.jokers
714 if jokers < transjokers
715 m.reply "#{source} only has #{jokers} jokers!!"
718 if q.registry.has_key?(dest)
719 destplayer = q.registry[dest]
721 destplayer = PlayerStats.new(0,0,0)
724 if sourceplayer == destplayer
725 m.reply "Source and destination are the same, I'm not going to touch them"
729 sourceplayer.score -= transscore
730 destplayer.score += transscore
731 sourceplayer.jokers -= transjokers
732 destplayer.jokers += transjokers
734 q.registry[source] = sourceplayer
735 calculate_ranks(m, q, source)
737 q.registry[dest] = destplayer
738 calculate_ranks(m, q, dest)
740 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
742 m.reply "#{source} doesn't have any points!"
747 def cmd_del_player( m, params )
749 q = create_quiz( chan )
751 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
755 debug q.rank_table.inspect
758 if q.registry.has_key?(nick)
759 player = q.registry[nick]
762 m.reply "Can't delete player #{nick} with score #{score}."
765 jokers = player.jokers
767 m.reply "Can't delete player #{nick} with #{jokers} jokers."
770 q.registry.delete(nick)
773 q.rank_table.each_index { |rank|
774 if nick.downcase == q.rank_table[rank][0].downcase
779 q.rank_table.delete_at(player_rank)
781 m.reply "Player #{nick} deleted."
783 m.reply "Player #{nick} isn't even in the database."
788 def cmd_set_score(m, params)
790 q = create_quiz( chan )
792 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
795 debug q.rank_table.inspect
798 val = params[:score].to_i
799 if q.registry.has_key?(nick)
800 player = q.registry[nick]
803 player = PlayerStats.new( val, 0, 0)
805 q.registry[nick] = player
806 calculate_ranks(m, q, nick)
807 m.reply "Score for player #{nick} set to #{val}."
811 def cmd_set_jokers(m, params)
813 q = create_quiz( chan )
815 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
818 debug q.rank_table.inspect
821 val = [params[:jokers].to_i, Max_Jokers].min
822 if q.registry.has_key?(nick)
823 player = q.registry[nick]
826 player = PlayerStats.new( 0, val, 0)
828 q.registry[nick] = player
829 m.reply "Jokers for player #{nick} set to #{val}."
835 plugin = QuizPlugin.new
836 plugin.default_auth( 'edit', false )
839 plugin.map 'quiz', :action => 'cmd_quiz'
840 plugin.map 'quiz solve', :action => 'cmd_solve'
841 plugin.map 'quiz hint', :action => 'cmd_hint'
842 plugin.map 'quiz skip', :action => 'cmd_skip'
843 plugin.map 'quiz joker', :action => 'cmd_joker'
844 plugin.map 'quiz score', :action => 'cmd_score'
845 plugin.map 'quiz score :player', :action => 'cmd_score_player'
846 plugin.map 'quiz fetch', :action => 'cmd_fetch'
847 plugin.map 'quiz top5', :action => 'cmd_top5'
848 plugin.map 'quiz top :number', :action => 'cmd_top_number'
849 plugin.map 'quiz stats', :action => 'cmd_stats'
852 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
853 plugin.map 'quiz autoask delay :time', :action => 'cmd_autoask_delay', :auth_path => 'edit', :requirements => {:time => /\d+/}
854 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
855 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
856 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
857 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'