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: n the Quiz class, @registry.has_key? seems to be case
11 # 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
14 # matching the nick. TODO define a class for the rank table. We might also need it
15 # for scoring in other games.
17 # Class for storing question/answer pairs
18 QuizBundle = Struct.new( "QuizBundle", :question, :answer )
20 # Class for storing player stats
21 PlayerStats = Struct.new( "PlayerStats", :score, :jokers, :jokers_time )
22 # Why do we still need jokers_time? //Firetech
24 # Maximum number of jokers a player can gain
32 #######################################################################
34 # One Quiz instance per channel, contains channel specific data
35 #######################################################################
37 attr_accessor :registry, :registry_conf, :questions, :question, :answer, :answer_core,
38 :first_try, :hint, :hintrange, :rank_table, :hinted, :has_errors
40 def initialize( channel, registry )
42 @registry = registry.sub_registry( 'private' )
44 @registry = registry.sub_registry( channel.downcase )
47 @registry.each_key { |k|
48 unless @registry.has_key?(k)
50 error "Data for #{k} is NOT ACCESSIBLE! Database corrupt?"
54 debug @registry.to_a.map { |a| a.join(", ")}.join("\n")
57 @registry_conf = @registry.sub_registry( "config" )
59 # Per-channel copy of the global questions table. Acts like a shuffled queue
60 # from which questions are taken, until empty. Then we refill it with questions
61 # from the global table.
62 @registry_conf["questions"] = [] unless @registry_conf.has_key?( "questions" )
64 # Autoask defaults to true
65 @registry_conf["autoask"] = true unless @registry_conf.has_key?( "autoask" )
67 @questions = @registry_conf["questions"]
76 # We keep this array of player stats for performance reasons. It's sorted by score
77 # and always synced with the registry player stats hash. This way we can do fast
78 # rank lookups, without extra sorting.
79 @rank_table = @registry.to_a.sort { |a,b| b[1].score<=>a[1].score }
84 #######################################################################
86 #######################################################################
87 class QuizPlugin < Plugin
91 @questions = Array.new
95 # Function that returns whether a char is a "separator", used for hints
111 # Fetches questions from a file on the server and from the wiki, then merges
112 # and transforms the questions and fills the global question table.
115 # Read the winning messages file
116 @win_messages = Array.new
117 if File.exists? "#{@bot.botclass}/quiz/win_messages"
118 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
120 warning( "win_messages file not found!" )
121 # Fill the array with a least one message or code accessing it would fail
122 @win_messages << "<who> guessed right! The answer was <answer>"
125 # TODO: Make this configurable, and add support for more than one file (there's a size limit in linux too ;) )
126 path = "#{@bot.botclass}/quiz/quiz.rbot"
127 debug "Fetching from #{path}"
129 m.reply "Fetching questions from local database and wiki.."
133 datafile = File.new( path, File::RDONLY )
134 localdata = datafile.read
136 m.reply "Failed to read local database file. oioi."
142 serverdata = @bot.httputil.get_cached( URI.parse( "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz" ) )
143 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
144 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
145 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
147 m.reply "Failed to download wiki questions. oioi."
149 m.reply "No questions loaded, aborting."
156 # Fuse together and remove comments, then split
157 data = "\n\n#{localdata}\n\n#{serverdata}".gsub( /^#.*$/, "" )
158 entries = data.split( "\nQuestion: " )
159 #First entry will be empty.
164 # We'll need at least two lines of data
166 # Check if question isn't empty
168 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
169 # Delete all lines between the question and the answer
172 p[1] = p[1].gsub( /Answer: /, "" ).strip
173 # If the answer was found
175 # Add the data to the array
176 b = QuizBundle.new( p[0], p[1] )
183 m.reply "done, #{@questions.length} questions loaded."
187 # Returns new Quiz instance for channel, or existing one
189 def create_quiz( channel )
190 unless @quizzes.has_key?( channel )
191 @quizzes[channel] = Quiz.new( channel, @registry )
194 if @quizzes[channel].has_errors
197 return @quizzes[channel]
202 def say_score( m, nick )
204 q = create_quiz( chan )
206 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
210 if q.registry.has_key?( nick )
211 score = q.registry[nick].score
212 jokers = q.registry[nick].jokers
215 q.rank_table.each_index { |rank| break if nick.downcase == q.rank_table[rank][0].downcase }
218 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
220 m.reply "#{nick} does not have a score yet. Lamer."
225 def help( plugin, topic="" )
227 "Quiz game aministration commands (requires authentication): 'quiz autoask <on/off>' => enable/disable 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)."
229 "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"
234 # Updates the per-channel rank table, which is kept for performance reasons.
235 # This table contains all players sorted by rank.
237 def calculate_ranks( m, q, nick )
238 if q.registry.has_key?( nick )
239 stats = q.registry[nick]
241 # Find player in table
244 q.rank_table.each_index do |i|
245 if nick.downcase == q.rank_table[i][0].downcase
251 # Remove player from old position
254 q.rank_table.delete_at( i )
259 # Insert player at new position
261 q.rank_table.each_index do |i|
262 if stats.score > q.rank_table[i][1].score
263 q.rank_table[i,0] = [[nick, stats]]
269 # If less than all other players' scores, append to table
271 i += 1 unless q.rank_table.empty?
272 q.rank_table << [nick, stats]
275 # Print congratulations/condolences if the player's rank has changed
278 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
280 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
284 q.rank_table << [[nick, PlayerStats.new( 1 )]]
289 # Reimplemented from Plugin
292 return unless m.kind_of?(PrivMessage)
295 return unless @quizzes.has_key?( chan )
298 return if q.question == nil
300 message = m.message.downcase.strip
302 nick = m.sourcenick.to_s
304 if message == q.answer.downcase or message == q.answer_core.downcase
308 reply = "WHOPEEE! #{nick} got it on the first try! That's worth an extra point. Answer was: #{q.answer}"
309 elsif q.rank_table.length >= 1 and nick.downcase == q.rank_table[0][0].downcase
310 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{nick} is invicible! Answer was: #{q.answer}"
311 elsif q.rank_table.length >= 2 and nick.downcase == q.rank_table[1][0].downcase
312 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}"
313 elsif q.rank_table.length >= 3 and nick.downcase == q.rank_table[2][0].downcase
314 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}"
316 reply = @win_messages[rand( @win_messages.length )].dup
317 reply.gsub!( "<who>", nick )
318 reply.gsub!( "<answer>", q.answer )
324 if q.registry.has_key?(nick)
325 player = q.registry[nick]
327 player = PlayerStats.new( 0, 0, 0 )
330 player.score = player.score + points
332 # Reward player with a joker every X points
333 if player.score % 15 == 0 and player.jokers < Max_Jokers
335 m.reply "#{nick} gains a new joker. Rejoice :)"
338 q.registry[nick] = player
339 calculate_ranks( m, q, nick)
342 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
344 # First try is used, and it wasn't the answer.
350 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
351 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
353 def unhilight_nick( nick )
356 0.upto( nick.length - 1 ) do |i|
357 new_nick += nick[i, 1]
358 new_nick += "." unless i == nick.length - 1
365 #######################################################################
367 #######################################################################
368 def cmd_quiz( m, params )
369 fetch_data( m ) if @questions.empty?
370 q = create_quiz( m.channel )
372 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
377 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
378 m.reply "Hint: #{q.hint}" if q.hinted
382 # Fill per-channel questions buffer
383 if q.questions.empty?
384 temp = @questions.dup
387 i = rand( temp.length )
388 q.questions << temp[i]
393 i = rand( q.questions.length )
394 q.question = q.questions[i].question
395 q.answer = q.questions[i].answer.gsub( "#", "" )
398 q.answer_core = /(#)(.*)(#)/.match( q.questions[i].answer )[2]
402 q.answer_core = q.answer.dup if q.answer_core == nil
404 # Check if core answer is numerical and tell the players so, if that's the case
405 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
406 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
408 q.questions.delete_at( i )
413 (0..q.answer_core.length-1).each do |index|
414 if is_sep(q.answer_core[index,1])
415 q.hint << q.answer_core[index]
422 # Generate array of unique random range
423 q.hintrange = (0..q.answer_core.length-1).sort_by{rand}
425 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
429 def cmd_solve( m, params )
432 return unless @quizzes.has_key?( chan )
435 m.reply "The correct answer was: #{q.answer}"
439 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
443 def cmd_hint( m, params )
445 nick = m.sourcenick.to_s
447 return unless @quizzes.has_key?(chan)
451 m.reply "#{nick}: Get a question first!"
453 num_chars = case q.hintrange.length # Number of characters to reveal
465 index = q.hintrange.pop
466 # New hint char until the char isn't a "separator" (space etc.)
467 end while is_sep(q.answer_core[index,1])
468 q.hint[index] = q.answer_core[index]
470 m.reply "Hint: #{q.hint}"
473 if q.hint == q.answer_core
474 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{nick}#{Color}."
477 if q.registry.has_key?( nick )
478 stats = q.registry[nick]
480 stats = PlayerStats.new( 0, 0, 0 )
483 stats["score"] = stats.score - 1
484 q.registry[nick] = stats
486 calculate_ranks( m, q, nick)
489 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
495 def cmd_skip( m, params )
497 return unless @quizzes.has_key?(chan)
501 cmd_quiz( m, params )
505 def cmd_joker( m, params )
507 nick = m.sourcenick.to_s
508 q = create_quiz(chan)
510 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
515 m.reply "#{nick}: There is no open question."
519 if q.registry[nick].jokers > 0
520 player = q.registry[nick]
523 q.registry[nick] = player
525 calculate_ranks( m, q, nick )
527 if player.jokers != 1
532 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{nick} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
533 m.reply "The answer was: #{q.answer}."
536 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
538 m.reply "#{nick}: You don't have any jokers left ;("
543 def cmd_fetch( m, params )
548 def cmd_top5( m, params )
550 q = create_quiz( chan )
552 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
556 if q.rank_table.empty?
557 m.reply "There are no scores known yet!"
561 m.reply "* Top 5 Players for #{chan}:"
563 [5, q.rank_table.length].min.times do |i|
564 player = q.rank_table[i]
566 score = player[1].score
567 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
572 def cmd_top_number( m, params )
573 num = params[:number].to_i
574 return unless 1..50 === num
576 q = create_quiz( chan )
578 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
582 if q.rank_table.empty?
583 m.reply "There are no scores known yet!"
588 m.reply "* Top #{num} Players for #{chan}:"
589 n = [ num, q.rank_table.length ].min
591 player = q.rank_table[i]
593 score = player[1].score
594 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
596 m.reply ar.join(" | ")
600 def cmd_stats( m, params )
601 fetch_data( m ) if @questions.empty?
603 m.reply "* Total Number of Questions:"
604 m.reply " #{@questions.length}"
608 def cmd_score( m, params )
609 nick = m.sourcenick.to_s
614 def cmd_score_player( m, params )
615 say_score( m, params[:player] )
619 def cmd_autoask( m, params )
621 q = create_quiz( chan )
623 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
627 if params[:enable].downcase == "on"
628 q.registry_conf["autoask"] = true
629 m.reply "Enabled autoask mode."
630 cmd_quiz( m, nil ) if q.question == nil
631 elsif params[:enable].downcase == "off"
632 q.registry_conf["autoask"] = false
633 m.reply "Disabled autoask mode."
635 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
640 def cmd_transfer( m, params )
642 q = create_quiz( chan )
644 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
648 debug q.rank_table.inspect
650 source = params[:source]
652 transscore = params[:score].to_i
653 transjokers = params[:jokers].to_i
654 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
656 if q.registry.has_key?(source)
657 sourceplayer = q.registry[source]
658 score = sourceplayer.score
662 if score < transscore
663 m.reply "#{source} only has #{score} points!"
666 jokers = sourceplayer.jokers
670 if jokers < transjokers
671 m.reply "#{source} only has #{jokers} jokers!!"
674 if q.registry.has_key?(dest)
675 destplayer = q.registry[dest]
677 destplayer = PlayerStats.new(0,0,0)
680 if sourceplayer == destplayer
681 m.reply "Source and destination are the same, I'm not going to touch them"
685 sourceplayer.score -= transscore
686 destplayer.score += transscore
687 sourceplayer.jokers -= transjokers
688 destplayer.jokers += transjokers
690 q.registry[source] = sourceplayer
691 calculate_ranks(m, q, source)
693 q.registry[dest] = destplayer
694 calculate_ranks(m, q, dest)
696 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
698 m.reply "#{source} doesn't have any points!"
703 def cmd_del_player( m, params )
705 q = create_quiz( chan )
707 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
711 debug q.rank_table.inspect
714 if q.registry.has_key?(nick)
715 player = q.registry[nick]
718 m.reply "Can't delete player #{nick} with score #{score}."
721 jokers = player.jokers
723 m.reply "Can't delete player #{nick} with #{jokers} jokers."
726 q.registry.delete(nick)
729 q.rank_table.each_index { |rank|
730 if nick.downcase == q.rank_table[rank][0].downcase
735 q.rank_table.delete_at(player_rank)
737 m.reply "Player #{nick} deleted."
739 m.reply "Player #{nick} isn't even in the database."
744 def cmd_set_score(m, params)
746 q = create_quiz( chan )
748 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
751 debug q.rank_table.inspect
754 val = params[:score].to_i
755 if q.registry.has_key?(nick)
756 player = q.registry[nick]
759 player = PlayerStats.new( val, 0, 0)
761 q.registry[nick] = player
762 calculate_ranks(m, q, nick)
763 m.reply "Score for player #{nick} set to #{val}."
767 def cmd_set_jokers(m, params)
769 q = create_quiz( chan )
771 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
774 debug q.rank_table.inspect
777 val = [params[:jokers].to_i, Max_Jokers].min
778 if q.registry.has_key?(nick)
779 player = q.registry[nick]
782 player = PlayerStats.new( 0, val, 0)
784 q.registry[nick] = player
785 m.reply "Jokers for player #{nick} set to #{val}."
791 plugin = QuizPlugin.new
792 plugin.default_auth( 'edit', false )
795 plugin.map 'quiz', :action => 'cmd_quiz'
796 plugin.map 'quiz solve', :action => 'cmd_solve'
797 plugin.map 'quiz hint', :action => 'cmd_hint'
798 plugin.map 'quiz skip', :action => 'cmd_skip'
799 plugin.map 'quiz joker', :action => 'cmd_joker'
800 plugin.map 'quiz score', :action => 'cmd_score'
801 plugin.map 'quiz score :player', :action => 'cmd_score_player'
802 plugin.map 'quiz fetch', :action => 'cmd_fetch'
803 plugin.map 'quiz top5', :action => 'cmd_top5'
804 plugin.map 'quiz top :number', :action => 'cmd_top_number'
805 plugin.map 'quiz stats', :action => 'cmd_stats'
808 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
809 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
810 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
811 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
812 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'