builtin/builtin.lua

   1 --
   2 -- This file contains built-in stuff in Minetest implemented in Lua.
   3 --
   4 -- It is always loaded and executed after registration of the C API,
   5 -- before loading and running any mods.
   6 --
   7
   8 --
   9 -- Override some Lua library functions
  10 --
  11
  12 print = minetest.debug
  13
  14 --
  15 -- Define some random basic things
  16 --
  17
  18 function basic_dump2(o)
  19         if type(o) == "number" then
  20                 return tostring(o)
  21         elseif type(o) == "string" then
  22                 return string.format("%q", o)
  23         elseif type(o) == "boolean" then
  24                 return tostring(o)
  25         elseif type(o) == "function" then
  26                 return "<function>"
  27         elseif type(o) == "userdata" then
  28                 return "<userdata>"
  29         elseif type(o) == "nil" then
  30                 return "nil"
  31         else
  32                 error("cannot dump a " .. type(o))
  33                 return nil
  34         end
  35 end
  36
  37 function dump2(o, name, dumped)
  38         name = name or "_"
  39         dumped = dumped or {}
  40         io.write(name, " = ")
  41         if type(o) == "number" or type(o) == "string" or type(o) == "boolean"
  42                         or type(o) == "function" or type(o) == "nil"
  43                         or type(o) == "userdata" then
  44                 io.write(basic_dump2(o), "\n")
  45         elseif type(o) == "table" then
  46                 if dumped[o] then
  47                         io.write(dumped[o], "\n")
  48                 else
  49                         dumped[o] = name
  50                         io.write("{}\n") -- new table
  51                         for k,v in pairs(o) do
  52                                 local fieldname = string.format("%s[%s]", name, basic_dump2(k))
  53                                 dump2(v, fieldname, dumped)
  54                         end
  55                 end
  56         else
  57                 error("cannot dump a " .. type(o))
  58                 return nil
  59         end
  60 end
  61
  62 function dump(o, dumped)
  63         dumped = dumped or {}
  64         if type(o) == "number" then
  65                 return tostring(o)
  66         elseif type(o) == "string" then
  67                 return string.format("%q", o)
  68         elseif type(o) == "table" then
  69                 if dumped[o] then
  70                         return "<circular reference>"
  71                 end
  72                 dumped[o] = true
  73                 local t = {}
  74                 for k,v in pairs(o) do
  75                         t[#t+1] = "" .. k .. " = " .. dump(v, dumped)
  76                 end
  77                 return "{" .. table.concat(t, ", ") .. "}"
  78         elseif type(o) == "boolean" then
  79                 return tostring(o)
  80         elseif type(o) == "function" then
  81                 return "<function>"
  82         elseif type(o) == "userdata" then
  83                 return "<userdata>"
  84         elseif type(o) == "nil" then
  85                 return "nil"
  86         else
  87                 error("cannot dump a " .. type(o))
  88                 return nil
  89         end
  90 end
  91
  92 function string:split(sep)
  93         local sep, fields = sep or ",", {}
  94         local pattern = string.format("([^%s]+)", sep)
  95         self:gsub(pattern, function(c) fields[#fields+1] = c end)
  96         return fields
  97 end
  98
  99 function string:trim()
 100         return (self:gsub("^%s*(.-)%s*$", "%1"))
 101 end
 102
 103 assert(string.trim("\n \t\tfoo\t ") == "foo")
 104
 105 --
 106 -- Item definition helpers
 107 --
 108
 109 function minetest.inventorycube(img1, img2, img3)
 110         img2 = img2 or img1
 111         img3 = img3 or img1
 112         return "[inventorycube"
 113                         .. "{" .. img1:gsub("%^", "&")
 114                         .. "{" .. img2:gsub("%^", "&")
 115                         .. "{" .. img3:gsub("%^", "&")
 116 end
 117
 118 function minetest.pos_to_string(pos)
 119         return "(" .. pos.x .. "," .. pos.y .. "," .. pos.z .. ")"
 120 end
 121
 122 function minetest.get_pointed_thing_position(pointed_thing, above)
 123         if pointed_thing.type == "node" then
 124                 if above then
 125                         -- The position where a node would be placed
 126                         return pointed_thing.above
 127                 else
 128                         -- The position where a node would be dug
 129                         return pointed_thing.under
 130                 end
 131         elseif pointed_thing.type == "object" then
 132                 obj = pointed_thing.ref
 133                 if obj ~= nil then
 134                         return obj:getpos()
 135                 else
 136                         return nil
 137                 end
 138         else
 139                 return nil
 140         end
 141 end
 142
 143 function minetest.dir_to_facedir(dir)
 144         if math.abs(dir.x) > math.abs(dir.z) then
 145                 if dir.x < 0 then
 146                         return 3
 147                 else
 148                         return 1
 149                 end
 150         else
 151                 if dir.z < 0 then
 152                         return 2
 153                 else
 154                         return 0
 155                 end
 156         end
 157 end
 158
 159 function minetest.dir_to_wallmounted(dir)
 160         if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
 161                 if dir.y < 0 then
 162                         return 1
 163                 else
 164                         return 0
 165                 end
 166         elseif math.abs(dir.x) > math.abs(dir.z) then
 167                 if dir.x < 0 then
 168                         return 3
 169                 else
 170                         return 2
 171                 end
 172         else
 173                 if dir.z < 0 then
 174                         return 5
 175                 else
 176                         return 4
 177                 end
 178         end
 179 end
 180
 181 function minetest.get_node_drops(nodename, toolname)
 182         local drop = ItemStack({name=nodename}):get_definition().drop
 183         if drop == nil then
 184                 -- default drop
 185                 return {ItemStack({name=nodename})}
 186         elseif type(drop) == "string" then
 187                 -- itemstring drop
 188                 return {ItemStack(drop)}
 189         elseif drop.items == nil then
 190                 -- drop = {} to disable default drop
 191                 return {}
 192         end
 193
 194         -- Extended drop table
 195         local got_items = {}
 196         local got_count = 0
 197         local _, item, tool
 198         for _, item in ipairs(drop.items) do
 199                 local good_rarity = true
 200                 local good_tool = true
 201                 if item.rarity ~= nil then
 202                         good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
 203                 end
 204                 if item.tools ~= nil then
 205                         good_tool = false
 206                         for _, tool in ipairs(item.tools) do
 207                                 if tool:sub(1, 1) == '~' then
 208                                         good_tool = toolname:find(tool:sub(2)) ~= nil
 209                                 else
 210                                         good_tool = toolname == tool
 211                                 end
 212                                 if good_tool then
 213                                         break
 214                                 end
 215                         end
 216                 end
 217                 if good_rarity and good_tool then
 218                         got_count = got_count + 1
 219                         for _, add_item in ipairs(item.items) do
 220                                 got_items[#got_items+1] = add_item
 221                         end
 222                         if drop.max_items ~= nil and got_count == drop.max_items then
 223                                 break
 224                         end
 225                 end
 226         end
 227         return got_items
 228 end
 229
 230 function minetest.item_place_node(itemstack, placer, pointed_thing)
 231         local item = itemstack:peek_item()
 232         local def = itemstack:get_definition()
 233         if def.type == "node" and pointed_thing.type == "node" then
 234                 local pos = pointed_thing.above
 235                 local oldnode = minetest.env:get_node(pos)
 236                 local olddef = ItemStack({name=oldnode.name}):get_definition()
 237
 238                 if not olddef.buildable_to then
 239                         minetest.log("info", placer:get_player_name() .. " tried to place"
 240                                 .. " node in invalid position " .. minetest.pos_to_string(pos)
 241                                 .. ", replacing " .. oldnode.name)
 242                         return
 243                 end
 244
 245                 minetest.log("action", placer:get_player_name() .. " places node "
 246                         .. def.name .. " at " .. minetest.pos_to_string(pos))
 247
 248                 local newnode = {name = def.name, param1 = 0, param2 = 0}
 249
 250                 -- Calculate direction for wall mounted stuff like torches and signs
 251                 if def.paramtype2 == 'wallmounted' then
 252                         local under = pointed_thing.under
 253                         local above = pointed_thing.above
 254                         local dir = {x = under.x - above.x, y = under.y - above.y, z = under.z - above.z}
 255                         newnode.param2 = minetest.dir_to_wallmounted(dir)
 256                 -- Calculate the direction for furnaces and chests and stuff
 257                 elseif def.paramtype2 == 'facedir' then
 258                         local playerpos = placer:getpos()
 259                         local dir = {x = pos.x - playerpos.x, y = pos.y - playerpos.y, z = pos.z - playerpos.z}
 260                         newnode.param2 = minetest.dir_to_facedir(dir)
 261                         minetest.log("action", "facedir: " .. newnode.param2)
 262                 end
 263
 264                 -- Add node and update
 265                 minetest.env:add_node(pos, newnode)
 266
 267                 -- Set metadata owner
 268                 if def.metadata_name ~= "" then
 269                         minetest.env:get_meta(pos):set_owner(placer:get_player_name())
 270                 end
 271
 272                 -- Run script hook
 273                 local _, callback
 274                 for _, callback in ipairs(minetest.registered_on_placenodes) do
 275                         callback(pos, newnode, placer)
 276                 end
 277
 278                 itemstack:take_item()
 279         end
 280         return itemstack
 281 end
 282
 283 function minetest.item_place_object(itemstack, placer, pointed_thing)
 284         local pos = minetest.get_pointed_thing_position(pointed_thing, true)
 285         if pos ~= nil then
 286                 local item = itemstack:take_item()
 287                 minetest.env:add_item(pos, item)
 288         end
 289         return itemstack
 290 end
 291
 292 function minetest.item_place(itemstack, placer, pointed_thing)
 293         if itemstack:get_definition().type == "node" then
 294                 return minetest.item_place_node(itemstack, placer, pointed_thing)
 295         else
 296                 return minetest.item_place_object(itemstack, placer, pointed_thing)
 297         end
 298 end
 299
 300 function minetest.item_drop(itemstack, dropper, pos)
 301         minetest.env:add_item(pos, itemstack)
 302         return ""
 303 end
 304
 305 function minetest.item_eat(hp_change, replace_with_item)
 306         return function(itemstack, user, pointed_thing)  -- closure
 307                 if itemstack:take_item() ~= nil then
 308                         user:set_hp(user:get_hp() + hp_change)
 309                         itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
 310                 end
 311                 return itemstack
 312         end
 313 end
 314
 315 function minetest.node_punch(pos, node, puncher)
 316         -- Run script hook
 317         local _, callback
 318         for _, callback in ipairs(minetest.registered_on_punchnodes) do
 319                 callback(pos, node, puncher)
 320         end
 321
 322 end
 323
 324 function minetest.node_dig(pos, node, digger)
 325         minetest.debug("node_dig")
 326
 327         local def = ItemStack({name=node.name}):get_definition()
 328         if not def.diggable then
 329                 minetest.debug("not diggable")
 330                 minetest.log("info", digger:get_player_name() .. " tried to dig "
 331                         .. node.name .. " which is not diggable "
 332                         .. minetest.pos_to_string(pos))
 333                 return
 334         end
 335
 336         local meta = minetest.env:get_meta(pos)
 337         if meta ~= nil and not meta:get_allow_removal() then
 338                 minetest.debug("dig prevented by metadata")
 339                 minetest.log("info", digger:get_player_name() .. " tried to dig "
 340                         .. node.name .. ", but removal is disabled by metadata "
 341                         .. minetest.pos_to_string(pos))
 342                 return
 343         end
 344
 345         minetest.log('action', digger:get_player_name() .. " digs "
 346                 .. node.name .. " at " .. minetest.pos_to_string(pos))
 347
 348         if not minetest.setting_getbool("creative_mode") then
 349                 local wielded = digger:get_wielded_item()
 350                 local drops = minetest.get_node_drops(node.name, wielded:get_name())
 351
 352                 -- Wear out tool
 353                 tp = wielded:get_tool_capabilities()
 354                 dp = minetest.get_dig_params(def.groups, tp)
 355                 wielded:add_wear(dp.wear)
 356                 digger:set_wielded_item(wielded)
 357
 358                 -- Add dropped items
 359                 local _, dropped_item
 360                 for _, dropped_item in ipairs(drops) do
 361                         digger:get_inventory():add_item("main", dropped_item)
 362                 end
 363         end
 364
 365         -- Remove node and update
 366         minetest.env:remove_node(pos)
 367
 368         -- Run script hook
 369         local _, callback
 370         for _, callback in ipairs(minetest.registered_on_dignodes) do
 371                 callback(pos, node, digger)
 372         end
 373 end
 374
 375 --
 376 -- Item definition defaults
 377 --
 378
 379 minetest.nodedef_default = {
 380         -- Item properties
 381         type="node",
 382         -- name intentionally not defined here
 383         description = "",
 384         groups = {},
 385         inventory_image = "",
 386         wield_image = "",
 387         wield_scale = {x=1,y=1,z=1},
 388         stack_max = 99,
 389         usable = false,
 390         liquids_pointable = false,
 391         tool_capabilities = nil,
 392
 393         -- Interaction callbacks
 394         on_place = minetest.item_place,
 395         on_drop = minetest.item_drop,
 396         on_use = nil,
 397
 398         on_punch = minetest.node_punch,
 399         on_dig = minetest.node_dig,
 400
 401         -- Node properties
 402         drawtype = "normal",
 403         visual_scale = 1.0,
 404         tile_images = {""},
 405         special_materials = {
 406                 {image="", backface_culling=true},
 407                 {image="", backface_culling=true},
 408         },
 409         alpha = 255,
 410         post_effect_color = {a=0, r=0, g=0, b=0},
 411         paramtype = "none",
 412         paramtype2 = "none",
 413         is_ground_content = false,
 414         sunlight_propagates = false,
 415         walkable = true,
 416         pointable = true,
 417         diggable = true,
 418         climbable = false,
 419         buildable_to = false,
 420         metadata_name = "",
 421         liquidtype = "none",
 422         liquid_alternative_flowing = "",
 423         liquid_alternative_source = "",
 424         liquid_viscosity = 0,
 425         light_source = 0,
 426         damage_per_second = 0,
 427         selection_box = {type="regular"},
 428         legacy_facedir_simple = false,
 429         legacy_wallmounted = false,
 430 }
 431
 432 minetest.craftitemdef_default = {
 433         type="craft",
 434         -- name intentionally not defined here
 435         description = "",
 436         groups = {},
 437         inventory_image = "",
 438         wield_image = "",
 439         wield_scale = {x=1,y=1,z=1},
 440         stack_max = 99,
 441         liquids_pointable = false,
 442         tool_capabilities = nil,
 443
 444         -- Interaction callbacks
 445         on_place = minetest.item_place,
 446         on_drop = minetest.item_drop,
 447         on_use = nil,
 448 }
 449
 450 minetest.tooldef_default = {
 451         type="tool",
 452         -- name intentionally not defined here
 453         description = "",
 454         groups = {},
 455         inventory_image = "",
 456         wield_image = "",
 457         wield_scale = {x=1,y=1,z=1},
 458         stack_max = 1,
 459         liquids_pointable = false,
 460         tool_capabilities = nil,
 461
 462         -- Interaction callbacks
 463         on_place = minetest.item_place,
 464         on_drop = minetest.item_drop,
 465         on_use = nil,
 466 }
 467
 468 minetest.noneitemdef_default = {  -- This is used for the hand and unknown items
 469         type="none",
 470         -- name intentionally not defined here
 471         description = "",
 472         groups = {},
 473         inventory_image = "",
 474         wield_image = "",
 475         wield_scale = {x=1,y=1,z=1},
 476         stack_max = 99,
 477         liquids_pointable = false,
 478         tool_capabilities = nil,
 479
 480         -- Interaction callbacks
 481         on_place = nil,
 482         on_drop = nil,
 483         on_use = nil,
 484 }
 485
 486 --
 487 -- Make raw registration functions inaccessible to anyone except builtin.lua
 488 --
 489
 490 local register_item_raw = minetest.register_item_raw
 491 minetest.register_item_raw = nil
 492
 493 local register_alias_raw = minetest.register_alias_raw
 494 minetest.register_item_raw = nil
 495
 496 --
 497 -- Item / entity / ABM registration functions
 498 --
 499
 500 minetest.registered_abms = {}
 501 minetest.registered_entities = {}
 502 minetest.registered_items = {}
 503 minetest.registered_nodes = {}
 504 minetest.registered_craftitems = {}
 505 minetest.registered_tools = {}
 506 minetest.registered_aliases = {}
 507
 508 -- For tables that are indexed by item name:
 509 -- If table[X] does not exist, default to table[minetest.registered_aliases[X]]
 510 local function set_alias_metatable(table)
 511         setmetatable(table, {
 512                 __index = function(name)
 513                         return rawget(table, minetest.registered_aliases[name])
 514                 end
 515         })
 516 end
 517 set_alias_metatable(minetest.registered_items)
 518 set_alias_metatable(minetest.registered_nodes)
 519 set_alias_metatable(minetest.registered_craftitems)
 520 set_alias_metatable(minetest.registered_tools)
 521
 522 -- These item names may not be used because they would interfere
 523 -- with legacy itemstrings
 524 local forbidden_item_names = {
 525         MaterialItem = true,
 526         MaterialItem2 = true,
 527         MaterialItem3 = true,
 528         NodeItem = true,
 529         node = true,
 530         CraftItem = true,
 531         craft = true,
 532         MBOItem = true,
 533         ToolItem = true,
 534         tool = true,
 535 }
 536
 537 local function check_modname_prefix(name)
 538         if name:sub(1,1) == ":" then
 539                 -- Escape the modname prefix enforcement mechanism
 540                 return name:sub(2)
 541         else
 542                 -- Modname prefix enforcement
 543                 local expected_prefix = minetest.get_current_modname() .. ":"
 544                 if name:sub(1, #expected_prefix) ~= expected_prefix then
 545                         error("Name " .. name .. " does not follow naming conventions: " ..
 546                                 "\"modname:\" or \":\" prefix required")
 547                 end
 548                 local subname = name:sub(#expected_prefix+1)
 549                 if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
 550                         error("Name " .. name .. " does not follow naming conventions: " ..
 551                                 "contains unallowed characters")
 552                 end
 553                 return name
 554         end
 555 end
 556
 557 function minetest.register_abm(spec)
 558         -- Add to minetest.registered_abms
 559         minetest.registered_abms[#minetest.registered_abms+1] = spec
 560 end
 561
 562 function minetest.register_entity(name, prototype)
 563         -- Check name
 564         if name == nil then
 565                 error("Unable to register entity: Name is nil")
 566         end
 567         name = check_modname_prefix(tostring(name))
 568
 569         prototype.name = name
 570         prototype.__index = prototype  -- so that it can be used as a metatable
 571
 572         -- Add to minetest.registered_entities
 573         minetest.registered_entities[name] = prototype
 574 end
 575
 576 function minetest.register_item(name, itemdef)
 577         -- Check name
 578         if name == nil then
 579                 error("Unable to register item: Name is nil")
 580         end
 581         name = check_modname_prefix(tostring(name))
 582         if forbidden_item_names[name] then
 583                 error("Unable to register item: Name is forbidden: " .. name)
 584         end
 585         itemdef.name = name
 586
 587         -- Apply defaults and add to registered_* table
 588         if itemdef.type == "node" then
 589                 setmetatable(itemdef, {__index = minetest.nodedef_default})
 590                 minetest.registered_nodes[itemdef.name] = itemdef
 591         elseif itemdef.type == "craft" then
 592                 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
 593                 minetest.registered_craftitems[itemdef.name] = itemdef
 594         elseif itemdef.type == "tool" then
 595                 setmetatable(itemdef, {__index = minetest.tooldef_default})
 596                 minetest.registered_tools[itemdef.name] = itemdef
 597         elseif itemdef.type == "none" then
 598                 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
 599         else
 600                 error("Unable to register item: Type is invalid: " .. dump(itemdef))
 601         end
 602
 603         -- Flowing liquid uses param2
 604         if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
 605                 itemdef.paramtype2 = "flowingliquid"
 606         end
 607
 608         -- BEGIN Legacy stuff
 609         if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
 610                 minetest.register_craft({
 611                         type="cooking",
 612                         output=itemdef.cookresult_itemstring,
 613                         recipe=itemdef.name,
 614                         cooktime=itemdef.furnace_cooktime
 615                 })
 616         end
 617         if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
 618                 minetest.register_craft({
 619                         type="fuel",
 620                         recipe=itemdef.name,
 621                         burntime=itemdef.furnace_burntime
 622                 })
 623         end
 624         -- END Legacy stuff
 625
 626         -- Disable all further modifications
 627         getmetatable(itemdef).__newindex = {}
 628
 629         --minetest.log("Registering item: " .. itemdef.name)
 630         minetest.registered_items[itemdef.name] = itemdef
 631         minetest.registered_aliases[itemdef.name] = nil
 632         register_item_raw(itemdef)
 633 end
 634
 635 function minetest.register_node(name, nodedef)
 636         nodedef.type = "node"
 637         minetest.register_item(name, nodedef)
 638 end
 639
 640 function minetest.register_craftitem(name, craftitemdef)
 641         craftitemdef.type = "craft"
 642
 643         -- BEGIN Legacy stuff
 644         if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
 645                 craftitemdef.inventory_image = craftitemdef.image
 646         end
 647         -- END Legacy stuff
 648
 649         minetest.register_item(name, craftitemdef)
 650 end
 651
 652 function minetest.register_tool(name, tooldef)
 653         tooldef.type = "tool"
 654         tooldef.stack_max = 1
 655
 656         -- BEGIN Legacy stuff
 657         if tooldef.inventory_image == nil and tooldef.image ~= nil then
 658                 tooldef.inventory_image = tooldef.image
 659         end
 660         if tooldef.tool_capabilities == nil and
 661            (tooldef.full_punch_interval ~= nil or
 662             tooldef.basetime ~= nil or
 663             tooldef.dt_weight ~= nil or
 664             tooldef.dt_crackiness ~= nil or
 665             tooldef.dt_crumbliness ~= nil or
 666             tooldef.dt_cuttability ~= nil or
 667             tooldef.basedurability ~= nil or
 668             tooldef.dd_weight ~= nil or
 669             tooldef.dd_crackiness ~= nil or
 670             tooldef.dd_crumbliness ~= nil or
 671             tooldef.dd_cuttability ~= nil) then
 672                 tooldef.tool_capabilities = {
 673                         full_punch_interval = tooldef.full_punch_interval,
 674                         basetime = tooldef.basetime,
 675                         dt_weight = tooldef.dt_weight,
 676                         dt_crackiness = tooldef.dt_crackiness,
 677                         dt_crumbliness = tooldef.dt_crumbliness,
 678                         dt_cuttability = tooldef.dt_cuttability,
 679                         basedurability = tooldef.basedurability,
 680                         dd_weight = tooldef.dd_weight,
 681                         dd_crackiness = tooldef.dd_crackiness,
 682                         dd_crumbliness = tooldef.dd_crumbliness,
 683                         dd_cuttability = tooldef.dd_cuttability,
 684                 }
 685         end
 686         -- END Legacy stuff
 687
 688         minetest.register_item(name, tooldef)
 689 end
 690
 691 function minetest.register_alias(name, convert_to)
 692         if forbidden_item_names[name] then
 693                 error("Unable to register alias: Name is forbidden: " .. name)
 694         end
 695         if minetest.registered_items[name] ~= nil then
 696                 minetest.log("WARNING: Not registering alias, item with same name" ..
 697                         " is already defined: " .. name .. " -> " .. convert_to)
 698         else
 699                 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
 700                 minetest.registered_aliases[name] = convert_to
 701                 register_alias_raw(name, convert_to)
 702         end
 703 end
 704
 705 -- Alias the forbidden item names to "" so they can't be
 706 -- created via itemstrings (e.g. /give)
 707 local name
 708 for name in pairs(forbidden_item_names) do
 709         minetest.registered_aliases[name] = ""
 710         register_alias_raw(name, "")
 711 end
 712
 713
 714 -- Deprecated:
 715 -- Aliases for minetest.register_alias (how ironic...)
 716 --minetest.alias_node = minetest.register_alias
 717 --minetest.alias_tool = minetest.register_alias
 718 --minetest.alias_craftitem = minetest.register_alias
 719
 720 --
 721 -- Built-in node definitions. Also defined in C.
 722 --
 723
 724 minetest.register_item(":unknown", {
 725         type = "none",
 726         description = "Unknown Item",
 727         inventory_image = "unknown_item.png",
 728         on_place = minetest.item_place,
 729         on_drop = minetest.item_drop,
 730 })
 731
 732 minetest.register_node(":air", {
 733         description = "Air (you hacker you!)",
 734         inventory_image = "unknown_block.png",
 735         wield_image = "unknown_block.png",
 736         drawtype = "airlike",
 737         paramtype = "light",
 738         sunlight_propagates = true,
 739         walkable = false,
 740         pointable = false,
 741         diggable = false,
 742         buildable_to = true,
 743         air_equivalent = true,
 744 })
 745
 746 minetest.register_node(":ignore", {
 747         description = "Ignore (you hacker you!)",
 748         inventory_image = "unknown_block.png",
 749         wield_image = "unknown_block.png",
 750         drawtype = "airlike",
 751         paramtype = "none",
 752         sunlight_propagates = false,
 753         walkable = false,
 754         pointable = false,
 755         diggable = false,
 756         buildable_to = true, -- A way to remove accidentally placed ignores
 757         air_equivalent = true,
 758 })
 759
 760 -- The hand (bare definition)
 761 minetest.register_item(":", {
 762         type = "none",
 763 })
 764
 765 --
 766 -- Default material types
 767 --
 768 function digprop_err()
 769         minetest.log("info", debug.traceback())
 770         minetest.log("info", "WARNING: The minetest.digprop_* functions are obsolete and need to be replaced by item groups.")
 771 end
 772
 773 minetest.digprop_constanttime = digprop_err
 774 minetest.digprop_stonelike = digprop_err
 775 minetest.digprop_dirtlike = digprop_err
 776 minetest.digprop_gravellike = digprop_err
 777 minetest.digprop_woodlike = digprop_err
 778 minetest.digprop_leaveslike = digprop_err
 779 minetest.digprop_glasslike = digprop_err
 780
 781 --
 782 -- Creative inventory
 783 --
 784
 785 minetest.creative_inventory = {}
 786
 787 minetest.add_to_creative_inventory = function(itemstring)
 788         table.insert(minetest.creative_inventory, itemstring)
 789 end
 790
 791 --
 792 -- Callback registration
 793 --
 794
 795 local function make_registration()
 796         local t = {}
 797         local registerfunc = function(func) table.insert(t, func) end
 798         return t, registerfunc
 799 end
 800
 801 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
 802 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
 803 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
 804 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
 805 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
 806 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
 807 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
 808 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
 809 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
 810 minetest.registered_on_joinplayers, minetest.register_on_joinplayer = make_registration()
 811 minetest.registered_on_leaveplayers, minetest.register_on_leaveplayer = make_registration()
 812
 813 --
 814 -- Misc. API functions
 815 --
 816
 817 minetest.timers_to_add = {}
 818 minetest.timers = {}
 819 minetest.register_globalstep(function(dtime)
 820         for _, timer in ipairs(minetest.timers_to_add) do
 821                 table.insert(minetest.timers, timer)
 822         end
 823         minetest.timers_to_add = {}
 824         for index, timer in ipairs(minetest.timers) do
 825                 timer.time = timer.time - dtime
 826                 if timer.time <= 0 then
 827                         timer.func(timer.param)
 828                         table.remove(minetest.timers,index)
 829                 end
 830         end
 831 end)
 832
 833 function minetest.after(time, func, param)
 834         table.insert(minetest.timers_to_add, {time=time, func=func, param=param})
 835 end
 836
 837 function minetest.check_player_privs(name, privs)
 838         local player_privs = minetest.get_player_privs(name)
 839         local missing_privileges = {}
 840         for priv, val in pairs(privs) do
 841                 if val then
 842                         if not player_privs[priv] then
 843                                 table.insert(missing_privileges, priv)
 844                         end
 845                 end
 846         end
 847         if #missing_privileges > 0 then
 848                 return false, missing_privileges
 849         end
 850         return true, ""
 851 end
 852
 853 function minetest.get_connected_players()
 854         -- This could be optimized a bit, but leave that for later
 855         local list = {}
 856         for _, obj in pairs(minetest.env:get_objects_inside_radius({x=0,y=0,z=0}, 1000000)) do
 857                 if obj:get_player_name() then
 858                         table.insert(list, obj)
 859                 end
 860         end
 861         return list
 862 end
 863
 864 function minetest.hash_node_position(pos)
 865         return (pos.z+32768)*65536*65536 + (pos.y+32768)*65536 + pos.x+32768
 866 end
 867
 868 --
 869 -- Privileges
 870 --
 871
 872 minetest.registered_privileges = {}
 873 function minetest.register_privilege(name, description)
 874         minetest.registered_privileges[name] = description
 875 end
 876
 877 minetest.register_privilege("interact", "Can interact with things and modify the world")
 878 minetest.register_privilege("teleport", "Can use /teleport command")
 879 minetest.register_privilege("bring", "Can teleport other players")
 880 minetest.register_privilege("settime", "Can use /time")
 881 minetest.register_privilege("privs", "Can modify privileges")
 882 minetest.register_privilege("server", "Can do server maintenance stuff")
 883 minetest.register_privilege("shout", "Can speak in chat")
 884 minetest.register_privilege("ban", "Can ban and unban players")
 885 minetest.register_privilege("give", "Can use /give and /giveme")
 886 minetest.register_privilege("password", "Can use /setpassword and /clearpassword")
 887
 888 --
 889 -- Chat commands
 890 --
 891
 892 minetest.chatcommands = {}
 893 function minetest.register_chatcommand(cmd, def)
 894         def = def or {}
 895         def.params = def.params or ""
 896         def.description = def.description or ""
 897         def.privs = def.privs or {}
 898         minetest.chatcommands[cmd] = def
 899 end
 900
 901 -- Register the help command
 902 minetest.register_chatcommand("help", {
 903         privs = {},
 904         params = "(nothing)/all/privs/<cmd>",
 905         description = "Get help for commands or list privileges",
 906         func = function(name, param)
 907                 local format_help_line = function(cmd, def)
 908                         local msg = "/"..cmd
 909                         if def.params and def.params ~= "" then msg = msg .. " " .. def.params end
 910                         if def.description and def.description ~= "" then msg = msg .. ": " .. def.description end
 911                         return msg
 912                 end
 913                 if param == "" then
 914                         local msg = ""
 915                         cmds = {}
 916                         for cmd, def in pairs(minetest.chatcommands) do
 917                                 if minetest.check_player_privs(name, def.privs) then
 918                                         table.insert(cmds, cmd)
 919                                 end
 920                         end
 921                         minetest.chat_send_player(name, "Available commands: "..table.concat(cmds, " "))
 922                         minetest.chat_send_player(name, "Use '/help <cmd>' to get more information, or '/help all' to list everything.")
 923                 elseif param == "all" then
 924                         minetest.chat_send_player(name, "Available commands:")
 925                         for cmd, def in pairs(minetest.chatcommands) do
 926                                 if minetest.check_player_privs(name, def.privs) then
 927                                         minetest.chat_send_player(name, format_help_line(cmd, def))
 928                                 end
 929                         end
 930                 elseif param == "privs" then
 931                         minetest.chat_send_player(name, "Available privileges:")
 932                         for priv, desc in pairs(minetest.registered_privileges) do
 933                                 minetest.chat_send_player(name, priv..": "..desc)
 934                         end
 935                 else
 936                         local cmd = param
 937                         def = minetest.chatcommands[cmd]
 938                         if not def then
 939                                 minetest.chat_send_player(name, "Command not available: "..cmd)
 940                         else
 941                                 minetest.chat_send_player(name, format_help_line(cmd, def))
 942                         end
 943                 end
 944         end,
 945 })
 946
 947 -- Register C++ commands without functions
 948 minetest.register_chatcommand("me", {params = nil, description = "chat action (eg. /me orders a pizza)"})
 949 minetest.register_chatcommand("status", {description = "print server status line"})
 950 minetest.register_chatcommand("shutdown", {params = "", description = "shutdown server", privs = {server=true}})
 951 minetest.register_chatcommand("setting", {params = "<name> = <value>", description = "set line in configuration file", privs = {server=true}})
 952 minetest.register_chatcommand("clearobjects", {params = "", description = "clear all objects in world", privs = {server=true}})
 953 minetest.register_chatcommand("time", {params = "<0...24000>", description = "set time of day", privs = {settime=true}})
 954 minetest.register_chatcommand("ban", {params = "<name>", description = "ban IP of player", privs = {ban=true}})
 955 minetest.register_chatcommand("unban", {params = "<name/ip>", description = "remove IP ban", privs = {ban=true}})
 956
 957 -- Register some other commands
 958 minetest.register_chatcommand("privs", {
 959         params = "<name>",
 960         description = "print out privileges of player",
 961         func = function(name, param)
 962                 if param == "" then
 963                         param = name
 964                 else
 965                         if not minetest.check_player_privs(name, {privs=true}) then
 966                                 minetest.chat_send_player(name, "Privileges of "..param.." are hidden from you.")
 967                         end
 968                 end
 969                 privs = {}
 970                 for priv, _ in pairs(minetest.get_player_privs(param)) do
 971                         table.insert(privs, priv)
 972                 end
 973                 minetest.chat_send_player(name, "Privileges of "..param..": "..table.concat(privs, " "))
 974         end,
 975 })
 976 minetest.register_chatcommand("grant", {
 977         params = "<name> <privilege>",
 978         description = "Give privilege to player",
 979         privs = {privs=true},
 980         func = function(name, param)
 981                 local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
 982                 if not grantname or not grantprivstr then
 983                         minetest.chat_send_player(name, "Invalid parameters (see /help grant)")
 984                         return
 985                 end
 986                 local grantprivs = minetest.string_to_privs(grantprivstr)
 987                 local privs = minetest.get_player_privs(grantname)
 988                 for priv, _ in pairs(grantprivs) do
 989                         privs[priv] = true
 990                 end
 991                 minetest.set_player_privs(grantname, privs)
 992         end,
 993 })
 994 minetest.register_chatcommand("revoke", {
 995         params = "<name> <privilege>",
 996         description = "Remove privilege from player",
 997         privs = {privs=true},
 998         func = function(name, param)
 999                 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
1000                 if not revokename or not revokeprivstr then
1001                         minetest.chat_send_player(name, "Invalid parameters (see /help revoke)")
1002                         return
1003                 end
1004                 local revokeprivs = minetest.string_to_privs(revokeprivstr)
1005                 local privs = minetest.get_player_privs(revokename)
1006                 for priv, _ in pairs(revokeprivs) do
1007                         table.remove(privs, priv)
1008                 end
1009                 minetest.set_player_privs(revokename, privs)
1010         end,
1011 })
1012 minetest.register_chatcommand("setpassword", {
1013         params = "<name> <password>",
1014         description = "set given password",
1015         privs = {password=true},
1016         func = function(name, param)
1017                 if param == "" then
1018                         minetest.chat_send_player(name, "Password field required")
1019                         return
1020                 end
1021                 minetest.set_player_password(name, param)
1022                 minetest.chat_send_player(name, "Password set")
1023         end,
1024 })
1025 minetest.register_chatcommand("clearpassword", {
1026         params = "<name>",
1027         description = "set empty password",
1028         privs = {password=true},
1029         func = function(name, param)
1030                 minetest.set_player_password(name, '')
1031                 minetest.chat_send_player(name, "Password cleared")
1032         end,
1033 })
1034
1035 minetest.register_chatcommand("teleport", {
1036         params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
1037         description = "teleport to given position",
1038         privs = {teleport=true},
1039         func = function(name, param)
1040                 -- Returns (pos, true) if found, otherwise (pos, false)
1041                 local function find_free_position_near(pos)
1042                         local tries = {
1043                                 {x=1,y=0,z=0},
1044                                 {x=-1,y=0,z=0},
1045                                 {x=0,y=0,z=1},
1046                                 {x=0,y=0,z=-1},
1047                         }
1048                         for _, d in ipairs(tries) do
1049                                 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
1050                                 local n = minetest.env:get_node(p)
1051                                 if not minetest.registered_nodes[n.name].walkable then
1052                                         return p, true
1053                                 end
1054                         end
1055                         return pos, false
1056                 end
1057
1058                 local teleportee = nil
1059                 local p = {}
1060                 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
1061                 teleportee = minetest.env:get_player_by_name(name)
1062                 if teleportee and p.x and p.y and p.z then
1063                         minetest.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
1064                         teleportee:setpos(p)
1065                         return
1066                 end
1067
1068                 local teleportee = nil
1069                 local p = nil
1070                 local target_name = nil
1071                 target_name = string.match(param, "^([^ ]+)$")
1072                 teleportee = minetest.env:get_player_by_name(name)
1073                 if target_name then
1074                         local target = minetest.env:get_player_by_name(target_name)
1075                         if target then
1076                                 p = target:getpos()
1077                         end
1078                 end
1079                 if teleportee and p then
1080                         p = find_free_position_near(p)
1081                         minetest.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
1082                         teleportee:setpos(p)
1083                         return
1084                 end
1085
1086                 if minetest.check_player_privs(name, {bring=true}) then
1087                         local teleportee = nil
1088                         local p = {}
1089                         local teleportee_name = nil
1090                         teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
1091                         if teleportee_name then
1092                                 teleportee = minetest.env:get_player_by_name(teleportee_name)
1093                         end
1094                         if teleportee and p.x and p.y and p.z then
1095                                 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
1096                                 teleportee:setpos(p)
1097                                 return
1098                         end
1099
1100                         local teleportee = nil
1101                         local p = nil
1102                         local teleportee_name = nil
1103                         local target_name = nil
1104                         teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
1105                         if teleportee_name then
1106                                 teleportee = minetest.env:get_player_by_name(teleportee_name)
1107                         end
1108                         if target_name then
1109                                 local target = minetest.env:get_player_by_name(target_name)
1110                                 if target then
1111                                         p = target:getpos()
1112                                 end
1113                         end
1114                         if teleportee and p then
1115                                 p = find_free_position_near(p)
1116                                 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
1117                                 teleportee:setpos(p)
1118                                 return
1119                         end
1120                 end
1121
1122                 minetest.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
1123                 return
1124         end,
1125 })
1126
1127 --
1128 -- Builtin chat handler
1129 --
1130
1131 minetest.register_on_chat_message(function(name, message)
1132         local cmd, param = string.match(message, "/([^ ]+) *(.*)")
1133         if not param then
1134                 param = ""
1135         end
1136         local cmd_def = minetest.chatcommands[cmd]
1137         if cmd_def then
1138                 if not cmd_def.func then
1139                         -- This is a C++ command
1140                         return false
1141                 else
1142                         local has_privs, missing_privs = minetest.check_player_privs(name, cmd_def.privs)
1143                         if has_privs then
1144                                 cmd_def.func(name, param)
1145                         else
1146                                 minetest.chat_send_player(name, "You don't have permission to run this command (missing privileges: "..table.concat(missing_privs, ", ")..")")
1147                         end
1148                         return true -- handled chat message
1149                 end
1150         end
1151         return false
1152 end)
1153
1154 --
1155 -- Authentication handler
1156 --
1157
1158 function minetest.string_to_privs(str)
1159         assert(type(str) == "string")
1160         privs = {}
1161         for _, priv in pairs(string.split(str, ',')) do
1162                 privs[priv:trim()] = true
1163         end
1164         return privs
1165 end
1166
1167 function minetest.privs_to_string(privs)
1168         assert(type(privs) == "table")
1169         list = {}
1170         for priv, bool in pairs(privs) do
1171                 if bool then
1172                         table.insert(list, priv)
1173                 end
1174         end
1175         return table.concat(list, ',')
1176 end
1177
1178 assert(minetest.string_to_privs("a,b").b == true)
1179 assert(minetest.privs_to_string({a=true,b=true}) == "a,b")
1180
1181 minetest.auth_file_path = minetest.get_worldpath().."/auth.txt"
1182 minetest.auth_table = {}
1183
1184 local function read_auth_file()
1185         local newtable = {}
1186         local file, errmsg = io.open(minetest.auth_file_path, 'rb')
1187         if not file then
1188                 minetest.log("info", minetest.auth_file_path.." could not be opened for reading ("..errmsg.."); assuming new world")
1189                 return
1190         end
1191         for line in file:lines() do
1192                 if line ~= "" then
1193                         local name, password, privilegestring = string.match(line, "([^:]*):([^:]*):([^:]*)")
1194                         if not name or not password or not privilegestring then
1195                                 error("Invalid line in auth.txt: "..dump(line))
1196                         end
1197                         local privileges = minetest.string_to_privs(privilegestring)
1198                         newtable[name] = {password=password, privileges=privileges}
1199                 end
1200         end
1201         io.close(file)
1202         minetest.auth_table = newtable
1203 end
1204
1205 local function save_auth_file()
1206         local newtable = {}
1207         -- Check table for validness before attempting to save
1208         for name, stuff in pairs(minetest.auth_table) do
1209                 assert(type(name) == "string")
1210                 assert(name ~= "")
1211                 assert(type(stuff) == "table")
1212                 assert(type(stuff.password) == "string")
1213                 assert(type(stuff.privileges) == "table")
1214         end
1215         local file, errmsg = io.open(minetest.auth_file_path, 'w+b')
1216         if not file then
1217                 error(minetest.auth_file_path.." could not be opened for writing: "..errmsg)
1218         end
1219         for name, stuff in pairs(minetest.auth_table) do
1220                 local privstring = minetest.privs_to_string(stuff.privileges)
1221                 file:write(name..":"..stuff.password..":"..privstring..'\n')
1222         end
1223         io.close(file)
1224 end
1225
1226 read_auth_file()
1227
1228 minetest.builtin_auth_handler = {
1229         get_auth = function(name)
1230                 assert(type(name) == "string")
1231                 if not minetest.auth_table[name] then
1232                         minetest.builtin_auth_handler.create_auth(name, minetest.get_password_hash(name, minetest.setting_get("default_password")))
1233                 end
1234                 if minetest.is_singleplayer() then
1235                         return {
1236                                 password = "",
1237                                 privileges = minetest.registered_privileges
1238                         }
1239                 else
1240                         if minetest.auth_table[name] and name == minetest.setting_get("name") then
1241                                 return {
1242                                         password = minetest.auth_table[name].password,
1243                                         privileges = minetest.registered_privileges
1244                                 }
1245                         else
1246                                 return minetest.auth_table[name]
1247                         end
1248                 end
1249         end,
1250         create_auth = function(name, password)
1251                 assert(type(name) == "string")
1252                 assert(type(password) == "string")
1253                 minetest.log('info', "Built-in authentication handler adding player '"..name.."'")
1254                 minetest.auth_table[name] = {
1255                         password = password,
1256                         privileges = minetest.string_to_privs(minetest.setting_get("default_privs")),
1257                 }
1258                 save_auth_file()
1259         end,
1260         set_password = function(name, password)
1261                 assert(type(name) == "string")
1262                 assert(type(password) == "string")
1263                 if not minetest.auth_table[name] then
1264                         minetest.builtin_auth_handler.create_auth(name, password)
1265                 else
1266                         minetest.log('info', "Built-in authentication handler setting password of player '"..name.."'")
1267                         minetest.auth_table[name].password = password
1268                         save_auth_file()
1269                 end
1270         end,
1271         set_privileges = function(name, privileges)
1272                 assert(type(name) == "string")
1273                 assert(type(privileges) == "table")
1274                 if not minetest.auth_table[name] then
1275                         minetest.builtin_auth_handler.create_auth(name, minetest.get_password_hash(name, minetest.setting_get("default_password")))
1276                 end
1277                 minetest.auth_table[name].privileges = privileges
1278                 save_auth_file()
1279         end
1280 }
1281
1282 function minetest.register_authentication_handler(handler)
1283         if minetest.registered_auth_handler then
1284                 error("Add-on authentication handler already registered by "..minetest.registered_auth_handler_modname)
1285         end
1286         minetest.registered_auth_handler = handler
1287         minetest.registered_auth_handler_modname = minetest.get_current_modname()
1288 end
1289
1290 function minetest.get_auth_handler()
1291         if minetest.registered_auth_handler then
1292                 return minetest.registered_auth_handler
1293         end
1294         return minetest.builtin_auth_handler
1295 end
1296
1297 function minetest.set_player_password(name, password)
1298         minetest.get_auth_handler().set_password(name, password)
1299 end
1300
1301 function minetest.set_player_privs(name, privs)
1302         minetest.get_auth_handler().set_privileges(name, privs)
1303 end
1304
1305 --
1306 -- Set random seed
1307 --
1308
1309 math.randomseed(os.time())
1310
1311 -- END