Software / code / prosody-modules
File
mod_pubsub_forgejo/mod_pubsub_forgejo.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 | 6203:131b8bfbefb4 |
line wrap: on
line source
module:depends("http") local pubsub_service = module:depends("pubsub").service local st = require "util.stanza" local json = require "util.json" local hashes = require "util.hashes" local from_hex = require"util.hex".from local hmacs = { sha1 = hashes.hmac_sha1, sha256 = hashes.hmac_sha256, sha384 = hashes.hmac_sha384, sha512 = hashes.hmac_sha512 } local format = module:require "format" local default_templates = module:require "templates" -- configuration local forgejo_secret = module:get_option("forgejo_secret") local default_node = module:get_option("forgejo_node", "forgejo") local node_prefix = module:get_option_string("forgejo_node_prefix", "forgejo/") local node_mapping = module:get_option_string("forgejo_node_mapping") local forgejo_actor = module:get_option_string("forgejo_actor") or true local skip_commitless_push = module:get_option_boolean( "forgejo_skip_commitless_push", true) local custom_templates = module:get_option("forgejo_templates") local forgejo_templates = default_templates if custom_templates ~= nil then for k, v in pairs(custom_templates) do forgejo_templates[k] = v end end -- used for develoment, should never be set in prod! local insecure = module:get_option_boolean("forgejo_insecure", false) -- validation if not insecure then assert(forgejo_secret, "Please set 'forgejo_secret'") end local error_mapping = { ["forbidden"] = 403, ["item-not-found"] = 404, ["internal-server-error"] = 500, ["conflict"] = 409 } local function verify_signature(secret, body, signature) if insecure then return true end if not signature then return false end local algo, digest = signature:match("^([^=]+)=(%x+)") if not algo then return false end local hmac = hmacs[algo] if not algo then return false end return hmac(secret, body) == from_hex(digest) end function handle_POST(event) local request, response = event.request, event.response if not verify_signature(forgejo_secret, request.body, request.headers.x_hub_signature) then module:log("debug", "Signature validation failed") return 401 end local data = json.decode(request.body) if not data then response.status_code = 400 return "Invalid JSON. From you of all people..." end local forgejo_event = request.headers.x_forgejo_event or data.object_kind if skip_commitless_push and forgejo_event == "push" and data.total_commits == 0 then module:log("debug", "Skipping push event with 0 commits") return 501 end if forgejo_templates[forgejo_event] == nil then module:log("debug", "Unsupported forgejo event %q", forgejo_event) return 501 end local item = format(data, forgejo_templates[forgejo_event]) if item == nil then module:log("debug", "Formatter returned nil for event %q", forgejo_event) return 501 end local node = default_node if node_mapping then node = node_prefix .. data.repository[node_mapping] end create_node(node) local ok, err = pubsub_service:publish(node, forgejo_actor, item.attr.id, item) if not ok then return error_mapping[err] or 500 end response.status_code = 202 return "Thank you forgejo.\n" .. tostring(item:indent(1, " ")) end module:provides("http", {route = {POST = handle_POST}}) function create_node(node) if not pubsub_service.nodes[node] then local ok, err = pubsub_service:create(node, true) if not ok then module:log("error", "Error creating node: %s", err) else module:log("debug", "Node %q created", node) end end end