Jump to content

Module:PadUtils

From PAD Wiki
Revision as of 05:59, 22 August 2025 by GlifterPad (talk | contribs)

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

-- Module:PadUtils
local p = {}

-- split "A;B;C" safely (ignores empty pieces)
local function split(text, delim)
    local out = {}
    if not text or text == "" then return out end
    for part in mw.text.gsplit(text, delim, true) do
        part = mw.text.trim(part)
        if part ~= "" then table.insert(out, part) end
    end
    return out
end

-- Accept any of:
--   "Floor Name"
--   "Floor_Target|Floor Label"
--   "[[Dungeon/Floor_Target|Floor Label]]"
--   "[[Floor_Target|Floor Label]]"
local function parseItem(item)
    local inner = item:match("^%[%[(.*)%]%]$")
    if inner then item = inner end
    local t, l = item:match("^(.-)|(.*)$")
    local target = mw.text.trim(t or item)
    local label  = mw.text.trim(l or item)
    return target, label
end

-- Always normalize to "base/floor" for the link target.
-- If target already starts with "base/", strip that prefix first.
local function normalizeTarget(base, target)
    target = mw.text.trim(target)
    local withSlash = base .. "/"
    if target:sub(1, #withSlash) == withSlash then
        target = target:sub(#withSlash + 1)
    end
    return base .. "/" .. target
end

function p.dungeonFloors(frame)
    local args    = frame.args
    local base    = args.base and mw.text.trim(args.base) or mw.title.getCurrentTitle().fullText
    local floors  = split(args.floors or "", ";")
    local ordered = (args.ol == "1" or args.ol == "true")
    local before  = args.before or ""
    local after   = args.after or ""

    if #floors == 0 then return "" end

    local lines = {}
    for _, raw in ipairs(floors) do
        local target, label = parseItem(raw)
        local titleText = normalizeTarget(base, target)

        local titleObj   = mw.title.new(titleText)
        local linkTarget = titleObj and titleObj.prefixedText or titleText  -- <-- fixed

        local bullet = ordered and "#" or "*"
        table.insert(lines, string.format("%s [[%s|%s%s%s]]", bullet, linkTarget, before, label, after))
    end

    return frame:preprocess(table.concat(lines, "\n"))
end

-- Module:PadUtils (append this function)
local p = {}

-- ... (keep your other helpers / functions above)

-- Build a nested list of all dungeons and their floors from Cargo.
-- Optional args:
--   type   : filter by Type (e.g., "Daily")
--   ol     : "1"/"true" to use <ol> for dungeons; floors are always <ul>
--   order  : "name" or "id" (defaults to name)
-- Build a nested list of all dungeons and their floors from Cargo.
-- Args (all optional):
--   type      : filter by Type (e.g., "Daily")
--   ol        : "1"/"true" -> numbered dungeons; floors stay bulleted
--   order     : "name" (default) or "id"   -- top-level and floor order
--   showcount : "1"/"true" -> append (N) after each dungeon name
--   limit     : max rows to fetch (default 5000)
-- Renders:
-- <a href="/wiki/Dungeon">Dungeon</a>
-- <ul>
--   <li><a href="/wiki/Dungeon/Floor">Floor</a></li>
--   ...
-- </ul>
-- (repeats for each dungeon)
function p.dungeonIndex(frame)
    local args  = frame.args
    local where = nil
    if args.type and args.type ~= "" then
        where = string.format("Type = '%s'", tostring(args.type):gsub("'", "''"))
    end

    local rows = mw.ext.cargo.query(
        'dungeon_floors',
        'Dungeon, Name',
        { where = where, orderBy = 'Dungeon, Name', limit = 5000 }
    )
    if not rows or #rows == 0 then
        return "''No results''"
    end

    -- strip [[...]] helper
    local function stripLinks(s)
        s = mw.text.trim(s or "")
        local inner = s:match("^%[%[(.*)%]%]$")
        return mw.text.trim(inner or s)
    end

    -- normalize a dungeon to a stable key + link target + display
    local function normalizeDungeon(raw)
        local s = stripLinks(raw)
        -- try to build a proper Title; this normalizes spaces/underscores
        local t = mw.title.new(s)
        if t then
            return t.prefixedText, t.prefixedText, t.text -- key, link target, display text
        else
            -- fallback: treat underscores/spaces as equivalent
            local display = (s:gsub("_", " "))
            return display, s, display
        end
    end

    -- group floors by normalized dungeon key
    local groups, order = {}, {}
    for _, r in ipairs(rows) do
        local key, linkTarget, display = normalizeDungeon(r.Dungeon)
        if not groups[key] then
            groups[key] = { link = linkTarget, label = display, floors = {} }
            table.insert(order, key)
        end
        table.insert(groups[key].floors, stripLinks(r.Name))
    end

    table.sort(order, function(a, b) return groups[a].label < groups[b].label end)
    -- sort floors alphabetically within each dungeon
    for _, k in ipairs(order) do table.sort(groups[k].floors) end

    -- build wikitext: dungeon as link on its own line, floors as bullets
    local out = {}
    for _, k in ipairs(order) do
        local g = groups[k]
        table.insert(out, string.format('[[%s|%s]]', g.link, g.label))
        for _, fname in ipairs(g.floors) do
            local target = g.link .. '/' .. fname
            table.insert(out, '* [[' .. target .. '|' .. fname .. ']]')
        end
        table.insert(out, "") -- blank line between dungeons
    end

    return frame:preprocess(table.concat(out, "\n"))
end

-- Build a list of floor links under the current dungeon (or a given base).
-- Usage from template/page:
--   {{#invoke:PadUtils|dungeonFloors | base={{FULLPAGENAME}} | floors=Floor A;Floor B }}
function p.dungeonFloors(frame)
    local args    = frame.args
    local base    = args.base and mw.text.trim(args.base) or mw.title.getCurrentTitle().fullText
    local floors  = args.floors or ""
    local ordered = (args.ol == "1" or args.ol == "true")
    local before  = args.before or ""
    local after   = args.after or ""

    -- split on semicolons
    local list = {}
    for part in mw.text.gsplit(floors, ";", true) do
        part = mw.text.trim(part)
        if part ~= "" then
            -- allow [[Target|Label]] or Target|Label or plain Name
            local inner = part:match("^%[%[(.*)%]%]$") or part
            local t, l  = inner:match("^(.-)|(.*)$")
            local target = mw.text.trim(t or inner)
            local label  = mw.text.trim(l or inner)

            -- if target already starts with "base/", strip it; always link as base/target
            local withSlash = base .. "/"
            if target:sub(1, #withSlash) == withSlash then
                target = target:sub(#withSlash + 1)
            end
            local fullTarget = base .. "/" .. target
            local titleObj   = mw.title.new(fullTarget)
            local linkTarget = titleObj and titleObj.prefixedText or fullTarget

            local bullet = ordered and "#" or "*"
            table.insert(list, string.format("%s [[%s|%s%s%s]]", bullet, linkTarget, before, label, after))
        end
    end

    return frame:preprocess(table.concat(list, "\n"))
end

-- List all dungeon floors that drop a given item.
-- Usage (on an item page):  {{#invoke:PadUtils|dropLocations|item=Dragon Seed}}
function p.dropLocations(frame)
    local item = mw.text.trim(frame.args.item or "")
    if item == "" then return "''(no item given)''" end

    -- Helper: strip [[...]] and trim
    local function stripLinks(s)
        s = mw.text.trim(s or "")
        local inner = s:match("^%[%[(.*)%]%]$")
        return mw.text.trim(inner or s)
    end

    -- Query Cargo. Prefer HOLDS (works on List fields); include LIKE as a fallback
    local itemEsc = item:gsub("'", "''")
    local where = string.format("Drops HOLDS '%s' OR Drops LIKE '%%%s%%'", itemEsc, itemEsc)

    local rows = mw.ext.cargo.query(
        'dungeon_floors',
        'Dungeon, Name',
        { where = where, orderBy = 'Dungeon, Name', limit = 5000 }
    )

    if not rows or #rows == 0 then
        return "None"
    end

    -- Build a simple bullet list: [[Dungeon/Name|Name]] (label = floor name)
    local out = {}
    for _, r in ipairs(rows) do
        local dungeon = stripLinks(r.Dungeon)         -- normalize against stray [[...]]
        dungeon = (mw.title.new(dungeon) and mw.title.new(dungeon).prefixedText) or dungeon
        local floor   = stripLinks(r.Name)

        local target = dungeon .. '/' .. floor
        local t = mw.title.new(target)
        local linkTarget = (t and t.prefixedText) or target

        table.insert(out, '* [[' .. linkTarget .. '|' .. floor .. ']]')
    end

    -- Render as wikitext (bullets + links)
    return frame:preprocess(table.concat(out, '\n'))
end

return p
Retrieved from "https://pad.laggygaming.com/index.php?title=Module:PadUtils&oldid=665"