Merge branches '642-kick-on-fast-commands' and 'master' of https://github.com/AuthMe/AuthMeReloaded into 642-kick-on-fast-commands

src/main/java/fr/xephi/authme/command/executable/authme/RegisterAdminCommand.java

@@ -74,7 +74,7 @@ public class RegisterAdminCommand implements ExecutableCommand {
             final Player player = bukkitService.getPlayerExact(playerName);
             if (player != null) {
                 bukkitService.scheduleSyncTaskFromOptionallyAsyncTask(() ->
-                    player.kickPlayer(commonService.retrieveSingleMessage(MessageKey.KICK_FOR_ADMIN_REGISTER)));
+                    player.kickPlayer(commonService.retrieveSingleMessage(player, MessageKey.KICK_FOR_ADMIN_REGISTER)));
             }
         });
     }

src/main/java/fr/xephi/authme/command/executable/authme/debug/MySqlDefaultChanger.java

@@ -172,6 +172,11 @@ class MySqlDefaultChanger implements DebugSection {
             + sender.getName() + "'");
     }
 
+    /**
+     * Outputs the current definitions of all {@link Columns} which can be migrated.
+     *
+     * @param sender command sender to output the data to
+     */
     private void showColumnDetails(CommandSender sender) {
         sender.sendMessage(ChatColor.BLUE + "MySQL column details");
         final String tableName = settings.getProperty(DatabaseSettings.MYSQL_TABLE);

src/main/java/fr/xephi/authme/data/TempbanManager.java

@@ -97,7 +97,7 @@ public class TempbanManager implements SettingsDependent, HasCleanup {
         if (isEnabled) {
             final String name = player.getName();
             final String ip = PlayerUtils.getPlayerIp(player);
-            final String reason = messages.retrieveSingle(MessageKey.TEMPBAN_MAX_LOGINS);
+            final String reason = messages.retrieveSingle(player, MessageKey.TEMPBAN_MAX_LOGINS);
 
             final Date expires = new Date();
             long newTime = expires.getTime() + (length * MILLIS_PER_MINUTE);

src/main/java/fr/xephi/authme/data/limbo/LimboPlayerTaskManager.java

@@ -49,9 +49,9 @@ class LimboPlayerTaskManager {
      */
     void registerMessageTask(Player player, LimboPlayer limbo, boolean isRegistered) {
         int interval = settings.getProperty(RegistrationSettings.MESSAGE_INTERVAL);
-        MessageResult messageResult = getMessageKey(player.getName(), isRegistered);
+        MessageResult result = getMessageKey(player.getName(), isRegistered);
         if (interval > 0) {
-            String[] joinMessage = messages.retrieveSingle(messageResult.messageKey, messageResult.args).split("\n");
+            String[] joinMessage = messages.retrieveSingle(player, result.messageKey, result.args).split("\n");
             MessageTask messageTask = new MessageTask(player, joinMessage);
             bukkitService.runTaskTimer(messageTask, 2 * TICKS_PER_SECOND, interval * TICKS_PER_SECOND);
             limbo.setMessageTask(messageTask);
@@ -67,7 +67,7 @@ class LimboPlayerTaskManager {
     void registerTimeoutTask(Player player, LimboPlayer limbo) {
         final int timeout = settings.getProperty(RestrictionSettings.TIMEOUT) * TICKS_PER_SECOND;
         if (timeout > 0) {
-            String message = messages.retrieveSingle(MessageKey.LOGIN_TIMEOUT_ERROR);
+            String message = messages.retrieveSingle(player, MessageKey.LOGIN_TIMEOUT_ERROR);
             BukkitTask task = bukkitService.runTaskLater(new TimeoutTask(player, message, playerCache), timeout);
             limbo.setTimeoutTask(task);
         }

src/main/java/fr/xephi/authme/datasource/MySQL.java

@@ -28,6 +28,10 @@ import java.util.Set;
 import static fr.xephi.authme.datasource.SqlDataSourceUtils.getNullableLong;
 import static fr.xephi.authme.datasource.SqlDataSourceUtils.logSqlException;
 
+/**
+ * MySQL data source.
+ */
+@SuppressWarnings({"checkstyle:AbbreviationAsWordInName"}) // Justification: Class name cannot be changed anymore
 public class MySQL implements DataSource {
 
     private boolean useSsl;
@@ -728,6 +732,13 @@ public class MySQL implements DataSource {
         return players;
     }
 
+    /**
+     * Creates a {@link PlayerAuth} object with the data from the provided result set.
+     *
+     * @param row the result set to read from
+     * @return generated player auth object with the data from the result set
+     * @throws SQLException .
+     */
     private PlayerAuth buildAuthFromResultSet(ResultSet row) throws SQLException {
         String salt = col.SALT.isEmpty() ? null : row.getString(col.SALT);
         int group = col.GROUP.isEmpty() ? -1 : row.getInt(col.GROUP);

src/main/java/fr/xephi/authme/datasource/SQLite.java

@@ -28,6 +28,7 @@ import static fr.xephi.authme.datasource.SqlDataSourceUtils.logSqlException;
 /**
  * SQLite data source.
  */
+@SuppressWarnings({"checkstyle:AbbreviationAsWordInName"}) // Justification: Class name cannot be changed anymore
 public class SQLite implements DataSource {
 
     private final Settings settings;

src/main/java/fr/xephi/authme/listener/OnJoinVerifier.java

@@ -123,7 +123,7 @@ public class OnJoinVerifier implements Reloadable {
             return false;
         } else if (!permissionsManager.hasPermission(player, PlayerStatePermission.IS_VIP)) {
             // Server is full and player is NOT VIP; set kick message and proceed with kick
-            event.setKickMessage(messages.retrieveSingle(MessageKey.KICK_FULL_SERVER));
+            event.setKickMessage(messages.retrieveSingle(player, MessageKey.KICK_FULL_SERVER));
             return true;
         }
 
@@ -135,12 +135,12 @@ public class OnJoinVerifier implements Reloadable {
         }
         Player nonVipPlayer = generateKickPlayer(onlinePlayers);
         if (nonVipPlayer != null) {
-            nonVipPlayer.kickPlayer(messages.retrieveSingle(MessageKey.KICK_FOR_VIP));
+            nonVipPlayer.kickPlayer(messages.retrieveSingle(player, MessageKey.KICK_FOR_VIP));
             event.allow();
             return false;
         } else {
             ConsoleLogger.info("VIP player " + player.getName() + " tried to join, but the server was full");
-            event.setKickMessage(messages.retrieveSingle(MessageKey.KICK_FULL_SERVER));
+            event.setKickMessage(messages.retrieveSingle(player, MessageKey.KICK_FULL_SERVER));
             return true;
         }
     }

src/main/java/fr/xephi/authme/listener/PlayerListener.java

@@ -270,7 +270,7 @@ public class PlayerListener implements Listener {
         try {
             runOnJoinChecks(JoiningPlayer.fromName(name), event.getAddress().getHostAddress());
         } catch (FailedVerificationException e) {
-            event.setKickMessage(m.retrieveSingle(e.getReason(), e.getArgs()));
+            event.setKickMessage(m.retrieveSingle(name, e.getReason(), e.getArgs()));
             event.setLoginResult(AsyncPlayerPreLoginEvent.Result.KICK_OTHER);
         }
     }
@@ -298,7 +298,7 @@ public class PlayerListener implements Listener {
             try {
                 runOnJoinChecks(JoiningPlayer.fromPlayerObject(player), event.getAddress().getHostAddress());
             } catch (FailedVerificationException e) {
-                event.setKickMessage(m.retrieveSingle(e.getReason(), e.getArgs()));
+                event.setKickMessage(m.retrieveSingle(player, e.getReason(), e.getArgs()));
                 event.setResult(PlayerLoginEvent.Result.KICK_OTHER);
             }
         }

src/main/java/fr/xephi/authme/listener/PlayerListener19Spigot.java

@@ -12,10 +12,11 @@ import javax.inject.Inject;
 
 public class PlayerListener19Spigot implements Listener {
 
+    private static boolean isPlayerSpawnLocationEventCalled = false;
+
     @Inject
     private TeleportationService teleportationService;
 
-    private static boolean isPlayerSpawnLocationEventCalled = false;
 
     public static boolean isPlayerSpawnLocationEventCalled() {
         return isPlayerSpawnLocationEventCalled;

src/main/java/fr/xephi/authme/message/Messages.java

@@ -5,6 +5,7 @@ import fr.xephi.authme.ConsoleLogger;
 import fr.xephi.authme.util.expiring.Duration;
 import org.bukkit.ChatColor;
 import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
 
 import javax.inject.Inject;
 import java.util.Map;
@@ -18,7 +19,9 @@ public class Messages {
     // Custom Authme tag replaced to new line
     private static final String NEWLINE_TAG = "%nl%";
 
-    private static final String PLAYER_TAG = "%username%";
+    // Global tag replacements
+    private static final String USERNAME_TAG = "%username%";
+    private static final String DISPLAYNAME_TAG = "%displayname%";
 
     /** Contains the keys of the singular messages for time units. */
     private static final Map<TimeUnit, MessageKey> TIME_UNIT_SINGULARS = ImmutableMap.<TimeUnit, MessageKey>builder()
@@ -51,9 +54,9 @@ public class Messages {
      * @param key The key of the message to send
      */
     public void send(CommandSender sender, MessageKey key) {
-        String[] lines = retrieve(key);
+        String[] lines = retrieve(key, sender);
         for (String line : lines) {
-            sender.sendMessage(line.replaceAll(PLAYER_TAG, sender.getName()));
+            sender.sendMessage(line);
         }
     }
 
@@ -67,7 +70,7 @@ public class Messages {
      * @param replacements The replacements to apply for the tags
      */
     public void send(CommandSender sender, MessageKey key, String... replacements) {
-        String message = retrieveSingle(key, replacements).replaceAll(PLAYER_TAG, sender.getName());
+        String message = retrieveSingle(sender, key, replacements);
         for (String line : message.split("\n")) {
             sender.sendMessage(line);
         }
@@ -77,10 +80,11 @@ public class Messages {
      * Retrieve the message from the text file and return it split by new line as an array.
      *
      * @param key The message key to retrieve
+     * @param sender The entity to send the message to
      * @return The message split by new lines
      */
-    public String[] retrieve(MessageKey key) {
-        String message = retrieveMessage(key);
+    public String[] retrieve(MessageKey key, CommandSender sender) {
+        String message = retrieveMessage(key, sender);
         if (message.isEmpty()) {
             // Return empty array instead of array with 1 empty string as entry
             return new String[0];
@@ -101,18 +105,43 @@ public class Messages {
             ? TIME_UNIT_SINGULARS.get(duration.getTimeUnit())
             : TIME_UNIT_PLURALS.get(duration.getTimeUnit());
 
-        return value + " " + retrieveMessage(timeUnitKey);
+        return value + " " + retrieveMessage(timeUnitKey, "");
     }
 
     /**
      * Retrieve the message from the text file.
      *
      * @param key The message key to retrieve
+     * @param sender The entity to send the message to
      * @return The message from the file
      */
-    private String retrieveMessage(MessageKey key) {
-        return formatMessage(
-            messagesFileHandler.getMessage(key.getKey()));
+    private String retrieveMessage(MessageKey key, CommandSender sender) {
+        String message = messagesFileHandler.getMessage(key.getKey());
+        String displayName = sender.getName();
+        if (sender instanceof Player) {
+            displayName = ((Player) sender).getDisplayName();
+        }
+        
+        return ChatColor.translateAlternateColorCodes('&', message)
+                .replace(NEWLINE_TAG, "\n")
+                .replace(USERNAME_TAG, sender.getName())
+                .replace(DISPLAYNAME_TAG, displayName);
+    }
+
+    /**
+     * Retrieve the message from the text file.
+     *
+     * @param key The message key to retrieve
+     * @param name The name of the entity to send the message to
+     * @return The message from the file
+     */
+    private String retrieveMessage(MessageKey key, String name) {
+        String message = messagesFileHandler.getMessage(key.getKey());
+        
+        return ChatColor.translateAlternateColorCodes('&', message)
+                .replace(NEWLINE_TAG, "\n")
+                .replace(USERNAME_TAG, name)
+                .replace(DISPLAYNAME_TAG, name);
     }
 
     /**
@@ -120,12 +149,13 @@ public class Messages {
      * logs an error if the number of supplied replacements doesn't correspond to the number of tags
      * the message key contains.
      *
+     * @param sender The entity to send the message to
      * @param key The key of the message to send
      * @param replacements The replacements to apply for the tags
      * @return The message from the file with replacements
      */
-    public String retrieveSingle(MessageKey key, String... replacements) {
-        String message = retrieveMessage(key);
+    public String retrieveSingle(CommandSender sender, MessageKey key, String... replacements) {
+        String message = retrieveMessage(key, sender);
         String[] tags = key.getTags();
         if (replacements.length == tags.length) {
             for (int i = 0; i < tags.length; ++i) {
@@ -137,9 +167,26 @@ public class Messages {
         return message;
     }
 
-    private static String formatMessage(String message) {
-        return ChatColor.translateAlternateColorCodes('&', message)
-            .replace(NEWLINE_TAG, "\n");
+    /**
+     * Retrieve the given message code with the given tag replacements. Note that this method
+     * logs an error if the number of supplied replacements doesn't correspond to the number of tags
+     * the message key contains.
+     *
+     * @param name The name of the entity to send the message to
+     * @param key The key of the message to send
+     * @param replacements The replacements to apply for the tags
+     * @return The message from the file with replacements
+     */
+    public String retrieveSingle(String name, MessageKey key, String... replacements) {
+        String message = retrieveMessage(key, name);
+        String[] tags = key.getTags();
+        if (replacements.length == tags.length) {
+            for (int i = 0; i < tags.length; ++i) {
+                message = message.replace(tags[i], replacements[i]);
+            }
+        } else {
+            ConsoleLogger.warning("Invalid number of replacements for message key '" + key + "'");
+        }
+        return message;
     }
-
 }

src/main/java/fr/xephi/authme/permission/handlers/LuckPermsHandler.java

@@ -62,7 +62,8 @@ public class LuckPermsHandler implements PermissionHandler {
             return false;
         }
 
-        DataMutateResult result = user.setPermissionUnchecked(luckPermsApi.getNodeFactory().makeGroupNode(newGroup).build());
+        DataMutateResult result = user.setPermissionUnchecked(
+            luckPermsApi.getNodeFactory().makeGroupNode(newGroup).build());
         if (result == DataMutateResult.FAIL) {
             return false;
         }

src/main/java/fr/xephi/authme/process/join/AsynchronousJoin.java

@@ -138,7 +138,7 @@ public class AsynchronousJoin implements AsynchronousProcess {
 
     private void handlePlayerWithUnmetNameRestriction(Player player, String ip) {
         bukkitService.scheduleSyncTaskFromOptionallyAsyncTask(() -> {
-            player.kickPlayer(service.retrieveSingleMessage(MessageKey.NOT_OWNER_ERROR));
+            player.kickPlayer(service.retrieveSingleMessage(player, MessageKey.NOT_OWNER_ERROR));
             if (service.getProperty(RestrictionSettings.BAN_UNKNOWN_IP)) {
                 server.banIP(ip);
             }
@@ -188,7 +188,7 @@ public class AsynchronousJoin implements AsynchronousProcess {
             && countOnlinePlayersByIp(ip) > service.getProperty(RestrictionSettings.MAX_JOIN_PER_IP)) {
 
             bukkitService.scheduleSyncTaskFromOptionallyAsyncTask(
-                () -> player.kickPlayer(service.retrieveSingleMessage(MessageKey.SAME_IP_ONLINE)));
+                () -> player.kickPlayer(service.retrieveSingleMessage(player, MessageKey.SAME_IP_ONLINE)));
             return false;
         }
         return true;

src/main/java/fr/xephi/authme/process/login/AsynchronousLogin.java

@@ -197,7 +197,7 @@ public class AsynchronousLogin implements AsynchronousProcess {
             tempbanManager.tempbanPlayer(player);
         } else if (service.getProperty(RestrictionSettings.KICK_ON_WRONG_PASSWORD)) {
             bukkitService.scheduleSyncTaskFromOptionallyAsyncTask(
-                () -> player.kickPlayer(service.retrieveSingleMessage(MessageKey.WRONG_PASSWORD)));
+                () -> player.kickPlayer(service.retrieveSingleMessage(player, MessageKey.WRONG_PASSWORD)));
         } else {
             service.send(player, MessageKey.WRONG_PASSWORD);
 

src/main/java/fr/xephi/authme/process/register/ProcessSyncEmailRegister.java

@@ -10,7 +10,9 @@ import org.bukkit.entity.Player;
 
 import javax.inject.Inject;
 
-
+/**
+ * Performs synchronous tasks after a successful {@link RegistrationType#EMAIL email registration}.
+ */
 public class ProcessSyncEmailRegister implements SynchronousProcess {
 
     @Inject
@@ -22,6 +24,11 @@ public class ProcessSyncEmailRegister implements SynchronousProcess {
     ProcessSyncEmailRegister() {
     }
 
+    /**
+     * Performs sync tasks for a player which has just registered by email.
+     *
+     * @param player the recently registered player
+     */
     public void processEmailRegister(Player player) {
         service.send(player, MessageKey.ACCOUNT_NOT_ACTIVATED);
         limboService.replaceTasksAfterRegistration(player);

src/main/java/fr/xephi/authme/process/register/ProcessSyncPasswordRegister.java

@@ -15,6 +15,7 @@ import org.bukkit.entity.Player;
 import javax.inject.Inject;
 
 /**
+ * Performs synchronous tasks after a successful {@link RegistrationType#PASSWORD password registration}.
  */
 public class ProcessSyncPasswordRegister implements SynchronousProcess {
 
@@ -46,6 +47,11 @@ public class ProcessSyncPasswordRegister implements SynchronousProcess {
         }
     }
 
+    /**
+     * Processes a player having registered with a password.
+     *
+     * @param player the newly registered player
+     */
     public void processPasswordRegister(Player player) {
         service.send(player, MessageKey.REGISTER_SUCCESS);
 
@@ -58,7 +64,7 @@ public class ProcessSyncPasswordRegister implements SynchronousProcess {
 
         // Kick Player after Registration is enabled, kick the player
         if (service.getProperty(RegistrationSettings.FORCE_KICK_AFTER_REGISTER)) {
-            player.kickPlayer(service.retrieveSingleMessage(MessageKey.REGISTER_SUCCESS));
+            player.kickPlayer(service.retrieveSingleMessage(player, MessageKey.REGISTER_SUCCESS));
             return;
         }
 

src/main/java/fr/xephi/authme/service/CommonService.java

@@ -63,11 +63,12 @@ public class CommonService {
     /**
      * Retrieves a message in one piece.
      *
+     * @param sender The entity to send the message to
      * @param key the key of the message
      * @return the message
      */
-    public String retrieveSingleMessage(MessageKey key) {
-        return messages.retrieveSingle(key);
+    public String retrieveSingleMessage(CommandSender sender, MessageKey key) {
+        return messages.retrieveSingle(sender, key);
     }
 
     /**

src/main/java/fr/xephi/authme/service/SessionService.java

@@ -45,11 +45,13 @@ public class SessionService implements Reloadable {
             database.setUnlogged(name);
             database.revokeSession(name);
             PlayerAuth auth = database.getAuth(name);
-            if (hasValidSessionData(auth, player)) {
+
+            SessionState state = fetchSessionStatus(auth, player);
+            if (state.equals(SessionState.VALID)) {
                 RestoreSessionEvent event = bukkitService.createAndCallEvent(
                     isAsync -> new RestoreSessionEvent(player, isAsync));
                 return !event.isCancelled();
-            } else {
+            } else if (state.equals(SessionState.IP_CHANGED)) {
                 service.send(player, MessageKey.SESSION_EXPIRED);
             }
         }
@@ -62,19 +64,26 @@ public class SessionService implements Reloadable {
      *
      * @param auth the player auth
      * @param player the associated player
-     * @return true if the player may resume his login session, false otherwise
+     * @return SessionState based on the state of the session (VALID, NOT_VALID, OUTDATED, IP_CHANGED)
      */
-    private boolean hasValidSessionData(PlayerAuth auth, Player player) {
+    private SessionState fetchSessionStatus(PlayerAuth auth, Player player) {
         if (auth == null) {
             ConsoleLogger.warning("No PlayerAuth in database for '" + player.getName() + "' during session check");
-            return false;
+            return SessionState.NOT_VALID;
         } else if (auth.getLastLogin() == null) {
-            return false;
+            return SessionState.NOT_VALID;
         }
         long timeSinceLastLogin = System.currentTimeMillis() - auth.getLastLogin();
-        return PlayerUtils.getPlayerIp(player).equals(auth.getLastIp())
-            && timeSinceLastLogin > 0
-            && timeSinceLastLogin < service.getProperty(PluginSettings.SESSIONS_TIMEOUT) * MILLIS_PER_MINUTE;
+
+        if (timeSinceLastLogin > 0
+            && timeSinceLastLogin < service.getProperty(PluginSettings.SESSIONS_TIMEOUT) * MILLIS_PER_MINUTE) {
+            if (PlayerUtils.getPlayerIp(player).equals(auth.getLastIp())) {
+                return SessionState.VALID;
+            } else {
+                return SessionState.IP_CHANGED;
+            }
+        }
+        return SessionState.OUTDATED;
     }
 
     public void grantSession(String name) {

src/main/java/fr/xephi/authme/service/SessionState.java

@@ -0,0 +1,13 @@
+package fr.xephi.authme.service;
+
+public enum SessionState {
+
+    VALID,
+
+    NOT_VALID,
+
+    OUTDATED,
+
+    IP_CHANGED
+
+}

src/main/java/fr/xephi/authme/settings/SettingsWarner.java

@@ -56,9 +56,9 @@ public class SettingsWarner {
         // Warn if spigot.yml has settings.bungeecord set to true but config.yml has Hooks.bungeecord set to false
         if (Utils.isSpigot() && Bukkit.spigot().getConfig().getBoolean("settings.bungeecord")
             && !settings.getProperty(HooksSettings.BUNGEECORD)) {
-            ConsoleLogger.warning("Note: Hooks.bungeecord is set to false but your server appears to be running in" +
-                " bungeecord mode (see your spigot.yml). In order to allow the datasource caching and the AuthMeBungee" +
-                " add-on to work properly you have to enable this option!");
+            ConsoleLogger.warning("Note: Hooks.bungeecord is set to false but your server appears to be running in"
+                + " bungeecord mode (see your spigot.yml). In order to allow the datasource caching and the"
+                + " AuthMeBungee add-on to work properly you have to enable this option!");
         }
 
         // Check if argon2 library is present and can be loaded

src/main/java/fr/xephi/authme/task/purge/PurgeExecutor.java

@@ -61,6 +61,11 @@ public class PurgeExecutor {
         purgePermissions(players);
     }
 
+    /**
+     * Purges data from the AntiXray plugin.
+     *
+     * @param cleared the players whose data should be cleared
+     */
     synchronized void purgeAntiXray(Collection<String> cleared) {
         if (!settings.getProperty(PurgeSettings.REMOVE_ANTI_XRAY_FILE)) {
             return;
@@ -95,6 +100,11 @@ public class PurgeExecutor {
         ConsoleLogger.info(ChatColor.GOLD + "Deleted " + names.size() + " user accounts");
     }
 
+    /**
+     * Purges data from the LimitedCreative plugin.
+     *
+     * @param cleared the players whose data should be cleared
+     */
     synchronized void purgeLimitedCreative(Collection<String> cleared) {
         if (!settings.getProperty(PurgeSettings.REMOVE_LIMITED_CREATIVE_INVENTORIES)) {
             return;
@@ -191,6 +201,11 @@ public class PurgeExecutor {
         ConsoleLogger.info("AutoPurge: Removed " + deletedFiles + " EssentialsFiles");
     }
 
+    /**
+     * Removes permission data (groups a user belongs to) for the given players.
+     *
+     * @param cleared the players to remove data for
+     */
     synchronized void purgePermissions(Collection<OfflinePlayer> cleared) {
         if (!settings.getProperty(PurgeSettings.REMOVE_PERMISSIONS)) {
             return;