Steam.lua

--[[
	@Author: NuzzyFutts
	@Github: github.com/NuzzyFutts
	@File: getSteamGames
	@input: {table} argv - A list of inputs
	Order of inputs:
		1. {string} defaultSteamPath - The path of the default steam directory
		2. {string} userID - The user's steam ID
]]
 
function main(DEFAULT_STEAM_PATH,USER_ID)
	
	local function hasValue (tab, val)
		for index, value in ipairs(tab) do
			if value == val then
				return true
			end
		end
		return false
	end

	local function isRightPath(path)
		return hasValue(path,"software") and hasValue(path,"valve") and hasValue(path,"steam")
	end
	
	local function getIDsAndLastPlayed()
		local LOCAL_CONFIG_VDF_PATH = DEFAULT_STEAM_PATH.."userdata\\"..USER_ID.."\\config\\localconfig.vdf"
		local vdfFile = io.open(LOCAL_CONFIG_VDF_PATH,"r")
		local count = 0								--used to keep track of lines
		local found = false							--used for easier check of if we are in the apps section
		local level = 0								--used to keep track how deep in entries we currently are before we find the apps section
		local foundLevel = 0						--Used to keep track of how deep in entries we are AFTER we have found the right apps sectgion
		local currApp = {}							--used to keep track of data for current app
		local apps = {}								--used for storing data of all apps
		local prevLineType = ""						--used to keep track of what type of info the previous line kept
		local path = {}								--used to keep track of the current path we are in inside the vdf
		local prevLine = ""							--used to keep track of what the previous line was

		if vdfFile then
			for line in vdfFile:lines() do

				count = count + 1
				line = string.lower(line)	-- we don't care about the capitalization of the data inside. Do this to reduce number of checks required

				if found or (string.match(line,'%s*apps') and isRightPath(path)) then

					--increment/decrement level to check for closing of individual apps
					--entries and for checking when apps section has ended
					if string.match(line,"^%s*{") then				--if on a line where an app entry is beginning
						foundLevel = foundLevel + 1
						prevLineType = "open"
					end

					--if on a line where an app entry is ending or line before is entry and this line is an entry
					if string.match(line,"^%s*}") or (prevLineType == "id" and string.match(line,'^%s*"(%d+)"') ~= nil) then

						--only decrement level if only first case is satisfied and second case is false
						if string.match(line,"^%s*}") then
							foundLevel = foundLevel - 1
						end
						
						-- Capture all remaining data and push it to return table
						if foundLevel == 1 then
							currApp["appID"] = appID
							table.insert(apps,currApp)

							--if the game has never been played
							if currApp.lastPlayed == nil then
								currApp.lastPlayed = 0				--set lastplayed timestamp to 0
							end

							currApp = {}
							prevLineType = "close"
						end
					end
					
					--individual game parameters capture
					local temp = string.match(line,'^%s*"(%d+)"')
					if temp ~= nil then
						appID = temp
						prevLineType = "id"
					end
					
					--if currently in an app entry
					if foundLevel == 2 then
						local title = string.match(line,'^%s*"(%w*)"')

						--if title of current line is lastplayed, get timestamp data
						if title == "lastplayed" then
							currApp["lastPlayed"] = string.match(line,'.*"(%d*)"')
						end
						prevLineType = "dataEntry"
					end

					--sets start line for check of closing of apps section
					if not found then
						prevLineType = "begin"
						found = true
						start = count
					end

					--checks to stop reading file if apps section has ended
					if foundLevel == 0  and start ~= count then
						break
					end
				end

				--This block is to keep track of what the current path is. So that we don't use the wrong "apps" section
				if not found then
					if string.match(line,"^%s*{") then		--if on a line where a subentry is beginning
						path[#path + 1] = string.match(prevLine,'^%s*"(%w*)"')
						level = level + 1
					end

					if string.match(line,"^%s*}") then		--if on a line where a subentry is ending
						table.remove(path,#path)
						level = level - 1
					end

					prevLine = line
				end
			end
			vdfFile:close()
		end
		return apps
	end

	local function getAllDirectories()
		local LIBRARY_FOLDERS_VDF_PATH = DEFAULT_STEAM_PATH.."steamapps\\libraryfolders.vdf"
		local libVDFFile = io.open(LIBRARY_FOLDERS_VDF_PATH,"r")				--open libraryfolders.vdf
		local dirs = {DEFAULT_STEAM_PATH}										--initialize dirs table with default steam directory preinserted

		--if vdf file exists
		if libVDFFile then

			--iterate through all the lines
			for line in libVDFFile:lines() do
				local dirline = string.match(line,'^%s*"%d+"%s*"(.*)"')			--match format for only lines with directories
				
				--if that format is on this line
				if dirline then
					newdirline = string.gsub(dirline,'\\\\','\\').."\\"
					table.insert(dirs,newdirline)								--insert that path into the table
				end
			end
			libVDFFile:close()
		end
		return dirs																--return table of directories
	end

	local function checkAppManifests(directories,appTable)
		local resultTable = {}
		local currTable = {}

		--iterate through all steam directories
		for i=1,table.getn(directories) do

			--iterate through all app possibilities in each directory
			for curr = 1, table.getn(appTable) do
				local currManifest = directories[i].."steamapps/appmanifest_"..appTable[curr].appID..".acf"		--generate filepath for app
				manifestFile = io.open(currManifest,"r")														--open file
				
				--check if file exists
				if manifestFile then

					--iterate through all lines
					for line in manifestFile:lines() do
						line = string.gsub(line,'[^%w%s%p]+',"")
						appName = string.match(line,'.*"name"%s*"(.*)"')										--obtain app name from file
						
						--if this line contains the name field
						if appName then
							currTable["appID"] = appTable[curr].appID
							currTable["lastPlayed"] = appTable[curr].lastPlayed
							currTable["appPath"] = "steam://rungameid/"..appTable[curr].appID
							currTable["bannerURL"] = "http://cdn.akamai.steamstatic.com/steam/apps/"..appTable[curr].appID.."/header.jpg"
							currTable["bannerName"] = appTable[curr].appID..".jpg"
							currTable["appName"] = appName														--set appName in appTable
							currTable["installed"] = true														--set installed var in appTable (only for consistency across launchers)
							currTable["hidden"] = false															--PLACEHOLDER/INITIAL ASSIGNMENT parameter for if game should be hidden
							currTable["launcher"] = "Steam"														--defines which launcher this game is from
							table.insert(resultTable,currTable)
							currTable = {}
							break
						end
					end
					manifestFile:close()
				end
			end
		end
		return resultTable																						--return fully populated appTable
	end

	local dirs = getAllDirectories()
	local ids = getIDsAndLastPlayed()
	local final = checkAppManifests(dirs,ids)

	--=====================================================================================
	--                                        DEBUG
	--=====================================================================================
	--Debug code to log all found appNames, lastPlayed timestamps, and appIDs
	for a = 1, table.getn(final) do
		debug("App Name: "..final[a].appName.."","Last Played: "..final[a].lastPlayed.."","App ID: "..final[a].appID.."","")
	end
	debug("Total number of games found: ",table.getn(final))

	return final
end