plugin XEP-0261: jingle in-band bystream first draft

src/plugins/plugin_xep_0261.py

@@ -0,0 +1,104 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# SAT plugin for Jingle (XEP-0261)
+# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jérôme Poisson (goffi@goffi.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.i18n import _
+from sat.core.log import getLogger
+log = getLogger(__name__)
+from wokkel import disco, iwokkel
+from zope.interface import implements
+from twisted.words.xish import domish
+import uuid
+
+try:
+    from twisted.words.protocols.xmlstream import XMPPHandler
+except ImportError:
+    from wokkel.subprotocols import XMPPHandler
+
+
+NS_JINGLE_IBB = 'urn:xmpp:jingle:transports:ibb:1'
+
+PLUGIN_INFO = {
+    "name": "Jingle In-Band Bytestreams",
+    "import_name": "XEP-0261",
+    "type": "XEP",
+    "protocols": ["XEP-0261"],
+    "dependencies": ["XEP-0166", "XEP-0047"],
+    "main": "XEP_0261",
+    "handler": "yes",
+    "description": _("""Implementation of Jingle In-Band Bytestreams""")
+}
+
+
+class XEP_0261(object):
+
+    def __init__(self, host):
+        log.info(_("plugin Jingle In-Band Bytestreams"))
+        self.host = host
+        self._j = host.plugins["XEP-0166"] # shortcut to access jingle
+        self._ibb = host.plugins["XEP-0047"] # and in-band bytestream
+        self._j.registerTransport(NS_JINGLE_IBB, self._j.TRANSPORT_STREAMING, self, -10000) # must be the lowest priority
+
+    def getHandler(self, profile):
+        return XEP_0261_handler()
+
+    def jingleSessionInit(self, session, content_name, profile):
+        transport_elt = domish.Element((NS_JINGLE_IBB, "transport"))
+        content_data = session['contents'][content_name]
+        content_data['ibb_block_size'] = self._ibb.BLOCK_SIZE
+        transport_elt['block-size'] = unicode(content_data['ibb_block_size'])
+        transport_elt['sid'] = content_data['ibb_sid'] = unicode(uuid.uuid4())
+        return transport_elt
+
+    def jingleHandler(self, action, session, content_name, transport_elt, profile):
+        content_data = session['contents'][content_name]
+        if action in (self._j.A_SESSION_ACCEPT, self._j.A_ACCEPTED_ACK):
+            pass
+        elif action == self._j.A_SESSION_INITIATE:
+            content_data['ibb_sid'] = transport_elt['sid']
+        elif action in (self._j.A_START, self._j.A_PREPARE_RESPONDER):
+            to_jid = session['to_jid']
+            sid = content_data['ibb_sid']
+            file_obj = content_data['file_obj']
+            args = [session, content_name, profile]
+            if action == self._j.A_START:
+                block_size = content_data['ibb_block_size']
+                d = self._ibb.startStream(file_obj, to_jid, sid, block_size, profile)
+                d.addErrback(self._streamEb, *args)
+            else:
+                d = self._ibb.createSession(file_obj, to_jid, sid, profile)
+                d.addCallbacks(self._streamCb, self._streamEb, args, None, args)
+        else:
+            log.warning(u"FIXME: unmanaged action {}".format(action))
+        return transport_elt
+
+    def _streamCb(self, dummy, session, content_name, profile):
+        self._j.contentTerminate(session, content_name, profile=profile)
+
+    def _streamEb(self, failure, session, content_name, profile):
+        log.warning(u"Error while streaming in-band: {}".format(failure))
+        self._j.contentTerminate(session, content_name, reason=self._j.REASON_FAILED_TRANSPORT, profile=profile)
+
+class XEP_0261_handler(XMPPHandler):
+    implements(iwokkel.IDisco)
+
+    def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
+        return [disco.DiscoFeature(NS_JINGLE_IBB)]
+
+    def getDiscoItems(self, requestor, target, nodeIdentifier=''):
+        return []