fix: Identify our Dialog and close them on auto login from Proxy or API

Author: Xephi

authme-core/src/main/java/fr/xephi/authme/platform/DialogAdapter.java

@@ -48,4 +48,13 @@ default void showTotpDialog(Player player, DialogWindowSpec dialog) {
     default void showRegisterDialog(Player player, RegistrationType type,
                                     RegisterSecondaryArgument secondArg, DialogWindowSpec dialog) {
     }
+
+    /**
+     * Closes any open dialog for the given player (e.g. after a force-login via the API).
+     * Has no effect if no dialog is currently open or if dialogs are not supported on this platform.
+     *
+     * @param player the player whose dialog should be closed
+     */
+    default void closeDialog(Player player) {
+    }
 }

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

@@ -20,6 +20,7 @@
 import fr.xephi.authme.process.register.executors.RegistrationMethod;
 import fr.xephi.authme.service.BukkitService;
 import fr.xephi.authme.service.CommonService;
+import fr.xephi.authme.service.DialogStateService;
 import fr.xephi.authme.service.DialogWindowService;
 import fr.xephi.authme.service.PreJoinDialogService;
 import fr.xephi.authme.service.PluginHookService;
@@ -103,6 +104,9 @@ public class AsynchronousJoin implements AsynchronousProcess {
     @Inject
     private DialogWindowService dialogWindowService;
 
+    @Inject
+    private DialogStateService dialogStateService;
+
     @Inject
     private PreJoinDialogService preJoinDialogService;
 
@@ -266,6 +270,7 @@ private void showPostJoinDialogIfNecessary(Player player, boolean isAuthAvailabl
                 secondArg,
                 dialogWindowService.createRegisterDialog(player, registrationType, secondArg));
         }
+        dialogStateService.markDialogOpen(player);
     }
 
     private void processPendingRegistration(Player player, PreJoinDialogService.PendingRegistration pendingRegistration) {

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

@@ -24,6 +24,7 @@
 import fr.xephi.authme.security.PasswordSecurity;
 import fr.xephi.authme.service.BukkitService;
 import fr.xephi.authme.service.CommonService;
+import fr.xephi.authme.service.DialogStateService;
 import fr.xephi.authme.service.DialogWindowService;
 import fr.xephi.authme.service.SessionService;
 import fr.xephi.authme.service.bungeecord.BungeeSender;
@@ -94,6 +95,9 @@ public class AsynchronousLogin implements AsynchronousProcess {
     @Inject
     private DialogWindowService dialogWindowService;
 
+    @Inject
+    private DialogStateService dialogStateService;
+
     AsynchronousLogin() {
     }
 
@@ -280,6 +284,7 @@ private void showTotpDialogIfEnabled(Player player) {
                 return;
             }
             dialogAdapter.showTotpDialog(player, dialogWindowService.createTotpDialog(player));
+            dialogStateService.markDialogOpen(player);
         }, 1L);
     }
 

authme-core/src/main/java/fr/xephi/authme/process/login/ProcessSyncPlayerLogin.java

@@ -8,7 +8,9 @@
 import fr.xephi.authme.events.RestoreInventoryEvent;
 import fr.xephi.authme.permission.PermissionsManager;
 import fr.xephi.authme.permission.PlayerStatePermission;
+import fr.xephi.authme.platform.DialogAdapter;
 import fr.xephi.authme.process.SynchronousProcess;
+import fr.xephi.authme.service.DialogStateService;
 import fr.xephi.authme.service.BukkitService;
 import fr.xephi.authme.service.CommonService;
 import fr.xephi.authme.service.JoinMessageService;
@@ -28,6 +30,12 @@
 
 public class ProcessSyncPlayerLogin implements SynchronousProcess {
 
+    @Inject
+    private DialogAdapter dialogAdapter;
+
+    @Inject
+    private DialogStateService dialogStateService;
+
     @Inject
     private BungeeSender bungeeSender;
 
@@ -94,6 +102,10 @@ public void processPlayerLoginFromProxy(Player player, boolean isFirstLogin, Lis
 
     private void processPlayerLogin(Player player, boolean isFirstLogin, List<String> authsWithSameIp,
                                     boolean proxyInitiated) {
+        if (dialogStateService.clearDialogOpen(player)) {
+            dialogAdapter.closeDialog(player);
+        }
+
         final String name = player.getName().toLowerCase(Locale.ROOT);
         final LimboPlayer limbo = limboService.getLimboPlayer(name);
 

authme-core/src/main/java/fr/xephi/authme/process/quit/AsynchronousQuit.java

@@ -8,6 +8,7 @@
 import fr.xephi.authme.process.AsynchronousProcess;
 import fr.xephi.authme.process.SyncProcessManager;
 import fr.xephi.authme.service.CommonService;
+import fr.xephi.authme.service.DialogStateService;
 import fr.xephi.authme.service.SessionService;
 import fr.xephi.authme.service.TeleportationService;
 import fr.xephi.authme.service.ValidationService;
@@ -56,6 +57,9 @@ public class AsynchronousQuit implements AsynchronousProcess {
     @Inject
     private TeleportationService teleportationService;
 
+    @Inject
+    private DialogStateService dialogStateService;
+
     AsynchronousQuit() {
     }
 
@@ -70,6 +74,7 @@ public void processQuit(Player player) {
         }
         String name = player.getName().toLowerCase(Locale.ROOT);
         teleportationService.clearOriginalJoinLocation(name);
+        dialogStateService.clearDialogOpen(player);
         boolean wasLoggedIn = playerCache.isAuthenticated(name);
 
         if (wasLoggedIn) {

authme-core/src/main/java/fr/xephi/authme/service/DialogStateService.java

@@ -0,0 +1,37 @@
+package fr.xephi.authme.service;
+
+import org.bukkit.entity.Player;
+
+import java.util.Set;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * Tracks which players currently have an AuthMe-owned dialog open.
+ * Used to ensure we only close dialogs that we opened, not dialogs from other plugins.
+ */
+public class DialogStateService {
+
+    private final Set<UUID> playersWithOpenDialog = ConcurrentHashMap.newKeySet();
+
+    /**
+     * Records that an AuthMe dialog was shown to the given player.
+     *
+     * @param player the player who was shown a dialog
+     */
+    public void markDialogOpen(Player player) {
+        playersWithOpenDialog.add(player.getUniqueId());
+    }
+
+    /**
+     * Removes the dialog-open record for the given player.
+     * Returns {@code true} if the player had an AuthMe dialog tracked (and it was removed),
+     * or {@code false} if there was no record (i.e. no AuthMe dialog was open for that player).
+     *
+     * @param player the player to clear
+     * @return true if an AuthMe dialog was tracked for this player
+     */
+    public boolean clearDialogOpen(Player player) {
+        return playersWithOpenDialog.remove(player.getUniqueId());
+    }
+}

authme-core/src/test/java/fr/xephi/authme/process/join/AsynchronousJoinTest.java

@@ -13,6 +13,7 @@
 import fr.xephi.authme.service.PreJoinDialogService;
 import fr.xephi.authme.service.BukkitService;
 import fr.xephi.authme.service.CommonService;
+import fr.xephi.authme.service.DialogStateService;
 import fr.xephi.authme.service.DialogWindowService;
 import fr.xephi.authme.service.PluginHookService;
 import fr.xephi.authme.service.SessionService;
@@ -88,6 +89,8 @@ public class AsynchronousJoinTest {
     @Mock
     private DialogWindowService dialogWindowService;
     @Mock
+    private DialogStateService dialogStateService;
+    @Mock
     private PreJoinDialogService preJoinDialogService;
 
     @BeforeAll

authme-core/src/test/java/fr/xephi/authme/process/login/AsynchronousLoginTest.java

@@ -23,6 +23,7 @@
 import fr.xephi.authme.service.BukkitService;
 import fr.xephi.authme.service.CommonService;
 import fr.xephi.authme.service.CancellableTask;
+import fr.xephi.authme.service.DialogStateService;
 import fr.xephi.authme.service.DialogWindowService;
 import fr.xephi.authme.service.SessionService;
 import fr.xephi.authme.service.bungeecord.BungeeSender;
@@ -92,6 +93,8 @@ public class AsynchronousLoginTest {
     private DialogAdapter dialogAdapter;
     @Mock
     private DialogWindowService dialogWindowService;
+    @Mock
+    private DialogStateService dialogStateService;
 
     @BeforeAll
     public static void initLogger() {

authme-paper-common/src/main/java/fr/xephi/authme/platform/AbstractPaperPlatformAdapter.java

@@ -57,6 +57,13 @@ public void showRegisterDialog(Player player, RegistrationType type,
         PaperDialogHelper.showRegisterDialog(player, type, secondArg, dialog);
     }
 
+    @Override
+    public void closeDialog(Player player) {
+        if (DIALOG_AVAILABLE) {
+            PaperDialogHelper.closeDialog(player);
+        }
+    }
+
     @Override
     public void registerCommands(AuthMe plugin, CommandHandler commandHandler, Collection<CommandDescription> commands) {
         new PaperBrigadierCommandRegistrar(commandHandler::processCommand).registerCommands(plugin, commands);

authme-paper-common/src/main/java/fr/xephi/authme/platform/PaperDialogHelper.java

@@ -25,6 +25,10 @@ public final class PaperDialogHelper {
     private PaperDialogHelper() {
     }
 
+    static void closeDialog(Player player) {
+        player.closeDialog();
+    }
+
     static void showLoginDialog(Player player, DialogWindowSpec dialog) {
         player.showDialog(createInGameCommandDialog(dialog, "login $(password)"));
     }