# HG changeset patch
# User Goffi <goffi@goffi.org>
# Date 1495389897 -7200
# Node ID db468f24b9fcea000c56b1f57f7be95d142fe511
# Parent  cffa50c9f26bced28f7dc37e0693a032dd94a7e3
plugin identity: plugin identity first draft:
this new plugin is a high level way to manage profile or entity identities, i.e. informations about them.
It has been created to handle easily data which can be in several location (e.g. roster, vcard-tmp, vcard4, etc.)
For now, only nickname can be gotten/set (set only works for profile's own identity, while get can be used on any jid).

diff -r cffa50c9f26b -r db468f24b9fc src/plugins/plugin_misc_identity.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/plugins/plugin_misc_identity.py	Sun May 21 20:04:57 2017 +0200
@@ -0,0 +1,94 @@
+#!/usr/bin/env python2
+# -*- coding: utf-8 -*-
+
+# SAT plugin for managing xep-0054
+# Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
+# Copyright (C) 2014 Emmanuel Gil Peyrot (linkmauve@linkmauve.fr)
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from sat.core.i18n import _
+from sat.core.constants import Const as C
+from sat.core.log import getLogger
+log = getLogger(__name__)
+from twisted.internet import defer
+from twisted.words.protocols.jabber import jid
+
+
+PLUGIN_INFO = {
+    C.PI_NAME: "Identity Plugin",
+    C.PI_IMPORT_NAME: "IDENTITY",
+    C.PI_TYPE: C.PLUG_TYPE_MISC ,
+    C.PI_PROTOCOLS: [],
+    C.PI_DEPENDENCIES: ["XEP-0054"],
+    C.PI_RECOMMENDATIONS: [],
+    C.PI_MAIN: "Identity",
+    C.PI_HANDLER: "no",
+    C.PI_DESCRIPTION: _("""Identity manager""")
+}
+
+
+class Identity(object):
+
+    def __init__(self, host):
+        log.info(_(u"Plugin Identity initialization"))
+        self.host = host
+        self._v = host.plugins[u'XEP-0054']
+        host.bridge.addMethod(u"identityGet", u".plugin", in_sign=u'ss', out_sign=u'a{ss}', method=self._getIdentity, async=True)
+        host.bridge.addMethod(u"identitySet", u".plugin", in_sign=u'a{ss}s', out_sign=u'', method=self._setIdentity, async=True)
+
+    def _getIdentity(self, jid_str, profile):
+        jid_ = jid.JID(jid_str)
+        client = self.host.getClient(profile)
+        return self.getIdentity(client, jid_)
+
+    @defer.inlineCallbacks
+    def getIdentity(self, client, jid_):
+        """Retrieve identity of an entity
+
+        @param jid_(jid.JID): entity to check
+        @return (dict(unicode, unicode)): identity data where key can be:
+            - nick: nickname of the entity
+                nickname is checked from, in this order:
+                    roster, vCard, user part of jid
+            cache is used when possible
+        """
+        id_data = {}
+        # we first check roster
+        roster_item = yield client.roster.getItem(jid_.userhostJID)
+        if roster_item is not None and roster_item.name:
+            id_data[u'nick'] = roster_item.name
+        else:
+            # then vcard
+            nick = yield self._v.getNick(client, jid_)
+            id_data[u'nick'] = nick if nick else jid_.user
+
+        defer.returnValue(id_data)
+
+    def _setIdentity(self, id_data, profile):
+        client = self.host.getClient(profile)
+        return self.setIdentity(client, id_data)
+
+    def setIdentity(self, client, id_data):
+        """Update profile's identity
+
+        @param id_data(dict[unicode, unicode]): data to update, key can be:
+            - nick: nickname
+                the vCard will be updated
+        """
+        if id_data.keys() != [u'nick']:
+            raise NotImplementedError(u'Only nick can be updated for now')
+        if u'nick' in id_data:
+            return self._v.setNick(client, id_data[u'nick'])
+