--- a/mod_cloud_notify/mod_cloud_notify.lua Sat Mar 11 01:37:28 2017 +0100
+++ b/mod_cloud_notify/mod_cloud_notify.lua Sat Mar 11 01:42:45 2017 +0100
@@ -1,5 +1,6 @@
-- XEP-0357: Push (aka: My mobile OS vendor won't let me have persistent TCP connections)
-- Copyright (C) 2015-2016 Kim Alvefur
+-- Copyright (C) 2017 Thilo Molitor
--
-- This file is MIT/X11 licensed.
@@ -13,18 +14,101 @@
-- configuration
local include_body = module:get_option_boolean("push_notification_with_body", false);
local include_sender = module:get_option_boolean("push_notification_with_sender", false);
+local max_push_errors = module:get_option_number("push_max_errors", 50);
--- For keeping state across reloads
-local push_enabled = module:open_store();
--- TODO map store would be better here
+local host_sessions = prosody.hosts[module.host].sessions;
+local push_errors = {};
+
+-- For keeping state across reloads while caching reads
+local push_store = (function()
+ local store = module:open_store();
+ local push_services = {};
+ local api = {};
+ function api:get(user)
+ if not push_services[user] then
+ local err;
+ push_services[user], err = store:get(user);
+ if not push_services[user] and err then
+ module:log("warn", "Error reading push notification storage for user '%s': %s", user, tostring(err));
+ push_services[user] = {};
+ return push_services[user], false;
+ end
+ end
+ if not push_services[user] then push_services[user] = {} end
+ return push_services[user], true;
+ end
+ function api:set(user, data)
+ push_services[user] = data;
+ local ok, err = store:set(user, push_services[user]);
+ if not ok then
+ module:log("error", "Error writing push notification storage for user '%s': %s", user, tostring(err));
+ return false;
+ end
+ return true;
+ end
+ function api:set_identifier(user, push_identifier, data)
+ local services = self:get(user);
+ services[push_identifier] = data;
+ return self:set(user, services);
+ end
+ return api;
+end)();
+
+local function handle_push_error(event)
+ local stanza = event.stanza;
+ local error_type, condition = stanza:get_error();
+ local push_identifier = stanza.attr.id;
+ local node = jid.split(stanza.attr.to);
+ local from = stanza.attr.from;
+ local user_push_services = push_store:get(node);
+
+ if user_push_services[push_identifier] and user_push_services[push_identifier].jid == from and error_type ~= "wait" then
+ push_errors[push_identifier] = push_errors[push_identifier] + 1;
+ module:log("info", "Got error of type '%s' (%s) for identifier '%s':"
+ .."error count for this identifier is now at %s", error_type, condition, push_identifier,
+ tostring(push_errors[push_identifier]));
+ if push_errors[push_identifier] >= max_push_errors then
+ module:log("warn", "Disabling push notifications for identifier '%s'", push_identifier);
+ -- remove push settings from sessions
+ for _, session in pairs(host_sessions[node].sessions) do
+ if session.push_identifier == push_identifier then
+ session.push_identifier = nil;
+ session.push_settings = nil;
+ end
+ end
+ -- save changed global config
+ push_store:set_identifier(node, push_identifier, nil);
+ push_errors[push_identifier] = nil;
+ -- unhook iq handlers for this identifier
+ module:unhook("iq-error/bare/"..push_identifier, handle_push_error);
+ module:unhook("iq-result/bare/"..push_identifier, handle_push_success);
+ end
+ end
+ return true;
+end
+
+local function handle_push_success(event)
+ local stanza = event.stanza;
+ local push_identifier = stanza.attr.id;
+ local node = jid.split(stanza.attr.to);
+ local from = stanza.attr.from;
+ local user_push_services = push_store:get(node);
+
+ if user_push_services[push_identifier] and user_push_services[push_identifier].jid == from and push_errors[push_identifier] then
+ push_errors[push_identifier] = 0;
+ module:log("debug", "Push succeeded, error count for identifier '%s' is now at %s", push_identifier, tostring(push_errors[push_identifier]));
+ end
+ return true;
+end
-- http://xmpp.org/extensions/xep-0357.html#disco
-module:hook("account-disco-info", function(event)
+local function account_dico_info(event)
(event.reply or event.stanza):tag("feature", {var=xmlns_push}):up();
-end);
+end
+module:hook("account-disco-info", account_dico_info);
-- http://xmpp.org/extensions/xep-0357.html#enabling
-module:hook("iq-set/self/"..xmlns_push..":enable", function (event)
+local function push_enable(event)
local origin, stanza = event.origin, event.stanza;
local enable = stanza.tags[1];
origin.log("debug", "Attempting to enable push notifications");
@@ -42,33 +126,28 @@
-- Could be intentional
origin.log("debug", "No publish options in request");
end
- local user_push_services, rerr = push_enabled:get(origin.username);
- if not user_push_services then
- if rerr then
- module:log("warn", "Error reading push notification storage: %s", rerr);
- origin.send(st.error_reply(stanza, "wait", "internal-server-error"));
- return true;
- end
- user_push_services = {};
- end
- user_push_services[push_jid .. "<" .. (push_node or "")] = {
+ local push_identifier = push_jid .. "<" .. (push_node or "");
+ local push_service = {
jid = push_jid;
node = push_node;
count = 0;
options = publish_options and st.preserialize(publish_options);
};
- local ok, err = push_enabled:set(origin.username, user_push_services);
+ local ok = push_store:set_identifier(origin.username, push_identifier, push_service);
if not ok then
origin.send(st.error_reply(stanza, "wait", "internal-server-error"));
else
- origin.log("info", "Push notifications enabled");
+ origin.push_identifier = push_identifier;
+ origin.push_settings = push_service;
+ origin.log("info", "Push notifications enabled (%s)", tostring(origin.push_identifier));
origin.send(st.reply(stanza));
end
return true;
-end);
+end
+module:hook("iq-set/self/"..xmlns_push..":enable", push_enable);
-- http://xmpp.org/extensions/xep-0357.html#disabling
-module:hook("iq-set/self/"..xmlns_push..":disable", function (event)
+local function push_disable(event)
local origin, stanza = event.origin, event.stanza;
local push_jid = stanza.tags[1].attr.jid; -- MUST include a 'jid' attribute
local push_node = stanza.tags[1].attr.node; -- A 'node' attribute MAY be included
@@ -76,15 +155,29 @@
origin.send(st.error_reply(stanza, "modify", "bad-request", "Missing jid"));
return true;
end
- local user_push_services = push_enabled:get(origin.username);
+ local user_push_services = push_store:get(origin.username);
for key, push_info in pairs(user_push_services) do
if push_info.jid == push_jid and (not push_node or push_info.node == push_node) then
+ origin.log("info", "Push notifications disabled (%s)", tostring(key));
+ if origin.push_identifier == key then
+ origin.push_identifier = nil;
+ origin.push_settings = nil;
+ end
user_push_services[key] = nil;
+ push_errors[key] = nil;
+ module:unhook("iq-error/bare/"..key, handle_push_error);
+ module:unhook("iq-result/bare/"..key, handle_push_success);
end
end
- origin.send(st.reply(stanza));
+ local ok = push_store:set(origin.username, user_push_services);
+ if not ok then
+ origin.send(st.error_reply(stanza, "wait", "internal-server-error"));
+ else
+ origin.send(st.reply(stanza));
+ end
return true;
-end);
+end
+module:hook("iq-set/self/"..xmlns_push..":disable", push_disable);
local push_form = dataform {
{ name = "FORM_TYPE"; type = "hidden"; value = "urn:xmpp:push:summary"; };
@@ -95,27 +188,34 @@
};
-- http://xmpp.org/extensions/xep-0357.html#publishing
-local function handle_notify_request(origin, stanza)
- local to = stanza.attr.to;
- local node = to and jid.split(to) or origin.username;
- local user_push_services = push_enabled:get(node);
- if not user_push_services then return end
+local function handle_notify_request(stanza, node, user_push_services)
+ if not user_push_services or not #user_push_services then return end
+
+ if stanza and stanza._notify then
+ module:log("debug", "Already sent push notification to %s@%s for this stanza, not doing it again", node, module.host);
+ return;
+ end
+ if stanza then
+ stanza._notify = true;
+ end
- for _, push_info in pairs(user_push_services) do
+ for push_identifier, push_info in pairs(user_push_services) do
+ -- increment count and save it
push_info.count = push_info.count + 1;
- local push_jid, push_node = push_info.jid, push_info.node;
- local push_publish = st.iq({ to = push_jid, from = node .. "@" .. module.host, type = "set", id = "push" })
+ push_store:set_identifier(node, push_identifier, push_info);
+ -- construct push stanza
+ local push_publish = st.iq({ to = push_info.jid, from = node .. "@" .. module.host, type = "set", id = push_identifier })
:tag("pubsub", { xmlns = "http://jabber.org/protocol/pubsub" })
- :tag("publish", { node = push_node })
+ :tag("publish", { node = push_info.node })
:tag("item")
:tag("notification", { xmlns = xmlns_push });
local form_data = {
["message-count"] = tostring(push_info.count);
};
- if include_sender then
+ if stanza and include_sender then
form_data["last-message-sender"] = stanza.attr.from;
end
- if include_body then
+ if stanza and include_body then
form_data["last-message-body"] = stanza:get_child_text("body");
end
push_publish:add_child(push_form:form(form_data));
@@ -125,33 +225,39 @@
if push_info.options then
push_publish:tag("publish-options"):add_child(st.deserialize(push_info.options));
end
- module:log("debug", "Sending push notification for %s@%s to %s", node, module.host, push_jid);
+ -- send out push
+ module:log("debug", "Sending push notification for %s@%s to %s (%s)", node, module.host, push_info.jid, tostring(push_info.node));
+ -- handle push errors for this node
+ if push_errors[push_identifier] == nil then
+ push_errors[push_identifier] = 0;
+ module:hook("iq-error/bare/"..push_identifier, handle_push_error);
+ module:hook("iq-result/bare/"..push_identifier, handle_push_success);
+ end
module:send(push_publish);
end
- push_enabled:set(node, user_push_services);
+end
+
+-- small helper function to extract relevant push settings
+local function get_push_settings(stanza, session)
+ local to = stanza.attr.to;
+ local node = to and jid.split(to) or session.username;
+ local user_push_services = push_store:get(node);
+ return node, user_push_services;
end
-- publish on offline message
module:hook("message/offline/handle", function(event)
- if event.stanza._notify then
- event.stanza._notify = nil;
- return;
- end
- return handle_notify_request(event.origin, event.stanza);
+ local node, user_push_services = get_push_settings(event.stanza, event.origin);
+ return handle_notify_request(event.stanza, node, user_push_services);
end, 1);
-- publish on unacked smacks message
-local function process_new_stanza(stanza, session)
- if getmetatable(stanza) ~= st.stanza_mt then
- return stanza; -- Things we don't want to touch
- end
- if stanza.name == "message" and stanza.attr.xmlns == nil and
- ( stanza.attr.type == "chat" or ( stanza.attr.type or "normal" ) == "normal" ) and
- -- not already notified via cloud
- not stanza._notify then
- stanza._notify = true;
- session.log("debug", "Invoking cloud handle_notify_request for new smacks hibernated stanza...");
- handle_notify_request(session, stanza)
+local function process_smacks_stanza(stanza, session)
+ if session.push_identifier then
+ session.log("debug", "Invoking cloud handle_notify_request for smacks queued stanza...");
+ local user_push_services = {[session.push_identifier] = session.push_settings};
+ local node = get_push_settings(stanza, session);
+ handle_notify_request(stanza, node, user_push_services);
end
return stanza;
end
@@ -162,42 +268,114 @@
local queue = event.queue;
-- process unacked stanzas
for i=1,#queue do
- process_new_stanza(queue[i], session);
+ process_smacks_stanza(queue[i], session);
end
-- process future unacked (hibernated) stanzas
- filters.add_filter(session, "stanzas/out", process_new_stanza);
+ filters.add_filter(session, "stanzas/out", process_smacks_stanza);
end
-- smacks hibernation is ended
local function restore_session(event)
- local session = event.origin;
- filters.remove_filter(session, "stanzas/out", process_new_stanza);
+ local session = event.resumed;
+ if session then -- older smacks module versions send only the "intermediate" session in event.session and no session.resumed one
+ filters.remove_filter(session, "stanzas/out", process_smacks_stanza);
+ -- this means the counter of outstanding push messages can be reset as well
+ if session.push_settings then
+ session.push_settings.count = 0;
+ push_store:set_identifier(session.username, session.push_identifier, session.push_settings);
+ end
+ end
end
-- smacks ack is delayed
local function ack_delayed(event)
local session = event.origin;
local queue = event.queue;
- -- process unacked stanzas (process_new_stanza will only send push requests for new messages)
+ -- process unacked stanzas (handle_notify_request() will only send push requests for new stanzas)
for i=1,#queue do
- process_new_stanza(queue[i], session);
+ process_smacks_stanza(queue[i], session);
+ end
+end
+
+-- archive message added
+local function archive_message_added(event)
+ -- event is: { origin = origin, stanza = stanza, for_user = store_user, id = id }
+ -- only notify for new mam messages when at least one device is only
+ if not event.for_user or not host_sessions[event.for_user] then return; end
+ local stanza = event.stanza;
+ local user_session = host_sessions[event.for_user].sessions;
+ local to = stanza.attr.to;
+ to = to and jid.split(to) or event.origin.username;
+
+ -- only notify if the stanza destination is the mam user we store it for
+ if event.for_user == to then
+ local user_push_services = push_store:get(to);
+ if not #user_push_services then return end
+
+ -- only notify nodes with no active sessions (smacks is counted as active and handled separate)
+ local notify_push_sevices = {};
+ for identifier, push_info in pairs(user_push_services) do
+ local identifier_found = nil;
+ for _, session in pairs(user_session) do
+ -- module:log("debug", "searching for '%s': identifier '%s' for session %s", tostring(identifier), tostring(session.push_identifier), tostring(session.full_jid));
+ if session.push_identifier == identifier then
+ identifier_found = session;
+ break;
+ end
+ end
+ if identifier_found then
+ identifier_found.log("debug", "Not notifying '%s' of new MAM stanza (session still alive)", identifier);
+ else
+ notify_push_sevices[identifier] = push_info;
+ end
+ end
+
+ return handle_notify_request(event.stanza, to, notify_push_sevices);
end
end
module:hook("smacks-hibernation-start", hibernate_session);
module:hook("smacks-hibernation-end", restore_session);
module:hook("smacks-ack-delayed", ack_delayed);
-
+module:hook("archive-message-added", archive_message_added);
-module:hook("message/offline/broadcast", function(event)
- local origin = event.origin;
- local user_push_services = push_enabled:get(origin.username);
- if not user_push_services then return end
+local function send_ping(event)
+ local user = event.user;
+ local user_push_services = push_store:get(user);
+ local push_services = event.push_services or user_push_services;
+ return handle_notify_request(nil, user, push_services);
+end
+-- can be used by other modules to ping one or more (or all) push endpoints
+module:hook("cloud-notify-ping", send_ping);
- for _, push_info in pairs(user_push_services) do
- if push_info then
- push_info.count = 0;
- end
+-- TODO: this has to be done on first connect not on offline broadcast, else the counter will be incorrect
+-- TODO: it seems this is already done, so this could be safely removed, couldn't it?
+-- module:hook("message/offline/broadcast", function(event)
+-- local origin = event.origin;
+-- local user_push_services = push_store:get(origin.username);
+-- if not #user_push_services then return end
+--
+-- for _, push_info in pairs(user_push_services) do
+-- if push_info then
+-- push_info.count = 0;
+-- end
+-- end
+-- push_store:set(origin.username, user_push_services);
+-- end, 1);
+
+function module.unload()
+ module:unhook("account-disco-info", account_dico_info);
+ module:unhook("iq-set/self/"..xmlns_push..":enable", push_enable);
+ module:unhook("iq-set/self/"..xmlns_push..":disable", push_disable);
+
+ module:unhook("smacks-hibernation-start", hibernate_session);
+ module:unhook("smacks-hibernation-end", restore_session);
+ module:unhook("smacks-ack-delayed", ack_delayed);
+ module:unhook("archive-message-added", archive_message_added);
+ module:unhook("cloud-notify-ping", send_ping);
+
+ for push_identifier, _ in pairs(push_errors) do
+ module:hook("iq-error/bare/"..push_identifier, handle_push_error);
+ module:hook("iq-result/bare/"..push_identifier, handle_push_success);
end
- push_enabled:set(origin.username, user_push_services);
-end, 1);
+end
\ No newline at end of file