libervia-backend: sat/plugins/plugin_misc

annotate sat/plugins/plugin_misc_identity.py @ 3758:b7cef1b24f83

plugins XEP-0060, XEP-0376, XEP-0465, CLI: PAM + PSS implementation: - update psSubscriptionsGet to use serialised return value - implement XEP-0376 Pubsub Account Management - implement XEP-0465 Public Pubsub Subscriptions - CLI `pubsub` commands updated accordingly, and added `--public` flags to `subscribe`, `Subscriptions` and `node Subscriptions get` ⚠ `XEP-0465` is speculative, the XEP has been accepted by council but not published yet. As is should be the next one, and current latest one is `XEP-0464`, `XEP-0465` has been anticipated. rel 365

author	Goffi <goffi@goffi.org>
date	Fri, 13 May 2022 18:38:05 +0200
parents	888109774673
children	213e83a4ed10

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3136 diff changeset	2
3479 be6d91572633 date update Goffi <goffi@goffi.org> parents: 3338 diff changeset	3 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	4
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	5 # This program is free software: you can redistribute it and/or modify
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	6 # it under the terms of the GNU Affero General Public License as published by
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	7 # the Free Software Foundation, either version 3 of the License, or
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	8 # (at your option) any later version.
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	9
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	10 # This program is distributed in the hope that it will be useful,
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	13 # GNU Affero General Public License for more details.
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	14
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	15 # You should have received a copy of the GNU Affero General Public License
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	17
3338 203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	18 from typing import Dict, List, Union, Coroutine, Any, Optional
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	19 from collections import namedtuple
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	20 from pathlib import Path
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	21 from twisted.internet import defer
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	22 from twisted.words.protocols.jabber import jid
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	23 from sat.core.xmpp import SatXMPPEntity
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	24 from sat.core.i18n import _
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	25 from sat.core.constants import Const as C
2463 65a6d2496504 plugin identity: return resource for MUC room occupants' nicks + added avatar and avatar_basename. Goffi <goffi@goffi.org> parents: 2427 diff changeset	26 from sat.core import exceptions
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	27 from sat.core.log import getLogger
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	28 from sat.memory import persistent
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	29 from sat.tools import image
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	30 from sat.tools import utils
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	31 from sat.tools.common import data_format
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	32
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	33
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	34 log = getLogger(__name__)
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	35
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	36
3278 27d4b71e264a plugin identity: fixed update in avatarSetPostTreatment Goffi <goffi@goffi.org> parents: 3277 diff changeset	37 IMPORT_NAME = "IDENTITY"
27d4b71e264a plugin identity: fixed update in avatarSetPostTreatment Goffi <goffi@goffi.org> parents: 3277 diff changeset	38
27d4b71e264a plugin identity: fixed update in avatarSetPostTreatment Goffi <goffi@goffi.org> parents: 3277 diff changeset	39
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	40 PLUGIN_INFO = {
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	41 C.PI_NAME: "Identity Plugin",
3278 27d4b71e264a plugin identity: fixed update in avatarSetPostTreatment Goffi <goffi@goffi.org> parents: 3277 diff changeset	42 C.PI_IMPORT_NAME: IMPORT_NAME,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	43 C.PI_TYPE: C.PLUG_TYPE_MISC,
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	44 C.PI_PROTOCOLS: [],
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	45 C.PI_DEPENDENCIES: [],
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	46 C.PI_RECOMMENDATIONS: ["XEP-0045"],
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	47 C.PI_MAIN: "Identity",
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	48 C.PI_HANDLER: "no",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	49 C.PI_DESCRIPTION: _("""Identity manager"""),
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	50 }
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	51
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	52 Callback = namedtuple("Callback", ("origin", "get", "set", "priority"))
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	53
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	54
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	55 class Identity:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	56
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	57 def __init__(self, host):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	58 log.info(_("Plugin Identity initialization"))
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	59 self.host = host
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	60 self._m = host.plugins.get("XEP-0045")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	61 self.metadata = {
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	62 "avatar": {
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	63 "type": dict,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	64 # convert avatar path to avatar metadata (and check validity)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	65 "set_data_filter": self.avatarSetDataFilter,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	66 # update profile avatar, so all frontends are aware
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	67 "set_post_treatment": self.avatarSetPostTreatment,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	68 "update_is_new_data": self.avatarUpdateIsNewData,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	69 "update_data_filter": self.avatarUpdateDataFilter,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	70 # we store the metadata in database, to restore it on next connection
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	71 # (it is stored only for roster entities)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	72 "store": True,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	73 },
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	74 "nicknames": {
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	75 "type": list,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	76 # accumulate all nicknames from all callbacks in a list instead
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	77 # of returning only the data from the first successful callback
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	78 "get_all": True,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	79 # append nicknames from roster, resource, etc.
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	80 "get_post_treatment": self.nicknamesGetPostTreatment,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	81 "update_is_new_data": self.nicknamesUpdateIsNewData,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	82 "store": True,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	83 },
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	84 }
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	85 host.trigger.add("roster_update", self._rosterUpdateTrigger)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	86 host.memory.setSignalOnUpdate("avatar")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	87 host.memory.setSignalOnUpdate("nicknames")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	88 host.bridge.addMethod(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	89 "identityGet",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	90 ".plugin",
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	91 in_sign="sasbs",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	92 out_sign="s",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	93 method=self._getIdentity,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	94 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	95 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	96 host.bridge.addMethod(
3338 203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	97 "identitiesGet",
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	98 ".plugin",
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	99 in_sign="asass",
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	100 out_sign="s",
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	101 method=self._getIdentities,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	102 async_=True,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	103 )
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	104 host.bridge.addMethod(
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	105 "identitiesBaseGet",
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	106 ".plugin",
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	107 in_sign="s",
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	108 out_sign="s",
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	109 method=self._getBaseIdentities,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	110 async_=True,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	111 )
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	112 host.bridge.addMethod(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	113 "identitySet",
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	114 ".plugin",
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	115 in_sign="ss",
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	116 out_sign="",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	117 method=self._setIdentity,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	118 async_=True,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	119 )
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	120 host.bridge.addMethod(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	121 "avatarGet",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	122 ".plugin",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	123 in_sign="sbs",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	124 out_sign="s",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	125 method=self._getAvatar,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	126 async_=True,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	127 )
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	128 host.bridge.addMethod(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	129 "avatarSet",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	130 ".plugin",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	131 in_sign="sss",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	132 out_sign="",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	133 method=self._setAvatar,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	134 async_=True,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	135 )
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	136
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	137 async def profileConnecting(self, client):
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	138 client._identity_update_lock = []
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	139 # we restore known identities from database
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	140 client._identity_storage = persistent.LazyPersistentBinaryDict(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	141 "identity", client.profile)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	142
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	143 stored_data = await client._identity_storage.all()
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	144
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	145 to_delete = []
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	146
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	147 for key, value in stored_data.items():
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	148 entity_s, name = key.split('\n')
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	149 if name not in self.metadata.keys():
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	150 log.debug(f"removing {key} from storage: not an allowed metadata name")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	151 to_delete.append(key)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	152 continue
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	153 entity = jid.JID(entity_s)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	154
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	155 if name == 'avatar':
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	156 if value is not None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	157 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	158 cache_uid = value['cache_uid']
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	159 if not cache_uid:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	160 raise ValueError
3326 9e1ba1e1179f plugin identity: added "filename" metadata for avatar Goffi <goffi@goffi.org> parents: 3278 diff changeset	161 filename = value['filename']
9e1ba1e1179f plugin identity: added "filename" metadata for avatar Goffi <goffi@goffi.org> parents: 3278 diff changeset	162 if not filename:
9e1ba1e1179f plugin identity: added "filename" metadata for avatar Goffi <goffi@goffi.org> parents: 3278 diff changeset	163 raise ValueError
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	164 except (ValueError, KeyError):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	165 log.warning(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	166 f"invalid data for {entity} avatar, it will be deleted: "
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	167 f"{value}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	168 to_delete.append(key)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	169 continue
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	170 cache = self.host.common_cache.getMetadata(cache_uid)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	171 if cache is None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	172 log.debug(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	173 f"purging avatar for {entity}: it is not in cache anymore")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	174 to_delete.append(key)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	175 continue
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	176
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	177 self.host.memory.updateEntityData(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	178 client, entity, name, value, silent=True
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	179 )
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	180
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	181 for key in to_delete:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	182 await client._identity_storage.adel(key)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	183
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	184 def _rosterUpdateTrigger(self, client, roster_item):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	185 old_item = client.roster.getItem(roster_item.jid)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	186 if old_item is None or old_item.name != roster_item.name:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	187 log.debug(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	188 f"roster nickname has been updated to {roster_item.name!r} for "
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	189 f"{roster_item.jid}"
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	190 )
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	191 defer.ensureDeferred(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	192 self.update(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	193 client,
3338 203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	194 IMPORT_NAME,
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	195 "nicknames",
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	196 [roster_item.name],
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	197 roster_item.jid
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	198 )
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	199 )
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	200 return True
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	201
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	202 def register(
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	203 self,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	204 origin: str,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	205 metadata_name: str,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	206 cb_get: Union[Coroutine, defer.Deferred],
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	207 cb_set: Union[Coroutine, defer.Deferred],
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	208 priority: int=0):
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	209 """Register callbacks to handle identity metadata
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	210
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	211 @param origin: namespace of the plugin managing this metadata
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	212 @param metadata_name: name of metadata can be:
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	213 - avatar
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	214 - nicknames
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	215 @param cb_get: method to retrieve a metadata
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	216 the method will get client and metadata names to retrieve as arguments.
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	217 @param cb_set: method to set a metadata
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	218 the method will get client, metadata name to set, and value as argument.
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	219 @param priority: priority of this method for the given metadata.
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	220 methods with bigger priorities will be called first
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	221 """
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	222 if not metadata_name in self.metadata.keys():
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	223 raise ValueError(f"Invalid metadata_name: {metadata_name!r}")
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	224 callback = Callback(origin=origin, get=cb_get, set=cb_set, priority=priority)
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	225 cb_list = self.metadata[metadata_name].setdefault('callbacks', [])
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	226 cb_list.append(callback)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	227 cb_list.sort(key=lambda c: c.priority, reverse=True)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	228
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	229 def getIdentityJid(self, client, peer_jid):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	230 """Return jid to use to set identity metadata
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	231
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	232 if it's a jid of a room occupant, full jid will be used
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	233 otherwise bare jid will be used
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	234 if None, bare jid of profile will be used
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	235 @return (jid.JID): jid to use for avatar
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	236 """
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	237 if peer_jid is None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	238 return client.jid.userhostJID()
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	239 if self._m is None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	240 return peer_jid.userhostJID()
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	241 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	242 return self._m.getBareOrFull(client, peer_jid)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	243
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	244 def checkType(self, metadata_name, value):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	245 """Check that type used for a metadata is the one declared in self.metadata"""
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	246 value_type = self.metadata[metadata_name]["type"]
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	247 if not isinstance(value, value_type):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	248 raise ValueError(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	249 f"{value} has wrong type: it is {type(value)} while {value_type} was "
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	250 f"expected")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	251
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	252 async def get(
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	253 self,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	254 client: SatXMPPEntity,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	255 metadata_name: str,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	256 entity: Optional[jid.JID],
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	257 use_cache: bool=True,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	258 prefilled_values: Optional[Dict[str, Any]]=None
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	259 ):
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	260 """Retrieve identity metadata of an entity
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	261
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	262 if metadata is already in cache, it is returned. Otherwise, registered callbacks
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	263 will be tried in priority order (bigger to lower)
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	264 @param metadata_name: name of the metadata
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	265 must be one of self.metadata key
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	266 the name will also be used as entity data name in host.memory
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	267 @param entity: entity for which avatar is requested
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	268 None to use profile's jid
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	269 @param use_cache: if False, cache won't be checked
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	270 @param prefilled_values: map of origin => value to use when `get_all` is set
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	271 """
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	272 entity = self.getIdentityJid(client, entity)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	273 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	274 metadata = self.metadata[metadata_name]
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	275 except KeyError:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	276 raise ValueError(f"Invalid metadata name: {metadata_name!r}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	277 get_all = metadata.get('get_all', False)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	278 if use_cache:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	279 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	280 data = self.host.memory.getEntityDatum(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	281 client, entity, metadata_name)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	282 except (KeyError, exceptions.UnknownEntityError):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	283 pass
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	284 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	285 return data
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	286
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	287 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	288 callbacks = metadata['callbacks']
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	289 except KeyError:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	290 log.warning(_("No callback registered for {metadata_name}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	291 .format(metadata_name=metadata_name))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	292 return [] if get_all else None
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	293
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	294 if get_all:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	295 all_data = []
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	296 elif prefilled_values is not None:
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	297 raise exceptions.InternalError(
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	298 "prefilled_values can only be used when `get_all` is set")
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	299
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	300 for callback in callbacks:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	301 try:
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	302 if prefilled_values is not None and callback.origin in prefilled_values:
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	303 data = prefilled_values[callback.origin]
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	304 log.debug(
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	305 f"using prefilled values {data!r} for {metadata_name} with "
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	306 f"{callback.origin}")
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	307 else:
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	308 data = await defer.ensureDeferred(callback.get(client, entity))
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	309 except exceptions.CancelError:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	310 continue
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	311 except Exception as e:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	312 log.warning(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	313 _("Error while trying to get {metadata_name} with {callback}: {e}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	314 .format(callback=callback.get, metadata_name=metadata_name, e=e))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	315 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	316 if data:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	317 self.checkType(metadata_name, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	318 if get_all:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	319 all_data.extend(data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	320 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	321 break
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	322 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	323 data = None
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	324
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	325 if get_all:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	326 data = all_data
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	327
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	328 post_treatment = metadata.get("get_post_treatment")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	329 if post_treatment is not None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	330 data = await utils.asDeferred(post_treatment, client, entity, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	331
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	332 self.host.memory.updateEntityData(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	333 client, entity, metadata_name, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	334
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	335 if metadata.get('store', False):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	336 key = f"{entity}\n{metadata_name}"
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	337 await client._identity_storage.aset(key, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	338
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	339 return data
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	340
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	341 async def set(self, client, metadata_name, data, entity=None):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	342 """Set identity metadata for an entity
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	343
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	344 Registered callbacks will be tried in priority order (bigger to lower)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	345 @param metadata_name(str): name of the metadata
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	346 must be one of self.metadata key
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	347 the name will also be used to set entity data in host.memory
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	348 @param data(object): value to set
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	349 @param entity(jid.JID, None): entity for which avatar is requested
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	350 None to use profile's jid
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	351 """
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	352 entity = self.getIdentityJid(client, entity)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	353 metadata = self.metadata[metadata_name]
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	354 data_filter = metadata.get("set_data_filter")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	355 if data_filter is not None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	356 data = await utils.asDeferred(data_filter, client, entity, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	357 self.checkType(metadata_name, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	358
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	359 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	360 callbacks = metadata['callbacks']
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	361 except KeyError:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	362 log.warning(_("No callback registered for {metadata_name}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	363 .format(metadata_name=metadata_name))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	364 return exceptions.FeatureNotFound(f"Can't set {metadata_name} for {entity}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	365
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	366 for callback in callbacks:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	367 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	368 await defer.ensureDeferred(callback.set(client, data, entity))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	369 except exceptions.CancelError:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	370 continue
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	371 except Exception as e:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	372 log.warning(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	373 _("Error while trying to set {metadata_name} with {callback}: {e}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	374 .format(callback=callback.set, metadata_name=metadata_name, e=e))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	375 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	376 break
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	377 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	378 raise exceptions.FeatureNotFound(f"Can't set {metadata_name} for {entity}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	379
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	380 post_treatment = metadata.get("set_post_treatment")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	381 if post_treatment is not None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	382 await utils.asDeferred(post_treatment, client, entity, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	383
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	384 async def update(
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	385 self,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	386 client: SatXMPPEntity,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	387 origin: str,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	388 metadata_name: str,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	389 data: Any,
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	390 entity: Optional[jid.JID]
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	391 ):
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	392 """Update a metadata in cache
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	393
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	394 This method may be called by plugins when an identity metadata is available.
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	395 @param origin: namespace of the plugin which is source of the metadata
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	396 """
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	397 entity = self.getIdentityJid(client, entity)
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	398 if (entity, metadata_name) in client._identity_update_lock:
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	399 log.debug(f"update is locked for {entity}'s {metadata_name}")
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	400 return
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	401 metadata = self.metadata[metadata_name]
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	402
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	403 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	404 cached_data = self.host.memory.getEntityDatum(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	405 client, entity, metadata_name)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	406 except (KeyError, exceptions.UnknownEntityError):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	407 # metadata is not cached, we do the update
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	408 pass
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	409 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	410 # metadata is cached, we check if the new value differs from the cached one
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	411 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	412 update_is_new_data = metadata["update_is_new_data"]
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	413 except KeyError:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	414 update_is_new_data = self.defaultUpdateIsNewData
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	415
3257 704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	416 if data is None:
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	417 if cached_data is None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	418 log.debug(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	419 f"{metadata_name} for {entity} is already disabled, nothing to "
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	420 f"do")
3257 704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	421 return
3262 aa71f1d40300 plugin identity: fixed update when cached data is None Goffi <goffi@goffi.org> parents: 3257 diff changeset	422 elif cached_data is None:
aa71f1d40300 plugin identity: fixed update when cached data is None Goffi <goffi@goffi.org> parents: 3257 diff changeset	423 pass
3257 704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	424 elif not update_is_new_data(client, entity, cached_data, data):
704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	425 log.debug(
704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	426 f"{metadata_name} for {entity} is already in cache, nothing to "
704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	427 f"do")
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	428 return
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	429
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	430 # we can't use the cache, so we do the update
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	431
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	432 log.debug(f"updating {metadata_name} for {entity}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	433
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	434 if metadata.get('get_all', False):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	435 # get_all is set, meaning that we have to check all plugins
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	436 # so we first delete current cache
3257 704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	437 try:
704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	438 self.host.memory.delEntityDatum(client, entity, metadata_name)
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	439 except (KeyError, exceptions.UnknownEntityError):
3257 704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	440 pass
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	441 # then fill it again by calling get, which will retrieve all values
3277 cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	442 # we lock update to avoid infinite recursions (update can be called during
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	443 # get callbacks)
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	444 client._identity_update_lock.append((entity, metadata_name))
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	445 await self.get(client, metadata_name, entity, prefilled_values={origin: data})
cf07641b764d plugin identity: fixed infinite loop on nicknames update Goffi <goffi@goffi.org> parents: 3262 diff changeset	446 client._identity_update_lock.remove((entity, metadata_name))
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	447 return
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	448
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	449 if data is not None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	450 data_filter = metadata['update_data_filter']
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	451 if data_filter is not None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	452 data = await utils.asDeferred(data_filter, client, entity, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	453 self.checkType(metadata_name, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	454
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	455 self.host.memory.updateEntityData(client, entity, metadata_name, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	456
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	457 if metadata.get('store', False):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	458 key = f"{entity}\n{metadata_name}"
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	459 await client._identity_storage.aset(key, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	460
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	461 def defaultUpdateIsNewData(self, client, entity, cached_data, new_data):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	462 return new_data != cached_data
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	463
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	464 def _getAvatar(self, entity, use_cache, profile):
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	465 client = self.host.getClient(profile)
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	466 entity = jid.JID(entity) if entity else None
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	467 d = defer.ensureDeferred(self.get(client, "avatar", entity, use_cache))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	468 d.addCallback(lambda data: data_format.serialise(data))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	469 return d
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	470
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	471 def _setAvatar(self, file_path, entity, profile_key=C.PROF_KEY_NONE):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	472 client = self.host.getClient(profile_key)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	473 entity = jid.JID(entity) if entity else None
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	474 return defer.ensureDeferred(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	475 self.set(client, "avatar", file_path, entity))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	476
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	477 async def avatarSetDataFilter(self, client, entity, file_path):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	478 """Convert avatar file path to dict data"""
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	479 file_path = Path(file_path)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	480 if not file_path.is_file():
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	481 raise ValueError(f"There is no file at {file_path} to use as avatar")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	482 avatar_data = {
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	483 'path': file_path,
3326 9e1ba1e1179f plugin identity: added "filename" metadata for avatar Goffi <goffi@goffi.org> parents: 3278 diff changeset	484 'filename': file_path.name,
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	485 'media_type': image.guess_type(file_path),
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	486 }
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	487 media_type = avatar_data['media_type']
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	488 if media_type is None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	489 raise ValueError(f"Can't identify type of image at {file_path}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	490 if not media_type.startswith('image/'):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	491 raise ValueError(f"File at {file_path} doesn't appear to be an image")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	492 return avatar_data
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	493
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	494 async def avatarSetPostTreatment(self, client, entity, avatar_data):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	495 """Update our own avatar"""
3278 27d4b71e264a plugin identity: fixed update in avatarSetPostTreatment Goffi <goffi@goffi.org> parents: 3277 diff changeset	496 await self.update(client, IMPORT_NAME, "avatar", avatar_data, entity)
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	497
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	498 def avatarBuildMetadata(self, path, media_type=None, cache_uid=None):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	499 """Helper method to generate avatar metadata
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	500
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	501 @param path(str, Path, None): path to avatar file
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	502 avatar file must be in cache
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	503 None if avatar is explicitely not set
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	504 @param media_type(str, None): type of the avatar file (MIME type)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	505 @param cache_uid(str, None): UID of avatar in cache
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	506 @return (dict, None): avatar metadata
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	507 None if avatar is not set
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	508 """
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	509 if path is None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	510 return None
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	511 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	512 if cache_uid is None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	513 raise ValueError("cache_uid must be set if path is set")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	514 path = Path(path)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	515 if media_type is None:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	516 media_type = image.guess_type(path)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	517
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	518 return {
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	519 "path": path,
3326 9e1ba1e1179f plugin identity: added "filename" metadata for avatar Goffi <goffi@goffi.org> parents: 3278 diff changeset	520 "filename": path.name,
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	521 "media_type": media_type,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	522 "cache_uid": cache_uid,
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	523 }
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	524
3257 704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	525 def avatarUpdateIsNewData(self, client, entity, cached_data, new_data):
704dada41df0 plugin identity: fixed update with `get_all` + better new data detection for avatar: Goffi <goffi@goffi.org> parents: 3254 diff changeset	526 return new_data['path'] != cached_data['path']
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	527
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	528 async def avatarUpdateDataFilter(self, client, entity, data):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	529 if not isinstance(data, dict):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	530 raise ValueError(f"Invalid data type ({type(data)}), a dict is expected")
3326 9e1ba1e1179f plugin identity: added "filename" metadata for avatar Goffi <goffi@goffi.org> parents: 3278 diff changeset	531 mandatory_keys = {'path', 'filename', 'cache_uid'}
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	532 if not data.keys() >= mandatory_keys:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	533 raise ValueError(f"missing avatar data keys: {mandatory_keys - data.keys()}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	534 return data
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	535
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	536 async def nicknamesGetPostTreatment(self, client, entity, plugin_nicknames):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	537 """Prepend nicknames from core locations + set default nickname
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	538
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	539 nicknames are checked from many locations, there is always at least
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	540 one nickname. First nickname of the list can be used in priority.
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	541 Nicknames are appended in this order:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	542 - roster, plugins set nicknames
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	543 - if no nickname is found, user part of jid is then used, or bare jid
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	544 if there is no user part.
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	545 For MUC, room nick is always put first
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	546 """
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	547 # we first check roster
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	548 nicknames = []
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	549 if entity.resource:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	550 # getIdentityJid let the resource only if the entity is a MUC room
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	551 # occupant jid
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	552 nicknames.append(entity.resource)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	553
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	554 roster_item = client.roster.getItem(entity.userhostJID())
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	555 if roster_item is not None and roster_item.name:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	556 # user set name has priority over entity set name
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	557 nicknames.append(roster_item.name)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	558
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	559 nicknames.extend(plugin_nicknames)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	560
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	561 if not nicknames:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	562 if entity.user:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	563 nicknames.append(entity.user.capitalize())
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	564 else:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	565 nicknames.append(entity.userhost())
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	566
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	567 # we remove duplicates while preserving order with dict
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	568 return list(dict.fromkeys(nicknames))
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	569
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	570 def nicknamesUpdateIsNewData(self, client, entity, cached_data, new_nicknames):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	571 return not set(new_nicknames).issubset(cached_data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	572
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	573 def _getIdentity(self, entity_s, metadata_filter, use_cache, profile):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	574 entity = jid.JID(entity_s)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	575 client = self.host.getClient(profile)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	576 d = defer.ensureDeferred(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	577 self.getIdentity(client, entity, metadata_filter, use_cache))
3338 203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	578 d.addCallback(data_format.serialise)
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	579 return d
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	580
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	581 async def getIdentity(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	582 self, client, entity=None, metadata_filter=None, use_cache=True):
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	583 """Retrieve identity of an entity
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	584
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	585 @param entity(jid.JID, None): entity to check
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	586 @param metadata_filter(list[str], None): if not None or empty, only return
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	587 metadata in this filter
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	588 @param use_cache(bool): if False, cache won't be checked
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	589 should be True most of time, to avoid useless network requests
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	590 @return (dict): identity data
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	591 """
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	592 id_data = {}
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	593
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	594 if not metadata_filter:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	595 metadata_names = self.metadata.keys()
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	596 else:
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	597 metadata_names = metadata_filter
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	598
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	599 for metadata_name in metadata_names:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	600 id_data[metadata_name] = await self.get(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	601 client, metadata_name, entity, use_cache)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	602
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	603 return id_data
2463 65a6d2496504 plugin identity: return resource for MUC room occupants' nicks + added avatar and avatar_basename. Goffi <goffi@goffi.org> parents: 2427 diff changeset	604
3338 203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	605 def _getIdentities(self, entities_s, metadata_filter, profile):
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	606 entities = [jid.JID(e) for e in entities_s]
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	607 client = self.host.getClient(profile)
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	608 d = defer.ensureDeferred(self.getIdentities(client, entities, metadata_filter))
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	609 d.addCallback(lambda d: data_format.serialise({str(j):i for j, i in d.items()}))
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	610 return d
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	611
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	612 async def getIdentities(
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	613 self,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	614 client: SatXMPPEntity,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	615 entities: List[jid.JID],
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	616 metadata_filter: Optional[List[str]] = None,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	617 ) -> dict:
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	618 """Retrieve several identities at once
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	619
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	620 @param entities: entities from which identities must be retrieved
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	621 @param metadata_filter: same as for [getIdentity]
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	622 @return: identities metadata where key is jid
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	623 if an error happens while retrieve a jid entity, it won't be present in the
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	624 result (and a warning will be logged)
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	625 """
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	626 identities = {}
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	627 get_identity_list = []
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	628 for entity_jid in entities:
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	629 get_identity_list.append(
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	630 defer.ensureDeferred(
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	631 self.getIdentity(
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	632 client,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	633 entity=entity_jid,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	634 metadata_filter=metadata_filter,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	635 )
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	636 )
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	637 )
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	638 identities_result = await defer.DeferredList(get_identity_list)
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	639 for idx, (success, identity) in enumerate(identities_result):
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	640 entity_jid = entities[idx]
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	641 if not success:
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	642 log.warning(f"Can't get identity for {entity_jid}")
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	643 else:
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	644 identities[entity_jid] = identity
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	645 return identities
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	646
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	647 def _getBaseIdentities(self, profile_key):
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	648 client = self.host.getClient(profile_key)
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	649 d = defer.ensureDeferred(self.getBaseIdentities(client))
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	650 d.addCallback(lambda d: data_format.serialise({str(j):i for j, i in d.items()}))
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	651 return d
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	652
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	653 async def getBaseIdentities(
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	654 self,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	655 client: SatXMPPEntity,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	656 ) -> dict:
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	657 """Retrieve identities for entities in roster + own identity + invitations
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	658
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	659 @param with_guests: if True, get affiliations of people invited by email
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	660
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	661 """
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	662 entities = client.roster.getJids() + [client.jid.userhostJID()]
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	663
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	664 return await self.getIdentities(
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	665 client,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	666 entities,
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	667 ['avatar', 'nicknames']
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	668 )
203a491fcd86 plugin identity: new methods `identitiesGet` and `identitiesBaseGet` Goffi <goffi@goffi.org> parents: 3326 diff changeset	669
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	670 def _setIdentity(self, id_data_s, profile):
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	671 client = self.host.getClient(profile)
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	672 id_data = data_format.deserialise(id_data_s)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	673 return defer.ensureDeferred(self.setIdentity(client, id_data))
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	674
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	675 async def setIdentity(self, client, id_data):
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	676 """Update profile's identity
db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	677
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	678 @param id_data(dict): data to update, key can be on of self.metadata keys
2253 db468f24b9fc plugin identity: plugin identity first draft: Goffi <goffi@goffi.org> parents: diff changeset	679 """
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	680 if not id_data.keys() <= self.metadata.keys():
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	681 raise ValueError(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	682 f"Invalid metadata names: {id_data.keys() - self.metadata.keys()}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	683 for metadata_name, data in id_data.items():
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	684 try:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	685 await self.set(client, metadata_name, data)
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	686 except Exception as e:
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	687 log.warning(
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	688 _("Can't set metadata {metadata_name!r}: {reason}")
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3137 diff changeset	689 .format(metadata_name=metadata_name, reason=e))

Mercurial > libervia-backend

annotate sat/plugins/plugin_misc_identity.py @ 3758:b7cef1b24f83