CraftyNav.lua

local ADDON_NAME, CraftyNav = ...
local debug = CraftyNav.DEBUG.newDebugger(CraftyNav.DEBUG.ERROR)

-------------------------------------------------------------------------------
-- Namespace Manipulation
--
-- Leverage Lua's setfenv to restrict all of my declarations to my own private "namespace"
-- Now, I can create "Local" functions without needing the local keyword
-------------------------------------------------------------------------------

local _G = _G -- but first, grab the global namespace or else we lose it
setmetatable(CraftyNav, { __index = _G }) -- inherit all member of the Global namespace
setfenv(1, CraftyNav)

-------------------------------------------------------------------------------
-- Constants
-------------------------------------------------------------------------------

local CONSTANTS = {
    IS_HOOKED = ADDON_NAME ..".IS_HOOKED",
    RECIPE_ID = ADDON_NAME ..".RECIPE_ID",
}
local PI = 3.14159265359
local DEGREES_90 = PI / 2
local DEGREES_270 = 3 * PI / 2

-------------------------------------------------------------------------------
-- CraftyNav Data
-------------------------------------------------------------------------------

local itemToRecipeIdMapping = {}
local originalScripts = {}
---@type History
local history
local backBtn, fwrdBtn

-------------------------------------------------------------------------------
-- Event Handlers
-------------------------------------------------------------------------------

local EventHandlers = {}

function EventHandlers:ADDON_LOADED(addonName)
    if addonName == ADDON_NAME then
        debug.trace:print("ADDON_LOADED", addonName)
    end

    if addonName == "Blizzard_Professions" then
        -- this happens when the user opens up a professions window
        -- until then, the UI knows nothing about the ProfessionsFrame and will just throw errors if we try to do anything
        initalizeAddonStuff()
    end
end

function EventHandlers:PLAYER_LOGIN()
    debug.trace:print("PLAYER_LOGIN")
end

function EventHandlers:PLAYER_ENTERING_WORLD(isInitialLogin, isReloadingUi)
    debug.trace:out("",1,"PLAYER_ENTERING_WORLD", "isInitialLogin",isInitialLogin, "isReloadingUi",isReloadingUi)
end

-------------------------------------------------------------------------------
-- Event Handler Registration
-------------------------------------------------------------------------------

function createEventListener(targetSelfAsProxy, eventHandlers)
    debug.info:print(ADDON_NAME, " EventListener:Activate() ...")

    local dispatcher = function(listenerFrame, eventName, ...)
        -- ignore the listenerFrame and instead
        eventHandlers[eventName](targetSelfAsProxy, ...)
    end

    local eventListenerFrame = CreateFrame("Frame")
    eventListenerFrame:SetScript("OnEvent", dispatcher)

    for eventName, _ in pairs(eventHandlers) do
        debug.info:print("EventListener:activate() - registering ", eventName)
        eventListenerFrame:RegisterEvent(eventName)
    end
end

-------------------------------------------------------------------------------
-- Tradeskill Utility Functions and Methods
-------------------------------------------------------------------------------

function isTradeSkillUiReady()
    local isReady = C_TradeSkillUI.IsTradeSkillReady()
    local professionName = C_TradeSkillUI.GetBaseProfessionInfo().professionName or "UNKNOWN"
    debug.info:print(professionName, " C_TradeSkillUI.IsTradeSkillReady() = ", tostring(isReady))
    return isReady
end

function getCurrentProfessionName()
    local professionName = C_TradeSkillUI.GetBaseProfessionInfo().professionName
    return professionName
end

function CraftyNav:isProfessionDataInitialized(professionName)
    assert(professionName)
    return (itemToRecipeIdMapping[professionName] and true) or false
end

function CraftyNav:getRecipeId(itemID)
    local professionName = C_TradeSkillUI.GetBaseProfessionInfo().professionName
    local map = itemToRecipeIdMapping[professionName]
    if (not map) then return end
    return map[itemID]
end

function CraftyNav:addRecipeId(professionName, itemID, recipeId)
    itemToRecipeIdMapping[professionName][itemID] = recipeId
end

function CraftyNav:createItemToRecipeIdMapping()
    if (not isTradeSkillUiReady()) then return end
    local professionName = C_TradeSkillUI.GetBaseProfessionInfo().professionName
    local tblCheck = itemToRecipeIdMapping[professionName]
    local isEmpty = isEmptyTable(tblCheck)
    local isBroken = tblCheck and isEmpty
    if (tblCheck and isTableNotEmpty(tblCheck)) then
        debug.trace:print("Already scanned so skipping: ", professionName)
        return
    elseif isBroken then
        debug.trace:print("BROKEN DATA... rescanning: ", professionName)
    end
    debug.info:print("Initializing ",professionName, "tblCheck",tblCheck, "isEmpty",isEmpty)

    itemToRecipeIdMapping[professionName] = {}
    local recipeIds = C_TradeSkillUI.GetAllRecipeIDs()
    if isEmptyTable(recipeIds) then
        debug.info:print("NO recipeIds!")
    end

    local n = 0
    for i, recipeId in ipairs(recipeIds) do
        local foo = C_TradeSkillUI.GetRecipeOutputItemData(recipeId)
        local itemID = foo and foo.itemID
        if (itemID) then
            self:addRecipeId(professionName,itemID,recipeId)
            n = n + 1
        end
    end

    if n == 0 then
        debug.info:print("NO recipeIds matched to any itemIDs!")
    end
end

-------------------------------------------------------------------------------
-- Tooltip Functions
-------------------------------------------------------------------------------

-- this is only needed because the recipe header
-- doesn't play by the same rules as the reagents
-- even though both claim to be buttons

local global_craft_header_bonus_tooltip_text -- this is sooooo lame

function addHelpTextToToolTip(tooltip, data)
    if tooltip == GameTooltip then
        local itemId = data.id or "none"
        debug.info:out("@",3, "addHelpTextToToolTip","itemId",itemId)
        if (global_craft_header_bonus_tooltip_text) then
            GameTooltip:AddLine(global_craft_header_bonus_tooltip_text, 0, 1, 0)
        end
    end
end

-------------------------------------------------------------------------------
-- Hooking Utility Functions and Methods
-------------------------------------------------------------------------------

-- check to see if the named script ("OnClick" for example)
-- that is currently attached to the given frame object
-- is actually the code in the myHook arg
function isMyHook(frame, scriptName, myHook)
    local currentFunc = frame:GetScript(scriptName)
    return currentFunc == myHook
end

function CraftyNav:rememberCurrentScript(frame, scriptName)
    vivify(originalScripts, frame, scriptName)
    originalScripts[frame][scriptName] = frame:GetScript(scriptName)
end

function CraftyNav:callPreviousCallback(frame, scriptName)
    local func = originalScripts[frame][scriptName]
    func(frame)
end

-------------------------------------------------------------------------------
-- Hooking for Tradeskill UI Recipe Header
-- add nav clicks and tooltipy OnEnter enhancements
-------------------------------------------------------------------------------

function hookHeader(pathToRecipeDisplay)
    local headerBtn = pathToRecipeDisplay.SchematicForm.OutputIcon
    if not headerBtn then return end

    debug.info:out("#",5, "header checking callbacks")

    -- PostClick
    if not isMyHook(headerBtn, "PostClick", headerCallbackForPostClick) then
        debug.info:out("#",7, "header SetScript PostClick")
        headerBtn:SetScript("PostClick", headerCallbackForPostClick)
    end

    -- OnEnter
    if not isMyHook(headerBtn, "OnEnter", headerCallbackForOnEnter) then
        debug.info:out("#",7, "header SetScript OnEnter","headerBtn",headerBtn)
        CraftyNav:rememberCurrentScript(headerBtn, "OnEnter")
        headerBtn:SetScript("OnEnter", headerCallbackForOnEnter)
    end

    -- OnLeave
    if not isMyHook(headerBtn, "OnLeave", headerCallbackForOnLeave) then
        debug.info:out("#",7, "header SetScript OnLeave","headerBtn",headerBtn)
        CraftyNav:rememberCurrentScript(headerBtn, "OnLeave")
        headerBtn:SetScript("OnLeave", headerCallbackForOnLeave)
    end
end

-------------------------------------------------------------------------------
-- Callbacks for Tradeskill UI Header
-------------------------------------------------------------------------------

function headerCallbackForPostClick(headerBtn, whichMouseButtonStr, isPressed)
    local name = ProfessionsFrame.CraftingPage.SchematicForm.recipeSchematic.name
    debug.info:out("}",7, "You PostClicked me with", "whichMouseButtonStr", whichMouseButtonStr, "name",name)
    local isRightClick = (whichMouseButtonStr == "RightButton")
    if (name and isRightClick) then
        setSearchBox(name)
        play(SND.PUFF)
    end
end

function headerCallbackForOnEnter(headerBtn)
    local name = ProfessionsFrame.CraftingPage.SchematicForm.recipeSchematic.name
    local text = CraftyNav.L10N.TOOLTIP_HEADER .. name .. (CraftyNav.L10N.TOOLTIP_HEADER_POST or "")
    debug.info:out("]",7, "Enter header!", "TOOLTIP_HEADER",text)

    -- Unlike the callback for the Reagent Buttons which successfully used the following API calls, not here!
    -- No matter what order, nor matter how much I begged or cried, the following never affected the tooltip.
    --CraftyNav:callPreviousCallback(headerBtn, "OnEnter")
    --GameTooltip:AddLine(text, 0, 1, 0)
    --GameTooltip:Show()
    -- So, instead I have to stuff text into global_craft_header_bonus_tooltip_text
    global_craft_header_bonus_tooltip_text = text
    CraftyNav:callPreviousCallback(headerBtn, "OnEnter")
end

function headerCallbackForOnLeave(headerBtn)
    debug.info:out("]",7, "LEAVE header!")
    global_craft_header_bonus_tooltip_text = nil
    CraftyNav:callPreviousCallback(headerBtn, "OnLeave")
end

function setSearchBox(term)
    ProfessionsFrame.CraftingPage.RecipeList.SearchBox:SetText(term or "")

    -- clear all filters.  that would be a useful API if it existed, huh?  Well fuck you very much
    C_TradeSkillUI.ClearInventorySlotFilter()
    C_TradeSkillUI.ClearRecipeCategoryFilter()
    C_TradeSkillUI.ClearRecipeSourceTypeFilter()
    C_TradeSkillUI.SetOnlyShowAvailableForOrders(false)
    C_TradeSkillUI.SetOnlyShowFirstCraftRecipes(false)
    C_TradeSkillUI.SetOnlyShowMakeableRecipes(false)
    C_TradeSkillUI.SetOnlyShowSkillUpRecipes(false)
    C_TradeSkillUI.SetRecipeItemLevelFilter(0,9999)
    C_TradeSkillUI.SetShowLearned(true)
    C_TradeSkillUI.SetShowUnlearned(true)

    -- now we can search unfettered
    C_TradeSkillUI.SetRecipeItemNameFilter(term)
end

-------------------------------------------------------------------------------
-- Hooking for Tradeskill UI Reagent Buttons
-- add nav clicks and tooltipy OnEnter enhancements
-------------------------------------------------------------------------------

local rN = 0
local rHookN = 0
function hookReagents(pathToRecipeDisplay)
    local reagentFrames = pathToRecipeDisplay.SchematicForm.Reagents:GetLayoutChildren()
    for i, reagentFrame in ipairs(reagentFrames) do
        local reagentBtn = reagentFrame.Button

        if reagentBtn then
            rN = rN + 1

            local debugLabel = reagentBtn:GetItemLink() or "UnKnOwN"

            -- PostClick
            if not isMyHook(reagentBtn, "PostClick", reagentCallbackForPostClick) then
                rHookN = rHookN + 1
                debug.info:out("%",7, rN, "reagent SetScript hooking the PostClick", debugLabel)
                reagentBtn:SetScript("PostClick", reagentCallbackForPostClick)
            else
                debug.info:out("%",9, rN, "reagent SetScript PostClick - already exists", debugLabel)
            end

            -- OnEnter
            if not isMyHook(reagentBtn, "OnEnter", reagentCallbackForOnEnter) then
                rHookN = rHookN + 1
                debug.info:out("%",7, rN, "reagent SetScript hooking the OnEnter", debugLabel)
                CraftyNav:rememberCurrentScript(reagentBtn, "OnEnter")
                reagentBtn:SetScript("OnEnter", reagentCallbackForOnEnter)
            else
                debug.info:out("%",9, rN, "reagent SetScript OnEnter - already exists", debugLabel)
            end
        end
    end
    debug.info:out("%",15, "reagent SetScript found total of ", rN)
    debug.info:out("%",15, "reagent SetScript hooked total of ", rHookN)

    rN = 0
    rHookN = 0
end

-------------------------------------------------------------------------------
-- Callbacks for Tradeskill Reagent Buttons
-------------------------------------------------------------------------------

function reagentCallbackForPostClick(reagentBtn, whichMouseButtonStr, isPressed)
    local debugLabel = reagentBtn:GetItemLink() or "UnKnOwN"
    debug.info:out("=",7, "Hi :-)", "reagentBtn",debugLabel, "whichMouseButtonStr",whichMouseButtonStr, "isPressed",isPressed)
    if whichMouseButtonStr ~= "RightButton" then return end

    CraftyNav:createItemToRecipeIdMapping()

    local reagentFrame = reagentBtn:GetParent()
    local craftInfo = reagentFrame.reagentSlotSchematic
    local itemId = craftInfo and craftInfo.reagents[1].itemID
    local recipeId = CraftyNav:getRecipeId(itemId)

    debug.info:out("=",7, "You PostClicked me with", "itemId",itemId, "recipeId", recipeId)
    if recipeId then
        debug.info:out("=",7, "opening :-)", "itemId",itemId, "recipeId", recipeId)
        openRecipe(recipeId, SND.ENTER)
        history:push(recipeId)
    else
        debug.info:out("=",7, "You PostClicked me but I have no recipe ID", "itemId",itemId, "recipeId", recipeId)
    end
end

function reagentCallbackForOnEnter(reagentBtn)
    local debugLabel = reagentBtn:GetItemLink() or "-fuckyoublizzard-"
    debug.info:out(">",7, "Enter reagent!", debugLabel)
    CraftyNav:callPreviousCallback(reagentBtn, "OnEnter")
    GameTooltip:AddLine(CraftyNav.L10N.TOOLTIP_REAGENT, 0, 1, 0)
    GameTooltip:Show()
end

-------------------------------------------------------------------------------
-- Sounds
-------------------------------------------------------------------------------

---@class SND
SND = {
    PUFF     = SOUNDKIT.UI_PROFESSION_FILTER_MENU_OPEN_CLOSE,
    DELETE   = SOUNDKIT.IG_CHAT_SCROLL_UP,
    KEYPRESS = SOUNDKIT.IG_MINIMAP_ZOOM_IN, -- IG_CHAT_SCROLL_DOWN
    ENTER    = SOUNDKIT.IG_CHAT_BOTTOM,
    NAV_INTO = SOUNDKIT.IG_ABILITY_PAGE_TURN, -- IG_QUEST_LOG_OPEN, --  IG_MAINMENU_OPTION
    NAV_OUTOF= SOUNDKIT.IG_ABILITY_PAGE_TURN, -- IG_QUEST_LOG_OPEN, --  IG_MAINMENU_OPTION
    OPEN     = SOUNDKIT.IG_SPELLBOOK_OPEN, -- IG_BACKPACK_OPEN, -- IG_MAINMENU_OPTION_CHECKBOX_OFF
    CLOSE    = SOUNDKIT.IG_SPELLBOOK_CLOSE, -- IG_CHARACTER_INFO_CLOSE, -- IG_MAINMENU_OPTION_CHECKBOX_ON
    SCROLL_UP = SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON,
    SCROLL_DOWN = SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON,
}
play = PlaySound

-------------------------------------------------------------------------------
-- Navigation "Back" and "Forward" Buttons
-------------------------------------------------------------------------------

function createNavButtons()
    history = History:new()
    backBtn = makeNavButton("BackBtn")
    fwrdBtn = makeNavButton("FrontBtn", backBtn)
end

function makeNavButton(name, previousBtn)
    name = ADDON_NAME .. name
    local btn = _G[name]
    if btn then -- we've already made it
        return
    end

    assert(ProfessionsFramePortrait, "can't find ProfessionsFramePortrait to anchor the nav buttons.")
    local blizProfWindow = ProfessionsFrame
    local blizIconFrame = ProfessionsFramePortrait
    local isForwardButton = previousBtn and true or false

    btn = CreateFrame("Button", name,  blizProfWindow, "UIPanelScrollUpButtonTemplate")
    btn:SetPoint("BOTTOMLEFT", previousBtn or blizIconFrame, "BOTTOMRIGHT", 0, 0)
    btn:SetFrameStrata(blizProfWindow:GetFrameStrata())
    btn:SetFrameLevel(blizProfWindow:GetFrameLevel()+1 )
    btn:RegisterForClicks("AnyUp")

    local rotation = isForwardButton and DEGREES_270 or DEGREES_90
    btn.Normal:SetRotation(rotation)
    btn.Pushed:SetRotation(rotation)
    btn.Disabled:SetRotation(rotation)
    btn.Highlight:SetRotation(rotation)

    local callback = isForwardButton and historyForward or historyRewind
    btn:SetScript("OnClick", callback)
    btn:SetEnabled(false)
    btn:Show()

    return btn
end

function historyRewind()
    local result = history:rewind()
    if not result then return end
    openRecipe(result, SND.KEYPRESS)
    updateButtonStates()
end

function historyForward()
    local result = history:forward()
    if not result then return end
    openRecipe(result, SND.ENTER)
    updateButtonStates()
end

function updateButtonStates()
    backBtn:SetEnabled( history:canRewind() )
    fwrdBtn:SetEnabled( history:canForward() )
end

-------------------------------------------------------------------------------
-- CraftyNav utils
-------------------------------------------------------------------------------

function isTableNotEmpty(table)
    return table and next(table)
end

function isEmptyTable(table)
    return not isTableNotEmpty(table)
end

-- ensure the data structure is ready to store values at the given coordinates
function vivify(matrix, x, y)
    if not matrix then matrix = {} end
    if not matrix[x] then matrix[x] = {} end
    --if not matrix[x][y] then matrix[x][y] = {} end
    -- TODO: automate this so it can support any depth
    return matrix
end

function openRecipe(recipeId, snd)
    if not recipeId then return end

    ProfessionsFrame:SetTab(ProfessionsFrame.recipesTabID) -- jump to the recipes tab
    setSearchBox(nil)
    C_TradeSkillUI.OpenRecipe(recipeId)
    play(snd or SND.KEYPRESS)

    -- Or...
    --local recipeInfo = C_TradeSkillUI.GetRecipeInfo(recipeId);
    --EventRegistry:TriggerEvent("ProfessionsRecipeListMixin.Event.OnRecipeSelected", recipeInfo, nilRecipeList);
end

-------------------------------------------------------------------------------
-- Tradeskill UI initialization
--
-- handle the recipe display panel which can appear in both of these locations:
-- ProfessionsFrame.CraftingPage.SchematicForm
-- ProfessionsFrame.OrdersPage.OrderView.OrderDetails.SchematicForm
-------------------------------------------------------------------------------

function handleRecipeListPick(someNumberProllyIndex, node, isSelected)
    handlePick(ProfessionsFrame.CraftingPage, node)
end

function handleOrderListPick(frame)
    handlePick(ProfessionsFrame.OrdersPage.OrderView.OrderDetails, frame)
end

function handlePick(pathToRecipeDisplay, node)
    hookHeader(pathToRecipeDisplay)
    hookReagents(pathToRecipeDisplay)
    if not node then return end
    local recipe = node and node.data and node.data.recipeInfo and node.data.recipeInfo.recipeID
    if recipe then
        history:push(recipe)
        updateButtonStates()
    end
end

-------------------------------------------------------------------------------
-- Addon Lifecycle
-------------------------------------------------------------------------------

function initalizeAddonStuff()
    assert(ProfessionsFrame, "can't find the ProfessionsFrame object")

    TooltipDataProcessor.AddTooltipPostCall(Enum.TooltipDataType.Item, addHelpTextToToolTip) -- TooltipDataProcessor.AllTypes

    -- initialize the initializers.
    -- create event listeners (for OnShow & Selections) that will in-turn...
    -- then create/reinitialize the necessary click handlers which will...
    -- then perform the actual navigation.
    ProfessionsFrame.CraftingPage.RecipeList.selectionBehavior:RegisterCallback("OnSelectionChanged", handleRecipeListPick)
    ProfessionsFrame.OrdersPage.OrderView:HookScript("OnShow", handleOrderListPick)

    -- forward / back buttons
    createNavButtons()
end

-------------------------------------------------------------------------------
-- OK, Go for it!
-------------------------------------------------------------------------------

createEventListener(CraftyNav, EventHandlers)