annotate Squawk.lua @ 8:34078dfcc67c

syntax fix
author wobin
date Sun, 19 Apr 2009 02:49:29 +1000
parents d19385c4a282
children c535960b1245
rev   line source
wobin@0 1 -- A Twitter client of sorts for World of Warcraft
wobin@0 2 -- Author: Wobin
wobin@0 3 -- Email: wobster@gmail.com
wobin@0 4 --
wobin@1 5 Squawk = LibStub("AceAddon-3.0"):NewAddon("Squawk")
wobin@0 6
wobin@0 7 Squawk.Model = {}
wobin@0 8 Squawk.View = {}
wobin@0 9 Squawk.Controller = {}
wobin@0 10
wobin@0 11 local Model = Squawk.Model
wobin@0 12 local View = Squawk.View
wobin@0 13 local Controller = Squawk.Controller
wobin@0 14
wobin@0 15 Model.UserSettings = {}
wobin@0 16 local Settings = Model.UserSettings
wobin@0 17
wobin@0 18 local defaults = {
wobin@0 19 profile = {
wobin@0 20 Squawks = {},
wobin@0 21 Follower = {},
wobin@0 22 Following = {},
wobin@7 23 Pending = {},
wobin@7 24 Requested = {},
wobin@0 25 Blocked = {},
wobin@0 26 }
wobin@0 27 }
wobin@0 28
wobin@0 29 function Squawk:OnInitialize()
wobin@0 30 Model.db = LibStub("AceDB-3.0"):New("SquawkDB", defaults)
wobin@4 31 Model.Squawks = Model.db.profile.Squawks
wobin@0 32 Settings.Follower = Model.db.profile.Follower
wobin@0 33 Settings.Following = Model.db.profile.Following
wobin@7 34 Settings.Pending = Model.db.profile.Pending
wobin@7 35 Settings.Requested = Model.db.profile.Requested
wobin@0 36 Settings.Blocked = Model.db.profile.Blocked
wobin@0 37 Settings.Private = Model.db.profile.Private
wobin@0 38
wobin@0 39 LibStub("AceComm-3.0"):Embed(Controller)
wobin@3 40 Controller:RegisterComm("Squawk", Controller.ReceiveMessage)
wobin@3 41
wobin@3 42 LibStub("AceConsole-3.0"):Embed(View)
wobin@0 43 end
wobin@0 44
wobin@0 45 -- Model --
wobin@0 46 --[[
wobin@0 47 --Each Squawk will have the following information:
wobin@0 48 -- * Owner (Name)
wobin@0 49 -- * Time (Epoch)
wobin@0 50 -- * Message (140 characters)
wobin@0 51 -- * ReplyTo (Name)
wobin@0 52 -- * Related (Names)
wobin@0 53 --
wobin@0 54 -- Each User will have the following lists:
wobin@0 55 -- * Follower
wobin@0 56 -- * Following
wobin@0 57 -- * Blocked
wobin@7 58 -- * Pending (Requests to follow that you haven't acted on)
wobin@7 59 -- * Requested (Requests to follow that you have made)
wobin@0 60 -- * Privacy State
wobin@7 61 --
wobin@7 62 -- A user can only request to follow an online person. Requests can be approved
wobin@7 63 -- on or offline, but the initial request must be made online.
wobin@7 64 --
wobin@7 65 -- When a user makes a request to follow a private user, the subsequent paths occur:
wobin@7 66 -- - Followee is added to Settings.Requested
wobin@7 67 -- - Followee receives 'follow request' -> (their) Settings.Pending
wobin@7 68 -- - Followee acts on request -> (their) Settings.Pending cleared
wobin@7 69 -- 1) Follwer is online
wobin@7 70 -- - Follower receives 'request accepted' -> Added to Settings.Following and
wobin@7 71 -- cleared from Settings.Requested
wobin@7 72 -- 2) Follower is offline
wobin@7 73 -- - The next time Follower is online and recieves a Squawk we check if there
wobin@7 74 -- is a Settings.Requested for that name, and if so assume they have approved
wobin@7 75 -- and clear/add records appropriately.
wobin@0 76 --]]
wobin@0 77 Model.Squawk = {}
wobin@0 78 local Squawk = Model.Squawk
wobin@0 79
wobin@0 80 function Squawk:new(Message, Owner)
wobin@0 81 local o = {}
wobin@0 82 o.Owner = Owner or UnitName("player")
wobin@0 83 o.Message = Message
wobin@0 84 o.Time = os.time()
wobin@0 85 local reply, to = strsplit("@", ((strsplit(" ", Message))))
wobin@0 86 if reply == "" then
wobin@0 87 o.ReplyTo = to
wobin@0 88 end
wobin@0 89
wobin@0 90 o.Related = {}
wobin@0 91
wobin@0 92 for word in string.gmatch(Message, "@(%a+)") do
wobin@0 93 if word ~= o.ReplyTo or "" then
wobin@0 94 table.insert(o.Related, word)
wobin@0 95 end
wobin@0 96 end
wobin@0 97
wobin@0 98 return o
wobin@0 99 end
wobin@0 100
wobin@0 101 function Squawk:Sort(Squawks)
wobin@0 102 return table.sort(Squawks, function(a,b) return a.Time < b.Time end)
wobin@0 103 end
wobin@0 104
wobin@2 105 function Squawk:GetOwn(Squawks)
wobin@2 106 local mine = {}
wobin@2 107 for _, squawk in ipairs(Squawks) do
wobin@2 108 if squawk.Owner == UnitName("player") then
wobin@2 109 table.insert(mine, squawk)
wobin@2 110 end
wobin@2 111 end
wobin@2 112 return self:Sort(mine)
wobin@2 113 end
wobin@2 114
wobin@0 115 function Settings:IsPrivate()
wobin@0 116 return Settings.Private
wobin@0 117 end
wobin@0 118
wobin@0 119 function Settings:AddFollower(Name)
wobin@2 120 Settings.Follower[Name] = 1
wobin@7 121 self:RemovePending(Name)
wobin@0 122 end
wobin@0 123
wobin@0 124 function Settings:AddFollowing(Name)
wobin@2 125 Settings.Following[Name] = 1
wobin@7 126 self:RemoveRequested(Name)
wobin@0 127 end
wobin@0 128
wobin@0 129 function Settings:AddBlock(Name)
wobin@2 130 Settings.Blocked[Name] = 1
wobin@7 131 self:RemoveFollower(Name)
wobin@7 132 self:RemoveFollowing(Name)
wobin@7 133 end
wobin@7 134
wobin@7 135 function Settings:AddPending(Name)
wobin@7 136 Settings.Pending[Name] = 1
wobin@7 137 end
wobin@7 138
wobin@7 139 function Settings:AddRequested(Name)
wobin@7 140 Settings.Requested[Name] = 1
wobin@0 141 end
wobin@0 142
wobin@0 143 function Settings:RemoveFollower(Name)
wobin@2 144 if Settings.Follower[Name] then
wobin@2 145 Settings.Follower[Name] = nil
wobin@0 146 end
wobin@0 147 end
wobin@0 148
wobin@0 149 function Settings:RemoveFollowing(Name)
wobin@2 150 if Settings.Following[Name] then
wobin@2 151 Settings.Following[Name] = nil
wobin@0 152 end
wobin@0 153 end
wobin@0 154
wobin@0 155 function Settings:RemoveBlock(Name)
wobin@2 156 if Settings.Blocked[Name] then
wobin@2 157 Settings.Blocked[Name] = nil
wobin@0 158 end
wobin@0 159 end
wobin@0 160
wobin@7 161 function Settings:RemovePending(Name)
wobin@7 162 if Settings.Pending[Name] then
wobin@7 163 Settings.Pending[Name] = nil
wobin@7 164 end
wobin@7 165 end
wobin@7 166
wobin@7 167 function Settings:RemoveRequested(Name)
wobin@7 168 if Settings.Requested[Name] then
wobin@7 169 Settings.Requested[Name] = nil
wobin@7 170 end
wobin@7 171 end
wobin@7 172
wobin@0 173 --Controller--
wobin@0 174
wobin@0 175 function Controller:TheyWantToFollowMe(Name)
wobin@0 176 if Settings:IsPrivate() then
wobin@7 177 Settings:AddPending(Name)
wobin@0 178 self:PutForwardFollowRequest(Name)
wobin@0 179 self:SendMessageToTarget(Name, "#Pending|"..UnitName("player"))
wobin@0 180 else
wobin@0 181 Settings:AddFollower(Name)
wobin@0 182 View:NotifyOfNewFollower(Name)
wobin@0 183 self:SendMessageToTarget(Name, "#Follow|"..UnitName("player"))
wobin@0 184 end
wobin@0 185 end
wobin@0 186
wobin@7 187 function Controller:TheyWantToUnfollowMe(Name)
wobin@7 188 Settings:RemoveFollower(Name)
wobin@7 189 end
wobin@7 190
wobin@0 191 function Controller:IWantToFollowThem(Name)
wobin@2 192 self:SendMessageToTarget(Name, "#Request|"..UnitName("player"))
wobin@7 193 Settings:AddRequested(Name)
wobin@7 194 end
wobin@7 195
wobin@7 196 function Controller:IWantToUnfollowThem(Name)
wobin@7 197 Settings:RemoveFollowing(Name)
wobin@7 198 self:SendMessageToTarget(Name, "#Unfollow|"..UnitName("player"))
wobin@7 199 View:NotifyOfUnfollowing(Name)
wobin@0 200 end
wobin@0 201
wobin@0 202 function Controller:IAmNowFollowingThem(Name)
wobin@0 203 Settings:AddFollowing(Name)
wobin@0 204 View:NotifyOfNewFollowing(Name)
wobin@0 205 end
wobin@0 206
wobin@7 207 function Controller:AddANewSquawk(Name, Message, Source)
wobin@7 208 if not Model.Blocked[Name] then
wobin@7 209
wobin@7 210 if Source == "WHISPER" then
wobin@7 211 if Model.Requested[Name] then -- We've been approved offline!
wobin@7 212 Model:AddFollowing(Name)
wobin@7 213 end
wobin@7 214
wobin@7 215 if not Model.Following[Name] then -- If we're no longer following this person
wobin@7 216 self:SendMessageToTarget(Name, "#Unfollow|"..UnitName("player"))
wobin@7 217 return
wobin@7 218 end
wobin@7 219
wobin@7 220 table.insert(Model.Squawks, Squawk:new(Message, Name))
wobin@7 221 View:UpdateSquawkList()
wobin@7 222 end
wobin@0 223 end
wobin@0 224
wobin@2 225 function Controller:SendNewSquawk(Message)
wobin@2 226 if not Model:IsPrivate() then
wobin@2 227 self:SendMessageToGuild("#Squawk|"..UnitName("player").."|"..Message)
wobin@2 228 end
wobin@2 229
wobin@2 230 self:AddANewSquawk(UnitName("player"), Message)
wobin@2 231
wobin@2 232 for name, _ in pairs(Model.Following) do
wobin@2 233 self:SendMessageToTarget(name, "#Squawk|"..UnitName("player").."|"..Message)
wobin@2 234 end
wobin@2 235 end
wobin@2 236
wobin@1 237 function Controller:ImPending(Name)
wobin@1 238 View:NotifyOfPending(Name)
wobin@1 239 end
wobin@1 240
wobin@7 241 function Controller:PutForwardFollowRequest(Name)
wobin@7 242 View:NotifyOfPendingRequest(Name)
wobin@7 243 end
wobin@7 244
wobin@0 245 function Controller:SendMessageToTarget(Name, Message)
wobin@0 246 self:SendCommMessage("Squawk", Message, "WHISPER", Name, "BULK")
wobin@0 247 end
wobin@0 248
wobin@0 249 function Controller:SendMessageToGuild(Message)
wobin@0 250 self:SendCommMessage("Squawk", Message, "GUILD")
wobin@0 251 end
wobin@0 252
wobin@0 253 local Parse = {
wobin@1 254 ["#Pending"] = Controller.ImPending,
wobin@1 255 ["#Follow"] = Controller.IAmNowFollowingThem,
wobin@7 256 ["#Unfollow"] = Controller.TheyWantToUnfollowMe,
wobin@2 257 ["#Squawk"] = Controller.AddANewSquawk,
wobin@2 258 ["#Request"] = Controller.TheyWantToFollowMe,
wobin@0 259 }
wobin@0 260
wobin@0 261 function Controller:ReceiveMessage(Prefix, Message, Distribution, Sender)
wobin@0 262 local command, name, info = strsplit("|",Message)
wobin@7 263 Parse[command](self, name, info, Distribution)
wobin@0 264 end
wobin@0 265 -- View --
wobin@0 266
wobin@0 267 function View:UpdateSquawkList()
wobin@3 268 self:Print("Updated Squawk List")
wobin@4 269 self:ShowMeMySquawks()
wobin@0 270 end
wobin@0 271
wobin@3 272 function View:NotifyOfPending(Name)
wobin@3 273 self:Print(Name.." will have to approve your request")
wobin@0 274 end
wobin@0 275
wobin@7 276 function View:NotifyOfPendingRequest(Name)
wobin@7 277 self:Print(Name.." wants to follow you.")
wobin@7 278 end
wobin@7 279
wobin@0 280 function View:NotifyOfNewFollowing(Name)
wobin@3 281 self:Print("You are now following "..Name)
wobin@0 282 end
wobin@0 283
wobin@7 284 function View:NotifyOfUnfollowing(Name)
wobin@7 285 self:Print("You are no longer following "..Name)
wobin@7 286 end
wobin@7 287
wobin@0 288 function View:NotifyOfNewFollower(Name)
wobin@3 289 self:Print(Name.." is now following you")
wobin@0 290 end
wobin@4 291
wobin@4 292 function View:ShowMeMySquawks()
wobin@5 293 for _,squawk in ipairs(Model.Squawks) do
wobin@4 294 self:Print(squawk.Message)
wobin@4 295 end
wobin@4 296 end
wobin@4 297
wobin@4 298 function View:ShowMeMyFollowers()
wobin@4 299 self:Print("My followers are:")
wobin@4 300 for name,_ in pairs(Settings.Follower) do
wobin@4 301 self:Print(name)
wobin@4 302 end
wobin@4 303 end
wobin@4 304
wobin@4 305 function View:ShowMeWhoImFollowing()
wobin@4 306 self:Print("I am following:")
wobin@4 307 for name,_ in pairs(Settings.Following) do
wobin@4 308 self:Print(name)
wobin@4 309 end
wobin@4 310 end
wobin@4 311
wobin@4 312 function View:ShowMeWhoIveBlocked()
wobin@4 313 self:Print("I've blocked:")
wobin@6 314 for name,_ in pairs(Settings.Blocked) do
wobin@4 315 self:Print(name)
wobin@4 316 end
wobin@4 317 end