annotate src/bridge/bridge_constructor/dbus_frontend_template.py @ 384:785420cd63f7

plugins: In-Band Bytestreams (XEP-0047) implementation
author Goffi <goffi@goffi.org>
date Thu, 29 Sep 2011 12:05:45 +0200
parents 3ea41a199b36
children e66d300c5d42
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/python
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
2 #-*- coding: utf-8 -*-
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
3
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 """
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
5 SAT communication bridge
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
6 Copyright (C) 2009, 2010, 2011 Jérôme Poisson (goffi@goffi.org)
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
7
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 This program is free software: you can redistribute it and/or modify
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 it under the terms of the GNU General Public License as published by
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 the Free Software Foundation, either version 3 of the License, or
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
11 (at your option) any later version.
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
12
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 This program is distributed in the hope that it will be useful,
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
16 GNU General Public License for more details.
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
17
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
20 """
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
21
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
22 from bridge_frontend import BridgeFrontend
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
23 import dbus, dbus.glib
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
24 from logging import debug, error
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
25
359
eb9d33ba4e36 bridge: templates' constants can now be overrided
Goffi <goffi@goffi.org>
parents: 337
diff changeset
26 const_INT_PREFIX = "org.goffi.SAT" #Interface prefix
eb9d33ba4e36 bridge: templates' constants can now be overrided
Goffi <goffi@goffi.org>
parents: 337
diff changeset
27 const_OBJ_PATH = '/org/goffi/SAT/bridge'
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
28 const_CORE_SUFFIX = ".core"
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
29 const_PLUGIN_SUFFIX = ".plugin"
359
eb9d33ba4e36 bridge: templates' constants can now be overrided
Goffi <goffi@goffi.org>
parents: 337
diff changeset
30
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
31 class BridgeExceptionNoService(Exception):
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
32 pass
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
33
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 class DBusBridgeFrontend(BridgeFrontend):
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 def __init__(self):
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
36 try:
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
37 self.sessions_bus = dbus.SessionBus()
359
eb9d33ba4e36 bridge: templates' constants can now be overrided
Goffi <goffi@goffi.org>
parents: 337
diff changeset
38 self.db_object = self.sessions_bus.get_object(const_INT_PREFIX,
eb9d33ba4e36 bridge: templates' constants can now be overrided
Goffi <goffi@goffi.org>
parents: 337
diff changeset
39 const_OBJ_PATH)
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
40 self.db_core_iface = dbus.Interface(self.db_object,
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
41 dbus_interface=const_INT_PREFIX + const_CORE_SUFFIX)
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
42 self.db_plugin_iface = dbus.Interface(self.db_object,
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
43 dbus_interface=const_INT_PREFIX + const_PLUGIN_SUFFIX)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
44 except dbus.exceptions.DBusException,e:
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
45 if e._dbus_error_name=='org.freedesktop.DBus.Error.ServiceUnknown':
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
46 raise BridgeExceptionNoService
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
47 else:
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
48 raise e
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
49 #props = self.db_core_iface.getProperties()
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
50
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
51 def register(self, functionName, handler, iface="core"):
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
52 if iface == "core":
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
53 self.db_core_iface.connect_to_signal(functionName, handler)
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
54 elif iface == "plugin":
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
55 self.db_plugin_iface.connect_to_signal(functionName, handler)
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
56 else:
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
57 error(_('Unknown interface'))
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
58
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
59 ##METHODS_PART##
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
60
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
61 #methods from plugins
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
62 def getRoomJoined(self, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
63 return self.db_plugin_iface.getRoomJoined(profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
64
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
65 def getRoomSubjects(self, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
66 return self.db_plugin_iface.getRoomSubjects(profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
67
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
68 def joinMUC(self, service, roomId, nick, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
69 return self.db_plugin_iface.joinMUC(service, roomId, nick, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
70
320
5fc5e6a7e5c3 plugin Tarot: added a launch method to automatically create a new room, invite players and create the game
Goffi <goffi@goffi.org>
parents: 307
diff changeset
71 def tarotGameLaunch(self, players, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
72 return self.db_plugin_iface.tarotGameLaunch(players, profile_key)
320
5fc5e6a7e5c3 plugin Tarot: added a launch method to automatically create a new room, invite players and create the game
Goffi <goffi@goffi.org>
parents: 307
diff changeset
73
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
74 def tarotGameCreate(self, room_jid, players, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
75 return self.db_plugin_iface.tarotGameCreate(room_jid, players, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
76
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
77 def tarotGameReady(self, player, referee, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
78 return self.db_plugin_iface.tarotGameReady(player, referee, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
79
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
80 def tarotGameContratChoosed(self, player, referee, contrat, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
81 return self.db_plugin_iface.tarotGameContratChoosed(player, referee, contrat, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
82
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
83 def tarotGamePlayCards(self, player, referee, cards, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
84 return self.db_plugin_iface.tarotGamePlayCards(player, referee, cards, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
85
361
141eeb7cd9e6 Quizz game: first draft
Goffi <goffi@goffi.org>
parents: 359
diff changeset
86 def quizGameLaunch(self, players, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
87 return self.db_plugin_iface.quizGameLaunch(players, profile_key)
361
141eeb7cd9e6 Quizz game: first draft
Goffi <goffi@goffi.org>
parents: 359
diff changeset
88
141eeb7cd9e6 Quizz game: first draft
Goffi <goffi@goffi.org>
parents: 359
diff changeset
89 def quizGameCreate(self, room_jid, players, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
90 return self.db_plugin_iface.quizGameCreate(room_jid, players, profile_key)
361
141eeb7cd9e6 Quizz game: first draft
Goffi <goffi@goffi.org>
parents: 359
diff changeset
91
141eeb7cd9e6 Quizz game: first draft
Goffi <goffi@goffi.org>
parents: 359
diff changeset
92 def quizGameReady(self, player, referee, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
93 return self.db_plugin_iface.quizGameReady(player, referee, profile_key)
361
141eeb7cd9e6 Quizz game: first draft
Goffi <goffi@goffi.org>
parents: 359
diff changeset
94
363
54c77a56b22f bridge: bridge_constuctor's frontend template update with quiz answer method
Goffi <goffi@goffi.org>
parents: 361
diff changeset
95 def quizGameAnswer(self, player, referee, answer, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
96 return self.db_plugin_iface.quizGameAnswer(player, referee, answer, profile_key)
363
54c77a56b22f bridge: bridge_constuctor's frontend template update with quiz answer method
Goffi <goffi@goffi.org>
parents: 361
diff changeset
97
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
98 def sendFile(self, to, path, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
99 return self.db_plugin_iface.sendFile(to, path, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
100
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
101 def findGateways(self, target, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
102 return self.db_plugin_iface.findGateways(target, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
103
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
104 def getCard(self, target, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
105 return self.db_plugin_iface.getCard(target, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
106
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
107 def getCardCache(self, target):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
108 return self.db_plugin_iface.getCardCache(target)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
109
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
110 def getAvatarFile(self, hash):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
111 return self.db_plugin_iface.getAvatarFile(hash)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
112
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
113 def in_band_register(self, target, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
114 return self.db_plugin_iface.in_band_register(target, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
115
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
116 def gatewayRegister(self, action, target, data, profile_key='@DEFAULT@'):
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
117 if data == None:
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
118 data = [('', '')] #XXX: we have to do this awful hack because python dbus need to guess the signature
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
119 return self.db_plugin_iface.gatewayRegister(action, target, data, profile_key)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
120
303
2b52a5da0978 plugin XEP_0277: microblog access model can now be changed
Goffi <goffi@goffi.org>
parents: 272
diff changeset
121 def getLastMicroblogs(self, jid, max_items, profile_key='@DEFAULT@', callback=None, errback=None):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
122 return self.db_plugin_iface.getLastMicroblogs(jid, max_items, profile_key, reply_handler=callback, error_handler=errback)
267
bdcd535e179e Bridge constructor:
Goffi <goffi@goffi.org>
parents:
diff changeset
123
307
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents: 304
diff changeset
124 def getMblogNodes(self, profile_key='@DEFAULT@', callback=None, errback=None):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
125 return self.db_plugin_iface.getMblogNodes(profile_key, reply_handler=callback, error_handler=errback)
307
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents: 304
diff changeset
126
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents: 304
diff changeset
127 def sendGroupBlog(self, groups, message, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
128 return self.db_plugin_iface.sendGroupBlog(groups, message, profile_key)
307
1e4575e12581 Group blog first draft
Goffi <goffi@goffi.org>
parents: 304
diff changeset
129
304
e04ccf122bb6 microblog sending
Goffi <goffi@goffi.org>
parents: 303
diff changeset
130 def sendPersonalEvent(self, event_type, data, profile_key='@DEFAULT@'):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
131 return self.db_plugin_iface.sendPersonalEvent(event_type, data, profile_key)
337
4402ac630712 bridge: async callback managed in bridge_constructor + misc
Goffi <goffi@goffi.org>
parents: 320
diff changeset
132
4402ac630712 bridge: async callback managed in bridge_constructor + misc
Goffi <goffi@goffi.org>
parents: 320
diff changeset
133 def setMicroblogAccess(self, access="presence", profile_key='@DEFAULT@', callback=None, errback=None):
371
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request
Goffi <goffi@goffi.org>
parents: 363
diff changeset
134 return self.db_plugin_iface.setMicroblogAccess(access, profile_key, reply_handler=callback, error_handler=errback)
304
e04ccf122bb6 microblog sending
Goffi <goffi@goffi.org>
parents: 303
diff changeset
135