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 s_find = string.find;

local pctl = require "util.prosodyctl";

local rostermanager = require "core.rostermanager";
local storagemanager = require "core.storagemanager";
local usermanager = require "core.usermanager";

-- copypaste from util.stanza
local function valid_xml_cdata(str, attr)
	return not s_find(str, attr and "[^\1\9\10\13\20-~\128-\247]" or "[^\9\10\13\20-~\128-\247]");
end

function module.command(_arg)
	if select(2, pctl.isrunning()) then
		pctl.show_warning("Stop Prosody before running this command");
		return 1;
	end

	for hostname, host in pairs(prosody.hosts) do
		if hostname ~= "*" then
			if host.users.name == "null" then
				storagemanager.initialize_host(hostname);
				usermanager.initialize_host(hostname);
			end
			local fixes = 0;
			for username in host.users.users() do
				local roster = rostermanager.load_roster(username, hostname);
				local changed = false;
				for contact, item in pairs(roster) do
					if contact ~= false then
						if item.name and not valid_xml_cdata(item.name, false) then
							item.name = item.name:gsub("[^\9\10\13\20-~\128-\247]", "�");
							fixes = fixes + 1;
							changed = true;
						end
						local clean_groups = {};
						for group in pairs(item.groups) do
							if valid_xml_cdata(group, false) then
								clean_groups[group] = true;
							else
								clean_groups[group:gsub("[^\9\10\13\20-~\128-\247]",  "�")] = true;
								fixes = fixes + 1;
								changed = true;
							end
						end
						item.groups = clean_groups;
					else
						-- pending entries etc
					end
				end
				if changed then
					assert(rostermanager.save_roster(username, hostname, roster));
				end
			end
			pctl.show_message("Fixed %d items on host %s", fixes, hostname);
		end
	end
	return 0;
end