Mercurial > libervia-backend
view sat/plugins/plugin_xep_0049.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 | be6d91572633 |
line wrap: on
line source
#!/usr/bin/env python3 # SAT plugin for managing xep-0049 # 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/>. from sat.core.i18n import _ from sat.core.constants import Const as C from sat.core.log import getLogger log = getLogger(__name__) from wokkel import compat from twisted.words.xish import domish PLUGIN_INFO = { C.PI_NAME: "XEP-0049 Plugin", C.PI_IMPORT_NAME: "XEP-0049", C.PI_TYPE: "XEP", C.PI_PROTOCOLS: ["XEP-0049"], C.PI_DEPENDENCIES: [], C.PI_MAIN: "XEP_0049", C.PI_HANDLER: "no", C.PI_DESCRIPTION: _("""Implementation of private XML storage"""), } class XEP_0049(object): NS_PRIVATE = "jabber:iq:private" def __init__(self, host): log.info(_("Plugin XEP-0049 initialization")) self.host = host def privateXMLStore(self, element, profile_key): """Store private data @param element: domish.Element to store (must have a namespace) @param profile_key: %(doc_profile_key)s """ assert isinstance(element, domish.Element) client = self.host.getClient(profile_key) # XXX: feature announcement in disco#info is not mandatory in XEP-0049, so we have to try to use private XML, and react according to the answer iq_elt = compat.IQ(client.xmlstream) query_elt = iq_elt.addElement("query", XEP_0049.NS_PRIVATE) query_elt.addChild(element) return iq_elt.send() def privateXMLGet(self, node_name, namespace, profile_key): """Store private data @param node_name: name of the node to get @param namespace: namespace of the node to get @param profile_key: %(doc_profile_key)s @return (domish.Element): a deferred which fire the stored data """ client = self.host.getClient(profile_key) # XXX: see privateXMLStore note about feature checking iq_elt = compat.IQ(client.xmlstream, "get") query_elt = iq_elt.addElement("query", XEP_0049.NS_PRIVATE) query_elt.addElement(node_name, namespace) def getCb(answer_iq_elt): answer_query_elt = next(answer_iq_elt.elements(XEP_0049.NS_PRIVATE, "query")) return answer_query_elt.firstChildElement() d = iq_elt.send() d.addCallback(getCb) return d