Objectives.lua

_addon.name = 'Objectives'
_addon.author = 'Meliora'
_addon.version = '0.2.0'
_addon.commands = {'ob'}

local packets = require('packets')
local entries = windower.addon_path .. 'data/entries.lua'
local objectives = {}
local objective_ids = {}
local capture_enabled = false
local pending_accepts = {}
local roe = {
    active = {},
    complete = {},
    max_count = 30
}

function log_message(message)
    windower.add_to_chat(122, ('[%s] %s'):format(_addon.name, message))
end

local function load_objectives()
    local ok, data = pcall(dofile, entries)
    if ok and type(data) == 'table' then
        objectives = data
        objective_ids = {}

        for _, entry in ipairs(objectives) do
            if entry and entry.id then
                objective_ids[tonumber(entry.id)] = entry
            end
        end

        return true
    end

    objectives = {}
    objective_ids = {}
    log_message('failed to load roe entries')
    return false
end

local function save_objectives()
    local lines = {'return {'}

    for index, entry in ipairs(objectives) do
        local fields = {('id=%d'):format(entry.id), ('name=%q'):format(entry.name)}

        if entry.category and entry.category ~= '' then
            fields[#fields + 1] = ('category=%q'):format(entry.category)
        else
            fields[#fields + 1] = 'category=""'
        end

        lines[#lines + 1] = ('    [%d] = {%s},'):format(index, table.concat(fields, ', '))
    end

    lines[#lines + 1] = '}, {"id", "name", "category"}'

    local file = io.open(entries, 'w')
    if not file then
        log_message('failed to save names.lua')
        return false
    end

    file:write(table.concat(lines, '\n'))
    file:write('\n')
    file:close()
    return true
end

local function accept_roe(id)
    id = tonumber(id)
    if not id or roe.complete[id] or roe.active[id] then
        return false
    end

    if id >= 4008 and id <= 4021 then
        return false
    end

    local packet = packets.new('outgoing', 0x10C, {
        ['RoE Quest'] = id
    })
    packets.inject(packet)
    return true
end

local function cancel_roe(id)
    id = tonumber(id)

    if not id then
        return false
    end

    local progress = roe.active[id]
    if progress == nil or progress ~= 0 then
        return false
    end

    local packet = packets.new('outgoing', 0x10D, {
        ['RoE Quest'] = id
    })
    packets.inject(packet)
    return true
end

local function sorted_objectives()
    local entries = {}

    for index, entry in ipairs(objectives) do
        entries[#entries + 1] = {
            index = index,
            id = entry.id,
            name = entry.name,
            category = entry.category
        }
    end

    table.sort(entries, function(left, right)
        return left.id < right.id
    end)

    return entries
end

local function available_slots()
    local count = 0

    for _ in pairs(roe.active) do
        count = count + 1
    end

    return roe.max_count - count
end

local function normalize_category(category)
    if type(category) ~= 'string' then
        return nil
    end

    category = category:lower():gsub('^%s+', ''):gsub('%s+$', '')

    if category == '' then
        return nil
    end

    return category
end

local function build_selected_list(category, cap_to_max)
    local selected = {}
    local normalized_category = normalize_category(category)

    for _, entry in ipairs(objectives) do
        local entry_category = normalize_category(entry.category)
        if not normalized_category or entry_category == normalized_category then
            selected[#selected + 1] = entry
        end
    end

    if cap_to_max and not normalized_category and #selected > roe.max_count then
        local capped = {}
        for i = 1, roe.max_count do
            capped[i] = selected[i]
        end

        return capped, normalized_category

    end

    return selected, normalized_category
end

local function count_set_candidates(selected, slot_limit)
    local count = 0

    for _, entry in ipairs(selected) do
        local id = entry.id
        if id and not roe.complete[id] and not roe.active[id] and not (id >= 4008 and id <= 4021) then
            count = count + 1
            if slot_limit and count >= slot_limit then
                break
            end
        end
    end

    return count

end

local function count_unset_candidates(selected)
    local count = 0

    for _, entry in ipairs(selected) do
        local progress = roe.active[entry.id]
        if progress ~= nil and progress == 0 then
            count = count + 1
        end
    end

    return count

end

local function set_objectives(category)
    if not load_objectives() then
        return
    end

    local selected, normalized_category = build_selected_list(category, true)
    if #selected == 0 then
        if normalized_category then
            log_message(('no RoE entries found for category "%s"'):format(normalized_category))
        else
            log_message('no RoE entries found in database')
        end

        return

    end

    local slots = available_slots()
    if slots <= 0 then
        log_message('no free RoE slots available')

        return

    end

    local scope = normalized_category and (' for category "' .. normalized_category .. '"') or ''
    local candidate_count = count_set_candidates(selected, slots)
    if candidate_count <= 0 then

        return

    end

    log_message(('Starting to set %d RoE objective(s)%s.'):format(candidate_count, scope))

    local queued = 0
    local skipped = 0

    for _, entry in ipairs(selected) do
        if queued >= slots then
            break
        end

        local id = entry.id
        if accept_roe(id) then
            queued = queued + 1
            coroutine.sleep(1.5)
        else
            skipped = skipped + 1
        end
    end

    log_message('Finished setting RoE' .. scope .. '.')
end

local function unset_objectives(category)
    if not load_objectives() then
        return
    end

    local selected, normalized_category = build_selected_list(category, false)
    if #selected == 0 then
        if normalized_category then
            log_message(('no RoE entries found for category "%s"'):format(normalized_category))
        else
            log_message('no RoE entries found in database')
        end
        return
    end

    local scope = normalized_category and (' for category "' .. normalized_category .. '"') or ''
    local candidate_count = count_unset_candidates(selected)
    if candidate_count <= 0 then
        return
    end
    log_message(('Starting to unset %d RoE objective(s)%s.'):format(candidate_count, scope))

    local queued = 0
    local skipped = 0

    for i = #selected, 1, -1 do
        local id = selected[i].id
        if cancel_roe(id) then
            queued = queued + 1
            coroutine.sleep(1.5)
        else
            skipped = skipped + 1
        end
    end

    log_message('Finished unsetting RoE' .. scope .. '.')
end

local function process_incoming_chunk(id, data)
    if id == 0x111 then
        roe.active = {}

        for i = 1, roe.max_count do
            local offset = 5 + ((i - 1) * 4)
            local roe_id, progress = data:unpack('b12b20', offset)
            if roe_id > 0 then
                roe.active[roe_id] = progress
            end
        end
        return
    end

    if id == 0x112 then
        local order = data:unpack('H', 133)
        local bits = {data:unpack(('b1'):rep(1024), 4)}

        for i, value in ipairs(bits) do
            if value == 1 then
                local roe_id = i + (1024 * order) - 1
                roe.complete[roe_id] = true
            end
        end
    end
end

local function record_id(id)
    if not capture_enabled then
        return
    end
    if not id or id == 0 then
        return
    end
    if objective_ids[id] then
        return
    end
end

local function enqueue_pending_id(id)
    if not capture_enabled or not id or id == 0 then
        return
    end
    pending_accepts[#pending_accepts + 1] = id
end

local function extract_undertaken_name(text)
    if type(text) ~= 'string' then
        return nil
    end

    local prefix = 'You have undertaken '
    if text:sub(1, #prefix) ~= prefix then
        return nil
    end

    local name = text:sub(#prefix + 1)

    name = name:gsub('[^\32-\126]', '')
    name = name:gsub('^%s+', ''):gsub('%s+$', '')
    name = name:match('([%w].*)') or name
    name = name:match('^(.*[%w%)])') or name
    name = name:gsub('%.%d+$', '')
    name = name:gsub('%.$', '')
    name = name:gsub('^%s+', ''):gsub('%s+$', '')

    if name == '' then
        return nil
    end

    return name
end

local function append_objective_mapping(id, name)
    id = tonumber(id)
    if not id or not name or name == '' then
        return
    end

    local existing = objective_ids[id]
    if existing then
        return
    end

    local entry = {
        id = id,
        name = name,
        category = ""
    }

    objectives[#objectives + 1] = entry
    objective_ids[id] = entry

    if save_objectives() then
        log_message(('added entry: %d -> %s'):format(id, name))
    end
end

load_objectives()

windower.register_event('outgoing chunk', function(id, original, modified, injected, blocked)
    if blocked or injected or id ~= 0x10C then
        return
    end

    local packet = packets.parse('outgoing', modified)
    if not packet then
        return
    end

    local roe_id = packet['RoE Quest']
    record_id(roe_id)
    enqueue_pending_id(roe_id)
end)

windower.register_event('incoming chunk', function(id, data)
    process_incoming_chunk(id, data)
end)

windower.register_event('load', function()
    local last_update = windower.packets.last_incoming(0x111)
    if last_update then
        process_incoming_chunk(0x111, last_update)
    end

    local last_log = windower.packets.last_incoming(0x112)
    if last_log then
        process_incoming_chunk(0x112, last_log)
    end
end)

windower.register_event('incoming text', function(original, modified)
    if not capture_enabled or #pending_accepts == 0 then
        return
    end

    local name = extract_undertaken_name(modified) or extract_undertaken_name(original)
    if not name then
        return
    end

    local id = table.remove(pending_accepts, 1)
    append_objective_mapping(id, name)
end)

windower.register_event('addon command', function(command, arg)

    local cmd = command and command:lower() or 'help'

    if cmd == 'set' then
        set_objectives(arg)
        return
    end

    if cmd == 'unset' then
        unset_objectives(arg)
        return
    end

    if cmd == 'capture' then
        if arg then
            local value = arg:lower()
            if value == 'on' then
                capture_enabled = true
            elseif value == 'off' then
                capture_enabled = false
            else
                log_message('usage: //ob capture')
                return
            end
        else
            capture_enabled = not capture_enabled
        end
        log_message('capture is now ' .. (capture_enabled and 'on' or 'off'))
        return
    end

    log_message('Commands:')
    log_message('ob set [category] -- Set [category] objectives. Skip category to set all')
    log_message('ob unset [category] -- Unset [category] objectives. Skip category to unset all')
    log_message('ob capture [category] -- Capture/add new RoE IDs to the entries file')
end)