Simple changes to support user-supplied league data

The www.pathofexile.com/trade site 403s apparently due to CloudFlare spam protection (see PathOfBuildingCommunity#8384).

If you're using POESESSID, this means you can't use the trade tool until you null-out the POESESSID, to use the static league data.

This branch attempts to fall back to a new field that can be user-supplied, Misc->TradeLeagueData.

This is intended to be grabbed from the source of www.pathofexile.com/trade by the user, rather than POB trying to grab it.

If that doesn't exist, the tool will finally fall back to the static list.

A UI entry isn't provided in this branch.

Author: Protuhj

src/Classes/TradeQuery.lua

@@ -1101,39 +1101,65 @@ function TradeQueryClass:UpdateRealms()
 		self.controls.realm.selIndex = nil
 		self.controls.realm:SetSel(self.pbRealmIndex)
 	end
-
-	if main.POESESSID and main.POESESSID ~= "" then
-		-- Fetch from trade page using POESESSID, includes private leagues
-		ConPrintf("Fetching realms and leagues using POESESSID")
-		self.tradeQueryRequests:FetchRealmsAndLeaguesHTML(function(data, errMsg)
-			if errMsg then
-				self:SetNotice(self.controls.pbNotice, "Error while fetching league list: "..errMsg)
-				return
-			end
-			local leagues = data.leagues
-			self.allLeagues = {}
-			for _, value in ipairs(leagues) do
-				if not self.allLeagues[value.realm] then self.allLeagues[value.realm] = {} end
-				t_insert(self.allLeagues[value.realm], value.id)
+	local function processLeagueData(leagueDataObject)
+		local leagues = leagueDataObject.leagues
+		self.allLeagues = {}
+		for _, value in ipairs(leagues) do
+			if not self.allLeagues[value.realm] then self.allLeagues[value.realm] = {} end
+			t_insert(self.allLeagues[value.realm], value.id)
+		end
+		ConPrintTable(self.allLeagues)
+		self.realmIds = {}
+		for _, value in pairs(leagueDataObject.realms) do
+			-- filter out only Path of Exile one realms, as poe2 is not supported yet
+			if value.text:match("PoE 1 ") then
+				self.realmIds[value.text:gsub("PoE 1 ", "")] = value.id
 			end
-			self.realmIds = {}
-			for _, value in pairs(data.realms) do
-				-- filter out only Path of Exile one realms, as poe2 is not supported yet
-				if value.text:match("PoE 1 ") then
-					self.realmIds[value.text:gsub("PoE 1 ", "")] = value.id
+		end
+	end
+	local function tryFallbacks()
+		if main.TradeLeagueData:len() > 0 then
+			-- full json state obj from HTML
+			local dataStr = main.TradeLeagueData:match('require%(%["main"%].+ t%((.+)%);}%);}%);')
+			if not dataStr then
+				ConPrintf("User-supplied league data is malformed: %s", main.TradeLeagueData)
+			else
+				local data, _, err = dkjson.decode(dataStr)
+				if err then
+					ConPrintf("Failed to parse JSON object. ".. err)
+				else
+					ConPrintf("Using user-supplied league data")
+					processLeagueData(data)
+					setRealmDropList()
+					self:SetNotice(self.controls.pbNotice, "Using user-supplied league data")
+					return
 				end
 			end
-			setRealmDropList()
-
-		end)
-	else
-		-- Fallback to static list
+		end
+		-- Finally, fallback to static list
 		ConPrintf("Using static realms list")
 		self.realmIds = {
 			["PC"]   = "pc",
 			["PS4"]  = "sony",
 			["Xbox"] = "xbox",
 		}
 		setRealmDropList()
+		self:SetNotice(self.controls.pbNotice, "Using static realms list")
+	end
+
+	if main.POESESSID and main.POESESSID ~= "" then
+		-- Fetch from trade page using POESESSID, includes private leagues
+		ConPrintf("Fetching realms and leagues using POESESSID")
+		self.tradeQueryRequests:FetchRealmsAndLeaguesHTML(function(data, errMsg)
+			if errMsg then
+				self:SetNotice(self.controls.pbNotice, "Error while fetching league list: "..errMsg)
+				tryFallbacks()
+			else
+				processLeagueData(data)
+				setRealmDropList()
+			end
+		end)
+	else
+		tryFallbacks()
 	end
 end

src/Classes/TradeQueryRequests.lua

@@ -400,6 +400,8 @@ function TradeQueryRequestsClass:FetchRealmsAndLeaguesHTML(callback)
 			-- full json state obj from HTML
 			local dataStr = response.body:match('require%(%["main"%].+ t%((.+)%);}%);}%);')
 			if not dataStr then
+				-- the response.body can hide a lua error, so it doesn't hurt to dump it to the console if debugging
+				ConPrintf("invalid response data: %s", response.body)
 				return callback(nil, "JSON object not found on the page.")
 			end
 			local data, _, err = dkjson.decode(dataStr)

src/Modules/Main.lua

@@ -103,6 +103,7 @@ function main:Init()
 	self.slotOnlyTooltips = true
 	self.POESESSID = ""
 	self.showPublicBuilds = true
+	self.TradeLeagueData = ""
 
 	if self.userPath then
 		self:ChangeUserPath(self.userPath, ignoreBuild)
@@ -617,6 +618,17 @@ function main:LoadSettings(ignoreBuild)
 				if node.attrib.showPublicBuilds then
 					self.showPublicBuilds = node.attrib.showPublicBuilds == "true"
 				end
+				-- If the Misc node has a child, and it's the "TradeLeagueData" node, parse the contents
+				-- into the TradeLeagueData field, for use if grabbing the data from www.pathofexile.com/trade 403s
+				-- when trying to search for items
+				for _, child in ipairs(node) do
+					if child.elem == "TradeLeagueData" then
+						if #child == 1 and child[1]:len() > 0 then
+							-- trim value
+							self.TradeLeagueData = child[1]:match"^%s*(.*)":match"(.-)%s*$"
+						end
+					end
+				end
 			end
 		end
 	end
@@ -703,7 +715,7 @@ function main:SaveSettings()
 		t_insert(sharedItemList, set)
 	end
 	t_insert(setXML, sharedItemList)
-	t_insert(setXML, { elem = "Misc", attrib = {
+	local misc = { elem = "Misc", attrib = {
 		buildSortMode = self.buildSortMode,
 		connectionProtocol = tostring(launch.connectionProtocol),
 		proxyURL = launch.proxyURL,
@@ -728,7 +740,9 @@ function main:SaveSettings()
 		invertSliderScrollDirection = tostring(self.invertSliderScrollDirection),
 		disableDevAutoSave = tostring(self.disableDevAutoSave),
 		showPublicBuilds = tostring(self.showPublicBuilds)
-	} })
+	} }
+	t_insert(misc, { elem = "TradeLeagueData", [1] = self.TradeLeagueData:match"^%s*(.*)":match"(.-)%s*$"})
+	t_insert(setXML, misc)
 	local res, errMsg = common.xml.SaveXMLFile(setXML, self.userPath.."Settings.xml")
 	if not res then
 		launch:ShowErrMsg("Error saving 'Settings.xml': %s", errMsg)