Software / code / prosody-modules
File
mod_webpresence/mod_webpresence.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 | 2348:1903add39b7c |
| child | 5588:f16720087ef2 |
line wrap: on
line source
module:depends("http"); local jid_split = require "util.jid".prepped_split; local b64 = require "util.encodings".base64.encode; local sha1 = require "util.hashes".sha1; local stanza = require "util.stanza".stanza; local json = require "util.json".encode_ordered; local function require_resource(name) local icon_path = module:get_option_string("presence_icons", "icons"); local f, err = module:load_resource(icon_path.."/"..name); if f then return f:read("*a"); end module:log("warn", "Failed to open image file %s", icon_path..name); return ""; end local statuses = { online = {}, away = {}, xa = {}, dnd = {}, chat = {}, offline = {} }; local function handle_request(event, path) local status, message; local jid, type = path:match("([^/]+)/?(.*)$"); if jid then local user, host = jid_split(jid); if host and not user then user, host = host, event.request.headers.host; if host then host = host:gsub(":%d+$", ""); end end if user and host then local user_sessions = hosts[host] and hosts[host].sessions[user]; if user_sessions and user_sessions.top_resources then status = user_sessions.top_resources[1]; if status and status.presence then message = status.presence:child_with_name("status"); status = status.presence:child_with_name("show"); if not status then status = "online"; else status = status:get_text(); end if message then message = message:get_text(); end end end end end status = status or "offline"; statuses[status].image = function() return { status_code = 200, headers = { content_type = "image/png" }, body = require_resource("status_"..status..".png") }; end; statuses[status].html = function() local jid_hash = sha1(jid, true); return { status_code = 200, headers = { content_type = "text/html" }, body = [[<!DOCTYPE html>]].. tostring( stanza("html") :tag("head") :tag("title"):text("XMPP Status Page for "..jid):up():up() :tag("body") :tag("div", { id = jid_hash.."_status", class = "xmpp_status" }) :tag("img", { id = jid_hash.."_img", class = "xmpp_status_image xmpp_status_"..status, src = "data:image/png;base64,"..b64(require_resource("status_"..status..".png")) }):up() :tag("span", { id = jid_hash.."_status_name", class = "xmpp_status_name" }) :text("\194\160"..status):up() :tag("span", { id = jid_hash.."_status_message", class = "xmpp_status_message" }) :text(message and "\194\160"..message.."" or "") ) }; end; statuses[status].text = function() return { status_code = 200, headers = { content_type = "text/plain" }, body = status }; end; statuses[status].message = function() return { status_code = 200, headers = { content_type = "text/plain" }, body = (message and message or "") }; end; statuses[status].json = function() return { status_code = 200, headers = { content_type = "application/json" }, body = json({ jid = jid, show = status, status = (message and message or "null") }) }; end; statuses[status].xml = function() return { status_code = 200, headers = { content_type = "application/xml" }, body = [[<?xml version="1.0" encoding="utf-8"?>]].. tostring( stanza("result") :tag("jid"):text(jid):up() :tag("show"):text(status):up() :tag("status"):text(message) ) }; end if ((type == "") or (not statuses[status][type])) then type = "image" end; return statuses[status][type](); end module:provides("http", { default_path = "/status"; route = { ["GET /*"] = handle_request; }; });