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