libervia-backend: src/plugins/plugin_misc_room

annotate src/plugins/plugin_misc_room_game.py @ 801:02ee9ef95277

plugin XEP-0045, primitivus: added MUC configuration

author	Goffi <goffi@goffi.org>
date	Tue, 04 Feb 2014 18:06:12 +0100
parents	23b0c949b86c
children	1fe00f0c9a91

rev	line source
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	1 #!/usr/bin/python
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	2 # -- coding: utf-8 --
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	3
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	4 # SAT: a jabber client
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013 Jérôme Poisson (goffi@goffi.org)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	6
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	10 # (at your option) any later version.
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	11
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	16
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	19
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 746 diff changeset	20 from sat.core.i18n import _
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	21 from logging import debug, warning, error
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	22 from twisted.words.protocols.jabber.jid import JID
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	23 from twisted.words.xish import domish
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	24 from time import time
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	25 from wokkel import disco, iwokkel
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	26 from zope.interface import implements
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	27 import copy
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	28 try:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	29 from twisted.words.protocols.xmlstream import XMPPHandler
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	30 except ImportError:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	31 from wokkel.subprotocols import XMPPHandler
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	32
718 074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	33 # Don't forget to set it to False before you commit
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	34 _DEBUG = False
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	35
718 074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	36 PLUGIN_INFO = {
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	37 "name": "Room game",
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	38 "import_name": "ROOM-GAME",
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	39 "type": "MISC",
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	40 "protocols": [],
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	41 "dependencies": ["XEP-0045", "XEP-0249"],
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	42 "main": "RoomGame",
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	43 "handler": "no", # handler MUST be "no" (dynamic inheritance)
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	44 "description": _("""Base class for MUC games""")
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	45 }
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	46
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	47
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	48 class RoomGame(object):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	49 """This class is used to help launching a MUC game.
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	50
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	51 Bridge methods callbacks: prepareRoom, playerReady, createGame
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	52 Triggered methods: userJoinedTrigger, userLeftTrigger
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	53 Also called from subclasses: newRound
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	54
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	55 For examples of messages sequences, please look in sub-classes.
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	56 """
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	57
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	58 # Values for self.invite_mode (who can invite after the game creation)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	59 FROM_ALL, FROM_NONE, FROM_REFEREE, FROM_PLAYERS = xrange(0, 4)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	60 # Values for self.wait_mode (for who we should wait before creating the game)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	61 FOR_ALL, FOR_NONE = xrange(0, 2)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	62 # Values for self.join_mode (who can join the game - NONE means solo game)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	63 ALL, INVITED, NONE = xrange(0, 3)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	64 # Values for ready_mode (how to turn a MUC user into a player)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	65 ASK, FORCE = xrange(0, 2)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	66
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	67 MESSAGE = '/message'
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	68 REQUEST = '%s/%s[@xmlns="%s"]'
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	69
718 074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	70 def __init__(self, host):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	71 """For other plugin to dynamically inherit this class, it is necessary to not use __init__ but _init_.
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	72 The subclass itself must be initialized this way:
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	73
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	74 class MyGame(object):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	75
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	76 def inheritFromRoomGame(self, host):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	77 global RoomGame
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	78 RoomGame = host.plugins["ROOM-GAME"].__class__
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	79 self.__class__ = type(self.__class__.__name__, (self.__class__, RoomGame, object), {})
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	80
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	81 def __init__(self, host):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	82 self.inheritFromRoomGame(host)
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	83 RoomGame._init_(self, host, ...)
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	84
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	85 """
718 074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	86 self.host = host
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	87
074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	88 def _init_(self, host, plugin_info, ns_tag, game_init={}, player_init={}):
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	89 """
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	90 @param host
711 c9792d0be499 plugins (tools): collective games (with no opponent, like radiocol) were handled like other games souliane <souliane@mailoo.org> parents: 683 diff changeset	91 @param plugin_info: PLUGIN_INFO map of the game plugin
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	92 @param ns_tag: couple (nameservice, tag) to construct the messages
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	93 @param game_init: dictionary for general game initialization
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	94 @param player_init: dictionary for player initialization, applicable to each player
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	95 """
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	96 self.host = host
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	97 self.name = plugin_info["import_name"]
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	98 self.ns_tag = ns_tag
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	99 self.request = self.REQUEST % (self.MESSAGE, ns_tag[1], ns_tag[0])
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	100 self.game_init = game_init
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	101 self.player_init = player_init
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	102 self.games = {}
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	103 self.invitations = {} # list of couple (x, y) with x the time and y a list of users
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	104
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	105 # These are the default settings, which can be overwritten by child class after initialization
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	106 self.invite_mode = self.FROM_PLAYERS if self.player_init == {} else self.FROM_NONE
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	107 self.wait_mode = self.FOR_NONE if self.player_init == {} else self.FOR_ALL
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	108 self.join_mode = self.INVITED
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	109 self.ready_mode = self.FORCE # TODO: asking for confirmation is not implemented
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	110
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	111 host.trigger.add("MUC user joined", self.userJoinedTrigger)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	112 host.trigger.add("MUC user left", self.userLeftTrigger)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	113
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	114 def _createOrInvite(self, room, other_players, profile):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	115 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	116 This is called only when someone explicitly wants to play.
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	117 The game must not be created if one already exists in the room,
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	118 and its creation could be postponed until all the expected players
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	119 join the room (in that case it will be created from userJoinedTrigger).
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	120 @param room: instance of wokkel.muc.Room
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	121 @param other_players: list for other players JID userhosts
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	122 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	123 user_jid = self.host.getJidNStream(profile)[0]
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	124 room_jid_s = room.occupantJID.userhost()
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	125 nick = self.host.plugins["XEP-0045"].getRoomNick(room_jid_s, profile)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	126 nicks = [nick]
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	127 if self._gameExists(room_jid_s):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	128 if not self._checkJoinAuth(room_jid_s, user_jid.userhost(), nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	129 return
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	130 nicks.extend(self._invitePlayers(room, other_players, nick, profile))
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	131 self._updatePlayers(room_jid_s, nicks, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	132 else:
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	133 self._initGame(room_jid_s, nick)
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	134 (auth, waiting, missing) = self._checkWaitAuth(room, other_players)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	135 nicks.extend(waiting)
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	136 nicks.extend(self._invitePlayers(room, missing, nick, profile))
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	137 if auth:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	138 self.createGame(room_jid_s, nicks, profile)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	139 else:
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	140 self._updatePlayers(room_jid_s, nicks, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	141
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	142 def _initGame(self, room_jid_s, referee_nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	143 """Important: do not add the referee to 'players' yet. For a
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	144 <players /> message to be emitted whenever a new player is joining,
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	145 it is necessary to not modify 'players' outside of _updatePlayers.
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	146 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	147 referee = room_jid_s + '/' + referee_nick
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	148 self.games[room_jid_s] = {'referee': referee, 'players': [], 'started': False}
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	149 self.games[room_jid_s].update(copy.deepcopy(self.game_init))
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	150 self.invitations.setdefault(room_jid_s, [])
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	151
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	152 def _gameExists(self, room_jid_s, started=False):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	153 """Return True if a game has been initialized/started.
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	154 @param started: if False, the game must be initialized to return True,
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	155 otherwise it must be initialized and started with createGame.
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	156 @return: True if a game is initialized/started in that room"""
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	157 return room_jid_s in self.games and (not started or self.games[room_jid_s]['started'])
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	158
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	159 def _checkJoinAuth(self, room_jid_s, user_jid_s=None, nick="", verbose=False):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	160 """Checks if this profile is allowed to join the game.
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	161 The parameter nick is used to check if the user is already
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	162 a player in that game. When this method is called from
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	163 userJoinedTrigger, nick is also used to check the user
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	164 identity instead of user_jid_s (see TODO comment below).
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	165 @param room_jid_s: the room hosting the game
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	166 @param user_jid_s: JID userhost of the user
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	167 @param nick: nick of the user
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	168 @return: True if this profile can join the game
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	169 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	170 auth = False
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	171 if not self._gameExists(room_jid_s):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	172 auth = False
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	173 elif self.join_mode == self.ALL or self.isPlayer(room_jid_s, nick):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	174 auth = True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	175 elif self.join_mode == self.INVITED:
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	176 user_jid_s = JID(user_jid_s).userhost()
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	177 # considering all the batches of invitations
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	178 for invitations in self.invitations[room_jid_s]:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	179 if user_jid_s is not None:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	180 if user_jid_s in invitations[1]:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	181 auth = True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	182 break
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	183 else:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	184 # TODO: that's not secure enough but what to do if
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	185 # wokkel.muc.User's 'entity' attribute is not set?!
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	186 if nick in [JID(invited).user for invited in invitations[1]]:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	187 auth = True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	188 break
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	189
718 074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	190 if not auth and (verbose or _DEBUG):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	191 debug(_("%s not allowed to join the game %s in %s") % (user_jid_s or nick, self.name, room_jid_s))
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	192 return auth
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	193
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	194 def _updatePlayers(self, room_jid_s, nicks, profile):
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	195 """Update the list of players and signal to the room that some players joined the game.
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	196 Remark: self.games[room_jid_s]['players'] should not be modified outside this method.
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	197 @param room_jid_s: room userhost
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	198 @param nicks: list of players nicks in the room (referee included, in first position)
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	199 """
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	200 if nicks == []:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	201 return
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	202 # this is better than set(nicks).difference(...) as it keeps the order
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	203 new_nicks = [nick for nick in nicks if nick not in self.games[room_jid_s]['players']]
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	204 if len(new_nicks) == 0:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	205 return
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	206 self.games[room_jid_s]['players'].extend(new_nicks)
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	207 self._signalPlayers(room_jid_s, [JID(room_jid_s)], profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	208
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	209 def _signalPlayers(self, room_jid_s, recipients, profile):
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	210 """Let these guys know that we are playing (they may not play themselves).
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	211 @param room_jid_s: room userhost
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	212 @recipients: list of JIDs, the recipients of the message could be:
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	213 - room JID
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	214 - room JID + "/" + user nick
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	215 """
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	216 if self._gameExists(room_jid_s, started=True):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	217 element = self._createStartElement(self.games[room_jid_s]['players'])
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	218 else:
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	219 element = self._createStartElement(self.games[room_jid_s]['players'], name="players")
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	220 elements = [(element, None, None)]
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	221 for child in self.getSyncData(room_jid_s):
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	222 # TODO: sync data may be different and private to each player,
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	223 # in that case send a separate message to the new players
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	224 elements.append((child, None, None))
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	225 for recipient in recipients:
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	226 self._sendElements(recipient, elements, profile=profile)
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	227
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	228 def getSyncData(self, room_jid_s):
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	229 """This method may be overwritten by any child class.
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	230 @return: a list of child elements to be added for the game to be synchronized.
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	231 """
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	232 return []
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	233
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	234 def _invitePlayers(self, room, other_players, nick, profile):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	235 """Invite players to a room, associated game may exist or not.
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	236 @param room: wokkel.muc.Room instance
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	237 @param other_players: list of JID userhosts to invite
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	238 @param nick: nick of the user who send the invitation
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	239 @return: list of room nicks for invited players who are already in the room
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	240 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	241 room_jid = room.occupantJID.userhostJID()
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	242 room_jid_s = room.occupantJID.userhost()
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	243 if not self._checkInviteAuth(room_jid_s, nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	244 return []
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	245 # TODO: remove invitation waiting for too long, using the time data
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	246 players_jids = [JID(player) for player in other_players]
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	247 self.invitations[room_jid_s].append((time(), [player.userhost() for player in players_jids]))
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	248 nicks = []
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	249 for player_jid in [player.userhostJID() for player in players_jids]:
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	250 # TODO: find a way to make it secure
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	251 other_nick = self.host.plugins["XEP-0045"].getRoomNickOfUser(room, player_jid, secure=False)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	252 if other_nick is None:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	253 self.host.plugins["XEP-0249"].invite(player_jid, room_jid, {"game": self.name}, profile)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	254 else:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	255 nicks.append(other_nick)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	256 return nicks
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	257
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	258 def _checkInviteAuth(self, room_jid_s, nick, verbose=False):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	259 """Checks if this user is allowed to invite players
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	260 @param room_jid_s: room userhost
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	261 @param nick: user nick in the room
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	262 @param verbose: display debug message
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	263 @return: True if the user is allowed to invite other players
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	264 """
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	265 auth = False
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	266 if self.invite_mode == self.FROM_ALL or not self._gameExists(room_jid_s):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	267 auth = True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	268 elif self.invite_mode == self.FROM_NONE:
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	269 auth = not self._gameExists(room_jid_s, started=True) and self.isReferee(room_jid_s, nick)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	270 elif self.invite_mode == self.FROM_REFEREE:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	271 auth = self.isReferee(room_jid_s, nick)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	272 elif self.invite_mode == self.FROM_PLAYERS:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	273 auth = self.isPlayer(room_jid_s, nick)
718 074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	274 if not auth and (verbose or _DEBUG):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	275 debug(_("%s not allowed to invite for the game %s in %s") % (nick, self.name, room_jid_s))
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	276 return auth
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	277
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	278 def isReferee(self, room_jid_s, nick):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	279 """Checks if the player with this nick is the referee for the game in this room"
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	280 @param room_jid_s: room userhost
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	281 @param nick: user nick in the room
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	282 @return: True if the user is the referee of the game in this room
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	283 """
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	284 if not self._gameExists(room_jid_s):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	285 return False
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	286 return room_jid_s + '/' + nick == self.games[room_jid_s]['referee']
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	287
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	288 def isPlayer(self, room_jid_s, nick):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	289 """Checks if the user with this nick is a player for the game in this room.
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	290 @param room_jid_s: room userhost
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	291 @param nick: user nick in the room
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	292 @return: True if the user is a player of the game in this room
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	293 """
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	294 if not self._gameExists(room_jid_s):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	295 return False
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	296 # Important: the referee is not in the 'players' list right after
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	297 # the game initialization, that's why we do also check with isReferee
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	298 return nick in self.games[room_jid_s]['players'] or self.isReferee(room_jid_s, nick)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	299
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	300 def _checkWaitAuth(self, room, other_players, verbose=False):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	301 """Check if we must wait for other players before starting the game.
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	302 @param room: wokkel.muc.Room instance
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	303 @param other_players: list of players JID userhosts without the referee
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	304 @param verbose: display debug message
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	305 @return: (x, y, z) with:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	306 x: False if we must wait, True otherwise
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	307 y: the nicks of the players that have been checked and confirmed
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	308 z: the players that have not been checked or that are missing
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	309 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	310 if self.wait_mode == self.FOR_NONE or other_players == []:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	311 result = (True, [], other_players)
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	312 elif len(room.roster) < len(other_players):
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	313 # do not check the players until we may actually have them all
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	314 result = (False, [], other_players)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	315 else:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	316 # TODO: find a way to make it secure
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	317 (nicks, missing) = self.host.plugins["XEP-0045"].getRoomNicksOfUsers(room, other_players, secure=False)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	318 result = (len(nicks) == len(other_players), nicks, missing)
718 074970227bc0 plugin tools: turn src/plugin/games.py into a plugin and move it to src/plugins/plugin_misc_room_game.py souliane <souliane@mailoo.org> parents: 717 diff changeset	319 if not result[0] and (verbose or _DEBUG):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	320 debug(_("Still waiting for %s before starting the game %s in %s") % (result[2], self.name, room.occupantJID.userhost()))
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	321 return result
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	322
712 f610864eb7a5 plugins (MUC, tools, games): generalize the generation of a unique room name when joining a MUC and no room is specified: souliane <souliane@mailoo.org> parents: 711 diff changeset	323 def getUniqueName(self, muc_service="", profile_key='@DEFAULT@'):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	324 """
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	325 @param muc_service: you can leave empty to autofind the muc service
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	326 @param profile_key
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	327 @return: a unique name for a new room to be created
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	328 """
712 f610864eb7a5 plugins (MUC, tools, games): generalize the generation of a unique room name when joining a MUC and no room is specified: souliane <souliane@mailoo.org> parents: 711 diff changeset	329 room = self.host.plugins["XEP-0045"].getUniqueName(muc_service, profile_key=profile_key)
f610864eb7a5 plugins (MUC, tools, games): generalize the generation of a unique room name when joining a MUC and no room is specified: souliane <souliane@mailoo.org> parents: 711 diff changeset	330 return "sat_%s_%s" % (self.name.lower(), room) if room != "" else ""
f610864eb7a5 plugins (MUC, tools, games): generalize the generation of a unique room name when joining a MUC and no room is specified: souliane <souliane@mailoo.org> parents: 711 diff changeset	331
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	332 def prepareRoom(self, other_players=[], room_jid_s=None, profile_key='@NONE@'):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	333 """Prepare the room for a game: create it if it doesn't exist and invite players.
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	334 @param other_players: list for other players JID userhosts
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	335 @param room_jid_s: JID userhost of the room, or None to generate a unique name
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	336 @param profile_key
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	337 """
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	338 debug(_('Preparing room for %s game') % self.name)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	339 profile = self.host.memory.getProfileName(profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	340 if not profile:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	341 error(_("Unknown profile"))
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	342 return
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	343
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	344 def roomJoined(room):
711 c9792d0be499 plugins (tools): collective games (with no opponent, like radiocol) were handled like other games souliane <souliane@mailoo.org> parents: 683 diff changeset	345 """@param room: instance of wokkel.muc.Room"""
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	346 self._createOrInvite(room, [JID(player).userhost() for player in other_players], profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	347
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	348 def afterClientInit(room_jid_s):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	349 """Create/join the given room, or a unique generated one if no room is specified.
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	350 @param room_jids: userhost of the room to join
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	351 """
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	352 if room_jid_s is not None and room_jid_s != "": # a room name has been specified
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	353 if room_jid_s in self.host.plugins["XEP-0045"].clients[profile].joined_rooms:
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	354 roomJoined(self.host.plugins["XEP-0045"].clients[profile].joined_rooms[room_jid_s])
712 f610864eb7a5 plugins (MUC, tools, games): generalize the generation of a unique room name when joining a MUC and no room is specified: souliane <souliane@mailoo.org> parents: 711 diff changeset	355 return
f610864eb7a5 plugins (MUC, tools, games): generalize the generation of a unique room name when joining a MUC and no room is specified: souliane <souliane@mailoo.org> parents: 711 diff changeset	356 else:
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	357 room_jid_s = self.getUniqueName(profile_key=profile_key)
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	358 if room_jid_s == "":
712 f610864eb7a5 plugins (MUC, tools, games): generalize the generation of a unique room name when joining a MUC and no room is specified: souliane <souliane@mailoo.org> parents: 711 diff changeset	359 return
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	360 user_jid = self.host.getJidNStream(profile)[0]
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	361 d = self.host.plugins["XEP-0045"].join(JID(room_jid_s), user_jid.user, {}, profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	362 d.addCallback(roomJoined)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	363
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	364 client = self.host.getClient(profile)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	365 if not client:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	366 error(_('No client for this profile key: %s') % profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	367 return
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	368 client.client_initialized.addCallback(lambda ignore: afterClientInit(room_jid_s))
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	369
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	370 def userJoinedTrigger(self, room, user, profile):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	371 """This trigger is used to check if the new user can take part of a game,
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	372 create the game if we were waiting for him or just update the players list.
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	373 @room: wokkel.muc.Room object. room.roster is a dict{wokkel.muc.User.nick: wokkel.muc.User}
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	374 @user: wokkel.muc.User object. user.nick is a unicode and user.entity a JID
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	375 @return: True to not interrupt the main process.
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	376 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	377 room_jid_s = room.occupantJID.userhost()
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	378 profile_nick = room.occupantJID.resource
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	379 if not self.isReferee(room_jid_s, profile_nick):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	380 return True # profile is not the referee
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	381 if not self._checkJoinAuth(room_jid_s, user.entity.userhost() if user.entity else None, user.nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	382 # user not allowed but let him know that we are playing :p
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	383 self._signalPlayers(room_jid_s, [JID(room_jid_s + '/' + user.nick)], profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	384 return True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	385 if self.wait_mode == self.FOR_ALL:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	386 # considering the last batch of invitations
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	387 batch = len(self.invitations[room_jid_s]) - 1
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	388 if batch < 0:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	389 error("Invitations from %s to play %s in %s have been lost!" % (profile_nick, self.name, room_jid_s))
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	390 return True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	391 other_players = self.invitations[room_jid_s][batch][1]
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	392 (auth, nicks, dummy) = self._checkWaitAuth(room, other_players)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	393 if auth:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	394 del self.invitations[room_jid_s][batch]
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	395 nicks.insert(0, profile_nick) # add the referee
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	396 self.createGame(room_jid_s, nicks, profile_key=profile)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	397 return True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	398 # let the room know that a new player joined
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	399 self._updatePlayers(room_jid_s, [user.nick], profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	400 return True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	401
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	402 def userLeftTrigger(self, room, user, profile):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	403 """This trigger is used to update or stop the game when a user leaves.
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	404 @room: wokkel.muc.Room object. room.roster is a dict{wokkel.muc.User.nick: wokkel.muc.User}
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	405 @user: wokkel.muc.User object. user.nick is a unicode and user.entity a JID
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	406 @return: True to not interrupt the main process.
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	407 """
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	408 room_jid_s = room.occupantJID.userhost()
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	409 profile_nick = room.occupantJID.resource
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	410 if not self.isReferee(room_jid_s, profile_nick):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	411 return True # profile is not the referee
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	412 if self.isPlayer(room_jid_s, user.nick):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	413 try:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	414 self.games[room_jid_s]['players'].remove(user.nick)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	415 except ValueError:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	416 pass
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	417 if self.wait_mode == self.FOR_ALL:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	418 # allow this user to join the game again
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	419 user_jid_s = user.entity.userhost()
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	420 if len(self.invitations[room_jid_s]) == 0:
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	421 self.invitations[room_jid_s].append((time(), [user_jid_s]))
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	422 else:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	423 batch = 0 # add to the first batch of invitations
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	424 if user_jid_s not in self.invitations[room_jid_s][batch][1]:
23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	425 self.invitations[room_jid_s][batch][1].append(user_jid_s)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	426 return True
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	427
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	428 def _checkCreateGameAndInit(self, room_jid_s, profile):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	429 """Check if that profile can create the game. If the game can be created
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	430 but is not initialized yet, this method will also do the initialization.
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	431 @param room_jid_s: room userhost
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	432 @param profile
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	433 @return: a couple (create, sync) with:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	434 - create: set to True to allow the game creation
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	435 - sync: set to True to advice a game synchronization
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	436 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	437 user_nick = self.host.plugins["XEP-0045"].getRoomNick(room_jid_s, profile)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	438 if not user_nick:
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	439 error('Internal error: profile %s has not joined the room %s' % (profile, room_jid_s))
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	440 return False, False
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	441 if self._gameExists(room_jid_s):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	442 is_referee = self.isReferee(room_jid_s, user_nick)
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	443 if self._gameExists(room_jid_s, started=True):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	444 warning(_("%s game already created in room %s") % (self.name, room_jid_s))
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	445 return False, is_referee
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	446 elif not is_referee:
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	447 warning(_("%s game in room %s can only be created by %s") % (self.name, room_jid_s, user_nick))
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	448 return False, False
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	449 else:
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	450 self._initGame(room_jid_s, user_nick)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	451 return True, False
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	452
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	453 def createGame(self, room_jid_s, nicks=[], profile_key='@NONE@'):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	454 """Create a new game - this can be called directly from a frontend
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	455 and skips all the checks and invitation system, but the game must
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	456 not exist and all the players must be in the room already.
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	457 @param room_jid: JID userhost of the room
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	458 @param nicks: list of players nicks in the room (referee included, in first position)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	459 @param profile_key: %(doc_profile_key)s"""
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	460 debug(_("Creating %s game in room %s") % (self.name, room_jid_s))
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	461 profile = self.host.memory.getProfileName(profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	462 if not profile:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	463 error(_("profile %s is unknown") % profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	464 return
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	465 (create, sync) = self._checkCreateGameAndInit(room_jid_s, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	466 if not create:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	467 if sync:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	468 debug(_('Synchronize game %s in %s for %s') % (self.name, room_jid_s, ', '.join(nicks)))
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	469 # TODO: we should call a method to re-send the information to a player who left
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	470 # and joined the room again, currently: we may restart a whole new round...
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	471 self._updatePlayers(room_jid_s, nicks, profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	472 return
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	473 self.games[room_jid_s]['started'] = True
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	474 self._updatePlayers(room_jid_s, nicks, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	475 if self.player_init == {}:
711 c9792d0be499 plugins (tools): collective games (with no opponent, like radiocol) were handled like other games souliane <souliane@mailoo.org> parents: 683 diff changeset	476 return
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	477 # specific data to each player
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	478 status = {}
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	479 players_data = {}
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	480 for nick in nicks:
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	481 # The dict must be COPIED otherwise it is shared between all users
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	482 players_data[nick] = copy.deepcopy(self.player_init)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	483 status[nick] = "init"
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	484 self.games[room_jid_s].update({'status': status, 'players_data': players_data})
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	485
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	486 def playerReady(self, player, referee, profile_key='@NONE@'):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	487 """Must be called when player is ready to start a new game
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	488 @param player: the player nick in the room
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	489 @param referee: referee userhost
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	490 """
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	491 profile = self.host.memory.getProfileName(profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	492 if not profile:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	493 error(_("profile %s is unknown") % profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	494 return
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	495 debug('new player ready: %s' % profile)
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	496 # TODO: we probably need to add the game and room names in the sent message
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	497 self.send(JID(referee), 'player_ready', {'player': player}, profile=profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	498
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	499 def newRound(self, room_jid, data, profile):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	500 """Launch a new round (reinit the user data)
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	501 @param room_jid: room userhost
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	502 @param data: a couple (common_data, msg_elts) with:
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	503 - common_data: backend initialization data for the new round
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	504 - msg_elts: dict to map each user to his specific initialization message
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	505 @param profile
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	506 """
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	507 debug(_('new round for %s game') % self.name)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	508 game_data = self.games[room_jid.userhost()]
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	509 players = game_data['players']
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	510 players_data = game_data['players_data']
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	511 game_data['stage'] = "init"
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	512
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	513 common_data, msg_elts = copy.deepcopy(data) if data is not None else (None, None)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	514
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	515 if isinstance(msg_elts, dict):
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	516 for player in players:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	517 to_jid = JID(room_jid.userhost() + "/" + player) # FIXME: gof:
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	518 elem = msg_elts[player] if isinstance(msg_elts[player], domish.Element) else None
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	519 self.send(to_jid, elem, profile=profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	520 elif isinstance(msg_elts, domish.Element):
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	521 self.send(room_jid, msg_elts, profile=profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	522 if common_data is not None:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	523 for player in players:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	524 players_data[player].update(common_data)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	525
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	526 def _createGameElt(self, to_jid):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	527 """Create a generic domish Element for the game messages
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	528 @param to_jid: JID of the recipient
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	529 @return: the created element
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	530 """
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	531 type_ = "normal" if to_jid.resource else "groupchat"
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	532 elt = domish.Element((None, 'message'))
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	533 elt["to"] = to_jid.full()
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	534 elt["type"] = type_
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	535 elt.addElement(self.ns_tag)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	536 return elt
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	537
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	538 def _createStartElement(self, players=None, name="started"):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	539 """Create a domish Element listing the game users
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	540 @param players: list of the players
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	541 @param name: element name:
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	542 - "started" to signal the players that the game has been started
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	543 - "players" to signal the list of players when the game is not started yet
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	544 @return the create element
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	545 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	546 started_elt = domish.Element((None, name))
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	547 if players is None:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	548 return started_elt
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	549 idx = 0
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	550 for player in players:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	551 player_elt = domish.Element((None, 'player'))
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	552 player_elt.addContent(player)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	553 player_elt['index'] = str(idx)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	554 idx += 1
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	555 started_elt.addChild(player_elt)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	556 return started_elt
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	557
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	558 def _sendElements(self, to_jid, data, profile=None):
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	559 """
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	560 @param to_jid: recipient JID
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	561 @param data: list of (elem, attr, content) with:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	562 - elem: domish.Element, unicode or a couple:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	563 - domish.Element to be directly added as a child to the message
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	564 - unicode name or couple (uri, name) to create a new domish.Element
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	565 and add it as a child to the message (see domish.Element.addElement)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	566 - attrs: dictionary of attributes for the new child
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	567 - content: unicode that is appended to the child content
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	568 @param profile: the profile from which the message is sent
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	569 """
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	570 if profile is None:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	571 error(_("Message can not be sent without a sender profile"))
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	572 return
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	573 msg = self._createGameElt(to_jid)
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	574 for elem, attrs, content in data:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	575 if elem is not None:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	576 if isinstance(elem, domish.Element):
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	577 msg.firstChildElement().addChild(elem)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	578 else:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	579 elem = msg.firstChildElement().addElement(elem)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	580 if attrs is not None:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	581 elem.attributes.update(attrs)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	582 if content is not None:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	583 elem.addContent(content)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	584 self.host.profiles[profile].xmlstream.send(msg)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	585
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	586
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	587 def send(self, to_jid, elem=None, attrs=None, content=None, profile=None):
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	588 """
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	589 @param to_jid: recipient JID
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	590 @param elem: domish.Element, unicode or a couple:
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	591 - domish.Element to be directly added as a child to the message
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	592 - unicode name or couple (uri, name) to create a new domish.Element
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	593 and add it as a child to the message (see domish.Element.addElement)
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	594 @param attrs: dictionary of attributes for the new child
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	595 @param content: unicode that is appended to the child content
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	596 @param profile: the profile from which the message is sent
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	597 """
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	598 self._sendElements(to_jid, [(elem, attrs, content)], profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	599
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	600 def getHandler(self, profile):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	601 return RoomGameHandler(self)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	602
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	603
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	604 class RoomGameHandler (XMPPHandler):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	605 implements(iwokkel.IDisco)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	606
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	607 def __init__(self, plugin_parent):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	608 self.plugin_parent = plugin_parent
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	609 self.host = plugin_parent.host
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	610
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	611 def connectionInitialized(self):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	612 self.xmlstream.addObserver(self.plugin_parent.request, self.plugin_parent.room_game_cmd, profile=self.parent.profile)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	613
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	614 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	615 return [disco.DiscoFeature(self.plugin_parent.ns_tag[0])]
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	616
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	617 def getDiscoItems(self, requestor, target, nodeIdentifier=''):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	618 return []

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_room_game.py @ 801:02ee9ef95277