common.lua

local mq = require 'mq'
local named = require('data.named')
local config = require('interface.configuration')
local helpers = require('utils.helpers')
local logger = require('utils.logger')
local movement = require('utils.movement')
local timer = require('libaqo.timer')
local abilities = require('ability')
local constants = require('constants')
local mode = require('mode')
local state = require('state')

local common = {}

local familiar = mq.TLO.Familiar and mq.TLO.Familiar.Stat.Item.ID() or mq.TLO.FindItem('Personal Hemic Source').ID()
-- Familiar: Personal Hemic Source
local illusion = mq.TLO.Illusion and mq.TLO.Illusion.Stat.Item.ID() or mq.TLO.FindItem('Jann\'s Veil').ID()
-- Illusion Benefit Greater Jann
local mount = mq.TLO.Mount and mq.TLO.Mount.Stat.Item.ID() or mq.TLO.FindItem('Golden Owlbear Saddle').ID()
-- Mount Blessing Meda

-- Generic Helper Functions

function common.isNamedMob(zone_short_name, mob_name)
    return named[zone_short_name:lower()] and named[zone_short_name:lower()][mob_name]
end

-- MQ Helper Functions

---Lookup the ID for a given spell.
--- @param spellName string #The name of the spell.
--- @return table|nil #Returns a table containing the spell rank name and spell ID
local function getSpell(spellName)
    local spell = mq.TLO.Spell(spellName)
    local rankname = spell.RankName()
    if not mq.TLO.Me.Book(rankname)() then return nil end
    if state.ActAsLevel and spell.Level() > state.ActAsLevel then return nil end
    return {ID=spell.ID(), Name=rankname, Ref=spell, Level=spell.Level(), BaseName=spell.BaseName()}
end

function common.getBestSpell(spells, options, spellGroup)
    local currentBest = nil
    for i,spellName in ipairs(spells) do
        local bestSpell = getSpell(spellName)
        if bestSpell then
            if not options then options = {} end
            options.SpellGroup = spellGroup
            for key,value in pairs(options) do
                bestSpell[key] = value
            end
            if not options.searchbylevel then
                logger.info('[%s] Found Spell: %s (%s)', spellGroup, bestSpell.Ref.Link(), bestSpell.Level)
                return abilities.Spell:new(bestSpell)
            else
                currentBest = (not currentBest or bestSpell.Level >= currentBest.Level) and bestSpell or currentBest
            end
        end
    end
    if currentBest then
        logger.info('[%s] Found Spell: %s (%s)', spellGroup, currentBest.Ref.Link(), currentBest.Level)
        return abilities.Spell:new(currentBest)
    end
    return nil
end

---Lookup the ID for a given AA.
---@param aaName string @The name of the AA.
---@param options table|nil @A table of options relating to the AA, such as the setting name controlling use of the AA
---@return table|nil @Returns a table containing the AA name, AA ID and the provided option name.
function common.getAA(aaName, options)
    local aaData = mq.TLO.Me.AltAbility(aaName)
    if aaData() and aaData.Spell() then
        if not options then options = {} end
        local spellData = {ID=aaData.ID(), Name=aaData.Name()}
        for key,value in pairs(options) do
            spellData[key] = value
        end
        logger.info('Found AA: %s (%s)', spellData.Name, aaData.Spell.Link())
        return abilities.AA:new(spellData)
    end
    return nil
end

local function getDisc(discName)
    local disc = mq.TLO.Spell(discName)
    local rankName = disc.RankName()
    if not rankName or not mq.TLO.Me.CombatAbility(rankName)() then return nil end
    return {ID=disc.ID(), Name=rankName, Ref=disc, Level=disc.Level()}
end

---Lookup the ID for a given disc.
---@param discs table @An ordered list of discs from best to worst
---@param options table|nil @A table of options relating to the disc, such as the setting name controlling use of the disc
---@return table|nil @Returns a table containing the disc name with rank, disc ID and the provided option name.
function common.getBestDisc(discs, options)
    for _,discName in ipairs(discs) do
        local bestDisc = getDisc(discName)
        if bestDisc then
            logger.info('Found Disc: %s (%s)', bestDisc.Ref.Link(), bestDisc.Level)
            if not options then options = {} end
            for key,value in pairs(options) do
                bestDisc[key] = value
            end
            return abilities.Disc:new(bestDisc)
        end
    end
    logger.info('Could not find disc: \ag%s\ax', discs[1])
    return nil
end

function common.getItem(itemName, options)
    if not itemName then return nil end
    local itemRef = mq.TLO.FindItem('='..itemName)
    if itemRef() and itemRef.Clicky() then
        if not options then options = {} end
        local spellData = {ID=itemRef.ID(), Name=itemRef.Name()}
        for key,value in pairs(options) do
            spellData[key] = value
        end
        logger.info('Found Item: %s', itemRef.ItemLink('CLICKABLE'))
        return abilities.Item:new(spellData)
    end
    return nil
end

function common.getSkill(name, options)
    if not mq.TLO.Me.Ability(name)() or not mq.TLO.Me.Skill(name)() or mq.TLO.Me.Skill(name)() == 0 then return nil end
    if not options then options = {} end
    local spellData = {Name=name}
    for key,value in pairs(options) do
        spellData[key] = value
    end
    logger.info('Found Skill: %s', name)
    return abilities.Skill:new(spellData)
end

---Check whether the specified dot is applied to the target.
---@param spell_id number @The ID of the spell to check.
---@param spell_name string @The name of the spell to check.
---@return boolean @Returns true if the spell is applied to the target, false otherwise.
function common.isTargetDottedWith(spell_id, spell_name)
    return mq.TLO.Target.MyBuff(spell_name)() ~= nil
    --if not mq.TLO.Target.MyBuff(spell_name)() then return false end
    --return spell_id == mq.TLO.Target.MyBuff(spell_name).ID()
end

---Determine if there are any hostile targets on XTarget.
---@return boolean @Returns true if at least 1 hostile auto hater spawn on XTarget, otherwise false.
function common.hostileXTargets()
    if mq.TLO.Me.XTarget() == 0 then return false end
    for i=1,20 do
        if mq.TLO.Me.XTarget(i).TargetType() == 'Auto Hater' and mq.TLO.Me.XTarget(i).Type() == 'NPC' then
            return true
        end
    end
    return false
end

function common.clearToBuff()
    -- return mq.TLO.Me.CombatState() ~= 'COMBAT' and not common.hostileXTargets() and not common.amIDead() and not state.forceEngage
    return mq.TLO.Me.CombatState() ~= 'COMBAT' and not mq.TLO.Spawn('npc radius '..config.get('CAMPRADIUS')).Aggressive() and not common.amIDead() and not state.forceEngage
end

---Determine whether currently in control of the character, i.e. not CC'd, stunned, mezzed, etc.
---@return boolean @Returns true if not under any loss of control effects, false otherwise.
function common.inControl()
    return not (mq.TLO.Me.Dead() or mq.TLO.Me.Charmed() or
            mq.TLO.Me.Stunned() or mq.TLO.Me.Silenced() or
            mq.TLO.Me.Mezzed() or mq.TLO.Me.Invulnerable() or mq.TLO.Me.Hovering())
end

function common.isBlockingWindowOpen()
    -- check blocking windows -- BigBankWnd, MerchantWnd, GiveWnd, TradeWnd
    return mq.TLO.Window('BigBankWnd').Open() or mq.TLO.Window('MerchantWnd').Open() or mq.TLO.Window('GiveWnd').Open() or mq.TLO.Window('TradeWnd').Open() or mq.TLO.Window('LootWnd').Open()
end

-- Movement Functions

---Chase after the assigned chase target if alive and in chase mode and the chase distance is exceeded.
local checkChaseTimer = timer:new(1000)
function common.checkChase()
    if mode.currentMode:getName() ~= 'chase' then return end
    --if not checkChaseTimer:expired() then return end
    --checkChaseTimer:reset()
    if mq.TLO.Stick.Active() or mq.TLO.Me.Combat() or (mq.TLO.Me.AutoFire() and mq.TLO.Target.Type() == 'NPC') or (state.class ~= 'BRD' and mq.TLO.Me.Casting()) or mq.TLO.Window('SpellBookWnd').Open() then
        if logger.flags.common.chase then
            logger.debug(logger.flags.common.chase, 'Not chasing due to one of: Stick.Active=%s, Me.Combat=%s, Me.AutoFire=%s, Me.Casting=%s', mq.TLO.Stick.Active(), mq.TLO.Me.Combat(), mq.TLO.Me.AutoFire, mq.TLO.Me.Casting())
        end
        return
    end
    local chase_spawn = mq.TLO.Spawn('pc ='..config.get('CHASETARGET'))
    local me_x = mq.TLO.Me.X()
    local me_y = mq.TLO.Me.Y()
    local chase_x = chase_spawn.X()
    local chase_y = chase_spawn.Y()
    if not chase_x or not chase_y then
        logger.debug(logger.flags.common.chase, 'Not chasing due to invalid chase spawn X=%s,Y=%s', chase_x, chase_y)
        return
    end
    if helpers.distance(me_x, me_y, chase_x, chase_y) > (config.get('CHASEDISTANCE')^2) then
        if mq.TLO.Me.Sitting() then mq.cmd('/stand') end
        if not movement.navToSpawn('pc ='..config.get('CHASETARGET'), 'dist='..config.get('CHASESTOPDISTANCE')) then
            local chaseSpawn = mq.TLO.Spawn('pc '..config.get('CHASETARGET'))
            if not mq.TLO.Navigation.Active() and chaseSpawn.LineOfSight() then
                mq.cmdf('/moveto id %s', chaseSpawn.ID())
                mq.delay(1000)
                mq.cmd('/keypress FORWARD')
            end
        end
    end
end

-- Burn Helper Functions

---Determine whether the conditions are met to engage burn routines.
---@param alwaysCondition function|nil @An extra function which can be provided to determine if the always burn condition should fire.
---@return boolean @Returns true if any burn condition is satisfied, otherwise false.
function common.isBurnConditionMet(alwaysCondition)
    -- activating a burn condition is good for 60 seconds, don't do check again if 60 seconds hasn't passed yet and burn is active.
    if not state.burnActiveTimer:expired() and state.burnActive then
        return true
    else
        state.burnActive = false
    end
    if state.burnNow then
        state.burnActiveTimer:reset()
        state.burnActive = true
        state.burnNow = false
        return true
    elseif mq.TLO.Me.CombatState() == 'COMBAT' or common.hostileXTargets() then
        local zone_sn = mq.TLO.Zone.ShortName():lower()
        if config.get('BURNALWAYS') then
            if alwaysCondition and not alwaysCondition() then
                return false
            end
            state.burn_type = nil
            return true
        elseif config.get('BURNALLNAMED') and named[zone_sn] and named[zone_sn][mq.TLO.Target.CleanName()] then
            logger.info('\arActivating Burns (named)\ax')
            state.burnActiveTimer:reset()
            state.burnActive = true
            state.burn_type = nil
            return true
        elseif mq.TLO.SpawnCount(string.format('xtarhater radius %d zradius 50', config.get('CAMPRADIUS')))() >= config.get('BURNCOUNT') then
            logger.info('\arActivating Burns (mob count > %d)\ax', config.get('BURNCOUNT'))
            state.burnActiveTimer:reset()
            state.burnActive = true
            state.burn_type = nil
            return true
        elseif config.get('BURNPCT') ~= 0 and (mq.TLO.Target.PctHPs() or 100) < config.get('BURNPCT') then
            logger.info('\arActivating Burns (percent HP)\ax')
            state.burnActiveTimer:reset()
            state.burnActive = true
            state.burn_type = nil
            return true
        end
    end
    state.burnActiveTimer:reset(0)
    state.burnActive = false
    state.burn_type = nil
    return false
end

---Check Geomantra buff and click charm item if missing and item is ready.
function common.checkCombatBuffs()
    if state.emu then return end
    if not mq.TLO.Me.Buff('Geomantra')() then
        local charm = mq.TLO.Me.Inventory('Charm')
        local charmSpell = charm.Clicky.Spell()
        if charmSpell and charmSpell:lower():find('geomantra') then
            abilities.use(abilities.Item:new({Name=charm(), ID=charm.ID()}))
        end
    end
end

---Check and cast any missing familiar, illusion or mount buffs. Removes illusion and dismounts after casting.
function common.checkItemBuffs()
    if familiar and familiar > 0 and not mq.TLO.Me.Buff('Familiar:')() then
        local familiarItem = mq.TLO.FindItem(familiar)
        abilities.use(abilities.Item:new({Name=familiarItem(), ID=familiarItem.ID()}))
        mq.delay(500+familiarItem.CastTime())
        mq.cmdf('/removebuff %s', familiarItem.Clicky())
    end
    if illusion and illusion > 0 and not mq.TLO.Me.Buff('Illusion Benefit')() then
        local illusionItem = mq.TLO.FindItem(illusion)
        abilities.use(abilities.Item:new({Name=illusionItem(), ID=illusionItem.ID()}))
        mq.delay(500+illusionItem.CastTime())
        mq.cmd('/removebuff illusion:')
    end
    if mount and mount > 0 and not mq.TLO.Me.Buff('Mount Blessing')() and mq.TLO.Me.CanMount() then
        local mountItem = mq.TLO.FindItem(mount)
        -- TODO: ignore stat mount of no blessing
        abilities.use(abilities.Item:new({Name=mountItem(), ID=mountItem.ID()}))
        mq.delay(500+mountItem.CastTime())
        mq.cmdf('/removebuff %s', mountItem.Clicky())
    end
end

local modrods = {['Summoned: Dazzling Modulation Shard']=true,['Sickle of Umbral Modulation']=true,['Wand of Restless Modulation']=true,
                ['Summoned: Large Modulation Shard']=true, ['Summoned: Medium Modulation Shard']=true, ['Summoned: Small Modulation Shard']=true, ['Azure Mind Crystal']=true}
---Attempt to click mod rods if mana is below 75%.
function common.checkMana()
    -- modrods
    local pct_mana = mq.TLO.Me.PctMana()
    local pct_end = mq.TLO.Me.PctEndurance()
    local group_mana = mq.TLO.Group.LowMana(70)()
    local feather = mq.TLO.FindItem('=Unified Phoenix Feather') or mq.TLO.FindItem('=Miniature Horn of Unity')
    if pct_mana < 75 and mq.TLO.Me.MaxMana() > 0 then
        local cursor = mq.TLO.Cursor.Name()
        if modrods[cursor] then
            mq.cmd('/autoinventory')
            mq.delay(50)
        end
        -- Find ModRods in check_mana since they poof when out of charges, can't just find once at startup.
        for item,_ in pairs(modrods) do
            local modrod = mq.TLO.FindItem(item)
            local hp_amount = modrod.Spell.Base(1)()
            if modrod() and hp_amount and math.abs(hp_amount)*2 < mq.TLO.Me.CurrentHPs() then
                abilities.use(abilities.Item:new({Name=modrod(), ID=modrod.ID()}))
            end
        end
        -- use feather for self if not grouped (group.LowMana is null if not grouped)
        if feather() and not group_mana and not mq.TLO.Me.Song(feather.Spell.Name())() then
            abilities.use(abilities.Item:new({Name=feather(), ID=feather.ID()}))
        end
    end
    -- use feather for group if > 2 members are below 70% mana
    if feather() and group_mana and group_mana > 2 and not mq.TLO.Me.Song(feather.Spell.Name())() then
        abilities.use(abilities.Item:new({Name=feather(), ID=feather.ID()}))
    end

    local zonesn = mq.TLO.Zone.ShortName()
    if zonesn ~= 'poknowledge' and zonesn ~= 'thevoida' and mq.TLO.Me.MaxMana() > 0 then
        local manastone = mq.TLO.FindItem('Manastone')
        if manastone() and mq.TLO.Me.PctMana() < config.get('MANASTONESTART') and mq.TLO.Me.PctHPs() > config.get('MANASTONESTARTHP') then
            local manastoneTimer = timer:new((config.get('MANASTONETIME') or 0)*1000)
            while mq.TLO.Me.PctHPs() > config.get('MANASTONESTOPHP') and not manastoneTimer:expired() do
                mq.cmd('/useitem manastone')
                mq.delay(1)
            end
        end
    end
end

---Sit down to med if the conditions for resting are met.
function common.rest()
    if not config.get('MEDCOMBAT') and (mq.TLO.Me.CombatState() == 'COMBAT' or state.assistMobID ~= 0) then return end
    if state.mobCount > 0 and (mode.currentMode:isTankMode() or mq.TLO.Group.MainTank() == mq.TLO.Me.CleanName() or config.get('MAINTANK')) then return end
    -- try to avoid just constant stand/sit, mainly for dumb bard sitting between every song
    if state.sitTimer:expired() then
        if (mq.TLO.Group.MainAssist.State() == 'SIT' or (config.get('ASSIST') == 'actor' and mq.TLO.Spawn(('id %s'):format(state.actorTankID)).State() == 'SIT')) and not mq.TLO.Me.Sitting() then
            mq.cmd('/sit')
            state.sitTimer:reset()
        end
        if mq.TLO.Me.PctHPs() < config.get('MEDHPSTART') then
            state.medding = true
            if not mq.TLO.Target() then mq.TLO.Me.DoTarget() end
        end
        if (mq.TLO.Me.MaxMana() > 0 and mq.TLO.Me.PctMana() < config.get('MEDMANASTART')) or mq.TLO.Me.PctEndurance() < config.get('MEDENDSTART') then
            state.medding = true
            if not mq.TLO.Target() then mq.TLO.Me.DoTarget() end
        end
        if not mq.TLO.Me.Sitting() and not mq.TLO.Me.Moving() and not mq.TLO.Me.Casting() and not state.casting and state.medding then
                --and not mq.TLO.Me.Combat() and not mq.TLO.Me.AutoFire() and
                --mq.TLO.SpawnCount(string.format('xtarhater radius %d zradius 50', config.get('CAMPRADIUS')))() == 0 then
            mq.cmd('/sit')
            state.sitTimer:reset()
        end
    end
    if mq.TLO.Me.PctHPs() > config.get('MEDHPSTOP') and mq.TLO.Me.PctEndurance() > config.get('MEDENDSTOP') and (mq.TLO.Me.MaxMana() == 0 or mq.TLO.Me.PctMana() > config.get('MEDMANASTOP')) then
        state.medding = false
    end
end

function common.petClicky()
    if mq.TLO.FindItem('Codex of Minion\'s Materiel')() then
        mq.cmd('/useitem "Codex of Minion\'s Materiel"')
        mq.delay(250)
        mq.delay(10000, function() return not mq.TLO.Me.Casting() end)
        mq.delay(2000)
    end
end

-- keep cursor clear for spell swaps and such
local autoInventoryTimer = timer:new(15000)
---Autoinventory an item if it has been on the cursor for 15 seconds.
function common.checkCursor()
    if mq.TLO.Cursor() then
        if common.amIDead() and constants.deleteWhenDead[mq.TLO.Cursor.Name()] then
            logger.info('Deleting %s from cursor because im dead and have no bags!', mq.TLO.Cursor.Name())
        elseif autoInventoryTimer.start_time == 0 then
            autoInventoryTimer:reset()
            logger.info('Dropping cursor item into inventory in 15 seconds')
        elseif autoInventoryTimer:expired() then
            mq.cmd('/autoinventory')
            autoInventoryTimer:reset(0)
        end
    elseif autoInventoryTimer.start_time ~= 0 then
        logger.debug(logger.flags.common.misc, 'Cursor is empty, resetting autoInventoryTimer')
        autoInventoryTimer:reset(0)
    end
end

function common.processList(aList, class, returnOnFirstUse)
    for _,entry in ipairs(aList) do
        if abilities.use(entry, class) then
            mq.delay(entry.delay or 200)
            if returnOnFirstUse then return true end
        end
    end
end

--Shamelessly stolen from Rekka and E3Next
function common.amIDead()
    for i=1,10 do
        local slot = mq.TLO.Me.Inventory('pack'..i)
        if slot() then
            return false
        end
    end
    if mq.TLO.Me.Inventory('Chest')() then
        return false
    end
    return true
end

return common