From c2deb9d0b5c9fa4c57249ee9afc0a7922686ce0a Mon Sep 17 00:00:00 2001 From: Xephi Date: Thu, 31 Dec 2015 16:35:38 +0100 Subject: [PATCH 01/16] Start rework of Settings Please move to another branch :3 (cherry picked from commit 0c5d835) --- .../settings/custom/ConverterSettings.java | 46 ++++++ .../authme/settings/custom/CustomSetting.java | 156 ++++++++++++++++++ .../settings/custom/DatabaseSettings.java | 121 ++++++++++++++ .../authme/settings/custom/EmailSettings.java | 83 ++++++++++ .../authme/settings/custom/HooksSettings.java | 54 ++++++ .../settings/custom/ProtectionSettings.java | 63 +++++++ .../authme/settings/custom/PurgeSettings.java | 62 +++++++ .../settings/custom/SecuritySettings.java | 60 +++++++ .../settings/custom/annotations/Comment.java | 20 +++ .../settings/custom/annotations/Type.java | 43 +++++ 10 files changed, 708 insertions(+) create mode 100644 src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/CustomSetting.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/annotations/Comment.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/annotations/Type.java diff --git a/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java b/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java new file mode 100644 index 000000000..7cee6a521 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java @@ -0,0 +1,46 @@ +package fr.xephi.authme.settings.custom; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; + +import fr.xephi.authme.settings.custom.annotations.Comment; +import fr.xephi.authme.settings.custom.annotations.Type; +import fr.xephi.authme.settings.custom.annotations.Type.SettingType; + +public class ConverterSettings extends CustomSetting { + + @Comment("Rakamak file name") + @Type(SettingType.String) + public String rakamakFileName = "users.rak"; + + @Comment("Rakamak use Ip ?") + @Type(SettingType.Boolean) + public boolean rakamakeUseIP = false; + + @Comment("Rakamak IP file name") + @Type(SettingType.String) + public String rakamakIPFileName = "UsersIp.rak"; + + @Comment("CrazyLogin database file name") + @Type(SettingType.String) + public String crazyLoginFileName = "accounts.db"; + + private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "converter.yml"); + + private ConverterSettings instance; + + public ConverterSettings() + { + super(configFile); + instance = this; + } + + public ConverterSettings getInstance() { + return instance; + } + + public void setInstance(ConverterSettings instance) { + this.instance = instance; + } +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/CustomSetting.java b/src/main/java/fr/xephi/authme/settings/custom/CustomSetting.java new file mode 100644 index 000000000..27792efd9 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/CustomSetting.java @@ -0,0 +1,156 @@ +package fr.xephi.authme.settings.custom; + +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.lang.reflect.Field; +import java.util.List; + +import fr.xephi.authme.ConsoleLogger; +import fr.xephi.authme.settings.CustomConfiguration; +import fr.xephi.authme.settings.custom.annotations.Comment; +import fr.xephi.authme.settings.custom.annotations.Type; + +public class CustomSetting extends CustomConfiguration { + + private File configFile; + public boolean isFirstLaunch = false; + + public CustomSetting(File file) { + super(file); + this.configFile = file; + try { + if (!configFile.exists()) + { + isFirstLaunch = true; + configFile.createNewFile(); + } + else + { + load(); + loadValues(); + } + save(); + } catch (IOException e) + { + ConsoleLogger.writeStackTrace(e); + } + } + + @Override + public boolean reLoad() + { + boolean out = true; + if (!configFile.exists()) { + try { + configFile.createNewFile(); + save(); + } catch (IOException e) { + out = false; + } + } + if (out) + { + load(); + loadValues(); + } + return out; + } + + public void loadValues() + { + for (Field f : this.getClass().getDeclaredFields()) + { + if (!f.isAnnotationPresent(Type.class)) + continue; + f.setAccessible(true); + try { + switch (f.getAnnotation(Type.class).value()) + { + case Boolean: + f.setBoolean(this, this.getBoolean(f.getName())); + break; + case Double: + f.setDouble(this, this.getDouble(f.getName())); + break; + case Int: + f.setInt(this, this.getInt(f.getName())); + break; + case Long: + f.setLong(this, this.getLong(f.getName())); + break; + case String: + f.set(this, this.getString(f.getName())); + break; + case StringList: + f.set(this, this.getStringList(f.getName())); + break; + default: + break; + } + } catch (Exception e) + { + ConsoleLogger.writeStackTrace(e); + } + } + } + + @Override + public void save() + { + FileWriter writer = null; + try { + writer = new FileWriter(configFile); + writer.write(""); + for (Field f : this.getClass().getDeclaredFields()) + { + if (!f.isAnnotationPresent(Comment.class)) + continue; + if (!f.isAnnotationPresent(Type.class)) + continue; + for (String s : f.getAnnotation(Comment.class).value()) + { + writer.append("# " + s + "\n"); + } + writer.append(f.getName() + ": "); + switch (f.getAnnotation(Type.class).value()) + { + case Boolean: + writer.append(f.getBoolean(this) ? "true" : "false"); + break; + case Double: + writer.append("" + f.getDouble(this)); + break; + case Int: + writer.append("" + f.getInt(this)); + break; + case String: + writer.append("'" + f.get(this).toString() + "'"); + break; + case StringList: + @SuppressWarnings("unchecked") + List list = (List) f.get(this); + writer.append("\n"); + if (list.isEmpty()) + writer.write("[]"); + else + for (String s : list) + writer.append(" - '" + s + "'\n"); + break; + case Long: + writer.append("" + f.getLong(this)); + break; + default: + break; + + } + writer.append("\n"); + writer.flush(); + } + writer.close(); + } catch (Exception e) { + ConsoleLogger.writeStackTrace(e); + } + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java new file mode 100644 index 000000000..c3c20c6bd --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java @@ -0,0 +1,121 @@ +package fr.xephi.authme.settings.custom; + +import java.io.File; + +import fr.xephi.authme.settings.custom.annotations.Comment; +import fr.xephi.authme.settings.custom.annotations.Type; +import fr.xephi.authme.settings.custom.annotations.Type.SettingType; + +public class DatabaseSettings extends CustomSetting { + + @Comment({"What type of database do you want to use?", + "Valid values: sqlite, mysql"}) + @Type(SettingType.String) + public String backend = "sqlite"; + + @Comment("Enable database caching, should improve database performance") + @Type(SettingType.Boolean) + public boolean caching = true; + + @Comment("Database host address") + @Type(SettingType.String) + public String mySQLHost = "127.0.0.1"; + + @Comment("Database port") + @Type(SettingType.String) + public String mySQLPort = "3306"; + + @Comment("Username about Database Connection Infos") + @Type(SettingType.String) + public String mySQLUsername = "authme"; + + @Comment("Password about Database Connection Infos") + @Type(SettingType.String) + public String mySQLPassword = "12345"; + + @Comment("Database Name, use with converters or as SQLITE database name") + @Type(SettingType.String) + public String mySQLDatabase = "authme"; + + @Comment("Table of the database") + @Type(SettingType.String) + public String mySQLTablename = "authme"; + + @Comment("Column of IDs to sort data") + @Type(SettingType.String) + public String mySQLColumnId = "id"; + + @Comment("Column for storing or checking players nickname") + @Type(SettingType.String) + public String mySQLColumnName = "username"; + + @Comment("Column for storing or checking players RealName ") + @Type(SettingType.String) + public String mySQLColumnRealName = "realname"; + + @Comment("Column for storing players passwords") + @Type(SettingType.String) + public String mySQLColumnPassword = "password"; + + @Comment("Column for storing players passwords salts") + @Type(SettingType.String) + public String mySQLColumnSalt = ""; + + @Comment("Column for storing players emails") + @Type(SettingType.String) + public String mySQLColumnEmail = "email"; + + @Comment("Column for storing if a player is logged in or not") + @Type(SettingType.String) + public String mySQLColumnLogged = "isLogged"; + + @Comment("Column for storing players ips") + @Type(SettingType.String) + public String mySQLColumnIp = "ip"; + + @Comment("Column for storing players lastlogins") + @Type(SettingType.String) + public String mySQLColumnLastLogin = "lastlogin"; + + @Comment("Column for storing player LastLocation - X") + @Type(SettingType.String) + public String mySQLColumnLastLocX = "x"; + + @Comment("Column for storing player LastLocation - Y") + @Type(SettingType.String) + public String mySQLColumnLastLocY = "y"; + + @Comment("Column for storing player LastLocation - Z") + @Type(SettingType.String) + public String mySQLColumnLastLocZ = "z"; + + @Comment("Column for storing player LastLocation - World Name") + @Type(SettingType.String) + public String mySQLColumnLastLocWorld = "world"; + + @Comment("Column for storing players groups") + @Type(SettingType.String) + public String mySQLColumnGroup = ""; + + @Comment("Enable this when you allow registration through a website") + @Type(SettingType.Boolean) + public boolean mySQLWebsite = false; + + private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "database.yml"); + + private DatabaseSettings instance; + + public DatabaseSettings() + { + super(configFile); + instance = this; + } + + public DatabaseSettings getInstance() { + return instance; + } + + public void setInstance(DatabaseSettings instance) { + this.instance = instance; + } +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java b/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java new file mode 100644 index 000000000..d6cc36753 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java @@ -0,0 +1,83 @@ +package fr.xephi.authme.settings.custom; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; + +import fr.xephi.authme.settings.custom.annotations.Comment; +import fr.xephi.authme.settings.custom.annotations.Type; +import fr.xephi.authme.settings.custom.annotations.Type.SettingType; + +public class EmailSettings extends CustomSetting { + + @Comment("Email SMTP server host") + @Type(SettingType.String) + public String mailSMTP = "smtp.gmail.com"; + + @Comment("Email SMTP server port") + @Type(SettingType.Int) + public int mailPort = 465; + + @Comment("Email account whose send the mail") + @Type(SettingType.String) + public String mailAccount = ""; + + @Comment("Email account password") + @Type(SettingType.String) + public String mailPassword = ""; + + @Comment("Random password length") + @Type(SettingType.Int) + public int recoveryPasswordLength = 8; + + @Comment("Mail Subject") + @Type(SettingType.String) + public String mailSubject = "Your new AuthMe password"; + + @Comment("Like maxRegPerIP but with email") + @Type(SettingType.Int) + public int maxRegPerEmail = 1; + + @Comment("Recall players to add an email ?") + @Type(SettingType.Boolean) + public boolean recallPlayers = false; + + @Comment("Delay in minute for the recall scheduler") + @Type(SettingType.Int) + public int delayRecall = 5; + + @Comment("Blacklist these domains for emails") + @Type(SettingType.StringList) + public List emailBlackListed = new ArrayList(); + + @Comment("Whitelist ONLY these domains for emails") + @Type(SettingType.StringList) + public List emailWhiteListed = new ArrayList(); + + @Comment("Do we need to send new password draw in an image ?") + @Type(SettingType.Boolean) + public boolean generateImage = false; + + private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "emails.yml"); + + private EmailSettings instance; + + public EmailSettings() + { + super(configFile); + instance = this; + if (this.isFirstLaunch) + { + this.emailBlackListed.add("10minutemail.com"); + save(); + } + } + + public EmailSettings getInstance() { + return instance; + } + + public void setInstance(EmailSettings instance) { + this.instance = instance; + } +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java new file mode 100644 index 000000000..307c79062 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java @@ -0,0 +1,54 @@ +package fr.xephi.authme.settings.custom; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; + +import fr.xephi.authme.settings.custom.annotations.Comment; +import fr.xephi.authme.settings.custom.annotations.Type; +import fr.xephi.authme.settings.custom.annotations.Type.SettingType; + +public class HooksSettings extends CustomSetting { + + @Comment("Do we need to hook with multiverse for spawn checking?") + @Type(SettingType.Boolean) + public boolean multiverse = true; + + @Comment("Do we need to hook with BungeeCord ?") + @Type(SettingType.Boolean) + public boolean bungeecord = false; + + @Comment("Send player to this BungeeCord server after register/login") + @Type(SettingType.String) + public String sendPlayerTo = ""; + + @Comment("Do we need to disable Essentials SocialSpy on join?") + @Type(SettingType.Boolean) + public boolean disableSocialSpy = false; + + @Comment("Do we need to force /motd Essentials command on join?") + @Type(SettingType.Boolean) + public boolean useEssentialsMotd = false; + + @Comment("Do we need to cache custom Attributes?") + @Type(SettingType.Boolean) + public boolean customAttributes = false; + + private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "hooks.yml"); + + private HooksSettings instance; + + public HooksSettings() + { + super(configFile); + instance = this; + } + + public HooksSettings getInstance() { + return instance; + } + + public void setInstance(HooksSettings instance) { + this.instance = instance; + } +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java b/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java new file mode 100644 index 000000000..e8e2d059c --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java @@ -0,0 +1,63 @@ +package fr.xephi.authme.settings.custom; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; + +import fr.xephi.authme.settings.custom.annotations.Comment; +import fr.xephi.authme.settings.custom.annotations.Type; +import fr.xephi.authme.settings.custom.annotations.Type.SettingType; + +public class ProtectionSettings extends CustomSetting { + + @Comment("Enable some servers protection ( country based login, antibot )") + @Type(SettingType.Boolean) + public boolean enableProtection = false; + + @Comment({"Countries allowed to join the server and register, see http://dev.bukkit.org/bukkit-plugins/authme-reloaded/pages/countries-codes/ for countries' codes", + "PLEASE USE QUOTES !"}) + @Type(SettingType.StringList) + public List countriesWhitelist = new ArrayList(); + + @Comment({"Countries not allowed to join the server and register", + "PLEASE USE QUOTES !"}) + @Type(SettingType.StringList) + public List countriesBlacklist = new ArrayList(); + + @Comment("Do we need to enable automatic antibot system?") + @Type(SettingType.Boolean) + public boolean enableAntiBot = false; + + @Comment("Max number of player allowed to login in 5 secs before enable AntiBot system automatically") + @Type(SettingType.Int) + public int antiBotSensibility = 5; + + @Comment("Duration in minutes of the antibot automatic system") + @Type(SettingType.Int) + public int antiBotDuration = 10; + + private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "protection.yml"); + + private ProtectionSettings instance; + + public ProtectionSettings() + { + super(configFile); + instance = this; + if (this.isFirstLaunch) + { + this.countriesWhitelist.add("US"); + this.countriesWhitelist.add("GB"); + this.countriesBlacklist.add("A1"); + save(); + } + } + + public ProtectionSettings getInstance() { + return instance; + } + + public void setInstance(ProtectionSettings instance) { + this.instance = instance; + } +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java new file mode 100644 index 000000000..3b85e2fb0 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java @@ -0,0 +1,62 @@ +package fr.xephi.authme.settings.custom; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; + +import fr.xephi.authme.settings.custom.annotations.Comment; +import fr.xephi.authme.settings.custom.annotations.Type; +import fr.xephi.authme.settings.custom.annotations.Type.SettingType; + +public class PurgeSettings extends CustomSetting { + + @Comment("If enabled, AuthMe automatically purges old, unused accounts") + @Type(SettingType.Boolean) + public boolean useAutoPurge = false; + + @Comment("Number of Days an account become Unused") + @Type(SettingType.Int) + public int daysBeforeRemovePlayer = 60; + + @Comment("Do we need to remove the player.dat file during purge process?") + @Type(SettingType.Boolean) + public boolean removePlayerDat = false; + + @Comment("Do we need to remove the Essentials/users/player.yml file during purge process?") + @Type(SettingType.Boolean) + public boolean removeEssentialsFiles = false; + + @Comment("World where are players.dat stores") + @Type(SettingType.String) + public String defaultWorld = "world"; + + @Comment("Do we need to remove LimitedCreative/inventories/player.yml, player_creative.yml files during purge process ?") + @Type(SettingType.Boolean) + public boolean removeLimiteCreativeInventories = false; + + @Comment("Do we need to remove the AntiXRayData/PlayerData/player file during purge process?") + @Type(SettingType.Boolean) + public boolean removeAntiXRayFile = false; + + @Comment("Do we need to remove permissions?") + @Type(SettingType.Boolean) + public boolean removePermissions = false; + + private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "purge.yml"); + + private PurgeSettings instance; + + public PurgeSettings() + { + super(configFile); + instance = this; + } + + public PurgeSettings getInstance() { + return instance; + } + + public void setInstance(PurgeSettings instance) { + this.instance = instance; + } +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java new file mode 100644 index 000000000..3166cbe26 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java @@ -0,0 +1,60 @@ +package fr.xephi.authme.settings.custom; + +import java.io.File; +import java.util.ArrayList; +import java.util.List; + +import fr.xephi.authme.settings.custom.annotations.Comment; +import fr.xephi.authme.settings.custom.annotations.Type; +import fr.xephi.authme.settings.custom.annotations.Type.SettingType; + +public class SecuritySettings extends CustomSetting { + + @Comment({"Stop the server if we can't contact the sql database", + "Take care with this, if you set that to false,", + "AuthMe automatically disable and the server is not protected!"}) + @Type(SettingType.Boolean) + public boolean stopServerOnProblem = true; + + @Comment("/reload support") + @Type(SettingType.Boolean) + public boolean useReloadCommandSupport = true; + + @Comment("Remove Spam from Console ?") + @Type(SettingType.Boolean) + public boolean removeSpamFromConsole = false; + + @Comment("Remove Password from Console ?") + @Type(SettingType.Boolean) + public boolean removePasswordFromConsole = true; + + @Comment("Player need to put a captcha when he fails too lot the password") + @Type(SettingType.Boolean) + public boolean useCaptcha = false; + + @Comment("Max allowed tries before request a captcha") + @Type(SettingType.Int) + public int maxLoginTryBeforeCaptcha = 5; + + @Comment("Captcha length ") + @Type(SettingType.Int) + public int captchaLength = 5; + + private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "security.yml"); + + private SecuritySettings instance; + + public SecuritySettings() + { + super(configFile); + instance = this; + } + + public SecuritySettings getInstance() { + return instance; + } + + public void setInstance(SecuritySettings instance) { + this.instance = instance; + } +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/annotations/Comment.java b/src/main/java/fr/xephi/authme/settings/custom/annotations/Comment.java new file mode 100644 index 000000000..d711a1943 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/annotations/Comment.java @@ -0,0 +1,20 @@ +package fr.xephi.authme.settings.custom.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * + * Add a comment to a field value + * + * @author xephi59 + * + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface Comment { + + public String[] value() default ""; +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/annotations/Type.java b/src/main/java/fr/xephi/authme/settings/custom/annotations/Type.java new file mode 100644 index 000000000..aae0af52b --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/annotations/Type.java @@ -0,0 +1,43 @@ +package fr.xephi.authme.settings.custom.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import fr.xephi.authme.settings.custom.annotations.Type.SettingType; + +/** +* +* Set the type of a field value +* +* @author xephi59 +* +*/ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface Type { + + public enum SettingType { + String(0), + Int(1), + Boolean(2), + Double(3), + StringList(4), + Long(5); + + private int type; + + SettingType(int type) + { + this.type = type; + } + + public int getType() + { + return this.type; + } + } + + public SettingType value() default SettingType.String; +} From 7d41ccbc9ca92feb23c71dfe2ff2b76ce4c0d14f Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sun, 3 Jan 2016 15:22:32 +0100 Subject: [PATCH 02/16] Settings: use class constants for properties, create custom writer - Create Property class for defining config properties - Create logic for typed retrival of properties from YAML file - Add custom save method - Retain comments from Comment annotations in the classes - Write in a sorted order: first discovered properties are first written to config.yml - Adjust properties to reflect the current config.yml - Add sample tests for the retrieval and writing of properties with the new setup --- .../settings/custom/ConverterSettings.java | 50 ++--- .../authme/settings/custom/CustomSetting.java | 156 ---------------- .../settings/custom/DatabaseSettings.java | 120 ++++++------ .../authme/settings/custom/EmailSettings.java | 97 +++++----- .../authme/settings/custom/HooksSettings.java | 57 +++--- .../authme/settings/custom/NewSetting.java | 148 +++++++++++++++ .../settings/custom/ProtectionSettings.java | 71 +++----- .../authme/settings/custom/PurgeSettings.java | 65 +++---- .../settings/custom/SecuritySettings.java | 73 ++++---- .../settings/custom/annotations/Type.java | 43 ----- .../{annotations => domain}/Comment.java | 11 +- .../settings/custom/domain/Property.java | 100 ++++++++++ .../settings/custom/domain/PropertyType.java | 146 +++++++++++++++ .../settings/custom/domain/SettingsClass.java | 7 + .../settings/custom/propertymap/Node.java | 121 ++++++++++++ .../custom/propertymap/PropertyMap.java | 48 +++++ .../propertymap/PropertyMapComparator.java | 39 ++++ .../fr/xephi/authme/util/CollectionUtils.java | 14 ++ .../fr/xephi/authme/util/StringUtils.java | 8 + .../settings/custom/NewSettingTest.java | 111 +++++++++++ .../settings/custom/NewSettingsWriteTest.java | 42 +++++ src/test/resources/437-config-test.yml | 44 +++++ src/test/resources/437-write-test.yml | 172 ++++++++++++++++++ 23 files changed, 1225 insertions(+), 518 deletions(-) delete mode 100644 src/main/java/fr/xephi/authme/settings/custom/CustomSetting.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/NewSetting.java delete mode 100644 src/main/java/fr/xephi/authme/settings/custom/annotations/Type.java rename src/main/java/fr/xephi/authme/settings/custom/{annotations => domain}/Comment.java (62%) create mode 100644 src/main/java/fr/xephi/authme/settings/custom/domain/Property.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/domain/SettingsClass.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/propertymap/Node.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMap.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMapComparator.java create mode 100644 src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java create mode 100644 src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java create mode 100644 src/test/resources/437-config-test.yml create mode 100644 src/test/resources/437-write-test.yml diff --git a/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java b/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java index 7cee6a521..c9f1ba99e 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java @@ -1,46 +1,32 @@ package fr.xephi.authme.settings.custom; -import java.io.File; -import java.util.ArrayList; -import java.util.List; +import fr.xephi.authme.settings.custom.domain.Comment; +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.SettingsClass; -import fr.xephi.authme.settings.custom.annotations.Comment; -import fr.xephi.authme.settings.custom.annotations.Type; -import fr.xephi.authme.settings.custom.annotations.Type.SettingType; +import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING; -public class ConverterSettings extends CustomSetting { +public class ConverterSettings implements SettingsClass { @Comment("Rakamak file name") - @Type(SettingType.String) - public String rakamakFileName = "users.rak"; + public static final Property RAKAMAK_FILE_NAME = + newProperty(STRING, "Converter.Rakamak.fileName", "users.rak"); - @Comment("Rakamak use Ip ?") - @Type(SettingType.Boolean) - public boolean rakamakeUseIP = false; + @Comment("Rakamak use IP?") + public static final Property RAKAMAK_USE_IP = + newProperty(BOOLEAN, "Converter.Rakamak.useIP", false); @Comment("Rakamak IP file name") - @Type(SettingType.String) - public String rakamakIPFileName = "UsersIp.rak"; + public static final Property RAKAMAK_IP_FILE_NAME = + newProperty(STRING, "Converter.Rakamak.ipFileName", "UsersIp.rak"); @Comment("CrazyLogin database file name") - @Type(SettingType.String) - public String crazyLoginFileName = "accounts.db"; + public static final Property CRAZYLOGIN_FILE_NAME = + newProperty(STRING, "Converter.CrazyLogin.fileName", "accounts.db"); - private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "converter.yml"); + private ConverterSettings() { + } - private ConverterSettings instance; - - public ConverterSettings() - { - super(configFile); - instance = this; - } - - public ConverterSettings getInstance() { - return instance; - } - - public void setInstance(ConverterSettings instance) { - this.instance = instance; - } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/CustomSetting.java b/src/main/java/fr/xephi/authme/settings/custom/CustomSetting.java deleted file mode 100644 index 27792efd9..000000000 --- a/src/main/java/fr/xephi/authme/settings/custom/CustomSetting.java +++ /dev/null @@ -1,156 +0,0 @@ -package fr.xephi.authme.settings.custom; - -import java.io.File; -import java.io.FileWriter; -import java.io.IOException; -import java.lang.reflect.Field; -import java.util.List; - -import fr.xephi.authme.ConsoleLogger; -import fr.xephi.authme.settings.CustomConfiguration; -import fr.xephi.authme.settings.custom.annotations.Comment; -import fr.xephi.authme.settings.custom.annotations.Type; - -public class CustomSetting extends CustomConfiguration { - - private File configFile; - public boolean isFirstLaunch = false; - - public CustomSetting(File file) { - super(file); - this.configFile = file; - try { - if (!configFile.exists()) - { - isFirstLaunch = true; - configFile.createNewFile(); - } - else - { - load(); - loadValues(); - } - save(); - } catch (IOException e) - { - ConsoleLogger.writeStackTrace(e); - } - } - - @Override - public boolean reLoad() - { - boolean out = true; - if (!configFile.exists()) { - try { - configFile.createNewFile(); - save(); - } catch (IOException e) { - out = false; - } - } - if (out) - { - load(); - loadValues(); - } - return out; - } - - public void loadValues() - { - for (Field f : this.getClass().getDeclaredFields()) - { - if (!f.isAnnotationPresent(Type.class)) - continue; - f.setAccessible(true); - try { - switch (f.getAnnotation(Type.class).value()) - { - case Boolean: - f.setBoolean(this, this.getBoolean(f.getName())); - break; - case Double: - f.setDouble(this, this.getDouble(f.getName())); - break; - case Int: - f.setInt(this, this.getInt(f.getName())); - break; - case Long: - f.setLong(this, this.getLong(f.getName())); - break; - case String: - f.set(this, this.getString(f.getName())); - break; - case StringList: - f.set(this, this.getStringList(f.getName())); - break; - default: - break; - } - } catch (Exception e) - { - ConsoleLogger.writeStackTrace(e); - } - } - } - - @Override - public void save() - { - FileWriter writer = null; - try { - writer = new FileWriter(configFile); - writer.write(""); - for (Field f : this.getClass().getDeclaredFields()) - { - if (!f.isAnnotationPresent(Comment.class)) - continue; - if (!f.isAnnotationPresent(Type.class)) - continue; - for (String s : f.getAnnotation(Comment.class).value()) - { - writer.append("# " + s + "\n"); - } - writer.append(f.getName() + ": "); - switch (f.getAnnotation(Type.class).value()) - { - case Boolean: - writer.append(f.getBoolean(this) ? "true" : "false"); - break; - case Double: - writer.append("" + f.getDouble(this)); - break; - case Int: - writer.append("" + f.getInt(this)); - break; - case String: - writer.append("'" + f.get(this).toString() + "'"); - break; - case StringList: - @SuppressWarnings("unchecked") - List list = (List) f.get(this); - writer.append("\n"); - if (list.isEmpty()) - writer.write("[]"); - else - for (String s : list) - writer.append(" - '" + s + "'\n"); - break; - case Long: - writer.append("" + f.getLong(this)); - break; - default: - break; - - } - writer.append("\n"); - writer.flush(); - } - writer.close(); - } catch (Exception e) { - ConsoleLogger.writeStackTrace(e); - } - } - -} diff --git a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java index c3c20c6bd..26e36310f 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java @@ -1,121 +1,109 @@ package fr.xephi.authme.settings.custom; -import java.io.File; +import fr.xephi.authme.settings.custom.domain.Comment; +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.SettingsClass; -import fr.xephi.authme.settings.custom.annotations.Comment; -import fr.xephi.authme.settings.custom.annotations.Type; -import fr.xephi.authme.settings.custom.annotations.Type.SettingType; +import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING; -public class DatabaseSettings extends CustomSetting { +public class DatabaseSettings implements SettingsClass { @Comment({"What type of database do you want to use?", "Valid values: sqlite, mysql"}) - @Type(SettingType.String) - public String backend = "sqlite"; + public static final Property BACKEND = + newProperty(STRING, "DataSource.backend", "sqlite"); @Comment("Enable database caching, should improve database performance") - @Type(SettingType.Boolean) - public boolean caching = true; + public static final Property USE_CACHING = + newProperty(BOOLEAN, "DataSource.caching", true); @Comment("Database host address") - @Type(SettingType.String) - public String mySQLHost = "127.0.0.1"; + public static final Property MYSQL_HOST = + newProperty(STRING, "DataSource.mySQLHost", "127.0.0.1"); @Comment("Database port") - @Type(SettingType.String) - public String mySQLPort = "3306"; + public static final Property MYSQL_PORT = + newProperty(STRING, "DataSource.mySQLPort", "3306"); @Comment("Username about Database Connection Infos") - @Type(SettingType.String) - public String mySQLUsername = "authme"; + public static final Property MYSQL_USERNAME = + newProperty(STRING, "DataSource.mySQLUsername", "authme"); @Comment("Password about Database Connection Infos") - @Type(SettingType.String) - public String mySQLPassword = "12345"; + public static final Property MYSQL_PASSWORD = + newProperty(STRING, "DataSource.mySQLPassword", "123456"); @Comment("Database Name, use with converters or as SQLITE database name") - @Type(SettingType.String) - public String mySQLDatabase = "authme"; + public static final Property MYSQL_DATABASE = + newProperty(STRING, "DataSource.mySQLDatabase", "authme"); @Comment("Table of the database") - @Type(SettingType.String) - public String mySQLTablename = "authme"; + public static final Property MYSQL_TABLE = + newProperty(STRING, "DataSource.mySQLTablename", "authme"); @Comment("Column of IDs to sort data") - @Type(SettingType.String) - public String mySQLColumnId = "id"; + public static final Property MYSQL_COL_ID = + newProperty(STRING, "DataSource.mySQLColumnId", "id"); @Comment("Column for storing or checking players nickname") - @Type(SettingType.String) - public String mySQLColumnName = "username"; + public static final Property MYSQL_COL_NAME = + newProperty(STRING, "DataSource.mySQLColumnName", "username"); @Comment("Column for storing or checking players RealName ") - @Type(SettingType.String) - public String mySQLColumnRealName = "realname"; + public static final Property MYSQL_COL_REALNAME = + newProperty(STRING, "DataSource.mySQLRealName", "realname"); @Comment("Column for storing players passwords") - @Type(SettingType.String) - public String mySQLColumnPassword = "password"; + public static final Property MYSQL_COL_PASSWORD = + newProperty(STRING, "DataSource.mySQLColumnPassword", "password"); @Comment("Column for storing players passwords salts") - @Type(SettingType.String) - public String mySQLColumnSalt = ""; + public static final Property MYSQL_COL_SALT = + newProperty(STRING, "ExternalBoardOptions.mySQLColumnSalt", ""); @Comment("Column for storing players emails") - @Type(SettingType.String) - public String mySQLColumnEmail = "email"; + public static final Property MYSQL_COL_EMAIL = + newProperty(STRING, "DataSource.mySQLColumnEmail", "email"); @Comment("Column for storing if a player is logged in or not") - @Type(SettingType.String) - public String mySQLColumnLogged = "isLogged"; + public static final Property MYSQL_COL_ISLOGGED = + newProperty(STRING, "DataSource.mySQLColumnLogged", "isLogged"); @Comment("Column for storing players ips") - @Type(SettingType.String) - public String mySQLColumnIp = "ip"; + public static final Property MYSQL_COL_IP = + newProperty(STRING, "DataSource.mySQLColumnIp", "ip"); @Comment("Column for storing players lastlogins") - @Type(SettingType.String) - public String mySQLColumnLastLogin = "lastlogin"; + public static final Property MYSQL_COL_LASTLOGIN = + newProperty(STRING, "DataSource.mySQLColumnLastLogin", "lastlogin"); @Comment("Column for storing player LastLocation - X") - @Type(SettingType.String) - public String mySQLColumnLastLocX = "x"; + public static final Property MYSQL_COL_LASTLOC_X = + newProperty(STRING, "DataSource.mySQLlastlocX", "x"); @Comment("Column for storing player LastLocation - Y") - @Type(SettingType.String) - public String mySQLColumnLastLocY = "y"; + public static final Property MYSQL_COL_LASTLOC_Y = + newProperty(STRING, "DataSource.mySQLlastlocY", "y"); @Comment("Column for storing player LastLocation - Z") - @Type(SettingType.String) - public String mySQLColumnLastLocZ = "z"; + public static final Property MYSQL_COL_LASTLOC_Z = + newProperty(STRING, "DataSource.mySQLlastlocZ", "z"); @Comment("Column for storing player LastLocation - World Name") - @Type(SettingType.String) - public String mySQLColumnLastLocWorld = "world"; + public static final Property MYSQL_COL_LASTLOC_WORLD = + newProperty(STRING, "DataSource.mySQLlastlocWorld", "world"); @Comment("Column for storing players groups") - @Type(SettingType.String) - public String mySQLColumnGroup = ""; + public static final Property MYSQL_COL_GROUP = + newProperty(STRING, "ExternalBoardOptions.mySQLColumnGroup", ""); @Comment("Enable this when you allow registration through a website") - @Type(SettingType.Boolean) - public boolean mySQLWebsite = false; + public static final Property MYSQL_WEBSITE = + newProperty(BOOLEAN, "DataSource.mySQLWebsite", false); - private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "database.yml"); - - private DatabaseSettings instance; - - public DatabaseSettings() - { - super(configFile); - instance = this; + private DatabaseSettings() { } - public DatabaseSettings getInstance() { - return instance; - } - - public void setInstance(DatabaseSettings instance) { - this.instance = instance; - } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java b/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java index d6cc36753..f53d9549d 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java @@ -1,83 +1,72 @@ package fr.xephi.authme.settings.custom; -import java.io.File; -import java.util.ArrayList; +import fr.xephi.authme.settings.custom.domain.Comment; +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.SettingsClass; + import java.util.List; -import fr.xephi.authme.settings.custom.annotations.Comment; -import fr.xephi.authme.settings.custom.annotations.Type; -import fr.xephi.authme.settings.custom.annotations.Type.SettingType; +import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.custom.domain.PropertyType.INTEGER; +import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING; +import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING_LIST; -public class EmailSettings extends CustomSetting { +public class EmailSettings implements SettingsClass { @Comment("Email SMTP server host") - @Type(SettingType.String) - public String mailSMTP = "smtp.gmail.com"; + public static final Property SMTP_HOST = + newProperty(STRING, "Email.mailSMTP", "smtp.gmail.com"); @Comment("Email SMTP server port") - @Type(SettingType.Int) - public int mailPort = 465; + public static final Property SMTP_PORT = + newProperty(INTEGER, "Email.mailPort", 465); - @Comment("Email account whose send the mail") - @Type(SettingType.String) - public String mailAccount = ""; + @Comment("Email account which sends the mails") + public static final Property MAIL_ACCOUNT = + newProperty(STRING, "Email.mailAccount", ""); @Comment("Email account password") - @Type(SettingType.String) - public String mailPassword = ""; + public static final Property MAIL_PASSWORD = + newProperty(STRING, "Email.mailPassword", ""); - @Comment("Random password length") - @Type(SettingType.Int) - public int recoveryPasswordLength = 8; + @Comment("Recovery password length") + public static final Property RECOVERY_PASSWORD_LENGTH = + newProperty(INTEGER, "Email.RecoveryPasswordLength", 8); @Comment("Mail Subject") - @Type(SettingType.String) - public String mailSubject = "Your new AuthMe password"; + public static final Property RECOVERY_MAIL_SUBJECT = + newProperty(STRING, "Email.mailSubject", "Your new AuthMe password"); @Comment("Like maxRegPerIP but with email") - @Type(SettingType.Int) - public int maxRegPerEmail = 1; + public static final Property MAX_REG_PER_EMAIL = + newProperty(INTEGER, "Email.maxRegPerEmail", 1); - @Comment("Recall players to add an email ?") - @Type(SettingType.Boolean) - public boolean recallPlayers = false; + @Comment("Recall players to add an email?") + public static final Property RECALL_PLAYERS = + newProperty(BOOLEAN, "Email.recallPlayers", false); @Comment("Delay in minute for the recall scheduler") - @Type(SettingType.Int) - public int delayRecall = 5; + public static final Property DELAY_RECALL = + newProperty(INTEGER, "Email.delayRecall", 5); @Comment("Blacklist these domains for emails") - @Type(SettingType.StringList) - public List emailBlackListed = new ArrayList(); + public static final Property> DOMAIN_BLACKLIST = + newProperty(STRING_LIST, "Email.emailBlacklisted", "10minutemail.com"); @Comment("Whitelist ONLY these domains for emails") - @Type(SettingType.StringList) - public List emailWhiteListed = new ArrayList(); + public static final Property> DOMAIN_WHITELIST = + newProperty(STRING_LIST, "Email.emailWhitelisted"); - @Comment("Do we need to send new password draw in an image ?") - @Type(SettingType.Boolean) - public boolean generateImage = false; + @Comment("Send the new password drawn in an image?") + public static final Property PASSWORD_AS_IMAGE = + newProperty(BOOLEAN, "Email.generateImage", false); - private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "emails.yml"); + @Comment("The OAuth2 token") + public static final Property OAUTH2_TOKEN = + newProperty(STRING, "Email.emailOauth2Token", ""); - private EmailSettings instance; + private EmailSettings() { + } - public EmailSettings() - { - super(configFile); - instance = this; - if (this.isFirstLaunch) - { - this.emailBlackListed.add("10minutemail.com"); - save(); - } - } - - public EmailSettings getInstance() { - return instance; - } - - public void setInstance(EmailSettings instance) { - this.instance = instance; - } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java index 307c79062..6f75eb247 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java @@ -1,54 +1,39 @@ package fr.xephi.authme.settings.custom; -import java.io.File; -import java.util.ArrayList; -import java.util.List; +import fr.xephi.authme.settings.custom.domain.Comment; +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.PropertyType; +import fr.xephi.authme.settings.custom.domain.SettingsClass; -import fr.xephi.authme.settings.custom.annotations.Comment; -import fr.xephi.authme.settings.custom.annotations.Type; -import fr.xephi.authme.settings.custom.annotations.Type.SettingType; +import static fr.xephi.authme.settings.custom.domain.Property.newProperty; -public class HooksSettings extends CustomSetting { +public class HooksSettings implements SettingsClass { @Comment("Do we need to hook with multiverse for spawn checking?") - @Type(SettingType.Boolean) - public boolean multiverse = true; + public static final Property MULTIVERSE = + newProperty(PropertyType.BOOLEAN, "Hooks.multiverse", true); - @Comment("Do we need to hook with BungeeCord ?") - @Type(SettingType.Boolean) - public boolean bungeecord = false; + @Comment("Do we need to hook with BungeeCord?") + public static final Property BUNGEECORD = + newProperty(PropertyType.BOOLEAN, "Hooks.bungeecord", false); @Comment("Send player to this BungeeCord server after register/login") - @Type(SettingType.String) - public String sendPlayerTo = ""; + public static final Property BUNGEECORD_SERVER = + newProperty(PropertyType.STRING, "bungeecord.server", ""); @Comment("Do we need to disable Essentials SocialSpy on join?") - @Type(SettingType.Boolean) - public boolean disableSocialSpy = false; + public static final Property DISABLE_SOCIAL_SPY = + newProperty(PropertyType.BOOLEAN, "Hooks.disableSocialSpy", false); @Comment("Do we need to force /motd Essentials command on join?") - @Type(SettingType.Boolean) - public boolean useEssentialsMotd = false; + public static final Property USE_ESSENTIALS_MOTD = + newProperty(PropertyType.BOOLEAN, "Hooks.useEssentialsMotd", false); @Comment("Do we need to cache custom Attributes?") - @Type(SettingType.Boolean) - public boolean customAttributes = false; + public static final Property CACHE_CUSTOM_ATTRIBUTES = + newProperty(PropertyType.BOOLEAN, "Hooks.customAttributes", false); - private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "hooks.yml"); + private HooksSettings() { + } - private HooksSettings instance; - - public HooksSettings() - { - super(configFile); - instance = this; - } - - public HooksSettings getInstance() { - return instance; - } - - public void setInstance(HooksSettings instance) { - this.instance = instance; - } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java new file mode 100644 index 000000000..b64d2f2ec --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java @@ -0,0 +1,148 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.ConsoleLogger; +import fr.xephi.authme.settings.custom.domain.Comment; +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.SettingsClass; +import fr.xephi.authme.settings.custom.propertymap.PropertyMap; +import fr.xephi.authme.util.CollectionUtils; +import fr.xephi.authme.util.StringUtils; +import org.bukkit.configuration.file.YamlConfiguration; + +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; + +/** + * The new settings manager. + */ +public class NewSetting { + + private static final List> CONFIGURATION_CLASSES = Arrays.asList( + ConverterSettings.class, DatabaseSettings.class, EmailSettings.class, HooksSettings.class, + ProtectionSettings.class, PurgeSettings.class, SecuritySettings.class); + + private static final int YAML_INDENTATION = 4; + + private File file; + private YamlConfiguration configuration; + + public NewSetting(File file) { + this.configuration = YamlConfiguration.loadConfiguration(file); + this.file = file; + } + + // TODO: No way of passing just a YamlConfiguration object (later on for mocking purposes) ? + // If not, best is probably to keep this constructor as package-private with @VisibleForTesting + // but it's not a satisfying solution + public NewSetting(YamlConfiguration yamlConfiguration, String file) { + this.configuration = yamlConfiguration; + this.file = new File(file); + } + + public T getOption(Property property) { + return property.getFromFile(configuration); + } + + public void save() { + PropertyMap properties = getAllPropertyFields(); + + try (FileWriter writer = new FileWriter(file)) { + writer.write(""); + + // Contains all but the last node of the setting, e.g. [DataSource, mysql] for "DataSource.mysql.username" + List currentPath = new ArrayList<>(); + for (Map.Entry entry : properties.entrySet()) { + Property property = entry.getKey(); + + // Handle properties + List propertyPath = Arrays.asList(property.getPath().split("\\.")); + List commonPathParts = CollectionUtils.filterCommonStart( + currentPath, propertyPath.subList(0, propertyPath.size() - 1)); + List newPathParts = CollectionUtils.getRange(propertyPath, commonPathParts.size()); + + if (commonPathParts.isEmpty()) { + writer.append("\n"); + } + + int indentationLevel = commonPathParts.size(); + if (newPathParts.size() > 1) { + for (String path : newPathParts.subList(0, newPathParts.size() - 1)) { + writer.append("\n") + .append(StringUtils.repeat(" ", indentationLevel * YAML_INDENTATION)) + .append(path) + .append(": "); + ++indentationLevel; + } + } + for (String comment : entry.getValue()) { + writer.append("\n") + .append(StringUtils.repeat(" ", indentationLevel * YAML_INDENTATION)) + .append("# ") + .append(comment); + } + writer.append("\n") + .append(StringUtils.repeat(" ", indentationLevel * YAML_INDENTATION)) + .append(CollectionUtils.getRange(newPathParts, newPathParts.size() - 1).get(0)) + .append(": "); + + List yamlLines = property.formatValueAsYaml(configuration); + String delim = ""; + for (String yamlLine : yamlLines) { + writer.append(delim).append(yamlLine); + delim = "\n" + StringUtils.repeat(" ", indentationLevel * YAML_INDENTATION); + } + + currentPath = propertyPath.subList(0, propertyPath.size() - 1); + } + writer.flush(); + writer.close(); + } catch (IOException e) { + ConsoleLogger.showError("Could not save config file - " + StringUtils.formatException(e)); + ConsoleLogger.writeStackTrace(e); + } + } + + private static PropertyMap getAllPropertyFields() { + PropertyMap properties = new PropertyMap(); + for (Class clazz : CONFIGURATION_CLASSES) { + Field[] declaredFields = clazz.getDeclaredFields(); + for (Field field : declaredFields) { + Property property = getFieldIfRelevant(field); + if (property != null) { + properties.put(property, getCommentsForField(field)); + } + } + } + return properties; + } + + private static String[] getCommentsForField(Field field) { + if (field.isAnnotationPresent(Comment.class)) { + return field.getAnnotation(Comment.class).value(); + } + return new String[0]; + } + + private static Property getFieldIfRelevant(Field field) { + field.setAccessible(true); + if (field.isAccessible() && Property.class.equals(field.getType()) && Modifier.isStatic(field.getModifiers())) { + try { + return (Property) field.get(null); + } catch (IllegalAccessException e) { + throw new IllegalStateException("Could not fetch field '" + field.getName() + "' from class '" + + field.getDeclaringClass().getSimpleName() + "': " + StringUtils.formatException(e)); + } + } + return null; + } + + + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java b/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java index e8e2d059c..9f5daf952 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java @@ -1,63 +1,46 @@ package fr.xephi.authme.settings.custom; -import java.io.File; -import java.util.ArrayList; +import fr.xephi.authme.settings.custom.domain.Comment; +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.SettingsClass; + import java.util.List; -import fr.xephi.authme.settings.custom.annotations.Comment; -import fr.xephi.authme.settings.custom.annotations.Type; -import fr.xephi.authme.settings.custom.annotations.Type.SettingType; +import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.custom.domain.PropertyType.INTEGER; +import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING_LIST; -public class ProtectionSettings extends CustomSetting { - @Comment("Enable some servers protection ( country based login, antibot )") - @Type(SettingType.Boolean) - public boolean enableProtection = false; +public class ProtectionSettings implements SettingsClass { + + @Comment("Enable some servers protection (country based login, antibot)") + public static final Property ENABLE_PROTECTION = + newProperty(BOOLEAN, "Protection.enableProtection", false); @Comment({"Countries allowed to join the server and register, see http://dev.bukkit.org/bukkit-plugins/authme-reloaded/pages/countries-codes/ for countries' codes", - "PLEASE USE QUOTES !"}) - @Type(SettingType.StringList) - public List countriesWhitelist = new ArrayList(); + "PLEASE USE QUOTES!"}) + public static final Property> COUNTRIES_WHITELIST = + newProperty(STRING_LIST, "Protection.countries", "US", "GB", "A1"); @Comment({"Countries not allowed to join the server and register", - "PLEASE USE QUOTES !"}) - @Type(SettingType.StringList) - public List countriesBlacklist = new ArrayList(); + "PLEASE USE QUOTES!"}) + public static final Property> COUNTRIES_BLACKLIST = + newProperty(STRING_LIST, "Protection.countriesBlacklist"); @Comment("Do we need to enable automatic antibot system?") - @Type(SettingType.Boolean) - public boolean enableAntiBot = false; + public static final Property ENABLE_ANTIBOT = + newProperty(BOOLEAN, "Protection.enableAntiBot", false); @Comment("Max number of player allowed to login in 5 secs before enable AntiBot system automatically") - @Type(SettingType.Int) - public int antiBotSensibility = 5; + public static final Property ANTIBOT_SENSIBILITY = + newProperty(INTEGER, "Protection.antiBotSensibility", 5); @Comment("Duration in minutes of the antibot automatic system") - @Type(SettingType.Int) - public int antiBotDuration = 10; + public static final Property ANTIBOT_DURATION = + newProperty(INTEGER, "Protection.antiBotDuration", 10); - private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "protection.yml"); + private ProtectionSettings() { + } - private ProtectionSettings instance; - - public ProtectionSettings() - { - super(configFile); - instance = this; - if (this.isFirstLaunch) - { - this.countriesWhitelist.add("US"); - this.countriesWhitelist.add("GB"); - this.countriesBlacklist.add("A1"); - save(); - } - } - - public ProtectionSettings getInstance() { - return instance; - } - - public void setInstance(ProtectionSettings instance) { - this.instance = instance; - } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java index 3b85e2fb0..c46e86482 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java @@ -1,62 +1,49 @@ package fr.xephi.authme.settings.custom; -import java.io.File; -import java.util.ArrayList; -import java.util.List; +import fr.xephi.authme.settings.custom.domain.Comment; +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.SettingsClass; -import fr.xephi.authme.settings.custom.annotations.Comment; -import fr.xephi.authme.settings.custom.annotations.Type; -import fr.xephi.authme.settings.custom.annotations.Type.SettingType; +import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.custom.domain.PropertyType.INTEGER; +import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING; -public class PurgeSettings extends CustomSetting { +public class PurgeSettings implements SettingsClass { @Comment("If enabled, AuthMe automatically purges old, unused accounts") - @Type(SettingType.Boolean) - public boolean useAutoPurge = false; + public static final Property USE_AUTO_PURGE = + newProperty(BOOLEAN, "Purge.useAutoPurge", false); @Comment("Number of Days an account become Unused") - @Type(SettingType.Int) - public int daysBeforeRemovePlayer = 60; + public static final Property DAYS_BEFORE_REMOVE_PLAYER = + newProperty(INTEGER, "Purge.daysBeforeRemovePlayer", 60); @Comment("Do we need to remove the player.dat file during purge process?") - @Type(SettingType.Boolean) - public boolean removePlayerDat = false; + public static final Property REMOVE_PLAYER_DAT = + newProperty(BOOLEAN, "Purge.removePlayerDat", false); @Comment("Do we need to remove the Essentials/users/player.yml file during purge process?") - @Type(SettingType.Boolean) - public boolean removeEssentialsFiles = false; + public static final Property REMOVE_ESSENTIALS_FILES = + newProperty(BOOLEAN, "Purge.removeEssentialsFiles", false); @Comment("World where are players.dat stores") - @Type(SettingType.String) - public String defaultWorld = "world"; + public static final Property DEFAULT_WORLD = + newProperty(STRING, "Purge.defaultWorld", "world"); @Comment("Do we need to remove LimitedCreative/inventories/player.yml, player_creative.yml files during purge process ?") - @Type(SettingType.Boolean) - public boolean removeLimiteCreativeInventories = false; + public static final Property REMOVE_LIMITED_CREATIVE_INVENTORIES = + newProperty(BOOLEAN, "Purge.removeLimitedCreativesInventories", false); @Comment("Do we need to remove the AntiXRayData/PlayerData/player file during purge process?") - @Type(SettingType.Boolean) - public boolean removeAntiXRayFile = false; + public static final Property REMOVE_ANTI_XRAY_FILE = + newProperty(BOOLEAN, "Purge.removeAntiXRayFile", false); @Comment("Do we need to remove permissions?") - @Type(SettingType.Boolean) - public boolean removePermissions = false; + public static final Property REMOVE_PERMISSIONS = + newProperty(BOOLEAN, "Purge.removePermissions", false); - private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "purge.yml"); + private PurgeSettings() { + } - private PurgeSettings instance; - - public PurgeSettings() - { - super(configFile); - instance = this; - } - - public PurgeSettings getInstance() { - return instance; - } - - public void setInstance(PurgeSettings instance) { - this.instance = instance; - } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java index 3166cbe26..4b4638b3e 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java @@ -1,60 +1,51 @@ package fr.xephi.authme.settings.custom; -import java.io.File; -import java.util.ArrayList; -import java.util.List; +import fr.xephi.authme.settings.custom.domain.Comment; +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.SettingsClass; -import fr.xephi.authme.settings.custom.annotations.Comment; -import fr.xephi.authme.settings.custom.annotations.Type; -import fr.xephi.authme.settings.custom.annotations.Type.SettingType; +import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.custom.domain.PropertyType.INTEGER; -public class SecuritySettings extends CustomSetting { +public class SecuritySettings implements SettingsClass { @Comment({"Stop the server if we can't contact the sql database", - "Take care with this, if you set that to false,", - "AuthMe automatically disable and the server is not protected!"}) - @Type(SettingType.Boolean) - public boolean stopServerOnProblem = true; + "Take care with this, if you set this to false,", + "AuthMe will automatically disable and the server won't be protected!"}) + public static final Property STOP_SERVER_ON_PROBLEM = + newProperty(BOOLEAN, "Security.SQLProblem.stopServer", true); @Comment("/reload support") - @Type(SettingType.Boolean) - public boolean useReloadCommandSupport = true; + public static final Property USE_RELOAD_COMMAND_SUPPORT = + newProperty(BOOLEAN, "Security.ReloadCommand.useReloadCommandSupport", true); - @Comment("Remove Spam from Console ?") - @Type(SettingType.Boolean) - public boolean removeSpamFromConsole = false; + @Comment("Remove spam from console?") + public static final Property REMOVE_SPAM_FROM_CONSOLE = + newProperty(BOOLEAN, "Security.console.noConsoleSpam", false); - @Comment("Remove Password from Console ?") - @Type(SettingType.Boolean) - public boolean removePasswordFromConsole = true; + @Comment("Remove passwords from console?") + public static final Property REMOVE_PASSWORD_FROM_CONSOLE = + newProperty(BOOLEAN, "Security.console.removePassword", true); @Comment("Player need to put a captcha when he fails too lot the password") - @Type(SettingType.Boolean) - public boolean useCaptcha = false; + public static final Property USE_CAPTCHA = + newProperty(BOOLEAN, "Security.captcha.useCaptcha", false); @Comment("Max allowed tries before request a captcha") - @Type(SettingType.Int) - public int maxLoginTryBeforeCaptcha = 5; + public static final Property MAX_LOGIN_TRIES_BEFORE_CAPTCHA = + newProperty(INTEGER, "Security.captcha.maxLoginTry", 5); - @Comment("Captcha length ") - @Type(SettingType.Int) - public int captchaLength = 5; + @Comment("Captcha length") + public static final Property CAPTCHA_LENGTH = + newProperty(INTEGER, "Security.captcha.captchaLength", 5); - private static File configFile = new File("." + File.separator + "plugins" + File.separator + "AuthMe" + File.separator + "security.yml"); + @Comment({"Kick players before stopping the server, that allow us to save position of players", + "and all needed information correctly without any corruption."}) + public static final Property KICK_PLAYERS_BEFORE_STOPPING = + newProperty(BOOLEAN, "Security.stop.kickPlayersBeforeStopping", true); - private SecuritySettings instance; + private SecuritySettings() { + } - public SecuritySettings() - { - super(configFile); - instance = this; - } - - public SecuritySettings getInstance() { - return instance; - } - - public void setInstance(SecuritySettings instance) { - this.instance = instance; - } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/annotations/Type.java b/src/main/java/fr/xephi/authme/settings/custom/annotations/Type.java deleted file mode 100644 index aae0af52b..000000000 --- a/src/main/java/fr/xephi/authme/settings/custom/annotations/Type.java +++ /dev/null @@ -1,43 +0,0 @@ -package fr.xephi.authme.settings.custom.annotations; - -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; - -import fr.xephi.authme.settings.custom.annotations.Type.SettingType; - -/** -* -* Set the type of a field value -* -* @author xephi59 -* -*/ -@Retention(RetentionPolicy.RUNTIME) -@Target(ElementType.FIELD) -public @interface Type { - - public enum SettingType { - String(0), - Int(1), - Boolean(2), - Double(3), - StringList(4), - Long(5); - - private int type; - - SettingType(int type) - { - this.type = type; - } - - public int getType() - { - return this.type; - } - } - - public SettingType value() default SettingType.String; -} diff --git a/src/main/java/fr/xephi/authme/settings/custom/annotations/Comment.java b/src/main/java/fr/xephi/authme/settings/custom/domain/Comment.java similarity index 62% rename from src/main/java/fr/xephi/authme/settings/custom/annotations/Comment.java rename to src/main/java/fr/xephi/authme/settings/custom/domain/Comment.java index d711a1943..f664e424b 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/annotations/Comment.java +++ b/src/main/java/fr/xephi/authme/settings/custom/domain/Comment.java @@ -1,4 +1,4 @@ -package fr.xephi.authme.settings.custom.annotations; +package fr.xephi.authme.settings.custom.domain; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; @@ -6,15 +6,12 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * - * Add a comment to a field value - * - * @author xephi59 - * + * Comment for properties which are also included in the YAML file upon saving. */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Comment { - public String[] value() default ""; + String[] value() default ""; + } diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java b/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java new file mode 100644 index 000000000..e777f6ec9 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java @@ -0,0 +1,100 @@ +package fr.xephi.authme.settings.custom.domain; + +import org.bukkit.configuration.file.YamlConfiguration; + +import java.util.Arrays; +import java.util.List; +import java.util.Objects; + +/** + * Properties (i.e. a setting that is read from the config.yml file). + */ +public class Property { + + private final PropertyType type; + private final String path; + private final T defaultValue; + + private Property(PropertyType type, String path, T defaultValue) { + Objects.requireNonNull(defaultValue); + this.type = type; + this.path = path; + this.defaultValue = defaultValue; + } + + public static Property newProperty(PropertyType type, String path, T defaultValue) { + return new Property<>(type, path, defaultValue); + } + + @SafeVarargs + public static Property> newProperty(PropertyType> type, String path, U... defaultValues) { + return new Property<>(type, path, Arrays.asList(defaultValues)); + } + + // ----- + // Overloaded convenience methods for specific types + // ----- + public static Property newProperty(String path, boolean defaultValue) { + return new Property<>(PropertyType.BOOLEAN, path, defaultValue); + } + + public static Property newProperty(String path, int defaultValue) { + return new Property<>(PropertyType.INTEGER, path, defaultValue); + } + + public static Property newProperty(String path, String defaultValue) { + return new Property<>(PropertyType.STRING, path, defaultValue); + } + + // ----- + // Hooks to the PropertyType methods + // ----- + + /** + * Get the property value from the given configuration. + * + * @param configuration The configuration to read the value from + * @return The value, or default if not present + */ + public T getFromFile(YamlConfiguration configuration) { + return type.getFromFile(this, configuration); + } + + /** + * Format the property value as YAML. + * + * @param configuration The configuration to read the value from + * @return The property value as YAML + */ + public List formatValueAsYaml(YamlConfiguration configuration) { + return type.asYaml(this, configuration); + } + + // ----- + // Trivial getters + // ----- + + /** + * Return the default value of the property. + * + * @return The default value + */ + public T getDefaultValue() { + return defaultValue; + } + + /** + * Return the property path (i.e. the node at which this property is located in the YAML file). + * + * @return The path + */ + public String getPath() { + return path; + } + + @Override + public String toString() { + return "Property '" + path + "'"; + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java b/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java new file mode 100644 index 000000000..3680de3f9 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java @@ -0,0 +1,146 @@ +package fr.xephi.authme.settings.custom.domain; + +import org.bukkit.configuration.file.YamlConfiguration; + +import java.util.ArrayList; +import java.util.List; + +import static java.util.Arrays.asList; + +/** + * Handles a certain property type and provides type-specific functionality. + * + * @param The value of the property + * @see Property + */ +public abstract class PropertyType { + + public static final PropertyType BOOLEAN = new BooleanProperty(); + public static final PropertyType DOUBLE = new DoubleProperty(); + public static final PropertyType INTEGER = new IntegerProperty(); + public static final PropertyType STRING = new StringProperty(); + public static final PropertyType> STRING_LIST = new StringListProperty(); + + /** + * Get the property's value from the given YAML configuration. + * + * @param property The property to retrieve + * @param configuration The YAML configuration to read from + * @return The read value, or the default value if absent + */ + public abstract T getFromFile(Property property, YamlConfiguration configuration); + + /** + * Return the property's value (or its default) as YAML. + * + * @param property The property to transform + * @param configuration The YAML configuration to read from + * @return The read value or its default in YAML format + */ + public List asYaml(Property property, YamlConfiguration configuration) { + return asYaml(getFromFile(property, configuration)); + } + + /** + * Transform the given value to YAML. + * + * @param value The value to transform + * @return The value as YAML + */ + protected abstract List asYaml(T value); + + + /** + * Boolean property. + */ + private static final class BooleanProperty extends PropertyType { + @Override + public Boolean getFromFile(Property property, YamlConfiguration configuration) { + return configuration.getBoolean(property.getPath(), property.getDefaultValue()); + } + + @Override + protected List asYaml(Boolean value) { + return asList(value ? "true" : "false"); + } + } + + /** + * Double property. + */ + private static final class DoubleProperty extends PropertyType { + @Override + public Double getFromFile(Property property, YamlConfiguration configuration) { + return configuration.getDouble(property.getPath(), property.getDefaultValue()); + } + + @Override + protected List asYaml(Double value) { + return asList(String.valueOf(value)); + } + } + + /** + * Integer property. + */ + private static final class IntegerProperty extends PropertyType { + @Override + public Integer getFromFile(Property property, YamlConfiguration configuration) { + return configuration.getInt(property.getPath(), property.getDefaultValue()); + } + + @Override + protected List asYaml(Integer value) { + return asList(String.valueOf(value)); + } + } + + /** + * String property. + */ + private static final class StringProperty extends PropertyType { + @Override + public String getFromFile(Property property, YamlConfiguration configuration) { + return configuration.getString(property.getPath(), property.getDefaultValue()); + } + + @Override + protected List asYaml(String value) { + return asList(toYamlLiteral(value)); + } + + public static String toYamlLiteral(String str) { + // TODO: Need to handle new lines properly + return "'" + str.replace("'", "''") + "'"; + } + } + + /** + * String list property. + */ + private static final class StringListProperty extends PropertyType> { + @Override + public List getFromFile(Property> property, YamlConfiguration configuration) { + if (!configuration.isList(property.getPath())) { + return property.getDefaultValue(); + } + return configuration.getStringList(property.getPath()); + } + + @Override + protected List asYaml(List value) { + if (value.isEmpty()) { + return asList("[]"); + } + + List resultLines = new ArrayList<>(); + resultLines.add(""); // add + for (String entry : value) { + // TODO: StringProperty#toYamlLiteral will return List... + resultLines.add(" - " + StringProperty.toYamlLiteral(entry)); + } + return resultLines; + } + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/SettingsClass.java b/src/main/java/fr/xephi/authme/settings/custom/domain/SettingsClass.java new file mode 100644 index 000000000..6820e12e1 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/domain/SettingsClass.java @@ -0,0 +1,7 @@ +package fr.xephi.authme.settings.custom.domain; + +/** + * Marker for classes that define {@link Property} fields. + */ +public interface SettingsClass { +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/propertymap/Node.java b/src/main/java/fr/xephi/authme/settings/custom/propertymap/Node.java new file mode 100644 index 000000000..4e621617e --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/propertymap/Node.java @@ -0,0 +1,121 @@ +package fr.xephi.authme.settings.custom.propertymap; + +import java.util.ArrayList; +import java.util.List; + +/** + * Node class for building a tree from supplied String paths, ordered by insertion. + *

+ * For instance, consider a tree to which the following paths are inserted (in the given order): + * "animal.bird.duck", "color.yellow", "animal.rodent.rat", "animal.rodent.rabbit", "color.red". + * For such a tree:

    + *
  • "animal" (or any of its children) is sorted before "color" (or any of its children)
    • + *
  • "animal.bird" or any child thereof is sorted before "animal.rodent"
    • + *
  • "animal.rodent.rat" comes before "animal.rodent.rabbit"
    • + *
+ * + * @see PropertyMapComparator + */ +final class Node { + + private final String name; + private final List children; + + private Node(String name) { + this.name = name; + this.children = new ArrayList<>(); + } + + /** + * Create a root node, i.e. the starting node for a new tree. Call this method to create + * a new tree and always pass this root to other methods. + * + * @return The generated root node. + */ + public static Node createRoot() { + return new Node(null); + } + + /** + * Add a node to the root, creating any intermediary children that don't exist. + * + * @param root The root to add the path to + * @param fullPath The entire path of the node to add, separate by periods + */ + public static void addNode(Node root, String fullPath) { + String[] pathParts = fullPath.split("\\."); + Node parent = root; + for (String part : pathParts) { + Node child = parent.getChild(part); + if (child == null) { + child = new Node(part); + parent.children.add(child); + } + parent = child; + } + } + + /** + * Compare two nodes by this class' sorting behavior (insertion order). + * Note that this method assumes that both supplied paths exist in the tree. + * + * @param root The root of the tree + * @param fullPath1 The full path to the first node + * @param fullPath2 The full path to the second node + * @return The comparison result, in the same format as {@link Comparable#compareTo} + */ + public static int compare(Node root, String fullPath1, String fullPath2) { + String[] path1 = fullPath1.split("\\."); + String[] path2 = fullPath2.split("\\."); + + int commonCount = 0; + Node commonNode = root; + while (commonCount < path1.length && commonCount < path2.length + && path1[commonCount].equals(path2[commonCount]) && commonNode != null) { + commonNode = commonNode.getChild(path1[commonCount]); + ++commonCount; + } + + if (commonNode == null) { + System.err.println("Could not find common node for '" + fullPath1 + "' at index " + commonCount); + return fullPath1.compareTo(fullPath2); // fallback + } else if (commonCount >= path1.length || commonCount >= path2.length) { + return Integer.compare(path1.length, path2.length); + } + int child1Index = commonNode.getChildIndex(path1[commonCount]); + int child2Index = commonNode.getChildIndex(path2[commonCount]); + return Integer.compare(child1Index, child2Index); + } + + private Node getChild(String name) { + for (Node child : children) { + if (child.name.equals(name)) { + return child; + } + } + return null; + } + + /** + * Return the child's index, i.e. the position at which it was inserted to its parent. + * + * @param name The name of the node + * @return The insertion index + */ + private int getChildIndex(String name) { + int i = 0; + for (Node child : children) { + if (child.name.equals(name)) { + return i; + } + ++i; + } + return -1; + } + + @Override + public String toString() { + return "Node '" + name + "'"; + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMap.java b/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMap.java new file mode 100644 index 000000000..e539db7ab --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMap.java @@ -0,0 +1,48 @@ +package fr.xephi.authme.settings.custom.propertymap; + +import fr.xephi.authme.settings.custom.domain.Property; + +import java.util.Map; +import java.util.Set; +import java.util.TreeMap; + +/** + * Class wrapping a {@code Map} for storing properties and their associated + * comments with custom ordering. + * + * @see PropertyMapComparator for details about the map's order + */ +public class PropertyMap { + + private Map propertyMap; + private PropertyMapComparator comparator; + + /** + * Create a new property map. + */ + public PropertyMap() { + comparator = new PropertyMapComparator(); + propertyMap = new TreeMap<>(comparator); + } + + /** + * Add a new property to the map. + * + * @param property The property to add + * @param comments The comments associated to the property + */ + public void put(Property property, String[] comments) { + comparator.add(property); + propertyMap.put(property, comments); + } + + /** + * Return the entry set of the map. + * + * @return The entry set + */ + public Set> entrySet() { + return propertyMap.entrySet(); + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMapComparator.java b/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMapComparator.java new file mode 100644 index 000000000..9b07070bc --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMapComparator.java @@ -0,0 +1,39 @@ +package fr.xephi.authme.settings.custom.propertymap; + +import fr.xephi.authme.settings.custom.domain.Property; + +import java.util.Comparator; + +/** + * Custom comparator for {@link PropertyMap}. It guarantees that the map's entries: + *
    + *
  • are grouped by path, e.g. all "DataSource.mysql" properties are together, and "DataSource.mysql" properties + * are within the broader "DataSource" group.
    • + *
  • are ordered by insertion, e.g. if the first "DataSource" property is inserted before the first "security" + * property, then "DataSource" properties will come before the "security" ones.
    • + *
+ */ +final class PropertyMapComparator implements Comparator { + + private Node parent = Node.createRoot(); + + /** + * Method to call when adding a new property to the map (as to retain its insertion time). + * + * @param property The property that is being added + */ + public void add(Property property) { + Node.addNode(parent, property.getPath()); + } + + @Override + public int compare(Property p1, Property p2) { + return Node.compare(parent, p1.getPath(), p2.getPath()); + } + + @Override + public boolean equals(Object obj) { + return this == obj; + } + +} diff --git a/src/main/java/fr/xephi/authme/util/CollectionUtils.java b/src/main/java/fr/xephi/authme/util/CollectionUtils.java index 5c3eaa7f7..519951655 100644 --- a/src/main/java/fr/xephi/authme/util/CollectionUtils.java +++ b/src/main/java/fr/xephi/authme/util/CollectionUtils.java @@ -3,6 +3,7 @@ package fr.xephi.authme.util; import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.Objects; /** * Utils class for collections. @@ -58,4 +59,17 @@ public final class CollectionUtils { public static boolean isEmpty(Collection coll) { return coll == null || coll.isEmpty(); } + + public static List filterCommonStart(List coll1, List coll2) { + List commonStart = new ArrayList<>(); + int minSize = Math.min(coll1.size(), coll2.size()); + for (int i = 0; i < minSize; ++i) { + if (Objects.equals(coll1.get(i), coll2.get(i))) { + commonStart.add(coll1.get(i)); + } else { + break; + } + } + return commonStart; + } } diff --git a/src/main/java/fr/xephi/authme/util/StringUtils.java b/src/main/java/fr/xephi/authme/util/StringUtils.java index 9ae0ec0fd..2ee243819 100644 --- a/src/main/java/fr/xephi/authme/util/StringUtils.java +++ b/src/main/java/fr/xephi/authme/util/StringUtils.java @@ -117,4 +117,12 @@ public final class StringUtils { return "[" + th.getClass().getSimpleName() + "]: " + th.getMessage(); } + public static String repeat(String str, int times) { + StringBuilder sb = new StringBuilder(str.length() * times); + for (int i = 0; i < times; ++i) { + sb.append(str); + } + return sb.toString(); + } + } diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java new file mode 100644 index 000000000..39a5062c8 --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java @@ -0,0 +1,111 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.custom.domain.PropertyType; +import org.bukkit.configuration.file.YamlConfiguration; +import org.junit.Test; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.stubbing.Answer; + +import java.io.File; +import java.net.URL; +import java.util.List; + +import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.contains; +import static org.hamcrest.Matchers.equalTo; +import static org.mockito.BDDMockito.given; +import static org.mockito.Matchers.anyBoolean; +import static org.mockito.Matchers.anyInt; +import static org.mockito.Matchers.anyString; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.mock; + +public class NewSettingTest { + + private static final String CONFIG_FILE = "437-config-test.yml"; + + @Test + public void shouldReturnIntegerFromFile() { + // given + YamlConfiguration file = mock(YamlConfiguration.class); + Property config = TestConfiguration.DURATION_IN_SECONDS; + given(file.getInt("test.duration", 4)).willReturn(18); + NewSetting settings = new NewSetting(file, "conf.txt"); + + // when + int retrieve = settings.getOption(config); + + // then + assertThat(retrieve, equalTo(18)); + } + + @Test + public void shouldLoadAllConfigs() { + // given + YamlConfiguration file = mock(YamlConfiguration.class); + + given(file.getString(anyString(), anyString())).willAnswer(new Answer() { + @Override + public String answer(InvocationOnMock invocation) throws Throwable { + // Return the second parameter -> the default + return (String) invocation.getArguments()[1]; + } + }); + + given(file.getInt(eq(EmailSettings.RECOVERY_PASSWORD_LENGTH.getPath()), anyInt())) + .willReturn(20); + given(file.getBoolean(eq(SecuritySettings.REMOVE_PASSWORD_FROM_CONSOLE.getPath()), anyBoolean())) + .willReturn(false); + + // when + NewSetting settings = new NewSetting(file, "conf.txt"); + + // then + // Expect the value we told the YAML mock to return: + assertThat(settings.getOption(EmailSettings.RECOVERY_PASSWORD_LENGTH), equalTo(20)); + // Expect the default: + assertThat(settings.getOption(EmailSettings.SMTP_HOST), equalTo(EmailSettings.SMTP_HOST.getDefaultValue())); + // Expect the value we told the YAML mock to return: + assertThat(settings.getOption(SecuritySettings.REMOVE_PASSWORD_FROM_CONSOLE), equalTo(false)); + } + + @Test + public void executeIntegrationTest() { + // given + YamlConfiguration yamlFile = YamlConfiguration.loadConfiguration(getConfigFile()); + NewSetting settings = new NewSetting(yamlFile, "conf.txt"); + + // when + int result = settings.getOption(TestConfiguration.DURATION_IN_SECONDS); + String systemName = settings.getOption(TestConfiguration.SYSTEM_NAME); + String helpHeader = settings.getOption(newProperty("settings.helpHeader", "")); + List unsafePasswords = settings.getOption( + newProperty(PropertyType.STRING_LIST, "Security.unsafePasswords")); + + // then + assertThat(result, equalTo(22)); + assertThat(systemName, equalTo(TestConfiguration.SYSTEM_NAME.getDefaultValue())); + assertThat(helpHeader, equalTo("AuthMeReloaded")); + assertThat(unsafePasswords, contains("123456", "qwerty", "54321")); + } + + private File getConfigFile() { + URL url = getClass().getClassLoader().getResource(CONFIG_FILE); + if (url == null) { + throw new RuntimeException("File '" + CONFIG_FILE + "' could not be loaded"); + } + return new File(url.getFile()); + } + + private static class TestConfiguration { + + public static final Property DURATION_IN_SECONDS = + newProperty("test.duration", 4); + + public static final Property SYSTEM_NAME = + newProperty("test.systemName", "[TestDefaultValue]"); + } + +} diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java new file mode 100644 index 000000000..1dadf75e6 --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java @@ -0,0 +1,42 @@ +package fr.xephi.authme.settings.custom; + +import org.junit.Test; + +import java.io.File; +import java.net.URL; + +import static org.junit.Assert.assertThat; +import static org.hamcrest.Matchers.equalTo; + +/** + * Test for the save() function of new settings + */ +public class NewSettingsWriteTest { + + private static final String CONFIG_FILE = "437-write-test.yml"; + + @Test + public void shouldWriteProperties() { + File file = getConfigFile(); + NewSetting setting = new NewSetting(file); + setting.save(); + + // assert that we can load the file again -- i.e. that it's valid YAML! + NewSetting newSetting = new NewSetting(file); + assertThat(newSetting.getOption(SecuritySettings.CAPTCHA_LENGTH), + equalTo(SecuritySettings.CAPTCHA_LENGTH.getDefaultValue())); + assertThat(newSetting.getOption(ProtectionSettings.COUNTRIES_BLACKLIST), + equalTo(ProtectionSettings.COUNTRIES_BLACKLIST.getDefaultValue())); + } + + + + private File getConfigFile() { + URL url = getClass().getClassLoader().getResource(CONFIG_FILE); + if (url == null) { + throw new RuntimeException("File '" + CONFIG_FILE + "' could not be loaded"); + } + return new File(url.getFile()); + } + +} diff --git a/src/test/resources/437-config-test.yml b/src/test/resources/437-config-test.yml new file mode 100644 index 000000000..f0d9f11b9 --- /dev/null +++ b/src/test/resources/437-config-test.yml @@ -0,0 +1,44 @@ +test: + duration: 22 +DataSource: + # What type of database do you want to use? + # Valid values: sqlite, mysql + backend: sqlite + # Enable database caching, should improve database performance + caching: true +settings: + # The name shown in the help messages. + helpHeader: AuthMeReloaded + GameMode: + # ForceSurvivalMode to player when join ? + ForceSurvivalMode: false +Security: + SQLProblem: + # Stop the server if we can't contact the sql database + # Take care with this, if you set that to false, + # AuthMe automatically disable and the server is not protected! + stopServer: true + ReloadCommand: + # /reload support + useReloadCommandSupport: true + console: + # Remove spam console + noConsoleSpam: false + # Replace passwords in the console when player type a command like /login + removePassword: true + captcha: + # Player need to put a captcha when he fails too lot the password + useCaptcha: false + # Max allowed tries before request a captcha + maxLoginTry: 5 + # Captcha length + captchaLength: 5 + unsafePasswords: + - '123456' + - 'qwerty' + - '54321' +Email: + # Email SMTP server host + mailSMTP: smtp.gmail.com + # Email SMTP server port + mailPort: 465 diff --git a/src/test/resources/437-write-test.yml b/src/test/resources/437-write-test.yml new file mode 100644 index 000000000..de2b762f8 --- /dev/null +++ b/src/test/resources/437-write-test.yml @@ -0,0 +1,172 @@ + + +Converter: + Rakamak: + # Rakamak file name + fileName: 'users.rak' + # Rakamak use IP? + useIP: false + # Rakamak IP file name + ipFileName: 'UsersIp.rak' + CrazyLogin: + # CrazyLogin database file name + fileName: 'accounts.db' + +DataSource: + # What type of database do you want to use? + # Valid values: sqlite, mysql + backend: 'sqlite' + # Enable database caching, should improve database performance + caching: true + # Database host address + mySQLHost: '127.0.0.1' + # Database port + mySQLPort: '3306' + # Username about Database Connection Infos + mySQLUsername: 'authme' + # Password about Database Connection Infos + mySQLPassword: '123456' + # Database Name, use with converters or as SQLITE database name + mySQLDatabase: 'authme' + # Table of the database + mySQLTablename: 'authme' + # Column of IDs to sort data + mySQLColumnId: 'id' + # Column for storing or checking players nickname + mySQLColumnName: 'username' + # Column for storing or checking players RealName + mySQLRealName: 'realname' + # Column for storing players passwords + mySQLColumnPassword: 'password' + # Column for storing players emails + mySQLColumnEmail: 'email' + # Column for storing if a player is logged in or not + mySQLColumnLogged: 'email' + # Column for storing players ips + mySQLColumnIp: 'ip' + # Column for storing players lastlogins + mySQLColumnLastLogin: 'lastlogin' + # Column for storing player LastLocation - X + mySQLlastlocX: 'x' + # Column for storing player LastLocation - Y + mySQLlastlocY: 'y' + # Column for storing player LastLocation - Z + mySQLlastlocZ: 'z' + # Column for storing player LastLocation - World Name + mySQLlastlocWorld: 'world' + # Enable this when you allow registration through a website + mySQLWebsite: false + +ExternalBoardOptions: + # Column for storing players passwords salts + mySQLColumnSalt: '' + # Column for storing players groups + mySQLColumnGroup: '' + +Email: + # Email SMTP server host + mailSMTP: 'smtp.gmail.com' + # Email SMTP server port + mailPort: 465 + # Email account which sends the mails + mailAccount: '' + # Email account password + mailPassword: '' + # Recovery password length + RecoveryPasswordLength: 8 + # Mail Subject + mailSubject: 'Your new AuthMe password' + # Like maxRegPerIP but with email + maxRegPerEmail: 1 + # Recall players to add an email? + recallPlayers: false + # Delay in minute for the recall scheduler + delayRecall: 5 + # Blacklist these domains for emails + emailBlacklisted: + - '10minutemail.com' + # Whitelist ONLY these domains for emails + emailWhitelisted: [] + # Send the new password drawn in an image? + generateImage: false + # The OAuth2 token + emailOauth2Token: '' + +Hooks: + # Do we need to hook with multiverse for spawn checking? + multiverse: true + # Do we need to hook with BungeeCord? + bungeecord: false + # Do we need to disable Essentials SocialSpy on join? + disableSocialSpy: false + # Do we need to force /motd Essentials command on join? + useEssentialsMotd: false + # Do we need to cache custom Attributes? + customAttributes: false + +bungeecord: + # Send player to this BungeeCord server after register/login + server: '' + +Protection: + # Enable some servers protection (country based login, antibot) + enableProtection: false + # Countries allowed to join the server and register, see http://dev.bukkit.org/bukkit-plugins/authme-reloaded/pages/countries-codes/ for countries' codes + # PLEASE USE QUOTES! + countries: + - 'US' + - 'GB' + - 'A1' + # Countries not allowed to join the server and register + # PLEASE USE QUOTES! + countriesBlacklist: [] + # Do we need to enable automatic antibot system? + enableAntiBot: false + # Max number of player allowed to login in 5 secs before enable AntiBot system automatically + antiBotSensibility: 5 + # Duration in minutes of the antibot automatic system + antiBotDuration: 10 + +Purge: + # If enabled, AuthMe automatically purges old, unused accounts + useAutoPurge: false + # Number of Days an account become Unused + daysBeforeRemovePlayer: 60 + # Do we need to remove the player.dat file during purge process? + removePlayerDat: false + # Do we need to remove the Essentials/users/player.yml file during purge process? + removeEssentialsFiles: false + # World where are players.dat stores + defaultWorld: 'world' + # Do we need to remove LimitedCreative/inventories/player.yml, player_creative.yml files during purge process ? + removeLimitedCreativesInventories: false + # Do we need to remove the AntiXRayData/PlayerData/player file during purge process? + removeAntiXRayFile: false + # Do we need to remove permissions? + removePermissions: false + +Security: + SQLProblem: + # Stop the server if we can't contact the sql database + # Take care with this, if you set this to false, + # AuthMe will automatically disable and the server won't be protected! + stopServer: true + ReloadCommand: + # /reload support + useReloadCommandSupport: true + console: + # Remove spam from console? + noConsoleSpam: false + # Remove passwords from console? + removePassword: true + captcha: + # Player need to put a captcha when he fails too lot the password + useCaptcha: false + # Max allowed tries before request a captcha + maxLoginTry: 5 + # Captcha length + captchaLength: 5 + stop: + # Kick players before stopping the server, that allow us to save position of players + # and all needed information correctly without any corruption. + kickPlayersBeforeStopping: true From cb07b3df3db39f5bc7faddd92633ee1ca17dba1c Mon Sep 17 00:00:00 2001 From: ljacqu Date: Mon, 4 Jan 2016 20:33:31 +0100 Subject: [PATCH 03/16] Create enum property type, trivial code simplification --- .../settings/custom/DatabaseSettings.java | 5 +-- .../authme/settings/custom/NewSetting.java | 19 ++++++---- .../settings/custom/domain/Property.java | 4 +++ .../settings/custom/domain/PropertyType.java | 36 +++++++++++++++++++ .../fr/xephi/authme/util/CollectionUtils.java | 14 ++++---- .../fr/xephi/authme/util/StringUtils.java | 8 ----- .../settings/custom/NewSettingTest.java | 3 ++ src/test/resources/437-config-test.yml | 2 +- 8 files changed, 66 insertions(+), 25 deletions(-) diff --git a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java index 26e36310f..d8c5d9912 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java @@ -1,5 +1,6 @@ package fr.xephi.authme.settings.custom; +import fr.xephi.authme.datasource.DataSource; import fr.xephi.authme.settings.custom.domain.Comment; import fr.xephi.authme.settings.custom.domain.Property; import fr.xephi.authme.settings.custom.domain.SettingsClass; @@ -12,8 +13,8 @@ public class DatabaseSettings implements SettingsClass { @Comment({"What type of database do you want to use?", "Valid values: sqlite, mysql"}) - public static final Property BACKEND = - newProperty(STRING, "DataSource.backend", "sqlite"); + public static final Property BACKEND = + newProperty(DataSource.DataSourceType.class, "DataSource.backend", DataSource.DataSourceType.SQLITE); @Comment("Enable database caching, should improve database performance") public static final Property USE_CACHING = diff --git a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java index b64d2f2ec..1b56cd0fd 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java +++ b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java @@ -28,8 +28,6 @@ public class NewSetting { ConverterSettings.class, DatabaseSettings.class, EmailSettings.class, HooksSettings.class, ProtectionSettings.class, PurgeSettings.class, SecuritySettings.class); - private static final int YAML_INDENTATION = 4; - private File file; private YamlConfiguration configuration; @@ -75,7 +73,7 @@ public class NewSetting { if (newPathParts.size() > 1) { for (String path : newPathParts.subList(0, newPathParts.size() - 1)) { writer.append("\n") - .append(StringUtils.repeat(" ", indentationLevel * YAML_INDENTATION)) + .append(indent(indentationLevel)) .append(path) .append(": "); ++indentationLevel; @@ -83,12 +81,12 @@ public class NewSetting { } for (String comment : entry.getValue()) { writer.append("\n") - .append(StringUtils.repeat(" ", indentationLevel * YAML_INDENTATION)) + .append(indent(indentationLevel)) .append("# ") .append(comment); } writer.append("\n") - .append(StringUtils.repeat(" ", indentationLevel * YAML_INDENTATION)) + .append(indent(indentationLevel)) .append(CollectionUtils.getRange(newPathParts, newPathParts.size() - 1).get(0)) .append(": "); @@ -96,7 +94,7 @@ public class NewSetting { String delim = ""; for (String yamlLine : yamlLines) { writer.append(delim).append(yamlLine); - delim = "\n" + StringUtils.repeat(" ", indentationLevel * YAML_INDENTATION); + delim = "\n" + indent(indentationLevel); } currentPath = propertyPath.subList(0, propertyPath.size() - 1); @@ -109,6 +107,15 @@ public class NewSetting { } } + private static String indent(int level) { + // YAML uses indentation of 4 spaces + StringBuilder sb = new StringBuilder(level * 4); + for (int i = 0; i < level; ++i) { + sb.append(" "); + } + return sb.toString(); + } + private static PropertyMap getAllPropertyFields() { PropertyMap properties = new PropertyMap(); for (Class clazz : CONFIGURATION_CLASSES) { diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java b/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java index e777f6ec9..89b9f9420 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java +++ b/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java @@ -31,6 +31,10 @@ public class Property { return new Property<>(type, path, Arrays.asList(defaultValues)); } + public static > Property newProperty(Class clazz, String path, E defaultValue) { + return new Property<>(new PropertyType.EnumProperty<>(clazz), path, defaultValue); + } + // ----- // Overloaded convenience methods for specific types // ----- diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java b/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java index 3680de3f9..ac6d3d692 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java +++ b/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java @@ -143,4 +143,40 @@ public abstract class PropertyType { } } + /** + * Enum property. + * @param The enum class + */ + static final class EnumProperty> extends PropertyType { + private Class clazz; + + public EnumProperty(Class clazz) { + this.clazz = clazz; + } + + @Override + public E getFromFile(Property property, YamlConfiguration configuration) { + String textValue = configuration.getString(property.getPath()); + if (textValue == null) { + return property.getDefaultValue(); + } + E mappedValue = mapToEnum(textValue); + return mappedValue != null ? mappedValue : property.getDefaultValue(); + } + + @Override + protected List asYaml(E value) { + return asList("'" + value + "'"); + } + + private E mapToEnum(String value) { + for (E entry : clazz.getEnumConstants()) { + if (entry.name().equalsIgnoreCase(value)) { + return entry; + } + } + return null; + } + } + } diff --git a/src/main/java/fr/xephi/authme/util/CollectionUtils.java b/src/main/java/fr/xephi/authme/util/CollectionUtils.java index 519951655..13077547c 100644 --- a/src/main/java/fr/xephi/authme/util/CollectionUtils.java +++ b/src/main/java/fr/xephi/authme/util/CollectionUtils.java @@ -60,15 +60,13 @@ public final class CollectionUtils { return coll == null || coll.isEmpty(); } - public static List filterCommonStart(List coll1, List coll2) { + public static List filterCommonStart(List list1, List list2) { List commonStart = new ArrayList<>(); - int minSize = Math.min(coll1.size(), coll2.size()); - for (int i = 0; i < minSize; ++i) { - if (Objects.equals(coll1.get(i), coll2.get(i))) { - commonStart.add(coll1.get(i)); - } else { - break; - } + int minSize = Math.min(list1.size(), list2.size()); + int i = 0; + while (i < minSize && Objects.equals(list1.get(i), list2.get(i))) { + commonStart.add(list1.get(i)); + ++i; } return commonStart; } diff --git a/src/main/java/fr/xephi/authme/util/StringUtils.java b/src/main/java/fr/xephi/authme/util/StringUtils.java index 2ee243819..9ae0ec0fd 100644 --- a/src/main/java/fr/xephi/authme/util/StringUtils.java +++ b/src/main/java/fr/xephi/authme/util/StringUtils.java @@ -117,12 +117,4 @@ public final class StringUtils { return "[" + th.getClass().getSimpleName() + "]: " + th.getMessage(); } - public static String repeat(String str, int times) { - StringBuilder sb = new StringBuilder(str.length() * times); - for (int i = 0; i < times; ++i) { - sb.append(str); - } - return sb.toString(); - } - } diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java index 39a5062c8..585f128ec 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java @@ -1,5 +1,6 @@ package fr.xephi.authme.settings.custom; +import fr.xephi.authme.datasource.DataSource; import fr.xephi.authme.settings.custom.domain.Property; import fr.xephi.authme.settings.custom.domain.PropertyType; import org.bukkit.configuration.file.YamlConfiguration; @@ -83,12 +84,14 @@ public class NewSettingTest { String helpHeader = settings.getOption(newProperty("settings.helpHeader", "")); List unsafePasswords = settings.getOption( newProperty(PropertyType.STRING_LIST, "Security.unsafePasswords")); + DataSource.DataSourceType dataSourceType = settings.getOption(DatabaseSettings.BACKEND); // then assertThat(result, equalTo(22)); assertThat(systemName, equalTo(TestConfiguration.SYSTEM_NAME.getDefaultValue())); assertThat(helpHeader, equalTo("AuthMeReloaded")); assertThat(unsafePasswords, contains("123456", "qwerty", "54321")); + assertThat(dataSourceType, equalTo(DataSource.DataSourceType.MYSQL)); } private File getConfigFile() { diff --git a/src/test/resources/437-config-test.yml b/src/test/resources/437-config-test.yml index f0d9f11b9..5057bea92 100644 --- a/src/test/resources/437-config-test.yml +++ b/src/test/resources/437-config-test.yml @@ -3,7 +3,7 @@ test: DataSource: # What type of database do you want to use? # Valid values: sqlite, mysql - backend: sqlite + backend: mysql # Enable database caching, should improve database performance caching: true settings: From 204a564a9ab9397a4872dda6bc5d18de68f8f82d Mon Sep 17 00:00:00 2001 From: ljacqu Date: Tue, 5 Jan 2016 21:59:08 +0100 Subject: [PATCH 04/16] Move new configuration packages and add test for PropertyMap --- .../settings/custom/ConverterSettings.java | 12 ++--- .../settings/custom/DatabaseSettings.java | 12 ++--- .../authme/settings/custom/EmailSettings.java | 16 +++--- .../authme/settings/custom/HooksSettings.java | 10 ++-- .../authme/settings/custom/NewSetting.java | 8 +-- .../settings/custom/ProtectionSettings.java | 14 ++--- .../authme/settings/custom/PurgeSettings.java | 14 ++--- .../settings/custom/SecuritySettings.java | 12 ++--- .../settings/{custom => }/domain/Comment.java | 2 +- .../{custom => }/domain/Property.java | 2 +- .../{custom => }/domain/PropertyType.java | 2 +- .../{custom => }/domain/SettingsClass.java | 2 +- .../{custom => }/propertymap/Node.java | 2 +- .../{custom => }/propertymap/PropertyMap.java | 4 +- .../propertymap/PropertyMapComparator.java | 4 +- .../settings/custom/NewSettingTest.java | 6 +-- .../settings/propertymap/PropertyMapTest.java | 53 +++++++++++++++++++ 17 files changed, 114 insertions(+), 61 deletions(-) rename src/main/java/fr/xephi/authme/settings/{custom => }/domain/Comment.java (88%) rename src/main/java/fr/xephi/authme/settings/{custom => }/domain/Property.java (98%) rename src/main/java/fr/xephi/authme/settings/{custom => }/domain/PropertyType.java (99%) rename src/main/java/fr/xephi/authme/settings/{custom => }/domain/SettingsClass.java (68%) rename src/main/java/fr/xephi/authme/settings/{custom => }/propertymap/Node.java (98%) rename src/main/java/fr/xephi/authme/settings/{custom => }/propertymap/PropertyMap.java (90%) rename src/main/java/fr/xephi/authme/settings/{custom => }/propertymap/PropertyMapComparator.java (91%) create mode 100644 src/test/java/fr/xephi/authme/settings/propertymap/PropertyMapTest.java diff --git a/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java b/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java index c9f1ba99e..f208727b7 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java @@ -1,12 +1,12 @@ package fr.xephi.authme.settings.custom; -import fr.xephi.authme.settings.custom.domain.Comment; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.SettingsClass; +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; -import static fr.xephi.authme.settings.custom.domain.Property.newProperty; -import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; -import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING; +import static fr.xephi.authme.settings.domain.Property.newProperty; +import static fr.xephi.authme.settings.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.domain.PropertyType.STRING; public class ConverterSettings implements SettingsClass { diff --git a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java index d8c5d9912..d638fd8f0 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java @@ -1,13 +1,13 @@ package fr.xephi.authme.settings.custom; import fr.xephi.authme.datasource.DataSource; -import fr.xephi.authme.settings.custom.domain.Comment; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.SettingsClass; +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; -import static fr.xephi.authme.settings.custom.domain.Property.newProperty; -import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; -import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING; +import static fr.xephi.authme.settings.domain.Property.newProperty; +import static fr.xephi.authme.settings.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.domain.PropertyType.STRING; public class DatabaseSettings implements SettingsClass { diff --git a/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java b/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java index f53d9549d..dcde50191 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java @@ -1,16 +1,16 @@ package fr.xephi.authme.settings.custom; -import fr.xephi.authme.settings.custom.domain.Comment; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.SettingsClass; +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; import java.util.List; -import static fr.xephi.authme.settings.custom.domain.Property.newProperty; -import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; -import static fr.xephi.authme.settings.custom.domain.PropertyType.INTEGER; -import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING; -import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING_LIST; +import static fr.xephi.authme.settings.domain.Property.newProperty; +import static fr.xephi.authme.settings.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.domain.PropertyType.INTEGER; +import static fr.xephi.authme.settings.domain.PropertyType.STRING; +import static fr.xephi.authme.settings.domain.PropertyType.STRING_LIST; public class EmailSettings implements SettingsClass { diff --git a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java index 6f75eb247..6e23c7398 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java @@ -1,11 +1,11 @@ package fr.xephi.authme.settings.custom; -import fr.xephi.authme.settings.custom.domain.Comment; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.PropertyType; -import fr.xephi.authme.settings.custom.domain.SettingsClass; +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.PropertyType; +import fr.xephi.authme.settings.domain.SettingsClass; -import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static fr.xephi.authme.settings.domain.Property.newProperty; public class HooksSettings implements SettingsClass { diff --git a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java index 1b56cd0fd..138c37d3d 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java +++ b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java @@ -1,10 +1,10 @@ package fr.xephi.authme.settings.custom; import fr.xephi.authme.ConsoleLogger; -import fr.xephi.authme.settings.custom.domain.Comment; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.SettingsClass; -import fr.xephi.authme.settings.custom.propertymap.PropertyMap; +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; +import fr.xephi.authme.settings.propertymap.PropertyMap; import fr.xephi.authme.util.CollectionUtils; import fr.xephi.authme.util.StringUtils; import org.bukkit.configuration.file.YamlConfiguration; diff --git a/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java b/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java index 9f5daf952..b71a9589b 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java @@ -1,15 +1,15 @@ package fr.xephi.authme.settings.custom; -import fr.xephi.authme.settings.custom.domain.Comment; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.SettingsClass; +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; import java.util.List; -import static fr.xephi.authme.settings.custom.domain.Property.newProperty; -import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; -import static fr.xephi.authme.settings.custom.domain.PropertyType.INTEGER; -import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING_LIST; +import static fr.xephi.authme.settings.domain.Property.newProperty; +import static fr.xephi.authme.settings.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.domain.PropertyType.INTEGER; +import static fr.xephi.authme.settings.domain.PropertyType.STRING_LIST; public class ProtectionSettings implements SettingsClass { diff --git a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java index c46e86482..e2e1c0290 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java @@ -1,13 +1,13 @@ package fr.xephi.authme.settings.custom; -import fr.xephi.authme.settings.custom.domain.Comment; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.SettingsClass; +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; -import static fr.xephi.authme.settings.custom.domain.Property.newProperty; -import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; -import static fr.xephi.authme.settings.custom.domain.PropertyType.INTEGER; -import static fr.xephi.authme.settings.custom.domain.PropertyType.STRING; +import static fr.xephi.authme.settings.domain.Property.newProperty; +import static fr.xephi.authme.settings.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.domain.PropertyType.INTEGER; +import static fr.xephi.authme.settings.domain.PropertyType.STRING; public class PurgeSettings implements SettingsClass { diff --git a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java index 4b4638b3e..c18e7e7ca 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java @@ -1,12 +1,12 @@ package fr.xephi.authme.settings.custom; -import fr.xephi.authme.settings.custom.domain.Comment; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.SettingsClass; +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; -import static fr.xephi.authme.settings.custom.domain.Property.newProperty; -import static fr.xephi.authme.settings.custom.domain.PropertyType.BOOLEAN; -import static fr.xephi.authme.settings.custom.domain.PropertyType.INTEGER; +import static fr.xephi.authme.settings.domain.Property.newProperty; +import static fr.xephi.authme.settings.domain.PropertyType.BOOLEAN; +import static fr.xephi.authme.settings.domain.PropertyType.INTEGER; public class SecuritySettings implements SettingsClass { diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/Comment.java b/src/main/java/fr/xephi/authme/settings/domain/Comment.java similarity index 88% rename from src/main/java/fr/xephi/authme/settings/custom/domain/Comment.java rename to src/main/java/fr/xephi/authme/settings/domain/Comment.java index f664e424b..92713aeec 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/domain/Comment.java +++ b/src/main/java/fr/xephi/authme/settings/domain/Comment.java @@ -1,4 +1,4 @@ -package fr.xephi.authme.settings.custom.domain; +package fr.xephi.authme.settings.domain; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java b/src/main/java/fr/xephi/authme/settings/domain/Property.java similarity index 98% rename from src/main/java/fr/xephi/authme/settings/custom/domain/Property.java rename to src/main/java/fr/xephi/authme/settings/domain/Property.java index 89b9f9420..71e111648 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/domain/Property.java +++ b/src/main/java/fr/xephi/authme/settings/domain/Property.java @@ -1,4 +1,4 @@ -package fr.xephi.authme.settings.custom.domain; +package fr.xephi.authme.settings.domain; import org.bukkit.configuration.file.YamlConfiguration; diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java similarity index 99% rename from src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java rename to src/main/java/fr/xephi/authme/settings/domain/PropertyType.java index ac6d3d692..dba0e9712 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/domain/PropertyType.java +++ b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java @@ -1,4 +1,4 @@ -package fr.xephi.authme.settings.custom.domain; +package fr.xephi.authme.settings.domain; import org.bukkit.configuration.file.YamlConfiguration; diff --git a/src/main/java/fr/xephi/authme/settings/custom/domain/SettingsClass.java b/src/main/java/fr/xephi/authme/settings/domain/SettingsClass.java similarity index 68% rename from src/main/java/fr/xephi/authme/settings/custom/domain/SettingsClass.java rename to src/main/java/fr/xephi/authme/settings/domain/SettingsClass.java index 6820e12e1..796505add 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/domain/SettingsClass.java +++ b/src/main/java/fr/xephi/authme/settings/domain/SettingsClass.java @@ -1,4 +1,4 @@ -package fr.xephi.authme.settings.custom.domain; +package fr.xephi.authme.settings.domain; /** * Marker for classes that define {@link Property} fields. diff --git a/src/main/java/fr/xephi/authme/settings/custom/propertymap/Node.java b/src/main/java/fr/xephi/authme/settings/propertymap/Node.java similarity index 98% rename from src/main/java/fr/xephi/authme/settings/custom/propertymap/Node.java rename to src/main/java/fr/xephi/authme/settings/propertymap/Node.java index 4e621617e..70d8ce239 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/propertymap/Node.java +++ b/src/main/java/fr/xephi/authme/settings/propertymap/Node.java @@ -1,4 +1,4 @@ -package fr.xephi.authme.settings.custom.propertymap; +package fr.xephi.authme.settings.propertymap; import java.util.ArrayList; import java.util.List; diff --git a/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMap.java b/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java similarity index 90% rename from src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMap.java rename to src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java index e539db7ab..934245a07 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMap.java +++ b/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java @@ -1,6 +1,6 @@ -package fr.xephi.authme.settings.custom.propertymap; +package fr.xephi.authme.settings.propertymap; -import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.domain.Property; import java.util.Map; import java.util.Set; diff --git a/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMapComparator.java b/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMapComparator.java similarity index 91% rename from src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMapComparator.java rename to src/main/java/fr/xephi/authme/settings/propertymap/PropertyMapComparator.java index 9b07070bc..e646fb61d 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/propertymap/PropertyMapComparator.java +++ b/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMapComparator.java @@ -1,6 +1,6 @@ -package fr.xephi.authme.settings.custom.propertymap; +package fr.xephi.authme.settings.propertymap; -import fr.xephi.authme.settings.custom.domain.Property; +import fr.xephi.authme.settings.domain.Property; import java.util.Comparator; diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java index 585f128ec..419d5917c 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java @@ -1,8 +1,8 @@ package fr.xephi.authme.settings.custom; import fr.xephi.authme.datasource.DataSource; -import fr.xephi.authme.settings.custom.domain.Property; -import fr.xephi.authme.settings.custom.domain.PropertyType; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.PropertyType; import org.bukkit.configuration.file.YamlConfiguration; import org.junit.Test; import org.mockito.invocation.InvocationOnMock; @@ -12,7 +12,7 @@ import java.io.File; import java.net.URL; import java.util.List; -import static fr.xephi.authme.settings.custom.domain.Property.newProperty; +import static fr.xephi.authme.settings.domain.Property.newProperty; import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.Matchers.contains; import static org.hamcrest.Matchers.equalTo; diff --git a/src/test/java/fr/xephi/authme/settings/propertymap/PropertyMapTest.java b/src/test/java/fr/xephi/authme/settings/propertymap/PropertyMapTest.java new file mode 100644 index 000000000..895b12e1c --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/propertymap/PropertyMapTest.java @@ -0,0 +1,53 @@ +package fr.xephi.authme.settings.propertymap; + +import fr.xephi.authme.settings.domain.Property; +import org.junit.Assert; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.Set; + + +import static org.hamcrest.Matchers.contains; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +/** + * Test for {@link PropertyMap}. + */ +public class PropertyMapTest { + + @Test + public void shouldKeepEntriesByInsertionAndGroup() { + // given + List paths = Arrays.asList("japan", "indonesia.jakarta", "japan.tokyo", "china.shanghai", "egypt.cairo", + "china.shenzhen", "china", "indonesia.jakarta.tugu", "egypt", "japan.nagoya", "japan.tokyo.taito"); + PropertyMap map = new PropertyMap(); + + // when + for (String path : paths) { + Property property = createPropertyWithPath(path); + map.put(property, new String[0]); + } + + // then + Set> entrySet = map.entrySet(); + List resultPaths = new ArrayList<>(entrySet.size()); + for (Map.Entry entry : entrySet) { + resultPaths.add(entry.getKey().getPath()); + } + + Assert.assertThat(resultPaths, contains("japan", "japan.tokyo", "japan.tokyo.taito", "japan.nagoya", + "indonesia.jakarta", "indonesia.jakarta.tugu", "china", "china.shanghai", "china.shenzhen", + "egypt", "egypt.cairo")); + } + + private static Property createPropertyWithPath(String path) { + Property property = mock(Property.class); + when(property.getPath()).thenReturn(path); + return property; + } +} From acda03bb40f4d6fd281f738b5a785703fd65750b Mon Sep 17 00:00:00 2001 From: ljacqu Date: Thu, 7 Jan 2016 21:38:03 +0100 Subject: [PATCH 05/16] #347 Create enum property + consistency tests --- .../settings/domain/EnumPropertyType.java | 44 ++++++++ .../authme/settings/domain/Property.java | 2 +- .../authme/settings/domain/PropertyType.java | 36 ------ .../custom/SettingsClassConsistencyTest.java | 106 ++++++++++++++++++ .../settings/domain/EnumPropertyTypeTest.java | 71 ++++++++++++ 5 files changed, 222 insertions(+), 37 deletions(-) create mode 100644 src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java create mode 100644 src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java create mode 100644 src/test/java/fr/xephi/authme/settings/domain/EnumPropertyTypeTest.java diff --git a/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java b/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java new file mode 100644 index 000000000..8455a893a --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java @@ -0,0 +1,44 @@ +package fr.xephi.authme.settings.domain; + +import org.bukkit.configuration.file.YamlConfiguration; + +import java.util.List; + +import static java.util.Arrays.asList; + +/** + * Enum property type. + * @param The enum class + */ +class EnumPropertyType> extends PropertyType { + + private Class clazz; + + public EnumPropertyType(Class clazz) { + this.clazz = clazz; + } + + @Override + public E getFromFile(Property property, YamlConfiguration configuration) { + String textValue = configuration.getString(property.getPath()); + if (textValue == null) { + return property.getDefaultValue(); + } + E mappedValue = mapToEnum(textValue); + return mappedValue != null ? mappedValue : property.getDefaultValue(); + } + + @Override + protected List asYaml(E value) { + return asList("'" + value + "'"); + } + + private E mapToEnum(String value) { + for (E entry : clazz.getEnumConstants()) { + if (entry.name().equalsIgnoreCase(value)) { + return entry; + } + } + return null; + } +} diff --git a/src/main/java/fr/xephi/authme/settings/domain/Property.java b/src/main/java/fr/xephi/authme/settings/domain/Property.java index 71e111648..809f7a987 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/Property.java +++ b/src/main/java/fr/xephi/authme/settings/domain/Property.java @@ -32,7 +32,7 @@ public class Property { } public static > Property newProperty(Class clazz, String path, E defaultValue) { - return new Property<>(new PropertyType.EnumProperty<>(clazz), path, defaultValue); + return new Property<>(new EnumPropertyType<>(clazz), path, defaultValue); } // ----- diff --git a/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java index dba0e9712..e41965640 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java +++ b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java @@ -143,40 +143,4 @@ public abstract class PropertyType { } } - /** - * Enum property. - * @param The enum class - */ - static final class EnumProperty> extends PropertyType { - private Class clazz; - - public EnumProperty(Class clazz) { - this.clazz = clazz; - } - - @Override - public E getFromFile(Property property, YamlConfiguration configuration) { - String textValue = configuration.getString(property.getPath()); - if (textValue == null) { - return property.getDefaultValue(); - } - E mappedValue = mapToEnum(textValue); - return mappedValue != null ? mappedValue : property.getDefaultValue(); - } - - @Override - protected List asYaml(E value) { - return asList("'" + value + "'"); - } - - private E mapToEnum(String value) { - for (E entry : clazz.getEnumConstants()) { - if (entry.name().equalsIgnoreCase(value)) { - return entry; - } - } - return null; - } - } - } diff --git a/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java b/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java new file mode 100644 index 000000000..c06ed11b1 --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java @@ -0,0 +1,106 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.ReflectionTestUtils; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; +import org.junit.BeforeClass; +import org.junit.Test; + +import java.io.File; +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import static org.hamcrest.Matchers.equalTo; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.fail; + +/** + * Test for {@link SettingsClass} implementations. + */ +public class SettingsClassConsistencyTest { + + private static final String SETTINGS_FOLDER = "src/main/java/fr/xephi/authme/settings/custom"; + private static List> classes; + + @BeforeClass + public static void scanForSettingsClasses() { + File settingsFolder = new File(SETTINGS_FOLDER); + File[] filesInFolder = settingsFolder.listFiles(); + if (filesInFolder == null || filesInFolder.length == 0) { + throw new IllegalStateException("Could not read folder '" + SETTINGS_FOLDER + "'. Is it correct?"); + } + + classes = new ArrayList<>(); + for (File file : filesInFolder) { + Class clazz = getSettingsClassFromFile(file); + if (clazz != null) { + classes.add(clazz); + } + } + System.out.println("Found " + classes.size() + " SettingsClass implementations"); + } + + /** + * Make sure that all {@link Property} instances we define are in public, static, final fields. + */ + @Test + public void shouldHavePublicStaticFinalFields() { + for (Class clazz : classes) { + Field[] fields = clazz.getDeclaredFields(); + for (Field field : fields) { + if (Property.class.isAssignableFrom(field.getType())) { + String fieldName = "Field " + clazz.getSimpleName() + "#" + field.getName(); + assertThat(fieldName + "should be public, static, and final", + isValidConstantField(field), equalTo(true)); + } + } + } + } + + /** + * Make sure that no properties use the same path. + */ + @Test + public void shouldHaveUniquePaths() { + Set paths = new HashSet<>(); + for (Class clazz : classes) { + Field[] fields = clazz.getDeclaredFields(); + for (Field field : fields) { + if (Property.class.isAssignableFrom(field.getType())) { + Property property = + (Property) ReflectionTestUtils.getFieldValue(clazz, null, field.getName()); + if (paths.contains(property.getPath())) { + fail("Path '" + property.getPath() + "' should be used by only one constant"); + } + paths.add(property.getPath()); + } + } + } + } + + private static boolean isValidConstantField(Field field) { + int modifiers = field.getModifiers(); + return Modifier.isPublic(modifiers) && Modifier.isStatic(modifiers) && Modifier.isFinal(modifiers); + } + + private static Class getSettingsClassFromFile(File file) { + String fileName = file.getPath(); + String className = fileName + .substring("src/main/java/".length(), fileName.length() - ".java".length()) + .replace(File.separator, "."); + try { + Class clazz = SettingsClassConsistencyTest.class.getClassLoader().loadClass(className); + if (SettingsClass.class.isAssignableFrom(clazz)) { + return (Class) clazz; + } + return null; + } catch (ClassNotFoundException e) { + throw new IllegalStateException("Could not load class '" + className + "'", e); + } + } + +} diff --git a/src/test/java/fr/xephi/authme/settings/domain/EnumPropertyTypeTest.java b/src/test/java/fr/xephi/authme/settings/domain/EnumPropertyTypeTest.java new file mode 100644 index 000000000..1b9d39091 --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/domain/EnumPropertyTypeTest.java @@ -0,0 +1,71 @@ +package fr.xephi.authme.settings.domain; + +import org.bukkit.configuration.file.YamlConfiguration; +import org.junit.Test; + +import static org.hamcrest.Matchers.equalTo; +import static org.junit.Assert.assertThat; +import static org.mockito.BDDMockito.given; +import static org.mockito.Mockito.mock; + +/** + * Test for {@link EnumPropertyType}. + */ +public class EnumPropertyTypeTest { + + @Test + public void shouldReturnCorrectEnumValue() { + // given + PropertyType propertyType = new EnumPropertyType<>(TestEnum.class); + Property property = Property.newProperty(TestEnum.class, "enum.path", TestEnum.ENTRY_C); + YamlConfiguration configuration = mock(YamlConfiguration.class); + given(configuration.getString(property.getPath())).willReturn("Entry_B"); + + // when + TestEnum result = propertyType.getFromFile(property, configuration); + + // then + assertThat(result, equalTo(TestEnum.ENTRY_B)); + } + + @Test + public void shouldFallBackToDefaultForInvalidValue() { + // given + PropertyType propertyType = new EnumPropertyType<>(TestEnum.class); + Property property = Property.newProperty(TestEnum.class, "enum.path", TestEnum.ENTRY_C); + YamlConfiguration configuration = mock(YamlConfiguration.class); + given(configuration.getString(property.getPath())).willReturn("Bogus"); + + // when + TestEnum result = propertyType.getFromFile(property, configuration); + + // then + assertThat(result, equalTo(TestEnum.ENTRY_C)); + } + + @Test + public void shouldFallBackToDefaultForNonExistentValue() { + // given + PropertyType propertyType = new EnumPropertyType<>(TestEnum.class); + Property property = Property.newProperty(TestEnum.class, "enum.path", TestEnum.ENTRY_C); + YamlConfiguration configuration = mock(YamlConfiguration.class); + given(configuration.getString(property.getPath())).willReturn(null); + + // when + TestEnum result = propertyType.getFromFile(property, configuration); + + // then + assertThat(result, equalTo(TestEnum.ENTRY_C)); + } + + + private enum TestEnum { + + ENTRY_A, + + ENTRY_B, + + ENTRY_C + + } +} From 30db03837a32f3f365d8dbd57cbf6447a190117d Mon Sep 17 00:00:00 2001 From: ljacqu Date: Thu, 7 Jan 2016 21:58:28 +0100 Subject: [PATCH 06/16] #347 Add 'contains' method to PropertyType --- .../settings/domain/EnumPropertyType.java | 6 +++ .../authme/settings/domain/PropertyType.java | 4 ++ .../settings/domain/EnumPropertyTypeTest.java | 47 +++++++++++++++++++ 3 files changed, 57 insertions(+) diff --git a/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java b/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java index 8455a893a..357067d8e 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java +++ b/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java @@ -33,6 +33,12 @@ class EnumPropertyType> extends PropertyType { return asList("'" + value + "'"); } + @Override + public boolean contains(Property property, YamlConfiguration configuration) { + return super.contains(property, configuration) + && mapToEnum(configuration.getString(property.getPath())) != null; + } + private E mapToEnum(String value) { for (E entry : clazz.getEnumConstants()) { if (entry.name().equalsIgnoreCase(value)) { diff --git a/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java index e41965640..b243ef657 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java +++ b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java @@ -49,6 +49,10 @@ public abstract class PropertyType { */ protected abstract List asYaml(T value); + protected boolean contains(Property property, YamlConfiguration configuration) { + return configuration.contains(property.getPath()); + } + /** * Boolean property. diff --git a/src/test/java/fr/xephi/authme/settings/domain/EnumPropertyTypeTest.java b/src/test/java/fr/xephi/authme/settings/domain/EnumPropertyTypeTest.java index 1b9d39091..461314e8d 100644 --- a/src/test/java/fr/xephi/authme/settings/domain/EnumPropertyTypeTest.java +++ b/src/test/java/fr/xephi/authme/settings/domain/EnumPropertyTypeTest.java @@ -58,6 +58,53 @@ public class EnumPropertyTypeTest { assertThat(result, equalTo(TestEnum.ENTRY_C)); } + @Test + public void shouldReturnTrueForContainsCheck() { + // given + PropertyType propertyType = new EnumPropertyType<>(TestEnum.class); + Property property = Property.newProperty(TestEnum.class, "my.test.path", TestEnum.ENTRY_C); + YamlConfiguration configuration = mock(YamlConfiguration.class); + given(configuration.contains(property.getPath())).willReturn(true); + given(configuration.getString(property.getPath())).willReturn("ENTRY_B"); + + // when + boolean result = propertyType.contains(property, configuration); + + // then + assertThat(result, equalTo(true)); + } + + @Test + public void shouldReturnFalseForFileWithoutConfig() { + // given + PropertyType propertyType = new EnumPropertyType<>(TestEnum.class); + Property property = Property.newProperty(TestEnum.class, "my.test.path", TestEnum.ENTRY_C); + YamlConfiguration configuration = mock(YamlConfiguration.class); + given(configuration.contains(property.getPath())).willReturn(false); + + // when + boolean result = propertyType.contains(property, configuration); + + // then + assertThat(result, equalTo(false)); + } + + @Test + public void shouldReturnFalseForUnknownValue() { + // given + PropertyType propertyType = new EnumPropertyType<>(TestEnum.class); + Property property = Property.newProperty(TestEnum.class, "my.test.path", TestEnum.ENTRY_C); + YamlConfiguration configuration = mock(YamlConfiguration.class); + given(configuration.contains(property.getPath())).willReturn(true); + given(configuration.getString(property.getPath())).willReturn("wrong value"); + + // when + boolean result = propertyType.contains(property, configuration); + + // then + assertThat(result, equalTo(false)); + } + private enum TestEnum { From 69c225c8506ed18d2126a000cce68c0238d10ed0 Mon Sep 17 00:00:00 2001 From: ljacqu Date: Fri, 8 Jan 2016 21:22:26 +0100 Subject: [PATCH 07/16] #347 Create tests and add check for missing settings in NewSetting --- .../authme/settings/custom/NewSetting.java | 71 ++----- .../custom/SettingsFieldRetriever.java | 67 +++++++ .../authme/settings/domain/Property.java | 10 + .../authme/settings/domain/PropertyType.java | 20 +- .../settings/propertymap/PropertyMap.java | 13 +- .../settings/custom/NewSettingsWriteTest.java | 1 - .../settings/domain/PropertyTypeTest.java | 182 ++++++++++++++++++ .../settings/propertymap/PropertyMapTest.java | 4 +- 8 files changed, 309 insertions(+), 59 deletions(-) create mode 100644 src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java create mode 100644 src/test/java/fr/xephi/authme/settings/domain/PropertyTypeTest.java diff --git a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java index 138c37d3d..86a15b0d5 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java +++ b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java @@ -1,9 +1,8 @@ package fr.xephi.authme.settings.custom; +import com.google.common.annotations.VisibleForTesting; import fr.xephi.authme.ConsoleLogger; -import fr.xephi.authme.settings.domain.Comment; import fr.xephi.authme.settings.domain.Property; -import fr.xephi.authme.settings.domain.SettingsClass; import fr.xephi.authme.settings.propertymap.PropertyMap; import fr.xephi.authme.util.CollectionUtils; import fr.xephi.authme.util.StringUtils; @@ -12,8 +11,6 @@ import org.bukkit.configuration.file.YamlConfiguration; import java.io.File; import java.io.FileWriter; import java.io.IOException; -import java.lang.reflect.Field; -import java.lang.reflect.Modifier; import java.util.ArrayList; import java.util.Arrays; import java.util.List; @@ -24,22 +21,21 @@ import java.util.Map; */ public class NewSetting { - private static final List> CONFIGURATION_CLASSES = Arrays.asList( - ConverterSettings.class, DatabaseSettings.class, EmailSettings.class, HooksSettings.class, - ProtectionSettings.class, PurgeSettings.class, SecuritySettings.class); - private File file; private YamlConfiguration configuration; public NewSetting(File file) { this.configuration = YamlConfiguration.loadConfiguration(file); this.file = file; + + PropertyMap propertyMap = SettingsFieldRetriever.getAllPropertyFields(); + if (!containsAllSettings(propertyMap)) { + save(propertyMap); + } } - // TODO: No way of passing just a YamlConfiguration object (later on for mocking purposes) ? - // If not, best is probably to keep this constructor as package-private with @VisibleForTesting - // but it's not a satisfying solution - public NewSetting(YamlConfiguration yamlConfiguration, String file) { + @VisibleForTesting + NewSetting(YamlConfiguration yamlConfiguration, String file) { this.configuration = yamlConfiguration; this.file = new File(file); } @@ -49,14 +45,16 @@ public class NewSetting { } public void save() { - PropertyMap properties = getAllPropertyFields(); + save(SettingsFieldRetriever.getAllPropertyFields()); + } + public void save(PropertyMap propertyMap) { try (FileWriter writer = new FileWriter(file)) { writer.write(""); // Contains all but the last node of the setting, e.g. [DataSource, mysql] for "DataSource.mysql.username" List currentPath = new ArrayList<>(); - for (Map.Entry entry : properties.entrySet()) { + for (Map.Entry, String[]> entry : propertyMap.entrySet()) { Property property = entry.getKey(); // Handle properties @@ -107,6 +105,15 @@ public class NewSetting { } } + private boolean containsAllSettings(PropertyMap propertyMap) { + for (Property property : propertyMap.keySet()) { + if (!property.isPresent(configuration)) { + return false; + } + } + return true; + } + private static String indent(int level) { // YAML uses indentation of 4 spaces StringBuilder sb = new StringBuilder(level * 4); @@ -116,40 +123,4 @@ public class NewSetting { return sb.toString(); } - private static PropertyMap getAllPropertyFields() { - PropertyMap properties = new PropertyMap(); - for (Class clazz : CONFIGURATION_CLASSES) { - Field[] declaredFields = clazz.getDeclaredFields(); - for (Field field : declaredFields) { - Property property = getFieldIfRelevant(field); - if (property != null) { - properties.put(property, getCommentsForField(field)); - } - } - } - return properties; - } - - private static String[] getCommentsForField(Field field) { - if (field.isAnnotationPresent(Comment.class)) { - return field.getAnnotation(Comment.class).value(); - } - return new String[0]; - } - - private static Property getFieldIfRelevant(Field field) { - field.setAccessible(true); - if (field.isAccessible() && Property.class.equals(field.getType()) && Modifier.isStatic(field.getModifiers())) { - try { - return (Property) field.get(null); - } catch (IllegalAccessException e) { - throw new IllegalStateException("Could not fetch field '" + field.getName() + "' from class '" - + field.getDeclaringClass().getSimpleName() + "': " + StringUtils.formatException(e)); - } - } - return null; - } - - - } diff --git a/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java b/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java new file mode 100644 index 000000000..9727ffac7 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java @@ -0,0 +1,67 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; +import fr.xephi.authme.settings.propertymap.PropertyMap; +import fr.xephi.authme.util.StringUtils; + +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.util.Arrays; +import java.util.List; + +/** + * Utility class responsible for the retrieval of all {@link Property} fields via reflections. + */ +final class SettingsFieldRetriever { + + /** The classes to scan for properties. */ + private static final List> CONFIGURATION_CLASSES = Arrays.asList( + ConverterSettings.class, DatabaseSettings.class, EmailSettings.class, HooksSettings.class, + ProtectionSettings.class, PurgeSettings.class, SecuritySettings.class); + + private SettingsFieldRetriever() { + } + + /** + * Scan all given classes for their properties and return the generated {@link PropertyMap}. + * + * @return PropertyMap containing all found properties and their associated comments + * @see #CONFIGURATION_CLASSES + */ + public static PropertyMap getAllPropertyFields() { + PropertyMap properties = new PropertyMap(); + for (Class clazz : CONFIGURATION_CLASSES) { + Field[] declaredFields = clazz.getDeclaredFields(); + for (Field field : declaredFields) { + Property property = getFieldIfRelevant(field); + if (property != null) { + properties.put(property, getCommentsForField(field)); + } + } + } + return properties; + } + + private static String[] getCommentsForField(Field field) { + if (field.isAnnotationPresent(Comment.class)) { + return field.getAnnotation(Comment.class).value(); + } + return new String[0]; + } + + private static Property getFieldIfRelevant(Field field) { + field.setAccessible(true); + if (field.isAccessible() && Property.class.equals(field.getType()) && Modifier.isStatic(field.getModifiers())) { + try { + return (Property) field.get(null); + } catch (IllegalAccessException e) { + throw new IllegalStateException("Could not fetch field '" + field.getName() + "' from class '" + + field.getDeclaringClass().getSimpleName() + "': " + StringUtils.formatException(e)); + } + } + return null; + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/domain/Property.java b/src/main/java/fr/xephi/authme/settings/domain/Property.java index 809f7a987..c0fd2bfe0 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/Property.java +++ b/src/main/java/fr/xephi/authme/settings/domain/Property.java @@ -74,6 +74,16 @@ public class Property { return type.asYaml(this, configuration); } + /** + * Return whether or not the given configuration file contains the property. + * + * @param configuration The configuration file to verify + * @return True if the property is present, false otherwise + */ + public boolean isPresent(YamlConfiguration configuration) { + return type.contains(this, configuration); + } + // ----- // Trivial getters // ----- diff --git a/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java index b243ef657..5338da7af 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java +++ b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java @@ -41,6 +41,17 @@ public abstract class PropertyType { return asYaml(getFromFile(property, configuration)); } + /** + * Return whether the property is present in the given configuration. + * + * @param property The property to search for + * @param configuration The configuration to verify + * @return True if the property is present, false otherwise + */ + public boolean contains(Property property, YamlConfiguration configuration) { + return configuration.contains(property.getPath()); + } + /** * Transform the given value to YAML. * @@ -49,10 +60,6 @@ public abstract class PropertyType { */ protected abstract List asYaml(T value); - protected boolean contains(Property property, YamlConfiguration configuration) { - return configuration.contains(property.getPath()); - } - /** * Boolean property. @@ -145,6 +152,11 @@ public abstract class PropertyType { } return resultLines; } + + @Override + public boolean contains(Property> property, YamlConfiguration configuration) { + return configuration.contains(property.getPath()) && configuration.isList(property.getPath()); + } } } diff --git a/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java b/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java index 934245a07..07cfc7144 100644 --- a/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java +++ b/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java @@ -14,7 +14,7 @@ import java.util.TreeMap; */ public class PropertyMap { - private Map propertyMap; + private Map, String[]> propertyMap; private PropertyMapComparator comparator; /** @@ -41,8 +41,17 @@ public class PropertyMap { * * @return The entry set */ - public Set> entrySet() { + public Set, String[]>> entrySet() { return propertyMap.entrySet(); } + /** + * Return the key set of the map, i.e. all property objects it holds. + * + * @return The key set + */ + public Set> keySet() { + return propertyMap.keySet(); + } + } diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java index 1dadf75e6..ab7e763db 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java @@ -30,7 +30,6 @@ public class NewSettingsWriteTest { } - private File getConfigFile() { URL url = getClass().getClassLoader().getResource(CONFIG_FILE); if (url == null) { diff --git a/src/test/java/fr/xephi/authme/settings/domain/PropertyTypeTest.java b/src/test/java/fr/xephi/authme/settings/domain/PropertyTypeTest.java new file mode 100644 index 000000000..6dce2ad3e --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/domain/PropertyTypeTest.java @@ -0,0 +1,182 @@ +package fr.xephi.authme.settings.domain; + +import org.bukkit.configuration.file.YamlConfiguration; +import org.junit.BeforeClass; +import org.junit.Test; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.stubbing.Answer; + +import java.util.Arrays; +import java.util.List; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.contains; +import static org.hamcrest.Matchers.equalTo; +import static org.mockito.Matchers.anyBoolean; +import static org.mockito.Matchers.anyDouble; +import static org.mockito.Matchers.anyInt; +import static org.mockito.Matchers.anyString; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +/** + * Test for {@link PropertyType} and the contained subtypes. + */ +public class PropertyTypeTest { + + private static YamlConfiguration configuration; + + @BeforeClass + public static void setUpYamlConfigurationMock() { + configuration = mock(YamlConfiguration.class); + + when(configuration.getBoolean(eq("bool.path.test"), anyBoolean())).thenReturn(true); + when(configuration.getBoolean(eq("bool.path.wrong"), anyBoolean())).thenAnswer(secondParameter()); + when(configuration.getDouble(eq("double.path.test"), anyDouble())).thenReturn(-6.4); + when(configuration.getDouble(eq("double.path.wrong"), anyDouble())).thenAnswer(secondParameter()); + when(configuration.getInt(eq("int.path.test"), anyInt())).thenReturn(27); + when(configuration.getInt(eq("int.path.wrong"), anyInt())).thenAnswer(secondParameter()); + when(configuration.getString(eq("str.path.test"), anyString())).thenReturn("Test value"); + when(configuration.getString(eq("str.path.wrong"), anyString())).thenAnswer(secondParameter()); + when(configuration.isList("list.path.test")).thenReturn(true); + when(configuration.getStringList("list.path.test")).thenReturn(Arrays.asList("test1", "Test2", "3rd test")); + when(configuration.isList("list.path.wrong")).thenReturn(false); + } + + /* Boolean */ + @Test + public void shouldGetBoolValue() { + // given + Property property = Property.newProperty("bool.path.test", false); + + // when + boolean result = property.getFromFile(configuration); + + // then + assertThat(result, equalTo(true)); + } + + @Test + public void shouldGetBoolDefault() { + // given + Property property = Property.newProperty("bool.path.wrong", true); + + // when + boolean result = property.getFromFile(configuration); + + // then + assertThat(result, equalTo(true)); + } + + /* Double */ + @Test + public void shouldGetDoubleValue() { + // given + Property property = Property.newProperty(PropertyType.DOUBLE, "double.path.test", 3.8); + + // when + double result = property.getFromFile(configuration); + + // then + assertThat(result, equalTo(-6.4)); + } + + @Test + public void shouldGetDoubleDefault() { + // given + Property property = Property.newProperty(PropertyType.DOUBLE, "double.path.wrong", 12.0); + + // when + double result = property.getFromFile(configuration); + + // then + assertThat(result, equalTo(12.0)); + } + + /* Integer */ + @Test + public void shouldGetIntValue() { + // given + Property property = Property.newProperty("int.path.test", 3); + + // when + int result = property.getFromFile(configuration); + + // then + assertThat(result, equalTo(27)); + } + + @Test + public void shouldGetIntDefault() { + // given + Property property = Property.newProperty("int.path.wrong", -10); + + // when + int result = property.getFromFile(configuration); + + // then + assertThat(result, equalTo(-10)); + } + + /* String */ + @Test + public void shouldGetStringValue() { + // given + Property property = Property.newProperty("str.path.test", "unused default"); + + // when + String result = property.getFromFile(configuration); + + // then + assertThat(result, equalTo("Test value")); + } + + @Test + public void shouldGetStringDefault() { + // given + Property property = Property.newProperty("str.path.wrong", "given default value"); + + // when + String result = property.getFromFile(configuration); + + // then + assertThat(result, equalTo("given default value")); + } + + /* String list */ + @Test + public void shouldGetStringListValue() { + // given + Property> property = Property.newProperty(PropertyType.STRING_LIST, "list.path.test", "1", "b"); + + // when + List result = property.getFromFile(configuration); + + // then + assertThat(result, contains("test1", "Test2", "3rd test")); + } + + @Test + public void shouldGetStringListDefault() { + // given + Property> property = + Property.newProperty(PropertyType.STRING_LIST, "list.path.wrong", "default", "list", "elements"); + + // when + List result = property.getFromFile(configuration); + + // then + assertThat(result, contains("default", "list", "elements")); + } + + private static Answer secondParameter() { + return new Answer() { + @Override + public T answer(InvocationOnMock invocation) throws Throwable { + // Return the second parameter -> the default + return (T) invocation.getArguments()[1]; + } + }; + } +} diff --git a/src/test/java/fr/xephi/authme/settings/propertymap/PropertyMapTest.java b/src/test/java/fr/xephi/authme/settings/propertymap/PropertyMapTest.java index 895b12e1c..40ea14b74 100644 --- a/src/test/java/fr/xephi/authme/settings/propertymap/PropertyMapTest.java +++ b/src/test/java/fr/xephi/authme/settings/propertymap/PropertyMapTest.java @@ -34,9 +34,9 @@ public class PropertyMapTest { } // then - Set> entrySet = map.entrySet(); + Set, String[]>> entrySet = map.entrySet(); List resultPaths = new ArrayList<>(entrySet.size()); - for (Map.Entry entry : entrySet) { + for (Map.Entry, String[]> entry : entrySet) { resultPaths.add(entry.getKey().getPath()); } From d0b7d0ff069be63834b432c61e637ee42ab17dda Mon Sep 17 00:00:00 2001 From: ljacqu Date: Fri, 8 Jan 2016 23:20:42 +0100 Subject: [PATCH 08/16] #347 Create consistency and integration tests for NewSetting - Ensure that the project's config.yml contains all settings that NewSetting is aware of - Add extensive, more generic integration tests --- .../authme/settings/custom/HooksSettings.java | 2 +- .../authme/settings/custom/NewSetting.java | 34 +++- .../authme/settings/custom/PurgeSettings.java | 2 +- src/main/resources/config.yml | 2 + .../custom/ConfigFileConsistencyTest.java | 35 ++++ .../custom/NewSettingIntegrationTest.java | 113 ++++++++++++ .../settings/custom/NewSettingTest.java | 122 +++++-------- .../settings/custom/NewSettingsWriteTest.java | 41 ----- .../settings/custom/TestConfiguration.java | 46 +++++ src/test/resources/437-config-test.yml | 44 ----- src/test/resources/437-write-test.yml | 172 ------------------ .../resources/config-incomplete-sample.yml | 27 +++ src/test/resources/config-sample-values.yml | 27 +++ 13 files changed, 329 insertions(+), 338 deletions(-) create mode 100644 src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java create mode 100644 src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java delete mode 100644 src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java create mode 100644 src/test/java/fr/xephi/authme/settings/custom/TestConfiguration.java delete mode 100644 src/test/resources/437-config-test.yml delete mode 100644 src/test/resources/437-write-test.yml create mode 100644 src/test/resources/config-incomplete-sample.yml create mode 100644 src/test/resources/config-sample-values.yml diff --git a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java index 6e23c7398..707821e05 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java @@ -19,7 +19,7 @@ public class HooksSettings implements SettingsClass { @Comment("Send player to this BungeeCord server after register/login") public static final Property BUNGEECORD_SERVER = - newProperty(PropertyType.STRING, "bungeecord.server", ""); + newProperty(PropertyType.STRING, "Hooks.sendPlayerTo", ""); @Comment("Do we need to disable Essentials SocialSpy on join?") public static final Property DISABLE_SOCIAL_SPY = diff --git a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java index 86a15b0d5..00aa9220e 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java +++ b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java @@ -24,6 +24,12 @@ public class NewSetting { private File file; private YamlConfiguration configuration; + /** + * Constructor. + * Loads the file as YAML and checks its integrity. + * + * @param file The configuration file + */ public NewSetting(File file) { this.configuration = YamlConfiguration.loadConfiguration(file); this.file = file; @@ -34,12 +40,33 @@ public class NewSetting { } } + /** + * Simple constructor for testing purposes. Does not check for all properties and + * never saves to the file. + * + * @param yamlConfiguration The YamlConfiguration object to use + * @param file The file to write to + * @param propertyMap The property map whose properties should be verified for presence, or null to skip this + */ @VisibleForTesting - NewSetting(YamlConfiguration yamlConfiguration, String file) { + NewSetting(YamlConfiguration yamlConfiguration, File file, PropertyMap propertyMap) { this.configuration = yamlConfiguration; - this.file = new File(file); + this.file = file; + + if (propertyMap != null) { + if (!containsAllSettings(propertyMap)) { + save(propertyMap); + } + } } + /** + * Get the given property from the configuration. + * + * @param property The property to retrieve + * @param The property's type + * @return The property's value + */ public T getOption(Property property) { return property.getFromFile(configuration); } @@ -105,7 +132,8 @@ public class NewSetting { } } - private boolean containsAllSettings(PropertyMap propertyMap) { + @VisibleForTesting + boolean containsAllSettings(PropertyMap propertyMap) { for (Property property : propertyMap.keySet()) { if (!property.isPresent(configuration)) { return false; diff --git a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java index e2e1c0290..cff4a7c98 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java @@ -25,7 +25,7 @@ public class PurgeSettings implements SettingsClass { @Comment("Do we need to remove the Essentials/users/player.yml file during purge process?") public static final Property REMOVE_ESSENTIALS_FILES = - newProperty(BOOLEAN, "Purge.removeEssentialsFiles", false); + newProperty(BOOLEAN, "Purge.removeEssentialsFile", false); @Comment("World where are players.dat stores") public static final Property DEFAULT_WORLD = diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index a98d97393..1e0b6491a 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -355,6 +355,8 @@ Email: emailWhitelisted: [] # Do we need to send new password draw in an image? generateImage: false + # The email OAuth 2 token (leave empty if not used) + emailOauth2Token: '' Hooks: # Do we need to hook with multiverse for spawn checking? multiverse: true diff --git a/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java b/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java new file mode 100644 index 000000000..b5bdc4df9 --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java @@ -0,0 +1,35 @@ +package fr.xephi.authme.settings.custom; + +import org.junit.Test; + +import java.io.File; +import java.io.IOException; +import java.net.URL; + +import static org.hamcrest.Matchers.equalTo; +import static org.junit.Assert.assertThat; +import static org.junit.Assume.assumeThat; + +/** + * Test for {@link NewSetting} and the project's config.yml, + * verifying that no settings are missing from the file. + */ +public class ConfigFileConsistencyTest { + + @Test + public void shouldHaveAllConfigs() throws IOException { + URL url = this.getClass().getResource("/config.yml"); + File configFile = new File(url.getFile()); + + // given + assumeThat(configFile.exists(), equalTo(true)); + NewSetting settings = new NewSetting(configFile); + + // when + boolean result = settings.containsAllSettings(SettingsFieldRetriever.getAllPropertyFields()); + + // then + assertThat(result, equalTo(true)); + } + +} diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java new file mode 100644 index 000000000..8e6801fe6 --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java @@ -0,0 +1,113 @@ +package fr.xephi.authme.settings.custom; + +import com.google.common.collect.ImmutableMap; +import fr.xephi.authme.ReflectionTestUtils; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.propertymap.PropertyMap; +import org.bukkit.configuration.file.YamlConfiguration; +import org.junit.BeforeClass; +import org.junit.Test; + +import java.io.File; +import java.lang.reflect.Field; +import java.net.URL; +import java.util.Arrays; +import java.util.Collections; +import java.util.Map; + +import static org.hamcrest.Matchers.equalTo; +import static org.junit.Assert.assertThat; +import static org.junit.Assume.assumeThat; + +/** + * Integration test for {@link NewSetting}. + */ +public class NewSettingIntegrationTest { + + /** File name of the sample config including all {@link TestConfiguration} values. */ + private static final String COMPLETE_FILE = "config-sample-values.yml"; + /** File name of the sample config missing certain {@link TestConfiguration} values. */ + private static final String INCOMPLETE_FILE = "config-incomplete-sample.yml"; + + private static PropertyMap propertyMap; + + @BeforeClass + public static void generatePropertyMap() { + propertyMap = new PropertyMap(); + for (Field field : TestConfiguration.class.getDeclaredFields()) { + Property property = + (Property) ReflectionTestUtils.getFieldValue(TestConfiguration.class, null, field.getName()); + String[] comments = new String[]{"Comment for '" + property.getPath() + "'"}; + propertyMap.put(property, comments); + } + } + + @Test + public void shouldLoadAndReadAllProperties() { + // given + YamlConfiguration configuration = YamlConfiguration.loadConfiguration(getConfigFile(COMPLETE_FILE)); + File file = new File("unused"); + assumeThat(file.exists(), equalTo(false)); + + // when / then + NewSetting settings = new NewSetting(configuration, file, propertyMap); + Map, Object> expectedValues = ImmutableMap., Object>builder() + .put(TestConfiguration.DURATION_IN_SECONDS, 22) + .put(TestConfiguration.SYSTEM_NAME, "Custom sys name") + .put(TestConfiguration.RATIO_LIMIT, -4.1) + .put(TestConfiguration.RATIO_FIELDS, Arrays.asList("Australia", "Burundi", "Colombia")) + .put(TestConfiguration.VERSION_NUMBER, 2492) + .put(TestConfiguration.SKIP_BORING_FEATURES, false) + .put(TestConfiguration.BORING_COLORS, Arrays.asList("beige", "gray")) + .put(TestConfiguration.DUST_LEVEL, 0.81) + .put(TestConfiguration.USE_COOL_FEATURES, true) + .put(TestConfiguration.COOL_OPTIONS, Arrays.asList("Dinosaurs", "Explosions", "Big trucks")) + .build(); + for (Map.Entry, Object> entry : expectedValues.entrySet()) { + assertThat("Property '" + entry.getKey().getPath() + "' has expected value", + settings.getOption(entry.getKey()), equalTo(entry.getValue())); + } + assertThat(file.exists(), equalTo(false)); + } + + @Test + public void shouldWriteMissingProperties() { + // given/when + File file = getConfigFile(INCOMPLETE_FILE); + YamlConfiguration configuration = YamlConfiguration.loadConfiguration(file); + assumeThat(configuration.contains(TestConfiguration.BORING_COLORS.getPath()), equalTo(false)); + // Expectation: File is rewritten to since it does not have all configurations + new NewSetting(configuration, file, propertyMap); + + // Load the settings again -> checks that what we wrote can be loaded again + configuration = YamlConfiguration.loadConfiguration(file); + + // then + NewSetting settings = new NewSetting(configuration, file, propertyMap); + Map, Object> expectedValues = ImmutableMap., Object>builder() + .put(TestConfiguration.DURATION_IN_SECONDS, 22) + .put(TestConfiguration.SYSTEM_NAME, "[TestDefaultValue]") + .put(TestConfiguration.RATIO_LIMIT, 3.0) + .put(TestConfiguration.RATIO_FIELDS, Arrays.asList("Australia", "Burundi", "Colombia")) + .put(TestConfiguration.VERSION_NUMBER, 32046) + .put(TestConfiguration.SKIP_BORING_FEATURES, false) + .put(TestConfiguration.BORING_COLORS, Collections.EMPTY_LIST) + .put(TestConfiguration.DUST_LEVEL, 0.2) + .put(TestConfiguration.USE_COOL_FEATURES, false) + .put(TestConfiguration.COOL_OPTIONS, Arrays.asList("Dinosaurs", "Explosions", "Big trucks")) + .build(); + for (Map.Entry, Object> entry : expectedValues.entrySet()) { + assertThat("Property '" + entry.getKey().getPath() + "' has expected value", + settings.getOption(entry.getKey()), equalTo(entry.getValue())); + } + } + + private File getConfigFile(String file) { + URL url = getClass().getClassLoader().getResource(file); + if (url == null) { + throw new IllegalStateException("File '" + file + "' could not be loaded"); + } + return new File(url.getFile()); + } + +} diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java index 419d5917c..080e1d0d0 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java @@ -1,114 +1,84 @@ package fr.xephi.authme.settings.custom; -import fr.xephi.authme.datasource.DataSource; import fr.xephi.authme.settings.domain.Property; -import fr.xephi.authme.settings.domain.PropertyType; import org.bukkit.configuration.file.YamlConfiguration; import org.junit.Test; import org.mockito.invocation.InvocationOnMock; import org.mockito.stubbing.Answer; import java.io.File; -import java.net.URL; -import java.util.List; -import static fr.xephi.authme.settings.domain.Property.newProperty; import static org.hamcrest.MatcherAssert.assertThat; -import static org.hamcrest.Matchers.contains; import static org.hamcrest.Matchers.equalTo; import static org.mockito.BDDMockito.given; import static org.mockito.Matchers.anyBoolean; +import static org.mockito.Matchers.anyDouble; import static org.mockito.Matchers.anyInt; import static org.mockito.Matchers.anyString; import static org.mockito.Matchers.eq; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; +/** + * Test for {@link NewSetting}. + */ public class NewSettingTest { - private static final String CONFIG_FILE = "437-config-test.yml"; - - @Test - public void shouldReturnIntegerFromFile() { - // given - YamlConfiguration file = mock(YamlConfiguration.class); - Property config = TestConfiguration.DURATION_IN_SECONDS; - given(file.getInt("test.duration", 4)).willReturn(18); - NewSetting settings = new NewSetting(file, "conf.txt"); - - // when - int retrieve = settings.getOption(config); - - // then - assertThat(retrieve, equalTo(18)); - } - @Test public void shouldLoadAllConfigs() { // given YamlConfiguration file = mock(YamlConfiguration.class); + given(file.getString(anyString(), anyString())).willAnswer(withDefaultArgument()); + given(file.getBoolean(anyString(), anyBoolean())).willAnswer(withDefaultArgument()); + given(file.getDouble(anyString(), anyDouble())).willAnswer(withDefaultArgument()); + given(file.getInt(anyString(), anyInt())).willAnswer(withDefaultArgument()); - given(file.getString(anyString(), anyString())).willAnswer(new Answer() { - @Override - public String answer(InvocationOnMock invocation) throws Throwable { - // Return the second parameter -> the default - return (String) invocation.getArguments()[1]; - } - }); + setReturnValue(file, TestConfiguration.VERSION_NUMBER, 20); + setReturnValue(file, TestConfiguration.SKIP_BORING_FEATURES, true); + setReturnValue(file, TestConfiguration.RATIO_LIMIT, 4.25); + setReturnValue(file, TestConfiguration.SYSTEM_NAME, "myTestSys"); - given(file.getInt(eq(EmailSettings.RECOVERY_PASSWORD_LENGTH.getPath()), anyInt())) - .willReturn(20); - given(file.getBoolean(eq(SecuritySettings.REMOVE_PASSWORD_FROM_CONSOLE.getPath()), anyBoolean())) - .willReturn(false); + // when / then + NewSetting settings = new NewSetting(file, new File("conf.txt"), null); - // when - NewSetting settings = new NewSetting(file, "conf.txt"); + assertThat(settings.getOption(TestConfiguration.VERSION_NUMBER), equalTo(20)); + assertThat(settings.getOption(TestConfiguration.SKIP_BORING_FEATURES), equalTo(true)); + assertThat(settings.getOption(TestConfiguration.RATIO_LIMIT), equalTo(4.25)); + assertThat(settings.getOption(TestConfiguration.SYSTEM_NAME), equalTo("myTestSys")); - // then - // Expect the value we told the YAML mock to return: - assertThat(settings.getOption(EmailSettings.RECOVERY_PASSWORD_LENGTH), equalTo(20)); - // Expect the default: - assertThat(settings.getOption(EmailSettings.SMTP_HOST), equalTo(EmailSettings.SMTP_HOST.getDefaultValue())); - // Expect the value we told the YAML mock to return: - assertThat(settings.getOption(SecuritySettings.REMOVE_PASSWORD_FROM_CONSOLE), equalTo(false)); + assertDefaultValue(TestConfiguration.DURATION_IN_SECONDS, settings); + assertDefaultValue(TestConfiguration.DUST_LEVEL, settings); + assertDefaultValue(TestConfiguration.COOL_OPTIONS, settings); } - @Test - public void executeIntegrationTest() { - // given - YamlConfiguration yamlFile = YamlConfiguration.loadConfiguration(getConfigFile()); - NewSetting settings = new NewSetting(yamlFile, "conf.txt"); - - // when - int result = settings.getOption(TestConfiguration.DURATION_IN_SECONDS); - String systemName = settings.getOption(TestConfiguration.SYSTEM_NAME); - String helpHeader = settings.getOption(newProperty("settings.helpHeader", "")); - List unsafePasswords = settings.getOption( - newProperty(PropertyType.STRING_LIST, "Security.unsafePasswords")); - DataSource.DataSourceType dataSourceType = settings.getOption(DatabaseSettings.BACKEND); - - // then - assertThat(result, equalTo(22)); - assertThat(systemName, equalTo(TestConfiguration.SYSTEM_NAME.getDefaultValue())); - assertThat(helpHeader, equalTo("AuthMeReloaded")); - assertThat(unsafePasswords, contains("123456", "qwerty", "54321")); - assertThat(dataSourceType, equalTo(DataSource.DataSourceType.MYSQL)); - } - - private File getConfigFile() { - URL url = getClass().getClassLoader().getResource(CONFIG_FILE); - if (url == null) { - throw new RuntimeException("File '" + CONFIG_FILE + "' could not be loaded"); + private static void setReturnValue(YamlConfiguration config, Property property, T value) { + if (value instanceof String) { + when(config.getString(eq(property.getPath()), anyString())).thenReturn((String) value); + } else if (value instanceof Integer) { + when(config.getInt(eq(property.getPath()), anyInt())).thenReturn((Integer) value); + } else if (value instanceof Boolean) { + when(config.getBoolean(eq(property.getPath()), anyBoolean())).thenReturn((Boolean) value); + } else if (value instanceof Double) { + when(config.getDouble(eq(property.getPath()), anyDouble())).thenReturn((Double) value); + } else { + throw new UnsupportedOperationException("Value has unsupported type '" + + (value == null ? "null" : value.getClass().getSimpleName()) + "'"); } - return new File(url.getFile()); } - private static class TestConfiguration { + private static void assertDefaultValue(Property property, NewSetting setting) { + assertThat(property.getPath() + " has default value", + setting.getOption(property).equals(property.getDefaultValue()), equalTo(true)); + } - public static final Property DURATION_IN_SECONDS = - newProperty("test.duration", 4); - - public static final Property SYSTEM_NAME = - newProperty("test.systemName", "[TestDefaultValue]"); + private static Answer withDefaultArgument() { + return new Answer() { + @Override + public T answer(InvocationOnMock invocation) throws Throwable { + // Return the second parameter -> the default + return (T) invocation.getArguments()[1]; + } + }; } } diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java deleted file mode 100644 index ab7e763db..000000000 --- a/src/test/java/fr/xephi/authme/settings/custom/NewSettingsWriteTest.java +++ /dev/null @@ -1,41 +0,0 @@ -package fr.xephi.authme.settings.custom; - -import org.junit.Test; - -import java.io.File; -import java.net.URL; - -import static org.junit.Assert.assertThat; -import static org.hamcrest.Matchers.equalTo; - -/** - * Test for the save() function of new settings - */ -public class NewSettingsWriteTest { - - private static final String CONFIG_FILE = "437-write-test.yml"; - - @Test - public void shouldWriteProperties() { - File file = getConfigFile(); - NewSetting setting = new NewSetting(file); - setting.save(); - - // assert that we can load the file again -- i.e. that it's valid YAML! - NewSetting newSetting = new NewSetting(file); - assertThat(newSetting.getOption(SecuritySettings.CAPTCHA_LENGTH), - equalTo(SecuritySettings.CAPTCHA_LENGTH.getDefaultValue())); - assertThat(newSetting.getOption(ProtectionSettings.COUNTRIES_BLACKLIST), - equalTo(ProtectionSettings.COUNTRIES_BLACKLIST.getDefaultValue())); - } - - - private File getConfigFile() { - URL url = getClass().getClassLoader().getResource(CONFIG_FILE); - if (url == null) { - throw new RuntimeException("File '" + CONFIG_FILE + "' could not be loaded"); - } - return new File(url.getFile()); - } - -} diff --git a/src/test/java/fr/xephi/authme/settings/custom/TestConfiguration.java b/src/test/java/fr/xephi/authme/settings/custom/TestConfiguration.java new file mode 100644 index 000000000..5f43262c7 --- /dev/null +++ b/src/test/java/fr/xephi/authme/settings/custom/TestConfiguration.java @@ -0,0 +1,46 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.PropertyType; +import fr.xephi.authme.settings.domain.SettingsClass; + +import java.util.List; + +import static fr.xephi.authme.settings.domain.Property.newProperty; + +/** + * Sample properties for testing purposes. + */ +class TestConfiguration implements SettingsClass { + + public static final Property DURATION_IN_SECONDS = + newProperty("test.duration", 4); + + public static final Property SYSTEM_NAME = + newProperty("test.systemName", "[TestDefaultValue]"); + + public static final Property RATIO_LIMIT = + newProperty(PropertyType.DOUBLE, "sample.ratio.limit", 3.0); + + public static final Property> RATIO_FIELDS = + newProperty(PropertyType.STRING_LIST, "sample.ratio.fields", "a", "b", "c"); + + public static final Property VERSION_NUMBER = + newProperty("version", 32046); + + public static final Property SKIP_BORING_FEATURES = + newProperty("features.boring.skip", false); + + public static final Property> BORING_COLORS = + newProperty(PropertyType.STRING_LIST, "features.boring.colors"); + + public static final Property DUST_LEVEL = + newProperty(PropertyType.DOUBLE, "features.boring.dustLevel", 0.2); + + public static final Property USE_COOL_FEATURES = + newProperty("features.cool.enabled", false); + + public static final Property> COOL_OPTIONS = + newProperty(PropertyType.STRING_LIST, "features.cool.options", "Sparks", "Sprinkles"); + +} diff --git a/src/test/resources/437-config-test.yml b/src/test/resources/437-config-test.yml deleted file mode 100644 index 5057bea92..000000000 --- a/src/test/resources/437-config-test.yml +++ /dev/null @@ -1,44 +0,0 @@ -test: - duration: 22 -DataSource: - # What type of database do you want to use? - # Valid values: sqlite, mysql - backend: mysql - # Enable database caching, should improve database performance - caching: true -settings: - # The name shown in the help messages. - helpHeader: AuthMeReloaded - GameMode: - # ForceSurvivalMode to player when join ? - ForceSurvivalMode: false -Security: - SQLProblem: - # Stop the server if we can't contact the sql database - # Take care with this, if you set that to false, - # AuthMe automatically disable and the server is not protected! - stopServer: true - ReloadCommand: - # /reload support - useReloadCommandSupport: true - console: - # Remove spam console - noConsoleSpam: false - # Replace passwords in the console when player type a command like /login - removePassword: true - captcha: - # Player need to put a captcha when he fails too lot the password - useCaptcha: false - # Max allowed tries before request a captcha - maxLoginTry: 5 - # Captcha length - captchaLength: 5 - unsafePasswords: - - '123456' - - 'qwerty' - - '54321' -Email: - # Email SMTP server host - mailSMTP: smtp.gmail.com - # Email SMTP server port - mailPort: 465 diff --git a/src/test/resources/437-write-test.yml b/src/test/resources/437-write-test.yml deleted file mode 100644 index de2b762f8..000000000 --- a/src/test/resources/437-write-test.yml +++ /dev/null @@ -1,172 +0,0 @@ - - -Converter: - Rakamak: - # Rakamak file name - fileName: 'users.rak' - # Rakamak use IP? - useIP: false - # Rakamak IP file name - ipFileName: 'UsersIp.rak' - CrazyLogin: - # CrazyLogin database file name - fileName: 'accounts.db' - -DataSource: - # What type of database do you want to use? - # Valid values: sqlite, mysql - backend: 'sqlite' - # Enable database caching, should improve database performance - caching: true - # Database host address - mySQLHost: '127.0.0.1' - # Database port - mySQLPort: '3306' - # Username about Database Connection Infos - mySQLUsername: 'authme' - # Password about Database Connection Infos - mySQLPassword: '123456' - # Database Name, use with converters or as SQLITE database name - mySQLDatabase: 'authme' - # Table of the database - mySQLTablename: 'authme' - # Column of IDs to sort data - mySQLColumnId: 'id' - # Column for storing or checking players nickname - mySQLColumnName: 'username' - # Column for storing or checking players RealName - mySQLRealName: 'realname' - # Column for storing players passwords - mySQLColumnPassword: 'password' - # Column for storing players emails - mySQLColumnEmail: 'email' - # Column for storing if a player is logged in or not - mySQLColumnLogged: 'email' - # Column for storing players ips - mySQLColumnIp: 'ip' - # Column for storing players lastlogins - mySQLColumnLastLogin: 'lastlogin' - # Column for storing player LastLocation - X - mySQLlastlocX: 'x' - # Column for storing player LastLocation - Y - mySQLlastlocY: 'y' - # Column for storing player LastLocation - Z - mySQLlastlocZ: 'z' - # Column for storing player LastLocation - World Name - mySQLlastlocWorld: 'world' - # Enable this when you allow registration through a website - mySQLWebsite: false - -ExternalBoardOptions: - # Column for storing players passwords salts - mySQLColumnSalt: '' - # Column for storing players groups - mySQLColumnGroup: '' - -Email: - # Email SMTP server host - mailSMTP: 'smtp.gmail.com' - # Email SMTP server port - mailPort: 465 - # Email account which sends the mails - mailAccount: '' - # Email account password - mailPassword: '' - # Recovery password length - RecoveryPasswordLength: 8 - # Mail Subject - mailSubject: 'Your new AuthMe password' - # Like maxRegPerIP but with email - maxRegPerEmail: 1 - # Recall players to add an email? - recallPlayers: false - # Delay in minute for the recall scheduler - delayRecall: 5 - # Blacklist these domains for emails - emailBlacklisted: - - '10minutemail.com' - # Whitelist ONLY these domains for emails - emailWhitelisted: [] - # Send the new password drawn in an image? - generateImage: false - # The OAuth2 token - emailOauth2Token: '' - -Hooks: - # Do we need to hook with multiverse for spawn checking? - multiverse: true - # Do we need to hook with BungeeCord? - bungeecord: false - # Do we need to disable Essentials SocialSpy on join? - disableSocialSpy: false - # Do we need to force /motd Essentials command on join? - useEssentialsMotd: false - # Do we need to cache custom Attributes? - customAttributes: false - -bungeecord: - # Send player to this BungeeCord server after register/login - server: '' - -Protection: - # Enable some servers protection (country based login, antibot) - enableProtection: false - # Countries allowed to join the server and register, see http://dev.bukkit.org/bukkit-plugins/authme-reloaded/pages/countries-codes/ for countries' codes - # PLEASE USE QUOTES! - countries: - - 'US' - - 'GB' - - 'A1' - # Countries not allowed to join the server and register - # PLEASE USE QUOTES! - countriesBlacklist: [] - # Do we need to enable automatic antibot system? - enableAntiBot: false - # Max number of player allowed to login in 5 secs before enable AntiBot system automatically - antiBotSensibility: 5 - # Duration in minutes of the antibot automatic system - antiBotDuration: 10 - -Purge: - # If enabled, AuthMe automatically purges old, unused accounts - useAutoPurge: false - # Number of Days an account become Unused - daysBeforeRemovePlayer: 60 - # Do we need to remove the player.dat file during purge process? - removePlayerDat: false - # Do we need to remove the Essentials/users/player.yml file during purge process? - removeEssentialsFiles: false - # World where are players.dat stores - defaultWorld: 'world' - # Do we need to remove LimitedCreative/inventories/player.yml, player_creative.yml files during purge process ? - removeLimitedCreativesInventories: false - # Do we need to remove the AntiXRayData/PlayerData/player file during purge process? - removeAntiXRayFile: false - # Do we need to remove permissions? - removePermissions: false - -Security: - SQLProblem: - # Stop the server if we can't contact the sql database - # Take care with this, if you set this to false, - # AuthMe will automatically disable and the server won't be protected! - stopServer: true - ReloadCommand: - # /reload support - useReloadCommandSupport: true - console: - # Remove spam from console? - noConsoleSpam: false - # Remove passwords from console? - removePassword: true - captcha: - # Player need to put a captcha when he fails too lot the password - useCaptcha: false - # Max allowed tries before request a captcha - maxLoginTry: 5 - # Captcha length - captchaLength: 5 - stop: - # Kick players before stopping the server, that allow us to save position of players - # and all needed information correctly without any corruption. - kickPlayersBeforeStopping: true diff --git a/src/test/resources/config-incomplete-sample.yml b/src/test/resources/config-incomplete-sample.yml new file mode 100644 index 000000000..a29879720 --- /dev/null +++ b/src/test/resources/config-incomplete-sample.yml @@ -0,0 +1,27 @@ +# Test config file with missing options from TestConfiguration +# Notice the commented out lines! + +test: + duration: 22 +# systemName: 'Custom sys name' +sample: + ratio: +# limit: 3.0 + fields: + - 'Australia' + - 'Burundi' + - 'Colombia' +#version: 2492 +features: +# boring: +# skip: false +# colors: +# - 'beige' +# - 'gray' +# dustLevel: 0.81 + cool: +# enabled: true + options: + - 'Dinosaurs' + - 'Explosions' + - 'Big trucks' diff --git a/src/test/resources/config-sample-values.yml b/src/test/resources/config-sample-values.yml new file mode 100644 index 000000000..1bd99d771 --- /dev/null +++ b/src/test/resources/config-sample-values.yml @@ -0,0 +1,27 @@ +# Test config file with all options +# defined in the TestConfiguration class + +test: + duration: 22 + systemName: 'Custom sys name' +sample: + ratio: + limit: -4.1 + fields: + - 'Australia' + - 'Burundi' + - 'Colombia' +version: 2492 +features: + boring: + skip: false + colors: + - 'beige' + - 'gray' + dustLevel: 0.81 + cool: + enabled: true + options: + - 'Dinosaurs' + - 'Explosions' + - 'Big trucks' From 752ebe5022f3df880042c07f56e5ee34a1016eb7 Mon Sep 17 00:00:00 2001 From: ljacqu Date: Fri, 8 Jan 2016 23:40:54 +0100 Subject: [PATCH 09/16] Fix cast exception in integration test - Although the class only has fields of Property type it would appear that CircleCI et al. may use libraries that add fields to classes later on, so we need to check for the field type --- .../settings/custom/NewSettingIntegrationTest.java | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java index 8e6801fe6..dcb3c6833 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java @@ -35,10 +35,12 @@ public class NewSettingIntegrationTest { public static void generatePropertyMap() { propertyMap = new PropertyMap(); for (Field field : TestConfiguration.class.getDeclaredFields()) { - Property property = - (Property) ReflectionTestUtils.getFieldValue(TestConfiguration.class, null, field.getName()); - String[] comments = new String[]{"Comment for '" + property.getPath() + "'"}; - propertyMap.put(property, comments); + Object fieldValue = ReflectionTestUtils.getFieldValue(TestConfiguration.class, null, field.getName()); + if (fieldValue instanceof Property) { + Property property = (Property) fieldValue; + String[] comments = new String[]{"Comment for '" + property.getPath() + "'"}; + propertyMap.put(property, comments); + } } } From 88629702f508ed2c97d81aae575c95d89cb7edfe Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sat, 9 Jan 2016 09:30:49 +0100 Subject: [PATCH 10/16] #347 Test that all read properties exist as Property field - Create consistency test to verify that all properties in config.yml are defined as a Property field in a SettingsClass implementation (currently fails) - Add some missing properties - Minor: convert tabs to spaces --- .../settings/custom/ConverterSettings.java | 12 +- .../settings/custom/DatabaseSettings.java | 54 +++---- .../authme/settings/custom/EmailSettings.java | 34 ++-- .../authme/settings/custom/HooksSettings.java | 12 +- .../settings/custom/PluginSettings.java | 46 ++++++ .../settings/custom/ProtectionSettings.java | 16 +- .../authme/settings/custom/PurgeSettings.java | 18 +-- .../settings/custom/RestrictionSettings.java | 147 ++++++++++++++++++ .../settings/custom/SecuritySettings.java | 16 +- .../custom/SettingsFieldRetriever.java | 5 +- .../settings/propertymap/PropertyMap.java | 19 ++- src/main/resources/config.yml | 2 - .../custom/ConfigFileConsistencyTest.java | 57 ++++++- .../custom/SettingsClassConsistencyTest.java | 2 +- 14 files changed, 345 insertions(+), 95 deletions(-) create mode 100644 src/main/java/fr/xephi/authme/settings/custom/PluginSettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java diff --git a/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java b/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java index f208727b7..f32cf7483 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/ConverterSettings.java @@ -10,19 +10,19 @@ import static fr.xephi.authme.settings.domain.PropertyType.STRING; public class ConverterSettings implements SettingsClass { - @Comment("Rakamak file name") - public static final Property RAKAMAK_FILE_NAME = + @Comment("Rakamak file name") + public static final Property RAKAMAK_FILE_NAME = newProperty(STRING, "Converter.Rakamak.fileName", "users.rak"); - @Comment("Rakamak use IP?") - public static final Property RAKAMAK_USE_IP = + @Comment("Rakamak use IP?") + public static final Property RAKAMAK_USE_IP = newProperty(BOOLEAN, "Converter.Rakamak.useIP", false); - @Comment("Rakamak IP file name") + @Comment("Rakamak IP file name") public static final Property RAKAMAK_IP_FILE_NAME = newProperty(STRING, "Converter.Rakamak.ipFileName", "UsersIp.rak"); - @Comment("CrazyLogin database file name") + @Comment("CrazyLogin database file name") public static final Property CRAZYLOGIN_FILE_NAME = newProperty(STRING, "Converter.CrazyLogin.fileName", "accounts.db"); diff --git a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java index d638fd8f0..582e5d6eb 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java @@ -11,100 +11,100 @@ import static fr.xephi.authme.settings.domain.PropertyType.STRING; public class DatabaseSettings implements SettingsClass { - @Comment({"What type of database do you want to use?", - "Valid values: sqlite, mysql"}) + @Comment({"What type of database do you want to use?", + "Valid values: sqlite, mysql"}) public static final Property BACKEND = newProperty(DataSource.DataSourceType.class, "DataSource.backend", DataSource.DataSourceType.SQLITE); - @Comment("Enable database caching, should improve database performance") + @Comment("Enable database caching, should improve database performance") public static final Property USE_CACHING = newProperty(BOOLEAN, "DataSource.caching", true); - @Comment("Database host address") + @Comment("Database host address") public static final Property MYSQL_HOST = newProperty(STRING, "DataSource.mySQLHost", "127.0.0.1"); - @Comment("Database port") + @Comment("Database port") public static final Property MYSQL_PORT = newProperty(STRING, "DataSource.mySQLPort", "3306"); - @Comment("Username about Database Connection Infos") + @Comment("Username about Database Connection Infos") public static final Property MYSQL_USERNAME = newProperty(STRING, "DataSource.mySQLUsername", "authme"); - @Comment("Password about Database Connection Infos") + @Comment("Password about Database Connection Infos") public static final Property MYSQL_PASSWORD = newProperty(STRING, "DataSource.mySQLPassword", "123456"); - @Comment("Database Name, use with converters or as SQLITE database name") + @Comment("Database Name, use with converters or as SQLITE database name") public static final Property MYSQL_DATABASE = newProperty(STRING, "DataSource.mySQLDatabase", "authme"); - @Comment("Table of the database") + @Comment("Table of the database") public static final Property MYSQL_TABLE = newProperty(STRING, "DataSource.mySQLTablename", "authme"); - @Comment("Column of IDs to sort data") + @Comment("Column of IDs to sort data") public static final Property MYSQL_COL_ID = newProperty(STRING, "DataSource.mySQLColumnId", "id"); - @Comment("Column for storing or checking players nickname") + @Comment("Column for storing or checking players nickname") public static final Property MYSQL_COL_NAME = newProperty(STRING, "DataSource.mySQLColumnName", "username"); - @Comment("Column for storing or checking players RealName ") + @Comment("Column for storing or checking players RealName ") public static final Property MYSQL_COL_REALNAME = newProperty(STRING, "DataSource.mySQLRealName", "realname"); - @Comment("Column for storing players passwords") + @Comment("Column for storing players passwords") public static final Property MYSQL_COL_PASSWORD = newProperty(STRING, "DataSource.mySQLColumnPassword", "password"); - @Comment("Column for storing players passwords salts") + @Comment("Column for storing players passwords salts") public static final Property MYSQL_COL_SALT = newProperty(STRING, "ExternalBoardOptions.mySQLColumnSalt", ""); - @Comment("Column for storing players emails") + @Comment("Column for storing players emails") public static final Property MYSQL_COL_EMAIL = newProperty(STRING, "DataSource.mySQLColumnEmail", "email"); - @Comment("Column for storing if a player is logged in or not") + @Comment("Column for storing if a player is logged in or not") public static final Property MYSQL_COL_ISLOGGED = newProperty(STRING, "DataSource.mySQLColumnLogged", "isLogged"); - @Comment("Column for storing players ips") + @Comment("Column for storing players ips") public static final Property MYSQL_COL_IP = newProperty(STRING, "DataSource.mySQLColumnIp", "ip"); - @Comment("Column for storing players lastlogins") + @Comment("Column for storing players lastlogins") public static final Property MYSQL_COL_LASTLOGIN = newProperty(STRING, "DataSource.mySQLColumnLastLogin", "lastlogin"); - @Comment("Column for storing player LastLocation - X") + @Comment("Column for storing player LastLocation - X") public static final Property MYSQL_COL_LASTLOC_X = newProperty(STRING, "DataSource.mySQLlastlocX", "x"); - @Comment("Column for storing player LastLocation - Y") + @Comment("Column for storing player LastLocation - Y") public static final Property MYSQL_COL_LASTLOC_Y = newProperty(STRING, "DataSource.mySQLlastlocY", "y"); - @Comment("Column for storing player LastLocation - Z") + @Comment("Column for storing player LastLocation - Z") public static final Property MYSQL_COL_LASTLOC_Z = newProperty(STRING, "DataSource.mySQLlastlocZ", "z"); - @Comment("Column for storing player LastLocation - World Name") + @Comment("Column for storing player LastLocation - World Name") public static final Property MYSQL_COL_LASTLOC_WORLD = newProperty(STRING, "DataSource.mySQLlastlocWorld", "world"); - @Comment("Column for storing players groups") + @Comment("Column for storing players groups") public static final Property MYSQL_COL_GROUP = newProperty(STRING, "ExternalBoardOptions.mySQLColumnGroup", ""); - @Comment("Enable this when you allow registration through a website") - public static final Property MYSQL_WEBSITE = + @Comment("Enable this when you allow registration through a website") + public static final Property MYSQL_WEBSITE = newProperty(BOOLEAN, "DataSource.mySQLWebsite", false); - private DatabaseSettings() { - } + private DatabaseSettings() { + } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java b/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java index dcde50191..683143652 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/EmailSettings.java @@ -14,51 +14,55 @@ import static fr.xephi.authme.settings.domain.PropertyType.STRING_LIST; public class EmailSettings implements SettingsClass { - @Comment("Email SMTP server host") - public static final Property SMTP_HOST = + @Comment("Email SMTP server host") + public static final Property SMTP_HOST = newProperty(STRING, "Email.mailSMTP", "smtp.gmail.com"); - @Comment("Email SMTP server port") + @Comment("Email SMTP server port") public static final Property SMTP_PORT = newProperty(INTEGER, "Email.mailPort", 465); - @Comment("Email account which sends the mails") + @Comment("Email account which sends the mails") public static final Property MAIL_ACCOUNT = newProperty(STRING, "Email.mailAccount", ""); - @Comment("Email account password") + @Comment("Email account password") public static final Property MAIL_PASSWORD = newProperty(STRING, "Email.mailPassword", ""); - @Comment("Recovery password length") + @Comment("Custom sender name, replacing the mailAccount name in the email") + public static final Property MAIL_SENDER_NAME = + newProperty("Email.mailSenderName", ""); + + @Comment("Recovery password length") public static final Property RECOVERY_PASSWORD_LENGTH = newProperty(INTEGER, "Email.RecoveryPasswordLength", 8); - @Comment("Mail Subject") + @Comment("Mail Subject") public static final Property RECOVERY_MAIL_SUBJECT = newProperty(STRING, "Email.mailSubject", "Your new AuthMe password"); - @Comment("Like maxRegPerIP but with email") + @Comment("Like maxRegPerIP but with email") public static final Property MAX_REG_PER_EMAIL = newProperty(INTEGER, "Email.maxRegPerEmail", 1); - @Comment("Recall players to add an email?") + @Comment("Recall players to add an email?") public static final Property RECALL_PLAYERS = newProperty(BOOLEAN, "Email.recallPlayers", false); - @Comment("Delay in minute for the recall scheduler") + @Comment("Delay in minute for the recall scheduler") public static final Property DELAY_RECALL = newProperty(INTEGER, "Email.delayRecall", 5); - @Comment("Blacklist these domains for emails") - public static final Property> DOMAIN_BLACKLIST = + @Comment("Blacklist these domains for emails") + public static final Property> DOMAIN_BLACKLIST = newProperty(STRING_LIST, "Email.emailBlacklisted", "10minutemail.com"); - @Comment("Whitelist ONLY these domains for emails") - public static final Property> DOMAIN_WHITELIST = + @Comment("Whitelist ONLY these domains for emails") + public static final Property> DOMAIN_WHITELIST = newProperty(STRING_LIST, "Email.emailWhitelisted"); - @Comment("Send the new password drawn in an image?") + @Comment("Send the new password drawn in an image?") public static final Property PASSWORD_AS_IMAGE = newProperty(BOOLEAN, "Email.generateImage", false); diff --git a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java index 707821e05..d838c33ad 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java @@ -9,27 +9,27 @@ import static fr.xephi.authme.settings.domain.Property.newProperty; public class HooksSettings implements SettingsClass { - @Comment("Do we need to hook with multiverse for spawn checking?") + @Comment("Do we need to hook with multiverse for spawn checking?") public static final Property MULTIVERSE = newProperty(PropertyType.BOOLEAN, "Hooks.multiverse", true); - @Comment("Do we need to hook with BungeeCord?") + @Comment("Do we need to hook with BungeeCord?") public static final Property BUNGEECORD = newProperty(PropertyType.BOOLEAN, "Hooks.bungeecord", false); - @Comment("Send player to this BungeeCord server after register/login") + @Comment("Send player to this BungeeCord server after register/login") public static final Property BUNGEECORD_SERVER = newProperty(PropertyType.STRING, "Hooks.sendPlayerTo", ""); - @Comment("Do we need to disable Essentials SocialSpy on join?") + @Comment("Do we need to disable Essentials SocialSpy on join?") public static final Property DISABLE_SOCIAL_SPY = newProperty(PropertyType.BOOLEAN, "Hooks.disableSocialSpy", false); - @Comment("Do we need to force /motd Essentials command on join?") + @Comment("Do we need to force /motd Essentials command on join?") public static final Property USE_ESSENTIALS_MOTD = newProperty(PropertyType.BOOLEAN, "Hooks.useEssentialsMotd", false); - @Comment("Do we need to cache custom Attributes?") + @Comment("Do we need to cache custom Attributes?") public static final Property CACHE_CUSTOM_ATTRIBUTES = newProperty(PropertyType.BOOLEAN, "Hooks.customAttributes", false); diff --git a/src/main/java/fr/xephi/authme/settings/custom/PluginSettings.java b/src/main/java/fr/xephi/authme/settings/custom/PluginSettings.java new file mode 100644 index 000000000..9778d04e4 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/PluginSettings.java @@ -0,0 +1,46 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; + +import static fr.xephi.authme.settings.domain.Property.newProperty; + +public class PluginSettings implements SettingsClass { + + @Comment("The name shown in the help messages") + public static final Property HELP_HEADER = + newProperty("settings.helpHeader", "AuthMeReloaded"); + + @Comment({ + "Do you want to enable the session feature?", + "If enabled, when a player authenticates successfully,", + "his IP and his nickname is saved.", + "The next time the player joins the server, if his IP", + "is the same as last time and the timeout hasn't", + "expired, he will not need to authenticate." + }) + public static final Property SESSIONS_ENABLED = + newProperty("settings.sessions.enabled", false); + + @Comment({ + "After how many minutes should a session expire?", + "0 for unlimited time (Very dangerous, use it at your own risk!)", + "Remember that sessions will end only after the timeout, and", + "if the player's IP has changed but the timeout hasn't expired,", + "the player will be kicked from the server due to invalid session" + }) + public static final Property SESSIONS_TIMEOUT = + newProperty("settings.sessions.timeout", 10); + + @Comment({ + "Should the session expire if the player tries to log in with", + "another IP address?" + }) + public static final Property SESSIONS_EXPIRE_ON_IP_CHANGE = + newProperty("settings.sessions.sessionExpireOnIpChange", true); + + private PluginSettings() { + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java b/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java index b71a9589b..2582c277f 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/ProtectionSettings.java @@ -14,29 +14,29 @@ import static fr.xephi.authme.settings.domain.PropertyType.STRING_LIST; public class ProtectionSettings implements SettingsClass { - @Comment("Enable some servers protection (country based login, antibot)") + @Comment("Enable some servers protection (country based login, antibot)") public static final Property ENABLE_PROTECTION = newProperty(BOOLEAN, "Protection.enableProtection", false); - @Comment({"Countries allowed to join the server and register, see http://dev.bukkit.org/bukkit-plugins/authme-reloaded/pages/countries-codes/ for countries' codes", - "PLEASE USE QUOTES!"}) + @Comment({"Countries allowed to join the server and register, see http://dev.bukkit.org/bukkit-plugins/authme-reloaded/pages/countries-codes/ for countries' codes", + "PLEASE USE QUOTES!"}) public static final Property> COUNTRIES_WHITELIST = newProperty(STRING_LIST, "Protection.countries", "US", "GB", "A1"); - @Comment({"Countries not allowed to join the server and register", - "PLEASE USE QUOTES!"}) + @Comment({"Countries not allowed to join the server and register", + "PLEASE USE QUOTES!"}) public static final Property> COUNTRIES_BLACKLIST = newProperty(STRING_LIST, "Protection.countriesBlacklist"); - @Comment("Do we need to enable automatic antibot system?") + @Comment("Do we need to enable automatic antibot system?") public static final Property ENABLE_ANTIBOT = newProperty(BOOLEAN, "Protection.enableAntiBot", false); - @Comment("Max number of player allowed to login in 5 secs before enable AntiBot system automatically") + @Comment("Max number of player allowed to login in 5 secs before enable AntiBot system automatically") public static final Property ANTIBOT_SENSIBILITY = newProperty(INTEGER, "Protection.antiBotSensibility", 5); - @Comment("Duration in minutes of the antibot automatic system") + @Comment("Duration in minutes of the antibot automatic system") public static final Property ANTIBOT_DURATION = newProperty(INTEGER, "Protection.antiBotDuration", 10); diff --git a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java index cff4a7c98..5fcc139d7 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/PurgeSettings.java @@ -11,35 +11,35 @@ import static fr.xephi.authme.settings.domain.PropertyType.STRING; public class PurgeSettings implements SettingsClass { - @Comment("If enabled, AuthMe automatically purges old, unused accounts") - public static final Property USE_AUTO_PURGE = + @Comment("If enabled, AuthMe automatically purges old, unused accounts") + public static final Property USE_AUTO_PURGE = newProperty(BOOLEAN, "Purge.useAutoPurge", false); - @Comment("Number of Days an account become Unused") + @Comment("Number of Days an account become Unused") public static final Property DAYS_BEFORE_REMOVE_PLAYER = newProperty(INTEGER, "Purge.daysBeforeRemovePlayer", 60); - @Comment("Do we need to remove the player.dat file during purge process?") + @Comment("Do we need to remove the player.dat file during purge process?") public static final Property REMOVE_PLAYER_DAT = newProperty(BOOLEAN, "Purge.removePlayerDat", false); - @Comment("Do we need to remove the Essentials/users/player.yml file during purge process?") + @Comment("Do we need to remove the Essentials/users/player.yml file during purge process?") public static final Property REMOVE_ESSENTIALS_FILES = newProperty(BOOLEAN, "Purge.removeEssentialsFile", false); - @Comment("World where are players.dat stores") + @Comment("World where are players.dat stores") public static final Property DEFAULT_WORLD = newProperty(STRING, "Purge.defaultWorld", "world"); - @Comment("Do we need to remove LimitedCreative/inventories/player.yml, player_creative.yml files during purge process ?") + @Comment("Do we need to remove LimitedCreative/inventories/player.yml, player_creative.yml files during purge process ?") public static final Property REMOVE_LIMITED_CREATIVE_INVENTORIES = newProperty(BOOLEAN, "Purge.removeLimitedCreativesInventories", false); - @Comment("Do we need to remove the AntiXRayData/PlayerData/player file during purge process?") + @Comment("Do we need to remove the AntiXRayData/PlayerData/player file during purge process?") public static final Property REMOVE_ANTI_XRAY_FILE = newProperty(BOOLEAN, "Purge.removeAntiXRayFile", false); - @Comment("Do we need to remove permissions?") + @Comment("Do we need to remove permissions?") public static final Property REMOVE_PERMISSIONS = newProperty(BOOLEAN, "Purge.removePermissions", false); diff --git a/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java b/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java new file mode 100644 index 000000000..f5fa9c061 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java @@ -0,0 +1,147 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.PropertyType; +import fr.xephi.authme.settings.domain.SettingsClass; + +import java.util.List; + +import static fr.xephi.authme.settings.domain.Property.newProperty; + +public class RestrictionSettings implements SettingsClass { + + @Comment({ + "Can not authenticated players chat and see the chat log?", + "Keep in mind that this feature also blocks all commands not", + "listed in the list below."}) + public static final Property ALLOW_CHAT = + newProperty("settings.restrictions.allowChat", false); + + @Comment("Allowed commands for unauthenticated players") + public static final Property> ALLOW_COMMANDS = + newProperty(PropertyType.STRING_LIST, "settings.restrictions.allowCommands", + "login", "register", "l", "reg", "email", "captcha"); + + @Comment("Max number of allowed registrations per IP") + // TODO ljacqu 20160109: If 0 == unlimited, add this fact ot the comment + public static final Property MAX_REGISTRATION_PER_IP = + newProperty("settings.restrictions.maxRegPerIp", 1); + + @Comment("Minimum allowed username length") + public static final Property MIN_NICKNAME_LENGTH = + newProperty("settings.restrictions.minNicknameLength", 4); + + @Comment("Maximum allowed username length") + public static final Property MAX_NICKNAME_LENGTH = + newProperty("settings.restrictions.maxNicknameLength", 16); + + @Comment({ + "When this setting is enabled, online players can't be kicked out", + "due to \"Logged in from another Location\"", + "This setting will prevent potential security exploits."}) + public static final Property FORCE_SINGLE_SESSION = + newProperty("settings.restrictions.ForceSingleSession", true); + + @Comment({ + "If enabled, every player will be teleported to the world spawnpoint", + "after successful authentication.", + "The quit location of the player will be overwritten.", + "This is different from \"teleportUnAuthedToSpawn\" that teleport player", + "back to his quit location after the authentication."}) + public static final Property FORCE_SPAWN_LOCATION_AFTER_LOGIN = + newProperty("settings.restrictions.ForceSpawnLocOnJoinEnabled", false); + + @Comment("This option will save the quit location of the players.") + public static final Property SAVE_QUIT_LOCATION = + newProperty("settings.restrictions.SaveQuitLocation", false); + + @Comment({ + "To activate the restricted user feature you need", + "to enable this option and configure the AllowedRestrctedUser field."}) + public static final Property ENABLE_RESTRICTED_USERS = + newProperty("settings.restrictions.AllowRestrictedUser", false); + + @Comment({ + "The restricted user feature will kick players listed below", + "if they don't match the defined IP address.", + "Example:", + " AllowedRestrictedUser:", + " - playername;127.0.0.1"}) + public static final Property> ALLOWED_RESTRICTED_USERS = + newProperty(PropertyType.STRING_LIST, "settings.restrictions.AllowedRestrictedUser"); + + @Comment("Should unregistered players be kicked immediately?") + public static final Property KICK_NON_REGISTERED = + newProperty("settings.restrictions.kickNonRegistered", false); + + @Comment("Should players be kicked on wrong password?") + public static final Property KICK_ON_WRONG_PASSWORD = + newProperty("settings.restrictions.kickOnWrongPassword", false); + + @Comment({ + "Should not logged in players be teleported to the spawn?", + "After the authentication they will be teleported back to", + "their normal position."}) + public static final Property TELEPORT_UNAUTHED_TO_SPAWN = + newProperty("settings.restrictions.teleportUnAuthedToSpawn", false); + + @Comment("Can unregistered players walk around?") + public static final Property ALLOW_UNAUTHED_MOVEMENT = + newProperty("settings.restrictions.allowMovement", false); + + @Comment({ + "Should not authenticated players have speed = 0?", + "This will reset the fly/walk speed to default value after the login."}) + public static final Property REMOVE_SPEED = + newProperty("settings.restrictions.removeSpeed", true); + + @Comment({ + "After how many seconds should players who fail to login or register", + "be kicked? Set to 0 to disable."}) + public static final Property TIMEOUT = + newProperty("settings.restrictions.timeout", 30); + + @Comment("Regex syntax of allowed characters in the player name.") + public static final Property ALLOWED_NICKNAME_CHARACTERS = + newProperty("settings.restrictions.allowedNicknameCharacters", "[a-zA-Z0-9_]*"); + + @Comment({ + "How far can unregistered players walk?", + "Set to 0 for unlimited radius" + }) + public static final Property ALLOWED_MOVEMENT_RADIUS = + newProperty("settings.restrictions.allowedMovementRadius", 100); + + @Comment({ + "Enable double check of password when you register", + "when it's true, registration requires that kind of command:", + "/register "}) + public static final Property ENABLE_PASSWORD_CONFIRMATION = + newProperty("settings.restrictions.enablePasswordConfirmation", true); + + @Comment("Should we protect the player inventory before logging in?") + public static final Property PROTECT_INVENTORY_BEFORE_LOGIN = + newProperty("settings.restrictions.ProtectInventoryBeforeLogIn", true); + + @Comment({ + "Should we display all other accounts from a player when he joins?", + "permission: /authme.admin.accounts"}) + public static final Property DISPLAY_OTHER_ACCOUNTS = + newProperty("settings.restrictions.displayOtherAccounts", true); + + @Comment({ + "WorldNames where we need to force the spawn location for ForceSpawnLocOnJoinEnabled", + "Case-sensitive!"}) + public static final Property> FORCE_SPAWN_ON_WORLDS = + newProperty(PropertyType.STRING_LIST, "settings.restrictions.ForceSpawnOnTheseWorlds", + "world", "world_nether", "world_the_end"); + + @Comment("Ban ip when the ip is not the ip registered in database") + public static final Property BAN_UNKNOWN_IP = + newProperty("settings.restrictions.banUnsafedIP", false); + + private RestrictionSettings() { + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java index c18e7e7ca..1605c166f 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java @@ -10,33 +10,33 @@ import static fr.xephi.authme.settings.domain.PropertyType.INTEGER; public class SecuritySettings implements SettingsClass { - @Comment({"Stop the server if we can't contact the sql database", + @Comment({"Stop the server if we can't contact the sql database", "Take care with this, if you set this to false,", "AuthMe will automatically disable and the server won't be protected!"}) - public static final Property STOP_SERVER_ON_PROBLEM = + public static final Property STOP_SERVER_ON_PROBLEM = newProperty(BOOLEAN, "Security.SQLProblem.stopServer", true); - @Comment("/reload support") + @Comment("/reload support") public static final Property USE_RELOAD_COMMAND_SUPPORT = newProperty(BOOLEAN, "Security.ReloadCommand.useReloadCommandSupport", true); - @Comment("Remove spam from console?") + @Comment("Remove spam from console?") public static final Property REMOVE_SPAM_FROM_CONSOLE = newProperty(BOOLEAN, "Security.console.noConsoleSpam", false); - @Comment("Remove passwords from console?") + @Comment("Remove passwords from console?") public static final Property REMOVE_PASSWORD_FROM_CONSOLE = newProperty(BOOLEAN, "Security.console.removePassword", true); - @Comment("Player need to put a captcha when he fails too lot the password") + @Comment("Player need to put a captcha when he fails too lot the password") public static final Property USE_CAPTCHA = newProperty(BOOLEAN, "Security.captcha.useCaptcha", false); - @Comment("Max allowed tries before request a captcha") + @Comment("Max allowed tries before request a captcha") public static final Property MAX_LOGIN_TRIES_BEFORE_CAPTCHA = newProperty(INTEGER, "Security.captcha.maxLoginTry", 5); - @Comment("Captcha length") + @Comment("Captcha length") public static final Property CAPTCHA_LENGTH = newProperty(INTEGER, "Security.captcha.captchaLength", 5); diff --git a/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java b/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java index 9727ffac7..f5c7f23d8 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java +++ b/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java @@ -18,8 +18,9 @@ final class SettingsFieldRetriever { /** The classes to scan for properties. */ private static final List> CONFIGURATION_CLASSES = Arrays.asList( - ConverterSettings.class, DatabaseSettings.class, EmailSettings.class, HooksSettings.class, - ProtectionSettings.class, PurgeSettings.class, SecuritySettings.class); + ConverterSettings.class, PluginSettings.class, RestrictionSettings.class, + DatabaseSettings.class, EmailSettings.class, HooksSettings.class, + ProtectionSettings.class, PurgeSettings.class, SecuritySettings.class); private SettingsFieldRetriever() { } diff --git a/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java b/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java index 07cfc7144..9cac52d30 100644 --- a/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java +++ b/src/main/java/fr/xephi/authme/settings/propertymap/PropertyMap.java @@ -14,7 +14,7 @@ import java.util.TreeMap; */ public class PropertyMap { - private Map, String[]> propertyMap; + private Map, String[]> map; private PropertyMapComparator comparator; /** @@ -22,7 +22,7 @@ public class PropertyMap { */ public PropertyMap() { comparator = new PropertyMapComparator(); - propertyMap = new TreeMap<>(comparator); + map = new TreeMap<>(comparator); } /** @@ -33,7 +33,7 @@ public class PropertyMap { */ public void put(Property property, String[] comments) { comparator.add(property); - propertyMap.put(property, comments); + map.put(property, comments); } /** @@ -42,7 +42,7 @@ public class PropertyMap { * @return The entry set */ public Set, String[]>> entrySet() { - return propertyMap.entrySet(); + return map.entrySet(); } /** @@ -51,7 +51,16 @@ public class PropertyMap { * @return The key set */ public Set> keySet() { - return propertyMap.keySet(); + return map.keySet(); + } + + /** + * Return the size of the map. + * + * @return The size + */ + public int size() { + return map.size(); } } diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index bc1725133..960cfc6ee 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -340,8 +340,6 @@ Email: RecoveryPasswordLength: 8 # Email subject of password get mailSubject: 'Your new AuthMe Password' - # Email text here - mailText: 'Dear ,

This is your new AuthMe password for the server

:



Do not forget to change password after login!
/changepassword newPassword' # Like maxRegPerIp but with email maxRegPerEmail: 1 # Recall players to add an email? diff --git a/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java b/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java index b5bdc4df9..eb12ab030 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java @@ -1,14 +1,24 @@ package fr.xephi.authme.settings.custom; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.propertymap.PropertyMap; +import fr.xephi.authme.util.StringUtils; +import org.bukkit.configuration.MemorySection; +import org.bukkit.configuration.file.YamlConfiguration; import org.junit.Test; import java.io.File; import java.io.IOException; import java.net.URL; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; import static org.hamcrest.Matchers.equalTo; import static org.junit.Assert.assertThat; -import static org.junit.Assume.assumeThat; +import static org.junit.Assert.fail; /** * Test for {@link NewSetting} and the project's config.yml, @@ -16,14 +26,15 @@ import static org.junit.Assume.assumeThat; */ public class ConfigFileConsistencyTest { + /** The file name of the project's sample config file. */ + private static final String CONFIG_FILE = "/config.yml"; + @Test public void shouldHaveAllConfigs() throws IOException { - URL url = this.getClass().getResource("/config.yml"); - File configFile = new File(url.getFile()); - // given - assumeThat(configFile.exists(), equalTo(true)); - NewSetting settings = new NewSetting(configFile); + URL url = this.getClass().getResource(CONFIG_FILE); + File configFile = new File(url.getFile()); + NewSetting settings = new NewSetting(YamlConfiguration.loadConfiguration(configFile), new File("bogus"), null); // when boolean result = settings.containsAllSettings(SettingsFieldRetriever.getAllPropertyFields()); @@ -32,4 +43,38 @@ public class ConfigFileConsistencyTest { assertThat(result, equalTo(true)); } + @Test + public void shouldNotHaveUnknownConfigs() { + // given + URL url = this.getClass().getResource(CONFIG_FILE); + File configFile = new File(url.getFile()); + YamlConfiguration configuration = YamlConfiguration.loadConfiguration(configFile); + Map allReadProperties = configuration.getValues(true); + Set knownKeys = getAllKnownPropertyPaths(); + + // when + List unknownPaths = new ArrayList<>(); + for (Map.Entry entry : allReadProperties.entrySet()) { + // The value being a MemorySection means it's a parent node + if (!(entry.getValue() instanceof MemorySection) && !knownKeys.contains(entry.getKey())) { + unknownPaths.add(entry.getKey()); + } + } + + // then + if (!unknownPaths.isEmpty()) { + fail("Found " + unknownPaths.size() + " unknown property paths in the project's config.yml: \n- " + + StringUtils.join("\n- ", unknownPaths)); + } + } + + private static Set getAllKnownPropertyPaths() { + PropertyMap propertyMap = SettingsFieldRetriever.getAllPropertyFields(); + Set paths = new HashSet<>(propertyMap.size()); + for (Property property : propertyMap.keySet()) { + paths.add(property.getPath()); + } + return paths; + } + } diff --git a/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java b/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java index c06ed11b1..6dab6bdfc 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java @@ -54,7 +54,7 @@ public class SettingsClassConsistencyTest { for (Field field : fields) { if (Property.class.isAssignableFrom(field.getType())) { String fieldName = "Field " + clazz.getSimpleName() + "#" + field.getName(); - assertThat(fieldName + "should be public, static, and final", + assertThat(fieldName + " should be public, static, and final", isValidConstantField(field), equalTo(true)); } } From 3845c1e0eb754d89f395be6f972f233ed3055c92 Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sat, 9 Jan 2016 12:45:58 +0100 Subject: [PATCH 11/16] #347 Add NewSetting to command service - Adjust NewSetting constructor to match needs in AuthMe - Add NewSetting to the command service - See CaptchaCommand for a sample replacement from Settings to NewSetting --- src/main/java/fr/xephi/authme/AuthMe.java | 20 +++++++--- .../xephi/authme/command/CommandService.java | 17 ++++++++- .../executable/captcha/CaptchaCommand.java | 10 ++--- .../executable/register/RegisterCommand.java | 2 +- .../authme/settings/custom/NewSetting.java | 38 ++++++++++--------- .../settings/domain/EnumPropertyType.java | 6 +-- .../authme/settings/domain/Property.java | 8 ++-- .../authme/settings/domain/PropertyType.java | 20 +++++----- .../authme/command/CommandServiceTest.java | 21 +++++++++- .../captcha/CaptchaCommandTest.java | 11 +++--- .../custom/NewSettingIntegrationTest.java | 4 +- .../settings/custom/NewSettingTest.java | 10 ++--- 12 files changed, 107 insertions(+), 60 deletions(-) diff --git a/src/main/java/fr/xephi/authme/AuthMe.java b/src/main/java/fr/xephi/authme/AuthMe.java index 70c8bfd6b..e9de7d941 100644 --- a/src/main/java/fr/xephi/authme/AuthMe.java +++ b/src/main/java/fr/xephi/authme/AuthMe.java @@ -48,6 +48,7 @@ import fr.xephi.authme.security.crypts.HashedPassword; import fr.xephi.authme.settings.OtherAccounts; import fr.xephi.authme.settings.Settings; import fr.xephi.authme.settings.Spawn; +import fr.xephi.authme.settings.custom.NewSetting; import fr.xephi.authme.util.GeoLiteAPI; import fr.xephi.authme.util.StringUtils; import fr.xephi.authme.util.Utils; @@ -67,6 +68,7 @@ import org.bukkit.scheduler.BukkitTask; import org.mcstats.Metrics; import org.mcstats.Metrics.Graph; +import java.io.File; import java.io.IOException; import java.net.URL; import java.util.Calendar; @@ -97,6 +99,7 @@ public class AuthMe extends JavaPlugin { private CommandHandler commandHandler = null; private PermissionsManager permsMan = null; private Settings settings; + private NewSetting newSettings; private Messages messages; private JsonCache playerBackup; private ModuleManager moduleManager; @@ -213,6 +216,7 @@ public class AuthMe extends JavaPlugin { setEnabled(false); return; } + newSettings = createNewSetting(); // Set up messages & password security messages = Messages.getInstance(); @@ -233,7 +237,7 @@ public class AuthMe extends JavaPlugin { // Set up the permissions manager and command handler permsMan = initializePermissionsManager(); - commandHandler = initializeCommandHandler(permsMan, messages, passwordSecurity); + commandHandler = initializeCommandHandler(permsMan, messages, passwordSecurity, newSettings); // Set up the module manager setupModuleManager(); @@ -415,11 +419,12 @@ public class AuthMe extends JavaPlugin { } private CommandHandler initializeCommandHandler(PermissionsManager permissionsManager, Messages messages, - PasswordSecurity passwordSecurity) { + PasswordSecurity passwordSecurity, NewSetting settings) { HelpProvider helpProvider = new HelpProvider(permissionsManager); Set baseCommands = CommandInitializer.buildCommands(); CommandMapper mapper = new CommandMapper(baseCommands, messages, permissionsManager, helpProvider); - CommandService commandService = new CommandService(this, mapper, helpProvider, messages, passwordSecurity); + CommandService commandService = new CommandService( + this, mapper, helpProvider, messages, passwordSecurity, settings); return new CommandHandler(commandService); } @@ -441,19 +446,24 @@ public class AuthMe extends JavaPlugin { * @return True on success, false on failure. */ private boolean loadSettings() { - // TODO: new configuration style (more files) try { settings = new Settings(this); Settings.reload(); } catch (Exception e) { ConsoleLogger.writeStackTrace(e); - ConsoleLogger.showError("Can't load the configuration file... Something went wrong, to avoid security issues the server will shutdown!"); + ConsoleLogger.showError("Can't load the configuration file... Something went wrong. " + + "To avoid security issues the server will shut down!"); server.shutdown(); return true; } return false; } + private NewSetting createNewSetting() { + File configFile = new File(getDataFolder() + "config.yml"); + return new NewSetting(getConfig(), configFile); + } + /** * Set up the console filter. */ diff --git a/src/main/java/fr/xephi/authme/command/CommandService.java b/src/main/java/fr/xephi/authme/command/CommandService.java index 08a2790e8..8a986b0ee 100644 --- a/src/main/java/fr/xephi/authme/command/CommandService.java +++ b/src/main/java/fr/xephi/authme/command/CommandService.java @@ -2,6 +2,8 @@ package fr.xephi.authme.command; import java.util.List; +import fr.xephi.authme.settings.custom.NewSetting; +import fr.xephi.authme.settings.domain.Property; import org.bukkit.command.CommandSender; import fr.xephi.authme.AuthMe; @@ -24,6 +26,7 @@ public class CommandService { private final HelpProvider helpProvider; private final CommandMapper commandMapper; private final PasswordSecurity passwordSecurity; + private final NewSetting settings; /** * Constructor. @@ -35,12 +38,13 @@ public class CommandService { * @param passwordSecurity The Password Security instance */ public CommandService(AuthMe authMe, CommandMapper commandMapper, HelpProvider helpProvider, Messages messages, - PasswordSecurity passwordSecurity) { + PasswordSecurity passwordSecurity, NewSetting settings) { this.authMe = authMe; this.messages = messages; this.helpProvider = helpProvider; this.commandMapper = commandMapper; this.passwordSecurity = passwordSecurity; + this.settings = settings; } /** @@ -156,4 +160,15 @@ public class CommandService { return messages.retrieve(key); } + /** + * Retrieve the given property's value. + * + * @param property The property to retrieve + * @param The type of the property + * @return The property's value + */ + public T getProperty(Property property) { + return settings.getProperty(property); + } + } diff --git a/src/main/java/fr/xephi/authme/command/executable/captcha/CaptchaCommand.java b/src/main/java/fr/xephi/authme/command/executable/captcha/CaptchaCommand.java index d21bac778..79f963f0b 100644 --- a/src/main/java/fr/xephi/authme/command/executable/captcha/CaptchaCommand.java +++ b/src/main/java/fr/xephi/authme/command/executable/captcha/CaptchaCommand.java @@ -6,7 +6,7 @@ import fr.xephi.authme.command.CommandService; import fr.xephi.authme.command.PlayerCommand; import fr.xephi.authme.output.MessageKey; import fr.xephi.authme.security.RandomString; -import fr.xephi.authme.settings.Settings; +import fr.xephi.authme.settings.custom.SecuritySettings; import fr.xephi.authme.util.Wrapper; import org.bukkit.entity.Player; @@ -28,20 +28,20 @@ public class CaptchaCommand extends PlayerCommand { return; } - if (!Settings.useCaptcha) { + if (!commandService.getProperty(SecuritySettings.USE_CAPTCHA)) { commandService.send(player, MessageKey.USAGE_LOGIN); return; } - if (!plugin.cap.containsKey(playerNameLowerCase)) { commandService.send(player, MessageKey.USAGE_LOGIN); return; } - if (Settings.useCaptcha && !captcha.equals(plugin.cap.get(playerNameLowerCase))) { + if (!captcha.equals(plugin.cap.get(playerNameLowerCase))) { plugin.cap.remove(playerNameLowerCase); - String randStr = RandomString.generate(Settings.captchaLength); + int captchaLength = commandService.getProperty(SecuritySettings.CAPTCHA_LENGTH); + String randStr = RandomString.generate(captchaLength); plugin.cap.put(playerNameLowerCase, randStr); commandService.send(player, MessageKey.CAPTCHA_WRONG_ERROR, plugin.cap.get(playerNameLowerCase)); return; diff --git a/src/main/java/fr/xephi/authme/command/executable/register/RegisterCommand.java b/src/main/java/fr/xephi/authme/command/executable/register/RegisterCommand.java index 51bf6c106..8ba9f2cb7 100644 --- a/src/main/java/fr/xephi/authme/command/executable/register/RegisterCommand.java +++ b/src/main/java/fr/xephi/authme/command/executable/register/RegisterCommand.java @@ -43,6 +43,6 @@ public class RegisterCommand extends PlayerCommand { @Override public String getAlternativeCommand() { - return "authme register "; + return "/authme register "; } } diff --git a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java index 00aa9220e..6f9abdc44 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java +++ b/src/main/java/fr/xephi/authme/settings/custom/NewSetting.java @@ -6,7 +6,7 @@ import fr.xephi.authme.settings.domain.Property; import fr.xephi.authme.settings.propertymap.PropertyMap; import fr.xephi.authme.util.CollectionUtils; import fr.xephi.authme.util.StringUtils; -import org.bukkit.configuration.file.YamlConfiguration; +import org.bukkit.configuration.file.FileConfiguration; import java.io.File; import java.io.FileWriter; @@ -22,41 +22,43 @@ import java.util.Map; public class NewSetting { private File file; - private YamlConfiguration configuration; + private FileConfiguration configuration; /** * Constructor. * Loads the file as YAML and checks its integrity. * + * @param configuration The configuration to interact with * @param file The configuration file */ - public NewSetting(File file) { - this.configuration = YamlConfiguration.loadConfiguration(file); + public NewSetting(FileConfiguration configuration, File file) { + this.configuration = configuration; this.file = file; - PropertyMap propertyMap = SettingsFieldRetriever.getAllPropertyFields(); - if (!containsAllSettings(propertyMap)) { - save(propertyMap); - } + // TODO ljacqu 20160109: Ensure that save() works as desired (i.e. that it always produces valid YAML) + // and then uncomment the lines below. Once this is uncommented, the checks in the old Settings.java should + // be removed as we should check to rewrite the config.yml file only at one place + // -------- + // PropertyMap propertyMap = SettingsFieldRetriever.getAllPropertyFields(); + // if (!containsAllSettings(propertyMap)) { + // save(propertyMap); + // } } /** - * Simple constructor for testing purposes. Does not check for all properties and - * never saves to the file. + * Constructor for testing purposes, allowing more options. * - * @param yamlConfiguration The YamlConfiguration object to use + * @param configuration The FileConfiguration object to use * @param file The file to write to * @param propertyMap The property map whose properties should be verified for presence, or null to skip this */ @VisibleForTesting - NewSetting(YamlConfiguration yamlConfiguration, File file, PropertyMap propertyMap) { - this.configuration = yamlConfiguration; + NewSetting(FileConfiguration configuration, File file, PropertyMap propertyMap) { + this.configuration = configuration; this.file = file; - if (propertyMap != null) { - if (!containsAllSettings(propertyMap)) { - save(propertyMap); - } + if (propertyMap != null && !containsAllSettings(propertyMap)) { + save(propertyMap); } } @@ -67,7 +69,7 @@ public class NewSetting { * @param The property's type * @return The property's value */ - public T getOption(Property property) { + public T getProperty(Property property) { return property.getFromFile(configuration); } diff --git a/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java b/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java index 357067d8e..ed184bb7d 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java +++ b/src/main/java/fr/xephi/authme/settings/domain/EnumPropertyType.java @@ -1,6 +1,6 @@ package fr.xephi.authme.settings.domain; -import org.bukkit.configuration.file.YamlConfiguration; +import org.bukkit.configuration.file.FileConfiguration; import java.util.List; @@ -19,7 +19,7 @@ class EnumPropertyType> extends PropertyType { } @Override - public E getFromFile(Property property, YamlConfiguration configuration) { + public E getFromFile(Property property, FileConfiguration configuration) { String textValue = configuration.getString(property.getPath()); if (textValue == null) { return property.getDefaultValue(); @@ -34,7 +34,7 @@ class EnumPropertyType> extends PropertyType { } @Override - public boolean contains(Property property, YamlConfiguration configuration) { + public boolean contains(Property property, FileConfiguration configuration) { return super.contains(property, configuration) && mapToEnum(configuration.getString(property.getPath())) != null; } diff --git a/src/main/java/fr/xephi/authme/settings/domain/Property.java b/src/main/java/fr/xephi/authme/settings/domain/Property.java index c0fd2bfe0..6b15b5d3b 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/Property.java +++ b/src/main/java/fr/xephi/authme/settings/domain/Property.java @@ -1,6 +1,6 @@ package fr.xephi.authme.settings.domain; -import org.bukkit.configuration.file.YamlConfiguration; +import org.bukkit.configuration.file.FileConfiguration; import java.util.Arrays; import java.util.List; @@ -60,7 +60,7 @@ public class Property { * @param configuration The configuration to read the value from * @return The value, or default if not present */ - public T getFromFile(YamlConfiguration configuration) { + public T getFromFile(FileConfiguration configuration) { return type.getFromFile(this, configuration); } @@ -70,7 +70,7 @@ public class Property { * @param configuration The configuration to read the value from * @return The property value as YAML */ - public List formatValueAsYaml(YamlConfiguration configuration) { + public List formatValueAsYaml(FileConfiguration configuration) { return type.asYaml(this, configuration); } @@ -80,7 +80,7 @@ public class Property { * @param configuration The configuration file to verify * @return True if the property is present, false otherwise */ - public boolean isPresent(YamlConfiguration configuration) { + public boolean isPresent(FileConfiguration configuration) { return type.contains(this, configuration); } diff --git a/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java index 5338da7af..dc1975bba 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java +++ b/src/main/java/fr/xephi/authme/settings/domain/PropertyType.java @@ -1,6 +1,6 @@ package fr.xephi.authme.settings.domain; -import org.bukkit.configuration.file.YamlConfiguration; +import org.bukkit.configuration.file.FileConfiguration; import java.util.ArrayList; import java.util.List; @@ -28,7 +28,7 @@ public abstract class PropertyType { * @param configuration The YAML configuration to read from * @return The read value, or the default value if absent */ - public abstract T getFromFile(Property property, YamlConfiguration configuration); + public abstract T getFromFile(Property property, FileConfiguration configuration); /** * Return the property's value (or its default) as YAML. @@ -37,7 +37,7 @@ public abstract class PropertyType { * @param configuration The YAML configuration to read from * @return The read value or its default in YAML format */ - public List asYaml(Property property, YamlConfiguration configuration) { + public List asYaml(Property property, FileConfiguration configuration) { return asYaml(getFromFile(property, configuration)); } @@ -48,7 +48,7 @@ public abstract class PropertyType { * @param configuration The configuration to verify * @return True if the property is present, false otherwise */ - public boolean contains(Property property, YamlConfiguration configuration) { + public boolean contains(Property property, FileConfiguration configuration) { return configuration.contains(property.getPath()); } @@ -66,7 +66,7 @@ public abstract class PropertyType { */ private static final class BooleanProperty extends PropertyType { @Override - public Boolean getFromFile(Property property, YamlConfiguration configuration) { + public Boolean getFromFile(Property property, FileConfiguration configuration) { return configuration.getBoolean(property.getPath(), property.getDefaultValue()); } @@ -81,7 +81,7 @@ public abstract class PropertyType { */ private static final class DoubleProperty extends PropertyType { @Override - public Double getFromFile(Property property, YamlConfiguration configuration) { + public Double getFromFile(Property property, FileConfiguration configuration) { return configuration.getDouble(property.getPath(), property.getDefaultValue()); } @@ -96,7 +96,7 @@ public abstract class PropertyType { */ private static final class IntegerProperty extends PropertyType { @Override - public Integer getFromFile(Property property, YamlConfiguration configuration) { + public Integer getFromFile(Property property, FileConfiguration configuration) { return configuration.getInt(property.getPath(), property.getDefaultValue()); } @@ -111,7 +111,7 @@ public abstract class PropertyType { */ private static final class StringProperty extends PropertyType { @Override - public String getFromFile(Property property, YamlConfiguration configuration) { + public String getFromFile(Property property, FileConfiguration configuration) { return configuration.getString(property.getPath(), property.getDefaultValue()); } @@ -131,7 +131,7 @@ public abstract class PropertyType { */ private static final class StringListProperty extends PropertyType> { @Override - public List getFromFile(Property> property, YamlConfiguration configuration) { + public List getFromFile(Property> property, FileConfiguration configuration) { if (!configuration.isList(property.getPath())) { return property.getDefaultValue(); } @@ -154,7 +154,7 @@ public abstract class PropertyType { } @Override - public boolean contains(Property> property, YamlConfiguration configuration) { + public boolean contains(Property> property, FileConfiguration configuration) { return configuration.contains(property.getPath()) && configuration.isList(property.getPath()); } } diff --git a/src/test/java/fr/xephi/authme/command/CommandServiceTest.java b/src/test/java/fr/xephi/authme/command/CommandServiceTest.java index 3b457291e..a08e18efd 100644 --- a/src/test/java/fr/xephi/authme/command/CommandServiceTest.java +++ b/src/test/java/fr/xephi/authme/command/CommandServiceTest.java @@ -8,6 +8,9 @@ import fr.xephi.authme.output.Messages; import fr.xephi.authme.permission.PermissionsManager; import fr.xephi.authme.process.Management; import fr.xephi.authme.security.PasswordSecurity; +import fr.xephi.authme.settings.custom.NewSetting; +import fr.xephi.authme.settings.custom.SecuritySettings; +import fr.xephi.authme.settings.domain.Property; import org.bukkit.command.CommandSender; import org.bukkit.entity.Player; import org.junit.Before; @@ -36,6 +39,7 @@ public class CommandServiceTest { private Messages messages; private PasswordSecurity passwordSecurity; private CommandService commandService; + private NewSetting settings; @Before public void setUpService() { @@ -44,7 +48,8 @@ public class CommandServiceTest { helpProvider = mock(HelpProvider.class); messages = mock(Messages.class); passwordSecurity = mock(PasswordSecurity.class); - commandService = new CommandService(authMe, commandMapper, helpProvider, messages, passwordSecurity); + settings = mock(NewSetting.class); + commandService = new CommandService(authMe, commandMapper, helpProvider, messages, passwordSecurity, settings); } @Test @@ -195,4 +200,18 @@ public class CommandServiceTest { assertThat(result, equalTo(givenMessages)); verify(messages).retrieve(key); } + + @Test + public void shouldRetrieveProperty() { + // given + Property property = SecuritySettings.CAPTCHA_LENGTH; + given(settings.getProperty(property)).willReturn(7); + + // when + int result = settings.getProperty(property); + + // then + assertThat(result, equalTo(7)); + verify(settings).getProperty(property); + } } diff --git a/src/test/java/fr/xephi/authme/command/executable/captcha/CaptchaCommandTest.java b/src/test/java/fr/xephi/authme/command/executable/captcha/CaptchaCommandTest.java index 60c72bd31..785b0b003 100644 --- a/src/test/java/fr/xephi/authme/command/executable/captcha/CaptchaCommandTest.java +++ b/src/test/java/fr/xephi/authme/command/executable/captcha/CaptchaCommandTest.java @@ -5,7 +5,7 @@ import fr.xephi.authme.command.CommandService; import fr.xephi.authme.command.ExecutableCommand; import fr.xephi.authme.output.MessageKey; import fr.xephi.authme.output.Messages; -import fr.xephi.authme.settings.Settings; +import fr.xephi.authme.settings.custom.SecuritySettings; import fr.xephi.authme.util.WrapperMock; import org.bukkit.command.BlockCommandSender; import org.bukkit.command.CommandSender; @@ -20,6 +20,7 @@ import java.util.Collections; import static org.hamcrest.Matchers.equalTo; import static org.junit.Assert.assertThat; +import static org.mockito.BDDMockito.given; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; @@ -35,8 +36,8 @@ public class CaptchaCommandTest { @Before public void setUpWrapperMock() { wrapperMock = WrapperMock.createInstance(); - Settings.useCaptcha = true; commandService = mock(CommandService.class); + given(commandService.getProperty(SecuritySettings.USE_CAPTCHA)).willReturn(true); } @Test @@ -46,7 +47,7 @@ public class CaptchaCommandTest { ExecutableCommand command = new CaptchaCommand(); // when - command.executeCommand(sender, new ArrayList(), mock(CommandService.class)); + command.executeCommand(sender, new ArrayList(), commandService); // then assertThat(wrapperMock.wasMockCalled(AuthMe.class), equalTo(false)); @@ -54,14 +55,14 @@ public class CaptchaCommandTest { } @Test - @Ignore public void shouldRejectIfCaptchaIsNotUsed() { // given Player player = mockPlayerWithName("testplayer"); ExecutableCommand command = new CaptchaCommand(); + given(commandService.getProperty(SecuritySettings.USE_CAPTCHA)).willReturn(false); // when - command.executeCommand(player, Collections.singletonList("1234"), mock(CommandService.class)); + command.executeCommand(player, Collections.singletonList("1234"), commandService); // then verify(commandService).send(player, MessageKey.USAGE_LOGIN); diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java index dcb3c6833..73b80b020 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingIntegrationTest.java @@ -67,7 +67,7 @@ public class NewSettingIntegrationTest { .build(); for (Map.Entry, Object> entry : expectedValues.entrySet()) { assertThat("Property '" + entry.getKey().getPath() + "' has expected value", - settings.getOption(entry.getKey()), equalTo(entry.getValue())); + settings.getProperty(entry.getKey()), equalTo(entry.getValue())); } assertThat(file.exists(), equalTo(false)); } @@ -100,7 +100,7 @@ public class NewSettingIntegrationTest { .build(); for (Map.Entry, Object> entry : expectedValues.entrySet()) { assertThat("Property '" + entry.getKey().getPath() + "' has expected value", - settings.getOption(entry.getKey()), equalTo(entry.getValue())); + settings.getProperty(entry.getKey()), equalTo(entry.getValue())); } } diff --git a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java index 080e1d0d0..64e213aed 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/NewSettingTest.java @@ -41,10 +41,10 @@ public class NewSettingTest { // when / then NewSetting settings = new NewSetting(file, new File("conf.txt"), null); - assertThat(settings.getOption(TestConfiguration.VERSION_NUMBER), equalTo(20)); - assertThat(settings.getOption(TestConfiguration.SKIP_BORING_FEATURES), equalTo(true)); - assertThat(settings.getOption(TestConfiguration.RATIO_LIMIT), equalTo(4.25)); - assertThat(settings.getOption(TestConfiguration.SYSTEM_NAME), equalTo("myTestSys")); + assertThat(settings.getProperty(TestConfiguration.VERSION_NUMBER), equalTo(20)); + assertThat(settings.getProperty(TestConfiguration.SKIP_BORING_FEATURES), equalTo(true)); + assertThat(settings.getProperty(TestConfiguration.RATIO_LIMIT), equalTo(4.25)); + assertThat(settings.getProperty(TestConfiguration.SYSTEM_NAME), equalTo("myTestSys")); assertDefaultValue(TestConfiguration.DURATION_IN_SECONDS, settings); assertDefaultValue(TestConfiguration.DUST_LEVEL, settings); @@ -68,7 +68,7 @@ public class NewSettingTest { private static void assertDefaultValue(Property property, NewSetting setting) { assertThat(property.getPath() + " has default value", - setting.getOption(property).equals(property.getDefaultValue()), equalTo(true)); + setting.getProperty(property).equals(property.getDefaultValue()), equalTo(true)); } private static Answer withDefaultArgument() { From fc0b7c46ac52fc356a6c80f99b09aba3834447e1 Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sat, 9 Jan 2016 21:57:20 +0100 Subject: [PATCH 12/16] #306 Add permission manager to command service - Inject permission manager into command service explicitly via constructor - Change command mapper to only care about generating FoundCommandResult objects, and command handler to worry about dealing with it later on --- src/main/java/fr/xephi/authme/AuthMe.java | 4 +- .../xephi/authme/command/CommandHandler.java | 77 +++++++++++++++-- .../xephi/authme/command/CommandMapper.java | 85 +------------------ .../xephi/authme/command/CommandService.java | 32 +++---- .../authme/security/PasswordSecurity.java | 2 +- .../authme/command/CommandHandlerTest.java | 5 +- .../authme/command/CommandMapperTest.java | 4 +- .../authme/command/CommandServiceTest.java | 27 ++---- 8 files changed, 101 insertions(+), 135 deletions(-) diff --git a/src/main/java/fr/xephi/authme/AuthMe.java b/src/main/java/fr/xephi/authme/AuthMe.java index e9de7d941..5e7c383f1 100644 --- a/src/main/java/fr/xephi/authme/AuthMe.java +++ b/src/main/java/fr/xephi/authme/AuthMe.java @@ -422,9 +422,9 @@ public class AuthMe extends JavaPlugin { PasswordSecurity passwordSecurity, NewSetting settings) { HelpProvider helpProvider = new HelpProvider(permissionsManager); Set baseCommands = CommandInitializer.buildCommands(); - CommandMapper mapper = new CommandMapper(baseCommands, messages, permissionsManager, helpProvider); + CommandMapper mapper = new CommandMapper(baseCommands, permissionsManager); CommandService commandService = new CommandService( - this, mapper, helpProvider, messages, passwordSecurity, settings); + this, mapper, helpProvider, messages, passwordSecurity, permissionsManager, settings); return new CommandHandler(commandService); } diff --git a/src/main/java/fr/xephi/authme/command/CommandHandler.java b/src/main/java/fr/xephi/authme/command/CommandHandler.java index e3ab671b4..37c1a2a16 100644 --- a/src/main/java/fr/xephi/authme/command/CommandHandler.java +++ b/src/main/java/fr/xephi/authme/command/CommandHandler.java @@ -3,6 +3,9 @@ package fr.xephi.authme.command; import java.util.ArrayList; import java.util.List; +import fr.xephi.authme.AuthMe; +import fr.xephi.authme.command.help.HelpProvider; +import org.bukkit.ChatColor; import org.bukkit.command.CommandSender; import fr.xephi.authme.util.StringUtils; @@ -13,6 +16,12 @@ import fr.xephi.authme.util.StringUtils; */ public class CommandHandler { + /** + * The threshold for suggesting a similar command. If the difference is below this value, we will + * ask the player whether he meant the similar command. + */ + private static final double SUGGEST_COMMAND_THRESHOLD = 0.75; + private final CommandService commandService; /** @@ -40,14 +49,32 @@ public class CommandHandler { parts.add(0, bukkitCommandLabel); FoundCommandResult result = commandService.mapPartsToCommand(sender, parts); - if (FoundResultStatus.SUCCESS.equals(result.getResultStatus())) { - executeCommand(sender, result); - } else { - commandService.outputMappingError(sender, result); - } + handleCommandResult(sender, result); return !FoundResultStatus.MISSING_BASE_COMMAND.equals(result.getResultStatus()); } + private void handleCommandResult(CommandSender sender, FoundCommandResult result) { + switch (result.getResultStatus()) { + case SUCCESS: + executeCommand(sender, result); + break; + case MISSING_BASE_COMMAND: + sender.sendMessage(ChatColor.DARK_RED + "Failed to parse " + AuthMe.getPluginName() + " command!"); + break; + case INCORRECT_ARGUMENTS: + sendImproperArgumentsMessage(sender, result); + break; + case UNKNOWN_LABEL: + sendUnknownCommandMessage(sender, result); + break; + case NO_PERMISSION: + sendPermissionDeniedError(sender); + break; + default: + throw new IllegalStateException("Unknown result status '" + result.getResultStatus() + "'"); + } + } + /** * Execute the command for the given command sender. * @@ -76,6 +103,46 @@ public class CommandHandler { return cleanArguments; } + /** + * Show an "unknown command" message to the user and suggest an existing command if its similarity is within + * the defined threshold. + * + * @param sender The command sender + * @param result The command that was found during the mapping process + */ + private static void sendUnknownCommandMessage(CommandSender sender, FoundCommandResult result) { + sender.sendMessage(ChatColor.DARK_RED + "Unknown command!"); + // Show a command suggestion if available and the difference isn't too big + if (result.getDifference() <= SUGGEST_COMMAND_THRESHOLD && result.getCommandDescription() != null) { + sender.sendMessage(ChatColor.YELLOW + "Did you mean " + ChatColor.GOLD + + CommandUtils.constructCommandPath(result.getCommandDescription()) + ChatColor.YELLOW + "?"); + } + + sender.sendMessage(ChatColor.YELLOW + "Use the command " + ChatColor.GOLD + "/" + result.getLabels().get(0) + + " help" + ChatColor.YELLOW + " to view help."); + } + + private void sendImproperArgumentsMessage(CommandSender sender, FoundCommandResult result) { + CommandDescription command = result.getCommandDescription(); + if (!commandService.getPermissionsManager().hasPermission(sender, command)) { + sendPermissionDeniedError(sender); + return; + } + + // Show the command argument help + sender.sendMessage(ChatColor.DARK_RED + "Incorrect command arguments!"); + commandService.outputHelp(sender, result, HelpProvider.SHOW_ARGUMENTS); + + List labels = result.getLabels(); + String childLabel = labels.size() >= 2 ? labels.get(1) : ""; + sender.sendMessage(ChatColor.GOLD + "Detailed help: " + ChatColor.WHITE + + "/" + labels.get(0) + " help " + childLabel); + } + + // TODO ljacqu 20151212: Remove me once I am a MessageKey + private static void sendPermissionDeniedError(CommandSender sender) { + sender.sendMessage(ChatColor.DARK_RED + "You don't have permission to use this command!"); + } } diff --git a/src/main/java/fr/xephi/authme/command/CommandMapper.java b/src/main/java/fr/xephi/authme/command/CommandMapper.java index 69d31fe5f..8bc5dccdd 100644 --- a/src/main/java/fr/xephi/authme/command/CommandMapper.java +++ b/src/main/java/fr/xephi/authme/command/CommandMapper.java @@ -1,13 +1,11 @@ package fr.xephi.authme.command; -import fr.xephi.authme.AuthMe; import fr.xephi.authme.command.executable.HelpCommand; import fr.xephi.authme.command.help.HelpProvider; import fr.xephi.authme.output.Messages; import fr.xephi.authme.permission.PermissionsManager; import fr.xephi.authme.util.CollectionUtils; import fr.xephi.authme.util.StringUtils; -import org.bukkit.ChatColor; import org.bukkit.command.CommandSender; import java.util.ArrayList; @@ -19,101 +17,24 @@ import static fr.xephi.authme.command.FoundResultStatus.MISSING_BASE_COMMAND; import static fr.xephi.authme.command.FoundResultStatus.UNKNOWN_LABEL; /** - * The AuthMe command handler, responsible for mapping incoming command parts to the correct {@link CommandDescription} - * or to display help messages for erroneous invocations (unknown command, no permission, etc.). + * The AuthMe command handler, responsible for mapping incoming + * command parts to the correct {@link CommandDescription}. */ public class CommandMapper { - /** - * The threshold for suggesting a similar command. If the difference is below this value, we will - * ask the player whether he meant the similar command. - */ - private static final double SUGGEST_COMMAND_THRESHOLD = 0.75; - /** * The class of the help command, to which the base label should also be passed in the arguments. */ private static final Class HELP_COMMAND_CLASS = HelpCommand.class; private final Set baseCommands; - private final Messages messages; private final PermissionsManager permissionsManager; - private final HelpProvider helpProvider; - public CommandMapper(Set baseCommands, Messages messages, - PermissionsManager permissionsManager, HelpProvider helpProvider) { + public CommandMapper(Set baseCommands, PermissionsManager permissionsManager) { this.baseCommands = baseCommands; - this.messages = messages; this.permissionsManager = permissionsManager; - this.helpProvider = helpProvider; } - public void outputStandardError(CommandSender sender, FoundCommandResult result) { - switch (result.getResultStatus()) { - case SUCCESS: - // Successful mapping, so no error to output - break; - case MISSING_BASE_COMMAND: - sender.sendMessage(ChatColor.DARK_RED + "Failed to parse " + AuthMe.getPluginName() + " command!"); - break; - case INCORRECT_ARGUMENTS: - sendImproperArgumentsMessage(sender, result); - break; - case UNKNOWN_LABEL: - sendUnknownCommandMessage(sender, result); - break; - case NO_PERMISSION: - sendPermissionDeniedError(sender); - break; - default: - throw new IllegalStateException("Unknown result status '" + result.getResultStatus() + "'"); - } - } - - /** - * Show an "unknown command" message to the user and suggest an existing command if its similarity is within - * the defined threshold. - * - * @param sender The command sender - * @param result The command that was found during the mapping process - */ - private static void sendUnknownCommandMessage(CommandSender sender, FoundCommandResult result) { - sender.sendMessage(ChatColor.DARK_RED + "Unknown command!"); - - // Show a command suggestion if available and the difference isn't too big - if (result.getDifference() <= SUGGEST_COMMAND_THRESHOLD && result.getCommandDescription() != null) { - sender.sendMessage(ChatColor.YELLOW + "Did you mean " + ChatColor.GOLD - + CommandUtils.constructCommandPath(result.getCommandDescription()) + ChatColor.YELLOW + "?"); - } - - sender.sendMessage(ChatColor.YELLOW + "Use the command " + ChatColor.GOLD + "/" + result.getLabels().get(0) - + " help" + ChatColor.YELLOW + " to view help."); - } - - private void sendImproperArgumentsMessage(CommandSender sender, FoundCommandResult result) { - CommandDescription command = result.getCommandDescription(); - if (!permissionsManager.hasPermission(sender, command)) { - sendPermissionDeniedError(sender); - return; - } - - // Show the command argument help - sender.sendMessage(ChatColor.DARK_RED + "Incorrect command arguments!"); - List lines = helpProvider.printHelp(sender, result, HelpProvider.SHOW_ARGUMENTS); - for (String line : lines) { - sender.sendMessage(line); - } - - List labels = result.getLabels(); - String childLabel = labels.size() >= 2 ? labels.get(1) : ""; - sender.sendMessage(ChatColor.GOLD + "Detailed help: " + ChatColor.WHITE - + "/" + labels.get(0) + " help " + childLabel); - } - - // TODO ljacqu 20151212: Remove me once I am a MessageKey - private static void sendPermissionDeniedError(CommandSender sender) { - sender.sendMessage(ChatColor.DARK_RED + "You don't have permission to use this command!"); - } /** * Map incoming command parts to a command. This processes all parts and distinguishes the labels from arguments. diff --git a/src/main/java/fr/xephi/authme/command/CommandService.java b/src/main/java/fr/xephi/authme/command/CommandService.java index 8a986b0ee..8dd1da599 100644 --- a/src/main/java/fr/xephi/authme/command/CommandService.java +++ b/src/main/java/fr/xephi/authme/command/CommandService.java @@ -1,11 +1,5 @@ package fr.xephi.authme.command; -import java.util.List; - -import fr.xephi.authme.settings.custom.NewSetting; -import fr.xephi.authme.settings.domain.Property; -import org.bukkit.command.CommandSender; - import fr.xephi.authme.AuthMe; import fr.xephi.authme.command.help.HelpProvider; import fr.xephi.authme.datasource.DataSource; @@ -14,6 +8,11 @@ import fr.xephi.authme.output.Messages; import fr.xephi.authme.permission.PermissionsManager; import fr.xephi.authme.process.Management; import fr.xephi.authme.security.PasswordSecurity; +import fr.xephi.authme.settings.custom.NewSetting; +import fr.xephi.authme.settings.domain.Property; +import org.bukkit.command.CommandSender; + +import java.util.List; /** * Service for implementations of {@link ExecutableCommand} to execute some common tasks. @@ -26,6 +25,7 @@ public class CommandService { private final HelpProvider helpProvider; private final CommandMapper commandMapper; private final PasswordSecurity passwordSecurity; + private final PermissionsManager permissionsManager; private final NewSetting settings; /** @@ -36,14 +36,18 @@ public class CommandService { * @param helpProvider Help provider * @param messages Messages instance * @param passwordSecurity The Password Security instance + * @param permissionsManager The permissions manager + * @param settings The settings manager */ public CommandService(AuthMe authMe, CommandMapper commandMapper, HelpProvider helpProvider, Messages messages, - PasswordSecurity passwordSecurity, NewSetting settings) { + PasswordSecurity passwordSecurity, PermissionsManager permissionsManager, + NewSetting settings) { this.authMe = authMe; this.messages = messages; this.helpProvider = helpProvider; this.commandMapper = commandMapper; this.passwordSecurity = passwordSecurity; + this.permissionsManager = permissionsManager; this.settings = settings; } @@ -79,17 +83,6 @@ public class CommandService { return commandMapper.mapPartsToCommand(sender, commandParts); } - /** - * Output the standard error message for the status in the provided {@link FoundCommandResult} object. - * Does not output anything for successful mappings. - * - * @param sender The sender to output the error to - * @param result The mapping result to process - */ - public void outputMappingError(CommandSender sender, FoundCommandResult result) { - commandMapper.outputStandardError(sender, result); - } - /** * Run the given task asynchronously with the Bukkit scheduler. * @@ -146,8 +139,7 @@ public class CommandService { * @return the permissions manager */ public PermissionsManager getPermissionsManager() { - // TODO ljacqu 20151226: Might be nicer to pass the perm manager via constructor - return authMe.getPermissionsManager(); + return permissionsManager; } /** diff --git a/src/main/java/fr/xephi/authme/security/PasswordSecurity.java b/src/main/java/fr/xephi/authme/security/PasswordSecurity.java index 552b64dd2..ddeb979d3 100644 --- a/src/main/java/fr/xephi/authme/security/PasswordSecurity.java +++ b/src/main/java/fr/xephi/authme/security/PasswordSecurity.java @@ -62,7 +62,7 @@ public class PasswordSecurity { * @param hashedPassword The encrypted password to test the clear-text password against * @param playerName The name of the player * - * @return True if the + * @return True if there was a password match with another encryption method, false otherwise */ private boolean compareWithAllEncryptionMethods(String password, HashedPassword hashedPassword, String playerName) { diff --git a/src/test/java/fr/xephi/authme/command/CommandHandlerTest.java b/src/test/java/fr/xephi/authme/command/CommandHandlerTest.java index 018721c0d..ed3943a2b 100644 --- a/src/test/java/fr/xephi/authme/command/CommandHandlerTest.java +++ b/src/test/java/fr/xephi/authme/command/CommandHandlerTest.java @@ -14,6 +14,7 @@ import static fr.xephi.authme.command.FoundResultStatus.SUCCESS; import static java.util.Arrays.asList; import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.Matchers.contains; +import static org.hamcrest.Matchers.containsString; import static org.mockito.BDDMockito.given; import static org.mockito.Matchers.any; import static org.mockito.Matchers.anyListOf; @@ -89,7 +90,9 @@ public class CommandHandlerTest { assertThat(captor.getValue(), contains("unreg", "testPlayer")); verify(command, never()).getExecutableCommand(); - verify(serviceMock).outputMappingError(eq(sender), any(FoundCommandResult.class)); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + verify(sender).sendMessage(captor.capture()); + assertThat(captor.getValue(), containsString("don't have permission")); } @Test diff --git a/src/test/java/fr/xephi/authme/command/CommandMapperTest.java b/src/test/java/fr/xephi/authme/command/CommandMapperTest.java index e65c08c68..a7d233050 100644 --- a/src/test/java/fr/xephi/authme/command/CommandMapperTest.java +++ b/src/test/java/fr/xephi/authme/command/CommandMapperTest.java @@ -1,7 +1,5 @@ package fr.xephi.authme.command; -import fr.xephi.authme.command.help.HelpProvider; -import fr.xephi.authme.output.Messages; import fr.xephi.authme.permission.PermissionsManager; import org.bukkit.command.CommandSender; import org.junit.Before; @@ -43,7 +41,7 @@ public class CommandMapperTest { @Before public void setUpMocks() { permissionsManagerMock = mock(PermissionsManager.class); - mapper = new CommandMapper(commands, mock(Messages.class), permissionsManagerMock, mock(HelpProvider.class)); + mapper = new CommandMapper(commands, permissionsManagerMock); } // ----------- diff --git a/src/test/java/fr/xephi/authme/command/CommandServiceTest.java b/src/test/java/fr/xephi/authme/command/CommandServiceTest.java index a08e18efd..e3e67e3ed 100644 --- a/src/test/java/fr/xephi/authme/command/CommandServiceTest.java +++ b/src/test/java/fr/xephi/authme/command/CommandServiceTest.java @@ -39,6 +39,7 @@ public class CommandServiceTest { private Messages messages; private PasswordSecurity passwordSecurity; private CommandService commandService; + private PermissionsManager permissionsManager; private NewSetting settings; @Before @@ -48,8 +49,10 @@ public class CommandServiceTest { helpProvider = mock(HelpProvider.class); messages = mock(Messages.class); passwordSecurity = mock(PasswordSecurity.class); + permissionsManager = mock(PermissionsManager.class); settings = mock(NewSetting.class); - commandService = new CommandService(authMe, commandMapper, helpProvider, messages, passwordSecurity, settings); + commandService = new CommandService( + authMe, commandMapper, helpProvider, messages, passwordSecurity, permissionsManager, settings); } @Test @@ -92,19 +95,6 @@ public class CommandServiceTest { verify(commandMapper).mapPartsToCommand(sender, commandParts); } - @Test - public void shouldOutputMappingError() { - // given - CommandSender sender = mock(CommandSender.class); - FoundCommandResult result = mock(FoundCommandResult.class); - - // when - commandService.outputMappingError(sender, result); - - // then - verify(commandMapper).outputStandardError(sender, result); - } - @Test @Ignore public void shouldRunTaskInAsync() { @@ -174,16 +164,11 @@ public class CommandServiceTest { @Test public void shouldReturnPermissionsManager() { - // given - PermissionsManager manager = mock(PermissionsManager.class); - given(authMe.getPermissionsManager()).willReturn(manager); - - // when + // given / when PermissionsManager result = commandService.getPermissionsManager(); // then - assertThat(result, equalTo(manager)); - verify(authMe).getPermissionsManager(); + assertThat(result, equalTo(permissionsManager)); } @Test From 4d2f39f06ed04d91adac473077174e9e0c1c01d6 Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sat, 9 Jan 2016 22:51:22 +0100 Subject: [PATCH 13/16] #306 Add tests for CommandHandler and CommandMapper --- .../authme/command/CommandHandlerTest.java | 136 ++++++++++++++++++ .../authme/command/CommandMapperTest.java | 19 +++ .../captcha/CaptchaCommandTest.java | 1 - 3 files changed, 155 insertions(+), 1 deletion(-) diff --git a/src/test/java/fr/xephi/authme/command/CommandHandlerTest.java b/src/test/java/fr/xephi/authme/command/CommandHandlerTest.java index ed3943a2b..345082bc9 100644 --- a/src/test/java/fr/xephi/authme/command/CommandHandlerTest.java +++ b/src/test/java/fr/xephi/authme/command/CommandHandlerTest.java @@ -1,5 +1,6 @@ package fr.xephi.authme.command; +import fr.xephi.authme.permission.PermissionsManager; import org.bukkit.command.CommandSender; import org.junit.Before; import org.junit.Test; @@ -7,10 +8,14 @@ import org.mockito.ArgumentCaptor; import org.mockito.Captor; import org.mockito.MockitoAnnotations; +import java.util.Collections; import java.util.List; +import static fr.xephi.authme.command.FoundResultStatus.INCORRECT_ARGUMENTS; +import static fr.xephi.authme.command.FoundResultStatus.MISSING_BASE_COMMAND; import static fr.xephi.authme.command.FoundResultStatus.NO_PERMISSION; import static fr.xephi.authme.command.FoundResultStatus.SUCCESS; +import static fr.xephi.authme.command.FoundResultStatus.UNKNOWN_LABEL; import static java.util.Arrays.asList; import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.Matchers.contains; @@ -20,8 +25,10 @@ import static org.mockito.Matchers.any; import static org.mockito.Matchers.anyListOf; import static org.mockito.Matchers.anyString; import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.atLeastOnce; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; /** @@ -95,6 +102,135 @@ public class CommandHandlerTest { assertThat(captor.getValue(), containsString("don't have permission")); } + @Test + public void shouldNotCallExecutableForWrongArguments() { + // given + String bukkitLabel = "unreg"; + String[] bukkitArgs = {"testPlayer"}; + CommandSender sender = mock(CommandSender.class); + CommandDescription command = mock(CommandDescription.class); + given(serviceMock.mapPartsToCommand(any(CommandSender.class), anyListOf(String.class))).willReturn( + new FoundCommandResult(command, asList("unreg"), asList("testPlayer"), 0.0, INCORRECT_ARGUMENTS)); + PermissionsManager permissionsManager = mock(PermissionsManager.class); + given(permissionsManager.hasPermission(sender, command)).willReturn(true); + given(serviceMock.getPermissionsManager()).willReturn(permissionsManager); + + // when + handler.processCommand(sender, bukkitLabel, bukkitArgs); + + // then + verify(serviceMock).mapPartsToCommand(eq(sender), captor.capture()); + assertThat(captor.getValue(), contains("unreg", "testPlayer")); + + verify(command, never()).getExecutableCommand(); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + verify(sender, atLeastOnce()).sendMessage(captor.capture()); + assertThat(captor.getAllValues().get(0), containsString("Incorrect command arguments")); + } + + @Test + public void shouldNotCallExecutableForWrongArgumentsAndPermissionDenied() { + // given + String bukkitLabel = "unreg"; + String[] bukkitArgs = {"testPlayer"}; + CommandSender sender = mock(CommandSender.class); + CommandDescription command = mock(CommandDescription.class); + given(serviceMock.mapPartsToCommand(any(CommandSender.class), anyListOf(String.class))).willReturn( + new FoundCommandResult(command, asList("unreg"), asList("testPlayer"), 0.0, INCORRECT_ARGUMENTS)); + PermissionsManager permissionsManager = mock(PermissionsManager.class); + given(permissionsManager.hasPermission(sender, command)).willReturn(false); + given(serviceMock.getPermissionsManager()).willReturn(permissionsManager); + + // when + handler.processCommand(sender, bukkitLabel, bukkitArgs); + + // then + verify(serviceMock).mapPartsToCommand(eq(sender), captor.capture()); + assertThat(captor.getValue(), contains("unreg", "testPlayer")); + + verify(command, never()).getExecutableCommand(); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + verify(sender).sendMessage(captor.capture()); + assertThat(captor.getValue(), containsString("You don't have permission")); + } + + @Test + public void shouldNotCallExecutableForFailedParsing() { + // given + String bukkitLabel = "unreg"; + String[] bukkitArgs = {"testPlayer"}; + CommandSender sender = mock(CommandSender.class); + CommandDescription command = mock(CommandDescription.class); + given(serviceMock.mapPartsToCommand(any(CommandSender.class), anyListOf(String.class))).willReturn( + new FoundCommandResult(command, asList("unreg"), asList("testPlayer"), 0.0, MISSING_BASE_COMMAND)); + + // when + handler.processCommand(sender, bukkitLabel, bukkitArgs); + + // then + verify(serviceMock).mapPartsToCommand(eq(sender), captor.capture()); + assertThat(captor.getValue(), contains("unreg", "testPlayer")); + + verify(command, never()).getExecutableCommand(); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + verify(sender).sendMessage(captor.capture()); + assertThat(captor.getValue(), containsString("Failed to parse")); + } + + @Test + public void shouldNotCallExecutableForUnknownLabelAndHaveSuggestion() { + // given + String bukkitLabel = "unreg"; + String[] bukkitArgs = {"testPlayer"}; + CommandSender sender = mock(CommandSender.class); + CommandDescription command = mock(CommandDescription.class); + given(command.getLabels()).willReturn(Collections.singletonList("test_cmd")); + given(serviceMock.mapPartsToCommand(any(CommandSender.class), anyListOf(String.class))).willReturn( + new FoundCommandResult(command, asList("unreg"), asList("testPlayer"), 0.01, UNKNOWN_LABEL)); + + // when + handler.processCommand(sender, bukkitLabel, bukkitArgs); + + // then + verify(serviceMock).mapPartsToCommand(eq(sender), captor.capture()); + assertThat(captor.getValue(), contains("unreg", "testPlayer")); + + verify(command, never()).getExecutableCommand(); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + verify(sender, times(3)).sendMessage(captor.capture()); + assertThat(captor.getAllValues().get(0), containsString("Unknown command")); + assertThat(captor.getAllValues().get(1), containsString("Did you mean")); + assertThat(captor.getAllValues().get(1), containsString("/test_cmd")); + assertThat(captor.getAllValues().get(2), containsString("Use the command")); + assertThat(captor.getAllValues().get(2), containsString("to view help")); + } + + @Test + public void shouldNotCallExecutableForUnknownLabelAndNotSuggestCommand() { + // given + String bukkitLabel = "unreg"; + String[] bukkitArgs = {"testPlayer"}; + CommandSender sender = mock(CommandSender.class); + CommandDescription command = mock(CommandDescription.class); + given(command.getLabels()).willReturn(Collections.singletonList("test_cmd")); + given(serviceMock.mapPartsToCommand(any(CommandSender.class), anyListOf(String.class))).willReturn( + new FoundCommandResult(command, asList("unreg"), asList("testPlayer"), 1.0, UNKNOWN_LABEL)); + + // when + handler.processCommand(sender, bukkitLabel, bukkitArgs); + + // then + verify(serviceMock).mapPartsToCommand(eq(sender), captor.capture()); + assertThat(captor.getValue(), contains("unreg", "testPlayer")); + + verify(command, never()).getExecutableCommand(); + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + verify(sender, times(2)).sendMessage(captor.capture()); + assertThat(captor.getAllValues().get(0), containsString("Unknown command")); + assertThat(captor.getAllValues().get(1), containsString("Use the command")); + assertThat(captor.getAllValues().get(1), containsString("to view help")); + } + @Test public void shouldStripWhitespace() { // given diff --git a/src/test/java/fr/xephi/authme/command/CommandMapperTest.java b/src/test/java/fr/xephi/authme/command/CommandMapperTest.java index a7d233050..8da420431 100644 --- a/src/test/java/fr/xephi/authme/command/CommandMapperTest.java +++ b/src/test/java/fr/xephi/authme/command/CommandMapperTest.java @@ -254,4 +254,23 @@ public class CommandMapperTest { assertThat(result.getDifference(), equalTo(0.0)); } + @Test + public void shouldRecognizeMissingPermissionForCommand() { + // given + List parts = Arrays.asList("authme", "login", "test1"); + CommandSender sender = mock(CommandSender.class); + given(permissionsManagerMock.hasPermission(eq(sender), any(CommandDescription.class))).willReturn(false); + + // when + FoundCommandResult result = mapper.mapPartsToCommand(sender, parts); + + // then + assertThat(result.getCommandDescription(), equalTo(getCommandWithLabel(commands, "authme", "login"))); + assertThat(result.getResultStatus(), equalTo(FoundResultStatus.NO_PERMISSION)); + assertThat(result.getArguments(), contains("test1")); + assertThat(result.getDifference(), equalTo(0.0)); + assertThat(result.getLabels(), equalTo(parts.subList(0, 2))); + assertThat(result.getArguments(), contains(parts.get(2))); + } + } diff --git a/src/test/java/fr/xephi/authme/command/executable/captcha/CaptchaCommandTest.java b/src/test/java/fr/xephi/authme/command/executable/captcha/CaptchaCommandTest.java index 785b0b003..c33b13ef3 100644 --- a/src/test/java/fr/xephi/authme/command/executable/captcha/CaptchaCommandTest.java +++ b/src/test/java/fr/xephi/authme/command/executable/captcha/CaptchaCommandTest.java @@ -11,7 +11,6 @@ import org.bukkit.command.BlockCommandSender; import org.bukkit.command.CommandSender; import org.bukkit.entity.Player; import org.junit.Before; -import org.junit.Ignore; import org.junit.Test; import org.mockito.Mockito; From ac164c73b934e3ab5bf4852cc012170550ddd7ba Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sat, 9 Jan 2016 23:42:56 +0100 Subject: [PATCH 14/16] #347 Add missing properties (incomplete) --- .../authme/settings/custom/HooksSettings.java | 17 +++-- .../settings/custom/RestrictionSettings.java | 25 +++++++ .../settings/custom/SecuritySettings.java | 68 ++++++++++++++++--- .../xephi/authme/settings/domain/Comment.java | 2 +- 4 files changed, 94 insertions(+), 18 deletions(-) diff --git a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java index d838c33ad..f13e66055 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java @@ -2,7 +2,6 @@ package fr.xephi.authme.settings.custom; import fr.xephi.authme.settings.domain.Comment; import fr.xephi.authme.settings.domain.Property; -import fr.xephi.authme.settings.domain.PropertyType; import fr.xephi.authme.settings.domain.SettingsClass; import static fr.xephi.authme.settings.domain.Property.newProperty; @@ -11,27 +10,31 @@ public class HooksSettings implements SettingsClass { @Comment("Do we need to hook with multiverse for spawn checking?") public static final Property MULTIVERSE = - newProperty(PropertyType.BOOLEAN, "Hooks.multiverse", true); + newProperty("Hooks.multiverse", true); @Comment("Do we need to hook with BungeeCord?") public static final Property BUNGEECORD = - newProperty(PropertyType.BOOLEAN, "Hooks.bungeecord", false); + newProperty("Hooks.bungeecord", false); @Comment("Send player to this BungeeCord server after register/login") public static final Property BUNGEECORD_SERVER = - newProperty(PropertyType.STRING, "Hooks.sendPlayerTo", ""); + newProperty("Hooks.sendPlayerTo", ""); @Comment("Do we need to disable Essentials SocialSpy on join?") public static final Property DISABLE_SOCIAL_SPY = - newProperty(PropertyType.BOOLEAN, "Hooks.disableSocialSpy", false); + newProperty("Hooks.disableSocialSpy", false); @Comment("Do we need to force /motd Essentials command on join?") public static final Property USE_ESSENTIALS_MOTD = - newProperty(PropertyType.BOOLEAN, "Hooks.useEssentialsMotd", false); + newProperty("Hooks.useEssentialsMotd", false); @Comment("Do we need to cache custom Attributes?") public static final Property CACHE_CUSTOM_ATTRIBUTES = - newProperty(PropertyType.BOOLEAN, "Hooks.customAttributes", false); + newProperty("Hooks.customAttributes", false); + + @Comment("These features are only available on VeryGames Server Provider") + public static final Property ENABLE_VERYGAMES_IP_CHECK = + newProperty("VeryGames.enableIpCheck", false); private HooksSettings() { } diff --git a/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java b/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java index f5fa9c061..e34a2c2fe 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java @@ -141,6 +141,31 @@ public class RestrictionSettings implements SettingsClass { public static final Property BAN_UNKNOWN_IP = newProperty("settings.restrictions.banUnsafedIP", false); + @Comment("Spawn priority; values: authme, essentials, multiverse, default") + public static final Property SPAWN_PRIORITY = + newProperty("settings.restrictions.spawnPriority", "authme,essentials,multiverse,default"); + + @Comment("Maximum Login authorized by IP") + public static final Property MAX_LOGIN_PER_IP = + newProperty("settings.restrictions.maxLoginPerIp", 0); + + @Comment("Maximum Join authorized by IP") + public static final Property MAX_JOIN_PER_IP = + newProperty("settings.restrictions.maxJoinPerIp", 0); + + @Comment("AuthMe will NEVER teleport players if set to true!") + public static final Property NO_TELEPORT = + newProperty("settings.restrictions.noTeleport", false); + + @Comment("Regex syntax for allowed chars in passwords") + public static final Property ALLOWED_PASSWORD_CHARS = + newProperty("settings.restrictions.allowedPasswordCharacters", "[\\x21-\\x7E]*"); + + @Comment("Force survival gamemode when player joins?") + public static final Property FORCE_SURVIVAL_MODE = + newProperty("settings.GameMode.ForceSurvivalMode", false); + + private RestrictionSettings() { } diff --git a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java index 1605c166f..dcb44b73e 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java @@ -1,12 +1,14 @@ package fr.xephi.authme.settings.custom; +import fr.xephi.authme.security.HashAlgorithm; import fr.xephi.authme.settings.domain.Comment; import fr.xephi.authme.settings.domain.Property; import fr.xephi.authme.settings.domain.SettingsClass; +import java.util.List; + import static fr.xephi.authme.settings.domain.Property.newProperty; -import static fr.xephi.authme.settings.domain.PropertyType.BOOLEAN; -import static fr.xephi.authme.settings.domain.PropertyType.INTEGER; +import static fr.xephi.authme.settings.domain.PropertyType.STRING_LIST; public class SecuritySettings implements SettingsClass { @@ -14,36 +16,82 @@ public class SecuritySettings implements SettingsClass { "Take care with this, if you set this to false,", "AuthMe will automatically disable and the server won't be protected!"}) public static final Property STOP_SERVER_ON_PROBLEM = - newProperty(BOOLEAN, "Security.SQLProblem.stopServer", true); + newProperty("Security.SQLProblem.stopServer", true); @Comment("/reload support") public static final Property USE_RELOAD_COMMAND_SUPPORT = - newProperty(BOOLEAN, "Security.ReloadCommand.useReloadCommandSupport", true); + newProperty("Security.ReloadCommand.useReloadCommandSupport", true); @Comment("Remove spam from console?") public static final Property REMOVE_SPAM_FROM_CONSOLE = - newProperty(BOOLEAN, "Security.console.noConsoleSpam", false); + newProperty("Security.console.noConsoleSpam", false); @Comment("Remove passwords from console?") public static final Property REMOVE_PASSWORD_FROM_CONSOLE = - newProperty(BOOLEAN, "Security.console.removePassword", true); + newProperty("Security.console.removePassword", true); @Comment("Player need to put a captcha when he fails too lot the password") public static final Property USE_CAPTCHA = - newProperty(BOOLEAN, "Security.captcha.useCaptcha", false); + newProperty("Security.captcha.useCaptcha", false); @Comment("Max allowed tries before request a captcha") public static final Property MAX_LOGIN_TRIES_BEFORE_CAPTCHA = - newProperty(INTEGER, "Security.captcha.maxLoginTry", 5); + newProperty("Security.captcha.maxLoginTry", 5); @Comment("Captcha length") public static final Property CAPTCHA_LENGTH = - newProperty(INTEGER, "Security.captcha.captchaLength", 5); + newProperty("Security.captcha.captchaLength", 5); @Comment({"Kick players before stopping the server, that allow us to save position of players", "and all needed information correctly without any corruption."}) public static final Property KICK_PLAYERS_BEFORE_STOPPING = - newProperty(BOOLEAN, "Security.stop.kickPlayersBeforeStopping", true); + newProperty("Security.stop.kickPlayersBeforeStopping", true); + + @Comment("Minimum length of password") + public static final Property MIN_PASSWORD_LENGTH = + newProperty("settings.security.minPasswordLength", 5); + + @Comment({ + "This is a very important option: every time a player joins the server,", + "if they are registered, AuthMe will switch him to unLoggedInGroup.", + "This should prevent all major exploits.", + "You can set up your permission plugin with this special group to have no permissions,", + "or only permission to chat (or permission to send private messages etc.).", + "The better way is to set up this group with few permissions, so if a player", + "tries to exploit an account they can do only what you've defined for the group.", + "After, a logged in player will be moved to his correct permissions group!", + "Please note that the group name is case-sensitive, so 'admin' is different from 'Admin'", + "Otherwise your group will be wiped and the player will join in the default group []!", + "Example unLoggedinGroup: NotLogged" + }) + public static final Property UNLOGGEDIN_GROUP = + newProperty("settings.security.unLoggedinGroup", "unLoggedinGroup"); + + @Comment({ + "Possible values: MD5, SHA1, SHA256, WHIRLPOOL, XAUTH, MD5VB, PHPBB,", + "MYBB, IPB3, PHPFUSION, SMF, XENFORO, SALTED2MD5, JOOMLA, BCRYPT, WBB3, SHA512,", + "DOUBLEMD5, PBKDF2, PBKDF2DJANGO, WORDPRESS, ROYALAUTH, CUSTOM (for developers only)" + }) + public static final Property PASSWORD_HASH = + newProperty(HashAlgorithm.class, "settings.security.passwordHash", HashAlgorithm.SHA256); + + @Comment("Salt length for the SALTED2MD5 MD5(MD5(password)+salt)") + public static final Property DOUBLE_MD5_SALT_LENGTH = + newProperty("settings.security.doubleMD5SaltLength", 8); + + @Comment({"If password checking return false, do we need to check with all", + "other password algorithm to check an old password?", + "AuthMe will update the password to the new password hash"}) + public static final Property SUPPORT_OLD_PASSWORD_HASH = + newProperty("settings.security.supportOldPasswordHash", false); + + @Comment({"Prevent unsafe passwords from being used; put them in lowercase!", + "unsafePasswords:", + "- '123456'", + "- 'password'"}) + public static final Property> UNSAFE_PASSWORDS = + newProperty(STRING_LIST, "settings.security.unsafePasswords", + "123456", "password", "qwerty", "12345", "54321"); private SecuritySettings() { } diff --git a/src/main/java/fr/xephi/authme/settings/domain/Comment.java b/src/main/java/fr/xephi/authme/settings/domain/Comment.java index 92713aeec..07f20e257 100644 --- a/src/main/java/fr/xephi/authme/settings/domain/Comment.java +++ b/src/main/java/fr/xephi/authme/settings/domain/Comment.java @@ -12,6 +12,6 @@ import java.lang.annotation.Target; @Target(ElementType.FIELD) public @interface Comment { - String[] value() default ""; + String[] value(); } From fb6cff2e073a043ea06bb3219f8c9e1dd83ab81e Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sun, 17 Jan 2016 09:23:01 +0100 Subject: [PATCH 15/16] #347 Add remaining missing properties --- .../settings/custom/BackupSettings.java | 29 +++++ .../settings/custom/DatabaseSettings.java | 46 ++++---- .../authme/settings/custom/HooksSettings.java | 30 ++++++ .../settings/custom/PluginSettings.java | 14 +++ .../settings/custom/RegistrationSettings.java | 101 ++++++++++++++++++ .../settings/custom/RestrictionSettings.java | 12 +++ .../custom/SettingsFieldRetriever.java | 7 +- src/main/resources/config.yml | 2 +- .../custom/ConfigFileConsistencyTest.java | 18 +++- .../custom/SettingsClassConsistencyTest.java | 13 +++ 10 files changed, 241 insertions(+), 31 deletions(-) create mode 100644 src/main/java/fr/xephi/authme/settings/custom/BackupSettings.java create mode 100644 src/main/java/fr/xephi/authme/settings/custom/RegistrationSettings.java diff --git a/src/main/java/fr/xephi/authme/settings/custom/BackupSettings.java b/src/main/java/fr/xephi/authme/settings/custom/BackupSettings.java new file mode 100644 index 000000000..f2e78931b --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/BackupSettings.java @@ -0,0 +1,29 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.SettingsClass; + +import static fr.xephi.authme.settings.domain.Property.newProperty; + +public class BackupSettings implements SettingsClass { + + @Comment("Enable or disable automatic backup") + public static final Property ENABLED = + newProperty("BackupSystem.ActivateBackup", false); + + @Comment("Set backup at every start of server") + public static final Property ON_SERVER_START = + newProperty("BackupSystem.OnServerStart", false); + + @Comment("Set backup at every stop of server") + public static final Property ON_SERVER_STOP = + newProperty("BackupSystem.OnServerStop", true); + + @Comment(" Windows only mysql installation Path") + public static final Property MYSQL_WINDOWS_PATH = + newProperty("BackupSystem.MysqlWindowsPath", "C:\\Program Files\\MySQL\\MySQL Server 5.1\\"); + + private BackupSettings() { + } +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java index 582e5d6eb..84f0b7085 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/DatabaseSettings.java @@ -6,8 +6,6 @@ import fr.xephi.authme.settings.domain.Property; import fr.xephi.authme.settings.domain.SettingsClass; import static fr.xephi.authme.settings.domain.Property.newProperty; -import static fr.xephi.authme.settings.domain.PropertyType.BOOLEAN; -import static fr.xephi.authme.settings.domain.PropertyType.STRING; public class DatabaseSettings implements SettingsClass { @@ -18,91 +16,91 @@ public class DatabaseSettings implements SettingsClass { @Comment("Enable database caching, should improve database performance") public static final Property USE_CACHING = - newProperty(BOOLEAN, "DataSource.caching", true); + newProperty("DataSource.caching", true); @Comment("Database host address") public static final Property MYSQL_HOST = - newProperty(STRING, "DataSource.mySQLHost", "127.0.0.1"); + newProperty("DataSource.mySQLHost", "127.0.0.1"); @Comment("Database port") public static final Property MYSQL_PORT = - newProperty(STRING, "DataSource.mySQLPort", "3306"); + newProperty("DataSource.mySQLPort", "3306"); @Comment("Username about Database Connection Infos") public static final Property MYSQL_USERNAME = - newProperty(STRING, "DataSource.mySQLUsername", "authme"); + newProperty("DataSource.mySQLUsername", "authme"); @Comment("Password about Database Connection Infos") public static final Property MYSQL_PASSWORD = - newProperty(STRING, "DataSource.mySQLPassword", "123456"); + newProperty("DataSource.mySQLPassword", "123456"); @Comment("Database Name, use with converters or as SQLITE database name") public static final Property MYSQL_DATABASE = - newProperty(STRING, "DataSource.mySQLDatabase", "authme"); + newProperty("DataSource.mySQLDatabase", "authme"); @Comment("Table of the database") public static final Property MYSQL_TABLE = - newProperty(STRING, "DataSource.mySQLTablename", "authme"); + newProperty("DataSource.mySQLTablename", "authme"); @Comment("Column of IDs to sort data") public static final Property MYSQL_COL_ID = - newProperty(STRING, "DataSource.mySQLColumnId", "id"); + newProperty("DataSource.mySQLColumnId", "id"); @Comment("Column for storing or checking players nickname") public static final Property MYSQL_COL_NAME = - newProperty(STRING, "DataSource.mySQLColumnName", "username"); + newProperty("DataSource.mySQLColumnName", "username"); @Comment("Column for storing or checking players RealName ") public static final Property MYSQL_COL_REALNAME = - newProperty(STRING, "DataSource.mySQLRealName", "realname"); + newProperty("DataSource.mySQLRealName", "realname"); @Comment("Column for storing players passwords") public static final Property MYSQL_COL_PASSWORD = - newProperty(STRING, "DataSource.mySQLColumnPassword", "password"); + newProperty("DataSource.mySQLColumnPassword", "password"); @Comment("Column for storing players passwords salts") public static final Property MYSQL_COL_SALT = - newProperty(STRING, "ExternalBoardOptions.mySQLColumnSalt", ""); + newProperty("ExternalBoardOptions.mySQLColumnSalt", ""); @Comment("Column for storing players emails") public static final Property MYSQL_COL_EMAIL = - newProperty(STRING, "DataSource.mySQLColumnEmail", "email"); + newProperty("DataSource.mySQLColumnEmail", "email"); @Comment("Column for storing if a player is logged in or not") public static final Property MYSQL_COL_ISLOGGED = - newProperty(STRING, "DataSource.mySQLColumnLogged", "isLogged"); + newProperty("DataSource.mySQLColumnLogged", "isLogged"); @Comment("Column for storing players ips") public static final Property MYSQL_COL_IP = - newProperty(STRING, "DataSource.mySQLColumnIp", "ip"); + newProperty("DataSource.mySQLColumnIp", "ip"); @Comment("Column for storing players lastlogins") public static final Property MYSQL_COL_LASTLOGIN = - newProperty(STRING, "DataSource.mySQLColumnLastLogin", "lastlogin"); + newProperty("DataSource.mySQLColumnLastLogin", "lastlogin"); @Comment("Column for storing player LastLocation - X") public static final Property MYSQL_COL_LASTLOC_X = - newProperty(STRING, "DataSource.mySQLlastlocX", "x"); + newProperty("DataSource.mySQLlastlocX", "x"); @Comment("Column for storing player LastLocation - Y") public static final Property MYSQL_COL_LASTLOC_Y = - newProperty(STRING, "DataSource.mySQLlastlocY", "y"); + newProperty("DataSource.mySQLlastlocY", "y"); @Comment("Column for storing player LastLocation - Z") public static final Property MYSQL_COL_LASTLOC_Z = - newProperty(STRING, "DataSource.mySQLlastlocZ", "z"); + newProperty("DataSource.mySQLlastlocZ", "z"); @Comment("Column for storing player LastLocation - World Name") public static final Property MYSQL_COL_LASTLOC_WORLD = - newProperty(STRING, "DataSource.mySQLlastlocWorld", "world"); + newProperty("DataSource.mySQLlastlocWorld", "world"); @Comment("Column for storing players groups") public static final Property MYSQL_COL_GROUP = - newProperty(STRING, "ExternalBoardOptions.mySQLColumnGroup", ""); + newProperty("ExternalBoardOptions.mySQLColumnGroup", ""); @Comment("Enable this when you allow registration through a website") public static final Property MYSQL_WEBSITE = - newProperty(BOOLEAN, "DataSource.mySQLWebsite", false); + newProperty("DataSource.mySQLWebsite", false); private DatabaseSettings() { } diff --git a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java index f13e66055..af0458ac4 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/HooksSettings.java @@ -2,8 +2,11 @@ package fr.xephi.authme.settings.custom; import fr.xephi.authme.settings.domain.Comment; import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.PropertyType; import fr.xephi.authme.settings.domain.SettingsClass; +import java.util.List; + import static fr.xephi.authme.settings.domain.Property.newProperty; public class HooksSettings implements SettingsClass { @@ -36,6 +39,33 @@ public class HooksSettings implements SettingsClass { public static final Property ENABLE_VERYGAMES_IP_CHECK = newProperty("VeryGames.enableIpCheck", false); + @Comment({ + "-1 means disabled. If you want that only activated players", + "can log into your server, you can set here the group number", + "of unactivated users, needed for some forum/CMS support"}) + public static final Property NON_ACTIVATED_USERS_GROUP = + newProperty("ExternalBoardOptions.nonActivedUserGroup", -1); + + @Comment("Other MySQL columns where we need to put the username (case-sensitive)") + public static final Property> MYSQL_OTHER_USERNAME_COLS = + newProperty(PropertyType.STRING_LIST, "ExternalBoardOptions.mySQLOtherUsernameColumns"); + + @Comment("How much log2 rounds needed in BCrypt (do not change if you do not know what it does)") + public static final Property BCRYPT_LOG2_ROUND = + newProperty("ExternalBoardOptions.bCryptLog2Round", 10); + + @Comment("phpBB table prefix defined during the phpBB installation process") + public static final Property PHPBB_TABLE_PREFIX = + newProperty("ExternalBoardOptions.phpbbTablePrefix", "phpbb_"); + + @Comment("phpBB activated group ID; 2 is the default registered group defined by phpBB") + public static final Property PHPBB_ACTIVATED_GROUP_ID = + newProperty("ExternalBoardOptions.phpbbActivatedGroupId", 2); + + @Comment("Wordpress prefix defined during WordPress installation") + public static final Property WORDPRESS_TABLE_PREFIX = + newProperty("ExternalBoardOptions.wordpressTablePrefix", "wp_"); + private HooksSettings() { } diff --git a/src/main/java/fr/xephi/authme/settings/custom/PluginSettings.java b/src/main/java/fr/xephi/authme/settings/custom/PluginSettings.java index 9778d04e4..e35076db2 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/PluginSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/PluginSettings.java @@ -40,6 +40,20 @@ public class PluginSettings implements SettingsClass { public static final Property SESSIONS_EXPIRE_ON_IP_CHANGE = newProperty("settings.sessions.sessionExpireOnIpChange", true); + @Comment("Message language, available: en, de, br, cz, pl, fr, ru, hu, sk, es, zhtw, fi, zhcn, lt, it, ko, pt") + public static final Property MESSAGES_LANGUAGE = + newProperty("settings.messagesLanguage", "en"); + + @Comment({ + "Take care with this option; if you don't want", + "to use Vault and group switching of AuthMe", + "for unloggedIn players, set this setting to true.", + "Default is false." + }) + public static final Property ENABLE_PERMISSION_CHECK = + newProperty("permission.EnablePermissionCheck", false); + + private PluginSettings() { } diff --git a/src/main/java/fr/xephi/authme/settings/custom/RegistrationSettings.java b/src/main/java/fr/xephi/authme/settings/custom/RegistrationSettings.java new file mode 100644 index 000000000..7e8301456 --- /dev/null +++ b/src/main/java/fr/xephi/authme/settings/custom/RegistrationSettings.java @@ -0,0 +1,101 @@ +package fr.xephi.authme.settings.custom; + +import fr.xephi.authme.settings.domain.Comment; +import fr.xephi.authme.settings.domain.Property; +import fr.xephi.authme.settings.domain.PropertyType; +import fr.xephi.authme.settings.domain.SettingsClass; + +import java.util.List; + +import static fr.xephi.authme.settings.domain.Property.newProperty; + +public class RegistrationSettings implements SettingsClass { + + @Comment("Enable registration on the server?") + public static final Property IS_ENABLED = + newProperty("settings.registration.enabled", true); + + @Comment({ + "Send every X seconds a message to a player to", + "remind him that he has to login/register"}) + public static final Property MESSAGE_INTERVAL = + newProperty("settings.registration.messageInterval", 5); + + @Comment({ + "Only registered and logged in players can play.", + "See restrictions for exceptions"}) + public static final Property FORCE = + newProperty("settings.registration.force", true); + + @Comment("Do we replace password registration by an email registration method?") + public static final Property USE_EMAIL_REGISTRATION = + newProperty("settings.registration.enableEmailRegistrationSystem", false); + + @Comment({ + "Enable double check of email when you register", + "when it's true, registration requires that kind of command:", + "/register "}) + public static final Property ENABLE_CONFIRM_EMAIL = + newProperty("settings.registration.doubleEmailCheck", false); + + @Comment({ + "Do we force kicking player after a successful registration?", + "Do not use with login feature below"}) + public static final Property FORCE_KICK_AFTER_REGISTER = + newProperty("settings.registration.forceKickAfterRegister", false); + + @Comment("Does AuthMe need to enforce a /login after a successful registration?") + public static final Property FORCE_LOGIN_AFTER_REGISTER = + newProperty("settings.registration.forceLoginAfterRegister", false); + + @Comment("Force these commands after /login, without any '/', use %p to replace with player name") + public static final Property> FORCE_COMMANDS = + newProperty(PropertyType.STRING_LIST, "settings.forceCommands"); + + @Comment("Force these commands after /login as service console, without any '/'. " + + "Use %p to replace with player name") + public static final Property> FORCE_COMMANDS_AS_CONSOLE = + newProperty(PropertyType.STRING_LIST, "settings.forceCommandsAsConsole"); + + @Comment("Force these commands after /register, without any '/', use %p to replace with player name") + public static final Property> FORCE_REGISTER_COMMANDS = + newProperty(PropertyType.STRING_LIST, "settings.forceRegisterCommands"); + + @Comment("Force these commands after /register as a server console, without any '/'. " + + "Use %p to replace with player name") + public static final Property> FORCE_REGISTER_COMMANDS_AS_CONSOLE = + newProperty(PropertyType.STRING_LIST, "settings.forceRegisterCommandsAsConsole"); + + @Comment({ + "Enable to display the welcome message (welcome.txt) after a registration or a login", + "You can use colors in this welcome.txt + some replaced strings:", + "{PLAYER}: player name, {ONLINE}: display number of online players, {MAXPLAYERS}: display server slots,", + "{IP}: player ip, {LOGINS}: number of players logged, {WORLD}: player current world, {SERVER}: server name", + "{VERSION}: get current bukkit version, {COUNTRY}: player country"}) + public static final Property USE_WELCOME_MESSAGE = + newProperty("settings.useWelcomeMessage", true); + + @Comment("Do we need to broadcast the welcome message to all server or only to the player? set true for " + + "server or false for player") + public static final Property BROADCAST_WELCOME_MESSAGE = + newProperty("settings.broadcastWelcomeMessage", false); + + @Comment("Do we need to delay the join/leave message to be displayed only when the player is authenticated?") + public static final Property DELAY_JOIN_LEAVE_MESSAGES = + newProperty("settings.delayJoinLeaveMessages", true); + + @Comment("Do we need to add potion effect Blinding before login/reigster?") + public static final Property APPLY_BLIND_EFFECT = + newProperty("settings.applyBlindEffect", false); + + @Comment({ + "Do we need to prevent people to login with another case?", + "If Xephi is registered, then Xephi can login, but not XEPHI/xephi/XePhI"}) + public static final Property PREVENT_OTHER_CASE = + newProperty("settings.preventOtherCase", false); + + + private RegistrationSettings() { + } + +} diff --git a/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java b/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java index e34a2c2fe..651c7833d 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java @@ -165,6 +165,18 @@ public class RestrictionSettings implements SettingsClass { public static final Property FORCE_SURVIVAL_MODE = newProperty("settings.GameMode.ForceSurvivalMode", false); + @Comment({ + "Below you can list all account names that", + "AuthMe will ignore for registration or login, configure it", + "at your own risk!! Remember that if you are going to add", + "nickname with [], you have to delimit name with ' '.", + "this option add compatibility with BuildCraft and some", + "other mods.", + "It is case-sensitive!" + }) + public static final Property> UNRESTRICTED_NAMES = + newProperty(PropertyType.STRING_LIST, "settings.unrestrictions.UnrestrictedName"); + private RestrictionSettings() { } diff --git a/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java b/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java index f5c7f23d8..74b722e8f 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java +++ b/src/main/java/fr/xephi/authme/settings/custom/SettingsFieldRetriever.java @@ -18,9 +18,10 @@ final class SettingsFieldRetriever { /** The classes to scan for properties. */ private static final List> CONFIGURATION_CLASSES = Arrays.asList( - ConverterSettings.class, PluginSettings.class, RestrictionSettings.class, - DatabaseSettings.class, EmailSettings.class, HooksSettings.class, - ProtectionSettings.class, PurgeSettings.class, SecuritySettings.class); + ConverterSettings.class, PluginSettings.class, RestrictionSettings.class, + DatabaseSettings.class, EmailSettings.class, HooksSettings.class, + ProtectionSettings.class, PurgeSettings.class, SecuritySettings.class, + RegistrationSettings.class, BackupSettings.class); private SettingsFieldRetriever() { } diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index 960cfc6ee..22dd7431c 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -209,7 +209,7 @@ settings: # Only registered and logged in players can play. # See restrictions for exceptions force: true - # Does we replace password registration by an Email registration method? + # Do we replace password registration by an email registration method? enableEmailRegistrationSystem: false # Enable double check of email when you register # when it's true, registration require that kind of command: diff --git a/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java b/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java index eb12ab030..d012a50a4 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/ConfigFileConsistencyTest.java @@ -1,9 +1,11 @@ package fr.xephi.authme.settings.custom; +import fr.xephi.authme.ReflectionTestUtils; import fr.xephi.authme.settings.domain.Property; import fr.xephi.authme.settings.propertymap.PropertyMap; import fr.xephi.authme.util.StringUtils; import org.bukkit.configuration.MemorySection; +import org.bukkit.configuration.file.FileConfiguration; import org.bukkit.configuration.file.YamlConfiguration; import org.junit.Test; @@ -16,8 +18,6 @@ import java.util.List; import java.util.Map; import java.util.Set; -import static org.hamcrest.Matchers.equalTo; -import static org.junit.Assert.assertThat; import static org.junit.Assert.fail; /** @@ -40,7 +40,19 @@ public class ConfigFileConsistencyTest { boolean result = settings.containsAllSettings(SettingsFieldRetriever.getAllPropertyFields()); // then - assertThat(result, equalTo(true)); + if (!result) { + FileConfiguration configuration = + (FileConfiguration) ReflectionTestUtils.getFieldValue(NewSetting.class, settings, "configuration"); + + Set knownProperties = getAllKnownPropertyPaths(); + List missingProperties = new ArrayList<>(); + for (String path : knownProperties) { + if (!configuration.contains(path)) { + missingProperties.add(path); + } + } + fail("Found missing properties!\n-" + StringUtils.join("\n-", missingProperties)); + } } @Test diff --git a/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java b/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java index 6dab6bdfc..a6b67763a 100644 --- a/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java +++ b/src/test/java/fr/xephi/authme/settings/custom/SettingsClassConsistencyTest.java @@ -7,6 +7,7 @@ import org.junit.BeforeClass; import org.junit.Test; import java.io.File; +import java.lang.reflect.Constructor; import java.lang.reflect.Field; import java.lang.reflect.Modifier; import java.util.ArrayList; @@ -14,6 +15,7 @@ import java.util.HashSet; import java.util.List; import java.util.Set; +import static org.hamcrest.Matchers.arrayWithSize; import static org.hamcrest.Matchers.equalTo; import static org.junit.Assert.assertThat; import static org.junit.Assert.fail; @@ -82,6 +84,17 @@ public class SettingsClassConsistencyTest { } } + @Test + public void shouldHaveHiddenDefaultConstructorOnly() { + for (Class clazz : classes) { + Constructor[] constructors = clazz.getDeclaredConstructors(); + assertThat(clazz + " should only have one constructor", + constructors, arrayWithSize(1)); + assertThat("Constructor of " + clazz + " is private", + Modifier.isPrivate(constructors[0].getModifiers()), equalTo(true)); + } + } + private static boolean isValidConstantField(Field field) { int modifiers = field.getModifiers(); return Modifier.isPublic(modifiers) && Modifier.isStatic(modifiers) && Modifier.isFinal(modifiers); From e18be3024adbffc7ab9e6c497ee643f4b31b4ee0 Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sun, 17 Jan 2016 12:33:29 +0100 Subject: [PATCH 16/16] #347 Use NewSetting properties for change password command --- .../authme/ChangePasswordAdminCommand.java | 11 +++++----- .../authme/RegisterAdminCommand.java | 5 +++-- .../changepassword/ChangePasswordCommand.java | 12 ++++++----- .../fr/xephi/authme/settings/Settings.java | 3 ++- .../settings/custom/RestrictionSettings.java | 2 +- .../settings/custom/SecuritySettings.java | 4 ++++ src/main/resources/config.yml | 4 +++- .../ChangePasswordCommandTest.java | 20 ++++++++++--------- 8 files changed, 37 insertions(+), 24 deletions(-) diff --git a/src/main/java/fr/xephi/authme/command/executable/authme/ChangePasswordAdminCommand.java b/src/main/java/fr/xephi/authme/command/executable/authme/ChangePasswordAdminCommand.java index ec2b7d98d..a1b27f16f 100644 --- a/src/main/java/fr/xephi/authme/command/executable/authme/ChangePasswordAdminCommand.java +++ b/src/main/java/fr/xephi/authme/command/executable/authme/ChangePasswordAdminCommand.java @@ -8,7 +8,8 @@ import fr.xephi.authme.command.ExecutableCommand; import fr.xephi.authme.datasource.DataSource; import fr.xephi.authme.output.MessageKey; import fr.xephi.authme.security.crypts.HashedPassword; -import fr.xephi.authme.settings.Settings; +import fr.xephi.authme.settings.custom.RestrictionSettings; +import fr.xephi.authme.settings.custom.SecuritySettings; import org.bukkit.command.CommandSender; import java.util.List; @@ -27,7 +28,7 @@ public class ChangePasswordAdminCommand implements ExecutableCommand { // Validate the password String playerPassLowerCase = playerPass.toLowerCase(); - if (!playerPassLowerCase.matches(Settings.getPassRegex)) { + if (!playerPassLowerCase.matches(commandService.getProperty(RestrictionSettings.ALLOWED_PASSWORD_REGEX))) { commandService.send(sender, MessageKey.PASSWORD_MATCH_ERROR); return; } @@ -35,12 +36,12 @@ public class ChangePasswordAdminCommand implements ExecutableCommand { commandService.send(sender, MessageKey.PASSWORD_IS_USERNAME_ERROR); return; } - if (playerPassLowerCase.length() < Settings.getPasswordMinLen - || playerPassLowerCase.length() > Settings.passwordMaxLength) { + if (playerPassLowerCase.length() < commandService.getProperty(SecuritySettings.MIN_PASSWORD_LENGTH) + || playerPassLowerCase.length() > commandService.getProperty(SecuritySettings.MAX_PASSWORD_LENGTH)) { commandService.send(sender, MessageKey.INVALID_PASSWORD_LENGTH); return; } - if (!Settings.unsafePasswords.isEmpty() && Settings.unsafePasswords.contains(playerPassLowerCase)) { + if (commandService.getProperty(SecuritySettings.UNSAFE_PASSWORDS).contains(playerPassLowerCase)) { commandService.send(sender, MessageKey.PASSWORD_UNSAFE_ERROR); return; } diff --git a/src/main/java/fr/xephi/authme/command/executable/authme/RegisterAdminCommand.java b/src/main/java/fr/xephi/authme/command/executable/authme/RegisterAdminCommand.java index 46916b7b8..107f8c7ae 100644 --- a/src/main/java/fr/xephi/authme/command/executable/authme/RegisterAdminCommand.java +++ b/src/main/java/fr/xephi/authme/command/executable/authme/RegisterAdminCommand.java @@ -7,6 +7,7 @@ import fr.xephi.authme.command.ExecutableCommand; import fr.xephi.authme.output.MessageKey; import fr.xephi.authme.security.crypts.HashedPassword; import fr.xephi.authme.settings.Settings; +import fr.xephi.authme.settings.custom.SecuritySettings; import org.bukkit.Bukkit; import org.bukkit.command.CommandSender; @@ -35,8 +36,8 @@ public class RegisterAdminCommand implements ExecutableCommand { commandService.send(sender, MessageKey.PASSWORD_IS_USERNAME_ERROR); return; } - if (playerPassLowerCase.length() < Settings.getPasswordMinLen - || playerPassLowerCase.length() > Settings.passwordMaxLength) { + if (playerPassLowerCase.length() < commandService.getProperty(SecuritySettings.MIN_PASSWORD_LENGTH) + || playerPassLowerCase.length() > commandService.getProperty(SecuritySettings.MAX_PASSWORD_LENGTH)) { commandService.send(sender, MessageKey.INVALID_PASSWORD_LENGTH); return; } diff --git a/src/main/java/fr/xephi/authme/command/executable/changepassword/ChangePasswordCommand.java b/src/main/java/fr/xephi/authme/command/executable/changepassword/ChangePasswordCommand.java index 0d1cdc481..a3b7f4451 100644 --- a/src/main/java/fr/xephi/authme/command/executable/changepassword/ChangePasswordCommand.java +++ b/src/main/java/fr/xephi/authme/command/executable/changepassword/ChangePasswordCommand.java @@ -5,7 +5,8 @@ import fr.xephi.authme.cache.auth.PlayerCache; import fr.xephi.authme.command.CommandService; import fr.xephi.authme.command.PlayerCommand; import fr.xephi.authme.output.MessageKey; -import fr.xephi.authme.settings.Settings; +import fr.xephi.authme.settings.custom.RestrictionSettings; +import fr.xephi.authme.settings.custom.SecuritySettings; import fr.xephi.authme.task.ChangePasswordTask; import fr.xephi.authme.util.Wrapper; import org.bukkit.entity.Player; @@ -32,7 +33,7 @@ public class ChangePasswordCommand extends PlayerCommand { // Make sure the password is allowed String playerPassLowerCase = newPassword.toLowerCase(); - if (!playerPassLowerCase.matches(Settings.getPassRegex)) { + if (!playerPassLowerCase.matches(commandService.getProperty(RestrictionSettings.ALLOWED_PASSWORD_REGEX))) { commandService.send(player, MessageKey.PASSWORD_MATCH_ERROR); return; } @@ -40,17 +41,18 @@ public class ChangePasswordCommand extends PlayerCommand { commandService.send(player, MessageKey.PASSWORD_IS_USERNAME_ERROR); return; } - if (playerPassLowerCase.length() < Settings.getPasswordMinLen - || playerPassLowerCase.length() > Settings.passwordMaxLength) { + if (playerPassLowerCase.length() < commandService.getProperty(SecuritySettings.MIN_PASSWORD_LENGTH) + || playerPassLowerCase.length() > commandService.getProperty(SecuritySettings.MAX_PASSWORD_LENGTH)) { commandService.send(player, MessageKey.INVALID_PASSWORD_LENGTH); return; } - if (!Settings.unsafePasswords.isEmpty() && Settings.unsafePasswords.contains(playerPassLowerCase)) { + if (commandService.getProperty(SecuritySettings.UNSAFE_PASSWORDS).contains(playerPassLowerCase)) { commandService.send(player, MessageKey.PASSWORD_UNSAFE_ERROR); return; } AuthMe plugin = AuthMe.getInstance(); + // TODO ljacqu 20160117: Call async task via Management commandService.runTaskAsynchronously(new ChangePasswordTask(plugin, player, oldPassword, newPassword)); } } diff --git a/src/main/java/fr/xephi/authme/settings/Settings.java b/src/main/java/fr/xephi/authme/settings/Settings.java index 4adfe15bd..ebad00fa4 100644 --- a/src/main/java/fr/xephi/authme/settings/Settings.java +++ b/src/main/java/fr/xephi/authme/settings/Settings.java @@ -7,6 +7,7 @@ import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.datasource.DataSource; import fr.xephi.authme.datasource.DataSource.DataSourceType; import fr.xephi.authme.security.HashAlgorithm; +import fr.xephi.authme.util.StringUtils; import fr.xephi.authme.util.Wrapper; import org.bukkit.configuration.file.YamlConfiguration; @@ -311,7 +312,7 @@ public final class Settings { try { return Files.toString(EMAIL_FILE, Charsets.UTF_8); } catch (IOException e) { - ConsoleLogger.showError(e.getMessage()); + ConsoleLogger.showError("Error loading email text: " + StringUtils.formatException(e)); ConsoleLogger.writeStackTrace(e); return ""; } diff --git a/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java b/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java index 651c7833d..32b68586d 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/RestrictionSettings.java @@ -158,7 +158,7 @@ public class RestrictionSettings implements SettingsClass { newProperty("settings.restrictions.noTeleport", false); @Comment("Regex syntax for allowed chars in passwords") - public static final Property ALLOWED_PASSWORD_CHARS = + public static final Property ALLOWED_PASSWORD_REGEX = newProperty("settings.restrictions.allowedPasswordCharacters", "[\\x21-\\x7E]*"); @Comment("Force survival gamemode when player joins?") diff --git a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java index dcb44b73e..94e33258c 100644 --- a/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java +++ b/src/main/java/fr/xephi/authme/settings/custom/SecuritySettings.java @@ -51,6 +51,10 @@ public class SecuritySettings implements SettingsClass { public static final Property MIN_PASSWORD_LENGTH = newProperty("settings.security.minPasswordLength", 5); + @Comment("Maximum length of password") + public static final Property MAX_PASSWORD_LENGTH = + newProperty("settings.security.passwordMaxLength", 30); + @Comment({ "This is a very important option: every time a player joins the server,", "if they are registered, AuthMe will switch him to unLoggedInGroup.", diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index 22dd7431c..d2e0a9e74 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -156,8 +156,10 @@ settings: # ForceSurvivalMode to player when join ? ForceSurvivalMode: false security: - # minimum Length of password + # Minimum length of password minPasswordLength: 5 + # Maximum length of password + passwordMaxLength: 30 # this is very important options, # every time player join the server, # if they are registered, AuthMe will switch him diff --git a/src/test/java/fr/xephi/authme/command/executable/changepassword/ChangePasswordCommandTest.java b/src/test/java/fr/xephi/authme/command/executable/changepassword/ChangePasswordCommandTest.java index 380480ae6..d00a4e37d 100644 --- a/src/test/java/fr/xephi/authme/command/executable/changepassword/ChangePasswordCommandTest.java +++ b/src/test/java/fr/xephi/authme/command/executable/changepassword/ChangePasswordCommandTest.java @@ -4,7 +4,8 @@ import fr.xephi.authme.ReflectionTestUtils; import fr.xephi.authme.cache.auth.PlayerCache; import fr.xephi.authme.command.CommandService; import fr.xephi.authme.output.MessageKey; -import fr.xephi.authme.settings.Settings; +import fr.xephi.authme.settings.custom.RestrictionSettings; +import fr.xephi.authme.settings.custom.SecuritySettings; import fr.xephi.authme.task.ChangePasswordTask; import fr.xephi.authme.util.WrapperMock; import org.bukkit.Server; @@ -19,9 +20,9 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; -import static java.util.Arrays.asList; import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.Matchers.equalTo; +import static org.mockito.BDDMockito.given; import static org.mockito.Mockito.any; import static org.mockito.Mockito.eq; import static org.mockito.Mockito.mock; @@ -44,11 +45,11 @@ public class ChangePasswordCommandTest { cacheMock = wrapperMock.getPlayerCache(); commandService = mock(CommandService.class); + when(commandService.getProperty(SecuritySettings.MIN_PASSWORD_LENGTH)).thenReturn(2); + when(commandService.getProperty(SecuritySettings.MAX_PASSWORD_LENGTH)).thenReturn(50); // Only allow passwords with alphanumerical characters for the test - Settings.getPassRegex = "[a-zA-Z0-9]+"; - Settings.getPasswordMinLen = 2; - Settings.passwordMaxLength = 50; - Settings.unsafePasswords = Collections.EMPTY_LIST; + when(commandService.getProperty(RestrictionSettings.ALLOWED_PASSWORD_REGEX)).thenReturn("[a-zA-Z0-9]+"); + when(commandService.getProperty(SecuritySettings.UNSAFE_PASSWORDS)).thenReturn(Collections.EMPTY_LIST); } @Test @@ -112,7 +113,7 @@ public class ChangePasswordCommandTest { // given CommandSender sender = initPlayerWithName("abc12", true); ChangePasswordCommand command = new ChangePasswordCommand(); - Settings.passwordMaxLength = 3; + given(commandService.getProperty(SecuritySettings.MAX_PASSWORD_LENGTH)).willReturn(3); // when command.executeCommand(sender, Arrays.asList("12", "test"), commandService); @@ -127,7 +128,7 @@ public class ChangePasswordCommandTest { // given CommandSender sender = initPlayerWithName("abc12", true); ChangePasswordCommand command = new ChangePasswordCommand(); - Settings.getPasswordMinLen = 7; + given(commandService.getProperty(SecuritySettings.MIN_PASSWORD_LENGTH)).willReturn(7); // when command.executeCommand(sender, Arrays.asList("oldverylongpassword", "tester"), commandService); @@ -142,7 +143,8 @@ public class ChangePasswordCommandTest { // given CommandSender sender = initPlayerWithName("player", true); ChangePasswordCommand command = new ChangePasswordCommand(); - Settings.unsafePasswords = asList("test", "abc123"); + given(commandService.getProperty(SecuritySettings.UNSAFE_PASSWORDS)) + .willReturn(Arrays.asList("test", "abc123")); // when command.executeCommand(sender, Arrays.asList("oldpw", "abc123"), commandService);