Mercurial > prosody-modules
view mod_groups_muc_bookmarks/mod_groups_muc_bookmarks.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 | 791aa8072f58 |
| children |
line wrap: on
line source
local jid_split = require "util.jid".split; local st = require "util.stanza"; local mod_groups = module:depends("groups_internal") local mod_pep = module:depends("pep") local XMLNS_BM2 = "urn:xmpp:bookmarks:1"; local XMLNS_XEP0060 = "http://jabber.org/protocol/pubsub"; local default_options = { ["persist_items"] = true; ["max_items"] = "max"; ["send_last_published_item"] = "never"; ["access_model"] = "whitelist"; }; local function get_current_bookmarks(jid, service) local ok, items = service:get_items(XMLNS_BM2, jid) if not ok then if items == "item-not-found" then return {}, nil; else return nil, items; end end return items or {}; end local function update_bookmark(jid, service, room, bookmark) local ok, err = service:publish(XMLNS_BM2, jid, room, bookmark, default_options); if ok then module:log("debug", "found existing matching bookmark, updated") else module:log("error", "failed to update bookmarks: %s", err) end end local function find_matching_bookmark(storage, room) return storage[room]; end local function inject_bookmark(jid, room, autojoin, name) module:log("debug", "Injecting bookmark for %s into %s", room, jid); local pep_service = mod_pep.get_pep_service(jid_split(jid)) local current, err = get_current_bookmarks(jid, pep_service); if err then module:log("error", "Could not retrieve existing bookmarks for %s: %s", jid, err); return; end local found = find_matching_bookmark(current, room) if found then local existing = found:get_child("conference", XMLNS_BM2); if autojoin ~= nil then existing.attr.autojoin = autojoin and "true" or "false" end if name ~= nil then -- do not change already configured names if not existing.attr.name then existing.attr.name = name end end else module:log("debug", "no existing bookmark found, adding new") found = st.stanza("item", { xmlns = XMLNS_XEP0060; id = room }) :tag("conference", { xmlns = XMLNS_BM2; name = name; autojoin = autojoin and "true" or "false"; }) end update_bookmark(jid, pep_service, room, found) end local function remove_bookmark(jid, room) local pep_service = mod_pep.get_pep_service(jid_split(jid)) return pep_service:retract(XMLNS_BM2, jid, room, st.stanza("retract", { id = room })); end local function handle_user_added(event) local group_info = event.group_info; local jid = event.user .. "@" .. event.host if group_info.muc_jid then inject_bookmark(jid, group_info.muc_jid, true, group_info.name); elseif group_info.mucs then for _, chat in ipairs(mod_groups.get_group_chats(event.id)) do if not chat.deleted then inject_bookmark(jid, chat.jid, true, chat.name); end end else module:log("debug", "ignoring user added event on group %s because it has no MUCs", event.id) end end local function handle_user_removed(event) -- Removing the bookmark is fine as the user just lost any privilege to -- be in the MUC (as group MUCs are members-only). local group_info = event.group_info; local jid = event.user .. "@" .. event.host if group_info.muc_jid then remove_bookmark(jid, event.group_info.muc_jid); elseif group_info.mucs then for _, muc_jid in ipairs(group_info.mucs) do remove_bookmark(jid, muc_jid); end else module:log("debug", "ignoring user removed event on group %s because it has no MUC", event.id) end end module:hook("group-user-added", handle_user_added) module:hook("group-user-removed", handle_user_removed) local function handle_muc_added(event) -- Add MUC to all members' bookmarks module:log("info", "Adding new group chat to all member bookmarks..."); local muc_jid, muc_name = event.muc.jid, event.muc.name; for member_username in pairs(mod_groups.get_members(event.group_id)) do local member_jid = member_username .. "@" .. module.host; inject_bookmark(member_jid, muc_jid, true, muc_name); end end local function handle_muc_removed(event) -- Remove MUC from all members' bookmarks local muc_jid = event.muc.jid; for member_username in ipairs(mod_groups.get_members(event.group_id)) do local member_jid = member_username .. "@" .. module.host; remove_bookmark(member_jid, muc_jid); end end module:hook("group-chat-added", handle_muc_added) module:hook("group-chat-removed", handle_muc_removed)
