libervia-backend: src/plugins/plugin_xep

annotate src/plugins/plugin_xep_0260.py @ 1571:c668081eba1c

plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport

author	Goffi <goffi@goffi.org>
date	Sun, 08 Nov 2015 14:48:04 +0100
parents	37d4be4a9fed
children	25906c0dbc63

rev	line source
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	3
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	4 # SAT plugin for Jingle (XEP-0260)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jérôme Poisson (goffi@goffi.org)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	6
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	11
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	16
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	19
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	20 from sat.core.i18n import _
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	21 from sat.core.log import getLogger
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	22 log = getLogger(__name__)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	23 from sat.core import exceptions
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	24 from wokkel import disco, iwokkel
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	25 from zope.interface import implements
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	26 from twisted.words.xish import domish
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	27 from twisted.words.protocols.jabber import jid
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	28 from twisted.internet import defer
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	29 import uuid
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	30
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	31 try:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	32 from twisted.words.protocols.xmlstream import XMPPHandler
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	33 except ImportError:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	34 from wokkel.subprotocols import XMPPHandler
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	35
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	36
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	37 NS_JINGLE_S5B = 'urn:xmpp:jingle:transports:s5b:1'
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	38
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	39 PLUGIN_INFO = {
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	40 "name": "Jingle SOCKS5 Bytestreams",
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	41 "import_name": "XEP-0260",
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	42 "type": "XEP",
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	43 "protocols": ["XEP-0260"],
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	44 "dependencies": ["XEP-0166", "XEP-0065"],
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	45 "main": "XEP_0260",
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	46 "handler": "yes",
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	47 "description": _("""Implementation of Jingle SOCKS5 Bytestreams""")
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	48 }
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	49
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	50
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	51 class ProxyError(Exception):
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	52 pass
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	53
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	54
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	55 class XEP_0260(object):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	56 # TODO: udp handling
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	57
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	58 def __init__(self, host):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	59 log.info(_("plugin Jingle SOCKS5 Bytestreams"))
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	60 self.host = host
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	61 self._j = host.plugins["XEP-0166"] # shortcut to access jingle
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	62 self._s5b = host.plugins["XEP-0065"] # and socks5 bytestream
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	63 self._j.registerTransport(NS_JINGLE_S5B, self._j.TRANSPORT_STREAMING, self, 100)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	64
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	65 def getHandler(self, profile):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	66 return XEP_0260_handler()
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	67
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	68 def _parseCandidates(self, transport_elt):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	69 """Parse <candidate> elements
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	70
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	71 @param transport_elt(domish.Element): parent <transport> element
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	72 @return (list[plugin_xep_0065.Candidate): list of parsed candidates
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	73 """
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	74 candidates = []
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	75 for candidate_elt in transport_elt.elements(NS_JINGLE_S5B, 'candidate'):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	76 try:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	77 cid = candidate_elt['cid']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	78 host = candidate_elt['host']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	79 jid_= jid.JID(candidate_elt['jid'])
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	80 port = int(candidate_elt.getAttribute('port', 1080))
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	81 priority = int(candidate_elt['priority'])
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	82 type_ = candidate_elt.getAttribute('type', self._s5b.TYPE_DIRECT)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	83 except (KeyError, ValueError):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	84 raise exceptions.DataError()
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	85 candidate = self._s5b.Candidate(host, port, type_, priority, jid_, cid)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	86 candidates.append(candidate)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	87 # self._s5b.registerCandidate(candidate)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	88 return candidates
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	89
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	90 def _buildCandidates(self, session, candidates, sid, session_hash, client, mode=None):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	91 """Build <transport> element with candidates
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	92
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	93 @param session(dict): jingle session data
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	94 @param candidates(iterator[plugin_xep_0065.Candidate]): iterator of candidates to add
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	95 @param sid(unicode): transport stream id
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	96 @param client: %(doc_client)s
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	97 @param mode(str, None): 'tcp' or 'udp', or None to have no attribute
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	98 @return (domish.Element): parent <transport> element where <candidate> elements must be added
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	99 """
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	100 proxy = next((candidate for candidate in candidates if candidate.type == self._s5b.TYPE_PROXY), None)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	101 transport_elt = domish.Element((NS_JINGLE_S5B, "transport"))
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	102 transport_elt['sid'] = sid
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	103 if proxy is not None:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	104 transport_elt['dstaddr'] = session_hash
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	105 if mode is not None:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	106 transport_elt['mode'] = 'tcp' # XXX: we only manage tcp for now
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	107
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	108 for candidate in candidates:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	109 log.debug(u"Adding candidate: {}".format(candidate))
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	110 candidate_elt = transport_elt.addElement('candidate', NS_JINGLE_S5B)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	111 if candidate.id is None:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	112 candidate.id = unicode(uuid.uuid4())
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	113 candidate_elt['cid'] = candidate.id
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	114 candidate_elt['host'] = candidate.host
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	115 candidate_elt['jid'] = candidate.jid.full()
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	116 candidate_elt['port'] = unicode(candidate.port)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	117 candidate_elt['priority'] = unicode(candidate.priority)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	118 candidate_elt['type'] = candidate.type
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	119 return transport_elt
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	120
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	121 @defer.inlineCallbacks
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	122 def jingleSessionInit(self, session, content_name, profile):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	123 client = self.host.getClient(profile)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	124 content_data = session['contents'][content_name]
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	125 transport_data = content_data['transport_data']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	126 sid = transport_data['sid'] = unicode(uuid.uuid4())
1567 268fda4236ca plugins XE0166, XEP-0234, XEP-0260, XEP-0261: renamed session key managing other peer's jid to "peer_jid" instead of "to_jid" Goffi <goffi@goffi.org> parents: 1560 diff changeset	127 session_hash = transport_data['session_hash'] = self._s5b.getSessionHash(client.jid, session['peer_jid'], sid)
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	128 candidates = transport_data['candidates'] = yield self._s5b.getCandidates(profile)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	129 mode = 'tcp' # XXX: we only manage tcp for now
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	130 transport_elt = self._buildCandidates(session, candidates, sid, session_hash, client, mode)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	131
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	132 defer.returnValue(transport_elt)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	133
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	134 def _proxyActivatedCb(self, iq_result_elt, candidate, session, content_name, profile):
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	135 """Called when activation confirmation has been received from proxy
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	136
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	137 cf XEP-0260 § 2.4
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	138 """
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	139 # now that the proxy is activated, we have to inform other peer
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	140 iq_elt, transport_elt = self._j.buildAction(self._j.A_TRANSPORT_INFO, session, content_name, profile)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	141 activated_elt = transport_elt.addElement('activated')
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	142 activated_elt['cid'] = candidate.id
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	143 iq_elt.send
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	144
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	145 def _proxyActivatedEb(self, stanza_error, candidate, session, content_name, profile):
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	146 """Called when activation error has been received from proxy
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	147
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	148 cf XEP-0260 § 2.4
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	149 """
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	150 # TODO: fallback to IBB
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	151 # now that the proxy is activated, we have to inform other peer
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	152 iq_elt, transport_elt = self._j.buildAction(self._j.A_TRANSPORT_INFO, session, content_name, profile)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	153 transport_elt.addElement('proxy-error')
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	154 iq_elt.send
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	155 return stanza_error
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	156
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	157 def _foundPeerCandidate(self, candidate, session, transport_data, content_name, client):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	158 """Called when the best candidate from other peer is found
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	159
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	160 @param candidate(XEP_0065.Candidate, None): selected candidate,
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	161 or None if no candidate is accessible
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	162 @param session(dict): session data
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	163 @param transport_data(dict): transport data
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	164 @param content_name(unicode): name of the current content
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	165 @param client(unicode): %(doc_client)s
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	166 """
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	167
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	168 transport_data['best_candidate'] = candidate
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	169 # we need to disconnect all non selected candidates before removing them
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	170 for c in transport_data['peer_candidates']:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	171 if c is None or c is candidate:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	172 continue
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	173 c.discard()
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	174 del transport_data['peer_candidates']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	175 iq_elt, transport_elt = self._j.buildAction(self._j.A_TRANSPORT_INFO, session, content_name, client.profile)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	176 if candidate is None:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	177 log.warning(u"Can't connect to any peer candidate")
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	178 candidate_elt = transport_elt.addElement('candidate-error')
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	179 else:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	180 log.info(u"Found best peer candidate: {}".format(unicode(candidate)))
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	181 candidate_elt = transport_elt.addElement('candidate-used')
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	182 candidate_elt['cid'] = candidate.id
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	183 iq_elt.send() # TODO: check result stanza
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	184 self._checkCandidates(session, content_name, transport_data, client)
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	185
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	186 def _checkCandidates(self, session, content_name, transport_data, client):
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	187 """Called when a candidate has been choosed
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	188
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	189 if we have both candidates, we select one, or fallback to an other transport
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	190 @param session(dict): session data
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	191 @param content_name(unicode): name of the current content
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	192 @param transport_data(dict): transport data
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	193 @param client(unicode): %(doc_client)s
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	194 """
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	195 content_data = session['contents'][content_name]
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	196 try:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	197 best_candidate = transport_data['best_candidate']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	198 except KeyError:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	199 # we have not our best candidate yet
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	200 return
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	201 try:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	202 peer_best_candidate = transport_data['peer_best_candidate']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	203 except KeyError:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	204 # we have not peer best candidate yet
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	205 return
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	206
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	207 # at this point we have both candidates, it's time to choose one
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	208 if best_candidate is None or peer_best_candidate is None:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	209 choosed_candidate = best_candidate or peer_best_candidate
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	210 else:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	211 if best_candidate.priority == peer_best_candidate.priority:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	212 # same priority, we choose initiator one according to XEP-0260 §2.4 #4
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	213 log.debug(u"Candidates have same priority, we choose the initiator one")
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	214 if session['initiator'] == client.jid:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	215 choosed_candidate = best_candidate
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	216 else:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	217 choosed_candidate = peer_best_candidate
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	218 else:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	219 choosed_candidate = max(best_candidate, peer_best_candidate, key=lambda c:c.priority)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	220
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	221 if choosed_candidate is None:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	222 log.warning(u"Socks5 negociation failed, we need to fallback to IBB")
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	223 else:
1571 c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	224 if choosed_candidate == peer_best_candidate:
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	225 # peer_best_candidate was choosed from the candidates we have sent
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	226 # so our_candidate is true if choosed_candidate is peer_best_candidate
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	227 our_candidate = True
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	228 # than also mean that best_candidate must be discarded !
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	229 try:
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	230 best_candidate.discard()
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	231 except AttributeError: # but it can be None
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	232 pass
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	233 else:
c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	234 our_candidate = False
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	235
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	236 log.info(u"Socks5 negociation successful, {who} candidate will be used: {candidate}".format(
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	237 who = u'our' if our_candidate else u'other peer',
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	238 candidate = choosed_candidate))
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	239 del transport_data['best_candidate']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	240 del transport_data['peer_best_candidate']
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	241
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	242 if choosed_candidate.type == self._s5b.TYPE_PROXY:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	243 # the file transfer need to wait for proxy activation
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	244 # (see XEP-0260 § 2.4)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	245 if our_candidate:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	246 d = self._s5b.connectCandidate(choosed_candidate, transport_data['session_hash'], profile=client.profile)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	247 d.addCallback(lambda dummy: choosed_candidate.activate(transport_data['sid'], session['peer_jid'], client))
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	248 args = [choosed_candidate, session, content_name, client.profile]
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	249 d.addCallbacks(self._proxyActivatedCb, self._proxyActivatedEb, args, None, args)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	250 else:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	251 # this Deferred will be called when we'll receive activation confirmation from other peer
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	252 d = transport_data['activation_d'] = defer.Deferred()
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	253 else:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	254 d = defer.succeed(None)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	255
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	256 if content_data['senders'] == session['role']:
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	257 # we can now start the file transfer (or start it after proxy activation)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	258 d.addCallback(lambda dummy: choosed_candidate.startTransfer(transport_data['session_hash']))
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	259
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	260 def _candidateInfo(self, candidate_elt, session, content_name, transport_data, client):
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	261 """Called when best candidate has been received from peer (or if none is working)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	262
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	263 @param candidate_elt(domish.Element): candidate-used or candidate-error element
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	264 (see XEP-0260 §2.3)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	265 @param session(dict): session data
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	266 @param content_name(unicode): name of the current content
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	267 @param transport_data(dict): transport data
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	268 @param client(unicode): %(doc_client)s
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	269 """
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	270 if candidate_elt.name == 'candidate-error':
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	271 # candidate-error, no candidate worked
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	272 transport_data['peer_best_candidate'] = None
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	273 else:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	274 # candidate-used, one candidate was choosed
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	275 try:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	276 cid = candidate_elt.attributes['cid']
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	277 except KeyError:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	278 log.warning(u"No cid found in <candidate-used>")
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	279 raise exceptions.DataError
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	280 try:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	281 candidate = (c for c in transport_data['candidates'] if c.id == cid).next()
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	282 except StopIteration:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	283 log.warning(u"Given cid doesn't correspond to any known candidate !")
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	284 raise exceptions.DataError # TODO: send an error to other peer, and use better exception
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	285 except KeyError:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	286 # a transport-info can also be intentionaly sent too early by other peer
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	287 # but there is little probability
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	288 log.error(u'"candidates" key doesn\'t exists in transport_data, it should at this point')
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	289 raise exceptions.InternalError
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	290 # at this point we have the candidate choosed by other peer
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	291 transport_data['peer_best_candidate'] = candidate
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	292 log.info(u"Other peer best candidate: {}".format(candidate))
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	293
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	294 del transport_data['candidates']
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	295 self._checkCandidates(session, content_name, transport_data, client)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	296
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	297 def _proxyActivationInfo(self, proxy_elt, session, content_name, transport_data, client):
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	298 """Called when proxy has been activated (or has sent an error)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	299
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	300 @param proxy_elt(domish.Element): <activated/> or <proxy-error/> element
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	301 (see XEP-0260 §2.4)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	302 @param session(dict): session data
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	303 @param content_name(unicode): name of the current content
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	304 @param transport_data(dict): transport data
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	305 @param client(unicode): %(doc_client)s
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	306 """
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	307 try:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	308 activation_d = transport_data.pop('activation_d')
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	309 except KeyError:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	310 log.warning(u"Received unexpected transport-info for proxy activation")
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	311
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	312 if proxy_elt.name == 'activated':
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	313 activation_d.callback(None)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	314 else:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	315 activation_d.errback(ProxyError)
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	316
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	317 @defer.inlineCallbacks
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	318 def jingleHandler(self, action, session, content_name, transport_elt, profile):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	319 client = self.host.getClient(profile)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	320 content_data = session['contents'][content_name]
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	321 transport_data = content_data['transport_data']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	322
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	323 if action in (self._j.A_ACCEPTED_ACK,):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	324 pass
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	325
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	326 elif action == self._j.A_SESSION_ACCEPT:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	327 # initiator side, we select a candidate in the ones sent by responder
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	328 assert 'peer_candidates' not in transport_data
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	329 transport_data['peer_candidates'] = self._parseCandidates(transport_elt)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	330
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	331 # elif action == self._j.A_START:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	332 elif action == self._j.A_START:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	333 session_hash = transport_data['session_hash']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	334 peer_candidates = transport_data['peer_candidates']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	335 file_obj = content_data['file_obj']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	336 stream_d = self._s5b.registerHash(session_hash, file_obj, profile)
1571 c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	337 stream_d.chainDeferred(content_data['finished_d'])
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	338 d = self._s5b.getBestCandidate(peer_candidates, session_hash, profile)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	339 d.addCallback(self._foundPeerCandidate, session, transport_data, content_name, client)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	340
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	341 elif action == self._j.A_SESSION_INITIATE:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	342 # responder side, we select a candidate in the ones sent by initiator
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	343 # and we give our candidates
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	344 assert 'peer_candidates' not in transport_data
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	345 sid = transport_data['sid'] = transport_elt['sid']
1567 268fda4236ca plugins XE0166, XEP-0234, XEP-0260, XEP-0261: renamed session key managing other peer's jid to "peer_jid" instead of "to_jid" Goffi <goffi@goffi.org> parents: 1560 diff changeset	346 session_hash = transport_data['session_hash'] = self._s5b.getSessionHash(session['peer_jid'], client.jid, sid)
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	347 peer_candidates = transport_data['peer_candidates'] = self._parseCandidates(transport_elt)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	348 file_obj = content_data['file_obj']
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	349 stream_d = self._s5b.registerHash(session_hash, file_obj, profile)
1571 c668081eba1c plugins XEP-0234, XEP-0260, XEP-0261: jingle session termination is managed by application (XEP-0234) instead of transport Goffi <goffi@goffi.org> parents: 1570 diff changeset	350 stream_d.chainDeferred(content_data['finished_d'])
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	351 d = self._s5b.getBestCandidate(peer_candidates, session_hash, profile)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	352 d.addCallback(self._foundPeerCandidate, session, transport_data, content_name, client)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	353 candidates = yield self._s5b.getCandidates(profile)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	354 # we remove duplicate candidates
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	355 candidates = [candidate for candidate in candidates if candidate not in peer_candidates]
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	356
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	357 transport_data['candidates'] = candidates
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	358 # we can now build a new <transport> element with our candidates
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	359 transport_elt = self._buildCandidates(session, candidates, sid, session_hash, client)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	360
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	361 elif action == self._j.A_TRANSPORT_INFO:
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	362 # transport-info can be about candidate or proxy activation
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	363 candidate_elt = None
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	364
1570 37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	365 for method, names in ((self._candidateInfo, ('candidate-used', 'candidate-error')),
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	366 (self._proxyActivationInfo, ('activated', 'proxy-error'))):
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	367 for name in names:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	368 try:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	369 candidate_elt = transport_elt.elements(NS_JINGLE_S5B, name).next()
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	370 except StopIteration:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	371 continue
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	372 else:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	373 method(candidate_elt, session, content_name, transport_data, client)
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	374 break
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	375
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	376 if candidate_elt is None:
37d4be4a9fed plugins XEP-0260, XEP-0065: proxy handling: Goffi <goffi@goffi.org> parents: 1567 diff changeset	377 log.warning(u"Unexpected transport element: {}".format(transport_elt.toXml()))
1560 dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	378
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	379 else:
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	380 log.warning(u"FIXME: unmanaged action {}".format(action))
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	381
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	382 defer.returnValue(transport_elt)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	383
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	384
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	385 class XEP_0260_handler(XMPPHandler):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	386 implements(iwokkel.IDisco)
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	387
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	388 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	389 return [disco.DiscoFeature(NS_JINGLE_S5B)]
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	390
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	391 def getDiscoItems(self, requestor, target, nodeIdentifier=''):
dcce63810733 plugin XEP-0260: first draft Goffi <goffi@goffi.org> parents: diff changeset	392 return []

Mercurial > libervia-backend

annotate src/plugins/plugin_xep_0260.py @ 1571:c668081eba1c