prosody-modules
06fbbd45ba75
mod_auto156/mod_auto156.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_auto156/mod_auto156.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 4614:5d494dba9c02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4613
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 -- Synthesize XEP-0156 JSON from DNS
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 local array = require "util.array";
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 local encodings = require "util.encodings";
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 local json = require "util.json";
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 local promise = require "util.promise";
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 local dns = require"net.adns".resolver();
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 local function check_dns(domain)
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 return dns:lookup_promise("_xmppconnect." .. domain, "TXT");
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 end
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 local function check_domain(domain)
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 return promise.resolve(domain):next(encodings.stringprep.nameprep):next(encodings.idna.to_ascii):next(
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 function(domain_A)
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 if not domain_A then
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 return promise.reject(400);
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 else
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 return domain_A;
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 end
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 end):next(check_dns):next(function(txt)
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 local uris = array();
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 for _, cm in ipairs(txt) do
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 local kind, uri = tostring(cm.txt):match("^_xmpp%-client%-(%w+)=([hpstw]+s?://.*)");
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 if kind then
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 uris:push({rel = "urn:xmpp:alt-connections:" .. kind, href = uri});
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 end
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 end
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 if #uris == 0 then
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 return promise.reject(404);
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 end
4614
5d494dba9c02 mod_auto156: Include the containing object in command output
Kim Alvefur <zash@zash.se>
parents: 4613
diff changeset
32 return {links=uris};
4613
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 end);
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 end
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 module:depends("http");
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 module:provides("http", {
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 route = {
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 ["GET /*"] = function(_, domain)
4614
5d494dba9c02 mod_auto156: Include the containing object in command output
Kim Alvefur <zash@zash.se>
parents: 4613
diff changeset
40 return check_domain(domain):next(function(altmethods)
5d494dba9c02 mod_auto156: Include the containing object in command output
Kim Alvefur <zash@zash.se>
parents: 4613
diff changeset
41 return {headers = {content_type = "application/json"}, body = json.encode(altmethods)};
4613
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
42 end);
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43 end,
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
44 },
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
45 });
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
47 function module.command(args)
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
48 local async = require "util.async";
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
49 for _, domain in ipairs(args) do
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50 print(assert(async.wait_for(check_domain(domain):next(json.encode))));
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
51 end
6478442d217f mod_auto156: Queries for XEP-0156 TXT records and prints in JSON format
Kim Alvefur <zash@zash.se>
parents:
diff changeset
52 end