Module:DataTableParser

Documentation for this module may be created at Module:DataTableParser/doc

-- Module:DataTableParser
-- Handles display and formatting of building data for Templates
-- Updated to parse wiki tables directly instead of using Cargo

local p = {}

-- Function to generate icon file reference for a resource
local function getResourceIcon(resourceName)
    if not resourceName or resourceName == "" then
        return ""
    end
    
    -- Convert spaces to underscores for file name
    local fileName = resourceName:gsub("%s+", "_") .. "_-_Icon.png"
    
    -- Check if the file actually exists in the wiki
    local fileTitle = mw.title.new("File:" .. fileName)
    if fileTitle and fileTitle.exists then
        -- Return file reference with appropriate size only if it exists
        return "[[File:" .. fileName .. "|20px]]"
    else
        -- If file doesn't exist, return empty string
        return ""
    end
end

-- Function to add icons to resource links in text
function p.iconize(frame)
    local text = frame.args[1] or ""
    
    -- Find all resource links [[Resource Name]] and add appropriate icons
    text = text:gsub("%[%[([^%]]+)%]%]", function(resourceName)
        local icon = getResourceIcon(resourceName)
        if icon ~= "" then
            return icon .. " [[" .. resourceName .. "]]"
        else
            -- If no icon exists, just return the original link
            return "[[" .. resourceName .. "]]"
        end
    end)
    
    return text
end

----------------------------------------------------------------------
-- Helper function to load/parse the wiki table page for buildings
----------------------------------------------------------------------
local function loadBuildingWikiTable()
    local title = "Data:Building"  -- The page containing your building table
    local content = mw.title.new(title):getContent()
    if not content then
        return nil, "Error: Building wiki table page not found!"
    end

    local lines = mw.text.split(content, "\n")
    -- Filter out magic words, noindex tags, or blank lines
    local filtered = {}
    for _, line in ipairs(lines) do
        line = mw.text.trim(line)
        if line ~= "" and not line:match("^__") and not line:match("<noindex>") and not line:match("</noindex>") then
            table.insert(filtered, line)
        end
    end
    if #filtered < 2 then
        return nil, "Error: No valid wiki table content found!"
    end

    local inTable = false
    local headers = {}  -- store the table headers
    local colMap = {}  -- map header name to column index
    local data = {}     -- array of row arrays
    local currentRow = {}

    local readingHeader = true  -- before the first row separator ("|-"), treat cells as headers

    for _, line in ipairs(filtered) do
        if line:match("^{|") then
            -- Start of table (line starts with "{|")
            inTable = true
        elseif line:match("^|%-") then
            -- Row separator ("|-")
            if not readingHeader and #currentRow > 0 then
                table.insert(data, currentRow)
            end
            currentRow = {}
            readingHeader = false  -- after the first row separator, subsequent cells are row cells
        elseif line:match("^!") then
            -- Header cell (starts with "!")
            local header = line:gsub("^!+%s*", "")  -- Remove leading ! and whitespace
            header = mw.text.trim(header)
            table.insert(headers, header)
        elseif line:match("^|%+") then
            -- Table caption line ("|+"), skip it
        elseif line:match("^|}") then
            -- End of table ("|}")
            if not readingHeader and #currentRow > 0 then
                table.insert(data, currentRow)
            end
            inTable = false
        elseif inTable and line:match("^|[^%-+}]") then
            -- Process table cell lines (lines that start with "|" but not "|+", "|-", or "|}")
            local cell = line:gsub("^|+%s*", "")  -- Remove leading | and whitespace
            cell = mw.text.trim(cell)
            if not readingHeader then
                table.insert(currentRow, cell)
            end
        end
    end

    -- Build colMap from headers (map header name to its column index)
    for i, h in ipairs(headers) do
        colMap[mw.text.trim(h)] = i
    end

    return { rows = data, colMap = colMap }, nil
end

----------------------------------------------------------------------
-- Helper function to load/parse the wiki table page for refining data
----------------------------------------------------------------------
local function loadRefiningWikiTable()
    local title = "Data:Refining"  -- The page containing your refining table
    local content = mw.title.new(title):getContent()
    if not content then
        return nil, "Error: Refining wiki table page not found!"
    end

    local lines = mw.text.split(content, "\n")
    -- Filter out magic words, noindex tags, or blank lines
    local filtered = {}
    for _, line in ipairs(lines) do
        line = mw.text.trim(line)
        if line ~= "" and not line:match("^__") and not line:match("<noindex>") and not line:match("</noindex>") then
            table.insert(filtered, line)
        end
    end
    if #filtered < 2 then
        return nil, "Error: No valid wiki table content found!"
    end

    local inTable = false
    local headers = {}  -- store the table headers
    local colMap = {}  -- map header name to column index
    local data = {}     -- array of row arrays
    local currentRow = {}

    local readingHeader = true  -- before the first row separator ("|-"), treat cells as headers

    for _, line in ipairs(filtered) do
        if line:match("^{|") then
            -- Start of table (line starts with "{|")
            inTable = true
        elseif line:match("^|%-") then
            -- Row separator ("|-")
            if not readingHeader and #currentRow > 0 then
                table.insert(data, currentRow)
            end
            currentRow = {}
            readingHeader = false  -- after the first row separator, subsequent cells are row cells
        elseif line:match("^!") then
            -- Header cell (starts with "!")
            local header = line:gsub("^!+%s*", "")  -- Remove leading ! and whitespace
            header = mw.text.trim(header)
            table.insert(headers, header)
        elseif line:match("^|%+") then
            -- Table caption line ("|+"), skip it
        elseif line:match("^|}") then
            -- End of table ("|}")
            if not readingHeader and #currentRow > 0 then
                table.insert(data, currentRow)
            end
            inTable = false
        elseif inTable and line:match("^|[^%-+}]") then
            -- Process table cell lines (lines that start with "|" but not "|+", "|-", or "|}")
            local cell = line:gsub("^|+%s*", "")  -- Remove leading | and whitespace
            cell = mw.text.trim(cell)
            if not readingHeader then
                table.insert(currentRow, cell)
            end
        end
    end

    -- Build colMap from headers (map header name to its column index)
    for i, h in ipairs(headers) do
        colMap[mw.text.trim(h)] = i
    end

    return { rows = data, colMap = colMap }, nil
end

-- Function to add icons to resource links in text
function p.iconize(frame)
    local text = frame.args[1] or ""
    
    -- Find all resource links [[Resource Name]] and add appropriate icons
    text = text:gsub("%[%[([^%]]+)%]%]", function(resourceName)
        local icon = getResourceIcon(resourceName)
        return icon .. " [[" .. resourceName .. "]]"
    end)
    
    return text
end

-- Function to format a recipe component
function p.formatComponent(text)
    if not text or text == "" then
        return ""
    end
    
    -- Split recipe into components (in case there are multiple)
    local components = mw.text.split(text, ";")
    local formatted = {}
    
    for i, component in ipairs(components) do
        component = mw.text.trim(component)
        -- Extract item name and quantity (e.g., "[[Salvaged Metal]] x 25")
        local itemName, quantity = component:match("%[%[([^%]]+)%]%] x (%d+)")
        
        if itemName and quantity then
            local icon = getResourceIcon(itemName)
            table.insert(formatted, icon .. " [[" .. itemName .. "]] x " .. quantity)
        else
            -- If pattern doesn't match, use as is
            table.insert(formatted, component)
        end
    end
    
    return table.concat(formatted, "<br>")
end

-- Function to get building data by name
function p.getBuildingData(buildingName)
    local buildingData, err = loadBuildingWikiTable()
    if not buildingData then
        return nil, err
    end
    
    local colMap = buildingData.colMap
    local rows = buildingData.rows
    
    local nameCol = colMap["Name"]
    if not nameCol then
        return nil, "Error: 'Name' column not found in Building table"
    end
    
    for _, fields in ipairs(rows) do
        local name = fields[nameCol]
        if name == buildingName then
            return fields, colMap
        end
    end
    
    return nil, "Building '" .. buildingName .. "' not found"
end

-- Function to get refining recipes by refiner name
function p.getRefiningRecipes(refinerName)
    local refiningData, err = loadRefiningWikiTable()
    if not refiningData then
        return nil, err
    end
    
    local colMap = refiningData.colMap
    local rows = refiningData.rows
    
    local refinerCol = colMap["Refiner Needed"]
    if not refinerCol then
        return nil, "Error: 'Refiner Needed' column not found in Refining table"
    end
    
    local recipes = {}
    for _, fields in ipairs(rows) do
        local refiner = fields[refinerCol]
        if refiner == refinerName then
            table.insert(recipes, fields)
        end
    end
    
    return recipes, colMap
end

-- Function to format a refining recipe row
function p.formatRecipeRow(recipe, colMap)
    local output = recipe[colMap["Name"]] or ""
    local ingredient = recipe[colMap["Ingredients to Smelt"]] or ""
    local time = recipe[colMap["Time to Smelt"]] or ""
    local quantity = recipe[colMap["Recipe to Smelt"]] or "1"
    
    -- Add icons to resource names
    local formattedOutput = p.iconize({args = {[1] = output}})
    local formattedIngredient = p.iconize({args = {[1] = ingredient}})
    
    -- Return formatted row HTML directly
    return "<tr>" ..
           "<td>" .. formattedOutput .. "</td>" ..
           "<td>" .. formattedIngredient .. "</td>" ..
           "<td style=\"text-align:center;\">" .. time .. "</td>" ..
           "<td style=\"text-align:center;\">" .. quantity .. "</td>" ..
           "</tr>"
end

-- Main function to format building data for the template
function p.formatBuilding(frame)
    local buildingName = frame.args[1] or frame.args.name
    
    if not buildingName then
        return "Error: No building name provided"
    end
    
    -- Get building data
    local building, colMap = p.getBuildingData(buildingName)
    
    if not building then
        return "Error: Building '" .. buildingName .. "' not found"
    end
    
    -- Map building data to template parameters
    local params = {
        Name = building[colMap["Name"]] or "",
        Description = p.iconize({args = {[1] = building[colMap["Description"]] or ""}}),
        JourneyRequirement = p.iconize({args = {[1] = building[colMap["Journey Requirement"]] or ""}}),
        ImageFile = building[colMap["Image File"]] or "",
        Health = building[colMap["Health"]] or "",
        EnergyConsumption = building[colMap["Power Cost"]] or "",
        GeneratesPower = building[colMap["Generates Power"]] or "",
        StorageSlots = building[colMap["Storage Slots"]] or "",
        StorageVolume = building[colMap["Storage Capacity"]] or "",
        Components = p.formatComponent(building[colMap["Recipe to Build"]] or ""),
        PlacedWith = p.iconize({args = {[1] = building[colMap["Placed With"]] or ""}}),
        AdditionalNotes = p.iconize({args = {[1] = building[colMap["Additional Notes"]] or ""}}),
        PrimarySource = "Crafting" -- Default value, adjust as needed
    }
    
    -- Generate formatted output for template
    local output = ""
    for param, value in pairs(params) do
        if value and value ~= "" then
            output = output .. "|" .. param .. "=" .. value .. "\n"
        end
    end
    
    return output
end

-- Function to format all refining recipes for a building
function p.formatRefiningRecipes(frame)
    local buildingName = frame.args[1] or frame.args.name
    
    if not buildingName then
        return "Error: No building name provided"
    end
    
    -- Get refining recipes
    local recipes, colMap = p.getRefiningRecipes(buildingName)
    
    if not recipes or #recipes == 0 then
        return "<tr><td colspan=\"4\" style=\"text-align:center;\">No recipes found.</td></tr>"
    end
    
    local output = ""
    for _, recipe in ipairs(recipes) do
        output = output .. p.formatRecipeRow(recipe, colMap)
    end
    
    return output
end

-- Helper function to display building with the template
-- Helper function to display building with the template
function p.displayBuilding(frame)
    local buildingName = frame.args[1] or frame.args.name
    
    if not buildingName then
        return "Error: No building name provided"
    end
    
    -- Get building data directly
    local buildingData, err = loadBuildingWikiTable()
    if not buildingData then
        return err
    end
    
    local rows = buildingData.rows
    
    -- Find the building by name (column 2)
    local building = nil
    for _, row in ipairs(rows) do
        if row[2] == buildingName then
            building = row
            break
        end
    end
    
    if not building then
        return "Error: Building '" .. buildingName .. "' not found"
    end
    
    -- For simplicity and to avoid confusion, map each parameter explicitly
    local args = {}
    
    -- Map row values to template parameters directly
    args["Name"] = building[2] or ""                -- Column 2: Name
    args["Description"] = building[3] or ""         -- Column 3: Description  
    args["JourneyRequirement"] = building[4] or ""  -- Column 4: JourneyRequirement
    args["Health"] = building[5] or ""              -- Column 5: Health
    args["EnergyConsumption"] = building[6] or ""   -- Column 6: PowerCost
    args["GeneratesPower"] = building[7] or ""      -- Column 7: GeneratesPower
    args["StorageSlots"] = building[8] or ""        -- Column 8: StorageSlots
    args["StorageVolume"] = building[9] or ""       -- Column 9: StorageCapacity
    args["Components"] = building[10] or ""         -- Column 10: RecipeToBuild
    args["PlacedWith"] = building[11] or ""         -- Column 11: PlacedWith
    args["AdditionalNotes"] = building[12] or ""    -- Column 12: AdditionalNotes
    args["ImageFile"] = building[14] or ""          -- Column 14: ImageFile
    args["PrimarySource"] = "Crafting"              -- Default value
    
    -- Handle YouTube video if present (Column 19: Youtube)
    if building[19] and building[19] ~= "-" and building[19] ~= "" then
        -- Set video title
        args["VideoTitle"] = "Building Guide"
        
        local youtubeUrl = building[19]
        
        -- Extract video ID from the URL
        local videoId = youtubeUrl:match("v=([%w-_]+)")
        if videoId then
            -- Use the #tag parser function instead of direct XML tags
            args["VideoEmbed"] = '{{#tag:youtube|' .. videoId .. '}}'
        else
            args["VideoEmbed"] = "Coming Soon"
        end
    else
        args["VideoEmbed"] = "Coming Soon"
    end
    
    -- Replace "-" placeholders with empty strings
    for key, value in pairs(args) do
        if value == "-" then
            args[key] = ""
        end
    end
    
    -- Process recipe components
    if args["Components"] and args["Components"] ~= "" then
        args["Components"] = p.formatComponent(args["Components"])
    end
    
    -- Process descriptions and journey requirements with iconize
    if args["Description"] and args["Description"] ~= "" then
        args["Description"] = p.iconize({args = {[1] = args["Description"]}})
    end
    
    if args["JourneyRequirement"] and args["JourneyRequirement"] ~= "" then
        args["JourneyRequirement"] = p.iconize({args = {[1] = args["JourneyRequirement"]}})
    end
    
    if args["PlacedWith"] and args["PlacedWith"] ~= "" then
        args["PlacedWith"] = p.iconize({args = {[1] = args["PlacedWith"]}})
    end
    
    -- Expand the template with our parameters
    return frame:expandTemplate{ title = 'BuildingRefinerDisplay', args = args }
end

-- Debug function to help troubleshoot
function p.debugBuilding(frame)
    local buildingName = frame.args[1] or frame.args.name
    
    if not buildingName then
        return "Error: No building name provided"
    end
    
    -- Get building data directly
    local buildingData, err = loadBuildingWikiTable()
    if not buildingData then
        return err
    end
    
    local colMap = buildingData.colMap
    local rows = buildingData.rows
    
    -- Find the building
    local building = nil
    for _, row in ipairs(rows) do
        if row[colMap["Name"]] == buildingName then
            building = row
            break
        end
    end
    
    if not building then
        return "Error: Building '" .. buildingName .. "' not found"
    end
    
    -- Output all data for debugging
    local debug = "Building: " .. buildingName .. "\n\n"
    for k, v in pairs(colMap) do
        debug = debug .. k .. ": " .. tostring(building[v] or "nil") .. "\n"
    end
    
    return debug
end

-- Debug function to show raw table data
function p.debugRawData(frame)
    local buildingData, err = loadBuildingWikiTable()
    if not buildingData then
        return err
    end
    
    local colMap = buildingData.colMap
    
    -- Show all column mappings
    local output = "Column mappings:\n"
    for name, index in pairs(colMap) do
        output = output .. name .. " -> " .. index .. "\n"
    end
    
    output = output .. "\n\nFirst row raw data:\n"
    local row = buildingData.rows[1]
    for i = 1, #row do
        output = output .. "Column " .. i .. ": " .. tostring(row[i]) .. "\n"
    end
    
    return output
end

-- Debug function to show template parameters
function p.debugTemplateParams(frame)
    local buildingName = frame.args[1] or frame.args.name
    
    if not buildingName then
        return "Error: No building name provided"
    end
    
    -- Get building data directly
    local buildingData, err = loadBuildingWikiTable()
    if not buildingData then
        return err
    end
    
    local colMap = buildingData.colMap
    local rows = buildingData.rows
    
    -- Find the building
    local building = nil
    for _, row in ipairs(rows) do
        if row[colMap["Name"]] == buildingName then
            building = row
            break
        end
    end
    
    if not building then
        return "Error: Building '" .. buildingName .. "' not found"
    end
    
    -- Map building data to template parameters
    local args = {
        ["Name"] = building[colMap["Name"]] or "",
        ["Description"] = building[colMap["Description"]] or "",
        ["JourneyRequirement"] = building[colMap["Journey Requirement"]] or "",
        ["ImageFile"] = building[colMap["Image File"]] or "",
        ["Health"] = building[colMap["Health"]] or "",
        ["EnergyConsumption"] = building[colMap["Power Cost"]] or "",
        ["GeneratesPower"] = building[colMap["Generates Power"]] or "",
        ["StorageSlots"] = building[colMap["Storage Slots"]] or "",
        ["StorageVolume"] = building[colMap["Storage Capacity"]] or "",
        ["Components"] = building[colMap["Recipe to Build"]] or "",
        ["PlacedWith"] = building[colMap["Placed With"]] or "",
        ["AdditionalNotes"] = building[colMap["Additional Notes"]] or "",
        ["PrimarySource"] = "Crafting" -- Default value, adjust as needed
    }
    
    -- Output the template parameters
    local result = "Template Parameters:\n"
    for param, value in pairs(args) do
        result = result .. param .. " = " .. tostring(value) .. "\n"
    end
    
    return result
end

-- Function to generate a YouTube embed from a building name
function p.getYoutubeEmbed(frame)
    local buildingName = frame.args[1] or ""
    
    -- Get building data
    local buildingData, err = loadBuildingWikiTable()
    if not buildingData then
        return "Error loading data"
    end
    
    local rows = buildingData.rows
    
    -- Find the building
    local building = nil
    for _, row in ipairs(rows) do
        if row[2] == buildingName then
            building = row
            break
        end
    end
    
    if not building or not building[19] or building[19] == "-" or building[19] == "" then
        return "Coming Soon"
    end
    
    -- Get YouTube URL and extract video ID
    local youtubeUrl = building[19]
    local videoId = youtubeUrl:match("v=([%w-_]+)")
    
    if not videoId then
        return "Coming Soon"
    end
    
    -- Return the raw tag (not as a string)
    return '<youtube>' .. videoId .. '</youtube>'
end

return p