4 # Plugin for the Ruby IRC bot (http://linuxbrit.co.uk/rbot/)
6 # A trivia quiz game. Fast paced, featureful and fun.
8 # Author:: Mark Kretschmann <markey@web.de>
9 # Author:: Jocke Andersson <ajocke@gmail.com>
10 # Author:: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
11 # Author:: Yaohan Chen <yaohan.chen@gmail.com>
13 # (c) 2006 Mark Kretschmann, Jocke Andersson, Giuseppe Bilotta
14 # (c) 2007 Giuseppe Bilotta, Yaohan Chen
16 # Licensed under GPL V2.
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 rank vs
20 # registry mismatches. So we have to make the @rank_table comparisons case
21 # insensitive as well. For the moment, redefine everything to downcase before
24 # TODO define a class for the rank table. We might also need it for scoring in
27 # TODO when Ruby 2.0 gets out, fix the FIXME 2.0 UTF-8 workarounds
29 # Class for storing question/answer pairs
30 QuizBundle = Struct.new( "QuizBundle", :question, :answer )
32 # Class for storing player stats
33 PlayerStats = Struct.new( "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
97 def initialize( channel, registry )
99 @registry = registry.sub_registry( 'private' )
101 @registry = registry.sub_registry( channel.downcase )
104 @registry.each_key { |k|
105 unless @registry.has_key?(k)
107 error "Data for #{k} is NOT ACCESSIBLE! Database corrupt?"
111 debug @registry.to_a.map { |a| a.join(", ")}.join("\n")
114 @registry_conf = @registry.sub_registry( "config" )
116 # Per-channel list of sources. If empty, the default one (quiz/quiz.rbot)
118 @registry_conf["sources"] = [] unless @registry_conf.has_key?( "sources" )
120 # Per-channel copy of the global questions table. Acts like a shuffled queue
121 # from which questions are taken, until empty. Then we refill it with questions
122 # from the global table.
123 @registry_conf["questions"] = [] unless @registry_conf.has_key?( "questions" )
125 # Autoask defaults to true
126 @registry_conf["autoask"] = true unless @registry_conf.has_key?( "autoask" )
128 # Autoask delay defaults to 0 (instantly)
129 @registry_conf["autoask_delay"] = 0 unless @registry_conf.has_key?( "autoask_delay" )
131 @questions = @registry_conf["questions"]
134 @canonical_answer = nil
143 # We keep this array of player stats for performance reasons. It's sorted by score
144 # and always synced with the registry player stats hash. This way we can do fast
145 # rank lookups, without extra sorting.
146 @rank_table = @registry.to_a.sort { |a,b| b[1].score<=>a[1].score }
151 #######################################################################
153 #######################################################################
154 class QuizPlugin < Plugin
155 BotConfig.register BotConfigBooleanValue.new('quiz.dotted_nicks',
157 :desc => "When true, nicks in the top X scores will be camouflaged to prevent IRC hilighting")
159 BotConfig.register BotConfigArrayValue.new('quiz.sources',
160 :default => ['quiz.rbot'],
161 :desc => "List of files and URLs that will be used to retrieve quiz questions")
166 @questions = Array.new
169 @ask_mutex = Mutex.new
172 # Function that returns whether a char is a "separator", used for hints
179 # Fetches questions from the data sources, which can be either local files
180 # (in quiz/) or web pages.
183 # Read the winning messages file
184 @win_messages = Array.new
185 if File.exists? "#{@bot.botclass}/quiz/win_messages"
186 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
188 warning( "win_messages file not found!" )
189 # Fill the array with a least one message or code accessing it would fail
190 @win_messages << "<who> guessed right! The answer was <answer>"
193 m.reply "Fetching questions ..."
195 # TODO Per-channel sources
198 @bot.config['quiz.sources'].each { |p|
199 if p =~ /^https?:\/\//
202 serverdata = @bot.httputil.get_cached( URI.parse( p ) ) # "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz"
203 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
204 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
205 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
206 data << "\n\n" << serverdata
208 m.reply "Failed to download questions from #{p}, ignoring sources"
211 path = "#{@bot.botclass}/quiz/#{p}"
212 debug "Fetching from #{path}"
216 datafile = File.new( path, File::RDONLY )
217 data << "\n\n" << datafile.read
219 m.reply "Failed to read from local database file #{p}, skipping."
226 # Fuse together and remove comments, then split
227 entries = data.strip.gsub( /^#.*$/, "" ).split( /(?:^|\n+)Question: / )
231 # We'll need at least two lines of data
233 # Check if question isn't empty
235 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
236 # Delete all lines between the question and the answer
239 p[1] = p[1].gsub( /Answer: /, "" ).strip
240 # If the answer was found
242 # Add the data to the array
243 b = QuizBundle.new( p[0], p[1] )
250 m.reply "done, #{@questions.length} questions loaded."
254 # Returns new Quiz instance for channel, or existing one
256 def create_quiz( channel )
257 unless @quizzes.has_key?( channel )
258 @quizzes[channel] = Quiz.new( channel, @registry )
261 if @quizzes[channel].has_errors
264 return @quizzes[channel]
269 def say_score( m, nick )
271 q = create_quiz( chan )
273 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
277 if q.registry.has_key?( nick )
278 score = q.registry[nick].score
279 jokers = q.registry[nick].jokers
282 q.rank_table.each_index { |rank| break if nick.downcase == q.rank_table[rank][0].downcase }
285 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
287 m.reply "#{nick} does not have a score yet. Lamer."
292 def help( plugin, topic="" )
294 "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)."
296 urls = @bot.config['quiz.sources'].select { |p| p =~ /^https?:\/\// }
297 "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(', ')}")
302 # Updates the per-channel rank table, which is kept for performance reasons.
303 # This table contains all players sorted by rank.
305 def calculate_ranks( m, q, nick )
306 if q.registry.has_key?( nick )
307 stats = q.registry[nick]
309 # Find player in table
312 q.rank_table.each_index do |i|
313 if nick.downcase == q.rank_table[i][0].downcase
319 # Remove player from old position
322 q.rank_table.delete_at( i )
327 # Insert player at new position
329 q.rank_table.each_index do |i|
330 if stats.score > q.rank_table[i][1].score
331 q.rank_table[i,0] = [[nick, stats]]
337 # If less than all other players' scores, append to table
339 i += 1 unless q.rank_table.empty?
340 q.rank_table << [nick, stats]
343 # Print congratulations/condolences if the player's rank has changed
346 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
348 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
352 q.rank_table << [[nick, PlayerStats.new( 1 )]]
357 # Reimplemented from Plugin
360 return unless m.kind_of?(PrivMessage)
363 return unless @quizzes.has_key?( chan )
366 return if q.question == nil
368 message = m.message.downcase.strip
370 nick = m.sourcenick.to_s
372 # Support multiple alternate answers and cores
373 answer = q.answers.find { |ans| ans.valid?(message) }
375 # List canonical answer which the hint was based on, to avoid confusion
376 # FIXME display this more friendly
377 answer.info = " (hints were for alternate answer #{q.canonical_answer.core})" if answer != q.canonical_answer and q.hinted
382 reply = "WHOPEEE! #{nick} got it on the first try! That's worth an extra point. Answer was: #{answer}"
383 elsif q.rank_table.length >= 1 and nick.downcase == q.rank_table[0][0].downcase
384 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{nick} is invicible! Answer was: #{answer}"
385 elsif q.rank_table.length >= 2 and nick.downcase == q.rank_table[1][0].downcase
386 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}"
387 elsif q.rank_table.length >= 3 and nick.downcase == q.rank_table[2][0].downcase
388 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}"
390 reply = @win_messages[rand( @win_messages.length )].dup
391 reply.gsub!( "<who>", nick )
392 reply.gsub!( "<answer>", answer )
398 if q.registry.has_key?(nick)
399 player = q.registry[nick]
401 player = PlayerStats.new( 0, 0, 0 )
404 player.score = player.score + points
406 # Reward player with a joker every X points
407 if player.score % 15 == 0 and player.jokers < Max_Jokers
409 m.reply "#{nick} gains a new joker. Rejoice :)"
412 q.registry[nick] = player
413 calculate_ranks( m, q, nick)
416 if q.registry_conf["autoask"]
417 delay = q.registry_conf["autoask_delay"]
419 m.reply "#{Bold}#{Color}03Next question in #{Bold}#{delay}#{Bold} seconds"
420 timer = @bot.timer.add_once(delay) {
421 @ask_mutex.synchronize do
422 @waiting.delete(chan)
426 @waiting[chan] = timer
432 # First try is used, and it wasn't the answer.
438 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
439 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
441 def unhilight_nick( nick )
442 return nick unless @bot.config['quiz.dotted_nicks']
443 return nick.split(//).join(".")
447 #######################################################################
449 #######################################################################
450 def cmd_quiz( m, params )
451 fetch_data( m ) if @questions.empty?
454 @ask_mutex.synchronize do
455 if @waiting.has_key?(chan)
456 m.reply "Next quiz question will be automatically asked soon, have patience"
461 q = create_quiz( chan )
463 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
468 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
469 m.reply "Hint: #{q.hint}" if q.hinted
473 # Fill per-channel questions buffer
474 if q.questions.empty?
475 q.questions = @questions.sort_by { rand }
478 # pick a question and delete it (delete_at returns the deleted item)
479 picked = q.questions.delete_at( rand(q.questions.length) )
481 q.question = picked.question
482 q.answers = picked.answer.split(/\s+\|\|\s+/).map { |ans| QuizAnswer.new(ans) }
484 # Check if any core answer is numerical and tell the players so, if that's the case
485 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
487 # The "canonical answer" is also determined here, defined to be the first found numerical answer, or
489 numeric = q.answers.find { |ans| ans.numeric? }
491 q.question += "#{Color}07 (Numerical answer)#{Color}"
492 q.canonical_answer = numeric
494 q.canonical_answer = q.answers.first
502 q.canonical_answer.core.scan(/./u) { |ch|
512 # Generate array of unique random range
513 q.hintrange = (0..q.hint.length-1).sort_by{ rand }
515 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
519 def cmd_solve( m, params )
522 return unless @quizzes.has_key?( chan )
525 m.reply "The correct answer was: #{q.canonical_answer}"
529 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
533 def cmd_hint( m, params )
535 nick = m.sourcenick.to_s
537 return unless @quizzes.has_key?(chan)
541 m.reply "#{nick}: Get a question first!"
543 num_chars = case q.hintrange.length # Number of characters to reveal
556 index = q.hintrange.pop
557 # New hint char until the char isn't a "separator" (space etc.)
558 end while is_sep(q.answer_array[index])
559 q.hint[index] = q.answer_array[index]
561 m.reply "Hint: #{q.hint}"
565 if q.hint == q.answer_array
566 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{nick}#{Color}."
569 if q.registry.has_key?( nick )
570 stats = q.registry[nick]
572 stats = PlayerStats.new( 0, 0, 0 )
575 stats["score"] = stats.score - 1
576 q.registry[nick] = stats
578 calculate_ranks( m, q, nick)
581 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
587 def cmd_skip( m, params )
589 return unless @quizzes.has_key?(chan)
593 cmd_quiz( m, params )
597 def cmd_joker( m, params )
599 nick = m.sourcenick.to_s
600 q = create_quiz(chan)
602 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
607 m.reply "#{nick}: There is no open question."
611 if q.registry[nick].jokers > 0
612 player = q.registry[nick]
615 q.registry[nick] = player
617 calculate_ranks( m, q, nick )
619 if player.jokers != 1
624 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{nick} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
625 m.reply "The answer was: #{q.canonical_answer}."
628 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
630 m.reply "#{nick}: You don't have any jokers left ;("
635 def cmd_fetch( m, params )
640 def cmd_refresh( m, params )
641 q = create_quiz ( m.channel )
644 cmd_quiz( m, params )
648 def cmd_top5( m, params )
650 q = create_quiz( chan )
652 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
656 if q.rank_table.empty?
657 m.reply "There are no scores known yet!"
661 m.reply "* Top 5 Players for #{chan}:"
663 [5, q.rank_table.length].min.times do |i|
664 player = q.rank_table[i]
666 score = player[1].score
667 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
672 def cmd_top_number( m, params )
673 num = params[:number].to_i
674 return if num < 1 or num > 50
676 q = create_quiz( chan )
678 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
682 if q.rank_table.empty?
683 m.reply "There are no scores known yet!"
688 m.reply "* Top #{num} Players for #{chan}:"
689 n = [ num, q.rank_table.length ].min
691 player = q.rank_table[i]
693 score = player[1].score
694 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
696 m.reply ar.join(" | ")
700 def cmd_stats( m, params )
701 fetch_data( m ) if @questions.empty?
703 m.reply "* Total Number of Questions:"
704 m.reply " #{@questions.length}"
708 def cmd_score( m, params )
709 nick = m.sourcenick.to_s
714 def cmd_score_player( m, params )
715 say_score( m, params[:player] )
719 def cmd_autoask( m, params )
721 q = create_quiz( chan )
723 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
727 case params[:enable].downcase
729 q.registry_conf["autoask"] = true
730 m.reply "Enabled autoask mode."
731 cmd_quiz( m, nil ) if q.question == nil
733 q.registry_conf["autoask"] = false
734 m.reply "Disabled autoask mode."
736 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
740 def cmd_autoask_delay( m, params )
742 q = create_quiz( chan )
744 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
748 delay = params[:time].to_i
749 q.registry_conf["autoask_delay"] = delay
750 m.reply "Autoask delay now #{q.registry_conf['autoask_delay']} seconds"
754 def cmd_transfer( m, params )
756 q = create_quiz( chan )
758 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
762 debug q.rank_table.inspect
764 source = params[:source]
766 transscore = params[:score].to_i
767 transjokers = params[:jokers].to_i
768 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
770 if q.registry.has_key?(source)
771 sourceplayer = q.registry[source]
772 score = sourceplayer.score
776 if score < transscore
777 m.reply "#{source} only has #{score} points!"
780 jokers = sourceplayer.jokers
784 if jokers < transjokers
785 m.reply "#{source} only has #{jokers} jokers!!"
788 if q.registry.has_key?(dest)
789 destplayer = q.registry[dest]
791 destplayer = PlayerStats.new(0,0,0)
794 if sourceplayer == destplayer
795 m.reply "Source and destination are the same, I'm not going to touch them"
799 sourceplayer.score -= transscore
800 destplayer.score += transscore
801 sourceplayer.jokers -= transjokers
802 destplayer.jokers += transjokers
804 q.registry[source] = sourceplayer
805 calculate_ranks(m, q, source)
807 q.registry[dest] = destplayer
808 calculate_ranks(m, q, dest)
810 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
812 m.reply "#{source} doesn't have any points!"
817 def cmd_del_player( m, params )
819 q = create_quiz( chan )
821 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
825 debug q.rank_table.inspect
828 if q.registry.has_key?(nick)
829 player = q.registry[nick]
832 m.reply "Can't delete player #{nick} with score #{score}."
835 jokers = player.jokers
837 m.reply "Can't delete player #{nick} with #{jokers} jokers."
840 q.registry.delete(nick)
843 q.rank_table.each_index { |rank|
844 if nick.downcase == q.rank_table[rank][0].downcase
849 q.rank_table.delete_at(player_rank)
851 m.reply "Player #{nick} deleted."
853 m.reply "Player #{nick} isn't even in the database."
858 def cmd_set_score(m, params)
860 q = create_quiz( chan )
862 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
865 debug q.rank_table.inspect
868 val = params[:score].to_i
869 if q.registry.has_key?(nick)
870 player = q.registry[nick]
873 player = PlayerStats.new( val, 0, 0)
875 q.registry[nick] = player
876 calculate_ranks(m, q, nick)
877 m.reply "Score for player #{nick} set to #{val}."
881 def cmd_set_jokers(m, params)
883 q = create_quiz( chan )
885 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
888 debug q.rank_table.inspect
891 val = [params[:jokers].to_i, Max_Jokers].min
892 if q.registry.has_key?(nick)
893 player = q.registry[nick]
896 player = PlayerStats.new( 0, val, 0)
898 q.registry[nick] = player
899 m.reply "Jokers for player #{nick} set to #{val}."
905 plugin = QuizPlugin.new
906 plugin.default_auth( 'edit', false )
909 plugin.map 'quiz', :action => 'cmd_quiz'
910 plugin.map 'quiz solve', :action => 'cmd_solve'
911 plugin.map 'quiz hint', :action => 'cmd_hint'
912 plugin.map 'quiz skip', :action => 'cmd_skip'
913 plugin.map 'quiz joker', :action => 'cmd_joker'
914 plugin.map 'quiz score', :action => 'cmd_score'
915 plugin.map 'quiz score :player', :action => 'cmd_score_player'
916 plugin.map 'quiz fetch', :action => 'cmd_fetch'
917 plugin.map 'quiz refresh', :action => 'cmd_refresh'
918 plugin.map 'quiz top5', :action => 'cmd_top5'
919 plugin.map 'quiz top :number', :action => 'cmd_top_number'
920 plugin.map 'quiz stats', :action => 'cmd_stats'
923 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
924 plugin.map 'quiz autoask delay :time', :action => 'cmd_autoask_delay', :auth_path => 'edit', :requirements => {:time => /\d+/}
925 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
926 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
927 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
928 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'