prosody-modules: mod_csi_battery_saver/mod_csi_battery

annotate mod_csi_battery_saver/mod_csi_battery_saver.lua @ 2745:b62cec32680e

mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating This needs a mod_smacks version at least as new as of commit f70c02c14161 otherwise message reordering could happen

author	tmolitor <thilo@eightysoft.de>
date	Fri, 18 Aug 2017 01:49:16 +0200
parents	2e30bb3a10d5
children	d3a2f4bdaf09

rev	line source
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	1 -- Copyright (C) 2016 Kim Alvefur
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	2 -- Copyright (C) 2017 Thilo Molitor
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	3 --
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	4
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	5 module:depends"csi"
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	6 module:depends"track_muc_joins"
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	7 local s_match = string.match;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	8 local s_sub = string.sub;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	9 local jid = require "util.jid";
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	10 local new_queue = require "util.queue".new;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	11 local datetime = require "util.datetime";
2741 69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	12 local st = require "util.stanza";
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	13
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	14 local xmlns_delay = "urn:xmpp:delay";
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	15
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	16 -- a log id for this module instance
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	17 local id = s_sub(require "util.hashes".sha256(datetime.datetime(), true), 1, 4);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	18
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	19 -- Patched version of util.stanza:find() that supports giving stanza names
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	20 -- without their namespace, allowing for every namespace.
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	21 local function find(self, path)
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	22 local pos = 1;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	23 local len = #path + 1;
2735 b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	24
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	25 repeat
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	26 local xmlns, name, text;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	27 local char = s_sub(path, pos, pos);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	28 if char == "@" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	29 return self.attr[s_sub(path, pos + 1)];
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	30 elseif char == "{" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	31 xmlns, pos = s_match(path, "^([^}]+)}()", pos + 1);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	32 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	33 name, text, pos = s_match(path, "^([^@/#]*)([/#]?)()", pos);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	34 name = name ~= "" and name or nil;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	35 if pos == len then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	36 if text == "#" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	37 local child = xmlns ~= nil and self:get_child(name, xmlns) or self:child_with_name(name);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	38 return child and child:get_text() or nil;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	39 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	40 return xmlns ~= nil and self:get_child(name, xmlns) or self:child_with_name(name);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	41 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	42 self = xmlns ~= nil and self:get_child(name, xmlns) or self:child_with_name(name);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	43 until not self
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	44 return nil;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	45 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	46
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	47 local function new_pump(output, ...)
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	48 -- luacheck: ignore 212/self
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	49 local q = new_queue(...);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	50 local flush = true;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	51 function q:pause()
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	52 flush = false;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	53 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	54 function q:resume()
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	55 flush = true;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	56 return q:flush();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	57 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	58 local push = q.push;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	59 function q:push(item)
2741 69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	60 local ok = push(self, item);
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	61 if not ok then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	62 q:flush();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	63 output(item, self);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	64 elseif flush then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	65 return q:flush();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	66 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	67 return true;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	68 end
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	69 function q:flush(alternative_output)
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	70 local out = alternative_output or output;
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	71 local item = self:pop();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	72 while item do
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	73 out(item, self);
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	74 item = self:pop();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	75 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	76 return true;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	77 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	78 return q;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	79 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	80
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	81 local function is_stamp_needed(stanza, session)
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	82 local st_name = stanza and stanza.name or nil;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	83 if st_name == "presence" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	84 return true;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	85 elseif st_name == "message" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	86 if stanza:get_child("delay", xmlns_delay) then return false; end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	87 if stanza.attr.type == "chat" or stanza.attr.type == "groupchat" then return true; end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	88 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	89 return false;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	90 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	91
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	92 local function add_stamp(stanza, session)
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	93 stanza = stanza:tag("delay", { xmlns = xmlns_delay, from = session.host, stamp = datetime.datetime()});
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	94 return stanza;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	95 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	96
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	97 local function is_important(stanza, session)
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	98 local st_name = stanza and stanza.name or nil;
2741 69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	99 if not st_name then return true; end -- nonzas are always important
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	100 if st_name == "presence" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	101 -- TODO check for MUC status codes?
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	102 return false;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	103 elseif st_name == "message" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	104 -- unpack carbon copies
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	105 local stanza_direction = "in";
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	106 local carbon;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	107 -- support carbon copied message stanzas having an arbitrary message-namespace or no message-namespace at all
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	108 if not carbon then carbon = find(stanza, "{urn:xmpp:carbons:2}/forwarded/message"); end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	109 if not carbon then carbon = find(stanza, "{urn:xmpp:carbons:1}/forwarded/message"); end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	110 stanza_direction = carbon and stanza:child_with_name("sent") and "out" or "in";
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	111 --session.log("debug", "mod_csi_battery_saver(%s): stanza_direction = %s, carbon = %s, stanza = %s", id, stanza_direction, carbon and "true" or "false", tostring(stanza));
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	112 if carbon then stanza = carbon; end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	113 -- carbon copied outgoing messages aren't important (but incoming carbon copies are!)
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	114 if carbon and stanza_direction == "out" then return false; end
2735 b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	115
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	116 local st_type = stanza.attr.type;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	117 if st_type == "headline" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	118 return false;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	119 end
2735 b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	120
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	121 -- We can't check for nick in encrypted groupchat messages, so let's treat them as important
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	122 -- Some clients don't set a body or an empty body for encrypted messages
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	123
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	124 -- check omemo https://xmpp.org/extensions/inbox/omemo.html
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	125 if stanza:get_child("encrypted", "eu.siacs.conversations.axolotl") or stanza:get_child("encrypted", "urn:xmpp:omemo:0") then return true; end
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	126
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	127 -- check xep27 pgp https://xmpp.org/extensions/xep-0027.html
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	128 if stanza:get_child("x", "jabber:x:encrypted") then return true; end
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	129
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	130 -- check xep373 pgp (OX) https://xmpp.org/extensions/xep-0373.html
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	131 if stanza:get_child("openpgp", "urn:xmpp:openpgp:0") then return true; end
b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	132
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	133 local body = stanza:get_child_text("body");
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	134 if st_type == "groupchat" then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	135 if stanza:get_child_text("subject") then return true; end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	136 if not body then return false; end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	137 if body:find(session.username, 1, true) then return true; end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	138 local rooms = session.rooms_joined;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	139 if not rooms then return false; end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	140 local room_nick = rooms[jid.bare(stanza_direction == "in" and stanza.attr.from or stanza.attr.to)];
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	141 if room_nick and body:find(room_nick, 1, true) then return true; end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	142 return false;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	143 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	144 return body ~= nil and body ~= "";
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	145 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	146 return true;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	147 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	148
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	149 module:hook("csi-client-inactive", function (event)
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	150 local session = event.origin;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	151 if session.pump then
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	152 session.log("debug", "mod_csi_battery_saver(%s): Client is inactive, buffering unimportant outgoing stanzas", id);
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	153 session.pump:pause();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	154 else
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	155 session.log("debug", "mod_csi_battery_saver(%s): Client is inactive the first time, initializing module for this session", id);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	156 local pump = new_pump(session.send, 100);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	157 pump:pause();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	158 session.pump = pump;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	159 session._pump_orig_send = session.send;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	160 function session.send(stanza)
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	161 session.log("debug", "mod_csi_battery_saver(%s): Got outgoing stanza: <%s>", id, tostring(stanza.name or stanza));
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	162 local important = is_important(stanza, session);
2742 2e30bb3a10d5 mod_csi_battery_saver: Fix a bug introduced by commit f43c77c69a8a tmolitor <thilo@eightysoft.de> parents: 2741 diff changeset	163 -- clone stanzas before adding delay stamp and putting them into the queue
2e30bb3a10d5 mod_csi_battery_saver: Fix a bug introduced by commit f43c77c69a8a tmolitor <thilo@eightysoft.de> parents: 2741 diff changeset	164 if st.is_stanza(stanza) then stanza = st.clone(stanza); end
2735 b5fae17e4403 mod_csi_battery_saver: correctly handle encrypted message stanzas tmolitor <thilo@eightysoft.de> parents: 2606 diff changeset	165 -- add delay stamp to unimportant (buffered) stanzas that can/need be stamped
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	166 if not important and is_stamp_needed(stanza, session) then stanza = add_stamp(stanza, session); end
2742 2e30bb3a10d5 mod_csi_battery_saver: Fix a bug introduced by commit f43c77c69a8a tmolitor <thilo@eightysoft.de> parents: 2741 diff changeset	167 -- add stanza to outgoing queue and flush the buffer if needed
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	168 pump:push(stanza);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	169 if important then
2741 69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	170 session.log("debug", "mod_csi_battery_saver(%s): Encountered important stanza, flushing buffer: <%s>", id, tostring(stanza.name or stanza));
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	171 pump:flush();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	172 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	173 return true;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	174 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	175 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	176 end);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	177
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	178 module:hook("csi-client-active", function (event)
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	179 local session = event.origin;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	180 if session.pump then
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	181 session.log("debug", "mod_csi_battery_saver(%s): Client is active, resuming direct delivery", id);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	182 session.pump:resume();
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	183 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	184 end);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	185
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	186 -- clean up this session on hibernation start
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	187 module:hook("smacks-hibernation-start", function (event)
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	188 local session = event.origin;
2741 69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	189 if session.pump then
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	190 session.log("debug", "mod_csi_battery_saver(%s): Hibernation started, flushing buffer and afterwards disabling for this session", id);
2741 69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	191 session.pump:flush();
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	192 session.send = session._pump_orig_send;
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	193 session.pump = nil;
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	194 session._pump_orig_send = nil;
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	195 end
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	196 end);
2741 69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	197
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	198 -- clean up this session on hibernation end as well
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	199 -- but don't change resumed.send(), it is already overwritten with session.send() by the smacks module
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	200 module:hook("smacks-hibernation-end", function (event)
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	201 local session = event.resumed;
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	202 if session.pump then
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	203 session.log("debug", "mod_csi_battery_saver(%s): Hibernation ended without being started, flushing buffer and afterwards disabling for this session", id);
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	204 session.pump:flush(session.send); -- use the fresh session.send() introduced by the smacks resume
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	205 -- don't reset session.send() because this is not the send previously overwritten by this module, but a fresh one
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	206 -- session.send = session._pump_orig_send;
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	207 session.pump = nil;
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	208 session._pump_orig_send = nil;
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	209 end
2741 69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	210 end);
69248dcd7cff mod_csi_battery_saver: Fix interaction with smacks hibernation tmolitor <thilo@eightysoft.de> parents: 2737 diff changeset	211
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	212 function module.unload()
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	213 module:log("info", "%s: Unloading module, flushing all buffers", id);
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	214 local host_sessions = prosody.hosts[module.host].sessions;
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	215 for _, user in pairs(host_sessions) do
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	216 for _, session in pairs(user.sessions) do
2745 b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	217 if session.pump then
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	218 session.log("debug", "mod_csi_battery_saver(%s): Flushing buffer and restoring to original session.send()", id);
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	219 session.pump:flush();
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	220 session.send = session._pump_orig_send;
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	221 session.pump = nil;
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	222 session._pump_orig_send = nil;
b62cec32680e mod_csi_battery_saver: Fix bug when smacks is resumed before hibernating tmolitor <thilo@eightysoft.de> parents: 2742 diff changeset	223 end
2606 538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	224 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	225 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	226 end
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	227
538c54d2dab3 mod_csi_battery_saver: CSI module to save battery on mobile devices, based on mod_csi_pump tmolitor <thilo@eightysoft.de> parents: diff changeset	228 module:log("info", "%s: Successfully loaded module", id);

Mercurial > prosody-modules

annotate mod_csi_battery_saver/mod_csi_battery_saver.lua @ 2745:b62cec32680e