mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License. diff --git a/mod_muc_anonymize_moderation_actions/README.md b/mod_muc_anonymize_moderation_actions/README.md --- a/mod_muc_anonymize_moderation_actions/README.md +++ b/mod_muc_anonymize_moderation_actions/README.md @@ -1,8 +1,10 @@ -<!-- -SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/> -SPDX-License-Identifier: AGPL-3.0-only ---> -# mod_muc_anonymize_moderation_actions +--- +labels: +- 'Stage-Alpha' +summary: Anonymize moderator actions for participants +--- + +## Introduction This modules allows to anonymize affiliation and role changes in MUC rooms. @@ -11,13 +13,10 @@ When the feature is enabled, when a mode This is particularly usefull to prevent some revenge when a moderator bans someone. -This module is under AGPL-3.0 license. - -It was tested on Prosody 0.12.x. ## Configuration -Just enable the module on your MUC VirtualHost. +Just enable the module on your MUC Component. The feature will be accessible throught the room configuration form. You can tweak the position of the settings in the MUC configuration form using `anonymize_moderation_actions_form_position`. @@ -26,7 +25,20 @@ This value will be passed as priority fo By default, the field will be between muc#roomconfig_changesubject and muc#roomconfig_moderatedroom (default value is `78`). ``` lua -VirtualHost "muc.example.com" +Component "muc.example.com" "muc" modules_enabled = { "muc_anonymize_moderation_actions" } anonymize_moderation_actions_form_position = 96 ``` + +## Compatibility + + ------ ---------------------- + trunk Works as of 25-05-12 + 0.13 Works + 0.12 Works + ------ ---------------------- + +### License + +SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/> +SPDX-License-Identifier: AGPL-3.0-only

local known_traits = {};

local function trait_added(event)
	local trait = event.item;
	local name = trait.name;
	if known_traits[name] then return; end

	known_traits[name] = trait.probabilities;
end

local function trait_removed(event)
	local trait = event.item;
	known_traits[trait.name] = nil;
end

module:handle_items("account-trait", trait_added, trait_removed);

local function bayes_probability(prior, prob_given_true, prob_given_false)
	local numerator = prob_given_true * prior;
	local denominator = numerator + prob_given_false * (1 - prior);
	return numerator / denominator;
end

local function prob_is_bad(traits, prior)
	prior = prior or 0.50;

	for trait, state in pairs(traits) do
		local probabilities = known_traits[trait];
		if probabilities then
			if state then
				prior = bayes_probability(
					prior,
					probabilities.prob_bad_true,
					probabilities.prob_bad_false
				);
			else
				prior = bayes_probability(
					prior,
					1 - probabilities.prob_bad_true,
					1 - probabilities.prob_bad_false
				);
			end
		end
	end

	return prior;
end

local function get_probability_bad(username, prior)
	local user_traits = {};
	module:fire_event("get-account-traits", { username = username, host = module.host, traits = user_traits });
	local result = prob_is_bad(user_traits, prior);
	return result;
end

return {
	get_probability_bad = get_probability_bad;
};