libervia-backend: sat/plugins/plugin_xep

annotate sat/plugins/plugin_xep_0234.py @ 3791:c61233f51b86

plugin XEP-0060: do not raise an error when not subscribed on unsubscribe: when an error is received on unsubscribe because user was not subscribed, a warning is logged, but no exception is raised anymore, as the expected result is reached.

author	Goffi <goffi@goffi.org>
date	Fri, 17 Jun 2022 14:15:23 +0200
parents	bbf92ef05f38
children	3ef988734869

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3136 diff changeset	2
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	3 # SàT plugin for Jingle File Transfer (XEP-0234)
3479 be6d91572633 date update Goffi <goffi@goffi.org> parents: 3434 diff changeset	4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	5
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	6 # This program is free software: you can redistribute it and/or modify
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	9 # (at your option) any later version.
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	10
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	11 # This program is distributed in the hope that it will be useful,
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	14 # GNU Affero General Public License for more details.
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	15
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	16 # You should have received a copy of the GNU Affero General Public License
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	18
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	19 import os.path
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	20 import mimetypes
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	21 from collections import namedtuple
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	22 from zope.interface import implementer
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	23 from twisted.words.xish import domish
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	24 from twisted.words.protocols.jabber import jid
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	25 from twisted.python import failure
1566 ec3848916ee8 plugin ip: implemented XEP-0279 for external ip retrieval + fixed bad exception handling Goffi <goffi@goffi.org> parents: 1557 diff changeset	26 from twisted.words.protocols.jabber.xmlstream import XMPPHandler
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: 1568 diff changeset	27 from twisted.internet import defer
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	28 from twisted.internet import reactor
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	29 from twisted.internet import error as internet_error
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	30 from wokkel import disco, iwokkel
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	31 from sat.core.i18n import _, D_
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	32 from sat.core.constants import Const as C
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	33 from sat.core.log import getLogger
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	34 from sat.core import exceptions
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	35 from sat.tools import utils
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	36 from sat.tools import stream
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	37 from sat.tools.common import date_utils
2535 a19b2c43e719 plugin XEP-0234: fixed regex import Goffi <goffi@goffi.org> parents: 2512 diff changeset	38 from sat.tools.common import regex
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	39
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	40
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	41 log = getLogger(__name__)
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	42
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	43 NS_JINGLE_FT = "urn:xmpp:jingle:apps:file-transfer:5"
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	44
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	45 PLUGIN_INFO = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	46 C.PI_NAME: "Jingle File Transfer",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	47 C.PI_IMPORT_NAME: "XEP-0234",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	48 C.PI_TYPE: "XEP",
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	49 C.PI_MODES: C.PLUG_MODE_BOTH,
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	50 C.PI_PROTOCOLS: ["XEP-0234"],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	51 C.PI_DEPENDENCIES: ["XEP-0166", "XEP-0300", "FILE"],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	52 C.PI_MAIN: "XEP_0234",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	53 C.PI_HANDLER: "yes",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	54 C.PI_DESCRIPTION: _("""Implementation of Jingle File Transfer"""),
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	55 }
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	56
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	57 EXTRA_ALLOWED = {"path", "namespace", "file_desc", "file_hash", "hash_algo"}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	58 Range = namedtuple("Range", ("offset", "length"))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	59
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	60
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	61 class XEP_0234:
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: 1568 diff changeset	62 # TODO: assure everything is closed when file is sent or session terminate is received
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	63 # TODO: call self._f.unregister when unloading order will be managing (i.e. when
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	64 # dependencies will be unloaded at the end)
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	65 Range = Range # we copy the class here, so it can be used by other plugins
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	66 name = PLUGIN_INFO[C.PI_NAME]
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	67 human_name = D_("file transfer")
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	68
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	69 def __init__(self, host):
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	70 log.info(_("plugin Jingle File Transfer initialization"))
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	71 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	72 host.registerNamespace("jingle-ft", NS_JINGLE_FT)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	73 self._j = host.plugins["XEP-0166"] # shortcut to access jingle
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	74 self._j.registerApplication(NS_JINGLE_FT, self)
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	75 self._f = host.plugins["FILE"]
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	76 self._f.register(self, priority=10000)
1618 0de5f210fe56 plugin XEP-0300: implemented hashing: Goffi <goffi@goffi.org> parents: 1598 diff changeset	77 self._hash = self.host.plugins["XEP-0300"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	78 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	79 "fileJingleSend",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	80 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	81 in_sign="ssssa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	82 out_sign="",
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	83 method=self._fileSend,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	84 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	85 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	86 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	87 "fileJingleRequest",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	88 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	89 in_sign="sssssa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	90 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	91 method=self._fileJingleRequest,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	92 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	93 )
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	94
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 1934 diff changeset	95 def getHandler(self, client):
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	96 return XEP_0234_handler()
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	97
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	98 def getProgressId(self, session, content_name):
1585 846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	99 """Return a unique progress ID
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	100
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	101 @param session(dict): jingle session
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	102 @param content_name(unicode): name of the content
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	103 @return (unicode): unique progress id
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	104 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	105 return "{}_{}".format(session["id"], content_name)
1585 846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	106
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	107 async def canHandleFileSend(self, client, peer_jid, filepath):
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	108 if peer_jid.resource:
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	109 return await self.host.hasFeature(client, NS_JINGLE_FT, peer_jid)
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	110 else:
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	111 # if we have a bare jid, Jingle Message Initiation will be tried
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	112 return True
404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	113
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	114 # generic methods
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	115
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	116 def buildFileElement(
5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	117 self, client, name=None, file_hash=None, hash_algo=None, size=None,
2927 69e4716d6268 plugins (jingle) file transfer: use initial "from" attribute as local jid instead of client.jid: Goffi <goffi@goffi.org> parents: 2771 diff changeset	118 mime_type=None, desc=None, modified=None, transfer_range=None, path=None,
69e4716d6268 plugins (jingle) file transfer: use initial "from" attribute as local jid instead of client.jid: Goffi <goffi@goffi.org> parents: 2771 diff changeset	119 namespace=None, file_elt=None, **kwargs):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	120 """Generate a <file> element with available metadata
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	121
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	122 @param file_hash(unicode, None): hash of the file
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	123 empty string to set <hash-used/> element
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	124 @param hash_algo(unicode, None): hash algorithm used
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	125 if file_hash is None and hash_algo is set, a <hash-used/> element will be
5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	126 generated
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	127 @param transfer_range(Range, None): where transfer must start/stop
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	128 @param modified(int, unicode, None): date of last modification
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	129 0 to use current date
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	130 int to use an unix timestamp
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	131 else must be an unicode string which will be used as it (it must be an XMPP
5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	132 time)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	133 @param file_elt(domish.Element, None): element to use
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	134 None to create a new one
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	135 @param **kwargs: data for plugin extension (ignored by default)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	136 @return (domish.Element): generated element
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	137 @trigger XEP-0234_buildFileElement(file_elt, extra_args): can be used to extend
5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	138 elements to add
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	139 """
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	140 if file_elt is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	141 file_elt = domish.Element((NS_JINGLE_FT, "file"))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	142 for name, value in (
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	143 ("name", name),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	144 ("size", size),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	145 ("media-type", mime_type),
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	146 ("desc", desc),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	147 ("path", path),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	148 ("namespace", namespace),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	149 ):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	150 if value is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	151 file_elt.addElement(name, content=str(value))
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	152
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	153 if modified is not None:
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	154 if isinstance(modified, int):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	155 file_elt.addElement("date", utils.xmpp_date(modified or None))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	156 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	157 file_elt.addElement("date", modified)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	158 elif "created" in kwargs:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	159 file_elt.addElement("date", utils.xmpp_date(kwargs.pop("created")))
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	160
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	161 range_elt = file_elt.addElement("range")
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	162 if transfer_range is not None:
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	163 if transfer_range.offset is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	164 range_elt["offset"] = transfer_range.offset
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	165 if transfer_range.length is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	166 range_elt["length"] = transfer_range.length
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	167 if file_hash is not None:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	168 if not file_hash:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	169 file_elt.addChild(self._hash.buildHashUsedElt())
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	170 else:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	171 file_elt.addChild(self._hash.buildHashElt(file_hash, hash_algo))
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	172 elif hash_algo is not None:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	173 file_elt.addChild(self._hash.buildHashUsedElt(hash_algo))
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	174 self.host.trigger.point(
5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	175 "XEP-0234_buildFileElement", client, file_elt, extra_args=kwargs)
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	176 if kwargs:
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	177 for kw in kwargs:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	178 log.debug("ignored keyword: {}".format(kw))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	179 return file_elt
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	180
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	181 def buildFileElementFromDict(self, client, file_data, **kwargs):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	182 """like buildFileElement but get values from a file_data dict
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	183
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	184 @param file_data(dict): metadata to use
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	185 @param **kwargs: data to override
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	186 """
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	187 if kwargs:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	188 file_data = file_data.copy()
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	189 file_data.update(kwargs)
3345 3dc8835d96cc plugin XEP-0234: fixed mime type in `buildFileElementFromDict` Goffi <goffi@goffi.org> parents: 3333 diff changeset	190 try:
3dc8835d96cc plugin XEP-0234: fixed mime type in `buildFileElementFromDict` Goffi <goffi@goffi.org> parents: 3333 diff changeset	191 file_data["mime_type"] = (
3dc8835d96cc plugin XEP-0234: fixed mime type in `buildFileElementFromDict` Goffi <goffi@goffi.org> parents: 3333 diff changeset	192 f'{file_data.pop("media_type")}/{file_data.pop("media_subtype")}'
3dc8835d96cc plugin XEP-0234: fixed mime type in `buildFileElementFromDict` Goffi <goffi@goffi.org> parents: 3333 diff changeset	193 )
3dc8835d96cc plugin XEP-0234: fixed mime type in `buildFileElementFromDict` Goffi <goffi@goffi.org> parents: 3333 diff changeset	194 except KeyError:
3dc8835d96cc plugin XEP-0234: fixed mime type in `buildFileElementFromDict` Goffi <goffi@goffi.org> parents: 3333 diff changeset	195 pass
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	196 return self.buildFileElement(client, **file_data)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	197
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	198 async def parseFileElement(
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	199 self, client, file_elt, file_data=None, given=False, parent_elt=None,
5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	200 keep_empty_range=False):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	201 """Parse a <file> element and file dictionary accordingly
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	202
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	203 @param file_data(dict, None): dict where the data will be set
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	204 following keys will be set (and overwritten if they already exist):
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	205 name, file_hash, hash_algo, size, mime_type, desc, path, namespace, range
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	206 if None, a new dict is created
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	207 @param given(bool): if True, prefix hash key with "given_"
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	208 @param parent_elt(domish.Element, None): parent of the file element
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	209 if set, file_elt must not be set
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	210 @param keep_empty_range(bool): if True, keep empty range (i.e. range when offset
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	211 and length are None).
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	212 Empty range is useful to know if a peer_jid can handle range
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	213 @return (dict): file_data
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	214 @trigger XEP-0234_parseFileElement(file_elt, file_data): can be used to parse new
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	215 elements
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	216 @raise exceptions.NotFound: there is not <file> element in parent_elt
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	217 @raise exceptions.DataError: if file_elt uri is not NS_JINGLE_FT
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	218 """
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	219 if parent_elt is not None:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	220 if file_elt is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	221 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	222 "file_elt must be None if parent_elt is set"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	223 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	224 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	225 file_elt = next(parent_elt.elements(NS_JINGLE_FT, "file"))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	226 except StopIteration:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	227 raise exceptions.NotFound()
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	228 else:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	229 if not file_elt or file_elt.uri != NS_JINGLE_FT:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	230 raise exceptions.DataError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	231 "invalid <file> element: {stanza}".format(stanza=file_elt.toXml())
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	232 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	233
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	234 if file_data is None:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	235 file_data = {}
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	236
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	237 for name in ("name", "desc", "path", "namespace"):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	238 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	239 file_data[name] = str(next(file_elt.elements(NS_JINGLE_FT, name)))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	240 except StopIteration:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	241 pass
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	242
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	243 name = file_data.get("name")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	244 if name == "..":
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	245 # we don't want to go to parent dir when joining to a path
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	246 name = "--"
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	247 file_data["name"] = name
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	248 elif name is not None and ("/" in name or "\\" in name):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	249 file_data["name"] = regex.pathEscape(name)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	250
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	251 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	252 file_data["mime_type"] = str(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	253 next(file_elt.elements(NS_JINGLE_FT, "media-type"))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	254 )
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	255 except StopIteration:
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	256 pass
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	257
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	258 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	259 file_data["size"] = int(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	260 str(next(file_elt.elements(NS_JINGLE_FT, "size")))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	261 )
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	262 except StopIteration:
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	263 pass
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	264
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	265 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	266 file_data["modified"] = date_utils.date_parse(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	267 next(file_elt.elements(NS_JINGLE_FT, "date"))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	268 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	269 except StopIteration:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	270 pass
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	271
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	272 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	273 range_elt = next(file_elt.elements(NS_JINGLE_FT, "range"))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	274 except StopIteration:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	275 pass
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	276 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	277 offset = range_elt.getAttribute("offset")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	278 length = range_elt.getAttribute("length")
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	279 if offset or length or keep_empty_range:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	280 file_data["transfer_range"] = Range(offset=offset, length=length)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	281
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	282 prefix = "given_" if given else ""
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	283 hash_algo_key, hash_key = "hash_algo", prefix + "file_hash"
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	284 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	285 file_data[hash_algo_key], file_data[hash_key] = self._hash.parseHashElt(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	286 file_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	287 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	288 except exceptions.NotFound:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	289 pass
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	290
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	291 self.host.trigger.point("XEP-0234_parseFileElement", client, file_elt, file_data)
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	292
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	293 return file_data
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	294
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	295 # bridge methods
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	296
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	297 def _fileSend(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	298 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	299 peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	300 filepath,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	301 name="",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	302 file_desc="",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	303 extra=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	304 profile=C.PROF_KEY_NONE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	305 ):
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	306 client = self.host.getClient(profile)
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	307 return defer.ensureDeferred(self.fileSend(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	308 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	309 jid.JID(peer_jid),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	310 filepath,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	311 name or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	312 file_desc or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	313 extra or None,
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	314 ))
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	315
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	316 async def fileSend(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	317 self, client, peer_jid, filepath, name, file_desc=None, extra=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	318 ):
1585 846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	319 """Send a file using jingle file transfer
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	320
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	321 @param peer_jid(jid.JID): destinee jid
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	322 @param filepath(str): absolute path of the file
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	323 @param name(unicode, None): name of the file
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	324 @param file_desc(unicode, None): description of the file
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	325 @return (D(unicode)): progress id
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	326 """
846a39900fa6 plugins XEP-0096, XEP-0260, file: sendFile method is managed by file plugin, which choose the best available method + progress_id fix Goffi <goffi@goffi.org> parents: 1575 diff changeset	327 progress_id_d = defer.Deferred()
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	328 if extra is None:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	329 extra = {}
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	330 if file_desc is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	331 extra["file_desc"] = file_desc
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	332 await self._j.initiate(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	333 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	334 peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	335 [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	336 {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	337 "app_ns": NS_JINGLE_FT,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	338 "senders": self._j.ROLE_INITIATOR,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	339 "app_kwargs": {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	340 "filepath": filepath,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	341 "name": name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	342 "extra": extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	343 "progress_id_d": progress_id_d,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	344 },
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	345 }
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	346 ],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	347 )
3403 404d4b29de52 plugin file, XEP-0234: registering is now done by class + use of async: Goffi <goffi@goffi.org> parents: 3345 diff changeset	348 return await progress_id_d
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	349
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	350 def _fileJingleRequest(
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	351 self, peer_jid, filepath, name="", file_hash="", hash_algo="", extra=None,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	352 profile=C.PROF_KEY_NONE):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	353 client = self.host.getClient(profile)
3434 c84c54c6b046 plugin XEP-0234: make `fileJingleRequest` async to fix call of `initiate` Goffi <goffi@goffi.org> parents: 3404 diff changeset	354 return defer.ensureDeferred(self.fileJingleRequest(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	355 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	356 jid.JID(peer_jid),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	357 filepath,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	358 name or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	359 file_hash or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	360 hash_algo or None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	361 extra or None,
3434 c84c54c6b046 plugin XEP-0234: make `fileJingleRequest` async to fix call of `initiate` Goffi <goffi@goffi.org> parents: 3404 diff changeset	362 ))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	363
3434 c84c54c6b046 plugin XEP-0234: make `fileJingleRequest` async to fix call of `initiate` Goffi <goffi@goffi.org> parents: 3404 diff changeset	364 async def fileJingleRequest(
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	365 self, client, peer_jid, filepath, name=None, file_hash=None, hash_algo=None,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	366 extra=None):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	367 """Request a file using jingle file transfer
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	368
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	369 @param peer_jid(jid.JID): destinee jid
2589 282d1314d574 plugin XEP-0329: new methods/signals to handle shares: Goffi <goffi@goffi.org> parents: 2562 diff changeset	370 @param filepath(str): absolute path where the file will be downloaded
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	371 @param name(unicode, None): name of the file
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	372 @param file_hash(unicode, None): hash of the file
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	373 @return (D(unicode)): progress id
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	374 """
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	375 progress_id_d = defer.Deferred()
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	376 if extra is None:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	377 extra = {}
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	378 if file_hash is not None:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	379 if hash_algo is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	380 raise ValueError(_("hash_algo must be set if file_hash is set"))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	381 extra["file_hash"] = file_hash
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	382 extra["hash_algo"] = hash_algo
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	383 else:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	384 if hash_algo is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	385 raise ValueError(_("file_hash must be set if hash_algo is set"))
3434 c84c54c6b046 plugin XEP-0234: make `fileJingleRequest` async to fix call of `initiate` Goffi <goffi@goffi.org> parents: 3404 diff changeset	386 await self._j.initiate(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	387 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	388 peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	389 [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	390 {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	391 "app_ns": NS_JINGLE_FT,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	392 "senders": self._j.ROLE_RESPONDER,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	393 "app_kwargs": {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	394 "filepath": filepath,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	395 "name": name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	396 "extra": extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	397 "progress_id_d": progress_id_d,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	398 },
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	399 }
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	400 ],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	401 )
3434 c84c54c6b046 plugin XEP-0234: make `fileJingleRequest` async to fix call of `initiate` Goffi <goffi@goffi.org> parents: 3404 diff changeset	402 return await progress_id_d
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	403
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	404 # jingle callbacks
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	405
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3403 diff changeset	406 def jingleDescriptionElt(
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3403 diff changeset	407 self, client, session, content_name, filepath, name, extra, progress_id_d
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3403 diff changeset	408 ):
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3403 diff changeset	409 return domish.Element((NS_JINGLE_FT, "description"))
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3403 diff changeset	410
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	411 def jingleSessionInit(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	412 self, client, session, content_name, filepath, name, extra, progress_id_d
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	413 ):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	414 if extra is None:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	415 extra = {}
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	416 else:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	417 if not EXTRA_ALLOWED.issuperset(extra):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	418 raise ValueError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	419 _("only the following keys are allowed in extra: {keys}").format(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	420 keys=", ".join(EXTRA_ALLOWED)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	421 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	422 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	423 progress_id_d.callback(self.getProgressId(session, content_name))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	424 content_data = session["contents"][content_name]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	425 application_data = content_data["application_data"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	426 assert "file_path" not in application_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	427 application_data["file_path"] = filepath
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	428 file_data = application_data["file_data"] = {}
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3403 diff changeset	429 desc_elt = self.jingleDescriptionElt(
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3403 diff changeset	430 client, session, content_name, filepath, name, extra, progress_id_d)
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	431 file_elt = desc_elt.addElement("file")
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	432
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	433 if content_data["senders"] == self._j.ROLE_INITIATOR:
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	434 # we send a file
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	435 if name is None:
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	436 name = os.path.basename(filepath)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	437 file_data["date"] = utils.xmpp_date()
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	438 file_data["desc"] = extra.pop("file_desc", "")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	439 file_data["name"] = name
2512 025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	440 mime_type = mimetypes.guess_type(name, strict=False)[0]
025afb04c10b plugin XEP-0234: some cleaning + added triggers to allow plugins to change parsing/generation of <file> element Goffi <goffi@goffi.org> parents: 2502 diff changeset	441 if mime_type is not None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	442 file_data["mime_type"] = mime_type
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	443 file_data["size"] = os.path.getsize(filepath)
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	444 if "namespace" in extra:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	445 file_data["namespace"] = extra["namespace"]
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	446 if "path" in extra:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	447 file_data["path"] = extra["path"]
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	448 self.buildFileElementFromDict(
5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	449 client, file_data, file_elt=file_elt, file_hash="")
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	450 else:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	451 # we request a file
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	452 file_hash = extra.pop("file_hash", "")
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	453 if not name and not file_hash:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	454 raise ValueError(_("you need to provide at least name or file hash"))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	455 if name:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	456 file_data["name"] = name
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	457 if file_hash:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	458 file_data["file_hash"] = file_hash
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	459 file_data["hash_algo"] = extra["hash_algo"]
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	460 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	461 file_data["hash_algo"] = self._hash.getDefaultAlgo()
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	462 if "namespace" in extra:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	463 file_data["namespace"] = extra["namespace"]
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	464 if "path" in extra:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	465 file_data["path"] = extra["path"]
3314 5887fb414758 component file sharing: add/parse affiliation when possible Goffi <goffi@goffi.org> parents: 3303 diff changeset	466 self.buildFileElementFromDict(client, file_data, file_elt=file_elt)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	467
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	468 return desc_elt
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	469
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	470 async def jingleRequestConfirmation(
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	471 self, client, action, session, content_name, desc_elt
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	472 ):
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	473 """This method request confirmation for a jingle session"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	474 content_data = session["contents"][content_name]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	475 senders = content_data["senders"]
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	476 if senders not in (self._j.ROLE_INITIATOR, self._j.ROLE_RESPONDER):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	477 log.warning("Bad sender, assuming initiator")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	478 senders = content_data["senders"] = self._j.ROLE_INITIATOR
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	479 # first we grab file informations
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	480 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	481 file_elt = next(desc_elt.elements(NS_JINGLE_FT, "file"))
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	482 except StopIteration:
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	483 raise failure.Failure(exceptions.DataError)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	484 file_data = {"progress_id": self.getProgressId(session, content_name)}
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	485
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	486 if senders == self._j.ROLE_RESPONDER:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	487 # we send the file
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	488 return await self._fileSendingRequestConf(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	489 client, session, content_data, content_name, file_data, file_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	490 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	491 else:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	492 # we receive the file
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	493 return await self._fileReceivingRequestConf(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	494 client, session, content_data, content_name, file_data, file_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	495 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	496
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	497 async def _fileSendingRequestConf(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	498 self, client, session, content_data, content_name, file_data, file_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	499 ):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	500 """parse file_elt, and handle file retrieving/permission checking"""
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	501 await self.parseFileElement(client, file_elt, file_data)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	502 content_data["application_data"]["file_data"] = file_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	503 finished_d = content_data["finished_d"] = defer.Deferred()
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	504
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	505 # confirmed_d is a deferred returning confimed value (only used if cont is False)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	506 cont, confirmed_d = self.host.trigger.returnPoint(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	507 "XEP-0234_fileSendingRequest",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	508 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	509 session,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	510 content_data,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	511 content_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	512 file_data,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	513 file_elt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	514 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	515 if not cont:
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	516 confirmed = await confirmed_d
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	517 if confirmed:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	518 args = [client, session, content_name, content_data]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	519 finished_d.addCallbacks(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	520 self._finishedCb, self._finishedEb, args, None, args
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	521 )
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	522 return confirmed
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	523
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	524 log.warning(_("File continue is not implemented yet"))
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	525 return False
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	526
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	527 async def _fileReceivingRequestConf(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	528 self, client, session, content_data, content_name, file_data, file_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	529 ):
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	530 """parse file_elt, and handle user permission/file opening"""
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	531 await self.parseFileElement(client, file_elt, file_data, given=True)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	532 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	533 hash_algo, file_data["given_file_hash"] = self._hash.parseHashElt(file_elt)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	534 except exceptions.NotFound:
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	535 try:
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	536 hash_algo = self._hash.parseHashUsedElt(file_elt)
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	537 except exceptions.NotFound:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	538 raise failure.Failure(exceptions.DataError)
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	539
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	540 if hash_algo is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	541 file_data["hash_algo"] = hash_algo
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	542 file_data["hash_hasher"] = hasher = self._hash.getHasher(hash_algo)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	543 file_data["data_cb"] = lambda data: hasher.update(data)
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	544
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	545 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	546 file_data["size"] = int(file_data["size"])
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	547 except ValueError:
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	548 raise failure.Failure(exceptions.DataError)
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	549
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	550 name = file_data["name"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	551 if "/" in name or "\\" in name:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	552 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	553 "File name contain path characters, we replace them: {}".format(name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	554 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	555 file_data["name"] = name.replace("/", "_").replace("\\", "_")
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	556
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	557 content_data["application_data"]["file_data"] = file_data
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	558
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	559 # now we actualy request permission to user
1574 babd97d80049 plugins XEP-0234, file: moved file request dialog to file plugin Goffi <goffi@goffi.org> parents: 1571 diff changeset	560
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	561 # deferred to track end of transfer
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	562 finished_d = content_data["finished_d"] = defer.Deferred()
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	563 confirmed = await self._f.getDestDir(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	564 client, session["peer_jid"], content_data, file_data, stream_object=True
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	565 )
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	566 if confirmed:
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	567 args = [client, session, content_name, content_data]
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	568 finished_d.addCallbacks(
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	569 self._finishedCb, self._finishedEb, args, None, args
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	570 )
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3314 diff changeset	571 return confirmed
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	572
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	573 @defer.inlineCallbacks
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	574 def jingleHandler(self, client, action, session, content_name, desc_elt):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	575 content_data = session["contents"][content_name]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	576 application_data = content_data["application_data"]
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1529 diff changeset	577 if action in (self._j.A_ACCEPTED_ACK,):
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	578 pass
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1529 diff changeset	579 elif action == self._j.A_SESSION_INITIATE:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	580 file_elt = next(desc_elt.elements(NS_JINGLE_FT, "file"))
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1529 diff changeset	581 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	582 next(file_elt.elements(NS_JINGLE_FT, "range"))
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1529 diff changeset	583 except StopIteration:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1529 diff changeset	584 # initiator doesn't manage <range>, but we do so we advertise it
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	585 # FIXME: to be checked
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1529 diff changeset	586 log.debug("adding <range> element")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	587 file_elt.addElement("range")
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	588 elif action == self._j.A_SESSION_ACCEPT:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	589 assert not "stream_object" in content_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	590 file_data = application_data["file_data"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	591 file_path = application_data["file_path"]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	592 senders = content_data["senders"]
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	593 if senders != session["role"]:
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	594 # we are receiving the file
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	595 try:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	596 # did the responder specified the size of the file?
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	597 file_elt = next(desc_elt.elements(NS_JINGLE_FT, "file"))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	598 size_elt = next(file_elt.elements(NS_JINGLE_FT, "size"))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	599 size = int(str(size_elt))
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	600 except (StopIteration, ValueError):
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	601 size = None
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	602 # XXX: hash security is not critical here, so we just take the higher
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	603 # mandatory one
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	604 hasher = file_data["hash_hasher"] = self._hash.getHasher()
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	605 progress_id = self.getProgressId(session, content_name)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	606 try:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	607 content_data["stream_object"] = stream.FileStreamObject(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	608 self.host,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	609 client,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	610 file_path,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	611 mode="wb",
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	612 uid=progress_id,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	613 size=size,
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	614 data_cb=lambda data: hasher.update(data),
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	615 )
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	616 except Exception as e:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	617 self.host.bridge.progressError(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	618 progress_id, C.PROGRESS_ERROR_FAILED, client.profile
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	619 )
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	620 yield self._j.terminate(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	621 client, self._j.REASON_FAILED_APPLICATION, session)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	622 raise e
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	623 else:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	624 # we are sending the file
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	625 size = file_data["size"]
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	626 # XXX: hash security is not critical here, so we just take the higher
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	627 # mandatory one
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	628 hasher = file_data["hash_hasher"] = self._hash.getHasher()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	629 content_data["stream_object"] = stream.FileStreamObject(
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	630 self.host,
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	631 client,
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	632 file_path,
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	633 uid=self.getProgressId(session, content_name),
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	634 size=size,
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	635 data_cb=lambda data: hasher.update(data),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	636 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	637 finished_d = content_data["finished_d"] = defer.Deferred()
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	638 args = [client, session, content_name, content_data]
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: 1568 diff changeset	639 finished_d.addCallbacks(self._finishedCb, self._finishedEb, args, None, args)
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	640 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	641 log.warning("FIXME: unmanaged action {}".format(action))
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	642 defer.returnValue(desc_elt)
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	643
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	644 def jingleSessionInfo(self, client, action, session, content_name, jingle_elt):
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	645 """Called on session-info action
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	646
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	647 manage checksum, and ignore <received/> element
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	648 """
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	649 # TODO: manage <received/> element
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	650 content_data = session["contents"][content_name]
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	651 elts = [elt for elt in jingle_elt.elements() if elt.uri == NS_JINGLE_FT]
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	652 if not elts:
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	653 return
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	654 for elt in elts:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	655 if elt.name == "received":
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	656 pass
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	657 elif elt.name == "checksum":
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	658 # we have received the file hash, we need to parse it
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	659 if content_data["senders"] == session["role"]:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	660 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	661 "unexpected checksum received while we are the file sender"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	662 )
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	663 raise exceptions.DataError
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	664 info_content_name = elt["name"]
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	665 if info_content_name != content_name:
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	666 # it was for an other content...
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	667 return
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	668 file_data = content_data["application_data"]["file_data"]
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	669 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	670 file_elt = next(elt.elements((NS_JINGLE_FT, "file")))
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	671 except StopIteration:
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	672 raise exceptions.DataError
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	673 algo, file_data["given_file_hash"] = self._hash.parseHashElt(file_elt)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	674 if algo != file_data.get("hash_algo"):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	675 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	676 "Hash algorithm used in given hash ({peer_algo}) doesn't correspond to the one we have used ({our_algo}) [{profile}]".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	677 peer_algo=algo,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	678 our_algo=file_data.get("hash_algo"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	679 profile=client.profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	680 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	681 )
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	682 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	683 self._receiverTryTerminate(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	684 client, session, content_name, content_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	685 )
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	686 else:
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	687 raise NotImplementedError
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	688
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	689 def jingleTerminate(self, client, action, session, content_name, jingle_elt):
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	690 if jingle_elt.decline:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	691 # progress is the only way to tell to frontends that session has been declined
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	692 progress_id = self.getProgressId(session, content_name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	693 self.host.bridge.progressError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	694 progress_id, C.PROGRESS_ERROR_DECLINED, client.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	695 )
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	696 elif not jingle_elt.success:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	697 progress_id = self.getProgressId(session, content_name)
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	698 first_child = jingle_elt.firstChildElement()
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	699 if first_child is not None:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	700 reason = first_child.name
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	701 if jingle_elt.text is not None:
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	702 reason = f"{reason} - {jingle_elt.text}"
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	703 else:
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	704 reason = C.PROGRESS_ERROR_FAILED
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	705 self.host.bridge.progressError(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	706 progress_id, reason, client.profile
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	707 )
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	708
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	709 def _sendCheckSum(self, client, session, content_name, content_data):
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	710 """Send the session-info with the hash checksum"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	711 file_data = content_data["application_data"]["file_data"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	712 hasher = file_data["hash_hasher"]
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	713 hash_ = hasher.hexdigest()
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	714 log.debug("Calculated hash: {}".format(hash_))
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	715 iq_elt, jingle_elt = self._j.buildSessionInfo(client, session)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	716 checksum_elt = jingle_elt.addElement((NS_JINGLE_FT, "checksum"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	717 checksum_elt["creator"] = content_data["creator"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	718 checksum_elt["name"] = content_name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	719 file_elt = checksum_elt.addElement("file")
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	720 file_elt.addChild(self._hash.buildHashElt(hash_))
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	721 iq_elt.send()
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	722
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	723 def _receiverTryTerminate(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	724 self, client, session, content_name, content_data, last_try=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	725 ):
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	726 """Try to terminate the session
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	727
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	728 This method must only be used by the receiver.
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	729 It check if transfer is finished, and hash available,
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	730 if everything is OK, it check hash and terminate the session
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	731 @param last_try(bool): if True this mean than session must be terminated even given hash is not available
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	732 @return (bool): True if session was terminated
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	733 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	734 if not content_data.get("transfer_finished", False):
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	735 return False
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	736 file_data = content_data["application_data"]["file_data"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	737 given_hash = file_data.get("given_file_hash")
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	738 if given_hash is None:
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	739 if last_try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	740 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	741 "sender didn't sent hash checksum, we can't check the file [{profile}]".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	742 profile=client.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	743 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	744 )
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	745 self._j.delayedContentTerminate(client, session, content_name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	746 content_data["stream_object"].close()
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	747 return True
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	748 return False
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	749 hasher = file_data["hash_hasher"]
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	750 hash_ = hasher.hexdigest()
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	751
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	752 if hash_ == given_hash:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	753 log.info(f"Hash checked, file was successfully transfered: {hash_}")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	754 progress_metadata = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	755 "hash": hash_,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	756 "hash_algo": file_data["hash_algo"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	757 "hash_verified": C.BOOL_TRUE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	758 }
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1620 diff changeset	759 error = None
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	760 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	761 log.warning("Hash mismatch, the file was not transfered correctly")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	762 progress_metadata = None
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	763 error = "Hash mismatch: given={algo}:{given}, calculated={algo}:{our}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	764 algo=file_data["hash_algo"], given=given_hash, our=hash_
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	765 )
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	766
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	767 self._j.delayedContentTerminate(client, session, content_name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	768 content_data["stream_object"].close(progress_metadata, error)
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	769 # we may have the last_try timer still active, so we try to cancel it
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	770 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	771 content_data["last_try_timer"].cancel()
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	772 except (KeyError, internet_error.AlreadyCalled):
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	773 pass
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	774 return True
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	775
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2624 diff changeset	776 def _finishedCb(self, __, client, session, content_name, content_data):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	777 log.info("File transfer terminated")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	778 if content_data["senders"] != session["role"]:
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	779 # we terminate the session only if we are the receiver,
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: 1568 diff changeset	780 # as recommanded in XEP-0234 §2 (after example 6)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	781 content_data["transfer_finished"] = True
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	782 if not self._receiverTryTerminate(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	783 client, session, content_name, content_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	784 ):
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	785 # we have not received the hash yet, we wait 5 more seconds
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	786 content_data["last_try_timer"] = reactor.callLater(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	787 5,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	788 self._receiverTryTerminate,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	789 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	790 session,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	791 content_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	792 content_data,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	793 last_try=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	794 )
1620 4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	795 else:
4dd07d026214 plugin XEP-0234: hash checksum proper handling Goffi <goffi@goffi.org> parents: 1618 diff changeset	796 # we are the sender, we send the checksum
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	797 self._sendCheckSum(client, session, content_name, content_data)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	798 content_data["stream_object"].close()
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: 1568 diff changeset	799
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2483 diff changeset	800 def _finishedEb(self, failure, client, session, content_name, content_data):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	801 log.warning("Error while streaming file: {}".format(failure))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	802 content_data["stream_object"].close()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	803 self._j.contentTerminate(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	804 client, session, content_name, reason=self._j.REASON_FAILED_TRANSPORT
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	805 )
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: 1568 diff changeset	806
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	807
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	808 @implementer(iwokkel.IDisco)
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	809 class XEP_0234_handler(XMPPHandler):
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	810
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	811 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	812 return [disco.DiscoFeature(NS_JINGLE_FT)]
1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	813
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2612 diff changeset	814 def getDiscoItems(self, requestor, target, nodeIdentifier=""):
1528 1c71d7335d02 plugin XEP-0234: jingle file transfer first draft Goffi <goffi@goffi.org> parents: diff changeset	815 return []

Mercurial > libervia-backend

annotate sat/plugins/plugin_xep_0234.py @ 3791:c61233f51b86