view mod_muc_activity/mod_muc_activity.lua @ 6214:cc5c0f1dc89b

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
author Menel <menel@snikket.de>
date Mon, 12 May 2025 10:42:26 +0200
parents a0429c322454
children
line wrap: on
line source

local os_time = os.time;
local math_floor = math.floor;
local store = module:open_store("muc_activity", "keyval");

local accumulator = {};

local field_var = "{urn:xmpp:muc-activity}message-activity";

module:hook("muc-room-destroyed", function (event)
	local jid = event.room.jid;
	module:log("debug", "deleting activity data for destroyed muc %s", jid);
	store:set_keys(jid, {});
	accumulator[jid] = nil;
end)

module:hook("muc-occupant-groupchat", function (event)
	local jid = event.room.jid;
	if not event.room:get_persistent() then
		-- we do not count stanzas in non-persistent rooms
		if accumulator[jid] then
			-- if we have state for the room, drop it.
			store:set_keys(jid, {});
			accumulator[jid] = nil;
		end

		return
	end

	if event.stanza:get_child("body") == nil then
		-- we do not count stanzas without body.
		return
	end

	module:log("debug", "counting stanza for MUC activity in %s", jid);
	accumulator[jid] = (accumulator[jid] or 0) + 1;
end)

local function shift(data)
	for i = 1, 23 do
		data[i] = data[i+1]
	end
end

local function accumulate(data)
	if data == nil then
		return 0;
	end
	local accum = 0;
	for i = 1, 24 do
		local v = data[i];
		if v ~= nil then
			accum = accum + v
		end
	end
	return accum;
end

module:hourly("muc-activity-shift", function ()
	module:log("info", "shifting MUC activity store forward by one hour");
	for jid in store:users() do
		local data = store:get(jid);
		local new = accumulator[jid] or 0;
		shift(data);
		data[24] = new;
		accumulator[jid] = nil;
		store:set(jid, data);
	end

	-- All remaining entries in the accumulator are non-existent in the store,
	-- otherwise they would have been removed earlier.
	for jid, count in pairs(accumulator) do
		store:set(jid, { [24] = count });
	end
	accumulator = {};
end)

module:hook("muc-disco#info", function(event)
	local room = event.room;
	local jid = room.jid;
	if not room:get_persistent() or not room:get_public() or room:get_members_only() or room:get_password() ~= nil then
		module:log("debug", "%s is not persistent or not public, not injecting message activity", jid);
		return;
	end
	local count = accumulate(store:get(jid)) / 24.0;
	table.insert(event.form, { name = field_var, label = "Message activity" });
	event.formdata[field_var] = tostring(count);
end);