Software / code / prosody-modules
File
mod_auto_moved/mod_auto_moved.lua @ 6302: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 |
| parent | 4679:f95a1e197a07 |
line wrap: on
line source
local id = require "util.id"; local jid = require "util.jid"; local promise = require "util.promise"; local rm = require "core.rostermanager"; local st = require "util.stanza"; local errors = require "util.error".init(module.name, { ["statement-not-found"] = { type = "cancel", condition = "item-not-found" }; ["statement-mismatch"] = { type = "cancel", condition = "conlict" }; }); module:hook("presence/bare", function (event) local origin, stanza = event.origin, event.stanza; if stanza.attr.type ~= "subscribe" then return; -- We're only interested in subscription requests end local moved = stanza:get_child("moved", "urn:xmpp:moved:1"); if not moved then return; -- We're only interested in stanzas with a moved notification end local verification = stanza:get_child("moved-verification", "https://prosody.im/protocol/moved"); if verification then return; -- We already attempted to verify this stanza end module:log("debug", "Received moved notification from %s", stanza.attr.from); local old_jid = moved:get_child_text("old-jid"); if not old_jid then return; -- Failed to read old JID end local to_user = jid.node(stanza.attr.to); local new_jid_unverified = jid.bare(stanza.attr.from); if not rm.is_contact_subscribed(to_user, module.host, old_jid) then return; -- Old JID was not an existing contact, ignore end if rm.is_contact_pending_in(to_user, module.host, new_jid_unverified) or rm.is_contact_subscribed(to_user, module.host, new_jid_unverified) then return; -- New JID already subscribed or pending, ignore end local moved_statement_query = st.iq({ to = old_jid, type = "get", id = id.short() }) :tag("pubsub", { xmlns = "http://jabber.org/protocol/pubsub" }) :tag("items", { node = "urn:xmpp:moved:1" }) :tag("item", { id = "current" }):up() :up() :up(); -- TODO: Catch and handle <gone/> errors per note in XEP-0283. module:send_iq(moved_statement_query):next(function (reply) module:log("debug", "Statement reply: %s", reply.stanza); local moved_statement = reply.stanza:find("{http://jabber.org/protocol/pubsub}pubsub/items/{http://jabber.org/protocol/pubsub}item/{urn:xmpp:moved:1}moved"); if not moved_statement then return promise.reject(errors.new("statement-not-found")); -- No statement found end local new_jid = jid.prep(moved_statement:get_child_text("new-jid")); if new_jid ~= new_jid_unverified then return promise.reject(errors.new("statement-mismatch")); -- Verification failed; JIDs do not match end -- Verified! module:log("info", "Verified moved notification <%s> -> <%s>", old_jid, new_jid); -- Add incoming subscription and respond rm.set_contact_pending_in(to_user, module.host, new_jid); rm.subscribed(to_user, module.host, new_jid); module:send(st.presence({ to = new_jid, from = to_user.."@"..module.host, type = "subscribed" })); rm.roster_push(to_user, module.host, new_jid); -- Request outgoing subscription if old JID had one if rm.is_user_subscribed(to_user, module.host, old_jid) then module:log("debug", "Requesting subscription to new JID"); rm.set_contact_pending_out(to_user, module.host, new_jid); module:send(st.presence({ to = new_jid, from = to_user.."@"..module.host, type = "subscribe" })); end end):catch(function (err) module:log("debug", "Failed to verify moved statement for <%s> -> <%s>: %s", old_jid, new_jid_unverified, require "util.serialization".serialize(err, "debug")); stanza:reset() :tag("moved-verification", { xmlns = "https://prosody.im/protocol/moved", status = "failed" }) :up(); module:send(stanza, origin); end); -- Halt processing of the stanza, for now return true; end, 1);