Mercurial > libervia-backend
annotate src/plugins/plugin_misc_xmllog.py @ 2096:efe31f0881fb
core (memory/disco): recover getItems on bridge's discoItems method if an item is empty
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sun, 18 Dec 2016 16:28:44 +0100 |
| parents | 2daf7b4c6756 |
| children | 33c8c4973743 |
| rev | line source |
|---|---|
|
1934
2daf7b4c6756
use of /usr/bin/env instead of /usr/bin/python in shebang
Goffi <goffi@goffi.org>
parents:
1706
diff
changeset
|
1 #!/usr/bin/env python2 |
| 277 | 2 # -*- coding: utf-8 -*- |
| 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 | 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 | 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 | 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 | 19 |
| 771 | 20 from sat.core.i18n import _ |
|
993
301b342c697a
core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents:
771
diff
changeset
|
21 from sat.core.log import getLogger |
|
301b342c697a
core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents:
771
diff
changeset
|
22 log = getLogger(__name__) |
| 277 | 23 from twisted.words.protocols.jabber.xmlstream import XmlStream |
| 24 from twisted.words.xish import domish | |
| 25 | |
| 26 PLUGIN_INFO = { | |
|
594
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
27 "name": "Raw XML log Plugin", |
|
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
28 "import_name": "XmlLog", |
|
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
29 "type": "Misc", |
|
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
30 "protocols": [], |
|
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
31 "dependencies": [], |
|
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
32 "main": "XmlLog", |
|
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
33 "handler": "no", |
|
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
34 "description": _("""Send raw XML logs to bridge""") |
| 277 | 35 } |
| 36 | |
|
594
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
37 |
| 277 | 38 class LoggingXmlStream(XmlStream): |
| 39 """This class send the raw XML to the Bridge, for logging purpose""" | |
| 40 | |
| 41 def send(self, obj): | |
|
594
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
42 if isinstance(obj, basestring): |
|
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
43 log = unicode(obj) |
| 277 | 44 elif isinstance(obj, domish.Element): |
|
594
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
45 log = obj.toXml() |
| 277 | 46 else: |
|
993
301b342c697a
core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents:
771
diff
changeset
|
47 log.error(_('INTERNAL ERROR: Unmanaged XML type')) |
|
285
6422fcdd831c
plugin XML Log: fixed dbus signal name
Goffi <goffi@goffi.org>
parents:
280
diff
changeset
|
48 self._host.bridge.xmlLog("OUT", log, self._profile) |
| 277 | 49 return XmlStream.send(self, obj) |
| 50 | |
| 51 def dataReceived(self, data): | |
|
1706
aa60bd58ac23
plugin (xml log): workaround for a crash on big stanzas
Goffi <goffi@goffi.org>
parents:
993
diff
changeset
|
52 # FIXME: we use "replace" here because a big stanza can be cut in the middle of a unicode char |
|
aa60bd58ac23
plugin (xml log): workaround for a crash on big stanzas
Goffi <goffi@goffi.org>
parents:
993
diff
changeset
|
53 # this plugin should probably moved to a better place, where stanzas are fully received |
|
aa60bd58ac23
plugin (xml log): workaround for a crash on big stanzas
Goffi <goffi@goffi.org>
parents:
993
diff
changeset
|
54 self._host.bridge.xmlLog("IN", data.decode('utf-8', 'replace'), self._profile) |
| 277 | 55 return XmlStream.dataReceived(self, data) |
|
587
952322b1d490
Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
538
diff
changeset
|
56 |
| 277 | 57 |
|
588
beaf6bec2fcd
Remove every old-style class.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
587
diff
changeset
|
58 class XmlLog(object): |
|
587
952322b1d490
Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
538
diff
changeset
|
59 |
| 277 | 60 params = """ |
| 61 <params> | |
| 62 <general> | |
| 63 <category name="Debug"> | |
| 64 <param name="Xml log" label="%(label_xmllog)s" value="false" type="bool" /> | |
| 65 </category> | |
| 66 </general> | |
| 67 </params> | |
| 68 """ % {"label_xmllog": _("Activate XML log")} | |
| 69 | |
| 70 def __init__(self, host): | |
|
993
301b342c697a
core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents:
771
diff
changeset
|
71 log.info(_("Plugin XML Log initialization")) |
| 277 | 72 self.host = host |
|
587
952322b1d490
Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
538
diff
changeset
|
73 |
| 277 | 74 #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
|
75 host.memory.updateParams(self.params) |
|
587
952322b1d490
Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
538
diff
changeset
|
76 |
| 277 | 77 #bridge |
|
594
e629371a28d3
Fix pep8 support in src/plugins.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
588
diff
changeset
|
78 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
|
79 |
|
538
2c4016921403
core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles
Goffi <goffi@goffi.org>
parents:
480
diff
changeset
|
80 do_log = self.host.memory.getParamA("Xml log", "Debug") |
| 277 | 81 if do_log: |
|
993
301b342c697a
core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents:
771
diff
changeset
|
82 log.info(_("XML log activated")) |
| 277 | 83 host.trigger.add("XML Initialized", self.logXml) |
|
587
952322b1d490
Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
538
diff
changeset
|
84 |
| 277 | 85 def logXml(self, xmlstream, profile): |
| 86 xmlstream.__class__ = LoggingXmlStream | |
| 87 xmlstream._profile = profile | |
| 88 xmlstream._host = self.host | |
| 89 return True |