Mercurial > libervia-backend
view src/plugins/plugin_misc_xmllog.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 | 2daf7b4c6756 |
children | 33c8c4973743 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # 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.log import getLogger log = getLogger(__name__) from twisted.words.protocols.jabber.xmlstream import XmlStream from twisted.words.xish import domish PLUGIN_INFO = { "name": "Raw XML log Plugin", "import_name": "XmlLog", "type": "Misc", "protocols": [], "dependencies": [], "main": "XmlLog", "handler": "no", "description": _("""Send raw XML logs to bridge""") } class LoggingXmlStream(XmlStream): """This class send the raw XML to the Bridge, for logging purpose""" def send(self, obj): if isinstance(obj, basestring): log = unicode(obj) elif isinstance(obj, domish.Element): log = obj.toXml() else: log.error(_('INTERNAL ERROR: Unmanaged XML type')) self._host.bridge.xmlLog("OUT", log, self._profile) return XmlStream.send(self, obj) def dataReceived(self, data): # FIXME: we use "replace" here because a big stanza can be cut in the middle of a unicode char # this plugin should probably moved to a better place, where stanzas are fully received self._host.bridge.xmlLog("IN", data.decode('utf-8', 'replace'), self._profile) return XmlStream.dataReceived(self, data) 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 #parameters host.memory.updateParams(self.params) #bridge host.bridge.addSignal("xmlLog", ".plugin", signature='sss') # args: direction("IN" or "OUT"), xml_data, profile do_log = self.host.memory.getParamA("Xml log", "Debug") if do_log: log.info(_("XML log activated")) host.trigger.add("XML Initialized", self.logXml) def logXml(self, xmlstream, profile): xmlstream.__class__ = LoggingXmlStream xmlstream._profile = profile xmlstream._host = self.host return True