Autocrafter groups support (#74)

* Add support for recipes with groups to autocrafter

* fix autocrafter replacements

* remove unnecessary check and move some code

* reorder and change back var name

* only whitespace changes

* reuse hash that is asigned to variable anyway

* add get_matching_craft

function that looks for the best matching recipe according to what user
put in recipe inventory

some crafts use groups in multiple recipes

* return right away if there is a chached craft

gives us more horizontal space to work with

* indentation adjusting

* use get_matching_craft to get best craft

this line was buggy anyhow

* new craft format: decremented_input

craft.decremented_input now only holds the items. Extra parameters are
dropped

* bugfix: when item has no groups

"" and unknown items have no def and thus no groups

* add function has_room_for_output

moving the output space calculation into its own function
helps keep autocraft() short and overseeable

* use has_room_for_output

* remove double-check of available materials

* add warning to ensure double-check was not needed

* rebuild cache whenever recipe inv changes

no need to check if still current, this only happens when user is
interacting and can only be better to do so.
Otherwise we would have to check groups etc. again just to check, so
might as well reset cache.

* remove unused line

* use minetest.get_item_group()

* whitespace cleanup

make code easier to read and give it a more
"thoughtthrough" look than the "smash it in to make it work" look it has
had.

(I'm holding back, there would be more to do overall through this mod)

* add .editorconfig

this should also help keep consistency throughout this mod

* changelog updated

at least the most recent more important ones

* whitespace changelog (trailing spaces)

---------

Co-authored-by: rubenwardy <rw@rubenwardy.com>
Co-authored-by: OgelGames <olliverdc28@gmail.com>
Co-authored-by: wsor4035 <24964441+wsor4035@users.noreply.github.com>

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+tab_width = 4
+charset = utf-8
+end_of_line = lf
+indent_style = tab
+insert_final_newline = false
+trim_trailing_whitespace = true

autocrafter.lua

@@ -1,11 +1,14 @@
 local S = minetest.get_translator("pipeworks")
-local autocrafterCache = {}  -- caches some recipe data to avoid to call the slow function minetest.get_craft_result() every second
+-- cache some recipe data to avoid calling the slow function
+-- minetest.get_craft_result() every second
+local autocrafterCache = {}
 
 local craft_time = 1
 
 local function count_index(invlist)
 	local index = {}
 	for _, stack in pairs(invlist) do
+		stack = ItemStack(stack)
 		if not stack:is_empty() then
 			local stack_name = stack:get_name()
 			index[stack_name] = (index[stack_name] or 0) + stack:get_count()
@@ -21,41 +24,152 @@ local function get_item_info(stack)
 	return description, name
 end
 
+-- Get best matching recipe for what user has put in crafting grid.
+-- This function does not consider crafting method (mix vs craft)
+local function get_matching_craft(output_name, example_recipe)
+	local recipes = minetest.get_all_craft_recipes(output_name)
+	if not recipes then
+		return example_recipe
+	end
+
+	if 1 == #recipes then
+		return recipes[1].items
+	end
+
+	local index_example = count_index(example_recipe)
+	local best_score = 0
+	local index_recipe, best_index, score, group
+	for i = 1, #recipes do
+		score = 0
+		index_recipe = count_index(recipes[i].items)
+		for recipe_item_name, _ in pairs(index_recipe) do
+			if index_example[recipe_item_name] then
+				score = score + 1
+			elseif recipe_item_name:sub(1, 6) == "group:" then
+				group = recipe_item_name:sub(7)
+				for example_item_name, _ in pairs(index_example) do
+					if minetest.get_item_group(example_item_name, group) > 0 then
+						score = score + 1
+						break
+					end
+				end
+			end
+		end
+		if best_score < score then
+			best_index = i
+		end
+	end
+
+	return best_index and recipes[best_index].items or example_recipe
+end
+
 local function get_craft(pos, inventory, hash)
 	local hash = hash or minetest.hash_node_position(pos)
 	local craft = autocrafterCache[hash]
-	if not craft then
+	if craft then return craft end
-		local recipe = inventory:get_list("recipe")
+
-		local output, decremented_input = minetest.get_craft_result({method = "normal", width = 3, items = recipe})
+	local example_recipe = inventory:get_list("recipe")
-		craft = {recipe = recipe, consumption=count_index(recipe), output = output, decremented_input = decremented_input}
+	local output, decremented_input = minetest.get_craft_result({
-		autocrafterCache[hash] = craft
+		method = "normal", width = 3, items = example_recipe
+	})
+
+	local recipe = example_recipe
+	if output and not output.item:is_empty() then
+		recipe = get_matching_craft(output.item:get_name(), example_recipe)
 	end
+
+	craft = {
+		recipe = recipe,
+		consumption = count_index(recipe),
+		output = output,
+		decremented_input = decremented_input.items
+	}
+	autocrafterCache[hash] = craft
 	return craft
 end
 
-local function autocraft(inventory, craft)
+-- From a consumption table with groups and an inventory index, build
-	if not craft then return false end
+-- a consumption table without groups
-	-- check if we have enough material available
+local function calculate_consumption(inv_index, consumption_with_groups)
-	local inv_index = count_index(inventory:get_list("src"))
+	inv_index = table.copy(inv_index)
-	for itemname, number in pairs(craft.consumption) do
+	consumption_with_groups = table.copy(consumption_with_groups)
-		if (not inv_index[itemname]) or inv_index[itemname] < number then return false end
+
-	end
+	local consumption = {}
-	-- check if output and all replacements fit in dst
+	local groups = {}
-	local output = craft.output.item
+
-	local out_items = count_index(craft.decremented_input.items)
+	-- First consume all non-group requirements
-	out_items[output:get_name()] = (out_items[output:get_name()] or 0) + output:get_count()
+	-- This is done to avoid consuming a non-group item which is also
-	local empty_count = 0
+	-- in a group
-	for _,item in pairs(inventory:get_list("dst")) do
+	for key, count in pairs(consumption_with_groups) do
-		if item:is_empty() then
+		if key:sub(1, 6) == "group:" then
-			empty_count = empty_count + 1
+			groups[#groups + 1] = key:sub(7, #key)
 		else
-			local name = item:get_name()
+			if not inv_index[key] or inv_index[key] < count then
-			if out_items[name] then
+				return nil
-				out_items[name] = out_items[name] - item:get_free_space()
+			end
+
+			consumption[key] = (consumption[key] or 0) + count
+			consumption_with_groups[key] = consumption_with_groups[key] - count
+			assert(consumption_with_groups[key] == 0)
+			consumption_with_groups[key] = nil
+			inv_index[key] = inv_index[key] - count
+			assert(inv_index[key] >= 0)
+		end
+	end
+
+	-- Next, resolve groups using the remaining items in the inventory
+	local take
+	if #groups > 0 then
+		for itemname, count in pairs(inv_index) do
+			if count > 0 then
+				local def = minetest.registered_items[itemname]
+				local item_groups = def and def.groups or {}
+				for i = 1, #groups do
+					local group = groups[i]
+					local groupname = "group:" .. group
+					if item_groups[group] and item_groups[group] >= 1
+						and consumption_with_groups[groupname] > 0
+					then
+						take = math.min(count, consumption_with_groups[groupname])
+						consumption_with_groups[groupname] =
+								consumption_with_groups[groupname] - take
+
+						assert(consumption_with_groups[groupname] >= 0)
+						consumption[itemname] =
+								(consumption[itemname] or 0) + take
+
+						inv_index[itemname] = inv_index[itemname] - take
+						assert(inv_index[itemname] >= 0)
+					end
+				end
 			end
 		end
 	end
-	for _,count in pairs(out_items) do
+
+	-- Finally, check everything has been consumed
+	for key, count in pairs(consumption_with_groups) do
+		if count > 0 then
+			return nil
+		end
+	end
+
+	return consumption
+end
+
+local function has_room_for_output(list_output, index_output)
+	local name
+	local empty_count = 0
+	for _, item in pairs(list_output) do
+		if item:is_empty() then
+			empty_count = empty_count + 1
+		else
+			name = item:get_name()
+			if index_output[name] then
+				index_output[name] = index_output[name] - item:get_free_space()
+			end
+		end
+	end
+	for _, count in pairs(index_output) do
 		if count > 0 then
 			empty_count = empty_count - 1
 		end
@@ -63,22 +177,54 @@ local function autocraft(inventory, craft)
 	if empty_count < 0 then
 		return false
 	end
+
+	return true
+end
+
+local function autocraft(inventory, craft)
+	if not craft then return false end
+
+	-- check if output and all replacements fit in dst
+	local output = craft.output.item
+	local out_items = count_index(craft.decremented_input)
+	out_items[output:get_name()] =
+			(out_items[output:get_name()] or 0) + output:get_count()
+
+	if not has_room_for_output(inventory:get_list("dst"), out_items) then
+		return false
+	end
+
+	-- check if we have enough material available
+	local inv_index = count_index(inventory:get_list("src"))
+	local consumption = calculate_consumption(inv_index, craft.consumption)
+	if not consumption then
+		return false
+	end
+
 	-- consume material
-	for itemname, number in pairs(craft.consumption) do
+	for itemname, number in pairs(consumption) do
-		for _ = 1, number do -- We have to do that since remove_item does not work if count > stack_max
+		-- We have to do that since remove_item does not work if count > stack_max
+		for _ = 1, number do
 			inventory:remove_item("src", ItemStack(itemname))
 		end
 	end
+
 	-- craft the result into the dst inventory and add any "replacements" as well
 	inventory:add_item("dst", output)
+	local leftover
 	for i = 1, 9 do
-		inventory:add_item("dst", craft.decremented_input.items[i])
+		leftover = inventory:add_item("dst", craft.decremented_input[i])
+		if leftover and not leftover:is_empty() then
+			minetest.log("warning", "[pipeworks] autocrafter didn't " ..
+				"calculate output space correctly.")
+		end
 	end
 	return true
 end
 
 -- returns false to stop the timer, true to continue running
--- is started only from start_autocrafter(pos) after sanity checks and cached recipe
+-- is started only from start_autocrafter(pos) after sanity checks and
+-- recipe is cached
 local function run_autocrafter(pos, elapsed)
 	local meta = minetest.get_meta(pos)
 	local inventory = meta:get_inventory()
@@ -90,7 +236,7 @@ local function run_autocrafter(pos, elapsed)
 		return false
 	end
 
-	for _ = 1, math.floor(elapsed/craft_time) do
+	for _ = 1, math.floor(elapsed / craft_time) do
 		local continue = autocraft(inventory, craft)
 		if not continue then return false end
 	end
@@ -114,33 +260,17 @@ end
 -- note, that this function assumes allready being updated to virtual items
 -- and doesn't handle recipes with stacksizes > 1
 local function after_recipe_change(pos, inventory)
+	local hash = minetest.hash_node_position(pos)
 	local meta = minetest.get_meta(pos)
+	autocrafterCache[hash] = nil
 	-- if we emptied the grid, there's no point in keeping it running or cached
 	if inventory:is_empty("recipe") then
 		minetest.get_node_timer(pos):stop()
-		autocrafterCache[minetest.hash_node_position(pos)] = nil
 		meta:set_string("infotext", S("unconfigured Autocrafter"))
 		inventory:set_stack("output", 1, "")
 		return
 	end
-	local recipe = inventory:get_list("recipe")
+	local craft = get_craft(pos, inventory, hash)
-
-	local hash = minetest.hash_node_position(pos)
-	local craft = autocrafterCache[hash]
-
-	if craft then
-		-- check if it changed
-		local cached_recipe = craft.recipe
-		for i = 1, 9 do
-			if recipe[i]:get_name() ~= cached_recipe[i]:get_name() then
-				autocrafterCache[hash] = nil -- invalidate recipe
-				craft = nil
-				break
-			end
-		end
-	end
-
-	craft = craft or get_craft(pos, inventory, hash)
 	local output_item = craft.output.item
 	local description, name = get_item_info(output_item)
 	meta:set_string("infotext", S("'@1' Autocrafter (@2)", description, name))
@@ -149,7 +279,8 @@ local function after_recipe_change(pos, inventory)
 	after_inventory_change(pos)
 end
 
--- clean out unknown items and groups, which would be handled like unknown items in the crafting grid
+-- clean out unknown items and groups, which would be handled like unknown
+-- items in the crafting grid
 -- if minetest supports query by group one day, this might replace them
 -- with a canonical version instead
 local function normalize(item_list)
@@ -180,58 +311,65 @@ local function on_output_change(pos, inventory, stack)
 			end
 			width_idx = (width_idx < 3) and (width_idx + 1) or 1
 		end
-		-- we'll set the output slot in after_recipe_change to the actual result of the new recipe
+		-- we'll set the output slot in after_recipe_change to the actual
+		-- result of the new recipe
 	end
 	after_recipe_change(pos, inventory)
 end
 
--- returns false if we shouldn't bother attempting to start the timer again after this
+-- returns false if we shouldn't bother attempting to start the timer again
+-- after this
 local function update_meta(meta, enabled)
 	local state = enabled and "on" or "off"
 	meta:set_int("enabled", enabled and 1 or 0)
 	local list_backgrounds = ""
 	if minetest.get_modpath("i3") or minetest.get_modpath("mcl_formspec") then
 		list_backgrounds = "style_type[box;colors=#666]"
-		for i=0, 2 do
+		for i = 0, 2 do
-			for j=0, 2 do
+			for j = 0, 2 do
-				list_backgrounds = list_backgrounds .. "box[".. 0.22+(i*1.25) ..",".. 0.22+(j*1.25) ..";1,1;]"
+				list_backgrounds = list_backgrounds .. "box[" ..
+					0.22 + (i * 1.25) .. "," .. 0.22 + (j * 1.25) .. ";1,1;]"
 			end
 		end
-		for i=0, 3 do
+		for i = 0, 3 do
-			for j=0, 2 do
+			for j = 0, 2 do
-				list_backgrounds = list_backgrounds .. "box[".. 5.28+(i*1.25) ..",".. 0.22+(j*1.25) ..";1,1;]"
+				list_backgrounds = list_backgrounds .. "box[" ..
+					5.28 + (i * 1.25) .. "," .. 0.22 + (j * 1.25) .. ";1,1;]"
 			end
 		end
-		for i=0, 7 do
+		for i = 0, 7 do
-			for j=0, 2 do
+			for j = 0, 2 do
-				list_backgrounds = list_backgrounds .. "box[".. 0.22+(i*1.25) ..",".. 5+(j*1.25) ..";1,1;]"
+				list_backgrounds = list_backgrounds .. "box[" ..
+					0.22 + (i * 1.25) .. "," .. 5 + (j * 1.25) .. ";1,1;]"
 			end
 		end
 	end
 	local size = "10.2,14"
 	local fs =
-		"formspec_version[2]"..
+		"formspec_version[2]" ..
-		"size["..size.."]"..
+		"size[" .. size .. "]" ..
-		pipeworks.fs_helpers.get_prepends(size)..
+		pipeworks.fs_helpers.get_prepends(size) ..
-		list_backgrounds..
+		list_backgrounds ..
-		"list[context;recipe;0.22,0.22;3,3;]"..
+		"list[context;recipe;0.22,0.22;3,3;]" ..
-		"image[4,1.45;1,1;[combine:16x16^[noalpha^[colorize:#141318:255]"..
+		"image[4,1.45;1,1;[combine:16x16^[noalpha^[colorize:#141318:255]" ..
-		"list[context;output;4,1.45;1,1;]"..
+		"list[context;output;4,1.45;1,1;]" ..
-		"image_button[4,2.6;1,0.6;pipeworks_button_" .. state .. ".png;" .. state .. ";;;false;pipeworks_button_interm.png]" ..
+		"image_button[4,2.6;1,0.6;pipeworks_button_" .. state .. ".png;" ..
-		"list[context;dst;5.28,0.22;4,3;]"..
+		state .. ";;;false;pipeworks_button_interm.png]" ..
-		"list[context;src;0.22,5;8,3;]"..
+		"list[context;dst;5.28,0.22;4,3;]" ..
-		pipeworks.fs_helpers.get_inv(9)..
+		"list[context;src;0.22,5;8,3;]" ..
-		"listring[current_player;main]"..
+		pipeworks.fs_helpers.get_inv(9) ..
+		"listring[current_player;main]" ..
 		"listring[context;src]" ..
-		"listring[current_player;main]"..
+		"listring[current_player;main]" ..
 		"listring[context;dst]" ..
 		"listring[current_player;main]"
 	if minetest.get_modpath("digilines") then
-		fs = fs.."field[0.22,4.1;4.5,0.75;channel;"..S("Channel")..";${channel}]"..
+		fs = fs .. "field[0.22,4.1;4.5,0.75;channel;" .. S("Channel") ..
-			"button[5,4.1;1.5,0.75;set_channel;"..S("Set").."]"..
+			";${channel}]" ..
-			"button_exit[6.8,4.1;2,0.75;close;"..S("Close").."]"
+			"button[5,4.1;1.5,0.75;set_channel;" .. S("Set") .. "]" ..
+			"button_exit[6.8,4.1;2,0.75;close;" .. S("Close") .. "]"
 	end
-	meta:set_string("formspec",fs)
+	meta:set_string("formspec", fs)
 
 	-- toggling the button doesn't quite call for running a recipe change check
 	-- so instead we run a minimal version for infotext setting only
@@ -251,9 +389,12 @@ local function update_meta(meta, enabled)
 end
 
 -- 1st version of the autocrafter had actual items in the crafting grid
--- the 2nd replaced these with virtual items, dropped the content on update and set "virtual_items" to string "1"
+-- the 2nd replaced these with virtual items, dropped the content on update and
--- the third added an output inventory, changed the formspec and added a button for enabling/disabling
+--   set "virtual_items" to string "1"
--- so we work out way backwards on this history and update each single case to the newest version
+-- the third added an output inventory, changed the formspec and added a button
+--   for enabling/disabling
+-- so we work out way backwards on this history and update each single case
+--   to the newest version
 local function upgrade_autocrafter(pos, meta)
 	local meta = meta or minetest.get_meta(pos)
 	local inv = meta:get_inventory()
@@ -264,7 +405,8 @@ local function upgrade_autocrafter(pos, meta)
 		update_meta(meta, true)
 
 		if meta:get_string("virtual_items") == "1" then -- we are version 2
-			-- we already dropped stuff, so lets remove the metadatasetting (we are not being called again for this node)
+			-- we already dropped stuff, so lets remove the metadatasetting
+			-- (we are not being called again for this node)
 			meta:set_string("virtual_items", "")
 		else -- we are version 1
 			local recipe = inv:get_list("recipe")
@@ -304,18 +446,23 @@ minetest.register_node("pipeworks:autocrafter", {
 			return inv:room_for_item("src", stack)
 		end,
 		input_inventory = "dst",
-		connect_sides = {left = 1, right = 1, front = 1, back = 1, top = 1, bottom = 1}},
+		connect_sides = {
+			left = 1, right = 1, front = 1, back = 1, top = 1, bottom = 1
+			}
+	},
 	on_construct = function(pos)
 		local meta = minetest.get_meta(pos)
 		local inv = meta:get_inventory()
-		inv:set_size("src", 3*8)
+		inv:set_size("src", 3 * 8)
-		inv:set_size("recipe", 3*3)
+		inv:set_size("recipe", 3 * 3)
-		inv:set_size("dst", 4*3)
+		inv:set_size("dst", 4 * 3)
 		inv:set_size("output", 1)
 		update_meta(meta, false)
 	end,
 	on_receive_fields = function(pos, formname, fields, sender)
-		if (fields.quit and not fields.key_enter_field) or not pipeworks.may_configure(pos, sender) then
+		if (fields.quit and not fields.key_enter_field)
+			or not pipeworks.may_configure(pos, sender)
+		then
 			return
 		end
 		local meta = minetest.get_meta(pos)
@@ -362,7 +509,9 @@ minetest.register_node("pipeworks:autocrafter", {
 	end,
 	allow_metadata_inventory_take = function(pos, listname, index, stack, player)
 		if not pipeworks.may_configure(pos, player) then
-			minetest.log("action", string.format("%s attempted to take from autocrafter at %s", player:get_player_name(), minetest.pos_to_string(pos)))
+			minetest.log("action", string.format("%s attempted to take from " ..
+				"autocrafter at %s",
+				player:get_player_name(), minetest.pos_to_string(pos)))
 			return 0
 		end
 		upgrade_autocrafter(pos)
@@ -378,7 +527,9 @@ minetest.register_node("pipeworks:autocrafter", {
 		after_inventory_change(pos)
 		return stack:get_count()
 	end,
-	allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player)
+	allow_metadata_inventory_move = function(
+			pos, from_list, from_index, to_list, to_index, count, player)
+
 		if not pipeworks.may_configure(pos, player) then return 0 end
 		upgrade_autocrafter(pos)
 		local inv = minetest.get_meta(pos):get_inventory()
@@ -419,13 +570,14 @@ minetest.register_node("pipeworks:autocrafter", {
 				if type(msg) == "table" then
 					if #msg < 3 then return end
 					local inv = meta:get_inventory()
-					for y=0,2,1 do
+					for y = 0, 2, 1 do
-						for x=1,3,1 do
+						for x = 1, 3, 1 do
-							local slot = y*3+x
+							local slot = y * 3 + x
-							if minetest.registered_items[msg[y+1][x]] then
+							if minetest.registered_items[msg[y + 1][x]] then
-								inv:set_stack("recipe",slot,ItemStack(msg[y+1][x]))
+								inv:set_stack("recipe", slot, ItemStack(
+									msg[y + 1][x]))
 							else
-								inv:set_stack("recipe",slot,ItemStack(""))
+								inv:set_stack("recipe", slot, ItemStack(""))
 							end
 						end
 					end
@@ -434,11 +586,12 @@ minetest.register_node("pipeworks:autocrafter", {
 					local meta = minetest.get_meta(pos)
 					local inv = meta:get_inventory()
 					local recipe = {}
-					for y=0,2,1 do
+					for y = 0, 2, 1 do
 						local row = {}
-						for x=1,3,1 do
+						for x = 1, 3, 1 do
-							local slot = y*3+x
+							local slot = y * 3 + x
-							table.insert(row, inv:get_stack("recipe",slot):get_name())
+							table.insert(row, inv:get_stack(
+									"recipe", slot):get_name())
 						end
 						table.insert(recipe, row)
 					end
@@ -465,4 +618,4 @@ minetest.register_node("pipeworks:autocrafter", {
 		},
 	},
 })
-pipeworks.ui_cat_tube_list[#pipeworks.ui_cat_tube_list+1] = "pipeworks:autocrafter"
+pipeworks.ui_cat_tube_list[#pipeworks.ui_cat_tube_list + 1] = "pipeworks:autocrafter"

changelog.txt

@@ -3,6 +3,60 @@ Changelog
 
 
 
+2023-06-22 (SwissalpS, rubenwardy)
+groups support in recipe. Set recipe as usual via recipe formspec or digilines.
+Autocrafter now resolves matching recipe using groups so that items in input
+inventory are used, that match group and no longer only strictly what user
+has in recipe-inventory
+
+
+
+2023-06-21 (OgelGames, BuckarooBanzay)
+fix autocrafter destroying replacement items (OG)
+remove facedir debugging logs (BB)
+
+
+
+2023-05-28 (SwissalpS)
+support setting 'can_receive' for teleport tubes via digiline
+
+
+
+2023-05-19 (fluxionary, OgelGames)
+log items going through teleport tubes
+
+
+
+2022-12-02 (wsor4035)
+bring back compatibility with mineclone2
+
+
+
+2022-11-11 (OgelGames)
+prevent tp- and sand-tubes from breaking themselves and refactor part of code
+
+2022-09-18 (fluxionary)
+protection checks before break-/placeing a node -> less violation logs
+
+
+2022-08-14 (wsor4035)
+prevent tubes from connecting to furnace front
+
+
+
+2022-08-13 (TurkeyMcMac)
+moved teleport-tube database to mod-storage
+
+
+
+2022-06-23 (S-S-X)
+on_repair tweak, improved repairing tubes
+
+
+* many updates not mentioned here *
+
+
+
 2017-10-19 (thetaepsilon)
 Directional flowables are now implemented.
 All devices for which it is relevant (valve, flow sensor etc.) have been converted so that they only flow on their connecting sides, so pressure propogation now works as expected for these devices when pressure logic is enabled.