Do not crash with tenplus1's hopper mod

There are multiple hopper mods and not all of them support the set_extra_container_info function,
so the mod crashes now if it is used together with an incompatible hopper mod.

To prevent the crash, execute the code for hopper compatibility if hopper and hopper.set_extra_container_info exist and not if a mod named hopper is installed.

.luacheckrc

@@ -0,0 +1,2 @@
+read_globals = {"minetest", "table", "vector", "default", "hopper", "pipeworks"}
+globals = {"connected_chests"}

LICENSE.txt

@@ -1,2 +1,2 @@
 connected_chest_open from default
-rest WTFPL
+Content which is not copied from minetest_game is licensed under MIT.

depends.txt

@@ -1,3 +0,0 @@
-default
-pipeworks?
-technic?

init.lua

@@ -1,5 +1,5 @@
-local load_time_start = minetest.get_us_time()
+-- for translation
-
+local S = minetest.get_translator("connected_chests")
 
 -- param_tab maps the x and z offset to a param2 value
 local param_tab = {
@@ -139,6 +139,8 @@ end
 connected_chests = {chestdata = chestdata}
 --[[
 connected_chests.register_chest(<original_node>, {
+	description = <string>, -- The name of the connected chest as shown to the
+		-- player, i.e. the node metadata infotext
 	get_formspec = function(metatable, pos)
 		return <formspec_of_big>
 	end,
@@ -159,6 +161,13 @@ function connected_chests.register_chest(fromname, data)
 	data.left = name_left
 	data.right = name_right
 
+	local description = data.description
+	if not description then
+		minetest.log("deprecated",
+			"Missing connected chest description for " .. fromname)
+		description = "Big " .. minetest.registered_nodes[fromname].description
+	end
+
 	-- executed when connecting the chest
 	data.on_connect = function(pu, pa, par, metatable)
 		minetest.add_node(pu, {name=name_left, param2=par})
@@ -167,7 +176,7 @@ function connected_chests.register_chest(fromname, data)
 		if not data.add_open_chest then
 			metatable.fields.formspec = data.get_formspec(metatable, pu)
 		end
-		metatable.fields.infotext = "Big " .. metatable.fields.infotext
+		metatable.fields.infotext = description
 		local meta = minetest.get_meta(pu)
 		meta:from_table(metatable)
 		local inv = meta:get_inventory()
@@ -218,7 +227,7 @@ function connected_chests.register_chest(fromname, data)
 	local inside_texture
 
 
-	chest.description = "Big " .. chest.description
+	chest.description = description
 	chest.groups = table.copy(chest.groups)
 	chest.groups.not_in_creative_inventory = 1
 	chest.legacy_facedir_simple = nil
@@ -279,7 +288,7 @@ function connected_chests.register_chest(fromname, data)
 		}
 		def_opened.diggable = false
 		def_opened.on_blast = function() end
-inside_texture = "default_chest_inside.png^([combine:16x32:5,0=" ..
+		inside_texture = "default_chest_inside.png^([combine:16x32:5,0=" ..
 			"default_chest_inside.png^connected_chests_inside_frame.png^[" ..
 			"makealpha:255,126,126)"
 		-- TODO, see right chest
@@ -368,14 +377,6 @@ inside_texture = "default_chest_inside.png^([combine:16x32:5,0=" ..
 			end
 		end
 
-		--~ def_opened.tiles[1] = "default_mese.png" -- top, passt
-		--~ def_opened.tiles[2] = "default_wood.png" -- bottom
-		--~ def_opened.tiles[3] = "default_stone.png" -- right and left side or so
-		--~ def_opened.tiles[4] = "default_obsidian.png" -- back side
-
-		--~ def_opened.tiles[5] = "default_cobble.png" -- front side
-		--~ def_opened.tiles[6] = "default_leaves.png" -- inside
-
 		-- fix right side, somehow
 		def_opened.tiles[4] = def_opened.tiles[3]
 		def_opened.tiles[4].name = def_opened.tiles[4].name .. "^[transformFX"
@@ -475,7 +476,7 @@ local function close_chest(vi)
 	pos.x = pos.x + x * 0.5
 	pos.z = pos.z + z * 0.5
 	minetest.sound_play("default_chest_close",
-		{gain = 10.3, pos = pos, max_hear_distance = 10})
+		{gain = 0.3, pos = pos, max_hear_distance = 10, pitch = 0.7}, true)
 end
 
 -- close all remaining open chest on shutdown
@@ -518,10 +519,11 @@ end)
 local chest_lid_obstructed = default.chest
 	and default.chest.chest_lid_obstructed
 connected_chests.register_chest("default:chest", {
+	description = S("Big Chest"),
 	add_open_chest = true,
 	on_rightclick = function(pos, _, player)
 		minetest.sound_play("default_chest_open",
-			{gain = 0.3, pos = pos, max_hear_distance = 10})
+			{gain = 0.3, pos = pos, max_hear_distance = 10, pitch = 0.7}, true)
 
 		local vi = minetest.hash_node_position(pos)
 		if not open_chests[vi]
@@ -531,7 +533,7 @@ connected_chests.register_chest("default:chest", {
 			-- TODO: test for invalid param2 values
 			local x, z = unpack(param_tab2[left_param2])
 			local pos_right = {x=pos.x-x, y=pos.y, z=pos.z-z}
-			node = minetest.get_node(pos_right)
+			local node = minetest.get_node(pos_right)
 			if node.name == "default:chest_connected_right"
 			and not chest_lid_obstructed(pos_right) then
 				minetest.swap_node(pos, {
@@ -559,16 +561,17 @@ connected_chests.register_chest("default:chest", {
 })
 
 connected_chests.register_chest("default:chest_locked", {
+	description = S("Big Locked Chest"),
 	lock = true,
 	add_open_chest = true,
 	on_rightclick = function(pos, _, player)
 		if not default.can_interact_with_node(player, pos) then
-			minetest.sound_play("default_chest_locked", {pos = pos})
+			minetest.sound_play("default_chest_locked", {pos = pos}, true)
 			return
 		end
 
 		minetest.sound_play("default_chest_open",
-			{gain = 0.32, pos = pos, max_hear_distance = 10})
+			{gain = 0.32, pos = pos, max_hear_distance = 10, pitch = 0.7}, true)
 
 		local vi = minetest.hash_node_position(pos)
 		-- TODO: somehow avoid using the chest node names here
@@ -579,7 +582,7 @@ connected_chests.register_chest("default:chest_locked", {
 			-- TODO: test for invalid param2 values
 			local x, z = unpack(param_tab2[left_param2])
 			local pos_right = {x=pos.x-x, y=pos.y, z=pos.z-z}
-			node = minetest.get_node(pos_right)
+			local node = minetest.get_node(pos_right)
 			if node.name == "default:chest_locked_connected_right"
 			and not chest_lid_obstructed(pos_right) then
 				minetest.swap_node(pos_right, {
@@ -621,7 +624,8 @@ if not chest_lid_obstructed then
 				(def.drawtype == "airlike" or
 				def.drawtype == "signlike" or
 				def.drawtype == "torchlike" or
-				(def.drawtype == "nodebox" and def.paramtype2 == "wallmounted")) then
+				(def.drawtype == "nodebox"
+					and def.paramtype2 == "wallmounted")) then
 			return false
 		end
 		return true
@@ -634,21 +638,80 @@ minetest.register_alias("connected_chests:chest_left",
 	"default:chest_connected_left")
 minetest.register_alias("connected_chests:chest_right",
 	"default:chest_connected_right")
-minetest.register_alias("connected_chests:chest_left_locked", "default:chest_locked_connected_left")
+minetest.register_alias("connected_chests:chest_left_locked",
-minetest.register_alias("connected_chests:chest_right_locked", "default:chest_locked_connected_right")
+	"default:chest_locked_connected_left")
-minetest.register_alias("connected_chests:chest_locked_left", "default:chest_locked_connected_left")
+minetest.register_alias("connected_chests:chest_right_locked",
-minetest.register_alias("connected_chests:chest_locked_right", "default:chest_locked_connected_right")
+	"default:chest_locked_connected_right")
+minetest.register_alias("connected_chests:chest_locked_left",
+	"default:chest_locked_connected_left")
+minetest.register_alias("connected_chests:chest_locked_right",
+	"default:chest_locked_connected_right")
 
---~ local function log_access(pos, player, text)
+if minetest.global_exists("hopper") and hopper.set_extra_container_info then
-	--~ minetest.log("action", player:get_player_name()..
+	local function get_inventory(chest_right_pos)
-		--~ " moves stuff "..text.." at "..minetest.pos_to_string(pos))
+		local node_right = minetest.get_node(chest_right_pos)
---~ end
+		if node_right.param2 > 3 then
-
+			-- The right connected chest node has an invalid param2 value
-
+			-- Cannot determine the inventory
-local time = (minetest.get_us_time() - load_time_start) / 1000000
+			return
-local msg = "[connected_chests] loaded after ca. " .. time .. " seconds."
+		end
-if time > 0.01 then
+		local x, z = unpack(param_tab2[node_right.param2])
-	print(msg)
+		local chest_left_pos = {x=chest_right_pos.x+x, y=chest_right_pos.y,
-else
+			z=chest_right_pos.z+z}
-	minetest.log("info", msg)
+		local node_left = minetest.get_node(chest_left_pos)
+		if node_left.name ~= "default:chest_connected_left"
+		and node_left.name ~= "default:chest_connected_left_open" then
+			minetest.log("error","The left chest is not a chest: " ..
+				node_left.name .. " at " .. vector.to_string(chest_left_pos))
+			return
+		end
+		if node_left.param2 ~= node_right.param2 then
+			minetest.log("error", "The chests are pointing in different " ..
+				"directions: node_left.param2:" .. node_left.param2 ..
+				", node_right.param2:" .. node_right.param2)
+			return
+		end
+		return minetest.get_meta(chest_left_pos):get_inventory()
+	end
+	hopper:add_container({
+		{"top", "default:chest_connected_left", "main"},
+		{"bottom", "default:chest_connected_left", "main"},
+		{"side", "default:chest_connected_left", "main"},
+		{"top", "default:chest_connected_right", "main",
+			get_inventory = get_inventory},
+		{"bottom", "default:chest_connected_right", "main",
+			get_inventory = get_inventory},
+		{"side", "default:chest_connected_right", "main",
+			get_inventory = get_inventory},
+		{"top", "default:chest_connected_left_open", "main"},
+		{"bottom", "default:chest_connected_left_open", "main"},
+		{"side", "default:chest_connected_left_open", "main"},
+		{"top", "default:chest_connected_right_open", "main",
+			get_inventory = get_inventory},
+		{"bottom", "default:chest_connected_right_open", "main",
+			get_inventory = get_inventory},
+		{"side", "default:chest_connected_right_open", "main",
+			get_inventory = get_inventory},
+	})
+	local function set_hopper_param2(hopper_pos, chest_left_pos)
+		local param2_by_offset = {
+			[vector.new(-1, 0, 0):to_string()] = 0,
+			[vector.new( 0, 0, 1):to_string()] = 1,
+			[vector.new( 1, 0, 0):to_string()] = 2,
+			[vector.new( 0, 0,-1):to_string()] = 3,
+		}
+		local hopper_param2 = param2_by_offset[
+			(chest_left_pos - hopper_pos):to_string()]
+		if hopper_param2 then
+			return hopper_param2
+		end
+		local x, z = unpack(
+			param_tab2[minetest.get_node(chest_left_pos).param2])
+		local chest_right_pos = {x=chest_left_pos.x-x, y=chest_left_pos.y,
+			z=chest_left_pos.z-z}
+		return param2_by_offset[(chest_right_pos - hopper_pos):to_string()]
+	end
+	hopper:set_extra_container_info({
+		{"default:chest_connected_left", set_hopper_param2 = set_hopper_param2},
+	})
 end

locale/connected_chests.eo.tr

@@ -0,0 +1,3 @@
+# textdomain: connected_chests
+Big Chest=Kestego
+Big Locked Chest=Ŝlosita kestego

locale/connected_chests.ru.tr

@@ -0,0 +1,3 @@
+# textdomain: connected_chests
+Big Chest=Большой сундук
+Big Locked Chest=Большой запертый сундук

locale/template.txt

@@ -0,0 +1,3 @@
+# textdomain: connected_chests
+Big Chest=
+Big Locked Chest=

mod.conf

@@ -0,0 +1,3 @@
+name = connected_chests
+depends = default
+optional_depends = pipeworks,technic,hopper