diff src/plugins/plugin_misc_quiz.py @ 362:208107419b17

Quiz game: buzzer, timer, answer management
author Goffi <goffi@goffi.org>
date Sun, 12 Jun 2011 22:34:15 +0200
parents 141eeb7cd9e6
children f964dcec1611
line wrap: on
line diff
--- a/src/plugins/plugin_misc_quiz.py	Sun Jun 12 16:28:33 2011 +0200
+++ b/src/plugins/plugin_misc_quiz.py	Sun Jun 12 22:34:15 2011 +0200
@@ -67,21 +67,56 @@
         host.bridge.addMethod("quizGameLaunch", ".communication", in_sign='ass', out_sign='', method=self.quizGameLaunch) #args: room_jid, players, profile
         host.bridge.addMethod("quizGameCreate", ".communication", in_sign='sass', out_sign='', method=self.quizGameCreate) #args: room_jid, players, profile
         host.bridge.addMethod("quizGameReady", ".communication", in_sign='sss', out_sign='', method=self.newPlayerReady) #args: player, referee, profile
+        host.bridge.addMethod("quizGameAnswer", ".communication", in_sign='ssss', out_sign='', method=self.playerAnswer)
         host.bridge.addSignal("quizGameStarted", ".communication", signature='ssass') #args: room_jid, referee, players, profile
         host.bridge.addSignal("quizGameNew", ".communication",
                               signature='sa{ss}s',
                               doc = { 'summary': 'Start a new game',
-                                      'param_0': "jid of game's room",
-                                      'param_1': "data of the game",
+                                      'param_0': "room_jid: jid of game's room",
+                                      'param_1': "game_data: data of the game",
                                       'param_2': '%(doc_profile)s'})
         host.bridge.addSignal("quizGameQuestion", ".communication",
                               signature = 'sssis',
                               doc = { 'summary': "Send the current question",
-                                      'param_0': "jid of game's room",
-                                      'param_1': "question id",
-                                      'param_2': "question to ask",
-                                      'param_3': "timer",
+                                      'param_0': "room_jid: jid of game's room",
+                                      'param_1': "question_id: question id",
+                                      'param_2': "question: question to ask",
+                                      'param_3': "timer: timer",
+                                      'param_4': '%(doc_profile)s'})
+        host.bridge.addSignal("quizGamePlayerBuzzed", ".communication",
+                              signature = 'ssbs',
+                              doc = { 'summary': "A player just pressed the buzzer",
+                                      'param_0': "room_jid: jid of game's room",
+                                      'param_1': "player: player who pushed the buzzer",
+                                      'param_2': "pause: should the game be paused ?",
+                                      'param_3': '%(doc_profile)s'})
+        host.bridge.addSignal("quizGamePlayerSays", ".communication",
+                              signature = 'sssis',
+                              doc = { 'summary': "A player just pressed the buzzer",
+                                      'param_0': "room_jid: jid of game's room",
+                                      'param_1': "player: player who pushed the buzzer",
+                                      'param_2': "text: what the player say",
+                                      'param_3': "delay: how long, in seconds, the text must appear",
                                       'param_4': '%(doc_profile)s'})
+        host.bridge.addSignal("quizGameAnswerResult", ".communication",
+                              signature = 'ssba{si}s',
+                              doc = { 'summary': "Result of the just given answer",
+                                      'param_0': "room_jid: jid of game's room",
+                                      'param_1': "player: player who gave the answer",
+                                      'param_2': "good_answer: True if the answer is right",
+                                      'param_3': "score: dict of score with player as key",
+                                      'param_4': '%(doc_profile)s'})
+        host.bridge.addSignal("quizGameTimerExpired", ".communication",
+                              signature = 'ss',
+                              doc = { 'summary': "Nobody answered the question in time",
+                                      'param_0': "room_jid: jid of game's room",
+                                      'param_1': '%(doc_profile)s'})
+        host.bridge.addSignal("quizGameTimerRestarted", ".communication",
+                              signature = 'sis',
+                              doc = { 'summary': "Nobody answered the question in time",
+                                      'param_0': "room_jid: jid of game's room",
+                                      'param_1': "time_left: time left before timer expiration",
+                                      'param_2': '%(doc_profile)s'})
         host.trigger.add("MUC user joined", self.userJoinedTrigger)
 
     def createGameElt(self, to_jid, type="normal"):
@@ -108,6 +143,37 @@
             game_data[data_elt.name] = unicode(data_elt)
         return game_data
 
+    def __answer_result_to_signal_args(self, answer_result_elt):
+        """Parse answer result element and return a tuple of signal arguments
+        @param answer_result_elt: answer result element
+        @return: (player, good_answer, score)"""
+        score = {}
+        for score_elt in answer_result_elt.children:
+            score[score_elt['player']] = int(score_elt['score'])
+        return (answer_result_elt['player'], answer_result_elt['good_answer'] == str(True), score)
+
+    def __answer_result(self, player_answering, good_answer, game_data):
+        """Convert a domish an answer_result element
+        @param player_answering: player who gave the answer
+        @param good_answer: True is the answer is right
+        @param game_data: data of the game"""
+        players_data = game_data['players_data']
+        score = {}
+        for player in game_data['players']:
+            score[player] = players_data[player]['score']
+        
+        answer_result_elt = domish.Element(('','answer_result'))
+        answer_result_elt['player'] = player_answering
+        answer_result_elt['good_answer'] = str(good_answer)
+        
+        for player in score:
+            score_elt = domish.Element(('',"score"))
+            score_elt['player'] = player
+            score_elt['score'] = str(score[player])
+            answer_result_elt.addChild(score_elt) 
+        
+        return answer_result_elt
+
     def __create_started_elt(self, players):
         """Create a game_started domish element"""
         started_elt = domish.Element(('','started'))
@@ -120,7 +186,7 @@
             started_elt.addChild(player_elt)
         return started_elt
 
-    def __ask_question(self, question_id, question, timer=30):
+    def __ask_question(self, question_id, question, timer):
         """Create a element for asking a question"""
         question_elt = domish.Element(('','question'))
         question_elt['id'] = question_id
@@ -133,7 +199,7 @@
         game_data['stage'] = "play"
         next_player_idx = game_data['current_player'] = (game_data['init_player'] + 1) % len(game_data['players']) #the player after the dealer start
         game_data['first_player'] = next_player = game_data['players'][next_player_idx]
-        to_jid = jid.JID(room_jid.userhost()+"/"+next_player) #FIXME: gof:
+        to_jid = jid.JID(room_jid.userhost()+"/"+next_player)
         mess = self.createGameElt(to_jid)
         yourturn_elt = mess.firstChildElement().addElement('your_turn')
         self.host.profiles[profile].xmlstream.send(mess)
@@ -233,10 +299,78 @@
         ready_elt['player'] = player
         self.host.profiles[profile].xmlstream.send(mess)
 
-    def askQuestion(self, room_jid, profile):
+    def playerAnswer(self, player, referee, answer, profile_key='@DEFAULT@'):
+        """Called when a player give an answer"""
+        profile = self.host.memory.getProfileName(profile_key)
+        if not profile:
+            error (_("profile %s is unknown") % profile_key)
+            return
+        debug ('new player answer (%(profile)s): %(answer)s' % {'profile':profile, 'answer':answer})
+        mess = self.createGameElt(jid.JID(referee))
+        answer_elt = mess.firstChildElement().addElement('player_answer')
+        answer_elt['player'] = player
+        answer_elt.addContent(answer)
+        self.host.profiles[profile].xmlstream.send(mess)
+
+    def timerExpired(self, room_jid, profile):
+        """Called when nobody answered the question in time"""
+        game_data = self.games[room_jid.userhost()]
+        game_data['stage'] = 'expired'
+        mess = self.createGameElt(room_jid)
+        expired_elt = mess.firstChildElement().addElement('timer_expired')
+        self.host.profiles[profile].xmlstream.send(mess)
+        reactor.callLater(4, self.askQuestion, room_jid, profile)
+
+    def pauseTimer(self, room_jid):
+        """Stop the timer and save the time left"""
+        game_data = self.games[room_jid.userhost()]
+        left = max(0, game_data["timer"].getTime() - time())
+        game_data['timer'].cancel()
+        game_data['time_left'] = int(left)
+        game_data['previous_stage'] = game_data['stage']
+        game_data['stage'] = "paused"
+
+    def restartTimer(self, room_jid, profile):
+        """Restart a timer with the saved time"""
+        game_data = self.games[room_jid.userhost()]
+        assert(game_data['time_left'] != None)
         mess = self.createGameElt(room_jid)
-        mess.firstChildElement().addChild(self.__ask_question("1", u"Quel est l'âge du capitaine ?"))
+        restarted_elt = mess.firstChildElement().addElement('timer_restarted')
+        restarted_elt["time_left"] = str(game_data['time_left'])
+        self.host.profiles[profile].xmlstream.send(mess)
+        game_data["timer"] = reactor.callLater(game_data['time_left'], self.timerExpired, room_jid, profile)
+        game_data["time_left"] = None
+        game_data['stage'] = game_data['previous_stage']
+        del game_data['previous_stage']
+
+    def askQuestion(self, room_jid, profile):
+        """Ask a new question"""
+        game_data = self.games[room_jid.userhost()]
+        game_data['stage'] = "question"
+        game_data['question_id'] = "1"
+        timer = 30
+        mess = self.createGameElt(room_jid)
+        mess.firstChildElement().addChild(self.__ask_question(game_data['question_id'], u"Quel est l'âge du capitaine ?", timer))
         self.host.profiles[profile].xmlstream.send(mess)
+        game_data["timer"] = reactor.callLater(timer, self.timerExpired, room_jid, profile)
+        game_data["time_left"] = None
+
+    def checkAnswer(self, room_jid, player, answer, profile): 
+        """Check if the answer given is right"""
+        game_data = self.games[room_jid.userhost()]
+        players_data = game_data['players_data']
+        good_answer =  game_data['question_id'] == "1" and answer=="42"
+        players_data[player]['score'] += 1 if good_answer else -1
+        players_data[player]['score'] = min(9, max(0, players_data[player]['score']))
+        
+        mess = self.createGameElt(room_jid)
+        mess.firstChildElement().addChild(self.__answer_result(player, good_answer, game_data))
+        self.host.profiles[profile].xmlstream.send(mess)
+        
+        if good_answer:
+            reactor.callLater(4, self.askQuestion, room_jid, profile)
+        else:
+            reactor.callLater(4, self.restartTimer, room_jid, profile)
 
     def newGame(self, room_jid, profile):
         """Launch a new round"""
@@ -287,7 +421,44 @@
             
             elif elt.name == 'question': #A question is asked
                 self.host.bridge.quizGameQuestion(room_jid.userhost(), elt["id"], unicode(elt), int(elt["timer"]), profile )
+            
+            elif elt.name == 'player_answer':
+                player = elt['player']
+                pause = game_data['stage'] == 'question' #we pause the game only if we are have a question at the moment
+                #we first send a buzzer message
+                mess = self.createGameElt(room_jid)
+                buzzer_elt = mess.firstChildElement().addElement('player_buzzed')
+                buzzer_elt['player'] = player
+                buzzer_elt['pause'] = str(pause) 
+                self.host.profiles[profile].xmlstream.send(mess)
+                if pause:
+                    self.pauseTimer(room_jid)
+                    #and we send the player answer
+                    mess = self.createGameElt(room_jid)
+                    _answer = unicode(elt)
+                    say_elt = mess.firstChildElement().addElement('player_says')
+                    say_elt['player'] = player
+                    say_elt.addContent(_answer)
+                    say_elt['delay'] = "3"
+                    reactor.callLater(2, self.host.profiles[profile].xmlstream.send, mess)
+                    reactor.callLater(6, self.checkAnswer, room_jid, player, _answer, profile=profile)
                 
+            elif elt.name == 'player_buzzed':
+                self.host.bridge.quizGamePlayerBuzzed(room_jid.userhost(), elt["player"], elt['pause'] == str(True), profile)
+            
+            elif elt.name == 'player_says':
+                self.host.bridge.quizGamePlayerSays(room_jid.userhost(), elt["player"], unicode(elt), int(elt["delay"]), profile)
+           
+            elif elt.name == 'answer_result':
+                player, good_answer, score = self.__answer_result_to_signal_args(elt)
+                self.host.bridge.quizGameAnswerResult(room_jid.userhost(), player, good_answer, score, profile)
+            
+            elif elt.name == 'timer_expired':
+                self.host.bridge.quizGameTimerExpired(room_jid.userhost(), profile)
+
+            elif elt.name == 'timer_restarted':
+                self.host.bridge.quizGameTimerRestarted(room_jid.userhost(), int(elt['time_left']), profile)
+
             else:
                 error (_('Unmanaged game element: %s') % elt.name)