Files
Questie-X/Modules/Network/QuestieLearnerComms.lua
T
2026-06-04 16:37:03 -05:00

370 lines
13 KiB
Lua

---@class QuestieLearnerComms
local QuestieLearnerComms = QuestieLoader:CreateModule("QuestieLearnerComms")
local _QuestieLearnerComms = QuestieLearnerComms.private
---@type QuestieLearner
local QuestieLearner = QuestieLoader:ImportModule("QuestieLearner")
local LibDeflate = LibStub("LibDeflate")
local AceSerializer = LibStub("AceSerializer-3.0")
local AceComm = LibStub("AceComm-3.0")
local addonPrefix = "QuestieLearner"
local hiddenChannelName = "questiecomm"
local ProtocolVersion = 2 -- Increment protocol version for enhanced/sanitized data
local time = time
local GetTime = GetTime
local math_min = math.min
local math_floor = math.floor
local math_random = math.random
local table_insert = table.insert
local table_getn = table.getn
-- Dev Logging Flags — defined first so all functions below can call DebugLog
local LOG_CRITICAL = true
local LOG_DEVELOP = false
local function DebugLog(tier, msg)
if tier == "CRITICAL" and LOG_CRITICAL then
-- print("[QuestieLearnerComms] " .. msg)
elseif tier == "DEVELOP" and LOG_DEVELOP then
-- print("[QuestieLearnerComms] " .. msg)
end
end
local function SanitizeData(data, depth)
depth = depth or 0
if depth > 10 then return nil end -- Prevent infinite recursion
if type(data) ~= "table" then return {} end
local sanitized = {}
for k, v in pairs(data) do
if type(k) ~= "string" and type(k) ~= "number" then
-- Skip non-string/number keys
elseif type(v) == "function" or type(v) == "userdata" or type(v) == "thread" then
-- Skip these types
elseif type(v) == "table" then
sanitized[k] = SanitizeData(v, depth + 1)
else
sanitized[k] = v
end
end
return sanitized
end
-- Throttling (Token Bucket)
local bucketCapacity = 9
local bucketWindow = 60
local tokenRefillRate = bucketCapacity / bucketWindow
local currentTokens = bucketCapacity
local lastTokenUpdate = GetTime()
local minChatInterval = 3.5
local lastChatMessageTime = 0
local rateLimitQueue = {}
local rateLimitQueueHead = 1
local rateLimitQueueTail = 0
-- Deduplication & Quarantine
local messageCache = {}
local messageCacheCount = 0 -- O(1) counter; avoids pairs() scan on every message
local incomingMessageQueue = {}
local incomingMessageQueueHead = 1
local incomingMessageQueueTail = 0
-- Cached hidden channel ID (avoids GetChannelName every ProcessQueues tick)
local _hiddenChannelId = 0
-- Sender Trust System
local senderTrust = {}
local bannedSenders = {}
local mutedUntil = {}
local XXH = LibStub("XXH_Lua_Lib", true)
local function RecordStrike(sender, reason)
if not senderTrust[sender] then senderTrust[sender] = { strikes = 0, lastMsg = 0, count = 0 } end
senderTrust[sender].strikes = senderTrust[sender].strikes + 1
DebugLog("DEVELOP", sender .. " gained a strike (" .. reason .. "). Total: " .. senderTrust[sender].strikes)
if senderTrust[sender].strikes >= 7 then
bannedSenders[sender] = true
DebugLog("CRITICAL", "Sender " .. sender .. " permanently banned (7 strikes).")
elseif senderTrust[sender].strikes >= 3 then
mutedUntil[sender] = GetTime() + 300 -- 5-minute mute
DebugLog("CRITICAL", "Sender " .. sender .. " muted for 5 minutes (3 strikes).")
end
end
local function IsSenderTrusted(sender)
if bannedSenders[sender] then return false end
if mutedUntil[sender] then
if GetTime() < mutedUntil[sender] then return false end
mutedUntil[sender] = nil -- mute expired
end
if not senderTrust[sender] then senderTrust[sender] = { strikes = 0, lastMsg = 0, count = 0 } end
local now = GetTime()
if now - senderTrust[sender].lastMsg < 1.0 then
senderTrust[sender].count = senderTrust[sender].count + 1
if senderTrust[sender].count > 10 then
RecordStrike(sender, "Spamming")
senderTrust[sender].count = 0
return false
end
else
senderTrust[sender].count = 1
end
senderTrust[sender].lastMsg = now
return true
end
local function IsDuplicateMessage(serializedData)
local hash
if XXH then
hash = XXH.xxh32(serializedData, 0)
else
hash = 0
for i = 1, string.len(serializedData) do
hash = math.mod(hash + string.byte(serializedData, i), 4294967296)
end
end
if messageCache[hash] then return true end
-- O(1) size tracking via explicit counter
messageCacheCount = messageCacheCount + 1
if messageCacheCount > 500 then
messageCache = {}
messageCacheCount = 0
end
messageCache[hash] = true
return false
end
local function GetLearnerSettings()
if Questie and Questie.dbLearner and Questie.dbLearner.global and Questie.dbLearner.global.settings then
return Questie.dbLearner.global.settings
end
return {}
end
local function GetCommsTuning()
local intensity = GetLearnerSettings().learnerCommsIntensity or "normal"
if intensity == "off" then
return false, 0, 999999, 0, 0
elseif intensity == "low" then
return true, 4, 6.0, 2, 1
elseif intensity == "fast" then
return true, 15, 1.5, 10, 4
end
return true, 9, 3.5, 6, 2
end
function QuestieLearnerComms:Initialize()
DebugLog("DEVELOP", "Initializing QuestieLearnerComms")
-- Register AceComm
AceComm:RegisterComm(addonPrefix, function(prefix, message, distribution, sender)
QuestieLearnerComms:OnCommReceived(prefix, message, distribution, sender)
end)
-- Setup Hidden Channel
local channelId, channelName = GetChannelName(hiddenChannelName)
if channelId == 0 then
JoinPermanentChannel(hiddenChannelName, nil, DEFAULT_CHAT_FRAME:GetID(), 1)
ChatFrame_RemoveChannel(DEFAULT_CHAT_FRAME, hiddenChannelName)
DebugLog("CRITICAL", "Joined hidden data-sharing channel: " .. hiddenChannelName)
end
-- Cache for use in ProcessQueues (avoids GetChannelName every tick)
_hiddenChannelId = GetChannelName(hiddenChannelName) or 0
-- Process incoming/outgoing queues
QuestieCompat.C_Timer.NewTicker(0.5, function() _QuestieLearnerComms:ProcessQueues() end)
-- Start Reinforcement Loop (every 60 seconds)
QuestieCompat.C_Timer.NewTicker(60, function() _QuestieLearnerComms:ProcessReinforcement() end)
end
function _QuestieLearnerComms:ProcessReinforcement()
if not QuestieLearner.data then return end
local categories = {"npcs", "quests", "items", "objects"}
local category = categories[math.random(table.getn(categories))]
if QuestieLearner.data[category] then
-- We loop randomly until we find an unconfirmed entry. Just take the first few options to save CPU.
local keys = {}
for k, v in pairs(QuestieLearner.data[category]) do
if type(v) == "table" and (v.mc or 0) < 7 then
table.insert(keys, k)
if table.getn(keys) >= 10 then break end -- Sample size 10
end
end
if table.getn(keys) > 0 then
local randomId = keys[math.random(table.getn(keys))]
local data = QuestieLearner.data[category][randomId]
local typ = string.upper(category)
typ = string.sub(typ, 1, string.len(typ) - 1) -- Remove trailing 's' (NPC, QUEST, ITEM, OBJECT)
DebugLog("DEVELOP", "[Reinforcement] Broadcasting " .. typ .. " " .. randomId)
QuestieLearnerComms:BroadcastLearnedData("REINFORCE", typ, randomId, data)
end
end
end
function QuestieLearnerComms:BroadcastLearnedData(op, entityType, entityId, data)
local commsEnabled = GetCommsTuning()
if not commsEnabled then return end
if not data or type(data) ~= "table" then return end
-- 1. Create Payload (sanitize data to remove functions before serialization)
local sanitizedData = SanitizeData(data)
if not sanitizedData or next(sanitizedData) == nil then return end
local payload = {
_ver = ProtocolVersion,
op = op, -- "NEW", "UPDATE", "CONFIRM"
typ = entityType,
id = entityId,
d = sanitizedData,
ts = time()
}
-- 2. Serialize and Compress
local serialized
local success, err = pcall(AceSerializer.Serialize, AceSerializer, payload)
if not success then
DebugLog("CRITICAL", "AceSerializer error: " .. tostring(err))
return
end
serialized = err
local compressed = LibDeflate:CompressDeflate(serialized, {level = 1})
local encoded = LibDeflate:EncodeForPrint(compressed)
-- 3. Broadcast (Token Bucket logic handled in QueueMessage)
_QuestieLearnerComms:QueueMessage(encoded)
end
function _QuestieLearnerComms:QueueMessage(encodedMessage)
local commsEnabled = GetCommsTuning()
if not commsEnabled then return end
rateLimitQueueTail = rateLimitQueueTail + 1
rateLimitQueue[rateLimitQueueTail] = encodedMessage
end
function _QuestieLearnerComms:ProcessQueues()
local commsEnabled, tunedBucketCapacity, tunedMinChatInterval, normalIncomingCount, combatIncomingCount = GetCommsTuning()
bucketCapacity = tunedBucketCapacity
tokenRefillRate = bucketCapacity / bucketWindow
minChatInterval = tunedMinChatInterval
currentTokens = math_min(bucketCapacity, currentTokens)
if not commsEnabled then return end
-- 1. Refill Tokens
local now = GetTime()
local elapsed = now - lastTokenUpdate
currentTokens = math_min(bucketCapacity, currentTokens + (elapsed * tokenRefillRate))
lastTokenUpdate = now
-- 2. Drain Outgoing Queue
if rateLimitQueueHead <= rateLimitQueueTail and currentTokens >= 1 and (now - lastChatMessageTime) >= minChatInterval then
local msg = rateLimitQueue[rateLimitQueueHead]
rateLimitQueue[rateLimitQueueHead] = nil
rateLimitQueueHead = rateLimitQueueHead + 1
if rateLimitQueueHead > rateLimitQueueTail then
rateLimitQueueHead = 1
rateLimitQueueTail = 0
end
currentTokens = currentTokens - 1
lastChatMessageTime = now
-- Use cached channel ID; refresh lazily if 0 (e.g. after disconnect)
if _hiddenChannelId == 0 then
_hiddenChannelId = GetChannelName(hiddenChannelName) or 0
end
if _hiddenChannelId > 0 then
SendChatMessage(msg, "CHANNEL", nil, _hiddenChannelId)
end
DebugLog("DEVELOP", "Broadcasted message. Tokens left: " .. math_floor(currentTokens))
end
-- 3. Process Incoming Queue (Combat Aware)
local processCount = InCombatLockdown() and combatIncomingCount or normalIncomingCount
for i = 1, processCount do
if incomingMessageQueueHead > incomingMessageQueueTail then break end
local rawMsg = incomingMessageQueue[incomingMessageQueueHead]
incomingMessageQueue[incomingMessageQueueHead] = nil
incomingMessageQueueHead = incomingMessageQueueHead + 1
if incomingMessageQueueHead > incomingMessageQueueTail then
incomingMessageQueueHead = 1
incomingMessageQueueTail = 0
end
_QuestieLearnerComms:ProcessRawMessage(rawMsg.text, rawMsg.sender)
end
end
-- Hook for Chat Message Event (Hidden Channel)
local frame = CreateFrame("Frame")
frame:RegisterEvent("CHAT_MSG_CHANNEL")
frame:SetScript("OnEvent", function(self, event, msg, sender, _, _, _, _, _, channelId, channelName)
local commsEnabled = GetCommsTuning()
if not commsEnabled then return end
if channelName == hiddenChannelName and sender ~= UnitName("player") then
incomingMessageQueueTail = incomingMessageQueueTail + 1
incomingMessageQueue[incomingMessageQueueTail] = {text = msg, sender = sender}
end
end)
function QuestieLearnerComms:OnCommReceived(prefix, message, distribution, sender)
local commsEnabled = GetCommsTuning()
if not commsEnabled then return end
if prefix == addonPrefix and sender ~= UnitName("player") then
incomingMessageQueueTail = incomingMessageQueueTail + 1
incomingMessageQueue[incomingMessageQueueTail] = {text = message, sender = sender}
end
end
function _QuestieLearnerComms:ProcessRawMessage(encodedMsg, sender)
if not IsSenderTrusted(sender) then return end
-- 1. Decode & Decompress
local compressed = LibDeflate:DecodeForPrint(encodedMsg)
if not compressed then
RecordStrike(sender, "Invalid Base64 Encoding")
return
end
local serialized = LibDeflate:DecompressDeflate(compressed)
if not serialized then
RecordStrike(sender, "Decompression Failed")
return
end
-- Deduplication Check
if IsDuplicateMessage(serialized) then return end
-- 2. Deserialize
local success, payload = AceSerializer:Deserialize(serialized)
if not success or type(payload) ~= "table" then
RecordStrike(sender, "Deserialization Failed")
return
end
-- 3. Version Check
if payload._ver ~= ProtocolVersion then return end
-- 4. Pass to Learner Processing Logic
local op = payload.op
local typ = payload.typ
local id = payload.id
local d = payload.d
if not typ or not id or not d then return end
DebugLog("DEVELOP", "Received " .. tostring(op) .. " " .. tostring(typ) .. " " .. tostring(id) .. " from " .. tostring(sender))
QuestieLearner:HandleNetworkData(typ, id, d, op)
end