Improve /report; add report API (#163)
This commit is contained in:
ANAND
Thomas--S
parent
f0c4e19b51
commit
64793ea22c
5 changed files with 153 additions and 107 deletions
14
mods/ctf/ctf_reports/README.md
Normal file
14
mods/ctf/ctf_reports/README.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# CTF Reports
|
||||
|
||||
Allows players to report players and bugs to admins and online moderators.
|
||||
|
||||
Suppose `player`, `griefer` and `moderator` are online players:
|
||||
|
||||
- `player` runs this command: `/report griefer is griefing`
|
||||
- `moderator` sees: `-!- player reported: griefer is griefing`
|
||||
- The admin (named in `name`) is mailed via email: `<player> Report: griefer is griefing (moderators online: moderator)`
|
||||
|
||||
License: WTFPL
|
||||
|
||||
Dependencies: `ctf`, `email`
|
||||
Optional dependencies: `irc`
|
||||
137
mods/ctf/ctf_reports/init.lua
Normal file
137
mods/ctf/ctf_reports/init.lua
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
ctf_reports = {}
|
||||
|
||||
local storage = minetest.get_mod_storage()
|
||||
|
||||
local function get_irc_mods()
|
||||
return storage:get_string("irc_mods"):split(",")
|
||||
end
|
||||
|
||||
local function add_irc_mod(name)
|
||||
local mods = get_irc_mods()
|
||||
if table.indexof(mods, name) > 0 then
|
||||
return false
|
||||
end
|
||||
mods[#mods + 1] = name
|
||||
storage:set_string("irc_mods", table.concat(mods, ","))
|
||||
minetest.log("action", name .. " subscribed to IRC reports")
|
||||
return true
|
||||
end
|
||||
|
||||
local function remove_irc_mod(name)
|
||||
local mods = get_irc_mods()
|
||||
local idx = table.indexof(mods, name)
|
||||
if idx > 0 then
|
||||
table.remove(mods, idx)
|
||||
storage:set_string("irc_mods", table.concat(mods, ","))
|
||||
minetest.log("action", name .. " unsubscribed from IRC reports")
|
||||
return true
|
||||
end
|
||||
return false
|
||||
end
|
||||
|
||||
-- If word corresponds to a player name, this method returns the
|
||||
-- word enclosed by color escape codes of the player's team and
|
||||
-- also the name followed by team name in parenthesis for IRC
|
||||
local function colorize_word(word)
|
||||
if not minetest.get_player_by_name(word) then
|
||||
return minetest.colorize("#FFFF00", word), word
|
||||
end
|
||||
|
||||
local tplayer = ctf.player(word)
|
||||
if not tplayer then
|
||||
return minetest.colorize("#FFFF00", word), word
|
||||
end
|
||||
|
||||
return minetest.colorize(ctf_colors.get_color(tplayer).css, word),
|
||||
word .. " (team " .. (tplayer.team or "none") .. ")"
|
||||
end
|
||||
|
||||
function ctf_reports.send_report(report)
|
||||
local ingame_report = ""
|
||||
local irc_report = ""
|
||||
|
||||
-- Colorize report word-by-word
|
||||
local parts = report:split(" ")
|
||||
for _, part in pairs(parts) do
|
||||
local ingame_part, irc_part = colorize_word(part)
|
||||
ingame_report = ingame_report .. " " .. ingame_part
|
||||
irc_report = irc_report .. " " .. irc_part
|
||||
end
|
||||
|
||||
ingame_report = ingame_report:trim()
|
||||
irc_report = irc_report:trim()
|
||||
|
||||
-- Send to online moderators / admins
|
||||
-- Get comma separated list of online moderators and admins
|
||||
local mods = {}
|
||||
|
||||
for _, player in pairs(minetest.get_connected_players()) do
|
||||
local toname = player:get_player_name()
|
||||
if minetest.check_player_privs(toname, { kick = true, ban = true }) then
|
||||
table.insert(mods, toname)
|
||||
minetest.chat_send_player(toname, ingame_report)
|
||||
end
|
||||
end
|
||||
|
||||
if not minetest.global_exists("irc") then
|
||||
return
|
||||
end
|
||||
|
||||
-- Append list of moderators in-game
|
||||
local msg
|
||||
if #mods == 0 then
|
||||
msg = irc_report .. " (no moderators online)"
|
||||
else
|
||||
msg = irc_report .. " (moderators online: " .. table.concat(mods, ", ") .. ")"
|
||||
end
|
||||
|
||||
-- Send to IRC moderators
|
||||
for _, toname in pairs(get_irc_mods()) do
|
||||
if not minetest.get_player_by_name(toname) then
|
||||
minetest.chat_send_player(toname, msg)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
minetest.register_chatcommand("report", {
|
||||
func = function(name, param)
|
||||
param = param:trim()
|
||||
if param == "" then
|
||||
return false, "Please add a message to your report. " ..
|
||||
"If it's about (a) particular player(s), please also include their name(s)."
|
||||
end
|
||||
|
||||
-- Count the number of words, by counting for replaced spaces
|
||||
-- Number of spaces = Number of words - 1
|
||||
local _, count = string.gsub(param, " ", "")
|
||||
if count == 0 then
|
||||
return false, "If you're reporting a player, you should" ..
|
||||
" also include a reason why (e.g. swearing, griefing, spawnkilling, etc.)."
|
||||
end
|
||||
|
||||
param = name .. " reported: " .. param
|
||||
|
||||
ctf_reports.send_report(param)
|
||||
|
||||
return true, "Report has been sent."
|
||||
end
|
||||
})
|
||||
|
||||
minetest.register_chatcommand("report_sub", {
|
||||
privs = { kick = true },
|
||||
func = function(name, param)
|
||||
if param:lower():trim() == "remove" then
|
||||
if remove_irc_mod(name) then
|
||||
return true, "Successfully removed!"
|
||||
else
|
||||
return false, "Unable to remove, are you even subscribed?"
|
||||
end
|
||||
else
|
||||
if add_irc_mod(name) then
|
||||
return true, "Successfully added!"
|
||||
else
|
||||
return false, "Unable to add, are you already subscribed?"
|
||||
end
|
||||
end
|
||||
end
|
||||
})
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
name = report
|
||||
depends = email
|
||||
name = ctf_reports
|
||||
depends = ctf, email
|
||||
optional_depends = irc
|
||||
description = Allows players to report misconduct or bugs using /report.
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
# Report
|
||||
|
||||
Allows players to report things to admins and online moderators.
|
||||
|
||||
Suppose `player`, `griefer` and `moderator` are online players.
|
||||
`player` runs this command: `/report griefer is griefing`
|
||||
`moderator` sees: `-!- player reported: griefer is griefing`
|
||||
The Admin (named in "name") is mailed via chatplus: `<player1> Report: player2 is griefing (mods online: player3)`
|
||||
|
||||
License: WTFPL
|
||||
Depends: email.
|
||||
|
||||
|
|
@ -1,93 +0,0 @@
|
|||
local storage = minetest.get_mod_storage()
|
||||
|
||||
local function get_irc_mods()
|
||||
return storage:get_string("irc_mods"):split(",")
|
||||
end
|
||||
|
||||
local function add_irc_mod(name)
|
||||
local mods = get_irc_mods()
|
||||
if table.indexof(mods, name) > 0 then
|
||||
return false
|
||||
end
|
||||
mods[#mods + 1] = name
|
||||
storage:set_string("irc_mods", table.concat(mods, ","))
|
||||
minetest.log("action", name .. " subscribed to IRC reports")
|
||||
return true
|
||||
end
|
||||
|
||||
local function remove_irc_mod(name)
|
||||
local mods = get_irc_mods()
|
||||
local idx = table.indexof(mods, name)
|
||||
if idx > 0 then
|
||||
table.remove(mods, idx)
|
||||
storage:set_string("irc_mods", table.concat(mods, ","))
|
||||
minetest.log("action", name .. " un-subscribed from IRC reports")
|
||||
return true
|
||||
end
|
||||
return false
|
||||
end
|
||||
|
||||
minetest.register_chatcommand("report_sub", {
|
||||
privs = { kick = true },
|
||||
func = function(name, param)
|
||||
if param:lower():trim() == "remove" then
|
||||
if remove_irc_mod(name) then
|
||||
return true, "Successfully removed!"
|
||||
else
|
||||
return false, "Unable to remove, are you even subscribed?"
|
||||
end
|
||||
else
|
||||
if add_irc_mod(name) then
|
||||
minetest.log("action", name .. " subscribed to IRC reports")
|
||||
return true, "Successfully added!"
|
||||
else
|
||||
return false, "Unable to add, are you already subscribed?"
|
||||
end
|
||||
end
|
||||
end
|
||||
})
|
||||
|
||||
minetest.register_chatcommand("report", {
|
||||
func = function(name, param)
|
||||
param = param:trim()
|
||||
if param == "" then
|
||||
return false, "Please add a message to your report. " ..
|
||||
"If it's about (a) particular player(s), please also include their name(s)."
|
||||
end
|
||||
local _, count = string.gsub(param, " ", "")
|
||||
if count == 0 then
|
||||
minetest.chat_send_player(name, "If you're reporting a player, " ..
|
||||
"you should also include a reason why. (Eg: swearing, sabotage)")
|
||||
end
|
||||
|
||||
-- Send to online moderators / admins
|
||||
-- Get comma separated list of online moderators and admins
|
||||
local mods = {}
|
||||
for _, player in pairs(minetest.get_connected_players()) do
|
||||
local toname = player:get_player_name()
|
||||
if minetest.check_player_privs(toname, {kick = true, ban = true}) then
|
||||
table.insert(mods, toname)
|
||||
minetest.chat_send_player(toname, minetest.colorize("#FFFF00",
|
||||
"-!- " .. name .. " reported: " .. param))
|
||||
end
|
||||
end
|
||||
|
||||
-- Build message for offline listeners
|
||||
local msg
|
||||
if #mods == 0 then
|
||||
msg = "Report from " ..name .. ": " .. param .. " (no mods online)"
|
||||
else
|
||||
msg = "Report from " ..name .. ": " .. param .. " (mods online: " ..
|
||||
table.concat(mods, ", ") .. ")"
|
||||
end
|
||||
|
||||
-- Send to IRC moderators
|
||||
for _, toname in pairs(get_irc_mods()) do
|
||||
if not minetest.get_player_by_name(toname) then
|
||||
minetest.chat_send_player(toname, msg)
|
||||
end
|
||||
end
|
||||
|
||||
return true, "Report has been sent."
|
||||
end
|
||||
})
|
||||
Loading…
Reference in a new issue