Add the exp_reports plugin and move the scenario onto it

Reports were the last legacy control module, kept in the lua state of
each instance. They are now an exp_reports plugin which stores them on
the controller: a report is immutable and holds the reported player, who
made it, the reason, the instance name and when it was made, and the only
operations are get, list, create and delete.

In game nothing is stored. The lua module sends each request over ipc,
the instance plugin asks the controller and hands the answer back with
rcon, and the module prints it to whoever asked if they are still online.
Answers are dropped if the instance stopped meanwhile. The module raises
on_player_reported with the count and reporters of every report against
the player, which report_jail and discord_alerts use, and the commands
and player list button call into it.

The web ui gets a /reports page: a table with search on the player,
reporter and reason, a filter on the instance, delete per row and a
create form which reports in the name of the web user.

New reports are posted to two optional webhooks configured on the
controller, a Discord channel hook as an embed and a generic JSON hook.
Failures are logged rather than failing the report.

Tests cover the messages, the controller against a real Controller, the
instance plugin against a real Instance, and the lua module through the
shared harness.
This commit is contained in:
bbassie committed 2026-09-06 16:44:23 +00:00
1 parent 142d296a02
commit bad98c5013
35 files changed
+1707 -350

No files matched your search

+7 -55
View File
@@ -3,13 +3,12 @@ Adds a commands that allow players to report other players
]]
local Commands = require("modules/exp_commands")
local format_player_name = Commands.format_player_name_locale
local parse_input = Commands.parse_input
local Roles = require("modules/exp_roles")
local player_has_permission = Roles.player_has_permission
local Reports = require("modules.exp_legacy.modules.control.reports") --- @dep modules.control.reports
local Reports = require("modules/exp_reports")
--- @param input string
--- @param player LuaPlayer
@@ -29,7 +28,7 @@ local function reportable_player(input, player)
end
end
--- Reports a player and notifies admins
--- Reports a player and notifies admins, the outcome is printed once the controller answers
Commands.new("create-report", { "exp-commands_reports.description-create" })
:argument("player", { "exp-commands_reports.arg-player-create" }, reportable_player)
:argument("reason", { "exp-commands_reports.arg-reason" }, Commands.types.string)
@@ -38,50 +37,20 @@ Commands.new("create-report", { "exp-commands_reports.description-create" })
:register(function(player, other_player, reason)
--- @cast other_player LuaPlayer
--- @cast reason string
local player_name = format_player_name(player)
local other_player_name = format_player_name(other_player)
if Reports.report_player(other_player, player.name, reason) then
local user_message = { "exp-commands_reports.response", other_player_name, reason }
local admin_message = { "exp-commands_reports.response-admin", other_player_name, player_name, reason }
for _, connected_player in ipairs(game.connected_players) do
if connected_player.admin then
connected_player.print(admin_message)
else
connected_player.print(user_message)
end
end
else
return Commands.status.invalid_input{ "exp-commands_reports.already-reported" }
end
Reports.create_report(player, other_player, reason)
end)
--- Gets a list of all reports that a player has on them. If no player then lists all players and the number of reports on them.
--- Lists the reports against a player, or the number against every player, printed once the controller answers
Commands.new("get-reports", { "exp-commands_reports.description-get" })
:optional("player", { "exp-commands_reports.arg-player-get" }, Commands.types.player)
:add_aliases{ "reports" }
:add_flags{ "admin_only" }
:register(function(player, other_player)
--- @cast other_player LuaPlayer?
if other_player then
local reports = Reports.get_reports(other_player)
local other_player_name = format_player_name(other_player)
Commands.print{ "exp-commands_reports.player-title", other_player_name, #reports }
for by_player_name, reason in pairs(reports) do
local by_player_name_formatted = format_player_name(by_player_name)
Commands.print{ "exp-commands_reports.list-element", by_player_name_formatted, reason }
end
else
local reports = Reports.user_reports
Commands.print{ "exp-commands_reports.reports-title" }
for player_name in pairs(reports) do
local player_name_formatted = format_player_name(player_name)
local report_count = Reports.count_reports(player_name)
Commands.print{ "exp-commands_reports.list-element", player_name_formatted, report_count }
end
end
Reports.list_reports(player, other_player)
end)
--- Clears all reports from a player or just the report from one player.
--- Clears all reports from a player or just the report from one player, printed once the controller answers
Commands.new("clear-reports", { "exp-commands_reports.description-clear" })
:argument("player", { "exp-commands_reports.arg-player-clear" }, Commands.types.player)
:optional("from-player", { "exp-commands_reports.arg-from-player" }, Commands.types.player)
@@ -89,22 +58,5 @@ Commands.new("clear-reports", { "exp-commands_reports.description-clear" })
:register(function(player, other_player, from_player)
--- @cast other_player LuaPlayer
--- @cast from_player LuaPlayer?
local player_name = format_player_name(player)
local other_player_name = format_player_name(other_player)
if from_player then
if not Reports.remove_report(other_player, from_player.name, player.name) then
local from_player_name = format_player_name(other_player)
return Commands.status.invalid_input{ "exp-commands_reports.not-reported-by", from_player_name }
else
game.print{ "exp-commands_reports.removed", other_player_name, player_name }
return Commands.status.success()
end
else
if not Reports.remove_all(other_player, player.name) then
return Commands.status.invalid_input{ "exp-commands_reports.not-reported" }
else
game.print{ "exp-commands_reports.removed-all", other_player_name, player_name }
return Commands.status.success()
end
end
Reports.delete_reports(player, other_player, from_player and from_player.name)
end)