Please leave a comment if you use it or if you have any ideas/feature requests.
- Doesn't work with .rar files. I haven't found a nice rar library for python (rarlib is annoying) and I don't have time to roll my own lib for rarfiles. I could apply some OS specific fixes.. (Please addon authors, use .zip files, .rar files are evil and doesn't work out of box on some OSes)
Wow User Interface UPdater or Wuiup for short is a little script which I wrote because I had a lot of addons which needed manual config/fixes each time they were updated.
Updates addons which you have added to your favorite list on WowInterface.
Has the ability to execute custom "hooks" before and after each update which basically allows you to back up some files and/or patch in your config/file changes.
Supports custom updaters which can update addon not hosted on WowInterface or which are rarely updated there.
Python 2.6 or 2.7 (I haven't tested it with 2.5 it might/might not work with it.)
How it works:
Wuiup downloads and keeps local version number of all addons which are in your wowinterface.com favorites. If version on wowinterface is different then local version it will download new version from wowinterface.com, delete old local copy and extract new version in wow addon directory.
Usually you just want to launch wuiup.py file. Or you can make a shortcut to update.bat (on windows), there's also an icon file if you want to assign an icon the shortcut. If you have your python install at some specific place, just edit the .bat .
There are some command-line switches. You can get more info by runing wuiup.py with with -h switch.
What are custom updaters and how they work?
By default Wuiup will only update addons in your wowinterface favorites. If you want to update addon which is not hosted in wowinterface you need to write your own custom updater. How to do that?
First you want to make a new file in ./updaters/ directory and call it something, for example wim.py (since I'm going to write custom updater for WIM).
In that file you need to import custom updater abstract class:
from updaters import Updater
Then all you need to do is make a subclass of Updater with a method called update which takes 1 parameter, local version of addon or None if there's no info about local version. This method must return newly installed/updated version or False if update failed for some reason.
self.current_version = cv
last_version = False
self.logging.info("Pretending to update WIM" if self.current_version or "Pretending to install WIM")
last_version = self._some_method_which_actually_updates_addon()
#Something bad happended
There's working example in ./updaters/wim.py
What does hooks do and how they work?
Before and after Wuiup updates addon from wowinterface.com or updates one using custom updater it checks if that addon has "before updater" and/or "after update" hooks installed.
How can I install / write such hooks?
All hooks are located in ./hooks/ directory. Filename of each hook is actually adddon_id + ".py" . For wowinterface.com addons, their IDs are their original wowinterface.com IDs.
To get ID of addon which is hosted on wowinterface.com you need to go to it's webpage and then look at pages url, for example:
ID is the number between info and -nameofaddon. In this case 11361.
So if you would want to write a hook which gets called when Overachiever is updated, you would make a file called 11361.py in ./hooks/ directory.
In that file you need to import hook abstract:
from hooks import AddonHookAbstract
And make an subclass of AddonHookAbstract called AddonHook, no other name will work at the moment. Now there's 2 method which you can overwrite -beforeUpdateHook() and afterUpdateHook(). Both should return True if everything worked or False if something went wrong.
Here's a small example:
To add addon hosted on curse take a look at curse custom updater. Use at your own risk.
If you can't figure out how to set it up - you are probably better off with another updater.
+Added simple support for addons hosted at Curse. Better integration requires bigger rewrite. Use at your own risk.
*Fixed DBM custom updater to support their new website.
*Some other minor fixes.
*added oUF_Freeb hook to examples
*Fixed several bugs which could cause the updater to lose it's datafile.
*Some really small tweaks.
You have just downloaded by the author . If you like this AddOn why not consider supporting the author? This author has set up a donation account. Donations ensure that authors can continue to develop useful tools for everyone.
*Clicking the donate button above will take you to PayPal.com
*Clicking the donate button above will take you to Pledgie.com