libervia-backend: src/plugins/plugin_exp

annotate src/plugins/plugin_exp_pipe.py @ 1448:227856b13d7a

core: new tools.sat_defer module, and implementation of RTDeferredSessions: The real-time deferred session is a class which manage session of several deferreds at once (pretty much like a DeferredList), with the ability to get intermediate results.

author	Goffi <goffi@goffi.org>
date	Sat, 15 Aug 2015 22:13:27 +0200
parents	3265a2639182
children	697effba0310

rev	line source
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	3
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	4 # SAT plugin for managing pipes (experimental)
1396 069ad98b360d 2015 copyright dates update Goffi <goffi@goffi.org> parents: 993 diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jérôme Poisson (goffi@goffi.org)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	10 # (at your option) any later version.
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	15 # GNU Affero General Public License for more details.
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 594 diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	19
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 609 diff changeset	20 from sat.core.i18n import _
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 811 diff changeset	21 from sat.core.constants import Const as C
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	22 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	23 log = getLogger(__name__)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	24 from twisted.words.xish import domish
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	25 from twisted.words.protocols.jabber import jid
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	26 from twisted.words.protocols import jabber
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	27 from twisted.internet import reactor
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	28
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	29 from wokkel import data_form
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	30
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	31 IQ_SET = '/iq[@type="set"]'
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	32 PROFILE_NAME = "pipe-transfer"
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	33 PROFILE = "http://jabber.org/protocol/si/profile/" + PROFILE_NAME
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	34
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	35 PLUGIN_INFO = {
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	36 "name": "Pipe Plugin",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	37 "import_name": "EXP-PIPE",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	38 "type": "EXP",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	39 "protocols": ["EXP-PIPE"],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	40 "dependencies": ["XEP-0020", "XEP-0095", "XEP-0065", "XEP-0047"],
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	41 "main": "Exp_Pipe",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	42 "handler": "no",
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	43 "description": _("""Implementation of SI Pipe Transfer""")
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	44 }
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	45
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	46
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	47 class Exp_Pipe(object):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	48 """This is a modified version of XEP-0096 to work with named pipes instead of files"""
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	49
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	50 def __init__(self, host):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	51 log.info(_("Plugin Pipe initialization"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	52 self.host = host
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	53 self.managed_stream_m = [self.host.plugins["XEP-0065"].NAMESPACE,
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	54 self.host.plugins["XEP-0047"].NAMESPACE] # Stream methods managed
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	55 self.host.plugins["XEP-0095"].registerSIProfile(PROFILE_NAME, self.transferRequest)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	56 host.bridge.addMethod("pipeOut", ".plugin", in_sign='ssa{ss}s', out_sign='s', method=self.pipeOut)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	57
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	58 def profileConnected(self, profile):
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	59 client = self.host.getClient(profile)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	60 client._pipe_waiting_for_approval = {} # key = id, value = [transfer data, IdelayedCall Reactor timeout,
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	61 # current stream method, [failed stream methods], profile]
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 585 diff changeset	62
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	63 def _kill_id(self, approval_id, profile):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	64 """Delete a waiting_for_approval id, called after timeout
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	65 @param approval_id: id of _pipe_waiting_for_approval"""
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	66 log.info(_("SI Pipe Transfer: TimeOut reached for id %s") % approval_id)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	67 try:
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	68 client = self.host.getClient(profile)
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	69 del client._pipe_waiting_for_approval[approval_id]
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	70 except KeyError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	71 log.warning(_(u"kill id called on a non existant approval id"))
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 585 diff changeset	72
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	73 def transferRequest(self, iq_id, from_jid, si_id, si_mime_type, si_el, profile):
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	74 """Called when a pipe transfer is requested
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	75 @param iq_id: id of the iq request
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	76 @param from_jid: jid of the sender
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	77 @param si_id: Stream Initiation session id
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	78 @param si_mime_type: Mime type of the pipe (or default "application/octet-stream" if unknown)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	79 @param si_el: domish.Element of the request
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	80 @param profile: %(doc_profile)s"""
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	81 log.info(_("EXP-PIPE file transfer requested"))
301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	82 log.debug(si_el.toXml())
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	83 client = self.host.getClient(profile)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	84 pipe_elts = filter(lambda elt: elt.name == 'pipe', si_el.elements())
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	85 feature_elts = self.host.plugins["XEP-0020"].getFeatureElt(si_el)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 585 diff changeset	86
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	87 if not pipe_elts:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	88 log.warning(_(u"No pipe element found"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	89 self.host.plugins["XEP-0095"].sendBadRequestError(iq_id, from_jid, profile)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	90 return
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 585 diff changeset	91
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	92 if feature_elts:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	93 feature_el = feature_elts[0]
941 c6d8fc63b1db core, plugins: host.getClient now raise an exception instead of returning None when no profile is found, plugins have been adapted consequently and a bit cleaned Goffi <goffi@goffi.org> parents: 916 diff changeset	94 data_form.Form.fromElement(feature_el.firstChildElement())
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	95 try:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	96 stream_method = self.host.plugins["XEP-0020"].negociate(feature_el, 'stream-method', self.managed_stream_m)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	97 except KeyError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	98 log.warning(_(u"No stream method found"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	99 self.host.plugins["XEP-0095"].sendBadRequestError(iq_id, from_jid, profile)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	100 return
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	101 if not stream_method:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	102 log.warning(_(u"Can't find a valid stream method"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	103 self.host.plugins["XEP-0095"].sendFailedError(iq_id, from_jid, profile)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	104 return
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	105 else:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	106 log.warning(_(u"No feature element found"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	107 self.host.plugins["XEP-0095"].sendBadRequestError(iq_id, from_jid, profile)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	108 return
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	109
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	110 #if we are here, the transfer can start, we just need user's agreement
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	111 data = {"id": iq_id, "from": from_jid}
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	112 client._pipe_waiting_for_approval[si_id] = [data, reactor.callLater(300, self._kill_id, si_id), stream_method, [], profile]
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	113
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	114 self.host.askConfirmation(si_id, "PIPE_TRANSFER", data, self.confirmationCB, profile)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	115
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	116 def confirmationCB(self, sid, accepted, frontend_data, profile):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	117 """Called on confirmation answer
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	118 @param sid: file transfer session id
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	119 @param accepted: True if file transfer is accepted
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	120 @param frontend_data: data sent by frontend"""
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	121 client = self.host.getClient(profile)
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	122 data, timeout, stream_method, failed_methods, profile = client._pipe_waiting_for_approval[sid]
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	123 if accepted:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	124 if timeout.active():
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	125 timeout.cancel()
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	126 try:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	127 dest_path = frontend_data['dest_path']
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	128 except KeyError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	129 log.error(_(u'dest path not found in frontend_data'))
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	130 del(client._pipe_waiting_for_approval[sid])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	131 return
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	132 if stream_method == self.host.plugins["XEP-0065"].NAMESPACE:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	133 file_obj = open(dest_path, 'w+')
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	134 self.host.plugins["XEP-0065"].prepareToReceive(jid.JID(data['from']), sid, file_obj, None, self._transferSucceeded, self._transferFailed, profile)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	135 elif stream_method == self.host.plugins["XEP-0047"].NAMESPACE:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	136 file_obj = open(dest_path, 'w+')
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	137 self.host.plugins["XEP-0047"].prepareToReceive(jid.JID(data['from']), sid, file_obj, None, self._transferSucceeded, self._transferFailed, profile)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	138 else:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	139 log.error(_(u"Unknown stream method, this should not happen at this stage, cancelling transfer"))
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	140 del(client._pipe_waiting_for_approval[sid])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	141 return
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	142
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	143 #we can send the iq result
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	144 feature_elt = self.host.plugins["XEP-0020"].chooseOption({'stream-method': stream_method})
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	145 misc_elts = []
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	146 misc_elts.append(domish.Element((PROFILE, "file")))
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	147 self.host.plugins["XEP-0095"].acceptStream(data["id"], data['from'], feature_elt, misc_elts, profile)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	148 else:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	149 log.debug(_(u"Transfer [%s] refused"), sid)
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	150 self.host.plugins["XEP-0095"].sendRejectedError(data["id"], data['from'], profile=profile)
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	151 del(client._pipe_waiting_for_approval[sid])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	152
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	153 def _transferSucceeded(self, sid, file_obj, stream_method, profile):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	154 """Called by the stream method when transfer successfuly finished
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	155 @param id: stream id"""
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	156 client = self.host.getClient(profile)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	157 file_obj.close()
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	158 log.info(_('Transfer %s successfuly finished') % sid)
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	159 del(client._pipe_waiting_for_approval[sid])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	160
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	161 def _transferFailed(self, sid, file_obj, stream_method, reason, profile):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	162 """Called when something went wrong with the transfer
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	163 @param id: stream id
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	164 @param reason: can be TIMEOUT, IO_ERROR, PROTOCOL_ERROR"""
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	165 client = self.host.getClient(profile)
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	166 data, timeout, stream_method, failed_methods, profile = client._pipe_waiting_for_approval[sid]
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	167 log.warning(_(u'Transfer %(id)s failed with stream method %(s_method)s') % {'id': sid,
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	168 's_method': stream_method})
941 c6d8fc63b1db core, plugins: host.getClient now raise an exception instead of returning None when no profile is found, plugins have been adapted consequently and a bit cleaned Goffi <goffi@goffi.org> parents: 916 diff changeset	169 # filepath = file_obj.name
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	170 file_obj.close()
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	171 #TODO: session remenber (within a time limit) when a stream method fail, and avoid that stream method with full jid for the rest of the session
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	172 log.warning(_(u"All stream methods failed, can't transfer the file"))
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	173 del(client._pipe_waiting_for_approval[sid])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	174
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	175 def pipeCb(self, filepath, sid, profile, IQ):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	176 if IQ['type'] == "error":
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	177 stanza_err = jabber.error.exceptionFromStanza(IQ)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	178 if stanza_err.code == '403' and stanza_err.condition == 'forbidden':
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	179 log.debug(_(u"Pipe transfer refused by %s") % IQ['from'])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	180 self.host.bridge.newAlert(_("The contact %s refused your pipe stream") % IQ['from'], _("Pipe stream refused"), "INFO", profile)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	181 else:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	182 log.warning(_(u"Error during pipe stream transfer with %s") % IQ['from'])
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	183 self.host.bridge.newAlert(_("Something went wrong during the pipe stream session intialisation with %s") % IQ['from'], _("Pipe stream error"), "ERROR", profile)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	184 return
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	185
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	186 si_elt = IQ.firstChildElement()
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	187
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	188 if IQ['type'] != "result" or not si_elt or si_elt.name != "si":
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	189 log.error(_(u"Protocol error during file transfer"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	190 return
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	191
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	192 feature_elts = self.host.plugins["XEP-0020"].getFeatureElt(si_elt)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	193 if not feature_elts:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	194 log.warning(_(u"No feature element"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	195 return
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 585 diff changeset	196
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	197 choosed_options = self.host.plugins["XEP-0020"].getChoosedOptions(feature_elts[0])
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	198 try:
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	199 stream_method = choosed_options["stream-method"]
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	200 except KeyError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	201 log.warning(_(u"No stream method choosed"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	202 return
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	203
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	204 if stream_method == self.host.plugins["XEP-0065"].NAMESPACE:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	205 #fd = os.open(filepath, os.O_RDONLY \| os.O_NONBLOCK) #XXX: non blocking openingl cause issues with XEP-0065's FileSender
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	206 #file_obj = os.fdopen(fd, 'r')
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	207 file_obj = open(filepath, 'r') # XXX: we have to be sure that filepath is well opened, as reading can block it
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	208 self.host.plugins["XEP-0065"].startStream(file_obj, jid.JID(IQ['from']), sid, None, self.sendSuccessCb, self.sendFailureCb, None, profile)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	209 elif stream_method == self.host.plugins["XEP-0047"].NAMESPACE:
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	210 #fd = os.open(filepath, os.O_RDONLY \| os.O_NONBLOCK) #XXX: non blocking openingl cause issues with XEP-0065's FileSender
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	211 #file_obj = os.fdopen(fd, 'r')
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	212 file_obj = open(filepath, 'r') # XXX: we have to be sure that filepath is well opened, as reading can block it
e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	213 self.host.plugins["XEP-0047"].startStream(file_obj, jid.JID(IQ['from']), sid, None, self.sendSuccessCb, self.sendFailureCb, None, profile)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	214 else:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	215 log.warning(_(u"Invalid stream method received"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	216
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 811 diff changeset	217 def pipeOut(self, to_jid, filepath, data={}, profile_key=C.PROF_KEY_NONE):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	218 """send a file using EXP-PIPE
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	219 @to_jid: recipient
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	220 @filepath: absolute path to the named pipe to send
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	221 @data: dictionnary with the optional data
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	222 @param profile_key: %(doc_profile_key)s
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	223 @return: an unique id to identify the transfer
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	224 """
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	225 profile = self.host.memory.getProfileName(profile_key)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	226 if not profile:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	227 log.warning(_(u"Trying to send a file from an unknown profile"))
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	228 return ""
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	229 feature_elt = self.host.plugins["XEP-0020"].proposeFeatures({'stream-method': self.managed_stream_m})
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 585 diff changeset	230
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	231 pipe_transfer_elts = []
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 585 diff changeset	232
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	233 pipe_elt = domish.Element((PROFILE, 'pipe'))
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	234 pipe_transfer_elts.append(pipe_elt)
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	235
594 e629371a28d3 Fix pep8 support in src/plugins. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	236 sid, offer = self.host.plugins["XEP-0095"].proposeStream(jid.JID(to_jid), PROFILE, feature_elt, pipe_transfer_elts, profile_key=profile)
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	237 offer.addCallback(self.pipeCb, filepath, sid, profile)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	238 return sid
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	239
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	240 def sendSuccessCb(self, sid, file_obj, stream_method, profile):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 941 diff changeset	241 log.info(_('Transfer %s successfuly finished') % sid)
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	242 file_obj.close()
b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	243
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 480 diff changeset	244 def sendFailureCb(self, sid, file_obj, stream_method, reason, profile):
401 b2caa2615c4c jp roster name manegement + Pipe transfer Goffi <goffi@goffi.org> parents: diff changeset	245 file_obj.close()
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	246 log.warning(_(u'Transfer %(id)s failed with stream method %(s_method)s %(profile)s') % {'id': sid, "s_method": stream_method, "profile": profile})

Mercurial > libervia-backend

annotate src/plugins/plugin_exp_pipe.py @ 1448:227856b13d7a