annotate src/plugins/plugin_xep_0049.py @ 1639:baac2e120600

plugin file[SatFile]: auto_end_signals flag can be False if the progressFinished and progressError signals are managed by caller.
author Goffi <goffi@goffi.org>
date Sun, 22 Nov 2015 17:27:27 +0100
parents 069ad98b360d
children d17772b0fe22
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/python
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
1396
069ad98b360d 2015 copyright dates update
Goffi <goffi@goffi.org>
parents: 993
diff changeset
5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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 _
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 989
diff changeset
21 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 989
diff changeset
22 log = getLogger(__name__)
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
23 from wokkel import compat
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from twisted.words.xish import domish
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
25
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 PLUGIN_INFO = {
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
29 "name": "XEP-0049 Plugin",
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
30 "import_name": "XEP-0049",
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
31 "type": "XEP",
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
32 "protocols": ["XEP-0049"],
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
33 "dependencies": [],
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
34 "main": "XEP_0049",
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
35 "handler": "no",
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
36 "description": _("""Implementation of private XML storage""")
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
37 }
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 class XEP_0049(object):
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
41 NS_PRIVATE = 'jabber:iq:private'
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
42
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
43 def __init__(self, host):
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 989
diff changeset
44 log.info(_("Plugin XEP-0049 initialization"))
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
45 self.host = host
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
46
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
47 def privateXMLStore(self, element, profile_key):
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
48 """Store private data
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
49 @param element: domish.Element to store (must have a namespace)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
50 @param profile_key: %(doc_profile_key)s
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
51
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 assert isinstance(element, domish.Element)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
54 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
55 # 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
56 iq_elt = compat.IQ(client.xmlstream)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
57 query_elt = iq_elt.addElement('query', XEP_0049.NS_PRIVATE)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
58 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
59 return iq_elt.send()
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
60
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
61 def privateXMLGet(self, node_name, namespace, profile_key):
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
62 """Store private data
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
63 @param node_name: name of the node to get
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
64 @param namespace: namespace of the node to get
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
65 @param profile_key: %(doc_profile_key)s
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
66 @return (domish.Element): a deferred which fire the stored data
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
67
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 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
70 # XXX: see privateXMLStore note about feature checking
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
71 iq_elt = compat.IQ(client.xmlstream, 'get')
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
72 query_elt = iq_elt.addElement('query', XEP_0049.NS_PRIVATE)
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
73 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
74 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
75 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
76 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
77 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
78 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
79 return d
980
f0bba18835ef plugin XEP-0049: private xml storage
Goffi <goffi@goffi.org>
parents:
diff changeset
80