4 # :title: Quiz plugin for rbot
6 # Author:: Mark Kretschmann <markey@web.de>
7 # Author:: Jocke Andersson <ajocke@gmail.com>
8 # Author:: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
9 # Author:: Yaohan Chen <yaohan.chen@gmail.com>
11 # Copyright:: (C) 2006 Mark Kretschmann, Jocke Andersson, Giuseppe Bilotta
12 # Copyright:: (C) 2007 Giuseppe Bilotta, Yaohan Chen
16 # A trivia quiz game. Fast paced, featureful and fun.
18 # FIXME:: interesting fact: in the Quiz class, @registry.has_key? seems to be
19 # case insensitive. Although this is all right for us, this leads to
20 # rank vs registry mismatches. So we have to make the @rank_table
21 # comparisons case insensitive as well. For the moment, redefine
22 # everything to downcase before matching the nick.
24 # TODO:: define a class for the rank table. We might also need it for scoring
27 # TODO:: when Ruby 2.0 gets out, fix the FIXME 2.0 UTF-8 workarounds
29 # Class for storing question/answer pairs
30 define_structure :QuizBundle, :question, :answer
32 # Class for storing player stats
33 define_structure :PlayerStats, :score, :jokers, :jokers_time
34 # Why do we still need jokers_time? //Firetech
36 # Maximum number of jokers a player can gain
44 #######################################################################
46 # Abstract an answer to a quiz question, by providing self as a string
47 # and a core that can be answered as an alternative. It also provides
48 # a boolean that tells if the core is numeric or not
49 #######################################################################
56 if @string =~ /#(.+)#/
58 @string.gsub!('#', '')
60 raise ArgumentError, "empty string can't be a valid answer!" if @string.empty?
61 raise ArgumentError, "empty core can't be a valid answer!" if @core and @core.empty?
63 @numeric = (core.to_i.to_s == core) || (core.to_f.to_s == core)
76 str.downcase == core.downcase || str.downcase == @string.downcase
88 #######################################################################
90 # One Quiz instance per channel, contains channel specific data
91 #######################################################################
93 attr_accessor :registry, :registry_conf, :questions,
94 :question, :answers, :canonical_answer, :answer_array,
95 :first_try, :hint, :hintrange, :rank_table, :hinted, :has_errors,
98 def initialize( channel, registry )
100 @registry = registry.sub_registry( 'private' )
102 @registry = registry.sub_registry( channel.downcase )
105 @registry.each_key { |k|
106 unless @registry.has_key?(k)
108 error "Data for #{k} is NOT ACCESSIBLE! Database corrupt?"
112 debug @registry.to_a.map { |a| a.join(", ")}.join("\n")
115 @registry_conf = @registry.sub_registry( "config" )
117 # Per-channel list of sources. If empty, the default one (quiz/quiz.rbot)
119 @registry_conf["sources"] = [] unless @registry_conf.has_key?( "sources" )
121 # Per-channel copy of the global questions table. Acts like a shuffled queue
122 # from which questions are taken, until empty. Then we refill it with questions
123 # from the global table.
124 @registry_conf["questions"] = [] unless @registry_conf.has_key?( "questions" )
126 # Autoask defaults to true
127 @registry_conf["autoask"] = true unless @registry_conf.has_key?( "autoask" )
129 # Autoask delay defaults to 0 (instantly)
130 @registry_conf["autoask_delay"] = 0 unless @registry_conf.has_key?( "autoask_delay" )
132 @questions = @registry_conf["questions"]
135 @canonical_answer = nil
144 # True if the answers is entirely done by separators
147 # We keep this array of player stats for performance reasons. It's sorted by score
148 # and always synced with the registry player stats hash. This way we can do fast
149 # rank lookups, without extra sorting.
150 @rank_table = @registry.to_a.sort { |a,b| b[1].score<=>a[1].score }
155 #######################################################################
157 #######################################################################
158 class QuizPlugin < Plugin
159 Config.register Config::BooleanValue.new('quiz.dotted_nicks',
161 :desc => "When true, nicks in the top X scores will be camouflaged to prevent IRC hilighting")
163 Config.register Config::ArrayValue.new('quiz.sources',
164 :default => ['quiz.rbot'],
165 :desc => "List of files and URLs that will be used to retrieve quiz questions")
170 @questions = Array.new
173 @ask_mutex = Mutex.new
176 # Function that returns whether a char is a "separator", used for hints
183 # Fetches questions from the data sources, which can be either local files
184 # (in quiz/) or web pages.
187 # Read the winning messages file
188 @win_messages = Array.new
189 if File.exists? "#{@bot.botclass}/quiz/win_messages"
190 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
192 warning( "win_messages file not found!" )
193 # Fill the array with a least one message or code accessing it would fail
194 @win_messages << "<who> guessed right! The answer was <answer>"
197 m.reply "Fetching questions ..."
199 # TODO Per-channel sources
202 @bot.config['quiz.sources'].each { |p|
203 if p =~ /^https?:\/\//
206 serverdata = @bot.httputil.get(p) # "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz"
207 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
208 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
209 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
210 data << "\n\n" << serverdata
212 m.reply "Failed to download questions from #{p}, ignoring sources"
215 path = "#{@bot.botclass}/quiz/#{p}"
216 debug "Fetching from #{path}"
220 datafile = File.new( path, File::RDONLY )
221 data << "\n\n" << datafile.read
223 m.reply "Failed to read from local database file #{p}, skipping."
230 # Fuse together and remove comments, then split
231 entries = data.strip.gsub( /^#.*$/, "" ).split( /(?:^|\n+)Question: / )
235 # We'll need at least two lines of data
237 # Check if question isn't empty
239 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
240 # Delete all lines between the question and the answer
243 p[1] = p[1].gsub( /Answer: /, "" ).strip
244 # If the answer was found
246 # Add the data to the array
247 b = QuizBundle.new( p[0], p[1] )
254 m.reply "done, #{@questions.length} questions loaded."
258 # Returns new Quiz instance for channel, or existing one
260 def create_quiz( channel )
261 unless @quizzes.has_key?( channel )
262 @quizzes[channel] = Quiz.new( channel, @registry )
265 if @quizzes[channel].has_errors
268 return @quizzes[channel]
273 def say_score( m, nick )
275 q = create_quiz( chan )
277 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
281 if q.registry.has_key?( nick )
282 score = q.registry[nick].score
283 jokers = q.registry[nick].jokers
286 q.rank_table.each_index { |rank| break if nick.downcase == q.rank_table[rank][0].downcase }
289 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
291 m.reply "#{nick} does not have a score yet. Lamer."
296 def help( plugin, topic="" )
298 "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). 'quiz cleanup' => remove players with no points and no jokers."
300 urls = @bot.config['quiz.sources'].select { |p| p =~ /^https?:\/\// }
301 "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. 'quiz refresh' => refresh the question pool for this channel." + (urls.empty? ? "" : "\nYou can add new questions at #{urls.join(', ')}")
306 # Updates the per-channel rank table, which is kept for performance reasons.
307 # This table contains all players sorted by rank.
309 def calculate_ranks( m, q, nick )
310 if q.registry.has_key?( nick )
311 stats = q.registry[nick]
313 # Find player in table
316 q.rank_table.each_index do |i|
317 if nick.downcase == q.rank_table[i][0].downcase
323 # Remove player from old position
326 q.rank_table.delete_at( i )
331 # Insert player at new position
333 q.rank_table.each_index do |i|
334 if stats.score > q.rank_table[i][1].score
335 q.rank_table[i,0] = [[nick, stats]]
341 # If less than all other players' scores, append to table
343 i += 1 unless q.rank_table.empty?
344 q.rank_table << [nick, stats]
347 # Print congratulations/condolences if the player's rank has changed
350 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
352 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
356 q.rank_table << [[nick, PlayerStats.new( 1 )]]
361 # Reimplemented from Plugin
364 return unless m.kind_of?(PrivMessage)
367 return unless @quizzes.has_key?( chan )
370 return if q.question == nil
372 message = m.message.downcase.strip
374 nick = m.sourcenick.to_s
376 # Support multiple alternate answers and cores
377 answer = q.answers.find { |ans| ans.valid?(message) }
379 # List canonical answer which the hint was based on, to avoid confusion
380 # FIXME display this more friendly
381 answer.info = " (hints were for alternate answer #{q.canonical_answer.core})" if answer != q.canonical_answer and q.hinted
386 reply = "WHOPEEE! #{nick} got it on the first try! That's worth an extra point. Answer was: #{answer}"
387 elsif q.rank_table.length >= 1 and nick.downcase == q.rank_table[0][0].downcase
388 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{nick} is invicible! Answer was: #{answer}"
389 elsif q.rank_table.length >= 2 and nick.downcase == q.rank_table[1][0].downcase
390 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: #{answer}"
391 elsif q.rank_table.length >= 3 and nick.downcase == q.rank_table[2][0].downcase
392 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: #{answer}"
394 reply = @win_messages[rand( @win_messages.length )].dup
395 reply.gsub!( "<who>", nick )
396 reply.gsub!( "<answer>", answer )
402 if q.registry.has_key?(nick)
403 player = q.registry[nick]
405 player = PlayerStats.new( 0, 0, 0 )
408 player.score = player.score + points
410 # Reward player with a joker every X points
411 if player.score % 15 == 0 and player.jokers < Max_Jokers
413 m.reply "#{nick} gains a new joker. Rejoice :)"
416 q.registry[nick] = player
417 calculate_ranks( m, q, nick)
420 if q.registry_conf["autoask"]
421 delay = q.registry_conf["autoask_delay"]
423 m.reply "#{Bold}#{Color}03Next question in #{Bold}#{delay}#{Bold} seconds"
424 timer = @bot.timer.add_once(delay) {
425 @ask_mutex.synchronize do
426 @waiting.delete(chan)
430 @waiting[chan] = timer
436 # First try is used, and it wasn't the answer.
442 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
443 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
445 def unhilight_nick( nick )
446 return nick unless @bot.config['quiz.dotted_nicks']
447 return nick.split(//).join(".")
451 #######################################################################
453 #######################################################################
454 def cmd_quiz( m, params )
455 fetch_data( m ) if @questions.empty?
458 @ask_mutex.synchronize do
459 if @waiting.has_key?(chan)
460 m.reply "Next quiz question will be automatically asked soon, have patience"
465 q = create_quiz( chan )
467 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
472 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
473 m.reply "Hint: #{q.hint}" if q.hinted
477 # Fill per-channel questions buffer
478 if q.questions.empty?
479 q.questions = @questions.sort_by { rand }
482 # pick a question and delete it (delete_at returns the deleted item)
483 picked = q.questions.delete_at( rand(q.questions.length) )
485 q.question = picked.question
486 q.answers = picked.answer.split(/\s+\|\|\s+/).map { |ans| QuizAnswer.new(ans) }
488 # Check if any core answer is numerical and tell the players so, if that's the case
489 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
491 # The "canonical answer" is also determined here, defined to be the first found numerical answer, or
493 numeric = q.answers.find { |ans| ans.numeric? }
495 q.question += "#{Color}07 (Numerical answer)#{Color}"
496 q.canonical_answer = numeric
498 q.canonical_answer = q.answers.first
506 q.canonical_answer.core.scan(/./u) { |ch|
515 # It's possible that an answer is entirely done by separators,
516 # in which case we'll hide everything
517 if q.answer_array == q.hint
525 # Generate array of unique random range
526 q.hintrange = (0..q.hint.length-1).sort_by{ rand }
528 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
532 def cmd_solve( m, params )
535 return unless @quizzes.has_key?( chan )
538 m.reply "The correct answer was: #{q.canonical_answer}"
542 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
546 def cmd_hint( m, params )
548 nick = m.sourcenick.to_s
550 return unless @quizzes.has_key?(chan)
554 m.reply "#{nick}: Get a question first!"
556 num_chars = case q.hintrange.length # Number of characters to reveal
569 index = q.hintrange.pop
570 # New hint char until the char isn't a "separator" (space etc.)
571 end while is_sep(q.answer_array[index]) and not q.all_seps
572 q.hint[index] = q.answer_array[index]
574 m.reply "Hint: #{q.hint}"
578 if q.hint == q.answer_array
579 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{nick}#{Color}."
582 if q.registry.has_key?( nick )
583 stats = q.registry[nick]
585 stats = PlayerStats.new( 0, 0, 0 )
588 stats["score"] = stats.score - 1
589 q.registry[nick] = stats
591 calculate_ranks( m, q, nick)
594 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
600 def cmd_skip( m, params )
602 return unless @quizzes.has_key?(chan)
606 cmd_quiz( m, params )
610 def cmd_joker( m, params )
612 nick = m.sourcenick.to_s
613 q = create_quiz(chan)
615 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
620 m.reply "#{nick}: There is no open question."
624 if q.registry[nick].jokers > 0
625 player = q.registry[nick]
628 q.registry[nick] = player
630 calculate_ranks( m, q, nick )
632 if player.jokers != 1
637 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{nick} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
638 m.reply "The answer was: #{q.canonical_answer}."
641 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
643 m.reply "#{nick}: You don't have any jokers left ;("
648 def cmd_fetch( m, params )
653 def cmd_refresh( m, params )
654 q = create_quiz(m.channel)
657 cmd_quiz( m, params )
661 def cmd_top5( m, params )
663 q = create_quiz( chan )
665 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
669 if q.rank_table.empty?
670 m.reply "There are no scores known yet!"
674 m.reply "* Top 5 Players for #{chan}:"
676 [5, q.rank_table.length].min.times do |i|
677 player = q.rank_table[i]
679 score = player[1].score
680 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
685 def cmd_top_number( m, params )
686 num = params[:number].to_i
687 return if num < 1 or num > 50
689 q = create_quiz( chan )
691 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
695 if q.rank_table.empty?
696 m.reply "There are no scores known yet!"
701 m.reply "* Top #{num} Players for #{chan}:"
702 n = [ num, q.rank_table.length ].min
704 player = q.rank_table[i]
706 score = player[1].score
707 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
709 m.reply ar.join(" | "), :split_at => /\s+\|\s+/
713 def cmd_stats( m, params )
714 fetch_data( m ) if @questions.empty?
716 m.reply "* Total Number of Questions:"
717 m.reply " #{@questions.length}"
721 def cmd_score( m, params )
722 nick = m.sourcenick.to_s
727 def cmd_score_player( m, params )
728 say_score( m, params[:player] )
732 def cmd_autoask( m, params )
734 q = create_quiz( chan )
736 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
740 case params[:enable].downcase
742 q.registry_conf["autoask"] = true
743 m.reply "Enabled autoask mode."
744 cmd_quiz( m, nil ) if q.question == nil
746 q.registry_conf["autoask"] = false
747 m.reply "Disabled autoask mode."
749 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
753 def cmd_autoask_delay( m, params )
755 q = create_quiz( chan )
757 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
761 delay = params[:time].to_i
762 q.registry_conf["autoask_delay"] = delay
763 m.reply "Autoask delay now #{q.registry_conf['autoask_delay']} seconds"
767 def cmd_transfer( m, params )
769 q = create_quiz( chan )
771 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
775 debug q.rank_table.inspect
777 source = params[:source]
779 transscore = params[:score].to_i
780 transjokers = params[:jokers].to_i
781 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
783 if q.registry.has_key?(source)
784 sourceplayer = q.registry[source]
785 score = sourceplayer.score
789 if score < transscore
790 m.reply "#{source} only has #{score} points!"
793 jokers = sourceplayer.jokers
797 if jokers < transjokers
798 m.reply "#{source} only has #{jokers} jokers!!"
801 if q.registry.has_key?(dest)
802 destplayer = q.registry[dest]
804 destplayer = PlayerStats.new(0,0,0)
807 if sourceplayer.object_id == destplayer.object_id
808 m.reply "Source and destination are the same, I'm not going to touch them"
812 sourceplayer.score -= transscore
813 destplayer.score += transscore
814 sourceplayer.jokers -= transjokers
815 destplayer.jokers += transjokers
817 q.registry[source] = sourceplayer
818 calculate_ranks(m, q, source)
820 q.registry[dest] = destplayer
821 calculate_ranks(m, q, dest)
823 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
825 m.reply "#{source} doesn't have any points!"
830 def cmd_del_player( m, params )
832 q = create_quiz( chan )
834 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
838 debug q.rank_table.inspect
841 if q.registry.has_key?(nick)
842 player = q.registry[nick]
845 m.reply "Can't delete player #{nick} with score #{score}."
848 jokers = player.jokers
850 m.reply "Can't delete player #{nick} with #{jokers} jokers."
853 q.registry.delete(nick)
856 q.rank_table.each_index { |rank|
857 if nick.downcase == q.rank_table[rank][0].downcase
862 q.rank_table.delete_at(player_rank)
864 m.reply "Player #{nick} deleted."
866 m.reply "Player #{nick} isn't even in the database."
871 def cmd_set_score(m, params)
873 q = create_quiz( chan )
875 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
878 debug q.rank_table.inspect
881 val = params[:score].to_i
882 if q.registry.has_key?(nick)
883 player = q.registry[nick]
886 player = PlayerStats.new( val, 0, 0)
888 q.registry[nick] = player
889 calculate_ranks(m, q, nick)
890 m.reply "Score for player #{nick} set to #{val}."
894 def cmd_set_jokers(m, params)
896 q = create_quiz( chan )
898 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
901 debug q.rank_table.inspect
904 val = [params[:jokers].to_i, Max_Jokers].min
905 if q.registry.has_key?(nick)
906 player = q.registry[nick]
909 player = PlayerStats.new( 0, val, 0)
911 q.registry[nick] = player
912 m.reply "Jokers for player #{nick} set to #{val}."
916 def cmd_cleanup(m, params)
918 q = create_quiz( chan )
920 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
925 q.registry.each { |nick, player|
926 null_players << nick if player.jokers == 0 and player.score == 0
928 debug "Cleaning up by removing #{null_players * ', '}"
929 null_players.each { |nick|
930 cmd_del_player(m, :nick => nick)
939 plugin = QuizPlugin.new
940 plugin.default_auth( 'edit', false )
943 plugin.map 'quiz', :action => 'cmd_quiz'
944 plugin.map 'quiz solve', :action => 'cmd_solve'
945 plugin.map 'quiz hint', :action => 'cmd_hint'
946 plugin.map 'quiz skip', :action => 'cmd_skip'
947 plugin.map 'quiz joker', :action => 'cmd_joker'
948 plugin.map 'quiz score', :action => 'cmd_score'
949 plugin.map 'quiz score :player', :action => 'cmd_score_player'
950 plugin.map 'quiz fetch', :action => 'cmd_fetch'
951 plugin.map 'quiz refresh', :action => 'cmd_refresh'
952 plugin.map 'quiz top5', :action => 'cmd_top5'
953 plugin.map 'quiz top :number', :action => 'cmd_top_number'
954 plugin.map 'quiz stats', :action => 'cmd_stats'
957 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
958 plugin.map 'quiz autoask delay :time', :action => 'cmd_autoask_delay', :auth_path => 'edit', :requirements => {:time => /\d+/}
959 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
960 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
961 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
962 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'
963 plugin.map 'quiz cleanup', :action => 'cmd_cleanup', :auth_path => 'edit'