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
93 BotConfig.register BotConfigBooleanValue.new('quiz.dotted_nicks',
95 :desc => "When true, nicks in the top X scores will be camouflaged to prevent IRC hilighting")
99 @questions = Array.new
102 @ask_mutex = Mutex.new
105 # Function that returns whether a char is a "separator", used for hints
121 # Fetches questions from a file on the server and from the wiki, then merges
122 # and transforms the questions and fills the global question table.
125 # Read the winning messages file
126 @win_messages = Array.new
127 if File.exists? "#{@bot.botclass}/quiz/win_messages"
128 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
130 warning( "win_messages file not found!" )
131 # Fill the array with a least one message or code accessing it would fail
132 @win_messages << "<who> guessed right! The answer was <answer>"
135 # TODO: Make this configurable, and add support for more than one file (there's a size limit in linux too ;) )
136 path = "#{@bot.botclass}/quiz/quiz.rbot"
137 debug "Fetching from #{path}"
139 m.reply "Fetching questions from local database and wiki.."
143 datafile = File.new( path, File::RDONLY )
144 localdata = datafile.read
146 m.reply "Failed to read local database file. oioi."
152 serverdata = @bot.httputil.get_cached( URI.parse( "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz" ) )
153 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
154 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
155 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
157 m.reply "Failed to download wiki questions. oioi."
159 m.reply "No questions loaded, aborting."
166 # Fuse together and remove comments, then split
167 data = "\n\n#{localdata}\n\n#{serverdata}".gsub( /^#.*$/, "" )
168 entries = data.split( "\nQuestion: " )
169 #First entry will be empty.
174 # We'll need at least two lines of data
176 # Check if question isn't empty
178 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
179 # Delete all lines between the question and the answer
182 p[1] = p[1].gsub( /Answer: /, "" ).strip
183 # If the answer was found
185 # Add the data to the array
186 b = QuizBundle.new( p[0], p[1] )
193 m.reply "done, #{@questions.length} questions loaded."
197 # Returns new Quiz instance for channel, or existing one
199 def create_quiz( channel )
200 unless @quizzes.has_key?( channel )
201 @quizzes[channel] = Quiz.new( channel, @registry )
204 if @quizzes[channel].has_errors
207 return @quizzes[channel]
212 def say_score( m, nick )
214 q = create_quiz( chan )
216 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
220 if q.registry.has_key?( nick )
221 score = q.registry[nick].score
222 jokers = q.registry[nick].jokers
225 q.rank_table.each_index { |rank| break if nick.downcase == q.rank_table[rank][0].downcase }
228 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
230 m.reply "#{nick} does not have a score yet. Lamer."
235 def help( plugin, topic="" )
237 "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)."
239 "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"
244 # Updates the per-channel rank table, which is kept for performance reasons.
245 # This table contains all players sorted by rank.
247 def calculate_ranks( m, q, nick )
248 if q.registry.has_key?( nick )
249 stats = q.registry[nick]
251 # Find player in table
254 q.rank_table.each_index do |i|
255 if nick.downcase == q.rank_table[i][0].downcase
261 # Remove player from old position
264 q.rank_table.delete_at( i )
269 # Insert player at new position
271 q.rank_table.each_index do |i|
272 if stats.score > q.rank_table[i][1].score
273 q.rank_table[i,0] = [[nick, stats]]
279 # If less than all other players' scores, append to table
281 i += 1 unless q.rank_table.empty?
282 q.rank_table << [nick, stats]
285 # Print congratulations/condolences if the player's rank has changed
288 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
290 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
294 q.rank_table << [[nick, PlayerStats.new( 1 )]]
299 # Reimplemented from Plugin
302 return unless m.kind_of?(PrivMessage)
305 return unless @quizzes.has_key?( chan )
308 return if q.question == nil
310 message = m.message.downcase.strip
312 nick = m.sourcenick.to_s
314 if message == q.answer.downcase or message == q.answer_core.downcase
318 reply = "WHOPEEE! #{nick} got it on the first try! That's worth an extra point. Answer was: #{q.answer}"
319 elsif q.rank_table.length >= 1 and nick.downcase == q.rank_table[0][0].downcase
320 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{nick} is invicible! Answer was: #{q.answer}"
321 elsif q.rank_table.length >= 2 and nick.downcase == q.rank_table[1][0].downcase
322 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}"
323 elsif q.rank_table.length >= 3 and nick.downcase == q.rank_table[2][0].downcase
324 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}"
326 reply = @win_messages[rand( @win_messages.length )].dup
327 reply.gsub!( "<who>", nick )
328 reply.gsub!( "<answer>", q.answer )
334 if q.registry.has_key?(nick)
335 player = q.registry[nick]
337 player = PlayerStats.new( 0, 0, 0 )
340 player.score = player.score + points
342 # Reward player with a joker every X points
343 if player.score % 15 == 0 and player.jokers < Max_Jokers
345 m.reply "#{nick} gains a new joker. Rejoice :)"
348 q.registry[nick] = player
349 calculate_ranks( m, q, nick)
352 if q.registry_conf["autoask"]
353 delay = q.registry_conf["autoask_delay"]
355 m.reply "#{Bold}#{Color}03Next question in #{Bold}#{delay}#{Bold} seconds"
356 timer = @bot.timer.add_once(delay) {
357 @ask_mutex.synchronize do
358 @waiting.delete(chan)
362 @waiting[chan] = timer
368 # First try is used, and it wasn't the answer.
374 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
375 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
377 def unhilight_nick( nick )
378 return nick unless @bot.config['quiz.dotted_nicks']
379 return nick.split(//).join(".")
383 #######################################################################
385 #######################################################################
386 def cmd_quiz( m, params )
387 fetch_data( m ) if @questions.empty?
390 @ask_mutex.synchronize do
391 if @waiting.has_key?(chan)
392 m.reply "Next quiz question will be automatically asked soon, have patience"
397 q = create_quiz( chan )
399 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
404 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
405 m.reply "Hint: #{q.hint}" if q.hinted
409 # Fill per-channel questions buffer
410 if q.questions.empty?
411 temp = @questions.dup
414 i = rand( temp.length )
415 q.questions << temp[i]
420 i = rand( q.questions.length )
421 q.question = q.questions[i].question
422 q.answer = q.questions[i].answer.gsub( "#", "" )
425 q.answer_core = /(#)(.*)(#)/.match( q.questions[i].answer )[2]
429 q.answer_core = q.answer.dup if q.answer_core == nil
431 # Check if core answer is numerical and tell the players so, if that's the case
432 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
433 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
435 q.questions.delete_at( i )
440 (0..q.answer_core.length-1).each do |index|
441 if is_sep(q.answer_core[index,1])
442 q.hint << q.answer_core[index]
449 # Generate array of unique random range
450 q.hintrange = (0..q.answer_core.length-1).sort_by{rand}
452 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
456 def cmd_solve( m, params )
459 return unless @quizzes.has_key?( chan )
462 m.reply "The correct answer was: #{q.answer}"
466 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
470 def cmd_hint( m, params )
472 nick = m.sourcenick.to_s
474 return unless @quizzes.has_key?(chan)
478 m.reply "#{nick}: Get a question first!"
480 num_chars = case q.hintrange.length # Number of characters to reveal
492 index = q.hintrange.pop
493 # New hint char until the char isn't a "separator" (space etc.)
494 end while is_sep(q.answer_core[index,1])
495 q.hint[index] = q.answer_core[index]
497 m.reply "Hint: #{q.hint}"
500 if q.hint == q.answer_core
501 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{nick}#{Color}."
504 if q.registry.has_key?( nick )
505 stats = q.registry[nick]
507 stats = PlayerStats.new( 0, 0, 0 )
510 stats["score"] = stats.score - 1
511 q.registry[nick] = stats
513 calculate_ranks( m, q, nick)
516 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
522 def cmd_skip( m, params )
524 return unless @quizzes.has_key?(chan)
528 cmd_quiz( m, params )
532 def cmd_joker( m, params )
534 nick = m.sourcenick.to_s
535 q = create_quiz(chan)
537 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
542 m.reply "#{nick}: There is no open question."
546 if q.registry[nick].jokers > 0
547 player = q.registry[nick]
550 q.registry[nick] = player
552 calculate_ranks( m, q, nick )
554 if player.jokers != 1
559 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{nick} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
560 m.reply "The answer was: #{q.answer}."
563 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
565 m.reply "#{nick}: You don't have any jokers left ;("
570 def cmd_fetch( m, params )
575 def cmd_top5( m, params )
577 q = create_quiz( chan )
579 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
583 if q.rank_table.empty?
584 m.reply "There are no scores known yet!"
588 m.reply "* Top 5 Players for #{chan}:"
590 [5, q.rank_table.length].min.times do |i|
591 player = q.rank_table[i]
593 score = player[1].score
594 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
599 def cmd_top_number( m, params )
600 num = params[:number].to_i
601 return if num < 1 or num > 50
603 q = create_quiz( chan )
605 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
609 if q.rank_table.empty?
610 m.reply "There are no scores known yet!"
615 m.reply "* Top #{num} Players for #{chan}:"
616 n = [ num, q.rank_table.length ].min
618 player = q.rank_table[i]
620 score = player[1].score
621 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
623 m.reply ar.join(" | ")
627 def cmd_stats( m, params )
628 fetch_data( m ) if @questions.empty?
630 m.reply "* Total Number of Questions:"
631 m.reply " #{@questions.length}"
635 def cmd_score( m, params )
636 nick = m.sourcenick.to_s
641 def cmd_score_player( m, params )
642 say_score( m, params[:player] )
646 def cmd_autoask( m, params )
648 q = create_quiz( chan )
650 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
654 case params[:enable].downcase
656 q.registry_conf["autoask"] = true
657 m.reply "Enabled autoask mode."
658 cmd_quiz( m, nil ) if q.question == nil
660 q.registry_conf["autoask"] = false
661 m.reply "Disabled autoask mode."
663 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
667 def cmd_autoask_delay( m, params )
669 q = create_quiz( chan )
671 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
675 delay = params[:time].to_i
676 q.registry_conf["autoask_delay"] = delay
677 m.reply "Autoask delay now #{q.registry_conf['autoask_delay']} seconds"
681 def cmd_transfer( m, params )
683 q = create_quiz( chan )
685 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
689 debug q.rank_table.inspect
691 source = params[:source]
693 transscore = params[:score].to_i
694 transjokers = params[:jokers].to_i
695 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
697 if q.registry.has_key?(source)
698 sourceplayer = q.registry[source]
699 score = sourceplayer.score
703 if score < transscore
704 m.reply "#{source} only has #{score} points!"
707 jokers = sourceplayer.jokers
711 if jokers < transjokers
712 m.reply "#{source} only has #{jokers} jokers!!"
715 if q.registry.has_key?(dest)
716 destplayer = q.registry[dest]
718 destplayer = PlayerStats.new(0,0,0)
721 if sourceplayer == destplayer
722 m.reply "Source and destination are the same, I'm not going to touch them"
726 sourceplayer.score -= transscore
727 destplayer.score += transscore
728 sourceplayer.jokers -= transjokers
729 destplayer.jokers += transjokers
731 q.registry[source] = sourceplayer
732 calculate_ranks(m, q, source)
734 q.registry[dest] = destplayer
735 calculate_ranks(m, q, dest)
737 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
739 m.reply "#{source} doesn't have any points!"
744 def cmd_del_player( m, params )
746 q = create_quiz( chan )
748 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
752 debug q.rank_table.inspect
755 if q.registry.has_key?(nick)
756 player = q.registry[nick]
759 m.reply "Can't delete player #{nick} with score #{score}."
762 jokers = player.jokers
764 m.reply "Can't delete player #{nick} with #{jokers} jokers."
767 q.registry.delete(nick)
770 q.rank_table.each_index { |rank|
771 if nick.downcase == q.rank_table[rank][0].downcase
776 q.rank_table.delete_at(player_rank)
778 m.reply "Player #{nick} deleted."
780 m.reply "Player #{nick} isn't even in the database."
785 def cmd_set_score(m, params)
787 q = create_quiz( chan )
789 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
792 debug q.rank_table.inspect
795 val = params[:score].to_i
796 if q.registry.has_key?(nick)
797 player = q.registry[nick]
800 player = PlayerStats.new( val, 0, 0)
802 q.registry[nick] = player
803 calculate_ranks(m, q, nick)
804 m.reply "Score for player #{nick} set to #{val}."
808 def cmd_set_jokers(m, params)
810 q = create_quiz( chan )
812 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
815 debug q.rank_table.inspect
818 val = [params[:jokers].to_i, Max_Jokers].min
819 if q.registry.has_key?(nick)
820 player = q.registry[nick]
823 player = PlayerStats.new( 0, val, 0)
825 q.registry[nick] = player
826 m.reply "Jokers for player #{nick} set to #{val}."
832 plugin = QuizPlugin.new
833 plugin.default_auth( 'edit', false )
836 plugin.map 'quiz', :action => 'cmd_quiz'
837 plugin.map 'quiz solve', :action => 'cmd_solve'
838 plugin.map 'quiz hint', :action => 'cmd_hint'
839 plugin.map 'quiz skip', :action => 'cmd_skip'
840 plugin.map 'quiz joker', :action => 'cmd_joker'
841 plugin.map 'quiz score', :action => 'cmd_score'
842 plugin.map 'quiz score :player', :action => 'cmd_score_player'
843 plugin.map 'quiz fetch', :action => 'cmd_fetch'
844 plugin.map 'quiz top5', :action => 'cmd_top5'
845 plugin.map 'quiz top :number', :action => 'cmd_top_number'
846 plugin.map 'quiz stats', :action => 'cmd_stats'
849 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
850 plugin.map 'quiz autoask delay :time', :action => 'cmd_autoask_delay', :auth_path => 'edit', :requirements => {:time => /\d+/}
851 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
852 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
853 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
854 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'