Mercurial > libervia-backend
annotate src/plugins/plugin_xep_0049.py @ 2503:c0bec8bac2b5
XEP-0329: implementation of File Information Sharing:
the plugin do an implementation for client and component.
For client, any directory from local file can be shared.
For component file are stored using new file handling mechanism from SàT.
Permission is handled, using "public" and "whitelist" for now.
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 28 Feb 2018 18:28:39 +0100 |
parents | 0046283a285d |
children |
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 | 2 # -*- coding: utf-8 -*- |
3 | |
4 # SAT plugin for managing xep-0049 | |
2483 | 5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org) |
980 | 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 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 | 24 from wokkel import compat |
25 from twisted.words.xish import domish | |
26 | |
27 | |
28 | |
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 | 38 } |
39 | |
40 | |
41 class XEP_0049(object): | |
42 NS_PRIVATE = 'jabber:iq:private' | |
43 | |
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 | 46 self.host = host |
47 | |
48 def privateXMLStore(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.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 | 57 iq_elt = compat.IQ(client.xmlstream) |
58 query_elt = iq_elt.addElement('query', XEP_0049.NS_PRIVATE) | |
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 | 61 |
62 def privateXMLGet(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.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 | 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) | |
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 | 81 |