view mod_statistics/mod_statistics.lua @ 6082:1a6cd0bbb7ab

mod_compliance_2023: Add 2023 Version of the compliance module, basis is the 2021 Version. diff --git a/mod_compliance_2023/README.md b/mod_compliance_2023/README.md new file mode 100644 --- /dev/null +++ b/mod_compliance_2023/README.md @@ -0,0 +1,22 @@ +--- +summary: XMPP Compliance Suites 2023 self-test +labels: +- Stage-Beta +rockspec: + dependencies: + - mod_cloud_notify + +... + +Compare the list of enabled modules with +[XEP-0479: XMPP Compliance Suites 2023] and produce basic report to the +Prosody log file. + +If installed with the Prosody plugin installer then all modules needed for a green checkmark should be included. (With prosody 0.12 only [mod_cloud_notify] is not included with prosody and we need the community module) + +# Compatibility + + Prosody-Version Status + --------------- ---------------------- + trunk Works as of 2024-12-21 + 0.12 Works diff --git a/mod_compliance_2023/mod_compliance_2023.lua b/mod_compliance_2023/mod_compliance_2023.lua new file mode 100644 --- /dev/null +++ b/mod_compliance_2023/mod_compliance_2023.lua @@ -0,0 +1,79 @@ +-- Copyright (c) 2021 Kim Alvefur +-- +-- This module is MIT licensed. + +local hostmanager = require "core.hostmanager"; + +local array = require "util.array"; +local set = require "util.set"; + +local modules_enabled = module:get_option_inherited_set("modules_enabled"); + +for host in pairs(hostmanager.get_children(module.host)) do + local component = module:context(host):get_option_string("component_module"); + if component then + modules_enabled:add(component); + modules_enabled:include(module:context(host):get_option_set("modules_enabled", {})); + end +end + +local function check(suggested, alternate, ...) + if set.intersection(modules_enabled, set.new({suggested; alternate; ...})):empty() then return suggested; end + return false; +end + +local compliance = { + array {"Server"; check("tls"); check("disco")}; + + array {"Advanced Server"; check("pep", "pep_simple")}; + + array {"Web"; check("bosh"); check("websocket")}; + + -- No Server requirements for Advanced Web + + array {"IM"; check("vcard_legacy", "vcard"); check("carbons"); check("http_file_share", "http_upload")}; + + array { + "Advanced IM"; + check("vcard_legacy", "vcard"); + check("blocklist"); + check("muc"); + check("private"); + check("smacks"); + check("mam"); + check("bookmarks"); + }; + + array {"Mobile"; check("smacks"); check("csi_simple", "csi_battery_saver")}; + + array {"Advanced Mobile"; check("cloud_notify")}; + + array {"A/V Calling"; check("turn_external", "external_services", "turncredentials", "extdisco")}; + +}; + +function check_compliance() + local compliant = true; + for _, suite in ipairs(compliance) do + local section = suite:pop(1); + if module:get_option_boolean("compliance_" .. section:lower():gsub("%A", "_"), true) then + local missing = set.new(suite:filter(function(m) return type(m) == "string" end):map(function(m) return "mod_" .. m end)); + if suite[1] then + if compliant then + compliant = false; + module:log("warn", "Missing some modules for XMPP Compliance 2023"); + end + module:log("info", "%s Compliance: %s", section, missing); + end + end + end + + if compliant then module:log("info", "XMPP Compliance 2023: Compliant ✔️"); end +end + +if prosody.start_time then + check_compliance() +else + module:hook_global("server-started", check_compliance); +end +
author Menel <menel@snikket.de>
date Sun, 22 Dec 2024 16:06:28 +0100
parents 66bda434d476
children 54e84ec12c82
line wrap: on
line source

module:set_global();

local stats = module:require("mod_statistics/stats");
local filters = require "util.filters";
local serialize = require "util.serialization".serialize;

local cached_values = {};

local sessions = {};

local function push_stat(conn, name, value)
	local value_str = serialize(value);
	return conn:write((("STAT %q (%s)\n"):format(name, value_str):gsub("\\\n", "\\n")));
end

local function push_stat_to_all(name, value)
	for conn in pairs(sessions) do
		push_stat(conn, name, value);
	end
end

local session_stats_tpl = ([[{
	message_in = %d, message_out = %d;
	presence_in = %d, presence_out = %d;
	iq_in = %d, iq_out = %d;
	bytes_in = %d, bytes_out = %d;
}]]):gsub("%s", "");


local jid_fields = {
	c2s = "full_jid";
	s2sin = "from_host";
	s2sout = "to_host";
	component = "host";
};

local function push_session_to_all(session, stats)
	local id = tostring(session):match("[a-f0-9]+$"); -- FIXME: Better id? :/
	local stanzas_in, stanzas_out = stats.stanzas_in, stats.stanzas_out;
	local s = (session_stats_tpl):format(
		stanzas_in.message, stanzas_out.message,
		stanzas_in.presence, stanzas_out.presence,
		stanzas_in.iq, stanzas_out.iq,
		stats.bytes_in, stats.bytes_out);
	local jid = session[jid_fields[session.type]] or "";
	for conn in pairs(sessions) do
		conn:write(("SESS %q %q %s\n"):format(id, jid, s));
	end
end

local available_stats = stats.stats;
local active_sessions = stats.active_sessions;

-- Handle statistics provided by other modules
local function item_handlers(host)
	host = host and (host.."/") or "";

	return function (event) -- Added
		local stats = event.item.statistics;
		local group = host..(stats.name and (stats.name.."::") or "");
		for name, stat in pairs(stats) do
			available_stats[group..name] = stat;
		end
	end, function (event) -- Removed
		local stats = event.item.statistics;
		local group = host..(stats.name and (stats.name.."::") or "");
		for name, stat in pairs(stats) do
			available_stats[group..name] = nil;
		end
	end;
end

module:handle_items("statistics-provider", item_handlers());
function module.add_host(module)
	module:handle_items("statistics-provider", item_handlers(module.host));
end

-- Network listener
local listener = {};

function listener.onconnect(conn)
	sessions[conn] = {};
	push_stat(conn, "version", prosody.version);
	for name, value in pairs(cached_values) do
		push_stat(conn, name, value);
	end
	conn:write("\n"); -- Signal end of first batch (for non-streaming clients)
end

function listener.onincoming(conn, data)
end

function listener.ondisconnect(conn)
	sessions[conn] = nil;
end

function listener.onreadtimeout()
	return true;
end

function module.load()
	if not(prosody and prosody.arg) then
		return;
	end
	filters.add_filter_hook(stats.filter_hook);

	module:add_timer(1, function ()
		for stat_name, stat in pairs(available_stats) do
			if stat.get then
				local cached = cached_values[stat_name];
				local new_value = stat.get();
				if new_value ~= cached then
					push_stat_to_all(stat_name, new_value);
					cached_values[stat_name] = new_value;
				end
			end
		end
		for session, session_stats in pairs(active_sessions) do
			active_sessions[session] = nil;
			push_session_to_all(session, session_stats);
		end
		return 1;
	end);

end
function module.unload()
	filters.remove_filter_hook(stats.filter_hook);
end
function module.command( args )
	local command = args[1];
	if command == "top" then
		local dir = module:get_directory();
		package.path = dir.."/?.lua;"..dir.."/?.lib.lua;"..package.path;
		local prosodytop = module:require "prosodytop";
		prosodytop.run();
	end
end

if prosody and prosody.arg then
	module:provides("net", {
		default_port = 5782;
		listener = listener;
		private = true;
	});
end