Software `/` code `/` prosody-modules

Annotate

mod_cloud_notify/mod_cloud_notify.lua @ 3353:e8d6f602f382

mod_password_reset: Improve error reporting when setting a password fails

author	Matthew Wild <mwild1@gmail.com>
date	Tue, 09 Oct 2018 14:10:42 +0100
parent	3108:cfcb020bcd1d
child	3619:74aa35aeb08a

rev	line source
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	1 -- XEP-0357: Push (aka: My mobile OS vendor won't let me have persistent TCP connections)
2247 d09014d8c901 mod_cloud_notify: Update copyright year Kim Alvefur <zash@zash.se> parents: 2246 diff changeset	2 -- Copyright (C) 2015-2016 Kim Alvefur
3055 6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	3 -- Copyright (C) 2017-2018 Thilo Molitor
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	4 --
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	5 -- This file is MIT/X11 licensed.
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	6
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	7 local t_insert = table.insert;
2976 df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	8 local s_match = string.match;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	9 local s_sub = string.sub;
3055 6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	10 local os_time = os.time;
3079 2a918a8c47db mod_cloud_notify: use next() instead of # operator and update README tmolitor <thilo@eightysoft.de> parents: 3078 diff changeset	11 local next = next;
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	12 local st = require"util.stanza";
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	13 local jid = require"util.jid";
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	14 local dataform = require"util.dataforms".new;
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	15 local filters = require"util.filters";
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	16 local hashes = require"util.hashes";
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	17
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	18 local xmlns_push = "urn:xmpp:push:0";
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	19
1909 c7389fe74de7 mod_cloud_notify: Make inclusion of message sender and body optional via config option Kim Alvefur <zash@zash.se> parents: 1908 diff changeset	20 -- configuration
2246 a3e3dc9131e7 mod_cloud_notify: Use typed config API Kim Alvefur <zash@zash.se> parents: 2201 diff changeset	21 local include_body = module:get_option_boolean("push_notification_with_body", false);
a3e3dc9131e7 mod_cloud_notify: Use typed config API Kim Alvefur <zash@zash.se> parents: 2201 diff changeset	22 local include_sender = module:get_option_boolean("push_notification_with_sender", false);
3055 6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	23 local max_push_errors = module:get_option_number("push_max_errors", 16);
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	24 local max_push_devices = module:get_option_number("push_max_devices", 5);
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	25 local dummy_body = module:get_option_string("push_notification_important_body", "New Message!");
1909 c7389fe74de7 mod_cloud_notify: Make inclusion of message sender and body optional via config option Kim Alvefur <zash@zash.se> parents: 1908 diff changeset	26
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	27 local host_sessions = prosody.hosts[module.host].sessions;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	28 local push_errors = {};
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	29 local id2node = {};
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	30
3055 6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	31 -- ordered table iterator, allow to iterate on the natural order of the keys of a table,
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	32 -- see http://lua-users.org/wiki/SortedIteration
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	33 local function __genOrderedIndex( t )
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	34 local orderedIndex = {}
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	35 for key in pairs(t) do
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	36 table.insert( orderedIndex, key )
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	37 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	38 -- sort in reverse order (newest one first)
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	39 table.sort( orderedIndex, function(a, b)
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	40 if a == nil or t[a] == nil or b == nil or t[b] == nil then return false end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	41 -- only one timestamp given, this is the newer one
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	42 if t[a].timestamp ~= nil and t[b].timestamp == nil then return true end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	43 if t[a].timestamp == nil and t[b].timestamp ~= nil then return false end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	44 -- both timestamps given, sort normally
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	45 if t[a].timestamp ~= nil and t[b].timestamp ~= nil then return t[a].timestamp > t[b].timestamp end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	46 return false -- normally not reached
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	47 end)
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	48 return orderedIndex
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	49 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	50 local function orderedNext(t, state)
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	51 -- Equivalent of the next function, but returns the keys in timestamp
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	52 -- order. We use a temporary ordered key table that is stored in the
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	53 -- table being iterated.
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	54
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	55 local key = nil
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	56 --print("orderedNext: state = "..tostring(state) )
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	57 if state == nil then
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	58 -- the first time, generate the index
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	59 t.__orderedIndex = __genOrderedIndex( t )
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	60 key = t.__orderedIndex[1]
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	61 else
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	62 -- fetch the next value
3078 6b860de18a53 mod_cloud_notify: Don't use deprecated table.getn tmolitor <thilo@eightysoft.de> parents: 3055 diff changeset	63 for i = 1, #t.__orderedIndex do
3055 6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	64 if t.__orderedIndex[i] == state then
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	65 key = t.__orderedIndex[i+1]
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	66 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	67 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	68 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	69
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	70 if key then
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	71 return key, t[key]
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	72 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	73
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	74 -- no more value to return, cleanup
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	75 t.__orderedIndex = nil
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	76 return
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	77 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	78 local function orderedPairs(t)
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	79 -- Equivalent of the pairs() function on tables. Allows to iterate
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	80 -- in order
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	81 return orderedNext, t, nil
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	82 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	83
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	84 -- small helper function to return new table with only "maximum" elements containing only the newest entries
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	85 local function reduce_table(table, maximum)
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	86 local count = 0;
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	87 local result = {};
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	88 for key, value in orderedPairs(table) do
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	89 count = count + 1;
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	90 if count > maximum then break end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	91 result[key] = value;
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	92 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	93 return result;
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	94 end
6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	95
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	96 -- For keeping state across reloads while caching reads
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	97 local push_store = (function()
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	98 local store = module:open_store();
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	99 local push_services = {};
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	100 local api = {};
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	101 function api:get(user)
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	102 if not push_services[user] then
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	103 local err;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	104 push_services[user], err = store:get(user);
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	105 if not push_services[user] and err then
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	106 module:log("warn", "Error reading push notification storage for user '%s': %s", user, tostring(err));
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	107 push_services[user] = {};
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	108 return push_services[user], false;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	109 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	110 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	111 if not push_services[user] then push_services[user] = {} end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	112 return push_services[user], true;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	113 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	114 function api:set(user, data)
3055 6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	115 push_services[user] = reduce_table(data, max_push_devices);
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	116 local ok, err = store:set(user, push_services[user]);
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	117 if not ok then
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	118 module:log("error", "Error writing push notification storage for user '%s': %s", user, tostring(err));
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	119 return false;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	120 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	121 return true;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	122 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	123 function api:set_identifier(user, push_identifier, data)
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	124 local services = self:get(user);
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	125 services[push_identifier] = data;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	126 return self:set(user, services);
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	127 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	128 return api;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	129 end)();
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	130
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	131
2642 0f1421af7f6a mod_cloud_notify: Move declarations of handle_push_success/error to fix referencing undefined variables (introduced in 6ab46ff685d0) Matthew Wild <mwild1@gmail.com> parents: 2625 diff changeset	132 -- Forward declarations, as both functions need to reference each other
0f1421af7f6a mod_cloud_notify: Move declarations of handle_push_success/error to fix referencing undefined variables (introduced in 6ab46ff685d0) Matthew Wild <mwild1@gmail.com> parents: 2625 diff changeset	133 local handle_push_success, handle_push_error;
0f1421af7f6a mod_cloud_notify: Move declarations of handle_push_success/error to fix referencing undefined variables (introduced in 6ab46ff685d0) Matthew Wild <mwild1@gmail.com> parents: 2625 diff changeset	134
0f1421af7f6a mod_cloud_notify: Move declarations of handle_push_success/error to fix referencing undefined variables (introduced in 6ab46ff685d0) Matthew Wild <mwild1@gmail.com> parents: 2625 diff changeset	135 function handle_push_error(event)
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	136 local stanza = event.stanza;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	137 local error_type, condition = stanza:get_error();
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	138 local node = id2node[stanza.attr.id];
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	139 if node == nil then return false; end -- unknown stanza? Ignore for now!
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	140 local from = stanza.attr.from;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	141 local user_push_services = push_store:get(node);
3085 1ea6861b533f mod_cloud_notify: Don't change table while iterating it tmolitor <thilo@eightysoft.de> parents: 3079 diff changeset	142 local changed = false;
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	143
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	144 for push_identifier, _ in pairs(user_push_services) do
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	145 local stanza_id = hashes.sha256(push_identifier, true);
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	146 if stanza_id == stanza.attr.id then
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	147 if user_push_services[push_identifier] and user_push_services[push_identifier].jid == from and error_type ~= "wait" then
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	148 push_errors[push_identifier] = push_errors[push_identifier] + 1;
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	149 module:log("info", "Got error of type '%s' (%s) for identifier '%s': "
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	150 .."error count for this identifier is now at %s", error_type, condition, push_identifier,
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	151 tostring(push_errors[push_identifier]));
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	152 if push_errors[push_identifier] >= max_push_errors then
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	153 module:log("warn", "Disabling push notifications for identifier '%s'", push_identifier);
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	154 -- remove push settings from sessions
2749 9756211fcbe3 mod_cloud_notify: Fix small bug. tmolitor <thilo@eightysoft.de> parents: 2736 diff changeset	155 if host_sessions[node] then
9756211fcbe3 mod_cloud_notify: Fix small bug. tmolitor <thilo@eightysoft.de> parents: 2736 diff changeset	156 for _, session in pairs(host_sessions[node].sessions) do
9756211fcbe3 mod_cloud_notify: Fix small bug. tmolitor <thilo@eightysoft.de> parents: 2736 diff changeset	157 if session.push_identifier == push_identifier then
9756211fcbe3 mod_cloud_notify: Fix small bug. tmolitor <thilo@eightysoft.de> parents: 2736 diff changeset	158 session.push_identifier = nil;
9756211fcbe3 mod_cloud_notify: Fix small bug. tmolitor <thilo@eightysoft.de> parents: 2736 diff changeset	159 session.push_settings = nil;
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	160 session.first_hibernated_push = nil;
2749 9756211fcbe3 mod_cloud_notify: Fix small bug. tmolitor <thilo@eightysoft.de> parents: 2736 diff changeset	161 end
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	162 end
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	163 end
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	164 -- save changed global config
3085 1ea6861b533f mod_cloud_notify: Don't change table while iterating it tmolitor <thilo@eightysoft.de> parents: 3079 diff changeset	165 changed = true;
1ea6861b533f mod_cloud_notify: Don't change table while iterating it tmolitor <thilo@eightysoft.de> parents: 3079 diff changeset	166 user_push_services[push_identifier] = nil
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	167 push_errors[push_identifier] = nil;
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	168 -- unhook iq handlers for this identifier (if possible)
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	169 if module.unhook then
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	170 module:unhook("iq-error/host/"..stanza_id, handle_push_error);
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	171 module:unhook("iq-result/host/"..stanza_id, handle_push_success);
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	172 id2node[stanza_id] = nil;
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	173 end
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	174 end
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	175 elseif user_push_services[push_identifier] and user_push_services[push_identifier].jid == from and error_type == "wait" then
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	176 module:log("debug", "Got error of type '%s' (%s) for identifier '%s': "
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	177 .."NOT increasing error count for this identifier", error_type, condition, push_identifier);
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	178 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	179 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	180 end
3085 1ea6861b533f mod_cloud_notify: Don't change table while iterating it tmolitor <thilo@eightysoft.de> parents: 3079 diff changeset	181 if changed then
1ea6861b533f mod_cloud_notify: Don't change table while iterating it tmolitor <thilo@eightysoft.de> parents: 3079 diff changeset	182 push_store:set(node, user_push_services);
1ea6861b533f mod_cloud_notify: Don't change table while iterating it tmolitor <thilo@eightysoft.de> parents: 3079 diff changeset	183 end
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	184 return true;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	185 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	186
2642 0f1421af7f6a mod_cloud_notify: Move declarations of handle_push_success/error to fix referencing undefined variables (introduced in 6ab46ff685d0) Matthew Wild <mwild1@gmail.com> parents: 2625 diff changeset	187 function handle_push_success(event)
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	188 local stanza = event.stanza;
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	189 local node = id2node[stanza.attr.id];
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	190 if node == nil then return false; end -- unknown stanza? Ignore for now!
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	191 local from = stanza.attr.from;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	192 local user_push_services = push_store:get(node);
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	193
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	194 for push_identifier, _ in pairs(user_push_services) do
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	195 if hashes.sha256(push_identifier, true) == stanza.attr.id then
2670 6e01878103c0 mod_smacks: Ignore user when writing or reading session_cache on prosody 0.9 tmolitor <thilo@eightysoft.de> parents: 2669 diff changeset	196 if user_push_services[push_identifier] and user_push_services[push_identifier].jid == from and push_errors[push_identifier] > 0 then
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	197 push_errors[push_identifier] = 0;
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	198 module:log("debug", "Push succeeded, error count for identifier '%s' is now at %s again", push_identifier, tostring(push_errors[push_identifier]));
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	199 end
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	200 end
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	201 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	202 return true;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	203 end
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	204
1908 eba279ddc050 mod_cloud_notify: Add some comments describing code blocks Kim Alvefur <zash@zash.se> parents: 1907 diff changeset	205 -- http://xmpp.org/extensions/xep-0357.html#disco
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	206 local function account_dico_info(event)
2200 e9e38ae8037f mod_cloud_notify: Advertise feature on bare jid disco (thanks iNPUTmice) Kim Alvefur <zash@zash.se> parents: 2198 diff changeset	207 (event.reply or event.stanza):tag("feature", {var=xmlns_push}):up();
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	208 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	209 module:hook("account-disco-info", account_dico_info);
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	210
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	211 -- http://xmpp.org/extensions/xep-0357.html#enabling
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	212 local function push_enable(event)
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	213 local origin, stanza = event.origin, event.stanza;
2254 122cb5f4930f mod_cloud_notify: Cache <enable> in local Kim Alvefur <zash@zash.se> parents: 2253 diff changeset	214 local enable = stanza.tags[1];
2252 a96f2d0f8750 mod_cloud_notify: Add some logging when a client attempts to enable push notifications Kim Alvefur <zash@zash.se> parents: 2247 diff changeset	215 origin.log("debug", "Attempting to enable push notifications");
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	216 -- MUST contain a 'jid' attribute of the XMPP Push Service being enabled
2254 122cb5f4930f mod_cloud_notify: Cache <enable> in local Kim Alvefur <zash@zash.se> parents: 2253 diff changeset	217 local push_jid = enable.attr.jid;
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	218 -- SHOULD contain a 'node' attribute
2254 122cb5f4930f mod_cloud_notify: Cache <enable> in local Kim Alvefur <zash@zash.se> parents: 2253 diff changeset	219 local push_node = enable.attr.node;
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	220 -- CAN contain a 'include_payload' attribute
fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	221 local include_payload = enable.attr.include_payload;
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	222 if not push_jid then
2257 f84b51f9aa82 mod_cloud_notify: Log message when 'jid' is missing from enable request Kim Alvefur <zash@zash.se> parents: 2255 diff changeset	223 origin.log("debug", "Push notification enable request missing the 'jid' field");
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	224 origin.send(st.error_reply(stanza, "modify", "bad-request", "Missing jid"));
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	225 return true;
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	226 end
2255 cdfc917a8cc7 mod_cloud_notify: Retrieve data form by name and namespace so unknown elements are ignored Kim Alvefur <zash@zash.se> parents: 2254 diff changeset	227 local publish_options = enable:get_child("x", "jabber:x:data");
2258 3abc51faf945 mod_cloud_notify: Log message if no dataform is found Kim Alvefur <zash@zash.se> parents: 2257 diff changeset	228 if not publish_options then
3abc51faf945 mod_cloud_notify: Log message if no dataform is found Kim Alvefur <zash@zash.se> parents: 2257 diff changeset	229 -- Could be intentional
3abc51faf945 mod_cloud_notify: Log message if no dataform is found Kim Alvefur <zash@zash.se> parents: 2257 diff changeset	230 origin.log("debug", "No publish options in request");
3abc51faf945 mod_cloud_notify: Log message if no dataform is found Kim Alvefur <zash@zash.se> parents: 2257 diff changeset	231 end
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	232 local push_identifier = push_jid .. "<" .. (push_node or "");
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	233 local push_service = {
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	234 jid = push_jid;
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	235 node = push_node;
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	236 include_payload = include_payload;
2253 97ebd28a8a75 mod_cloud_notify: Apply pre-serialization to publish-options Kim Alvefur <zash@zash.se> parents: 2252 diff changeset	237 options = publish_options and st.preserialize(publish_options);
3055 6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	238 timestamp = os_time();
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	239 };
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	240 local ok = push_store:set_identifier(origin.username, push_identifier, push_service);
2201 eb5555a3a535 mod_cloud_notify: Enable persistent storage of user notification settings Kim Alvefur <zash@zash.se> parents: 2200 diff changeset	241 if not ok then
eb5555a3a535 mod_cloud_notify: Enable persistent storage of user notification settings Kim Alvefur <zash@zash.se> parents: 2200 diff changeset	242 origin.send(st.error_reply(stanza, "wait", "internal-server-error"));
eb5555a3a535 mod_cloud_notify: Enable persistent storage of user notification settings Kim Alvefur <zash@zash.se> parents: 2200 diff changeset	243 else
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	244 origin.push_identifier = push_identifier;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	245 origin.push_settings = push_service;
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	246 origin.first_hibernated_push = nil;
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	247 origin.log("info", "Push notifications enabled for %s (%s)", tostring(stanza.attr.from), tostring(origin.push_identifier));
2201 eb5555a3a535 mod_cloud_notify: Enable persistent storage of user notification settings Kim Alvefur <zash@zash.se> parents: 2200 diff changeset	248 origin.send(st.reply(stanza));
eb5555a3a535 mod_cloud_notify: Enable persistent storage of user notification settings Kim Alvefur <zash@zash.se> parents: 2200 diff changeset	249 end
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	250 return true;
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	251 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	252 module:hook("iq-set/self/"..xmlns_push..":enable", push_enable);
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	253
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	254 -- http://xmpp.org/extensions/xep-0357.html#disabling
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	255 local function push_disable(event)
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	256 local origin, stanza = event.origin, event.stanza;
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	257 local push_jid = stanza.tags[1].attr.jid; -- MUST include a 'jid' attribute
7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	258 local push_node = stanza.tags[1].attr.node; -- A 'node' attribute MAY be included
7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	259 if not push_jid then
7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	260 origin.send(st.error_reply(stanza, "modify", "bad-request", "Missing jid"));
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	261 return true;
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	262 end
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	263 local user_push_services = push_store:get(origin.username);
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	264 for key, push_info in pairs(user_push_services) do
7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	265 if push_info.jid == push_jid and (not push_node or push_info.node == push_node) then
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	266 origin.log("info", "Push notifications disabled (%s)", tostring(key));
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	267 if origin.push_identifier == key then
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	268 origin.push_identifier = nil;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	269 origin.push_settings = nil;
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	270 origin.first_hibernated_push = nil;
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	271 end
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	272 user_push_services[key] = nil;
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	273 push_errors[key] = nil;
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	274 if module.unhook then
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	275 module:unhook("iq-error/host/"..key, handle_push_error);
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	276 module:unhook("iq-result/host/"..key, handle_push_success);
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	277 id2node[key] = nil;
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	278 end
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	279 end
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	280 end
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	281 local ok = push_store:set(origin.username, user_push_services);
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	282 if not ok then
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	283 origin.send(st.error_reply(stanza, "wait", "internal-server-error"));
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	284 else
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	285 origin.send(st.reply(stanza));
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	286 end
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	287 return true;
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	288 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	289 module:hook("iq-set/self/"..xmlns_push..":disable", push_disable);
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	290
2976 df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	291 -- Patched version of util.stanza:find() that supports giving stanza names
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	292 -- without their namespace, allowing for every namespace.
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	293 local function find(self, path)
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	294 local pos = 1;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	295 local len = #path + 1;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	296
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	297 repeat
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	298 local xmlns, name, text;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	299 local char = s_sub(path, pos, pos);
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	300 if char == "@" then
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	301 return self.attr[s_sub(path, pos + 1)];
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	302 elseif char == "{" then
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	303 xmlns, pos = s_match(path, "^([^}]+)}()", pos + 1);
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	304 end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	305 name, text, pos = s_match(path, "^([^@/#]*)([/#]?)()", pos);
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	306 name = name ~= "" and name or nil;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	307 if pos == len then
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	308 if text == "#" then
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	309 local child = xmlns ~= nil and self:get_child(name, xmlns) or self:child_with_name(name);
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	310 return child and child:get_text() or nil;
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	311 end
2976 df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	312 return xmlns ~= nil and self:get_child(name, xmlns) or self:child_with_name(name);
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	313 end
2976 df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	314 self = xmlns ~= nil and self:get_child(name, xmlns) or self:child_with_name(name);
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	315 until not self
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	316 return nil;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	317 end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	318
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	319 -- is this push a high priority one (this is needed for ios apps not using voip pushes)
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	320 local function is_important(stanza)
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	321 local st_name = stanza and stanza.name or nil;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	322 if not st_name then return false; end -- nonzas are never important here
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	323 if st_name == "presence" then
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	324 return false; -- same for presences
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	325 elseif st_name == "message" then
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	326 -- unpack carbon copies
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	327 local stanza_direction = "in";
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	328 local carbon;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	329 local st_type;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	330 -- support carbon copied message stanzas having an arbitrary message-namespace or no message-namespace at all
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	331 if not carbon then carbon = find(stanza, "{urn:xmpp:carbons:2}/forwarded/message"); end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	332 if not carbon then carbon = find(stanza, "{urn:xmpp:carbons:1}/forwarded/message"); end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	333 stanza_direction = carbon and stanza:child_with_name("sent") and "out" or "in";
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	334 if carbon then stanza = carbon; end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	335 st_type = stanza.attr.type;
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	336
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	337 -- headline message are always not important
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	338 if st_type == "headline" then return false; end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	339
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	340 -- carbon copied outgoing messages are not important
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	341 if carbon and stanza_direction == "out" then return false; end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	342
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	343 -- We can't check for body contents in encrypted messages, so let's treat them as important
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	344 -- Some clients don't even set a body or an empty body for encrypted messages
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	345
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	346 -- check omemo https://xmpp.org/extensions/inbox/omemo.html
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	347 if stanza:get_child("encrypted", "eu.siacs.conversations.axolotl") or stanza:get_child("encrypted", "urn:xmpp:omemo:0") then return true; end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	348
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	349 -- check xep27 pgp https://xmpp.org/extensions/xep-0027.html
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	350 if stanza:get_child("x", "jabber:x:encrypted") then return true; end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	351
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	352 -- check xep373 pgp (OX) https://xmpp.org/extensions/xep-0373.html
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	353 if stanza:get_child("openpgp", "urn:xmpp:openpgp:0") then return true; end
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	354
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	355 local body = stanza:get_child_text("body");
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	356 if st_type == "groupchat" and stanza:get_child_text("subject") then return false; end -- groupchat subjects are not important here
df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	357 return body ~= nil and body ~= ""; -- empty bodies are not important
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	358 end
2976 df86ce6bb0b4 Implement dummy body message to indicate high priority push tmolitor <thilo@eightysoft.de> parents: 2792 diff changeset	359 return false; -- this stanza wasn't one of the above cases --> it is not important, too
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	360 end
fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	361
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	362 local push_form = dataform {
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	363 { name = "FORM_TYPE"; type = "hidden"; value = "urn:xmpp:push:summary"; };
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	364 { name = "message-count"; type = "text-single"; };
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	365 { name = "pending-subscription-count"; type = "text-single"; };
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	366 { name = "last-message-sender"; type = "jid-single"; };
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	367 { name = "last-message-body"; type = "text-single"; };
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	368 };
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	369
1907 7fe7bd7b33b6 mod_cloud_notify: Allow the 'node' to be left out when disabling, clients MAY include it (and therefore leave it out) Kim Alvefur <zash@zash.se> parents: 1784 diff changeset	370 -- http://xmpp.org/extensions/xep-0357.html#publishing
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	371 local function handle_notify_request(stanza, node, user_push_services, log_push_decline)
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	372 local pushes = 0;
3079 2a918a8c47db mod_cloud_notify: use next() instead of # operator and update README tmolitor <thilo@eightysoft.de> parents: 3078 diff changeset	373 if not user_push_services or next(user_push_services) == nil then return pushes end
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	374
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	375 for push_identifier, push_info in pairs(user_push_services) do
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	376 local send_push = true; -- only send push to this node when not already done for this stanza or if no stanza is given at all
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	377 if stanza then
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	378 if not stanza._push_notify then stanza._push_notify = {}; end
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	379 if stanza._push_notify[push_identifier] then
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	380 if log_push_decline then
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	381 module:log("debug", "Already sent push notification for %s@%s to %s (%s)", node, module.host, push_info.jid, tostring(push_info.node));
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	382 end
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	383 send_push = false;
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	384 end
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	385 stanza._push_notify[push_identifier] = true;
8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	386 end
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	387
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	388 if send_push then
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	389 -- construct push stanza
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	390 local stanza_id = hashes.sha256(push_identifier, true);
2751 6b710a8bdf03 mod_cloud_notify: Implement version 0.3 of XEP-0357 tmolitor <thilo@eightysoft.de> parents: 2749 diff changeset	391 local push_publish = st.iq({ to = push_info.jid, from = module.host, type = "set", id = stanza_id })
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	392 :tag("pubsub", { xmlns = "http://jabber.org/protocol/pubsub" })
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	393 :tag("publish", { node = push_info.node })
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	394 :tag("item")
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	395 :tag("notification", { xmlns = xmlns_push });
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	396 local form_data = {
3010 7ee59f417c16 mod_cloud_notify: remove useless counter (hardcode it to 1) tmolitor <thilo@eightysoft.de> parents: 2976 diff changeset	397 -- hardcode to 1 because other numbers are just meaningless (the XEP does not specify what exactly to count)
7ee59f417c16 mod_cloud_notify: remove useless counter (hardcode it to 1) tmolitor <thilo@eightysoft.de> parents: 2976 diff changeset	398 ["message-count"] = "1";
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	399 };
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	400 if stanza and include_sender then
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	401 form_data["last-message-sender"] = stanza.attr.from;
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	402 end
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	403 if stanza and include_body then
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	404 form_data["last-message-body"] = stanza:get_child_text("body");
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	405 elseif stanza and dummy_body and is_important(stanza) then
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	406 form_data["last-message-body"] = tostring(dummy_body);
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	407 end
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	408 push_publish:add_child(push_form:form(form_data));
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	409 push_publish:up(); -- / notification
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	410 push_publish:up(); -- / publish
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	411 push_publish:up(); -- / pubsub
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	412 if push_info.options then
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	413 push_publish:tag("publish-options"):add_child(st.deserialize(push_info.options));
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	414 end
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	415 -- send out push
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	416 module:log("debug", "Sending%s push notification for %s@%s to %s (%s)", form_data["last-message-body"] and " important" or "", node, module.host, push_info.jid, tostring(push_info.node));
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	417 -- module:log("debug", "PUSH STANZA: %s", tostring(push_publish));
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	418 -- handle push errors for this node
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	419 if push_errors[push_identifier] == nil then
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	420 push_errors[push_identifier] = 0;
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	421 module:hook("iq-error/host/"..stanza_id, handle_push_error);
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	422 module:hook("iq-result/host/"..stanza_id, handle_push_success);
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	423 id2node[stanza_id] = node;
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	424 end
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	425 module:send(push_publish);
d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	426 pushes = pushes + 1;
1909 c7389fe74de7 mod_cloud_notify: Make inclusion of message sender and body optional via config option Kim Alvefur <zash@zash.se> parents: 1908 diff changeset	427 end
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	428 end
2712 d89ab70808f6 mod_cloud_notify: fix bug when multiple resources are used tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	429 return pushes;
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	430 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	431
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	432 -- small helper function to extract relevant push settings
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	433 local function get_push_settings(stanza, session)
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	434 local to = stanza.attr.to;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	435 local node = to and jid.split(to) or session.username;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	436 local user_push_services = push_store:get(node);
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	437 return node, user_push_services;
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	438 end
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	439
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	440 -- publish on offline message
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	441 module:hook("message/offline/handle", function(event)
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	442 local node, user_push_services = get_push_settings(event.stanza, event.origin);
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	443 module:log("debug", "Invoking cloud handle_notify_request() for offline stanza");
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	444 handle_notify_request(event.stanza, node, user_push_services, true);
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	445 end, 1);
b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	446
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	447 -- publish on unacked smacks message
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	448 local function process_smacks_stanza(stanza, session)
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	449 if session.push_identifier then
2714 75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	450 session.log("debug", "Invoking cloud handle_notify_request() for smacks queued stanza");
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	451 local user_push_services = {[session.push_identifier] = session.push_settings};
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	452 local node = get_push_settings(stanza, session);
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	453 if handle_notify_request(stanza, node, user_push_services, true) ~= 0 then
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	454 if session.hibernating and not session.first_hibernated_push then
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	455 -- if important stanzas are treated differently (pushed with last-message-body field set to dummy string)
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	456 -- and the message was important (e.g. had a last-message-body field) OR if we treat all pushes equally,
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	457 -- then record the time of first push in the session for the smack module which will extend its hibernation
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	458 -- timeout based on the value of session.first_hibernated_push
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	459 if not dummy_body or (dummy_body and is_important(stanza)) then
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	460 session.first_hibernated_push = os_time();
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	461 end
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	462 end
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	463 end
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	464 end
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	465 return stanza;
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	466 end
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	467
2714 75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	468 local function process_smacks_queue(queue, session)
75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	469 if not session.push_identifier then return; end
75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	470 local user_push_services = {[session.push_identifier] = session.push_settings};
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	471 local notified = { unimportant = false; important = false }
2714 75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	472 for i=1, #queue do
75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	473 local stanza = queue[i];
75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	474 local node = get_push_settings(stanza, session);
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	475 stanza_type = "unimportant"
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	476 if dummy_body and is_important(stanza) then stanza_type = "important"; end
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	477 if not notified[stanza_type] then -- only notify if we didn't try to push for this stanza type already
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	478 -- session.log("debug", "Invoking cloud handle_notify_request() for smacks queued stanza: %d", i);
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	479 if handle_notify_request(stanza, node, user_push_services, false) ~= 0 then
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	480 if session.hibernating and not session.first_hibernated_push then
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	481 -- if important stanzas are treated differently (pushed with last-message-body field set to dummy string)
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	482 -- and the message was important (e.g. had a last-message-body field) OR if we treat all pushes equally,
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	483 -- then record the time of first push in the session for the smack module which will extend its hibernation
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	484 -- timeout based on the value of session.first_hibernated_push
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	485 if not dummy_body or (dummy_body and is_important(stanza)) then
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	486 session.first_hibernated_push = os_time();
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	487 end
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	488 end
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	489 session.log("debug", "Cloud handle_notify_request() > 0, not notifying for other queued stanzas of type %s", stanza_type);
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	490 notified[stanza_type] = true
cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	491 end
2714 75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	492 end
75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	493 end
75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	494 end
75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	495
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	496 -- smacks hibernation is started
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	497 local function hibernate_session(event)
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	498 local session = event.origin;
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	499 local queue = event.queue;
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	500 session.first_hibernated_push = nil;
2395 2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	501 -- process unacked stanzas
2714 75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	502 process_smacks_queue(queue, session);
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	503 -- process future unacked (hibernated) stanzas
2736 fff185e7ab73 mod_cloud_notify: Implement the "stripped stanzas" proposal. tmolitor <thilo@eightysoft.de> parents: 2714 diff changeset	504 filters.add_filter(session, "stanzas/out", process_smacks_stanza, -990);
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	505 end
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	506
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	507 -- smacks hibernation is ended
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	508 local function restore_session(event)
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	509 local session = event.resumed;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	510 if session then -- older smacks module versions send only the "intermediate" session in event.session and no session.resumed one
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	511 filters.remove_filter(session, "stanzas/out", process_smacks_stanza);
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	512 session.first_hibernated_push = nil;
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	513 end
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	514 end
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	515
2395 2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	516 -- smacks ack is delayed
2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	517 local function ack_delayed(event)
2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	518 local session = event.origin;
2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	519 local queue = event.queue;
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	520 -- process unacked stanzas (handle_notify_request() will only send push requests for new stanzas)
2714 75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	521 process_smacks_queue(queue, session);
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	522 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	523
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	524 -- archive message added
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	525 local function archive_message_added(event)
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	526 -- event is: { origin = origin, stanza = stanza, for_user = store_user, id = id }
3055 6abee021d9db mod_cloud_notify: Limit number of devices to 5 and change some default settings tmolitor <thilo@eightysoft.de> parents: 3010 diff changeset	527 -- only notify for new mam messages when at least one device is online
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	528 if not event.for_user or not host_sessions[event.for_user] then return; end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	529 local stanza = event.stanza;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	530 local user_session = host_sessions[event.for_user].sessions;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	531 local to = stanza.attr.to;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	532 to = to and jid.split(to) or event.origin.username;
2643 777d07e0cd73 mod_cloud_notify: Whitespace fixes Matthew Wild <mwild1@gmail.com> parents: 2642 diff changeset	533
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	534 -- only notify if the stanza destination is the mam user we store it for
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	535 if event.for_user == to then
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	536 local user_push_services = push_store:get(to);
3079 2a918a8c47db mod_cloud_notify: use next() instead of # operator and update README tmolitor <thilo@eightysoft.de> parents: 3078 diff changeset	537 if next(user_push_services) == nil then return end
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	538
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	539 -- only notify nodes with no active sessions (smacks is counted as active and handled separate)
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	540 local notify_push_services = {};
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	541 for identifier, push_info in pairs(user_push_services) do
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	542 local identifier_found = nil;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	543 for _, session in pairs(user_session) do
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	544 -- module:log("debug", "searching for '%s': identifier '%s' for session %s", tostring(identifier), tostring(session.push_identifier), tostring(session.full_jid));
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	545 if session.push_identifier == identifier then
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	546 identifier_found = session;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	547 break;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	548 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	549 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	550 if identifier_found then
2714 75b137cf869a mod_cloud_notify: Don't notify for all smacks queued stanzas in a row tmolitor <thilo@eightysoft.de> parents: 2712 diff changeset	551 identifier_found.log("debug", "Not cloud notifying '%s' of new MAM stanza (session still alive)", identifier);
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	552 else
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	553 notify_push_services[identifier] = push_info;
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	554 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	555 end
2643 777d07e0cd73 mod_cloud_notify: Whitespace fixes Matthew Wild <mwild1@gmail.com> parents: 2642 diff changeset	556
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	557 handle_notify_request(event.stanza, to, notify_push_services, true);
2395 2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	558 end
2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	559 end
2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	560
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	561 module:hook("smacks-hibernation-start", hibernate_session);
218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	562 module:hook("smacks-hibernation-end", restore_session);
2395 2e641ab995b3 mod_cloud_notify: added code to respond to the new event "smacks-ack-delayed" issued by mod_smacks when acks are delayed for a certain amount of time. This allows to send out notification requests before the read timeout or connection close event really happens, thus allowing conversations to be smoother. tmolitor <thilo@eightysoft.de> parents: 2263 diff changeset	563 module:hook("smacks-ack-delayed", ack_delayed);
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	564 module:hook("archive-message-added", archive_message_added);
2141 218a3d3f7f97 mod_cloud_notify: added ability to notify even if the session is hibernated by mod_smacks tmolitor <thilo@eightysoft.de> parents: 2051 diff changeset	565
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	566 local function send_ping(event)
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	567 local user = event.user;
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	568 local user_push_services = push_store:get(user);
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	569 local push_services = event.push_services or user_push_services;
3108 cfcb020bcd1d mod_cloud_notify: inform mod_smacks of first push in hibernated state tmolitor <thilo@eightysoft.de> parents: 3085 diff changeset	570 handle_notify_request(nil, user, push_services, true);
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	571 end
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	572 -- can be used by other modules to ping one or more (or all) push endpoints
6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	573 module:hook("cloud-notify-ping", send_ping);
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	574
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	575 module:log("info", "Module loaded");
2609 6ab46ff685d0 mod_cloud_notify: Respect Daniel's business rules and remove endpoints on error tmolitor <thilo@eightysoft.de> parents: 2395 diff changeset	576 function module.unload()
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	577 if module.unhook then
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	578 module:unhook("account-disco-info", account_dico_info);
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	579 module:unhook("iq-set/self/"..xmlns_push..":enable", push_enable);
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	580 module:unhook("iq-set/self/"..xmlns_push..":disable", push_disable);
2643 777d07e0cd73 mod_cloud_notify: Whitespace fixes Matthew Wild <mwild1@gmail.com> parents: 2642 diff changeset	581
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	582 module:unhook("smacks-hibernation-start", hibernate_session);
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	583 module:unhook("smacks-hibernation-end", restore_session);
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	584 module:unhook("smacks-ack-delayed", ack_delayed);
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	585 module:unhook("archive-message-added", archive_message_added);
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	586 module:unhook("cloud-notify-ping", send_ping);
2643 777d07e0cd73 mod_cloud_notify: Whitespace fixes Matthew Wild <mwild1@gmail.com> parents: 2642 diff changeset	587
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	588 for push_identifier, _ in pairs(push_errors) do
e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	589 local stanza_id = hashes.sha256(push_identifier, true);
2791 008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	590 module:unhook("iq-error/host/"..stanza_id, handle_push_error);
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	591 module:unhook("iq-result/host/"..stanza_id, handle_push_success);
008cf272b7ea mod_cloud_notify: Fix regression in error handling tmolitor <thilo@eightysoft.de> parents: 2751 diff changeset	592 id2node[stanza_id] = nil;
2669 e6d243ed88ca mod_cloud_notify: Fix module:unhook calls not available in prosody 0.9, fixes #874 tmolitor <thilo@eightysoft.de> parents: 2643 diff changeset	593 end
1783 b31fe2d22310 mod_cloud_notify: XEP-0357: Push - the server bits ("app server" not included) Kim Alvefur <zash@zash.se> parents: diff changeset	594 end
2643 777d07e0cd73 mod_cloud_notify: Whitespace fixes Matthew Wild <mwild1@gmail.com> parents: 2642 diff changeset	595
2625 8c6562f16496 mod_cloud_notify: Fixed error in push deduplication tmolitor <thilo@eightysoft.de> parents: 2609 diff changeset	596 module:log("info", "Module unloaded");
2643 777d07e0cd73 mod_cloud_notify: Whitespace fixes Matthew Wild <mwild1@gmail.com> parents: 2642 diff changeset	597 end

prosody-modules

e8d6f602f382

mod_cloud_notify/mod_cloud_notify.lua

Software / code / prosody-modules

Annotate

mod_cloud_notify/mod_cloud_notify.lua @ 3353:e8d6f602f382

Software `/` code `/` prosody-modules