add partial support for compassgps - maps only, currently

init.lua

@@ -2,6 +2,7 @@ local modname = minetest.get_current_modname()
 local modpath = minetest.get_modpath(modname)
 
 local ccompass_modpath = minetest.get_modpath("ccompass")
+local compassgps_modpath = minetest.get_modpath("compassgps")
 local default_modpath = minetest.get_modpath("default")
 local unified_inventory_modpath = minetest.get_modpath("unified_inventory")
 local sfinv_buttons_modpath = minetest.get_modpath("sfinv_buttons")
@@ -145,6 +146,36 @@ local function write_book(player_name)
 	return new_book
 end
 
+local function write_cgpsmap(player_name)
+	local state = get_state(player_name)
+	local category = state.category
+	if category ~= LOCATION_CATEGORY then
+		return
+	end
+	local entry_selected = state.entry_selected[category]
+	local content = modstore:get_string(player_name .. "_category_" .. category .. "_entry_" .. entry_selected .. "_content")
+	local pos_string = modstore:get_string(player_name .. "_category_" .. category .. "_entry_" .. entry_selected .. "_topic")
+	local meta = minetest.string_to_pos(pos_string)
+	if not meta then
+		return
+	end
+	meta.bkmrkname = content
+	local new_map = ItemStack("compassgps:cgpsmap_marked")
+	-- TODO: set_metadata is a deprecated function, but it is necessary because that's what cgpsmap uses.
+	new_map:set_metadata(minetest.serialize(meta))
+	return new_map
+end
+
+local function write_item(player_name, itemstack)
+	local item_name = itemstack:get_name()
+	if item_name == "default:book" then
+		return write_book(player_name)
+	end
+	if item_name == "compassgps:cgpsmap" then
+		return write_cgpsmap(player_name)
+	end
+end
+
 local function read_book(itemstack, player_name)
 	local meta = itemstack:get_meta()
 	local topic = meta:get_string("title")
@@ -169,6 +200,30 @@ local function read_book(itemstack, player_name)
 	save_state(player_name, state)
 end
 
+local function read_cgpsmap(itemstack, player_name)
+	-- TODO: get_metadata is a deprecated function, but it is necessary because that's what cgpsmap uses.
+	local meta = minetest.deserialize(itemstack:get_metadata())
+	if not (meta and meta.x and meta.y and meta.z) then
+		return
+	end
+	local content = meta.bkmrkname or ""
+	local topic = minetest.pos_to_string(meta)
+	local state = get_state(player_name)
+	local entry_index = state.entry_counts[LOCATION_CATEGORY] + 1
+	state.entry_counts[LOCATION_CATEGORY] = entry_index
+	save_entry(player_name, LOCATION_CATEGORY, entry_index, content, topic)
+	save_state(player_name, state)
+end
+
+local function read_item(itemstack, player_name)
+	local item_name = itemstack:get_name()
+	if item_name == "default:book_written" then
+		read_book(itemstack, player_name)
+	elseif item_name == "compassgps:cgpsmap_marked" then
+		read_cgpsmap(itemstack, player_name)
+	end
+end
+
 local function set_ccompass(player_name, old_compass)
 	local old_pos = old_compass:get_meta():get_string("target_pos")
 	if not ccompass_recalibration_allowed and old_pos ~= "" then
@@ -181,7 +236,6 @@ local function set_ccompass(player_name, old_compass)
 	if category ~= LOCATION_CATEGORY then
 		return
 	end
-	local entry_selected = state.entry_selected[category]
 	local topic = modstore:get_string(player_name .. "_category_" .. category .. "_entry_" .. entry_selected .. "_topic")
 	local pos = minetest.string_to_pos(topic)
 	if not pos then
@@ -204,18 +258,26 @@ local ccompass_prefix = "ccompass:"
 local ccompass_prefix_length = #ccompass_prefix
 local detached_callbacks = {
 	allow_put = function(inv, listname, index, stack, player)
+		local stack_name = stack:get_name()
 		if listname == "write_book" then
-			if stack:get_name() == "default:book" then
+			if stack_name == "default:book" then
+				return 1
+			end
+			local player_name = player:get_player_name()
+			local state = get_state(player_name)
+			local category = state.category
+			if category == LOCATION_CATEGORY and stack_name == "compassgps:cgpsmap" then
 				return 1
 			end
 			return 0
 		elseif listname == "read_book" then
-			if stack:get_name() == "default:book_written" then
+			if stack_name == "default:book_written" or stack_name == "compassgps:cgpsmap_marked" then
 				return 1
 			end
 			return 0
-		elseif listname == "set_ccompass" then
+		elseif listname == "set_compass" then
-			if stack:get_name():sub(1,ccompass_prefix_length) == ccompass_prefix then
+			-- TODO: support setting cgpscompass compasses directly
+			if stack_name:sub(1,ccompass_prefix_length) == ccompass_prefix then
 				return 1
 			end
 			return 0
@@ -225,10 +287,10 @@ local detached_callbacks = {
 		local player_name = player:get_player_name()
 		if listname == "write_book" then
 			inv:remove_item(listname, stack)		
-			inv:add_item(listname, write_book(player_name))
+			inv:add_item(listname, write_item(player_name, stack))
 		elseif listname == "read_book" then
-			read_book(stack, player_name)
+			read_item(stack, player_name)
-		elseif listname == "set_ccompass" then
+		elseif listname == "set_compass" then
 			local new_ccompass = set_ccompass(player_name, stack)
 			if new_ccompass then
 				inv:remove_item(listname, stack)
@@ -240,7 +302,7 @@ local detached_callbacks = {
 
 local item_invs = {}
 local function ensure_detached_inventory(player_name)
-	if item_invs[player_name] or not(default_modpath or ccompass_modpath) then
+	if item_invs[player_name] or not(default_modpath or ccompass_modpath or compassgps_modpath) then
 		return
 	end
 	local inv = minetest.create_detached_inventory("personal_log_"..player_name, detached_callbacks)
@@ -248,12 +310,29 @@ local function ensure_detached_inventory(player_name)
 		inv:set_size("write_book", 1)
 		inv:set_size("read_book", 1)
 	end
-	if ccompass_modpath then
+	if ccompass_modpath or compassgps_modpath then
-		inv:set_size("set_ccompass", 1)
+		inv:set_size("set_compass", 1)
 	end
 	item_invs[player_name] = true
 end
 
+-- if a player leaves stuff in their detached inventory, try giving it to them when they leave
+local function try_return(detached_inv, player_inv, listname)
+	local item = detached_inv:get_stack(listname, 1)
+	item = player_inv:add_item("main", item)
+	detached_inv:set_stack(listname, 1, item) -- if it didn't fit, put it back in detached and hope the player comes back
+end
+local function return_all_items(player)
+	local player_name = player:get_player_name()
+	if item_invs[player_name] then
+		local player_inv = minetest.get_inventory({type="player", name=player_name})
+		local detached_inv = minetest.get_inventory({type="detached", name="personal_log_"..player_name})
+		try_return(detached_inv, player_inv, "set_compass") -- do compass first, it's most expensive
+		try_return(detached_inv, player_inv, "write_book")
+		try_return(detached_inv, player_inv, "read_book")
+	end
+end
+
 local function item_formspec(player_name, label, listname)
 	local formspec = "size[8,6]"
 		.. "label[1,0.25;" .. label .. "]"
@@ -334,9 +413,10 @@ local function make_personal_log_formspec(player)
 		formspec[#formspec+1] = "button[0,0.75;1.25,0.5;copy_to;"..S("To Book").."]"
 			.."button[1.375,0.75;1.25,0.5;copy_from;"..S("From Book").."]"
 	end
-		
+
+	-- TODO: support setting cgpscompass compasses directly
 	if ccompass_modpath and category_index == LOCATION_CATEGORY then
-		formspec[#formspec+1] = "button[2.75,0.75;1.25,0.5;set_ccompass;"..S("To Compass").."]"
+		formspec[#formspec+1] = "button[2.75,0.75;1.25,0.5;set_compass;"..S("To Compass").."]"
 	end
 
 	formspec[#formspec+1] = "container_end[]"
@@ -352,7 +432,13 @@ minetest.register_on_player_receive_fields(function(player, formname, fields)
 		return
 	end
 	if fields.back then
+		return_all_items(player)
 		minetest.show_formspec(player:get_player_name(),"personal_log:root", make_personal_log_formspec(player))
+		return
+	end
+	if fields.quit then
+		return_all_items(player)
+		return
 	end
 end)
 
@@ -361,6 +447,7 @@ local function on_player_receive_fields(player, fields, update_callback)
 	local state = get_state(player_name)
 	local category = state.category
 	local entry_selected = state.entry_selected[category]
+	local valid_entry_selected = entry_selected > 0 and entry_selected <= state.entry_counts[category]
 
 	if fields.log_table then
 		local table_event = minetest.explode_table_event(fields.log_table)
@@ -425,7 +512,7 @@ local function on_player_receive_fields(player, fields, update_callback)
 	
 	if fields.teleport
 		and category == LOCATION_CATEGORY
-		and state.entry_counts[category] ~= 0
+		and valid_entry_selected
 		and minetest.check_player_privs(player_name, "teleport") then
 		local pos_string = modstore:get_string(player_name .. "_category_" .. category .. "_entry_" .. entry_selected .. "_topic")
 		local pos = minetest.string_to_pos(pos_string)
@@ -435,7 +522,7 @@ local function on_player_receive_fields(player, fields, update_callback)
 	end
 
 	if fields.copy_to then
-		if state.entry_counts[category] ~= 0 then
+		if valid_entry_selected then
 			minetest.show_formspec(player_name, "personal_log:item",
 				item_formspec(player_name, S("Copy log to blank book:"), "write_book"))
 		end
@@ -446,14 +533,14 @@ local function on_player_receive_fields(player, fields, update_callback)
 			item_formspec(player_name, S("Copy log from written book:"), "read_book"))
 		return
 	end
-	if fields.set_ccompass then
+	if fields.set_compass then
-		if state.entry_counts[category] ~= 0 then
+		if valid_entry_selected then
 			minetest.show_formspec(player_name, "personal_log:item",
-				item_formspec(player_name, S("Set a compass to this location:"), "set_ccompass"))
+				item_formspec(player_name, S("Set a compass to this location:"), "set_compass"))
 		end
 		return
 	end
-	
+
 	-- Do this one last, since it should always be true and we don't want to do it if we don't have to
 	if fields.category_select then
 		for i, category in ipairs(categories) do

locale/template.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-02-04 03:44-0700\n"
+"POT-Creation-Date: 2020-02-04 13:23-0700\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,92 +17,96 @@ msgstr ""
 "Content-Type: text/plain; charset=CHARSET\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: personal_log\init.lua:12
+#: personal_log\init.lua:18
 msgid "Location"
 msgstr ""
 
-#: personal_log\init.lua:13
+#: personal_log\init.lua:19
 msgid "Event"
 msgstr ""
 
-#: personal_log\init.lua:14
+#: personal_log\init.lua:20
 msgid "General"
 msgstr ""
 
-#: personal_log\init.lua:125
+#: personal_log\init.lua:142
-msgid "Category:"
-msgstr ""
-
-#: personal_log\init.lua:126
-msgid "Personal Log Entries"
-msgstr ""
-
-#: personal_log\init.lua:164
-msgid "Save"
-msgstr ""
-
-#: personal_log\init.lua:165
-msgid "New"
-msgstr ""
-
-#: personal_log\init.lua:166
-msgid "Move Up"
-msgstr ""
-
-#: personal_log\init.lua:167
-msgid "Move Down"
-msgstr ""
-
-#: personal_log\init.lua:168
-msgid "Delete"
-msgstr ""
-
-#: personal_log\init.lua:171
-msgid "To Book"
-msgstr ""
-
-#: personal_log\init.lua:172
-msgid "From Book"
-msgstr ""
-
-#: personal_log\init.lua:176
-msgid "To Compass"
-msgstr ""
-
-#: personal_log\init.lua:208
 msgid "\"@1\" by @2"
 msgstr ""
 
-#: personal_log\init.lua:242
+#: personal_log\init.lua:230
 msgid "Compass is already calibrated."
 msgstr ""
 
-#: personal_log\init.lua:327
+#: personal_log\init.lua:342
 msgid "Back"
 msgstr ""
 
-#: personal_log\init.lua:416
+#: personal_log\init.lua:363
+msgid "Category:"
+msgstr ""
+
+#: personal_log\init.lua:364
+msgid "Personal Log Entries"
+msgstr ""
+
+#: personal_log\init.lua:402
+msgid "Save"
+msgstr ""
+
+#: personal_log\init.lua:403
+msgid "New"
+msgstr ""
+
+#: personal_log\init.lua:404
+msgid "Move Up"
+msgstr ""
+
+#: personal_log\init.lua:405
+msgid "Move Down"
+msgstr ""
+
+#: personal_log\init.lua:406
+msgid "Delete"
+msgstr ""
+
+#: personal_log\init.lua:409
+msgid "Teleport"
+msgstr ""
+
+#: personal_log\init.lua:413
+msgid "To Book"
+msgstr ""
+
+#: personal_log\init.lua:414
+msgid "From Book"
+msgstr ""
+
+#: personal_log\init.lua:419
+msgid "To Compass"
+msgstr ""
+
+#: personal_log\init.lua:527
 msgid "Copy log to blank book:"
 msgstr ""
 
-#: personal_log\init.lua:421
+#: personal_log\init.lua:533
 msgid "Copy log from written book:"
 msgstr ""
 
-#: personal_log\init.lua:426
+#: personal_log\init.lua:539
 msgid "Set a compass to this location:"
 msgstr ""
 
-#: personal_log\init.lua:456
+#: personal_log\init.lua:579
-#: personal_log\init.lua:468
+#: personal_log\init.lua:591
 msgid "Your personal log for keeping track of what happens where"
 msgstr ""
 
-#: personal_log\init.lua:469
+#: personal_log\init.lua:592
-#: personal_log\init.lua:477
+#: personal_log\init.lua:600
 msgid "Log"
 msgstr ""
 
-#: personal_log\init.lua:481
+#: personal_log\init.lua:604
 msgid "Open personal log"
 msgstr ""

mod.conf

@@ -1,3 +1,3 @@
 name = personal_log
 description = A personal log where players can track events and places
-optional_depends = unified_inventory, sfinv_buttons, sfinv, ccompass, default
+optional_depends = unified_inventory, sfinv_buttons, sfinv, ccompass, default, compassgps