Merge branch '1449-commands-with-delay'

src/main/java/fr/xephi/authme/settings/commandconfig/Command.java

@@ -9,6 +9,8 @@ public class Command {
     private String command;
     /** The executor of the command. */
     private Executor executor = Executor.PLAYER;
+    /** Delay before executing the command (in ticks) */
+    private long delay = 0;
 
     /**
      * Default constructor (for bean mapping).
@@ -17,14 +19,21 @@ public class Command {
     }
 
     /**
-     * Constructor.
+     * Creates a copy of this Command object, setting the given command text on the copy.
      *
-     * @param command the command
+     * @param command the command text to use in the copy
-     * @param executor the executor of the command
+     * @return copy of the source with the new command
      */
-    public Command(String command, Executor executor) {
+    public Command copyWithCommand(String command) {
-        this.command = command;
+        Command copy = new Command();
-        this.executor = executor;
+        setValuesToCopyWithNewCommand(copy, command);
+        return copy;
+    }
+
+    protected void setValuesToCopyWithNewCommand(Command copy, String newCommand) {
+        copy.command = newCommand;
+        copy.executor = this.executor;
+        copy.delay = this.delay;
     }
 
     public String getCommand() {
@@ -43,6 +52,14 @@ public class Command {
         this.executor = executor;
     }
 
+    public long getDelay() {
+        return delay;
+    }
+
+    public void setDelay(long delay) {
+        this.delay = delay;
+    }
+
     @Override
     public String toString() {
         return command + " (" + executor + ")";

src/main/java/fr/xephi/authme/settings/commandconfig/CommandManager.java

@@ -125,18 +125,26 @@ public class CommandManager implements Reloadable {
     }
 
     private <T extends Command> void executeCommands(Player player, List<T> commands, Predicate<T> predicate) {
-        for (T command : commands) {
+        for (T cmd : commands) {
-            if (predicate.test(command)) {
+            if (predicate.test(cmd)) {
-                final String execution = command.getCommand();
+                long delay = cmd.getDelay();
-                if (Executor.CONSOLE.equals(command.getExecutor())) {
+                if (delay > 0) {
-                    bukkitService.dispatchConsoleCommand(execution);
+                    bukkitService.scheduleSyncDelayedTask(() -> dispatchCommand(player, cmd), delay);
                 } else {
-                    bukkitService.dispatchCommand(player, execution);
+                    dispatchCommand(player, cmd);
                 }
             }
         }
     }
 
+    private void dispatchCommand(Player player, Command command) {
+        if (Executor.CONSOLE.equals(command.getExecutor())) {
+            bukkitService.dispatchConsoleCommand(command.getCommand());
+        } else {
+            bukkitService.dispatchCommand(player, command.getCommand());
+        }
+    }
+
     private static boolean shouldCommandBeRun(OnLoginCommand command, int numberOfOtherAccounts) {
         return (!command.getIfNumberOfAccountsAtLeast().isPresent()
                 || command.getIfNumberOfAccountsAtLeast().get() <= numberOfOtherAccounts)
@@ -166,22 +174,19 @@ public class CommandManager implements Reloadable {
 
     private WrappedTagReplacer<Command, Player> newReplacer(Map<String, Command> commands) {
         return new WrappedTagReplacer<>(availableTags, commands.values(), Command::getCommand,
-            (cmd, text) -> new Command(text, cmd.getExecutor()));
+            Command::copyWithCommand);
     }
 
-    private WrappedTagReplacer<OnLoginCommand, Player> newOnLoginCmdReplacer(
+    private WrappedTagReplacer<OnLoginCommand, Player> newOnLoginCmdReplacer(Map<String, OnLoginCommand> commands) {
-        Map<String, OnLoginCommand> commands) {
-
         return new WrappedTagReplacer<>(availableTags, commands.values(), Command::getCommand,
-            (cmd, text) -> new OnLoginCommand(text, cmd.getExecutor(), cmd.getIfNumberOfAccountsAtLeast(),
+            OnLoginCommand::copyWithCommand);
-                cmd.getIfNumberOfAccountsLessThan()));
     }
 
     private List<Tag<Player>> buildAvailableTags() {
         return Arrays.asList(
-            createTag("%p",       pl -> pl.getName()),
+            createTag("%p",       Player::getName),
-            createTag("%nick",    pl -> pl.getDisplayName()),
+            createTag("%nick",    Player::getDisplayName),
-            createTag("%ip",      pl -> PlayerUtils.getPlayerIp(pl)),
+            createTag("%ip",      PlayerUtils::getPlayerIp),
             createTag("%country", pl -> geoIpService.getCountryName(PlayerUtils.getPlayerIp(pl))));
     }
 }

src/main/java/fr/xephi/authme/settings/commandconfig/CommandMigrationService.java

@@ -41,8 +41,9 @@ class CommandMigrationService implements MigrationService {
 
     private boolean moveOtherAccountsConfig(CommandConfig commandConfig) {
         if (settingsMigrationService.hasOldOtherAccountsCommand()) {
-            OnLoginCommand command = new OnLoginCommand(
+            OnLoginCommand command = new OnLoginCommand();
-                replaceOldPlaceholdersWithNew(settingsMigrationService.getOldOtherAccountsCommand()), Executor.CONSOLE);
+            command.setCommand(replaceOldPlaceholdersWithNew(settingsMigrationService.getOldOtherAccountsCommand()));
+            command.setExecutor(Executor.CONSOLE);
             command.setIfNumberOfAccountsAtLeast(
                 Optional.of(settingsMigrationService.getOldOtherAccountsCommandThreshold()));
 

src/main/java/fr/xephi/authme/settings/commandconfig/CommandSettingsHolder.java

@@ -44,6 +44,13 @@ public final class CommandSettingsHolder implements SettingsHolder {
             "    command: 'broadcast %p has joined, welcome back!'",
             "    executor: CONSOLE",
             "",
+            "You can also add delay to command. It will run after the specified ticks. Example:",
+            "onLogin:",
+            "  rules:",
+            "    command: 'rules'",
+            "    executor: PLAYER",
+            "    delay: 200",
+            "",
             "Supported command events: onLogin, onSessionLogin, onFirstLogin, onJoin, onLogout, onRegister, "
                 + "onUnregister",
             "",

src/main/java/fr/xephi/authme/settings/commandconfig/OnLoginCommand.java

@@ -17,28 +17,18 @@ public class OnLoginCommand extends Command {
     }
 
     /**
-     * Constructor.
+     * Creates a copy of this object, using the given command as new {@link Command#command command}.
      *
-     * @param command the command to execute
+     * @param command the command text to use in the copy
-     * @param executor the executor of the command
+     * @return copy of the source with the new command
      */
-    public OnLoginCommand(String command, Executor executor) {
+    @Override
-        super(command, executor);
+    public OnLoginCommand copyWithCommand(String command) {
-    }
+        OnLoginCommand copy = new OnLoginCommand();
-
+        setValuesToCopyWithNewCommand(copy, command);
-    /**
+        copy.ifNumberOfAccountsAtLeast = this.ifNumberOfAccountsAtLeast;
-     * Constructor.
+        copy.ifNumberOfAccountsLessThan = this.ifNumberOfAccountsLessThan;
-     *
+        return copy;
-     * @param command the command to execute
-     * @param executor the executor of the command
-     * @param ifNumberOfAccountsAtLeast required number of accounts for the command to run
-     * @param ifNumberOfAccountsLessThan max threshold of accounts, from which the command will not be run
-     */
-    public OnLoginCommand(String command, Executor executor, Optional<Integer> ifNumberOfAccountsAtLeast,
-                          Optional<Integer> ifNumberOfAccountsLessThan) {
-        super(command, executor);
-        this.ifNumberOfAccountsAtLeast = ifNumberOfAccountsAtLeast;
-        this.ifNumberOfAccountsLessThan = ifNumberOfAccountsLessThan;
     }
 
     public Optional<Integer> getIfNumberOfAccountsAtLeast() {

src/main/resources/commands.yml

@@ -24,6 +24,13 @@
 #     command: 'broadcast %p has joined, welcome back!'
 #     executor: CONSOLE
 # 
+# You can also add delay to command. It will run after the specified ticks. Example:
+# onLogin:
+#   rules:
+#     command: 'rules'
+#     executor: PLAYER
+#     delay: 200
+# 
 # Supported command events: onLogin, onSessionLogin, onFirstLogin, onJoin, onLogout, onRegister, onUnregister
 # 
 # For onLogin and onFirstLogin, you can use 'ifNumberOfAccountsLessThan' and 'ifNumberOfAccountsAtLeast'

src/test/java/fr/xephi/authme/settings/commandconfig/CommandManagerTest.java

@@ -3,6 +3,7 @@ package fr.xephi.authme.settings.commandconfig;
 import com.google.common.io.Files;
 import fr.xephi.authme.TestHelper;
 import fr.xephi.authme.service.BukkitService;
+import fr.xephi.authme.service.BukkitServiceTestHelper;
 import fr.xephi.authme.service.GeoIpService;
 import fr.xephi.authme.settings.SettingsMigrationService;
 import org.bukkit.entity.Player;
@@ -25,6 +26,7 @@ import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.BDDMockito.given;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.only;
+import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoMoreInteractions;
 import static org.mockito.Mockito.verifyZeroInteractions;
@@ -59,6 +61,7 @@ public class CommandManagerTest {
     public void setup() throws IOException {
         testFolder = temporaryFolder.newFolder();
         player = mockPlayer();
+        BukkitServiceTestHelper.setBukkitServiceToScheduleSyncDelayedTaskWithDelay(bukkitService);
     }
 
     @Test
@@ -74,6 +77,8 @@ public class CommandManagerTest {
         verify(bukkitService).dispatchConsoleCommand("msg Bobby Welcome back");
         verify(bukkitService).dispatchCommand(any(Player.class), eq("motd"));
         verify(bukkitService).dispatchCommand(any(Player.class), eq("list"));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(60L));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(120L));
         verifyNoMoreInteractions(bukkitService);
         verifyZeroInteractions(geoIpService);
     }
@@ -92,6 +97,9 @@ public class CommandManagerTest {
         verify(bukkitService).dispatchCommand(player, "motd");
         verify(bukkitService).dispatchCommand(player, "list");
         verify(bukkitService).dispatchConsoleCommand("helpop Player Bobby has more than 1 account");
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(60L));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(120L));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(180L));
         verifyNoMoreInteractions(bukkitService);
         verifyZeroInteractions(geoIpService);
     }
@@ -111,6 +119,10 @@ public class CommandManagerTest {
         verify(bukkitService).dispatchCommand(player, "list");
         verify(bukkitService).dispatchConsoleCommand("helpop Player Bobby has more than 1 account");
         verify(bukkitService).dispatchConsoleCommand("log Bobby 127.0.0.3 many accounts");
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(60L));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(120L));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(180L));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(240L));
         verifyNoMoreInteractions(bukkitService);
         verifyZeroInteractions(geoIpService);
     }
@@ -129,6 +141,9 @@ public class CommandManagerTest {
         verify(bukkitService).dispatchCommand(player, "motd");
         verify(bukkitService).dispatchCommand(player, "list");
         verify(bukkitService).dispatchConsoleCommand("helpop Player Bobby has more than 1 account");
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(60L));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(120L));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(180L));
         verifyNoMoreInteractions(bukkitService);
         verifyZeroInteractions(geoIpService);
     }
@@ -138,6 +153,7 @@ public class CommandManagerTest {
         // given
         copyJarFileAsCommandsYml(TEST_FILES_FOLDER + "commands.incomplete.yml");
         initManager();
+        BukkitServiceTestHelper.setBukkitServiceToScheduleSyncDelayedTaskWithDelay(bukkitService);
 
         // when
         manager.runCommandsOnLogin(player, Collections.emptyList());
@@ -145,6 +161,7 @@ public class CommandManagerTest {
         // then
         verify(bukkitService).dispatchConsoleCommand("msg Bobby Welcome back, bob");
         verify(bukkitService).dispatchCommand(any(Player.class), eq("list"));
+        verify(bukkitService).scheduleSyncDelayedTask(any(Runnable.class), eq(100L));
         verifyNoMoreInteractions(bukkitService);
         verifyZeroInteractions(geoIpService);
     }
@@ -232,6 +249,7 @@ public class CommandManagerTest {
         // then
         verify(bukkitService).dispatchCommand(any(Player.class), eq("me I just registered"));
         verify(bukkitService).dispatchConsoleCommand("log Bobby (127.0.0.3, Syldavia) registered");
+        verify(bukkitService, times(2)).scheduleSyncDelayedTask(any(Runnable.class), eq(100L));
         verifyNoMoreInteractions(bukkitService);
     }
 

src/test/resources/fr/xephi/authme/settings/commandconfig/commands.complete.yml

@@ -8,9 +8,11 @@ onRegister:
     announce:
         command: 'me I just registered'
         executor: PLAYER
+        delay: 100
     notify:
         command: 'log %p (%ip, %country) registered'
         executor: CONSOLE
+        delay: 100
 onLogin:
     welcome:
         command: 'msg %p Welcome back'
@@ -18,18 +20,22 @@ onLogin:
     show_motd:
         command: 'motd'
         executor: PLAYER
+        delay: 60
     display_list:
         command: 'list'
         executor: PLAYER
+        delay: 120
     warn_for_alts:
         command: 'helpop Player %p has more than 1 account'
         executor: CONSOLE
         ifNumberOfAccountsAtLeast: 2
+        delay: 180
     log_suspicious_user:
         command: 'log %p %ip many accounts'
         executor: CONSOLE
         ifNumberOfAccountsAtLeast: 5
         ifNumberOfAccountsLessThan: 20
+        delay: 240
 onSessionLogin:
     welcome:
         command: 'msg %p Session login!'

src/test/resources/fr/xephi/authme/settings/commandconfig/commands.incomplete.yml

@@ -8,12 +8,14 @@ onLogin:
     welcome:
         command: 'msg %p Welcome back, %nick'
         executor: CONSOLE
+        delay: 0
     show_motd:
         # command: 'motd' <-- mandatory property, so entry should be ignored
         executor: PLAYER
     display_list:
         command: 'list'
         executor: WRONG_EXECUTOR
+        delay: 100
 doesNotExist:
     wrongEntry:
         command: 'should be ignored'