view plugins/muc/whois.lib.lua @ 13955:01f95f3de6fc

usermanager: More consistent method behaviour, errors, and (pre-)events This commit refactors most of the exported usermanager methods substantially to ensure that all of them correctly check for the presence of the host and method they are calling and return consistent errors if either is incorrect or missing. It also unifies the event and logging code, so as a result there are more events being fired than before this commit (it also adds pre- events so that modules can block an action from going ahead). We don't have good test coverage of this API, but some manual testing suggests it seems to be working okay...
author Matthew Wild <mwild1@gmail.com>
date Thu, 25 Sep 2025 16:53:35 +0100
parents e66d932eeb58
children
line wrap: on
line source

-- Prosody IM
-- Copyright (C) 2008-2010 Matthew Wild
-- Copyright (C) 2008-2010 Waqas Hussain
-- Copyright (C) 2014 Daurnimator
--
-- This project is MIT/X11 licensed. Please see the
-- COPYING file in the source package for more information.
--

local valid_whois = {
	moderators = true;
	anyone = true;
};

local function get_whois(room)
	return room._data.whois or "moderators";
end

local function set_whois(room, whois)
	assert(valid_whois[whois], "Invalid whois value")
	if get_whois(room) == whois then return false; end
	room._data.whois = whois;
	return true;
end

module:hook("muc-disco#info", function(event)
	local whois = get_whois(event.room) ~= "anyone" and "muc_semianonymous" or "muc_nonanonymous";
	event.reply:tag("feature", { var = whois }):up();
end);

module:hook("muc-config-form", function(event)
	local whois = get_whois(event.room);
	table.insert(event.form, {
		name = 'muc#roomconfig_whois',
		type = 'list-single',
		label = 'Addresses (JIDs) of room occupants may be viewed by:',
		options = {
			{ value = 'moderators', label = 'Moderators only', default = whois == 'moderators' },
			{ value = 'anyone',     label = 'Anyone',          default = whois == 'anyone' }
		}
	});
end, 80-4);

module:hook("muc-config-submitted/muc#roomconfig_whois", function(event)
	if set_whois(event.room, event.value) then
		local code = (event.value == 'moderators') and "173" or "172";
		event.status_codes[code] = true;
	end
end);

-- Mask 'from' jid as occupant jid if room is anonymous
module:hook("muc-invite", function(event)
	local room, stanza = event.room, event.stanza;
	if get_whois(room) == "moderators" and room:get_default_role(room:get_affiliation(stanza.attr.to)) ~= "moderator" then
		local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
		local occupant_jid = room:get_occupant_jid(invite.attr.from);
		if occupant_jid ~= nil then -- FIXME: This will expose real jid if inviter is not in room
			invite.attr.from = occupant_jid;
		end
	end
end, 50);

return {
	get = get_whois;
	set = set_whois;
};