Updater 2.3- Easy, Safe, and Policy-Compliant auto-updating for your plugins [NEW!]

Discussion in 'Resources' started by Gravity, Aug 28, 2012.

Thread Status:
Not open for further replies.
  1. Offline

    Gravity Retired Staff

    Updater - Version 2.3
    Updater is an easy-to-use but robust and fully policy-compliant plugin updating system. It provides plugin developers with the ability to both check for and download new updates straight from BukkitDev, and requires no web server setup to function.

    Download and Source:
    Updater is a single class file that you need to add to your plugin. Simply create a new class somewhere in your plugin named "Updater", and populate it with Updater's source code, which you can find by clicking the "Get Updater" link below. Then, go to the "How to use it" section to learn how adding one line of code to your plugin will implement Updater.

    Get Updater

    Features:

    • No more hassle! Never worry about configuring your Dropbox text files to the latest build's url, or forgetting to update external files again. Upload once to BukkitDev, and as soon as your file is approved clients will start downloading it, even if the approval comes at 4am and you're fast asleep.
    • Setup is as easy as copying a class and giving it your BukkitDev project slug. Updater will do the rest.
    • Ability to tag certain builds as non-update builds. For instance, on my Jenkins system every build is tagged with -DEV, so that people who are using it do not get switched to the official latest build, and can stay testing the pre-release. Simply edit the "noUpdateTag" array in the class to define what kind of builds should be left alone.
    • Don't hassle your users anymore. Server admins have enough on their hands, don't concern them with updates, because they just will /not/ update. From personal experience, I know that the only time I cared about a plugin update was when something broke. It's far too difficult to worry about a new file every day, but if you let Updater automatically install updates, your users will rejoice!
    • Be safe. EVERY file that Updater downloads has been approved by BukkitDev staff. Real humans go line-by-line through the code of each plugin that is approved on dev.bukkit.org, to verify it is free of any malicious code. Your user's shouldn't have to blindly accept your trust, you can instead show and prove to them that by using updater, you are keeping them secure.
    • Works with both .jar file and .zip file updates.
    -- Get Updater --


    How it works:

    - First, Updater connects to BukkitDev API and requests information about your project.

    - It then searches the information for the latest file, and obtains information about it like its name and version number.

    - Optionally, Updater will run a version check, comparing the newest file with the plugin's current version. NOTE: For this to work, your file titles must be named in this format: 'PluginName vVersionNumber', such as 'AntiCheat v1.0' (or simply 'v1.0', the name is not needed, but suggested). Here's a screenshot of how this should look, if done properly:
    File titles with proper version numbers (open)

    [​IMG]

    - Assuming that an update is needed, Updater will download the file from dev.bukkit.org and store it in the update folder. This is a folder defined in the bukkit.yml file where any stored jars will be switched with its currently-in-use counterpart when the system is reloaded or restarted. This means that the user does not need to worry about replacing the downloaded file with the current file; it's all done in the background.

    How to use it:

    If you are using Maven to manage your project you can use my Maven repository to get the dependency. To do this, edit your pom.xml to add the following repository:
    Code:
        <repositories>
            <repository>
                <id>gravity-repo</id>
                <url>http://repo.gravitydevelopment.net</url>
            </repository>
        </repositories>
    
    Then, add the following dependency:
    Code:
        <dependencies>
            <dependency>
                <groupId>net.gravitydevelopment.updater</groupId>
                <artifactId>updater</artifactId>
                <version>2.1</version>
            </dependency>
        </dependencies>
    
    Otherwise, you can use the traditional way and download the source code for Updater. Simply place this somewhere within your plugin's packages, and then switch over to your main class to get to work.

    As with most of my projects, I boast the fact that you only need one line of code added to your main class (the one that extends JavaPlugin) to make this work (along with my Updater class, of course), so here's what it is:

    Code:
    Updater updater = new Updater(this, id, this.getFile(), Updater.UpdateType.DEFAULT, false);
    That's it! This single line of code will literally keep the user updated for the rest of their life. Here's a breakdown of what all these values are:

    1) "this" - The plugin instance. I suggest using this in your onEnable() method, so that you can properly issue the 'this' keyword. Other methods that are called before onEnable() will not work (but anything after it, or that is called BY onEnable() does work).

    2) "id" - This is how Updater finds your project on BukkitDev. If you don't know what this is, follow the instructions on this wiki article.

    3) "this.getFile()" - The plugin's file, this is so that Updater can properly replace your plugin with the update when it is downloaded. Note that this is a protected value, and so it can only be accessed within your plugin's main class

    4) "Updater.UpdateType.DEFAULT" - This allows you to choose which type of update you would like to take place. Currently there are 3 options:
    - DEFAULT - Typically what you would want. Do an update check, and then if it's out of date download and install the latest update.
    - NO_VERSION_CHECK - In case you know you need (or want) to update, skip version checking and just download the latest file, regardless of any it's details.
    - NO_DOWNLOAD - In case you just want to do a version check. No files will be downloaded, but you still get information about the newest build on DBO, like it's version number and size.

    5) "false" - This is a value declaring whether you want Updater to announce the progress of the download, as it takes place. This is similar to what this output (to the console) will look like:
    Output (open)

    2012-08-29 16:30:56 [INFO] [AntiCheat] Enabling AntiCheat v1.3.6-DEV
    2012-08-29 16:30:57 [INFO] About to download a new update: AntiCheat v1.3.5
    2012-08-29 16:30:57 [INFO] Downloading update: 10% of 93738 bytes.
    2012-08-29 16:30:57 [INFO] Downloading update: 20% of 93738 bytes.
    2012-08-29 16:30:57 [INFO] Downloading update: 30% of 93738 bytes.
    2012-08-29 16:30:57 [INFO] Downloading update: 50% of 93738 bytes.
    2012-08-29 16:30:57 [INFO] Downloading update: 70% of 93738 bytes.
    2012-08-29 16:30:57 [INFO] Downloading update: 80% of 93738 bytes.
    2012-08-29 16:30:57 [INFO] Downloading update: 90% of 93738 bytes.
    2012-08-29 16:30:57 [INFO] Downloading update: 100% of 93738 bytes.
    2012-08-29 16:30:57 [INFO] Finished updating.

    If this option is true, and there is no update, there will be no output to the console.

    You can also see these values documented in JavaDocs here: http://gravitydevelopment.net/docs/updater/

    ------------------------------------------------------------------------------------------------------------------------------------
    NOTICE:
    As of Updater 2.0, a configuration file is created to allow server administrators to globally toggle updating for any plugin using this class. While this option does provide a convenient method for server admins to disable all Updater instances, Bukkit project submission guidelines still require that you make your plugin's Updater instance specifically toggleable with its own configuration option. This gives server administrators the opportunity to only disable the updating capabilities of one plugin in particular, should they choose to do so. You may read more about compliance with this policy here.
    ------------------------------------------------------------------------------------------------------------------------------------


    Expanding updater:

    Note: The following contains more advanced user information on controlling Updater. While Updater is very simple to use, it also gives a great deal of feedback and control to the developer if they want to use it. If you are just starting to develop plugins, it is recommended that you stop here and just use Updater as you have learned to use it so far. If you are an advanced user, you may continue on, but know that all of the following info is optional, and only necessary if you want to customize your experience.

    Now, of course you may want to know what the outcome of the process was, so you can inform the user or update some values in your plugin to reflect that it is now updated. This result can easily be obtained by using the "getResult()" call. This returns an UpdateResult that reflects what happened.​

    Code:
            Updater.UpdateResult result = updater.getResult();
            switch(result)
            {
                case SUCCESS:
                    // Success: The updater found an update, and has readied it to be loaded the next time the server restarts/reloads
                    break;
                case NO_UPDATE:
                    // No Update: The updater did not find an update, and nothing was downloaded.
                    break;
                case DISABLED:
                    // Won't Update: The updater was disabled in its configuration file.
                    break;
                case FAIL_DOWNLOAD:
                    // Download Failed: The updater found an update, but was unable to download it.
                    break;
                case FAIL_DBO:
                    // dev.bukkit.org Failed: For some reason, the updater was unable to contact DBO to download the file.
                    break;
                case FAIL_NOVERSION:
                    // No version found: When running the version check, the file on DBO did not contain the a version in the format 'vVersion' such as 'v1.0'.
                    break;
                case FAIL_BADID:
                    // Bad id: The id provided by the plugin running the updater was invalid and doesn't exist on DBO.
                    break;
                case FAIL_APIKEY:
                    // Bad API key: The user provided an invalid API key for the updater to use.
                    break;
                case UPDATE_AVAILABLE:
                  // There was an update found, but because you had the UpdateType set to NO_DOWNLOAD, it was not downloaded.
            }
    All these values, of course, are documented in easy-to-read HTML here: http://gravitydevelopment.net/docs/updater/

    You also may want to know information about the newest update. Some people prefer to have Updater run a version check ONLY (using UpdateType.NO_DOWNLOAD), then, if there is an update available, start notifying admins as they log in that there is a new version ready, with information like file size and version. An admin would then issue a command, and the developer would run Updater again but this time with UpdateType set to NO_VERSION_CHECK, thus downloading the newest build at the admin's request.

    We have a few methods available for you to use for this information. We already know that we can determine the outcome of the version check by calling getResult(), but here are some more methods you can call to get information about the newest file:

    - getLatestName() - Returns the name of the latest file you have uploaded to BukkitDev (Ex: "AntiCheat v1.5.9")
    - getLatestType() - Returns the type of the latest file you have uploaded to BukkitDev (Alpha, Beta, Release)
    - getLatestGameVersion() - Returns the compatible Game Version of the latest file you have uploaded to BukkitDev (Ex: "CB 1.6.2-R1.0")
    - getLatestFileLink() - Returns the link to the latest file you have uploaded.

    The scenario mentioned about would look something like this (pseudocode):

    Code:
    // In main class
    
    public static boolean update = false;
    public static String name = "";
    public static ReleaseType type = null;
    public static String version = "";
    public static String link = "";
    // You would want to make getter methods in your class, this is just for simplicity.
    
    public void onEnable()
    {
      Updater updater = new Updater(this, YOUR_ID_HERE, this.getFile(), Updater.UpdateType.NO_DOWNLOAD, false); // Start Updater but just do a version check
      update = updater.getResult() == Updater.UpdateResult.UPDATE_AVAILABLE; // Determine if there is an update ready for us
      name = updater.getLatestName(); // Get the latest name
      version = updater.getLatestGameVersion(); // Get the latest game version
      type = updater.getLatestType(); // Get the latest file's type
      link = updater.getLatestFileLink(); // Get the latest link
    }
    
    // In a listener class:
    
    @EventHandler
    public void onPlayerJoin(PlayerJoinEvent event)
    {
      Player player = event.getPlayer();
      if(player.hasPermission("foo.bar") && Main.update)
      {
        player.sendMessage("An update is available: " + Main.name + ", a " + Main.type + " for " + Main.version + " available at " + Main.link);
        // Will look like - An update is available: AntiCheat v1.5.9, a release for CB 1.6.2-R0.1 available at http://media.curseforge.com/XYZ
        player.sendMessage("Type /update if you would like to automatically update.");
      }
    }
    
    // And then later in a CommandExecutor class, when they type /update:
    
    Updater updater = new Updater(this, YOUR_ID_HERE, this.getFile(), Updater.UpdateType.NO_VERSION_CHECK, true); // Go straight to downloading, and announce progress to console.
    

     
    Last edited: May 6, 2016
    FisheyLP, Nathat23, Eathuis and 36 others like this.
  2. Offline

    p000ison

    Seems to be useless :p
     
  3. Offline

    bob7

    Does this support ZIP files?
     
  4. Offline

    Deathmarine Retired Staff

    Code:java
    1. PluginDescriptionFile pdf = this.getDescription();
    2. //Updater
    3. if(config.getBoolean("AutoUpdater.Enabled",true)){
    4. Updater up = new Updater(this,pdf.getName().toLowerCase(),this.getFile(),UpdateType.DEFAULT,true);
    5. if(!up.getResult().equals(UpdateResult.SUCCESS)||up.pluginFile(this.getFile().getName())){
    6. if(up.getResult().equals(UpdateResult.FAIL_NOVERSION)){
    7. this.getLogger().info("Unable to connect to dev.bukkit.org.");
    8. }else{
    9. this.getLogger().info("No Updates found on dev.bukkit.org.");
    10. }
    11. }else{
    12. this.getLogger().info("Update "+up.getLatestVersionString()+" found please restart your server.");
    13. }
    14. }


    This seems to be working great for me. But I made a few changes myself. :)
     
  5. Offline

    IDragonfire

  6. Offline

    Neodork

    This works great. I love the class, great job!
     
  7. Offline

    lol768 Retired Staff

    Does the version field in the plugin.yml even allow text?
     
  8. Offline

    zack6849

    apparently
     
  9. Offline

    IDragonfire

  10. Offline

    zeeveener

    EDIT: Nevermind. I thought I had to change the actual file name to the (Name)(v#.#) format...

    Show Spoiler
    How am I supposed to change the name of the downloaded file to the name of the file it is downloading. Right now it just replicates the name of the currently running plugin file.

    So:
    Running plugin file: ZPort v6.1.jar
    File to download: ZPort v6.2.jar
    File that gets downloaded into the update folder: ZPort v6.1.jar
    However the plugin runs as version 6.2...

    How do I change the naming scheme without altering the Updater.class?
     
  11. Offline

    xXSniperzzXx_SD

    Is there any chance that you can also check what version the next update is for? So you can work better with the new way Bukkit is gonna work?
     
  12. Offline

    bob7

    You need to include a fail check, every time bukitdev goes down it produces an error.
     
    confuserr likes this.
  13. Offline

    xXSniperzzXx_SD

    Any chance that you can add a way to make sure the update is using the same CB?
    h31ix
     
  14. Offline

    Gravity Retired Staff

    Hm. Interesting idea, I suppose getting the version would be useful.. going to have to reconsider the threading I've done if I want to do that and give developers a chance to grab that info before the file is downloaded, though. I'll take a look - a chance you could file a ticket on the repository so I don't forget?
     
  15. Offline

    xXSniperzzXx_SD

    I did add it on my own a while ago, but then i removed it for a reason i forget :p
     
  16. Offline

    bob7

    So no fail checks? I just want it to ping bukkit dev to insure connectivity, then download the jars.

    On the side note, why did you change your name!? I thought @h31ix was a great name! Gravity is soo unoriginal :(
     
  17. Offline

    Gravity Retired Staff

    That would have been fixed by the threading update.
    For the same reason you had to copy and paste my username to get it right
     
    jorisk322 likes this.
  18. Offline

    xXSniperzzXx_SD

    Gravity
    Just a question do you think this would work
    http://pastehtml.com/view/cqk3gsp81.rtxt
    I used that so i could highlight what i added
    then you just compare the versions, then the dev can just do what ever with it?


    Edit: Every time i read Gravity the word gravy pops into my head
     
  19. Offline

    mastermustard

    Gravity i think i did something wrong its telling me "updater" is never read
    Code:
            Updater updater = new Updater(this, "MultiRules", this.getFile(), Updater.UpdateType.NO_DOWNLOAD, false);
    also how would i add in the option to change through config im kind of new to it and when i tried to just replace the "NO_DOWNLOAD" with the method (getConfig().getString"") it said i couldnt do that...
     
  20. Offline

    bob7

    This doesn't seem to be properly threaded. I thought the actual connection to bukkitdev would be threaded, not the download. The connection is the time were timeouts may occur, it currently takes 10 minutes (Depending on bukkitdev) to turn my server on.
     
  21. Offline

    Gravity Retired Staff

    The older versions aren't, the updated code should be. I'm kind of busy with other stuff and have limited spurts of time to focus on it though so if you think something's wrong please make a PR.
     
  22. Offline

    FuZioN720

    How do you make this configable in the config?
     
  23. Offline

    Gravity Retired Staff

    Same way you make anything else configurable. Just add a boolean to the config labeled "auto-update" or something (it's up to you) and don't start updater until you've verified it's true. How you do it is your choice; as long as there's a way to turn it off in the config, it's okay.
     
  24. Offline

    FuZioN720

    Wow my brain just wouldn't work i'm so stupid thanks Gravity
     
  25. Offline

    doglover129

    I keep getting errors. It says:
    [SEVERE] Exception in thread "Thread-7"
    [SEVERE] java.lang.IndexOutOfBoundsException: index (0) must be less than an size (0)

    Any idea what I might have done wrong?
     
  26. Offline

    Gravity Retired Staff

    Sounds like there's no 'v' denoting the version or something. What project are you using?
     
  27. Offline

    doglover129

    GriefLog

    EDIT: 1. How do I set a version?
    2. Do I update the version every time I update the plugin?
     
  28. Offline

    Gravity Retired Staff

    Your 3 most recent files have been uploaded without a "v" in front of the version.
     
  29. Offline

    doglover129

    so
    So what do I do? Do you have like, would it be "Grief Log "? Or just " Log"? Or what? Do I need to add the v?
     
  30. Offline

    Skyshayde

    you need something like v1.6 in it, for example, Grief Log v1.6. This is so it can tell what version each update is, so it doesn't "update" to an old one.
     
    Gravity likes this.
  31. Offline

    Gravity Retired Staff

    ^ that.
    Please read the post's instructions on setting it up.
     
Thread Status:
Not open for further replies.

Share This Page