fbfe96c505
/!\ this is a huge commit /!\ starting from this commit, SàT is needs Python 3.6+ /!\ SàT maybe be instable or some feature may not work anymore, this will improve with time This patch port backend, bridge and frontends to Python 3. Roughly this has been done this way: - 2to3 tools has been applied (with python 3.7) - all references to python2 have been replaced with python3 (notably shebangs) - fixed files not handled by 2to3 (notably the shell script) - several manual fixes - fixed issues reported by Python 3 that where not handled in Python 2 - replaced "async" with "async_" when needed (it's a reserved word from Python 3.7) - replaced zope's "implements" with @implementer decorator - temporary hack to handle data pickled in database, as str or bytes may be returned, to be checked later - fixed hash comparison for password - removed some code which is not needed anymore with Python 3 - deactivated some code which needs to be checked (notably certificate validation) - tested with jp, fixed reported issues until some basic commands worked - ported Primitivus (after porting dependencies like urwid satext) - more manual fixes
128 lines
4.2 KiB
Python
128 lines
4.2 KiB
Python
#!/usr/bin/env python3
|
||
# -*- coding: utf-8 -*-
|
||
|
||
# SAT plugin for managing xep-0054
|
||
# Copyright (C) 2009-2019 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 import exceptions
|
||
from sat.core.log import getLogger
|
||
|
||
log = getLogger(__name__)
|
||
from twisted.internet import defer
|
||
from twisted.words.protocols.jabber import jid
|
||
import os.path
|
||
|
||
|
||
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(_("Plugin Identity initialization"))
|
||
self.host = host
|
||
self._v = host.plugins["XEP-0054"]
|
||
host.bridge.addMethod(
|
||
"identityGet",
|
||
".plugin",
|
||
in_sign="ss",
|
||
out_sign="a{ss}",
|
||
method=self._getIdentity,
|
||
async_=True,
|
||
)
|
||
host.bridge.addMethod(
|
||
"identitySet",
|
||
".plugin",
|
||
in_sign="a{ss}s",
|
||
out_sign="",
|
||
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["nick"] = roster_item.name
|
||
elif jid_.resource and self._v.isRoom(client, jid_):
|
||
id_data["nick"] = jid_.resource
|
||
else:
|
||
# and finally then vcard
|
||
nick = yield self._v.getNick(client, jid_)
|
||
if nick:
|
||
id_data["nick"] = nick
|
||
elif jid_.user:
|
||
id_data["nick"] = jid_.user.capitalize()
|
||
else:
|
||
id_data["nick"] = jid_.userhost()
|
||
|
||
try:
|
||
avatar_path = id_data["avatar"] = yield self._v.getAvatar(
|
||
client, jid_, cache_only=False
|
||
)
|
||
except exceptions.NotFound:
|
||
pass
|
||
else:
|
||
if avatar_path:
|
||
id_data["avatar_basename"] = os.path.basename(avatar_path)
|
||
else:
|
||
del id_data["avatar"]
|
||
|
||
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 list(id_data.keys()) != ["nick"]:
|
||
raise NotImplementedError("Only nick can be updated for now")
|
||
if "nick" in id_data:
|
||
return self._v.setNick(client, id_data["nick"])
|