GuildAutoGreeter.lua

require "Window"
require "ICCommLib"

local GuildAutoGreeter = {}
local GuildAutoGreeterInst
local Utils = Apollo.GetPackage("SimpleUtils").tPackage

local strInstructions = "Use {player} in a message to insert the player name.\n" ..
                        "To have a random message chosen, place multiple messages on separate lines."

local Major, Minor, Patch, Suffix = 1, 10, 0, 0
local GUILDAUTOGREETER_CURRENT_VERSION = string.format("%d.%d.%d", Major, Minor, Patch)

local defaultSettings =
{
  enabled = true,
  salutation = false,
  welcome = true,
  greetingThreshold = 3
}

function GuildAutoGreeter:new(o)
    o = o or {}
    setmetatable(o, self)
    self.__index = self

  self.strJoinedMessage = "Welcome {player}"
  self.strSalutationMessage = "Hello {player}"
  self.state = false
  self.config = defaultSettings
  self.playersGreeted = {}
  self.playersGreetedSelf = {}
  self.tQueuedData = {}
  self.strGuildChannelName = ""
  self.addon = {}

    return o
end

function GuildAutoGreeter:Init()
  local bHasConfigureFunction = false
  local strConfigureButtonText = ""
  local tDependencies = {
    -- "UnitOrPackageName",
  }
  self.addon = Apollo.RegisterAddon(self, bHasConfigureFunction, strConfigureButtonText, tDependencies)
end

function GuildAutoGreeter:OnLoad()
  self.xmlDoc = XmlDoc.CreateFromFile("GuildAutoGreeter.xml")
  self.xmlDoc:RegisterCallback("OnDocLoaded", self)
end

function GuildAutoGreeter:OnDocLoaded()
  if self.xmlDoc ~= nil and self.xmlDoc:IsLoaded() then
      self.wndMain = Apollo.LoadForm(self.xmlDoc, "GuildAutoGreeterForm", nil, self)
    if self.wndMain == nil then
      Apollo.AddAddonErrorText(self, "Could not load the main window for some reason.")
      return
    end
      self.wndMain:Show(false, true)
    self.wndMain:FindChild("Description"):SetText(strInstructions)
  end
  -- Register handlers for events, slash commands and timer, etc.
  -- e.g. Apollo.RegisterEventHandler("KeyDown", "OnKeyDown", self)
  Apollo.RegisterSlashCommand("guildautogreeter", "OnSlashCommand", self)
  Apollo.RegisterSlashCommand("autogreet", "OnSlashCommand", self)

  Apollo.RegisterEventHandler("InterfaceMenuListHasLoaded", "OnInterfaceMenuListHasLoaded", self)
  Apollo.RegisterEventHandler("Generic_ToggleGuildAutoGreeter", "OnGuildGreetOptions", self)
  --Apollo.RegisterEventHandler("ChatMessage", "OnChatMessage", self)
  Apollo.RegisterEventHandler("GuildResult", "OnGuildResult", self) -- game client initiated events

  Apollo.RegisterTimerHandler("GreetTimer", "OnGreetTimerUpdate", self)
  Apollo.CreateTimer("GreetTimer", 4, true)
end

function GuildAutoGreeter:OnGreeterMessage(channel, tMsg)
  if type(tMsg) ~= "string" then
    return
  end

  -- Count greeting from another player and update the count for the greeted player
  self:IncrPlayerGreeting(tMsg)
end

function GuildAutoGreeter:OnGreetTimerUpdate(strVar, nValue)
  if #self.tQueuedData > 0 then
    local tMessage = self.tQueuedData[1]
    table.remove(self.tQueuedData, 1)

    ChatSystemLib.Command("/g " .. tMessage.msg)
    if (tMessage.type == "salutation") then
      self:SendMessage(tMessage.player)
    end
  else
    Apollo.StopTimer("GreetTimer")
  end
end

function GuildAutoGreeter:IncrPlayerGreeting(strPlayer)
  if 	self.playersGreeted[strPlayer] == nil then
    self.playersGreeted[strPlayer] = 1
  else
    self.playersGreeted[strPlayer] = self.playersGreeted[strPlayer] + 1
  end
end


function GuildAutoGreeter:OnGuildResult(guildSender, strName, nRank, eResult )
  local guildType = guildSender:GetType()
  if self.config.enabled == true and FriendshipLib.GetPersonalStatus() ~= FriendshipLib.AccountPresenceState_Away	then
    if guildType == 1 then
      if eResult == GuildLib.GuildResult_InviteAccepted then
        -- Do Member joined with strName
        self:SendGuildWelcome(strName)
      elseif eResult == GuildLib.GuildResult_MemberOnline then
        -- Do Member Online with strName
        self:SendGuildSalutation(strName)
      end
    end
  end
end


-- Send Message when player joins guild
function GuildAutoGreeter:SendGuildWelcome(playerName)
  if self.config.welcome == true then
    if self.strJoinedMessage ~= "" and self.strJoinedMessage ~= nil then
      local message = self:SelectRandomMessage(self.strJoinedMessage)
      self:AddMessageToQueue(message, "welcome", playerName)
    end
  end
end


-- Send Message when player comes online
function GuildAutoGreeter:SendGuildSalutation(playerName)
  if self.config.salutation == true then
    if self.strSalutationMessage ~= "" and self.strSalutationMessage ~= nil then
      -- Only Greet if other people's greetings haven't crossed the threshold
      if self.playersGreeted[playerName] == nil or self.playersGreeted[playerName] < self.config.greetingThreshold then
        -- Only Greet if you haven't greeted once.
        if self.playersGreetedSelf[playerName] == nil then
          local message = self:SelectRandomMessage(self.strSalutationMessage)
          self:AddMessageToQueue(message, "salutation", playerName)
          self.playersGreetedSelf[playerName] = true
        end
      end
    end
  end
end


function GuildAutoGreeter:SelectRandomMessage(tbl)
  local tSplitMessages = string.split(tbl, "\n")
  local count = #tSplitMessages
  local idx = math.random(count)
  -- return truncated message so that only first 100 characters are returned
  return string.sub(tSplitMessages[idx],1,100)
end


function GuildAutoGreeter:AddMessageToQueue(message, messageType, playerName)
  firstName = string.split(playerName, " ")[1]
  local t = {
    msg = string.gsub(message, "{player}", firstName),
    type = messageType,
    player = playerName
  }
  table.insert(self.tQueuedData, t)
  Apollo.StartTimer("GreetTimer")
end

function GuildAutoGreeter:OnInterfaceMenuListHasLoaded()
  Event_FireGenericEvent("InterfaceMenuList_NewAddOn", "GuildAutoGreeter", {"Generic_ToggleGuildAutoGreeter", "", "CRB_Basekit:kitIcon_Holo_Social"})
  self.playerUnit = GameLib.GetPlayerUnit()
  self.strPlayerGuild = self.playerUnit:GetGuildName()
  if self.strPlayerGuild ~= nil then
    self:UpdateCommChannel()
    --self.commChannel:SetSendMessageResultFunction("OnGreeterMessage", self)
    --self.commChannel:SetJoinResultFunction("OnChannelJoin", self)
  else
    self.strGuildChannelName = ""
    self.commChannel = nil
  end

  -- Report Self
  Event_FireGenericEvent("OneVersion_ReportAddonInfo", "GuildAutoGreeter", Major, Minor, Patch, Suffix, false)
end

function GuildAutoGreeter:UpdateCommChannel()
  if not self.commChannel then
    self.commChannel = ICCommLib.JoinChannel("GuildAutoGreeter", ICCommLib.CodeEnumICCommChannelType.Guild, GuildLib.GetGuilds()[1])
  end

  if self.commChannel:IsReady() then
    self.commChannel:SetReceivedMessageFunction("OnGreeterMessage", self)
  else
    -- Channel not ready yet, repeat in a few seconds
    Apollo.CreateTimer("UpdateCommChannel", 1, false)
    Apollo.StartTimer("UpdateCommChannel")
  end
end

function GuildAutoGreeter:SendMessage(msg)
  if not self.commChannel then
      Print("[GuildAutoGreeter] Error sending Markers. Attempting to fix this now. If this issue persists, contact the developers")
      self:UpdateCommChannel()
      return false
  else
      self.commChannel:SendMessage(msg)
  end
end


function GuildAutoGreeter:OnOK()
  wndGreeting = self.wndMain:FindChild("Greeting")
  wndSalutation = self.wndMain:FindChild("Salutation")
  self.strJoinedMessage = wndGreeting:GetText()
  self.strSalutationMessage = wndSalutation:GetText()
  self.state = false
  self.wndMain:Close()
end

function GuildAutoGreeter:OnCancel()
  self.state = false
  self.wndMain:Close()
end

function GuildAutoGreeter:OnSave(eLevel)
  if eLevel ~= GameLib.CodeEnumAddonSaveLevel.Character then
    return
    end

  local tSavedData = {
    addonConfigVersion = GUILDAUTOGREETER_CURRENT_VERSION,
    salutation = self.strSalutationMessage,
    welcome = self.strJoinedMessage,
    config = self.config
  }
  return tSavedData
end

function GuildAutoGreeter:OnRestore(eLevel, tSavedData)
  if eLevel ~= GameLib.CodeEnumAddonSaveLevel.Character then
    return
  end
  if tSavedData.addonConfigVersion == GUILDAUTOGREETER_CURRENT_VERSION then
    self.strJoinedMessage = tSavedData.welcome
    self.strSalutationMessage = tSavedData.salutation
    if tSavedData.config then
      self.config = deepcopy(tSavedData.config)
    end
  end
end

function GuildAutoGreeter:OnSlashCommand(sCmd, sInput)
  local s = string.lower(sInput)
  if s == nil or s == "" or s == "help" then
    Utils:cprint("GuildAutoGreeter")
    Utils:cprint("Usage:  /autogreet <command>")
    Utils:cprint("============================")
    Utils:cprint("   options   Shows the addon options.")
    Utils:cprint("   enable    Enables the addon (default)")
    Utils:cprint("   disable   Disables the addon")
    Utils:cprint("   clear     Clears the greeting cache")
    Utils:cprint("   reset      Restore default settings")
  elseif s == "options" then
    self:OnGuildGreetOptions()
  elseif s == "enable" then
    self.config.enabled = true
    self:ApplySettings()
  elseif s == "disable" then
    self.config.enabled = false
    self:ApplySettings()
  elseif s == "clear" then
    self.config = deepcopy(defaultSettings)
    self:ApplySettings()
  elseif s == "reset" then
    self.config = deepcopy(defaultSettings)
    self:ApplySettings()
  end
end

function GuildAutoGreeter:ApplySettings()
  local wndGreeting = self.wndMain:FindChild("Greeting")
  local wndSalutation = self.wndMain:FindChild("Salutation")
  local wndEnbaledButton = self.wndMain:FindChild("EnabledButton")
  local wndWelcomeButton = self.wndMain:FindChild("WelcomeButton")
  local wndSalutationButton = self.wndMain:FindChild("SalutationButton")
  local wndSliderFrame = self.wndMain:FindChild("Threshold"):FindChild("ThresholdSliderFrame")
  local wndSlider = wndSliderFrame:FindChild("ThresholdSlider")
  local wndEditBox = wndSliderFrame:FindChild("ThresholdEditBox")

  wndGreeting:SetText(self.strJoinedMessage)
  wndSalutation:SetText(self.strSalutationMessage)
  wndEnbaledButton:SetCheck(self.config.enabled)
  wndWelcomeButton:SetCheck(self.config.welcome)
  wndSalutationButton:SetCheck(self.config.salutation)
  wndEditBox:SetText(tostring(self.config.greetingThreshold))
  wndSlider:SetValue(tonumber(self.config.greetingThreshold))
end

function GuildAutoGreeter:OnGuildGreetOptions()
  if self.state == false then
    self.state = true
    self:ApplySettings()
    self.wndMain:Show(self.state)
  else
    self.state = false
    self.wndMain:Show(self.state)
  end
end

---------------------------------------------------------------------------------------------------
-- GuildAutoGreeterForm Functions
---------------------------------------------------------------------------------------------------
function GuildAutoGreeter:OnClose( wndHandler, wndControl )
  self.state = false
end

function GuildAutoGreeter:OnEnableChecked( wndHandler, wndControl, eMouseButton )
  self.config.enabled = true
end

function GuildAutoGreeter:OnEnableUnchecked( wndHandler, wndControl, eMouseButton )
  self.config.enabled = false
end

function GuildAutoGreeter:OnWelcomeChecked( wndHandler, wndControl, eMouseButton )
  self.config.welcome = true
end

function GuildAutoGreeter:OnWelcomeUnchecked( wndHandler, wndControl, eMouseButton )
  self.config.welcome = false
end

function GuildAutoGreeter:OnSalutationChecked( wndHandler, wndControl, eMouseButton )
  self.config.salutation = true
end

function GuildAutoGreeter:OnSalutationUnchecked( wndHandler, wndControl, eMouseButton )
  self.config.salutation = false
end

function GuildAutoGreeter:OnOptionsSliderChanged(wndHandler, wndControl, fValue, fOldValue)
  local wndEditBox = wndControl:GetParent():FindChild("ThresholdEditBox")

  if wndEditBox then
    wndEditBox:SetText(tostring(math.floor(fValue)))
  end
  self.config.greetingThreshold = math.floor(fValue)
end


local GuildAutoGreeterInst = GuildAutoGreeter:new()
GuildAutoGreeterInst:Init()