implemented config-option vanish-fake-join-leave, analogous to EssentialsDiscord

Author: BlvckBytes

Essentials/src/main/java/com/earth2me/essentials/EssentialsPlayerListener.java

@@ -21,6 +21,7 @@
 import io.papermc.paper.event.player.PlayerServerFullCheckEvent;
 import net.ess3.api.IEssentials;
 import net.ess3.api.events.AfkStatusChangeEvent;
+import net.ess3.api.events.VanishStatusChangeEvent;
 import net.ess3.provider.CommandSendListenerProvider;
 import net.ess3.provider.FormattedCommandAliasProvider;
 import net.ess3.provider.InventoryViewProvider;
@@ -32,6 +33,7 @@
 import net.essentialsx.api.v2.events.AsyncUserDataLoadEvent;
 import org.bukkit.BanEntry;
 import org.bukkit.BanList;
+import org.bukkit.Bukkit;
 import org.bukkit.GameMode;
 import org.bukkit.Location;
 import org.bukkit.Material;
@@ -297,14 +299,7 @@ public void onPlayerQuit(final PlayerQuitEvent event) {
         if (hideJoinQuitMessages() || ess.getSettings().allowSilentJoinQuit() && user.isAuthorized("essentials.silentquit")) {
             event.setQuitMessage(null);
         } else if (ess.getSettings().isCustomQuitMessage() && event.getQuitMessage() != null) {
-            final Player player = event.getPlayer();
-            final String msg = ess.getSettings().getCustomQuitMessage()
-                .replace("{PLAYER}", player.getDisplayName())
-                .replace("{USERNAME}", player.getName())
-                .replace("{ONLINE}", NumberFormat.getInstance().format(ess.getOnlinePlayers().size() - 1)) // Subtract 1 as the leaving player is still online during this time
-                .replace("{UPTIME}", DateUtil.formatDateDiff(ManagementFactory.getRuntimeMXBean().getStartTime()))
-                .replace("{PREFIX}", FormatUtil.replaceFormat(ess.getPermissionsHandler().getPrefix(player)))
-                .replace("{SUFFIX}", FormatUtil.replaceFormat(ess.getPermissionsHandler().getSuffix(player)));
+            final String msg = buildQuitMessage(user);
 
             event.setQuitMessage(msg.isEmpty() ? null : msg);
         }
@@ -341,6 +336,50 @@ public void onPlayerQuit(final PlayerQuitEvent event) {
         user.dispose();
     }
 
+    @EventHandler(ignoreCancelled = true, priority = EventPriority.MONITOR)
+    public void onVanishStatusChange(final VanishStatusChangeEvent event) {
+        if (!ess.getSettings().isVanishFakeJoinLeave()) {
+            return;
+        }
+
+        if (event.getValue()) {
+            final String quitMessage = buildQuitMessage((User) event.getAffected());
+
+            if (!quitMessage.isEmpty()) {
+                Bukkit.broadcastMessage(quitMessage);
+            }
+
+            return;
+        }
+
+        final String joinMessage = buildJoinMessage((User) event.getAffected(), false, null);
+
+        if (!joinMessage.isEmpty()) {
+            Bukkit.broadcastMessage(joinMessage);
+        }
+    }
+
+    private String buildJoinMessage(final User user, boolean newUsername, String lastAccountName) {
+        return (newUsername && ess.getSettings().isCustomNewUsernameMessage() ? ess.getSettings().getCustomNewUsernameMessage() : ess.getSettings().getCustomJoinMessage())
+          .replace("{PLAYER}", user.getDisplayName()).replace("{USERNAME}", user.getName())
+          .replace("{UNIQUE}", NumberFormat.getInstance().format(ess.getUsers().getUserCount()))
+          .replace("{ONLINE}", NumberFormat.getInstance().format(ess.getOnlinePlayers().size()))
+          .replace("{UPTIME}", DateUtil.formatDateDiff(ManagementFactory.getRuntimeMXBean().getStartTime()))
+          .replace("{PREFIX}", FormatUtil.replaceFormat(ess.getPermissionsHandler().getPrefix(user.getBase())))
+          .replace("{SUFFIX}", FormatUtil.replaceFormat(ess.getPermissionsHandler().getSuffix(user.getBase())))
+          .replace("{OLDUSERNAME}", lastAccountName == null ? "" : lastAccountName);
+    }
+
+    private String buildQuitMessage(final User user) {
+        return ess.getSettings().getCustomQuitMessage()
+          .replace("{PLAYER}", user.getDisplayName())
+          .replace("{USERNAME}", user.getName())
+          .replace("{ONLINE}", NumberFormat.getInstance().format(ess.getOnlinePlayers().size() - 1)) // Subtract 1 as the leaving player is still online during this time
+          .replace("{UPTIME}", DateUtil.formatDateDiff(ManagementFactory.getRuntimeMXBean().getStartTime()))
+          .replace("{PREFIX}", FormatUtil.replaceFormat(ess.getPermissionsHandler().getPrefix(user.getBase())))
+          .replace("{SUFFIX}", FormatUtil.replaceFormat(ess.getPermissionsHandler().getSuffix(user.getBase())));
+    }
+
     @SuppressWarnings("UnstableApiUsage")
     private final class JoinListener1_21 implements Listener {
         private final Map<UUID, String> newUserLocales = new ConcurrentHashMap<>();
@@ -458,14 +497,7 @@ private void joinFlow(final User user, final long currentTime, final String mess
         } else if (message == null || hideJoinQuitMessages()) {
             effectiveMessage = null;
         } else if (ess.getSettings().isCustomJoinMessage()) {
-            final String msg = (newUsername && ess.getSettings().isCustomNewUsernameMessage() ? ess.getSettings().getCustomNewUsernameMessage() : ess.getSettings().getCustomJoinMessage())
-                    .replace("{PLAYER}", user.getDisplayName()).replace("{USERNAME}", user.getName())
-                    .replace("{UNIQUE}", NumberFormat.getInstance().format(ess.getUsers().getUserCount()))
-                    .replace("{ONLINE}", NumberFormat.getInstance().format(ess.getOnlinePlayers().size()))
-                    .replace("{UPTIME}", DateUtil.formatDateDiff(ManagementFactory.getRuntimeMXBean().getStartTime()))
-                    .replace("{PREFIX}", FormatUtil.replaceFormat(ess.getPermissionsHandler().getPrefix(user.getBase())))
-                    .replace("{SUFFIX}", FormatUtil.replaceFormat(ess.getPermissionsHandler().getSuffix(user.getBase())))
-                    .replace("{OLDUSERNAME}", lastAccountName == null ? "" : lastAccountName);
+            final String msg = buildJoinMessage(user, newUsername, lastAccountName);
             effectiveMessage = msg.isEmpty() ? null : msg;
         } else if (ess.getSettings().allowSilentJoinQuit()) {
             effectiveMessage = message;

Essentials/src/main/java/com/earth2me/essentials/ISettings.java

@@ -229,6 +229,8 @@ public interface ISettings extends IConf {
 
     boolean sleepIgnoresVanishedPlayers();
 
+    boolean isVanishFakeJoinLeave();
+
     boolean isAfkListName();
 
     String getAfkListName();

Essentials/src/main/java/com/earth2me/essentials/Settings.java

@@ -1350,6 +1350,11 @@ public boolean sleepIgnoresVanishedPlayers() {
         return config.getBoolean("sleep-ignores-vanished-player", true);
     }
 
+    @Override
+    public boolean isVanishFakeJoinLeave() {
+        return config.getBoolean("vanish-fake-join-leave", false);
+    }
+
     public String _getAfkListName() {
         return FormatUtil.replaceFormat(config.getString("afk-list-name", "none"));
     }

Essentials/src/main/resources/config.yml

@@ -544,6 +544,9 @@ sleep-ignores-afk-players: true
 # Players with the permission 'essentials.sleepingignored' will always be ignored.
 sleep-ignores-vanished-player: true
 
+# Whether or not fake join and leave messages should be sent to the ingame-chat when a player toggles vanish.
+vanish-fake-join-leave: false
+
 # Change the player's /list name when they are AFK. This is none by default, which specifies that Essentials
 # should not interfere with the AFK player's /list name.
 # You may use color codes, {USERNAME} for the player's name, or {PLAYER} for the player's display name.