Mercurial > libervia-backend
annotate sat/plugins/plugin_xep_0297.py @ 3908:d43b197735d1
tests (unit/AP gateway): add tests for events:
rel 372
author | Goffi <goffi@goffi.org> |
---|---|
date | Thu, 22 Sep 2022 00:01:48 +0200 |
parents | be6d91572633 |
children | 944f51f9c2b4 |
rev | line source |
---|---|
3028 | 1 #!/usr/bin/env python3 |
3137 | 2 |
1274 | 3 |
4 # SAT plugin for Stanza Forwarding (XEP-0297) | |
3479 | 5 # Copyright (C) 2009-2021 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 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
24 |
1274 | 25 log = getLogger(__name__) |
26 | |
27 from wokkel import disco, iwokkel | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
28 |
1274 | 29 try: |
30 from twisted.words.protocols.xmlstream import XMPPHandler | |
31 except ImportError: | |
32 from wokkel.subprotocols import XMPPHandler | |
3028 | 33 from zope.interface import implementer |
1274 | 34 |
35 from twisted.words.xish import domish | |
36 | |
37 PLUGIN_INFO = { | |
3028 | 38 C.PI_NAME: "Stanza Forwarding", |
39 C.PI_IMPORT_NAME: "XEP-0297", | |
40 C.PI_TYPE: "XEP", | |
41 C.PI_PROTOCOLS: ["XEP-0297"], | |
2145
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", |
3028 | 43 C.PI_HANDLER: "yes", |
44 C.PI_DESCRIPTION: D_("""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): | |
3028 | 52 log.info(_("Stanza Forwarding plugin initialization")) |
1274 | 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 | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
73 def forward(self, stanza, to_jid, stamp, body="", profile_key=C.PROF_KEY_NONE): |
1274 | 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 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
85 log.warning( |
3028 | 86 "THIS METHOD IS DEPRECATED" |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
87 ) # FIXME: we use this warning until we check the method |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
88 msg = domish.Element((None, "message")) |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
89 msg["to"] = to_jid.full() |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
90 msg["type"] = stanza["type"] |
1274 | 91 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
92 body_elt = domish.Element((None, "body")) |
1274 | 93 if body: |
94 body_elt.addContent(body) | |
95 | |
2698 | 96 forwarded_elt = domish.Element((C.NS_FORWARD, "forwarded")) |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
97 delay_elt = self.host.plugins["XEP-0203"].delay(stamp) |
1274 | 98 forwarded_elt.addChild(delay_elt) |
99 if not stanza.uri: # None or '' | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
100 XEP_0297.updateUri(stanza, "jabber:client") |
1274 | 101 forwarded_elt.addChild(stanza) |
102 | |
103 msg.addChild(body_elt) | |
104 msg.addChild(forwarded_elt) | |
105 | |
106 client = self.host.getClient(profile_key) | |
3028 | 107 return client.sendMessageData({"xml": msg}) |
1274 | 108 |
109 | |
3028 | 110 @implementer(iwokkel.IDisco) |
1274 | 111 class XEP_0297_handler(XMPPHandler): |
112 | |
113 def __init__(self, plugin_parent, profile): | |
114 self.plugin_parent = plugin_parent | |
115 self.host = plugin_parent.host | |
116 self.profile = profile | |
117 | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
118 def getDiscoInfo(self, requestor, target, nodeIdentifier=""): |
2698 | 119 return [disco.DiscoFeature(C.NS_FORWARD)] |
1274 | 120 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
121 def getDiscoItems(self, requestor, target, nodeIdentifier=""): |
1274 | 122 return [] |