libervia-backend: sat/plugins/plugin_misc

comparison sat/plugins/plugin_misc_identity.py @ 3817:998c5318230f

plugin identity: make the plugin compatible with component + description: the plugin can now be used with components. the new `description` field is now available. rel 368

author	Goffi <goffi@goffi.org>
date	Wed, 29 Jun 2022 11:49:03 +0200
parents	213e83a4ed10
children	524856bd7b19

comparison

equal deleted inserted replaced

-:213e83a4ed10
+:998c5318230f
 PLUGIN_INFO = {
 C.PI_NAME: "Identity Plugin",
 C.PI_IMPORT_NAME: IMPORT_NAME,
 C.PI_TYPE: C.PLUG_TYPE_MISC,
+C.PI_MODES: C.PLUG_MODE_BOTH,
 C.PI_PROTOCOLS: [],
 C.PI_DEPENDENCIES: [],
 C.PI_RECOMMENDATIONS: ["XEP-0045"],
 C.PI_MAIN: "Identity",
 C.PI_HANDLER: "no",
 # append nicknames from roster, resource, etc.
 "get_post_treatment": self.nicknamesGetPostTreatment,
 "update_is_new_data": self.nicknamesUpdateIsNewData,
 "store": True,
 },
+"description": {
+"type": str,
+"get_all": True,
+"get_post_treatment": self.descriptionGetPostTreatment,
+"store": True,
+}
 }
 host.trigger.add("roster_update", self._rosterUpdateTrigger)
 host.memory.setSignalOnUpdate("avatar")
 host.memory.setSignalOnUpdate("nicknames")
 host.bridge.addMethod(
 if not isinstance(value, value_type):
 raise ValueError(
 f"{value} has wrong type: it is {type(value)} while {value_type} was "
 f"expected")
+def getFieldType(self, metadata_name: str) -> str:
+"""Return the type the requested field
+@param metadata_name: name of the field to check
+@raise KeyError: the request field doesn't exist
+"""
+return self.metadata[metadata_name]["type"]
 async def get(
 self,
 client: SatXMPPEntity,
 metadata_name: str,
 entity: Optional[jid.JID],
 .format(callback=callback.get, metadata_name=metadata_name, e=e))
 else:
 if data:
 self.checkType(metadata_name, data)
 if get_all:
-all_data.extend(data)
+if isinstance(data, list):
+all_data.extend(data)
+else:
+all_data.append(data)
 else:
 break
 else:
 data = None
 post_treatment = metadata.get("set_post_treatment")
 if post_treatment is not None:
 await utils.asDeferred(post_treatment, client, entity, data)
 async def update(
 self,
 client: SatXMPPEntity,
 origin: str,
 metadata_name: str,
 data: Any,
 entity: Optional[jid.JID]
 ):
 """Update a metadata in cache
 This method may be called by plugins when an identity metadata is available.
 @param origin: namespace of the plugin which is source of the metadata
 """
 - roster, plugins set nicknames
 - if no nickname is found, user part of jid is then used, or bare jid
 if there is no user part.
 For MUC, room nick is always put first
 """
-# we first check roster
 nicknames = []
+# for MUC we add resource
 if entity.resource:
 # getIdentityJid let the resource only if the entity is a MUC room
 # occupant jid
 nicknames.append(entity.resource)
-roster_item = client.roster.getItem(entity.userhostJID())
+# we first check roster (if we are not in a component)
-if roster_item is not None and roster_item.name:
+if not client.is_component:
-# user set name has priority over entity set name
+roster_item = client.roster.getItem(entity.userhostJID())
-nicknames.append(roster_item.name)
+if roster_item is not None and roster_item.name:
+# user set name has priority over entity set name
+nicknames.append(roster_item.name)
 nicknames.extend(plugin_nicknames)
 if not nicknames:
 if entity.user:
 # we remove duplicates while preserving order with dict
 return list(dict.fromkeys(nicknames))
 def nicknamesUpdateIsNewData(self, client, entity, cached_data, new_nicknames):
 return not set(new_nicknames).issubset(cached_data)
+async def descriptionGetPostTreatment(
+self,
+client: SatXMPPEntity,
+entity: jid.JID,
+plugin_description: List[str]
+) -> str:
+"""Join all descriptions in a unique string"""
+return '\n'.join(plugin_description)
 def _getIdentity(self, entity_s, metadata_filter, use_cache, profile):
 entity = jid.JID(entity_s)
 client = self.host.getClient(profile)
 d = defer.ensureDeferred(
 self.getIdentity(client, entity, metadata_filter, use_cache))
 d.addCallback(data_format.serialise)
 return d
 async def getIdentity(
-self, client, entity=None, metadata_filter=None, use_cache=True):
+self,
+client: SatXMPPEntity,
+entity: Optional[jid.JID] = None,
+metadata_filter: Optional[List[str]] = None,
+use_cache: bool = True
+) -> Dict[str, Any]:
 """Retrieve identity of an entity
-@param entity(jid.JID, None): entity to check
+@param entity: entity to check
-@param metadata_filter(list[str], None): if not None or empty, only return
+@param metadata_filter: if not None or empty, only return
 metadata in this filter
-@param use_cache(bool): if False, cache won't be checked
+@param use_cache: if False, cache won't be checked
 should be True most of time, to avoid useless network requests
-@return (dict): identity data
+@return: identity data
 """
 id_data = {}
 if not metadata_filter:
 metadata_names = self.metadata.keys()
 """Retrieve identities for entities in roster + own identity + invitations
 @param with_guests: if True, get affiliations of people invited by email
 """
-entities = client.roster.getJids() + [client.jid.userhostJID()]
+if client.is_component:
+entities = [client.jid.userhostJID()]
+else:
+entities = client.roster.getJids() + [client.jid.userhostJID()]
 return await self.getIdentities(
 client,
 entities,
 ['avatar', 'nicknames']
 return defer.ensureDeferred(self.setIdentity(client, id_data))
 async def setIdentity(self, client, id_data):
 """Update profile's identity
-@param id_data(dict): data to update, key can be on of self.metadata keys
+@param id_data(dict): data to update, key can be one of self.metadata keys
 """
 if not id_data.keys() <= self.metadata.keys():
 raise ValueError(
 f"Invalid metadata names: {id_data.keys() - self.metadata.keys()}")
 for metadata_name, data in id_data.items():

Mercurial > libervia-backend

comparison sat/plugins/plugin_misc_identity.py @ 3817:998c5318230f