Mercurial > libervia-backend
comparison sat/plugins/plugin_xep_0045.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 | dcebc585c29f |
| children | be6d91572633 |
comparison
equal
deleted
inserted
replaced
| 3253:1af840e84af7 | 3254:6cf4bd6972c2 |
|---|---|
| 233 except exceptions.NotFound: | 233 except exceptions.NotFound: |
| 234 return False | 234 return False |
| 235 else: | 235 else: |
| 236 return True | 236 return True |
| 237 | 237 |
| 238 def isRoom(self, client, entity_jid): | |
| 239 """Tell if a jid is a joined MUC | |
| 240 | |
| 241 similar to isJoinedRoom but returns a boolean | |
| 242 @param entity_jid(jid.JID): full or bare jid of the entity check | |
| 243 @return (bool): True if the bare jid of the entity is a room jid | |
| 244 """ | |
| 245 try: | |
| 246 self.checkRoomJoined(client, entity_jid.userhostJID()) | |
| 247 except exceptions.NotFound: | |
| 248 return False | |
| 249 else: | |
| 250 return True | |
| 251 | |
| 252 def getBareOrFull(self, client, peer_jid): | |
| 253 """use full jid if peer_jid is an occupant of a room, bare jid else | |
| 254 | |
| 255 @param peer_jid(jid.JID): entity to test | |
| 256 @return (jid.JID): bare or full jid | |
| 257 """ | |
| 258 if peer_jid.resource: | |
| 259 if not self.isRoom(client, peer_jid): | |
| 260 return peer_jid.userhostJID() | |
| 261 return peer_jid | |
| 262 | |
| 238 def _getRoomJoinedArgs(self, room, profile): | 263 def _getRoomJoinedArgs(self, room, profile): |
| 239 return [ | 264 return [ |
| 240 room.roomJID.userhost(), | 265 room.roomJID.userhost(), |
| 241 XEP_0045._getOccupants(room), | 266 XEP_0045._getOccupants(room), |
| 242 room.nick, | 267 room.nick, |
| 1146 log.debug("room {room} joined with nick {nick}".format( | 1171 log.debug("room {room} joined with nick {nick}".format( |
| 1147 room=room.occupantJID.userhost(), nick=user.nick)) | 1172 room=room.occupantJID.userhost(), nick=user.nick)) |
| 1148 # we set type so we don't have to use a deferred | 1173 # we set type so we don't have to use a deferred |
| 1149 # with disco to check entity type | 1174 # with disco to check entity type |
| 1150 self.host.memory.updateEntityData( | 1175 self.host.memory.updateEntityData( |
| 1151 room.roomJID, C.ENTITY_TYPE, C.ENTITY_TYPE_MUC, | 1176 self.client, room.roomJID, C.ENTITY_TYPE, C.ENTITY_TYPE_MUC |
| 1152 profile_key=self.client.profile) | 1177 ) |
| 1153 elif room.state not in (ROOM_STATE_OCCUPANTS, ROOM_STATE_LIVE): | 1178 elif room.state not in (ROOM_STATE_OCCUPANTS, ROOM_STATE_LIVE): |
| 1154 log.warning( | 1179 log.warning( |
| 1155 "Received user presence data in a room before its initialisation " | 1180 "Received user presence data in a room before its initialisation " |
| 1156 "(current state: {state})," | 1181 "(current state: {state})," |
| 1157 "this is not standard! Ignoring it: {room} ({nick})".format( | 1182 "this is not standard! Ignoring it: {room} ({nick})".format( |