Mercurial > libervia-backend
view sat/plugins/plugin_xep_0264.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 | 559a625a236b |
children | 4230aaeab9a7 |
line wrap: on
line source
#!/usr/bin/env python3 # SAT plugin for managing xep-0264 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) # Copyright (C) 2014 Emmanuel Gil Peyrot (linkmauve@linkmauve.fr) # 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/>. from sat.core.i18n import _ from sat.core.constants import Const as C from sat.core.log import getLogger log = getLogger(__name__) from twisted.internet import threads from twisted.python.failure import Failure from zope.interface import implementer from wokkel import disco, iwokkel from sat.core import exceptions import hashlib try: from PIL import Image except: raise exceptions.MissingModule( "Missing module pillow, please download/install it from https://python-pillow.github.io" ) # cf. https://stackoverflow.com/a/23575424 from PIL import ImageFile ImageFile.LOAD_TRUNCATED_IMAGES = True try: from twisted.words.protocols.xmlstream import XMPPHandler except ImportError: from wokkel.subprotocols import XMPPHandler MIME_TYPE = "image/jpeg" SAVE_FORMAT = "JPEG" # (cf. Pillow documentation) NS_THUMBS = "urn:xmpp:thumbs:1" PLUGIN_INFO = { C.PI_NAME: "XEP-0264", C.PI_IMPORT_NAME: "XEP-0264", C.PI_TYPE: "XEP", C.PI_MODES: C.PLUG_MODE_BOTH, C.PI_PROTOCOLS: ["XEP-0264"], C.PI_DEPENDENCIES: ["XEP-0234"], C.PI_MAIN: "XEP_0264", C.PI_HANDLER: "yes", C.PI_DESCRIPTION: _("""Thumbnails handling"""), } class XEP_0264(object): SIZE_SMALL = (250, 250) SIZE_MEDIUM = (1024, 1024) def __init__(self, host): log.info(_("Plugin XEP_0264 initialization")) self.host = host host.trigger.add("XEP-0234_buildFileElement", self._addFileThumbnails) host.trigger.add("XEP-0234_parseFileElement", self._getFileThumbnails) def getHandler(self, client): return XEP_0264_handler() ## triggers ## def _addFileThumbnails(self, file_elt, extra_args): try: thumbnails = extra_args["extra"][C.KEY_THUMBNAILS] except KeyError: return for thumbnail in thumbnails: thumbnail_elt = file_elt.addElement((NS_THUMBS, "thumbnail")) thumbnail_elt["uri"] = "cid:" + thumbnail["id"] thumbnail_elt["media-type"] = MIME_TYPE width, height = thumbnail["size"] thumbnail_elt["width"] = str(width) thumbnail_elt["height"] = str(height) return True def _getFileThumbnails(self, file_elt, file_data): thumbnails = [] for thumbnail_elt in file_elt.elements(NS_THUMBS, "thumbnail"): uri = thumbnail_elt["uri"] if uri.startswith("cid:"): thumbnail = {"id": uri[4:]} width = thumbnail_elt.getAttribute("width") height = thumbnail_elt.getAttribute("height") if width and height: try: thumbnail["size"] = int(width), int(height) except ValueError: pass try: thumbnail["mime_type"] = thumbnail_elt["media-type"] except KeyError: pass thumbnails.append(thumbnail) if thumbnails: file_data.setdefault("extra", {})[C.KEY_THUMBNAILS] = thumbnails return True ## thumbnails generation ## def getThumbId(self, image_uid, size): """return an ID unique for image/size combination @param image_uid(unicode): unique id of the image can be a hash @param size(tuple(int)): requested size of thumbnail @return (unicode): unique id for this image/size """ return hashlib.sha256(repr((image_uid, size))).hexdigest() def _blockingGenThumb(self, source_path, size=None, max_age=None, image_uid=None): """Generate a thumbnail for image This is a blocking method and must be executed in a thread params are the same as for [generateThumbnail] """ if size is None: size = self.SIZE_SMALL try: img = Image.open(source_path) except IOError: return Failure(exceptions.DataError("Can't open image")) img.thumbnail(size) uid = self.getThumbId(image_uid or source_path, size) with self.host.common_cache.cacheData( PLUGIN_INFO[C.PI_IMPORT_NAME], uid, MIME_TYPE, max_age ) as f: img.save(f, SAVE_FORMAT) return img.size, uid def generateThumbnail(self, source_path, size=None, max_age=None, image_uid=None): """Generate a thumbnail of image @param source_path(unicode): absolute path to source image @param size(int, None): max size of the thumbnail can be one of self.SIZE_* None to use default value (i.e. self.SIZE_SMALL) @param max_age(int, None): same as for [memory.cache.Cache.cacheData]) @param image_uid(unicode, None): unique ID to identify the image use hash whenever possible if None, source_path will be used @return D(tuple[tuple[int,int], unicode]): tuple with: - size of the thumbnail - unique Id of the thumbnail """ d = threads.deferToThread( self._blockingGenThumb, source_path, size, max_age, image_uid=image_uid ) d.addErrback( lambda failure_: log.error("thumbnail generation error: {}".format(failure_)) ) return d @implementer(iwokkel.IDisco) class XEP_0264_handler(XMPPHandler): def getDiscoInfo(self, requestor, target, nodeIdentifier=""): return [disco.DiscoFeature(NS_THUMBS)] def getDiscoItems(self, requestor, target, nodeIdentifier=""): return []