Software / code / prosody-modules
File
mod_muc_bot/mod_muc_bot.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 | 4824:205b9d06fe6b |
line wrap: on
line source
local st = require "util.stanza"; local jid = require "util.jid"; local bots = module:get_option_set("known_bots", {}); module:hook("muc-occupant-groupchat", function(event) if event.occupant then return end -- skip messages from actual occupants local room = event.room; if bots:contains(jid.bare(event.from)) or bots:contains(jid.host(event.from)) then local nick = room:get_registered_nick(jid); if not nick then -- Allow bot to specify its own nick, but we're appending '[bot]' to it. -- FIXME HATS!!! nick = event.stanza:get_child_text("nick", "http://jabber.org/protocol/nick"); nick = (nick or jid.bare(event.from)) .. "[bot]"; end local virtual_occupant_jid = jid.prep(room.jid .. "/" .. nick, true); if not virtual_occupant_jid then module:send(st.error_reply(event.stanza, "modify", "jid-malformed", "Nickname must pass strict validation", room.jid)); return true; end local occupant = room:new_occupant(jid.bare(event.from), virtual_occupant_jid); local join = st.presence({from = event.from; to = virtual_occupant_jid}); local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"}); occupant:set_session(event.from, join, true); room:save_occupant(occupant); room:publicise_occupant_status(occupant, dest_x); -- Inject virtual occupant to trick all the other hooks on this event that -- this is an actual legitimate participant. event.occupant = occupant; end end, 66); module:hook("muc-occupant-pre-join", function(event) local room = event.room; local nick = jid.resource(event.occupant.nick); if nick:sub(-5, -1) == "[bot]" then event.origin.send(st.error_reply(event.stanza, "modify", "policy-violation", "Only known bots may use the [bot] suffix", room.jid)); return true; end end, 3); module:hook("muc-occupant-pre-change", function(event) local room = event.room; local nick = jid.resource(event.dest_occupant.nick); if nick:sub(-5, -1) == "[bot]" then event.origin.send(st.error_reply(event.stanza, "modify", "policy-violation", "Only known bots may use the [bot] suffix", room.jid)); return true; end end, 3); if not module:get_option_boolean("bots_get_messages", true) then module:hook("muc-broadcast-message", function (event) event.room:broadcast(event.stanza, function (nick, occupant) if nick:sub(-5, -1) == "[bot]" or bots:contains(occupant.bare_jid) or bots:contains(jid.host(occupant.bare_jid)) then return false; else return true; end end); return true; end, -100); end if module:get_option_boolean("ignore_bot_errors", true) then module:hook("message/full", function (event) local stanza = event.stanza; if stanza.attr.type == "error" then if bots:contains(jid.bare(stanza.attr.from)) or bots:contains(jid.host(stanza.attr.from)) then module:log("debug", "Ignoring error from known bot"); return true; end end end, 1); end assert(string.sub("foo[bot]", -5, -1) == "[bot]", "substring indicies, how do they work?");