digtron/controller.lua

local S = digtron.S

local position_and_anchor = "position[0.025,0.1]anchor[0,0]"

local listname_to_title =
{
	["main"] = S("Main Inventory"),
	["fuel"] = S("Fuel"),
}

---------------------------------------------------------------------------------------------------------------------

-- Sequencer commands
-- Yes, this indexing scheme is complicated. It's necessary in order to make sequences
-- language-agnostic, and saves a bit of storage space in the process by shortening and
-- standardizing command tags.
-- Also makes it future-proof, we can add new commands without disrupting existing stored sequences
local sequencer_commands =
{
	seq = S("Sequence"),
	dmb = S("Dig Move Build"),
	dmd = S("Dig Move Down"),
	mup = S("Move Up"),
	mdn = S("Move Down"),
	mlt = S("Move Left"),
	mrt = S("Move Right"),
	mfw = S("Move Forward"),
	mbk = S("Move Back"),
	rlt = S("Yaw Left"),
	rrt = S("Yaw Right"),
	rup = S("Pitch Up"),
	rdn = S("Pitch Down"),
	rcl = S("Roll Clockwise"),
	rcc = S("Roll Widdershins"),
}

-- This sets the order in which they'll be shown on the dropdown menu
local sequencer_dropdown_order =
{
	"seq", "dmb", "dmd", "mup", "mdn", "mlt", "mrt", "mfw", "mbk", "rlt", "rrt", "rup", "rdn", "rcl", "rcc"
}
-- Allows commands to be turned into an index into the dropdown order, needed for defaulting to the current command when building the formspec
local sequencer_dropdown_order_reverse = {}
for i, command in ipairs(sequencer_dropdown_order) do
	sequencer_dropdown_order_reverse[command] = i
end

-- Build the actual text string used in the formspec dropdown
local sequencer_dropdown_list = {}
for _, cmd in ipairs(sequencer_dropdown_order) do
	table.insert(sequencer_dropdown_list, sequencer_commands[cmd])
end
sequencer_dropdown_list = table.concat(sequencer_dropdown_list, ",")

-- Reverse lookup from human-readable command to internal tag, used in on_recieve_fields processing
local sequencer_commands_reverse = {}
for cmd, command in pairs(sequencer_commands) do
	sequencer_commands_reverse[command] = cmd
end

-- Creates a default sequence
-- Root must always be a seq command
digtron.default_sequence = function()
	return {cmd="seq", cnt=1, cur=1, seq={{cmd="dmb", cnt=1, cur=1}}}
end

-----------------------------------------------------------------------------------------
--- Manipulating sequences

-- searches down through the sequence tree to find the next command that can be executed
local find_next_item_to_execute = function(sequence)
	local target = sequence
	while target and target.cur > 0 do
		if target.cmd ~= "seq" then
			return target
		else
			local found = false
			for i, command in ipairs(target.seq) do
				if command.cur > 0 then
					target = command
					found = true
					break
				end
			end
			if not found then return nil end -- Sequence is finished
		end
	end
end

-- recurses down through the sequence tree to modify the current counts of sequence items
-- with target_item having just been executed.
local decrement_sequence
decrement_sequence = function(sequence, target_item)
	local found = false
	for i, command in ipairs(sequence.seq) do
		if found then
			-- there's further items in the curent sequence's list after the target_item,
			-- return without decrementing its parent
			return "found"
		elseif command == target_item then
			target_item.cur = target_item.cur - 1 -- decrement the remaining count on the target item
			found = true -- note that we've found the target item.
		elseif command.cmd == "seq" then
			local subsequence_result = decrement_sequence(command, target_item) -- recurse
			if subsequence_result == "decrement_parent" then
				-- the item was in the subsequence and the subsequence's list of commands are finished
				-- so decrement the subsequence's current count and reset its constituents to their defaults
				command.cur = command.cur - 1
				for _, subcommand in ipairs(command.seq) do
					subcommand.cur = subcommand.cnt
				end
				found = true
				target_item = command
			end
		end
	end
	if found and target_item.cur == 0 then
		-- the item was found and was the last in the list and it's at 0.
		-- Tell the previous call that it needs to decrement its sequence count.
		return "decrement_parent"
	end
end

-- recurses through the whole sequence setting all current counts to the base value
local reset_sequence
reset_sequence = function(sequence)
	for _, command in ipairs(sequence.seq) do
		command.cur = command.cnt
		if command.cmd == "seq" then
			reset_sequence(command)
		end
	end
end

----------------------------------------------------------------------------------------------
-- Finding, adding, removing

-- all field prefixes in the above create_sequence_list should be of this length
-- saves computation in trying to find the index part of the field name
local sequencer_field_length = string.len("sequencer_com:")
-- find an item based on the index string at the end of its field
local find_item = function(field, sequence)
	local index_list = field:sub(sequencer_field_length+1):split(":")
	local target = sequence
	for i = 1, #index_list do
		if target.seq then
			target = target.seq[tonumber(index_list[i])]
		else
			return nil
		end
		if target == nil then
			--minetest.log("error", "[Digtron] find_item failed to find a sequence item.")
			return nil
		end
	end
	return target
end

local delete_item = function(field, sequence)
	local index_list = field:sub(sequencer_field_length+1):split(":")
	local target = sequence
	for i = 1, #index_list-1 do
		target = target.seq[tonumber(index_list[i])]
		if target == nil then
			minetest.log("error", "[Digtron] delete_item failed to find a sequence item.")
			return nil
		end
	end	
	table.remove(target.seq, tonumber(index_list[#index_list]))
end

-- recurses through sequences ensuring there are tables for seq commands
local clean_subsequences
clean_subsequences = function(sequence)
	for i, val in ipairs(sequence.seq) do
		if val.cmd == "seq" then
			if val.seq == nil then
				val.seq = {}
			else
				clean_subsequences(val)
			end
		else
			val.seq = nil
		end
	end
end

-----------------------------------------------------------------------------
-- Executing

local cycling_digtrons = {}
local start_command = function(digtron_id, command, count, player_name)
	cycling_digtrons[digtron_id] = {
		command = command,
		count = count,
		last_action = minetest.get_gametime(),
		player_name = player_name,
	}
end
local cancel_command = function(digtron_id)
	cycling_digtrons[digtron_id] = nil
end
local is_cycling = function(digtron_id)
	return cycling_digtrons[digtron_id] ~= nil
end

local execute_command
local refresh_open_formspec

local command_functions = {
	mup = function(digtron_id, pos, facedir, player_name)
		return digtron.move(digtron_id, vector.add(pos, digtron.facedir_to_up(facedir)), player_name) end,
	mdn = function(digtron_id, pos, facedir, player_name)
		return digtron.move(digtron_id, vector.add(pos, vector.multiply(digtron.facedir_to_up(facedir), -1)), player_name) end,
	mlt = function(digtron_id, pos, facedir, player_name)
		return digtron.move(digtron_id, vector.add(pos, vector.multiply(digtron.facedir_to_right(facedir), -1)), player_name) end,
	mrt = function(digtron_id, pos, facedir, player_name)
		return digtron.move(digtron_id, vector.add(pos, digtron.facedir_to_right(facedir)), player_name) end,
	mfw = function(digtron_id, pos, facedir, player_name)
		return digtron.move(digtron_id, vector.add(pos, digtron.facedir_to_dir(facedir)), player_name) end,
	mbk = function(digtron_id, pos, facedir, player_name)
		return digtron.move(digtron_id, vector.add(pos, vector.multiply(digtron.facedir_to_dir(facedir), -1)), player_name) end,
	rlt = function(digtron_id, pos, facedir, player_name)
		return digtron.rotate(digtron_id, vector.multiply(digtron.facedir_to_up(facedir), -1), player_name) end,
	rrt = function(digtron_id, pos, facedir, player_name)
		return digtron.rotate(digtron_id, digtron.facedir_to_up(facedir), player_name) end,
	rup = function(digtron_id, pos, facedir, player_name)
		return digtron.rotate(digtron_id, digtron.facedir_to_right(facedir), player_name) end,
	rdn = function(digtron_id, pos, facedir, player_name)
		return digtron.rotate(digtron_id, vector.multiply(digtron.facedir_to_right(facedir), -1), player_name) end,
	rcl = function(digtron_id, pos, facedir, player_name)
		return digtron.rotate(digtron_id, digtron.facedir_to_dir(facedir), player_name) end,
	rcc = function(digtron_id, pos, facedir, player_name)
		return digtron.rotate(digtron_id, vector.multiply(digtron.facedir_to_dir(facedir), -1), player_name) end,
	dmb = function(digtron_id, pos, facedir, player_name)
		return digtron.execute_dig_move_build_cycle(digtron_id, player_name) end,
	dmd = function(digtron_id, pos, facedir, player_name)
		return digtron.execute_dig_move_build_cycle(digtron_id, player_name, true) end,
	seq = function(digtron_id, pos, facedir, player_name)
		local sequence = digtron.get_sequence(digtron_id)
		local target = find_next_item_to_execute(sequence)
		if target == nil then
			return false
		end
		local success = execute_command(digtron_id, target.cmd, player_name)
		if success then
			local decrement_result = decrement_sequence(sequence, target)
			if decrement_result == "decrement_parent" then
				sequence.cur = sequence.cur - 1
				reset_sequence(sequence)
			end		
			return true
		else
			return false
		end
	end
}

execute_command = function(digtron_id, command, player_name)
	local pos = digtron.get_pos(digtron_id)
	local node = minetest.get_node(pos)
	if node.name ~= "digtron:controller" then
		minetest.log("error", "[Digtron] execute_command was given the command " .. command .. " for " .. digtron_id
			.. " by " .. player_name .. " but the node at " .. minetest.pos_to_string(pos) .. " was a " .. node.name)
		return
	end
	local facedir = node.param2

	local func = command_functions[command]
	if func then
		return func(digtron_id, pos, facedir, player_name)
	else
		minetest.log("error", "[Digtron] " .. digtron_id .. " was given command " .. command .. " but "
			.. " that command was not recognized by execute_command.")
		return false
	end
end

local done_cycling = {}
minetest.register_globalstep(function(dtime)
	local gametime = minetest.get_gametime()
	for digtron_id, data in pairs(cycling_digtrons) do
		if data.last_action < gametime then
			local success = execute_command(digtron_id, data.command, data.player_name)
			refresh_open_formspec(digtron_id)
			local new_count = data.count
			if data.command ~= "seq" then
				-- It's somewhat hacky having two different counters,
				-- but I'm getting tired of laborious elegance at this point.
				-- sequences handle their own counters internally and that's fine.
				new_count = new_count - 1
			end
			if new_count < 1 or not success then
				table.insert(done_cycling, digtron_id)
			else
				data.count = new_count
				data.last_action = gametime
			end
		end
	end
	
	while next(done_cycling) ~= nil do
		cycling_digtrons[table.remove(done_cycling)] = nil
	end
end)

-------------------------------------------------------------------------------------------------------------------
-- Sequence tab formspec

-- Recursively builds a formspec representation. Dropdowns and buttons are indexed with : delimiters, eg:
--:1
--:2
--:2:1
--:2:2
--:2:2:1
--:3
local create_sequence_list
create_sequence_list = function(sequence_in, list_out, root_index, x, y)
	if sequence_in == nil then
		minetest.log("error", "[Digtron] create_sequence_list was given a nil sequence_in parameter")
		return y
	end
	root_index = root_index or ""
	x = x or 0
	y = y or 0
	for i, val in ipairs(sequence_in) do
		local index = root_index .. ":" .. i
		if val.cur == 0 then
			table.insert(list_out, "box[" .. x+2.6 .. "," .. y .. ";0.7,0.5;#FF000088]")
		end
		
		table.insert(list_out, "dropdown[".. x ..","..y..";1.75,0.5;sequencer_com"..index..";"..sequencer_dropdown_list..";"
			.. sequencer_dropdown_order_reverse[val.cmd].."]field["
			.. x+1.8 ..",".. y ..";0.75,0.5;sequencer_cnt"..index..";;"..val.cnt.."]"
			.. "field_close_on_enter[sequencer_cnt"..index..";false]"
			.. "label[".. x+2.65 .."," .. y+0.25 .. ";" .. S("@1 left", val.cur) .. "]"
			.. "button[".. x+3.3 .. ","..y ..";0.75,0.5;sequencer_del"..index..";"..S("Delete").."]")
		if val.cmd == "seq" then
			table.insert(list_out, "button[".. x+4.1 ..","..y ..";0.75,0.5;sequencer_ins"..index..";"..S("Insert").."]")
			y = y + 0.6
			-- Recurse into sub-sequence
			y = create_sequence_list(val.seq, list_out, index, x+0.25, y)
		else
			y = y + 0.6
		end
	end
	return y
end

local sequence_tab = function(digtron_id)
	local sequence = digtron.get_sequence(digtron_id)
	local list_out = {"size[5.75,12]"
		.. position_and_anchor
		.. "real_coordinates[true]"
		
		.. "container[0.2,0.2]"
		.. "field[0,0.1;0.7,0.5;cycles;"..S("Cycles")..";" .. sequence.cnt .."]"
		.. "field_close_on_enter[cycles;false]"
	}
	if sequence.cur == 0 then
		table.insert(list_out, "box[0.75,0.1;0.7,0.5;#FF000088]")
	end	
	if is_cycling(digtron_id) then
		table.insert(list_out, "button[1.5,0.1;1,0.5;stop;"..S("Stop").."]")
	else
		table.insert(list_out, "button[1.5,0.1;1,0.5;execute;"..S("Execute").."]")
	end
	
	table.insert(list_out,
		"label[0.8,0.35;" .. S("@1 left", sequence.cur) .."]"
		.. "button[2.5,0.1;1,0.5;reset;"..S("Reset").."]"
		.. "container_end[]"
		.. "container[0.2,1]"
	)
	local y = create_sequence_list(sequence.seq, list_out)
	table.insert(list_out,
		"button[0,".. y ..";1,0.5;sequencer_insert_end;"..S("New\nCommand").."]"
		.. "container_end[]"
	)
	return table.concat(list_out)
end

-- Handles returned fields for the sequence tab
local update_sequence = function(digtron_id, fields, player_name)
	local sequence = digtron.get_sequence(digtron_id)
	local delete_field = nil
	local insert_field = nil	
	for field, value in pairs(fields) do
		-- Go through all fields submitted to find the ones that are for changing commands in the sequence list	
		local command_type = field:sub(1,sequencer_field_length)
		if command_type == "sequencer_com:" then
			local seq_item = find_item(field, sequence)
			local new_cmd = sequencer_commands_reverse[value]
			if seq_item.cmd ~= new_cmd then
				seq_item.cmd = new_cmd
			end			
		elseif command_type == "sequencer_cnt:" then
			local val_int = tonumber(value)
			if val_int then
				val_int = math.floor(val_int)
				local seq_item = find_item(field, sequence)
				if seq_item.cnt ~= val_int then
					seq_item.cnt = val_int
					seq_item.cur = val_int
				end
			end
				
		--Save these to do last so as to not invalidate indices
		--Adding and removing items makes find_item not work
		elseif command_type == "sequencer_del:" then
			delete_field = field
		elseif command_type == "sequencer_ins:" then
			insert_field = field
		end
	end
	
	if insert_field and delete_field then
		minetest.log("error", "[Digtron] somehow an insertion and a deletion were both registered for a single update_sequence call. "
			.. "ignoring the deletion.")
		delete_field = nil
	end
	
	if insert_field then
		local item = find_item(insert_field, sequence)
		-- adds a "dig move build" command as the default new item
		item.seq = item.seq or {} -- just in case something went wrong with clean_subsequence
		table.insert(item.seq, {cmd="dmb",cnt=1,cur=1})
	elseif delete_field then
		delete_item(delete_field, sequence)
	end
	
	if fields.sequencer_insert_end then
		-- adds a "dig move build" command as the default new item
		table.insert(sequence.seq, {cmd="dmb",cnt=1,cur=1})
	end
	
	if fields.cycles then
		local new_cycles = tonumber(fields.cycles)
		if new_cycles ~= nil then
			new_cycles = math.floor(new_cycles)
			if new_cycles ~= sequence.cnt then
				sequence.cnt = new_cycles
				sequence.cur = sequence.cnt
			end
		end
	end
	
	if fields.execute and sequence.cur > 0 then
		start_command(digtron_id, "seq", 1, player_name)
	end
	
	if fields.stop and is_cycling(digtron_id) then
		cancel_command(digtron_id)
	end
	
	if fields.reset then
		cancel_command(digtron_id)
		reset_sequence(sequence)
		sequence.cur = sequence.cnt
	end
	
	clean_subsequences(sequence) -- if commands were changed to or away from "seq", ensure they have the right .seq member
	digtron.set_sequence(digtron_id, sequence)
end

-------------------------------------------------------------------------------------------------------
-- Controls tab

local cycles_cache = {} -- TODO something's not saving right here

local controls_tab = function(digtron_id)
	return "size[4.2,5]"
		.. position_and_anchor
		.. "container[0,0]"
		.. "button_exit[0,0;1,1;disassemble;"..S("Disassemble").."]"
		.. "field[1.2,0.3;1.75,1;digtron_name;"..S("Digtron name")..";"
		.. minetest.formspec_escape(digtron.get_name(digtron_id)).."]"
		.. "field_close_on_enter[digtron_name;false]"
		.. "field[2.9,0.3;0.7,1;cycles;"..S("Cycles")..";".. (cycles_cache[digtron_id] or 1) .."]"
		.. "field_close_on_enter[cycles;false]"
		.. "button[3.3,0;1,1;execute;"..S("Execute").."]"
		.. "container_end[]"
		
		.. "container[0,1]"
		.. "box[0,0;4,2;#DDDDDD]"
		.. "label[1.8,0.825;"..S("Move").."]"
		.. "button[1.1,0.1;1,1;move_up;"..S("Up").."]"
		.. "button[1.1,1.1;1,1;move_down;"..S("Down").."]"
		.. "button[2.1,0.1;1,1;move_forward;"..S("Forward").."]"
		.. "button[2.1,1.1;1,1;move_back;"..S("Back").."]"
		.. "button[0.1,0.6;1,1;move_left;"..S("Left").."]"
		.. "button[3.1,0.6;1,1;move_right;"..S("Right").."]"
		.. "container_end[]"

		.. "container[0.5,3.2]"
		.. "box[0,0;3,2;#DDDDDD]"
		.. "label[1.3,0.825;"..S("Rotate").."]"
		.. "button[0.1,0.1;1,1;rot_counterclockwise;"..S("Roll\nWiddershins").."]"
		.. "button[2.1,0.1;1,1;rot_clockwise;"..S("Roll\nClockwise").."]"
		.. "button[1.1,0.1;1,1;rot_up;"..S("Pitch Up").."]"
		.. "button[1.1,1.1;1,1;rot_down;"..S("Pitch Down").."]"
		.. "button[0.1,1.1;1,1;rot_left;"..S("Yaw Left").."]"
		.. "button[2.1,1.1;1,1;rot_right;"..S("Yaw Right").."]"
		.. "container_end[]"
end

local update_controls = function(digtron_id, pos, player_name, facedir, fields)
	local refresh = false

	if fields.disassemble then
		local pos = digtron.disassemble(digtron_id, player_name)
	end
	
	local cycles = math.max(math.floor(tonumber(fields.cycles) or 1), 1)
	cycles_cache[digtron_id] = cycles
	
	-- Translation
	if fields.move_forward then
		start_command(digtron_id, "mfw", cycles, player_name)
	elseif fields.move_back then
		start_command(digtron_id, "mbk", cycles, player_name)
	elseif fields.move_up then
		start_command(digtron_id, "mup", cycles, player_name)
	elseif fields.move_down then
		start_command(digtron_id, "mdn", cycles, player_name)
	elseif fields.move_left then
		start_command(digtron_id, "mlt", cycles, player_name)
	elseif fields.move_right then
		start_command(digtron_id, "mrt", cycles, player_name)
	-- Rotation	
	elseif fields.rot_counterclockwise then
		start_command(digtron_id, "rcc", cycles, player_name)
	elseif fields.rot_clockwise then
		start_command(digtron_id, "rcl", cycles, player_name)
	elseif fields.rot_up then
		start_command(digtron_id, "rup", cycles, player_name)
	elseif fields.rot_down then
		start_command(digtron_id, "rdn", cycles, player_name)
	elseif fields.rot_left then
		start_command(digtron_id, "rlt", cycles, player_name)
	elseif fields.rot_right then
		start_command(digtron_id, "rrt", cycles, player_name)
	end

	if fields.execute then
		start_command(digtron_id, "dmb", cycles, player_name)
		refresh = true
	end
	
	if fields.key_enter_field == "digtron_name" or fields.digtron_name then
		local pos = digtron.get_pos(digtron_id)
		if pos then
			local meta = minetest.get_meta(pos)
			meta:set_string("infotext", fields.digtron_name)
			digtron.set_name(digtron_id, fields.digtron_name)
			refresh = true
		end
	end

	return refresh
end

--------------------------------------------------------------------------------------------------
-- Inventory tab formspec

local inv_tab = function(digtron_id, inv_tab_context, player_context)
	local inv_list = inv_tab_context.listname
	local pages = inv_tab_context.pages
	local current_page = player_context.inv_page[inv_list]
	local starting_index = (current_page - 1) * 8 * 4
	local paging_controls = ""
	if pages > 1 then
		paging_controls = "button[0,0;1,1;page_back;<<]"
		.. "label[1.125,0.25;"..S("Page @1/@2", current_page, pages) .. "]"
		.. "button[2,0;1,1;page_forward;>>]"
	end
	
	return "size[8,9]"
		.. position_and_anchor
		.. "container[0,0]"
		.. "list[detached:" .. digtron_id .. ";"..inv_list..";0,0;8,4;"..starting_index.."]"
		.. "container_end[]"
		.. "container[2.5,4]" .. paging_controls .. "container_end[]"
		.. "container[0,5]list[current_player;main;0,0;8,1;]list[current_player;main;0,1.25;8,3;8]container_end[]"
		.. "listring[current_player;main]"
		.. "listring[detached:" .. digtron_id .. ";"..inv_list.."]"
end

------------------------------------------------------------------------------------------------------

-- This allows us to know which digtron the player has a formspec open for without
-- sending the digtron_id over the network
local player_interacting_with_digtron_id = {}
local get_context = function(digtron_id, player_name)
	local digtron_context = player_interacting_with_digtron_id[digtron_id] or {players={}}
	local player_context = digtron_context.players[player_name] or {current_tab = 1}
	digtron_context.players[player_name] = player_context
	player_interacting_with_digtron_id[digtron_id] = digtron_context
	return player_context, digtron_context
end
local get_context_for_player = function(player_name)
	for digtron_id, digtron_context in pairs(player_interacting_with_digtron_id) do
		local player_context = digtron_context.players[player_name]
		if player_context and player_context.open then
			return player_context, digtron_context, digtron_id
		end
	end
end
-- TODO: dispose of cached digtron context when a digtron is disposed

local get_controller_assembled_formspec = function(digtron_id, player_name)
	local player_context, digtron_context = get_context(digtron_id, player_name)
	local inv = digtron.get_inventory(digtron_id) -- ensures the detatched inventory exists and is populated
	
	if digtron_context.tabs == nil then
		digtron_context.tabs = {}
		local lists = inv:get_lists()
		for listname, contents in pairs(lists) do
			table.insert(digtron_context.tabs, {
				tab_type = "inventory",
				listname = listname,
				size = #contents,
				pages = math.floor(#contents/(8*4)) + 1})
		end
	end
	if player_context.inv_page == nil then
		player_context.inv_page = {}
		local lists = inv:get_lists()
		for listname, contents in pairs(lists) do
			player_context.inv_page[listname] = player_context.inv_page[listname] or 1
		end
	end

	local tabs = "tabheader[0,0;tab_header;"..S("Controls")..","..S("Sequence")
	for _, tab in ipairs(digtron_context.tabs) do
		tabs = tabs .. "," .. listname_to_title[tab.listname] or tab.listname
	end
	tabs = tabs .. ";" .. player_context.current_tab .. "]"
	
	if player_context.current_tab == 1 then
		return controls_tab(digtron_id) .. tabs
	elseif player_context.current_tab == 2 then
		return sequence_tab(digtron_id) .. tabs
	else
		local inv_tab_context = digtron_context.tabs[player_context.current_tab - 2]
		return inv_tab(digtron_id, inv_tab_context, player_context) .. tabs
	end
end

-- For now, only refresh the UI if it's open to tab 2 (the sequencer). Other tabs
-- don't have things that are changed "on the fly" by Digtron operation.
refresh_open_formspec = function(digtron_id)
	local digtron_context = player_interacting_with_digtron_id[digtron_id]
	if digtron_context == nil then
		return
	end
	for player_name, player_context in pairs(digtron_context.players) do
		if player_context.open and player_context.current_tab == 2 then
			minetest.show_formspec(player_name,
				"digtron:controller_assembled",
				get_controller_assembled_formspec(digtron_id, player_name))
		end
	end
end

-- Controlling a fully armed and operational Digtron
minetest.register_on_player_receive_fields(function(player, formname, fields)
	if formname ~= "digtron:controller_assembled" then
		return
	end
	local player_name = player:get_player_name()
	
	-- Get and validate various values
	local player_context, digtron_context, digtron_id = get_context_for_player(player_name)
	if player_context == nil then
		minetest.log("error", "[Digtron] player_interacting_with_digtron_id context not found for " .. player_name)
		return
	end
	local pos = digtron.get_pos(digtron_id)
	if pos == nil then
		minetest.log("error", "[Digtron] controller was unable to look up a position for digtron id for " .. digtron_id)
		return
	end
	local node = minetest.get_node(pos)
	if node.name ~= "digtron:controller" then
		minetest.log("error", "[Digtron] player " .. player_name .. " interacted with the controller for "
			.. digtron_id .. " but the node at " .. minetest.pos_to_string(pos) .. " was a " ..node.name
			.. " rather than a digtron:controller")
		return
	end

	local current_tab = player_context.current_tab
	local refresh = false
	if fields.tab_header then
		local new_tab = tonumber(fields.tab_header)
		if new_tab <= #(digtron_context.tabs) + 2 then
			player_context.current_tab = new_tab
			refresh = true
		else
			minetest.log("error", "[Digtron] digtron:controller_assembled formspec returned the out-of-range tab index "
				.. new_tab)
		end
	end

	if current_tab == 1 then
		-- Controls
		refresh = update_controls(digtron_id, pos, player_name, node.param2, fields)

	elseif current_tab == 2 then
		--Sequencer
		update_sequence(digtron_id, fields, player_name)
		refresh = true
	else -- inventory tabs
		local tab_context = digtron_context.tabs[current_tab - 2]
		local current_page = player_context.inv_page[tab_context.listname]
		if fields.page_forward then
			if current_page < tab_context.pages then
				player_context.inv_page[tab_context.listname] = current_page + 1
				refresh = true
			end
		end
		if fields.page_back then
			if current_page > 1 then
				player_context.inv_page[tab_context.listname] = current_page - 1
				refresh = true
			end		
		end	
	end
	
	if fields.quit then
		player_context.open = false
	end
	
	if refresh then
		minetest.show_formspec(player_name,
			"digtron:controller_assembled",
			get_controller_assembled_formspec(digtron_id, player_name))
	end	
end)

-- Doesn't deep-copy
local combine_defs = function(base_def, override_content)
	local out = {}
	for key, value in pairs(base_def) do
		out[key] = value
	end
	for key, value in pairs(override_content) do
		out[key] = value
	end
	return out
end

local base_def = {
	_doc_items_longdesc = nil,
    _doc_items_usagehelp = nil,
	-- Note: this is not in the "digtron" group because we do not want it to be incorporated
	-- into digtrons by mere adjacency; it must be the root node and only one root node is allowed.
	groups = {cracky = 3, oddly_breakable_by_hand = 3},
	paramtype = "light",
	paramtype2= "facedir",
	is_ground_content = false,
	drawtype = "nodebox",
		node_box = {
		type = "fixed",
		fixed = {
			{-0.3125, -0.3125, -0.3125, 0.3125, 0.3125, 0.3125}, -- Core
			{-0.1875, 0.3125, -0.1875, 0.1875, 0.5, 0.1875}, -- +y_connector
			{-0.1875, -0.5, -0.1875, 0.1875, -0.3125, 0.1875}, -- -y_Connector
			{0.3125, -0.1875, -0.1875, 0.5, 0.1875, 0.1875}, -- +x_connector
			{-0.5, -0.1875, -0.1875, -0.3125, 0.1875, 0.1875}, -- -x_connector
			{-0.1875, -0.1875, 0.3125, 0.1875, 0.1875, 0.5}, -- +z_connector
			{-0.5, 0.125, -0.5, -0.125, 0.5, -0.3125}, -- back_connector_3
			{0.125, 0.125, -0.5, 0.5, 0.5, -0.3125}, -- back_connector_1
			{0.125, -0.5, -0.5, 0.5, -0.125, -0.3125}, -- back_connector_2
			{-0.5, -0.5, -0.5, -0.125, -0.125, -0.3125}, -- back_connector_4
		},
	},
	sounds = default.node_sound_metal_defaults(),
	on_blast = digtron.on_blast,
}

minetest.register_node("digtron:controller_unassembled", combine_defs(base_def, {
	description = S("Digtron Control Module"),
	_digtron_assembled_node = "digtron:controller",
	tiles = {
		"digtron_plate.png^[transformR90",
		"digtron_plate.png^[transformR270",
		"digtron_plate.png",
		"digtron_plate.png^[transformR180",
		"digtron_plate.png",
		"digtron_plate.png^digtron_control.png",
	},

	on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
		local returnstack, success = digtron.on_rightclick(pos, node, clicker, itemstack, pointed_thing)
		if returnstack then
			return returnstack, success
		end

		if clicker == nil then return end
		
		local player_name = clicker:get_player_name()
		local digtron_id = digtron.assemble(pos, player_name)
		if digtron_id then
			local player_context = get_context(digtron_id, player_name)
			player_context.open = true
			minetest.show_formspec(player_name,
				"digtron:controller_assembled",
				get_controller_assembled_formspec(digtron_id, player_name))
		end
	end
}))

minetest.register_node("digtron:controller", combine_defs(base_def, {
	description = S("Digtron Assembly"), -- Will normally be obscured by the player-set Digtron name
	tiles = {
		"digtron_plate.png^[transformR90",
		"digtron_plate.png^[transformR270",
		"digtron_plate.png",
		"digtron_plate.png^[transformR180",
		"digtron_plate.png",
		"digtron_plate.png^digtron_control.png^digtron_intermittent.png",
	},
	_digtron_disassembled_node = "digtron:controller_unassembled",
	groups = {cracky = 3, oddly_breakable_by_hand = 3, not_in_creative_inventory = 1},
	
	on_dig = function(pos, node, digger)
		local player_name
		if digger then
			player_name = digger:get_player_name()
		end
		local meta = minetest.get_meta(pos)
		local digtron_id = meta:get_string("digtron_id")
		local digtron_layout_node_id = meta:get_int("digtron_layout_node_id")
		
		local stack = ItemStack({name=node.name, count=1, wear=0})
		local stack_meta = stack:get_meta()
		stack_meta:set_string("digtron_id", digtron_id)
		stack_meta:set_int("digtron_layout_node_id", digtron_layout_node_id)
		stack_meta:set_string("description", digtron.get_name(digtron_id))
		local inv = digger:get_inventory()
		local stack = inv:add_item("main", stack)
		if stack:get_count() > 0 then
			minetest.add_item(pos, stack)
		end		
		-- TODO call on_dignodes callback
		if digtron_id ~= "" then
			local removed = digtron.remove_from_world(digtron_id, player_name)
			if removed then
				for _, removed_pos in ipairs(removed) do
					minetest.check_for_falling(removed_pos)
				end
			else
				minetest.remove_node(pos)
			end
		else
			minetest.remove_node(pos)
		end
	end,
	
	preserve_metadata = function(pos, oldnode, oldmeta, drops)
		for _, dropped in ipairs(drops) do
			if dropped:get_name() == "digtron:controller" then
				local stack_meta = dropped:get_meta()
				stack_meta:set_string("digtron_id", oldmeta:get_string("digtron_id"))
				stack_meta:set_int("digtron_layout_node_id", oldmeta:get_int("digtron_layout_node_id"))
				stack_meta:set_string("description", oldmeta:get_string("infotext"))
				return
			end
		end
	end,
	
	on_place = function(itemstack, placer, pointed_thing)
        -- Shall place item and return the leftover itemstack.
        -- The placer may be any ObjectRef or nil.
		local player_name
		if placer then player_name = placer:get_player_name() end
		
		local stack_meta = itemstack:get_meta()
		local digtron_id = stack_meta:get_string("digtron_id")
		if digtron_id ~= "" then
			local target_pos
			local below_node = minetest.get_node(pointed_thing.under)
			local below_def = minetest.registered_nodes[below_node.name]
			if below_def.buildable_to then
				target_pos = pointed_thing.under
			else
				target_pos = pointed_thing.above
			end
			-- TODO rotate layout based on player orientation
			
			-- move up so that the lowest y-coordinate on the Digtron is
			-- at the y-coordinate of the place clicked on and test again.
			local bbox = digtron.get_bounding_box(digtron_id)
			if bbox then			
				target_pos.y = target_pos.y + math.abs(bbox.minp.y)
	
				if target_pos then
					local success, succeeded, failed = digtron.is_buildable_to(digtron_id, nil, target_pos, player_name)
					if success then
						local built_positions = digtron.build_to_world(digtron_id, nil, target_pos, player_name)
						for _, built_pos in ipairs(built_positions) do
							minetest.check_for_falling(built_pos)
						end
						
						local meta = minetest.get_meta(target_pos)
						meta:set_string("infotext", digtron.get_name(digtron_id))
	
						minetest.sound_play("digtron_machine_assemble", {gain = 0.5, pos=target_pos})
						-- Note: DO NOT RESPECT CREATIVE MODE here.
						-- If we allow multiple copies of a Digtron running around with the same digtron_id,
						-- human sacrifice, dogs and cats living together, mass hysteria
						return ItemStack("")
					else
						-- if that fails, show ghost of Digtron and fail to place.
						digtron.show_buildable_nodes(succeeded, failed)
						minetest.sound_play("digtron_buzzer", {gain = 0.5, pos=target_pos})
					end
				end
			else
				minetest.log("error", "[Digtron] digtron:controller on_place failed to find data for " .. digtron_id
					.. ", placing an unassembled controller.")
				itemstack:set_name("digtron:controller_unassembled")
				return minetest.item_place(itemstack, placer, pointed_thing)
			end
			return itemstack
		else
			-- Should be impossible to have a controller without an ID, but if it happens place an unassembled node
			itemstack:set_name("digtron:controller_unassembled")
			return minetest.item_place(itemstack, placer, pointed_thing)
		end
	end,
	
	on_rightclick = function(pos, node, clicker, itemstack, pointed_thing)
		local returnstack, success = digtron.on_rightclick(pos, node, clicker, itemstack, pointed_thing)
		if returnstack then
			return returnstack, success
		end

		if clicker == nil then return end
		
		local meta = minetest.get_meta(pos)
		local digtron_id = meta:get_string("digtron_id")
		
		local player_name = clicker:get_player_name()
		
		if digtron_id == "" then		
			if not digtron.recover_digtron_id(pos) then
				minetest.log("error", "[Digtron] The digtron:controller node at " .. minetest.pos_to_string(pos)
					.. " had no digtron id associated with it when " .. player_name
					.. "right-clicked on it. Converting it into a digtron:controller_unassembled.")
				node.name = "digtron:controller_unassembled"
				minetest.set_node(pos, node)
				return
			end
		end
		
		local player_context = get_context(digtron_id, player_name)
		player_context.open = true
		minetest.show_formspec(player_name,
			"digtron:controller_assembled",
			get_controller_assembled_formspec(digtron_id, player_name))
	end,
}))

minetest.register_lbm({
	label = "Validate and repair Digtron controller metadata",
	name = "digtron:validate_controller_metadata",
	nodenames = {"digtron:controller"},
	run_at_every_load = true,
	action = function(pos, node)
		local meta = minetest.get_meta(pos)
		local digtron_id = meta:get_string("digtron_id")
		if digtron_id == "" then		
			if not digtron.recover_digtron_id(pos) then
				minetest.log("error", "[Digtron] The digtron:controller node at " .. minetest.pos_to_string(pos)
					.. " had no digtron id associated with it. Converting it into a digtron:controller_unassembled.")
				node.name = "digtron:controller_unassembled"
				minetest.set_node(pos, node)
			end
		end		
	end,
})