Add support for playerfactions mod (#37)

Add faction indicator to HUD

.luacheckrc

@@ -0,0 +1,19 @@
+unused_args = false
+allow_defined_top = true
+
+read_globals = {
+	"DIR_DELIM",
+	"core",
+	"dump",
+	"vector", "nodeupdate",
+	"VoxelManip", "VoxelArea",
+	"PseudoRandom", "ItemStack",
+	"AreaStore",
+	"intllib",
+	"default",
+	table = { fields = { "copy", "getn" } }
+}
+
+globals = {
+	"minetest"
+}

README.md

@@ -1,21 +1,29 @@
-Areas mod for Minetest 0.4.8+
-=============================
+Areas mod for Minetest
+======================
+
+Dependencies
+------------
+
+Minetest 5.0.0+ is recommended, but 0.4.16+ should work as well.
 
 
 Configuration
 -------------
 
-If you wish to specify configuration options, such as whether players are
-allowed to protect their own areas with the `protect` command (disabled by
-default), you should check config.lua and set the appropriate settings in your
-server's configuration file (probably `minetest.conf`).
+Open the tab `Settings -> All Settings -> Mods -> areas` to get a list of all
+possible settings.
+
+For server owners: Check `settingtypes.txt` and modify your `minetest.conf`
+according to the wanted setting changes.
+
 
 
 Tutorial
 --------
 
-To protect an area you must first set the corner positions of the area.
-In order to set the corner positions you can run:
+1) Specify the corner positions of the area you would like to protect.
+Use one of the following commands:
+
   * `/area_pos set` and punch the two corner nodes to set them.
   * `/area_pos set1/set2` and punch only the first or second corner node to
 	set them one at a time.
@@ -23,25 +31,25 @@ In order to set the corner positions you can run:
   * `/area_pos1/2 X Y Z` to set one of the positions to the specified
 	coordinates.
 
-Once you have set the border positions you can protect the area by running one
-of the following commands:
+2) Protect the selected area by running one of the following commands:
+
   * `/set_owner <OwnerName> <AreaName>` -- If you have the `areas` privilege.
   * `/protect <AreaName>` -- If you have the `areas` privilege or the server
 	administrator has enabled area self-protection.
 
-The area name is used only for informational purposes (so that you know what
-an area is for).  It is not used for any other purpose.
+The area name is used only for informational purposes and has no functional
+importance.
+
 For example: `/set_owner SomePlayer Mese city`
 
-Now that you own an area you may want to add sub-owners to it. You can do this
-with the `add_owner` command.  Anyone with an area can use the `add_owner`
-command on their areas.  Before using the `add_owner` command you have to
-select the corners of the sub-area as you did for `set_owner`. If your markers
-are still around your original area and you want to grant access to your
-entire area you will not have to re-set them. You can also use `select_area` to
-place the markers at the corners of an existing area if you've reset your
+3) You now own an area. You may now add sub-owners to it if you want to (see command `/add_owner`). Before using the `/add_owner` command you have to
+select the corners of the sub-area as you did in step 1.
+
+If your markers are still around your original area and you want to grant
+access to your entire area you will not have to re-set them. Use `/select_area` to place the markers at the corners of an existing area if you've reset your
 markers and want to grant access to a full area.
-The `add_owner` command expects three arguments:
+
+The `/add_owner` command expects three arguments:
   1. The ID number of the parent area (the area that you want to add a
 	sub-area to).
   2. The name of the player that will own the sub-area.

api.lua

@@ -1,7 +1,41 @@
+local hudHandlers = {}
+
+
+areas.registered_on_adds = {}
+areas.registered_on_removes = {}
+areas.registered_on_moves = {}
+
+function areas:registerOnAdd(func)
+	table.insert(areas.registered_on_adds, func)
+end
+
+function areas:registerOnRemove(func)
+	table.insert(areas.registered_on_removes, func)
+end
+
+function areas:registerOnMove(func)
+	table.insert(areas.registered_on_moves, func)
+end
+
+
+--- Adds a function as a HUD handler, it will be able to add items to the Areas HUD element.
+function areas:registerHudHandler(handler)
+	table.insert(hudHandlers, handler)
+end
+
+
+function areas:getExternalHudEntries(pos)
+	local areas = {}
+	for _, func in pairs(hudHandlers) do
+		func(pos, areas)
+	end
+	return areas
+end
 
 --- Returns a list of areas that include the provided position.
 function areas:getAreasAtPos(pos)
 	local res = {}
+
 	if self.store then
 		local a = self.store:get_areas_for_pos(pos, false, true)
 		for store_id, store_area in pairs(a) do
@@ -60,9 +94,13 @@ function areas:canInteract(pos, name)
 	for _, area in pairs(self:getAreasAtPos(pos)) do
 		if area.owner == name or area.open then
 			return true
-		else
-			owned = true
+		elseif areas.factions_available and area.faction_open then
+			local faction_name = factions.get_player_faction(area.owner)
+			if faction_name ~= nil and faction_name == factions.get_player_faction(name) then
+				return true
+			end
 		end
+		owned = true
 	end
 	return not owned
 end
@@ -125,4 +163,3 @@ function areas:canInteractInArea(pos1, pos2, name, allow_open)
 	-- intersecting areas and they are all owned by the player.
 	return true
 end
-

api.md

@@ -0,0 +1,48 @@
+Areas mod API
+===
+
+API list
+---
+
+ * `areas:registerHudHandler(handler)` - Registers a handler to add items to the Areas HUD.  See [HUD](#hud).
+ * `areas:registerOnAdd(func(id, area))`
+ * `areas:registerOnRemove(func(id))`
+ * `areas:registerOnMove(func(id, area, pos1, pos2))`
+
+
+HUD
+---
+
+If you are making a protection mod or a similar mod that adds invisible regions
+to the world, and you would like then to show up in the areas HUD element, you
+can register a callback to show your areas.
+
+HUD handler specification:
+
+ * `handler(pos, list)`
+   * `pos` - The position to check.
+   * `list` - The list of area HUD elements, this should be modified in-place.
+
+The area list item is a table containing a list of tables with the following fields:
+
+ * `id` - An identifier for the area. This should be a unique string in the format `mod:id`.
+ * `name` - The name of the area.
+ * `owner` - The player name of the region owner, if any.
+
+All of the fields are optional but at least one of them must be set.
+
+### Example
+
+	local function areas_hud_handler(pos, areas)
+		local val = find_my_protection(pos)
+
+		if val then
+			table.insert(areas, {
+				id = "mod:"..val.id,
+				name = val.name,
+				owner = val.owner,
+			})
+		end
+	end
+
+	areas:registerHudHandler(areas_hud_handler)

chatcommands.lua

@@ -60,7 +60,7 @@ minetest.register_chatcommand("set_owner", {
 
 		local id = areas:add(ownerName, areaName, pos1, pos2, nil)
 		areas:save()
-	
+
 		minetest.chat_send_player(ownerName,
 				"You have been granted control over area #"..
 				id..". Type /list_areas to show your areas.")
@@ -286,6 +286,30 @@ minetest.register_chatcommand("area_open", {
 })
 
 
+if areas.factions_available then
+	minetest.register_chatcommand("area_faction_open", {
+		params = "<ID>",
+		description = "Toggle an area open/closed for members in your faction.",
+		func = function(name, param)
+			local id = tonumber(param)
+			if not id then
+				return false, "Invalid usage, see /help area_faction_open."
+			end
+			
+			if not areas:isAreaOwner(id, name) then
+				return false, "Area "..id.." does not exist"
+						.." or is not owned by you."
+			end
+			local open = not areas.areas[id].faction_open
+			-- Save false as nil to avoid inflating the DB.
+			areas.areas[id].faction_open = open or nil
+			areas:save()
+			return true, ("Area %s for faction members."):format(open and "opened" or "closed")
+		end
+	})
+end
+
+
 minetest.register_chatcommand("move_area", {
 	params = "<ID>",
 	description = "Move (or resize) an area to the current positions.",
@@ -383,10 +407,10 @@ minetest.register_chatcommand("area_info", {
 			table.insert(lines, ("%s spanning up to %dx%dx%d.")
 				:format(str, size.x, size.y, size.z))
 		end
-		local function priv_limit_info(priv, max_count, max_size)
+		local function priv_limit_info(lpriv, lmax_count, lmax_size)
 			size_info(("Players with the %q privilege"..
 				" can protect up to %d areas"):format(
-					priv, max_count), max_size)
+					lpriv, lmax_count), lmax_size)
 		end
 		if self_prot then
 			if privs.areas then

hud.lua

@@ -1,17 +1,43 @@
 -- This is inspired by the landrush mod by Bremaweb
 
 areas.hud = {}
+areas.hud.refresh = 0
 
 minetest.register_globalstep(function(dtime)
+
+	areas.hud.refresh = areas.hud.refresh + dtime
+	if areas.hud.refresh > areas.config["tick"] then
+		areas.hud.refresh = 0
+	else
+		return
+	end
+
 	for _, player in pairs(minetest.get_connected_players()) do
 		local name = player:get_player_name()
-		local pos = vector.round(player:getpos())
+		local pos = vector.round(player:get_pos())
+		pos = vector.apply(pos, function(p)
+			return math.max(math.min(p, 2147483), -2147483)
+		end)
 		local areaStrings = {}
+
 		for id, area in pairs(areas:getAreasAtPos(pos)) do
-			table.insert(areaStrings, ("%s [%u] (%s%s)")
+			local faction_info = area.faction_open and areas.factions_available and
+					factions.get_player_faction(area.owner)
+			area.faction_open = faction_info
+			table.insert(areaStrings, ("%s [%u] (%s%s%s)")
 					:format(area.name, id, area.owner,
-					area.open and ":open" or ""))
+					area.open and ":open" or "",
+					faction_info and ":"..faction_info or ""))
 		end
+
+		for i, area in pairs(areas:getExternalHudEntries(pos)) do
+			local str = ""
+			if area.name then str = area.name .. " " end
+			if area.id then str = str.."["..area.id.."] " end
+			if area.owner then str = str.."("..area.owner..")" end
+			table.insert(areaStrings, str)
+		end
+
 		local areaString = "Areas:"
 		if #areaStrings > 0 then
 			areaString = areaString.."\n"..

init.lua

@@ -4,6 +4,8 @@
 
 areas = {}
 
+areas.factions_available = minetest.global_exists("factions")
+
 areas.adminPrivs = {areas=true}
 areas.startTime = os.clock()
 
@@ -32,7 +34,7 @@ if not minetest.registered_privileges[areas.config.self_protection_privilege] th
 	})
 end
 
-if minetest.setting_getbool("log_mod") then
+if minetest.settings:get_bool("log_mods") then
 	local diffTime = os.clock() - areas.startTime
 	minetest.log("action", "areas loaded in "..diffTime.."s.")
 end

internal.lua

@@ -1,6 +1,18 @@
 
 function areas:player_exists(name)
-	return minetest.auth_table[name] ~= nil
+	return minetest.get_auth_handler().get_auth(name) ~= nil
+end
+
+local safe_file_write = minetest.safe_file_write
+if safe_file_write == nil then
+	function safe_file_write(path, content)
+		local file, err = io.open(path, "w")
+		if err then
+			return err
+		end
+		file:write(content)
+		file:close()
+	end
 end
 
 -- Save the areas table to a file
@@ -10,12 +22,7 @@ function areas:save()
 		minetest.log("error", "[areas] Failed to serialize area data!")
 		return
 	end
-	local file, err = io.open(self.config.filename, "w")
-	if err then
-		return err
-	end
-	file:write(datastr)
-	file:close()
+	return safe_file_write(self.config.filename, datastr)
 end
 
 -- Load the areas table from the save file
@@ -86,6 +93,11 @@ function areas:add(owner, name, pos1, pos2, parent)
 		owner = owner,
 		parent = parent
 	}
+
+	for i=1, #areas.registered_on_adds do
+		areas.registered_on_adds[i](id, self.areas[id])
+	end
+
 	-- Add to AreaStore
 	if self.store then
 		local sid = self.store:insert_area(pos1, pos2, tostring(id))
@@ -118,6 +130,10 @@ function areas:remove(id, recurse)
 		end
 	end
 
+	for i=1, #areas.registered_on_removes do
+		areas.registered_on_removes[i](id)
+	end
+
 	-- Remove main entry
 	self.areas[id] = nil
 
@@ -133,6 +149,11 @@ function areas:move(id, area, pos1, pos2)
 	area.pos1 = pos1
 	area.pos2 = pos2
 
+
+	for i=1, #areas.registered_on_moves do
+		areas.registered_on_moves[i](id, area, pos1, pos2)
+	end
+
 	if self.store then
 		self.store:remove_area(areas.store_ids[id])
 		local sid = self.store:insert_area(pos1, pos2, tostring(id))
@@ -282,4 +303,3 @@ function areas:isAreaOwner(id, name)
 	end
 	return false
 end
-

legacy.lua

@@ -10,7 +10,7 @@ minetest.register_chatcommand("legacy_load_areas", {
 		minetest.chat_send_player(name, "Converting areas...")
 		local version = tonumber(param)
 		if version == 0 then
-			err = areas:node_ownership_load()
+			local err = areas:node_ownership_load()
 			if err then
 				minetest.chat_send_player(name, "Error loading legacy file: "..err)
 				return
@@ -48,6 +48,7 @@ minetest.register_chatcommand("legacy_load_areas", {
 
 function areas:node_ownership_load()
 	local filename = minetest.get_worldpath().."/owners.tbl"
+	local tables, err
 	tables, err = loadfile(filename)
 	if err then
 		return err

mod.conf

@@ -0,0 +1,2 @@
+name = areas
+optional_depends = playerfactions

pos.lua

@@ -11,6 +11,16 @@ areas.set_pos = {}
 areas.pos1 = {}
 areas.pos2 = {}
 
+local LIMIT = 30992 -- this is due to MAPBLOCK_SIZE=16!
+
+local function posLimit(pos)
+	return {
+		x = math.max(math.min(pos.x, LIMIT), -LIMIT),
+		y = math.max(math.min(pos.y, LIMIT), -LIMIT),
+		z = math.max(math.min(pos.z, LIMIT), -LIMIT)
+	}
+end
+
 minetest.register_chatcommand("select_area", {
 	params = "<ID>",
 	description = "Select a area by id.",
@@ -35,7 +45,7 @@ minetest.register_chatcommand("area_pos1", {
 		.." location or the one specified",
 	privs = {},
 	func = function(name, param)
-		local pos = nil
+		local pos
 		local found, _, x, y, z = param:find(
 				"^(-?%d+)[, ](-?%d+)[, ](-?%d+)$")
 		if found then
@@ -43,14 +53,14 @@ minetest.register_chatcommand("area_pos1", {
 		elseif param == "" then
 			local player = minetest.get_player_by_name(name)
 			if player then
-				pos = player:getpos()
+				pos = player:get_pos()
 			else
 				return false, "Unable to get position."
 			end
 		else
 			return false, "Invalid usage, see /help area_pos1."
 		end
-		pos = vector.round(pos)
+		pos = posLimit(vector.round(pos))
 		areas:setPos1(name, pos)
 		return true, "Area position 1 set to "
 				..minetest.pos_to_string(pos)
@@ -62,7 +72,7 @@ minetest.register_chatcommand("area_pos2", {
 	description = "Set area protection region position 2 to your"
 		.." location or the one specified",
 	func = function(name, param)
-		local pos = nil
+		local pos
 		local found, _, x, y, z = param:find(
 				"^(-?%d+)[, ](-?%d+)[, ](-?%d+)$")
 		if found then
@@ -70,14 +80,14 @@ minetest.register_chatcommand("area_pos2", {
 		elseif param == "" then
 			local player = minetest.get_player_by_name(name)
 			if player then
-				pos = player:getpos()
+				pos = player:get_pos()
 			else
 				return false, "Unable to get position."
 			end
 		else
 			return false, "Invalid usage, see /help area_pos2."
 		end
-		pos = vector.round(pos)
+		pos = posLimit(vector.round(pos))
 		areas:setPos2(name, pos)
 		return true, "Area position 2 set to "
 				..minetest.pos_to_string(pos)
@@ -130,12 +140,12 @@ function areas:getPos(playerName)
 end
 
 function areas:setPos1(playerName, pos)
-	areas.pos1[playerName] = pos
+	areas.pos1[playerName] = posLimit(pos)
 	areas.markPos1(playerName)
 end
 
 function areas:setPos2(playerName, pos)
-	areas.pos2[playerName] = pos
+	areas.pos2[playerName] = posLimit(pos)
 	areas.markPos2(playerName)
 end
 

settings.lua

@@ -2,42 +2,45 @@ local world_path = minetest.get_worldpath()
 
 areas.config = {}
 
-local function setting(tp, name, default)
-	local full_name = "areas."..name
+local function setting(name, tp, default)
+	local full_name = "areas." .. name
 	local value
-	if tp == "boolean" then
-		value = minetest.setting_getbool(full_name)
+	if tp == "bool" then
+		value = minetest.settings:get_bool(full_name)
+		default = value == nil and minetest.is_yes(default)
 	elseif tp == "string" then
-		value = minetest.setting_get(full_name)
-	elseif tp == "position" then
+		value = minetest.settings:get(full_name)
+	elseif tp == "v3f" then
 		value = minetest.setting_get_pos(full_name)
-	elseif tp == "number" then
-		value = tonumber(minetest.setting_get(full_name))
+		default = value == nil and minetest.string_to_pos(default)
+	elseif tp == "float" or tp == "int" then
+		value = tonumber(minetest.settings:get(full_name))
+		local v, other = default:match("^(%S+) (.+)")
+		default = value == nil and tonumber(other and v or default)
 	else
-		error("Invalid setting type!")
+		error("Cannot parse setting type " .. tp)
 	end
+
 	if value == nil then
 		value = default
+		assert(default ~= nil, "Cannot parse default for " .. full_name)
 	end
+	--print("add", name, default, value)
 	areas.config[name] = value
 end
 
+local file = io.open(areas.modpath .. "/settingtypes.txt", "r")
+for line in file:lines() do
+	local name, tp, value = line:match("^areas%.(%S+) %(.*%) (%S+) (.*)")
+	if value then
+		setting(name, tp, value)
+	end
+end
+file:close()
+
 --------------
 -- Settings --
 --------------
 
-setting("string", "filename", world_path.."/areas.dat")
-
--- Allow players with a privilege create their own areas
--- within the maximum size and number.
-setting("boolean",  "self_protection", false)
-setting("string",   "self_protection_privilege", "interact")
-setting("position", "self_protection_max_size",      {x=64,  y=128, z=64})
-setting("number",   "self_protection_max_areas",      4)
--- For players with the areas_high_limit privilege.
-setting("position", "self_protection_max_size_high", {x=512, y=512, z=512})
-setting("number",   "self_protection_max_areas_high", 32)
-
--- legacy_table (owner_defs) compatibility.  Untested and has known issues.
-setting("boolean", "legacy_table", false)
+setting("filename", "string", world_path.."/areas.dat")
 

settingtypes.txt

@@ -0,0 +1,38 @@
+# This file is parsed in "settings.lua". Check regex first.
+
+# Static paths do not work well with settings
+#areas.filename (Configuration file path) string (world_path)/areas.dat
+
+# Allow players with a privilege create their own areas using /protect
+# within the specified size and amount limits.
+areas.self_protection (Self protection) bool false
+
+# Self protection: Privilege required to protect an area
+areas.self_protection_privilege (Self protection: Required privs) string interact
+
+# Refresh delay for the name displays in the HUD in seconds
+areas.tick (HUD update delay) float 0.5 0 100
+
+# Enable the legacy owner_defs metatable mode. Untested and possibly unstable
+areas.legacy_table (Legacy owner_defs metatable) bool false
+
+[Self protection (normal)]
+
+# Self protection (normal): Maximal size of the protectable area
+# Only enter positive whole numbers for the coordinate values or you'll mess up stuff.
+areas.self_protection_max_size (Maximal area size) v3f (64, 128, 64)
+
+# Self protection (normal): Maximal amount of protected areas per player
+areas.self_protection_max_areas (Maximal area count) int 4
+
+[Self protection (high)]
+
+# Self protection (normal): Maximal size of the protectable area
+# This setting applies for plyaers with the privilege 'areas_high_limit'
+areas.self_protection_max_size_high (Maximal area size) v3f (512, 512, 512)
+
+# Self protection (normal): Maximal amount of protected areas per player
+# Only enter positive whole numbers for the coordinate values or you'll mess up stuff.
+# This setting applies for plyaers with the privilege 'areas_high_limit'
+areas.self_protection_max_areas_high (Maximal area count) float 32
+