annotate libervia/frontends/tools/xmltools.py @ 4306:94e0968987cd

plugin XEP-0033: code modernisation, improve delivery, data validation: - Code has been rewritten using Pydantic models and `async` coroutines for data validation and cleaner element parsing/generation. - Delivery has been completely rewritten. It now works even if server doesn't support multicast, and send to local multicast service first. Delivering to local multicast service first is due to bad support of XEP-0033 in server (notably Prosody which has an incomplete implementation), and the current impossibility to detect if a sub-domain service handles fully multicast or only for local domains. This is a workaround to have a good balance between backward compatilibity and use of bandwith, and to make it work with the incoming email gateway implementation (the gateway will only deliver to entities of its own domain). - disco feature checking now uses `async` corountines. `host` implementation still use Deferred return values for compatibility with legacy code. rel 450
author Goffi <goffi@goffi.org>
date Thu, 26 Sep 2024 16:12:01 +0200
parents 0d7bb4df2343
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
1 #!/usr/bin/env python3
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
675
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
3
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # SAT: a jabber client
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
675
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
6
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
11
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
16
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
19
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
20 """This library help manage XML used in SàT frontends """
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
21
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
22 # we don't import minidom as a different class can be used in frontends
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
23 # (e.g. NativeDOM in Libervia)
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
24
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
25
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
26 def inline_root(doc):
4270
0d7bb4df2343 Reformatted code base using black.
Goffi <goffi@goffi.org>
parents: 4074
diff changeset
27 """make the root attribute inline
675
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
28 @param root_node: minidom's Document compatible class
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
29 @return: plain XML
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
30 """
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
31 root_elt = doc.documentElement
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
32 if root_elt.hasAttribute("style"):
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
33 styles_raw = root_elt.getAttribute("style")
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
34 styles = styles_raw.split(";")
675
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
35 new_styles = []
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
36 for style in styles:
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
37 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
38 key, value = style.split(":")
675
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
39 except ValueError:
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
40 continue
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
41 if key.strip().lower() == "display":
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
42 value = "inline"
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
43 new_styles.append("%s: %s" % (key.strip(), value.strip()))
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
44 root_elt.setAttribute("style", "; ".join(new_styles))
675
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
45 else:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
46 root_elt.setAttribute("style", "display: inline")
675
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
47 return root_elt.toxml()