libervia-backend: src/plugins/plugin_xep

comparison src/plugins/plugin_xep_0047.py @ 1524:7b0fcefd52d4

plugin XEP-0047, XEP-0096: In-Band Bystream plugin cleaning: - some renaming, comments improvments, etc - progress callback is no more managed here, as it will be managed by application - no more file data is used, beside file_obj - a proper Deferred is used instead of success and error callbacks - more clean error sending method plugin XEP-0096 has been updated to handle changes. Its temporarily partially broken though

author	Goffi <goffi@goffi.org>
date	Fri, 25 Sep 2015 19:19:12 +0200
parents	3265a2639182
children	6a8dd91476f0

comparison

equal deleted inserted replaced

-:0209f8d35873
+:7b0fcefd52d4
 # 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 twisted.words.protocols.jabber import client as jabber_client, jid
+from sat.core import exceptions
-from twisted.words.xish import domish
+from twisted.words.protocols.jabber import client as jabber_client
+from twisted.words.protocols.jabber import jid
+from twisted.words.protocols.jabber import xmlstream
+from twisted.words.protocols.jabber import error
 from twisted.internet import reactor
+from twisted.internet import defer
+from twisted.python import failure
 from wokkel import disco, iwokkel
 from zope.interface import implements
 MESSAGE = '/message'
 IQ_SET = '/iq[@type="set"]'
 NS_IBB = 'http://jabber.org/protocol/ibb'
 IBB_OPEN = IQ_SET + '/open[@xmlns="' + NS_IBB + '"]'
-IBB_CLOSE = IQ_SET + '/close[@xmlns="' + NS_IBB + '" and @sid="%s"]'
+IBB_CLOSE = IQ_SET + '/close[@xmlns="' + NS_IBB + '" and @sid="{}"]'
-IBB_IQ_DATA = IQ_SET + '/data[@xmlns="' + NS_IBB + '" and @sid="%s"]'
+IBB_IQ_DATA = IQ_SET + '/data[@xmlns="' + NS_IBB + '" and @sid="{}"]'
-IBB_MESSAGE_DATA = MESSAGE + '/data[@xmlns="' + NS_IBB + '" and @sid="%s"]'
+IBB_MESSAGE_DATA = MESSAGE + '/data[@xmlns="' + NS_IBB + '" and @sid="{}"]'
 TIMEOUT = 60  # timeout for workflow
-BLOCK_SIZE = 4096
+DEFER_KEY = 'finished' # key of the deferred used to track session end
 PLUGIN_INFO = {
 "name": "In-Band Bytestream Plugin",
 "import_name": "XEP-0047",
 "type": "XEP",
 }
 class XEP_0047(object):
 NAMESPACE = NS_IBB
+BLOCK_SIZE = 4096
 def __init__(self, host):
 log.info(_("In-Band Bytestreams plugin initialization"))
 self.host = host
 def profileConnected(self, profile):
 client = self.host.getClient(profile)
 client.xep_0047_current_stream = {}  # key: stream_id, value: data(dict)
-def _timeOut(self, sid, profile):
+def _timeOut(self, sid, client):
-"""Delecte current_stream id, called after timeout
+"""Delete current_stream id, called after timeout
-@param id: id of client.xep_0047_current_stream"""
-log.info(_("In-Band Bytestream: TimeOut reached for id %(sid)s [%(profile)s]")
+@param sid(unicode): session id of client.xep_0047_current_stream
-% {"sid": sid, "profile": profile})
+@param client: %(doc_client)s
-self._killId(sid, False, "TIMEOUT", profile)
+"""
+log.info(_("In-Band Bytestream: TimeOut reached for id {sid} [{profile}]")
-def _killId(self, sid, success=False, failure_reason="UNKNOWN", profile=None):
+.format(sid=sid, profile=client.profile))
-"""Delete an current_stream id, clean up associated observers
+self._killSession(sid, client, "TIMEOUT")
-@param sid: id of client.xep_0047_current_stream"""
-assert(profile)
+def _killSession(self, sid, client, failure_reason=None):
-client = self.host.getClient(profile)
+"""Delete a current_stream id, clean up associated observers
-if sid not in client.xep_0047_current_stream:
+@param sid(unicode): session id
+@param client: %(doc_client)s
+@param failure_reason(None, unicode): if None the session is successful
+else, will be used to call failure_cb
+"""
+try:
+session = client.xep_0047_current_stream[sid]
+except KeyError:
 log.warning(_("kill id called on a non existant id"))
 return
-if "observer_cb" in client.xep_0047_current_stream[sid]:
-client.xmlstream.removeObserver(client.xep_0047_current_stream[sid]["event_data"], client.xep_0047_current_stream[sid]["observer_cb"])
+try:
-if client.xep_0047_current_stream[sid]['timer'].active():
+observer_cb = session['observer_cb']
-client.xep_0047_current_stream[sid]['timer'].cancel()
+except KeyError:
-if "size" in client.xep_0047_current_stream[sid]:
+pass
-self.host.removeProgressCB(sid, profile)
+else:
+client.xmlstream.removeObserver(session["event_data"], observer_cb)
-file_obj = client.xep_0047_current_stream[sid]['file_obj']
-success_cb = client.xep_0047_current_stream[sid]['success_cb']
+if session['timer'].active():
-failure_cb = client.xep_0047_current_stream[sid]['failure_cb']
+session['timer'].cancel()
 del client.xep_0047_current_stream[sid]
+success = failure_reason is None
+stream_d = session[DEFER_KEY]
 if success:
-success_cb(sid, file_obj, NS_IBB, profile)
+stream_d.callback(None)
 else:
-failure_cb(sid, file_obj, NS_IBB, failure_reason, profile)
+stream_d.errback(failure.Failure(exceptions.DataError(failure_reason)))
-def getProgress(self, sid, data, profile):
+def createSession(self, *args, **kwargs):
-"""Fill data with position of current transfer"""
+"""like [_createSession] but return the session deferred instead of the whole session
-client = self.host.getClient(profile)
-try:
+session deferred is fired when transfer is finished
-file_obj = client.xep_0047_current_stream[sid]["file_obj"]
+"""
-data["position"] = str(file_obj.tell())
+return self._createSession(*args, **kwargs)[DEFER_KEY]
-data["size"] = str(client.xep_0047_current_stream[sid]["size"])
-except:
+def _createSession(self, file_obj, to_jid, sid, profile):
-pass
-def prepareToReceive(self, from_jid, sid, file_obj, size, success_cb, failure_cb, profile):
 """Called when a bytestream is imminent
-@param from_jid: jid of the sender
-@param sid: Stream id
+@param file_obj(file): File object where data will be written
-@param file_obj: File object where data will be written
+@param to_jid(jid.JId): jid of the other peer
-@param size: full size of the data, or None if unknown
+@param sid(unicode): session id
-@param success_cb: method to call when successfuly finished
+@param profile: %(doc_profile)s
-@param failure_cb: method to call when something goes wrong
+@return (dict): session data
-@param profile: %(doc_profile)s"""
+"""
 client = self.host.getClient(profile)
-data = client.xep_0047_current_stream[sid] = {}
+if sid in client.xep_0047_current_stream:
-data["from"] = from_jid
+raise exceptions.ConflictError(u'A session with this id already exists !')
-data["file_obj"] = file_obj
+session_data = client.xep_0047_current_stream[sid] = \
-data["seq"] = -1
+{'id': sid,
-if size:
+DEFER_KEY: defer.Deferred(),
-data["size"] = size
+'to': to_jid,
-self.host.registerProgressCB(sid, self.getProgress, profile)
+'file_obj': file_obj,
-data["timer"] = reactor.callLater(TIMEOUT, self._timeOut, sid)
+'seq': -1,
-data["success_cb"] = success_cb
+'timer': reactor.callLater(TIMEOUT, self._timeOut, sid, client),
-data["failure_cb"] = failure_cb
+}
-def streamOpening(self, IQ, profile):
+return session_data
-log.debug(_("IBB stream opening"))
-IQ.handled = True
+def _onIBBOpen(self, iq_elt, profile):
-client = self.host.getClient(profile)
+""""Called when an IBB <open> element is received
-open_elt = IQ.firstChildElement()
+@param iq_elt(domish.Element): the whole <iq> stanza
+@param profile: %(doc_profile)s
+"""
+log.debug(_(u"IBB stream opening"))
+iq_elt.handled = True
+client = self.host.getClient(profile)
+open_elt = iq_elt.elements(NS_IBB, 'open').next()
 block_size = open_elt.getAttribute('block-size')
 sid = open_elt.getAttribute('sid')
 stanza = open_elt.getAttribute('stanza', 'iq')
 if not sid or not block_size or int(block_size) > 65535:
-log.warning(_(u"malformed IBB transfer: %s" % IQ['id']))
+return self._sendError('not-acceptable', sid or None, iq_elt, client)
-self.sendNotAcceptableError(IQ['id'], IQ['from'], client.xmlstream)
-return
 if not sid in client.xep_0047_current_stream:
 log.warning(_(u"Ignoring unexpected IBB transfer: %s" % sid))
-self.sendNotAcceptableError(IQ['id'], IQ['from'], client.xmlstream)
+return self._sendError('not-acceptable', sid or None, iq_elt, client)
-return
+session_data = client.xep_0047_current_stream[sid]
-if client.xep_0047_current_stream[sid]["from"] != jid.JID(IQ['from']):
+if session_data["to"] != jid.JID(iq_elt['from']):
 log.warning(_("sended jid inconsistency (man in the middle attack attempt ?)"))
-self.sendNotAcceptableError(IQ['id'], IQ['from'], client.xmlstream)
+return self._sendError('not-acceptable', sid, iq_elt, client)
-self._killId(sid, False, "PROTOCOL_ERROR", profile=profile)
-return
+# at this stage, the session looks ok and will be accepted
-#at this stage, the session looks ok and will be accepted
+# we reset the timeout:
+session_data["timer"].reset(TIMEOUT)
-#we reset the timeout:
-client.xep_0047_current_stream[sid]["timer"].reset(TIMEOUT)
+# we save the xmlstream, events and observer data to allow observer removal
+session_data["event_data"] = event_data = (IBB_MESSAGE_DATA if stanza == 'message' else IBB_IQ_DATA).format(sid)
-#we save the xmlstream, events and observer data to allow observer removal
+session_data["observer_cb"] = observer_cb = self._onIBBData
-client.xep_0047_current_stream[sid]["event_data"] = event_data = (IBB_MESSAGE_DATA if stanza == 'message' else IBB_IQ_DATA) % sid
+event_close = IBB_CLOSE.format(sid)
-client.xep_0047_current_stream[sid]["observer_cb"] = observer_cb = self.messageData if stanza == 'message' else self.iqData
+# we now set the stream observer to look after data packet
-event_close = IBB_CLOSE % sid
+# FIXME: if we never get the events, the observers stay.
-#we now set the stream observer to look after data packet
+#        would be better to have generic observer and check id once triggered
 client.xmlstream.addObserver(event_data, observer_cb, profile=profile)
-client.xmlstream.addOnetimeObserver(event_close, self.streamClosing, profile=profile)
+client.xmlstream.addOnetimeObserver(event_close, self._onIBBClose, profile=profile)
-#finally, we send the accept stanza
+# finally, we send the accept stanza
-result = domish.Element((None, 'iq'))
+iq_result_elt = xmlstream.toResponse(iq_elt, 'result')
-result['type'] = 'result'
+client.xmlstream.send(iq_result_elt)
-result['id'] = IQ['id']
-result['to'] = IQ['from']
+def _onIBBClose(self, iq_elt, profile):
-client.xmlstream.send(result)
+""""Called when an IBB <close> element is received
-def streamClosing(self, IQ, profile):
+@param iq_elt(domish.Element): the whole <iq> stanza
-IQ.handled = True
+@param profile: %(doc_profile)s
+"""
+iq_elt.handled = True
 client = self.host.getClient(profile)
 log.debug(_("IBB stream closing"))
-data_elt = IQ.firstChildElement()
+close_elt = iq_elt.elements(NS_IBB, 'close').next()
-sid = data_elt.getAttribute('sid')
+# XXX: this observer is only triggered on valid sid, so we don't need to check it
-result = domish.Element((None, 'iq'))
+sid = close_elt['sid']
-result['type'] = 'result'
-result['id'] = IQ['id']
+iq_result_elt = xmlstream.toResponse(iq_elt, 'result')
-result['to'] = IQ['from']
+client.xmlstream.send(iq_result_elt)
-client.xmlstream.send(result)
+self._killSession(sid, client)
-self._killId(sid, success=True, profile=profile)
+def _onIBBData(self, element, profile):
-def iqData(self, IQ, profile):
+"""Observer called on <iq> or <message> stanzas with data element
-IQ.handled = True
-client = self.host.getClient(profile)
+Manage the data elelement (check validity and write to the file_obj)
-data_elt = IQ.firstChildElement()
+@param element(domish.Element): <iq> or <message> stanza
+@param profile: %(doc_profile)s
-if self._manageDataElt(data_elt, 'iq', IQ['id'], jid.JID(IQ['from']), profile):
+"""
-#and send a success answer
+element.handled = True
-result = domish.Element((None, 'iq'))
+client = self.host.getClient(profile)
-result['type'] = 'result'
+data_elt = element.elements(NS_IBB, 'data').next()
-result['id'] = IQ['id']
+sid = data_elt['sid']
-result['to'] = IQ['from']
+try:
-client.xmlstream.send(result)
+session_data = client.xep_0047_current_stream[sid]
+except KeyError:
-def messageData(self, message_elt, profile):
+log.warning(_(u"Received data for an unknown session id"))
-sid = message_elt.getAttribute('id', '')
+return self._sendError('item-not-found', None, element, client)
-self._manageDataElt(message_elt, 'message', sid, jid.JID(message_elt['from']), profile)
+from_jid = session_data["to"]
-def _manageDataElt(self, data_elt, stanza, sid, stanza_from_jid, profile):
+file_obj = session_data["file_obj"]
-"""Manage the data elelement (check validity and write to the file_obj)
-@param data_elt: "data" domish element
+if from_jid.full() != element['from']:
-@return: True if success"""
+log.warning(_(u"sended jid inconsistency (man in the middle attack attempt ?)\ninitial={initial}\ngiven={given}").format(initial=from_jid, given=element['from']))
-client = self.host.getClient(profile)
+if element.name == 'iq':
-sid = data_elt.getAttribute('sid')
+self._sendError('not-acceptable', sid, element, client)
-if sid not in client.xep_0047_current_stream:
+return
-log.error(_("Received data for an unknown session id"))
-return False
+session_data["seq"] = (session_data["seq"] + 1) % 65535
+if int(data_elt.getAttribute("seq", -1)) != session_data["seq"]:
-from_jid = client.xep_0047_current_stream[sid]["from"]
+log.warning(_(u"Sequence error"))
-file_obj = client.xep_0047_current_stream[sid]["file_obj"]
+if element.name == 'iq':
+reason = 'not-acceptable'
-if stanza_from_jid != from_jid:
+self._sendError(reason, sid, element, client)
-log.warning(_("sended jid inconsistency (man in the middle attack attempt ?)"))
+self.terminateStream(session_data, client, reason)
-if stanza == 'iq':
+return
-self.sendNotAcceptableError(sid, from_jid, client.xmlstream)
-return False
+# we reset the timeout:
+session_data["timer"].reset(TIMEOUT)
-client.xep_0047_current_stream[sid]["seq"] += 1
-if int(data_elt.getAttribute("seq", -1)) != client.xep_0047_current_stream[sid]["seq"]:
+# we can now decode the data
-log.warning(_("Sequence error"))
-if stanza == 'iq':
-self.sendNotAcceptableError(data_elt["id"], from_jid, client.xmlstream)
-return False
-#we reset the timeout:
-client.xep_0047_current_stream[sid]["timer"].reset(TIMEOUT)
-#we can now decode the data
 try:
 file_obj.write(base64.b64decode(str(data_elt)))
 except TypeError:
-#The base64 data is invalid
+# The base64 data is invalid
-log.warning(_("Invalid base64 data"))
+log.warning(_(u"Invalid base64 data"))
-if stanza == 'iq':
+if element.name == 'iq':
-self.sendNotAcceptableError(data_elt["id"], from_jid, client.xmlstream)
+self._sendError('not-acceptable', sid, element, client)
-return False
+self.terminateStream(session_data, client, reason)
-return True
+return
-def sendNotAcceptableError(self, iq_id, to_jid, xmlstream):
+# we can now ack success
-"""Not acceptable error used when the stream is not expected or something is going wrong
+if element.name == 'iq':
-@param iq_id: IQ id
+iq_result_elt = xmlstream.toResponse(element, 'result')
-@param to_jid: addressee
+client.xmlstream.send(iq_result_elt)
-@param xmlstream: XML stream to use to send the error"""
-result = domish.Element((None, 'iq'))
+def _sendError(self, error_condition, sid, iq_elt, client):
-result['type'] = 'result'
+"""Send error stanza
-result['id'] = iq_id
-result['to'] = to_jid
+@param error_condition: one of twisted.words.protocols.jabber.error.STANZA_CONDITIONS keys
-error_el = result.addElement('error')
+@param sid(unicode,None): jingle session id, or None, if session must not be destroyed
-error_el['type'] = 'cancel'
+@param iq_elt(domish.Element): full <iq> stanza
-error_el.addElement(('urn:ietf:params:xml:ns:xmpp-stanzas', 'not-acceptable'))
+@param client: %(doc_client)s
-xmlstream.send(result)
+"""
+iq_elt = error.StanzaError(error_condition).toResponse(iq_elt)
-def startStream(self, file_obj, to_jid, sid, length, successCb, failureCb, size=None, profile=None):
+log.warning(u"Error while managing in-band bytestream session, cancelling: {}".format(error_condition))
+if sid is not None:
+self._killSession(sid, client, error_condition)
+client.xmlstream.send(iq_elt)
+def startStream(self, file_obj, to_jid, sid, block_size=None, profile=None):
 """Launch the stream workflow
-@param file_obj: file_obj to send
-@param to_jid: JID of the recipient
+@param file_obj(file): file_obj to send
-@param sid: Stream session id
+@param to_jid(jid.JID): JID of the recipient
-@param length: number of byte to send, or None to send until the end
+@param sid(unicode): Stream session id
-@param successCb: method to call when stream successfuly finished
+@param block_size(int, None): size of the block (or None for default)
-@param failureCb: method to call when something goes wrong
+@param profile: %(doc_profile)s
-@param profile: %(doc_profile)s"""
+"""
-client = self.host.getClient(profile)
+session_data = self._createSession(file_obj, to_jid, sid, profile)
-if length is not None:
+session_defer = session_data[DEFER_KEY]
-log.error(_('stream length not managed yet'))
+client = self.host.getClient(profile)
-return
-data = client.xep_0047_current_stream[sid] = {}
+if block_size is None:
-data["timer"] = reactor.callLater(TIMEOUT, self._timeOut, sid)
+block_size = XEP_0047.BLOCK_SIZE
-data["file_obj"] = file_obj
+assert block_size <= 65535
-data["to"] = to_jid
+session_data["block_size"] = block_size
-data["success_cb"] = successCb
-data["failure_cb"] = failureCb
-data["block_size"] = BLOCK_SIZE
-if size:
-data["size"] = size
-self.host.registerProgressCB(sid, self.getProgress, profile)
 iq_elt = jabber_client.IQ(client.xmlstream, 'set')
 iq_elt['from'] = client.jid.full()
 iq_elt['to'] = to_jid.full()
 open_elt = iq_elt.addElement('open', NS_IBB)
-open_elt['block-size'] = str(BLOCK_SIZE)
+open_elt['block-size'] = str(block_size)
 open_elt['sid'] = sid
-open_elt['stanza'] = 'iq'
+open_elt['stanza'] = 'iq' # TODO: manage <message> stanza ?
-iq_elt.addCallback(self.iqResult, sid, 0, length, profile)
+iq_elt.addCallback(self._IQDataStream, session_data, client)
 iq_elt.send()
+return session_defer
-def iqResult(self, sid, seq, length, profile, iq_elt):
-"""Called when the result of open iq is received"""
+def _IQDataStream(self, session_data, client, iq_elt):
-client = self.host.getClient(profile)
+"""Called during the whole data streaming
-data = client.xep_0047_current_stream[sid]
-if iq_elt["type"] == "error":
+@param session_data(dict): data of this streaming session
-log.warning(_("Transfer failed"))
+@param client: %(doc_client)s
-self.terminateStream(sid, "IQ_ERROR")
+@param iq_elt(domish.Element): iq result
-return
+"""
+if iq_elt['type'] == 'error':
-if data['timer'].active():
+log.warning(_(u"IBB transfer failed: {}").format(iq_elt))
-data['timer'].cancel()
+self.terminateStream(session_data, client, "IQ_ERROR")
+return
-buffer = data["file_obj"].read(data["block_size"])
-if buffer:
+session_data["timer"].reset(TIMEOUT)
+buffer_ = session_data["file_obj"].read(session_data["block_size"])
+if buffer_:
 next_iq_elt = jabber_client.IQ(client.xmlstream, 'set')
-next_iq_elt['to'] = data["to"].full()
+next_iq_elt['to'] = session_data["to"].full()
 data_elt = next_iq_elt.addElement('data', NS_IBB)
-data_elt['seq'] = str(seq)
+seq = session_data['seq'] = (session_data['seq'] + 1) % 65535
-data_elt['sid'] = sid
+data_elt['seq'] = unicode(seq)
-data_elt.addContent(base64.b64encode(buffer))
+data_elt['sid'] = session_data['id']
-next_iq_elt.addCallback(self.iqResult, sid, seq + 1, length, profile)
+data_elt.addContent(base64.b64encode(buffer_))
+next_iq_elt.addCallback(self._IQDataStream, session_data, client)
 next_iq_elt.send()
 else:
-self.terminateStream(sid, profile=profile)
+self.terminateStream(session_data, client)
-def terminateStream(self, sid, failure_reason=None, profile=None):
+def terminateStream(self, session_data, client, failure_reason=None):
 """Terminate the stream session
-@param to_jid: recipient
-@param sid: Session id
+@param session_data(dict): data of this streaming session
-@param file_obj: file object used
+@param client: %(doc_client)s
-@param xmlstream: XML stream used with this session
+@param failure_reason(unicode, None): reason of the failure, or None if steam was successful
-@param progress_cb: True if we have to remove the progress callback
+"""
-@param callback: method to call after finishing
-@param failure_reason: reason of the failure, or None if steam was successful"""
-client = self.host.getClient(profile)
-data = client.xep_0047_current_stream[sid]
 iq_elt = jabber_client.IQ(client.xmlstream, 'set')
-iq_elt['to'] = data["to"].full()
+iq_elt['to'] = session_data["to"].full()
 close_elt = iq_elt.addElement('close', NS_IBB)
-close_elt['sid'] = sid
+close_elt['sid'] = session_data['id']
 iq_elt.send()
-self.host.removeProgressCB(sid, profile)
+self._killSession(session_data['id'], client, failure_reason)
-if failure_reason:
-self._killId(sid, False, failure_reason, profile=profile)
-else:
-self._killId(sid, True, profile=profile)
 class XEP_0047_handler(XMPPHandler):
 implements(iwokkel.IDisco)
 def __init__(self, parent):
 self.plugin_parent = parent
 def connectionInitialized(self):
-self.xmlstream.addObserver(IBB_OPEN, self.plugin_parent.streamOpening, profile=self.parent.profile)
+self.xmlstream.addObserver(IBB_OPEN, self.plugin_parent._onIBBOpen, profile=self.parent.profile)
 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
 return [disco.DiscoFeature(NS_IBB)]
 def getDiscoItems(self, requestor, target, nodeIdentifier=''):

Mercurial > libervia-backend

comparison src/plugins/plugin_xep_0047.py @ 1524:7b0fcefd52d4