Mercurial > libervia-backend
view sat/plugins/plugin_xep_0020.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-0020 # 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 sat.core import exceptions from twisted.words.xish import domish from zope.interface import implementer try: from twisted.words.protocols.xmlstream import XMPPHandler except ImportError: from wokkel.subprotocols import XMPPHandler from wokkel import disco, iwokkel, data_form NS_FEATURE_NEG = "http://jabber.org/protocol/feature-neg" PLUGIN_INFO = { C.PI_NAME: "XEP 0020 Plugin", C.PI_IMPORT_NAME: "XEP-0020", C.PI_TYPE: "XEP", C.PI_PROTOCOLS: ["XEP-0020"], C.PI_MAIN: "XEP_0020", C.PI_HANDLER: "yes", C.PI_DESCRIPTION: _("""Implementation of Feature Negotiation"""), } class XEP_0020(object): def __init__(self, host): log.info(_("Plugin XEP_0020 initialization")) def getHandler(self, client): return XEP_0020_handler() def getFeatureElt(self, elt): """Check element's children to find feature elements @param elt(domish.Element): parent element of the feature element @return: feature elements @raise exceptions.NotFound: no feature element found """ try: feature_elt = next(elt.elements(NS_FEATURE_NEG, "feature")) except StopIteration: raise exceptions.NotFound return feature_elt def _getForm(self, elt, namespace): """Return the first child data form @param elt(domish.Element): parent of the data form @param namespace (None, unicode): form namespace or None to ignore @return (None, data_form.Form): data form or None is nothing is found """ if namespace is None: try: form_elt = next(elt.elements(data_form.NS_X_DATA)) except StopIteration: return None else: return data_form.Form.fromElement(form_elt) else: return data_form.findForm(elt, namespace) def getChoosedOptions(self, feature_elt, namespace): """Return choosed feature for feature element @param feature_elt(domish.Element): feature domish element @param namespace (None, unicode): form namespace or None to ignore @return (dict): feature name as key, and choosed option as value @raise exceptions.NotFound: not data form is found """ form = self._getForm(feature_elt, namespace) if form is None: raise exceptions.NotFound result = {} for field in form.fields: values = form.fields[field].values result[field] = values[0] if values else None if len(values) > 1: log.warning( _( "More than one value choosed for {}, keeping the first one" ).format(field) ) return result def negotiate(self, feature_elt, name, negotiable_values, namespace): """Negotiate the feature options @param feature_elt(domish.Element): feature element @param name: the option name (i.e. field's var attribute) to negotiate @param negotiable_values(iterable): acceptable values for this negotiation first corresponding value will be returned @param namespace (None, unicode): form namespace or None to ignore @raise KeyError: name is not found in data form fields """ form = self._getForm(feature_elt, namespace) options = [option.value for option in form.fields[name].options] for value in negotiable_values: if value in options: return value return None def chooseOption(self, options, namespace): """Build a feature element with choosed options @param options(dict): dict with feature as key and choosed option as value @param namespace (None, unicode): form namespace or None to ignore """ feature_elt = domish.Element((NS_FEATURE_NEG, "feature")) x_form = data_form.Form("submit", formNamespace=namespace) x_form.makeFields(options) feature_elt.addChild(x_form.toElement()) return feature_elt def proposeFeatures(self, options_dict, namespace): """Build a feature element with options to propose @param options_dict(dict): dict with feature as key and iterable of acceptable options as value @param namespace(None, unicode): feature namespace """ feature_elt = domish.Element((NS_FEATURE_NEG, "feature")) x_form = data_form.Form("form", formNamespace=namespace) for field in options_dict: x_form.addField( data_form.Field( "list-single", field, options=[data_form.Option(option) for option in options_dict[field]], ) ) feature_elt.addChild(x_form.toElement()) return feature_elt @implementer(iwokkel.IDisco) class XEP_0020_handler(XMPPHandler): def getDiscoInfo(self, requestor, target, nodeIdentifier=""): return [disco.DiscoFeature(NS_FEATURE_NEG)] def getDiscoItems(self, requestor, target, nodeIdentifier=""): return []