prosody-modules
1a6cd0bbb7ab
mod_muc_hats_api/README.md
Software / code / prosody-modules
File
mod_muc_hats_api/README.md @ 6110: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 |
| parent | 6003:fe081789f7b5 |
line wrap: on
line source
--- summary: API for managing MUC hats --- # Introduction This module provides an internal API (i.e. to other modules) to manage 'hats' for users in MUC rooms. Hats (first defined in [XEP-0317], currently deferred) are additional identifiers that can be attached to users in a group chat. For example in an educational context, you may have a 'Teacher' hat that allows students to identify their teachers. Hats consist of a machine-readable unique identifier (a URI), and optionally a human-readable label. [XEP-0317] suggests a protocol for users to manage their own hats, but though the API in this module allows for both user-managed and system-managed hats, there is currently no protocol implemented for users to manage their own hats, which is rarely desired in real-world implementations. The rest of this documentation is designed for developers who use this module. ## Data model ### User ``` { "hats": { "urn:uuid:164c41a2-7461-4cff-bdae-3f93078a6607": { "active": false }, "http://example.com/hats/foo": { "active": true, "required": true, "title": "Awesome" } } ``` | Field | Type | Description | |-------|--------|--------------------------------------------------------------| | hats | object | An object where mapping hat ids (key) to attachments (value) | Hat IDs must be a URI that uniquely identifies the hat. ### Attachment ``` { "active": true, "required": true, "title": "My Awesome Hat" } ``` | Field | Type | Description | |----------|---------|-------------------------------------------------------------| | active | boolean | If true, indicates the user is currently displaying the hat | | required | boolean | If true, indicates the user is not able to remove the hat | | title | string | A human-readable display name or label for the hat | All fields are optional, omitted boolean values are equivalent to false. ## API All methods return 'nil, err' on failure as standard throughout the Prosody codebase. Example of using this module from another module: ``` local muc_hats = module:depends("muc_hats_api"); muc_hats.add_user_hat("user@localhost", "room@conference.localhost", "urn:uuid:164c41a2-7461-4cff-bdae-3f93078a6607", { active = true }); ``` Note that the module only works when loaded on a MUC host, which generally means any module that uses it must also be loaded on the MUC host that it is managing. ### add_user_hat `add_user_hat(user_jid, room_jid, hat_id, attachment)` Adds the identified hat to a user's... wardrobe? The user must already have an affiliation with the room (i.e. member, admin or owner). If `attachment` is omitted, it defaults to `{}`. #### Error cases item-not-found : Supplied room JID was not found on the current host item-not-found : Supplied user JID was not affiliated with the room ### remove_user_hat `remove_user_hat(user_jid, room_jid, hat_id)` If the identified hat is currently available to the user, it is removed. #### Error cases item-not-found : Supplied room JID was not found on the current host item-not-found : Supplied user JID was not affiliated with the room ### set_user_hats `set_user_hats(user_jid, room_jid, hats)` Ensures the listed hats are the hats available to a user, automatically adding/removing as necessary. The `hats` parameter should be an object mapping hat ids (keys) to attachment objects (values). #### Error cases item-not-found : Supplied room JID was not found on the current host item-not-found : Supplied user JID was not affiliated with the room
