annotate sat/plugins/plugin_xep_0049.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
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
1 #!/usr/bin/env python3
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
3
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # SAT plugin for managing xep-0049
3136
9d0df638c8b4 dates update
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
5 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
6
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
11
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
16
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
19
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
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: 989
diff changeset
22 from sat.core.log import getLogger
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
23
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 989
diff changeset
24 log = getLogger(__name__)
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from wokkel import compat
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
26 from twisted.words.xish import domish
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
27
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
28
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
29 PLUGIN_INFO = {
2145
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
30 C.PI_NAME: "XEP-0049 Plugin",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
31 C.PI_IMPORT_NAME: "XEP-0049",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
32 C.PI_TYPE: "XEP",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
33 C.PI_PROTOCOLS: ["XEP-0049"],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
34 C.PI_DEPENDENCIES: [],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
35 C.PI_MAIN: "XEP_0049",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
36 C.PI_HANDLER: "no",
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
37 C.PI_DESCRIPTION: _("""Implementation of private XML storage"""),
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
38 }
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
39
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
40
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
41 class XEP_0049(object):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
42 NS_PRIVATE = "jabber:iq:private"
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
43
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
44 def __init__(self, host):
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 989
diff changeset
45 log.info(_("Plugin XEP-0049 initialization"))
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
46 self.host = host
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
47
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
48 def privateXMLStore(self, element, profile_key):
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
49 """Store private data
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
50 @param element: domish.Element to store (must have a namespace)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
51 @param profile_key: %(doc_profile_key)s
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
52
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
53 """
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
54 assert isinstance(element, domish.Element)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
55 client = self.host.getClient(profile_key)
989
93359853e4bc plugins XEP-0048, XEP-0049: feature is not checked anymore before using private XML storage, as feature announcement is not mandatory in XEP-0049
Goffi <goffi@goffi.org>
parents: 980
diff changeset
56 # XXX: feature announcement in disco#info is not mandatory in XEP-0049, so we have to try to use private XML, and react according to the answer
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
57 iq_elt = compat.IQ(client.xmlstream)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
58 query_elt = iq_elt.addElement("query", XEP_0049.NS_PRIVATE)
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
59 query_elt.addChild(element)
989
93359853e4bc plugins XEP-0048, XEP-0049: feature is not checked anymore before using private XML storage, as feature announcement is not mandatory in XEP-0049
Goffi <goffi@goffi.org>
parents: 980
diff changeset
60 return iq_elt.send()
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
61
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
62 def privateXMLGet(self, node_name, namespace, profile_key):
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
63 """Store private data
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
64 @param node_name: name of the node to get
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
65 @param namespace: namespace of the node to get
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
66 @param profile_key: %(doc_profile_key)s
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
67 @return (domish.Element): a deferred which fire the stored data
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
68
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
69 """
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
70 client = self.host.getClient(profile_key)
989
93359853e4bc plugins XEP-0048, XEP-0049: feature is not checked anymore before using private XML storage, as feature announcement is not mandatory in XEP-0049
Goffi <goffi@goffi.org>
parents: 980
diff changeset
71 # XXX: see privateXMLStore note about feature checking
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
72 iq_elt = compat.IQ(client.xmlstream, "get")
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
73 query_elt = iq_elt.addElement("query", XEP_0049.NS_PRIVATE)
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
74 query_elt.addElement(node_name, namespace)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
75
989
93359853e4bc plugins XEP-0048, XEP-0049: feature is not checked anymore before using private XML storage, as feature announcement is not mandatory in XEP-0049
Goffi <goffi@goffi.org>
parents: 980
diff changeset
76 def getCb(answer_iq_elt):
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
77 answer_query_elt = next(answer_iq_elt.elements(XEP_0049.NS_PRIVATE, "query"))
989
93359853e4bc plugins XEP-0048, XEP-0049: feature is not checked anymore before using private XML storage, as feature announcement is not mandatory in XEP-0049
Goffi <goffi@goffi.org>
parents: 980
diff changeset
78 return answer_query_elt.firstChildElement()
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
79
989
93359853e4bc plugins XEP-0048, XEP-0049: feature is not checked anymore before using private XML storage, as feature announcement is not mandatory in XEP-0049
Goffi <goffi@goffi.org>
parents: 980
diff changeset
80 d = iq_elt.send()
93359853e4bc plugins XEP-0048, XEP-0049: feature is not checked anymore before using private XML storage, as feature announcement is not mandatory in XEP-0049
Goffi <goffi@goffi.org>
parents: 980
diff changeset
81 d.addCallback(getCb)
93359853e4bc plugins XEP-0048, XEP-0049: feature is not checked anymore before using private XML storage, as feature announcement is not mandatory in XEP-0049
Goffi <goffi@goffi.org>
parents: 980
diff changeset
82 return d