plugins/muc/muc.lib.lua

-- Prosody IM

-- Copyright (C) 2008-2010 Matthew Wild

-- Copyright (C) 2008-2010 Waqas Hussain

-- 

-- This project is MIT/X11 licensed. Please see the

-- COPYING file in the source package for more information.

--

local select = select;

local pairs, ipairs = pairs, ipairs;

local datamanager = require "util.datamanager";

local datetime = require "util.datetime";

local dataform = require "util.dataforms";

local jid_split = require "util.jid".split;

local jid_bare = require "util.jid".bare;

local jid_prep = require "util.jid".prep;

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 base64 = require "util.encodings".base64;

local md5 = require "util.hashes".md5;

local muc_domain = nil; --module:get_host();

local default_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):reset(), 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;

	["malformed error"] = true;

};

local function get_error_condition(stanza)

	local _, condition = stanza:get_error();

	return condition or "malformed error";

end

local function is_kickable_error(stanza)

	local cond = get_error_condition(stanza);

	return kickable_error_conditions[cond] and cond;

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

-----------

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" then

		return "participant";

	elseif not affiliation then

		if not self:is_members_only() then

			return self:is_moderated() and "visitor" or "participant";

		end

	end

end

function room_mt:broadcast_presence(stanza, sid, code, nick)

	stanza = get_filtered_presence(stanza);

	local occupant = self._occupants[stanza.attr.from];

	stanza:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})

		:tag("item", {affiliation=occupant.affiliation or "none", role=occupant.role or "none", nick=nick}):up();

	if code then

		stanza:tag("status", {code=code}):up();

	end

	self:broadcast_except_nick(stanza, stanza.attr.from);

	local me = self._occupants[stanza.attr.from];

	if me then

		stanza:tag("status", {code='110'}):up();

		stanza.attr.to = sid;

		self:_route_stanza(stanza);

	end

end

function room_mt:broadcast_message(stanza, historic)

	local to = stanza.attr.to;

	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

	stanza.attr.to = to;

	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.attr.to = "";

		local stamp = datetime.datetime();

		local chars = #tostring(stanza);

		stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = stamp}):up(); -- XEP-0203

		stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)

		local entry = { stanza = stanza, stamp = stamp };

		t_insert(history, entry);

		while #history > (self._data.history_length or default_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 or "none", role=o_data.role or "none"}):up();

			self:_route_stanza(pres);

		end

	end

end

function room_mt:send_history(to, stanza)

	local history = self._data['history']; -- send discussion history

	if history then

		local x_tag = stanza and stanza:get_child("x", "http://jabber.org/protocol/muc");

		local history_tag = x_tag and x_tag:get_child("history", "http://jabber.org/protocol/muc");

		local maxchars = history_tag and tonumber(history_tag.attr.maxchars);

		if maxchars then maxchars = math.floor(maxchars); end

		local maxstanzas = math.floor(history_tag and tonumber(history_tag.attr.maxstanzas) or #history);

		if not history_tag then maxstanzas = 20; end

		local seconds = history_tag and tonumber(history_tag.attr.seconds);

		if seconds then seconds = datetime.datetime(os.time() - math.floor(seconds)); end

		local since = history_tag and history_tag.attr.since;

		if since then since = datetime.parse(since); since = since and datetime.datetime(since); end

		if seconds and (not since or since < seconds) then since = seconds; end

		local n = 0;

		local charcount = 0;

		local stanzacount = 0;

		for i=#history,1,-1 do

			local entry = history[i];

			if maxchars then

				if not entry.chars then

					entry.stanza.attr.to = "";

					entry.chars = #tostring(entry.stanza);

				end

				charcount = charcount + entry.chars + #to;

				if charcount > maxchars then break; end

			end

			if since and since > entry.stamp then break; end

			if n + 1 > maxstanzas then break; end

			n = n + 1;

		end

		for i=#history-n+1,#history do

			local msg = history[i].stanza;

			msg.attr.to = to;

			self:_route_stanza(msg);

		end

	end

	if self._data['subject'] then

		self:_route_stanza(st.message({type='groupchat', from=self._data['subject_from'] or self.jid, to=to}):tag("subject"):text(self._data['subject']));

	end

end

function room_mt:get_disco_info(stanza)

	return st.reply(stanza):query("http://jabber.org/protocol/disco#info")

		:tag("identity", {category="conference", type="text", name=self:get_name()}):up()

		:tag("feature", {var="http://jabber.org/protocol/muc"}):up()

		:tag("feature", {var=self:get_password() and "muc_passwordprotected" or "muc_unsecured"}):up()

		:tag("feature", {var=self:is_moderated() and "muc_moderated" or "muc_unmoderated"}):up()

		:tag("feature", {var=self:is_members_only() and "muc_membersonly" or "muc_open"}):up()

		:tag("feature", {var=self:is_persistent() and "muc_persistent" or "muc_temporary"}):up()

		:tag("feature", {var=self:is_hidden() and "muc_hidden" or "muc_public"}):up()

		:tag("feature", {var=self._data.whois ~= "anyone" and "muc_semianonymous" or "muc_nonanonymous"}):up()

		:add_child(dataform.new({

			{ name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" },

			{ name = "muc#roominfo_description", label = "Description"}

		}):form({["muc#roominfo_description"] = self:get_description()}, 'result'))

	;

end

function room_mt:get_disco_items(stanza)

	local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#items");

	for room_jid in pairs(self._occupants) do

		reply:tag("item", {jid = room_jid, name = room_jid:match("/(.*)")}):up();

	end

	return reply;

end

function room_mt:set_subject(current_nick, subject)

	-- TODO check nick's authority

	if subject == "" then subject = nil; end

	self._data['subject'] = subject;

	self._data['subject_from'] = current_nick;

	if self.save then self:save(); end

	local msg = st.message({type='groupchat', from=current_nick})

		:tag('subject'):text(subject):up();

	self:broadcast_message(msg, false);

	return true;

end

local function build_unavailable_presence_from_error(stanza)

	local type, condition, text = stanza:get_error();

	local error_message = "Kicked: "..(condition and condition:gsub("%-", " ") or "presence error");

	if text then

		error_message = error_message..": "..text;

	end

	return st.presence({type='unavailable', from=stanza.attr.from, to=stanza.attr.to})

		:tag('status'):text(error_message);

end

function room_mt:set_name(name)

	if name == "" or type(name) ~= "string" or name == (jid_split(self.jid)) then name = nil; end

	if self._data.name ~= name then

		self._data.name = name;

		if self.save then self:save(true); end

	end

end

function room_mt:get_name()

	return self._data.name or jid_split(self.jid);

end

function room_mt:set_description(description)

	if description == "" or type(description) ~= "string" then description = nil; end

	if self._data.description ~= description then

		self._data.description = description;

		if self.save then self:save(true); end

	end

end

function room_mt:get_description()

	return self._data.description;

end

function room_mt:set_password(password)

	if password == "" or type(password) ~= "string" then password = nil; end

	if self._data.password ~= password then

		self._data.password = password;

		if self.save then self:save(true); end

	end

end

function room_mt:get_password()

	return self._data.password;

end

function room_mt:set_moderated(moderated)

	moderated = moderated and true or nil;

	if self._data.moderated ~= moderated then

		self._data.moderated = moderated;

		if self.save then self:save(true); end

	end

end

function room_mt:is_moderated()

	return self._data.moderated;

end

function room_mt:set_members_only(members_only)

	members_only = members_only and true or nil;

	if self._data.members_only ~= members_only then

		self._data.members_only = members_only;

		if self.save then self:save(true); end

	end

end

function room_mt:is_members_only()

	return self._data.members_only;

end

function room_mt:set_persistent(persistent)

	persistent = persistent and true or nil;

	if self._data.persistent ~= persistent then

		self._data.persistent = persistent;

		if self.save then self:save(true); end

	end

end

function room_mt:is_persistent()

	return self._data.persistent;

end

function room_mt:set_hidden(hidden)

	hidden = hidden and true or nil;

	if self._data.hidden ~= hidden then

		self._data.hidden = hidden;

		if self.save then self:save(true); end

	end

end

function room_mt:is_hidden()

	return self._data.hidden;

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, build_unavailable_presence_from_error(stanza));

			end

		elseif type == "unavailable" then -- unavailable

			if current_nick then

				log("debug", "%s leaving %s", current_nick, room);

				local occupant = self._occupants[current_nick];

				local new_jid = next(occupant.sessions);

				if new_jid == from then new_jid = next(occupant.sessions, new_jid); end

				if new_jid then

					local jid = occupant.jid;

					occupant.jid = new_jid;

					occupant.sessions[from] = nil;

					pr.attr.to = from;

					pr:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})

						:tag("item", {affiliation=occupant.affiliation or "none", role='none'}):up()

						:tag("status", {code='110'});

					self:_route_stanza(pr);

					if jid ~= new_jid then

						pr = st.clone(occupant.sessions[new_jid])

							:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})

							:tag("item", {affiliation=occupant.affiliation or "none", role=occupant.role or "none"});

						pr.attr.from = current_nick;

						self:broadcast_except_nick(pr, current_nick);

					end

				else

					occupant.role = 'none';

					self:broadcast_presence(pr, from);

					self._occupants[current_nick] = nil;

				end

				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, from);

					else -- change nick

						local occupant = self._occupants[current_nick];

						local is_multisession = next(occupant.sessions, next(occupant.sessions));

						if self._occupants[to] or is_multisession then

							log("debug", "%s couldn't change nick", current_nick);

							local reply = st.error_reply(stanza, "cancel", "conflict"):up();

							reply.tags[1].attr.code = "409";

							origin.send(reply: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, from, '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, from);

							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;

				local is_merge;

				if self._occupants[to] then

					if jid_bare(from) ~= jid_bare(self._occupants[to].jid) then

						new_nick = nil;

					end

					is_merge = true;

				end

				local password = stanza:get_child("x", "http://jabber.org/protocol/muc");

				password = password and password:get_child("password", "http://jabber.org/protocol/muc");

				password = password and password[1] ~= "" and password[1];

				if self:get_password() and self:get_password() ~= password then

					log("debug", "%s couldn't join due to invalid password: %s", from, to);

					local reply = st.error_reply(stanza, "auth", "not-authorized"):up();

					reply.tags[1].attr.code = "401";

					origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));

				elseif not new_nick then

					log("debug", "%s couldn't join due to nick conflict: %s", from, to);

					local reply = st.error_reply(stanza, "cancel", "conflict"):up();

					reply.tags[1].attr.code = "409";

					origin.send(reply: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

						if not is_merge then

							self._occupants[to] = {affiliation=affiliation, role=role, jid=from, sessions={[from]=get_filtered_presence(stanza)}};

						else

							self._occupants[to].sessions[from] = get_filtered_presence(stanza);

						end

						self._jid_nick[from] = to;

						self:send_occupant_list(from);

						pr.attr.from = to;

						pr:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})

							:tag("item", {affiliation=affiliation or "none", role=role or "none"}):up();

						if not is_merge then

							self:broadcast_except_nick(pr, to);

						end

						pr:tag("status", {code='110'});

						if self._data.whois == 'anyone' then

							pr:tag("status", {code='100'}):up();

						end

						pr.attr.to = from;

						self:_route_stanza(pr);

						self:send_history(from, stanza);

					elseif not affiliation then -- registration required for entering members-only room

						local reply = st.error_reply(stanza, "auth", "registration-required"):up();

						reply.tags[1].attr.code = "407";

						origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));

					else -- banned

						local reply = st.error_reply(stanza, "auth", "forbidden"):up();

						reply.tags[1].attr.code = "403";

						origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));

					end

				end

			end

		elseif type ~= 'result' then -- bad type

			if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences

				origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?

			end

		end

	elseif not current_nick then -- not in room

		if type == "error" or type == "result" then

			local id = stanza.name == "iq" and stanza.attr.id and base64.decode(stanza.attr.id);

			local _nick, _id, _hash = (id or ""):match("^(.+)%z(.*)%z(.+)$");

			local occupant = self._occupants[stanza.attr.to];

			if occupant and _nick and self._jid_nick[_nick] and _id and _hash then

				local id, _to = stanza.attr.id;

				for jid in pairs(occupant.sessions) do

					if md5(jid) == _hash then

						_to = jid;

						break;

					end

				end

				if _to then

					stanza.attr.to, stanza.attr.from, stanza.attr.id = _to, self._jid_nick[_nick], _id;

					self:_route_stanza(stanza);

					stanza.attr.to, stanza.attr.from, stanza.attr.id = to, from, id;

				end

			end

		else

			origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));

		end

	elseif stanza.name == "message" and type == "groupchat" then -- groupchat messages not allowed in PM

		origin.send(st.error_reply(stanza, "modify", "bad-request"));

	elseif current_nick and stanza.name == "message" and type == "error" and is_kickable_error(stanza) then

		log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);

		self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza)); -- 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;

			local bare = jid_bare(jid);

			stanza.attr.to, stanza.attr.from = jid, current_nick;

			local id = stanza.attr.id;

			if stanza.name=='iq' and type=='get' and stanza.tags[1].attr.xmlns == 'vcard-temp' and bare ~= jid then

				stanza.attr.to = bare;

				stanza.attr.id = base64.encode(jid.."\0"..id.."\0"..md5(from));

			end

			self:_route_stanza(stanza);

			stanza.attr.to, stanza.attr.from, stanza.attr.id = to, from, id;

		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:send_form(origin, stanza)

	origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")

		:add_child(self:get_form_layout():form())

	);

end

function room_mt:get_form_layout()

	local title = "Configuration for "..self.jid;

	return dataform.new({

		title = title,

		instructions = title,

		{

			name = 'FORM_TYPE',

			type = 'hidden',

			value = 'http://jabber.org/protocol/muc#roomconfig'

		},

		{

			name = 'muc#roomconfig_roomname',

			type = 'text-single',

			label = 'Name',

			value = self:get_name() or "",

		},

		{

			name = 'muc#roomconfig_roomdesc',

			type = 'text-single',

			label = 'Description',

			value = self:get_description() or "",

		},

		{

			name = 'muc#roomconfig_persistentroom',

			type = 'boolean',

			label = 'Make Room Persistent?',

			value = self:is_persistent()

		},

		{

			name = 'muc#roomconfig_publicroom',

			type = 'boolean',

			label = 'Make Room Publicly Searchable?',

			value = not self:is_hidden()

		},

		{

			name = 'muc#roomconfig_whois',

			type = 'list-single',

			label = 'Who May Discover Real JIDs?',

			value = {

				{ value = 'moderators', label = 'Moderators Only', default = self._data.whois == 'moderators' },

				{ value = 'anyone',     label = 'Anyone',          default = self._data.whois == 'anyone' }

			}

		},

		{

			name = 'muc#roomconfig_roomsecret',

			type = 'text-private',

			label = 'Password',

			value = self:get_password() or "",

		},

		{

			name = 'muc#roomconfig_moderatedroom',

			type = 'boolean',

			label = 'Make Room Moderated?',

			value = self:is_moderated()

		},

		{

			name = 'muc#roomconfig_membersonly',

			type = 'boolean',

			label = 'Make Room Members-Only?',

			value = self:is_members_only()

		}

	});

end

local valid_whois = {

	moderators = true,

	anyone = true,

}

function room_mt:process_form(origin, stanza)

	local query = stanza.tags[1];

	local form;

	for _, tag in ipairs(query.tags) do if tag.name == "x" and tag.attr.xmlns == "jabber:x:data" then form = tag; break; end end

	if not form then origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); return; end

	if form.attr.type == "cancel" then origin.send(st.reply(stanza)); return; end

	if form.attr.type ~= "submit" then origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form")); return; end

	local fields = self:get_form_layout():data(form);

	if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration")); return; end

	local dirty = false

	local name = fields['muc#roomconfig_roomname'];

	if name ~= self:get_name() then

		self:set_name(name);

	end

	local description = fields['muc#roomconfig_roomdesc'];

	if description ~= self:get_description() then

		self:set_description(description);

	end

	local persistent = fields['muc#roomconfig_persistentroom'];

	dirty = dirty or (self:is_persistent() ~= persistent)

	module:log("debug", "persistent=%s", tostring(persistent));

	local moderated = fields['muc#roomconfig_moderatedroom'];

	dirty = dirty or (self:is_moderated() ~= moderated)

	module:log("debug", "moderated=%s", tostring(moderated));

	local membersonly = fields['muc#roomconfig_membersonly'];

	dirty = dirty or (self:is_members_only() ~= membersonly)

	module:log("debug", "membersonly=%s", tostring(membersonly));

	local public = fields['muc#roomconfig_publicroom'];

	dirty = dirty or (self:is_hidden() ~= (not public and true or nil))

	local whois = fields['muc#roomconfig_whois'];

	if not valid_whois[whois] then

	    origin.send(st.error_reply(stanza, 'cancel', 'bad-request', "Invalid value for 'whois'"));

	    return;

	end

	local whois_changed = self._data.whois ~= whois

	self._data.whois = whois

	module:log('debug', 'whois=%s', whois)

	local password = fields['muc#roomconfig_roomsecret'];

	if self:get_password() ~= password then

		self:set_password(password);

	end

	self:set_moderated(moderated);

	self:set_members_only(membersonly);

	self:set_persistent(persistent);

	self:set_hidden(not public);

	if self.save then self:save(true); end