builtin/chatcommands.lua

   1 -- Minetest: builtin/chatcommands.lua
   2
   3 --
   4 -- Chat command handler
   5 --
   6
   7 minetest.chatcommands = {}
   8 function minetest.register_chatcommand(cmd, def)
   9         def = def or {}
  10         def.params = def.params or ""
  11         def.description = def.description or ""
  12         def.privs = def.privs or {}
  13         minetest.chatcommands[cmd] = def
  14 end
  15
  16 minetest.register_on_chat_message(function(name, message)
  17         local cmd, param = string.match(message, "^/([^ ]+) *(.*)")
  18         if not param then
  19                 param = ""
  20         end
  21         local cmd_def = minetest.chatcommands[cmd]
  22         if cmd_def then
  23                 if not cmd_def.func then
  24                         -- This is a C++ command
  25                         return false
  26                 else
  27                         local has_privs, missing_privs = minetest.check_player_privs(name, cmd_def.privs)
  28                         if has_privs then
  29                                 cmd_def.func(name, param)
  30                         else
  31                                 minetest.chat_send_player(name, "You don't have permission to run this command (missing privileges: "..table.concat(missing_privs, ", ")..")")
  32                         end
  33                         return true -- handled chat message
  34                 end
  35         end
  36         return false
  37 end)
  38
  39 --
  40 -- Chat commands
  41 --
  42
  43 -- Register C++ commands without functions
  44 minetest.register_chatcommand("me", {params = nil, description = "chat action (eg. /me orders a pizza)", privs = {shout=true}})
  45 minetest.register_chatcommand("status", {description = "print server status line"})
  46 minetest.register_chatcommand("shutdown", {params = "", description = "shutdown server", privs = {server=true}})
  47 minetest.register_chatcommand("clearobjects", {params = "", description = "clear all objects in world", privs = {server=true}})
  48 minetest.register_chatcommand("time", {params = "<0...24000>", description = "set time of day", privs = {settime=true}})
  49 minetest.register_chatcommand("ban", {params = "<name>", description = "ban IP of player", privs = {ban=true}})
  50 minetest.register_chatcommand("unban", {params = "<name/ip>", description = "remove IP ban", privs = {ban=true}})
  51
  52 -- Register other commands
  53 minetest.register_chatcommand("help", {
  54         privs = {},
  55         params = "(nothing)/all/privs/<cmd>",
  56         description = "Get help for commands or list privileges",
  57         func = function(name, param)
  58                 local format_help_line = function(cmd, def)
  59                         local msg = "/"..cmd
  60                         if def.params and def.params ~= "" then msg = msg .. " " .. def.params end
  61                         if def.description and def.description ~= "" then msg = msg .. ": " .. def.description end
  62                         return msg
  63                 end
  64                 if param == "" then
  65                         local msg = ""
  66                         cmds = {}
  67                         for cmd, def in pairs(minetest.chatcommands) do
  68                                 if minetest.check_player_privs(name, def.privs) then
  69                                         table.insert(cmds, cmd)
  70                                 end
  71                         end
  72                         minetest.chat_send_player(name, "Available commands: "..table.concat(cmds, " "))
  73                         minetest.chat_send_player(name, "Use '/help <cmd>' to get more information, or '/help all' to list everything.")
  74                 elseif param == "all" then
  75                         minetest.chat_send_player(name, "Available commands:")
  76                         for cmd, def in pairs(minetest.chatcommands) do
  77                                 if minetest.check_player_privs(name, def.privs) then
  78                                         minetest.chat_send_player(name, format_help_line(cmd, def))
  79                                 end
  80                         end
  81                 elseif param == "privs" then
  82                         minetest.chat_send_player(name, "Available privileges:")
  83                         for priv, def in pairs(minetest.registered_privileges) do
  84                                 minetest.chat_send_player(name, priv..": "..def.description)
  85                         end
  86                 else
  87                         local cmd = param
  88                         def = minetest.chatcommands[cmd]
  89                         if not def then
  90                                 minetest.chat_send_player(name, "Command not available: "..cmd)
  91                         else
  92                                 minetest.chat_send_player(name, format_help_line(cmd, def))
  93                         end
  94                 end
  95         end,
  96 })
  97 minetest.register_chatcommand("privs", {
  98         params = "<name>",
  99         description = "print out privileges of player",
 100         func = function(name, param)
 101                 if param == "" then
 102                         param = name
 103                 else
 104                         --[[if not minetest.check_player_privs(name, {privs=true}) then
 105                                 minetest.chat_send_player(name, "Privileges of "..param.." are hidden from you.")
 106                                 return
 107                         end]]
 108                 end
 109                 minetest.chat_send_player(name, "Privileges of "..param..": "..minetest.privs_to_string(minetest.get_player_privs(param), ' '))
 110         end,
 111 })
 112 minetest.register_chatcommand("grant", {
 113         params = "<name> <privilege>|all",
 114         description = "Give privilege to player",
 115         privs = {},
 116         func = function(name, param)
 117                 if not minetest.check_player_privs(name, {privs=true}) and
 118                                 not minetest.check_player_privs(name, {basic_privs=true}) then
 119                         minetest.chat_send_player(name, "Your privileges are insufficient.")
 120                         return
 121                 end
 122                 local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
 123                 if not grantname or not grantprivstr then
 124                         minetest.chat_send_player(name, "Invalid parameters (see /help grant)")
 125                         return
 126                 end
 127                 local grantprivs = minetest.string_to_privs(grantprivstr)
 128                 if grantprivstr == "all" then
 129                         grantprivs = minetest.registered_privileges
 130                 end
 131                 local privs = minetest.get_player_privs(grantname)
 132                 local privs_known = true
 133                 for priv, _ in pairs(grantprivs) do
 134                         if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not minetest.check_player_privs(name, {privs=true}) then
 135                                 minetest.chat_send_player(name, "Your privileges are insufficient.")
 136                                 return
 137                         end
 138                         if not minetest.registered_privileges[priv] then
 139                                 minetest.chat_send_player(name, "Unknown privilege: "..priv)
 140                                 privs_known = false
 141                         end
 142                         privs[priv] = true
 143                 end
 144                 if not privs_known then
 145                         return
 146                 end
 147                 minetest.set_player_privs(grantname, privs)
 148                 minetest.chat_send_player(name, "Privileges of "..grantname..": "..minetest.privs_to_string(minetest.get_player_privs(grantname), ' '))
 149                 if grantname ~= name then
 150                         minetest.chat_send_player(grantname, name.." granted you privileges: "..minetest.privs_to_string(grantprivs, ' '))
 151                 end
 152         end,
 153 })
 154 minetest.register_chatcommand("revoke", {
 155         params = "<name> <privilege>|all",
 156         description = "Remove privilege from player",
 157         privs = {},
 158         func = function(name, param)
 159                 if not minetest.check_player_privs(name, {privs=true}) and
 160                                 not minetest.check_player_privs(name, {basic_privs=true}) then
 161                         minetest.chat_send_player(name, "Your privileges are insufficient.")
 162                         return
 163                 end
 164                 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
 165                 if not revokename or not revokeprivstr then
 166                         minetest.chat_send_player(name, "Invalid parameters (see /help revoke)")
 167                         return
 168                 end
 169                 local revokeprivs = minetest.string_to_privs(revokeprivstr)
 170                 local privs = minetest.get_player_privs(revokename)
 171                 for priv, _ in pairs(revokeprivs) do
 172                         if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not minetest.check_player_privs(name, {privs=true}) then
 173                                 minetest.chat_send_player(name, "Your privileges are insufficient.")
 174                                 return
 175                         end
 176                 end
 177                 if revokeprivstr == "all" then
 178                         privs = {}
 179                 else
 180                         for priv, _ in pairs(revokeprivs) do
 181                                 privs[priv] = nil
 182                         end
 183                 end
 184                 minetest.set_player_privs(revokename, privs)
 185                 minetest.chat_send_player(name, "Privileges of "..revokename..": "..minetest.privs_to_string(minetest.get_player_privs(revokename), ' '))
 186                 if revokename ~= name then
 187                         minetest.chat_send_player(revokename, name.." revoked privileges from you: "..minetest.privs_to_string(revokeprivs, ' '))
 188                 end
 189         end,
 190 })
 191 minetest.register_chatcommand("setpassword", {
 192         params = "<name> <password>",
 193         description = "set given password",
 194         privs = {password=true},
 195         func = function(name, param)
 196                 local toname, raw_password = string.match(param, "^([^ ]+) +(.+)$")
 197                 if not toname then
 198                         toname = string.match(param, "^([^ ]+) *$")
 199                         raw_password = nil
 200                 end
 201                 if not toname then
 202                         minetest.chat_send_player(name, "Name field required")
 203                         return
 204                 end
 205                 local actstr = "?"
 206                 if not raw_password then
 207                         minetest.set_player_password(toname, "")
 208                         actstr = "cleared"
 209                 else
 210                         minetest.set_player_password(toname, minetest.get_password_hash(toname, raw_password))
 211                         actstr = "set"
 212                 end
 213                 minetest.chat_send_player(name, "Password of player \""..toname.."\" "..actstr)
 214                 if toname ~= name then
 215                         minetest.chat_send_player(toname, "Your password was "..actstr.." by "..name)
 216                 end
 217         end,
 218 })
 219 minetest.register_chatcommand("clearpassword", {
 220         params = "<name>",
 221         description = "set empty password",
 222         privs = {password=true},
 223         func = function(name, param)
 224                 toname = param
 225                 if not toname then
 226                         minetest.chat_send_player(toname, "Name field required")
 227                         return
 228                 end
 229                 minetest.set_player_password(toname, '')
 230                 minetest.chat_send_player(name, "Password of player \""..toname.."\" cleared")
 231         end,
 232 })
 233
 234 minetest.register_chatcommand("auth_reload", {
 235         params = "",
 236         description = "reload authentication data",
 237         privs = {server=true},
 238         func = function(name, param)
 239                 local done = minetest.auth_reload()
 240                 if done then
 241                         minetest.chat_send_player(name, "Done.")
 242                 else
 243                         minetest.chat_send_player(name, "Failed.")
 244                 end
 245         end,
 246 })
 247
 248 minetest.register_chatcommand("teleport", {
 249         params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
 250         description = "teleport to given position",
 251         privs = {teleport=true},
 252         func = function(name, param)
 253                 -- Returns (pos, true) if found, otherwise (pos, false)
 254                 local function find_free_position_near(pos)
 255                         local tries = {
 256                                 {x=1,y=0,z=0},
 257                                 {x=-1,y=0,z=0},
 258                                 {x=0,y=0,z=1},
 259                                 {x=0,y=0,z=-1},
 260                         }
 261                         for _, d in ipairs(tries) do
 262                                 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
 263                                 local n = minetest.env:get_node(p)
 264                                 if not minetest.registered_nodes[n.name].walkable then
 265                                         return p, true
 266                                 end
 267                         end
 268                         return pos, false
 269                 end
 270
 271                 local teleportee = nil
 272                 local p = {}
 273                 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
 274                 teleportee = minetest.env:get_player_by_name(name)
 275                 if teleportee and p.x and p.y and p.z then
 276                         minetest.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
 277                         teleportee:setpos(p)
 278                         return
 279                 end
 280
 281                 local teleportee = nil
 282                 local p = nil
 283                 local target_name = nil
 284                 target_name = string.match(param, "^([^ ]+)$")
 285                 teleportee = minetest.env:get_player_by_name(name)
 286                 if target_name then
 287                         local target = minetest.env:get_player_by_name(target_name)
 288                         if target then
 289                                 p = target:getpos()
 290                         end
 291                 end
 292                 if teleportee and p then
 293                         p = find_free_position_near(p)
 294                         minetest.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
 295                         teleportee:setpos(p)
 296                         return
 297                 end
 298
 299                 if minetest.check_player_privs(name, {bring=true}) then
 300                         local teleportee = nil
 301                         local p = {}
 302                         local teleportee_name = nil
 303                         teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
 304                         if teleportee_name then
 305                                 teleportee = minetest.env:get_player_by_name(teleportee_name)
 306                         end
 307                         if teleportee and p.x and p.y and p.z then
 308                                 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
 309                                 teleportee:setpos(p)
 310                                 return
 311                         end
 312
 313                         local teleportee = nil
 314                         local p = nil
 315                         local teleportee_name = nil
 316                         local target_name = nil
 317                         teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
 318                         if teleportee_name then
 319                                 teleportee = minetest.env:get_player_by_name(teleportee_name)
 320                         end
 321                         if target_name then
 322                                 local target = minetest.env:get_player_by_name(target_name)
 323                                 if target then
 324                                         p = target:getpos()
 325                                 end
 326                         end
 327                         if teleportee and p then
 328                                 p = find_free_position_near(p)
 329                                 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
 330                                 teleportee:setpos(p)
 331                                 return
 332                         end
 333                 end
 334
 335                 minetest.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
 336                 return
 337         end,
 338 })
 339
 340 minetest.register_chatcommand("set", {
 341         params = "[-n] <name> <value> | <name>",
 342         description = "set or read server configuration setting",
 343         privs = {server=true},
 344         func = function(name, param)
 345                 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
 346                 if arg and arg == "-n" and setname and setvalue then
 347                         minetest.setting_set(setname, setvalue)
 348                         minetest.chat_send_player(name, setname.." = "..setvalue)
 349                         return
 350                 end
 351                 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
 352                 if setname and setvalue then
 353                         if not minetest.setting_get(setname) then
 354                                 minetest.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.")
 355                                 return
 356                         end
 357                         minetest.setting_set(setname, setvalue)
 358                         minetest.chat_send_player(name, setname.." = "..setvalue)
 359                         return
 360                 end
 361                 local setname = string.match(param, "([^ ]+)")
 362                 if setname then
 363                         local setvalue = minetest.setting_get(setname)
 364                         if not setvalue then
 365                                 setvalue = "<not set>"
 366                         end
 367                         minetest.chat_send_player(name, setname.." = "..setvalue)
 368                         return
 369                 end
 370                 minetest.chat_send_player(name, "Invalid parameters (see /help set)")
 371         end,
 372 })
 373
 374 minetest.register_chatcommand("mods", {
 375         params = "",
 376         description = "lists mods installed on the server",
 377         privs = {},
 378         func = function(name, param)
 379                 local response = ""
 380                 local modnames = minetest.get_modnames()
 381                 for i, mod in ipairs(modnames) do
 382                         response = response .. mod
 383                         -- Add space if not at the end
 384                         if i ~= #modnames then
 385                                 response = response .. " "
 386                         end
 387                 end
 388                 minetest.chat_send_player(name, response)
 389         end,
 390 })
 391
 392 local function handle_give_command(cmd, giver, receiver, stackstring)
 393         minetest.log("action", giver.." invoked "..cmd..', stackstring="'
 394                         ..stackstring..'"')
 395         minetest.log(cmd..' invoked, stackstring="'..stackstring..'"')
 396         local itemstack = ItemStack(stackstring)
 397         if itemstack:is_empty() then
 398                 minetest.chat_send_player(giver, 'error: cannot give an empty item')
 399                 return
 400         elseif not itemstack:is_known() then
 401                 minetest.chat_send_player(giver, 'error: cannot give an unknown item')
 402                 return
 403         end
 404         local receiverref = minetest.env:get_player_by_name(receiver)
 405         if receiverref == nil then
 406                 minetest.chat_send_player(giver, receiver..' is not a known player')
 407                 return
 408         end
 409         local leftover = receiverref:get_inventory():add_item("main", itemstack)
 410         if leftover:is_empty() then
 411                 partiality = ""
 412         elseif leftover:get_count() == itemstack:get_count() then
 413                 partiality = "could not be "
 414         else
 415                 partiality = "partially "
 416         end
 417         -- The actual item stack string may be different from what the "giver"
 418         -- entered (e.g. big numbers are always interpreted as 2^16-1).
 419         stackstring = itemstack:to_string()
 420         if giver == receiver then
 421                 minetest.chat_send_player(giver, '"'..stackstring
 422                         ..'" '..partiality..'added to inventory.');
 423         else
 424                 minetest.chat_send_player(giver, '"'..stackstring
 425                         ..'" '..partiality..'added to '..receiver..'\'s inventory.');
 426                 minetest.chat_send_player(receiver, '"'..stackstring
 427                         ..'" '..partiality..'added to inventory.');
 428         end
 429 end
 430
 431 minetest.register_chatcommand("give", {
 432         params = "<name> <itemstring>",
 433         description = "give item to player",
 434         privs = {give=true},
 435         func = function(name, param)
 436                 local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
 437                 if not toname or not itemstring then
 438                         minetest.chat_send_player(name, "name and itemstring required")
 439                         return
 440                 end
 441                 handle_give_command("/give", name, toname, itemstring)
 442         end,
 443 })
 444 minetest.register_chatcommand("giveme", {
 445         params = "<itemstring>",
 446         description = "give item to yourself",
 447         privs = {give=true},
 448         func = function(name, param)
 449                 local itemstring = string.match(param, "(.+)$")
 450                 if not itemstring then
 451                         minetest.chat_send_player(name, "itemstring required")
 452                         return
 453                 end
 454                 handle_give_command("/giveme", name, name, itemstring)
 455         end,
 456 })
 457 minetest.register_chatcommand("spawnentity", {
 458         params = "<entityname>",
 459         description = "spawn entity at your position",
 460         privs = {give=true, interact=true},
 461         func = function(name, param)
 462                 local entityname = string.match(param, "(.+)$")
 463                 if not entityname then
 464                         minetest.chat_send_player(name, "entityname required")
 465                         return
 466                 end
 467                 print('/spawnentity invoked, entityname="'..entityname..'"')
 468                 local player = minetest.env:get_player_by_name(name)
 469                 if player == nil then
 470                         print("Unable to spawn entity, player is nil")
 471                         return true -- Handled chat message
 472                 end
 473                 local p = player:getpos()
 474                 p.y = p.y + 1
 475                 minetest.env:add_entity(p, entityname)
 476                 minetest.chat_send_player(name, '"'..entityname
 477                                 ..'" spawned.');
 478         end,
 479 })
 480 minetest.register_chatcommand("pulverize", {
 481         params = "",
 482         description = "delete item in hand",
 483         privs = {},
 484         func = function(name, param)
 485                 local player = minetest.env:get_player_by_name(name)
 486                 if player == nil then
 487                         print("Unable to pulverize, player is nil")
 488                         return true -- Handled chat message
 489                 end
 490                 if player:get_wielded_item():is_empty() then
 491                         minetest.chat_send_player(name, 'Unable to pulverize, no item in hand.')
 492                 else
 493                         player:set_wielded_item(nil)
 494                         minetest.chat_send_player(name, 'An item was pulverized.')
 495                 end
 496         end,
 497 })
 498