Mercurial > libervia-backend

comparison libervia/backend/plugins/plugin_xep_0049.py @ 4071:4b842c1fb686

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
refactoring: renamed `sat` package to `libervia.backend`
author Goffi <goffi@goffi.org>
date Fri, 02 Jun 2023 11:49:51 +0200
parents sat/plugins/plugin_xep_0049.py@524856bd7b19
children
comparison
equal deleted inserted replaced
4070:d10748475025 4071:4b842c1fb686
1 #!/usr/bin/env python3
2
3
4 # SAT plugin for managing xep-0049
5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
6
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
16
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 from libervia.backend.core.i18n import _
21 from libervia.backend.core.constants import Const as C
22 from libervia.backend.core.log import getLogger
23
24 log = getLogger(__name__)
25 from wokkel import compat
26 from twisted.words.xish import domish
27
28
29 PLUGIN_INFO = {
30 C.PI_NAME: "XEP-0049 Plugin",
31 C.PI_IMPORT_NAME: "XEP-0049",
32 C.PI_TYPE: "XEP",
33 C.PI_PROTOCOLS: ["XEP-0049"],
34 C.PI_DEPENDENCIES: [],
35 C.PI_MAIN: "XEP_0049",
36 C.PI_HANDLER: "no",
37 C.PI_DESCRIPTION: _("""Implementation of private XML storage"""),
38 }
39
40
41 class XEP_0049(object):
42 NS_PRIVATE = "jabber:iq:private"
43
44 def __init__(self, host):
45 log.info(_("Plugin XEP-0049 initialization"))
46 self.host = host
47
48 def private_xml_store(self, element, profile_key):
49 """Store private data
50 @param element: domish.Element to store (must have a namespace)
51 @param profile_key: %(doc_profile_key)s
52
53 """
54 assert isinstance(element, domish.Element)
55 client = self.host.get_client(profile_key)
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
57 iq_elt = compat.IQ(client.xmlstream)
58 query_elt = iq_elt.addElement("query", XEP_0049.NS_PRIVATE)
59 query_elt.addChild(element)
60 return iq_elt.send()
61
62 def private_xml_get(self, node_name, namespace, profile_key):
63 """Store private data
64 @param node_name: name of the node to get
65 @param namespace: namespace of the node to get
66 @param profile_key: %(doc_profile_key)s
67 @return (domish.Element): a deferred which fire the stored data
68
69 """
70 client = self.host.get_client(profile_key)
71 # XXX: see private_xml_store note about feature checking
72 iq_elt = compat.IQ(client.xmlstream, "get")
73 query_elt = iq_elt.addElement("query", XEP_0049.NS_PRIVATE)
74 query_elt.addElement(node_name, namespace)
75
76 def get_cb(answer_iq_elt):
77 answer_query_elt = next(answer_iq_elt.elements(XEP_0049.NS_PRIVATE, "query"))
78 return answer_query_elt.firstChildElement()
79
80 d = iq_elt.send()
81 d.addCallback(get_cb)
82 return d