Mercurial > libervia-backend
view sat/plugins/plugin_xep_0095.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-0095 # 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.protocols.jabber import xmlstream from twisted.words.protocols.jabber import error from zope.interface import implementer from wokkel import disco from wokkel import iwokkel import uuid PLUGIN_INFO = { C.PI_NAME: "XEP 0095 Plugin", C.PI_IMPORT_NAME: "XEP-0095", C.PI_TYPE: "XEP", C.PI_PROTOCOLS: ["XEP-0095"], C.PI_MAIN: "XEP_0095", C.PI_HANDLER: "yes", C.PI_DESCRIPTION: _("""Implementation of Stream Initiation"""), } IQ_SET = '/iq[@type="set"]' NS_SI = "http://jabber.org/protocol/si" SI_REQUEST = IQ_SET + '/si[@xmlns="' + NS_SI + '"]' SI_PROFILE_HEADER = "http://jabber.org/protocol/si/profile/" SI_ERROR_CONDITIONS = ("bad-profile", "no-valid-streams") class XEP_0095(object): def __init__(self, host): log.info(_("Plugin XEP_0095 initialization")) self.host = host self.si_profiles = {} # key: SI profile, value: callback def getHandler(self, client): return XEP_0095_handler(self) def registerSIProfile(self, si_profile, callback): """Add a callback for a SI Profile @param si_profile(unicode): SI profile name (e.g. file-transfer) @param callback(callable): method to call when the profile name is asked """ self.si_profiles[si_profile] = callback def unregisterSIProfile(self, si_profile): try: del self.si_profiles[si_profile] except KeyError: log.error( "Trying to unregister SI profile [{}] which was not registered".format( si_profile ) ) def streamInit(self, iq_elt, client): """This method is called on stream initiation (XEP-0095 #3.2) @param iq_elt: IQ element """ log.info(_("XEP-0095 Stream initiation")) iq_elt.handled = True si_elt = next(iq_elt.elements(NS_SI, "si")) si_id = si_elt["id"] si_mime_type = iq_elt.getAttribute("mime-type", "application/octet-stream") si_profile = si_elt["profile"] si_profile_key = ( si_profile[len(SI_PROFILE_HEADER) :] if si_profile.startswith(SI_PROFILE_HEADER) else si_profile ) if si_profile_key in self.si_profiles: # We know this SI profile, we call the callback self.si_profiles[si_profile_key](client, iq_elt, si_id, si_mime_type, si_elt) else: # We don't know this profile, we send an error self.sendError(client, iq_elt, "bad-profile") def sendError(self, client, request, condition): """Send IQ error as a result @param request(domish.Element): original IQ request @param condition(str): error condition """ if condition in SI_ERROR_CONDITIONS: si_condition = condition condition = "bad-request" else: si_condition = None iq_error_elt = error.StanzaError(condition).toResponse(request) if si_condition is not None: iq_error_elt.error.addElement((NS_SI, si_condition)) client.send(iq_error_elt) def acceptStream(self, client, iq_elt, feature_elt, misc_elts=None): """Send the accept stream initiation answer @param iq_elt(domish.Element): initial SI request @param feature_elt(domish.Element): 'feature' element containing stream method to use @param misc_elts(list[domish.Element]): list of elements to add """ log.info(_("sending stream initiation accept answer")) if misc_elts is None: misc_elts = [] result_elt = xmlstream.toResponse(iq_elt, "result") si_elt = result_elt.addElement((NS_SI, "si")) si_elt.addChild(feature_elt) for elt in misc_elts: si_elt.addChild(elt) client.send(result_elt) def _parseOfferResult(self, iq_elt): try: si_elt = next(iq_elt.elements(NS_SI, "si")) except StopIteration: log.warning("No <si/> element found in result while expected") raise exceptions.DataError return (iq_elt, si_elt) def proposeStream( self, client, to_jid, si_profile, feature_elt, misc_elts, mime_type="application/octet-stream", ): """Propose a stream initiation @param to_jid(jid.JID): recipient @param si_profile(unicode): Stream initiation profile (XEP-0095) @param feature_elt(domish.Element): feature element, according to XEP-0020 @param misc_elts(list[domish.Element]): list of elements to add @param mime_type(unicode): stream mime type @return (tuple): tuple with: - session id (unicode) - (D(domish_elt, domish_elt): offer deferred which returl a tuple with iq_elt and si_elt """ offer = client.IQ() sid = str(uuid.uuid4()) log.debug(_("Stream Session ID: %s") % offer["id"]) offer["from"] = client.jid.full() offer["to"] = to_jid.full() si = offer.addElement("si", NS_SI) si["id"] = sid si["mime-type"] = mime_type si["profile"] = si_profile for elt in misc_elts: si.addChild(elt) si.addChild(feature_elt) offer_d = offer.send() offer_d.addCallback(self._parseOfferResult) return sid, offer_d @implementer(iwokkel.IDisco) class XEP_0095_handler(xmlstream.XMPPHandler): def __init__(self, plugin_parent): self.plugin_parent = plugin_parent self.host = plugin_parent.host def connectionInitialized(self): self.xmlstream.addObserver( SI_REQUEST, self.plugin_parent.streamInit, client=self.parent ) def getDiscoInfo(self, requestor, target, nodeIdentifier=""): return [disco.DiscoFeature(NS_SI)] + [ disco.DiscoFeature( "http://jabber.org/protocol/si/profile/{}".format(profile_name) ) for profile_name in self.plugin_parent.si_profiles ] def getDiscoItems(self, requestor, target, nodeIdentifier=""): return []