Mercurial > prosody-modules
view mod_sms_free/mod_sms_free.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 | 5a70dd2349a7 |
| children |
line wrap: on
line source
local http = require "net.http"; local jid_split = require "util.jid".split; local dataforms_new = require "util.dataforms".new; local adhoc_new = module:require "adhoc".new; local adhoc_simple_form = require "util.adhoc".new_simple_form; local t_concat = table.concat; local store = module:open_store(); local function api_handler(body, code) if code == 200 then module:log("debug", "SMS correctly sent."); elseif code == 0 then module:log("error", "error querying Free API: %s", body); elseif code >= 400 then module:log("warn", "received error code %d: %s", code, body); end end local function message_handler(event) local message = event.stanza; local username, host = jid_split(message.attr.to); -- Only proceed if the user has set Free credentials. local data = store:get(username); if not data then return; end -- Only proceed if the message is of type chat or normal. local message_type = message.attr.type; if message_type == "error" or message_type == "headline" or message_type == "groupchat" then -- TODO: Maybe handle groupchat or headline in the future. return; end -- Only proceed if the message contains a body. local body = message:get_child_text("body"); if not body then return; end -- Only proceed if all sessions are "xa", or if there are no sessions. local sessions = prosody.hosts[host].sessions[username]; if sessions then local do_send = true; for _, session in pairs(sessions.sessions) do local show = session.presence:get_child_text("show"); if show ~= "xa" then do_send = false; end end if not do_send then return; end end -- Then do the actual request to send the SMS. local headers = { user = data.user, pass = data.pass, msg = http.urlencode(body), }; http.request("https://smsapi.free-mobile.fr/sendmsg", { headers = headers }, api_handler); end local set_form = dataforms_new { title = "Set mobile.free.fr SMS credentials"; instructions = "Enable the “Notifications by SMS” service at https://mobile.free.fr/moncompte/ and paste the credentials in this form."; { type = "hidden"; name = "FORM_TYPE"; value = "http://prosody.im/protocol/sms_free#set"; }; { type = "text-single"; name = "user"; label = "Your login on Free’s website"; }; { type = "text-single"; name = "pass"; label = "Your authentication key"; }; }; local set_adhoc = adhoc_simple_form(set_form, function (data, errors, state) if errors then local errmsg = {}; for name, text in pairs(errors) do errmsg[#errmsg + 1] = name .. ": " .. text; end return { status = "completed", error = { message = t_concat(errmsg, "\n") } }; end local username, host = jid_split(state.from); module:log("debug", "Setting mobile.free.fr credentials for %s@%s: user=%s, pass=%s", username, host, data.user, data.pass); local ok, err = store:set(username, { user = data.user, pass = data.pass }); if ok then return { status = "completed", info = "SMS notifications to your phone enabled." }; else return { status = "completed", error = { message = err } }; end end); module:provides("adhoc", adhoc_new("Set mobile.free.fr SMS notification credentials", "http://prosody.im/protocol/sms_free#set", set_adhoc)); module:provides("adhoc", adhoc_new("Unset mobile.free.fr SMS notifications", "http://prosody.im/protocol/sms_free#unset", function (_, data) if data.action ~= "execute" then return { status = "canceled" }; end module:log("debug", "Unsetting mobile.free.fr credentials."); local username, host = jid_split(data.from); local ok, err = store:set(username, nil); if ok then return { status = "completed", info = "SMS notifications to your phone disabled." }; else return { status = "completed", error = { message = err } }; end end)); -- Stanzas sent to local clients. module:hook("message/bare", message_handler); module:hook("message/full", message_handler);
