Mercurial > libervia-backend
annotate src/plugins/plugin_xep_0297.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 |
| 1274 | 2 # -*- coding: utf-8 -*- |
| 3 | |
| 4 # SAT plugin for Stanza Forwarding (XEP-0297) | |
| 2483 | 5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org) |
| 1766 | 6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org) |
| 1274 | 7 |
| 8 # This program is free software: you can redistribute it and/or modify | |
| 9 # it under the terms of the GNU Affero General Public License as published by | |
| 10 # the Free Software Foundation, either version 3 of the License, or | |
| 11 # (at your option) any later version. | |
| 12 | |
| 13 # This program is distributed in the hope that it will be useful, | |
| 14 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 16 # GNU Affero General Public License for more details. | |
| 17 | |
| 18 # You should have received a copy of the GNU Affero General Public License | |
| 19 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 20 | |
| 21 from sat.core.constants import Const as C | |
|
2137
410e7a940a8b
plugin XEP-0297: used sendMessage in forward, and added comment/warning:
Goffi <goffi@goffi.org>
parents:
2129
diff
changeset
|
22 from sat.core.i18n import _, D_ |
| 1274 | 23 from sat.core.log import getLogger |
| 24 log = getLogger(__name__) | |
| 25 | |
| 26 from wokkel import disco, iwokkel | |
| 27 try: | |
| 28 from twisted.words.protocols.xmlstream import XMPPHandler | |
| 29 except ImportError: | |
| 30 from wokkel.subprotocols import XMPPHandler | |
| 31 from zope.interface import implements | |
| 32 | |
| 33 from twisted.words.xish import domish | |
| 34 | |
|
2099
ad88808591ef
plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents:
1934
diff
changeset
|
35 NS_SF = C.NS_FORWARD |
| 1274 | 36 |
| 37 PLUGIN_INFO = { | |
|
2145
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
38 C.PI_NAME: u"Stanza Forwarding", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
39 C.PI_IMPORT_NAME: u"XEP-0297", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
40 C.PI_TYPE: u"XEP", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
41 C.PI_PROTOCOLS: [u"XEP-0297"], |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
42 C.PI_MAIN: "XEP_0297", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
43 C.PI_HANDLER: u"yes", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
44 C.PI_DESCRIPTION: D_(u"""Implementation of Stanza Forwarding""") |
| 1274 | 45 } |
| 46 | |
| 47 | |
| 48 class XEP_0297(object): | |
|
2137
410e7a940a8b
plugin XEP-0297: used sendMessage in forward, and added comment/warning:
Goffi <goffi@goffi.org>
parents:
2129
diff
changeset
|
49 # FIXME: check this implementation which doesn't seems to be used |
| 1274 | 50 |
| 51 def __init__(self, host): | |
| 52 log.info(_("Stanza Forwarding plugin initialization")) | |
| 53 self.host = host | |
| 54 | |
|
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
2137
diff
changeset
|
55 def getHandler(self, client): |
|
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
2137
diff
changeset
|
56 return XEP_0297_handler(self, client.profile) |
| 1274 | 57 |
| 58 @classmethod | |
| 59 def updateUri(cls, element, uri): | |
| 60 """Update recursively the element URI. | |
| 61 | |
| 62 @param element (domish.Element): element to update | |
| 63 @param uri (unicode): new URI | |
| 64 """ | |
| 65 # XXX: we need this because changing the URI of an existing element | |
| 66 # containing children doesn't update the children's blank URI. | |
| 67 element.uri = uri | |
| 68 element.defaultUri = uri | |
| 69 for child in element.children: | |
| 70 if isinstance(child, domish.Element) and not child.uri: | |
| 71 XEP_0297.updateUri(child, uri) | |
| 72 | |
| 73 def forward(self, stanza, to_jid, stamp, body='', profile_key=C.PROF_KEY_NONE): | |
| 74 """Forward a message to the given JID. | |
| 75 | |
| 76 @param stanza (domish.Element): original stanza to be forwarded. | |
| 77 @param to_jid (JID): recipient JID. | |
| 78 @param stamp (datetime): offset-aware timestamp of the original reception. | |
| 79 @param body (unicode): optional description. | |
| 80 @param profile_key (unicode): %(doc_profile_key)s | |
| 81 @return: a Deferred when the message has been sent | |
| 82 """ | |
|
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
2137
diff
changeset
|
83 # FIXME: this method is not used and doesn't use mess_data which should be used for client.sendMessageData |
|
2137
410e7a940a8b
plugin XEP-0297: used sendMessage in forward, and added comment/warning:
Goffi <goffi@goffi.org>
parents:
2129
diff
changeset
|
84 # should it be deprecated? A method constructing the element without sending it seems more natural |
|
410e7a940a8b
plugin XEP-0297: used sendMessage in forward, and added comment/warning:
Goffi <goffi@goffi.org>
parents:
2129
diff
changeset
|
85 log.warning(u"THIS METHOD IS DEPRECATED") # FIXME: we use this warning until we check the method |
| 1274 | 86 msg = domish.Element((None, 'message')) |
| 87 msg['to'] = to_jid.full() | |
| 88 msg['type'] = stanza['type'] | |
| 89 | |
| 90 body_elt = domish.Element((None, 'body')) | |
| 91 if body: | |
| 92 body_elt.addContent(body) | |
| 93 | |
| 94 forwarded_elt = domish.Element((NS_SF, 'forwarded')) | |
| 95 delay_elt = self.host.plugins['XEP-0203'].delay(stamp) | |
| 96 forwarded_elt.addChild(delay_elt) | |
| 97 if not stanza.uri: # None or '' | |
| 98 XEP_0297.updateUri(stanza, 'jabber:client') | |
| 99 forwarded_elt.addChild(stanza) | |
| 100 | |
| 101 msg.addChild(body_elt) | |
| 102 msg.addChild(forwarded_elt) | |
| 103 | |
| 104 client = self.host.getClient(profile_key) | |
|
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
2137
diff
changeset
|
105 return client.sendMessageData({u'xml': msg}) |
| 1274 | 106 |
| 107 | |
| 108 class XEP_0297_handler(XMPPHandler): | |
| 109 implements(iwokkel.IDisco) | |
| 110 | |
| 111 def __init__(self, plugin_parent, profile): | |
| 112 self.plugin_parent = plugin_parent | |
| 113 self.host = plugin_parent.host | |
| 114 self.profile = profile | |
| 115 | |
| 116 def getDiscoInfo(self, requestor, target, nodeIdentifier=''): | |
| 117 return [disco.DiscoFeature(NS_SF)] | |
| 118 | |
| 119 def getDiscoItems(self, requestor, target, nodeIdentifier=''): | |
| 120 return [] |