prosody
30a91d819913
plugins/mod_account_activity.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Annotate

plugins/mod_account_activity.lua @ 13665:30a91d819913 13.0

mod_account_activity: Record an account's last activity timestamp This is similar to mod_lastlog/mod_lastlog2. Some functionality was dropped, compared to mod_lastlog2. These features (recording the IP address, or tracking the timestamp of multiple events) are handled better by the mod_audit family of modules. For example, those correctly handle multiple logins, IP address truncation, and data retention policies. The "registered" timestamp from mod_lastlog2 was also dropped, as this has been stored in account_details by Prosody itself since at least 0.12 already.
author Matthew Wild <mwild1@gmail.com>
date Wed, 12 Feb 2025 12:33:45 +0000
child 13667:3052eae50c98
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13665
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 local jid = require "util.jid";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 local time = os.time;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 local store = module:open_store(nil, "keyval+");
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6 module:hook("authentication-success", function(event)
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 local session = event.session;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 if session.username then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9 store:set_key(session.username, "timestamp", time());
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 end);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 module:hook("resource-unbind", function(event)
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 local session = event.session;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15 if session.username then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 store:set_key(session.username, "timestamp", time());
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 end);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20 local user_sessions = prosody.hosts[module.host].sessions;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 function get_last_active(username) --luacheck: ignore 131/get_last_active
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22 if user_sessions[username] then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23 return os.time(), true; -- Currently connected
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 else
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25 local last_activity = store:get(username);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 if not last_activity then return nil; end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 return last_activity.timestamp;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
28 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 module:add_item("shell-command", {
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
32 section = "user";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
33 section_desc = "View user activity data";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
34 name = "activity";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
35 desc = "View the last recorded user activity for an account";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
36 args = { { name = "jid"; type = "string" } };
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
37 host_selector = "jid";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
38 handler = function(self, userjid) --luacheck: ignore 212/self
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
39 local username = jid.prepped_split(userjid);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
40 local last_timestamp, is_online = get_last_active(username);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
41 if not last_timestamp then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
42 return true, "No activity";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
43 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
44
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
45 return true, ("%s (%s)"):format(os.date("%Y-%m-%d %H:%M:%S", last_timestamp), (is_online and "online" or "offline"));
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
46 end;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
47 });
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
48
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
49 module:add_item("shell-command", {
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
50 section = "migrate";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
51 section_desc = "Perform data migrations";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
52 name = "account_activity_lastlog2";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
53 desc = "Migrate account activity information from mod_lastlog2";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
54 args = { { name = "host"; type = "string" } };
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
55 host_selector = "host";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
56 handler = function(self, host) --luacheck: ignore 212/host
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
57 local lastlog2 = module:open_store("lastlog2", "keyval+");
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
58 local n_updated, n_errors, n_skipped = 0, 0, 0;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
59
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
60 local async = require "util.async";
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
61
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
62 local p = require "util.promise".new(function (resolve)
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
63 local async_runner = async.runner(function ()
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
64 local n = 0;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
65 for username in lastlog2:items() do
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
66 n = n + 1;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
67 if n % 100 == 0 then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
68 self.session.print(("Processed %d..."):format(n));
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
69 async.sleep(0);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
70 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
71 local lastlog2_data = lastlog2:get(username);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
72 if lastlog2_data then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
73 local current_data, err = store:get(username);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
74 if not current_data then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
75 if not err then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
76 current_data = {};
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
77 else
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
78 n_errors = n_errors + 1;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
79 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
80 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
81 if current_data then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
82 local imported_timestamp = current_data.timestamp;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
83 local latest;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
84 for k, v in pairs(lastlog2_data) do
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
85 if k ~= "registered" and (not latest or v.timestamp > latest) then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
86 latest = v.timestamp;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
87 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
88 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
89 if latest and (not imported_timestamp or imported_timestamp < latest) then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
90 local ok, err = store:set_key(username, "timestamp", latest);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
91 if ok then
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
92 n_updated = n_updated + 1;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
93 else
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
94 self.session.print(("WW: Failed to import %q: %s"):format(username, err));
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
95 n_errors = n_errors + 1;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
96 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
97 else
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
98 n_skipped = n_skipped + 1;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
99 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
100 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
101 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
102 end
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
103 return resolve(("%d accounts imported, %d errors, %d skipped"):format(n_updated, n_errors, n_skipped));
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
104 end);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
105 async_runner:run(true);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
106 end);
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
107 return p;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
108 end;
30a91d819913 mod_account_activity: Record an account's last activity timestamp
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
109 });