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.
11 # Class for storing question/answer pairs
12 QuizBundle = Struct.new( "QuizBundle", :question, :answer )
14 # Class for storing player stats
15 PlayerStats = Struct.new( "PlayerStats", :score, :jokers, :jokers_time )
16 # Why do we still need jokers_time? //Firetech
18 # Maximum number of jokers a player can gain
26 #######################################################################
28 # One Quiz instance per channel, contains channel specific data
29 #######################################################################
31 attr_accessor :registry, :registry_conf, :questions, :question, :answer, :answer_core,
32 :first_try, :hint, :hintrange, :rank_table, :hinted, :has_errors
34 def initialize( channel, registry )
36 @registry = registry.sub_registry( 'private' )
38 @registry = registry.sub_registry( channel )
41 @registry.each_key { |k|
42 unless @registry.has_key?(k)
44 error "Data for #{k} is NOT ACCESSIBLE! Database corrupt?"
48 debug @registry.to_a.map { |a| a.join(", ")}.join("\n")
51 @registry_conf = @registry.sub_registry( "config" )
53 # Per-channel copy of the global questions table. Acts like a shuffled queue
54 # from which questions are taken, until empty. Then we refill it with questions
55 # from the global table.
56 @registry_conf["questions"] = [] unless @registry_conf.has_key?( "questions" )
58 # Autoask defaults to true
59 @registry_conf["autoask"] = true unless @registry_conf.has_key?( "autoask" )
61 @questions = @registry_conf["questions"]
70 # We keep this array of player stats for performance reasons. It's sorted by score
71 # and always synced with the registry player stats hash. This way we can do fast
72 # rank lookups, without extra sorting.
73 @rank_table = @registry.to_a.sort { |a,b| b[1].score<=>a[1].score }
78 #######################################################################
80 #######################################################################
81 class QuizPlugin < Plugin
85 @questions = Array.new
89 # Function that returns whether a char is a "separator", used for hints
105 # Fetches questions from a file on the server and from the wiki, then merges
106 # and transforms the questions and fills the global question table.
109 # Read the winning messages file
110 @win_messages = Array.new
111 if File.exists? "#{@bot.botclass}/quiz/win_messages"
112 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
114 warning( "win_messages file not found!" )
115 # Fill the array with a least one message or code accessing it would fail
116 @win_messages << "<who> guessed right! The answer was <answer>"
119 # TODO: Make this configurable, and add support for more than one file (there's a size limit in linux too ;) )
120 path = "#{@bot.botclass}/quiz/quiz.rbot"
121 debug "Fetching from #{path}"
123 m.reply "Fetching questions from local database and wiki.."
127 datafile = File.new( path, File::RDONLY )
128 localdata = datafile.read
130 m.reply "Failed to read local database file. oioi."
136 serverdata = @bot.httputil.get_cached( URI.parse( "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz" ) )
137 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
138 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
139 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
141 m.reply "Failed to download wiki questions. oioi."
143 m.reply "No questions loaded, aborting."
150 # Fuse together and remove comments, then split
151 data = "\n\n#{localdata}\n\n#{serverdata}".gsub( /^#.*$/, "" )
152 entries = data.split( "\nQuestion: " )
153 #First entry will be empty.
158 # We'll need at least two lines of data
160 # Check if question isn't empty
162 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
163 # Delete all lines between the question and the answer
166 p[1] = p[1].gsub( /Answer: /, "" ).strip
167 # If the answer was found
169 # Add the data to the array
170 b = QuizBundle.new( p[0], p[1] )
177 m.reply "done, #{@questions.length} questions loaded."
181 # Returns new Quiz instance for channel, or existing one
183 def create_quiz( channel )
184 unless @quizzes.has_key?( channel )
185 @quizzes[channel] = Quiz.new( channel, @registry )
188 if @quizzes[channel].has_errors
191 return @quizzes[channel]
196 def say_score( m, nick )
197 chan = m.channel.downcase
198 q = create_quiz( chan )
200 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
204 if q.registry.has_key?( nick )
205 score = q.registry[nick].score
206 jokers = q.registry[nick].jokers
209 q.rank_table.each_index { |rank| break if nick == q.rank_table[rank][0] }
212 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
214 m.reply "#{nick} does not have a score yet. Lamer."
219 def help( plugin, topic="" )
221 "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)."
223 "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"
228 # Updates the per-channel rank table, which is kept for performance reasons.
229 # This table contains all players sorted by rank.
231 def calculate_ranks( m, q, nick )
232 if q.registry.has_key?( nick )
233 stats = q.registry[nick]
235 # Find player in table
238 q.rank_table.each_index do |i|
239 if nick == q.rank_table[i][0]
245 # Remove player from old position
248 q.rank_table.delete_at( i )
253 # Insert player at new position
255 q.rank_table.each_index do |i|
256 if stats.score > q.rank_table[i][1].score
257 q.rank_table[i,0] = [[nick, stats]]
263 # If less than all other players' scores, append to table
265 i += 1 unless q.rank_table.empty?
266 q.rank_table << [nick, stats]
269 # Print congratulations/condolences if the player's rank has changed
272 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
274 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
278 q.rank_table << [[nick, PlayerStats.new( 1 )]]
283 # Reimplemented from Plugin
286 return unless m.kind_of?(PrivMessage)
288 chan = m.channel.downcase
289 return unless @quizzes.has_key?( chan )
292 return if q.question == nil
294 message = m.message.downcase.strip
296 nick = m.sourcenick.to_s
298 if message == q.answer.downcase or message == q.answer_core.downcase
302 reply = "WHOPEEE! #{nick} got it on the first try! That's worth an extra point. Answer was: #{q.answer}"
303 elsif q.rank_table.length >= 1 and nick == q.rank_table[0][0]
304 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{nick} is invicible! Answer was: #{q.answer}"
305 elsif q.rank_table.length >= 2 and nick == q.rank_table[1][0]
306 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}"
307 elsif q.rank_table.length >= 3 and nick == q.rank_table[2][0]
308 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}"
310 reply = @win_messages[rand( @win_messages.length )].dup
311 reply.gsub!( "<who>", nick )
312 reply.gsub!( "<answer>", q.answer )
318 if q.registry.has_key?(nick)
319 player = q.registry[nick]
321 player = PlayerStats.new( 0, 0, 0 )
324 player.score = player.score + points
326 # Reward player with a joker every X points
327 if player.score % 15 == 0 and player.jokers < Max_Jokers
329 m.reply "#{m.sourcenick.to_s} gains a new joker. Rejoice :)"
332 q.registry[nick] = player
333 calculate_ranks( m, q, nick)
336 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
338 # First try is used, and it wasn't the answer.
344 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
345 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
347 def unhilight_nick( nick )
350 0.upto( nick.length - 1 ) do |i|
351 new_nick += nick[i, 1]
352 new_nick += "." unless i == nick.length - 1
359 #######################################################################
361 #######################################################################
362 def cmd_quiz( m, params )
363 fetch_data( m ) if @questions.empty?
364 q = create_quiz( m.channel.to_s )
366 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
371 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
372 m.reply "Hint: #{q.hint}" if q.hinted
376 # Fill per-channel questions buffer
377 if q.questions.empty?
378 temp = @questions.dup
381 i = rand( temp.length )
382 q.questions << temp[i]
387 i = rand( q.questions.length )
388 q.question = q.questions[i].question
389 q.answer = q.questions[i].answer.gsub( "#", "" )
392 q.answer_core = /(#)(.*)(#)/.match( q.questions[i].answer )[2]
396 q.answer_core = q.answer.dup if q.answer_core == nil
398 # Check if core answer is numerical and tell the players so, if that's the case
399 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
400 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
402 q.questions.delete_at( i )
407 (0..q.answer_core.length-1).each do |index|
408 if is_sep(q.answer_core[index,1])
409 q.hint << q.answer_core[index]
416 # Generate array of unique random range
417 q.hintrange = (0..q.answer_core.length-1).sort_by{rand}
419 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
423 def cmd_solve( m, params )
424 chan = m.channel.to_s
426 return unless @quizzes.has_key?( chan )
429 m.reply "The correct answer was: #{q.answer}"
433 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
437 def cmd_hint( m, params )
438 chan = m.channel.downcase
439 nick = m.sourcenick.to_s
441 return unless @quizzes.has_key?(chan)
445 m.reply "#{nick}: Get a question first!"
447 num_chars = case q.hintrange.length # Number of characters to reveal
459 index = q.hintrange.pop
460 # New hint char until the char isn't a "separator" (space etc.)
461 end while is_sep(q.answer_core[index,1])
462 q.hint[index] = q.answer_core[index]
464 m.reply "Hint: #{q.hint}"
467 if q.hint == q.answer_core
468 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{nick}#{Color}."
471 if q.registry.has_key?( nick )
472 stats = q.registry[nick]
474 stats = PlayerStats.new( 0, 0, 0 )
477 stats["score"] = stats.score - 1
478 q.registry[nick] = stats
480 calculate_ranks( m, q, nick)
483 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
489 def cmd_skip( m, params )
490 chan = m.channel.downcase
491 return unless @quizzes.has_key?(chan)
495 cmd_quiz( m, params )
499 def cmd_joker( m, params )
500 chan = m.channel.downcase
501 nick = m.sourcenick.to_s
502 q = create_quiz(chan)
504 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
509 m.reply "#{nick}: There is no open question."
513 if q.registry[nick].jokers > 0
514 player = q.registry[nick]
517 q.registry[nick] = player
519 calculate_ranks( m, q, nick )
521 if player.jokers != 1
526 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{nick} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
527 m.reply "The answer was: #{q.answer}."
530 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
532 m.reply "#{nick}: You don't have any jokers left ;("
537 def cmd_fetch( m, params )
542 def cmd_top5( m, params )
543 chan = m.channel.downcase
544 q = create_quiz( chan )
546 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
550 if q.rank_table.empty?
551 m.reply "There are no scores known yet!"
555 m.reply "* Top 5 Players for #{chan}:"
557 [5, q.rank_table.length].min.times do |i|
558 player = q.rank_table[i]
560 score = player[1].score
561 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
566 def cmd_top_number( m, params )
567 num = params[:number].to_i
568 return unless 1..50 === num
569 chan = m.channel.downcase
570 q = create_quiz( chan )
572 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
576 if q.rank_table.empty?
577 m.reply "There are no scores known yet!"
582 m.reply "* Top #{num} Players for #{chan}:"
583 n = [ num, q.rank_table.length ].min
585 player = q.rank_table[i]
587 score = player[1].score
588 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
590 m.reply ar.join(" | ")
594 def cmd_stats( m, params )
595 fetch_data( m ) if @questions.empty?
597 m.reply "* Total Number of Questions:"
598 m.reply " #{@questions.length}"
602 def cmd_score( m, params )
603 nick = m.sourcenick.to_s
608 def cmd_score_player( m, params )
609 say_score( m, params[:player] )
613 def cmd_autoask( m, params )
614 chan = m.channel.downcase
615 q = create_quiz( chan )
617 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
621 if params[:enable].downcase == "on"
622 q.registry_conf["autoask"] = true
623 m.reply "Enabled autoask mode."
624 cmd_quiz( m, nil ) if q.question == nil
625 elsif params[:enable].downcase == "off"
626 q.registry_conf["autoask"] = false
627 m.reply "Disabled autoask mode."
629 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
634 def cmd_transfer( m, params )
635 chan = m.channel.downcase
636 q = create_quiz( chan )
638 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
642 debug q.rank_table.inspect
644 source = params[:source]
646 transscore = params[:score].to_i
647 transjokers = params[:jokers].to_i
648 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
650 if q.registry.has_key?(source)
651 sourceplayer = q.registry[source]
652 score = sourceplayer.score
656 if score < transscore
657 m.reply "#{source} only has #{score} points!"
660 jokers = sourceplayer.jokers
664 if jokers < transjokers
665 m.reply "#{source} only has #{jokers} jokers!!"
668 if q.registry.has_key?(dest)
669 destplayer = q.registry[dest]
671 destplayer = PlayerStats.new(0,0,0)
674 sourceplayer.score -= transscore
675 destplayer.score += transscore
676 sourceplayer.jokers -= transjokers
677 destplayer.jokers += transjokers
679 q.registry[source] = sourceplayer
680 calculate_ranks(m, q, source)
682 q.registry[dest] = destplayer
683 calculate_ranks(m, q, dest)
685 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
687 m.reply "#{source} doesn't have any points!"
692 def cmd_del_player( m, params )
693 chan = m.channel.downcase
694 q = create_quiz( chan )
696 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
700 debug q.rank_table.inspect
703 if q.registry.has_key?(nick)
704 player = q.registry[nick]
707 m.reply "Can't delete player #{nick} with score #{score}."
710 jokers = player.jokers
712 m.reply "Can't delete player #{nick} with #{jokers} jokers."
715 q.registry.delete(nick)
718 q.rank_table.each_index { |rank|
719 if nick == q.rank_table[rank][0]
724 q.rank_table.delete_at(player_rank)
726 m.reply "Player #{nick} deleted."
728 m.reply "Player #{nick} isn't even in the database."
733 def cmd_set_score(m, params)
734 chan = m.channel.downcase
735 q = create_quiz( chan )
737 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
740 debug q.rank_table.inspect
743 val = params[:score].to_i
744 if q.registry.has_key?(nick)
745 player = q.registry[nick]
748 player = PlayerStats.new( val, 0, 0)
750 q.registry[nick] = player
751 calculate_ranks(m, q, nick)
752 m.reply "Score for player #{nick} set to #{val}."
756 def cmd_set_jokers(m, params)
757 chan = m.channel.downcase
758 q = create_quiz( chan )
760 m.reply "Sorry, the quiz database for #{chan} seems to be corrupt"
763 debug q.rank_table.inspect
766 val = [params[:jokers].to_i, Max_Jokers].min
767 if q.registry.has_key?(nick)
768 player = q.registry[nick]
771 player = PlayerStats.new( 0, val, 0)
773 q.registry[nick] = player
774 m.reply "Jokers for player #{nick} set to #{val}."
780 plugin = QuizPlugin.new
781 plugin.default_auth( 'edit', false )
784 plugin.map 'quiz', :action => 'cmd_quiz'
785 plugin.map 'quiz solve', :action => 'cmd_solve'
786 plugin.map 'quiz hint', :action => 'cmd_hint'
787 plugin.map 'quiz skip', :action => 'cmd_skip'
788 plugin.map 'quiz joker', :action => 'cmd_joker'
789 plugin.map 'quiz score', :action => 'cmd_score'
790 plugin.map 'quiz score :player', :action => 'cmd_score_player'
791 plugin.map 'quiz fetch', :action => 'cmd_fetch'
792 plugin.map 'quiz top5', :action => 'cmd_top5'
793 plugin.map 'quiz top :number', :action => 'cmd_top_number'
794 plugin.map 'quiz stats', :action => 'cmd_stats'
797 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
798 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
799 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
800 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
801 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'