Mercurial > libervia-backend
view sat/plugins/plugin_xep_0352.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 Explicit Message Encryption # 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 twisted.words.xish import domish from sat.core.i18n import _, D_ from sat.core.constants import Const as C from sat.core.log import getLogger log = getLogger(__name__) PLUGIN_INFO = { C.PI_NAME: "Client State Indication", C.PI_IMPORT_NAME: "XEP-0352", C.PI_TYPE: C.PLUG_TYPE_XEP, C.PI_PROTOCOLS: ["XEP-0352"], C.PI_DEPENDENCIES: [], C.PI_MAIN: "XEP_0352", C.PI_HANDLER: "no", C.PI_DESCRIPTION: D_("Notify server when frontend is not actively used, to limit " "traffic and save bandwidth and battery life"), } NS_CSI = "urn:xmpp:csi:0" class XEP_0352(object): def __init__(self, host): log.info(_("Client State Indication plugin initialization")) self.host = host host.registerNamespace("csi", NS_CSI) def isActive(self, client): try: if not client._xep_0352_enabled: return True return client._xep_0352_active except AttributeError: # _xep_0352_active can not be set if isActive is called before # profileConnected has been called log.debug("isActive called when XEP-0352 plugin has not yet set the " "attributes") return True def profileConnected(self, client): if (NS_CSI, 'csi') in client.xmlstream.features: log.info(_("Client State Indication is available on this server")) client._xep_0352_enabled = True client._xep_0352_active = True else: log.warning(_("Client State Indication is not available on this server, some" " bandwidth optimisations can't be used.")) client._xep_0352_enabled = False def setInactive(self, client): if self.isActive(client): inactive_elt = domish.Element((NS_CSI, 'inactive')) client.send(inactive_elt) client._xep_0352_active = False log.info("inactive state set") def setActive(self, client): if not self.isActive(client): active_elt = domish.Element((NS_CSI, 'active')) client.send(active_elt) client._xep_0352_active = True log.info("active state set")