1 -- Minetest: builtin/chatcommands.lua
4 -- Chat command handler
8 function core.register_chatcommand(cmd, def)
10 def.params = def.params or ""
11 def.description = def.description or ""
12 def.privs = def.privs or {}
13 core.chatcommands[cmd] = def
16 if core.setting_getbool("mod_profiling") then
17 local tracefct = profiling_print_log
18 profiling_print_log = nil
19 core.register_chatcommand("save_mod_profile",
22 description = "save mod profiling data to logfile " ..
23 "(depends on default loglevel)",
25 privs = { server=true }
29 core.register_on_chat_message(function(name, message)
30 local cmd, param = string.match(message, "^/([^ ]+) *(.*)")
34 local cmd_def = core.chatcommands[cmd]
38 local has_privs, missing_privs = core.check_player_privs(name, cmd_def.privs)
40 local success, message = cmd_def.func(name, param)
42 core.chat_send_player(name, message)
45 core.chat_send_player(name, "You don't have permission"
46 .. " to run this command (missing privileges: "
47 .. table.concat(missing_privs, ", ") .. ")")
49 return true -- Handled chat message
55 core.register_chatcommand("me", {
57 description = "chat action (eg. /me orders a pizza)",
59 func = function(name, param)
60 core.chat_send_all("* " .. name .. " " .. param)
64 core.register_chatcommand("help", {
66 params = "[all/privs/<cmd>]",
67 description = "Get help for commands or list privileges",
68 func = function(name, param)
69 local function format_help_line(cmd, def)
71 if def.params and def.params ~= "" then
72 msg = msg .. " " .. def.params
74 if def.description and def.description ~= "" then
75 msg = msg .. ": " .. def.description
82 for cmd, def in pairs(core.chatcommands) do
83 if core.check_player_privs(name, def.privs) then
84 table.insert(cmds, cmd)
88 return true, "Available commands: " .. table.concat(cmds, " ") .. "\n"
89 .. "Use '/help <cmd>' to get more information,"
90 .. " or '/help all' to list everything."
91 elseif param == "all" then
93 for cmd, def in pairs(core.chatcommands) do
94 if core.check_player_privs(name, def.privs) then
95 table.insert(cmds, format_help_line(cmd, def))
99 return true, "Available commands:\n"..table.concat(cmds, "\n")
100 elseif param == "privs" then
102 for priv, def in pairs(core.registered_privileges) do
103 table.insert(privs, priv .. ": " .. def.description)
106 return true, "Available privileges:\n"..table.concat(privs, "\n")
109 local def = core.chatcommands[cmd]
111 return false, "Command not available: "..cmd
113 return true, format_help_line(cmd, def)
119 core.register_chatcommand("privs", {
121 description = "print out privileges of player",
122 func = function(name, param)
123 param = (param ~= "" and param or name)
124 return true, "Privileges of " .. param .. ": "
125 .. core.privs_to_string(
126 core.get_player_privs(param), ' ')
129 core.register_chatcommand("grant", {
130 params = "<name> <privilege>|all",
131 description = "Give privilege to player",
132 func = function(name, param)
133 if not core.check_player_privs(name, {privs=true}) and
134 not core.check_player_privs(name, {basic_privs=true}) then
135 return false, "Your privileges are insufficient."
137 local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
138 if not grantname or not grantprivstr then
139 return false, "Invalid parameters (see /help grant)"
140 elseif not core.auth_table[grantname] then
141 return false, "Player " .. grantname .. " does not exist."
143 local grantprivs = core.string_to_privs(grantprivstr)
144 if grantprivstr == "all" then
145 grantprivs = core.registered_privileges
147 local privs = core.get_player_privs(grantname)
148 local privs_unknown = ""
149 for priv, _ in pairs(grantprivs) do
150 if priv ~= "interact" and priv ~= "shout" and
151 not core.check_player_privs(name, {privs=true}) then
152 return false, "Your privileges are insufficient."
154 if not core.registered_privileges[priv] then
155 privs_unknown = privs_unknown .. "Unknown privilege: " .. priv .. "\n"
159 if privs_unknown ~= "" then
160 return false, privs_unknown
162 core.set_player_privs(grantname, privs)
163 core.log("action", name..' granted ('..core.privs_to_string(grantprivs, ', ')..') privileges to '..grantname)
164 if grantname ~= name then
165 core.chat_send_player(grantname, name
166 .. " granted you privileges: "
167 .. core.privs_to_string(grantprivs, ' '))
169 return true, "Privileges of " .. grantname .. ": "
170 .. core.privs_to_string(
171 core.get_player_privs(grantname), ' ')
174 core.register_chatcommand("revoke", {
175 params = "<name> <privilege>|all",
176 description = "Remove privilege from player",
178 func = function(name, param)
179 if not core.check_player_privs(name, {privs=true}) and
180 not core.check_player_privs(name, {basic_privs=true}) then
181 return false, "Your privileges are insufficient."
183 local revoke_name, revoke_priv_str = string.match(param, "([^ ]+) (.+)")
184 if not revoke_name or not revoke_priv_str then
185 return false, "Invalid parameters (see /help revoke)"
186 elseif not core.auth_table[revoke_name] then
187 return false, "Player " .. revoke_name .. " does not exist."
189 local revoke_privs = core.string_to_privs(revoke_priv_str)
190 local privs = core.get_player_privs(revoke_name)
191 for priv, _ in pairs(revoke_privs) do
192 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and
193 not core.check_player_privs(name, {privs=true}) then
194 return false, "Your privileges are insufficient."
197 if revoke_priv_str == "all" then
200 for priv, _ in pairs(revoke_privs) do
204 core.set_player_privs(revoke_name, privs)
205 core.log("action", name..' revoked ('
206 ..core.privs_to_string(revoke_privs, ', ')
207 ..') privileges from '..revoke_name)
208 if revoke_name ~= name then
209 core.chat_send_player(revoke_name, name
210 .. " revoked privileges from you: "
211 .. core.privs_to_string(revoke_privs, ' '))
213 return true, "Privileges of " .. revoke_name .. ": "
214 .. core.privs_to_string(
215 core.get_player_privs(revoke_name), ' ')
219 core.register_chatcommand("setpassword", {
220 params = "<name> <password>",
221 description = "set given password",
222 privs = {password=true},
223 func = function(name, param)
224 local toname, raw_password = string.match(param, "^([^ ]+) +(.+)$")
226 toname = param:match("^([^ ]+) *$")
230 return false, "Name field required"
233 if not raw_password then
234 core.set_player_password(toname, "")
237 core.set_player_password(toname,
238 core.get_password_hash(toname,
242 if toname ~= name then
243 core.chat_send_player(toname, "Your password was "
244 .. actstr .. " by " .. name)
246 return true, "Password of player \"" .. toname .. "\" " .. actstr
250 core.register_chatcommand("clearpassword", {
252 description = "set empty password",
253 privs = {password=true},
254 func = function(name, param)
257 return false, "Name field required"
259 core.set_player_password(toname, '')
260 return true, "Password of player \"" .. toname .. "\" cleared"
264 core.register_chatcommand("auth_reload", {
266 description = "reload authentication data",
267 privs = {server=true},
268 func = function(name, param)
269 local done = core.auth_reload()
270 return done, (done and "Done." or "Failed.")
274 core.register_chatcommand("teleport", {
275 params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
276 description = "teleport to given position",
277 privs = {teleport=true},
278 func = function(name, param)
279 -- Returns (pos, true) if found, otherwise (pos, false)
280 local function find_free_position_near(pos)
287 for _, d in ipairs(tries) do
288 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
289 local n = core.get_node_or_nil(p)
291 local def = core.registered_nodes[n.name]
292 if def and not def.walkable then
300 local teleportee = nil
302 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
306 teleportee = core.get_player_by_name(name)
307 if teleportee and p.x and p.y and p.z then
309 return true, "Teleporting to "..core.pos_to_string(p)
312 local teleportee = nil
314 local target_name = nil
315 target_name = param:match("^([^ ]+)$")
316 teleportee = core.get_player_by_name(name)
318 local target = core.get_player_by_name(target_name)
323 if teleportee and p then
324 p = find_free_position_near(p)
326 return true, "Teleporting to " .. target_name
327 .. " at "..core.pos_to_string(p)
330 if not core.check_player_privs(name, {bring=true}) then
331 return false, "You don't have permission to teleport other players (missing bring privilege)"
334 local teleportee = nil
336 local teleportee_name = nil
337 teleportee_name, p.x, p.y, p.z = param:match(
338 "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
339 p.x, p.y, p.z = tonumber(p.x), tonumber(p.y), tonumber(p.z)
340 if teleportee_name then
341 teleportee = core.get_player_by_name(teleportee_name)
343 if teleportee and p.x and p.y and p.z then
345 return true, "Teleporting " .. teleportee_name
346 .. " to " .. core.pos_to_string(p)
349 local teleportee = nil
351 local teleportee_name = nil
352 local target_name = nil
353 teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
354 if teleportee_name then
355 teleportee = core.get_player_by_name(teleportee_name)
358 local target = core.get_player_by_name(target_name)
363 if teleportee and p then
364 p = find_free_position_near(p)
366 return true, "Teleporting " .. teleportee_name
367 .. " to " .. target_name
368 .. " at " .. core.pos_to_string(p)
371 return false, 'Invalid parameters ("' .. param
372 .. '") or player not found (see /help teleport)'
376 core.register_chatcommand("set", {
377 params = "[-n] <name> <value> | <name>",
378 description = "set or read server configuration setting",
379 privs = {server=true},
380 func = function(name, param)
381 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
382 if arg and arg == "-n" and setname and setvalue then
383 core.setting_set(setname, setvalue)
384 return true, setname .. " = " .. setvalue
386 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
387 if setname and setvalue then
388 if not core.setting_get(setname) then
389 return false, "Failed. Use '/set -n <name> <value>' to create a new setting."
391 core.setting_set(setname, setvalue)
392 return true, setname .. " = " .. setvalue
394 local setname = string.match(param, "([^ ]+)")
396 local setvalue = core.setting_get(setname)
398 setvalue = "<not set>"
400 return true, setname .. " = " .. setvalue
402 return false, "Invalid parameters (see /help set)."
406 core.register_chatcommand("mods", {
408 description = "List mods installed on the server",
410 func = function(name, param)
411 return true, table.concat(core.get_modnames(), ", ")
415 local function handle_give_command(cmd, giver, receiver, stackstring)
416 core.log("action", giver .. " invoked " .. cmd
417 .. ', stackstring="' .. stackstring .. '"')
418 local itemstack = ItemStack(stackstring)
419 if itemstack:is_empty() then
420 return false, "Cannot give an empty item"
421 elseif not itemstack:is_known() then
422 return false, "Cannot give an unknown item"
424 local receiverref = core.get_player_by_name(receiver)
425 if receiverref == nil then
426 return false, receiver .. " is not a known player"
428 local leftover = receiverref:get_inventory():add_item("main", itemstack)
430 if leftover:is_empty() then
432 elseif leftover:get_count() == itemstack:get_count() then
433 partiality = "could not be "
435 partiality = "partially "
437 -- The actual item stack string may be different from what the "giver"
438 -- entered (e.g. big numbers are always interpreted as 2^16-1).
439 stackstring = itemstack:to_string()
440 if giver == receiver then
441 return true, ("%q %sadded to inventory.")
442 :format(stackstring, partiality)
444 core.chat_send_player(receiver, ("%q %sadded to inventory.")
445 :format(stackstring, partiality))
446 return true, ("%q %sadded to %s's inventory.")
447 :format(stackstring, partiality, receiver)
451 core.register_chatcommand("give", {
452 params = "<name> <ItemString>",
453 description = "give item to player",
455 func = function(name, param)
456 local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
457 if not toname or not itemstring then
458 return false, "Name and ItemString required"
460 return handle_give_command("/give", name, toname, itemstring)
464 core.register_chatcommand("giveme", {
465 params = "<ItemString>",
466 description = "give item to yourself",
468 func = function(name, param)
469 local itemstring = string.match(param, "(.+)$")
470 if not itemstring then
471 return false, "ItemString required"
473 return handle_give_command("/giveme", name, name, itemstring)
477 core.register_chatcommand("spawnentity", {
478 params = "<EntityName>",
479 description = "Spawn entity at your position",
480 privs = {give=true, interact=true},
481 func = function(name, param)
482 local entityname = string.match(param, "(.+)$")
483 if not entityname then
484 return false, "EntityName required"
486 core.log("action", ("/spawnentity invoked, entityname=%q")
488 local player = core.get_player_by_name(name)
489 if player == nil then
490 core.log("error", "Unable to spawn entity, player is nil")
491 return false, "Unable to spawn entity, player is nil"
493 local p = player:getpos()
495 core.add_entity(p, entityname)
496 return true, ("%q spawned."):format(entityname)
500 core.register_chatcommand("pulverize", {
502 description = "Destroy item in hand",
503 func = function(name, param)
504 local player = core.get_player_by_name(name)
506 core.log("error", "Unable to pulverize, no player.")
507 return false, "Unable to pulverize, no player."
509 if player:get_wielded_item():is_empty() then
510 return false, "Unable to pulverize, no item in hand."
512 player:set_wielded_item(nil)
513 return true, "An item was pulverized."
518 core.rollback_punch_callbacks = {}
520 core.register_on_punchnode(function(pos, node, puncher)
521 local name = puncher:get_player_name()
522 if core.rollback_punch_callbacks[name] then
523 core.rollback_punch_callbacks[name](pos, node, puncher)
524 core.rollback_punch_callbacks[name] = nil
528 core.register_chatcommand("rollback_check", {
529 params = "[<range>] [<seconds>] [limit]",
530 description = "Check who has last touched a node or near it,"
531 .. " max. <seconds> ago (default range=0,"
532 .. " seconds=86400=24h, limit=5)",
533 privs = {rollback=true},
534 func = function(name, param)
535 local range, seconds, limit =
536 param:match("(%d+) *(%d*) *(%d*)")
537 range = tonumber(range) or 0
538 seconds = tonumber(seconds) or 86400
539 limit = tonumber(limit) or 5
541 return false, "That limit is too high!"
544 core.rollback_punch_callbacks[name] = function(pos, node, puncher)
545 local name = puncher:get_player_name()
546 core.chat_send_player(name, "Checking " .. core.pos_to_string(pos) .. "...")
547 local actions = core.rollback_get_node_actions(pos, range, seconds, limit)
548 local num_actions = #actions
549 if num_actions == 0 then
550 core.chat_send_player(name, "Nobody has touched"
551 .. " the specified location in "
552 .. seconds .. " seconds")
555 local time = os.time()
556 for i = num_actions, 1, -1 do
557 local action = actions[i]
558 core.chat_send_player(name,
559 ("%s %s %s -> %s %d seconds ago.")
561 core.pos_to_string(action.pos),
569 return true, "Punch a node (range=" .. range .. ", seconds="
570 .. seconds .. "s, limit=" .. limit .. ")"
574 core.register_chatcommand("rollback", {
575 params = "<player name> [<seconds>] | :<actor> [<seconds>]",
576 description = "revert actions of a player; default for <seconds> is 60",
577 privs = {rollback=true},
578 func = function(name, param)
579 local target_name, seconds = string.match(param, ":([^ ]+) *(%d*)")
580 if not target_name then
581 local player_name = nil
582 player_name, seconds = string.match(param, "([^ ]+) *(%d*)")
583 if not player_name then
584 return false, "Invalid parameters. See /help rollback"
585 .. " and /help rollback_check."
587 target_name = "player:"..player_name
589 seconds = tonumber(seconds) or 60
590 core.chat_send_player(name, "Reverting actions of "
591 .. target_name .. " since "
592 .. seconds .. " seconds.")
593 local success, log = core.rollback_revert_actions_by(
594 target_name, seconds)
597 response = "(log is too long to show)\n"
599 for _, line in pairs(log) do
600 response = response .. line .. "\n"
603 response = response .. "Reverting actions "
604 .. (success and "succeeded." or "FAILED.")
605 return success, response
609 core.register_chatcommand("status", {
610 description = "Print server status",
611 func = function(name, param)
612 return true, core.get_server_status()
616 core.register_chatcommand("time", {
617 params = "<0...24000>",
618 description = "set time of day",
619 privs = {settime=true},
620 func = function(name, param)
622 return false, "Missing time."
624 local newtime = tonumber(param)
625 if newtime == nil then
626 return false, "Invalid time."
628 core.set_timeofday((newtime % 24000) / 24000)
629 core.log("action", name .. " sets time " .. newtime)
630 return true, "Time of day changed."
634 core.register_chatcommand("shutdown", {
635 description = "shutdown server",
636 privs = {server=true},
637 func = function(name, param)
638 core.log("action", name .. " shuts down server")
639 core.request_shutdown()
640 core.chat_send_all("*** Server shutting down (operator request).")
644 core.register_chatcommand("ban", {
646 description = "Ban IP of player",
648 func = function(name, param)
650 return true, "Ban list: " .. core.get_ban_list()
652 if not core.get_player_by_name(param) then
653 return false, "No such player."
655 if not core.ban_player(param) then
656 return false, "Failed to ban player."
658 local desc = core.get_ban_description(param)
659 core.log("action", name .. " bans " .. desc .. ".")
660 return true, "Banned " .. desc .. "."
664 core.register_chatcommand("unban", {
665 params = "<name/ip>",
666 description = "remove IP ban",
668 func = function(name, param)
669 if not core.unban_player_or_ip(param) then
670 return false, "Failed to unban player/IP."
672 core.log("action", name .. " unbans " .. param)
673 return true, "Unbanned " .. param
677 core.register_chatcommand("kick", {
678 params = "<name> [reason]",
679 description = "kick a player",
681 func = function(name, param)
682 local tokick, reason = param:match("([^ ]+) (.+)")
683 tokick = tokick or param
684 if not core.kick_player(tokick, reason) then
685 return false, "Failed to kick player " .. tokick
687 core.log("action", name .. " kicked " .. tokick)
688 return true, "Kicked " .. tokick
692 core.register_chatcommand("clearobjects", {
693 description = "clear all objects in world",
694 privs = {server=true},
695 func = function(name, param)
696 core.log("action", name .. " clears all objects.")
697 core.chat_send_all("Clearing all objects. This may take long."
698 .. " You may experience a timeout. (by "
701 core.log("action", "Object clearing done.")
702 core.chat_send_all("*** Cleared all objects.")
706 core.register_chatcommand("msg", {
707 params = "<name> <message>",
708 description = "Send a private message",
709 privs = {shout=true},
710 func = function(name, param)
711 local sendto, message = param:match("^(%S+)%s(.+)$")
713 return false, "Invalid usage, see /help msg."
715 if not core.get_player_by_name(sendto) then
716 return false, "The player " .. sendto
719 core.log("action", "PM from " .. name .. " to " .. sendto
721 core.chat_send_player(sendto, "PM from " .. name .. ": "
723 return true, "Message sent."
727 core.register_chatcommand("last-login", {
729 description = "Get the last login time of a player",
730 func = function(name, param)
734 local pauth = core.get_auth_handler().get_auth(param)
735 if pauth and pauth.last_login then
736 -- Time in UTC, ISO 8601 format
737 return true, "Last login time was " ..
738 os.date("!%Y-%m-%dT%H:%M:%SZ", pauth.last_login)
740 return false, "Last login time is unknown"