From 7d814e11c759b7d6c02c7bca018315ec5acc5955 Mon Sep 17 00:00:00 2001 From: dicebox Date: Fri, 10 Feb 2017 18:28:40 +0100 Subject: [PATCH] git subrepo clone https://github.com/minetest-mods/xban2.git mods/xban2 subrepo: subdir: "mods/xban2" merged: "97fb251" upstream: origin: "https://github.com/minetest-mods/xban2.git" branch: "master" commit: "97fb251" git-subrepo: version: "0.3.1" origin: "https://github.com/ingydotnet/git-subrepo" commit: "a7ee886" --- mods/xban2/.gitrepo | 11 + mods/xban2/bower.json | 15 ++ mods/xban2/dbimport.lua | 38 +++ mods/xban2/doc/API.md | 32 +++ mods/xban2/doc/dbformat.txt | 45 ++++ mods/xban2/gui.lua | 140 +++++++++++ mods/xban2/importers/minetest.lua | 29 +++ mods/xban2/importers/v1.lua | 33 +++ mods/xban2/importers/v2.lua | 35 +++ mods/xban2/init.lua | 387 ++++++++++++++++++++++++++++++ mods/xban2/mod.conf | 1 + mods/xban2/serialize.lua | 31 +++ 12 files changed, 797 insertions(+) create mode 100644 mods/xban2/.gitrepo create mode 100644 mods/xban2/bower.json create mode 100644 mods/xban2/dbimport.lua create mode 100644 mods/xban2/doc/API.md create mode 100644 mods/xban2/doc/dbformat.txt create mode 100644 mods/xban2/gui.lua create mode 100644 mods/xban2/importers/minetest.lua create mode 100644 mods/xban2/importers/v1.lua create mode 100644 mods/xban2/importers/v2.lua create mode 100644 mods/xban2/init.lua create mode 100644 mods/xban2/mod.conf create mode 100644 mods/xban2/serialize.lua diff --git a/mods/xban2/.gitrepo b/mods/xban2/.gitrepo new file mode 100644 index 0000000..b987da8 --- /dev/null +++ b/mods/xban2/.gitrepo @@ -0,0 +1,11 @@ +; DO NOT EDIT (unless you know what you are doing) +; +; This subdirectory is a git "subrepo", and this file is maintained by the +; git-subrepo command. See https://github.com/git-commands/git-subrepo#readme +; +[subrepo] + remote = https://github.com/minetest-mods/xban2.git + branch = master + commit = 97fb251ad954a5927a4ba59e72cffd277e6d244c + parent = 1efe84b655ab17a05304cb7dec516d4e70bd5fcc + cmdver = 0.3.1 diff --git a/mods/xban2/bower.json b/mods/xban2/bower.json new file mode 100644 index 0000000..1e1576d --- /dev/null +++ b/mods/xban2/bower.json @@ -0,0 +1,15 @@ +{ + "name": "xban2", + "description": "Ban system extension with support for temporary bans.", + "keywords": [ + "ban", + "administration", + "system", + "server" + ], + "homepage": "http://github.com/kaeza/minetest-xban2.git", + "authors": [ + "Diego Martínez " + ], + "license": "BSD 2-Clause" +} diff --git a/mods/xban2/dbimport.lua b/mods/xban2/dbimport.lua new file mode 100644 index 0000000..ec9293d --- /dev/null +++ b/mods/xban2/dbimport.lua @@ -0,0 +1,38 @@ + +xban.importers = { } + +dofile(xban.MP.."/importers/minetest.lua") +dofile(xban.MP.."/importers/v1.lua") +dofile(xban.MP.."/importers/v2.lua") + +minetest.register_chatcommand("xban_dbi", { + description = "Import old databases", + params = "", + privs = { server=true }, + func = function(name, params) + if params == "--list" then + local names = { } + for name in pairs(xban.importers) do + table.insert(names, name) + end + minetest.chat_send_player(name, + ("[xban] Known importers: %s"):format( + table.concat(names, ", "))) + return + elseif not xban.importers[params] then + minetest.chat_send_player(name, + ("[xban] Unknown importer `%s'"):format(params)) + minetest.chat_send_player(name, "[xban] Try `--list'") + return + end + local f = xban.importers[params] + local ok, err = f() + if ok then + minetest.chat_send_player(name, + "[xban] Import successfull") + else + minetest.chat_send_player(name, + ("[xban] Import failed: %s"):format(err)) + end + end, +}) diff --git a/mods/xban2/doc/API.md b/mods/xban2/doc/API.md new file mode 100644 index 0000000..bee7c42 --- /dev/null +++ b/mods/xban2/doc/API.md @@ -0,0 +1,32 @@ + +## Extended Ban Mod API + +### ban_player + +`xban.ban_player(player_or_ip, source, expires, reason)` + +Ban a player and all of his/her alternative names and IPs. + +#### Arguments: + +* `player_or_ip` - Player to search for and ban. See note 1 below. +* `source` - Source of the ban. See note 2 below. +* `expires` - Time at which the ban expires. If nil, ban is permanent. +* `reason` - Reason for ban. + +### unban_player + +`xban.unban_player(player_or_ip, source)` + +Unban a player and all of his/her alternative names and IPs. + +#### Arguments: + +* `player_or_ip` - Player to search for and unban. +* `source` - Source of the ban. See note 2 below. + +### Notes + +* 1: If player is currently online, all his accounts are kicked. +* 2: Mods using the xban API are advised to use the `"modname:source"` +format for `source` (for example: `"anticheat:main"`). diff --git a/mods/xban2/doc/dbformat.txt b/mods/xban2/doc/dbformat.txt new file mode 100644 index 0000000..71b25a5 --- /dev/null +++ b/mods/xban2/doc/dbformat.txt @@ -0,0 +1,45 @@ + +Database is a regular Lua script that returns a table. + +Table has a single named field `timestamp' containing the time_t the +DB was last saved. It's not used in the mod and is only meant for +external use (I don't find filesystem timestamps too reliable). + +Next is a simple array (number indices) of entries. + +Each entry contains following fields: + +[1] = { + -- Names/IPs associated with this entry + names = { + ["foo"] = true, + ["bar"] = true, + ["123.45.67.89"] = true, + }, + banned = true, -- Whether this user is banned + -- Other fields do not apply if false + time = 12341234, -- Time of last ban (*1) + expires = 43214321 -- Time at which ban expires (*2) + -- If nil, permanent ban + reason = "asdf", -- Reason for ban + source = "qwerty", -- Source of ban (*2) + record = { + [1] = { + source = "asdf", + reason = "qwerty", + time = 12341234, + expires = 43214321, + }, + [1] = { + source = "asdf", + reason = "Unbanned", -- When unbanned + time = 12341234, + }, + }, +} + +Notes: +(*1) All times are expressed in whatever unit `os.time()' uses + (`time_t' on most (all?) systems). +(*2) Mods using the xban API are advised to use the "modname:source" + format for `source' (for example: "anticheat:main"). diff --git a/mods/xban2/gui.lua b/mods/xban2/gui.lua new file mode 100644 index 0000000..d3306e2 --- /dev/null +++ b/mods/xban2/gui.lua @@ -0,0 +1,140 @@ + +local FORMNAME = "xban2:main" +local MAXLISTSIZE = 100 + +local strfind, format = string.find, string.format + +local ESC = minetest.formspec_escape + +local function make_list(filter) + filter = filter or "" + local list, n, dropped = { }, 0, false + for k in pairs(minetest.auth_table) do + if strfind(k, filter, 1, true) then + if n >= MAXLISTSIZE then + dropped = true + break + end + n=n+1 list[n] = k + end + end + table.sort(list) + return list, dropped +end + +local states = { } + +local function get_state(name) + local state = states[name] + if not state then + state = { index=1, filter="" } + states[name] = state + state.list, state.dropped = make_list() + end + return state +end + +local function get_record_simple(name) + local e = xban.find_entry(name) + if not e then + return nil, ("No entry for `%s'"):format(name) + elseif (not e.record) or (#e.record == 0) then + return nil, ("`%s' has no ban records"):format(name) + end + local record = { } + for _, rec in ipairs(e.record) do + local msg = (os.date("%Y-%m-%d %H:%M:%S", rec.time).." | " + ..(rec.reason or "No reason given.")) + table.insert(record, msg) + end + return record, e.record +end + +local function make_fs(name) + local state = get_state(name) + local list, filter = state.list, state.filter + local pli, ei = state.player_index or 1, state.entry_index or 0 + if pli > #list then + pli = #list + end + local fs = { + "size[16,12]", + "label[0,-.1;Filter]", + "field[1.5,0;12.8,1;filter;;"..ESC(filter).."]", + "button[14,-.3;2,1;search;Search]", + } + local fsn = #fs + fsn=fsn+1 fs[fsn] = format("textlist[0,.8;4,9.3;player;%s;%d;0]", + table.concat(list, ","), pli) + local record_name = list[pli] + if record_name then + local record, e = get_record_simple(record_name) + if record then + for i, r in ipairs(record) do + record[i] = ESC(r) + end + fsn=fsn+1 fs[fsn] = format( + "textlist[4.2,.8;11.7,9.3;entry;%s;%d;0]", + table.concat(record, ","), ei) + local rec = e[ei] + if rec then + fsn=fsn+1 fs[fsn] = format("label[0,10.3;%s]", + ESC("Source: "..(rec.source or "") + .."\nTime: "..os.date("%c", rec.time) + .."\n"..(rec.expires and + os.date("%c", rec.expires) or "")), + pli) + end + else + fsn=fsn+1 fs[fsn] = "textlist[4.2,.8;11.7,9.3;err;"..ESC(e)..";0]" + fsn=fsn+1 fs[fsn] = "label[0,10.3;"..ESC(e).."]" + end + else + local e = "No entry matches the query." + fsn=fsn+1 fs[fsn] = "textlist[4.2,.8;11.7,9.3;err;"..ESC(e)..";0]" + fsn=fsn+1 fs[fsn] = "label[0,10.3;"..ESC(e).."]" + end + return table.concat(fs) +end + +minetest.register_on_player_receive_fields(function(player, formname, fields) + if formname ~= FORMNAME then return end + local name = player:get_player_name() + if not minetest.check_player_privs(name, { ban=true }) then + minetest.log("warning", + "[xban2] Received fields from unauthorized user: "..name) + return + end + local state = get_state(name) + if fields.player then + local t = minetest.explode_textlist_event(fields.player) + if (t.type == "CHG") or (t.type == "DCL") then + state.player_index = t.index + minetest.show_formspec(name, FORMNAME, make_fs(name)) + end + return + end + if fields.entry then + local t = minetest.explode_textlist_event(fields.entry) + if (t.type == "CHG") or (t.type == "DCL") then + state.entry_index = t.index + minetest.show_formspec(name, FORMNAME, make_fs(name)) + end + return + end + if fields.search then + local filter = fields.filter or "" + state.filter = filter + state.list = make_list(filter) + minetest.show_formspec(name, FORMNAME, make_fs(name)) + end +end) + +minetest.register_chatcommand("xban_gui", { + description = "Show XBan GUI", + params = "", + privs = { ban=true, }, + func = function(name, params) + minetest.show_formspec(name, FORMNAME, make_fs(name)) + end, +}) diff --git a/mods/xban2/importers/minetest.lua b/mods/xban2/importers/minetest.lua new file mode 100644 index 0000000..e19c3c6 --- /dev/null +++ b/mods/xban2/importers/minetest.lua @@ -0,0 +1,29 @@ + +function xban.importers.minetest() + local f, e = io.open(minetest.get_worldpath().."/ipban.txt") + if not f then + return false, "Unable to open `ipban.txt': "..e + end + for line in f:lines() do + local ip, name = line:match("([^|]+)%|(.+)") + if ip and name then + local entry + entry = xban.find_entry(ip, true) + entry.banned = true + entry.reason = "Banned in `ipban.txt'" + entry.names[name] = true + entry.names[ip] = true + entry.time = os.time() + entry.expires = nil + entry.source = "xban:importer_minetest" + table.insert(entry.record, { + source = entry.source, + reason = entry.reason, + time = entry.time, + expires = nil, + }) + end + end + f:close() + return true +end diff --git a/mods/xban2/importers/v1.lua b/mods/xban2/importers/v1.lua new file mode 100644 index 0000000..a3722c7 --- /dev/null +++ b/mods/xban2/importers/v1.lua @@ -0,0 +1,33 @@ + +function xban.importers.v1() + local f, e = io.open(minetest.get_worldpath().."/players.iplist") + if not f then + return false, "Unable to open `players.iplist': "..e + end + for line in f:lines() do + local list = line:split("|") + if #list >= 2 then + local banned = (list[1]:sub(1, 1) == "!") + local entry + entry = xban.find_entry(list[1], true) + entry.banned = banned + for _, name in ipairs(list) do + entry.names[name] = true + end + if banned then + entry.reason = "Banned in `players.iplist'" + entry.time = os.time() + entry.expires = nil + entry.source = "xban:importer_v1" + table.insert(entry.record, { + source = entry.source, + reason = entry.reason, + time = entry.time, + expires = nil, + }) + end + end + end + f:close() + return true +end diff --git a/mods/xban2/importers/v2.lua b/mods/xban2/importers/v2.lua new file mode 100644 index 0000000..fd29966 --- /dev/null +++ b/mods/xban2/importers/v2.lua @@ -0,0 +1,35 @@ + +function xban.importers.v2() + return pcall(function() + local f, e = io.open(minetest.get_worldpath().."/players.iplist.v2") + if not f then + error("Unable to open `players.iplist.v2': "..e) + end + local text = f:read("*a") + f:close() + local db = minetest.deserialize(text) + for _, e in ipairs(db) do + for name in pairs(e.names) do + local entry = xban.find_entry(name, true) + if entry.source ~= "xban:importer_v2" then + for nm in pairs(e.names) do + entry.names[nm] = true + end + if e.banned then + entry.banned = true + entry.reason = e.banned + entry.source = "xban:importer_v2" + entry.time = e.time + entry.expires = e.expires + table.insert(entry.record, { + source = entry.source, + reason = entry.reason, + time = entry.time, + expires = entry.expires, + }) + end + end + end + end + end) +end diff --git a/mods/xban2/init.lua b/mods/xban2/init.lua new file mode 100644 index 0000000..b3c42a6 --- /dev/null +++ b/mods/xban2/init.lua @@ -0,0 +1,387 @@ + +xban = { MP = minetest.get_modpath(minetest.get_current_modname()) } + +dofile(xban.MP.."/serialize.lua") + +local db = { } +local tempbans = { } + +local DEF_SAVE_INTERVAL = 300 -- 5 minutes +local DEF_DB_FILENAME = minetest.get_worldpath().."/xban.db" + +local DB_FILENAME = minetest.setting_get("xban.db_filename") +local SAVE_INTERVAL = tonumber( + minetest.setting_get("xban.db_save_interval")) or DEF_SAVE_INTERVAL + +if (not DB_FILENAME) or (DB_FILENAME == "") then + DB_FILENAME = DEF_DB_FILENAME +end + +local function make_logger(level) + return function(text, ...) + minetest.log(level, "[xban] "..text:format(...)) + end +end + +local ACTION = make_logger("action") +local INFO = make_logger("info") +local WARNING = make_logger("warning") +local ERROR = make_logger("error") + +local unit_to_secs = { + s = 1, m = 60, h = 3600, + D = 86400, W = 604800, M = 2592000, Y = 31104000, + [""] = 1, +} + +local function parse_time(t) --> secs + local secs = 0 + for num, unit in t:gmatch("(%d+)([smhDWMY]?)") do + secs = secs + (tonumber(num) * (unit_to_secs[unit] or 1)) + end + return secs +end + +function xban.find_entry(player, create) --> entry, index + for index, e in ipairs(db) do + for name in pairs(e.names) do + if name == player then + return e, index + end + end + end + if create then + print(("Created new entry for `%s'"):format(player)) + local e = { + names = { [player]=true }, + banned = false, + record = { }, + } + table.insert(db, e) + return e, #db + end + return nil +end + +function xban.get_info(player) --> ip_name_list, banned, last_record + local e = xban.find_entry(player) + if not e then + return nil, "No such entry" + end + return e.names, e.banned, e.record[#e.record] +end + +function xban.ban_player(player, source, expires, reason) --> bool, err + if xban.get_whitelist(player) then + return nil, "Player is whitelisted; remove from whitelist first" + end + local e = xban.find_entry(player, true) + if e.banned then + return nil, "Already banned" + end + local rec = { + source = source, + time = os.time(), + expires = expires, + reason = reason, + } + table.insert(e.record, rec) + e.names[player] = true + local pl = minetest.get_player_by_name(player) + if pl then + local ip = minetest.get_player_ip(player) + if ip then + e.names[ip] = true + end + e.last_pos = pl:getpos() + end + e.reason = reason + e.time = rec.time + e.expires = expires + e.banned = true + local msg + local date = (expires and os.date("%c", expires) + or "the end of time") + if expires then + table.insert(tempbans, e) + msg = ("Banned: Expires: %s, Reason: %s"):format(date, reason) + else + msg = ("Banned: Reason: %s"):format(reason) + end + for nm in pairs(e.names) do + minetest.kick_player(nm, msg) + end + ACTION("%s bans %s until %s for reason: %s", source, player, + date, reason) + ACTION("Banned Names/IPs: %s", table.concat(e.names, ", ")) + return true +end + +function xban.unban_player(player, source) --> bool, err + local e = xban.find_entry(player) + if not e then + return nil, "No such entry" + end + local rec = { + source = source, + time = os.time(), + reason = "Unbanned", + } + table.insert(e.record, rec) + e.banned = false + e.reason = nil + e.expires = nil + e.time = nil + ACTION("%s unbans %s", source, player) + ACTION("Unbanned Names/IPs: %s", table.concat(e.names, ", ")) + return true +end + +function xban.get_whitelist(name_or_ip) + return db.whitelist and db.whitelist[name_or_ip] +end + +function xban.remove_whitelist(name_or_ip) + if db.whitelist then + db.whitelist[name_or_ip] = nil + end +end + +function xban.add_whitelist(name_or_ip, source) + local wl = db.whitelist + if not wl then + wl = { } + db.whitelist = wl + end + wl[name_or_ip] = { + source=source, + } + return true +end + +function xban.get_record(player) + local e = xban.find_entry(player) + if not e then + return nil, ("No entry for `%s'"):format(player) + elseif (not e.record) or (#e.record == 0) then + return nil, ("`%s' has no ban records"):format(player) + end + local record = { } + for _, rec in ipairs(e.record) do + local msg = rec.reason or "No reason given." + if rec.expires then + msg = msg..(", Expires: %s"):format(os.date("%c", e.expires)) + end + if rec.source then + msg = msg..", Source: "..rec.source + end + table.insert(record, ("[%s]: %s"):format(os.date("%c", e.time), msg)) + end + local last_pos + if e.last_pos then + last_pos = ("User was last seen at %s"):format( + minetest.pos_to_string(e.last_pos)) + end + return record, last_pos +end + +minetest.register_on_prejoinplayer(function(name, ip) + local wl = db.whitelist or { } + if wl[name] or wl[ip] then return end + local e = xban.find_entry(name) or xban.find_entry(ip) + if not e then return end + if e.banned then + local date = (e.expires and os.date("%c", e.expires) + or "the end of time") + return ("Banned: Expires: %s, Reason: %s"):format( + date, e.reason) + end +end) + +minetest.register_on_joinplayer(function(player) + local name = player:get_player_name() + local e = xban.find_entry(name) + local ip = minetest.get_player_ip(name) + if not e then + if ip then + e = xban.find_entry(ip, true) + else + return + end + end + e.names[name] = true + if ip then + e.names[ip] = true + end + e.last_seen = os.time() +end) + +minetest.register_chatcommand("xban", { + description = "XBan a player", + params = " ", + privs = { ban=true }, + func = function(name, params) + local plname, reason = params:match("(%S+)%s+(.+)") + if not (plname and reason) then + return false, "Usage: /xban " + end + local ok, e = xban.ban_player(plname, name, nil, reason) + return ok, ok and ("Banned %s."):format(plname) or e + end, +}) + +minetest.register_chatcommand("xtempban", { + description = "XBan a player temporarily", + params = "