Mercurial > libervia-backend
view src/plugins/plugin_misc_xmllog.py @ 1963:a2bc5089c2eb
backend, frontends: message refactoring (huge commit):
/!\ several features are temporarily disabled, like notifications in frontends
next step in refactoring, with the following changes:
- jp: updated jp message to follow changes in backend/bridge
- jp: added --lang, --subject, --subject_lang, and --type options to jp message + fixed unicode handling for jid
- quick_frontend (QuickApp, QuickChat):
- follow backend changes
- refactored chat, message are now handled in OrderedDict and uid are kept so they can be updated
- Message and Occupant classes handle metadata, so frontend just have to display them
- Primitivus (Chat):
- follow backend/QuickFrontend changes
- info & standard messages are handled in the same MessageWidget class
- improved/simplified handling of messages, removed update() method
- user joined/left messages are merged when next to each other
- a separator is shown when message is received while widget is out of focus, so user can quickly see the new messages
- affiliation/role are shown (in a basic way for now) in occupants panel
- removed "/me" messages handling, as it will be done by a backend plugin
- message language is displayed when available (only one language per message for now)
- fixed :history and :search commands
- core (constants): new constants for messages type, XML namespace, entity type
- core: *Message methods renamed to follow new code sytle (e.g. sendMessageToBridge => messageSendToBridge)
- core (messages handling): fixed handling of language
- core (messages handling): mes_data['from'] and ['to'] are now jid.JID
- core (core.xmpp): reorganised message methods, added getNick() method to client.roster
- plugin text commands: fixed plugin and adapted to new messages behaviour. client is now used in arguments instead of profile
- plugins: added information for cancellation reason in CancelError calls
- plugin XEP-0045: various improvments, but this plugin still need work:
- trigger is used to avoid message already handled by the plugin to be handled a second time
- changed the way to handle history, the last message from DB is checked and we request only messages since this one, in seconds (thanks Poezio folks :))
- subject reception is waited before sending the roomJoined signal, this way we are sure that everything including history is ready
- cmd_* method now follow the new convention with client instead of profile
- roomUserJoined and roomUserLeft messages are removed, the events are now handled with info message with a "ROOM_USER_JOINED" info subtype
- probably other forgotten stuffs :p
author | Goffi <goffi@goffi.org> |
---|---|
date | Mon, 20 Jun 2016 18:41:53 +0200 |
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