Mercurial > libervia-backend
view sat/plugins/plugin_xep_0363.py @ 3254:6cf4bd6972c2
core, frontends: avatar refactoring:
/!\ huge commit
Avatar logic has been reworked around the IDENTITY plugin: plugins able to handle avatar
or other identity related metadata (like nicknames) register to IDENTITY plugin in the
same way as for other features like download/upload. Once registered, IDENTITY plugin will
call them when suitable in order of priority, and handle caching.
Methods to manage those metadata from frontend now use serialised data.
For now `avatar` and `nicknames` are handled:
- `avatar` is now a dict with `path` + metadata like `media_type`, instead of just a string
path
- `nicknames` is now a list of nicknames in order of priority. This list is never empty,
and `nicknames[0]` should be the preferred nickname to use by frontends in most cases.
In addition to contact specified nicknames, user set nickname (the one set in roster) is
used in priority when available.
Among the side changes done with this commit, there are:
- a new `contactGet` bridge method to get roster metadata for a single contact
- SatPresenceProtocol.send returns a Deferred to check when it has actually been sent
- memory's methods to handle entities data now use `client` as first argument
- metadata filter can be specified with `getIdentity`
- `getAvatar` and `setAvatar` are now part of the IDENTITY plugin instead of XEP-0054 (and
there signature has changed)
- `isRoom` and `getBareOrFull` are now part of XEP-0045 plugin
- jp avatar/get command uses `xdg-open` first when available for `--show` flag
- `--no-cache` has been added to jp avatar/get and identity/get
- jp identity/set has been simplified, explicit options (`--nickname` only for now) are
used instead of `--field`. `--field` may come back in the future if necessary for extra
data.
- QuickContactList `SetContact` now handle None as a value, and doesn't use it to delete the
metadata anymore
- improved cache handling for `metadata` and `nicknames` in quick frontend
- new `default` argument in QuickContactList `getCache`
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 14 Apr 2020 21:00:33 +0200 |
parents | 163014f09bf4 |
children | 9057713ab124 |
line wrap: on
line source
#!/usr/bin/env python3 # SàT plugin for HTTP File Upload (XEP-0363) # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. import os.path import mimetypes from dataclasses import dataclass from wokkel import disco, iwokkel from zope.interface import implementer from twisted.words.protocols.jabber import jid from twisted.words.protocols.jabber.xmlstream import XMPPHandler from twisted.internet import reactor from twisted.internet import defer from twisted.web import client as http_client from twisted.web import http_headers from sat.core.i18n import _ from sat.core.constants import Const as C from sat.core.log import getLogger from sat.core import exceptions from sat.tools import web as sat_web log = getLogger(__name__) PLUGIN_INFO = { C.PI_NAME: "HTTP File Upload", C.PI_IMPORT_NAME: "XEP-0363", C.PI_TYPE: "XEP", C.PI_PROTOCOLS: ["XEP-0363"], C.PI_DEPENDENCIES: ["FILE", "UPLOAD"], C.PI_MAIN: "XEP_0363", C.PI_HANDLER: "yes", C.PI_DESCRIPTION: _("""Implementation of HTTP File Upload"""), } NS_HTTP_UPLOAD = "urn:xmpp:http:upload:0" ALLOWED_HEADERS = ('authorization', 'cookie', 'expires') @dataclass class Slot: """Upload slot""" put: str get: str headers: list class XEP_0363(object): def __init__(self, host): log.info(_("plugin HTTP File Upload initialization")) self.host = host host.bridge.addMethod( "fileHTTPUpload", ".plugin", in_sign="sssbs", out_sign="", method=self._fileHTTPUpload, ) host.bridge.addMethod( "fileHTTPUploadGetSlot", ".plugin", in_sign="sisss", out_sign="(ss)", method=self._getSlot, async_=True, ) host.plugins["UPLOAD"].register( "HTTP Upload", self.getHTTPUploadEntity, self.fileHTTPUpload ) def getHandler(self, client): return XEP_0363_handler() async def getHTTPUploadEntity(self, client, upload_jid=None): """Get HTTP upload capable entity upload_jid is checked, then its components @param upload_jid(None, jid.JID): entity to check @return(D(jid.JID)): first HTTP upload capable entity @raise exceptions.NotFound: no entity found """ try: entity = client.http_upload_service except AttributeError: found_entities = await self.host.findFeaturesSet(client, (NS_HTTP_UPLOAD,)) try: entity = client.http_upload_service = next(iter(found_entities)) except StopIteration: entity = client.http_upload_service = None if entity is None: raise exceptions.NotFound("No HTTP upload entity found") return entity def _fileHTTPUpload(self, filepath, filename="", upload_jid="", ignore_tls_errors=False, profile=C.PROF_KEY_NONE): assert os.path.isabs(filepath) and os.path.isfile(filepath) client = self.host.getClient(profile) progress_id_d, __ = defer.ensureDeferred(self.fileHTTPUpload( client, filepath, filename or None, jid.JID(upload_jid) if upload_jid else None, {"ignore_tls_errors": ignore_tls_errors}, )) return progress_id_d async def fileHTTPUpload( self, client, filepath, filename=None, upload_jid=None, options=None): """Upload a file through HTTP @param filepath(str): absolute path of the file @param filename(None, unicode): name to use for the upload None to use basename of the path @param upload_jid(jid.JID, None): upload capable entity jid, or None to use autodetected, if possible @param options(dict): options where key can be: - ignore_tls_errors(bool): if True, SSL certificate will not be checked @param profile: %(doc_profile)s @return (D(tuple[D(unicode), D(unicode)])): progress id and Deferred which fire download URL """ if options is None: options = {} ignore_tls_errors = options.get("ignore_tls_errors", False) filename = filename or os.path.basename(filepath) size = os.path.getsize(filepath) size_adjust = [] #: this trigger can be used to modify the requested size, it is notably useful #: with encryption. The size_adjust is a list which can be filled by int to add #: to the initial size self.host.trigger.point( "XEP-0363_upload_size", client, options, filepath, size, size_adjust, triggers_no_cancel=True) if size_adjust: size = sum([size, *size_adjust]) try: slot = await self.getSlot(client, filename, size, upload_jid=upload_jid) except Exception as e: log.warning(_("Can't get upload slot: {reason}").format(reason=e)) raise e else: log.debug(f"Got upload slot: {slot}") sat_file = self.host.plugins["FILE"].File( self.host, client, filepath, uid=options.get("progress_id"), size=size, auto_end_signals=False ) progress_id = sat_file.uid file_producer = http_client.FileBodyProducer(sat_file) if ignore_tls_errors: agent = http_client.Agent(reactor, sat_web.NoCheckContextFactory()) else: agent = http_client.Agent(reactor) headers = {"User-Agent": [C.APP_NAME.encode("utf-8")]} for name, value in slot.headers: name = name.encode('utf-8') value = value.encode('utf-8') headers[name] = value await self.host.trigger.asyncPoint( "XEP-0363_upload", client, options, sat_file, file_producer, slot, triggers_no_cancel=True) download_d = agent.request( b"PUT", slot.put.encode("utf-8"), http_headers.Headers(headers), file_producer, ) download_d.addCallbacks( self._uploadCb, self._uploadEb, (sat_file, slot), None, (sat_file,), ) return progress_id, download_d def _uploadCb(self, __, sat_file, slot): """Called once file is successfully uploaded @param sat_file(SatFile): file used for the upload should be closed, but it is needed to send the progressFinished signal @param slot(Slot): put/get urls """ log.info(f"HTTP upload finished ({slot.get})") sat_file.progressFinished({"url": slot.get}) return slot.get def _uploadEb(self, failure_, sat_file): """Called on unsuccessful upload @param sat_file(SatFile): file used for the upload should be closed, be is needed to send the progressError signal """ try: wrapped_fail = failure_.value.reasons[0] except (AttributeError, IndexError) as e: log.warning(_("upload failed: {reason}").format(reason=e)) sat_file.progressError(str(failure_)) else: if wrapped_fail.check(sat_web.SSLError): msg = "TLS validation error, can't connect to HTTPS server" else: msg = "can't upload file" log.warning(msg + ": " + str(wrapped_fail.value)) sat_file.progressError(msg) raise failure_ def _getSlot(self, filename, size, content_type, upload_jid, profile_key=C.PROF_KEY_NONE): """Get an upload slot This method can be used when uploading is done by the frontend @param filename(unicode): name of the file to upload @param size(int): size of the file (must be non null) @param upload_jid(jid.JID(), None, ''): HTTP upload capable entity @param content_type(unicode, None): MIME type of the content empty string or None to guess automatically """ client = self.host.getClient(profile_key) filename = filename.replace("/", "_") return defer.ensureDeferred(self.getSlot( client, filename, size, content_type or None, upload_jid or None )) async def getSlot(self, client, filename, size, content_type=None, upload_jid=None): """Get a slot (i.e. download/upload links) @param filename(unicode): name to use for the upload @param size(int): size of the file to upload (must be >0) @param content_type(None, unicode): MIME type of the content None to autodetect @param upload_jid(jid.JID, None): HTTP upload capable upload_jid or None to use the server component (if any) @param client: %(doc_client)s @return (Slot): the upload (put) and download (get) URLs @raise exceptions.NotFound: no HTTP upload capable upload_jid has been found """ assert filename and size if content_type is None: # TODO: manage python magic for file guessing (in a dedicated plugin ?) content_type = mimetypes.guess_type(filename, strict=False)[0] if upload_jid is None: try: upload_jid = client.http_upload_service except AttributeError: found_entity = await self.getHTTPUploadEntity(profile=client.profile) return await self.getSlot( client, filename, size, content_type, found_entity) else: if upload_jid is None: raise exceptions.NotFound("No HTTP upload entity found") iq_elt = client.IQ("get") iq_elt["to"] = upload_jid.full() request_elt = iq_elt.addElement((NS_HTTP_UPLOAD, "request")) request_elt["filename"] = filename request_elt["size"] = str(size) if content_type is not None: request_elt["content-type"] = content_type iq_result_elt = await iq_elt.send() try: slot_elt = next(iq_result_elt.elements(NS_HTTP_UPLOAD, "slot")) put_elt = next(slot_elt.elements(NS_HTTP_UPLOAD, "put")) put_url = put_elt['url'] get_elt = next(slot_elt.elements(NS_HTTP_UPLOAD, "get")) get_url = get_elt['url'] except (StopIteration, KeyError): raise exceptions.DataError("Incorrect stanza received from server") headers = [] for header_elt in put_elt.elements(NS_HTTP_UPLOAD, "header"): try: name = header_elt["name"] value = str(header_elt) except KeyError: log.warning(_("Invalid header element: {xml}").format( iq_result_elt.toXml())) continue name = name.replace('\n', '') value = value.replace('\n', '') if name.lower() not in ALLOWED_HEADERS: log.warning(_('Ignoring unauthorised header "{name}": {xml}') .format(name=name, xml = iq_result_elt.toXml())) continue headers.append((name, value)) return Slot(put=put_url, get=get_url, headers=headers) @implementer(iwokkel.IDisco) class XEP_0363_handler(XMPPHandler): def getDiscoInfo(self, requestor, target, nodeIdentifier=""): return [disco.DiscoFeature(NS_HTTP_UPLOAD)] def getDiscoItems(self, requestor, target, nodeIdentifier=""): return []