Java tutorial
/** * This file is part of GreatmancodeTools. * * Copyright (c) 2013-2015, Greatman <http://github.com/greatman/> * * GreatmancodeTools is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * GreatmancodeTools is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with GreatmancodeTools. If not, see <http://www.gnu.org/licenses/>. */ package com.greatmancode.tools.utils; import com.greatmancode.tools.interfaces.caller.ServerCaller; import org.bukkit.configuration.file.YamlConfiguration; import org.json.simple.JSONArray; import org.json.simple.JSONObject; import org.json.simple.JSONValue; import java.io.BufferedReader; import java.io.File; import java.io.IOException; import java.io.InputStreamReader; import java.net.MalformedURLException; import java.net.URL; import java.net.URLConnection; /** * Check dev.bukkit.org to find updates for a given plugin, and download the updates if needed.<br> * <b>VERY, VERY IMPORTANT</b>: Because there are no standards for adding auto-update toggles in your plugin's config, this system provides NO CHECK WITH YOUR CONFIG to make sure the user has allowed auto-updating. * <br> * It is a <b>BUKKIT POLICY</b> that you include a boolean value in your config that prevents the auto-updater from running <b>AT ALL</b>. * <br> * If you fail to include this option in your config, your plugin will be <b>REJECTED</b> when you attempt to submit it to dev.bukkit.org.<br> * An example of a good configuration option would be something similar to 'auto-update: true' - if this value is set to false you may NOT run the auto-updater. * <br> * If you are unsure about these rules, please read the plugin submission guidelines: http://goo.gl/8iU5l * * @author Gravity * @version 2.0 */ public class Updater { private UpdateType type; private String versionName; private String versionLink; private String versionType; private String versionGameVersion; // Whether to announce file downloads private boolean announce; private ServerCaller caller; // Connecting to RSS private URL url; // Updater thread private Thread thread; // Project's Curse ID private int id = -1; // BukkitDev ServerMods API key private String apiKey = null; // Gets remote file's title private static final String TITLE_VALUE = "name"; // Gets remote file's download link private static final String LINK_VALUE = "downloadUrl"; // Gets remote file's release type private static final String TYPE_VALUE = "releaseType"; // Gets remote file's build version private static final String VERSION_VALUE = "gameVersion"; // Path to GET private static final String QUERY = "/servermods/files?projectIds="; // Slugs will be appended to this to get to the project's RSS feed private static final String HOST = "https://api.curseforge.com"; // If the version number contains one of these, don't update. private static final String[] NO_UPDATE_TAG = { "-DEV", "-PRE", "-SNAPSHOT" }; // Used for downloading files private static final int BYTE_SIZE = 1024; // Config file private YamlConfiguration config; // Used for determining the outcome of the update process private Updater.UpdateResult result = Updater.UpdateResult.SUCCESS; /** * Gives the dev the result of the update process. Can be obtained by called getResult(). */ public enum UpdateResult { /** * The updater found an update, and has readied it to be loaded the next time the server restarts/reloads. */ SUCCESS, /** * The updater did not find an update, and nothing was downloaded. */ NO_UPDATE, /** * The server administrator has disabled the updating system */ DISABLED, /** * The updater found an update, but was unable to download it. */ FAIL_DOWNLOAD, /** * For some reason, the updater was unable to contact dev.bukkit.org to download the file. */ FAIL_DBO, /** * When running the version check, the file on DBO did not contain the a version in the format 'vVersion' such as 'v1.0'. */ FAIL_NOVERSION, /** * The id provided by the plugin running the updater was invalid and doesn't exist on DBO. */ FAIL_BADID, /** * The server administrator has improperly configured their API key in the configuration */ FAIL_APIKEY, /** * The updater found an update, but because of the UpdateType being set to NO_DOWNLOAD, it wasn't downloaded. */ UPDATE_AVAILABLE } /** * Allows the dev to specify the type of update that will be run. */ public enum UpdateType { /** * Run a version check, and then if the file is out of date, download the newest version. */ DEFAULT, /** * Don't run a version check, just find the latest update and download it. */ NO_VERSION_CHECK, /** * Get information about the version and the download size, but don't actually download anything. */ NO_DOWNLOAD } /** * Initialize the updater * * @param caller The Server Caller * @param id The dev.bukkit.org id of the project * @param type Specify the type of update this will be. See {@link UpdateType} * @param announce True if the program should announce the progress of new updates in console */ public Updater(ServerCaller caller, int id, UpdateType type, boolean announce) { this.caller = caller; this.type = type; this.announce = announce; this.id = id; final File pluginFile = caller.getDataFolder().getParentFile(); final File updaterFile = new File(pluginFile, "Updater"); final File updaterConfigFile = new File(updaterFile, "config.yml"); if (!updaterFile.exists()) { updaterFile.mkdir(); } if (!updaterConfigFile.exists()) { try { updaterConfigFile.createNewFile(); } catch (final IOException e) { caller.getLogger() .severe("The updater could not create a configuration in " + updaterFile.getAbsolutePath()); e.printStackTrace(); } } this.config = YamlConfiguration.loadConfiguration(updaterConfigFile); this.config.options().header( "This configuration file affects all plugins using the Updater system (version 2+ - http://forums.bukkit.org/threads/96681/ )" + '\n' + "If you wish to use your API key, read http://wiki.bukkit.org/ServerMods_API and place it below." + '\n' + "Some updating systems will not adhere to the disabled value, but these may be turned off in their plugin's configuration."); this.config.addDefault("api-key", "PUT_API_KEY_HERE"); this.config.addDefault("disable", false); if (this.config.get("api-key", null) == null) { this.config.options().copyDefaults(true); try { this.config.save(updaterConfigFile); } catch (final IOException e) { caller.getLogger() .severe("The updater could not save the configuration in " + updaterFile.getAbsolutePath()); e.printStackTrace(); } } if (this.config.getBoolean("disable")) { this.result = UpdateResult.DISABLED; return; } String key = this.config.getString("api-key"); if (key.equalsIgnoreCase("PUT_API_KEY_HERE") || key.equals("")) { key = null; } this.apiKey = key; try { this.url = new URL(Updater.HOST + Updater.QUERY + id); } catch (final MalformedURLException e) { caller.getLogger().severe("The project ID provided for updating, " + id + " is invalid."); this.result = UpdateResult.FAIL_BADID; e.printStackTrace(); } this.thread = new Thread(new UpdateRunnable()); this.thread.start(); } /** * Get the result of the update process. */ public Updater.UpdateResult getResult() { this.waitForThread(); return this.result; } /** * Get the latest version's release type (release, beta, or alpha). */ public String getLatestType() { this.waitForThread(); return this.versionType; } /** * Get the latest version's game version. */ public String getLatestGameVersion() { this.waitForThread(); return this.versionGameVersion; } /** * Get the latest version's name. * @return the latest version name */ public String getLatestName() { this.waitForThread(); return this.versionName; } /** * Get the latest version's file link. * @return The latest version file link. */ public String getLatestFileLink() { this.waitForThread(); return this.versionLink; } /** * As the result of Updater output depends on the thread's completion, it is necessary to wait for the thread to finish * before allowing anyone to check the result. */ private void waitForThread() { if ((this.thread != null) && this.thread.isAlive()) { try { this.thread.join(); } catch (final InterruptedException e) { e.printStackTrace(); } } } /** * Check to see if the program should continue by evaluation whether the plugin is already updated, or shouldn't be updated */ private boolean versionCheck(String title) { if (this.type != UpdateType.NO_VERSION_CHECK) { final String version = caller.getPluginVersion(); final String remoteVersion = title; // Get the newest file's version number if (this.hasTag(version) || version.contains(remoteVersion)) { // We already have the latest version, or this build is tagged for no-update this.result = Updater.UpdateResult.NO_UPDATE; return false; } } return true; } /** * Evaluate whether the version number is marked showing that it should not be updated by this program */ private boolean hasTag(String version) { for (final String string : Updater.NO_UPDATE_TAG) { if (version.contains(string)) { return true; } } return false; } private boolean read() { try { final URLConnection conn = this.url.openConnection(); conn.setConnectTimeout(5000); if (this.apiKey != null) { conn.addRequestProperty("X-API-Key", this.apiKey); } conn.addRequestProperty("User-Agent", "Updater (by Gravity)"); conn.setDoOutput(true); final BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream())); final String response = reader.readLine(); final JSONArray array = (JSONArray) JSONValue.parse(response); if (array.size() == 0) { caller.getLogger().warning("The updater could not find any files for the project id " + this.id); this.result = UpdateResult.FAIL_BADID; return false; } this.versionName = (String) ((JSONObject) array.get(array.size() - 1)).get(Updater.TITLE_VALUE); this.versionLink = (String) ((JSONObject) array.get(array.size() - 1)).get(Updater.LINK_VALUE); this.versionType = (String) ((JSONObject) array.get(array.size() - 1)).get(Updater.TYPE_VALUE); this.versionGameVersion = (String) ((JSONObject) array.get(array.size() - 1)) .get(Updater.VERSION_VALUE); return true; } catch (final IOException e) { if (e.getMessage().contains("HTTP response code: 403")) { caller.getLogger() .warning("dev.bukkit.org rejected the API key provided in plugins/Updater/config.yml"); caller.getLogger().warning("Please double-check your configuration to ensure it is correct."); this.result = UpdateResult.FAIL_APIKEY; } else { caller.getLogger().warning("The updater could not contact dev.bukkit.org for updating."); caller.getLogger().warning( "If you have not recently modified your configuration and this is the first time you are seeing this message, the site may be experiencing temporary downtime."); this.result = UpdateResult.FAIL_DBO; } e.printStackTrace(); return false; } } private class UpdateRunnable implements Runnable { @Override public void run() { if (Updater.this.url != null) { // Obtain the results of the project's file feed if (Updater.this.read()) { if (Updater.this.versionCheck(Updater.this.versionName)) { if ((Updater.this.versionLink != null) && (Updater.this.type != UpdateType.NO_DOWNLOAD)) { } else { Updater.this.result = UpdateResult.UPDATE_AVAILABLE; } } } } } } }