Software / code / prosody-modules
File
mod_auth_http/mod_auth_http.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 | 4454:8862a80cbd00 |
line wrap: on
line source
-- Prosody IM -- Copyright (C) 2008-2013 Matthew Wild -- Copyright (C) 2008-2013 Waqas Hussain -- Copyright (C) 2014 Kim Alvefur -- -- This project is MIT/X11 licensed. Please see the -- COPYING file in the source package for more information. -- local new_sasl = require "util.sasl".new; local base64 = require "util.encodings".base64.encode; local have_async, async = pcall(require, "util.async"); local http = require "net.http"; if not have_async then error("Your version of Prosody does not support async and is incompatible"); end local host = module.host; local api_base = module:get_option_string("http_auth_url", ""):gsub("$host", host); if api_base == "" then error("http_auth_url required") end api_base = api_base:gsub("/$", ""); local auth_creds = module:get_option_string("http_auth_credentials"); local method_types = { -- Unlisted methods default to GET register = "POST"; set_password = "POST"; remove_user = "POST"; }; local provider = {}; local function make_request(method_name, params) local wait, done = async.waiter(); local method_type = method_types[method_name] or "GET"; params.server = params.server or host; local encoded_params = http.formencode(params); local url; local ex = { method = method_type; headers = { Authorization = auth_creds and ("Basic "..base64(auth_creds)) or nil; }; } if method_type == "POST" then url = api_base.."/"..method_name; ex.headers["Content-Type"] = "application/x-www-form-urlencoded"; ex.body = encoded_params; else url = api_base.."/"..method_name.."?"..encoded_params; end local content, code; local function cb(content_, code_) content, code = content_, code_; done(); end http.request(url, ex, cb); wait(); return code, content; end function provider.test_password(username, password) local code, body = make_request("check_password", { user = username, pass = password }); if code == 200 and body == "true" then return true; end return false; end function provider.users() return function() return nil; end end function provider.set_password(username, password) local code = make_request("set_password", { user = username, pass = password }); if code == 200 or code == 201 or code == 204 then return true; end return false; end function provider.user_exists(username) local code, body = make_request("user_exists", { user = username }); if code == 200 and body == "true" then return true; end return false; end function provider.create_user(username, password) local code = make_request("register", { user = username, pass = password }); if code == 201 then return true; end return false; end function provider.delete_user(username) local code = make_request("remove_user", { user = username }); if code == 200 or code == 201 or code == 204 then return true; end return false; end function provider.get_sasl_handler() return new_sasl(host, { --luacheck: ignore 212/sasl 212/realm plain_test = function(sasl, username, password, realm) return provider.test_password(username, password), true; end; }); end module:provides("auth", provider);