annotate mod_firewall/marks.lib.lua @ 6549:d2e50b587721

mod_firewall: marks: switch to keyval+ store API
author Matthew Wild <mwild1@gmail.com>
date Sun, 24 May 2026 10:49:09 +0100
parents 430584888704
children f9d93d7cd6d5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6549
d2e50b587721 mod_firewall: marks: switch to keyval+ store API
Matthew Wild <mwild1@gmail.com>
parents: 6548
diff changeset
1 local mark_storage = module:open_store("firewall_marks", "keyval+");
2894
165d2877eeac mod_firewall: Add experimental user-centric persistent marks behind a feature flag
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
165d2877eeac mod_firewall: Add experimental user-centric persistent marks behind a feature flag
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 local user_sessions = prosody.hosts[module.host].sessions;
165d2877eeac mod_firewall: Add experimental user-centric persistent marks behind a feature flag
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
6548
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
5 module:hook("resource-bind", function (event)
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
6 local session = event.session;
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
7 local username = session.username;
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
8 local user = user_sessions[username];
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
9 local marks = user.firewall_marks;
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
10 if not marks then
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
11 marks = mark_storage:get(username) or {};
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
12 user.firewall_marks = marks; -- luacheck: ignore 122
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
13 end
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
14 session.firewall_marks = marks;
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
15 end);
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
16
430584888704 mod_firewall: marks: load marks from storage on login
Matthew Wild <mwild1@gmail.com>
parents: 5542
diff changeset
17
5536
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
18 module:hook("firewall/marked/user", function (event)
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
19 local user = user_sessions[event.username];
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
20 local marks = user and user.firewall_marks;
5541
3804ee5117ca mod_firewall: Load marks from storage on demand rather than at login
Matthew Wild <mwild1@gmail.com>
parents: 5536
diff changeset
21 if user and not marks then
3804ee5117ca mod_firewall: Load marks from storage on demand rather than at login
Matthew Wild <mwild1@gmail.com>
parents: 5536
diff changeset
22 -- Load marks from storage to cache on the user object
3804ee5117ca mod_firewall: Load marks from storage on demand rather than at login
Matthew Wild <mwild1@gmail.com>
parents: 5536
diff changeset
23 marks = mark_storage:get(event.username) or {};
3804ee5117ca mod_firewall: Load marks from storage on demand rather than at login
Matthew Wild <mwild1@gmail.com>
parents: 5536
diff changeset
24 user.firewall_marks = marks; --luacheck: ignore 122
3804ee5117ca mod_firewall: Load marks from storage on demand rather than at login
Matthew Wild <mwild1@gmail.com>
parents: 5536
diff changeset
25 end
5536
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
26 if marks then
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
27 marks[event.mark] = event.timestamp;
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
28 end
6549
d2e50b587721 mod_firewall: marks: switch to keyval+ store API
Matthew Wild <mwild1@gmail.com>
parents: 6548
diff changeset
29 local ok, err = mark_storage:set_key(event.username, event.mark, event.timestamp);
5536
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
30 if not ok then
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
31 module:log("error", "Failed to mark user %q with %q: %s", event.username, event.mark, err);
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
32 end
5542
048284447643 mod_firewall: Add console commands to mark/unmark users
Matthew Wild <mwild1@gmail.com>
parents: 5541
diff changeset
33 return true;
048284447643 mod_firewall: Add console commands to mark/unmark users
Matthew Wild <mwild1@gmail.com>
parents: 5541
diff changeset
34 end, -1);
2894
165d2877eeac mod_firewall: Add experimental user-centric persistent marks behind a feature flag
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35
5536
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
36 module:hook("firewall/unmarked/user", function (event)
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
37 local user = user_sessions[event.username];
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
38 local marks = user and user.firewall_marks;
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
39 if marks then
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
40 marks[event.mark] = nil;
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
41 end
6549
d2e50b587721 mod_firewall: marks: switch to keyval+ store API
Matthew Wild <mwild1@gmail.com>
parents: 6548
diff changeset
42 local ok, err = mark_storage:set_key(event.username, event.mark, nil);
5536
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
43 if not ok then
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
44 module:log("error", "Failed to unmark user %q with %q: %s", event.username, event.mark, err);
96dec7681af8 mod_firewall: Update user marks to store instantly via map store
Matthew Wild <mwild1@gmail.com>
parents: 2894
diff changeset
45 end
5542
048284447643 mod_firewall: Add console commands to mark/unmark users
Matthew Wild <mwild1@gmail.com>
parents: 5541
diff changeset
46 return true;
048284447643 mod_firewall: Add console commands to mark/unmark users
Matthew Wild <mwild1@gmail.com>
parents: 5541
diff changeset
47 end, -1);