wow/mailopener: Core.lua comparison

comparison Core.lua @ 3:c6f0976069c7

Default value for the welcome / bye notification is now set to false The mailframe checkbox now primarily toggles the mail opening, however if you hold shift you can still disable the entire addon Now properly removes QuickAuction?s mail count Now tracks when a mail lost all attachments rather than it being deleted in order to continue processing the next item (mail sent by players containing text should now work properly). This should also be good for a nice speed increase. Added a variable called ?busy? to the MailOpener object indicating whether or not Mail Opener is currently working. Other addons (or macros) can retrieve it with ?LibStub("AceAddon-3.0"):GetAddon("MailOpener").busy? A mail refresh from the Postal service should no longer occur while mail is being opened but will happen instantly afterwards. Postal?s module toggling will now be handled by Postal itself. Added a short summary to the top of all modules for other developers. The time remaining until next mail box refresh should be displayed for as long as Mail Opener can be sure.

author	Zerotorescue
date	Tue, 07 Sep 2010 17:46:27 +0200
parents	57ba1593ac42
children	1ba07a64bf14

comparison

equal deleted inserted replaced

-:57ba1593ac42
+:c6f0976069c7
-MailOpener = LibStub("AceAddon-3.0"):NewAddon("MailOpener", "AceEvent-3.0", "AceTimer-3.0");
+-- You can access this addon's object through: LibStub("AceAddon-3.0"):GetAddon("MailOpener")
+local MailOpener = LibStub("AceAddon-3.0"):NewAddon("MailOpener", "AceEvent-3.0", "AceTimer-3.0");
-local enabled = true;
-local MailOpenerConfig, lastAmount, lastQuickAuctionsStatus, opening, freshList, mailboxEmptySoundPlayed;
+-- You can check if MailOpener is busy with LibStub("AceAddon-3.0"):GetAddon("MailOpener").busy (true or false/nil)
+local AutoOpenMail, MailOpenerConfig, lastAmount, lastQuickAuctionsStatus, freshList, mailboxEmptySoundPlayed;
 function MailOpener:OnInitialize()
 	local defaults = {
 		global = {
 			uses = 0;
 			},
 			modules = {
 				Collected = true,
 			},
 			notifications = {
-				welcome = true,
+				welcome = false,
-				bye = true,
+				bye = false,
 				finishedCurrentBatch = true,
 				mailboxIsEmpty = true,
 				skipped = {
 					all = true,
 	-- Make the open all checkbox
 	local check = CreateFrame("CheckButton", "cbMailOpenerEnable", MailFrame, "ChatConfigCheckButtonTemplate");
 	check:SetHeight(26);
 	check:SetWidth(26);
-	check:SetChecked(enabled);
+	check:SetChecked(true);
 	check:SetHitRectInsets(0, -80, 0, 0);
 	check:SetScript("OnClick", function(self)
-		if self:GetChecked() then
+		if IsShiftKeyDown() then
-			MailOpener:Enable();
+			-- Shift key = toggle addon on or off, since addon is already on there's only one option
+			if not MailOpener:IsEnabled() then
+				print("|cff15ff00Mail Opener|r: Shift key was held down, so |cff00ff00enabling|r the entire addon as well as automatic opening of mail.");
+				MailOpener:Enable();
+				-- The above calls MAIL_SHOW which changes AutoOpenMail, so we can't remember the old setting
+				AutoOpenMail = true;
+				self:SetChecked(true);
+			else
+				print("|cff15ff00Mail Opener|r: Shift key was held down, so |cffff0000disabling|r the entire addon.");
+				MailOpener:Disable();
+				self:SetChecked(false);
+			end
 		else
-			MailOpener:Disable();
+			-- Normal click
-		end
-	end);
+			if self:GetChecked() then
-	check.tooltip = "Toggle Mail Opener on or off.";
+				print("|cff15ff00Mail Opener|r: |cff00ff00Enabling|r automatic opening of mail.");
+				AutoOpenMail = true;
+			else
+				print("|cff15ff00Mail Opener|r: |cffff0000Disabling|r automatic opening of mail.");
+				AutoOpenMail = false;
+			end
+		end
+	end);
+	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.";
 	check:SetPoint("TOPLEFT", MailFrame, "TOPLEFT", 68, -13)
 	if self.QuickAuctionsEnabled then
 		-- QA is enabled so move the checkbox further to the right
 function MailOpener:OnDisable()
 	self:UnregisterEvent("MAIL_SHOW");
 	self.btnConfig:Hide();
-	enabled = false;
 	MailOpener:Stop();
 end
 -- 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
 function MailOpener:PLAYER_ENTERING_WORLD()
 	self:RegisterMessage("MO_OPEN_COMPLETE");
 	self:Debug("defaultStatus:" .. self.db.profile.general.defaultStatus);
 	-- Change the mail opening status according to our settings
 	if self.db.profile.general.defaultStatus == "_enabled" then
-		enabled = true;
+		AutoOpenMail = true;
-	else
+		self.cbOpenAll:SetChecked(true);
-		enabled = false;
+	elseif self.db.profile.general.defaultStatus == "disabled" then
-	end
+		-- Disable auto opening but leave mail opener enabled
-	self.cbOpenAll:SetChecked(enabled);
+		AutoOpenMail = false;
+		self.cbOpenAll:SetChecked(false);
+	elseif self.db.profile.general.defaultStatus == "xdisabled" then
+		-- Disable entire addon
+		MailOpener:Disable();
+		self.cbOpenAll:SetChecked(false);
+	end
 	self:ToggleQAStatus();
 	-- Hide the InboxTooMuchMail warning to allow room for our mail remaining info line
 	InboxTooMuchMail:Hide()
 	InboxTooMuchMail.Show = function() end
 	if self.QuickAuctionsEnabled then
-		-- Go through all children of the mail frame to find the post button
+		local QAMail = LibStub("AceAddon-3.0"):GetAddon("QuickAuctions"):GetModule("Mail");
-		local kids = { InboxFrame:GetChildren() };
+		-- Hide the open all button
-		for _, child in ipairs(kids) do
+		QAMail.massOpening:Hide();
-			if child then
+		-- Hide the x mail remaining text
-				local width = floor( child:GetWidth() + .5 );
+		QAMail.totalMail:Hide();
-				local height = floor( child:GetHeight() + .5 );
-				-- The open all button has a static width and height
-				if width == 130 and height == 24 then
-					child:Hide();
-					break;
-				end
-			end
-		end
 	end
 	if self.db.profile.notifications.welcome then
 		-- Welcome notification
 		local _, c = UnitClass("player");
 -- Fired after a successful server sync
 -- Fired when mail is deleted (which happens after taking all attachments from a mail sent by the game)
 function MailOpener:MAIL_INBOX_UPDATE()
 	local current, total = GetInboxNumItems();
+	-- Calculate the amount of mail waiting that actually have attachments
+	-- 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
+	local currentMailWithAttachments = 0;
+	for i = 1, current do
+		local _, _, _, _, money, _, _, items = GetInboxHeaderInfo(i);
+		if (items and items > 0) or (money and money > 0) then
+			currentMailWithAttachments = currentMailWithAttachments + 1;
+		end
+	end
 	local tempLastAmount = lastAmount;
-	lastAmount = current;
+	lastAmount = currentMailWithAttachments;
-	if current ~= tempLastAmount then
+	if currentMailWithAttachments ~= tempLastAmount then
-		self:Debug("MAIL_INBOX_UPDATE - lastAmount:" .. tempLastAmount .. " - current:" .. current);
+		self:Debug("MAIL_INBOX_UPDATE - lastAmount:" .. tempLastAmount .. " - current:" .. currentMailWithAttachments);
 	end
-	if current > tempLastAmount then
+	if currentMailWithAttachments > tempLastAmount then
 		-- New messages arrived in our mailbox, so this was a refresh, so set a timer
+		self:Debug("MO_SERVER_SYNCED");
 		-- Yell that we successfully synced with the server
 		self:SendMessage("MO_SERVER_SYNCED");
 		-- This list is fresh
 			-- Allow overriding of mailopening with the shift key
 			-- Open the current mail
 			self:ScheduleOpen(false);
 		end
-	elseif current < tempLastAmount then
+	elseif currentMailWithAttachments < tempLastAmount then
 		-- We lost a mail
+		-- TODO: NYI: May need to delay this until the mail is actually deleted
+		self:Debug("MO_MAIL_EMPTIED");
 		-- Yell that we successfully opened/removed a mail
-		self:SendMessage("MO_MAIL_DELETED");
+		self:SendMessage("MO_MAIL_EMPTIED");
-	elseif (current == 50 and tempLastAmount == 50) then
+	elseif (currentMailWithAttachments == 50 and tempLastAmount == 50) then
 		if not IsShiftKeyDown() then
 			-- Allow overriding of mailopening with the shift key
 			-- Open the current mail
 			self:ScheduleOpen(false);
 		end
 	end
-	tempLastAmount = current;
 end
 function MailOpener:ScheduleOpen(continued)
 	if lastAmount > 0 then
 		local waitTime;
 		self.tmrOpenNow = self:ScheduleTimer("OpenNow", waitTime);
 	end
 end
 function MailOpener:OpenNow()
-	self:Debug("OpenNow (" .. ((opening and "1") or "0") .. ")");
+	self:Debug("OpenNow (" .. ((self.busy and "1") or "0") .. ")");
-	if not opening and MailFrame:IsVisible() then
+	if not self.busy and MailFrame:IsVisible() and AutoOpenMail then
 		self:Debug("OpenNow");
 		-- BeanCounter is the only addon hiding the mail close button while busy, so we can look for that
 		local BeanCounterActive = not InboxCloseButton:IsVisible();
 				self:Debug("Turning automail |cffff0000off|r.");
 				QuickAuctionsAutoMail:Click();
 			end
-			opening = true;
+			self.busy = true;
 			self:Debug("MO_OPEN_MAIL");
 			-- Summon the mail opening gods
 			self:SendMessage("MO_OPEN_MAIL");
 		end
 	end
 end
 function MailOpener:MO_OPEN_COMPLETE()
-	opening = false;
+	self.busy = false;
 	-- Try a recheck
 	self:Recheck();
 	local current, total = GetInboxNumItems();
 	if (total - current) == 0 then
-		-- Play the sound
+		-- There is probably no unopenable mail remaining, so play the sound (if enabled)
 		if self.db.profile.notifications.mailboxEmptySound and (not MailOpener.db.profile.notifications.mailboxEmptySoundOnlyOnce or not mailboxEmptySoundPlayed) then
 			PlaySoundFile(self.db.profile.notifications.mailboxEmptySoundFile);
 			mailboxEmptySoundPlayed = true;
 		end
 	end
-	if self.db.profile.general.autoReenableQAAutoMail and self.QuickAuctionsEnabled and QuickAuctionsAutoMail and not QuickAuctionsAutoMail:GetChecked() then
+	if self.QuickAuctionsEnabled then
-		-- If auto re-enable "QA Auto mail" is enabled and QA's auto mail is currently toggled OFF, turn it on
+		-- Quick Auctions enabled?
-		-- We need to do this with a :click to trigger the right events
+		-- Toggle automailing as per settings
-		self:Debug("Turning automail |cff00ff00on|r.");
+		if self.db.profile.general.autoReenableQAAutoMail and  QuickAuctionsAutoMail and not QuickAuctionsAutoMail:GetChecked() then
+			-- If auto re-enable "QA Auto mail" is enabled and QA's auto mail is currently toggled OFF, turn it on
-		QuickAuctionsAutoMail:Click();
+			-- We need to do this with a :click to trigger the right events
-	elseif self.db.profile.general.autoSetBackQAAutoMail and self.QuickAuctionsEnabled and QuickAuctionsAutoMail and lastQuickAuctionsStatus ~= QuickAuctionsAutoMail:GetChecked() then
-		-- 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
-		-- We need to do this with a :click to trigger the right events
-		if lastQuickAuctionsStatus then
 			self:Debug("Turning automail |cff00ff00on|r.");
-		else
-			self:Debug("Turning automail |cffff0000off|r.");
+			QuickAuctionsAutoMail:Click();
-		end
+		elseif self.db.profile.general.autoSetBackQAAutoMail and QuickAuctionsAutoMail and lastQuickAuctionsStatus ~= QuickAuctionsAutoMail:GetChecked() then
+			-- 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
-		QuickAuctionsAutoMail:Click();
+			-- We need to do this with a :click to trigger the right events
+			if lastQuickAuctionsStatus then
+				self:Debug("Turning automail |cff00ff00on|r.");
+			else
+				self:Debug("Turning automail |cffff0000off|r.");
+			end
+			QuickAuctionsAutoMail:Click();
+		end
 	end
 	if self.db.profile.general.continueOpening then
 		self:ScheduleOpen(true);
 	end
 	self:Debug("|cffffff00Recheck|r");
 	-- Freshlist prevents this from being run too often
 	-- It is set to true after a server sync
 	-- and set to false 61 seconds afterwards with a recheck called instantly after it
-	if not freshList and MailFrame:IsVisible() then
+	-- We're not refreshing while we're opening because it is automatically done when current batch was completely opened
+	if not freshList and not self.busy and MailFrame:IsVisible() then
 		self:Debug("|cff00ff00Recheck|r");
 		-- If this isn't a fresh list (so messages weren't received within the last 60 seconds) and the mailbox wasn't closed
 		-- BeanCounter is the only addon hiding the mail close button while busy, so we can look for that
 		local BeanCounterActive = not InboxCloseButton:IsVisible();
-		if not BeanCounterActive then
+		if not BeanCounterActive and AutoOpenMail then
 			-- Query the server
 			CheckInbox();
 		end
 		-- Stop previous timer
 function MailOpener:Stop()
 	if self.db.profile.notifications.bye then
 		print("|cff15ff00Mail Opener|r: Have a nice day. :)");
 	end
-	opening = false;
+	self.busy = false;
 	-- We won't need this anymore
 	self:UnregisterEvent("MAIL_CLOSED");
 	self:UnregisterEvent("PLAYER_LEAVING_WORLD");
 	self:UnregisterEvent("MAIL_INBOX_UPDATE");
 -- Toggle Postal's opening modules on or off
 function MailOpener:TogglePostalModule(name, status)
 	if MailOpener.PostalEnabled and Postal then
 		-- Postal must be enabled
-		-- Remember the setting in Postal
+		-- Toggle module (let Postal handle this)
-		Postal.db.profile.ModuleEnabledState[name] = status;
+		Postal.ToggleModule(nil, name, Postal:GetModule(name), status);
-		-- Toggle module
-		if status then
-			Postal:GetModule(name):Enable();
-		else
-			Postal:GetModule(name):Disable();
-		end
 	end
 end
 -- Change Quick Auction's auto mail status based on our prefered settings
 function MailOpener:ToggleQAStatus()

Mercurial > wow > mailopener

comparison Core.lua @ 3:c6f0976069c7