From d7e46215b86ebaeb2615c3a9b7eaeb1f1fb55eab Mon Sep 17 00:00:00 2001 From: Dan Mulloy Date: Thu, 27 Nov 2014 20:35:30 -0500 Subject: [PATCH] Format pom.xml and plugin.yml, completely remove updater --- ProtocolLib/pom.xml | 40 +- .../comphenix/protocol/CommandProtocol.java | 38 +- .../comphenix/protocol/ProtocolLibrary.java | 132 +--- .../comphenix/protocol/metrics/Updater.java | 625 ------------------ ProtocolLib/src/main/resources/plugin.yml | 3 +- 5 files changed, 43 insertions(+), 795 deletions(-) delete mode 100644 ProtocolLib/src/main/java/com/comphenix/protocol/metrics/Updater.java diff --git a/ProtocolLib/pom.xml b/ProtocolLib/pom.xml index 1f579e5d..5055a4d6 100644 --- a/ProtocolLib/pom.xml +++ b/ProtocolLib/pom.xml @@ -4,8 +4,11 @@ com.comphenix.protocol ProtocolLib 3.6.0-SNAPSHOT - jar + ProtocolLib + Provides read/write access to the Minecraft protocol. + http://www.spigotmc.org/resources/protocollib.1997/ + jar cp1252 @@ -14,15 +17,10 @@ - comphenix-releases - Comphenix Maven Releases - http://repo.comphenix.net/content/repositories/releases/ + shadowvolt-repo + Shadowvolt Maven Repository + http://ci.shadowvolt.com/plugin/repository/everything/ - - comphenix-snapshots - Comphenix Maven Snapshots - http://repo.comphenix.net/content/repositories/snapshots/ - @@ -32,7 +30,6 @@ comphenix-releases - Comphenix Maven Releases http://repo.comphenix.net/content/repositories/releases/ @@ -94,26 +91,6 @@ - - org.apache.maven.plugins maven-jar-plugin @@ -202,9 +179,6 @@ - http://dev.bukkit.org/server-mods/protocollib/ - ProtocolLib - scm:git:git://github.com/aadnk/ProtocolLib.git scm:git:git@github.com:aadnk/ProtocolLib.git diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/CommandProtocol.java b/ProtocolLib/src/main/java/com/comphenix/protocol/CommandProtocol.java index 96399015..258aaa1e 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/CommandProtocol.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/CommandProtocol.java @@ -26,8 +26,6 @@ import org.bukkit.plugin.Plugin; import com.comphenix.protocol.error.ErrorReporter; import com.comphenix.protocol.events.PacketListener; -import com.comphenix.protocol.metrics.Updater; -import com.comphenix.protocol.metrics.Updater.UpdateType; import com.comphenix.protocol.timing.TimedListenerManager; import com.comphenix.protocol.timing.TimingReportGenerator; @@ -43,13 +41,11 @@ class CommandProtocol extends CommandBase { public static final String NAME = "protocol"; private Plugin plugin; - private Updater updater; private ProtocolConfig config; - public CommandProtocol(ErrorReporter reporter, Plugin plugin, Updater updater, ProtocolConfig config) { + public CommandProtocol(ErrorReporter reporter, Plugin plugin, ProtocolConfig config) { super(reporter, CommandBase.PERMISSION_ADMIN, NAME, 1); this.plugin = plugin; - this.updater = updater; this.config = config; } @@ -60,10 +56,6 @@ class CommandProtocol extends CommandBase { // Only return TRUE if we executed the correct command if (subCommand.equalsIgnoreCase("config") || subCommand.equalsIgnoreCase("reload")) reloadConfiguration(sender); - else if (subCommand.equalsIgnoreCase("check")) - checkVersion(sender); - // else if (subCommand.equalsIgnoreCase("update")) - // updateVersion(sender); else if (subCommand.equalsIgnoreCase("timings")) toggleTimings(sender, args); else if (subCommand.equalsIgnoreCase("listeners")) @@ -73,14 +65,6 @@ class CommandProtocol extends CommandBase { return true; } - public void checkVersion(final CommandSender sender) { - performUpdate(sender, UpdateType.NO_DOWNLOAD); - } - - public void updateVersion(final CommandSender sender) { - performUpdate(sender, UpdateType.DEFAULT); - } - // Display every listener on the server private void printListeners(final CommandSender sender, String[] args) { ProtocolManager manager = ProtocolLibrary.getProtocolManager(); @@ -96,26 +80,6 @@ class CommandProtocol extends CommandBase { } } - private void performUpdate(final CommandSender sender, UpdateType type) { - if (updater.isChecking()) { - sender.sendMessage(ChatColor.RED + "Already checking for an update."); - return; - } - - // Perform on an async thread - Runnable notify = new Runnable() { - @Override - public void run() { - sender.sendMessage(ChatColor.YELLOW + "[ProtocolLib] " + updater.getResult()); - - updater.removeListener(this); - updateFinished(); - } - }; - updater.start(type); - updater.addListener(notify); - } - private void toggleTimings(CommandSender sender, String[] args) { TimedListenerManager manager = TimedListenerManager.getInstance(); boolean state = !manager.isTiming(); // toggle diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/ProtocolLibrary.java b/ProtocolLib/src/main/java/com/comphenix/protocol/ProtocolLibrary.java index 64abbc00..20675c4b 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/ProtocolLibrary.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/ProtocolLibrary.java @@ -94,10 +94,6 @@ public class ProtocolLibrary extends JavaPlugin { */ public static final String MINECRAFT_LAST_RELEASE_DATE = "2013-12-10"; - // Update information -// static final String BUKKIT_DEV_SLUG = "protocollib"; -// static final int BUKKIT_DEV_ID = 45564; - // Different commands private enum ProtocolCommand { FILTER, @@ -131,7 +127,7 @@ public class ProtocolLibrary extends JavaPlugin { // Structure compiler private BackgroundCompiler backgroundCompiler; - // Used to clean up server packets that have expired. But mostly required to simulate + // Used to clean up server packets that have expired, but mostly required to simulate // recieving client packets. private int packetTask = -1; private int tickCounter = 0; @@ -143,13 +139,9 @@ public class ProtocolLibrary extends JavaPlugin { // Settings/options private int configExpectedMod = -1; - // Updater -// private Updater updater; -// private static boolean UPDATES_DISABLED; - - // Logger - private Logger logger; - private Handler redirectHandler; + // Logger + private Logger logger; + private Handler redirectHandler; // Commands private CommandProtocol commandProtocol; @@ -206,19 +198,8 @@ public class ProtocolLibrary extends JavaPlugin { // Handle unexpected Minecraft versions MinecraftVersion version = verifyMinecraftVersion(); - // TODO: Redo the update mechanism for Spigot? - // Set updater - this will not perform any update automatically -// updater = new Updater(this, BUKKIT_DEV_ID, getFile(), UpdateType.NO_DOWNLOAD, true); - unhookTask = new DelayedSingleTask(this); - protocolManager = PacketFilterManager.newBuilder(). - classLoader(getClassLoader()). - server(getServer()). - library(this). - minecraftVersion(version). - unhookTask(unhookTask). - reporter(reporter). - build(); + protocolManager = PacketFilterManager.newBuilder().classLoader(getClassLoader()).server(getServer()).library(this).minecraftVersion(version).unhookTask(unhookTask).reporter(reporter).build(); // Setup error reporter detailedReporter.addGlobalParameter("manager", protocolManager); @@ -258,20 +239,22 @@ public class ProtocolLibrary extends JavaPlugin { for (ProtocolCommand command : ProtocolCommand.values()) { try { switch (command) { - case PROTOCOL: - commandProtocol = new CommandProtocol(reporter, this, null, config); break; - case FILTER: - commandFilter = new CommandFilter(reporter, this, config); break; - case PACKET: - commandPacket = new CommandPacket(reporter, this, logger, commandFilter, protocolManager); break; + case PROTOCOL: + commandProtocol = new CommandProtocol(reporter, this, config); + break; + case FILTER: + commandFilter = new CommandFilter(reporter, this, config); + break; + case PACKET: + commandPacket = new CommandPacket(reporter, this, logger, commandFilter, protocolManager); + break; } } catch (OutOfMemoryError e) { throw e; } catch (ThreadDeath e) { throw e; } catch (Throwable e) { - reporter.reportWarning(this, Report.newBuilder(REPORT_CANNOT_REGISTER_COMMAND). - messageParam(command.name(), e.getMessage()).error(e)); + reporter.reportWarning(this, Report.newBuilder(REPORT_CANNOT_REGISTER_COMMAND).messageParam(command.name(), e.getMessage()).error(e)); } } } @@ -325,13 +308,13 @@ public class ProtocolLibrary extends JavaPlugin { } } - private void setupBroadcastUsers(final String permission) { - // Guard against multiple calls - if (redirectHandler != null) - return; + private void setupBroadcastUsers(final String permission) { + // Guard against multiple calls + if (redirectHandler != null) + return; - // Broadcast information to every user too - redirectHandler = new Handler() { + // Broadcast information to every user too + redirectHandler = new Handler() { @Override public void publish(LogRecord record) { // Only display warnings and above @@ -351,8 +334,8 @@ public class ProtocolLibrary extends JavaPlugin { } }; - logger.addHandler(redirectHandler); - } + logger.addHandler(redirectHandler); + } @Override public void onEnable() { @@ -366,10 +349,7 @@ public class ProtocolLibrary extends JavaPlugin { // Silly plugin reloaders! if (protocolManager == null) { Logger directLogging = Logger.getLogger("Minecraft"); - String[] message = new String[] { - " PROTOCOLLIB DOES NOT SUPPORT PLUGIN RELOADERS. ", - " PLEASE USE THE BUILT-IN RELOAD COMMAND. ", - }; + String[] message = new String[] { " PROTOCOLLIB DOES NOT SUPPORT PLUGIN RELOADERS. ", " PLEASE USE THE BUILT-IN RELOAD COMMAND. ", }; // Print as severe for (String line : ChatExtensions.toFlowerBox(message, "*", 3, 1)) { @@ -442,12 +422,11 @@ public class ProtocolLibrary extends JavaPlugin { logger.warning("Version " + current + " is lower than the minimum " + minimum); if (current.compareTo(maximum) > 0) logger.warning("Version " + current + " has not yet been tested! Proceed with caution."); - } + } return current; } catch (Exception e) { - reporter.reportWarning(this, - Report.newBuilder(REPORT_CANNOT_PARSE_MINECRAFT_VERSION).error(e).messageParam(maximum)); + reporter.reportWarning(this, Report.newBuilder(REPORT_CANNOT_PARSE_MINECRAFT_VERSION).error(e).messageParam(maximum)); // Unknown version - just assume it is the latest return maximum; @@ -492,10 +471,7 @@ public class ProtocolLibrary extends JavaPlugin { // We don't need to set internal classes or instances to NULL - that would break the other loaded plugin skipDisable = true; - throw new IllegalStateException( - String.format("Detected a newer version of ProtocolLib (%s) in plugin folder than the current (%s). Disabling.", - newestVersion.getVersion(), currentVersion.getVersion()) - ); + throw new IllegalStateException(String.format("Detected a newer version of ProtocolLib (%s) in plugin folder than the current (%s). Disabling.", newestVersion.getVersion(), currentVersion.getVersion())); } } @@ -514,9 +490,7 @@ public class ProtocolLibrary extends JavaPlugin { throw new RuntimeException("plugin.yml might be corrupt."); } catch (RuntimeException e) { - reporter.reportWarning(this, - Report.newBuilder(REPORT_CANNOT_REGISTER_COMMAND).messageParam(name, e.getMessage()).error(e) - ); + reporter.reportWarning(this, Report.newBuilder(REPORT_CANNOT_REGISTER_COMMAND).messageParam(name, e.getMessage()).error(e)); } } @@ -541,18 +515,12 @@ public class ProtocolLibrary extends JavaPlugin { // We KNOW we're on the main thread at the moment manager.sendProcessedPackets(tickCounter++, true); - // House keeping - updateConfiguration(); - - // Check for updates too -// if (!UPDATES_DISABLED && (tickCounter % 20) == 0) { -// checkUpdates(); -// } - } - }, ASYNC_MANAGER_DELAY, ASYNC_MANAGER_DELAY); - - } catch (OutOfMemoryError e) { - throw e; + // House keeping + updateConfiguration(); + } + }, ASYNC_MANAGER_DELAY, ASYNC_MANAGER_DELAY); + } catch (OutOfMemoryError e) { + throw e; } catch (ThreadDeath e) { throw e; } catch (Throwable e) { @@ -571,38 +539,12 @@ public class ProtocolLibrary extends JavaPlugin { } } -// private void checkUpdates() { -// // Ignore milliseconds - it's pointless -// long currentTime = System.currentTimeMillis() / MILLI_PER_SECOND; -// -// try { -// long updateTime = config.getAutoLastTime() + config.getAutoDelay(); -// -// // Should we update? -// if (currentTime > updateTime && !updater.isChecking()) { -// // Initiate the update as if it came from the console -// if (config.isAutoDownload()) -// commandProtocol.updateVersion(getServer().getConsoleSender()); -// else if (config.isAutoNotify()) -// commandProtocol.checkVersion(getServer().getConsoleSender()); -// else -// commandProtocol.updateFinished(); -// } -// } catch (Exception e) { -// reporter.reportDetailed(this, Report.newBuilder(REPORT_CANNOT_UPDATE_PLUGIN).error(e)); -// UPDATES_DISABLED = true; -// } -// } - @Override public void onDisable() { if (skipDisable) { return; } - // Bukkit will shut down tasks on our executors - // ... - // Disable compiler if (backgroundCompiler != null) { backgroundCompiler.shutdownAll(); @@ -632,12 +574,6 @@ public class ProtocolLibrary extends JavaPlugin { // To clean up global parameters reporter = new BasicErrorReporter(); - - // Leaky ClassLoader begone! -// if (updater == null || updater.getResult() != UpdateResult.SUCCESS) { -// CleanupStaticMembers cleanup = new CleanupStaticMembers(getClassLoader(), reporter); -// cleanup.resetAll(); -// } } // Get the Bukkit logger first, before we try to create our own diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/metrics/Updater.java b/ProtocolLib/src/main/java/com/comphenix/protocol/metrics/Updater.java deleted file mode 100644 index d39dc9aa..00000000 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/metrics/Updater.java +++ /dev/null @@ -1,625 +0,0 @@ -/* - * Updater for Bukkit. - * - * This class provides the means to safely and easily update a plugin, or check to see if it is updated using dev.bukkit.org - */ - -// Somewhat modified by aadnk. -package com.comphenix.protocol.metrics; - -import java.io.BufferedInputStream; -import java.io.BufferedOutputStream; -import java.io.BufferedReader; -import java.io.File; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.InputStreamReader; -import java.net.MalformedURLException; -import java.net.URL; -import java.net.URLConnection; -import java.util.Enumeration; -import java.util.List; -import java.util.concurrent.CopyOnWriteArrayList; -import java.util.zip.ZipEntry; -import java.util.zip.ZipFile; - -import org.bukkit.configuration.file.YamlConfiguration; -import org.bukkit.plugin.Plugin; -import org.json.simple.JSONArray; -import org.json.simple.JSONObject; -import org.json.simple.JSONValue; - -import com.comphenix.protocol.ProtocolLibrary; -import com.comphenix.protocol.error.Report; -import com.comphenix.protocol.error.ReportType; -import com.comphenix.protocol.utility.MinecraftVersion; -import com.google.common.base.Preconditions; - -/** - * Check dev.bukkit.org to find updates for a given plugin, and download the updates if needed. - *

- * VERY, VERY IMPORTANT: 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. - *
- * It is a BUKKIT POLICY that you include a boolean value in your config that prevents the auto-updater from running AT ALL. - *
- * If you fail to include this option in your config, your plugin will be REJECTED when you attempt to submit it to dev.bukkit.org. - *

- * 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. - *
- * 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 { - public static final ReportType REPORT_CANNOT_UPDATE_PLUGIN = new ReportType("Cannot update ProtocolLib."); - - private Plugin plugin; - private UpdateType type; - private String versionName; - private String versionLink; - private String versionType; - private String versionGameVersion; - private String versionFileName; - - private boolean announce; // Whether to announce file downloads - - private URL url; // Connecting to RSS - private File file; // The plugin's file - private Thread thread; // Updater thread - - private int id = -1; // Project's Curse ID - private String apiKey = null; // BukkitDev ServerMods API key - private static final String TITLE_VALUE = "name"; // Gets remote file's title - private static final String LINK_VALUE = "downloadUrl"; // Gets remote file's download link - private static final String TYPE_VALUE = "releaseType"; // Gets remote file's release type - private static final String VERSION_VALUE = "gameVersion"; // Gets remote file's build version - private static final Object FILE_NAME = "fileName"; // Gets remote file's name - private static final String QUERY = "/servermods/files?projectIds="; // Path to GET - private static final String HOST = "https://api.curseforge.com"; // Slugs will be appended to this to get to the project's RSS feed - - private static final String[] NO_UPDATE_TAG = { "-DEV", "-PRE", "-SNAPSHOT" }; // If the version number contains one of these, don't update. - private static final int BYTE_SIZE = 1024; // Used for downloading files - - private YamlConfiguration config; // Config file - private String updateFolder;// The folder that downloads will be placed in - private Updater.UpdateResult result = Updater.UpdateResult.SUCCESS; // Used for determining the outcome of the update process - private List listeners = new CopyOnWriteArrayList(); - - /** - * 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 found an update, and has readied it to be loaded the next time the server restarts/reloads."), - - /** - * The updater did not find an update, and nothing was downloaded. - */ - NO_UPDATE("The updater did not find an update, and nothing was downloaded."), - - /** - * The server administrator has disabled the updating system - */ - DISABLED("The server administrator has disabled the updating system"), - - /** - * The updater found an update, but was unable to download it. - */ - FAIL_DOWNLOAD("The updater found an update, but was unable to download it."), - - /** - * For some reason, the updater was unable to contact dev.bukkit.org to download the file. - */ - FAIL_DBO("For some reason, the updater was unable to contact dev.bukkit.org to download the file.") - , - /** - * 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("When running the version check, the file on DBO did not contain the a version in the format 'vVersion' such as 'v1.0'."), - - /** - * The id provided by the plugin running the updater was invalid and doesn't exist on DBO. - */ - FAIL_BADID("The id provided by the plugin running the updater was invalid and doesn't exist on DBO."), - - /** - * The server administrator has improperly configured their API key in the configuration - */ - FAIL_APIKEY("The server administrator has improperly configured their API key in the configuration"), - - /** - * The updater found an update, but because of the UpdateType being set to NO_DOWNLOAD, it wasn't downloaded. - */ - UPDATE_AVAILABLE("The updater found an update, but because of the UpdateType being set to NO_DOWNLOAD, it wasn't downloaded."); - - private final String description; - - private UpdateResult(String description) { - this.description = description; - } - - @Override - public String toString() { - return description; - } - } - - /** - * 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. - *

- * Call {@link #start()} to actually start looking (and downloading) updates. - * - * @param plugin The plugin that is checking for an update. - * @param id The dev.bukkit.org id of the project - * @param file The file that the plugin is running from, get this by doing this.getFile() from within your main class. - * @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(Plugin plugin, int id, File file, UpdateType type, boolean announce) { - this.plugin = plugin; - this.type = type; - this.announce = announce; - this.file = file; - this.id = id; - this.updateFolder = plugin.getServer().getUpdateFolder(); - - final File pluginFile = plugin.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) { - plugin.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) { - plugin.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) { - plugin.getLogger().severe("The project ID provided for updating, " + id + " is invalid."); - this.result = UpdateResult.FAIL_BADID; - e.printStackTrace(); - } - } - - // aadnk - decouple the thread start and the constructor. - /** - * Begin looking for updates. - * @param type - the update type. - */ - public void start(UpdateType type) { - waitForThread(); - - this.type = type; - this.thread = new Thread(new UpdateRunnable()); - this.thread.start(); - } - - /** - * Add a listener to be executed when we have determined if an update is available. - *

- * The listener will be executed on the main thread. - * @param listener - the listener to add. - */ - public void addListener(Runnable listener) { - listeners.add(Preconditions.checkNotNull(listener, "listener cannot be NULL")); - } - - /** - * Remove a listener. - * @param listener - the listener to remove. - * @return TRUE if the listener was removed, FALSE otherwise. - */ - public boolean removeListener(Runnable listener) { - return listeners.remove(listener); - } - - /** - * 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. - */ - public String getLatestName() { - this.waitForThread(); - return this.versionName; - } - - /** - * Get the latest version's 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(); - } - } - } - - /** - * Determine if we are already checking for an update. - * @return TRUE if we are, FALSE otherwise. - */ - public boolean isChecking() { - return this.thread != null && this.thread.isAlive(); - } - - /** - * Save an update from dev.bukkit.org into the server's update folder. - */ - private void saveFile(File folder, String file, String u) { - if (!folder.exists()) { - folder.mkdir(); - } - BufferedInputStream in = null; - FileOutputStream fout = null; - try { - // Download the file - final URL url = new URL(u); - final int fileLength = url.openConnection().getContentLength(); - in = new BufferedInputStream(url.openStream()); - fout = new FileOutputStream(folder.getAbsolutePath() + "/" + file); - - final byte[] data = new byte[Updater.BYTE_SIZE]; - int count; - if (this.announce) { - this.plugin.getLogger().info("About to download a new update: " + this.versionName); - } - long downloaded = 0; - while ((count = in.read(data, 0, Updater.BYTE_SIZE)) != -1) { - downloaded += count; - fout.write(data, 0, count); - final int percent = (int) ((downloaded * 100) / fileLength); - if (this.announce && ((percent % 10) == 0)) { - this.plugin.getLogger().info("Downloading update: " + percent + "% of " + fileLength + " bytes."); - } - } - //Just a quick check to make sure we didn't leave any files from last time... - for (final File xFile : new File(this.plugin.getDataFolder().getParent(), this.updateFolder).listFiles()) { - if (xFile.getName().endsWith(".zip")) { - xFile.delete(); - } - } - // Check to see if it's a zip file, if it is, unzip it. - final File dFile = new File(folder.getAbsolutePath() + "/" + file); - if (dFile.getName().endsWith(".zip")) { - // Unzip - this.unzip(dFile.getCanonicalPath()); - } - if (this.announce) { - this.plugin.getLogger().info("Finished updating."); - } - } catch (final Exception ex) { - this.plugin.getLogger().warning("The auto-updater tried to download a new update, but was unsuccessful."); - this.result = Updater.UpdateResult.FAIL_DOWNLOAD; - } finally { - try { - if (in != null) { - in.close(); - } - if (fout != null) { - fout.close(); - } - } catch (final Exception ex) { - } - } - } - - /** - * Part of Zip-File-Extractor, modified by Gravity for use with Bukkit - */ - private void unzip(String file) { - try { - final File fSourceZip = new File(file); - final String zipPath = file.substring(0, file.length() - 4); - ZipFile zipFile = new ZipFile(fSourceZip); - Enumeration e = zipFile.entries(); - while (e.hasMoreElements()) { - ZipEntry entry = e.nextElement(); - File destinationFilePath = new File(zipPath, entry.getName()); - destinationFilePath.getParentFile().mkdirs(); - if (entry.isDirectory()) { - continue; - } else { - final BufferedInputStream bis = new BufferedInputStream(zipFile.getInputStream(entry)); - int b; - final byte buffer[] = new byte[Updater.BYTE_SIZE]; - final FileOutputStream fos = new FileOutputStream(destinationFilePath); - final BufferedOutputStream bos = new BufferedOutputStream(fos, Updater.BYTE_SIZE); - while ((b = bis.read(buffer, 0, Updater.BYTE_SIZE)) != -1) { - bos.write(buffer, 0, b); - } - bos.flush(); - bos.close(); - bis.close(); - final String name = destinationFilePath.getName(); - if (name.endsWith(".jar") && this.pluginFile(name)) { - destinationFilePath.renameTo(new File(this.plugin.getDataFolder().getParent(), this.updateFolder + "/" + name)); - } - } - entry = null; - destinationFilePath = null; - } - e = null; - zipFile.close(); - zipFile = null; - - // Move any plugin data folders that were included to the right place, Bukkit won't do this for us. - for (final File dFile : new File(zipPath).listFiles()) { - if (dFile.isDirectory()) { - if (this.pluginFile(dFile.getName())) { - final File oFile = new File(this.plugin.getDataFolder().getParent(), dFile.getName()); // Get current dir - final File[] contents = oFile.listFiles(); // List of existing files in the current dir - for (final File cFile : dFile.listFiles()) // Loop through all the files in the new dir - { - boolean found = false; - for (final File xFile : contents) // Loop through contents to see if it exists - { - if (xFile.getName().equals(cFile.getName())) { - found = true; - break; - } - } - if (!found) { - // Move the new file into the current dir - cFile.renameTo(new File(oFile.getCanonicalFile() + "/" + cFile.getName())); - } else { - // This file already exists, so we don't need it anymore. - cFile.delete(); - } - } - } - } - dFile.delete(); - } - new File(zipPath).delete(); - fSourceZip.delete(); - } catch (final IOException ex) { - this.plugin.getLogger().warning("The auto-updater tried to unzip a new update file, but was unsuccessful."); - this.result = Updater.UpdateResult.FAIL_DOWNLOAD; - ex.printStackTrace(); - } - new File(file).delete(); - } - - /** - * Check if the name of a jar is one of the plugins currently installed, used for extracting the correct files out of a zip. - */ - private boolean pluginFile(String name) { - for (final File file : new File("plugins").listFiles()) { - if (file.getName().equals(name)) { - return true; - } - } - return false; - } - - /** - * 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 = this.plugin.getDescription().getVersion(); - final String[] splitTitle = title.split(" "); - - // aadnk - expect a Maven-style version format (ARTIFACT 1.2.3-SNAPSHOT). - if (splitTitle.length == 2) { - // Get the newest file's version number - final String remoteVersion = splitTitle[1].split("-")[0]; - - // Parse the version - MinecraftVersion parsedRemote = new MinecraftVersion(remoteVersion); - MinecraftVersion parsedCurrent = new MinecraftVersion(plugin.getDescription().getVersion()); - - // The remote version has to be greater - if (this.hasTag(version) || parsedRemote.compareTo(parsedCurrent) <= 0) { - // 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().size() == 0 ? "" : " (" + 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 VERSION[-SNAPSHOT]'"); - this.plugin.getLogger().warning("Please notify the author of this error."); - this.result = Updater.UpdateResult.FAIL_NOVERSION; - 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) { - this.plugin.getLogger().warning("The updater could not find any files for the project id " + this.id); - this.result = UpdateResult.FAIL_BADID; - return false; - } - - final JSONObject jsonObject = (JSONObject) array.get(array.size() - 1); - this.versionFileName = (String) jsonObject.get(Updater.FILE_NAME); - this.versionName = (String) jsonObject.get(Updater.TITLE_VALUE); - this.versionLink = (String) jsonObject.get(Updater.LINK_VALUE); - this.versionType = (String) jsonObject.get(Updater.TYPE_VALUE); - this.versionGameVersion = (String) jsonObject.get(Updater.VERSION_VALUE); - - return true; - } catch (final IOException e) { - if (e.getMessage().contains("HTTP response code: 403")) { - this.plugin.getLogger().warning("dev.bukkit.org rejected the API key provided in plugins/Updater/config.yml"); - this.plugin.getLogger().warning("Please double-check your configuration to ensure it is correct."); - this.result = UpdateResult.FAIL_APIKEY; - } else { - this.plugin.getLogger().warning("The updater could not contact dev.bukkit.org for updating."); - this.plugin.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; - } - } - - // aadnk - added listeners - private class UpdateRunnable implements Runnable { - @Override - public void run() { - try { - 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)) { - performUpdate(); - } - } - } - } catch (Exception e) { - // Any generic error will be handled here - ProtocolLibrary.getErrorReporter().reportDetailed( - Updater.this, Report.newBuilder(REPORT_CANNOT_UPDATE_PLUGIN).error(e).callerParam(this)); - - } finally { - // Invoke the listeners on the main thread - for (Runnable listener : listeners) { - plugin.getServer().getScheduler().scheduleSyncDelayedTask(plugin, listener); - } - } - } - - private void performUpdate() { - if ((Updater.this.versionLink != null) && (Updater.this.type != UpdateType.NO_DOWNLOAD)) { - final File pluginFolder = plugin.getDataFolder().getParentFile(); - File destinationFolder = new File(pluginFolder, updateFolder); - String name = Updater.this.file.getName(); - - // If it's a zip file, it shouldn't be downloaded as the plugin's name - if (Updater.this.versionLink.endsWith(".zip")) { - name = versionFileName; - } - Updater.this.saveFile( - destinationFolder, - name, - Updater.this.versionLink - ); - } else { - Updater.this.result = UpdateResult.UPDATE_AVAILABLE; - } - } - } -} diff --git a/ProtocolLib/src/main/resources/plugin.yml b/ProtocolLib/src/main/resources/plugin.yml index 5104fcce..c24be3a3 100644 --- a/ProtocolLib/src/main/resources/plugin.yml +++ b/ProtocolLib/src/main/resources/plugin.yml @@ -1,8 +1,7 @@ name: ProtocolLib version: ${project.version} description: Provides read/write access to the Minecraft protocol. -author: Comphenix -website: http://www.comphenix.net/ProtocolLib +authors: [dmulloy2, comphenix] main: com.comphenix.protocol.ProtocolLibrary load: startup