annotate sat_frontends/tools/xmltools.py @ 3254:6cf4bd6972c2

core, frontends: avatar refactoring: /!\ huge commit Avatar logic has been reworked around the IDENTITY plugin: plugins able to handle avatar or other identity related metadata (like nicknames) register to IDENTITY plugin in the same way as for other features like download/upload. Once registered, IDENTITY plugin will call them when suitable in order of priority, and handle caching. Methods to manage those metadata from frontend now use serialised data. For now `avatar` and `nicknames` are handled: - `avatar` is now a dict with `path` + metadata like `media_type`, instead of just a string path - `nicknames` is now a list of nicknames in order of priority. This list is never empty, and `nicknames[0]` should be the preferred nickname to use by frontends in most cases. In addition to contact specified nicknames, user set nickname (the one set in roster) is used in priority when available. Among the side changes done with this commit, there are: - a new `contactGet` bridge method to get roster metadata for a single contact - SatPresenceProtocol.send returns a Deferred to check when it has actually been sent - memory's methods to handle entities data now use `client` as first argument - metadata filter can be specified with `getIdentity` - `getAvatar` and `setAvatar` are now part of the IDENTITY plugin instead of XEP-0054 (and there signature has changed) - `isRoom` and `getBareOrFull` are now part of XEP-0045 plugin - jp avatar/get command uses `xdg-open` first when available for `--show` flag - `--no-cache` has been added to jp avatar/get and identity/get - jp identity/set has been simplified, explicit options (`--nickname` only for now) are used instead of `--field`. `--field` may come back in the future if necessary for extra data. - QuickContactList `SetContact` now handle None as a value, and doesn't use it to delete the metadata anymore - improved cache handling for `metadata` and `nicknames` in quick frontend - new `default` argument in QuickContactList `getCache`
author Goffi <goffi@goffi.org>
date Tue, 14 Apr 2020 21:00:33 +0200
parents 559a625a236b
children be6d91572633
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
3136
9d0df638c8b4 dates update
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
5 # Copyright (C) 2009-2020 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
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
26 def inlineRoot(doc):
abb9a5104de8 new xml tools module (sat.tools.frontends.xml):
Goffi <goffi@goffi.org>
parents:
diff changeset
27 """ make the root attribute inline
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()