EpicKnarvik97/Jail
EpicKnarvik97/Jail
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update notifications! For dev, stable-dev, and bukkit channels! :)

Browse Source
This commit is contained in:
graywolf336 2014-07-21 18:17:30 -05:00
parent 6fe5eeb346
commit 1c92f90ccc
11 changed files with 284 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -51,7 +51,6 @@ ToDo
* Jailing for swearing
* Guards (PlayerMoveProtectionAction - when they try to move do we teleport them back, let the guards get them, or nothing)
* Storing permissions
* Update Notifications
* Pages on jail list
Notice

47
pom.xml
View File

@ -8,20 +8,27 @@
<name>Jail</name>
<description>Ban too harsh? Mute too weak? Kicking not enough? Jail them!</description>
<url>http://dev.bukkit.org/bukkit-plugins/jail/</url>
<ciManagement>
<url>http://ci.graywolf336.com/job/Jail/</url>
<system>jenkins</system>
</ciManagement>
<issueManagement>
<url>http://dev.bukkit.org/bukkit-plugins/jail/tickets/</url>
<system>Dev Bukkit</system>
</issueManagement>
<scm>
<url>https://github.com/graywolf336/Jail</url>
<connection>scm:git:git://github.com/graywolf336/Jail.git</connection>
<developerConnection>scm:git:git:@github.com/graywolf336/Jail.git</developerConnection>
</scm>
<properties>
<project.build.number>0</project.build.number>
</properties>
<repositories>
<repository>
<id>vault-repo</id>
@ -112,6 +119,20 @@
<!-- End of Test Dependencies -->
</dependencies>
<profiles>
<profile>
<id>jenkins</id>
<activation>
<property>
<name>env.BUILD_NUMBER</name>
</property>
</activation>
<properties>
<project.build.number>${env.BUILD_NUMBER}</project.build.number>
</properties>
</profile>
</profiles>
<build>
<directory>target</directory>
<outputDirectory>target/classes</outputDirectory>
@ -148,7 +169,31 @@
</configuration>
</plugin>
<!-- Jar Plugin -->
<!-- Token replacement plugin -->
<plugin>
<groupId>com.google.code.maven-replacer-plugin</groupId>
<artifactId>maven-replacer-plugin</artifactId>
<version>1.3.8</version>
<executions>
<execution>
<phase>prepare-package</phase>
<goals>
<goal>replace</goal>
</goals>
</execution>
</executions>
<configuration>
<file>target/classes/plugin.yml</file>
<replacements>
<replacement>
<token>maven-version-number</token>
<value>${project.version}-b${project.build.number}</value>
</replacement>
</replacements>
</configuration>
</plugin>
<!-- Jar plugin -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>

26
src/main/java/com/graywolf336/jail/JailMain.java
View File

@ -1,5 +1,7 @@
package com.graywolf336.jail;
import java.util.concurrent.TimeUnit;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.plugin.PluginManager;
@ -40,6 +42,7 @@ public class JailMain extends JavaPlugin {
private PrisonerManager pm;
private ScoreBoardManager sbm;
private MoveProtectionListener mpl;
private Update update;
private boolean debug = false;
public void onEnable() {
@ -107,6 +110,7 @@ public class JailMain extends JavaPlugin {
jt = new JailTimer(this);
sbm = new ScoreBoardManager(this);
reloadJailPayManager();
reloadUpdateCheck();
getLogger().info("Completed enablement.");
}
@ -123,6 +127,7 @@ public class JailMain extends JavaPlugin {
if(io != null)
io.closeConnection();
update = null;
jt = null;
sbm = null;
jpm = null;
@ -214,6 +219,22 @@ public class JailMain extends JavaPlugin {
}
}
public void reloadUpdateCheck() {
update = new Update(this);
if(getConfig().getBoolean(Settings.UPDATENOTIFICATIONS.getPath())) {
try {
getServer().getScheduler().runTaskTimerAsynchronously(this, new Runnable() {
public void run() {
update.query();
}
}, 80L, Util.getTime(getConfig().getString(Settings.UPDATETIME.getPath()), TimeUnit.SECONDS) * 20);
} catch (Exception e) {
e.printStackTrace();
getLogger().severe("Was unable to schedule the update checking, please check your time format is correct.");
}
}
}
/** Gets the {@link HandCuffManager} instance. */
public HandCuffManager getHandCuffManager() {
return this.hcm;
@ -249,6 +270,11 @@ public class JailMain extends JavaPlugin {
return this.sbm;
}
/** Gets the {@link Update} instance. */
public Update getUpdate() {
return this.update;
}
/** Sets whether the plugin is in debugging or not. */
public boolean setDebugging(boolean debug) {
this.debug = debug;

174
src/main/java/com/graywolf336/jail/Update.java Normal file
View File

@ -0,0 +1,174 @@
package com.graywolf336.jail;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.JSONValue;
import com.graywolf336.jail.enums.Settings;
public class Update {
private JailMain plugin;
// The project's unique ID
private static final int projectID = 31139;
// Static information for querying the API
private static final String BUKKIT_API_QUERY = "https://api.curseforge.com/servermods/files?projectIds=" + projectID;
private static final String CI_STABLEDEV_API_QUERY = "http://ci.graywolf336.com/job/Jail/lastStableBuild/api/json";
private static final String CI_DEV_API_QUERY = "http://ci.graywolf336.com/job/Jail/lastSuccessfulBuild/api/json";
private boolean needed = false;
// The url for the new file and file version
private String fileUrl = "", version = "";
public Update(JailMain plugin) {
this.plugin = plugin;
}
public void query() {
String channel = plugin.getConfig().getString(Settings.UPDATECHANNEL.getPath(), "bukkit");
URL url = null;
try {
if(channel.equalsIgnoreCase("stable-dev")) {
url = new URL(CI_STABLEDEV_API_QUERY);
}else if(channel.equalsIgnoreCase("dev")) {
url = new URL(CI_DEV_API_QUERY);
}else {
url = new URL(BUKKIT_API_QUERY);
}
} catch (MalformedURLException e) {
plugin.getLogger().warning("The url for checking for an update was malformed, please open a ticket about this.");
return;
}
try {
// Open a connection and query the project
URLConnection conn = url.openConnection();
// Add the user-agent to identify the program
conn.addRequestProperty("User-Agent", "Jail Update Checker");
// Read the response of the query
// The response will be in a JSON format, so only reading one line is necessary.
final BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String response = reader.readLine();
if(channel.equalsIgnoreCase("stable-dev") || channel.equalsIgnoreCase("dev")) {
// Parse the object from the response from the CI server
JSONObject obj = (JSONObject) JSONValue.parse(response);
// Get the latest build number
long number = Long.parseLong(obj.get("number").toString());
// Get the current running version
String[] ver = plugin.getDescription().getVersion().split("-b");
// Let them know they're on a custom version when on build #0.
if(ver[ver.length - 1].equalsIgnoreCase("0")) {
plugin.getLogger().info("You are using a custom version, you can disable update checking.");
}
// Parse the current build number to a number
long curr = Long.parseLong(ver[ver.length - 1]);
// Check if the build on the CI server is higher than the one we're running
needed = number > curr;
// Alert the console that an update is needed, if it is needed
if(needed) {
this.version = obj.get("fullDisplayName").toString();
this.fileUrl = obj.get("url").toString();
plugin.getLogger().info("New development version of Jail is available: " + this.version);
plugin.getLogger().info(this.fileUrl);
}
}else {
// Parse the array of files from the query's response
JSONArray array = (JSONArray) JSONValue.parse(response);
// Make sure there are results returned
if (array.size() > 0) {
// Get the newest file's details
JSONObject latest = (JSONObject) array.get(array.size() - 1);
// Split the numbers into their own separate items
String remoteVer = ((String) latest.get("name")).split(" v")[1];
// 3.0.0-SNAPSHOT-b0
String currentVer = plugin.getDescription().getVersion().split("-")[0];
plugin.debug(remoteVer + " verus " + currentVer);
this.needed = this.versionCompare(remoteVer, currentVer) > 0;
if(needed) {
this.version = latest.get("name").toString();
this.fileUrl = latest.get("fileUrl").toString();
plugin.getLogger().info("New stable version of Jail is available: " + this.version);
plugin.getLogger().info(this.fileUrl);
}
}
}
} catch (IOException e) {
// There was an error reading the query
e.printStackTrace();
plugin.getLogger().severe("There was an error checking for an update, please see the above stacktrace for details before reporting.");
return;
}
}
/**
* Compares two version strings.
*
* Use this instead of String.compareTo() for a non-lexicographical
* comparison that works for version strings. e.g. "1.10".compareTo("1.6").
*
* @note It does not work if "1.10" is supposed to be equal to "1.10.0".
*
* @param str1 a string of ordinal numbers separated by decimal points.
* @param str2 a string of ordinal numbers separated by decimal points.
* @return The result is a negative integer if str1 is _numerically_ less than str2.
* The result is a positive integer if str1 is _numerically_ greater than str2.
* The result is zero if the strings are _numerically_ equal.
*/
private Integer versionCompare(String str1, String str2)
{
String[] vals1 = str1.split("\\.");
String[] vals2 = str2.split("\\.");
int i = 0;
// set index to first non-equal ordinal or length of shortest version string
while (i < vals1.length && i < vals2.length && vals1[i].equals(vals2[i]))
{
i++;
}
// compare first non-equal ordinal number
if (i < vals1.length && i < vals2.length)
{
int diff = Integer.valueOf(vals1[i]).compareTo(Integer.valueOf(vals2[i]));
return Integer.signum(diff);
}
// the strings are equal or one string is a substring of the other
// e.g. "1.2.3" = "1.2.3" or "1.2.3" < "1.2.3.4"
else
{
return Integer.signum(vals1.length - vals2.length);
}
}
/** Returns true if there is an update needed, false if not. */
public boolean isAvailable() {
return this.needed;
}
/** Returns the new version. */
public String getNewVersion() {
return this.version;
}
/** Returns the new file url. */
public String getFileUrl() {
return this.fileUrl;
}
}

17
src/main/java/com/graywolf336/jail/Util.java
View File

@ -110,10 +110,23 @@ public class Util {
return wand;
}
/**
*
* Converts a string like '20minutes' into the appropriate amount of the given unit.
*
* @param time in a string to convert.
* @param unit which to convert to.
* @return The time in the unit given that is converted.
* @throws Exception if there are no matches
*/
public static Long getTime(String time, TimeUnit unit) throws Exception {
return unit.convert(getTime(time), TimeUnit.MILLISECONDS);
}
/**
* Converts a string like '20minutes' into the appropriate amount of milliseconds.
*
* @param time The string to convert.
* @param time in a string to convert.
* @return The time in milliseconds that is converted.
* @throws Exception if there are no matches
*/
@ -144,7 +157,7 @@ public class Util {
throw new Exception("Invalid format.");
}
return Long.valueOf(t);
return t;
}
/**

1
src/main/java/com/graywolf336/jail/command/subcommands/JailReloadCommand.java
View File

@ -25,6 +25,7 @@ public class JailReloadCommand implements Command {
jm.getPlugin().reloadScoreBoardManager();
jm.getPlugin().reloadJailSticks();
jm.getPlugin().reloadJailPayManager();
jm.getPlugin().reloadUpdateCheck();
sender.sendMessage(jm.getPlugin().getJailIO().getLanguageString(LangString.PLUGINRELOADED));
}catch (Exception e) {

4
src/main/java/com/graywolf336/jail/enums/Settings.java
View File

@ -56,7 +56,9 @@ public enum Settings {
SCOREBOARDTITLE("jailing.during.scoreboard.title"),
SCOREBOARDTIME("jailing.during.scoreboard.time"),
TELEPORTONRELEASE("jailing.release.teleport"),
UPDATENOTIFICATIONS("system.updateNotifications"),
UPDATECHANNEL("system.updates.channel"),
UPDATENOTIFICATIONS("system.updates.notification"),
UPDATETIME("system.updates.time"),
USEBUKKITTIMER("system.useBukkitTimer");
private String path;

10
src/main/java/com/graywolf336/jail/listeners/PlayerListener.java
View File

@ -143,6 +143,16 @@ public class PlayerListener implements Listener {
}
}
@EventHandler
public void notifyUpdate(PlayerJoinEvent event) {
if(pl.getConfig().getBoolean(Settings.UPDATENOTIFICATIONS.getPath())) {
if(event.getPlayer().isOp() && pl.getUpdate().isAvailable()) {
event.getPlayer().sendMessage(ChatColor.BLUE + "" + ChatColor.BOLD + "An update for Jail is available: " + pl.getUpdate().getNewVersion());
event.getPlayer().sendMessage(ChatColor.BLUE + "" + ChatColor.BOLD + pl.getUpdate().getFileUrl());
}
}
}
@EventHandler
public void handleGoingOffline(PlayerQuitEvent event) {
if(pl.getJailManager().isPlayerJailed(event.getPlayer().getUniqueId())) {

5
src/main/resources/config.yml
View File

@ -2,7 +2,10 @@ system:
configVersion: 3
debug: false
language: 'en'
updateNotifications: true
updates:
channel: 'bukkit' #can be dev, stable-dev, bukkit
notification: true
time: 1h #the amount of time between checks for an update, while we are in betas it will be low but when out of beta it will be every 11 hours
useBukkitTimer: true
storage:
type: 'flatfile' #can be flatfile, sqlite, or mysql

2
src/main/resources/plugin.yml
View File

@ -1,6 +1,6 @@
name: Jail
main: com.graywolf336.jail.JailMain
version: ${project.version}-b${BUILD_NUMBER}
version: maven-version-number
description: Ban too harsh? Kick/mute/whatever not enough? Jail bad players!
authors: [graywolf336]
website: dev.bukkit.org/server-mods/jail/

4
src/test/java/test/java/com/graywolf336/jail/TestJailStuff.java
View File

@ -50,7 +50,9 @@ public class TestJailStuff {
assertEquals("The config version is not 3.", 3, main.getConfig().getInt("system.configVersion"));
//This is enabled by default in testing.
//assertFalse("Default debugging is on.", main.getConfig().getBoolean("system.debug"));
assertTrue("Default updating notifications is false.", main.getConfig().getBoolean("system.updateNotifications"));
assertEquals("Default updating channel is not bukkit.", "bukkit", main.getConfig().getString("system.updates.channel"));
assertTrue("Default updating notifications is false.", main.getConfig().getBoolean("system.updates.notification"));
assertEquals("Default updating time checking is not 1h.", "1h", main.getConfig().getString("system.updates.time"));
//Storage system
assertEquals("The default storage system is not flatfile.", "flatfile", main.getConfig().getString("storage.type"));