add option to import compared builds from local build folder

Author: oboking

src/Classes/CompareTab.lua

@@ -13,6 +13,7 @@ local dkjson = require "dkjson"
 local tradeHelpers = LoadModule("Classes/CompareTradeHelpers")
 local buySimilar = LoadModule("Classes/CompareBuySimilar")
 local calcsHelpers = LoadModule("Classes/CompareCalcsHelpers")
+local buildListHelpers = LoadModule("Modules/BuildListHelpers")
 
 -- Node IDs below this value are normal passive tree nodes; IDs at or above are cluster jewel nodes
 local CLUSTER_NODE_OFFSET = 65536
@@ -183,11 +184,6 @@ function CompareTabClass:InitControls()
 		end
 	end
 
-	-- Notes sub-tab controls
-	self.controls.notesDesc = new("LabelControl", nil, {0, 0, 0, 16}, "^7These are the notes from the compared build. Any edits here are saved with this comparison and do not affect the main build's notes.")
-	self.controls.notesDesc.shown = function()
-		return self.compareViewMode == "NOTES" and #self.compareEntries > 0
-	end
 	self.controls.notesEdit = new("EditControl", nil, {0, 0, 0, 0}, "", nil, "^%C\t\n", nil, nil, 16, true)
 	self.controls.notesEdit.shown = function()
 		return self.compareViewMode == "NOTES" and #self.compareEntries > 0
@@ -1396,7 +1392,7 @@ function CompareTabClass:OpenImportPopup()
 	controls.state.label = function()
 		return stateText or ""
 	end
-	controls.go = new("ButtonControl", nil, {-45, 130, 80, 20}, "Import", function()
+	controls.go = new("ButtonControl", nil, {-118, 130, 80, 20}, "Import", function()
 		local buf = controls.input.buf
 		if not buf or buf == "" then
 			return
@@ -1433,12 +1429,115 @@ function CompareTabClass:OpenImportPopup()
 			stateText = colorCodes.NEGATIVE .. "Invalid build code"
 		end
 	end)
-	controls.cancel = new("ButtonControl", nil, {45, 130, 80, 20}, "Cancel", function()
+	controls.importFolder = new("ButtonControl", nil, {0, 130, 140, 20}, "Import from Folder", function()
+		main:ClosePopup()
+		self:OpenImportFolderPopup()
+	end)
+	controls.cancel = new("ButtonControl", nil, {118, 130, 80, 20}, "Cancel", function()
 		main:ClosePopup()
 	end)
 	main:OpenPopup(500, 160, "Import Comparison Build", controls, "go", "input", "cancel")
 end
 
+-- Open the "Import from Folder" popup: browse the user's local builds folder and
+-- import the selected build file as a comparison.
+function CompareTabClass:OpenImportFolderPopup()
+	local controls = {}
+	local searchText = ""
+	local sortMode = main.buildSortMode
+
+	-- Minimal listMode-like host consumed by BuildListControl/PathControl.
+	local listHost = {
+		subPath = "",
+		list = { },
+		controls = { },
+	}
+	function listHost:BuildList()
+		wipeTable(self.list)
+		local scanned = buildListHelpers.ScanFolder(self.subPath, searchText)
+		for _, entry in ipairs(scanned) do
+			t_insert(self.list, entry)
+		end
+		buildListHelpers.SortList(self.list, sortMode)
+	end
+	function listHost:SelectControl(control)
+		-- Focus is managed by the popup's ControlHost; this is a no-op for the popup list.
+	end
+
+	-- Import the given build entry (xml file on disk) as a comparison.
+	local function importBuildEntry(build)
+		local fileHnd = io.open(build.fullFileName, "r")
+		if not fileHnd then
+			main:OpenMessagePopup("Import Error", "Couldn't open '"..build.fullFileName.."'.")
+			return
+		end
+		local xmlText = fileHnd:read("*a")
+		fileHnd:close()
+		if not xmlText or xmlText == "" then
+			main:OpenMessagePopup("Import Error", "Build file is empty or unreadable.")
+			return
+		end
+		if self:ImportBuild(xmlText, build.buildName) then
+			main:ClosePopup()
+		else
+			main:OpenMessagePopup("Import Error", "Failed to import build for comparison.")
+		end
+	end
+
+	-- Search box and sort dropdown sit above the build list.
+	controls.searchText = new("EditControl", {"TOPLEFT", nil, "TOPLEFT"}, {15, 25, 450, 20}, "", "Search", "%c%(%)", 100, function(buf)
+		searchText = buf
+		listHost:BuildList()
+	end, nil, nil, true)
+	controls.sort = new("DropDownControl", {"TOPLEFT", nil, "TOPLEFT"}, {475, 25, 210, 20}, buildListHelpers.buildSortDropList, function(index, value)
+		sortMode = value.sortMode
+		main.buildSortMode = value.sortMode
+		buildListHelpers.SortList(listHost.list, sortMode)
+	end)
+	controls.sort:SelByValue(sortMode, "sortMode")
+
+	-- Build list itself. Reuses BuildListControl (which provides the PathControl breadcrumbs)
+	controls.buildList = new("BuildListControl", {"TOPLEFT", nil, "TOPLEFT"}, {15, 75, 0, 0}, listHost)
+	controls.buildList.width = function() return 670 end
+	controls.buildList.height = function() return 355 end
+
+	-- Override instance methods on the BuildListControl to tailor it for the popup:
+	-- navigate folders, import builds, and suppress rename/delete/drag behaviors.
+	function controls.buildList:LoadBuild(build)
+		if build.folderName then
+			self.controls.path:SetSubPath(self.listMode.subPath .. build.folderName .. "/")
+		else
+			importBuildEntry(build)
+		end
+	end
+	function controls.buildList:OnSelKeyDown(index, build, key)
+		if key == "RETURN" then
+			self:LoadBuild(build)
+		end
+	end
+	function controls.buildList:CanReceiveDrag() return false end
+	function controls.buildList:OnSelCopy() end
+	function controls.buildList:OnSelCut() end
+	function controls.buildList:OnSelDelete() end
+	function controls.buildList.controls.path:CanReceiveDrag() return false end
+
+	-- Populate the initial list now that the control (and its path control) exist.
+	listHost:BuildList()
+
+	controls.open = new("ButtonControl", {"TOPLEFT", nil, "TOPLEFT"}, {255, 465, 80, 20}, "Open", function()
+		local sel = controls.buildList.selValue
+		if sel then
+			controls.buildList:LoadBuild(sel)
+		end
+	end)
+	controls.open.enabled = function() return controls.buildList.selValue ~= nil end
+	controls.close = new("ButtonControl", {"TOPLEFT", nil, "TOPLEFT"}, {365, 465, 80, 20}, "Close", function()
+		main:ClosePopup()
+	end)
+
+	main:OpenPopup(700, 500, "Import from Folder", controls, "open", "searchText", "close")
+end
+
 -- ============================================================
 -- DRAW - Main render method
 -- ============================================================
@@ -4364,13 +4463,8 @@ function CompareTabClass:DrawNotes(vp, compareEntry, inputEvents)
 		end
 	end
 
-	-- Position label and edit control
-	self.controls.notesDesc.x = vp.x + 8
-	self.controls.notesDesc.y = vp.y + 8
-
-	local editY = vp.y + 30
 	self.controls.notesEdit.x = vp.x + 8
-	self.controls.notesEdit.y = editY
+	self.controls.notesEdit.y = vp.y + 8
 	self.controls.notesEdit.width = function()
 		return vp.width - 16
 	end

src/Modules/BuildList.lua

@@ -7,12 +7,8 @@ local pairs = pairs
 local ipairs = ipairs
 local t_insert = table.insert
 
-local buildSortDropList = {
-	{ label = "Sort by Name", sortMode = "NAME" },
-	{ label = "Sort by Class", sortMode = "CLASS" },
-	{ label = "Sort by Last Edited", sortMode = "EDITED"},
-	{ label = "Sort by Level", sortMode = "LEVEL"},
-}
+local buildListHelpers = LoadModule("Modules/BuildListHelpers")
+local buildSortDropList = buildListHelpers.buildSortDropList
 
 local listMode = new("ControlHost")
 
@@ -197,116 +193,16 @@ end
 
 function listMode:BuildList()
 	wipeTable(self.list)
-	local filterList = main.filterBuildList or ""
-	local handle = nil
-	if filterList ~= "" then
-		handle = NewFileSearch(main.buildPath..self.subPath.."*"..filterList.."*.xml")
-	else
-		handle = NewFileSearch(main.buildPath..self.subPath.."*.xml")
-	end
-	while handle do
-		local fileName = handle:GetFileName()
-		local build = { }
-		build.fileName = fileName
-		build.subPath = self.subPath
-		build.fullFileName = main.buildPath..self.subPath..fileName
-		build.modified = handle:GetFileModifiedTime()
-		build.buildName = fileName:gsub("%.xml$","")
-		local fileHnd = io.open(build.fullFileName, "r")
-		if fileHnd then
-			local fileText = fileHnd:read("*a")
-			fileHnd:close()
-			if not fileText then
-				main:OpenCloudErrorPopup(build.fullFileName)
-				return
-			end
-			fileText = fileText:match("(<Build.->)")
-			if fileText then
-				local xml = common.xml.ParseXML(fileText.."</Build>")
-				if xml and xml[1] then
-					build.level = tonumber(xml[1].attrib.level)
-					build.className = xml[1].attrib.className
-					build.ascendClassName = xml[1].attrib.ascendClassName
-				end
-			end
-		end
-		t_insert(self.list, build)
-		if not handle:NextFile() then
-			break
-		end
-	end
-handle = NewFileSearch(main.buildPath..self.subPath.."*", true)
-	while handle do
-		local folderName = handle:GetFileName()
-		t_insert(self.list, {
-			folderName = folderName,
-			subPath = self.subPath,
-			fullFileName = main.buildPath..self.subPath..folderName,
-			modified = handle:GetFileModifiedTime()
-		})
-		if not handle:NextFile() then
-			break
-		end
+	local scanned = buildListHelpers.ScanFolder(self.subPath, main.filterBuildList or "")
+	for _, entry in ipairs(scanned) do
+		t_insert(self.list, entry)
 	end
 	self:SortList()
 end
 
 function listMode:SortList()
 	local oldSelFileName = self.controls.buildList.selValue and self.controls.buildList.selValue.fileName
-	table.sort(self.list, function(a, b)
-		local a_is_folder = a.folderName ~= nil
-		local b_is_folder = b.folderName ~= nil
-
-		if a_is_folder and not b_is_folder then return true end
-		if not a_is_folder and b_is_folder then return false end
-
-
-		if main.buildSortMode == "EDITED" then
-			local modA = a.modified or 0 -- Use 0 as fallback if modified time is nil
-			local modB = b.modified or 0
-			if modA ~= modB then
-				return modA > modB -- Newest first maybe allow for inverting of order?
-			end
-			-- If modified times are the same or both 0 fall back to name sort
-			if a_is_folder then
-				return naturalSortCompare(a.folderName, b.folderName)
-			else
-				return naturalSortCompare(a.fileName, b.fileName)
-			end
-		end
-
-		if a_is_folder then
-			return naturalSortCompare(a.folderName, b.folderName)
-		else
-			if main.buildSortMode == "CLASS" then
-				local a_has_class = a.className ~= nil
-				local b_has_class = b.className ~= nil
-				if not a_has_class and b_has_class then return true
-				elseif a_has_class and not b_has_class then return false
-				elseif a_has_class and b_has_class and a.className ~= b.className then
-					return a.className < b.className
-				end
-
-				local a_has_asc = a.ascendClassName ~= nil
-				local b_has_asc = b.ascendClassName ~= nil
-				if not a_has_asc and b_has_asc then return true
-				elseif a_has_asc and not b_has_asc then return false
-				elseif a_has_asc and b_has_asc and a.ascendClassName ~= b.ascendClassName then
-					return a.ascendClassName < b.ascendClassName
-				end
-				return naturalSortCompare(a.fileName, b.fileName)
-			elseif main.buildSortMode == "LEVEL" then
-				if a.level and not b.level then return false
-				elseif not a.level and b.level then return true
-				elseif a.level and b.level then
-					if a.level ~= b.level then return a.level < b.level end
-				end
-				return naturalSortCompare(a.fileName, b.fileName)
-			else
-				return naturalSortCompare(a.fileName, b.fileName)
-			end
-		end
-	end)
+	buildListHelpers.SortList(self.list, main.buildSortMode)
 	if oldSelFileName then
 		self.controls.buildList:SelByFileName(oldSelFileName)
 	end