Module:Sandbox/Aurelain/Heroes

Documentation for this module may be created at Module:Sandbox/Aurelain/Heroes/doc

-- Usage: {{#invoke:HeroesOverview|display|lang=en|faction=Temple}}
local p = {}
local SkillsOverview = require("Module:SkillsOverview")

local FACTION_MAPPING = {
    Temple =     'human',
    Necropolis = 'undead',
    Grove =      'nature',
    Hive =       'demon',
    Schism =     'unfrozen',
    Dungeon =    'dungeon',
}

-- Note: The right side is just a fallback, it will seldom be used.
local TRANSLATION_IDS = {
    wiki_name = 'Name',
}

------------------------------------------------------------------------------------------------------------------------
-- Displays a variable
------------------------------------------------------------------------------------------------------------------------
local function dump(target)
    return '<pre>' .. mw.dumpObject(target) .. '</pre>'
end

------------------------------------------------------------------------------------------------------------------------
-- Retrieves the text for some specific ids from Cargo Translations.
------------------------------------------------------------------------------------------------------------------------
local function translateIds(ids, lang, extra)
    -- Key list
    local list = {}
    for key, _ in pairs(ids) do
        list[#list + 1] = key
    end
    local idListString = '"' .. table.concat(list, '", "') .. '"'

    -- Cargo
    local where = {}
    table.insert(where, 'target_id IN (' .. idListString .. ')')
    table.insert(where, 'language = "' .. lang .. '"')
    if extra then
        table.insert(where, extra)
    end
    local results = mw.ext.cargo.query('Translation', 'target_id, name', {
        where = table.concat(where, ' AND '),
        limit = 100
    })

    -- Dictionary
    local dictionary = mw.clone(ids)
    if results then
        for _, row in ipairs(results) do
            dictionary[row['target_id']] = row['name']
        end
    end
    return dictionary
end

------------------------------------------------------------------------------------------------------------------------
-- Converts a dictionary into a linear array
------------------------------------------------------------------------------------------------------------------------
local function flatten(hub)
    local list = {}
    for _, entry in pairs(hub) do
        list[#list + 1] = entry
    end
    return list
end

------------------------------------------------------------------------------------------------------------------------
-- Interrogates the Hero Cargo table
------------------------------------------------------------------------------------------------------------------------
local function queryHero(lang, forcedFaction)
    -- fields:
    local fields = {}
    table.insert(fields, 'Hero.id = id');
    table.insert(fields, 'Hero.faction = faction');
    table.insert(fields, 'Hero.class_id = class_id');
    table.insert(fields, 'Hero.icon = icon');
    table.insert(fields, 'Hero.specialization_id = specialization_id');
    table.insert(fields, 'Hero.start_skills = start_skills');
    table.insert(fields, 'Hero.start_skill_levels = start_skill_levels');
    table.insert(fields, 'Hero.start_magics = start_magics');
    table.insert(fields, 'Translation.name = name');
    table.insert(fields, 'Translation.language = language');

    -- where:
    local where = {}
    local _ = forcedFaction and table.insert(where, 'Hero.faction="' .. forcedFaction .. '"')
    table.insert(where, 'Hero.id not like "campaign%"')
    table.insert(where, 'Hero.id not like "tutorial%"')
    table.insert(where, 'Hero.id not like "%_fun_%"')
    table.insert(where, 'Translation.type = "hero"')
    table.insert(where, '(Translation.language = "en" OR Translation.language = "' .. lang .. '")')

    -- query:
    return mw.ext.cargo.query('Hero, Translation', table.concat(fields, ','), {
        join = 'Hero.id = Translation.target_id',
        where = table.concat(where, ' AND '),
        limit = 500
    })
end

------------------------------------------------------------------------------------------------------------------------
-- Interrogates the HeroClass Cargo table
------------------------------------------------------------------------------------------------------------------------
local function queryHeroClass(lang)
    -- fields:
    local fields = {}
    table.insert(fields, 'HeroClass.id = id');
    table.insert(fields, 'Translation.name = name');
    table.insert(fields, 'Translation.language = language');

    -- where:
    local where = {}
    table.insert(where, '(Translation.language = "en" OR Translation.language = "' .. lang .. '")')

    -- query:
    return mw.ext.cargo.query('HeroClass, Translation', table.concat(fields, ','), {
        join = 'HeroClass.id = Translation.target_id',
        where = table.concat(where, ' AND '),
        limit = 500
    })
end

------------------------------------------------------------------------------------------------------------------------
-- Interrogates the HeroSpecialization Cargo table
------------------------------------------------------------------------------------------------------------------------
local function queryHeroSpecialization(lang)
    -- fields:
    local fields = {}
    table.insert(fields, 'HeroSpecialization.id = id');
    table.insert(fields, 'HeroSpecialization.icon = icon');
    table.insert(fields, 'Translation.name = name');
    table.insert(fields, 'Translation.description = description');
    table.insert(fields, 'Translation.language = language');

    -- where:
    local where = {}
    table.insert(where, '(Translation.language = "en" OR Translation.language = "' .. lang .. '")')

    -- query:
    return mw.ext.cargo.query('HeroSpecialization, Translation', table.concat(fields, ','), {
        join = 'HeroSpecialization.id = Translation.target_id',
        where = table.concat(where, ' AND '),
        limit = 500
    })
end

------------------------------------------------------------------------------------------------------------------------
-- Boilerplate for the header cells
------------------------------------------------------------------------------------------------------------------------
local function addTh(tr, text)
    tr:tag('th'):wikitext(text):done()
end

------------------------------------------------------------------------------------------------------------------------
-- Boilerplate for the body cells
------------------------------------------------------------------------------------------------------------------------
local function addTd(tr, text)
    tr:tag('td'):wikitext(text):done()
end

------------------------------------------------------------------------------------------------------------------------
-- Boilerplate for the separator rows
------------------------------------------------------------------------------------------------------------------------
local function addSeparator(htmlTable, className, content)
    htmlTable:tag('tr')
        :addClass('separator')
        :addClass(className)
        :tag('td'):attr('data-sort-value', ''):attr('colspan', 7):wikitext(content):done()
end

------------------------------------------------------------------------------------------------------------------------
--
------------------------------------------------------------------------------------------------------------------------
local function createHeader(htmlTable)
    local tr = htmlTable:tag('tr')
end

------------------------------------------------------------------------------------------------------------------------
--
------------------------------------------------------------------------------------------------------------------------
local function createBody(htmlTable)

end

------------------------------------------------------------------------------------------------------------------------
-- Main public function
------------------------------------------------------------------------------------------------------------------------
function p.display(frame)
    --if 1 then return dump(frame) end

    -- Args
    local args = frame.args
    local lang = args.lang ~= '' and args.lang or 'en'
    lang = 'fr'
    local forcedFaction = FACTION_MAPPING[args.faction] or nil

    -- Language
    local words = translateIds(TRANSLATION_IDS, lang)

    -- Cargo
    local main = queryHero(lang, forcedFaction)
    local classes = queryHeroClass(lang)
    local specializations = queryHeroSpecialization(lang)
    local skillsHub = SkillsOverview.getSkillsFromCargo(lang)
    --local spellsHub =
    if 1 then return dump(skillsHub) end

    --local hub = consolidateHeroes(main)
    --local heroes = flatten(hub);

    -- Various manipulations
    --table.sort(heroes, sortSpells)

    -- Table
    local htmlTable = mw.html.create('table')
    htmlTable:addClass('wikitable sortable')
    createHeader(htmlTable)
    createBody(htmlTable)

    -- Output
    local styleTag = frame:extensionTag('templatestyles', '', { src = frame:getTitle() .. '/styles.css' })
    --return dump(pages)
    return styleTag .. tostring(htmlTable)
end

return p