Mercurial > libervia-backend
view sat_frontends/tools/jid.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: a jabber client # 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/>. # hack to use this module with pyjamas try: str("") # XXX: unicode doesn't exist in pyjamas # normal version class BaseJID(str): def __new__(cls, jid_str): self = str.__new__(cls, cls._normalize(jid_str)) return self def __init__(self, jid_str): pass def _parse(self): """Find node domain and resource""" node_end = self.find("@") if node_end < 0: node_end = 0 domain_end = self.find("/") if domain_end == 0: raise ValueError("a jid can't start with '/'") if domain_end == -1: domain_end = len(self) self.node = self[:node_end] or None self.domain = self[(node_end + 1) if node_end else 0 : domain_end] self.resource = self[domain_end + 1 :] or None except ( TypeError, AttributeError, ): # Error raised is not the same depending on pyjsbuild options # pyjamas version class BaseJID(object): def __init__(self, jid_str): self.__internal_str = JID._normalize(jid_str) def __str__(self): return self.__internal_str def __getattr__(self, name): return getattr(self.__internal_str, name) def __eq__(self, other): if not isinstance(other, JID): return False return ( self.node == other.node and self.domain == other.domain and self.resource == other.resource ) def __hash__(self): return hash("JID<{}>".format(self.__internal_str)) def find(self, *args): return self.__internal_str.find(*args) def _parse(self): """Find node domain and resource""" node_end = self.__internal_str.find("@") if node_end < 0: node_end = 0 domain_end = self.__internal_str.find("/") if domain_end == 0: raise ValueError("a jid can't start with '/'") if domain_end == -1: domain_end = len(self.__internal_str) self.node = self.__internal_str[:node_end] or None self.domain = self.__internal_str[ (node_end + 1) if node_end else 0 : domain_end ] self.resource = self.__internal_str[domain_end + 1 :] or None class JID(BaseJID): """This class help manage JID (Node@Domaine/Resource)""" def __init__(self, jid_str): super(JID, self).__init__(jid_str) self._parse() @staticmethod def _normalize(jid_str): """Naive normalization before instantiating and parsing the JID""" if not jid_str: return jid_str tokens = jid_str.split("/") tokens[0] = tokens[0].lower() # force node and domain to lower-case return "/".join(tokens) @property def bare(self): if not self.node: return JID(self.domain) return JID("{}@{}".format(self.node, self.domain)) def is_valid(self): """ @return: True if the JID is XMPP compliant """ # TODO: implement real check, according to the RFC http://tools.ietf.org/html/rfc6122 return self.domain != "" def newResource(entity, resource): """Build a new JID from the given entity and resource. @param entity (JID): original JID @param resource (unicode): new resource @return: a new JID instance """ return JID("%s/%s" % (entity.bare, resource))