Mercurial > prosody-modules
view mod_groups_muc_bookmarks/mod_groups_muc_bookmarks.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 | 791aa8072f58 |
| children |
line wrap: on
line source
local jid_split = require "util.jid".split; local st = require "util.stanza"; local mod_groups = module:depends("groups_internal") local mod_pep = module:depends("pep") local XMLNS_BM2 = "urn:xmpp:bookmarks:1"; local XMLNS_XEP0060 = "http://jabber.org/protocol/pubsub"; local default_options = { ["persist_items"] = true; ["max_items"] = "max"; ["send_last_published_item"] = "never"; ["access_model"] = "whitelist"; }; local function get_current_bookmarks(jid, service) local ok, items = service:get_items(XMLNS_BM2, jid) if not ok then if items == "item-not-found" then return {}, nil; else return nil, items; end end return items or {}; end local function update_bookmark(jid, service, room, bookmark) local ok, err = service:publish(XMLNS_BM2, jid, room, bookmark, default_options); if ok then module:log("debug", "found existing matching bookmark, updated") else module:log("error", "failed to update bookmarks: %s", err) end end local function find_matching_bookmark(storage, room) return storage[room]; end local function inject_bookmark(jid, room, autojoin, name) module:log("debug", "Injecting bookmark for %s into %s", room, jid); local pep_service = mod_pep.get_pep_service(jid_split(jid)) local current, err = get_current_bookmarks(jid, pep_service); if err then module:log("error", "Could not retrieve existing bookmarks for %s: %s", jid, err); return; end local found = find_matching_bookmark(current, room) if found then local existing = found:get_child("conference", XMLNS_BM2); if autojoin ~= nil then existing.attr.autojoin = autojoin and "true" or "false" end if name ~= nil then -- do not change already configured names if not existing.attr.name then existing.attr.name = name end end else module:log("debug", "no existing bookmark found, adding new") found = st.stanza("item", { xmlns = XMLNS_XEP0060; id = room }) :tag("conference", { xmlns = XMLNS_BM2; name = name; autojoin = autojoin and "true" or "false"; }) end update_bookmark(jid, pep_service, room, found) end local function remove_bookmark(jid, room) local pep_service = mod_pep.get_pep_service(jid_split(jid)) return pep_service:retract(XMLNS_BM2, jid, room, st.stanza("retract", { id = room })); end local function handle_user_added(event) local group_info = event.group_info; local jid = event.user .. "@" .. event.host if group_info.muc_jid then inject_bookmark(jid, group_info.muc_jid, true, group_info.name); elseif group_info.mucs then for _, chat in ipairs(mod_groups.get_group_chats(event.id)) do if not chat.deleted then inject_bookmark(jid, chat.jid, true, chat.name); end end else module:log("debug", "ignoring user added event on group %s because it has no MUCs", event.id) end end local function handle_user_removed(event) -- Removing the bookmark is fine as the user just lost any privilege to -- be in the MUC (as group MUCs are members-only). local group_info = event.group_info; local jid = event.user .. "@" .. event.host if group_info.muc_jid then remove_bookmark(jid, event.group_info.muc_jid); elseif group_info.mucs then for _, muc_jid in ipairs(group_info.mucs) do remove_bookmark(jid, muc_jid); end else module:log("debug", "ignoring user removed event on group %s because it has no MUC", event.id) end end module:hook("group-user-added", handle_user_added) module:hook("group-user-removed", handle_user_removed) local function handle_muc_added(event) -- Add MUC to all members' bookmarks module:log("info", "Adding new group chat to all member bookmarks..."); local muc_jid, muc_name = event.muc.jid, event.muc.name; for member_username in pairs(mod_groups.get_members(event.group_id)) do local member_jid = member_username .. "@" .. module.host; inject_bookmark(member_jid, muc_jid, true, muc_name); end end local function handle_muc_removed(event) -- Remove MUC from all members' bookmarks local muc_jid = event.muc.jid; for member_username in ipairs(mod_groups.get_members(event.group_id)) do local member_jid = member_username .. "@" .. module.host; remove_bookmark(member_jid, muc_jid); end end module:hook("group-chat-added", handle_muc_added) module:hook("group-chat-removed", handle_muc_removed)
