libervia-backend/sat/plugins/plugin_xep_0297.py
Goffi fbfe96c505 Python 3 port:
/!\ this is a huge commit
/!\ starting from this commit, SàT is needs Python 3.6+
/!\ SàT maybe be instable or some feature may not work anymore, this will improve with time

This patch port backend, bridge and frontends to Python 3.

Roughly this has been done this way:

- 2to3 tools has been applied (with python 3.7)
- all references to python2 have been replaced with python3 (notably shebangs)
- fixed files not handled by 2to3 (notably the shell script)
- several manual fixes
- fixed issues reported by Python 3 that where not handled in Python 2
- replaced "async" with "async_" when needed (it's a reserved word from Python 3.7)
- replaced zope's "implements" with @implementer decorator
- temporary hack to handle data pickled in database, as str or bytes may be returned,
  to be checked later
- fixed hash comparison for password
- removed some code which is not needed anymore with Python 3
- deactivated some code which needs to be checked (notably certificate validation)
- tested with jp, fixed reported issues until some basic commands worked
- ported Primitivus (after porting dependencies like urwid satext)
- more manual fixes
2019-08-13 19:08:41 +02:00

122 lines
4.3 KiB
Python
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# SAT plugin for Stanza Forwarding (XEP-0297)
# Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
# Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org)
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from sat.core.constants import Const as C
from sat.core.i18n import _, D_
from sat.core.log import getLogger
log = getLogger(__name__)
from wokkel import disco, iwokkel
try:
from twisted.words.protocols.xmlstream import XMPPHandler
except ImportError:
from wokkel.subprotocols import XMPPHandler
from zope.interface import implementer
from twisted.words.xish import domish
PLUGIN_INFO = {
C.PI_NAME: "Stanza Forwarding",
C.PI_IMPORT_NAME: "XEP-0297",
C.PI_TYPE: "XEP",
C.PI_PROTOCOLS: ["XEP-0297"],
C.PI_MAIN: "XEP_0297",
C.PI_HANDLER: "yes",
C.PI_DESCRIPTION: D_("""Implementation of Stanza Forwarding"""),
}
class XEP_0297(object):
# FIXME: check this implementation which doesn't seems to be used
def __init__(self, host):
log.info(_("Stanza Forwarding plugin initialization"))
self.host = host
def getHandler(self, client):
return XEP_0297_handler(self, client.profile)
@classmethod
def updateUri(cls, element, uri):
"""Update recursively the element URI.
@param element (domish.Element): element to update
@param uri (unicode): new URI
"""
# XXX: we need this because changing the URI of an existing element
# containing children doesn't update the children's blank URI.
element.uri = uri
element.defaultUri = uri
for child in element.children:
if isinstance(child, domish.Element) and not child.uri:
XEP_0297.updateUri(child, uri)
def forward(self, stanza, to_jid, stamp, body="", profile_key=C.PROF_KEY_NONE):
"""Forward a message to the given JID.
@param stanza (domish.Element): original stanza to be forwarded.
@param to_jid (JID): recipient JID.
@param stamp (datetime): offset-aware timestamp of the original reception.
@param body (unicode): optional description.
@param profile_key (unicode): %(doc_profile_key)s
@return: a Deferred when the message has been sent
"""
# FIXME: this method is not used and doesn't use mess_data which should be used for client.sendMessageData
# should it be deprecated? A method constructing the element without sending it seems more natural
log.warning(
"THIS METHOD IS DEPRECATED"
) #  FIXME: we use this warning until we check the method
msg = domish.Element((None, "message"))
msg["to"] = to_jid.full()
msg["type"] = stanza["type"]
body_elt = domish.Element((None, "body"))
if body:
body_elt.addContent(body)
forwarded_elt = domish.Element((C.NS_FORWARD, "forwarded"))
delay_elt = self.host.plugins["XEP-0203"].delay(stamp)
forwarded_elt.addChild(delay_elt)
if not stanza.uri: # None or ''
XEP_0297.updateUri(stanza, "jabber:client")
forwarded_elt.addChild(stanza)
msg.addChild(body_elt)
msg.addChild(forwarded_elt)
client = self.host.getClient(profile_key)
return client.sendMessageData({"xml": msg})
@implementer(iwokkel.IDisco)
class XEP_0297_handler(XMPPHandler):
def __init__(self, plugin_parent, profile):
self.plugin_parent = plugin_parent
self.host = plugin_parent.host
self.profile = profile
def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
return [disco.DiscoFeature(C.NS_FORWARD)]
def getDiscoItems(self, requestor, target, nodeIdentifier=""):
return []