Transcriptor.lua

local _, ns = ...

-------------------------------------------------------------------------------
-- Module Declaration
--

local plugin = BigWigs:NewPlugin("Transcriptor")
if not plugin then return end

-------------------------------------------------------------------------------
-- Locals
--

-- luacheck: globals Transcriptor TranscriptDB TranscriptIgnore
local ipairs, next, print, split, trim = ipairs, next, print, string.split, string.trim
local sort, concat, tremove, wipe = table.sort, table.concat, table.remove, table.wipe
local tonumber, ceil, floor = tonumber, math.ceil, math.floor

local logging = nil
local timer = nil

local temp = {}
local function quartiles(t)
	wipe(temp)
	for i = 1, #t do
		local v = tonumber(t[i])
		if v then
			temp[#temp+1] = v
		elseif t[i]:find("/", nil, true) then
			v = tonumber(trim(t[i]):match("^%d+.*/(.-)$")) -- just use the last value
			if v then
				temp[#temp+1] = v
			end
		end
	end
	sort(temp)
	local count = #temp

	-- stupid small data sets
	if count == 0 then
		return 0, 0, 0, 0, 0
	elseif count == 1 then
		local a = temp[1]
		return a, a, a, a, 1
	elseif count == 2 then
		local a, b = temp[1], temp[2]
		return a, b, a, b, 2
	end

	local q1, q3
	if count % 2 == 0 then -- should i average or just use the inner indexes?
		q1 = (temp[ceil(count / 4)] + temp[ceil(count / 4) + 1]) / 2
		q3 = (temp[floor(count * .75)] + temp[floor(count * .75) + 1]) / 2
	else
		q1 = temp[ceil(count / 4)]
		q3 = temp[ceil(count * .75)]
	end
	return q1, q3, temp[1], temp[count], count
end

local diffShort = {
	[1] = "5N",
	[2] = "5H",
	[3] = "10N",
	[4] = "25N",
	[5] = "10H",
	[6] = "25H",
	[7] = "25LFR",
	[8] = "5M+",
	[14] = "N",
	[15] = "H",
	[16] = "M",
	[17] = "LFR",
	[18] = "40E",
	[19] = "5E",
	[23] = "5M",
	[24] = "5TW",
}

local function parseLogInfo(logName, log)
	-- logNameFormat = "[%s]@[%s] - Zone:%d Difficulty:%d,%s Type:%s " .. format("Version: %s.%s", wowVersion, buildRevision)
	-- "[2018-09-04]@[18:11:58] - Zone:1763 Difficulty:8,5Challenge Type:party Version: 8.0.1.27547"
	local year, month, day, hour, min, sec, map, diff, _, _, version = logName:match("^%[(%d+)-(%d+)-(%d+)%]@%[(%d+):(%d+):(%d+)%] %- Zone:(%d+) Difficulty:(%d+),(.+) Type:(.+) Version: (.+)$")
	if not version then
		-- try previous format
		-- logNameFormat = "[%s]@[%s] - %d/%d/%s/%s/%s@%s" .. format(" (%s) (%s.%s)", version, wowVersion, buildRevision)
		-- "[2017-06-20]@[23:26:47] - 1147/1676/Tomb of Sargeras/Tomb of Sargeras/The Twisting Nether@Heroic (v7.2.0) (7.2.5.24367)"
		year, month, day, hour, min, sec, map, diff, version = logName:match("^%[(%d+)-(%d+)-(%d+)%]@%[(%d+):(%d+):(%d+)%] %- %d+/(%d+)/.-/.-/.-@(.-) %(.-%) %((.-)%)$")
	end
	if not version then return end

	local killed, encounter, duration = false, nil, 0
	if log.COMBAT then
		-- should probably handle multiple encounters in one log, but meh
		for _, line in next, log.COMBAT do
			if line:find("ENCOUNTER_START", nil, true) then
				-- "<1.94 23:38:46> [ENCOUNTER_START] ENCOUNTER_START#2051#Kil'jaeden#15#24"
				encounter = line:match("%d+#(.-)#%d+#%d+")
			elseif line:find("ENCOUNTER_END", nil, true) then
				-- "<524.88 23:47:29> [ENCOUNTER_END] 2051#Kil'jaeden#15#24#1"
				local e, k = line:match("%d+#(.-)#%d+#%d+#(%d)$")
				encounter = e
				killed = tonumber(k) == 1
				break
			elseif line:find("BOSS_KILL", nil, true) then
				-- "<524.88 23:47:29> [BOSS_KILL] 2051#Kil'jaeden"
				encounter = line:match("#(.-)$")
				killed = true
				break
			end
		end
	end
	if log.total and #log.total > 0 then
		duration = tonumber(log.total[#log.total]:match("^<(.-)%s")) or 0
	end

	local diffName = diffShort[tonumber(diff)] or GetDifficultyInfo(diff) or diff
	local zone = GetRealZoneText(map) or tostring(map)
	local info = ("%s - |cffffffff%s|r (%s)"):format(zone, encounter or UNKNOWN, diffName)
	local timestamp = time({day=day,month=month,year=year,hour=hour,min=min,sec=sec})

	-- I should probably cache this stuff
	return info, timestamp, zone, encounter, killed, duration
end

-------------------------------------------------------------------------------
-- Locale
--

local L = setmetatable({}, { __newindex = function(t, k, v) rawset(t, k, v == true and k or v) end })
ns.L = L

L["Transcriptor"] = true
L["Automatically start Transcriptor logging when you pull a boss and stop when you win or wipe."] = true

L["Your Transcriptor DB has been reset! You can still view the contents of the DB in your SavedVariables folder until you exit the game or reload your UI."] = true
L["Transcriptor is currently using %.01f MB of memory. You should clear some logs or risk losing them."] = true
L["Log deleted."] = true

L["Raid only"] = true
L["Only enable logging while in a raid instance."] = true
L["Start with pull timer"] = true
L["Start Transcriptor logging from a pull timer at two seconds remaining."] = true
L["Show spell cast details"] = true
L["Include some spell stats and the time between casts in the log tooltip when available."] = true
L["Delete short logs"] = true
L["Automatically delete logs shorter than 30 seconds."] = true
L["Keep one log per fight"] = true
L["Only keep a log for the longest attempt or latest kill of an encounter."] = true
L["Stored logs (%s / %s) - Click to delete"] = true
L["No logs recorded"] = true
L["%d stored events over %.01f seconds. %s"] = true
L["Ignored Events"] = true
L["Clear All"] = true

L.win = " |cff20ff20" .. _G.WIN .. "|r"
L.failed = " |cffff2020" .. _G.FAILED .. "|r"

-------------------------------------------------------------------------------
-- Options
--

plugin.defaultDB = {
	enabled = false,
	onpull = false,
	details = false,
	delete = false,
	keepone = false,
	raid = false,
}

local GetOptions
do
	local sorted = {}
	local timerEvents = {"SPELL_CAST_START", "SPELL_CAST_SUCCESS", "SPELL_AURA_APPLIED"}

	local function GetDescription(info)
		local log = Transcriptor:Get(info.arg)
		if not log then return end

		local numEvents = log.total and #log.total or 0
		if numEvents == 0 then return end

		local duration = tonumber(log.total[numEvents]:match("^<(.-)%s")) or 0
		local desc = L["%d stored events over %.01f seconds. %s"]:format(numEvents, duration, "")
		if not log.TIMERS or not plugin.db.profile.details then
			return desc
		end

		desc = ("%s\n"):format(desc)
		for _, event in ipairs(timerEvents) do
			if log.TIMERS[event] then
				desc = ("%s\n%s\n"):format(desc, event)

				for k, v in next, log.TIMERS[event] do sorted[k] = v end
				sort(sorted, function(a, b) return a:match("^(.+)-%d+") < b:match("^(.+)-%d+") end) -- sort by spell name

				for _, spell in ipairs(sorted) do
					local info, times = split("=", spell, 2)
					local spellName, spellId, npc = info:match("^(.+)-(%d+)-(npc:%d+)")
					if npc == "npc:1" then
						npc = ""
					else
						npc = " "..npc
					end
					local values = {split(",", (times:gsub("%b[]","")))}
					local _, pull = split(":", tremove(values, 1))
					local sincePull, sincePreviousEvent = pull:match("^(.+)/(.+/.+)")
					-- use the lower and upper quartiles to find outliers
					local q1, q3, low, high, count = quartiles(values)
					if count == 0 then
						desc = ("%s|cfffed000%s (%d)%s|r | Count: |cff20ff20%d|r | From pull: |cff20ff20%s|r\n"):format(desc, spellName, spellId, npc, count + 1, sincePull or pull)
						if sincePull then
							desc = ("%s    |cffffff9a(%s)|r\n"):format(desc, sincePreviousEvent:gsub("/", "+", 1))
						end
					elseif low == high then
						desc = ("%s|cfffed000%s (%d)%s|r | Count: |cff20ff20%d|r | From pull: |cff20ff20%s|r | CD: |cff20ff20%.01f|r\n"):format(desc, spellName, spellId, npc, count + 1, sincePull or pull, low)
					else
						if sincePull then
							pull = tonumber(sincePull)
							tinsert(values, 1, sincePreviousEvent)
						end
						local iqr = q3 - q1
						local lower = q1 - (1.5 * iqr)
						local upper = q3 + (1.5 * iqr)
						count = 0
						local total = 0
						local list = {}
						for i = 1, #values do
							local v = tonumber(values[i])
							if not v then -- handle special events
								local stageValues = { split("/", values[i]) }
								if #stageValues > 1 then
									local fromStage, fromLast = trim(stageValues[1]), trim(stageValues[#stageValues])
									if not tonumber(fromStage) then -- special event name
										if fromStage == "TooManyStages" then -- actually a set of ending values
											v = tonumber(fromLast)
										elseif #stageValues == 2 then -- special event values (sanity check)
											list[#list + 1] = ("|cffffff9a(%s+%s)|r"):format(fromStage, fromLast)
										end
									else -- ending values, just use the time since last value
										v = tonumber(fromLast)
									end
								end
							end
							if v then
								if lower <= v and v <= upper then
									count = count + 1
									total = total + v
								else
									v = ("|cffff7f3f%s|r"):format(v) -- outlier
								end
								local num = #list + 1
								list[num] = num % 24 == 0 and ("\n    %s"):format(v) or v -- simple wrapping
							end
						end
						local avg = total / count
						desc = ("%s|cfffed000%s (%d)%s|r | Count: |cff20ff20%d|r | Avg: |cff20ff20%.01f|r | Min: |cff20ff20%.01f|r | Max: |cff20ff20%.01f|r | From pull: |cff20ff20%.01f|r\n    %s\n"):format(desc, spellName, spellId, npc, count + 1, avg, low, high, pull, concat(list, ", "))
					end
				end
				wipe(sorted)
			end
		end

		return desc
	end


	local function get(info)
		return plugin.db.profile[info[#info]]
	end
	local function set(info, value)
		plugin.db.profile[info[#info]] = value
	end
	local function set_reboot(info, value)
		plugin.db.profile[info[#info]] = value
		plugin:Disable()
		plugin:Enable()
	end
	local function delete(info)
		if info.arg then
			Transcriptor:Clear(info.arg)
		else
			Transcriptor:ClearAll()
		end
		GameTooltip:Hide()
		--collectgarbage()
	end
	local function disabled(info)
		return InCombatLockdown()
	end

	function GetOptions()
		local logs = Transcriptor:GetAll()
		local count = 0
		for _ in next, logs do
			count = count + 1
		end

		UpdateAddOnMemoryUsage()
		local mem = GetAddOnMemoryUsage("Transcriptor") / 1000
		mem = ("|cff%s%.01f MB|r"):format(mem > 60 and "ff2020" or "ffd200", mem)

		local options = {
			name = L["Transcriptor"],
			type = "group",
			args = {
				heading = {
					type = "description",
					name = L["Automatically start Transcriptor logging when you pull a boss and stop when you win or wipe."].."\n",
					fontSize = "medium",
					width = "full",
					order = 1,
				},
				enabled = {
					type = "toggle",
					name = ENABLE,
					get = get,
					set = set_reboot,
					order = 2,
				},
				raid = {
					type = "toggle",
					name = L["Raid only"],
					desc = L["Only enable logging while in a raid instance."],
					get = get,
					set = set,
					order = 3,
				},
				onpull = {
					type = "toggle",
					name = L["Start with pull timer"],
					desc = L["Start Transcriptor logging from a pull timer at two seconds remaining."],
					get = get,
					set = set_reboot,
					order = 4,
				},
				delete = {
					type = "toggle",
					name = L["Delete short logs"],
					desc = L["Automatically delete logs shorter than 30 seconds."],
					get = get,
					set = set,
					order = 5,
				},
				keepone = {
					type = "toggle",
					name = L["Keep one log per fight"],
					desc = L["Only keep a log for the longest attempt or latest kill of an encounter."],
					get = get,
					set = set,
					order = 6,
				},
				details = {
					type = "toggle",
					name = L["Show spell cast details"],
					desc = L["Include some spell stats and the time between casts in the log tooltip when available."],
					get = get,
					set = set,
					order = 7,
				},
				clear = {
					type = "execute",
					name = L["Clear All"],
					func = delete,
					width = "full",
					disabled = disabled,
					hidden = function() return not next(logs) end,
					order = 8,
				},
				size = {
					type = "description",
					name = L["Stored logs (%s / %s) - Click to delete"]:format(count, mem),
					fontSize = "medium",
					width = "full",
					hidden = function() return not next(logs) end,
					order = 9,
				},
				-- part of the zone tree
				ignoredEvents = {
					type = "group",
					name = "|cffffffff"..L["Ignored Events"].."|r",
					get = function(info)
						local key = info[#info]
						return TranscriptIgnore[key]
					end,
					set = function(info, value)
						local key = info[#info]
						TranscriptIgnore[key] = value or nil
					end,
					order = -1,
					args = {
						reset = {
							type = "execute",
							name = RESET,
							func = function()
								TranscriptIgnore = {}
							end,
							width = "full",
							order = 0,
						},
					},
				},
			},
		}

		local ignoredEvents = options.args.ignoredEvents.args
		for _, event in next, Transcriptor.events do
			local cat = Transcriptor.EventCategories[event] or "GENERAL"
			if cat == "NONE" then cat = "GENERAL" end
			if not ignoredEvents[cat] then
				ignoredEvents[cat] = {
					type = "group", inline = true,
					name = cat,
					args = {},
				}
			end
			ignoredEvents[cat].args[event] = {
				type = "toggle",
				name = event,
				width = "full",
			}
		end

		for key, log in next, logs do
			local info, ts, zone, encounter, killed = parseLogInfo(key, log)
			local name
			if info then
				local result = killed and L.win or encounter and L.failed or ""
				name = ("[%s] %s%s"):format(date("%F %T", ts), info:gsub("^.- %- ", ""), result)
			else
				name = key
				zone = UNKNOWN
			end

			if not options.args[zone] then
				options.args[zone] = {
					type = "group",
					name = zone,
					order = 10,
					args = {},
				}
			end

			options.args[zone].args[key] = {
				type = "execute",
				name = name,
				desc = GetDescription,
				func = delete,
				arg = key,
				disabled = disabled,
				width = "full",
				order = ts,
			}
		end

		return options
	end
end

plugin.subPanelOptions = {
	key = "BigWigs: Transcriptor",
	name = L["Transcriptor"],
	options = GetOptions,
}

-------------------------------------------------------------------------------
-- Initialization
--

local function Refresh()
	local ACR = LibStub("AceConfigRegistry-3.0", true)
	if ACR then -- make sure it's loaded (provided by BigWigs_Options)
		ACR:NotifyChange("BigWigs")
	end
end

function plugin:BigWigs_ProfileUpdate()
	self:Disable()
	self:Enable()
	Refresh()
end

function plugin:OnPluginEnable()
	-- cleanup old savedvars
	self.db.profile.ignoredEvents = nil
	self.db.global.ignoredEvents = nil

	-- try to fix memory overflow error
	if Transcriptor and TranscriptDB == nil then
		print("\n|cffff2020" .. L["Your Transcriptor DB has been reset! You can still view the contents of the DB in your SavedVariables folder until you exit the game or reload your UI."])
		TranscriptDB = {}
	end

	self:RegisterMessage("BigWigs_ProfileUpdate")
	if self.db.profile.enabled then
		if self.db.profile.onpull then
			self:RegisterMessage("BigWigs_StartPull")
			self:RegisterMessage("BigWigs_StopPull")
		end
		self:RegisterEvent("ENCOUNTER_START")
		self:RegisterEvent("ENCOUNTER_END")
		-- catch fights that have a module but don't use ENCOUNTER events
		self:RegisterMessage("BigWigs_OnBossEngage")
		self:RegisterMessage("BigWigs_OnBossWin")
		self:RegisterMessage("BigWigs_OnBossWipe")
	end
	self:RegisterEvent("PLAYER_REGEN_DISABLED", Refresh)
	self:RegisterEvent("PLAYER_REGEN_ENABLED", Refresh)
end

function plugin:OnPluginDisable()
	if logging then
		self:Stop()
	end
	timer = nil
end

SLASH_BigWigs_Transcriptor1 = "/bwts"
SlashCmdList.BigWigs_Transcriptor = function()
	LibStub("AceConfigDialog-3.0"):Open("BigWigs", "BigWigs: Transcriptor")
end

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

function plugin:BigWigs_StartPull(_, _, seconds)
	if seconds > 2 then
		self:CancelTimer(timer)
		timer = self:ScheduleTimer("Start", seconds-2)
	else
		self:Start()
	end
end

function plugin:BigWigs_StopPull()
	if timer then
		self:CancelTimer(timer)
		timer = nil
	end
end

function plugin:BigWigs_OnBossEngage(_, module)
	if not module:GetEncounterID() then
		self:Start()
	end
end

function plugin:BigWigs_OnBossWin(_, module)
	if not module:GetEncounterID() then
		self:ScheduleTimer("Stop", 12) -- catch the end events
	end
end

function plugin:BigWigs_OnBossWipe(_, module)
	if not module:GetEncounterID() then
		self:Stop()
	end
end

function plugin:ENCOUNTER_START(_, id, name, diff, size)
	-- XXX this will start logging dungeons and shit for people without little wigs
	self:Start()
end

function plugin:ENCOUNTER_END(_, id, name, diff, size, status)
	self:ScheduleTimer("Stop", status == 0 and 5 or 12) -- catch the end events
end

function plugin:Start()
	local _, instanceType, diff = GetInstanceInfo()
	if (instanceType ~= "raid" and diff ~= 198 and diff ~= 215) and self.db.profile.raid then return end -- diff check for SoD raids

	if timer then
		self:CancelTimer(timer)
		timer = nil
	end
	-- stop your current log and start a new one
	if Transcriptor:IsLogging() and not logging then
		self:Stop(true)
	end
	if not Transcriptor:IsLogging() then
		Transcriptor:StartLog()
		logging = true
	end
end

function plugin:Stop(silent)
	logging = nil
	if not Transcriptor:IsLogging() then return end

	local logName = Transcriptor:StopLog()

	if self.db.profile.delete and logName then
		local log = Transcriptor:Get(logName)
		if #log.total == 0 or tonumber(log.total[#log.total]:match("^<(.-)%s")) < 30 then
			Transcriptor:Clear(logName)
			print("|cffff2020" .. L["Log deleted."])
			logName = nil
		end
	end

	if self.db.profile.keepone and logName then
		local log = Transcriptor:Get(logName)
		local encounter, _, _, _, isWin = parseLogInfo(logName, log)
		if isWin then
			-- delete previous logs
			for name, log in next, Transcriptor:GetAll() do
				local e = parseLogInfo(name, log)
				if name ~= logName and e == encounter then
					Transcriptor:Clear(logName)
				end
			end
		else
			-- keep the longest attempt or last kill
			local encounterLogs = {}
			local lastWin, lastWinTime = nil, nil
			local longLog, longLogTime = nil, nil
			for name, log in next, Transcriptor:GetAll() do
				local e, t, _, _, k, d = parseLogInfo(name, log)
				if e == encounter then
					encounterLogs[name] = true
					if k and (not lastWin or t > lastWinTime) then
						lastWin = name
						lastWinTime = t
					end
					if not longLog or d > longLogTime then
						longLog = name
						longLogTime = d
					end
				end
			end
			local winner = lastWin or longLog
			for name in next, encounterLogs do
				if name ~= winner then
					Transcriptor:Clear(name)
				end
			end
		end
	end

	if not silent then
		-- check memory
		UpdateAddOnMemoryUsage()
		local mem = GetAddOnMemoryUsage("Transcriptor") / 1000
		if mem > 60 then
			print("\n|cffff2020" .. L["Transcriptor is currently using %.01f MB of memory. You should clear some logs or risk losing them."]:format(mem))
		end
	end
end