init.lua 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543
  1. if not minetest.global_exists("xban") then xban = {} end
  2. xban.db = xban.db or {}
  3. xban.tempbans = xban.tempbans or {}
  4. xban.MP = minetest.get_modpath("xban2")
  5. -- Localize for performance.
  6. local vector_round = vector.round
  7. -- Reloadable.
  8. dofile(xban.MP.."/serialize.lua")
  9. local DEF_SAVE_INTERVAL = 300 -- 5 minutes
  10. local DEF_DB_FILENAME = minetest.get_worldpath().."/xban.db"
  11. local DB_FILENAME = minetest.settings:get("xban.db_filename")
  12. local SAVE_INTERVAL = tonumber(
  13. minetest.settings:get("xban.db_save_interval")) or DEF_SAVE_INTERVAL
  14. if (not DB_FILENAME) or (DB_FILENAME == "") then
  15. DB_FILENAME = DEF_DB_FILENAME
  16. end
  17. local function make_logger(level)
  18. return function(text, ...)
  19. minetest.log(level, "[xban] "..text:format(...))
  20. end
  21. end
  22. local ACTION = make_logger("action")
  23. local WARNING = make_logger("warning")
  24. local unit_to_secs = {
  25. s = 1, m = 60, h = 3600,
  26. D = 86400, W = 604800, M = 2592000, Y = 31104000,
  27. [""] = 1,
  28. }
  29. local function parse_time(t) --> secs
  30. local secs = 0
  31. for num, unit in t:gmatch("(%d+)([smhDWMY]?)") do
  32. secs = secs + (tonumber(num) * (unit_to_secs[unit] or 1))
  33. end
  34. return secs
  35. end
  36. function xban.find_entry(player, create) --> entry, index
  37. local db = xban.db
  38. local dblen = #xban.db
  39. for index = 1, dblen do
  40. local e = db[index]
  41. for name in pairs(e.names) do
  42. if name == player then
  43. return e, index
  44. end
  45. end
  46. end
  47. if create then
  48. ACTION("Created new entry for `%s'", player)
  49. local e = {
  50. names = { [player]=true },
  51. banned = false,
  52. record = { },
  53. last_pos = { },
  54. last_seen = { },
  55. }
  56. db[#db + 1] = e
  57. return e, #db
  58. end
  59. return nil
  60. end
  61. function xban.get_info(player) --> ip_name_list, banned, last_record
  62. local e = xban.find_entry(player)
  63. if not e then
  64. return nil, "No such entry."
  65. end
  66. return e.names, e.banned, e.record[#e.record]
  67. end
  68. function xban.ban_player(player, source, expires, reason) --> bool, err
  69. if xban.get_whitelist(player) then
  70. return nil, "Player is whitelisted; remove from whitelist first!"
  71. end
  72. local e = xban.find_entry(player, true)
  73. if e.banned then
  74. return nil, "Player already banned."
  75. end
  76. if minetest.check_player_privs(player, {server=true}) then
  77. return nil, "Administrators cannot be banned!"
  78. end
  79. local rec = {
  80. source = source,
  81. time = os.time(), -- Date of ban.
  82. expires = expires,
  83. reason = reason,
  84. }
  85. table.insert(e.record, rec)
  86. e.names[player] = true
  87. local pl = minetest.get_player_by_name(player)
  88. if pl then
  89. local ip = minetest.get_player_ip(player)
  90. if ip then
  91. e.names[ip] = true
  92. end
  93. e.last_pos[player] = pl:get_pos()
  94. end
  95. e.reason = reason
  96. e.time = rec.time
  97. e.expires = expires
  98. e.banned = true
  99. local msg
  100. local date = (expires and os.date("%c", expires)
  101. or "The End of Time")
  102. if expires then
  103. table.insert(xban.tempbans, e)
  104. msg = ("Banned: Expires: %s, Reason: %s"):format(date, reason)
  105. else
  106. msg = ("Banned: Reason: %s"):format(reason)
  107. end
  108. for nm in pairs(e.names) do
  109. minetest.kick_player(nm, msg)
  110. end
  111. ACTION("%s bans %s until %s for reason: %s", source, player,
  112. date, reason)
  113. ACTION("Banned Names/IPs: %s", table.concat(e.names, ", "))
  114. return true
  115. end
  116. function xban.unban_player(player, source) --> bool, err
  117. local e = xban.find_entry(player)
  118. if not e then
  119. return nil, "No such entry."
  120. end
  121. if not e.banned then
  122. return nil, "Player not banned."
  123. end
  124. local rec = {
  125. source = source,
  126. time = os.time(),
  127. reason = "Unbanned",
  128. }
  129. table.insert(e.record, rec)
  130. e.banned = false
  131. e.reason = nil
  132. e.expires = nil
  133. e.time = nil
  134. ACTION("%s unbans %s", source, player)
  135. ACTION("Unbanned Names/IPs: %s", table.concat(e.names, ", "))
  136. return true
  137. end
  138. function xban.get_whitelist(name_or_ip)
  139. return xban.db.whitelist and xban.db.whitelist[name_or_ip]
  140. end
  141. function xban.remove_whitelist(name_or_ip)
  142. if xban.db.whitelist then
  143. xban.db.whitelist[name_or_ip] = nil
  144. end
  145. end
  146. function xban.add_whitelist(name_or_ip, source)
  147. local wl = xban.db.whitelist
  148. if not wl then
  149. wl = { }
  150. xban.db.whitelist = wl
  151. end
  152. wl[name_or_ip] = {
  153. source=source,
  154. }
  155. return true
  156. end
  157. function xban.get_record(player)
  158. local e = xban.find_entry(player)
  159. if not e then
  160. return nil, ("No entry for <%s>."):format(rename.gpn(player))
  161. elseif (not e.record) or (#e.record == 0) then
  162. return nil, ("<%s> has no ban records."):format(rename.gpn(player))
  163. end
  164. local record = { }
  165. for _, rec in ipairs(e.record) do
  166. local msg = rec.reason and ("Reason: '" .. rec.reason .. "'") or "No reason given"
  167. if rec.expires then
  168. msg = msg..(", Expires: %s"):format(os.date("%c", e.expires))
  169. end
  170. if rec.source then
  171. msg = msg..", Source: '"..rec.source.."'"
  172. end
  173. table.insert(record, ("[%s]: %s."):format(os.date("%c", e.time), msg))
  174. end
  175. local last_pos
  176. if e.last_pos and e.last_pos[player] then
  177. last_pos = ("User was last seen at %s."):format(
  178. rc.pos_to_namestr(vector_round(e.last_pos[player])))
  179. end
  180. return record, last_pos
  181. end
  182. function xban.on_prejoinplayer(name, ip)
  183. if minetest.check_player_privs(name, {server=true}) then
  184. return
  185. end
  186. local wl = xban.db.whitelist or { }
  187. if wl[name] or wl[ip] then return end
  188. local e = xban.find_entry(name) or xban.find_entry(ip)
  189. if not e then return end
  190. if e.banned then
  191. local date = (e.expires and os.date("%c", e.expires) or "The End of Time")
  192. return ("\nBanned!\nExpires: %s\nReason: %s"):format(date, e.reason)
  193. end
  194. end
  195. function xban.on_joinplayer(player)
  196. local name = player:get_player_name()
  197. local e = xban.find_entry(name)
  198. local ip = minetest.get_player_ip(name)
  199. if not e then
  200. -- Don't create database entries for players who never registered.
  201. -- This keeps the database size limited to only those players who
  202. -- decided to play on the server for a while. Guests are not included.
  203. if ip and passport.player_registered(name) then
  204. e = xban.find_entry(ip, true)
  205. else
  206. return
  207. end
  208. end
  209. e.names[name] = true
  210. if ip then
  211. e.names[ip] = true
  212. end
  213. e.last_seen[name] = os.time()
  214. end
  215. function xban.on_leaveplayer(player, timeout)
  216. local pname = player:get_player_name()
  217. -- Don't record last_pos for temporary accounts.
  218. if not passport.player_registered(pname) then
  219. return
  220. end
  221. local e = xban.find_entry(pname)
  222. if e then
  223. e.last_pos[pname] = player:get_pos()
  224. end
  225. end
  226. function xban.chatcommand_ban(name, params)
  227. local plname, reason = params:match("^(%S+)%s+(.+)$")
  228. if not (plname and reason) then
  229. minetest.chat_send_player(name, "# Server: Usage: '/xban <player> <reason>'.")
  230. return false
  231. end
  232. reason = reason:trim()
  233. local ok, e = xban.ban_player(plname, rename.gpn(name), nil, reason)
  234. local msg = ("# Server: Banned <%s>."):format(rename.gpn(plname))
  235. if not ok then
  236. msg = "# Server: " .. e
  237. end
  238. minetest.chat_send_player(name, msg)
  239. return ok
  240. end
  241. function xban.chatcommand_tempban(name, params)
  242. local plname, time, reason = params:match("^(%S+)%s+(%S+)%s+(.+)$")
  243. if not (plname and time and reason) then
  244. minetest.chat_send_player(name, "# Server: Usage: '/xtempban <player> <time> <reason>'.")
  245. return false
  246. end
  247. time = parse_time(time)
  248. if time < 60 then
  249. minetest.chat_send_player(name, "# Server: You must ban for at least 60 seconds.")
  250. return false
  251. end
  252. reason = reason:trim()
  253. local expires = os.time() + time
  254. local ok, e = xban.ban_player(plname, rename.gpn(name), expires, reason)
  255. local msg = ("# Server: Banned <%s> until %s."):format(rename.gpn(plname), os.date("%c", expires))
  256. if not ok then
  257. msg = "# Server: " .. e
  258. end
  259. minetest.chat_send_player(name, msg)
  260. return ok
  261. end
  262. function xban.chatcommand_xunban(name, params)
  263. local plname = params:match("^%S+$")
  264. if not plname or plname == "" then
  265. minetest.chat_send_player(name, "# Server: Usage: '/xunban <player>|<ip>'.")
  266. return
  267. end
  268. local ok, e = xban.unban_player(plname, rename.gpn(name))
  269. local msg = ("# Server: Unbanned <%s>."):format(rename.gpn(plname))
  270. if not ok then
  271. msg = "# Server: " .. e
  272. end
  273. minetest.chat_send_player(name, msg)
  274. return ok
  275. end
  276. function xban.chatcommand_record(name, params)
  277. local plname = params:match("^%S+$")
  278. if not plname or plname == "" then
  279. minetest.chat_send_player(name, "# Server: Usage: '/xban_record <player>|<ip>'.")
  280. return false
  281. end
  282. local record, last_pos = xban.get_record(plname)
  283. if not record then
  284. local err = last_pos
  285. minetest.chat_send_player(name, "# Server: [xban]: "..err)
  286. return
  287. end
  288. for _, e in ipairs(record) do
  289. minetest.chat_send_player(name, "# Server: [xban]: "..e)
  290. end
  291. if last_pos then
  292. minetest.chat_send_player(name, "# Server: [xban]: "..last_pos)
  293. end
  294. minetest.chat_send_player(name, "# Server: [xban]: End of record.")
  295. return true
  296. end
  297. function xban.chatcommand_wl(name, params)
  298. local cmd, plname = params:match("^%s*(%S+)%s*(%S+)%s*$")
  299. if not cmd or cmd == "" then
  300. minetest.chat_send_player(name, "# Server: Usage: '/xban_wl (add|del|get) <name>|<ip>'.")
  301. return false
  302. end
  303. if not plname or plname == "" then
  304. minetest.chat_send_player(name, "# Server: Usage: '/xban_wl (add|del|get) <name>|<ip>'.")
  305. return false
  306. end
  307. if cmd == "add" then
  308. xban.add_whitelist(plname, rename.gpn(name))
  309. ACTION("%s adds %s to whitelist", name, plname)
  310. minetest.chat_send_player(name, "# Server: Added <"..rename.gpn(plname).."> to whitelist!")
  311. return true
  312. elseif cmd == "del" then
  313. xban.remove_whitelist(plname)
  314. ACTION("%s removes %s to whitelist", name, plname)
  315. minetest.chat_send_player(name, "# Server: Removed <"..rename.gpn(plname).."> from whitelist!")
  316. return true
  317. elseif cmd == "get" then
  318. local e = xban.get_whitelist(plname)
  319. if e then
  320. minetest.chat_send_player(name, "# Server: Source: "..(e.source and ("'"..e.source.."'") or "Unknown")..".")
  321. return true
  322. else
  323. minetest.chat_send_player(name, "# Server: No whitelist for <"..rename.gpn(plname)..">!")
  324. return true
  325. end
  326. end
  327. end
  328. function xban.check_temp_bans()
  329. minetest.after(60, function() xban.check_temp_bans() end)
  330. local to_rm = { }
  331. local now = os.time()
  332. for i, e in ipairs(xban.tempbans) do
  333. if e.expires and (e.expires <= now) then
  334. table.insert(to_rm, i)
  335. e.banned = false
  336. e.expires = nil
  337. e.reason = nil
  338. e.time = nil
  339. end
  340. end
  341. for _, i in ipairs(to_rm) do
  342. table.remove(xban.tempbans, i)
  343. end
  344. end
  345. function xban.save_db()
  346. minetest.after(SAVE_INTERVAL, function() xban.save_db() end)
  347. local f, e = io.open(DB_FILENAME, "wt")
  348. xban.db.timestamp = os.time()
  349. if f then
  350. local ok, err = f:write(xban.serialize(xban.db))
  351. if not ok then
  352. WARNING("Unable to save database: %s", err)
  353. end
  354. else
  355. WARNING("Unable to save database: %s", e)
  356. end
  357. if f then f:close() end
  358. return
  359. end
  360. function xban.load_db()
  361. local f, e = io.open(DB_FILENAME, "rt")
  362. if not f then
  363. WARNING("Unable to load database: %s", e)
  364. return
  365. end
  366. local cont = f:read("*a")
  367. if not cont then
  368. WARNING("Unable to load database: %s", "Read failed")
  369. return
  370. end
  371. local t, e2 = minetest.deserialize(cont)
  372. if not t then
  373. WARNING("Unable to load database: %s",
  374. "Deserialization failed: "..(e2 or "unknown error"))
  375. return
  376. end
  377. local function is_vector(data)
  378. local count = 0
  379. if type(data) == "table" then
  380. for k, v in pairs(data) do
  381. count = count + 1
  382. end
  383. end
  384. if count ~= 3 then
  385. return false
  386. end
  387. if type(data) == "table"
  388. and type(data.x) == "number"
  389. and type(data.y) == "number"
  390. and type(data.z) == "number"
  391. and count == 3 then
  392. return true
  393. end
  394. return false
  395. end
  396. -- Update DB format. Remove entries that are in an old, invalid format.
  397. for k, v in ipairs(t) do
  398. if type(v.last_seen) ~= "nil" and type(v.last_seen) ~= "table" then
  399. v.last_seen = nil
  400. end
  401. if type(v.last_pos) ~= "nil" and is_vector(v.last_pos) then
  402. v.last_pos = nil
  403. end
  404. -- Add empty tables for missing elements.
  405. if not v.last_pos then
  406. v.last_pos = {}
  407. end
  408. if not v.last_seen then
  409. v.last_seen = {}
  410. end
  411. end
  412. xban.db = t
  413. xban.tempbans = {}
  414. for _, entry in ipairs(xban.db) do
  415. if entry.banned and entry.expires then
  416. table.insert(xban.tempbans, entry)
  417. end
  418. end
  419. end
  420. if not xban.registered then
  421. minetest.register_on_joinplayer(function(...)
  422. return xban.on_joinplayer(...)
  423. end)
  424. minetest.register_on_prejoinplayer(function(...)
  425. return xban.on_prejoinplayer(...)
  426. end)
  427. minetest.register_on_leaveplayer(function(...)
  428. return xban.on_leaveplayer(...)
  429. end)
  430. minetest.register_chatcommand("xban_wl", {
  431. description = "Manages the XBan whitelist.",
  432. params = "(add|del|get) <name>|<ip>",
  433. privs = { ban=true },
  434. func = function(...)
  435. return xban.chatcommand_wl(...)
  436. end,
  437. })
  438. minetest.register_chatcommand("xban_record", {
  439. description = "Show the ban records of a player.",
  440. params = "<player>|<ip>",
  441. privs = { ban=true },
  442. func = function(...)
  443. return xban.chatcommand_record(...)
  444. end,
  445. })
  446. minetest.register_chatcommand("xunban", {
  447. description = "XUnban a player.",
  448. params = "<player>|<ip>",
  449. privs = { ban=true },
  450. func = function(...)
  451. return xban.chatcommand_xunban(...)
  452. end,
  453. })
  454. minetest.register_chatcommand("xtempban", {
  455. description = "XBan a player temporarily.",
  456. params = "<player> <time> <reason>",
  457. privs = { ban=true },
  458. func = function(...)
  459. return xban.chatcommand_tempban(...)
  460. end,
  461. })
  462. minetest.register_chatcommand("xban", {
  463. description = "XBan a player.",
  464. params = "<player> <reason>",
  465. privs = { ban=true },
  466. func = function(...)
  467. return xban.chatcommand_ban(...)
  468. end,
  469. })
  470. minetest.register_on_shutdown(function(...) return xban.save_db(...) end)
  471. minetest.after(SAVE_INTERVAL, function() xban.save_db() end)
  472. minetest.after(1, function() xban.check_temp_bans() end)
  473. xban.load_db()
  474. local c = "xban:core"
  475. local f = xban.MP .. "/init.lua"
  476. reload.register_file(c, f, false)
  477. xban.registered = true
  478. end
  479. -- Reloadable.
  480. dofile(xban.MP.."/dbimport.lua")
  481. dofile(xban.MP.."/gui.lua")