libervia-backend: src/bridge/bridge_constructor/dbus_frontend

annotate src/bridge/bridge_constructor/dbus_frontend_template.py @ 568:239abc5484c9

bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/

author	Goffi <goffi@goffi.org>
date	Mon, 07 Jan 2013 01:01:10 +0100
parents	0bb2e0d1c878
children	ca13633d3b6b

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
459 cf005701624b copyleft date update Goffi <goffi@goffi.org> parents: 455 diff changeset	6 Copyright (C) 2009, 2010, 2011, 2012 Jérôme Poisson (goffi@goffi.org)
267 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
480 2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+ Goffi <goffi@goffi.org> parents: 477 diff changeset	9 it under the terms of the GNU Affero General Public License as published by
267 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
480 2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+ Goffi <goffi@goffi.org> parents: 477 diff changeset	16 GNU Affero General Public License for more details.
267 bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	17
480 2a072735e459 Licence modification: the full project is now under AGPL v3+ instead of GPL v3+ Goffi <goffi@goffi.org> parents: 477 diff changeset	18 You should have received a copy of the GNU Affero General Public License
267 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
535 790be337cc41 bridge: fixed D-Bus warning in frontend side of bridge Goffi <goffi@goffi.org> parents: 480 diff changeset	23 import dbus
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
535 790be337cc41 bridge: fixed D-Bus warning in frontend side of bridge Goffi <goffi@goffi.org> parents: 480 diff changeset	26 from dbus.mainloop.glib import DBusGMainLoop
790be337cc41 bridge: fixed D-Bus warning in frontend side of bridge Goffi <goffi@goffi.org> parents: 480 diff changeset	27 DBusGMainLoop(set_as_default=True)
790be337cc41 bridge: fixed D-Bus warning in frontend side of bridge Goffi <goffi@goffi.org> parents: 480 diff changeset	28
359 eb9d33ba4e36 bridge: templates' constants can now be overrided Goffi <goffi@goffi.org> parents: 337 diff changeset	29 const_INT_PREFIX = "org.goffi.SAT" #Interface prefix
419 6c167a2e04b8 bridge: added generic D-Bus exception management + asyncCreateProfile method Goffi <goffi@goffi.org> parents: 405 diff changeset	30 const_ERROR_PREFIX = const_INT_PREFIX+".error"
359 eb9d33ba4e36 bridge: templates' constants can now be overrided Goffi <goffi@goffi.org> parents: 337 diff changeset	31 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	32 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	33 const_PLUGIN_SUFFIX = ".plugin"
359 eb9d33ba4e36 bridge: templates' constants can now be overrided Goffi <goffi@goffi.org> parents: 337 diff changeset	34
267 bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	35 class BridgeExceptionNoService(Exception):
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	36 pass
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	37
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	38 class DBusBridgeFrontend(BridgeFrontend):
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	39 def __init__(self):
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	40 try:
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	41 self.sessions_bus = dbus.SessionBus()
359 eb9d33ba4e36 bridge: templates' constants can now be overrided Goffi <goffi@goffi.org> parents: 337 diff changeset	42 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	43 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	44 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	45 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	46 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	47 dbus_interface=const_INT_PREFIX + const_PLUGIN_SUFFIX)
267 bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	48 except dbus.exceptions.DBusException,e:
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	49 if e._dbus_error_name=='org.freedesktop.DBus.Error.ServiceUnknown':
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	50 raise BridgeExceptionNoService
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	51 else:
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	52 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	53 #props = self.db_core_iface.getProperties()
267 bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	54
371 3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request Goffi <goffi@goffi.org> parents: 363 diff changeset	55 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	56 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	57 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	58 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	59 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	60 else:
3ea41a199b36 bridge refactoring: categories are now core and plugin instead of communication and request Goffi <goffi@goffi.org> parents: 363 diff changeset	61 error(_('Unknown interface'))
267 bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	62
568 239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	63 def __getattribute__(self, name):
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	64 """ usual __getattribute__ if the method exists, else try to find a plugin method """
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	65 try:
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	66 return object.__getattribute__(self, name)
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	67 except AttributeError:
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	68 # The attribute is not found, we try the plugin proxy to find the requested method
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	69
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	70 def getPluginMethod(args, *kwargs):
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	71 # We first check if we have an async call. We detect this in two ways:
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	72 # - if we have the 'callback' and 'errback' keyword arguments
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	73 # - or if the last two arguments are callable
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	74
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	75 async = False
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	76
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	77 if kwargs:
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	78 if 'callback' in kwargs and 'errback' in kwargs:
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	79 async = True
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	80 _callback = kwargs.pop('callback')
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	81 _errback = kwargs.pop('errback')
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	82 elif len(args)>=2 and callable(args[-1]) and callable(args[-2]):
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	83 async = True
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	84 args = list(args)
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	85 _errback = args.pop()
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	86 _callback = args.pop()
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	87
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	88 method = getattr(self.db_plugin_iface, name)
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	89
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	90 if async:
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	91 kwargs['reply_handler'] = _callback
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	92 kwargs['error_handler'] = lambda err:_errback(err._dbus_error_name[len(const_ERROR_PREFIX)+1:])
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	93
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	94 return method(args, *kwargs)
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	95
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	96 return getPluginMethod
239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	97
267 bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	98 ##METHODS_PART##
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	99
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	100 #methods from plugins
568 239abc5484c9 bridge: generic plugin methods handling for frontend side in D-Bus Bridge \o/ Goffi <goffi@goffi.org> parents: 562 diff changeset	101
449 961543b20806 bridge: removed default profile_key in dbus_frontend_template to avoid difficult to find bugs Goffi <goffi@goffi.org> parents: 435 diff changeset	102 def joinMUC(self, room_jid, nick, options, profile_key):
405 10b4f577d0c0 MUC update to follow wokkel's MUC branch update Goffi <goffi@goffi.org> parents: 401 diff changeset	103 if options == None:
10b4f577d0c0 MUC update to follow wokkel's MUC branch update Goffi <goffi@goffi.org> parents: 401 diff changeset	104 options = [('', '')] #XXX: we have to do this awful hack because python dbus need to guess the signature
10b4f577d0c0 MUC update to follow wokkel's MUC branch update Goffi <goffi@goffi.org> parents: 401 diff changeset	105 return self.db_plugin_iface.joinMUC(room_jid, nick, options, 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	106
449 961543b20806 bridge: removed default profile_key in dbus_frontend_template to avoid difficult to find bugs Goffi <goffi@goffi.org> parents: 435 diff changeset	107 def gatewayRegister(self, action, target, data, profile_key):
267 bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	108 if data == None:
bdcd535e179e Bridge constructor: Goffi <goffi@goffi.org> parents: diff changeset	109 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	110 return self.db_plugin_iface.gatewayRegister(action, target, data, profile_key)

Mercurial > libervia-backend

annotate src/bridge/bridge_constructor/dbus_frontend_template.py @ 568:239abc5484c9