libervia-backend: src/plugins/plugin_misc

annotate src/plugins/plugin_misc_xmllog.py @ 771:bfabeedbf32e

core: i18n refactoring: - _() is no more installed in __builtin__ - instead, there is a new sat.core.i18n module - added D_() method for deferred translation - languageSwitch method allow to dynamically change translation language - import gettext is tested against ImportError, and dummy methods are used when not available (mainly useful for Libervia)

author	Goffi <goffi@goffi.org>
date	Sun, 29 Dec 2013 17:06:01 +0100
parents	4f747d7fde8c
children	301b342c697a

rev	line source
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	3
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	4 # SàT plugin for managing raw XML log
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	5 # Copyright (C) 2011 Jérôme Poisson (goffi@goffi.org)
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	10 # (at your option) any later version.
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	15 # GNU Affero General Public License for more details.
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	19
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 662 diff changeset	20 from sat.core.i18n import _
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	21 from logging import debug, info, error
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	22 from twisted.words.protocols.jabber.xmlstream import XmlStream
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	23 from twisted.words.xish import domish
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	24
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	25 PLUGIN_INFO = {
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	26 "name": "Raw XML log Plugin",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	27 "import_name": "XmlLog",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	28 "type": "Misc",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	29 "protocols": [],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	30 "dependencies": [],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	31 "main": "XmlLog",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	32 "handler": "no",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	33 "description": _("""Send raw XML logs to bridge""")
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	34 }
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	35
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	36
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	37 class LoggingXmlStream(XmlStream):
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	38 """This class send the raw XML to the Bridge, for logging purpose"""
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	39
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	40 def send(self, obj):
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	41 if isinstance(obj, basestring):
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	42 log = unicode(obj)
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	43 elif isinstance(obj, domish.Element):
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	44 log = obj.toXml()
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	45 else:
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	46 error(_('INTERNAL ERROR: Unmanaged XML type'))
285 6422fcdd831c plugin XML Log: fixed dbus signal name Goffi <goffi@goffi.org> parents: 280 diff changeset	47 self._host.bridge.xmlLog("OUT", log, self._profile)
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	48 return XmlStream.send(self, obj)
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	49
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	50 def dataReceived(self, data):
285 6422fcdd831c plugin XML Log: fixed dbus signal name Goffi <goffi@goffi.org> parents: 280 diff changeset	51 self._host.bridge.xmlLog("IN", data.decode('utf-8'), self._profile)
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	52 return XmlStream.dataReceived(self, data)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	53
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	54
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	55 class XmlLog(object):
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	56
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	57 params = """
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	58 <params>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	59 <general>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	60 <category name="Debug">
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	61 <param name="Xml log" label="%(label_xmllog)s" value="false" type="bool" />
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	62 </category>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	63 </general>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	64 </params>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	65 """ % {"label_xmllog": _("Activate XML log")}
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	66
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	67 def __init__(self, host):
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	68 info(_("Plugin XML Log initialization"))
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	69 self.host = host
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	70
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	71 #parameters
662 4f747d7fde8c core: importParams renamed to updateParams: it now updates the parameter instead of appending children if it find an existing one. Goffi <goffi@goffi.org> parents: 609 diff changeset	72 host.memory.updateParams(self.params)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	73
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	74 #bridge
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	75 host.bridge.addSignal("xmlLog", ".plugin", signature='sss') # args: direction("IN" or "OUT"), xml_data, profile
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	76
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	77 do_log = self.host.memory.getParamA("Xml log", "Debug")
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	78 if do_log:
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	79 info(_("XML log activated"))
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	80 host.trigger.add("XML Initialized", self.logXml)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	81
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	82 def logXml(self, xmlstream, profile):
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	83 xmlstream.__class__ = LoggingXmlStream
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	84 xmlstream._profile = profile
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	85 xmlstream._host = self.host
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	86 return True

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_xmllog.py @ 771:bfabeedbf32e