Mercurial > wow > mailopener

annotate Core.lua @ 5:1ba07a64bf14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added a ?FailSafe? module which will safe you from mail failing to open. The opening of a single mail may get stuck when other things occur such as mail being send at the exact same time. This module will continue with the next mail after a set timeout (default set to 20 seconds).
author Zerotorescue
date Tue, 07 Sep 2010 20:57:49 +0200
parents c6f0976069c7
children f10c8a083d2a
rev   line source
Zerotorescue@3 1 -- You can access this addon's object through: LibStub("AceAddon-3.0"):GetAddon("MailOpener")
Zerotorescue@3 2 local MailOpener = LibStub("AceAddon-3.0"):NewAddon("MailOpener", "AceEvent-3.0", "AceTimer-3.0");
Zerotorescue@0 3
Zerotorescue@3 4 -- You can check if MailOpener is busy with LibStub("AceAddon-3.0"):GetAddon("MailOpener").busy (true or false/nil)
Zerotorescue@3 5
Zerotorescue@3 6 local AutoOpenMail, MailOpenerConfig, lastAmount, lastQuickAuctionsStatus, freshList, mailboxEmptySoundPlayed;
Zerotorescue@0 7
Zerotorescue@0 8 function MailOpener:OnInitialize()
Zerotorescue@0 9 local defaults = {
Zerotorescue@0 10 global = {
Zerotorescue@0 11 uses = 0;
Zerotorescue@0 12 },
Zerotorescue@0 13 profile = {
Zerotorescue@0 14 general = {
Zerotorescue@0 15 defaultStatus = "_enabled",
Zerotorescue@0 16 defaultQAStatus = "__remember",
Zerotorescue@0 17 continueOpeningStackableItems = false,
Zerotorescue@0 18 autoDisableQAAutoMail = true,
Zerotorescue@0 19 autoReenableQAAutoMail = false,
Zerotorescue@0 20 autoSetBackQAAutoMail = true,
Zerotorescue@0 21 continueOpening = false,
Zerotorescue@0 22 waitTime = 5,
Zerotorescue@0 23 initialDelay = 0.5,
Zerotorescue@0 24 },
Zerotorescue@0 25 modules = {
Zerotorescue@0 26 Collected = true,
Zerotorescue@5 27 FailSafe = true,
Zerotorescue@0 28 },
Zerotorescue@0 29 notifications = {
Zerotorescue@3 30 welcome = false,
Zerotorescue@3 31 bye = false,
Zerotorescue@0 32 finishedCurrentBatch = true,
Zerotorescue@0 33 mailboxIsEmpty = true,
Zerotorescue@0 34
Zerotorescue@0 35 skipped = {
Zerotorescue@0 36 all = true,
Zerotorescue@0 37 inventoryFull = true,
Zerotorescue@0 38 keepFreeSpaceLimit = true,
Zerotorescue@0 39 GMMail = true,
Zerotorescue@0 40 COD = true,
Zerotorescue@0 41 normalGoldMail = true,
Zerotorescue@0 42 normalItemsMail = true,
Zerotorescue@0 43 AHexpired = true,
Zerotorescue@0 44 AHsuccess = true,
Zerotorescue@0 45 AHwon = true,
Zerotorescue@0 46 AHcanceled = true,
Zerotorescue@0 47 AHoutbid = true,
Zerotorescue@0 48 other = true,
Zerotorescue@0 49 },
Zerotorescue@0 50 processed = {
Zerotorescue@0 51 all = true,
Zerotorescue@0 52 normalGoldMail = true,
Zerotorescue@0 53 normalItemsMail = true,
Zerotorescue@0 54 AHexpired = true,
Zerotorescue@0 55 AHsuccess = true,
Zerotorescue@0 56 AHwon = true,
Zerotorescue@0 57 AHcanceled = true,
Zerotorescue@0 58 AHoutbid = true,
Zerotorescue@0 59 other = true,
Zerotorescue@0 60 },
Zerotorescue@0 61
Zerotorescue@0 62 bagsFullSound = false,
Zerotorescue@0 63 bagsFullSoundFile = "Sound\\Spells\\SimonGame_Visual_BadPress.wav",
Zerotorescue@0 64 bagsFullSoundFileName = "Simon Error",
Zerotorescue@0 65 bagsFullSoundOnlyOnce = true,
Zerotorescue@0 66 mailboxEmptySound = false,
Zerotorescue@0 67 mailboxEmptySoundFile = "Sound\\Spells\\SimonGame_Visual_GameStart.wav",
Zerotorescue@0 68 mailboxEmptySoundFileName = "Simon Start",
Zerotorescue@0 69 mailboxEmptySoundOnlyOnce = true,
Zerotorescue@0 70 },
Zerotorescue@0 71 },
Zerotorescue@0 72 };
Zerotorescue@0 73
Zerotorescue@0 74 -- Register our saved variables database
Zerotorescue@0 75 self.db = LibStub("AceDB-3.0"):New("MailOpenerDB", defaults, true);
Zerotorescue@0 76
Zerotorescue@0 77 -- Set these as object variables so we can use them in our modules
Zerotorescue@0 78 if select(6, GetAddOnInfo("Postal")) == nil then
Zerotorescue@0 79 self.PostalEnabled = true;
Zerotorescue@0 80
Zerotorescue@0 81 -- Ensure this addon is loaded if AddonLoader is installed
Zerotorescue@0 82 if AddonLoader and AddonLoader.LoadAddOn and not Postal then
Zerotorescue@0 83 AddonLoader:LoadAddOn("Postal");
Zerotorescue@0 84 end
Zerotorescue@0 85 end
Zerotorescue@0 86
Zerotorescue@0 87 if select(6, GetAddOnInfo("QuickAuctions")) == nil then
Zerotorescue@0 88 self.QuickAuctionsEnabled = true;
Zerotorescue@0 89
Zerotorescue@0 90 -- Ensure this addon is loaded if AddonLoader is installed
Zerotorescue@0 91 if AddonLoader and AddonLoader.LoadAddOn then
Zerotorescue@0 92 AddonLoader:LoadAddOn("QuickAuctions");
Zerotorescue@0 93 end
Zerotorescue@0 94 end
Zerotorescue@0 95
Zerotorescue@0 96 -- Don't enable the config module until we need it
Zerotorescue@0 97 for name, module in self:IterateModules() do
Zerotorescue@0 98 if name == "Config" then
Zerotorescue@0 99 module:SetEnabledState(false);
Zerotorescue@0 100 elseif self.db.profile.modules[name] ~= nil then
Zerotorescue@0 101 if self.db.profile.modules[name] then
Zerotorescue@0 102 self:Debug("|cff00ff00Enabling|r module: " .. name);
Zerotorescue@0 103 else
Zerotorescue@0 104 self:Debug("|cffff0000Disabling|r module: " .. name);
Zerotorescue@0 105 end
Zerotorescue@0 106
Zerotorescue@0 107 module:SetEnabledState(self.db.profile.modules[name]);
Zerotorescue@0 108 end
Zerotorescue@0 109 end
Zerotorescue@0 110
Zerotorescue@0 111 -- Make the open all checkbox
Zerotorescue@0 112 local check = CreateFrame("CheckButton", "cbMailOpenerEnable", MailFrame, "ChatConfigCheckButtonTemplate");
Zerotorescue@0 113 check:SetHeight(26);
Zerotorescue@0 114 check:SetWidth(26);
Zerotorescue@3 115 check:SetChecked(true);
Zerotorescue@0 116 check:SetHitRectInsets(0, -80, 0, 0);
Zerotorescue@0 117 check:SetScript("OnClick", function(self)
Zerotorescue@3 118 if IsShiftKeyDown() then
Zerotorescue@3 119 -- Shift key = toggle addon on or off, since addon is already on there's only one option
Zerotorescue@3 120
Zerotorescue@3 121 if not MailOpener:IsEnabled() then
Zerotorescue@3 122 print("|cff15ff00Mail Opener|r: Shift key was held down, so |cff00ff00enabling|r the entire addon as well as automatic opening of mail.");
Zerotorescue@3 123
Zerotorescue@3 124 MailOpener:Enable();
Zerotorescue@3 125
Zerotorescue@3 126 -- The above calls MAIL_SHOW which changes AutoOpenMail, so we can't remember the old setting
Zerotorescue@3 127 AutoOpenMail = true;
Zerotorescue@3 128
Zerotorescue@3 129 self:SetChecked(true);
Zerotorescue@3 130 else
Zerotorescue@3 131 print("|cff15ff00Mail Opener|r: Shift key was held down, so |cffff0000disabling|r the entire addon.");
Zerotorescue@3 132
Zerotorescue@3 133 MailOpener:Disable();
Zerotorescue@3 134
Zerotorescue@3 135 self:SetChecked(false);
Zerotorescue@3 136 end
Zerotorescue@0 137 else
Zerotorescue@3 138 -- Normal click
Zerotorescue@3 139
Zerotorescue@3 140 if self:GetChecked() then
Zerotorescue@3 141 print("|cff15ff00Mail Opener|r: |cff00ff00Enabling|r automatic opening of mail.");
Zerotorescue@3 142
Zerotorescue@3 143 AutoOpenMail = true;
Zerotorescue@3 144 else
Zerotorescue@3 145 print("|cff15ff00Mail Opener|r: |cffff0000Disabling|r automatic opening of mail.");
Zerotorescue@3 146
Zerotorescue@3 147 AutoOpenMail = false;
Zerotorescue@3 148 end
Zerotorescue@0 149 end
Zerotorescue@0 150 end);
Zerotorescue@3 151 check.tooltip = "Toggle automatic mail opening on or off (you can force this by holding shift when opening the mailbox.\n\nHold the |cffffffffSHIFT|r key to disable the entire addon.";
Zerotorescue@0 152 check:SetPoint("TOPLEFT", MailFrame, "TOPLEFT", 68, -13)
Zerotorescue@0 153
Zerotorescue@0 154 if self.QuickAuctionsEnabled then
Zerotorescue@0 155 -- QA is enabled so move the checkbox further to the right
Zerotorescue@0 156
Zerotorescue@0 157 check:SetPoint("TOPLEFT", MailFrame, "TOPLEFT", 155, -13);
Zerotorescue@0 158 end
Zerotorescue@0 159
Zerotorescue@0 160 -- Get reference to the text field
Zerotorescue@0 161 local checkboxText = _G[check:GetName() .. "Text"];
Zerotorescue@0 162 checkboxText:SetText("Mail Opener");
Zerotorescue@0 163 -- We like this color more
Zerotorescue@0 164 checkboxText:SetTextColor(1, 0.8, 0, 1);
Zerotorescue@0 165
Zerotorescue@0 166 self.cbOpenAll = check;
Zerotorescue@0 167
Zerotorescue@0 168 -- Make the config button
Zerotorescue@0 169 local button = CreateFrame("Button", "btnMailOpenerConfig", MailFrame, "UIPanelButtonTemplate")
Zerotorescue@0 170 button:SetText("Config")
Zerotorescue@0 171 button:SetHeight(23)
Zerotorescue@0 172 button:SetWidth(55)
Zerotorescue@0 173 if self.PostalEnabled then
Zerotorescue@0 174 button:SetPoint("TOPRIGHT", MailFrame, "TOPRIGHT", -75, -13);
Zerotorescue@0 175 else
Zerotorescue@0 176 button:SetPoint("TOPRIGHT", MailFrame, "TOPRIGHT", -55, -13);
Zerotorescue@0 177 end
Zerotorescue@0 178 button:SetScript("OnClick", function()
Zerotorescue@0 179 MailOpener:EnableConfigModule();
Zerotorescue@0 180
Zerotorescue@0 181 MailOpenerConfig:Show();
Zerotorescue@0 182
Zerotorescue@0 183 if MailOpener.db.global.uses >= 15 then
Zerotorescue@0 184 MailOpener:ShowBetaPopup();
Zerotorescue@0 185 end
Zerotorescue@0 186 end);
Zerotorescue@0 187
Zerotorescue@0 188 self.btnConfig = button;
Zerotorescue@0 189
Zerotorescue@0 190 -- Disable the AddonLoader slash commands
Zerotorescue@0 191 SLASH_MO1 = nil;
Zerotorescue@0 192 SLASH_MAILOPEN1 = nil;
Zerotorescue@0 193 SLASH_MAILOPENER1 = nil;
Zerotorescue@0 194
Zerotorescue@0 195 -- Register our own slash commands
Zerotorescue@0 196 SLASH_MAILOPENER1 = "/mo";
Zerotorescue@0 197 SLASH_MAILOPENER2 = "/mailopen";
Zerotorescue@0 198 SLASH_MAILOPENER3 = "/mailopener";
Zerotorescue@0 199 SlashCmdList["MAILOPENER"] = function(msg)
Zerotorescue@0 200 MailOpener:EnableConfigModule();
Zerotorescue@0 201
Zerotorescue@0 202 MailOpenerConfig:CommandHandler(msg);
Zerotorescue@0 203 end
Zerotorescue@0 204
Zerotorescue@0 205 -- Attempt to remove the interface options added by AddonLoader (if enabled)
Zerotorescue@0 206 if AddonLoader and AddonLoader.RemoveInterfaceOptions then
Zerotorescue@0 207 AddonLoader:RemoveInterfaceOptions("Mail Opener");
Zerotorescue@0 208 end
Zerotorescue@0 209
Zerotorescue@0 210 -- Now create our own options frame
Zerotorescue@0 211 local frame = CreateFrame("Frame", nil, UIParent);
Zerotorescue@0 212 frame:Hide();
Zerotorescue@0 213 frame.name = "Mail Opener";
Zerotorescue@0 214 frame:HookScript("OnShow", function(self)
Zerotorescue@0 215 -- Enable the config module
Zerotorescue@0 216 MailOpener:EnableConfigModule();
Zerotorescue@0 217
Zerotorescue@0 218 -- Load the options and add it to the blizzard interface list
Zerotorescue@0 219 MailOpenerConfig:Load();
Zerotorescue@0 220
Zerotorescue@0 221 -- Refresh the frame to instantly show the right options
Zerotorescue@0 222 InterfaceOptionsFrame_OpenToCategory(self.name)
Zerotorescue@0 223 end);
Zerotorescue@0 224 -- And add it to the interface options
Zerotorescue@0 225 InterfaceOptions_AddCategory(frame);
Zerotorescue@0 226 end
Zerotorescue@0 227
Zerotorescue@0 228 function MailOpener:OnEnable()
Zerotorescue@0 229 self:RegisterEvent("MAIL_SHOW");
Zerotorescue@0 230 self:RegisterEvent("PLAYER_ENTERING_WORLD");
Zerotorescue@0 231
Zerotorescue@0 232 self.btnConfig:Show();
Zerotorescue@0 233
Zerotorescue@0 234 -- Reset variables
Zerotorescue@0 235 lastAmount = 0;
Zerotorescue@0 236 self.debugChannel = nil;
Zerotorescue@0 237
Zerotorescue@0 238 self.db.global.uses = ( self.db.global.uses + 1 );
Zerotorescue@0 239
Zerotorescue@0 240 if self.db.global.uses == 15 then
Zerotorescue@0 241 self:ShowBetaPopup();
Zerotorescue@0 242 end
Zerotorescue@0 243
Zerotorescue@0 244 -- If we were toggling this addon on while the mailbox is opened we must register all events again
Zerotorescue@0 245 if MailFrame:IsVisible() then
Zerotorescue@0 246 self:MAIL_SHOW();
Zerotorescue@0 247 end
Zerotorescue@0 248 end
Zerotorescue@0 249
Zerotorescue@0 250 function MailOpener:OnDisable()
Zerotorescue@0 251 self:UnregisterEvent("MAIL_SHOW");
Zerotorescue@0 252
Zerotorescue@0 253 self.btnConfig:Hide();
Zerotorescue@0 254
Zerotorescue@0 255 MailOpener:Stop();
Zerotorescue@0 256 end
Zerotorescue@0 257
Zerotorescue@0 258 -- We must disable Quick Auction's auto mail (if set up that way in the settings) before opening the mailbox or it will instantly start sending stuff
Zerotorescue@0 259 function MailOpener:PLAYER_ENTERING_WORLD()
Zerotorescue@0 260 self:UnregisterEvent("PLAYER_ENTERING_WORLD");
Zerotorescue@0 261
Zerotorescue@0 262 self:ToggleQAStatus();
Zerotorescue@0 263 end
Zerotorescue@0 264
Zerotorescue@0 265 -- Fired when the mailbox is opened
Zerotorescue@0 266 function MailOpener:MAIL_SHOW()
Zerotorescue@0 267 -- To stop the timer when the mailbox is closed
Zerotorescue@0 268 self:RegisterEvent("MAIL_CLOSED", "Stop");
Zerotorescue@0 269 self:RegisterEvent("PLAYER_LEAVING_WORLD", "Stop");
Zerotorescue@0 270
Zerotorescue@0 271 -- To set the timer for when to refresh again
Zerotorescue@0 272 self:RegisterEvent("MAIL_INBOX_UPDATE");
Zerotorescue@0 273
Zerotorescue@0 274 -- We need to know when opening has completed
Zerotorescue@0 275 self:RegisterMessage("MO_OPEN_COMPLETE");
Zerotorescue@0 276
Zerotorescue@0 277 self:Debug("defaultStatus:" .. self.db.profile.general.defaultStatus);
Zerotorescue@0 278 -- Change the mail opening status according to our settings
Zerotorescue@0 279 if self.db.profile.general.defaultStatus == "_enabled" then
Zerotorescue@3 280 AutoOpenMail = true;
Zerotorescue@3 281 self.cbOpenAll:SetChecked(true);
Zerotorescue@3 282 elseif self.db.profile.general.defaultStatus == "disabled" then
Zerotorescue@3 283 -- Disable auto opening but leave mail opener enabled
Zerotorescue@3 284
Zerotorescue@3 285 AutoOpenMail = false;
Zerotorescue@3 286 self.cbOpenAll:SetChecked(false);
Zerotorescue@3 287 elseif self.db.profile.general.defaultStatus == "xdisabled" then
Zerotorescue@3 288 -- Disable entire addon
Zerotorescue@3 289
Zerotorescue@3 290 MailOpener:Disable();
Zerotorescue@3 291 self.cbOpenAll:SetChecked(false);
Zerotorescue@0 292 end
Zerotorescue@0 293
Zerotorescue@0 294 self:ToggleQAStatus();
Zerotorescue@0 295
Zerotorescue@0 296 -- Hide the InboxTooMuchMail warning to allow room for our mail remaining info line
Zerotorescue@0 297 InboxTooMuchMail:Hide()
Zerotorescue@0 298 InboxTooMuchMail.Show = function() end
Zerotorescue@0 299
Zerotorescue@0 300 if self.QuickAuctionsEnabled then
Zerotorescue@3 301 local QAMail = LibStub("AceAddon-3.0"):GetAddon("QuickAuctions"):GetModule("Mail");
Zerotorescue@0 302
Zerotorescue@3 303 -- Hide the open all button
Zerotorescue@3 304 QAMail.massOpening:Hide();
Zerotorescue@3 305 -- Hide the x mail remaining text
Zerotorescue@3 306 QAMail.totalMail:Hide();
Zerotorescue@0 307 end
Zerotorescue@0 308
Zerotorescue@0 309 if self.db.profile.notifications.welcome then
Zerotorescue@0 310 -- Welcome notification
Zerotorescue@0 311 local _, c = UnitClass("player");
Zerotorescue@0 312 c = RAID_CLASS_COLORS[c];
Zerotorescue@0 313 c = string.format("|cff%02x%02x%02x", c.r * 255 + 0.5, c.g * 255 + 0.5, c.b * 255 + 0.5);
Zerotorescue@0 314
Zerotorescue@0 315 print("|cff15ff00Mail Opener|r: Welcome back "..c..UnitName("player").."|r. Requesting new mail from the local Postal Service, your mail will automatically be opened when it becomes available.");
Zerotorescue@0 316 end
Zerotorescue@0 317
Zerotorescue@0 318 mailboxEmptySoundPlayed = nil;
Zerotorescue@0 319
Zerotorescue@0 320 self:Recheck();
Zerotorescue@0 321
Zerotorescue@0 322 if self.db.profile.general.continueOpening then
Zerotorescue@0 323 self:ScheduleOpen(true);
Zerotorescue@0 324 end
Zerotorescue@0 325 end
Zerotorescue@0 326
Zerotorescue@0 327 -- Fired after a successful server sync
Zerotorescue@0 328 -- Fired when mail is deleted (which happens after taking all attachments from a mail sent by the game)
Zerotorescue@0 329 function MailOpener:MAIL_INBOX_UPDATE()
Zerotorescue@0 330 local current, total = GetInboxNumItems();
Zerotorescue@0 331
Zerotorescue@3 332 -- Calculate the amount of mail waiting that actually have attachments
Zerotorescue@3 333 -- If we just compare numbers we won't be including mail that isn't automatically deleted when opened, such as mail with attachments sent by other players
Zerotorescue@3 334 local currentMailWithAttachments = 0;
Zerotorescue@3 335 for i = 1, current do
Zerotorescue@3 336 local _, _, _, _, money, _, _, items = GetInboxHeaderInfo(i);
Zerotorescue@3 337
Zerotorescue@3 338 if (items and items > 0) or (money and money > 0) then
Zerotorescue@3 339 currentMailWithAttachments = currentMailWithAttachments + 1;
Zerotorescue@3 340 end
Zerotorescue@0 341 end
Zerotorescue@0 342
Zerotorescue@3 343 local tempLastAmount = lastAmount;
Zerotorescue@3 344 lastAmount = currentMailWithAttachments;
Zerotorescue@3 345
Zerotorescue@3 346 if currentMailWithAttachments ~= tempLastAmount then
Zerotorescue@3 347 self:Debug("MAIL_INBOX_UPDATE - lastAmount:" .. tempLastAmount .. " - current:" .. currentMailWithAttachments);
Zerotorescue@3 348 end
Zerotorescue@3 349
Zerotorescue@3 350 if currentMailWithAttachments > tempLastAmount then
Zerotorescue@0 351 -- New messages arrived in our mailbox, so this was a refresh, so set a timer
Zerotorescue@0 352
Zerotorescue@3 353 self:Debug("MO_SERVER_SYNCED");
Zerotorescue@3 354
Zerotorescue@0 355 -- Yell that we successfully synced with the server
Zerotorescue@0 356 self:SendMessage("MO_SERVER_SYNCED");
Zerotorescue@0 357
Zerotorescue@0 358 -- This list is fresh
Zerotorescue@0 359 freshList = true;
Zerotorescue@0 360 mailboxEmptySoundPlayed = nil;
Zerotorescue@0 361
Zerotorescue@0 362 -- Stop previous timer
Zerotorescue@0 363 self:CancelTimer(self.tmrRecheck, true);
Zerotorescue@0 364 -- More will arrive in 60 seconds
Zerotorescue@0 365 self.tmrRecheck = self:ScheduleTimer(function()
Zerotorescue@0 366 self:Debug("tmrRecheck 61 finished");
Zerotorescue@0 367
Zerotorescue@0 368 -- We can get a fresh list now, so query the server
Zerotorescue@0 369 freshList = false;
Zerotorescue@0 370
Zerotorescue@0 371 -- Look for mail
Zerotorescue@0 372 self:Recheck();
Zerotorescue@0 373 end, 61);
Zerotorescue@0 374 self:Debug("tmrRecheck 61");
Zerotorescue@0 375
Zerotorescue@0 376 if not IsShiftKeyDown() then
Zerotorescue@0 377 -- Allow overriding of mailopening with the shift key
Zerotorescue@0 378
Zerotorescue@0 379 -- Open the current mail
Zerotorescue@0 380 self:ScheduleOpen(false);
Zerotorescue@0 381 end
Zerotorescue@3 382 elseif currentMailWithAttachments < tempLastAmount then
Zerotorescue@2 383 -- We lost a mail
Zerotorescue@2 384
Zerotorescue@3 385 -- TODO: NYI: May need to delay this until the mail is actually deleted
Zerotorescue@3 386
Zerotorescue@3 387 self:Debug("MO_MAIL_EMPTIED");
Zerotorescue@3 388
Zerotorescue@2 389 -- Yell that we successfully opened/removed a mail
Zerotorescue@3 390 self:SendMessage("MO_MAIL_EMPTIED");
Zerotorescue@3 391 elseif (currentMailWithAttachments == 50 and tempLastAmount == 50) then
Zerotorescue@0 392 if not IsShiftKeyDown() then
Zerotorescue@0 393 -- Allow overriding of mailopening with the shift key
Zerotorescue@0 394
Zerotorescue@0 395 -- Open the current mail
Zerotorescue@0 396 self:ScheduleOpen(false);
Zerotorescue@0 397 end
Zerotorescue@0 398 end
Zerotorescue@0 399 end
Zerotorescue@0 400
Zerotorescue@0 401 function MailOpener:ScheduleOpen(continued)
Zerotorescue@0 402 if lastAmount > 0 then
Zerotorescue@0 403 local waitTime;
Zerotorescue@0 404 if continued then
Zerotorescue@0 405 waitTime = self.db.profile.general.waitTime;
Zerotorescue@0 406 else
Zerotorescue@0 407 -- Even though this is not a continuation and should be instant, we set a .5 second timer to prevent multiple calls of the OpenNow function
Zerotorescue@0 408 waitTime = self.db.profile.general.initialDelay;
Zerotorescue@0 409 end
Zerotorescue@0 410
Zerotorescue@0 411 -- Stop previous timer
Zerotorescue@0 412 self:CancelTimer(self.tmrOpenNow, true);
Zerotorescue@0 413 -- Schedule the next open
Zerotorescue@0 414 self.tmrOpenNow = self:ScheduleTimer("OpenNow", waitTime);
Zerotorescue@0 415 end
Zerotorescue@0 416 end
Zerotorescue@0 417
Zerotorescue@0 418 function MailOpener:OpenNow()
Zerotorescue@3 419 self:Debug("OpenNow (" .. ((self.busy and "1") or "0") .. ")");
Zerotorescue@3 420 if not self.busy and MailFrame:IsVisible() and AutoOpenMail then
Zerotorescue@0 421 self:Debug("OpenNow");
Zerotorescue@0 422
Zerotorescue@0 423 -- BeanCounter is the only addon hiding the mail close button while busy, so we can look for that
Zerotorescue@0 424 local BeanCounterActive = not InboxCloseButton:IsVisible();
Zerotorescue@0 425
Zerotorescue@0 426 if not BeanCounterActive then
Zerotorescue@0 427 -- BeanCounter is INACTIVE
Zerotorescue@0 428
Zerotorescue@0 429 self:CancelTimer(self.tmrTryAgain, true); -- Insurance
Zerotorescue@0 430
Zerotorescue@0 431 if QuickAuctionsAutoMail then
Zerotorescue@0 432 -- Remember the last known quick auctions status
Zerotorescue@0 433 lastQuickAuctionsStatus = QuickAuctionsAutoMail:GetChecked();
Zerotorescue@0 434 end
Zerotorescue@0 435 if self.db.profile.general.autoDisableQAAutoMail and self.QuickAuctionsEnabled and QuickAuctionsAutoMail and QuickAuctionsAutoMail:GetChecked() then
Zerotorescue@0 436 -- If auto disable "QA Auto mail" is enabled and QA's auto mail is currently toggled on, turn it off
Zerotorescue@0 437 -- We need to do this with a :click to trigger the right events
Zerotorescue@0 438
Zerotorescue@0 439 self:Debug("Turning automail |cffff0000off|r.");
Zerotorescue@0 440
Zerotorescue@0 441 QuickAuctionsAutoMail:Click();
Zerotorescue@0 442 end
Zerotorescue@0 443
Zerotorescue@3 444 self.busy = true;
Zerotorescue@0 445
Zerotorescue@0 446 self:Debug("MO_OPEN_MAIL");
Zerotorescue@0 447
Zerotorescue@0 448 -- Summon the mail opening gods
Zerotorescue@0 449 self:SendMessage("MO_OPEN_MAIL");
Zerotorescue@0 450 else
Zerotorescue@0 451 -- BeanCounter is ACTIVE
Zerotorescue@0 452 self:Debug("BeanCounter active, waiting .5 seconds...");
Zerotorescue@0 453
Zerotorescue@0 454 self:CancelTimer(self.tmrTryAgain, true); -- Insurance
Zerotorescue@0 455 -- Wait with summoning until BeanCounter is done, try again every 0.5 seconds
Zerotorescue@0 456 self.tmrTryAgain = self:ScheduleTimer("OpenNow", 0.5);
Zerotorescue@0 457 end
Zerotorescue@0 458 end
Zerotorescue@0 459 end
Zerotorescue@0 460
Zerotorescue@0 461 function MailOpener:MO_OPEN_COMPLETE()
Zerotorescue@3 462 self.busy = false;
Zerotorescue@1 463
Zerotorescue@1 464 -- Try a recheck
Zerotorescue@1 465 self:Recheck();
Zerotorescue@1 466
Zerotorescue@0 467 local current, total = GetInboxNumItems();
Zerotorescue@0 468
Zerotorescue@0 469 if (total - current) == 0 then
Zerotorescue@3 470 -- There is probably no unopenable mail remaining, so play the sound (if enabled)
Zerotorescue@3 471
Zerotorescue@0 472 if self.db.profile.notifications.mailboxEmptySound and (not MailOpener.db.profile.notifications.mailboxEmptySoundOnlyOnce or not mailboxEmptySoundPlayed) then
Zerotorescue@0 473 PlaySoundFile(self.db.profile.notifications.mailboxEmptySoundFile);
Zerotorescue@0 474 mailboxEmptySoundPlayed = true;
Zerotorescue@0 475 end
Zerotorescue@0 476 end
Zerotorescue@0 477
Zerotorescue@3 478 if self.QuickAuctionsEnabled then
Zerotorescue@3 479 -- Quick Auctions enabled?
Zerotorescue@3 480 -- Toggle automailing as per settings
Zerotorescue@0 481
Zerotorescue@3 482 if self.db.profile.general.autoReenableQAAutoMail and QuickAuctionsAutoMail and not QuickAuctionsAutoMail:GetChecked() then
Zerotorescue@3 483 -- If auto re-enable "QA Auto mail" is enabled and QA's auto mail is currently toggled OFF, turn it on
Zerotorescue@3 484 -- We need to do this with a :click to trigger the right events
Zerotorescue@3 485
Zerotorescue@0 486 self:Debug("Turning automail |cff00ff00on|r.");
Zerotorescue@3 487
Zerotorescue@3 488 QuickAuctionsAutoMail:Click();
Zerotorescue@3 489 elseif self.db.profile.general.autoSetBackQAAutoMail and QuickAuctionsAutoMail and lastQuickAuctionsStatus ~= QuickAuctionsAutoMail:GetChecked() then
Zerotorescue@3 490 -- If auto set back "QA Auto mail" is enabled and QA's auto mail is currently not the same as it was before starting, toggle it
Zerotorescue@3 491 -- We need to do this with a :click to trigger the right events
Zerotorescue@3 492
Zerotorescue@3 493 if lastQuickAuctionsStatus then
Zerotorescue@3 494 self:Debug("Turning automail |cff00ff00on|r.");
Zerotorescue@3 495 else
Zerotorescue@3 496 self:Debug("Turning automail |cffff0000off|r.");
Zerotorescue@3 497 end
Zerotorescue@3 498
Zerotorescue@3 499 QuickAuctionsAutoMail:Click();
Zerotorescue@0 500 end
Zerotorescue@0 501 end
Zerotorescue@0 502
Zerotorescue@0 503 if self.db.profile.general.continueOpening then
Zerotorescue@0 504 self:ScheduleOpen(true);
Zerotorescue@0 505 end
Zerotorescue@0 506 end
Zerotorescue@0 507
Zerotorescue@0 508 -- Run another CheckInbox
Zerotorescue@0 509 function MailOpener:Recheck()
Zerotorescue@0 510 self:Debug("|cffffff00Recheck|r");
Zerotorescue@0 511
Zerotorescue@0 512 -- Freshlist prevents this from being run too often
Zerotorescue@0 513 -- It is set to true after a server sync
Zerotorescue@0 514 -- and set to false 61 seconds afterwards with a recheck called instantly after it
Zerotorescue@3 515
Zerotorescue@3 516 -- We're not refreshing while we're opening because it is automatically done when current batch was completely opened
Zerotorescue@3 517 if not freshList and not self.busy and MailFrame:IsVisible() then
Zerotorescue@0 518 self:Debug("|cff00ff00Recheck|r");
Zerotorescue@0 519
Zerotorescue@0 520 -- If this isn't a fresh list (so messages weren't received within the last 60 seconds) and the mailbox wasn't closed
Zerotorescue@0 521
Zerotorescue@0 522 -- BeanCounter is the only addon hiding the mail close button while busy, so we can look for that
Zerotorescue@0 523 local BeanCounterActive = not InboxCloseButton:IsVisible();
Zerotorescue@0 524
Zerotorescue@3 525 if not BeanCounterActive and AutoOpenMail then
Zerotorescue@0 526 -- Query the server
Zerotorescue@0 527 CheckInbox();
Zerotorescue@0 528 end
Zerotorescue@0 529
Zerotorescue@0 530 -- Stop previous timer
Zerotorescue@0 531 self:CancelTimer(self.tmrRecheck, true);
Zerotorescue@0 532 -- Keep trying until it works
Zerotorescue@0 533 self.tmrRecheck = self:ScheduleTimer("Recheck", 2);
Zerotorescue@0 534
Zerotorescue@0 535 self:Debug("tmrRecheck 2");
Zerotorescue@0 536 end
Zerotorescue@0 537 end
Zerotorescue@0 538
Zerotorescue@0 539 -- Stop checking for new mail and unregister the events we needed
Zerotorescue@0 540 function MailOpener:Stop()
Zerotorescue@0 541 if self.db.profile.notifications.bye then
Zerotorescue@0 542 print("|cff15ff00Mail Opener|r: Have a nice day. :)");
Zerotorescue@0 543 end
Zerotorescue@0 544
Zerotorescue@3 545 self.busy = false;
Zerotorescue@0 546
Zerotorescue@0 547 -- We won't need this anymore
Zerotorescue@0 548 self:UnregisterEvent("MAIL_CLOSED");
Zerotorescue@0 549 self:UnregisterEvent("PLAYER_LEAVING_WORLD");
Zerotorescue@0 550 self:UnregisterEvent("MAIL_INBOX_UPDATE");
Zerotorescue@0 551
Zerotorescue@0 552 -- Messages
Zerotorescue@0 553 self:UnregisterMessage("MO_OPEN_COMPLETE");
Zerotorescue@0 554
Zerotorescue@0 555 -- Timers
Zerotorescue@0 556 self:CancelTimer(self.tmrTryAgain, true);
Zerotorescue@0 557 self:CancelTimer(self.tmrOpenNow, true);
Zerotorescue@0 558
Zerotorescue@0 559 -- If we wait with disabling QA automail until MAIL_SHOW, QA will beat us to it and already start sending stuff
Zerotorescue@0 560 self:ToggleQAStatus();
Zerotorescue@0 561 end
Zerotorescue@0 562
Zerotorescue@0 563 function MailOpener:Debug(t)
Zerotorescue@0 564 if not self.debugChannel and self.debugChannel ~= false then
Zerotorescue@0 565 -- We want to check just once, so if you add a debug channel later just do a /reload (registering an event for this is wasted resources)
Zerotorescue@0 566 self.debugChannel = false;
Zerotorescue@0 567
Zerotorescue@0 568 for i = 1, NUM_CHAT_WINDOWS do
Zerotorescue@0 569 local name = GetChatWindowInfo(i);
Zerotorescue@0 570
Zerotorescue@0 571 if name:upper() == "DEBUG" then
Zerotorescue@0 572 self.debugChannel = _G["ChatFrame" .. i];
Zerotorescue@0 573 end
Zerotorescue@0 574 end
Zerotorescue@0 575 end
Zerotorescue@0 576
Zerotorescue@0 577 if self.debugChannel then
Zerotorescue@0 578 self.debugChannel:AddMessage(t);
Zerotorescue@0 579 end
Zerotorescue@0 580 end
Zerotorescue@0 581
Zerotorescue@0 582 -- Enable our config module if it's disabled and make a reference to it
Zerotorescue@0 583 function MailOpener:EnableConfigModule()
Zerotorescue@0 584 if not MailOpenerConfig then
Zerotorescue@0 585 MailOpenerConfig = self:GetModule("Config");
Zerotorescue@0 586 MailOpenerConfig:Enable();
Zerotorescue@0 587 end
Zerotorescue@0 588 end
Zerotorescue@0 589
Zerotorescue@0 590 -- Toggle Postal's opening modules on or off
Zerotorescue@0 591 function MailOpener:TogglePostalModule(name, status)
Zerotorescue@0 592 if MailOpener.PostalEnabled and Postal then
Zerotorescue@0 593 -- Postal must be enabled
Zerotorescue@0 594
Zerotorescue@3 595 -- Toggle module (let Postal handle this)
Zerotorescue@3 596 Postal.ToggleModule(nil, name, Postal:GetModule(name), status);
Zerotorescue@0 597 end
Zerotorescue@0 598 end
Zerotorescue@0 599
Zerotorescue@0 600 -- Change Quick Auction's auto mail status based on our prefered settings
Zerotorescue@0 601 function MailOpener:ToggleQAStatus()
Zerotorescue@0 602 self:Debug("defaultQAStatus:" .. self.db.profile.general.defaultQAStatus);
Zerotorescue@0 603
Zerotorescue@0 604 if self.QuickAuctionsEnabled and self.db.profile.general.defaultQAStatus ~= "__remember" and QuickAuctionsAutoMail then
Zerotorescue@0 605 if self.db.profile.general.defaultQAStatus == "_enabled" and not QuickAuctionsAutoMail:GetChecked() then
Zerotorescue@0 606 self:Debug("Turning automail |cff00ff00on|r.");
Zerotorescue@0 607
Zerotorescue@0 608 QuickAuctionsAutoMail:Click();
Zerotorescue@0 609 elseif self.db.profile.general.defaultQAStatus == "disabled" and QuickAuctionsAutoMail:GetChecked() then
Zerotorescue@0 610 self:Debug("Turning automail |cffff0000off|r.");
Zerotorescue@0 611
Zerotorescue@0 612 QuickAuctionsAutoMail:Click();
Zerotorescue@0 613 end
Zerotorescue@0 614 end
Zerotorescue@0 615 end
Zerotorescue@0 616
Zerotorescue@0 617 function MailOpener:FormatMoney(copper)
Zerotorescue@0 618 local gold = floor( copper / 10000 );
Zerotorescue@0 619 local silver = floor( ( copper - ( gold * 10000 ) ) / 100 );
Zerotorescue@0 620 local copper = mod(copper, 100);
Zerotorescue@0 621
Zerotorescue@0 622 if gold > 0 then
Zerotorescue@0 623 return format(GOLD_AMOUNT_TEXTURE .. " " .. SILVER_AMOUNT_TEXTURE .. " " .. COPPER_AMOUNT_TEXTURE, gold, 0, 0, silver, 0, 0, copper, 0, 0);
Zerotorescue@0 624 elseif silver > 0 then
Zerotorescue@0 625 return format(SILVER_AMOUNT_TEXTURE .. " " .. COPPER_AMOUNT_TEXTURE, silver, 0, 0, copper, 0, 0);
Zerotorescue@0 626 else
Zerotorescue@0 627 return format(COPPER_AMOUNT_TEXTURE, copper, 0, 0);
Zerotorescue@0 628 end
Zerotorescue@0 629 end
Zerotorescue@0 630
Zerotorescue@0 631 StaticPopupDialogs["MailOpenerCopyWindow"] = {
Zerotorescue@0 632 text = "Please CTRL-C to copy.",
Zerotorescue@0 633 button2 = CLOSE,
Zerotorescue@0 634 hasEditBox = 1,
Zerotorescue@0 635 hasWideEditBox = 1,
Zerotorescue@0 636 OnShow = function()
Zerotorescue@0 637 local editBox = _G[this:GetName().."WideEditBox"];
Zerotorescue@0 638 if editBox and MailOpener.currentPopupContents then
Zerotorescue@0 639 editBox:SetText(MailOpener.currentPopupContents);
Zerotorescue@0 640 editBox:SetFocus();
Zerotorescue@0 641 editBox:HighlightText(0);
Zerotorescue@0 642 end
Zerotorescue@0 643
Zerotorescue@0 644 -- Position the close button in the middle
Zerotorescue@0 645 local button = _G[this:GetName().."Button2"];
Zerotorescue@0 646 if button then
Zerotorescue@0 647 -- Remove previous know position
Zerotorescue@0 648 button:ClearAllPoints();
Zerotorescue@0 649 button:SetWidth(200);
Zerotorescue@0 650 -- Reposition in the center
Zerotorescue@0 651 button:SetPoint("CENTER", editBox, "CENTER", 0, -30);
Zerotorescue@0 652 end
Zerotorescue@0 653 end,
Zerotorescue@0 654 EditBoxOnEscapePressed = function()
Zerotorescue@0 655 this:GetParent():Hide();
Zerotorescue@0 656 end,
Zerotorescue@0 657 timeout = 0,
Zerotorescue@0 658 whileDead = 1,
Zerotorescue@0 659 hideOnEscape = 1,
Zerotorescue@0 660 maxLetters = 1024,
Zerotorescue@1 661 };
Zerotorescue@1 662
Zerotorescue@1 663 -- The below either has to be removed or changed when releasing
Zerotorescue@0 664
Zerotorescue@0 665 function MailOpener:ShowBetaPopup()
Zerotorescue@0 666 function TableDump(key, val, jumps)
Zerotorescue@0 667 local cache = "";
Zerotorescue@0 668
Zerotorescue@0 669 if not jumps then
Zerotorescue@0 670 jumps = 0;
Zerotorescue@0 671 end
Zerotorescue@0 672
Zerotorescue@0 673 local spacer = "";
Zerotorescue@0 674 if jumps > 0 then
Zerotorescue@0 675 for i = 1, jumps do
Zerotorescue@0 676 spacer = spacer .. " ";
Zerotorescue@0 677 end
Zerotorescue@0 678 end
Zerotorescue@0 679
Zerotorescue@0 680 if type(val) == "table" then
Zerotorescue@0 681 cache = cache .. spacer .. key .. " = {\n";
Zerotorescue@0 682 foreach(val, function(k, v)
Zerotorescue@0 683 cache = cache .. TableDump(k, v, (jumps + 1));
Zerotorescue@0 684 end);
Zerotorescue@0 685 cache = cache .. spacer .. "},\n";
Zerotorescue@0 686 else
Zerotorescue@0 687 cache = cache .. spacer .. key .. " = " .. tostring(val) .. ",\n";
Zerotorescue@0 688 end
Zerotorescue@0 689
Zerotorescue@0 690 return cache;
Zerotorescue@0 691 end
Zerotorescue@0 692
Zerotorescue@0 693 local cache = "";
Zerotorescue@0 694 foreach(MailOpener.db.profile, function(k, v)
Zerotorescue@0 695 cache = cache .. TableDump(k, v, 0);
Zerotorescue@0 696 end);
Zerotorescue@0 697
Zerotorescue@0 698 local AceGUI = LibStub("AceGUI-3.0");
Zerotorescue@0 699 local frame = AceGUI:Create("Frame");
Zerotorescue@0 700 frame:SetTitle("Mail Opener ALPHA");
Zerotorescue@0 701 frame:SetWidth(575);
Zerotorescue@0 702 frame:SetHeight(375);
Zerotorescue@0 703
Zerotorescue@0 704 -- Add a normal description label
Zerotorescue@0 705 local desc = AceGUI:Create("Label");
Zerotorescue@0 706 desc:SetText("|cff00ff00After you have been using Mail Opener for a while and configured it just as you want it to be, please report your favorite settings by copying the text below at either of the below links. Thanks in advance!|r\n\n");
Zerotorescue@0 707 desc:SetFont(GameFontHighlightSmall:GetFont(), 13);
Zerotorescue@0 708 desc:SetFullWidth(true);
Zerotorescue@0 709 frame:AddChild(desc);
Zerotorescue@0 710
Zerotorescue@0 711 -- Add a MultiLineEditBox
Zerotorescue@0 712 local settingsMLEEB = AceGUI:Create("MultiLineEditBox");
Zerotorescue@0 713 settingsMLEEB:SetText(cache);
Zerotorescue@0 714 settingsMLEEB:SetLabel("Hit CTRL-A to select all and CTRL-C to copy the text. You can then use CTRL-V to paste.");
Zerotorescue@0 715 settingsMLEEB:SetFullWidth(true);
Zerotorescue@0 716 settingsMLEEB:SetNumLines(8);
Zerotorescue@0 717 settingsMLEEB:DisableButton(true);
Zerotorescue@0 718 settingsMLEEB:SetCallback("OnTextChanged", function()
Zerotorescue@0 719 settingsMLEEB:SetText(cache);
Zerotorescue@0 720 end);
Zerotorescue@0 721 frame:AddChild(settingsMLEEB);
Zerotorescue@0 722
Zerotorescue@0 723 -- Empty line between the two links
Zerotorescue@0 724 local label = AceGUI:Create("Label");
Zerotorescue@0 725 label:SetText("Please post the above text at either of these two links:");
Zerotorescue@0 726 label:SetFullWidth(true);
Zerotorescue@0 727 frame:AddChild(label);
Zerotorescue@0 728
Zerotorescue@0 729 local desc1 = AceGUI:Create("InteractiveLabel");
Zerotorescue@0 730 desc1:SetText("|cff00bbbb[http://wow.curseforge.com/addons/mailopener/create-ticket/]|r");
Zerotorescue@0 731 desc1:SetFont(GameFontHighlightSmall:GetFont(), 13);
Zerotorescue@0 732 desc1:SetFullWidth(true);
Zerotorescue@0 733 desc1:SetCallback("OnClick", function()
Zerotorescue@0 734 MailOpener.currentPopupContents = "http://wow.curseforge.com/addons/mailopener/create-ticket/";
Zerotorescue@0 735
Zerotorescue@0 736 StaticPopup_Show("MailOpenerCopyWindow");
Zerotorescue@0 737 end);
Zerotorescue@0 738 desc1:SetCallback("OnEnter", function()
Zerotorescue@0 739 frame:SetStatusText("Click to copy this URL.");
Zerotorescue@0 740 end);
Zerotorescue@0 741 desc1:SetCallback("OnLeave", function()
Zerotorescue@0 742 frame:SetStatusText("");
Zerotorescue@0 743 end);
Zerotorescue@0 744 frame:AddChild(desc1);
Zerotorescue@0 745
Zerotorescue@0 746 -- Empty line between the two links
Zerotorescue@0 747 local spacer = AceGUI:Create("Label");
Zerotorescue@0 748 spacer:SetText(" ");
Zerotorescue@0 749 frame:AddChild(spacer);
Zerotorescue@0 750
Zerotorescue@0 751 local desc2 = AceGUI:Create("InteractiveLabel");
Zerotorescue@0 752 desc2:SetText("|cff00bbbb[http://20kleveling.com/JMTCforum/posting.php?mode=reply&f=9&t=1403]|r");
Zerotorescue@0 753 desc2:SetFont(GameFontHighlightSmall:GetFont(), 13);
Zerotorescue@0 754 desc2:SetFullWidth(true);
Zerotorescue@0 755 desc2:SetCallback("OnClick", function()
Zerotorescue@0 756 MailOpener.currentPopupContents = "http://20kleveling.com/JMTCforum/posting.php?mode=reply&f=9&t=1403";
Zerotorescue@0 757
Zerotorescue@0 758 StaticPopup_Show("MailOpenerCopyWindow");
Zerotorescue@0 759 end);
Zerotorescue@0 760 desc2:SetCallback("OnEnter", function()
Zerotorescue@0 761 frame:SetStatusText("Click to copy this URL.");
Zerotorescue@0 762 end);
Zerotorescue@0 763 desc2:SetCallback("OnLeave", function()
Zerotorescue@0 764 frame:SetStatusText("");
Zerotorescue@0 765 end);
Zerotorescue@0 766 frame:AddChild(desc2);
Zerotorescue@0 767
Zerotorescue@0 768 -- Empty line between the two links
Zerotorescue@0 769 local label = AceGUI:Create("Label");
Zerotorescue@0 770 label:SetText("\n\nps. You can always view this window again at a later time by clicking the \"Config\" button in the mail frame.\nps2. The information above is completely Mail Opener related. It will be used to determine the best default settings.");
Zerotorescue@0 771 label:SetFullWidth(true);
Zerotorescue@0 772 frame:AddChild(label);
Zerotorescue@0 773 end