IMPORTANT: due to a drive failure, as of 13-Mar-2021, the Mercurial repository had to be re-mirrored, which changed every commit SHA. The old SHAs and trees are backed up in the vault branches. Please migrate to the new branches as soon as you can.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
prosody/plugins/muc/muc.lib.lua

587 lines
23 KiB

-- Prosody IM
-- Copyright (C) 2008-2009 Matthew Wild
-- Copyright (C) 2008-2009 Waqas Hussain
--
-- This project is MIT/X11 licensed. Please see the
-- COPYING file in the source package for more information.
--
local datamanager = require "util.datamanager";
local datetime = require "util.datetime";
local jid_split = require "util.jid".split;
local jid_bare = require "util.jid".bare;
local st = require "util.stanza";
local log = require "util.logger".init("mod_muc");
local multitable_new = require "util.multitable".new;
local t_insert, t_remove = table.insert, table.remove;
local setmetatable = setmetatable;
local muc_domain = nil; --module:get_host();
local history_length = 20;
------------
local function filter_xmlns_from_array(array, filters)
local count = 0;
for i=#array,1,-1 do
local attr = array[i].attr;
if filters[attr and attr.xmlns] then
t_remove(array, i);
count = count + 1;
end
end
return count;
end
local function filter_xmlns_from_stanza(stanza, filters)
if filters then
if filter_xmlns_from_array(stanza.tags, filters) ~= 0 then
return stanza, filter_xmlns_from_array(stanza, filters);
end
end
return stanza, 0;
end
local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
local function get_filtered_presence(stanza)
return filter_xmlns_from_stanza(st.clone(stanza), presence_filters);
end
local kickable_error_conditions = {
["gone"] = true;
["internal-server-error"] = true;
["item-not-found"] = true;
["jid-malformed"] = true;
["recipient-unavailable"] = true;
["redirect"] = true;
["remote-server-not-found"] = true;
["remote-server-timeout"] = true;
["service-unavailable"] = true;
};
local function get_kickable_error(stanza)
for _, tag in ipairs(stanza.tags) do
if tag.name == "error" and tag.attr.xmlns == "jabber:client" then
for _, cond in ipairs(tag.tags) do
if cond.attr.xmlns == "urn:ietf:params:xml:ns:xmpp-stanzas" then
return kickable_error_conditions[cond.name] and cond.name;
end
end
return true; -- malformed error message
end
end
return true; -- malformed error message
end
local function getUsingPath(stanza, path, getText)
local tag = stanza;
for _, name in ipairs(path) do
if type(tag) ~= 'table' then return; end
tag = tag:child_with_name(name);
end
if tag and getText then tag = table.concat(tag); end
return tag;
end
local function getTag(stanza, path) return getUsingPath(stanza, path); end
local function getText(stanza, path) return getUsingPath(stanza, path, true); end
-----------
--[[function get_room_disco_info(room, stanza)
return st.iq({type='result', id=stanza.attr.id, from=stanza.attr.to, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#info")
:tag("identity", {category='conference', type='text', name=room._data["name"]):up()
:tag("feature", {var="http://jabber.org/protocol/muc"}); -- TODO cache disco reply
end
function get_room_disco_items(room, stanza)
return st.iq({type='result', id=stanza.attr.id, from=stanza.attr.to, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#items");
end -- TODO allow non-private rooms]]
--
local room_mt = {};
room_mt.__index = room_mt;
function room_mt:get_default_role(affiliation)
if affiliation == "owner" or affiliation == "admin" then
return "moderator";
elseif affiliation == "member" or not affiliation then
return "participant";
end
end
function room_mt:broadcast_presence(stanza, code, nick)
stanza = get_filtered_presence(stanza);
local data = self._occupants[stanza.attr.from];
stanza:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
:tag("item", {affiliation=data.affiliation, role=data.role, nick=nick}):up();
if code then
stanza:tag("status", {code=code}):up();
end
local me;
for occupant, o_data in pairs(self._occupants) do
if occupant ~= stanza.attr.from then
for jid in pairs(o_data.sessions) do
stanza.attr.to = jid;
self:route_stanza(stanza);
end
else
me = o_data;
end
end
if me then
stanza:tag("status", {code='110'});
for jid in pairs(me.sessions) do
stanza.attr.to = jid;
self:route_stanza(stanza);
end
end
end
function room_mt:broadcast_message(stanza, historic)
for occupant, o_data in pairs(self._occupants) do
for jid in pairs(o_data.sessions) do
stanza.attr.to = jid;
self:route_stanza(stanza);
end
end
if historic then -- add to history
local history = self._data['history'];
if not history then history = {}; self._data['history'] = history; end
-- stanza = st.clone(stanza);
stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = datetime.datetime()}):up(); -- XEP-0203
stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
t_insert(history, st.clone(st.preserialize(stanza)));
while #history > history_length do t_remove(history, 1) end
end
end
function room_mt:broadcast_except_nick(stanza, nick)
for rnick, occupant in pairs(self._occupants) do
if rnick ~= nick then
for jid in pairs(occupant.sessions) do
stanza.attr.to = jid;
self:route_stanza(stanza);
end
end
end
end
function room_mt:send_occupant_list(to)
local current_nick = self._jid_nick[to];
for occupant, o_data in pairs(self._occupants) do
if occupant ~= current_nick then
local pres = get_filtered_presence(o_data.sessions[o_data.jid]);
pres.attr.to, pres.attr.from = to, occupant;
pres:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
:tag("item", {affiliation=o_data.affiliation, role=o_data.role}):up();
self:route_stanza(pres);
end
end
end
function room_mt:send_history(to)
local history = self._data['history']; -- send discussion history
if history then
for _, msg in ipairs(history) do
msg = st.deserialize(msg);
msg.attr.to=to;
self:route_stanza(msg);
end
end
if self._data['subject'] then
self:route_stanza(st.message({type='groupchat', from=self.jid, to=to}):tag("subject"):text(self._data['subject']));
end
end
local function room_get_disco_info(self, stanza) end
local function room_get_disco_items(self, stanza) end
function room_mt:set_subject(current_nick, subject)
-- TODO check nick's authority
if subject == "" then subject = nil; end
self._data['subject'] = subject;
local msg = st.message({type='groupchat', from=current_nick})
:tag('subject'):text(subject):up();
self:broadcast_message(msg, false);
return true;
end
function room_mt:handle_to_occupant(origin, stanza) -- PM, vCards, etc
local from, to = stanza.attr.from, stanza.attr.to;
local room = jid_bare(to);
local current_nick = self._jid_nick[from];
local type = stanza.attr.type;
log("debug", "room: %s, current_nick: %s, stanza: %s", room or "nil", current_nick or "nil", stanza:top_tag());
if (select(2, jid_split(from)) == muc_domain) then error("Presence from the MUC itself!!!"); end
if stanza.name == "presence" then
local pr = get_filtered_presence(stanza);
pr.attr.from = current_nick;
if type == "error" then -- error, kick em out!
if current_nick then
log("debug", "kicking %s from %s", current_nick, room);
self:handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to})
:tag('status'):text('This participant is kicked from the room because he sent an error presence')); -- send unavailable
end
elseif type == "unavailable" then -- unavailable
if current_nick then
log("debug", "%s leaving %s", current_nick, room);
local data = self._occupants[current_nick];
data.role = 'none';
self:broadcast_presence(pr);
self._occupants[current_nick] = nil;
self._jid_nick[from] = nil;
end
elseif not type then -- available
if current_nick then
--if #pr == #stanza or current_nick ~= to then -- commented because google keeps resending directed presence
if current_nick == to then -- simple presence
log("debug", "%s broadcasted presence", current_nick);
self._occupants[current_nick].sessions[from] = pr;
self:broadcast_presence(pr);
else -- change nick
if self._occupants[to] then
log("debug", "%s couldn't change nick", current_nick);
origin.send(st.error_reply(stanza, "cancel", "conflict"):tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
else
local data = self._occupants[current_nick];
local to_nick = select(3, jid_split(to));
if to_nick then
log("debug", "%s (%s) changing nick to %s", current_nick, data.jid, to);
local p = st.presence({type='unavailable', from=current_nick});
self:broadcast_presence(p, '303', to_nick);
self._occupants[current_nick] = nil;
self._occupants[to] = data;
self._jid_nick[from] = to;
pr.attr.from = to;
self._occupants[to].sessions[from] = pr;
self:broadcast_presence(pr);
else
--TODO malformed-jid
end
end
end
--else -- possible rejoin
-- log("debug", "%s had connection replaced", current_nick);
-- self:handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to})
-- :tag('status'):text('Replaced by new connection'):up()); -- send unavailable
-- self:handle_to_occupant(origin, stanza); -- resend available
--end
else -- enter room
local new_nick = to;
if self._occupants[to] then
new_nick = nil;
end
if not new_nick then
log("debug", "%s couldn't join due to nick conflict: %s", from, to);
origin.send(st.error_reply(stanza, "cancel", "conflict"):tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
else
log("debug", "%s joining as %s", from, to);
if not next(self._affiliations) then -- new room, no owners
self._affiliations[jid_bare(from)] = "owner";
end
local affiliation = self:get_affiliation(from);
local role = self:get_default_role(affiliation)
if role then -- new occupant
self._occupants[to] = {affiliation=affiliation, role=role, jid=from, sessions={[from]=get_filtered_presence(stanza)}};
self._jid_nick[from] = to;
self:send_occupant_list(from);
pr.attr.from = to;
self:broadcast_presence(pr);
self:send_history(from);
else -- banned
origin.send(st.error_reply(stanza, "auth", "forbidden"):tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
end
end
end
elseif type ~= 'result' then -- bad type
origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
end
elseif not current_nick and type ~= "error" and type ~= "result" then -- not in room
origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
elseif stanza.name == "message" and type == "groupchat" then -- groupchat messages not allowed in PM
origin.send(st.error_reply(stanza, "modify", "bad-request"));
elseif stanza.name == "message" and type == "error" and get_kickable_error(stanza) then
log("debug", "%s kicked from %s for sending an error message", current_nick, room);
self:handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to}):tag('status'):text('This participant is kicked from the room because he sent an error message to another occupant')); -- send unavailable
else -- private stanza
local o_data = self._occupants[to];
if o_data then
log("debug", "%s sent private stanza to %s (%s)", from, to, o_data.jid);
local jid = o_data.jid;
-- TODO if stanza.name=='iq' and type=='get' and stanza.tags[1].attr.xmlns == 'vcard-temp' then jid = jid_bare(jid); end
stanza.attr.to, stanza.attr.from = jid, current_nick;
self:route_stanza(stanza);
elseif type ~= "error" and type ~= "result" then -- recipient not in room
origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
end
end
end
function room_mt:handle_to_room(origin, stanza) -- presence changes and groupchat messages, along with disco/etc
local type = stanza.attr.type;
local xmlns = stanza.tags[1] and stanza.tags[1].attr.xmlns;
if stanza.name == "iq" and type == "get" and xmlns ~= "http://jabber.org/protocol/muc#admin" then -- disco requests
if xmlns == "http://jabber.org/protocol/disco#info" then
origin.send(room_get_disco_info(self, stanza));
elseif xmlns == "http://jabber.org/protocol/disco#items" then
origin.send(room_get_disco_items(self, stanza));
else
origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
end
elseif stanza.name == "iq" and xmlns == "http://jabber.org/protocol/muc#admin" then
local actor = stanza.attr.from;
local affiliation = self:get_affiliation(actor);
local current_nick = self._jid_nick[actor];
local role = current_nick and self._occupants[current_nick].role or self:get_default_role(affiliation);
local item = stanza.tags[1].tags[1];
if item and item.name == "item" then
if type == "set" then
local callback = function() origin.send(st.reply(stanza)); end
if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
local occupant = self._occupants[self.jid.."/"..item.attr.nick];
if occupant then item.attr.jid = occupant.jid; end
end
if item.attr.affiliation and item.attr.jid and not item.attr.role then
local success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, callback);
if not success then origin.send(st.error_reply(stanza, errtype, err)); end
elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
local success, errtype, err = self:set_role(actor, self.jid.."/"..item.attr.nick, item.attr.role, callback);
if not success then origin.send(st.error_reply(stanza, errtype, err)); end
else
origin.send(st.error_reply(stanza, "cancel", "bad-request"));
end
elseif type == "get" then
local _aff = item.attr.affiliation;
local _rol = item.attr.role;
if _aff and not _rol then
if affiliation == "owner" or (affiliation == "admin" and _aff ~= "owner" and _aff ~= "admin") then
local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
for jid, affiliation in pairs(self._affiliations) do
if affiliation == _aff then
reply:tag("item", {affiliation = _aff, jid = jid}):up();
end
end
origin.send(reply);
else
origin.send(st.error_reply(stanza, "auth", "forbidden"));
end
elseif _rol and not _aff then
if role == "moderator" then -- TODO allow admins and owners not in room? Provide read-only access to everyone who can see the participants anyway?
if _rol == "none" then _rol = nil; end
local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
for nick, occupant in pairs(self._occupants) do
if occupant.role == _rol then
reply:tag("item", {nick = nick, role = _rol or "none", affiliation = occupant.affiliation or "none", jid = occupant.jid}):up();
end
end
origin.send(reply);
else
origin.send(st.error_reply(stanza, "auth", "forbidden"));
end
else
origin.send(st.error_reply(stanza, "cancel", "bad-request"));
end
end
elseif type == "set" or type == "get" then
origin.send(st.error_reply(stanza, "cancel", "bad-request"));
end
elseif stanza.name == "message" and type == "groupchat" then
local from, to = stanza.attr.from, stanza.attr.to;
local room = jid_bare(to);
local current_nick = self._jid_nick[from];
if not current_nick then -- not in room
origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
else
local from = stanza.attr.from;
stanza.attr.from = current_nick;
local subject = getText(stanza, {"subject"});
if subject then
self:set_subject(current_nick, subject); -- TODO use broadcast_message_stanza
else
self:broadcast_message(stanza, true);
end
end
elseif stanza.name == "presence" then -- hack - some buggy clients send presence updates to the room rather than their nick
local to = stanza.attr.to;
local current_nick = self._jid_nick[stanza.attr.from];
if current_nick then
stanza.attr.to = current_nick;
self:handle_to_occupant(origin, stanza);
stanza.attr.to = to;
elseif type ~= "error" and type ~= "result" then
origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
end
elseif stanza.name == "message" and not stanza.attr.type and #stanza.tags == 1 and self._jid_nick[stanza.attr.from]
and stanza.tags[1].name == "x" and stanza.tags[1].attr.xmlns == "http://jabber.org/protocol/muc#user" and #stanza.tags[1].tags == 1
and stanza.tags[1].tags[1].name == "invite" and stanza.tags[1].tags[1].attr.to then
local _from, _to = stanza.attr.from, stanza.attr.to;
local _invitee = stanza.tags[1].tags[1].attr.to;
stanza.attr.from, stanza.attr.to = _to, _invitee;
stanza.tags[1].tags[1].attr.from, stanza.tags[1].tags[1].attr.to = _from, nil;
self:route_stanza(stanza);
stanza.tags[1].tags[1].attr.from, stanza.tags[1].tags[1].attr.to = nil, _invitee;
stanza.attr.from, stanza.attr.to = _from, _to;
else
if type == "error" or type == "result" then return; end
origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
end
end
function room_mt:handle_stanza(origin, stanza)
local to_node, to_host, to_resource = jid_split(stanza.attr.to);
if to_resource then
self:handle_to_occupant(origin, stanza);
else
self:handle_to_room(origin, stanza);
end
end
function room_mt:route_stanza(stanza) end -- Replace with a routing function, e.g., function(room, stanza) core_route_stanza(origin, stanza); end
function room_mt:get_affiliation(jid)
local node, host, resource = jid_split(jid);
local bare = node and node.."@"..host or host;
local result = self._affiliations[bare]; -- Affiliations are granted, revoked, and maintained based on the user's bare JID.
if not result and self._affiliations[host] == "outcast" then result = "outcast"; end -- host banned
return result;
end
function room_mt:set_affiliation(actor, jid, affiliation, callback)
jid = jid_bare(jid);
if affiliation == "none" then affiliation = nil; end
if affiliation and affiliation ~= "outcast" and affiliation ~= "owner" and affiliation ~= "admin" and affiliation ~= "member" then
return nil, "modify", "not-acceptable";
end
if self:get_affiliation(actor) ~= "owner" then return nil, "cancel", "not-allowed"; end
if jid_bare(actor) == jid then return nil, "cancel", "not-allowed"; end
self._affiliations[jid] = affiliation;
local role = self:get_default_role(affiliation);
local p = st.presence()
:tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
:tag("item", {affiliation=affiliation or "none", role=role or "none"}):up();
local x = p.tags[1];
local item = x.tags[1];
if not role then -- getting kicked
p.attr.type = "unavailable";
if affiliation == "outcast" then
x:tag("status", {code="301"}):up(); -- banned
else
x:tag("status", {code="321"}):up(); -- affiliation change
end
end
local modified_nicks = {};
for nick, occupant in pairs(self._occupants) do
if jid_bare(occupant.jid) == jid then
if not role then -- getting kicked
self._occupants[nick] = nil;
else
t_insert(modified_nicks, nick);
occupant.affiliation, occupant.role = affiliation, role;
end
p.attr.from = nick;
for jid in pairs(occupant.sessions) do -- remove for all sessions of the nick
if not role then self._jid_nick[jid] = nil; end
p.attr.to = jid;
self:route_stanza(p);
end
end
end
if callback then callback(); end
for _, nick in ipairs(modified_nicks) do
p.attr.from = nick;
self:broadcast_except_nick(p, nick);
end
return true;
end
function room_mt:get_role(nick)
local session = self._occupants[nick];
return session and session.role or nil;
end
function room_mt:set_role(actor, nick, role, callback)
if role == "none" then role = nil; end
if role and role ~= "moderator" and role ~= "participant" and role ~= "visitor" then return nil, "modify", "not-acceptable"; end
if self:get_affiliation(actor) ~= "owner" then return nil, "cancel", "not-allowed"; end
local occupant = self._occupants[nick];
if not occupant then return nil, "modify", "not-acceptable"; end
if occupant.affiliation == "owner" or occupant.affiliation == "admin" then return nil, "cancel", "not-allowed"; end
local p = st.presence({from = nick})
:tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
:tag("item", {affiliation=occupant.affiliation or "none", nick=nick, role=role or "none"}):up();
if not role then -- kick
p.attr.type = "unavailable";
self._occupants[nick] = nil;
for jid in pairs(occupant.sessions) do -- remove for all sessions of the nick
self._jid_nick[jid] = nil;
end
p:tag("status", {code = "307"}):up();
else
occupant.role = role;
end
for jid in pairs(occupant.sessions) do -- send to all sessions of the nick
p.attr.to = jid;
self:route_stanza(p);
end
if callback then callback(); end
self:broadcast_except_nick(p, nick);
return true;
end
local _M = {}; -- module "muc"
function _M.new_room(jid)
return setmetatable({
jid = jid;
_jid_nick = {};
_occupants = {};
_data = {};
_affiliations = {};
}, room_mt);
end
return _M;
--[[function get_disco_info(stanza)
return st.iq({type='result', id=stanza.attr.id, from=muc_domain, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#info")
:tag("identity", {category='conference', type='text', name=muc_name}):up()
:tag("feature", {var="http://jabber.org/protocol/muc"}); -- TODO cache disco reply
end
function get_disco_items(stanza)
local reply = st.iq({type='result', id=stanza.attr.id, from=muc_domain, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#items");
for room in pairs(rooms_info:get()) do
reply:tag("item", {jid=room, name=rooms_info:get(room, "name")}):up();
end
return reply; -- TODO cache disco reply
end]]
--[[function handle_to_domain(origin, stanza)
local type = stanza.attr.type;
if type == "error" or type == "result" then return; end
if stanza.name == "iq" and type == "get" then
local xmlns = stanza.tags[1].attr.xmlns;
if xmlns == "http://jabber.org/protocol/disco#info" then
origin.send(get_disco_info(stanza));
elseif xmlns == "http://jabber.org/protocol/disco#items" then
origin.send(get_disco_items(stanza));
else
origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- TODO disco/etc
end
else
origin.send(st.error_reply(stanza, "cancel", "service-unavailable", "The muc server doesn't deal with messages and presence directed at it"));
end
end
register_component(muc_domain, function(origin, stanza)
local to_node, to_host, to_resource = jid_split(stanza.attr.to);
if to_resource and not to_node then
if type == "error" or type == "result" then return; end
origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- host/resource
elseif to_resource then
handle_to_occupant(origin, stanza);
elseif to_node then
handle_to_room(origin, stanza)
else -- to the main muc domain
if type == "error" or type == "result" then return; end
handle_to_domain(origin, stanza);
end
end);]]
--[[module.unload = function()
deregister_component(muc_domain);
end
module.save = function()
return {rooms = rooms.data; jid_nick = jid_nick.data; rooms_info = rooms_info.data; persist_list = persist_list};
end
module.restore = function(data)
rooms.data, jid_nick.data, rooms_info.data, persist_list =
data.rooms or {}, data.jid_nick or {}, data.rooms_info or {}, data.persist_list or {};
end]]