annotate src/plugins/plugin_xep_0049.py @ 2424:467ddb437a71

frontends (xmlui): fixed crash on advanced_list use: the data variable was set to None but kept for other nodes, resulting in a crash in a later test where a dict was expected.
author Goffi <goffi@goffi.org>
date Wed, 08 Nov 2017 08:31:21 +0100
parents 8b37a62336c3
children 0046283a285d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1934
2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1 #!/usr/bin/env python2
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
2 # -*- coding: utf-8 -*-
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
2414
8b37a62336c3 misc: date update (yes it's a bit late :p )
Goffi <goffi@goffi.org>
parents: 2145
diff changeset
5 # Copyright (C) 2009-2017 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
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 989
diff changeset
23 log = getLogger(__name__)
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from wokkel import compat
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from twisted.words.xish import domish
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
26
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",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents: 1934
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):
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
42 NS_PRIVATE = 'jabber:iq:private'
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)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
58 query_elt = iq_elt.addElement('query', XEP_0049.NS_PRIVATE)
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
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
72 iq_elt = compat.IQ(client.xmlstream, 'get')
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
73 query_elt = iq_elt.addElement('query', XEP_0049.NS_PRIVATE)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
74 query_elt.addElement(node_name, namespace)
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
75 def getCb(answer_iq_elt):
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 answer_query_elt = answer_iq_elt.elements(XEP_0049.NS_PRIVATE, 'query').next()
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
77 return answer_query_elt.firstChildElement()
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 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
79 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
80 return d
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
81