prosody-modules: mod_smacks/mod

annotate mod_smacks/mod_smacks.lua @ 3967:0957ba6aeb99

mod_smacks: Update documentation and slightly adjust default values

author	tmolitor <thilo@eightysoft.de>
date	Sun, 05 Apr 2020 23:37:17 +0200
parents	e93e58b33bf6
children	bf5d91769f99

rev	line source
1670 5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	1 -- XEP-0198: Stream Management for Prosody IM
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	2 --
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	3 -- Copyright (C) 2010-2015 Matthew Wild
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	4 -- Copyright (C) 2010 Waqas Hussain
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	5 -- Copyright (C) 2012-2015 Kim Alvefur
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	6 -- Copyright (C) 2012 Thijs Alkemade
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	7 -- Copyright (C) 2014 Florian Zeitz
3841 b5d367798570 Fix bug readding stanzas to outgoing_queue on resume tmolitor <thilo@eightysoft.de> parents: 3646 diff changeset	8 -- Copyright (C) 2016-2020 Thilo Molitor
1670 5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	9 --
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	10 -- This project is MIT/X11 licensed. Please see the
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	11 -- COPYING file in the source package for more information.
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	12 --
5f5ff061b316 mod_smacks: Add license header Kim Alvefur <zash@zash.se> parents: 1637 diff changeset	13
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	14 local st = require "util.stanza";
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	15 local dep = require "util.dependencies";
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	16 local cache = dep.softreq("util.cache"); -- only available in prosody 0.10+
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	17 local uuid_generate = require "util.uuid".generate;
2756 dbba101601b4 mod_smacks: Fix #921 tmolitor <thilo@eightysoft.de> parents: 2744 diff changeset	18 local jid = require "util.jid";
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	19
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	20 local t_insert, t_remove = table.insert, table.remove;
220 263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	21 local math_min = math.min;
3107 f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	22 local math_max = math.max;
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	23 local os_time = os.time;
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	24 local tonumber, tostring = tonumber, tostring;
201 bc24f58a0d39 mod_smacks: Use filters for catching incoming stanzas (more reliable and efficient), also add some logic to make compatible with the stream resumption module (coming soon) Matthew Wild <mwild1@gmail.com> parents: 200 diff changeset	25 local add_filter = require "util.filters".add_filter;
257 08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	26 local timer = require "util.timer";
593 db2a40cbd6ef Add a <delay> to stanzas that are queued (and don't have one already), so clients can show them with the original timestamp. Thijs Alkemade <thijsalkemade@gmail.com> parents: 592 diff changeset	27 local datetime = require "util.datetime";
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	28
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	29 local xmlns_sm2 = "urn:xmpp:sm:2";
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	30 local xmlns_sm3 = "urn:xmpp:sm:3";
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	31 local xmlns_errors = "urn:ietf:params:xml:ns:xmpp-stanzas";
593 db2a40cbd6ef Add a <delay> to stanzas that are queued (and don't have one already), so clients can show them with the original timestamp. Thijs Alkemade <thijsalkemade@gmail.com> parents: 592 diff changeset	32 local xmlns_delay = "urn:xmpp:delay";
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	33
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	34 local sm2_attr = { xmlns = xmlns_sm2 };
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	35 local sm3_attr = { xmlns = xmlns_sm3 };
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	36
3967 0957ba6aeb99 mod_smacks: Update documentation and slightly adjust default values tmolitor <thilo@eightysoft.de> parents: 3942 diff changeset	37 local resume_timeout = module:get_option_number("smacks_hibernation_time", 600);
576 44b69c3d5351 mod_smacks: Fix smacks on s2s connections, but disable it by default. Kim Alvefur <zash@zash.se> parents: 478 diff changeset	38 local s2s_smacks = module:get_option_boolean("smacks_enabled_s2s", false);
1881 3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	39 local s2s_resend = module:get_option_boolean("smacks_s2s_resend", false);
642 842a8a3b0d81 mod_smacks: Make smacks_max_unacked_stanzas configurable Matthew Wild <mwild1@gmail.com> parents: 641 diff changeset	40 local max_unacked_stanzas = module:get_option_number("smacks_max_unacked_stanzas", 0);
3967 0957ba6aeb99 mod_smacks: Update documentation and slightly adjust default values tmolitor <thilo@eightysoft.de> parents: 3942 diff changeset	41 local delayed_ack_timeout = module:get_option_number("smacks_max_ack_delay", 30);
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	42 local max_hibernated_sessions = module:get_option_number("smacks_max_hibernated_sessions", 10);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	43 local max_old_sessions = module:get_option_number("smacks_max_old_sessions", 10);
754 713c6791fbcc mod_smacks: Import prosody.core_process_stanza() Kim Alvefur <zash@zash.se> parents: 642 diff changeset	44 local core_process_stanza = prosody.core_process_stanza;
757 92c6f84ec446 mod_smacks: Use require to import (thanks a lot, autocomplete) Kim Alvefur <zash@zash.se> parents: 756 diff changeset	45 local sessionmanager = require"core.sessionmanager";
200 64a573203c20 mod_smacks: Better logic for deciding what is a stanza and what is not, and deciding when to send ack requests Matthew Wild <mwild1@gmail.com> parents: 160 diff changeset	46
3493 3d4eefdd950a mod_smacks: Raise error on out-of-range config options (thanks marc0s) Matthew Wild <mwild1@gmail.com> parents: 3479 diff changeset	47 assert(max_hibernated_sessions > 0, "smacks_max_hibernated_sessions must be greater than 0");
3935 c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	48 assert(max_old_sessions > 0, "smacks_max_old_sessions must be greater than 0");
3493 3d4eefdd950a mod_smacks: Raise error on out-of-range config options (thanks marc0s) Matthew Wild <mwild1@gmail.com> parents: 3479 diff changeset	49
640 d87131b29bbd mod_smacks: Remove dependency on connlisteners (use sessions table shared by mod_c2s directly) Matthew Wild <mwild1@gmail.com> parents: 625 diff changeset	50 local c2s_sessions = module:shared("/*/c2s/sessions");
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	51
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	52 local function init_session_cache(max_entries, evict_callback)
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	53 -- old prosody version < 0.10 (no limiting at all!)
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	54 if not cache then
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	55 local store = {};
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	56 return {
2701 d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	57 get = function(user, key)
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	58 if not user then return nil; end
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	59 if not key then return nil; end
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	60 return store[key];
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	61 end;
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	62 set = function(user, key, value)
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	63 if not user then return nil; end
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	64 if not key then return nil; end
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	65 store[key] = value;
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	66 end;
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	67 };
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	68 end
3104 626d2c781c66 mod_smacks: send maximum resumption timeout to client Jonas Wielicki <jonas@wielicki.name> parents: 2937 diff changeset	69
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	70 -- use per user limited cache for prosody >= 0.10
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	71 local stores = {};
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	72 return {
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	73 get = function(user, key)
2701 d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	74 if not user then return nil; end
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	75 if not key then return nil; end
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	76 if not stores[user] then
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	77 stores[user] = cache.new(max_entries, evict_callback);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	78 end
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	79 return stores[user]:get(key);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	80 end;
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	81 set = function(user, key, value)
2701 d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	82 if not user then return nil; end
d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	83 if not key then return nil; end
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	84 if not stores[user] then stores[user] = cache.new(max_entries, evict_callback); end
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	85 stores[user]:set(key, value);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	86 -- remove empty caches completely
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	87 if not stores[user]:count() then stores[user] = nil; end
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	88 end;
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	89 };
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	90 end
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	91 local old_session_registry = init_session_cache(max_old_sessions, nil);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	92 local session_registry = init_session_cache(max_hibernated_sessions, function(resumption_token, session)
2701 d96831e46b64 Fix #889 tmolitor <thilo@eightysoft.de> parents: 2670 diff changeset	93 if session.destroyed then return true; end -- destroyed session can always be removed from cache
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	94 session.log("warn", "User has too much hibernated sessions, removing oldest session (token: %s)", resumption_token);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	95 -- store old session's h values on force delete
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	96 -- save only actual h value and username/host (for security)
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	97 old_session_registry.set(session.username, resumption_token, {
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	98 h = session.handled_stanza_count,
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	99 username = session.username,
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	100 host = session.host
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	101 });
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	102 return true; -- allow session to be removed from full cache to make room for new one
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	103 end);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	104
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	105 local function stoppable_timer(delay, callback)
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	106 local stopped = false;
3620 fb1c8dee2ead mod_smacks: piggyback ack request onto ack response if queue is not empty, use native stoppable timers if supported tmolitor <thilo@eightysoft.de> parents: 3493 diff changeset	107 local timer = module:add_timer(delay, function (t)
fb1c8dee2ead mod_smacks: piggyback ack request onto ack response if queue is not empty, use native stoppable timers if supported tmolitor <thilo@eightysoft.de> parents: 3493 diff changeset	108 if stopped then return; end
fb1c8dee2ead mod_smacks: piggyback ack request onto ack response if queue is not empty, use native stoppable timers if supported tmolitor <thilo@eightysoft.de> parents: 3493 diff changeset	109 return callback(t);
fb1c8dee2ead mod_smacks: piggyback ack request onto ack response if queue is not empty, use native stoppable timers if supported tmolitor <thilo@eightysoft.de> parents: 3493 diff changeset	110 end);
3621 c2c851722a8a mod_smacks: fix prosody 0.9 compatibility tmolitor <thilo@eightysoft.de> parents: 3620 diff changeset	111 if timer and timer.stop then return timer; end -- new prosody api includes stop() function
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	112 return {
3935 c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	113 stop = function(self) stopped = true end;
3620 fb1c8dee2ead mod_smacks: piggyback ack request onto ack response if queue is not empty, use native stoppable timers if supported tmolitor <thilo@eightysoft.de> parents: 3493 diff changeset	114 timer;
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	115 };
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	116 end
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	117
2394 4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	118 local function delayed_ack_function(session)
3646 58047d6f2b89 mod_smacks: fix bug #1405 (prevent timer from running for already destroyed sessions) tmolitor <thilo@eightysoft.de> parents: 3640 diff changeset	119 -- fire event only if configured to do so and our session is not already hibernated or destroyed
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	120 if delayed_ack_timeout > 0 and session.awaiting_ack
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	121 and not session.hibernating and not session.destroyed then
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	122 session.log("debug", "Firing event 'smacks-ack-delayed', queue = %d",
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	123 session.outgoing_stanza_queue and #session.outgoing_stanza_queue or 0);
2394 4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	124 module:fire_event("smacks-ack-delayed", {origin = session, queue = session.outgoing_stanza_queue});
4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	125 end
2494 d300ae5dba87 mod_smacks: Fix some bugs with smacks-ack-delayed event triggering. tmolitor <thilo@eightysoft.de> parents: 2491 diff changeset	126 session.delayed_ack_timer = nil;
2394 4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	127 end
4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	128
591 36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	129 local function can_do_smacks(session, advertise_only)
36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	130 if session.smacks then return false, "unexpected-request", "Stream management is already enabled"; end
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	131
591 36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	132 local session_type = session.type;
2417 5e7badecf7fe mod_smacks: Check if a session is an authenticated c2s session by looking for a username (fix for change in 0.10 9f70d35a1602) Kim Alvefur <zash@zash.se> parents: 2394 diff changeset	133 if session.username then
591 36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	134 if not(advertise_only) and not(session.resource) then -- Fail unless we're only advertising sm
592 f9c73c1249cd Update smacks to urn:xmpp:sm:3. Fix typo in can_do_smacks. Thijs Alkemade <thijsalkemade@gmail.com> parents: 591 diff changeset	135 return false, "unexpected-request", "Client must bind a resource before enabling stream management";
591 36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	136 end
36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	137 return true;
595 7693724881b3 Fix a typo in mod_smacks (type -> session_type). Thijs Alkemade <thijsalkemade@gmail.com> parents: 594 diff changeset	138 elseif s2s_smacks and (session_type == "s2sin" or session_type == "s2sout") then
591 36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	139 return true;
36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	140 end
36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	141 return false, "service-unavailable", "Stream management is not available for this stream";
36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	142 end
36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	143
263 41f1cac40560 mod_smacks: Fixed to use the correct events API. Waqas Hussain <waqas20@gmail.com> parents: 258 diff changeset	144 module:hook("stream-features",
41f1cac40560 mod_smacks: Fixed to use the correct events API. Waqas Hussain <waqas20@gmail.com> parents: 258 diff changeset	145 function (event)
591 36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	146 if can_do_smacks(event.origin, true) then
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	147 event.features:tag("sm", sm2_attr):tag("optional"):up():up();
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	148 event.features:tag("sm", sm3_attr):tag("optional"):up():up();
589 57ac609444c4 mod_smacks: Only advertise stream features when a stream is authenticated, and doesn't already have smacks enabled Matthew Wild <mwild1@gmail.com> parents: 588 diff changeset	149 end
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	150 end);
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	151
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	152 module:hook("s2s-stream-features",
263 41f1cac40560 mod_smacks: Fixed to use the correct events API. Waqas Hussain <waqas20@gmail.com> parents: 258 diff changeset	153 function (event)
591 36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	154 if can_do_smacks(event.origin, true) then
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	155 event.features:tag("sm", sm2_attr):tag("optional"):up():up();
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	156 event.features:tag("sm", sm3_attr):tag("optional"):up():up();
576 44b69c3d5351 mod_smacks: Fix smacks on s2s connections, but disable it by default. Kim Alvefur <zash@zash.se> parents: 478 diff changeset	157 end
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	158 end);
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	159
3478 f6319346e2a3 mod_smacks: improved debug logging Georg Lukas <georg@op-co.de> parents: 3477 diff changeset	160 local function request_ack_if_needed(session, force, reason)
2491 5fbca7de2088 mod_smacks: Send out more ack requests where needed tmolitor <thilo@eightysoft.de> parents: 2417 diff changeset	161 local queue = session.outgoing_stanza_queue;
3640 b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	162 local expected_h = session.last_acknowledged_stanza + #queue;
b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	163 -- session.log("debug", "* SMACKS(1) *: awaiting_ack=%s, hibernating=%s", tostring(session.awaiting_ack), tostring(session.hibernating));
2727 91cbeb6ad987 mod_smacks: don't send out <r> when already hibernating tmolitor <thilo@eightysoft.de> parents: 2713 diff changeset	164 if session.awaiting_ack == nil and not session.hibernating then
3640 b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	165 -- this check of last_requested_h prevents ack-loops if missbehaving clients report wrong
3634 915e32d5a147 mod_smacks: fix bug for missbehaving clients sending multiple acks in a row tmolitor <thilo@eightysoft.de> parents: 3621 diff changeset	166 -- stanza counts. it is set when an <r> is really sent (e.g. inside timer), preventing any
3640 b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	167 -- further requests until a higher h-value would be expected.
b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	168 -- session.log("debug", "* SMACKS(2) *: #queue=%s, max_unacked_stanzas=%s, expected_h=%s, last_requested_h=%s", tostring(#queue), tostring(max_unacked_stanzas), tostring(expected_h), tostring(session.last_requested_h));
b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	169 if (#queue > max_unacked_stanzas and expected_h ~= session.last_requested_h) or force then
3478 f6319346e2a3 mod_smacks: improved debug logging Georg Lukas <georg@op-co.de> parents: 3477 diff changeset	170 session.log("debug", "Queuing <r> (in a moment) from %s - #queue=%d", reason, #queue);
2624 c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	171 session.awaiting_ack = false;
c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	172 session.awaiting_ack_timer = stoppable_timer(1e-06, function ()
3640 b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	173 -- session.log("debug", "* SMACKS(3) *: awaiting_ack=%s, hibernating=%s", tostring(session.awaiting_ack), tostring(session.hibernating));
3646 58047d6f2b89 mod_smacks: fix bug #1405 (prevent timer from running for already destroyed sessions) tmolitor <thilo@eightysoft.de> parents: 3640 diff changeset	174 -- only request ack if needed and our session is not already hibernated or destroyed
58047d6f2b89 mod_smacks: fix bug #1405 (prevent timer from running for already destroyed sessions) tmolitor <thilo@eightysoft.de> parents: 3640 diff changeset	175 if not session.awaiting_ack and not session.hibernating and not session.destroyed then
3640 b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	176 session.log("debug", "Sending <r> (inside timer, before send) from %s - #queue=%d", reason, #queue);
2624 c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	177 (session.sends2s or session.send)(st.stanza("r", { xmlns = session.smacks }))
3634 915e32d5a147 mod_smacks: fix bug for missbehaving clients sending multiple acks in a row tmolitor <thilo@eightysoft.de> parents: 3621 diff changeset	178 session.awaiting_ack = true;
3640 b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	179 -- expected_h could be lower than this expression e.g. more stanzas added to the queue meanwhile)
b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	180 session.last_requested_h = session.last_acknowledged_stanza + #queue;
b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	181 session.log("debug", "Sending <r> (inside timer, after send) from %s - #queue=%d", reason, #queue);
2624 c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	182 if not session.delayed_ack_timer then
c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	183 session.delayed_ack_timer = stoppable_timer(delayed_ack_timeout, function()
c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	184 delayed_ack_function(session);
c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	185 end);
c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	186 end
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	187 end
2624 c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	188 end);
c110b6bfe5d1 mod_smacks: Prevent ack loop on misbehaving clients tmolitor <thilo@eightysoft.de> parents: 2623 diff changeset	189 end
2491 5fbca7de2088 mod_smacks: Send out more ack requests where needed tmolitor <thilo@eightysoft.de> parents: 2417 diff changeset	190 end
3104 626d2c781c66 mod_smacks: send maximum resumption timeout to client Jonas Wielicki <jonas@wielicki.name> parents: 2937 diff changeset	191
2713 eea1d5bac451 mod_smacks: Fix delayed_ack event tmolitor <thilo@eightysoft.de> parents: 2701 diff changeset	192 -- Trigger "smacks-ack-delayed"-event if we added new (ackable) stanzas to the outgoing queue
eea1d5bac451 mod_smacks: Fix delayed_ack event tmolitor <thilo@eightysoft.de> parents: 2701 diff changeset	193 -- and there isn't already a timer for this event running.
eea1d5bac451 mod_smacks: Fix delayed_ack event tmolitor <thilo@eightysoft.de> parents: 2701 diff changeset	194 -- If we wouldn't do this, stanzas added to the queue after the first "smacks-ack-delayed"-event
eea1d5bac451 mod_smacks: Fix delayed_ack event tmolitor <thilo@eightysoft.de> parents: 2701 diff changeset	195 -- would not trigger this event (again).
eea1d5bac451 mod_smacks: Fix delayed_ack event tmolitor <thilo@eightysoft.de> parents: 2701 diff changeset	196 if #queue > max_unacked_stanzas and session.awaiting_ack and session.delayed_ack_timer == nil then
eea1d5bac451 mod_smacks: Fix delayed_ack event tmolitor <thilo@eightysoft.de> parents: 2701 diff changeset	197 session.log("debug", "Calling delayed_ack_function directly (still waiting for ack)");
eea1d5bac451 mod_smacks: Fix delayed_ack event tmolitor <thilo@eightysoft.de> parents: 2701 diff changeset	198 delayed_ack_function(session);
eea1d5bac451 mod_smacks: Fix delayed_ack event tmolitor <thilo@eightysoft.de> parents: 2701 diff changeset	199 end
2491 5fbca7de2088 mod_smacks: Send out more ack requests where needed tmolitor <thilo@eightysoft.de> parents: 2417 diff changeset	200 end
5fbca7de2088 mod_smacks: Send out more ack requests where needed tmolitor <thilo@eightysoft.de> parents: 2417 diff changeset	201
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	202 local function outgoing_stanza_filter(stanza, session)
1597 dc0cf2ba0e1a mod_smacks: Stanzas don't have a ':' in their name Kim Alvefur <zash@zash.se> parents: 1539 diff changeset	203 local is_stanza = stanza.attr and not stanza.attr.xmlns and not stanza.name:find":";
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	204 if is_stanza and not stanza._cached then -- Stanza in default stream namespace
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	205 local queue = session.outgoing_stanza_queue;
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	206 local cached_stanza = st.clone(stanza);
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	207 cached_stanza._cached = true;
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	208
1599 8e006226e4c5 mod_smacks: Don't attach timestamps to 'iq' stanzas Kim Alvefur <zash@zash.se> parents: 1598 diff changeset	209 if cached_stanza and cached_stanza.name ~= "iq" and cached_stanza:get_child("delay", xmlns_delay) == nil then
2756 dbba101601b4 mod_smacks: Fix #921 tmolitor <thilo@eightysoft.de> parents: 2744 diff changeset	210 cached_stanza = cached_stanza:tag("delay", {
dbba101601b4 mod_smacks: Fix #921 tmolitor <thilo@eightysoft.de> parents: 2744 diff changeset	211 xmlns = xmlns_delay,
dbba101601b4 mod_smacks: Fix #921 tmolitor <thilo@eightysoft.de> parents: 2744 diff changeset	212 from = jid.bare(session.full_jid or session.host),
dbba101601b4 mod_smacks: Fix #921 tmolitor <thilo@eightysoft.de> parents: 2744 diff changeset	213 stamp = datetime.datetime()
dbba101601b4 mod_smacks: Fix #921 tmolitor <thilo@eightysoft.de> parents: 2744 diff changeset	214 });
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	215 end
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	216
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	217 queue[#queue+1] = cached_stanza;
1522 d4a4ed31567e mod_smacks: Trick session.send() into not returning nil or mod_message will act as if messages were not delivered Kim Alvefur <zash@zash.se> parents: 1520 diff changeset	218 if session.hibernating then
d4a4ed31567e mod_smacks: Trick session.send() into not returning nil or mod_message will act as if messages were not delivered Kim Alvefur <zash@zash.se> parents: 1520 diff changeset	219 session.log("debug", "hibernating, stanza queued");
3620 fb1c8dee2ead mod_smacks: piggyback ack request onto ack response if queue is not empty, use native stoppable timers if supported tmolitor <thilo@eightysoft.de> parents: 3493 diff changeset	220 module:fire_event("smacks-hibernation-stanza-queued", {origin = session, queue = queue, stanza = cached_stanza});
2087 e48dbb640408 mod_smacks: Drop stanzas instead of turning them into the empty string Kim Alvefur <zash@zash.se> parents: 1881 diff changeset	221 return nil;
1522 d4a4ed31567e mod_smacks: Trick session.send() into not returning nil or mod_message will act as if messages were not delivered Kim Alvefur <zash@zash.se> parents: 1520 diff changeset	222 end
3478 f6319346e2a3 mod_smacks: improved debug logging Georg Lukas <georg@op-co.de> parents: 3477 diff changeset	223 request_ack_if_needed(session, false, "outgoing_stanza_filter");
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	224 end
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	225 return stanza;
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	226 end
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	227
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	228 local function count_incoming_stanzas(stanza, session)
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	229 if not stanza.attr.xmlns then
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	230 session.handled_stanza_count = session.handled_stanza_count + 1;
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	231 session.log("debug", "Handled %d incoming stanzas", session.handled_stanza_count);
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	232 end
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	233 return stanza;
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	234 end
2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	235
1529 16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	236 local function wrap_session_out(session, resume)
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	237 if not resume then
1528 5ccb3ee2cf72 mod_smacks: Remove variable not used after 2881d532f385 Kim Alvefur <zash@zash.se> parents: 1527 diff changeset	238 session.outgoing_stanza_queue = {};
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	239 session.last_acknowledged_stanza = 0;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	240 end
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	241
2122 3f788f18cc10 mod_smacks: Adjust filter priorities to avoid conflict with mod_websocket Kim Alvefur <zash@zash.se> parents: 2091 diff changeset	242 add_filter(session, "stanzas/out", outgoing_stanza_filter, -999);
988 c15cea87036f mod_smacks: Wrap session:close() and make the session not resumable Kim Alvefur <zash@zash.se> parents: 987 diff changeset	243
c15cea87036f mod_smacks: Wrap session:close() and make the session not resumable Kim Alvefur <zash@zash.se> parents: 987 diff changeset	244 local session_close = session.close;
c15cea87036f mod_smacks: Wrap session:close() and make the session not resumable Kim Alvefur <zash@zash.se> parents: 987 diff changeset	245 function session.close(...)
c15cea87036f mod_smacks: Wrap session:close() and make the session not resumable Kim Alvefur <zash@zash.se> parents: 987 diff changeset	246 if session.resumption_token then
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	247 session_registry.set(session.username, session.resumption_token, nil);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	248 old_session_registry.set(session.username, session.resumption_token, nil);
988 c15cea87036f mod_smacks: Wrap session:close() and make the session not resumable Kim Alvefur <zash@zash.se> parents: 987 diff changeset	249 session.resumption_token = nil;
c15cea87036f mod_smacks: Wrap session:close() and make the session not resumable Kim Alvefur <zash@zash.se> parents: 987 diff changeset	250 end
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	251 -- send out last ack as per revision 1.5.2 of XEP-0198
2623 a65260300708 mod_smacks: Made module more error resistant tmolitor <thilo@eightysoft.de> parents: 2608 diff changeset	252 if session.smacks and session.conn then
2937 e672d1050529 mod_smacks: Ensure stanza count attributes are always strings (thanks Martin) Matthew Wild <mwild1@gmail.com> parents: 2756 diff changeset	253 (session.sends2s or session.send)(st.stanza("a", { xmlns = session.smacks, h = string.format("%d", session.handled_stanza_count) }));
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	254 end
988 c15cea87036f mod_smacks: Wrap session:close() and make the session not resumable Kim Alvefur <zash@zash.se> parents: 987 diff changeset	255 return session_close(...);
c15cea87036f mod_smacks: Wrap session:close() and make the session not resumable Kim Alvefur <zash@zash.se> parents: 987 diff changeset	256 end
1529 16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	257 return session;
16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	258 end
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	259
1529 16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	260 local function wrap_session_in(session, resume)
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	261 if not resume then
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	262 session.handled_stanza_count = 0;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	263 end
2122 3f788f18cc10 mod_smacks: Adjust filter priorities to avoid conflict with mod_websocket Kim Alvefur <zash@zash.se> parents: 2091 diff changeset	264 add_filter(session, "stanzas/in", count_incoming_stanzas, 999);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	265
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	266 return session;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	267 end
201 bc24f58a0d39 mod_smacks: Use filters for catching incoming stanzas (more reliable and efficient), also add some logic to make compatible with the stream resumption module (coming soon) Matthew Wild <mwild1@gmail.com> parents: 200 diff changeset	268
1529 16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	269 local function wrap_session(session, resume)
16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	270 wrap_session_out(session, resume);
16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	271 wrap_session_in(session, resume);
16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	272 return session;
16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	273 end
16893646a458 mod_smacks: Move wrap_session() contents into separate direction-specific routines Kim Alvefur <zash@zash.se> parents: 1528 diff changeset	274
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	275 function handle_enable(session, stanza, xmlns_sm)
591 36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	276 local ok, err, err_text = can_do_smacks(session);
36003cae2370 mod_smacks: Consolidate logic for deciding whether to advertise or allow smacks for a given session, and fix an issue with not allowing s2s connections to enable smacks because of not binding a resource... (thanks xnyphs) Matthew Wild <mwild1@gmail.com> parents: 590 diff changeset	277 if not ok then
590 40b707d7a809 mod_smacks: Handle a client trying to <enable> twice, or trying to <enable> before resource binding (thanks Thijs Alkemade) Matthew Wild <mwild1@gmail.com> parents: 589 diff changeset	278 session.log("warn", "Failed to enable smacks: %s", err_text); -- TODO: XEP doesn't say we can send error text, should it?
1527 06ecc5b3ca46 mod_smacks: Send failure correctly on s2s Kim Alvefur <zash@zash.se> parents: 1526 diff changeset	279 (session.sends2s or session.send)(st.stanza("failed", { xmlns = xmlns_sm }):tag(err, { xmlns = xmlns_errors}));
590 40b707d7a809 mod_smacks: Handle a client trying to <enable> twice, or trying to <enable> before resource binding (thanks Thijs Alkemade) Matthew Wild <mwild1@gmail.com> parents: 589 diff changeset	280 return true;
40b707d7a809 mod_smacks: Handle a client trying to <enable> twice, or trying to <enable> before resource binding (thanks Thijs Alkemade) Matthew Wild <mwild1@gmail.com> parents: 589 diff changeset	281 end
40b707d7a809 mod_smacks: Handle a client trying to <enable> twice, or trying to <enable> before resource binding (thanks Thijs Alkemade) Matthew Wild <mwild1@gmail.com> parents: 589 diff changeset	282
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	283 module:log("debug", "Enabling stream management");
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	284 session.smacks = xmlns_sm;
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	285
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	286 wrap_session(session, false);
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	287
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	288 local resume_token;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	289 local resume = stanza.attr.resume;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	290 if resume == "true" or resume == "1" then
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	291 resume_token = uuid_generate();
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	292 session_registry.set(session.username, resume_token, session);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	293 session.resumption_token = resume_token;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	294 end
3110 06e07b483805 mod_smacks: Convert max number into a string before inserting it into a stanza. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 3107 diff changeset	295 (session.sends2s or session.send)(st.stanza("enabled", { xmlns = xmlns_sm, id = resume_token, resume = resume, max = tostring(resume_timeout) }));
576 44b69c3d5351 mod_smacks: Fix smacks on s2s connections, but disable it by default. Kim Alvefur <zash@zash.se> parents: 478 diff changeset	296 return true;
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	297 end
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	298 module:hook_stanza(xmlns_sm2, "enable", function (session, stanza) return handle_enable(session, stanza, xmlns_sm2); end, 100);
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	299 module:hook_stanza(xmlns_sm3, "enable", function (session, stanza) return handle_enable(session, stanza, xmlns_sm3); end, 100);
576 44b69c3d5351 mod_smacks: Fix smacks on s2s connections, but disable it by default. Kim Alvefur <zash@zash.se> parents: 478 diff changeset	300
1530 fb7cd669f41b mod_smacks: Initiate outgoing smacks on s2s when sending request and incoming when the remote says enabled Kim Alvefur <zash@zash.se> parents: 1529 diff changeset	301 module:hook_stanza("http://etherx.jabber.org/streams", "features",
fb7cd669f41b mod_smacks: Initiate outgoing smacks on s2s when sending request and incoming when the remote says enabled Kim Alvefur <zash@zash.se> parents: 1529 diff changeset	302 function (session, stanza)
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	303 stoppable_timer(1e-6, function ()
1531 7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	304 if can_do_smacks(session) then
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	305 if stanza:get_child("sm", xmlns_sm3) then
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	306 session.sends2s(st.stanza("enable", sm3_attr));
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	307 session.smacks = xmlns_sm3;
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	308 elseif stanza:get_child("sm", xmlns_sm2) then
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	309 session.sends2s(st.stanza("enable", sm2_attr));
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	310 session.smacks = xmlns_sm2;
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	311 else
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	312 return;
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	313 end
7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	314 wrap_session_out(session, false);
1530 fb7cd669f41b mod_smacks: Initiate outgoing smacks on s2s when sending request and incoming when the remote says enabled Kim Alvefur <zash@zash.se> parents: 1529 diff changeset	315 end
1531 7d86fc477993 mod_smacks: Delay initiation of outgoing smacks on s2s until after queued stanzas are sent Kim Alvefur <zash@zash.se> parents: 1530 diff changeset	316 end);
1530 fb7cd669f41b mod_smacks: Initiate outgoing smacks on s2s when sending request and incoming when the remote says enabled Kim Alvefur <zash@zash.se> parents: 1529 diff changeset	317 end);
fb7cd669f41b mod_smacks: Initiate outgoing smacks on s2s when sending request and incoming when the remote says enabled Kim Alvefur <zash@zash.se> parents: 1529 diff changeset	318
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	319 function handle_enabled(session, stanza, xmlns_sm)
576 44b69c3d5351 mod_smacks: Fix smacks on s2s connections, but disable it by default. Kim Alvefur <zash@zash.se> parents: 478 diff changeset	320 module:log("debug", "Enabling stream management");
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	321 session.smacks = xmlns_sm;
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	322
1530 fb7cd669f41b mod_smacks: Initiate outgoing smacks on s2s when sending request and incoming when the remote says enabled Kim Alvefur <zash@zash.se> parents: 1529 diff changeset	323 wrap_session_in(session, false);
576 44b69c3d5351 mod_smacks: Fix smacks on s2s connections, but disable it by default. Kim Alvefur <zash@zash.se> parents: 478 diff changeset	324
44b69c3d5351 mod_smacks: Fix smacks on s2s connections, but disable it by default. Kim Alvefur <zash@zash.se> parents: 478 diff changeset	325 -- FIXME Resume?
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	326
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	327 return true;
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	328 end
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	329 module:hook_stanza(xmlns_sm2, "enabled", function (session, stanza) return handle_enabled(session, stanza, xmlns_sm2); end, 100);
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	330 module:hook_stanza(xmlns_sm3, "enabled", function (session, stanza) return handle_enabled(session, stanza, xmlns_sm3); end, 100);
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	331
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	332 function handle_r(origin, stanza, xmlns_sm)
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	333 if not origin.smacks then
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	334 module:log("debug", "Received ack request from non-smack-enabled session");
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	335 return;
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	336 end
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	337 module:log("debug", "Received ack request, acking for %d", origin.handled_stanza_count);
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	338 -- Reply with <a>
2937 e672d1050529 mod_smacks: Ensure stanza count attributes are always strings (thanks Martin) Matthew Wild <mwild1@gmail.com> parents: 2756 diff changeset	339 (origin.sends2s or origin.send)(st.stanza("a", { xmlns = xmlns_sm, h = string.format("%d", origin.handled_stanza_count) }));
3640 b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	340 -- piggyback our own ack request if needed (see request_ack_if_needed() for explanation of last_requested_h)
b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	341 local expected_h = origin.last_acknowledged_stanza + #origin.outgoing_stanza_queue;
b2f32b3c6ec1 mod_smacks: fix bug in bad client handling introduced by last commit tmolitor <thilo@eightysoft.de> parents: 3634 diff changeset	342 if #origin.outgoing_stanza_queue > 0 and expected_h ~= origin.last_requested_h then
3620 fb1c8dee2ead mod_smacks: piggyback ack request onto ack response if queue is not empty, use native stoppable timers if supported tmolitor <thilo@eightysoft.de> parents: 3493 diff changeset	343 request_ack_if_needed(origin, true, "piggybacked by handle_r");
fb1c8dee2ead mod_smacks: piggyback ack request onto ack response if queue is not empty, use native stoppable timers if supported tmolitor <thilo@eightysoft.de> parents: 3493 diff changeset	344 end
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	345 return true;
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	346 end
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	347 module:hook_stanza(xmlns_sm2, "r", function (origin, stanza) return handle_r(origin, stanza, xmlns_sm2); end);
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	348 module:hook_stanza(xmlns_sm3, "r", function (origin, stanza) return handle_r(origin, stanza, xmlns_sm3); end);
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	349
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	350 function handle_a(origin, stanza)
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	351 if not origin.smacks then return; end
200 64a573203c20 mod_smacks: Better logic for deciding what is a stanza and what is not, and deciding when to send ack requests Matthew Wild <mwild1@gmail.com> parents: 160 diff changeset	352 origin.awaiting_ack = nil;
2090 1796a022dd29 mod_smacks: Keep timer object around and stop it when needed (trunk only) Kim Alvefur <zash@zash.se> parents: 2089 diff changeset	353 if origin.awaiting_ack_timer then
1796a022dd29 mod_smacks: Keep timer object around and stop it when needed (trunk only) Kim Alvefur <zash@zash.se> parents: 2089 diff changeset	354 origin.awaiting_ack_timer:stop();
1796a022dd29 mod_smacks: Keep timer object around and stop it when needed (trunk only) Kim Alvefur <zash@zash.se> parents: 2089 diff changeset	355 end
2394 4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	356 if origin.delayed_ack_timer then
4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	357 origin.delayed_ack_timer:stop();
2494 d300ae5dba87 mod_smacks: Fix some bugs with smacks-ack-delayed event triggering. tmolitor <thilo@eightysoft.de> parents: 2491 diff changeset	358 origin.delayed_ack_timer = nil;
2394 4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	359 end
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	360 -- Remove handled stanzas from outgoing_stanza_queue
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	361 -- origin.log("debug", "ACK: h=%s, last=%s", stanza.attr.h or "", origin.last_acknowledged_stanza or "");
1407 b631c8a8b9e7 mod_smacks: Assert that the 'h' attribute is present and a number Kim Alvefur <zash@zash.se> parents: 1406 diff changeset	362 local h = tonumber(stanza.attr.h);
b631c8a8b9e7 mod_smacks: Assert that the 'h' attribute is present and a number Kim Alvefur <zash@zash.se> parents: 1406 diff changeset	363 if not h then
b631c8a8b9e7 mod_smacks: Assert that the 'h' attribute is present and a number Kim Alvefur <zash@zash.se> parents: 1406 diff changeset	364 origin:close{ condition = "invalid-xml"; text = "Missing or invalid 'h' attribute"; };
3477 1f2381492c9f mod_smacks: no crash on <a> without @h, fix #1317 Georg Lukas <georg@op-co.de> parents: 3450 diff changeset	365 return;
1407 b631c8a8b9e7 mod_smacks: Assert that the 'h' attribute is present and a number Kim Alvefur <zash@zash.se> parents: 1406 diff changeset	366 end
b631c8a8b9e7 mod_smacks: Assert that the 'h' attribute is present and a number Kim Alvefur <zash@zash.se> parents: 1406 diff changeset	367 local handled_stanza_count = h-origin.last_acknowledged_stanza;
220 263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	368 local queue = origin.outgoing_stanza_queue;
263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	369 if handled_stanza_count > #queue then
1416 7ddb522d9b28 mod_smacks: Fix logging (Thanks Ge0rG) Kim Alvefur <zash@zash.se> parents: 1408 diff changeset	370 origin.log("warn", "The client says it handled %d new stanzas, but we only sent %d :)",
220 263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	371 handled_stanza_count, #queue);
1416 7ddb522d9b28 mod_smacks: Fix logging (Thanks Ge0rG) Kim Alvefur <zash@zash.se> parents: 1408 diff changeset	372 origin.log("debug", "Client h: %d, our h: %d", tonumber(stanza.attr.h), origin.last_acknowledged_stanza);
220 263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	373 for i=1,#queue do
1416 7ddb522d9b28 mod_smacks: Fix logging (Thanks Ge0rG) Kim Alvefur <zash@zash.se> parents: 1408 diff changeset	374 origin.log("debug", "Q item %d: %s", i, tostring(queue[i]));
220 263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	375 end
263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	376 end
3450 9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	377
220 263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	378 for i=1,math_min(handled_stanza_count,#queue) do
3450 9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	379 local handled_stanza = t_remove(origin.outgoing_stanza_queue, 1);
9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	380 module:fire_event("delivery/success", { session = origin, stanza = handled_stanza });
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	381 end
3450 9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	382
1406 7d76dd2310ef mod_smacks: Add more debug logging Kim Alvefur <zash@zash.se> parents: 1405 diff changeset	383 origin.log("debug", "#queue = %d", #queue);
220 263858d40ceb mod_smacks: Fix the logic for handling outgoing stanzas and ack requests Matthew Wild <mwild1@gmail.com> parents: 202 diff changeset	384 origin.last_acknowledged_stanza = origin.last_acknowledged_stanza + handled_stanza_count;
3478 f6319346e2a3 mod_smacks: improved debug logging Georg Lukas <georg@op-co.de> parents: 3477 diff changeset	385 request_ack_if_needed(origin, false, "handle_a")
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	386 return true;
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	387 end
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	388 module:hook_stanza(xmlns_sm2, "a", handle_a);
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	389 module:hook_stanza(xmlns_sm3, "a", handle_a);
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	390
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	391 --TODO: Optimise... incoming stanzas should be handled by a per-session
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	392 -- function that has a counter as an upvalue (no table indexing for increments,
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	393 -- and won't slow non-198 sessions). We can also then remove the .handled flag
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	394 -- on stanzas
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	395
3935 c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	396 local function handle_unacked_stanzas(session)
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	397 local queue = session.outgoing_stanza_queue;
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	398 local error_attr = { type = "cancel" };
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	399 if #queue > 0 then
202 d11478ae374e mod_smacks: Clean outgoing stanza queue correctly on session close Matthew Wild <mwild1@gmail.com> parents: 201 diff changeset	400 session.outgoing_stanza_queue = {};
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	401 for i=1,#queue do
3450 9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	402 if not module:fire_event("delivery/failure", { session = session, stanza = queue[i] }) then
9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	403 local reply = st.reply(queue[i]);
9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	404 if reply.attr.to ~= session.full_jid then
9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	405 reply.attr.type = "error";
9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	406 reply:tag("error", error_attr)
9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	407 :tag("recipient-unavailable", {xmlns = "urn:ietf:params:xml:ns:xmpp-stanzas"});
9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	408 core_process_stanza(session, reply);
9b6206f23151 mod_smacks: Fire event on delivery failure/success for each stanza Matthew Wild <mwild1@gmail.com> parents: 3218 diff changeset	409 end
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	410 end
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	411 end
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	412 end
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	413 end
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	414
3935 c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	415 -- don't send delivery errors for messages which will be delivered by mam later on
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	416 module:hook("delivery/failure", function(event)
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	417 local session, stanza = event.session, event.stanza;
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	418 -- Only deal with authenticated (c2s) sessions
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	419 if session.username then
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	420 if stanza.name == "message" and stanza.attr.xmlns == nil and
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	421 ( stanza.attr.type == "chat" or ( stanza.attr.type or "normal" ) == "normal" ) then
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	422 -- do nothing here for normal messages and don't send out "message delivery errors",
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	423 -- because messages are already in MAM at this point (no need to frighten users)
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	424 if session.mam_requested and stanza._was_archived then
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	425 return true; -- stanza handled, don't send an error
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	426 end
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	427 -- store message in offline store, if this client does not use mam and was the last client online
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	428 local sessions = prosody.hosts[module.host].sessions[session.username] and
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	429 prosody.hosts[module.host].sessions[session.username].sessions or nil;
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	430 if sessions and next(sessions) == session.resource and next(sessions, session.resource) == nil then
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	431 module:fire_event("message/offline/handle", { origin = session, stanza = stanza } );
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	432 return true; -- stanza handled, don't send an error
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	433 end
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	434 end
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	435 end
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	436 end);
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	437
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	438 -- mark stanzas as archived --> this will allow us to send back errors for stanzas not archived
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	439 -- because the user configured the server to do so ("no-archive"-setting for one special contact for example)
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	440 module:hook("archive-message-added", function(event)
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	441 local session, stanza, for_user, stanza_id = event.origin, event.stanza, event.for_user, event.id;
3942 e93e58b33bf6 mod_smacks: fix logging issue in mam eventhandler tmolitor <thilo@eightysoft.de> parents: 3935 diff changeset	442 local log = session.log or module._log
e93e58b33bf6 mod_smacks: fix logging issue in mam eventhandler tmolitor <thilo@eightysoft.de> parents: 3935 diff changeset	443 log("debug", "Marking stanza as archived, archive_id: %s, stanza: %s", tostring(stanza_id), tostring(stanza:top_tag()));
3935 c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	444 stanza._was_archived = true;
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	445 end);
c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	446
622 ce39df945de1 mod_smacks: Use pre-resource-unbind (0.9 feature) to fix reloadability and multiple host support Matthew Wild <mwild1@gmail.com> parents: 595 diff changeset	447 module:hook("pre-resource-unbind", function (event)
ce39df945de1 mod_smacks: Use pre-resource-unbind (0.9 feature) to fix reloadability and multiple host support Matthew Wild <mwild1@gmail.com> parents: 595 diff changeset	448 local session, err = event.session, event.error;
1024 d7655e634c30 mod_smacks: Allow resumption if the TCP connection is closed from our end, c15cea87036f ensures distinction from cleanly closed streams (thanks Lance) Kim Alvefur <zash@zash.se> parents: 994 diff changeset	449 if session.smacks then
257 08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	450 if not session.resumption_token then
08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	451 local queue = session.outgoing_stanza_queue;
08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	452 if #queue > 0 then
3150 14b6ad2b773f mod_smacks: Reduce unacked stanza log message from warn->debug Matthew Wild <mwild1@gmail.com> parents: 3110 diff changeset	453 session.log("debug", "Destroying session with %d unacked stanzas", #queue);
257 08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	454 handle_unacked_stanzas(session);
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	455 end
257 08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	456 else
586 f733e7599ed6 mod_smacks: Add logging to hibernation and session destruction (thanks darkrain) Matthew Wild <mwild1@gmail.com> parents: 576 diff changeset	457 session.log("debug", "mod_smacks hibernating session for up to %d seconds", resume_timeout);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	458 local hibernate_time = os_time(); -- Track the time we went into hibernation
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	459 session.hibernating = hibernate_time;
478 db0f065c4e09 mod_smacks: Don't destroy a session that binds the same resource as a hibernating smacks session (thanks xnyhps for tracking down the problem, though I've used a different fix) Matthew Wild <mwild1@gmail.com> parents: 345 diff changeset	460 local resumption_token = session.resumption_token;
2140 3a94b3cd31e2 mod_smacks: added new events for hibernation start/end tmolitor <thilo@eightysoft.de> parents: 2136 diff changeset	461 module:fire_event("smacks-hibernation-start", {origin = session, queue = session.outgoing_stanza_queue});
257 08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	462 timer.add_task(resume_timeout, function ()
586 f733e7599ed6 mod_smacks: Add logging to hibernation and session destruction (thanks darkrain) Matthew Wild <mwild1@gmail.com> parents: 576 diff changeset	463 session.log("debug", "mod_smacks hibernation timeout reached...");
478 db0f065c4e09 mod_smacks: Don't destroy a session that binds the same resource as a hibernating smacks session (thanks xnyhps for tracking down the problem, though I've used a different fix) Matthew Wild <mwild1@gmail.com> parents: 345 diff changeset	464 -- We need to check the current resumption token for this resource
db0f065c4e09 mod_smacks: Don't destroy a session that binds the same resource as a hibernating smacks session (thanks xnyhps for tracking down the problem, though I've used a different fix) Matthew Wild <mwild1@gmail.com> parents: 345 diff changeset	465 -- matches the smacks session this timer is for in case it changed
db0f065c4e09 mod_smacks: Don't destroy a session that binds the same resource as a hibernating smacks session (thanks xnyhps for tracking down the problem, though I've used a different fix) Matthew Wild <mwild1@gmail.com> parents: 345 diff changeset	466 -- (for example, the client may have bound a new resource and
db0f065c4e09 mod_smacks: Don't destroy a session that binds the same resource as a hibernating smacks session (thanks xnyhps for tracking down the problem, though I've used a different fix) Matthew Wild <mwild1@gmail.com> parents: 345 diff changeset	467 -- started a new smacks session, or not be using smacks)
810 464ed063a8f2 mod_smacks: Less table indexing! Kim Alvefur <zash@zash.se> parents: 757 diff changeset	468 local curr_session = full_sessions[session.full_jid];
1598 043d08448d87 mod_smacks: Remove negation of condition, most likely a leftover from debugging Kim Alvefur <zash@zash.se> parents: 1597 diff changeset	469 if session.destroyed then
987 fabff75bfc3f mod_smacks: If a hibernating session was destroyed before the timeout, don't destroy it again or say that it was resumed Kim Alvefur <zash@zash.se> parents: 925 diff changeset	470 session.log("debug", "The session has already been destroyed");
fabff75bfc3f mod_smacks: If a hibernating session was destroyed before the timeout, don't destroy it again or say that it was resumed Kim Alvefur <zash@zash.se> parents: 925 diff changeset	471 elseif curr_session and curr_session.resumption_token == resumption_token
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	472 -- Check the hibernate time still matches what we think it is,
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	473 -- otherwise the session resumed and re-hibernated.
478 db0f065c4e09 mod_smacks: Don't destroy a session that binds the same resource as a hibernating smacks session (thanks xnyhps for tracking down the problem, though I've used a different fix) Matthew Wild <mwild1@gmail.com> parents: 345 diff changeset	474 and session.hibernating == hibernate_time then
3107 f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	475 -- wait longer if the timeout isn't reached because push was enabled for this session
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	476 -- session.first_hibernated_push is the starting point for hibernation timeouts of those push enabled clients
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	477 -- wait for an additional resume_timeout seconds if no push occured since hibernation at all
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	478 local current_time = os_time();
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	479 local timeout_start = math_max(session.hibernating, session.first_hibernated_push or session.hibernating);
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	480 if session.push_identifier ~= nil and not session.first_hibernated_push then
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	481 session.log("debug", "No push happened since hibernation started, hibernating session for up to %d extra seconds", resume_timeout);
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	482 return resume_timeout;
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	483 end
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	484 if current_time-timeout_start < resume_timeout and session.push_identifier ~= nil then
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	485 session.log("debug", "A push happened since hibernation started, hibernating session for up to %d extra seconds", current_time-timeout_start);
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	486 return current_time-timeout_start; -- time left to wait
f703cc6e72df mod_smacks: defer timeouts for push enabled clients tmolitor <thilo@eightysoft.de> parents: 3104 diff changeset	487 end
586 f733e7599ed6 mod_smacks: Add logging to hibernation and session destruction (thanks darkrain) Matthew Wild <mwild1@gmail.com> parents: 576 diff changeset	488 session.log("debug", "Destroying session for hibernating too long");
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	489 session_registry.set(session.username, session.resumption_token, nil);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	490 -- save only actual h value and username/host (for security)
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	491 old_session_registry.set(session.username, session.resumption_token, {
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	492 h = session.handled_stanza_count,
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	493 username = session.username,
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	494 host = session.host
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	495 });
257 08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	496 session.resumption_token = nil;
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	497 sessionmanager.destroy_session(session);
586 f733e7599ed6 mod_smacks: Add logging to hibernation and session destruction (thanks darkrain) Matthew Wild <mwild1@gmail.com> parents: 576 diff changeset	498 else
f733e7599ed6 mod_smacks: Add logging to hibernation and session destruction (thanks darkrain) Matthew Wild <mwild1@gmail.com> parents: 576 diff changeset	499 session.log("debug", "Session resumed before hibernation timeout, all is well")
257 08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	500 end
08fa42e1ab06 mod_smacks: Fixes for monkey-patched sessionmanager.destroy to handle stream resumption, and to fall back to stock destroy() if the session is not smacks-enabled. Matthew Wild <mwild1@gmail.com> parents: 256 diff changeset	501 end);
622 ce39df945de1 mod_smacks: Use pre-resource-unbind (0.9 feature) to fix reloadability and multiple host support Matthew Wild <mwild1@gmail.com> parents: 595 diff changeset	502 return true; -- Postpone destruction for now
160 9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	503 end
9a7671720dec mod_smacks: XEP-0198 Stream Management acks. Initial commit - very rough, useful mainly for testing at the moment, most certainly contains bugs :) Matthew Wild <mwild1@gmail.com> parents: diff changeset	504 end
622 ce39df945de1 mod_smacks: Use pre-resource-unbind (0.9 feature) to fix reloadability and multiple host support Matthew Wild <mwild1@gmail.com> parents: 595 diff changeset	505 end);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	506
1732 2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	507 local function handle_s2s_destroyed(event)
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	508 local session = event.session;
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	509 local queue = session.outgoing_stanza_queue;
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	510 if queue and #queue > 0 then
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	511 session.log("warn", "Destroying session with %d unacked stanzas", #queue);
1881 3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	512 if s2s_resend then
3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	513 for i = 1, #queue do
3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	514 module:send(queue[i]);
3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	515 end
3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	516 session.outgoing_stanza_queue = nil;
3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	517 else
3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	518 handle_unacked_stanzas(session);
3683eb95bc1a mod_smacks: Add experimental resending of unacked messages in s2s queues (disabled by default) Kim Alvefur <zash@zash.se> parents: 1733 diff changeset	519 end
1732 2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	520 end
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	521 end
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	522
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	523 module:hook("s2sout-destroyed", handle_s2s_destroyed);
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	524 module:hook("s2sin-destroyed", handle_s2s_destroyed);
2f9ee9ed6267 mod_smacks: Handle unacked messages in s2s queues Kim Alvefur <zash@zash.se> parents: 1706 diff changeset	525
3218 67f1d1f22625 mod_smacks: Improve logging on resume so session changes are more easily tracked Matthew Wild <mwild1@gmail.com> parents: 3150 diff changeset	526 local function get_session_id(session)
67f1d1f22625 mod_smacks: Improve logging on resume so session changes are more easily tracked Matthew Wild <mwild1@gmail.com> parents: 3150 diff changeset	527 return session.id or (tostring(session):match("[a-f0-9]+$"));
67f1d1f22625 mod_smacks: Improve logging on resume so session changes are more easily tracked Matthew Wild <mwild1@gmail.com> parents: 3150 diff changeset	528 end
67f1d1f22625 mod_smacks: Improve logging on resume so session changes are more easily tracked Matthew Wild <mwild1@gmail.com> parents: 3150 diff changeset	529
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	530 function handle_resume(session, stanza, xmlns_sm)
925 720b8268778e mod_smacks: Don't allow steam resumption onto a stream after resource binding Kim Alvefur <zash@zash.se> parents: 908 diff changeset	531 if session.full_jid then
994 487cd02aada0 mod_smacks: Complain a little louder about clients trying to resume after resource binding Kim Alvefur <zash@zash.se> parents: 988 diff changeset	532 session.log("warn", "Tried to resume after resource binding");
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	533 session.send(st.stanza("failed", { xmlns = xmlns_sm })
925 720b8268778e mod_smacks: Don't allow steam resumption onto a stream after resource binding Kim Alvefur <zash@zash.se> parents: 908 diff changeset	534 :tag("unexpected-request", { xmlns = xmlns_errors })
720b8268778e mod_smacks: Don't allow steam resumption onto a stream after resource binding Kim Alvefur <zash@zash.se> parents: 908 diff changeset	535 );
720b8268778e mod_smacks: Don't allow steam resumption onto a stream after resource binding Kim Alvefur <zash@zash.se> parents: 908 diff changeset	536 return true;
720b8268778e mod_smacks: Don't allow steam resumption onto a stream after resource binding Kim Alvefur <zash@zash.se> parents: 908 diff changeset	537 end
720b8268778e mod_smacks: Don't allow steam resumption onto a stream after resource binding Kim Alvefur <zash@zash.se> parents: 908 diff changeset	538
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	539 local id = stanza.attr.previd;
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	540 local original_session = session_registry.get(session.username, id);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	541 if not original_session then
588 8042558336b6 mod_smacks: Log message when client tries to resume unknown session Matthew Wild <mwild1@gmail.com> parents: 587 diff changeset	542 session.log("debug", "Tried to resume non-existent session with id %s", id);
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	543 local old_session = old_session_registry.get(session.username, id);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	544 if old_session and session.username == old_session.username
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	545 and session.host == old_session.host
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	546 and old_session.h then
2937 e672d1050529 mod_smacks: Ensure stanza count attributes are always strings (thanks Martin) Matthew Wild <mwild1@gmail.com> parents: 2756 diff changeset	547 session.send(st.stanza("failed", { xmlns = xmlns_sm, h = string.format("%d", old_session.h) })
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	548 :tag("item-not-found", { xmlns = xmlns_errors })
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	549 );
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	550 else
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	551 session.send(st.stanza("failed", { xmlns = xmlns_sm })
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	552 :tag("item-not-found", { xmlns = xmlns_errors })
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	553 );
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	554 end;
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	555 elseif session.username == original_session.username
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	556 and session.host == original_session.host then
3218 67f1d1f22625 mod_smacks: Improve logging on resume so session changes are more easily tracked Matthew Wild <mwild1@gmail.com> parents: 3150 diff changeset	557 session.log("debug", "mod_smacks resuming existing session %s...", get_session_id(original_session));
3478 f6319346e2a3 mod_smacks: improved debug logging Georg Lukas <georg@op-co.de> parents: 3477 diff changeset	558 original_session.log("debug", "mod_smacks session resumed from %s...", get_session_id(session));
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	559 -- TODO: All this should move to sessionmanager (e.g. session:replace(new_session))
623 c1f3958695ea mod_smacks: If a resumed session still has a connection open, close that connection before resuming Matthew Wild <mwild1@gmail.com> parents: 622 diff changeset	560 if original_session.conn then
3218 67f1d1f22625 mod_smacks: Improve logging on resume so session changes are more easily tracked Matthew Wild <mwild1@gmail.com> parents: 3150 diff changeset	561 original_session.log("debug", "mod_smacks closing an old connection for this session");
623 c1f3958695ea mod_smacks: If a resumed session still has a connection open, close that connection before resuming Matthew Wild <mwild1@gmail.com> parents: 622 diff changeset	562 local conn = original_session.conn;
640 d87131b29bbd mod_smacks: Remove dependency on connlisteners (use sessions table shared by mod_c2s directly) Matthew Wild <mwild1@gmail.com> parents: 625 diff changeset	563 c2s_sessions[conn] = nil;
623 c1f3958695ea mod_smacks: If a resumed session still has a connection open, close that connection before resuming Matthew Wild <mwild1@gmail.com> parents: 622 diff changeset	564 conn:close();
c1f3958695ea mod_smacks: If a resumed session still has a connection open, close that connection before resuming Matthew Wild <mwild1@gmail.com> parents: 622 diff changeset	565 end
3935 c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	566 local migrated_session_log = session.log;
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	567 original_session.ip = session.ip;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	568 original_session.conn = session.conn;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	569 original_session.send = session.send;
2623 a65260300708 mod_smacks: Made module more error resistant tmolitor <thilo@eightysoft.de> parents: 2608 diff changeset	570 original_session.close = session.close;
1637 ad6694f7b13c mod_smacks: Don't restore filters from original session after resumption, use new filters Matthew Wild <mwild1@gmail.com> parents: 1599 diff changeset	571 original_session.filter = session.filter;
1706 e4867211cddb mod_smacks: Set session upvalue of filter() to correct session Kim Alvefur <zash@zash.se> parents: 1705 diff changeset	572 original_session.filter.session = original_session;
1705 6fa220a9f36d mod_smacks: Move set of filters from new session to session being resumed Kim Alvefur <zash@zash.se> parents: 1704 diff changeset	573 original_session.filters = session.filters;
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	574 original_session.stream = session.stream;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	575 original_session.secure = session.secure;
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	576 original_session.hibernating = nil;
3479 9ef309fb501d mod_smacks: apply resumed logger and type to new session, fix #1229 Georg Lukas <georg@op-co.de> parents: 3478 diff changeset	577 session.log = original_session.log;
9ef309fb501d mod_smacks: apply resumed logger and type to new session, fix #1229 Georg Lukas <georg@op-co.de> parents: 3478 diff changeset	578 session.type = original_session.type;
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	579 wrap_session(original_session, true);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	580 -- Inform xmppstream of the new session (passed to its callbacks)
1520 2881d532f385 mod_smacks: Use filters for queuing outgoing stanzas instead of wrapping session.send() Kim Alvefur <zash@zash.se> parents: 1518 diff changeset	581 original_session.stream:set_session(original_session);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	582 -- Similar for connlisteners
640 d87131b29bbd mod_smacks: Remove dependency on connlisteners (use sessions table shared by mod_c2s directly) Matthew Wild <mwild1@gmail.com> parents: 625 diff changeset	583 c2s_sessions[session.conn] = original_session;
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	584
2623 a65260300708 mod_smacks: Made module more error resistant tmolitor <thilo@eightysoft.de> parents: 2608 diff changeset	585 original_session.send(st.stanza("resumed", { xmlns = xmlns_sm,
2937 e672d1050529 mod_smacks: Ensure stanza count attributes are always strings (thanks Martin) Matthew Wild <mwild1@gmail.com> parents: 2756 diff changeset	586 h = string.format("%d", original_session.handled_stanza_count), previd = id }));
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	587
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	588 -- Fake an <a> with the h of the <resume/> from the client
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	589 original_session:dispatch_stanza(st.stanza("a", { xmlns = xmlns_sm,
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	590 h = stanza.attr.h }));
1343 7dbde05b48a9 all the things: Remove trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 1325 diff changeset	591
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	592 -- Ok, we need to re-send any stanzas that the client didn't see
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	593 -- ...they are what is now left in the outgoing stanza queue
3841 b5d367798570 Fix bug readding stanzas to outgoing_queue on resume tmolitor <thilo@eightysoft.de> parents: 3646 diff changeset	594 -- We have to use the send of "session" because we don't want to add our resent stanzas
b5d367798570 Fix bug readding stanzas to outgoing_queue on resume tmolitor <thilo@eightysoft.de> parents: 3646 diff changeset	595 -- to the outgoing queue again
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	596 local queue = original_session.outgoing_stanza_queue;
3841 b5d367798570 Fix bug readding stanzas to outgoing_queue on resume tmolitor <thilo@eightysoft.de> parents: 3646 diff changeset	597 session.log("debug", "resending all unacked stanzas that are still queued after resume, #queue = %d", #queue);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	598 for i=1,#queue do
3841 b5d367798570 Fix bug readding stanzas to outgoing_queue on resume tmolitor <thilo@eightysoft.de> parents: 3646 diff changeset	599 session.send(queue[i]);
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	600 end
3935 c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	601 session.log("debug", "all stanzas resent, now disabling send() in this migrated session, #queue = %d", #queue);
2623 a65260300708 mod_smacks: Made module more error resistant tmolitor <thilo@eightysoft.de> parents: 2608 diff changeset	602 function session.send(stanza)
3935 c49fea05772e mod_smacks: handle mam-enabled session internally tmolitor <thilo@eightysoft.de> parents: 3841 diff changeset	603 migrated_session_log("error", "Tried to send stanza on old session migrated by smacks resume (maybe there is a bug?): %s", tostring(stanza));
2623 a65260300708 mod_smacks: Made module more error resistant tmolitor <thilo@eightysoft.de> parents: 2608 diff changeset	604 return false;
a65260300708 mod_smacks: Made module more error resistant tmolitor <thilo@eightysoft.de> parents: 2608 diff changeset	605 end
2744 f70c02c14161 mod_smacks: Trigger event smacks-hibernation-end after queue resend tmolitor <thilo@eightysoft.de> parents: 2727 diff changeset	606 module:fire_event("smacks-hibernation-end", {origin = session, resumed = original_session, queue = queue});
3478 f6319346e2a3 mod_smacks: improved debug logging Georg Lukas <georg@op-co.de> parents: 3477 diff changeset	607 request_ack_if_needed(original_session, true, "handle_resume");
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	608 else
755 bab7c4ace803 mod_smacks: Fix log statement Kim Alvefur <zash@zash.se> parents: 754 diff changeset	609 module:log("warn", "Client %s@%s[%s] tried to resume stream for %s@%s[%s]",
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	610 session.username or "?", session.host or "?", session.type,
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	611 original_session.username or "?", original_session.host or "?", original_session.type);
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	612 session.send(st.stanza("failed", { xmlns = xmlns_sm })
345 445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	613 :tag("not-authorized", { xmlns = xmlns_errors }));
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	614 end
445178d15b51 mod_smacks: Merge mod_fastreconnect (resumption support), fix a number of bugs, refactor the code and add some more comments to explain process Matthew Wild <mwild1@gmail.com> parents: 263 diff changeset	615 return true;
1298 659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	616 end
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	617 module:hook_stanza(xmlns_sm2, "resume", function (session, stanza) return handle_resume(session, stanza, xmlns_sm2); end);
659da45a2b4b mod_smacks: Handle both version 2 and version 3 namespace Florian Zeitz <florob@babelmonkeys.de> parents: 1293 diff changeset	618 module:hook_stanza(xmlns_sm3, "resume", function (session, stanza) return handle_resume(session, stanza, xmlns_sm3); end);
1733 9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	619
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	620 local function handle_read_timeout(event)
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	621 local session = event.session;
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	622 if session.smacks then
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	623 if session.awaiting_ack then
2090 1796a022dd29 mod_smacks: Keep timer object around and stop it when needed (trunk only) Kim Alvefur <zash@zash.se> parents: 2089 diff changeset	624 if session.awaiting_ack_timer then
1796a022dd29 mod_smacks: Keep timer object around and stop it when needed (trunk only) Kim Alvefur <zash@zash.se> parents: 2089 diff changeset	625 session.awaiting_ack_timer:stop();
1796a022dd29 mod_smacks: Keep timer object around and stop it when needed (trunk only) Kim Alvefur <zash@zash.se> parents: 2089 diff changeset	626 end
2394 4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	627 if session.delayed_ack_timer then
4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	628 session.delayed_ack_timer:stop();
2494 d300ae5dba87 mod_smacks: Fix some bugs with smacks-ack-delayed event triggering. tmolitor <thilo@eightysoft.de> parents: 2491 diff changeset	629 session.delayed_ack_timer = nil;
2394 4c27ebcf4cbd mod_smacks: added new event "smacks-ack-delayed" used by mod_cloud_notify and extended the readme file accordingly (also mention mod_smacks_offline and mod_smacks_noerror in readme file) tmolitor <thilo@eightysoft.de> parents: 2251 diff changeset	630 end
1733 9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	631 return false; -- Kick the session
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	632 end
2091 ea95637cf041 mod_smacks: Log when sending <r> from read timeout event (0.10+) Kim Alvefur <zash@zash.se> parents: 2090 diff changeset	633 session.log("debug", "Sending <r> (read timeout)");
1733 9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	634 (session.sends2s or session.send)(st.stanza("r", { xmlns = session.smacks }));
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	635 session.awaiting_ack = true;
2596 ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	636 if not session.delayed_ack_timer then
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	637 session.delayed_ack_timer = stoppable_timer(delayed_ack_timeout, function()
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	638 delayed_ack_function(session);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	639 end);
ffb6646b4253 Implement XEP-0198 revision 1.5.2 and limit number of hibernated sessions per user tmolitor <thilo@eightysoft.de> parents: 2494 diff changeset	640 end
1733 9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	641 return true;
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	642 end
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	643 end
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	644
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	645 module:hook("s2s-read-timeout", handle_read_timeout);
9abd3dce619a mod_smacks: Handle the read timeout event (0.10+ only) and send an ack request, close the connection the second time if unanswerd Kim Alvefur <zash@zash.se> parents: 1732 diff changeset	646 module:hook("c2s-read-timeout", handle_read_timeout);

Mercurial > prosody-modules

annotate mod_smacks/mod_smacks.lua @ 3967:0957ba6aeb99