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,
40 :question, :answer, :answer_core, :answer_array,
41 :first_try, :hint, :hintrange, :rank_table, :hinted, :has_errors
43 def initialize( channel, registry )
45 @registry = registry.sub_registry( 'private' )
47 @registry = registry.sub_registry( channel.downcase )
50 @registry.each_key { |k|
51 unless @registry.has_key?(k)
53 error "Data for #{k} is NOT ACCESSIBLE! Database corrupt?"
57 debug @registry.to_a.map { |a| a.join(", ")}.join("\n")
60 @registry_conf = @registry.sub_registry( "config" )
62 # Per-channel list of sources. If empty, the default one (quiz/quiz.rbot)
64 @registry_conf["sources"] = [] unless @registry_conf.has_key?( "sources" )
66 # Per-channel copy of the global questions table. Acts like a shuffled queue
67 # from which questions are taken, until empty. Then we refill it with questions
68 # from the global table.
69 @registry_conf["questions"] = [] unless @registry_conf.has_key?( "questions" )
71 # Autoask defaults to true
72 @registry_conf["autoask"] = true unless @registry_conf.has_key?( "autoask" )
74 # Autoask delay defaults to 0 (instantly)
75 @registry_conf["autoask_delay"] = 0 unless @registry_conf.has_key?( "autoask_delay" )
77 @questions = @registry_conf["questions"]
81 @answer_array = [] # Array of UTF-8 characters
87 # We keep this array of player stats for performance reasons. It's sorted by score
88 # and always synced with the registry player stats hash. This way we can do fast
89 # rank lookups, without extra sorting.
90 @rank_table = @registry.to_a.sort { |a,b| b[1].score<=>a[1].score }
95 #######################################################################
97 #######################################################################
98 class QuizPlugin < Plugin
99 BotConfig.register BotConfigBooleanValue.new('quiz.dotted_nicks',
101 :desc => "When true, nicks in the top X scores will be camouflaged to prevent IRC hilighting")
103 BotConfig.register BotConfigArrayValue.new('quiz.sources',
104 :default => ['quiz.rbot'],
105 :desc => "List of files and URLs that will be used to retrieve quiz questions")
110 @questions = Array.new
113 @ask_mutex = Mutex.new
116 # Function that returns whether a char is a "separator", used for hints
123 # Fetches questions from the data sources, which can be either local files
124 # (in quiz/) or web pages.
127 # Read the winning messages file
128 @win_messages = Array.new
129 if File.exists? "#{@bot.botclass}/quiz/win_messages"
130 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
132 warning( "win_messages file not found!" )
133 # Fill the array with a least one message or code accessing it would fail
134 @win_messages << "<who> guessed right! The answer was <answer>"
137 m.reply "Fetching questions ..."
139 # TODO Per-channel sources
142 @bot.config['quiz.sources'].each { |p|
143 if p =~ /^https?:\/\//
146 serverdata = @bot.httputil.get_cached( URI.parse( p ) ) # "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz"
147 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
148 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
149 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
150 data << "\n\n" << serverdata
152 m.reply "Failed to download questions from #{p}, ignoring sources"
155 path = "#{@bot.botclass}/quiz/#{p}"
156 debug "Fetching from #{path}"
160 datafile = File.new( path, File::RDONLY )
161 data << "\n\n" << datafile.read
163 m.reply "Failed to read from local database file #{p}, skipping."
170 # Fuse together and remove comments, then split
171 entries = data.gsub( /^#.*$/, "" ).split( "\nQuestion: " )
172 # First entry will be empty.
177 # We'll need at least two lines of data
179 # Check if question isn't empty
181 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
182 # Delete all lines between the question and the answer
185 p[1] = p[1].gsub( /Answer: /, "" ).strip
186 # If the answer was found
188 # Add the data to the array
189 b = QuizBundle.new( p[0], p[1] )
196 m.reply "done, #{@questions.length} questions loaded."
200 # Returns new Quiz instance for channel, or existing one
202 def create_quiz( channel )
203 unless @quizzes.has_key?( channel )
204 @quizzes[channel] = Quiz.new( channel, @registry )
207 if @quizzes[channel].has_errors
210 return @quizzes[channel]
215 def say_score( m, nick )
217 q = create_quiz( chan )
219 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
223 if q.registry.has_key?( nick )
224 score = q.registry[nick].score
225 jokers = q.registry[nick].jokers
228 q.rank_table.each_index { |rank| break if nick.downcase == q.rank_table[rank][0].downcase }
231 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
233 m.reply "#{nick} does not have a score yet. Lamer."
238 def help( plugin, topic="" )
240 "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)."
242 urls = @bot.config['quiz.sources'].select { |p| p =~ /^https?:\/\// }
243 "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." + (urls.empty? ? "" : "\nYou can add new questions at #{urls.join(', ')}")
248 # Updates the per-channel rank table, which is kept for performance reasons.
249 # This table contains all players sorted by rank.
251 def calculate_ranks( m, q, nick )
252 if q.registry.has_key?( nick )
253 stats = q.registry[nick]
255 # Find player in table
258 q.rank_table.each_index do |i|
259 if nick.downcase == q.rank_table[i][0].downcase
265 # Remove player from old position
268 q.rank_table.delete_at( i )
273 # Insert player at new position
275 q.rank_table.each_index do |i|
276 if stats.score > q.rank_table[i][1].score
277 q.rank_table[i,0] = [[nick, stats]]
283 # If less than all other players' scores, append to table
285 i += 1 unless q.rank_table.empty?
286 q.rank_table << [nick, stats]
289 # Print congratulations/condolences if the player's rank has changed
292 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
294 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
298 q.rank_table << [[nick, PlayerStats.new( 1 )]]
303 # Reimplemented from Plugin
306 return unless m.kind_of?(PrivMessage)
309 return unless @quizzes.has_key?( chan )
312 return if q.question == nil
314 message = m.message.downcase.strip
316 nick = m.sourcenick.to_s
318 if message == q.answer.downcase or message == q.answer_core.downcase
322 reply = "WHOPEEE! #{nick} got it on the first try! That's worth an extra point. Answer was: #{q.answer}"
323 elsif q.rank_table.length >= 1 and nick.downcase == q.rank_table[0][0].downcase
324 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{nick} is invicible! Answer was: #{q.answer}"
325 elsif q.rank_table.length >= 2 and nick.downcase == q.rank_table[1][0].downcase
326 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}"
327 elsif q.rank_table.length >= 3 and nick.downcase == q.rank_table[2][0].downcase
328 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}"
330 reply = @win_messages[rand( @win_messages.length )].dup
331 reply.gsub!( "<who>", nick )
332 reply.gsub!( "<answer>", q.answer )
338 if q.registry.has_key?(nick)
339 player = q.registry[nick]
341 player = PlayerStats.new( 0, 0, 0 )
344 player.score = player.score + points
346 # Reward player with a joker every X points
347 if player.score % 15 == 0 and player.jokers < Max_Jokers
349 m.reply "#{nick} gains a new joker. Rejoice :)"
352 q.registry[nick] = player
353 calculate_ranks( m, q, nick)
356 if q.registry_conf["autoask"]
357 delay = q.registry_conf["autoask_delay"]
359 m.reply "#{Bold}#{Color}03Next question in #{Bold}#{delay}#{Bold} seconds"
360 timer = @bot.timer.add_once(delay) {
361 @ask_mutex.synchronize do
362 @waiting.delete(chan)
366 @waiting[chan] = timer
372 # First try is used, and it wasn't the answer.
378 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
379 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
381 def unhilight_nick( nick )
382 return nick unless @bot.config['quiz.dotted_nicks']
383 return nick.split(//).join(".")
387 #######################################################################
389 #######################################################################
390 def cmd_quiz( m, params )
391 fetch_data( m ) if @questions.empty?
394 @ask_mutex.synchronize do
395 if @waiting.has_key?(chan)
396 m.reply "Next quiz question will be automatically asked soon, have patience"
401 q = create_quiz( chan )
403 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
408 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
409 m.reply "Hint: #{q.hint}" if q.hinted
413 # Fill per-channel questions buffer
414 if q.questions.empty?
415 temp = @questions.dup
418 i = rand( temp.length )
419 q.questions << temp[i]
424 i = rand( q.questions.length )
425 q.question = q.questions[i].question
426 q.answer = q.questions[i].answer.gsub( "#", "" )
429 q.answer_core = /(#)(.*)(#)/.match( q.questions[i].answer )[2]
433 q.answer_core = q.answer.dup if q.answer_core == nil
435 # Check if core answer is numerical and tell the players so, if that's the case
436 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
437 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
439 q.questions.delete_at( i )
445 q.answer_core.scan(/./u) { |ch|
455 # Generate array of unique random range
456 q.hintrange = (0..q.hint.length-1).sort_by{rand}
458 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
462 def cmd_solve( m, params )
465 return unless @quizzes.has_key?( chan )
468 m.reply "The correct answer was: #{q.answer}"
472 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
476 def cmd_hint( m, params )
478 nick = m.sourcenick.to_s
480 return unless @quizzes.has_key?(chan)
484 m.reply "#{nick}: Get a question first!"
486 num_chars = case q.hintrange.length # Number of characters to reveal
498 index = q.hintrange.pop
499 # New hint char until the char isn't a "separator" (space etc.)
500 end while is_sep(q.answer_array[index])
501 q.hint[index] = q.answer_array[index]
503 m.reply "Hint: #{q.hint}"
506 if q.hint == q.answer_core
507 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{nick}#{Color}."
510 if q.registry.has_key?( nick )
511 stats = q.registry[nick]
513 stats = PlayerStats.new( 0, 0, 0 )
516 stats["score"] = stats.score - 1
517 q.registry[nick] = stats
519 calculate_ranks( m, q, nick)
522 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
528 def cmd_skip( m, params )
530 return unless @quizzes.has_key?(chan)
534 cmd_quiz( m, params )
538 def cmd_joker( m, params )
540 nick = m.sourcenick.to_s
541 q = create_quiz(chan)
543 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
548 m.reply "#{nick}: There is no open question."
552 if q.registry[nick].jokers > 0
553 player = q.registry[nick]
556 q.registry[nick] = player
558 calculate_ranks( m, q, nick )
560 if player.jokers != 1
565 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{nick} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
566 m.reply "The answer was: #{q.answer}."
569 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
571 m.reply "#{nick}: You don't have any jokers left ;("
576 def cmd_fetch( m, params )
581 def cmd_top5( m, params )
583 q = create_quiz( chan )
585 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
589 if q.rank_table.empty?
590 m.reply "There are no scores known yet!"
594 m.reply "* Top 5 Players for #{chan}:"
596 [5, q.rank_table.length].min.times do |i|
597 player = q.rank_table[i]
599 score = player[1].score
600 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
605 def cmd_top_number( m, params )
606 num = params[:number].to_i
607 return if num < 1 or num > 50
609 q = create_quiz( chan )
611 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
615 if q.rank_table.empty?
616 m.reply "There are no scores known yet!"
621 m.reply "* Top #{num} Players for #{chan}:"
622 n = [ num, q.rank_table.length ].min
624 player = q.rank_table[i]
626 score = player[1].score
627 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
629 m.reply ar.join(" | ")
633 def cmd_stats( m, params )
634 fetch_data( m ) if @questions.empty?
636 m.reply "* Total Number of Questions:"
637 m.reply " #{@questions.length}"
641 def cmd_score( m, params )
642 nick = m.sourcenick.to_s
647 def cmd_score_player( m, params )
648 say_score( m, params[:player] )
652 def cmd_autoask( m, params )
654 q = create_quiz( chan )
656 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
660 case params[:enable].downcase
662 q.registry_conf["autoask"] = true
663 m.reply "Enabled autoask mode."
664 cmd_quiz( m, nil ) if q.question == nil
666 q.registry_conf["autoask"] = false
667 m.reply "Disabled autoask mode."
669 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
673 def cmd_autoask_delay( m, params )
675 q = create_quiz( chan )
677 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
681 delay = params[:time].to_i
682 q.registry_conf["autoask_delay"] = delay
683 m.reply "Autoask delay now #{q.registry_conf['autoask_delay']} seconds"
687 def cmd_transfer( m, params )
689 q = create_quiz( chan )
691 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
695 debug q.rank_table.inspect
697 source = params[:source]
699 transscore = params[:score].to_i
700 transjokers = params[:jokers].to_i
701 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
703 if q.registry.has_key?(source)
704 sourceplayer = q.registry[source]
705 score = sourceplayer.score
709 if score < transscore
710 m.reply "#{source} only has #{score} points!"
713 jokers = sourceplayer.jokers
717 if jokers < transjokers
718 m.reply "#{source} only has #{jokers} jokers!!"
721 if q.registry.has_key?(dest)
722 destplayer = q.registry[dest]
724 destplayer = PlayerStats.new(0,0,0)
727 if sourceplayer == destplayer
728 m.reply "Source and destination are the same, I'm not going to touch them"
732 sourceplayer.score -= transscore
733 destplayer.score += transscore
734 sourceplayer.jokers -= transjokers
735 destplayer.jokers += transjokers
737 q.registry[source] = sourceplayer
738 calculate_ranks(m, q, source)
740 q.registry[dest] = destplayer
741 calculate_ranks(m, q, dest)
743 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
745 m.reply "#{source} doesn't have any points!"
750 def cmd_del_player( m, params )
752 q = create_quiz( chan )
754 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
758 debug q.rank_table.inspect
761 if q.registry.has_key?(nick)
762 player = q.registry[nick]
765 m.reply "Can't delete player #{nick} with score #{score}."
768 jokers = player.jokers
770 m.reply "Can't delete player #{nick} with #{jokers} jokers."
773 q.registry.delete(nick)
776 q.rank_table.each_index { |rank|
777 if nick.downcase == q.rank_table[rank][0].downcase
782 q.rank_table.delete_at(player_rank)
784 m.reply "Player #{nick} deleted."
786 m.reply "Player #{nick} isn't even in the database."
791 def cmd_set_score(m, params)
793 q = create_quiz( chan )
795 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
798 debug q.rank_table.inspect
801 val = params[:score].to_i
802 if q.registry.has_key?(nick)
803 player = q.registry[nick]
806 player = PlayerStats.new( val, 0, 0)
808 q.registry[nick] = player
809 calculate_ranks(m, q, nick)
810 m.reply "Score for player #{nick} set to #{val}."
814 def cmd_set_jokers(m, params)
816 q = create_quiz( chan )
818 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
821 debug q.rank_table.inspect
824 val = [params[:jokers].to_i, Max_Jokers].min
825 if q.registry.has_key?(nick)
826 player = q.registry[nick]
829 player = PlayerStats.new( 0, val, 0)
831 q.registry[nick] = player
832 m.reply "Jokers for player #{nick} set to #{val}."
838 plugin = QuizPlugin.new
839 plugin.default_auth( 'edit', false )
842 plugin.map 'quiz', :action => 'cmd_quiz'
843 plugin.map 'quiz solve', :action => 'cmd_solve'
844 plugin.map 'quiz hint', :action => 'cmd_hint'
845 plugin.map 'quiz skip', :action => 'cmd_skip'
846 plugin.map 'quiz joker', :action => 'cmd_joker'
847 plugin.map 'quiz score', :action => 'cmd_score'
848 plugin.map 'quiz score :player', :action => 'cmd_score_player'
849 plugin.map 'quiz fetch', :action => 'cmd_fetch'
850 plugin.map 'quiz top5', :action => 'cmd_top5'
851 plugin.map 'quiz top :number', :action => 'cmd_top_number'
852 plugin.map 'quiz stats', :action => 'cmd_stats'
855 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
856 plugin.map 'quiz autoask delay :time', :action => 'cmd_autoask_delay', :auth_path => 'edit', :requirements => {:time => /\d+/}
857 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
858 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
859 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
860 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'