comparison src/plugins/plugin_xep_0261.py @ 1527:bfef1934a8f3

plugin XEP-0261: jingle in-band bystream first draft
author Goffi <goffi@goffi.org>
date Fri, 25 Sep 2015 19:19:12 +0200
parents
children cbfbe028d099
comparison
equal deleted inserted replaced
1526:bb451fd1cea3 1527:bfef1934a8f3
1 #!/usr/bin/python
2 # -*- coding: utf-8 -*-
3
4 # SAT plugin for Jingle (XEP-0261)
5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jérôme Poisson (goffi@goffi.org)
6
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
16
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 from sat.core.i18n import _
21 from sat.core.log import getLogger
22 log = getLogger(__name__)
23 from wokkel import disco, iwokkel
24 from zope.interface import implements
25 from twisted.words.xish import domish
26 import uuid
27
28 try:
29 from twisted.words.protocols.xmlstream import XMPPHandler
30 except ImportError:
31 from wokkel.subprotocols import XMPPHandler
32
33
34 NS_JINGLE_IBB = 'urn:xmpp:jingle:transports:ibb:1'
35
36 PLUGIN_INFO = {
37 "name": "Jingle In-Band Bytestreams",
38 "import_name": "XEP-0261",
39 "type": "XEP",
40 "protocols": ["XEP-0261"],
41 "dependencies": ["XEP-0166", "XEP-0047"],
42 "main": "XEP_0261",
43 "handler": "yes",
44 "description": _("""Implementation of Jingle In-Band Bytestreams""")
45 }
46
47
48 class XEP_0261(object):
49
50 def __init__(self, host):
51 log.info(_("plugin Jingle In-Band Bytestreams"))
52 self.host = host
53 self._j = host.plugins["XEP-0166"] # shortcut to access jingle
54 self._ibb = host.plugins["XEP-0047"] # and in-band bytestream
55 self._j.registerTransport(NS_JINGLE_IBB, self._j.TRANSPORT_STREAMING, self, -10000) # must be the lowest priority
56
57 def getHandler(self, profile):
58 return XEP_0261_handler()
59
60 def jingleSessionInit(self, session, content_name, profile):
61 transport_elt = domish.Element((NS_JINGLE_IBB, "transport"))
62 content_data = session['contents'][content_name]
63 content_data['ibb_block_size'] = self._ibb.BLOCK_SIZE
64 transport_elt['block-size'] = unicode(content_data['ibb_block_size'])
65 transport_elt['sid'] = content_data['ibb_sid'] = unicode(uuid.uuid4())
66 return transport_elt
67
68 def jingleHandler(self, action, session, content_name, transport_elt, profile):
69 content_data = session['contents'][content_name]
70 if action in (self._j.A_SESSION_ACCEPT, self._j.A_ACCEPTED_ACK):
71 pass
72 elif action == self._j.A_SESSION_INITIATE:
73 content_data['ibb_sid'] = transport_elt['sid']
74 elif action in (self._j.A_START, self._j.A_PREPARE_RESPONDER):
75 to_jid = session['to_jid']
76 sid = content_data['ibb_sid']
77 file_obj = content_data['file_obj']
78 args = [session, content_name, profile]
79 if action == self._j.A_START:
80 block_size = content_data['ibb_block_size']
81 d = self._ibb.startStream(file_obj, to_jid, sid, block_size, profile)
82 d.addErrback(self._streamEb, *args)
83 else:
84 d = self._ibb.createSession(file_obj, to_jid, sid, profile)
85 d.addCallbacks(self._streamCb, self._streamEb, args, None, args)
86 else:
87 log.warning(u"FIXME: unmanaged action {}".format(action))
88 return transport_elt
89
90 def _streamCb(self, dummy, session, content_name, profile):
91 self._j.contentTerminate(session, content_name, profile=profile)
92
93 def _streamEb(self, failure, session, content_name, profile):
94 log.warning(u"Error while streaming in-band: {}".format(failure))
95 self._j.contentTerminate(session, content_name, reason=self._j.REASON_FAILED_TRANSPORT, profile=profile)
96
97 class XEP_0261_handler(XMPPHandler):
98 implements(iwokkel.IDisco)
99
100 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
101 return [disco.DiscoFeature(NS_JINGLE_IBB)]
102
103 def getDiscoItems(self, requestor, target, nodeIdentifier=''):
104 return []