Mercurial > libervia-backend
view frontends/src/jp/cmd_debug.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 | 741db5abf077 |
children | 8b37a62336c3 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # jp: a SàT command line tool # 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/>. import base from sat.core.i18n import _ from sat_frontends.jp.constants import Const as C import json __commands__ = ["Debug"] class BridgeCommon(object): def evalArgs(self): if self.args.arg: try: return eval(u'[{}]'.format(u",".join(self.args.arg))) except SyntaxError as e: self.disp(u"Can't evaluate arguments: {mess}\n{text}\n{offset}^".format( mess=e, text=e.text.decode('utf-8'), offset=u" "*(e.offset-1) ), error=True) self.host.quit(C.EXIT_BAD_ARG) else: return [] class Method(base.CommandBase, BridgeCommon): def __init__(self, host): base.CommandBase.__init__(self, host, 'method', help=_(u'call a bridge method')) BridgeCommon.__init__(self) self.need_loop=True def add_parser_options(self): self.parser.add_argument("method", type=str, help=_(u"name of the method to execute")) self.parser.add_argument("arg", type=base.unicode_decoder, nargs="*", help=_(u"argument of the method")) def method_cb(self, ret=None): if ret is not None: self.disp(unicode(ret)) self.host.quit() def method_eb(self, failure): self.disp(_(u"Error while executing {}: {}".format(self.args.method, failure)), error=True) self.host.quit(C.EXIT_ERROR) def start(self): method = getattr(self.host.bridge, self.args.method) args = self.evalArgs() try: method(*args, profile=self.profile, callback=self.method_cb, errback=self.method_eb) except TypeError: # maybe the method doesn't need a profile ? try: method(*args, callback=self.method_cb, errback=self.method_eb) except TypeError: self.method_eb(_(u"bad arguments")) class Signal(base.CommandBase, BridgeCommon): def __init__(self, host): base.CommandBase.__init__(self, host, 'signal', help=_(u'send a fake signal from backend')) BridgeCommon.__init__(self) def add_parser_options(self): self.parser.add_argument("signal", type=str, help=_(u"name of the signal to send")) self.parser.add_argument("arg", type=base.unicode_decoder, nargs="*", help=_(u"argument of the signal")) def start(self): args = self.evalArgs() json_args = json.dumps(args) # XXX: we use self.args.profile and not self.profile # because we want the raw profile_key (so plugin handle C.PROF_KEY_NONE) self.host.bridge.debugFakeSignal(self.args.signal, json_args, self.args.profile) class Bridge(base.CommandBase): subcommands = (Method, Signal) def __init__(self, host): super(Bridge, self).__init__(host, 'bridge', use_profile=False, help=_('bridge s(t)imulation')) class Debug(base.CommandBase): subcommands = (Bridge,) def __init__(self, host): super(Debug, self).__init__(host, 'debug', use_profile=False, help=_('debugging tools'))