Factorio-Paranoidal_mod/Milestones/scripts/presets_loader.lua

local table = require("__flib__.table")

require("scripts.util")
require("presets.presets")
require("presets.presets_pymods")
require("presets.preset_addons")

local function validate_milestone_presets(interface_name, presets_to_validate, existing_table)
    local valid = true
    if type(presets_to_validate) ~= "table" then
        print_delayed_red("Interface " .. interface_name .. " should return a table.")
        valid = false
    else
        for preset_name, preset in pairs(presets_to_validate) do
            if type(preset_name) ~= "string" then
                print_delayed_red("Interface " .. interface_name .. " should return a table with named keys.")
                valid = false
                break
            end
            if existing_table[preset_name] then
                log("Preset " .. preset_name .. " already exists. Overriding.")
            end
            if not preset.required_mods then
                print_delayed_red("Preset " .. preset_name .. " is missing a `required_mods` value.")
                valid = false
            end
            if not preset.milestones then
                print_delayed_red("Preset " .. preset_name .. " is missing a `milestones` value.")
                valid = false
            else
                _, error = validate_milestones(preset.milestones)
                if error then
                    print_delayed_red({"", "Preset ", preset_name, ": ", error})
                    valid = false
                end
            end
        end
    end
    if not valid then
        print_delayed_red("[img=utility/danger_icon] Please warn the mod author for " .. interface_name .. " about the errors above.")
    end
    return valid
end

function is_preset_mods_enabled(preset)
    local forbidden_mods = preset.forbidden_mods or {}
    for _, mod_name in pairs(preset.required_mods) do
        if not game.active_mods[mod_name] then return false end
    end
    for _, mod_name in pairs(forbidden_mods) do
        if game.active_mods[mod_name] then return false end
    end
    return true
end

local function validate_and_add_to_preset_table(interface_name, remote_milestones_presets, existing_table)
    if validate_milestone_presets(interface_name, remote_milestones_presets, existing_table) then
        ---@cast remote_milestones_presets table
        for remote_preset_name, remote_preset in pairs(remote_milestones_presets) do
            existing_table[remote_preset_name] = remote_preset
        end
    end
end

function fetch_remote_presets()
    -- See presets.lua to find out how to use these reverse remote interface to add your own preset or preset addon.
    global.remote_presets = {}
    global.remote_preset_addons = {}
    for interface_name, functions in pairs(remote.interfaces) do
        if functions["milestones_presets"] then
            local remote_milestones_presets = remote.call(interface_name, "milestones_presets")
            validate_and_add_to_preset_table("milestones_presets", remote_milestones_presets, global.remote_presets)
        end
        if functions["milestones_preset_addons"] then
            local remote_milestones_presets = remote.call(interface_name, "milestones_preset_addons")
            validate_and_add_to_preset_table("milestones_preset_addons", remote_milestones_presets, global.remote_preset_addons)
        end
    end
end

function add_remote_presets_to_preset_tables()
    if global.remote_presets then -- Should always be set in on_init, but just for migration safety
        for remote_preset_name, remote_preset in pairs(global.remote_presets) do
            presets[remote_preset_name] = remote_preset
        end
    end
    if global.remote_preset_addons then
        for remote_preset_name, remote_preset in pairs(global.remote_preset_addons) do
            preset_addons[remote_preset_name] = remote_preset
        end
    end
end

function get_auto_detected_preset_name()
    local chosen_preset_name
    local max_nb_mods_matched = -1
    for _, preset_name in pairs(global.valid_preset_names) do
        local preset = presets[preset_name]
        if preset and #preset.required_mods > max_nb_mods_matched then
            max_nb_mods_matched = #preset.required_mods
            chosen_preset_name = preset_name
        end
    end
    return chosen_preset_name
end

function load_presets()
    global.valid_preset_names = {"Empty"}

    for preset_name, preset in pairs(presets) do
        if is_preset_mods_enabled(preset) then
            table.insert(global.valid_preset_names, preset_name)
        end
    end
    log("Valid presets found: " .. serpent.line(global.valid_preset_names))

    if global.current_preset_name == nil then
        global.current_preset_name = get_auto_detected_preset_name()
        log("Auto-detected preset used: " .. global.current_preset_name)
        table.insert(global.delayed_chat_messages, {"milestones.message_loaded_presets", global.current_preset_name})
        global.loaded_milestones = table.deep_copy(presets[global.current_preset_name].milestones)
    end
end

function load_preset_addons()
    local preset_addons_loaded = {}
    for preset_addon_name, preset_addon in pairs(preset_addons) do
        if is_preset_mods_enabled(preset_addon) then
            table.insert(preset_addons_loaded, preset_addon_name)
            for _, milestone in pairs(preset_addon.milestones) do
                table.insert(global.loaded_milestones, milestone)
            end
        end
    end
    log("Preset addons loaded: " .. serpent.line(preset_addons_loaded))

    if #preset_addons_loaded == 1 then
        table.insert(global.delayed_chat_messages, {"milestones.message_loaded_preset_addons_singular", preset_addons_loaded[1]})
    elseif #preset_addons_loaded > 1 then
        table.insert(global.delayed_chat_messages, {"milestones.message_loaded_preset_addons_plural", table.concat(preset_addons_loaded, ", ")})
    end
end

function reload_presets()
    log("Reloading presets")
    local added_presets = {}
    local new_valid_preset_names = {"Empty"}

    for preset_name, preset in pairs(presets) do
        if is_preset_mods_enabled(preset) then
            table.insert(new_valid_preset_names, preset_name)
            if not table_contains(global.valid_preset_names, preset_name) then
                table.insert(added_presets, preset_name)
            end
        end
    end
    global.valid_preset_names = new_valid_preset_names
    log("New presets found: " .. serpent.line(added_presets))
    log("New list of valid presets: " .. serpent.line(global.valid_preset_names))
    if #added_presets == 1 then
        table.insert(global.delayed_chat_messages, {"milestones.message_reloaded_presets_singular", added_presets[1]})
    elseif #added_presets > 1 then
        table.insert(global.delayed_chat_messages, {"milestones.message_reloaded_presets_plural", table.concat(added_presets, ", ")})
    end
end