Mercurial > libervia-backend
view src/bridge/bridge_constructor/constructors/embedded/constructor.py @ 2144:1d3f73e065e1
core, jp: component handling + client handling refactoring:
- SàT can now handle components
- plugin have now a "modes" key in PLUGIN_INFO where they declare if they can be used with clients and or components. They default to be client only.
- components are really similar to clients, but with some changes in behaviour:
* component has "entry point", which is a special plugin with a componentStart method, which is called just after component is connected
* trigger end with a different suffixes (e.g. profileConnected vs profileConnectedComponent), so a plugin which manage both clients and components can have different workflow
* for clients, only triggers of plugins handling client mode are launched
* for components, only triggers of plugins needed in dependencies are launched. They all must handle component mode.
* component have a sendHistory attribute (False by default) which can be set to True to allow saving sent messages into history
* for convenience, "client" is still used in method even if it can now be a component
* a new "component" boolean attribute tells if we have a component or a client
* components have to add themselve Message protocol
* roster and presence protocols are not added for components
* component default port is 5347 (which is Prosody's default port)
- asyncCreateProfile has been renamed for profileCreate, both to follow new naming convention and to prepare the transition to fully asynchronous bridge
- createProfile has a new "component" attribute. When used to create a component, it must be set to a component entry point
- jp: added --component argument to profile/create
- disconnect bridge method is now asynchronous, this way frontends can know when disconnection is finished
- new PI_* constants for PLUGIN_INFO values (not used everywhere yet)
- client/component connection workflow has been moved to their classes instead of being a host methods
- host.messageSend is now client.sendMessage, and former client.sendMessage is now client.sendMessageData.
- identities are now handled in client.identities list, so it can be updated dynamically by plugins (in the future, frontends should be able to update them too through bridge)
- profileConnecting* profileConnected* profileDisconnected* and getHandler now all use client instead of profile
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 12 Feb 2017 17:55:43 +0100 |
parents | 442423faf220 |
children | 8b37a62336c3 |
line wrap: on
line source
#!/usr/bin/env python2 #-*- coding: utf-8 -*- # SàT: a XMPP client # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. from sat.bridge.bridge_constructor import base_constructor # from textwraps import dedent class EmbeddedConstructor(base_constructor.Constructor): NAME = "embedded" CORE_TEMPLATE = "embedded_template.py" CORE_DEST = "embedded.py" CORE_FORMATS = { 'methods': """\ def {name}(self, {args}{args_comma}callback=None, errback=None): {ret_routine} """, 'signals': """\ def {name}(self, {args}): try: cb = self._signals_cbs["{category}"]["{name}"] except KeyError: log.warning(u"ignoring signal {name}: no callback registered") else: cb({args_result}) """ } FRONTEND_TEMPLATE = "embedded_frontend_template.py" FRONTEND_DEST = CORE_DEST FRONTEND_FORMATS = {} def core_completion_method(self, completion, function, default, arg_doc, async_): completion.update({ 'debug': "" if not self.args.debug else 'log.debug ("%s")\n%s' % (completion['name'], 8 * ' '), 'args_result': self.getArguments(function['sig_in'], name=arg_doc), 'args_comma': ', ' if function['sig_in'] else '', }) if async_: completion["cb_or_lambda"] = "callback" if function['sig_out'] else "lambda dummy: callback()" completion["ret_routine"] = """\ d = self._methods_cbs["{name}"]({args_result}) if callback is not None: d.addCallback({cb_or_lambda}) if errback is None: d.addErrback(lambda failure_: log.error(failure_)) else: d.addErrback(errback) return d """.format(**completion) else: completion['ret_or_nothing'] = 'ret' if function['sig_out'] else '' completion["ret_routine"] = """\ try: ret = self._methods_cbs["{name}"]({args_result}) except Exception as e: if errback is not None: errback(e) else: raise e else: if callback is None: return ret else: callback({ret_or_nothing})""".format(**completion) def core_completion_signal(self, completion, function, default, arg_doc, async_): completion.update({ 'args_result': self.getArguments(function['sig_in'], name=arg_doc), })