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

    lycano

  3. Offline

    I Al Istannen

  4. Offline

    Dankrushen

    I have a problem, I added this to my plugin, and it just downgrades. Maybe it takes time for the downloads server to update? Alright, yeah I just checked and the API server is just old and it auto-updates to and older version of the plugin, is there a way to never downgrade?
     
  5. Offline

    nverdier

  6. Offline

    Tecno_Wizard

    As I was rummaging around in the source code looking for something I noticed that the functionality I was looking for is already built in, but I don't see any notation on how to use it.

    Code:
    if (this.hasTag(localVersion) || !this.shouldUpdate(localVersion, remoteVersion)) {
                        // We already have the latest version, or this build is tagged for no-update
                        this.result = UpdateResult.NO_UPDATE;
                        return false;
                    }
    How can you tag a build for no-update? Thanks!


    EDIT: Nvm, found it. If anyone is interested, you do this by adding things from the NO_UPDATE_TAG array to the build name. Of course, you can add your own.
     
    Last edited: Jul 3, 2015
  7. Offline

    Betagear

    I have a bug where the updater tells me that he couldn't find any files for the project id 93582, but I have uploaded 2 files wich have been both validated and follows the format. I verified also 3 times the ID. Can anyone help me ?
    Integration (In case of) : Updater updater = new Updater(this, 93582, this.getFile(), Updater.UpdateType.DEFAULT, true);
    Project page : http://dev.bukkit.org/bukkit-plugins/stomparena/
    Page with the ID : https://api.curseforge.com/servermods/projects?search=stomparena
     
  8. Offline

    bwfcwalshy Retired Staff

  9. Offline

    Betagear

    @bwfcwalshy What should I do then ? I uploaded files, why aren't they on the API ?

    EDIT : The files appeared after some times, so nothing to do but wait ;)
     
    Last edited: Jul 19, 2015
  10. Offline

    Corndogoz

    Sounds really cool, except i like programming more then copying others people exact code, anyways my way has more functionality, sorry if I spell wrong, its late at night
     
  11. Offline

    Dankrushen

    @nverdier I have them have all the same name, should I be putting the versions in the name?
     
  12. Offline

    scorpiaa_

    Is it possible to copy the whole setup (xml, rss, etc) to a local server? So I don't need to release my Network plugins on Bukkit.org?
     
  13. Offline

    finnisfun

    Question: to be able to search for the plugin ID, is it required that your plugin be in beta? I have an alpha plugin, and I'd like to get updater up and running before releasing a beta version.
     
  14. Offline

    eyamaz

    Report the project itself and ask the moderator for the project ID.
     
  15. Offline

    foxi69

    Can someone make this updater to spigot?
     
  16. Offline

    Tecno_Wizard

    @foxi69, spigot provides no plugin checking. Hence op if someone was to push out a malicious update to their plugin, you would have no second line of defence. Not the greatest idea...
     
    Last edited by a moderator: Aug 24, 2015
  17. Offline

    HON95

    Your repo site is offline, though, I'm only seeing the CloudFlare offline page. Guess I'll download the source instead for now.
     
  18. Offline

    Ramon1711

    So why I have this error? How can I fix it??
     

    Attached Files:

  19. Online

    timtower Moderator Moderator

  20. Offline

    Dankrushen

    For some odd reason the updater has stopped working, it only started today saying that it can't find my project.

    EDIT: Well, apparently Bukkit decided they wanted to stop working for a bit, I have no clue if the updater works again, but I can access the api.curseforge.com page again
     
    Last edited: Dec 10, 2015
  21. Offline

    Zombie_Striker

  22. Offline

    xtechgamer735

    I am experiencing the same issue - you haven't done anything wrong no. When I visit it in my browser it either displays the files or just displays a null output ('[]' in the corner). I think its a problem with curse rather than the updater. I have considered writing my own webpage to cache this information from the page but I'm not sure if bukkit would allow me to include that in a release?
     
  23. Offline

    Zombie_Striker

    The link to my project now works. I guess there is a "down-time" when retrieving the files.

    [Edit] It gives me this error I can't figure out. The whole "FileVersions should follow the "PluginName vVersion"" message gets printed out. I have changed the name of the .jar file to follow that format, and I have edited the project's name to follow that format, but I still am receiving the error. Am I misunderstanding what that error meant?
     
    Last edited: Jan 4, 2016
  24. Offline

    Mrs. bwfctower

    I'm not getting that. I see all of the files.

    EDIT: Didn't see that post until I posted. Ninja'd.
     
  25. Offline

    ivan bakalov

    Can anyone help me? I am trying to take the dependency for pom.xml, and it's not working. Anyone help?
     
  26. Offline

    Ebaldino

    Hi Ivan,

    This is my entire pom.xml. It works, although I do get warnings because Gravity uses bukkit 1.64 and there's no dependency information for that.

    Code:
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>io.github.ebaldino</groupId>
      <artifactId>SignBoard</artifactId>
      <version>0.8</version>
      <properties>
          <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      </properties>
    <build>
           <defaultGoal>clean package install</defaultGoal>
          <plugins>
              <plugin>
                  <groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-compiler-plugin</artifactId>
                  <configuration>
                      <source>1.7</source>
                      <target>1.7</target>
                  </configuration>
              </plugin>
              <plugin>
                  <groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-shade-plugin</artifactId>
                  <version>2.3</version>          
                  <executions>
                      <execution>
                          <phase>package</phase>
                          <goals>
                              <goal>shade</goal>
                          </goals>
                      </execution>
                  </executions>                  
                  <configuration>
                      <artifactSet>
                          <includes>
                              <include>org.mcstats.*:*</include>
                              <include>net.gravitydevelopment.updater*:*</include>
                          </includes>                            
                      </artifactSet>
                      <relocations>
                          <relocation>
                              <pattern>org.mcstats</pattern>
                              <shadedPattern>io.github.ebaldino.signboard</shadedPattern>
                          </relocation>
                          <relocation>
                             <pattern>net.gravitydevelopment.updater</pattern>
                             <shadedPattern>io.github.ebaldino.signboard</shadedPattern>                     
                         </relocation>                                                                            
                      </relocations>                        
                  </configuration>                    
              </plugin>      
          </plugins>
       </build>
       <repositories>
            <repository>
                <id>Plugin Metrics</id>
                <url>http://repo.mcstats.org/content/repositories/public</url>
            </repository>
           <repository>
               <id>bukkit-repo</id>
               <url>https://hub.spigotmc.org/nexus/content/groups/public/</url>
           </repository>
           <repository>
                <id>gravity-repo</id>
                <url>http://repo.gravitydevelopment.net</url>
            </repository>            
       </repositories>
       <dependencies>
           <dependency>
               <groupId>org.bukkit</groupId>
               <artifactId>bukkit</artifactId>
               <version>1.10-R0.1-SNAPSHOT</version>      
               <type>jar</type>      
           </dependency>             
           <dependency>
                <groupId>net.gravitydevelopment.updater</groupId>
                <artifactId>updater</artifactId>
                <version>2.3</version> 
                <scope>compile</scope>          
            </dependency>    
            <dependency>
                <groupId>org.mcstats.bukkit</groupId>
                <artifactId>metrics</artifactId>
                <version>LATEST</version>
                <scope>compile</scope>
            </dependency>           
       </dependencies>
    </project>
    ===========================================================
     
    Last edited: Aug 27, 2016
  27. Offline

    Ebaldino

    Hi Gravity,

    I got Updater to work with the pom.xml shade and it runs fine.
    (I have an issue about how/where Curse stores files, but I'll try to figure that out myself).

    I edited out the comments I made on my previous post. I finally realized your instructions say that the file's title needs to be in the "v.x.x" format, not the file's name. I feel stupid for not realizing it sooner.

    I'll try it out, I'm fairly sure it'll work.

    Best regards,
     
    Last edited: Aug 27, 2016
  28. Offline

    Machine Maker

    I am having trouble getting the updater to work. This is what my files are called:

    I'm pretty sure this is correct, but I keep getting FAIL_NOVERSION as the UpdateResult. I added code to log in the console the title to see what was being passed to the plugin here:
    Code:
    final String title = this.versionName;
            if (this.type != UpdateType.NO_VERSION_CHECK) {
                final String localVersion = this.plugin.getDescription().getVersion();
                this.plugin.getLogger().info(title);
                if (title.split(DELIMETER).length >= 2) {
                    // Get the newest file's version number
                    final String remoteVersion = title.split(DELIMETER)[title.split(DELIMETER).length - 1].split(" ")[0];
                    if (this.hasTag(localVersion) || !this.shouldUpdate(localVersion, remoteVersion)) {
                        // We already have the latest version, or this build is tagged for no-update
                        this.result = Updater.UpdateResult.NO_UPDATE;
                        return false;
                    }
                } else {
                    // The file's name did not contain the string 'vVersion'
                    final String authorInfo = this.plugin.getDescription().getAuthors().isEmpty() ? "" : " (" + this.plugin.getDescription().getAuthors().get(0) + ")";
                    this.plugin.getLogger().warning("The author of this plugin" + authorInfo + " has misconfigured their Auto Update system");
                    this.plugin.getLogger().warning("File versions should follow the format 'PluginName vVERSION'");
                    this.plugin.getLogger().warning("Please notify the author of this error.");
                    this.result = Updater.UpdateResult.FAIL_NOVERSION;
                    return false;
                }
            }
    The title is DecraftingTable 0.1.5. Idk where that is coming from. What am I doing wrong?
     
  29. Offline

    Cristichi

    Last edited: May 31, 2018
  30. Offline

    xGhOsTkiLLeRx

    Indeed your API results are really weird. The good old gravity version of the Updater is inactive, but I'll maintain a fork that you can find here: https://github.com/timbru31/updater
    I'm going to open an issue that it handles these invalid responses.

    You should try to contact Curse about your issue with your project.
     
  31. Offline

    Cristichi

    Looks like now it works fine, they just needed more time to update the info (it took so long tho...)
     
Thread Status:
Not open for further replies.

Share This Page