Mercurial > prosody-modules
view mod_mam_adhoc/mod_mam_adhoc.lua @ 6258:06fbbd45ba75
mod_cloud_notify: Readme: fix links and labels that were removed in the last commit
diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md
--- a/mod_cloud_notify/README.md
+++ b/mod_cloud_notify/README.md
@@ -1,3 +1,9 @@
+----
+-labels:
+-- 'Stage-Beta'
+-summary: 'XEP-0357: Cloud push notifications'
+----
+
# Introduction
This module enables support for sending "push notifications" to clients
@@ -32,15 +38,15 @@ notification to your device. When your d
it will display it or wake up the app so it can connect to XMPP and
receive any pending messages.
-This protocol is described for developers in \[XEP-0357: Push
-Notifications\].
+This protocol is described for developers in [XEP-0357: Push
+Notifications].
-For this module to work reliably, you must have \[mod_smacks\],
-\[mod_mam\] and \[mod_carbons\] also enabled on your server.
+For this module to work reliably, you must have [mod_smacks],
+[mod_mam] and [mod_carbons] also enabled on your server.
Some clients, notably Siskin and Snikket iOS need some additional
extensions that are not currently defined in a standard XEP. To support
-these clients, see \[mod_cloud_notify_extensions\].
+these clients, see [mod_cloud_notify_extensions].
# Configuration
@@ -58,18 +64,18 @@ these clients, see \[mod_cloud_notify_ex
# Internal design notes
App servers are notified about offline messages, messages stored by
-\[mod_mam\] or messages waiting in the smacks queue. The business rules
+[mod_mam] or messages waiting in the smacks queue. The business rules
outlined
[here](//mail.jabber.org/pipermail/standards/2016-February/030925.html)
are all honored[^2].
-To cooperate with \[mod_smacks\] this module consumes some events:
+To cooperate with [mod_smacks] this module consumes some events:
`smacks-ack-delayed`, `smacks-hibernation-start` and
`smacks-hibernation-end`. These events allow this module to send out
notifications for messages received while the session is hibernated by
-\[mod_smacks\] or even when smacks acknowledgements for messages are
+[mod_smacks] or even when smacks acknowledgements for messages are
delayed by a certain amount of seconds configurable with the
-\[mod_smacks\] setting `smacks_max_ack_delay`.
+[mod_smacks] setting `smacks_max_ack_delay`.
The `smacks_max_ack_delay` setting allows to send out notifications to
clients which aren't already in smacks hibernation state (because the
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 10:44:37 +0200 |
| parents | 27b41ee61601 |
| children |
line wrap: on
line source
module:depends"adhoc"; local dataforms_new = require "util.dataforms".new; local jid_split = require "util.jid".split; local t_insert = table.insert; local prefs = module:require"mod_mam/mamprefs"; local set_prefs, get_prefs = prefs.set, prefs.get; local mam_prefs_form = dataforms_new{ title = "Archive preferences"; --instructions = ""; { name = "default", label = "Default storage policy", type = "list-single", value = { { value = "always", label = "Always" }, { value = "never", label = "Never", default = true}, { value = "roster", label = "Roster" }, }, }; { name = "always", label = "Always store messages to/from", type = "jid-multi" }; { name = "never", label = "Never store messages to/from", type = "jid-multi" }; }; local host = module.host; local default_attrs = { always = true, [true] = "always", never = false, [false] = "never", roster = "roster", } local function mam_prefs_handler(self, data, state) local username = jid_split(data.from); if state then -- the second return value if data.action == "cancel" then return { status = "canceled" }; end local fields = mam_prefs_form:data(data.form); local default, always, never = fields.default, fields.always, fields.never; local prefs = {}; if default then prefs[false] = default_attrs[default]; end if always then for i=1,#always do prefs[always[i]] = true; end end if never then for i=1,#never do prefs[never[i]] = false; end end set_prefs(username, prefs); return { status = "completed" } else -- No state, send the form. local prefs = get_prefs(username); local values = { default = { { value = "always", label = "Always" }; { value = "never", label = "Never" }; { value = "roster", label = "Roster" }; }; always = {}; never = {}; }; for jid, p in pairs(prefs) do if jid then t_insert(values[p and "always" or "never"], jid); elseif p == true then -- Yes, this is ugly. FIXME later. values.default[1].default = true; elseif p == false then values.default[2].default = true; elseif p == "roster" then values.default[3].default = true; end end return { status = "executing", actions = { "complete" }, form = { layout = mam_prefs_form, values = values } }, true; end end module:provides("adhoc", module:require"adhoc".new("Archive settings", "urn:xmpp:mam#configure", mam_prefs_handler, "local_user"));
