WhoLib Compatibility

akhtar · Post by **akhtar** » Sat Aug 08, 2009 9:14 am

I'm creating this topic to discuss getting census+ to work with wholib.

Essentially, any addon that wants to run background /whos will work fine on its own - as long as its the only such addon a user is running. When there are more than one - the addons often interact very badly and in difficult to fix ways.

Example: Consider that you have 3 addons that each run a who request at the exact same time. The server sends back one response. Which /who was it to?

WhoLib is supposed to make life easy for addon developers, and it actually does - if you support it in your addon.

If you don't support wholib, well then wholib is just like any other addon which want to run who requests in the background - you will have conflicts.

There are 2 main strategies:

1) Use wholib as part of your addon
2) Use wholib if it is there and your original code if not.

I have modded the current census+ to support wholib if it is there, and work normally if not. I haven't done much testing, I'm hoping that folks will pitch in and help. I posted here almost a year ago about this - but we were all busy getting ready for 3.0 i guess, and noone followed up.

Here's a link to the modded version:

http://www.wowace.com/addons/census-wholib-version/

and the ticket on wowace.com

http://www.wowace.com/addons/wholib/tic ... us-compat/

Sylvanaar

Post by **Rollie** » Tue Aug 11, 2009 1:35 pm

Thank you for starting this and doing the leg work on getting it all rolling, it is much appreciated!

I am going to look at incorporating your modifications.

akhtar · Post by **akhtar** » Tue Aug 11, 2009 2:57 pm

No prob - its been on my todo list for almost a year since I first posted over here about it.

The updated wholib combined with the modified census+ i linked have been running really well.

You should consider hosting the census+ source over on wowace.com or curseforge.com. If you have an account over there let me know - i'll add you onto the wholib project.

Post by **Rollie** » Tue Aug 11, 2009 3:33 pm

It does currently throw an error if LibWho is NOT present, working on a fix atm.

Code: Select all

Message&#58; ..\AddOns\CensusPlus\CensusPlus.lua line 1346&#58;
   Cannot find a library instance of "LibWho-2.0".

Post by **Rollie** » Tue Aug 11, 2009 3:40 pm

Changing

Code: Select all

		wholib = wholib or LibStub&#40;"LibWho-2.0"&#41;;

to

Code: Select all

		wholib = wholib or LibStub&#58;GetLibrary&#40;"LibWho-2.0", true&#41;;

Seems to do the trick. Do you see any problems with doing it this way?

Post by **Rollie** » Tue Aug 11, 2009 3:49 pm

Okay, testing using WhoLib, and it is doing each query twice. Will need to dig into that.

akhtar · Post by **akhtar** » Fri Aug 14, 2009 11:46 am

One thought may be that you don't need to retry queries. Wholib will do that for you.

akhtar · Post by **akhtar** » Mon Aug 31, 2009 8:44 am

Still running really well with the version i modified - did you resolve the double query issue?

Isaura · Post by **Isaura** » Mon Aug 31, 2009 4:24 pm

Will this version also prevent the popping up from the who window every second, when census is active.
It is pretty worse atm, probly cause of another addon that was updated lately.
Before, it stopped popping up by clicking the friendstab and close the social window.
That doesn't work anymore. Actually nothing works.
Well one thing does. Dragging the social window almost out of your screen so its not in the way anymore

So if this version can change this annoying behavior I will we very glad, and a lot of others with me I think.

akhtar · Post by **akhtar** » Mon Sep 07, 2009 12:09 am

I cleaned up the issue page at wowace.com, and rezipped the last version I had worked on. The link is updated in the OP, and here : http://static.wowace.com/content/attach ... ib-003.zip

Post by **Rollie** » Mon Sep 07, 2009 7:18 pm

Yeah, I haven't looked into it again since the first time. It's up on my list though.

zybron · Post by **zybron** » Tue Sep 08, 2009 10:05 am

It looks like the section of code beginning on line 2020 of CensusPlus.lua is responsible for re-queuing a /who request:

Code: Select all

               --
					-- Resend /who command
					--
					g_WhoAttempts = g_WhoAttempts + 1;
					local whoText = CensusPlus_CreateWhoText&#40;g_CurrentJob&#41;;
					if&#40; CensusPlus_PerCharInfo&#91;"Verbose"&#93; == true &#41; then
						CensusPlus_Msg&#40;CENSUSPlus_WAITING&#41;;
					end
					if&#40; g_WhoAttempts < 2 &#41; then
						CensusPlus_SendWho&#40;whoText&#41;;
					else
						g_WaitingForWhoUpdate = false;
					end

If the WhoLib covers this, I would imagine it would be safe to remove this section entirely. I'm at work right now and can't test it, but I'll do so when I get home and see if this fixes the duplicates. Otherwise, I've been using the WhoLib version akhtar worked up for some time now without any other issue.

Kosh · Post by **Kosh** » Wed Sep 09, 2009 1:41 am

If the goal is to produce a version of CP that optionally uses WhoLib, only if it is present, then removing the section of code wouldn't be the way to go. Instead, if you are right and WhoLib negates the need to resend, then the block should be enclosed in an if() to only execute when WhoLib isn't being used. Without looking more closely at the code, it's possible that some of that may still need to execute (or alternate code might be needed if WhoLib never comes back for a query).

zybron · Post by **zybron** » Wed Sep 09, 2009 5:31 am

Kosh wrote:If the goal is to produce a version of CP that optionally uses WhoLib, only if it is present, then removing the section of code wouldn't be the way to go. Instead, if you are right and WhoLib negates the need to resend, then the block should be enclosed in an if() to only execute when WhoLib isn't being used. Without looking more closely at the code, it's possible that some of that may still need to execute (or alternate code might be needed if WhoLib never comes back for a query).

Yes, very true. And after playing around with it, with wholib enabled, that section of code still needs

Code: Select all

g_WaitingForWhoUpdate = false;

in order to function properly. So, add a check for wholib and process the original code or just turn turn off the waiting flag.

With the above code replacing the original code, there were no duplicates.

akhtar · Post by **akhtar** » Fri Sep 18, 2009 4:03 am

Sounds like its pretty close - enough so - that we could put together an alpha/beta version for further testing.

Isaura · Post by **Isaura** » Sun Sep 20, 2009 10:02 am

This afternoon I installed this version from wowace: CensusPlus-Wholib-003 (.zip)
I must say I didn't play very long, but yeah, hurrah, I didn't see any popups anymore.

Just to let you know

akhtar · Post by **akhtar** » Thu Oct 01, 2009 10:26 pm

I have created a project on wowace.com to store the source changes I have made, in case anyone wants to submit patches etc.

http://www.wowace.com/addons/census-wholib-version/

Ody · Post by **Ody** » Tue Dec 08, 2009 1:24 pm

I'm using your modified version for serveral months, waiting for a 3.3 release.

akhtar · Post by **akhtar** » Sun Nov 14, 2010 8:30 am

Updated wholib version for 4.0

http://www.wowace.com/addons/census-wholib-version/

Sylvanaar

Ody · Post by **Ody** » Mon Nov 15, 2010 3:38 pm

Thanks Sylvanaar for the update