Mercurial > libervia-backend
annotate sat/plugins/plugin_xep_0297.py @ 4037:524856bd7b19
massive refactoring to switch from camelCase to snake_case:
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.
However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.
To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.
This is a massive change, and may result in some bugs.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 08 Apr 2023 13:54:42 +0200 |
| parents | 944f51f9c2b4 |
| children |
| 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 |
|
3913
944f51f9c2b4
core (xmpp): make `send` a blocking method, fix `sendMessageData` calls:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
25 from twisted.internet import defer |
|
944f51f9c2b4
core (xmpp): make `send` a blocking method, fix `sendMessageData` calls:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
26 |
| 1274 | 27 log = getLogger(__name__) |
| 28 | |
| 29 from wokkel import disco, iwokkel | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
30 |
| 1274 | 31 try: |
| 32 from twisted.words.protocols.xmlstream import XMPPHandler | |
| 33 except ImportError: | |
| 34 from wokkel.subprotocols import XMPPHandler | |
| 3028 | 35 from zope.interface import implementer |
| 1274 | 36 |
| 37 from twisted.words.xish import domish | |
| 38 | |
| 39 PLUGIN_INFO = { | |
| 3028 | 40 C.PI_NAME: "Stanza Forwarding", |
| 41 C.PI_IMPORT_NAME: "XEP-0297", | |
| 42 C.PI_TYPE: "XEP", | |
| 43 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
|
44 C.PI_MAIN: "XEP_0297", |
| 3028 | 45 C.PI_HANDLER: "yes", |
| 46 C.PI_DESCRIPTION: D_("""Implementation of Stanza Forwarding"""), | |
| 1274 | 47 } |
| 48 | |
| 49 | |
| 50 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
|
51 # FIXME: check this implementation which doesn't seems to be used |
| 1274 | 52 |
| 53 def __init__(self, host): | |
| 3028 | 54 log.info(_("Stanza Forwarding plugin initialization")) |
| 1274 | 55 self.host = host |
| 56 | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3913
diff
changeset
|
57 def get_handler(self, client): |
|
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
2137
diff
changeset
|
58 return XEP_0297_handler(self, client.profile) |
| 1274 | 59 |
| 60 @classmethod | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3913
diff
changeset
|
61 def update_uri(cls, element, uri): |
| 1274 | 62 """Update recursively the element URI. |
| 63 | |
| 64 @param element (domish.Element): element to update | |
| 65 @param uri (unicode): new URI | |
| 66 """ | |
| 67 # XXX: we need this because changing the URI of an existing element | |
| 68 # containing children doesn't update the children's blank URI. | |
| 69 element.uri = uri | |
| 70 element.defaultUri = uri | |
| 71 for child in element.children: | |
| 72 if isinstance(child, domish.Element) and not child.uri: | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3913
diff
changeset
|
73 XEP_0297.update_uri(child, uri) |
| 1274 | 74 |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
75 def forward(self, stanza, to_jid, stamp, body="", profile_key=C.PROF_KEY_NONE): |
| 1274 | 76 """Forward a message to the given JID. |
| 77 | |
| 78 @param stanza (domish.Element): original stanza to be forwarded. | |
| 79 @param to_jid (JID): recipient JID. | |
| 80 @param stamp (datetime): offset-aware timestamp of the original reception. | |
| 81 @param body (unicode): optional description. | |
| 82 @param profile_key (unicode): %(doc_profile_key)s | |
| 83 @return: a Deferred when the message has been sent | |
| 84 """ | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3913
diff
changeset
|
85 # FIXME: this method is not used and doesn't use mess_data which should be used for client.send_message_data |
|
2137
410e7a940a8b
plugin XEP-0297: used sendMessage in forward, and added comment/warning:
Goffi <goffi@goffi.org>
parents:
2129
diff
changeset
|
86 # 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
|
87 log.warning( |
| 3028 | 88 "THIS METHOD IS DEPRECATED" |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
89 ) # FIXME: we use this warning until we check the method |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
90 msg = domish.Element((None, "message")) |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
91 msg["to"] = to_jid.full() |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
92 msg["type"] = stanza["type"] |
| 1274 | 93 |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
94 body_elt = domish.Element((None, "body")) |
| 1274 | 95 if body: |
| 96 body_elt.addContent(body) | |
| 97 | |
| 2698 | 98 forwarded_elt = domish.Element((C.NS_FORWARD, "forwarded")) |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
99 delay_elt = self.host.plugins["XEP-0203"].delay(stamp) |
| 1274 | 100 forwarded_elt.addChild(delay_elt) |
| 101 if not stanza.uri: # None or '' | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3913
diff
changeset
|
102 XEP_0297.update_uri(stanza, "jabber:client") |
| 1274 | 103 forwarded_elt.addChild(stanza) |
| 104 | |
| 105 msg.addChild(body_elt) | |
| 106 msg.addChild(forwarded_elt) | |
| 107 | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3913
diff
changeset
|
108 client = self.host.get_client(profile_key) |
|
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3913
diff
changeset
|
109 return defer.ensureDeferred(client.send_message_data({"xml": msg})) |
| 1274 | 110 |
| 111 | |
| 3028 | 112 @implementer(iwokkel.IDisco) |
| 1274 | 113 class XEP_0297_handler(XMPPHandler): |
| 114 | |
| 115 def __init__(self, plugin_parent, profile): | |
| 116 self.plugin_parent = plugin_parent | |
| 117 self.host = plugin_parent.host | |
| 118 self.profile = profile | |
| 119 | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
120 def getDiscoInfo(self, requestor, target, nodeIdentifier=""): |
| 2698 | 121 return [disco.DiscoFeature(C.NS_FORWARD)] |
| 1274 | 122 |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
123 def getDiscoItems(self, requestor, target, nodeIdentifier=""): |
| 1274 | 124 return [] |