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

local setmetatable = setmetatable;
local pcall = pcall;
local type = type;
local t_concat = table.concat;
local print = print;

local socket_url = require "socket.url";
local http = require "socket.http";
local ltn12 = require "ltn12";

--local json = require "json";
local json = module:require("couchdb/json");

--module("couchdb")
local _M = {};

local function urlcat(url, path)
	return url:gsub("/*$", "").."/"..path:gsub("^/*", "");
end

local doc_mt = {};
doc_mt.__index = doc_mt;

function doc_mt:get()
	return self.db:get(socket_url.escape(self.id));
end
function doc_mt:put(val)
	return self.db:put(socket_url.escape(self.id), val);
end
function doc_mt:__tostring()
	return "couchdb.doc("..self.url..")";
end


local db_mt = {};
db_mt.__index = db_mt;

function db_mt:__tostring()
	return "couchdb.db("..self.url..")";
end
function db_mt:doc(id)
	local url = urlcat(self.url, socket_url.escape(id));
	return setmetatable({ url = url, db = self, id = id }, doc_mt);
end
function db_mt:get(id)
	local url = urlcat(self.url, id);
	local a,b = http.request(url);
	local r,x = pcall(json.decode, a);
	if r then a = x; end
	return a,b;
end
function db_mt:put(id, value)
	local url = urlcat(self.url, id);
	if type(value) == "table" then
		value = json.encode(value);
	elseif value ~= nil and type(value) ~= "string" then
		return nil, "Invalid type";
	end
	local t = {};
	local a,b = http.request {
		url = url,
		sink = ltn12.sink.table(t),
		source = ltn12.source.string(value),
		method = "PUT",
		headers = {
			["Content-Length"] = #value,
			["Content-Type"] = "application/json"
		}
	};
	a = t_concat(t);
	local r,x = pcall(json.decode, a);
	if r then a = x; end
	return a,b;
end


local server_mt = {};
server_mt.__index = server_mt;

function server_mt:db(name)
	local url = urlcat(self.url, socket_url.escape(name));
	return setmetatable({ url = url }, db_mt);
end
function server_mt:__tostring()
	return "couchdb.server("..self.url..")";
end


function _M.server(url)
	return setmetatable({ url = url }, server_mt);
end
function _M.db(url)
	return setmetatable({ url = url }, db_mt);
end

return _M;