Mercurial > libervia-backend
view sat/plugins/plugin_misc_xmllog.py @ 3372:5d926c7b0d99
plugin app manager: first draft:
/!\ new optional dependency: pyyaml
this plugin manage the life cycle of external applications. Application handlers register
to it.
Data needed to launch an application as set in YAML files. Local data types are used to
get values directly from SàT:
- !sat_conf to retrieve a configuration value
- !sat_generate_pwd to generate a password
- !sat_param for parameters specified a launch
Data can be exposed when an instance is launched, this can be used to specify the port
(notably the one used for web), or a generated password.
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 28 Sep 2020 21:10:30 +0200 |
parents | 559a625a236b |
children | 524856bd7b19 |
line wrap: on
line source
#!/usr/bin/env python3 # SàT plugin for managing raw XML log # Copyright (C) 2011 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.core.i18n import _ from sat.core.constants import Const as C from sat.core.log import getLogger from twisted.words.xish import domish from functools import partial log = getLogger(__name__) PLUGIN_INFO = { C.PI_NAME: "Raw XML log Plugin", C.PI_IMPORT_NAME: "XmlLog", C.PI_TYPE: "Misc", C.PI_PROTOCOLS: [], C.PI_DEPENDENCIES: [], C.PI_MAIN: "XmlLog", C.PI_HANDLER: "no", C.PI_DESCRIPTION: _("""Send raw XML logs to bridge"""), } class XmlLog(object): params = """ <params> <general> <category name="Debug"> <param name="Xml log" label="%(label_xmllog)s" value="false" type="bool" /> </category> </general> </params> """ % { "label_xmllog": _("Activate XML log") } def __init__(self, host): log.info(_("Plugin XML Log initialization")) self.host = host host.memory.updateParams(self.params) host.bridge.addSignal( "xmlLog", ".plugin", signature="sss" ) # args: direction("IN" or "OUT"), xml_data, profile host.trigger.add("stream_hooks", self.addHooks) def addHooks(self, client, receive_hooks, send_hooks): self.do_log = self.host.memory.getParamA("Xml log", "Debug") if self.do_log: receive_hooks.append(partial(self.onReceive, client=client)) send_hooks.append(partial(self.onSend, client=client)) log.info(_("XML log activated")) return True def onReceive(self, element, client): self.host.bridge.xmlLog("IN", element.toXml(), client.profile) def onSend(self, obj, client): if isinstance(obj, str): xml_log = obj elif isinstance(obj, domish.Element): xml_log = obj.toXml() else: log.error(_("INTERNAL ERROR: Unmanaged XML type")) self.host.bridge.xmlLog("OUT", xml_log, client.profile)