Mercurial > libervia-backend
annotate frontends/src/jp/output_std.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 | 227a4e617549 |
| children | 8f96c242fa89 |
| rev | line source |
|---|---|
| 1950 | 1 #! /usr/bin/python |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # jp: a SàT command line tool | |
| 5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) | |
| 6 | |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 """Standard outputs""" | |
| 20 | |
| 21 | |
| 22 from sat_frontends.jp.constants import Const as C | |
| 23 import json | |
| 24 | |
| 25 __outputs__ = ["Default", "Json"] | |
| 26 DEFAULT = u'default' | |
| 27 JSON = u'json' | |
| 28 JSON_RAW = u'json_raw' | |
| 29 | |
| 30 | |
| 31 class Default(object): | |
| 32 """Default outputs""" | |
| 33 | |
| 34 def __init__(self, jp): | |
| 35 jp.register_output(C.OUTPUT_TEXT, DEFAULT, self.text) | |
| 36 jp.register_output(C.OUTPUT_LIST, DEFAULT, self.list) | |
| 37 | |
| 38 def text(self, data): | |
| 39 print data | |
| 40 | |
| 41 def list(self, data): | |
| 42 print u'\n'.join(data) | |
| 43 | |
| 44 | |
| 45 class Json(object): | |
| 46 """outputs in json format""" | |
| 47 | |
| 48 def __init__(self, jp): | |
| 49 jp.register_output(C.OUTPUT_LIST, JSON, self.dump_pretty) | |
| 50 jp.register_output(C.OUTPUT_LIST, JSON_RAW, self.dump) | |
| 51 jp.register_output(C.OUTPUT_DICT, JSON, self.dump_pretty) | |
| 52 jp.register_output(C.OUTPUT_DICT, JSON_RAW, self.dump) | |
| 53 | |
| 54 def dump(self, data): | |
| 55 print json.dumps(data) | |
| 56 | |
| 57 def dump_pretty(self, data): | |
| 58 print json.dumps(data, indent=4) |