Storage Module Update + Action History (.json use / no dependencies) #910

DukeOfCheese · 2025-04-15T09:46:28Z

Future Considerations:

Add support for the Discord.js bot to view action history

… dependencies using a .json file

…story display format

…o action history

…(BAN, KICK, WARN, UNBAN) across the action history

DukeOfCheese · 2025-04-15T09:46:49Z

Very open to suggestions / additions, somewhat in early stages

server/action_history.lua

client/gui_c.lua

server/action_history.lua

server/admin_server.lua

server/banlist.lua

…line ban event

…ntly, regardless of action history setting

…ved clarity and performance

DukeOfCheese · 2025-04-20T14:30:54Z

@Blumlaut Is this use of storage.lua more along the lines of what you were thinking?

…functions for improved organization

Blumlaut · 2025-04-22T10:45:43Z

@Blumlaut Is this use of storage.lua more along the lines of what you were thinking?

i'll have to review the code in detail when i have more time but glancing over it thats about what i was thinking of, i'm just wondering how to best make this work with plugins, i wonder if we should just let them overwrite the Storage entity, or do something else...

Edit: Maybe instead of letting them overwrite the storage entity introduce something like with plugins and have a storage backend convar that people can set, this would also allow us to merge additional storage backends without having to overwrite the default

DukeOfCheese · 2025-04-22T11:25:52Z

Would it be worth removing the custom banlist convar in favour of this updated storage system or should the function still check for it for backwards compatibility

Blumlaut · 2025-04-22T11:36:42Z

Would it be worth removing the custom banlist convar in favour of this updated storage system or should the function still check for it for backwards compatibility

Good question, it hasn't been officially supported (or documented..) for years now, i'm not sure if it works any more even.

I'd probably drop it altogether and force people to migrate to the new system.

…ction history management

…methods and action logging

DukeOfCheese · 2025-04-23T00:22:27Z

Ban system completely overhauled with new system, commented at points throughout banlist.lua just to make my ideas clear. At the moment, no old code is deleted, rather commented out to ensure nothing is missed.

Small thing with this storage module, the performBanlistUpgrades() might not work as expected, I'll have to try it out once I get back to my PC

Copilot

Pull Request Overview

This pull request introduces a comprehensive action history tracking system for EasyAdmin that stores moderation actions (warns, kicks, bans, offline bans) in JSON files without external dependencies. The system integrates with existing EasyAdmin events and provides a GUI for viewing and managing action history.

Key Changes:

New storage module (storage.lua) with a unified API for managing banlists and action history using versioned JSON files
Action history tracking system with Discord ID-based user identification, automatic 30-day expiry, and webhook logging
Client GUI enhancements to view, delete, and unban from action history with permission controls

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 21 comments.

Show a summary per file

File	Description
server/storage.lua	New unified storage module providing API functions for banlist and action history management with versioned JSON file format
server/action_history.lua	New action history system with server events for viewing, logging, and deleting moderation actions
server/banlist.lua	Refactored to use new Storage API instead of direct file operations, with action history integration
server/admin_server.lua	Added action history logging for kicks and warns, integrated with existing moderation events
client/gui_c.lua	Added action history submenu with view, delete, and unban functionality in the player menu
shared/util_shared.lua	Added three new permissions for action history: view, add, and delete
fxmanifest.lua	Added storage.lua to server scripts and two new convars for action history configuration
language/*.json	Added localization strings for action history UI elements across 7 languages

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

server/action_history.lua

Copilot · 2025-11-16T14:13:58Z

server/banlist.lua

-        end
-    end
-    return identifierfound
+    return Storage.getBanIdentifier(theIdentifier)


The IsIdentifierBanned function calls Storage.getBanIdentifier(theIdentifier) which expects an array of identifiers (see storage.lua line 64-75 where it loops over identifiers), but passes a single string identifier instead. This will cause the function to fail. Wrap the identifier in a table: Storage.getBanIdentifier({theIdentifier}).

Suggested change

return Storage.getBanIdentifier(theIdentifier)

return Storage.getBanIdentifier({theIdentifier})

This function returns a boolean. Don't think this is necessary

server/storage.lua

Copilot · 2025-11-16T14:13:59Z

server/storage.lua

+                    PrintDebugMessage("banlist.json file was missing, we created a new one.", 2)
+                    content = json.encode({})
+                end
+                local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode(banlist, {indent = true}), -1)


The removeBan function saves the banlist incorrectly. It should save a structured object with version and data fields (consistent with LoadList), but it's only saving the array directly.

Change line 125 to:

local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode({version = currentVersion, data = banlist}, {indent = true}), -1)

Suggested change

local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode(banlist, {indent = true}), -1)

local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode({version = currentVersion, data = banlist}, {indent = true}), -1)

Banlist is set as a variable at the top of the file and does not need to be edited here

Copilot · 2025-11-16T14:13:59Z

server/storage.lua

+            PrintDebugMessage("actions.json file was missing, we created a new one.", 2)
+            content = json.encode({})
+        end
+        local saved = SaveResourceFile(GetCurrentResourceName(), "actions.json", json.encode(actions, {indent = true}), -1)


The addAction function saves the actions incorrectly. It should save a structured object with version and data fields (consistent with LoadList), but it's only saving the array directly.

Change line 184 to:

local saved = SaveResourceFile(GetCurrentResourceName(), "actions.json", json.encode({version = currentVersion, data = actions}, {indent = true}), -1)

Suggested change

local saved = SaveResourceFile(GetCurrentResourceName(), "actions.json", json.encode(actions, {indent = true}), -1)

local saved = SaveResourceFile(GetCurrentResourceName(), "actions.json", json.encode({version = currentVersion, data = actions}, {indent = true}), -1)

Same as above

server/storage.lua

Copilot · 2025-11-16T14:14:03Z

server/banlist.lua

+    -- local ban = {banid = GetFreshBanId(), name = bannedUsername,identifiers = bannedIdentifiers,  banner = banner or "Unknown", reason = reason, expire = expires, expireString = formatDateString(expires) }
+    -- updateBlacklist( ban )
+    Storage.addBan(GetFreshBanId(), bannedUsername, bannedIdentifiers, banner or "Unknown", reason, expires, formatDateString(expires), "BAN", os.time())
+    Storage.addAction("BAN", bannedIdentifiers[1], reason, banner or "Unknown", source, expires, formatDateString(expires))


The function signature for Storage.addAction expects 5 required parameters (type, identifier, reason, moderator_name, moderator_identifier), but this call passes 7 arguments including expires and formatDateString(expires). These extra parameters don't match the function definition in storage.lua line 169 and will be ignored or cause unexpected behavior.

Suggested change

Storage.addAction("BAN", bannedIdentifiers[1], reason, banner or "Unknown", source, expires, formatDateString(expires))

Storage.addAction("BAN", bannedIdentifiers[1], reason, banner or "Unknown", source)

Will take a look

Copilot · 2025-11-16T14:14:03Z

client/gui_c.lua

+						RegisterNetEvent("EasyAdmin:ReceiveActionHistory")
+						AddEventHandler("EasyAdmin:ReceiveActionHistory", function(actionHistory)
+							actionHistoryMenu:Clear()
+							if #actionHistory == 0 then
+								local noActionsItem = NativeUI.CreateItem(GetLocalisedText("noactions"), GetLocalisedText("noactionsguide"))
+								actionHistoryMenu:AddItem(noActionsItem)
+							end
+							for i, action in ipairs(actionHistory) do
+								local actionSubmenu = _menuPool:AddSubMenu(actionHistoryMenu, "[#"..action.id.."] " .. action.action .. " by " .. action.moderator, GetLocalisedText("reason") .. ": " ..  action.reason or "", true)
+								actionSubmenu:SetMenuWidthOffset(menuWidth)
+								if action.action == "BAN" and permissions["player.ban.remove"] then
+									local actionUnban = NativeUI.CreateItem(GetLocalisedText("unbanplayer"), GetLocalisedText("unbanplayerguide"))
+									actionUnban.Activated = function(ParentMenu, SelectedItem)
+										TriggerServerEvent("EasyAdmin:UnbanPlayer", action.id)
+										TriggerEvent("EasyAdmin:showNotification", GetLocalisedText("unbanplayer"))
+										TriggerServerEvent("EasyAdmin:GetActionHistory", thePlayer.discord)
+										ParentMenu:Visible(false)
+										ParentMenu.ParentMenu:Visible(true)
+									end
+									actionSubmenu:AddItem(actionUnban)
+								end
+								if permissions["player.actionhistory.delete"] then
+									local actionDelete = NativeUI.CreateItem(GetLocalisedText("deleteaction"), GetLocalisedText("deleteactionguide"))
+									actionDelete.Activated = function(ParentMenu, SelectedItem)
+										TriggerServerEvent("EasyAdmin:DeleteAction", action.id)
+										TriggerEvent("EasyAdmin:showNotification", GetLocalisedText("actiondeleted"))
+										TriggerServerEvent("EasyAdmin:GetActionHistory", thePlayer.discord)
+										ParentMenu:Visible(false)
+										ParentMenu.ParentMenu:Visible(true)
+									end
+									actionSubmenu:AddItem(actionDelete)
+								end
+								local punishedDiscord = NativeUI.CreateItem(GetLocalisedText("getplayerdiscord"), GetLocalisedText("getplayerdiscordguide"))
+								punishedDiscord.Activated = function(ParentMenu, SelectedItem)
+									if action.discord then
+										copyToClipboard(action.discord)
+									else
+										TriggerEvent("EasyAdmin:showNotification", GetLocalisedText("nodiscordpresent"))
+									end
+								end
+								actionSubmenu:AddItem(punishedDiscord)
+								local moderatorDiscord = NativeUI.CreateItem(GetLocalisedText("getmoderatordiscord"), GetLocalisedText("getmoderatordiscordguide"))
+								moderatorDiscord.Activated = function(ParentMenu, SelectedItem)
+									if action.moderatorId then
+										copyToClipboard(action.moderatorId)
+									else
+										TriggerEvent("EasyAdmin:showNotification", GetLocalisedText("nodiscordpresent"))
+									end
+								end
+								actionSubmenu:AddItem(moderatorDiscord)
+								actionSubmenu:RefreshIndex()
+							end
+						end)


The event handler for EasyAdmin:ReceiveActionHistory is registered inside the menu generation loop, which means it will be registered multiple times if the menu is regenerated or if there are multiple players. This creates duplicate handlers that will all execute, causing the action history menu to be populated multiple times. Register the event handler once outside the menu generation function or use a unique handler registration pattern.

I want it to refire everytime you open menu in case new actions come through so I believe this is intended

This is TECHNICALLY correct, but the menu is cleared before

Copilot · 2025-11-16T14:14:03Z

server/storage.lua

+                bans = {}
+            })
+        end
+        local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode(banlist, {indent = true}), -1)


The addBan function saves the banlist incorrectly. It should save a structured object with version and data fields (as loaded by LoadList), but it's only saving the array directly. This breaks consistency with the file format.

Change line 97 to:

local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode({version = currentVersion, data = banlist}, {indent = true}), -1)

Suggested change

local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode(banlist, {indent = true}), -1)

local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode({version = currentVersion, data = banlist}, {indent = true}), -1)

Same as above

server/banlist.lua

language/de.json

server/action_history.lua

server/banlist.lua

Co-authored-by: blumlaut <[email protected]>

…gui_c.lua banlist menu item)

…ove expired actions

…ge file

…ately

Co-authored-by: Copilot <[email protected]>

DukeOfCheese · 2025-11-19T06:38:02Z

I've also gone through all of Copilot's suggestions, some of it was beneficial, the unresolved ones are ones I'm not 100% sure about whether it would impact

Blumlaut · 2025-11-19T11:06:13Z

server/storage.lua


 local function LoadList(fileName)
    local content = LoadResourceFile(GetCurrentResourceName(), fileName .. ".json")
+    local currentVersion = GetConvar("$ea_storageAPIVersion", 1)


this is not quite what i meant.

I was more thinking of
https://docs.fivem.net/natives/?_0x964BAB1D

see:

EasyAdmin/shared/util_shared.lua

Lines 195 to 198 in b81a223

function GetVersion()

local resourceName = GetCurrentResourceName()

local version = GetResourceMetadata(resourceName, 'version', 0)

local is_master = GetResourceMetadata(resourceName, 'is_master', 0) == "yes" or false

DukeOfCheese added 5 commits April 13, 2025 23:45

Adds a moderation action history into the player submenus without any…

035d8af

… dependencies using a .json file

Refactor action deletion logic to use action ID and improve action hi…

aa3e543

…story display format

Enhance action logging by adding detailed ban and unban information t…

5013313

…o action history

Normalize action names in logging: use consistent casing for actions …

3305aaf

…(BAN, KICK, WARN, UNBAN) across the action history

Add unban option to action history for banned players

0c02a69

Blumlaut reviewed Apr 15, 2025

View reviewed changes

DukeOfCheese marked this pull request as draft April 15, 2025 11:15

DukeOfCheese added 8 commits April 15, 2025 21:19

Implement ban storage functionality and integrate ban addition in off…

4fb2aaf

…line ban event

Merge branch 'master' of https://github.com/DukeOfCheese/EasyAdmin

6b5e511

Update loading item text in action history menu for better localization

d1481ec

Refactor action logging to ensure action history is recorded consiste…

3680508

…ntly, regardless of action history setting

Update English localization for improved clarity and consistency

76355de

Merge branch 'Blumlaut:master' into master

ed5b1eb

feat(storage): implement banlist and actions management functions

989b2c7

feat(storage): refactor ban and action management functions for impro…

73e1691

…ved clarity and performance

DukeOfCheese mentioned this pull request Apr 21, 2025

Add Notes command and notes to admin menu #387

Open

feat(storage): refactor action history management to utilize storage …

0156946

…functions for improved organization

DukeOfCheese added 6 commits April 23, 2025 00:03

Merge branch 'Blumlaut:master' into master

0abecb4

feat(storage): add action logging functionality and permissions for a…

8b0d481

…ction history management

Merge branch 'master' of https://github.com/DukeOfCheese/EasyAdmin

4560358

fix(warnPlayer): correct permission check logic for warning players

cd5ff0a

feat(action-logging): implement action logging for moderation events

74645cd

feat(storage): enhance storage functionality with new ban management …

df983c8

…methods and action logging

DukeOfCheese changed the title ~~Action History (.json use / no dependencies)~~ Storage Module Update + Action History (.json use / no dependencies) Apr 23, 2025

Blumlaut requested a review from Copilot November 16, 2025 14:09

Copilot started reviewing on behalf of Blumlaut November 16, 2025 14:09 View session

Copilot finished reviewing on behalf of Blumlaut November 16, 2025 14:11

Copilot AI reviewed Nov 16, 2025

View reviewed changes

Blumlaut requested changes Nov 16, 2025

View reviewed changes

DukeOfCheese and others added 22 commits November 18, 2025 12:27

Update de.json

ec876de

Co-authored-by: blumlaut <[email protected]>

Update de.json

d98157a

Co-authored-by: blumlaut <[email protected]>

Update server/action_history.lua

1925abf

Co-authored-by: blumlaut <[email protected]>

Update server/banlist.lua

bd3ce68

Co-authored-by: blumlaut <[email protected]>

(fix): Translations

d7ad37c

(fix): Process convars during runtime

7045a68

(fix): Removing dead code

beb2bbf

Merge branch 'master' of https://github.com/DukeOfCheese/EasyAdmin

8773696

(remove): Comment regarding refreshing ban list (still required from …

e174d15

…gui_c.lua banlist menu item)

(add): Debug message for clearing expired actions

fc405a8

(remove): Unused variable

dda8022

(fix): Removing dead code

262fac2

(edit): Moved Storage API Version number to a convar

240323e

(fix): Runtime issue with populating actionsjson before trying to rem…

2512597

…ove expired actions

(fix): Moved action_history storage management to the dedicated stora…

0e32c0e

…ge file

(fix): Action being sent to Storage module was erroneous

0bfce68

(fix): Fix removeBan function to not return false if not found immedi…

8362789

…ately

(fix): Malformed table creation for logging action

729a83f

(fix): Action remove ban has ban ID

98da3ac

Update server/storage.lua

cff08b8

Co-authored-by: Copilot <[email protected]>

Update server/storage.lua

679d838

Co-authored-by: Copilot <[email protected]>

(remove): Comments

342e287

Blumlaut requested changes Nov 19, 2025

View reviewed changes

github-actions bot added the Stale label Dec 8, 2025

	return Storage.getBanIdentifier(theIdentifier)
	return Storage.getBanIdentifier({theIdentifier})

	local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode(banlist, {indent = true}), -1)
	local saved = SaveResourceFile(GetCurrentResourceName(), "banlist.json", json.encode({version = currentVersion, data = banlist}, {indent = true}), -1)

	Storage.addAction("BAN", bannedIdentifiers[1], reason, banner or "Unknown", source, expires, formatDateString(expires))
	Storage.addAction("BAN", bannedIdentifiers[1], reason, banner or "Unknown", source)

	function GetVersion()
	local resourceName = GetCurrentResourceName()
	local version = GetResourceMetadata(resourceName, 'version', 0)
	local is_master = GetResourceMetadata(resourceName, 'is_master', 0) == "yes" or false

Storage Module Update + Action History (.json use / no dependencies) #910

Are you sure you want to change the base?

Storage Module Update + Action History (.json use / no dependencies) #910

Uh oh!

Conversation

DukeOfCheese commented Apr 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DukeOfCheese commented Apr 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DukeOfCheese commented Apr 20, 2025

Uh oh!

Blumlaut commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DukeOfCheese commented Apr 22, 2025

Uh oh!

Blumlaut commented Apr 22, 2025

Uh oh!

DukeOfCheese commented Apr 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

DukeOfCheese Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

DukeOfCheese Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

DukeOfCheese Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

DukeOfCheese Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

DukeOfCheese Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

DukeOfCheese Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

DukeOfCheese Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DukeOfCheese commented Apr 15, 2025 •

edited

Loading

Blumlaut commented Apr 22, 2025 •

edited

Loading

Blumlaut Nov 19, 2025 •

edited

Loading