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)"})
  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                         end
 107                 end
 108                 minetest.chat_send_player(name, "Privileges of "..param..": "..minetest.privs_to_string(minetest.get_player_privs(param), ' '))
 109         end,
 110 })
 111 minetest.register_chatcommand("grant", {
 112         params = "<name> <privilege>|all",
 113         description = "Give privilege to player",
 114         privs = {},
 115         func = function(name, param)
 116                 if not minetest.check_player_privs(name, {privs=true}) and
 117                                 not minetest.check_player_privs(name, {basic_privs=true}) then
 118                         minetest.chat_send_player(name, "Your privileges are insufficient.")
 119                         return
 120                 end
 121                 local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
 122                 if not grantname or not grantprivstr then
 123                         minetest.chat_send_player(name, "Invalid parameters (see /help grant)")
 124                         return
 125                 end
 126                 local grantprivs = minetest.string_to_privs(grantprivstr)
 127                 if grantprivstr == "all" then
 128                         grantprivs = minetest.registered_privileges
 129                 end
 130                 local privs = minetest.get_player_privs(grantname)
 131                 local privs_known = true
 132                 for priv, _ in pairs(grantprivs) do
 133                         if priv ~= "interact" and priv ~= "shout" and not minetest.check_player_privs(name, {privs=true}) then
 134                                 minetest.chat_send_player(name, "Your privileges are insufficient.")
 135                                 return
 136                         end
 137                         if not minetest.registered_privileges[priv] then
 138                                 minetest.chat_send_player(name, "Unknown privilege: "..priv)
 139                                 privs_known = false
 140                         end
 141                         privs[priv] = true
 142                 end
 143                 if not privs_known then
 144                         return
 145                 end
 146                 minetest.set_player_privs(grantname, privs)
 147                 minetest.chat_send_player(name, "Privileges of "..grantname..": "..minetest.privs_to_string(minetest.get_player_privs(grantname), ' '))
 148                 if grantname ~= name then
 149                         minetest.chat_send_player(grantname, name.." granted you privileges: "..minetest.privs_to_string(grantprivs, ' '))
 150                 end
 151         end,
 152 })
 153 minetest.register_chatcommand("revoke", {
 154         params = "<name> <privilege>|all",
 155         description = "Remove privilege from player",
 156         privs = {},
 157         func = function(name, param)
 158                 if not minetest.check_player_privs(name, {privs=true}) and
 159                                 not minetest.check_player_privs(name, {basic_privs=true}) then
 160                         minetest.chat_send_player(name, "Your privileges are insufficient.")
 161                         return
 162                 end
 163                 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
 164                 if not revokename or not revokeprivstr then
 165                         minetest.chat_send_player(name, "Invalid parameters (see /help revoke)")
 166                         return
 167                 end
 168                 local revokeprivs = minetest.string_to_privs(revokeprivstr)
 169                 local privs = minetest.get_player_privs(revokename)
 170                 for priv, _ in pairs(revokeprivs) do
 171                         if priv ~= "interact" and priv ~= "shout" and not minetest.check_player_privs(name, {privs=true}) then
 172                                 minetest.chat_send_player(name, "Your privileges are insufficient.")
 173                                 return
 174                         end
 175                 end
 176                 if revokeprivstr == "all" then
 177                         privs = {}
 178                 else
 179                         for priv, _ in pairs(revokeprivs) do
 180                                 privs[priv] = nil
 181                         end
 182                 end
 183                 minetest.set_player_privs(revokename, privs)
 184                 minetest.chat_send_player(name, "Privileges of "..revokename..": "..minetest.privs_to_string(minetest.get_player_privs(revokename), ' '))
 185                 if revokename ~= name then
 186                         minetest.chat_send_player(revokename, name.." revoked privileges from you: "..minetest.privs_to_string(revokeprivs, ' '))
 187                 end
 188         end,
 189 })
 190 minetest.register_chatcommand("setpassword", {
 191         params = "<name> <password>",
 192         description = "set given password",
 193         privs = {password=true},
 194         func = function(name, param)
 195                 if param == "" then
 196                         minetest.chat_send_player(name, "Password field required")
 197                         return
 198                 end
 199                 minetest.set_player_password(name, param)
 200                 minetest.chat_send_player(name, "Password set")
 201         end,
 202 })
 203 minetest.register_chatcommand("clearpassword", {
 204         params = "<name>",
 205         description = "set empty password",
 206         privs = {password=true},
 207         func = function(name, param)
 208                 minetest.set_player_password(name, '')
 209                 minetest.chat_send_player(name, "Password cleared")
 210         end,
 211 })
 212
 213 minetest.register_chatcommand("auth_reload", {
 214         params = "",
 215         description = "reload authentication data",
 216         privs = {server=true},
 217         func = function(name, param)
 218                 local done = minetest.auth_reload()
 219                 if done then
 220                         minetest.chat_send_player(name, "Done.")
 221                 else
 222                         minetest.chat_send_player(name, "Failed.")
 223                 end
 224         end,
 225 })
 226
 227 minetest.register_chatcommand("teleport", {
 228         params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
 229         description = "teleport to given position",
 230         privs = {teleport=true},
 231         func = function(name, param)
 232                 -- Returns (pos, true) if found, otherwise (pos, false)
 233                 local function find_free_position_near(pos)
 234                         local tries = {
 235                                 {x=1,y=0,z=0},
 236                                 {x=-1,y=0,z=0},
 237                                 {x=0,y=0,z=1},
 238                                 {x=0,y=0,z=-1},
 239                         }
 240                         for _, d in ipairs(tries) do
 241                                 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
 242                                 local n = minetest.env:get_node(p)
 243                                 if not minetest.registered_nodes[n.name].walkable then
 244                                         return p, true
 245                                 end
 246                         end
 247                         return pos, false
 248                 end
 249
 250                 local teleportee = nil
 251                 local p = {}
 252                 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
 253                 teleportee = minetest.env:get_player_by_name(name)
 254                 if teleportee and p.x and p.y and p.z then
 255                         minetest.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
 256                         teleportee:setpos(p)
 257                         return
 258                 end
 259
 260                 local teleportee = nil
 261                 local p = nil
 262                 local target_name = nil
 263                 target_name = string.match(param, "^([^ ]+)$")
 264                 teleportee = minetest.env:get_player_by_name(name)
 265                 if target_name then
 266                         local target = minetest.env:get_player_by_name(target_name)
 267                         if target then
 268                                 p = target:getpos()
 269                         end
 270                 end
 271                 if teleportee and p then
 272                         p = find_free_position_near(p)
 273                         minetest.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
 274                         teleportee:setpos(p)
 275                         return
 276                 end
 277
 278                 if minetest.check_player_privs(name, {bring=true}) then
 279                         local teleportee = nil
 280                         local p = {}
 281                         local teleportee_name = nil
 282                         teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
 283                         if teleportee_name then
 284                                 teleportee = minetest.env:get_player_by_name(teleportee_name)
 285                         end
 286                         if teleportee and p.x and p.y and p.z then
 287                                 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
 288                                 teleportee:setpos(p)
 289                                 return
 290                         end
 291
 292                         local teleportee = nil
 293                         local p = nil
 294                         local teleportee_name = nil
 295                         local target_name = nil
 296                         teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
 297                         if teleportee_name then
 298                                 teleportee = minetest.env:get_player_by_name(teleportee_name)
 299                         end
 300                         if target_name then
 301                                 local target = minetest.env:get_player_by_name(target_name)
 302                                 if target then
 303                                         p = target:getpos()
 304                                 end
 305                         end
 306                         if teleportee and p then
 307                                 p = find_free_position_near(p)
 308                                 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
 309                                 teleportee:setpos(p)
 310                                 return
 311                         end
 312                 end
 313
 314                 minetest.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
 315                 return
 316         end,
 317 })
 318
 319 minetest.register_chatcommand("set", {
 320         params = "[-n] <name> <value> | <name>",
 321         description = "set or read server configuration setting",
 322         privs = {server=true},
 323         func = function(name, param)
 324                 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
 325                 if arg and arg == "-n" and setname and setvalue then
 326                         minetest.setting_set(setname, setvalue)
 327                         minetest.chat_send_player(name, setname.." = "..setvalue)
 328                         return
 329                 end
 330                 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
 331                 if setname and setvalue then
 332                         if not minetest.setting_get(setname) then
 333                                 minetest.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.")
 334                                 return
 335                         end
 336                         minetest.setting_set(setname, setvalue)
 337                         minetest.chat_send_player(name, setname.." = "..setvalue)
 338                         return
 339                 end
 340                 local setname = string.match(param, "([^ ]+)")
 341                 if setname then
 342                         local setvalue = minetest.setting_get(setname)
 343                         if not setvalue then
 344                                 setvalue = "<not set>"
 345                         end
 346                         minetest.chat_send_player(name, setname.." = "..setvalue)
 347                         return
 348                 end
 349                 minetest.chat_send_player(name, "Invalid parameters (see /help set)")
 350         end,
 351 })
 352