Mercurial > prosody-modules
view mod_devices/mod_devices.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 | 4cf65afd90f4 |
| children |
line wrap: on
line source
local it = require "util.iterators"; local new_id = require "util.id".medium; local max_user_devices = module:get_option_number("max_user_devices", 5); local device_store = module:open_store("devices"); local device_map_store = module:open_store("devices", "map"); --- Helper functions local function _compare_device_timestamps(a, b) return (a.last_activity_at or 0) < (b.last_activity_at or 0); end local function sorted_devices(devices) return it.sorted_pairs(devices, _compare_device_timestamps); end local function new_device(username, alt_ids) local current_time = os.time(); local device = { id = "dv-"..new_id(); created_at = current_time; last_activity = "created"; last_activity_at = current_time; alt_ids = alt_ids or {}; }; local devices = device_store:get(username); if not devices then devices = {}; end devices[device.id] = device; local devices_ordered = {}; for id in sorted_devices(devices) do table.insert(devices_ordered, id); end if #devices_ordered > max_user_devices then -- Iterate through oldest devices that are above limit, backwards for i = #devices_ordered, max_user_devices+1, -1 do local id = table.remove(devices_ordered, i); devices[id] = nil; module:log("debug", "Removing old device for %s: %s", username, id); end end device_store:set(username, devices); return device; end local function get_device_with_alt_id(username, alt_id_type, alt_id) local devices = device_store:get(username); if not devices then return nil; end for _, device in pairs(devices) do if device.alt_ids[alt_id_type] == alt_id then return device; end end end local function set_device_alt_id(username, device_id, alt_id_type, alt_id) local devices = device_store:get(username); if not devices or not devices[device_id] then return nil, "no such device"; end devices[device_id].alt_ids[alt_id_type] = alt_id; end local function record_device_state(username, device_id, activity, time) local device = device_map_store:get(username, device_id); device.last_activity = activity; device.last_activity_at = time or os.time(); device_map_store:set(username, device_id, device); end local function find_device(username, info) for _, alt_id_type in ipairs({ "resumption_token", "resource" }) do local alt_id = info[alt_id_type]; if alt_id then local device = get_device_with_alt_id(username, alt_id_type, alt_id); if device then return device, alt_id_type; end end end end --- Information gathering module:hook("pre-resource-bind", function (event) event.session.device_requested_resource = event.resource; end, 1000); local function store_resumption_token(session, stanza) session.device_requested_resume = stanza.attr.previd; end module:hook_stanza("urn:xmpp:sm:2", "resume", store_resumption_token, 5); module:hook_stanza("urn:xmpp:sm:3", "resume", store_resumption_token, 5); --- Identify device after resource bind module:hook("resource-bind", function (event) local info = { resource = event.session.device_requested_resource; resumption_token = event.session.device_requested_resume; }; local device, source = find_device(event.session.username, info); if device then event.session.log("debug", "Associated with device %s (from %s)", device.id, source); event.session.device_id = device.id; else device = new_device(event.session.username, info); event.session.log("debug", "Creating new device %s for session", device.id); event.session.device_id = device.id; end record_device_state(event.session.username, device.id, "login"); end, 1000); module:hook("resource-unbind", function (event) if event.session.device_id then record_device_state(event.session.username, event.session.device_id, "logout"); end end);
