Updated pipeworks' textures and mechanisms

mods/pipeworks/common.lua

@@ -126,9 +126,18 @@ end
 function fs_helpers.cycling_button(meta, base, meta_name, values)
 	local current_value = meta:get_int(meta_name)
 	local new_value = (current_value + 1) % (#values)
-	local text = values[current_value + 1]
+	local val = values[current_value + 1]
+	local text
+	local texture_name = nil
+	--when we get a table, we know the caller wants an image_button
+	if type(val) == "table" then
+		text = val["text"]
+		texture_name = val["texture"]
+	else
+		text = val
+	end
 	local field = "fs_helpers_cycling:"..new_value..":"..meta_name
-	return base..";"..field..";"..minetest.formspec_escape(text).."]"
+	return base..";"..(texture_name and texture_name..";" or "")..field..";"..minetest.formspec_escape(text).."]"
 end
 
 ---------

mods/pipeworks/teleport_tube.lua

@@ -1,53 +1,76 @@
-
 local filename=minetest.get_worldpath() .. "/teleport_tubes"
 
-local function read_file()
+local tp_tube_db = nil -- nil forces a read
-	local f = io.open(filename, "r")
+local tp_tube_db_version = 2.0
-	if f == nil then return {} end
+
-    	local t = f:read("*all")
+local function hash(pos)
-    	f:close()
+	return string.format("%d", minetest.hash_node_position(pos))
-	if t == "" or t == nil then return {} end
-	return minetest.deserialize(t)
 end
 
-local function write_file(tbl)
+local function save_tube_db()
-	local f = io.open(filename, "w")
+	local file, err = io.open(filename, "w")
-    	f:write(minetest.serialize(tbl))
+	if file then
-    	f:close()
+		tp_tube_db.version = tp_tube_db_version
+		file:write(minetest.serialize(tp_tube_db))
+		tp_tube_db.version = nil
+		io.close(file)
+	else
+		error(err)
+	end
 end
 
-local function update_pos_in_file(pos)
+local function migrate_tube_db()
-	local tbl=read_file()
+		local tmp_db = {}
-	for _, val in ipairs(tbl) do
+		tp_tube_db.version = nil
-		if val.x == pos.x and val.y == pos.y and val.z == pos.z then
+		for key, val in pairs(tp_tube_db) do
-			local meta = minetest.get_meta(val)
+			if(val.channel ~= "") then -- skip unconfigured tubes
-			val.channel = meta:get_string("channel")
+				tmp_db[hash(val)] = val
-			val.cr = meta:get_int("can_receive")
+			end
+		end
+		tp_tube_db = tmp_db
+		save_tube_db()
+end
+
+local function read_tube_db()
+	local file = io.open(filename, "r")
+	if file ~= nil then
+		local file_content = file:read("*all")
+		io.close(file)
+
+		if file_content and file_content ~= "" then
+			tp_tube_db = minetest.deserialize(file_content)
+			if(not tp_tube_db.version or tonumber(tp_tube_db.version) < tp_tube_db_version) then
+				migrate_tube_db()
+			end
+			tp_tube_db.version = nil -- we add it back when saving
+			return tp_tube_db -- we read sucessfully
 		end
 	end
-	write_file(tbl)
+	tp_tube_db = {}
+	return tp_tube_db
 end
 
-local function add_tube_in_file(pos,channel, cr)
+-- updates or adds a tube
-	local tbl=read_file()
+local function set_tube(pos, channel, can_receive)
-	for _,val in ipairs(tbl) do
+	local tubes = tp_tube_db or read_tube_db()
-		if val.x==pos.x and val.y==pos.y and val.z==pos.z then
+	local hash = hash(pos)
-			return
+	local tube = tubes[hash]
-		end
+	if tube then
+		tube.channel = channel
+		tube.cr = can_receive
+		save_tube_db()
+		return
 	end
-	table.insert(tbl,{x=pos.x,y=pos.y,z=pos.z,channel=channel,cr=cr})
+
-	write_file(tbl)
+	-- we haven't found any tp tube to update, so lets add it
+	tp_tube_db[hash] = {x=pos.x,y=pos.y,z=pos.z,channel=channel,cr=can_receive}
+	save_tube_db()
 end
 
-local function remove_tube_in_file(pos)
+local function remove_tube(pos)
-	local tbl = read_file()
+	local tubes = tp_tube_db or read_tube_db()
-	local newtbl = {}
+	tubes[hash(pos)] = nil
-	for _, val in ipairs(tbl) do
+	save_tube_db()
-		if val.x ~= pos.x or val.y ~= pos.y or val.z ~= pos.z then
-			table.insert(newtbl, val)
-		end
-	end
-	write_file(newtbl)
 end
 
 local function read_node_with_vm(pos)
@@ -58,39 +81,28 @@ local function read_node_with_vm(pos)
 	return minetest.get_name_from_content_id(data[area:index(pos.x, pos.y, pos.z)])
 end
 
-local function get_tubes_in_file(pos,channel)
+local function get_receivers(pos, channel)
-	local tbl = read_file()
+	local tubes = tp_tube_db or read_tube_db()
-	local newtbl = {}
+	local receivers = {}
-	local changed = false
+	local dirty = false
-	for _, val in ipairs(tbl) do
+	for key, val in pairs(tubes) do
-		local meta = minetest.get_meta(val)
+		-- skip all non-receivers and the tube that it came from as early as possible, as this is called often
-		local name = read_node_with_vm(val)
+		if (val.cr == 1 and val.channel == channel and (val.x ~= pos.x or val.y ~= pos.y or val.z ~= pos.z)) then
-		local is_loaded = (minetest.get_node_or_nil(val) ~= nil)
+			local is_loaded = (minetest.get_node_or_nil(val) ~= nil)
-		local is_teleport_tube = minetest.registered_nodes[name] and minetest.registered_nodes[name].is_teleport_tube
+			local node_name = is_loaded and minetest.get_node(pos).name or read_node_with_vm(val)
-		if is_teleport_tube then
+
-			if is_loaded and (val.channel ~= meta:get_string("channel") or val.cr ~= meta:get_int("can_receive")) then
+			if minetest.registered_nodes[node_name] and minetest.registered_nodes[node_name].is_teleport_tube then
-				val.channel = meta:get_string("channel")
+				table.insert(receivers, val)
-				val.cr = meta:get_int("can_receive")
+			else
-				changed = true
+				tp_tube_db[key] = nil
-			end
+				dirty = true
-			if val.cr == 1 and val.channel == channel and (val.x ~= pos.x or val.y ~= pos.y or val.z ~= pos.z) then
-				table.insert(newtbl, val)
-			end
-		else
-			val.to_remove = true
-			changed = true
-		end
-	end
-	if changed then
-		local updated = {}
-		for _, val in ipairs(tbl) do
-			if not val.to_remove then
-				table.insert(updated, val)
 			end
 		end
-		write_file(updated)
 	end
-	return newtbl
+	if dirty then
+		save_tube_db()
+	end
+	return receivers
 end
 
 local teleport_noctr_textures={"pipeworks_teleport_tube_noctr.png","pipeworks_teleport_tube_noctr.png","pipeworks_teleport_tube_noctr.png",
@@ -102,11 +114,11 @@ local teleport_end_textures={"pipeworks_teleport_tube_end.png","pipeworks_telepo
 local teleport_short_texture="pipeworks_teleport_tube_short.png"
 local teleport_inv_texture="pipeworks_teleport_tube_inv.png"
 
-local function set_teleport_tube_formspec(meta)
+local function set_teleport_tube_formspec(meta, can_receive)
-	local cr = meta:get_int("can_receive") ~= 0
+	local cr = (can_receive ~= 0)
 	meta:set_string("formspec","size[10.5,1;]"..
-		"field[0,0.5;7,1;channel;Channel:;${channel}]"..
+			"field[0,0.5;7,1;channel;Channel:;${channel}]"..
-		"button[8,0;2.5,1;"..(cr and "cr0" or "cr1")..";"..
+			"button[8,0;2.5,1;"..(cr and "cr0" or "cr1")..";"..
 			(cr and "Send and Receive" or "Send only").."]")
 end
 
@@ -118,10 +130,13 @@ pipeworks.register_tube("pipeworks:teleport_tube","Teleporting Pneumatic Tube Se
 			velocity.x = 0
 			velocity.y = 0
 			velocity.z = 0
-			local meta = minetest.get_meta(pos)
+
-			local channel = meta:get_string("channel")
+			local channel = minetest.get_meta(pos):get_string("channel")
-			local target = get_tubes_in_file(pos,channel)
+			if channel == "" then return {} end
+
+			local target = get_receivers(pos, channel)
 			if target[1] == nil then return {} end
+
 			local d = math.random(1,#target)
 			pos.x = target[d].x
 			pos.y = target[d].y
@@ -131,50 +146,79 @@ pipeworks.register_tube("pipeworks:teleport_tube","Teleporting Pneumatic Tube Se
 	},
 	on_construct = function(pos)
 		local meta = minetest.get_meta(pos)
-		meta:set_string("channel","")
+		meta:set_int("can_receive", 1)
-		meta:set_int("can_receive",1)
+		set_teleport_tube_formspec(meta, 1)
-		add_tube_in_file(pos,"")
-		set_teleport_tube_formspec(meta)
 	end,
 	on_receive_fields = function(pos,formname,fields,sender)
+		if not fields.channel then
+			return -- ignore escaping or clientside manipulation of the form
+		end
+
 		local meta = minetest.get_meta(pos)
+		local can_receive = meta:get_int("can_receive")
 
-		--check for private channels
+		-- check for private channels each time before actually changing anything
-		if fields.channel ~= nil then
+		-- to not even allow switching between can_receive states of private channels
+		if fields.channel ~= "" then
+			local sender_name = sender:get_player_name()
 			local name, mode = fields.channel:match("^([^:;]+)([:;])")
-			if name and mode and name ~= sender:get_player_name() then
+			if name and mode and name ~= sender_name then
-				
 				--channels starting with '[name]:' can only be used by the named player
 				if mode == ":" then
-					minetest.chat_send_player(sender:get_player_name(), "Sorry, channel '"..fields.channel.."' is reserved for exclusive use by "..name)
+					minetest.chat_send_player(sender_name, "Sorry, channel '"..fields.channel.."' is reserved for exclusive use by "..name)
 					return
 				
 				--channels starting with '[name];' can be used by other players, but cannot be received from
-				elseif mode == ";" and (fields.cr1 or (meta:get_int("can_receive") ~= 0 and not fields.cr0)) then
+				elseif mode == ";" and (fields.cr1 or (can_receive ~= 0 and not fields.cr0)) then
-					minetest.chat_send_player(sender:get_player_name(), "Sorry, receiving from channel '"..fields.channel.."' is reserved for "..name)
+					minetest.chat_send_player(sender_name, "Sorry, receiving from channel '"..fields.channel.."' is reserved for "..name)
 					return
 				end
 			end
 		end
 
-		if fields.channel==nil then fields.channel=meta:get_string("channel") end
+		local dirty = false
-		meta:set_string("channel",fields.channel)
+
-		remove_tube_in_file(pos)
+		-- test if a can_receive button was pressed
-		if fields.cr0 then meta:set_int("can_receive", 0) end
+		if fields.cr0 and can_receive ~= 0 then
-		if fields.cr1 then meta:set_int("can_receive", 1) end
+			can_receive = 0
-		local cr = meta:get_int("can_receive")
+			meta:set_int("can_receive", can_receive)
-		add_tube_in_file(pos, fields.channel, meta:get_int("can_receive"))
+			dirty = true
-		set_teleport_tube_formspec(meta)
+		elseif fields.cr1 and can_receive ~= 1 then
+			can_receive = 1
+			meta:set_int("can_receive", can_receive)
+			dirty = true
+		end
+
+		-- was the channel changed?
+		local channel = meta:get_string("channel")
+		if fields.channel ~= channel then
+			channel = fields.channel
+			meta:set_string("channel", channel)
+			dirty = true
+		end
+
+		-- save if we changed something, handle the empty channel while we're at it
+		if dirty then
+			if channel ~= "" then
+				set_tube(pos, channel, can_receive)
+			else
+				-- remove empty channel tubes, to not have to search through them
+				remove_tube(pos)
+			end
+			set_teleport_tube_formspec(meta, can_receive)
+		end
 	end,
 	on_destruct = function(pos)
-		remove_tube_in_file(pos)
+		remove_tube(pos)
-	end})
+	end
+})
 
 if minetest.get_modpath("mesecons_mvps") ~= nil then
 	mesecon.register_on_mvps_move(function(moved_nodes)
 		for _, n in ipairs(moved_nodes) do
 			if string.find(n.node.name, "pipeworks:teleport_tube") ~= nil then
-				update_pos_in_file(n.pos)
+				local meta = minetest.get_meta(n.pos)
+				set_tube(n.pos, meta:get_string("channel"), meta:get_int("can_receive"))
 			end
 		end
 	end)