Mercurial > prosody-modules
view mod_adhoc_dataforms_demo/mod_adhoc_dataforms_demo.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 | 3e2e708fd18b |
| children |
line wrap: on
line source
local dataforms = require "util.dataforms"; local adhoc_util = require "util.adhoc"; local serialization = require "util.serialization"; local adhoc_new = module:require "adhoc".new; -- Dataform borrowed from Prosodys busted test for util.dataforms local form = dataforms.new({ title = "form-title", instructions = "form-instructions", { type = "hidden", name = "FORM_TYPE", value = "xmpp:prosody.im/spec/util.dataforms#1", }; { type = "fixed", label = "fixed-label", name = "fixed-field#1", value = "fixed-value", }, { type = "hidden", label = "hidden-label", name = "hidden-field", value = "hidden-value", }, { type = "text-single", label = "text-single-label", name = "text-single-field", value = "text-single-value", }, { type = "text-multi", label = "text-multi-label", name = "text-multi-field", value = "text\nmulti\nvalue", }, { type = "text-private", label = "text-private-label", name = "text-private-field", value = "text-private-value", }, { type = "boolean", label = "boolean-label", name = "boolean-field", value = true, }, { type = "fixed", label = "fixed-label", name = "fixed-field#2", value = "fixed-value", }, { type = "list-multi", label = "list-multi-label", name = "list-multi-field", value = { "list-multi-option-value#1", "list-multi-option-value#3", }, options = { { label = "list-multi-option-label#1", value = "list-multi-option-value#1", default = true, }, { label = "list-multi-option-label#2", value = "list-multi-option-value#2", default = false, }, { label = "list-multi-option-label#3", value = "list-multi-option-value#3", default = true, }, } }, { type = "jid-single", label = "jid-single-label", name = "jid-single-field", value = "jid@single/value", }, { type = "jid-multi", label = "jid-multi-label", name = "jid-multi-field", value = { "jid@multi/value#1", "jid@multi/value#2", }, }, { type = "list-single", label = "list-single-label", name = "list-single-field", value = "list-single-value", options = { "list-single-value", "list-single-value#2", "list-single-value#3", } }, }) local function handler(fields, err, data) -- luacheck: ignore 212/data return { status = "completed", info = "Data was:\n" .. serialization.serialize(err or fields), }; end module:provides("adhoc", adhoc_new("Dataforms Demo", "xmpp:zash.se/mod_adhoc_dataforms_demo#form", adhoc_util.new_simple_form(form, handler), "any")); local function multi_step_command(_, data, state) if data.action == "cancel" then return { status = "canceled" }; elseif data.action == "complete" then return { status = "completed", info = "State was:\n" .. serialization.serialize(state, { fatal = false }), }; end if state and data.action == "execute" then data.action = "next"; elseif not state and data.action == "next" then -- Prevent jumping directly to step 2 return { status = "canceled", error = "Invalid action" }; end state = state or { step = 1, forms = { } }; if data.action == "next" then state.step = state.step + 1; elseif data.action == "prev" then state.step = math.max(state.step - 1, 1); end local current_form = state.forms[state.step] if not current_form then current_form = { title = string.format("Step %d", state.step); instructions = state.step == 1 and "Here's a form." or "Here's another form."; }; local already_selected = {}; for _ = 1, math.random(1, 5) do local random repeat random = math.random(2, #form); until not already_selected[random] already_selected[random] = true; table.insert(current_form, form[random]); end state.forms[state.step] = dataforms.new(current_form); end local next_step = { status = "executing", form = current_form, default = "next", actions = { "next", "complete" }, }; if state.step > 1 then table.insert(next_step.actions, 1, "prev"); end return next_step, state; end local permission = "any"; if not module.send_iq then -- hacky attempt at detecting 0.11 or earlier permission = "user"; end module:depends("adhoc"); module:provides("adhoc", adhoc_new("Multi-step command demo", "xmpp:zash.se/mod_adhoc_dataforms_demo#multi", multi_step_command, permission));
