libervia-backend: sat/plugins/plugin_misc

annotate sat/plugins/plugin_misc_upload.py @ 3456:6deea0d8d0e7

plugin tickets, merge_requests: renamed "tickets" feature to "lists": this feature is more generic than only "tickets" for technical stuff, thus the name "lists" seems more appropriate.

author	Goffi <goffi@goffi.org>
date	Thu, 04 Feb 2021 21:05:21 +0100
parents	9057713ab124
children	be6d91572633

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	1 #!/usr/bin/env python3
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	2
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	3 # SAT plugin for uploading files
3136 9d0df638c8b4 dates update Goffi <goffi@goffi.org> parents: 3089 diff changeset	4 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	5
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	6 # This program is free software: you can redistribute it and/or modify
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	9 # (at your option) any later version.
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	10
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	11 # This program is distributed in the hope that it will be useful,
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	14 # GNU Affero General Public License for more details.
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	15
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	16 # You should have received a copy of the GNU Affero General Public License
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	18
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	19 import os
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	20 import os.path
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	21 from twisted.internet import defer
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	22 from twisted.words.protocols.jabber import jid
2863 a97a5c73594d plugin upload: fixed inversion of title and message body + better error message on failed upload Goffi <goffi@goffi.org> parents: 2771 diff changeset	23 from twisted.words.protocols.jabber import error as jabber_error
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	24 from sat.core.i18n import _, D_
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	25 from sat.core.constants import Const as C
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	26 from sat.tools.common import data_format
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	27 from sat.core.log import getLogger
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	28 from sat.core import exceptions
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	29 from sat.tools import xml_tools
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	30
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	31 log = getLogger(__name__)
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	32
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	33
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	34 PLUGIN_INFO = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	35 C.PI_NAME: "File Upload",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	36 C.PI_IMPORT_NAME: "UPLOAD",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	37 C.PI_TYPE: C.PLUG_TYPE_MISC,
3289 9057713ab124 plugin comp file sharing: files can now be uploaded/downloaded via HTTP: Goffi <goffi@goffi.org> parents: 3182 diff changeset	38 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	39 C.PI_MAIN: "UploadPlugin",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	40 C.PI_HANDLER: "no",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	41 C.PI_DESCRIPTION: _("""File upload management"""),
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	42 }
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	43
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	44
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	45 UPLOADING = D_("Please select a file to upload")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	46 UPLOADING_TITLE = D_("File upload")
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	47
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	48
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	49 class UploadPlugin(object):
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	50 # TODO: plugin unload
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	51
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	52 def __init__(self, host):
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	53 log.info(_("plugin Upload initialization"))
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	54 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	55 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	56 "fileUpload",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	57 ".plugin",
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	58 in_sign="sssss",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	59 out_sign="a{ss}",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	60 method=self._fileUpload,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	61 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	62 )
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	63 self._upload_callbacks = []
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	64
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	65 def _fileUpload(
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	66 self, filepath, filename, upload_jid_s="", options='', profile=C.PROF_KEY_NONE
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	67 ):
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	68 client = self.host.getClient(profile)
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	69 upload_jid = jid.JID(upload_jid_s) if upload_jid_s else None
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	70 options = data_format.deserialise(options)
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	71
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	72 return defer.ensureDeferred(self.fileUpload(
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	73 client, filepath, filename or None, upload_jid, options
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	74 ))
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	75
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	76 async def fileUpload(self, client, filepath, filename, upload_jid, options):
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	77 """Send a file using best available method
a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	78
a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	79 parameters are the same as for [upload]
2867 3cac3d050046 plugin upload: minor fixes in some docstring length Goffi <goffi@goffi.org> parents: 2863 diff changeset	80 @return (dict): action dictionary, with progress id in case of success, else xmlui
3cac3d050046 plugin upload: minor fixes in some docstring length Goffi <goffi@goffi.org> parents: 2863 diff changeset	81 message
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	82 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	83
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	84 try:
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	85 progress_id, __ = await self.upload(
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	86 client, filepath, filename, upload_jid, options)
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	87 except Exception as e:
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	88 if (isinstance(e, jabber_error.StanzaError)
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	89 and e.condition == 'not-acceptable'):
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	90 reason = e.text
2863 a97a5c73594d plugin upload: fixed inversion of title and message body + better error message on failed upload Goffi <goffi@goffi.org> parents: 2771 diff changeset	91 else:
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	92 reason = str(e)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	93 msg = D_("Can't upload file: {reason}").format(reason=reason)
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	94 log.warning(msg)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	95 return {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	96 "xmlui": xml_tools.note(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	97 msg, D_("Can't upload file"), C.XMLUI_DATA_LVL_WARNING
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	98 ).toXml()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	99 }
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	100 else:
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	101 return {"progress": progress_id}
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	102
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	103 async def upload(self, client, filepath, filename=None, upload_jid=None,
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	104 options=None):
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	105 """Send a file using best available method
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	106
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	107 @param filepath(str): absolute path to the file
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	108 @param filename(None, unicode): name to use for the upload
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	109 None to use basename of the path
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	110 @param upload_jid(jid.JID, None): upload capable entity jid,
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	111 or None to use autodetected, if possible
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	112 @param options(dict): option to use for the upload, may be:
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	113 - ignore_tls_errors(bool): True to ignore SSL/TLS certificate verification
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	114 used only if HTTPS transport is needed
3182 f2bb57348587 plugin attach, XEP-0363: progress id can now be specified: Goffi <goffi@goffi.org> parents: 3136 diff changeset	115 - progress_id(str): id to use for progression
f2bb57348587 plugin attach, XEP-0363: progress id can now be specified: Goffi <goffi@goffi.org> parents: 3136 diff changeset	116 if not specified, one will be generated
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	117 @param profile: %(doc_profile)s
2867 3cac3d050046 plugin upload: minor fixes in some docstring length Goffi <goffi@goffi.org> parents: 2863 diff changeset	118 @return (tuple[unicode,D(unicode)]): progress_id and a Deferred which fire
3cac3d050046 plugin upload: minor fixes in some docstring length Goffi <goffi@goffi.org> parents: 2863 diff changeset	119 download URL when upload is finished
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	120 """
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	121 if options is None:
a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	122 options = {}
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	123 if not os.path.isfile(filepath):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	124 raise exceptions.DataError("The given path doesn't link to a file")
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	125 for method_name, available_cb, upload_cb, priority in self._upload_callbacks:
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	126 try:
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	127 upload_jid = await available_cb(client, upload_jid)
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	128 except exceptions.NotFound:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	129 continue # no entity managing this extension found
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	130
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	131 log.info(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	132 "{name} method will be used to upload the file".format(name=method_name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	133 )
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	134 progress_id, download_d = await upload_cb(
e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	135 client, filepath, filename, upload_jid, options
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	136 )
3089 e75024e41f81 plugin upload, XEP-0363: code modernisation + preparation for extension: Goffi <goffi@goffi.org> parents: 3028 diff changeset	137 return progress_id, download_d
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	138
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	139 raise exceptions.NotFound("Can't find any method to upload a file")
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	140
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	141 def register(self, method_name, available_cb, upload_cb, priority=0):
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	142 """Register a fileUploading method
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	143
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	144 @param method_name(unicode): short name for the method, must be unique
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	145 @param available_cb(callable): method to call to check if this method is usable
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	146 the callback must take two arguments: upload_jid (can be None) and profile
2867 3cac3d050046 plugin upload: minor fixes in some docstring length Goffi <goffi@goffi.org> parents: 2863 diff changeset	147 the callback must return the first entity found (being upload_jid or one of its
3cac3d050046 plugin upload: minor fixes in some docstring length Goffi <goffi@goffi.org> parents: 2863 diff changeset	148 components)
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	149 exceptions.NotFound must be raised if no entity has been found
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	150 @param upload_cb(callable): method to upload a file
a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	151 must have the same signature as [fileUpload]
2867 3cac3d050046 plugin upload: minor fixes in some docstring length Goffi <goffi@goffi.org> parents: 2863 diff changeset	152 must return a tuple with progress_id and a Deferred which fire download URL
3cac3d050046 plugin upload: minor fixes in some docstring length Goffi <goffi@goffi.org> parents: 2863 diff changeset	153 when upload is finished
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	154 @param priority(int): pririoty of this method, the higher available will be used
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	155 """
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	156 assert method_name
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	157 for data in self._upload_callbacks:
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	158 if method_name == data[0]:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	159 raise exceptions.ConflictError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	160 "A method with this name is already registered"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	161 )
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	162 self._upload_callbacks.append((method_name, available_cb, upload_cb, priority))
1824 a19161bb3ff7 plugin upload, XEP-0363: splitted fileUpload in fileUpload + upload: Goffi <goffi@goffi.org> parents: 1766 diff changeset	163 self._upload_callbacks.sort(key=lambda data: data[3], reverse=True)
1640 d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	164
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	165 def unregister(self, method_name):
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	166 for idx, data in enumerate(self._upload_callbacks):
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	167 if data[0] == method_name:
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	168 del [idx]
d470affbe65c plugin XEP-0363, upload: File upload (through HTTP upload only for now): Goffi <goffi@goffi.org> parents: diff changeset	169 return
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2867 diff changeset	170 raise exceptions.NotFound("The name to unregister doesn't exist")

Mercurial > libervia-backend

annotate sat/plugins/plugin_misc_upload.py @ 3456:6deea0d8d0e7