libervia-backend: src/plugins/plugin_misc_room

annotate src/plugins/plugin_misc_room_game.py @ 1794:b0ed4863dbc7

bridge (D-Bus): fixed handling of profile in kwargs: kwargs are not handled by python D-Bus (i.e. they are not sent through D-Bus). The "profile" and "profile_key" kwargs are often used through SàT with the bridge, this was working so far because they were used for core methods (which have a signature in DBus.py handling profile), or in Libervia browser who ignore profile argument. But if the profile or profile_key was used as a keyword for plugin method outside of Libervia browser, they were ignored, this commit fix this by adding them to the args list.

author	Goffi <goffi@goffi.org>
date	Wed, 13 Jan 2016 18:44:32 +0100
parents	d17772b0fe22
children	ffcd7904b655

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
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1409 diff changeset	5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
683 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 _
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 877 diff changeset	21 from sat.core.constants import Const as C
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	22 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	23 log = getLogger(__name__)
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	24 from twisted.words.protocols.jabber import jid
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	25 from twisted.words.xish import domish
849 c5a8f602662b plugin room_game, radiocol: RoomGame.send returns a Deferred. souliane <souliane@mailoo.org> parents: 844 diff changeset	26 from twisted.internet import defer
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	27 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	28 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	29 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	30 import copy
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	31 try:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	32 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	33 except ImportError:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	34 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	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 # 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	37 _DEBUG = False
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	38
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	39 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	40 "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	41 "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	42 "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	43 "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	44 "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	45 "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	46 "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	47 "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	48 }
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	49
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	50
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	51 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	52 """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	53
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	54 Bridge methods callbacks: _prepareRoom, _playerReady, _createGame
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	55 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	56 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	57
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	58 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	59 """
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	60
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	61 # 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	62 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	63 # 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	64 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	65 # 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	66 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	67 # 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	68 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	69
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	70 MESSAGE = '/message'
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	71 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	72
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	73 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	74 """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	75 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	76
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	77 class MyGame(object):
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	78
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	79 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	80 global RoomGame
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	81 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	82 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	83
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	84 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	85 self.inheritFromRoomGame(host)
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	86 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	87
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	88 """
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	89 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	90
877 386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	91 def _init_(self, host, plugin_info, ns_tag, game_init=None, player_init=None):
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	92 """
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	93 @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	94 @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	95 @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	96 @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	97 @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	98 """
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	99 self.host = host
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	100 self.name = plugin_info["import_name"]
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	101 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	102 self.request = self.REQUEST % (self.MESSAGE, ns_tag[1], ns_tag[0])
877 386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	103 if game_init is None:
386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	104 game_init = {}
386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	105 if player_init is None:
386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	106 player_init = {}
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	107 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	108 self.player_init = player_init
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	109 self.games = {}
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	110 self.invitations = {} # values are a couple (x, y) with x the time and y a list of users
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	111
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	112 # 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	113 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	114 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	115 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	116 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	117
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	118 # this has been added for testing purpose. It is sometimes needed to remove a dependence
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	119 # while building the synchronization data, for example to replace a call to time.time()
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	120 # by an arbitrary value. If needed, this attribute would be set to True from the testcase.
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	121 self.testing = False
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	122
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	123 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	124 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	125
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	126 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	127 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	128 This is called only when someone explicitly wants to play.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	129
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	130 The game will not be created if one already exists in the room,
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	131 also 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	132 join the room (in that case it will be created from userJoinedTrigger).
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	133 @param room (wokkel.muc.Room): the room
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	134 @param other_players (list[jid.JID]): list of the other players JID (bare)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	135 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	136 user_jid = self.host.getJidNStream(profile)[0]
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	137 room_jid = room.occupantJID.userhostJID()
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	138 nick = self.host.plugins["XEP-0045"].getRoomNick(room_jid, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	139 nicks = [nick]
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	140 if self._gameExists(room_jid):
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	141 if not self._checkJoinAuth(room_jid, user_jid, nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	142 return
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	143 nicks.extend(self._invitePlayers(room, other_players, nick, profile))
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	144 self._updatePlayers(room_jid, nicks, True, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	145 else:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	146 self._initGame(room_jid, nick)
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	147 (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	148 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	149 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	150 if auth:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	151 self.createGame(room_jid, nicks, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	152 else:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	153 self._updatePlayers(room_jid, nicks, False, profile)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	154
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	155 def _initGame(self, room_jid, referee_nick):
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	156 """
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	157
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	158 @param room_jid (jid.JID): JID of the room
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	159 @param referee_nick (unicode): nickname of the referee
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	160 """
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	161 # Important: do not add the referee to 'players' yet. For a
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	162 # <players /> message to be emitted whenever a new player is joining,
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	163 # it is necessary to not modify 'players' outside of _updatePlayers.
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	164 referee_jid = jid.JID(room_jid.userhost() + '/' + referee_nick)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	165 self.games[room_jid] = {'referee': referee_jid, 'players': [], 'started': False, 'status': {}}
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	166 self.games[room_jid].update(copy.deepcopy(self.game_init))
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	167 self.invitations.setdefault(room_jid, [])
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	168
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	169 def _gameExists(self, room_jid, started=False):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	170 """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	171 @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	172 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	173 @return: True if a game is initialized/started in that room"""
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	174 return room_jid in self.games and (not started or self.games[room_jid]['started'])
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	175
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	176 def _checkJoinAuth(self, room_jid, user_jid=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	177 """Checks if this profile is allowed to join the game.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	178
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	179 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	180 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	181 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	182 identity instead of user_jid_s (see TODO comment below).
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	183 @param room_jid (jid.JID): the JID of the room hosting the game
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	184 @param user_jid (jid.JID): JID of the user
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	185 @param nick (unicode): 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	186 @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	187 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	188 auth = False
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	189 if not self._gameExists(room_jid):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	190 auth = False
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	191 elif self.join_mode == self.ALL or self.isPlayer(room_jid, nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	192 auth = True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	193 elif 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	194 # considering all the batches of invitations
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	195 for invitations in self.invitations[room_jid]:
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	196 if user_jid is not None:
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	197 if user_jid.userhostJID() in invitations[1]:
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	198 auth = True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	199 break
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	200 else:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	201 # 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	202 # wokkel.muc.User's 'entity' attribute is not set?!
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	203 if nick in [invited.user for invited in invitations[1]]:
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	204 auth = True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	205 break
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	206
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	207 if not auth and (verbose or _DEBUG):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	208 log.debug(_(u"%(user)s not allowed to join the game %(game)s in %(room)s") % {'user': user_jid.userhost() or nick, 'game': self.name, 'room': room_jid.userhost()})
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	209 return auth
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	210
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	211 def _updatePlayers(self, room_jid, nicks, sync, profile):
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	212 """Update the list of players and signal to the room that some players joined the game.
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	213 If sync is True, the news players are synchronized with the game data they have missed.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	214 Remark: self.games[room_jid]['players'] should not be modified outside this method.
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	215 @param room_jid (jid.JID): JID of the room
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	216 @param nicks (list[unicode]): list of players nicks in the room (referee included, in first position)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	217 @param sync (bool): set to True to send synchronization data to the new players
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	218 @param profile (unicode): %(doc_profile)s
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	219 """
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	220 if nicks == []:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	221 return
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	222 # this is better than set(nicks).difference(...) as it keeps the order
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	223 new_nicks = [nick for nick in nicks if nick not in self.games[room_jid]['players']]
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	224 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	225 return
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	226
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	227 def setStatus(status):
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	228 for nick in new_nicks:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	229 self.games[room_jid]['status'][nick] = status
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	230
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	231 sync = sync and self._gameExists(room_jid, True) and len(self.games[room_jid]['players']) > 0
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	232 setStatus('desync' if sync else 'init')
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	233 self.games[room_jid]['players'].extend(new_nicks)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	234 self._synchronizeRoom(room_jid, [room_jid], profile)
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	235 if sync:
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	236 setStatus('init')
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	237
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	238 def _synchronizeRoom(self, room_jid, recipients, profile):
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	239 """Communicate the list of players to the whole room or only to some users,
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	240 also send the synchronization data to the players who recently joined the game.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	241 @param room_jid (jid.JID): JID of the room
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	242 @recipients (list[jid.JID]): list of JIDs, the recipients of the message could be:
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	243 - room JID
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	244 - room JID + "/" + user nick
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	245 @param profile (unicode): %(doc_profile)s
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	246 """
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	247 if self._gameExists(room_jid, started=True):
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	248 element = self._createStartElement(self.games[room_jid]['players'])
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	249 else:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	250 element = self._createStartElement(self.games[room_jid]['players'], name="players")
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	251 elements = [(element, None, None)]
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	252
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	253 sync_args = []
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	254 sync_data = self._getSyncData(room_jid)
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	255 for nick in sync_data:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	256 user_jid = jid.JID(room_jid.userhost() + '/' + nick)
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	257 if user_jid in recipients:
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	258 user_elements = copy.deepcopy(elements)
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	259 for child in sync_data[nick]:
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	260 user_elements.append((child, None, None))
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	261 recipients.remove(user_jid)
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	262 else:
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	263 user_elements = [(child, None, None) for child in sync_data[nick]]
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	264 sync_args.append(([user_jid, user_elements], {'profile': profile}))
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	265
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	266 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	267 self._sendElements(recipient, elements, profile=profile)
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	268 for args, kwargs in sync_args:
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	269 self._sendElements(args, *kwargs)
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	270
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	271 def _getSyncData(self, room_jid, force_nicks=None):
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	272 """The synchronization data are returned for each player who
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	273 has the state 'desync' or if he's been contained by force_nicks.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	274 @param room_jid (jid.JID): JID of the room
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	275 @param force_nicks: force the synchronization for this list of the nicks
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	276 @return: a mapping between player nicks and a list of elements to
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	277 be sent by self._synchronizeRoom for the game to be synchronized.
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	278 """
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	279 if not self._gameExists(room_jid):
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	280 return {}
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	281 data = {}
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	282 status = self.games[room_jid]['status']
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	283 nicks = [nick for nick in status if status[nick] == 'desync']
877 386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	284 if force_nicks is None:
386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	285 force_nicks = []
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	286 for nick in force_nicks:
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	287 if nick not in nicks:
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	288 nicks.append(nick)
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	289 for nick in nicks:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	290 elements = self.getSyncDataForPlayer(room_jid, nick)
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	291 if elements:
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	292 data[nick] = elements
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	293 return data
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	294
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	295 def getSyncDataForPlayer(self, room_jid, nick):
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	296 """This method may (and should probably) be overwritten by a child class.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	297 @param room_jid (jid.JID): JID of the room
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	298 @param nick: the nick of the player to be synchronized
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	299 @return: a list of elements to synchronize this player with the game.
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	300 """
8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	301 return []
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	302
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	303 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	304 """Invite players to a room, associated game may exist or not.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	305
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	306 @param room (wokkel.muc.Room): the room
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	307 @param other_players (list[jid.JID]): list of the players to invite
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	308 @param nick (unicode): nick of the user who send the invitation
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	309 @return: list[unicode] 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	310 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	311 room_jid = room.occupantJID.userhostJID()
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	312 if not self._checkInviteAuth(room_jid, nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	313 return []
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	314 # TODO: remove invitation waiting for too long, using the time data
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	315 self.invitations[room_jid].append((time(), [player.userhostJID() for player in other_players]))
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	316 nicks = []
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	317 for player_jid in [player.userhostJID() for player in other_players]:
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	318 # TODO: find a way to make it secure
857 3c270d691e56 test: fix the tests for plugin room game souliane <souliane@mailoo.org> parents: 849 diff changeset	319 other_nick = self.host.plugins["XEP-0045"].getRoomNickOfUser(room, player_jid, secure=self.testing)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	320 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	321 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	322 else:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	323 nicks.append(other_nick)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	324 return nicks
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	325
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	326 def _checkInviteAuth(self, room_jid, nick, verbose=False):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	327 """Checks if this user is allowed to invite players
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	328
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	329 @param room_jid (jid.JID): JID of the room
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	330 @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	331 @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	332 @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	333 """
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	334 auth = False
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	335 if self.invite_mode == self.FROM_ALL or not self._gameExists(room_jid):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	336 auth = True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	337 elif self.invite_mode == self.FROM_NONE:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	338 auth = not self._gameExists(room_jid, started=True) and self.isReferee(room_jid, nick)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	339 elif self.invite_mode == self.FROM_REFEREE:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	340 auth = self.isReferee(room_jid, nick)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	341 elif self.invite_mode == self.FROM_PLAYERS:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	342 auth = self.isPlayer(room_jid, 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	343 if not auth and (verbose or _DEBUG):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	344 log.debug(_(u"%(user)s not allowed to invite for the game %(game)s in %(room)s") % {'user': nick, 'game': self.name, 'room': room_jid.userhost()})
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	345 return auth
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	346
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	347 def isReferee(self, room_jid, nick):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	348 """Checks if the player with this nick is the referee for the game in this room"
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	349 @param room_jid (jid.JID): room JID
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	350 @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	351 @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	352 """
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	353 if not self._gameExists(room_jid):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	354 return False
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	355 return jid.JID(room_jid.userhost() + '/' + nick) == self.games[room_jid]['referee']
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	356
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	357 def isPlayer(self, room_jid, nick):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	358 """Checks if the user with this nick is a player for the game in this room.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	359 @param room_jid (jid.JID): JID of the room
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	360 @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	361 @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	362 """
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	363 if not self._gameExists(room_jid):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	364 return False
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	365 # 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	366 # the game initialization, that's why we do also check with isReferee
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	367 return nick in self.games[room_jid]['players'] or self.isReferee(room_jid, nick)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	368
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	369 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	370 """Check if we must wait for other players before starting the game.
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	371
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	372 @param room (wokkel.muc.Room): the room
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	373 @param other_players (list[jid.JID]): list of the players without the referee
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	374 @param verbose (bool): display debug message
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	375 @return: (x, y, z) with:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	376 x: False if we must wait, True otherwise
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	377 y: the nicks of the players that have been checked and confirmed
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	378 z: the JID of the players that have not been checked or that are missing
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	379 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	380 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	381 result = (True, [], other_players)
791 23b0c949b86c plugins room games, XEP-0045: small fixes, improved docstrings souliane <souliane@mailoo.org> parents: 790 diff changeset	382 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	383 # 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	384 result = (False, [], other_players)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	385 else:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	386 # 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	387 (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	388 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	389 if not result[0] and (verbose or _DEBUG):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	390 log.debug(_(u"Still waiting for %(users)s before starting the game %(game)s in %(room)s") % {'users': result[2], 'game': self.name, 'room': room.occupantJID.userhost()})
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	391 return result
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	392
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	393 def getUniqueName(self, muc_service=None, profile_key=C.PROF_KEY_NONE):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	394 """Generate unique room name
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	395
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	396 @param muc_service (jid.JID): you can leave empty to autofind the muc service
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	397 @param profile_key (unicode): %(doc_profile_key)s
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	398 @return: jid.JID (unique name for a new room to be created)
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	399 """
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	400 # FIXME: jid.JID must be used instead of strings
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	401 room = self.host.plugins["XEP-0045"].getUniqueName(muc_service, profile_key=profile_key)
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	402 return jid.JID("sat_%s_%s" % (self.name.lower(), room.userhost()))
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	403
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	404 def _prepareRoom(self, other_players=None, room_jid_s='', profile_key=C.PROF_KEY_NONE):
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	405 room_jid = jid.JID(room_jid_s) if room_jid_s else None
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	406 other_players = [jid.JID(player).userhostJID() for player in other_players]
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	407 return self.prepareRoom(other_players, room_jid, profile_key)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	408
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	409 def prepareRoom(self, other_players=None, room_jid=None, profile_key=C.PROF_KEY_NONE):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	410 """Prepare the room for a game: create it if it doesn't exist and invite players.
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	411
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	412 @param other_players (list[JID]): list of other players JID (bare)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	413 @param room_jid (jid.JID): JID of the room, or None to generate a unique name
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	414 @param profile_key (unicode): %(doc_profile_key)s
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	415 """
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	416 log.debug(_(u'Preparing room for %s game') % self.name)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	417 profile = self.host.memory.getProfileName(profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	418 if not profile:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	419 log.error(_("Unknown profile"))
1257 83ed877541e3 plugin misc_room_game, radiocol, tarot: fixes bridge method "prepareRoom" declaration (add "async=True") souliane <souliane@mailoo.org> parents: 993 diff changeset	420 return defer.succeed(None)
877 386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	421 if other_players is None:
386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	422 other_players = []
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	423
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	424 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	425 """@param room: instance of wokkel.muc.Room"""
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	426 self._createOrInvite(room, other_players, profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	427
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	428 # Create/join the given room, or a unique generated one if no room is specified.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	429 if room_jid is None:
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	430 room_jid = self.getUniqueName(profile_key=profile_key)
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	431 else:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	432 if room_jid in self.host.plugins["XEP-0045"].clients[profile].joined_rooms:
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	433 roomJoined(self.host.plugins["XEP-0045"].clients[profile].joined_rooms[room_jid])
1257 83ed877541e3 plugin misc_room_game, radiocol, tarot: fixes bridge method "prepareRoom" declaration (add "async=True") souliane <souliane@mailoo.org> parents: 993 diff changeset	434 return defer.succeed(None)
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	435
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	436 user_jid = self.host.getJidNStream(profile)[0]
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	437 d = self.host.plugins["XEP-0045"].join(room_jid, user_jid.user, {}, profile)
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	438 return d.addCallback(roomJoined)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	439
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	440 def userJoinedTrigger(self, room, user, profile):
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	441 """This trigger is used to check if the new user can take part of a game, create the game if we were waiting for him or just update the players list.
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	442
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	443 @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	444 @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	445 @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	446 """
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	447 room_jid = room.occupantJID.userhostJID()
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	448 profile_nick = room.occupantJID.resource
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	449 if not self.isReferee(room_jid, profile_nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	450 return True # profile is not the referee
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	451 if not self._checkJoinAuth(room_jid, user.entity 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	452 # user not allowed but let him know that we are playing :p
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	453 self._synchronizeRoom(room_jid, [jid.JID(room_jid.userhost() + '/' + user.nick)], profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	454 return True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	455 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	456 # considering the last batch of invitations
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	457 batch = len(self.invitations[room_jid]) - 1
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	458 if batch < 0:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	459 log.error(u"Invitations from %s to play %s in %s have been lost!" % (profile_nick, self.name, room_jid.userhost()))
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	460 return True
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	461 other_players = self.invitations[room_jid][batch][1]
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	462 (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	463 if auth:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	464 del self.invitations[room_jid][batch]
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	465 nicks.insert(0, profile_nick) # add the referee
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	466 self.createGame(room_jid, nicks, profile_key=profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	467 return True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	468 # let the room know that a new player joined
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	469 self._updatePlayers(room_jid, [user.nick], True, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	470 return True
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	471
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	472 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	473 """This trigger is used to update or stop the game when a user leaves.
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	474
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	475 @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	476 @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	477 @return: True to not interrupt the main process.
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	478 """
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	479 room_jid = room.occupantJID.userhostJID()
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	480 profile_nick = room.occupantJID.resource
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	481 if not self.isReferee(room_jid, profile_nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	482 return True # profile is not the referee
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	483 if self.isPlayer(room_jid, user.nick):
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	484 try:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	485 self.games[room_jid]['players'].remove(user.nick)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	486 except ValueError:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	487 pass
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	488 if len(self.games[room_jid]['players']) == 0:
828 8f335c03eebb plugins room_games, radiocol, libervia: small changes like refactorization to ease the maintenance souliane <souliane@mailoo.org> parents: 825 diff changeset	489 return True
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	490 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	491 # allow this user to join the game again
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	492 user_jid = user.entity.userhostJID()
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	493 if len(self.invitations[room_jid]) == 0:
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	494 self.invitations[room_jid].append((time(), [user_jid]))
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	495 else:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	496 batch = 0 # add to the first batch of invitations
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	497 if user_jid not in self.invitations[room_jid][batch][1]:
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	498 self.invitations[room_jid][batch][1].append(user_jid)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	499 return True
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	500
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	501 def _checkCreateGameAndInit(self, room_jid, profile):
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	502 """Check if that profile can create the game. If the game can be created
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	503 but is not initialized yet, this method will also do the initialization.
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	504
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	505 @param room_jid (jid.JID): JID of the room
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	506 @param profile
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	507 @return: a couple (create, sync) with:
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	508 - create: set to True to allow the game creation
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	509 - sync: set to True to advice a game synchronization
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	510 """
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	511 user_nick = self.host.plugins["XEP-0045"].getRoomNick(room_jid, profile)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	512 if not user_nick:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	513 log.error(u'Internal error: profile %s has not joined the room %s' % (profile, room_jid.userhost()))
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	514 return False, False
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	515 if self._gameExists(room_jid):
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	516 is_referee = self.isReferee(room_jid, user_nick)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	517 if self._gameExists(room_jid, started=True):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	518 log.warning(_(u"%(game)s game already created in room %(room)s") % {'game': self.name, 'room': room_jid.userhost()})
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	519 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	520 elif not is_referee:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	521 log.warning(_(u"%(game)s game in room %(room)s can only be created by %(user)s") % {'game': self.name, 'room': room_jid.userhost(), 'user': user_nick})
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	522 return False, False
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	523 else:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	524 self._initGame(room_jid, user_nick)
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	525 return True, False
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	526
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	527 def _createGame(self, room_jid_s, nicks=None, profile_key=C.PROF_KEY_NONE):
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	528 self.createGame(jid.JID(room_jid_s), nicks, profile_key)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	529
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	530 def createGame(self, room_jid, nicks=None, profile_key=C.PROF_KEY_NONE):
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	531 """Create a new game.
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	532
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	533 This can be called directly from a frontend and skips all the checks and invitation system,
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	534 but the game must not exist and all the players must be in the room already.
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	535 @param room_jid (jid.JID): JID of the room
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	536 @param nicks (list[unicode]): list of players nicks in the room (referee included, in first position)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	537 @param profile_key (unicode): %(doc_profile_key)s
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	538 """
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	539 log.debug(_(u"Creating %(game)s game in room %(room)s") % {'game': self.name, 'room': room_jid})
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	540 profile = self.host.memory.getProfileName(profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	541 if not profile:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	542 log.error(_(u"profile %s is unknown") % profile_key)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	543 return
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	544 (create, sync) = self._checkCreateGameAndInit(room_jid, profile)
877 386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	545 if nicks is None:
386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	546 nicks = []
717 358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	547 if not create:
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	548 if sync:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	549 self._updatePlayers(room_jid, nicks, True, profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	550 return
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	551 self.games[room_jid]['started'] = True
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	552 self._updatePlayers(room_jid, nicks, False, profile)
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	553 if self.player_init:
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	554 # specific data to each player (score, private data)
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	555 self.games[room_jid].setdefault('players_data', {})
825 e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	556 for nick in nicks:
e3f4d80f987d plugins room_games, radiocol: better synchronization after a user joins a running game souliane <souliane@mailoo.org> parents: 811 diff changeset	557 # The dict must be COPIED otherwise it is shared between all users
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	558 self.games[room_jid]['players_data'][nick] = copy.deepcopy(self.player_init)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	559
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	560 def _playerReady(self, player_nick, referee_jid_s, profile_key=C.PROF_KEY_NONE):
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	561 self.playerReady(player_nick, jid.JID(referee_jid_s), profile_key)
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	562
83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	563 def playerReady(self, player_nick, referee_jid, profile_key=C.PROF_KEY_NONE):
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	564 """Must be called when player is ready to start a new game
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	565
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	566 @param player: the player nick in the room
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	567 @param referee_jid (jid.JID): JID of the referee
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	568 """
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	569 profile = self.host.memory.getProfileName(profile_key)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	570 if not profile:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	571 log.error(_(u"profile %s is unknown") % profile_key)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	572 return
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	573 log.debug(u'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	574 # TODO: we probably need to add the game and room names in the sent message
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	575 self.send(referee_jid, 'player_ready', {'player': player_nick}, profile=profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	576
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	577 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	578 """Launch a new round (reinit the user data)
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	579
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	580 @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	581 @param data: a couple (common_data, msg_elts) with:
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	582 - common_data: backend initialization data for the new round
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	583 - msg_elts: dict to map each user to his specific initialization message
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	584 @param profile
19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	585 """
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	586 log.debug(_(u'new round for %s game') % self.name)
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	587 game_data = self.games[room_jid]
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	588 players = game_data['players']
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	589 players_data = game_data['players_data']
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	590 game_data['stage'] = "init"
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	591
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	592 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	593
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	594 if isinstance(msg_elts, dict):
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	595 for player in players:
1359 83127a4c89ce plugins room_game, quiz, radiocol, tarot: use JID instead of unicode in many methods + class attributes souliane <souliane@mailoo.org> parents: 1257 diff changeset	596 to_jid = 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	597 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	598 self.send(to_jid, elem, profile=profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	599 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	600 self.send(room_jid, msg_elts, profile=profile)
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	601 if common_data is not None:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	602 for player in players:
877 386ab96af575 plugin room_game: fix issues with data structures initialization souliane <souliane@mailoo.org> parents: 857 diff changeset	603 players_data[player].update(copy.deepcopy(common_data))
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	604
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	605 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	606 """Create a generic domish Element for the game messages
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	607
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	608 @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	609 @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	610 """
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	611 type_ = "normal" if to_jid.resource else "groupchat"
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	612 elt = domish.Element((None, 'message'))
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	613 elt["to"] = to_jid.full()
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	614 elt["type"] = type_
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	615 elt.addElement(self.ns_tag)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	616 return elt
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	617
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	618 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	619 """Create a domish Element listing the game users
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	620
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	621 @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	622 @param name: element name:
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	623 - "started" to signal the players that the game has been started
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	624 - "players" to signal the list of players when the game is not started yet
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	625 @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	626 """
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	627 started_elt = domish.Element((None, name))
683 75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	628 if players is None:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	629 return started_elt
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	630 idx = 0
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	631 for player in players:
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	632 player_elt = domish.Element((None, 'player'))
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	633 player_elt.addContent(player)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	634 player_elt['index'] = str(idx)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	635 idx += 1
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	636 started_elt.addChild(player_elt)
75e4f5e2cc65 plugins radiocol, card_game, quiz: code factorization souliane <souliane@mailoo.org> parents: diff changeset	637 return started_elt
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	638
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	639 def _sendElements(self, to_jid, data, profile=None):
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	640 """ TODO
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	641
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	642 @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	643 @param data: list of (elem, attr, content) with:
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	644 - elem: domish.Element, unicode or a couple:
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	645 - domish.Element to be directly added as a child to the message
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	646 - unicode name or couple (uri, name) to create a new domish.Element
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	647 and add it as a child to the message (see domish.Element.addElement)
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	648 - attrs: dictionary of attributes for the new child
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	649 - content: unicode that is appended to the child content
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	650 @param profile: the profile from which the message is sent
849 c5a8f602662b plugin room_game, radiocol: RoomGame.send returns a Deferred. souliane <souliane@mailoo.org> parents: 844 diff changeset	651 @return: a Deferred instance
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	652 """
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	653 if profile is None:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 944 diff changeset	654 log.error(_("Message can not be sent without a sender profile"))
849 c5a8f602662b plugin room_game, radiocol: RoomGame.send returns a Deferred. souliane <souliane@mailoo.org> parents: 844 diff changeset	655 return defer.fail(None)
790 19262fb77230 plugin room game: improved docstrings, added '_' as prefix for internal methods names souliane <souliane@mailoo.org> parents: 771 diff changeset	656 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	657 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	658 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	659 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	660 msg.firstChildElement().addChild(elem)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	661 else:
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	662 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	663 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	664 elem.attributes.update(attrs)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	665 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	666 elem.addContent(content)
539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	667 self.host.profiles[profile].xmlstream.send(msg)
849 c5a8f602662b plugin room_game, radiocol: RoomGame.send returns a Deferred. souliane <souliane@mailoo.org> parents: 844 diff changeset	668 return defer.succeed(None)
746 539f278bc265 plugin room_games, radiocol: send the current queue to new players souliane <souliane@mailoo.org> parents: 718 diff changeset	669
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	670 def send(self, to_jid, elem=None, attrs=None, content=None, profile=None):
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	671 """ TODO
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	672
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	673 @param to_jid: recipient JID
ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	674 @param elem: domish.Element, unicode or a couple:
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	675 - domish.Element to be directly added as a child to the message
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	676 - unicode name or couple (uri, name) to create a new domish.Element
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 941 diff changeset	677 and add it as a child to the message (see domish.Element.addElement)
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	678 @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	679 @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	680 @param profile: the profile from which the message is sent
849 c5a8f602662b plugin room_game, radiocol: RoomGame.send returns a Deferred. souliane <souliane@mailoo.org> parents: 844 diff changeset	681 @return: a Deferred instance
714 ecc5a5b34ee1 plugins (games): add a method to send messages more easily souliane <souliane@mailoo.org> parents: 712 diff changeset	682 """
849 c5a8f602662b plugin room_game, radiocol: RoomGame.send returns a Deferred. souliane <souliane@mailoo.org> parents: 844 diff changeset	683 return 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	684
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	685 def getHandler(self, profile):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	686 return RoomGameHandler(self)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	687
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	688
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	689 class RoomGameHandler (XMPPHandler):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	690 implements(iwokkel.IDisco)
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	691
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	692 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	693 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	694 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	695
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	696 def connectionInitialized(self):
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	697 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	698
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	699 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	700 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	701
358018c5c398 plugins (games): more factorization and flexibility for launching and joining games: souliane <souliane@mailoo.org> parents: 714 diff changeset	702 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	703 return []

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_room_game.py @ 1794:b0ed4863dbc7