libervia-backend: sat/plugins/plugin_misc

annotate sat/plugins/plugin_misc_xmllog.py @ 3317:83f25da66bec

core (memory): files are now public by default except for those in root directory: using public permissions by default makes permissions change more easy as we don't have to recursively change all permissions of sub files when changing directory. Root directories are private by default.

author	Goffi <goffi@goffi.org>
date	Sat, 01 Aug 2020 16:02:41 +0200
parents	559a625a236b
children	524856bd7b19

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2691 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3040 diff changeset	2
277 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 _
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	21 from sat.core.constants import Const as C
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 771 diff changeset	22 from sat.core.log import getLogger
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	23 from twisted.words.xish import domish
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	24 from functools import partial
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	25
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 771 diff changeset	26 log = getLogger(__name__)
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	27
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	28 PLUGIN_INFO = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	29 C.PI_NAME: "Raw XML log Plugin",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	30 C.PI_IMPORT_NAME: "XmlLog",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	31 C.PI_TYPE: "Misc",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	32 C.PI_PROTOCOLS: [],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	33 C.PI_DEPENDENCIES: [],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	34 C.PI_MAIN: "XmlLog",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	35 C.PI_HANDLER: "no",
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2691 diff changeset	36 C.PI_DESCRIPTION: _("""Send raw XML logs to bridge"""),
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	37 }
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	38
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	39
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	40 class XmlLog(object):
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	41
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	42 params = """
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	43 <params>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	44 <general>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	45 <category name="Debug">
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	46 <param name="Xml log" label="%(label_xmllog)s" value="false" type="bool" />
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	47 </category>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	48 </general>
05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	49 </params>
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	50 """ % {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	51 "label_xmllog": _("Activate XML log")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	52 }
277 05caa87196e6 new xml log plugin Goffi <goffi@goffi.org> parents: diff changeset	53
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	54 def __init__(self, host):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 771 diff changeset	55 log.info(_("Plugin XML Log initialization"))
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	56 self.host = host
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	57 host.memory.updateParams(self.params)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	58 host.bridge.addSignal(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	59 "xmlLog", ".plugin", signature="sss"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	60 ) # args: direction("IN" or "OUT"), xml_data, profile
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	61
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	62 host.trigger.add("stream_hooks", self.addHooks)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	63
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	64 def addHooks(self, client, receive_hooks, send_hooks):
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	65 self.do_log = self.host.memory.getParamA("Xml log", "Debug")
2440 51d346e283fd plugin XML Log: Monkey patch is done on the whole XmlStream class, making it available as soon as the stream start + long received message are sent once fully parsed (not cut anymore) Goffi <goffi@goffi.org> parents: 2145 diff changeset	66 if self.do_log:
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	67 receive_hooks.append(partial(self.onReceive, client=client))
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	68 send_hooks.append(partial(self.onSend, client=client))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2691 diff changeset	69 log.info(_("XML log activated"))
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	70 return True
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 538 diff changeset	71
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	72 def onReceive(self, element, client):
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	73 self.host.bridge.xmlLog("IN", element.toXml(), client.profile)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	74
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	75 def onSend(self, obj, client):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2691 diff changeset	76 if isinstance(obj, str):
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	77 xml_log = obj
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	78 elif isinstance(obj, domish.Element):
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	79 xml_log = obj.toXml()
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2624 diff changeset	80 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2691 diff changeset	81 log.error(_("INTERNAL ERROR: Unmanaged XML type"))
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	82 self.host.bridge.xmlLog("OUT", xml_log, client.profile)

Mercurial > libervia-backend

annotate sat/plugins/plugin_misc_xmllog.py @ 3317:83f25da66bec