429 lines
20 KiB
Python
Executable file
429 lines
20 KiB
Python
Executable file
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# SAT plugin for managing xep-0045
|
|
# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org)
|
|
|
|
# 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 logging import debug, info, warning, error
|
|
from twisted.internet import defer
|
|
from twisted.words.protocols.jabber import jid
|
|
|
|
from sat.core import exceptions
|
|
from sat.memory import memory
|
|
|
|
import uuid
|
|
|
|
from wokkel import muc
|
|
from sat.tools import xml_tools
|
|
|
|
|
|
try:
|
|
from twisted.words.protocols.xmlstream import XMPPHandler
|
|
except ImportError:
|
|
from wokkel.subprotocols import XMPPHandler
|
|
|
|
PLUGIN_INFO = {
|
|
"name": "XEP 0045 Plugin",
|
|
"import_name": "XEP-0045",
|
|
"type": "XEP",
|
|
"protocols": ["XEP-0045"],
|
|
"dependencies": [],
|
|
"main": "XEP_0045",
|
|
"handler": "yes",
|
|
"description": _("""Implementation of Multi-User Chat""")
|
|
}
|
|
|
|
|
|
class UnknownRoom(Exception):
|
|
pass
|
|
|
|
|
|
class XEP_0045(object):
|
|
|
|
def __init__(self, host):
|
|
info(_("Plugin XEP_0045 initialization"))
|
|
self.host = host
|
|
self.clients = {}
|
|
self._sessions = memory.Sessions()
|
|
host.bridge.addMethod("joinMUC", ".plugin", in_sign='ssa{ss}s', out_sign='s', method=self._join)
|
|
host.bridge.addMethod("mucNick", ".plugin", in_sign='sss', out_sign='', method=self.mucNick)
|
|
host.bridge.addMethod("mucLeave", ".plugin", in_sign='ss', out_sign='', method=self.mucLeave, async=True)
|
|
host.bridge.addMethod("getRoomsJoined", ".plugin", in_sign='s', out_sign='a(sass)', method=self.getRoomsJoined)
|
|
host.bridge.addMethod("getRoomsSubjects", ".plugin", in_sign='s', out_sign='a(ss)', method=self.getRoomsSubjects)
|
|
host.bridge.addMethod("getUniqueRoomName", ".plugin", in_sign='ss', out_sign='s', method=self.getUniqueName)
|
|
host.bridge.addMethod("configureRoom", ".plugin", in_sign='ss', out_sign='s', method=self._configureRoom, async=True)
|
|
host.bridge.addSignal("roomJoined", ".plugin", signature='sasss') # args: room_jid, room_nicks, user_nick, profile
|
|
host.bridge.addSignal("roomLeft", ".plugin", signature='ss') # args: room_jid, profile
|
|
host.bridge.addSignal("roomUserJoined", ".plugin", signature='ssa{ss}s') # args: room_jid, user_nick, user_data, profile
|
|
host.bridge.addSignal("roomUserLeft", ".plugin", signature='ssa{ss}s') # args: room_jid, user_nick, user_data, profile
|
|
host.bridge.addSignal("roomUserChangedNick", ".plugin", signature='ssss') # args: room_jid, old_nick, new_nick, profile
|
|
host.bridge.addSignal("roomNewSubject", ".plugin", signature='sss') # args: room_jid, subject, profile
|
|
self.__submit_conf_id = host.registerCallback(self._submitConfiguration, with_data=True)
|
|
|
|
def __check_profile(self, profile):
|
|
"""check if profile is used and connected
|
|
if profile known but disconnected, remove it from known profiles
|
|
@param profile: profile to check
|
|
@return: True if the profile is known and connected, else False"""
|
|
if not profile or profile not in self.clients or not self.host.isConnected(profile):
|
|
error(_('Unknown or disconnected profile (%s)') % profile)
|
|
if profile in self.clients:
|
|
del self.clients[profile]
|
|
return False
|
|
return True
|
|
|
|
def __room_joined(self, room, profile):
|
|
"""Called when the user is in the requested room"""
|
|
|
|
def _sendBridgeSignal(ignore=None):
|
|
self.host.bridge.roomJoined(room.roomJID.userhost(), [user.nick for user in room.roster.values()], room.nick, profile)
|
|
|
|
room_jid_s = room.roomJID.userhost()
|
|
self.host.memory.updateEntityData(room.roomJID, "type", "chatroom", profile)
|
|
self.clients[profile].joined_rooms[room_jid_s] = room
|
|
if room.locked:
|
|
#FIXME: the current behaviour is to create an instant room
|
|
#and send the signal only when the room is unlocked
|
|
#a proper configuration management should be done
|
|
print "room locked !"
|
|
self.clients[profile].configure(room.roomJID, {}).addCallbacks(_sendBridgeSignal, lambda x: error(_('Error while configuring the room')))
|
|
else:
|
|
_sendBridgeSignal()
|
|
return room
|
|
|
|
def __err_joining_room(self, failure, room_jid, nick, history_options, password, profile):
|
|
"""Called when something is going wrong when joining the room"""
|
|
if hasattr(failure.value, "condition") and failure.value.condition == 'conflict':
|
|
# we have a nickname conflict, we try again with "_" suffixed to current nickname
|
|
nick += '_'
|
|
return self.clients[profile].join(room_jid, nick, history_options, password).addCallbacks(self.__room_joined, self.__err_joining_room, callbackKeywords={'profile': profile}, errbackArgs=[room_jid, nick, history_options, password, profile])
|
|
mess = _("Error while joining the room %s" % room_jid.userhost())
|
|
error(mess)
|
|
self.host.bridge.newAlert(mess, _("Group chat error"), "ERROR", profile)
|
|
raise failure
|
|
|
|
def getRoomsJoined(self, profile_key='@DEFAULT@'):
|
|
"""Return room where user is"""
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
result = []
|
|
if not self.__check_profile(profile):
|
|
return result
|
|
for room in self.clients[profile].joined_rooms.values():
|
|
result.append((room.roomJID.userhost(), [user.nick for user in room.roster.values()], room.nick))
|
|
return result
|
|
|
|
def getRoomNick(self, room_jid_s, profile_key='@DEFAULT@'):
|
|
"""return nick used in room by user
|
|
@param room_jid_s: unicode room id
|
|
@profile_key: profile
|
|
@return: nick or empty string in case of error"""
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not self.__check_profile(profile) or room_jid_s not in self.clients[profile].joined_rooms:
|
|
return ''
|
|
return self.clients[profile].joined_rooms[room_jid_s].nick
|
|
|
|
def getRoomNickOfUser(self, room, user_jid, secure=True):
|
|
"""Returns the nick of the given user in the room.
|
|
@room: instance of wokkel.muc.Room
|
|
@user: JID or unicode (JID userhost).
|
|
@param secure: set to True for a secure check
|
|
@return: the nick or None if the user didn't join the room.
|
|
"""
|
|
if not isinstance(user_jid, jid.JID):
|
|
user_jid = jid.JID(user_jid).userhostJID()
|
|
for user in room.roster.values():
|
|
if user.entity is not None:
|
|
if user.entity.userhostJID() == user_jid.userhostJID():
|
|
return user.nick
|
|
elif not secure:
|
|
# FIXME: this is NOT ENOUGH to check an identity!!
|
|
# See in which conditions user.entity could be None.
|
|
if user.nick == user_jid.user:
|
|
return user.nick
|
|
return None
|
|
|
|
def getRoomNicksOfUsers(self, room, users=[], secure=True):
|
|
"""Returns the nicks of the given users in the room.
|
|
@room: instance of wokkel.muc.Room
|
|
@users: list of JID or unicode (JID userhost).
|
|
@param secure: set to True for a secure check
|
|
@return: (x, y) with x a list containing the nicks of
|
|
the users who are in the room, and y the missing users.
|
|
"""
|
|
nicks = []
|
|
missing = []
|
|
for user in users:
|
|
nick = self.getRoomNickOfUser(room, user, secure)
|
|
if nick is None:
|
|
missing.append(user)
|
|
else:
|
|
nicks.append(nick)
|
|
return nicks, missing
|
|
|
|
def _configureRoom(self, room_jid_s, profile_key='@NONE@'):
|
|
d = self.configureRoom(jid.JID(room_jid_s), profile_key)
|
|
d.addCallback(lambda xmlui: xmlui.toXml())
|
|
return d
|
|
|
|
def configureRoom(self, room_jid, profile_key='@NONE@'):
|
|
""" return the room configuration form
|
|
@param room: jid of the room to configure
|
|
@param profile_key: %(doc_profile_key)s
|
|
@return: configuration form as XMLUI
|
|
|
|
"""
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not self.__check_profile(profile):
|
|
raise exceptions.ProfileUnknownError("Unknown or disconnected profile")
|
|
if room_jid.userhost() not in self.clients[profile].joined_rooms:
|
|
raise UnknownRoom("This room has not been joined")
|
|
|
|
def config2XMLUI(result):
|
|
if not result:
|
|
return ""
|
|
session_id, session_data = self._sessions.newSession(profile=profile)
|
|
session_data["room_jid"] = room_jid
|
|
xmlui = xml_tools.dataForm2XMLUI(result, submit_id=self.__submit_conf_id)
|
|
xmlui.session_id = session_id
|
|
return xmlui
|
|
|
|
d = self.clients[profile].getConfiguration(room_jid)
|
|
d.addCallback(config2XMLUI)
|
|
return d
|
|
|
|
def _submitConfiguration(self, raw_data, profile):
|
|
try:
|
|
session_data = self._sessions.profileGet(raw_data["session_id"], profile)
|
|
except KeyError:
|
|
warning ("session id doesn't exist, session has probably expired")
|
|
# TODO: send error dialog
|
|
return defer.succeed({})
|
|
|
|
data = xml_tools.XMLUIResult2DataFormResult(raw_data)
|
|
d = self.clients[profile].configure(session_data['room_jid'], data)
|
|
d.addCallback(lambda ignore: {})
|
|
del self._sessions[raw_data["session_id"]]
|
|
return d
|
|
|
|
def isNickInRoom(self, room_jid, nick, profile):
|
|
"""Tell if a nick is currently present in a room"""
|
|
profile = self.host.memory.getProfileName(profile)
|
|
if not self.__check_profile(profile):
|
|
raise exceptions.ProfileUnknownError("Unknown or disconnected profile")
|
|
if room_jid.userhost() not in self.clients[profile].joined_rooms:
|
|
raise UnknownRoom("This room has not been joined")
|
|
return self.clients[profile].joined_rooms[room_jid.userhost()].inRoster(muc.User(nick))
|
|
|
|
def getRoomsSubjects(self, profile_key='@DEFAULT@'):
|
|
"""Return received subjects of rooms"""
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not self.__check_profile(profile):
|
|
return []
|
|
return self.clients[profile].rec_subjects.values()
|
|
|
|
def getMUCService(self, profile):
|
|
"""Return the MUC service or None"""
|
|
muc_service = None
|
|
for service in self.host.memory.getServerServiceEntities("conference", "text", profile=profile):
|
|
if not ".irc." in service.userhost():
|
|
#FIXME:
|
|
#This awfull ugly hack is here to avoid an issue with openfire: the irc gateway
|
|
#use "conference/text" identity (instead of "conference/irc"), there is certainly a better way
|
|
#to manage this, but this hack fill do it for test purpose
|
|
muc_service = service
|
|
break
|
|
return muc_service
|
|
|
|
def getUniqueName(self, muc_service="", profile_key='@DEFAULT@'):
|
|
"""Return unique name for room, avoiding collision
|
|
@param muc_service: leave empty string to use the default service
|
|
@return: unique room userhost, or '' if an error occured.
|
|
"""
|
|
#TODO: we should use #RFC-0045 10.1.4 when available here
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not profile:
|
|
error(_("Unknown profile"))
|
|
return ""
|
|
room_name = uuid.uuid1()
|
|
print "\n\n===> room_name:", room_name
|
|
if muc_service == "":
|
|
muc_service = self.getMUCService(profile)
|
|
if not muc_service:
|
|
error(_("Can't find a MUC service"))
|
|
return ""
|
|
muc_service = muc_service.userhost()
|
|
return "%s@%s" % (room_name, muc_service)
|
|
|
|
def join(self, room_jid, nick, options, profile_key='@DEFAULT@'):
|
|
def _errDeferred(exc_obj=Exception, txt='Error while joining room'):
|
|
d = defer.Deferred()
|
|
d.errback(exc_obj(txt))
|
|
return d
|
|
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not self.__check_profile(profile):
|
|
return _errDeferred()
|
|
if room_jid.userhost() in self.clients[profile].joined_rooms:
|
|
warning(_('%(profile)s is already in room %(room_jid)s') % {'profile': profile, 'room_jid': room_jid.userhost()})
|
|
return _errDeferred()
|
|
info(_("[%(profile)s] is joining room %(room)s with nick %(nick)s") % {'profile': profile, 'room': room_jid.userhost(), 'nick': nick})
|
|
|
|
history_options = options["history"] == "True" if "history" in options else None
|
|
password = options["password"] if "password" in options else None
|
|
|
|
return self.clients[profile].join(room_jid, nick, history_options, password).addCallbacks(self.__room_joined, self.__err_joining_room, callbackKeywords={'profile': profile}, errbackArgs=[room_jid, nick, history_options, password, profile])
|
|
# FIXME: how to set the cancel method on the Deferred created by wokkel?
|
|
# This happens when the room is not reachable, e.g. no internet connection:
|
|
# > /usr/local/lib/python2.7/dist-packages/twisted/internet/defer.py(480)_startRunCallbacks()
|
|
# -> raise AlreadyCalledError(extra)
|
|
|
|
def _join(self, room_jid_s, nick, options={}, profile_key='@DEFAULT@'):
|
|
"""join method used by bridge: use the join method, but doesn't return any deferred
|
|
@return the room userhost (given value or unique generated name)
|
|
"""
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not self.__check_profile(profile):
|
|
return
|
|
if room_jid_s == "":
|
|
room_jid_s = self.getUniqueName(profile_key=profile_key)
|
|
try:
|
|
room_jid = jid.JID(room_jid_s)
|
|
except:
|
|
mess = _("Invalid room jid: %s") % room_jid_s
|
|
warning(mess)
|
|
self.host.bridge.newAlert(mess, _("Group chat error"), "ERROR", profile)
|
|
return
|
|
d = self.join(room_jid, nick, options, profile)
|
|
# TODO: error management + signal in bridge
|
|
return room_jid_s
|
|
|
|
def nick(self, room_jid, nick, profile_key):
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not self.__check_profile(profile):
|
|
raise exceptions.ProfileUnknownError("Unknown or disconnected profile")
|
|
if room_jid.userhost() not in self.clients[profile].joined_rooms:
|
|
raise UnknownRoom("This room has not been joined")
|
|
return self.clients[profile].nick(room_jid, nick)
|
|
|
|
def leave(self, room_jid, profile_key):
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not self.__check_profile(profile):
|
|
raise exceptions.ProfileUnknownError("Unknown or disconnected profile")
|
|
if room_jid.userhost() not in self.clients[profile].joined_rooms:
|
|
raise UnknownRoom("This room has not been joined")
|
|
return self.clients[profile].leave(room_jid)
|
|
|
|
def subject(self, room_jid, subject, profile_key):
|
|
profile = self.host.memory.getProfileName(profile_key)
|
|
if not self.__check_profile(profile):
|
|
raise exceptions.ProfileUnknownError("Unknown or disconnected profile")
|
|
if room_jid.userhost() not in self.clients[profile].joined_rooms:
|
|
raise UnknownRoom("This room has not been joined")
|
|
return self.clients[profile].subject(room_jid, subject)
|
|
|
|
def mucNick(self, room_jid_s, nick, profile_key='@DEFAULT@'):
|
|
"""Change nickname in a room"""
|
|
return self.nick(jid.JID(room_jid_s), nick, profile_key)
|
|
|
|
def mucLeave(self, room_jid_s, profile_key='@DEFAULT@'):
|
|
"""Leave a room"""
|
|
return self.leave(jid.JID(room_jid_s), profile_key)
|
|
|
|
def getHandler(self, profile):
|
|
self.clients[profile] = SatMUCClient(self)
|
|
return self.clients[profile]
|
|
|
|
|
|
class SatMUCClient (muc.MUCClient):
|
|
#implements(iwokkel.IDisco)
|
|
|
|
def __init__(self, plugin_parent):
|
|
self.plugin_parent = plugin_parent
|
|
self.host = plugin_parent.host
|
|
muc.MUCClient.__init__(self)
|
|
self.joined_rooms = {} # FIXME: seem to do the same thing as MUCClient's _rooms attribute, must be removed
|
|
self.rec_subjects = {}
|
|
self.__changing_nicks = set() # used to keep trace of who is changing nick,
|
|
# and to discard userJoinedRoom signal in this case
|
|
print "init SatMUCClient OK"
|
|
|
|
def subject(self, room, subject):
|
|
return muc.MUCClientProtocol.subject(self, room, subject)
|
|
|
|
def unavailableReceived(self, presence):
|
|
#XXX: we override this method to manage nickname change
|
|
#TODO: feed this back to Wokkel
|
|
"""
|
|
Unavailable presence was received.
|
|
|
|
If this was received from a MUC room occupant JID, that occupant has
|
|
left the room.
|
|
"""
|
|
room, user = self._getRoomUser(presence)
|
|
|
|
if room is None or user is None:
|
|
return
|
|
|
|
room.removeUser(user)
|
|
|
|
if muc.STATUS_CODE.NEW_NICK in presence.mucStatuses:
|
|
self.__changing_nicks.add(presence.nick)
|
|
self.userChangedNick(room, user, presence.nick)
|
|
else:
|
|
self.__changing_nicks.discard(presence.nick)
|
|
self.userLeftRoom(room, user)
|
|
|
|
def receivedGroupChat(self, room, user, body):
|
|
debug('receivedGroupChat: room=%s user=%s body=%s', room, user, body)
|
|
|
|
def userJoinedRoom(self, room, user):
|
|
if user.nick in self.__changing_nicks:
|
|
self.__changing_nicks.remove(user.nick)
|
|
else:
|
|
debug(_("user %(nick)s has joined room (%(room_id)s)") % {'nick': user.nick, 'room_id': room.occupantJID.userhost()})
|
|
if not self.host.trigger.point("MUC user joined", room, user, self.parent.profile):
|
|
return
|
|
user_data = {'entity': user.entity.full() if user.entity else '', 'affiliation': user.affiliation, 'role': user.role}
|
|
self.host.bridge.roomUserJoined(room.roomJID.userhost(), user.nick, user_data, self.parent.profile)
|
|
|
|
def userLeftRoom(self, room, user):
|
|
if not self.host.trigger.point("MUC user left", room, user, self.parent.profile):
|
|
return
|
|
if user.nick == room.nick:
|
|
# we left the room
|
|
room_jid_s = room.roomJID.userhost()
|
|
info(_("Room [%(room)s] left (%(profile)s))") % {"room": room_jid_s,
|
|
"profile": self.parent.profile})
|
|
self.host.memory.delEntityCache(room.roomJID, self.parent.profile)
|
|
del self.plugin_parent.clients[self.parent.profile].joined_rooms[room_jid_s]
|
|
self.host.bridge.roomLeft(room.roomJID.userhost(), self.parent.profile)
|
|
else:
|
|
debug(_("user %(nick)s left room (%(room_id)s)") % {'nick': user.nick, 'room_id': room.occupantJID.userhost()})
|
|
user_data = {'entity': user.entity.full() if user.entity else '', 'affiliation': user.affiliation, 'role': user.role}
|
|
self.host.bridge.roomUserLeft(room.roomJID.userhost(), user.nick, user_data, self.parent.profile)
|
|
|
|
def userChangedNick(self, room, user, new_nick):
|
|
self.host.bridge.roomUserChangedNick(room.roomJID.userhost(), user.nick, new_nick, self.parent.profile)
|
|
|
|
def userUpdatedStatus(self, room, user, show, status):
|
|
print("FIXME: MUC status not managed yet")
|
|
#FIXME:
|
|
|
|
def receivedSubject(self, room, user, subject):
|
|
debug(_("New subject for room (%(room_id)s): %(subject)s") % {'room_id': room.roomJID.full(), 'subject': subject})
|
|
self.rec_subjects[room.roomJID.userhost()] = (room.roomJID.userhost(), subject)
|
|
self.host.bridge.roomNewSubject(room.roomJID.userhost(), subject, self.parent.profile)
|