File

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 +

+
−# Account based MUC joining
+
−
+
−Normally when joining a MUC groupchat, it is each individual client that
+
−joins. This means their presence in the group is tied to the session,
+
−which can be short-lived or unstable, especially in the case of mobile
+
−clients.
+
−
+
−This has a few problems. For one, for every message to the groupchat, a
+
−copy is sent to each joined client. This means that at the account
+
−level, each message would pass by once for each client that is joined,
+
−making it difficult to archive these messages in the users personal
+
−archive.
+
−
+
−A potentially better approach would be that the user account itself is
+
−the entity that joins the groupchat. Since the account is an entity that
+
−lives in the server itself, and the server tends to be online on a good
+
−connection most of the time, this may improve the experience and
+
−simplify some problems.
+
−
+
−This is one of the essential changes in the MIX architecture, which is
+
−being designed to replace MUC.
+
−
+
−`mod_minimix` is an experiment meant to determine if things can be
+
−improved without replacing the entire MUC standard. It works by
+
−pretending to each client that nothing is different and that they are
+
−joining MUCs directly, but behind the scenes, it arranges it such that
+
−only the account itself joins each groupchat. Which sessions have joined
+
−which groups are kept track of. Groupchat messages are then forked to
+
−those sessions, similar to how normal chat messages work.
+
−
+
−## Known issues
+
−
+
−-   You can never leave.
+
−-   You will never see anyone leave.
+
−-   Being kicked is not handled.
+
−
+
−## Unknown issues
+
−
+
−-   Probably many.
+
−
+
−## TODO
+
−
+
−-   Integrate with bookmarks
+
−-   tracking outgoing presence
+
−-   leaving rooms
+
−-   nickname management
+
−-   bookmark sync
+
−
+
−# Compatibility
+
−
+
−Briefly tested with Prosody trunk (as of this writing).