97337202cb
- SàT can now handle components
- plugin have now a "modes" key in PLUGIN_INFO where they declare if they can be used with clients and or components. They default to be client only.
- components are really similar to clients, but with some changes in behaviour:
* component has "entry point", which is a special plugin with a componentStart method, which is called just after component is connected
* trigger end with a different suffixes (e.g. profileConnected vs profileConnectedComponent), so a plugin which manage both clients and components can have different workflow
* for clients, only triggers of plugins handling client mode are launched
* for components, only triggers of plugins needed in dependencies are launched. They all must handle component mode.
* component have a sendHistory attribute (False by default) which can be set to True to allow saving sent messages into history
* for convenience, "client" is still used in method even if it can now be a component
* a new "component" boolean attribute tells if we have a component or a client
* components have to add themselve Message protocol
* roster and presence protocols are not added for components
* component default port is 5347 (which is Prosody's default port)
- asyncCreateProfile has been renamed for profileCreate, both to follow new naming convention and to prepare the transition to fully asynchronous bridge
- createProfile has a new "component" attribute. When used to create a component, it must be set to a component entry point
- jp: added --component argument to profile/create
- disconnect bridge method is now asynchronous, this way frontends can know when disconnection is finished
- new PI_* constants for PLUGIN_INFO values (not used everywhere yet)
- client/component connection workflow has been moved to their classes instead of being a host methods
- host.messageSend is now client.sendMessage, and former client.sendMessage is now client.sendMessageData.
- identities are now handled in client.identities list, so it can be updated dynamically by plugins (in the future, frontends should be able to update them too through bridge)
- profileConnecting* profileConnected* profileDisconnected* and getHandler now all use client instead of profile
120 lines
4.3 KiB
Python
120 lines
4.3 KiB
Python
#!/usr/bin/env python2
|
||
# -*- coding: utf-8 -*-
|
||
|
||
# SAT plugin for Stanza Forwarding (XEP-0297)
|
||
# Copyright (C) 2009-2016 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 implements
|
||
|
||
from twisted.words.xish import domish
|
||
|
||
NS_SF = C.NS_FORWARD
|
||
|
||
PLUGIN_INFO = {
|
||
u"name": u"Stanza Forwarding",
|
||
u"import_name": u"XEP-0297",
|
||
u"type": u"XEP",
|
||
u"protocols": [u"XEP-0297"],
|
||
u"main": "XEP_0297",
|
||
u"handler": u"yes",
|
||
u"description": D_(u"""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(u"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((NS_SF, '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({u'xml': msg})
|
||
|
||
|
||
class XEP_0297_handler(XMPPHandler):
|
||
implements(iwokkel.IDisco)
|
||
|
||
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(NS_SF)]
|
||
|
||
def getDiscoItems(self, requestor, target, nodeIdentifier=''):
|
||
return []
|