John@0: -- lists consist of three things
John@0: -- 1) a base state - agreed on by one or more list holders
John@0: -- 2) change sets - incremental list changes (can be rolled forwards or
John@0: -- backwards)
John@0: -- 3) working state - not saved because it can be so easily calculated
John@0: --
John@0: -- A separate user list is held - lists index into this
John@0: 
John@0: 
John@0: -- TODO: rename player
John@5: -- TODO: list trimming
John@0: 
John@4: -- notes on list storage:
John@7: -- Using names as keys as I do now is atrocious.
John@4: -- It prevents insertions (twss) to the middle of the list because then it acts
John@4: -- as a side effect onto all the others. ie ABCD -> AXBCD would be phrased as
John@4: -- "insert X and shift down B,C,D" which sucks. BCD haven't really been affected
John@4: -- (yet) because their relative positions to the others are still intact - ie
John@4: -- they are still below A right where they belong. But really X hasn't done
John@4: -- anything to affect their relative standing.
John@4: --
John@4: -- Ok so we can't use names.
John@4: --
John@4: -- We can't use monotonic integers either because it suffers the same problem.
John@4: -- Also consider, randoming in someone to a list of ABCD. Say they roll spot 2.
John@4: -- What if someone else runs a separate raid and also randoms someone into slot
John@4: -- 2? How do you handle that conflict? Difficult. Also, consider this:
John@4: -- List of ABCD on night 1.
John@4: -- Admin 1 on night 2 rolls in 30 new people. ABCD's indexes are shuffled to be
John@4: -- between 1-35.
John@4: -- Admin 2 on night 3 rolls in 5 new ones and people ABCD and PQRST now all have
John@4: -- indexes between 1-9.
John@4: -- When these two are resolved against one another, do the 1-9 peopole end up on
John@4: -- top of the list compared to those other 30? 
John@4: --
John@4: -- Solution:
John@4: -- Need a huge random space with purposely left gaps to leave plenty of room for
John@4: -- conflicts.
John@4: -- So if ABCD had randomed on a space of say, 10,000 and then were sorted into
John@4: -- order, then the next 30 could roll into that same space and have a proper
John@4: -- ordering. Then the next 5, etc.
John@4: --
John@4: -- Handling conflicts:
John@4: --
John@9: -- Executive decision: random on a range of [0,1], ie math.random
John@9: --                     then on an add-to-end event just do last + .1
John@9: --                     disallow random after any add-to-end event occurs
John@9: --                     because the list either elongates beyond 1 OR becomes
John@9: --                     ridiculously bottom heavy, thus meaning that randoms
John@9: --                     don't get an even distibution from then on (in fact
John@9: --                     they'll end up getting top favor)
John@9: --                     * if a stream contains a random-add after an add-to-end
John@9: --                     it is declared invalid. tough tits. it's just not a fair
John@9: --                     distribution at that point.
John@0: 
John@8: -- todo: list-of-lists must not use int indices. those will lead to peril.
John@0: bsk.lists = {}
John@8: bsk.persons = {}
John@0: 
John@8: local raidList = {}
John@8: local reserveList = {}
John@8: local activeListKey = 1 -- temporary
John@8: local personsReverse = {} 
John@0: 
John@0: local tinsert = table.insert
John@0: local sformat = string.format
John@0: local getn = table.getn
John@0: 
John@0: function bsk:tcopy(to, from)
John@0:   for k,v in pairs(from) do
John@0:     if(type(v)=="table") then
John@0:       to[k] = {}
John@0:       bsk:tcopy(to[k], v);
John@0:     else
John@0:       to[k] = v;
John@0:     end
John@0:   end
John@0: end
John@0: local shallowCopy = function(t)
John@0:   local u = { }
John@0:   for k, v in pairs(t) do u[k] = v end
John@0:   return setmetatable(u, getmetatable(t))
John@0: end
John@0: 
John@1: -- Debugging {{{
John@9: function bsk:PrettyPrintList(listIndex)
John@9:     local list = bsk.lists[listIndex]
John@9:     bsk:Print("List: " .. list.name .. " (" .. list.time .. ")")
John@9:     for i = 1,#list do
John@9:         bsk:Print("  " .. i .. " - " .. bsk.persons[list[i]].main)
John@9:     end
John@9: end
John@9: function bsk:PrettyPrintLists()
John@9:     for i,_ in pairs(bsk.lists) do
John@9:         bsk:PrettyPrintList(i)
John@9:     end
John@9: end
John@1: function bsk:PrintLists()
John@1:     bsk:PrintTable(bsk.lists)
John@1: end
John@1: function bsk:PrintChanges()
John@1:     bsk:PrintTable(bsk.db.profile.changes)
John@1: end
John@8: function bsk:PrintPersons()
John@8:     bsk:PrintTable(bsk.persons)
John@1: end
John@0: function bsk:PrintTable(table, depth)
John@0:     depth = depth or ""
John@0:     if not table then return end
John@0:     for i,v in pairs(table) do 
John@0:         if( type(v) == "string" ) then
John@0:             self:Print(depth .. i ..  " - " .. v) 
John@0:         elseif( type(v) == "number" ) then
John@0:             self:Print(depth .. i .. " - " .. tostring(v))
John@0:         elseif( type(v) == "table" ) then
John@0:             self:Print(depth .. i .." - ") 
John@0:             self:PrintTable(v,depth.."   ")
John@0:         elseif( type(v) == "boolean" ) then
John@0:             self:Print(depth .. i .. " - " .. tostring(v))
John@0:         else
John@0:             self:Print(depth .. i .. " - not sure how to print type: " .. type(v) )
John@0:         end
John@0:     end
John@0: end
John@0: 
John@0: --}}}
John@0: 
John@9: function bsk:UpdatePersonsReverse()
John@9:     for i,v in pairs(bsk.persons) do
John@9:         if i ~= "time" then
John@9:             personsReverse[v.main] = i
John@9:         end
John@9:     end
John@9: end
John@9: 
John@5: function bsk:CreateWorkingStateFromChanges(changes)
John@8:     local personsBase = self.db.profile.persons
John@0:     local listBase = self.db.profile.listBase
John@0: 
John@0:     -- copy the base to the working state
John@0:     wipe(bsk.lists)
John@8:     wipe(bsk.persons)
John@8:     wipe(personsReverse)
John@8: 
John@0:     bsk:tcopy(bsk.lists,listBase)
John@8:     bsk:tcopy(bsk.persons,personsBase)
John@0: 
John@0:     -- now just go through the changes list applying each
John@5:     for i,v in ipairs(changes) do
John@0:         bsk:ProcessChange(v)
John@0:     end
John@9: 
John@9:     -- update the persons reverse list
John@9:     bsk:UpdatePersonsReverse()
John@0: end
John@0: 
John@0: function bsk:CreateChange(change)
John@0:     -- sanity
John@0:     assert(change)
John@0:     assert(change.action)
John@0:     assert(change.arg)
John@0: 
John@0:     bsk:StartChange(change)
John@0:     bsk:CommitChange(change)
John@0: end
John@0: 
John@0: function bsk:StartChange(change)
John@0:     local changes = self.db.profile.changes
John@0:     change.time = time()
John@0:     local n = getn(changes)
John@0:     if n > 0 then
John@0:         if changes[n].time >= change.time then
John@0:             change.time = changes[n].time + 1
John@0:         end
John@0:     end
John@0: end
John@0: 
John@0: function bsk:CommitChange(change)
John@0:     local changes = self.db.profile.changes
John@0:     tinsert(changes,change)
John@0:     -- TODO: broadcast change
John@0: end
John@0: 
John@0: 
John@0: -- timestamp logic:
John@0: -- use time() for comparisons - local clients use date() to make it pretty. only
John@0: -- dowisde - we can't have a server timestamp. Which kind of sucks, but it turns
John@0: -- out you can change timezones when you enter an instance server, so you really
John@0: -- never know what time it is.
John@0: -- There's unfortunately no hard-and-proven method for determining the true time
John@0: -- difference between local time and server time. You can't just query the two
John@0: -- and compare them because your server timezone can change (!) if you go into
John@0: -- an instance server with a different timezone. This is apparently a big
John@0: -- problem on Oceanic realms.
John@0: --
John@0: --  Timestamp handling (brainstorming how to deal with drift):
John@0: --  (not an issue) if someone sends you time in the future, update your offset so you won't
John@0: --  send out events in the "past" to that person
John@0: --  (not an issue - using local UTC now) on change-zone-event: check if you've changed timezones - might need update
John@0: --  each time you add a change, check the tail of the change list; if this is
John@0: --  less than that, you have a problem. Print a message. if this is equal, then
John@0: --  that's ok, just bump it by 1 second. This could happen in the case of, say,
John@0: --  spam-clicking the undo button or adding names to the list. The recipients
John@0: --  should be ok with this since they'll follow the same algorithm. The only
John@0: --  real chance for a problem is if two people click within the 1 second window?
John@0: --  if someone sends you a past event,
John@0: --          it's ok if it's newer than anything in the changes list
John@0: --          otherwise ... causality has been violated.
John@0: --  Whenever an admin signon event happens, have the admins each perform a
John@0: --  timestamp check. Issue warnings for anyone with a clock that's more than
John@0: --  X seconds out of sync with the others. Seriously, why isn't NTP a standard
John@0: --  setting on all operating systems ...
John@0: 
John@0: function bsk:ProcessChange(change)
John@8:     if change.action == "AddPerson" then
John@8:         bsk:DoAddPerson(change)
John@0:     elseif change.action == "CreateList" then
John@0:         bsk:DoCreateList(change)
John@8:     elseif change.action == "AddPersonToList" then
John@8:         bsk:DoAddPersonToList(change)
John@8:     elseif change.action == "SuicidePerson" then
John@8:         bsk:DoSuicidePerson(change)
John@0:     else
John@0:         bsk:Print("Unknown message encountered")
John@0:         bsk:PrintTable(change)
John@0:         assert(false)
John@0:     end 
John@0: end
John@0: 
John@1: -- Action and DoAction defs {{{
John@0: --
John@0: -- The actual actions for changes start here
John@0: --
John@0: -- Each action occurs as a pair of functions. The bsk:Action() function is from
John@0: -- a list admin's point of view. Each will check for admin status, then create a
John@0: -- change bundle, call the handler for that change (ie the DoAction func), and
John@0: -- then record/transmist the bundle. These are simple and repetitive functions.
John@0: --
John@0: -- The bsk:DoAction() function is tasked with executing the bundle and is what
John@0: -- non-admins and admins alike will call to transform their working state via a
John@0: -- change packet. Each Do() function will accept *only* a change packet, and
John@0: -- it's assumed that the change has been vetted elsewhere. These are very blunt
John@0: -- routines.
John@0: --
John@0: -- Note that "undo" has no special voodoo to it. It's basically a change that
John@0: -- reverses the prior change on the stack.
John@0: 
John@8: -- persons list
John@8: function bsk:DoAddPerson(change)
John@0:     assert(change)
John@8:     assert(change.arg.id)
John@0:     local arg = change.arg
John@0:     -- require admin
John@8:     local persons = bsk.persons
John@0:     local name = arg.name
John@8:     local id = arg.id
John@8:     assert(persons[id]==nil)
John@8:     persons[id] = {main=name}
John@8:     persons.time=change.time
John@8:     personsReverse[name] = id
John@0:     return true
John@0: end
John@0: 
John@8: function bsk:AddPerson(name)
John@8:     local persons = bsk.persons
John@0:     local guid = UnitGUID(name)
John@0:     -- TODO: check guid to be sure it's a player
John@0:     if not guid then
John@0:         self:Print(sformat("Could not add player %s - they must be in range or group",name))
John@0:         return
John@0:     end
John@8:     local id = string.sub(guid,6) -- skip at least 0x0580 ...
John@8:     id = id:gsub("^0*(.*)","%1") -- nom all leading zeroes remaining
John@8:     
John@8:     if persons[id] and persons[id] ~= name then
John@8:         self:Print(sformat("Namechange detected for %s - new is %s, please rename the existing entry", persons[id], name))
John@0:         return
John@0:     end
John@8:     if persons[id] ~= nil then
John@8:         self:Print(sformat("%s is already in the persons list; disregarding", name))
John@0:         return
John@0:     end
John@8:     local change = {action="AddPerson",arg={name=name,id=id}}
John@8:     if bsk:DoAddPerson(change) then
John@0:         bsk:CreateChange(change)
John@0:     end
John@0: end
John@0: 
John@0: function bsk:DoCreateList(change)
John@0:     -- TODO: this segment will probably be useful as bsk:SearchForListByName
John@0:     local lists = bsk.lists
John@0:     for i,v in pairs(lists) do
John@0:         if v.name == change.arg.name then
John@0:             self:Print(sformat("List %s already exists",v.name))
John@0:             return false
John@0:         end
John@0:     end
John@0:     tinsert(lists,{name=change.arg.name,time=change.time})
John@0:     return true
John@0: end
John@0: 
John@0: function bsk:CreateList(name)
John@0:     -- require admin
John@0:     local change={action="CreateList",arg={name=name}}
John@0:     bsk:StartChange(change)
John@0:     self:Print("Creating ... " .. name)
John@0:     if bsk:DoCreateList(change) then
John@0:         bsk:CommitChange(change)
John@0:     end
John@0: end
John@0: 
John@9: -- TODO: break into AddPersonToListEnd and AddPersonToListRandom
John@8: function bsk:DoAddPersonToList(change)
John@0:     local listIndex = change.arg.listIndex
John@0:     local slist = change.arg.slist
John@0:     local list = bsk.lists[listIndex]
John@0: 
John@0:     if #slist == 1 then -- end of list insertion - just one person
John@0:         tinsert(list,slist[1])
John@0:         list.time = change.time
John@0:     else
John@0:         self:Print("Adding to middle of list is not yet supported")
John@0:         return false
John@0:     end
John@0:     return true
John@0: end
John@0: 
John@8: function bsk:AddPersonToList(name,list)
John@0:     -- require admin
John@0:     local listIndex = bsk:GetListIndex(list)
John@8:     local id = personsReverse[name]
John@9:     bsk:Print(sformat("Adding %s (%s) to list %s (%s)", name, id, list, listIndex))
John@8:     local slist = {id} -- TODO: support adding to elsewhere besides the end
John@8:     local change = {action="AddPersonToList",arg={id=id,listIndex=listIndex,slist=slist}}
John@0:     bsk:StartChange(change)
John@8:     if bsk:DoAddPersonToList(change) then
John@0:         bsk:CommitChange(change)
John@0:     end
John@0: end
John@0: 
John@8: function bsk:DoRemovePerson(change)
John@0: 
John@0:     -- return true
John@0: end
John@0: 
John@8: function bsk:RemovePerson(name)
John@8:     -- from both persons and lists
John@0: end
John@0: 
John@8: function bsk:DoSuicidePerson(change)
John@0:     local listIndex = change.arg.listIndex
John@0:     local list = bsk.lists[listIndex]
John@0:     local slist = shallowCopy(change.arg.list)
John@0:     -- the goal here is to rotate the suicide list by 1
John@0:     -- then we can just mash it on top of the intersection between the original
John@0:     -- list and the working copy
John@0:     local stemp = shallowCopy(change.arg.list)
John@0:     local temp = table.remove(stemp,1) -- pop
John@0:     tinsert(stemp,temp) -- push_back
John@0:     --bsk:Print(sformat("Before suicide of %s on list %s",slist[1],list.name))
John@0:     --bsk:PrintTable(list)
John@0:     for i = 1, #list do
John@0:         if list[i] == slist[1] then
John@0:             table.remove(slist,1)
John@0:             list[i] = stemp[1]
John@0:             table.remove(stemp,1)
John@0:         end
John@0:     end
John@0:     list.time=change.time
John@0:     --bsk:Print("After")
John@0:     --bsk:PrintTable(list)
John@0:     return true
John@0: end
John@0: 
John@8: function bsk:SuicidePerson(name,list)
John@0:     -- require admin
John@0:     bsk:PopulateRaidList()
John@0:     local listIndex = bsk:GetListIndex(list)
John@1:     local slist=bsk:GetSuicideList(name,bsk.lists[listIndex])
John@8:     local change = {action="SuicidePerson",arg={names=names,list=slist,listIndex=listIndex}}
John@0:     bsk:StartChange(change)
John@8:     if bsk:DoSuicidePerson(change) then
John@0:        bsk:CommitChange(change)
John@0:     end
John@0: end
John@5: 
John@5: function bsk:TrimLists(time)
John@5:     if not bsk:CheckListCausality() then
John@5:         self:Print("Unable to trim lists due to violated causality")
John@5: 
John@5:         return false
John@5:     end
John@5: 
John@5:     if type(time) ~= "number" then
John@5:         time = tonumber(time)
John@5:     end
John@5: 
John@5:     -- bisect the changes list by "time"
John@5:     local before = {}
John@5:     for i,v in ipairs(self.db.profile.changes) do
John@5:         if v.time <= time then
John@5:             tinsert(before,v)
John@5:         else
John@5:             break
John@5:         end
John@5:     end
John@5: 
John@5:     -- apply first half
John@5:     bsk:CreateWorkingStateFromChanges(before)
John@5: 
John@5:     -- save this state permanently; trim the changes permanently
John@8:     bsk:tcopy(bsk.db.profile.persons,bsk.persons)
John@5:     bsk:tcopy(bsk.db.profile.listBase,bsk.lists)
John@8:     while bsk.db.profile.changes ~= nil and bsk.db.profile.changes[1] ~= nil and bsk.db.profile.changes[1].time <= time do
John@5:         table.remove(bsk.db.profile.changes,1)
John@5:     end
John@5: 
John@5:     -- using the trimmed list and the new bases, recreate the working state
John@5:     bsk:CreateWorkingStateFromChanges(bsk.db.profile.changes)
John@5: end
John@5: 
John@1: --}}}
John@1: -- Higher order actions (ie calls other Doers){{{
John@8: function bsk:AddMissingPersons()
John@1:     bsk:PopulateRaidList() 
John@1:     local t = {}
John@8:     for _,v in pairs(bsk.persons) do
John@8:         t[v.main] = true
John@8:         -- TODO: also add alts here
John@1:     end
John@8:     for i,_ in pairs(raidList) do
John@2:         if t[i] == nil then
John@8:             bsk:Print(sformat("Person %s is missing from the persons list - adding",i))
John@8:             bsk:AddPerson(i)
John@1:         end
John@1:     end
John@1:     -- TODO: batch into a single op - no need to spam 25 messages in a row
John@1: end
John@3: function bsk:PopulateListRandom(index)
John@3:     -- difference (raid+reserve)^list, then random shuffle that, then add
John@3:     bsk:PopulateRaidList()
John@3:     local list = bsk.lists[index]
John@3: 
John@3:     local t = {}
John@3:     --for i = 1,#list do
John@8:     --    if not (raidList(list[i]) or reserveList(list[i])) then
John@3:     --        tinsert(t,)
John@3:     --    end
John@3:     --end
John@3: end
John@1: --}}}
John@1: 
John@1: -- "Soft" actions- ie things that cause nonpermanent state {{{
John@1: 
John@1: -- reserves
John@1: function bsk:AddReserve(name)
John@8:     reserveList[name]=true
John@1:     -- TODO: communicate to others. don't store this in any way.
John@1: end
John@1: 
John@1: function bsk:RemoveReserve(name)
John@8:     reserveList[name]=false
John@1:     -- TODO: communicate to others. don't store this in any way.
John@1: end
John@1: 
John@1: 
John@1: --function bsk:GetActiveList()
John@1: --    return bsk.lists[1] -- todo!
John@1: --end
John@1: 
John@1: --}}}
John@0: 
John@0: -- The following code is from Xinhuan (wowace forum member)
John@0: -- Pre-create the unitID strings we will use
John@0: local pID = {}
John@0: local rID = {}
John@0: for i = 1, 4 do
John@0:     pID[i] = format("party%d", i)
John@0: end
John@0: for i = 1, 40 do
John@0:     rID[i] = format("raid%d", i)
John@0: end
John@0: function bsk:PopulateRaidList()
John@0:     local inParty = GetNumPartyMembers()
John@0:     local inRaid = GetNumRaidMembers()
John@0: 
John@8:     wipe(raidList)
John@0:     if inRaid > 0 then
John@0:         for i = 1, inRaid do
John@8:             raidList[UnitName(rID[i])]=true
John@0:         end
John@0:     elseif inParty > 0 then
John@0:         for i = 1, inParty do
John@8:             raidList[UnitName(pID[i])]=true
John@0:         end
John@0:         -- Now add yourself as the last party member
John@8:         raidList[UnitName("player")]=true
John@0:     else
John@0:         -- You're alone
John@8:         raidList[UnitName("player")]=true
John@0:     end
John@0: end
John@0: 
John@0: -- undo rules!
John@0: -- only the most recent event can be undone
John@0: -- ^^^ on a given list?
John@0: -- algorithm is easy, given "Suicide A B C"
John@0: -- just find A,B,C in the list and replace in order from the s message
John@0: -- while undo is allowed *per-list*, certain events in the stream will
John@0: -- prevent proper undo, such as add/delete player or add/delete list
John@0: 
John@0: 
John@1: function bsk:GetSuicideList(name,list)
John@1:     --self:Print("Calculating changeset for "..name.." from list -")
John@1:     --self:PrintTable(list)
John@1:     local t = {}
John@1:     local ret = {}
John@1:     local pushing = false
John@1:     for i = 1, #list do
John@1:         if list[i] == name then
John@1:             pushing = true
John@1:         end
John@8:         if pushing and (raidList[list[i]] or reserveList[list[i]]) then
John@1:             tinsert(ret,list[i])
John@1:         end
John@1:     end
John@1:     return ret
John@0: end
John@0: 
John@5: -- returns true if the events in the list are in time order
John@5: function bsk:CheckListCausality()
John@5:     local t = nil
John@5:     for i,v in ipairs(bsk.db.profile.changes) do
John@5:         if t ~= nil then
John@5:             if v.time <= t then
John@5:                 return false
John@5:             end
John@5:         end
John@5:         t = v.time
John@5:     end
John@5:     return true
John@5: end
John@0: 
John@0: -- Support functions
John@0: 
John@0: function bsk:GetListIndex(name)
John@0:     for i,v in pairs(bsk.lists) do
John@0:         if v.name == name then
John@0:             return i
John@0:         end
John@0:     end
John@0:     assert(false)
John@0: end
John@1: 
John@3: local shuffleArray = function(array)
John@3:     local arrayCount = #array
John@3:     for i = arrayCount, 2, -1 do
John@3:         local j = math.random(1, i)
John@3:         array[i], array[j] = array[j], array[i]
John@3:     end
John@3:     return array
John@3: end
John@3: