Discord Module (#3844)

Co-authored-by: MD <1917406+mdcfe@users.noreply.github.com>
Co-authored-by: pop4959 <pop4959@gmail.com>
Co-authored-by: Riley Park <riley.park@meino.net>
Co-authored-by: Jason <11360596+jpenilla@users.noreply.github.com>

.checkstyle/suppressions.xml

@@ -3,5 +3,5 @@
 <suppressions>
     <suppress files=".*[\\/]test[\\/]java[\\/].*" checks="RequireExplicitVisibilityModifier"/>
     <!-- TODO: don't suppress I-prefixed API interfaces under com.earth2me.essentials -->
-    <suppress files="(com[\\/]earth2me[\\/]essentials[\\/]|net[\\/]ess3[\\/])(?:[^\\/]+$|(?!api)[^\\/]+[\\/])" checks="MissingJavadoc(Method|Type)"/>
+    <suppress files="(com[\\/]earth2me[\\/]essentials[\\/]|net[\\/]ess3[\\/]|net[\\/]essentialsx[\\/])(?:[^\\/]+$|(?!api)[^\\/]+[\\/])" checks="MissingJavadoc(Method|Type)"/>
 </suppressions>

.github/workflows/build-master.yml

@@ -58,6 +58,7 @@ jobs:
         mv Essentials/build/docs/javadoc/ javadocs/
         cp -r EssentialsAntiBuild/build/docs/javadoc/ javadocs/EssentialsAntiBuild/
         cp -r EssentialsChat/build/docs/javadoc/ javadocs/EssentialsChat/
+        cp -r EssentialsDiscord/build/docs/javadoc/ javadocs/EssentialsDiscord/
         cp -r EssentialsGeoIP/build/docs/javadoc/ javadocs/EssentialsGeoIP/
         cp -r EssentialsProtect/build/docs/javadoc/ javadocs/EssentialsProtect/
         cp -r EssentialsSpawn/build/docs/javadoc/ javadocs/EssentialsSpawn/

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

@@ -21,6 +21,7 @@
 import com.earth2me.essentials.commands.IEssentialsCommand;
 import com.earth2me.essentials.commands.NoChargeException;
 import com.earth2me.essentials.commands.NotEnoughArgumentsException;
+import com.earth2me.essentials.commands.PlayerNotFoundException;
 import com.earth2me.essentials.commands.QuietAbortException;
 import com.earth2me.essentials.economy.EconomyLayers;
 import com.earth2me.essentials.economy.vault.VaultEconomyProvider;
@@ -38,6 +39,7 @@
 import com.earth2me.essentials.textreader.KeywordReplacer;
 import com.earth2me.essentials.textreader.SimpleTextInput;
 import com.earth2me.essentials.updatecheck.UpdateChecker;
+import com.earth2me.essentials.utils.FormatUtil;
 import com.earth2me.essentials.utils.VersionUtil;
 import io.papermc.lib.PaperLib;
 import net.ess3.api.Economy;
@@ -118,6 +120,7 @@
 import java.util.HashMap;
 import java.util.LinkedHashSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Set;
 import java.util.UUID;
@@ -895,6 +898,94 @@ public User getOfflineUser(final String name) {
         return user;
     }
 
+    @Override
+    public User matchUser(final Server server, final User sourceUser, final String searchTerm, final Boolean getHidden, final boolean getOffline) throws PlayerNotFoundException {
+        final User user;
+        Player exPlayer;
+
+        try {
+            exPlayer = server.getPlayer(UUID.fromString(searchTerm));
+        } catch (final IllegalArgumentException ex) {
+            if (getOffline) {
+                exPlayer = server.getPlayerExact(searchTerm);
+            } else {
+                exPlayer = server.getPlayer(searchTerm);
+            }
+        }
+
+        if (exPlayer != null) {
+            user = getUser(exPlayer);
+        } else {
+            user = getUser(searchTerm);
+        }
+
+        if (user != null) {
+            if (!getOffline && !user.getBase().isOnline()) {
+                throw new PlayerNotFoundException();
+            }
+
+            if (getHidden || canInteractWith(sourceUser, user)) {
+                return user;
+            } else { // not looking for hidden and cannot interact (i.e is hidden)
+                if (getOffline && user.getName().equalsIgnoreCase(searchTerm)) { // if looking for offline and got an exact match
+                    return user;
+                }
+            }
+            throw new PlayerNotFoundException();
+        }
+        final List<Player> matches = server.matchPlayer(searchTerm);
+
+        if (matches.isEmpty()) {
+            final String matchText = searchTerm.toLowerCase(Locale.ENGLISH);
+            for (final User userMatch : getOnlineUsers()) {
+                if (getHidden || canInteractWith(sourceUser, userMatch)) {
+                    final String displayName = FormatUtil.stripFormat(userMatch.getDisplayName()).toLowerCase(Locale.ENGLISH);
+                    if (displayName.contains(matchText)) {
+                        return userMatch;
+                    }
+                }
+            }
+        } else {
+            for (final Player player : matches) {
+                final User userMatch = getUser(player);
+                if (userMatch.getDisplayName().startsWith(searchTerm) && (getHidden || canInteractWith(sourceUser, userMatch))) {
+                    return userMatch;
+                }
+            }
+            final User userMatch = getUser(matches.get(0));
+            if (getHidden || canInteractWith(sourceUser, userMatch)) {
+                return userMatch;
+            }
+        }
+        throw new PlayerNotFoundException();
+    }
+
+    @Override
+    public boolean canInteractWith(final CommandSource interactor, final User interactee) {
+        if (interactor == null) {
+            return !interactee.isHidden();
+        }
+
+        if (interactor.isPlayer()) {
+            return canInteractWith(getUser(interactor.getPlayer()), interactee);
+        }
+
+        return true; // console
+    }
+
+    @Override
+    public boolean canInteractWith(final User interactor, final User interactee) {
+        if (interactor == null) {
+            return !interactee.isHidden();
+        }
+
+        if (interactor.equals(interactee)) {
+            return true;
+        }
+
+        return interactor.getBase().canSee(interactee.getBase());
+    }
+
     //This will create a new user if there is not a match.
     @Override
     public User getUser(final Player base) {

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

@@ -310,8 +310,6 @@ public void run() {
                 user.setDisplayNick();
                 updateCompass(user);
 
-                ess.runTaskAsynchronously(() -> ess.getServer().getPluginManager().callEvent(new AsyncUserDataLoadEvent(user)));
-
                 if (!ess.getVanishedPlayersNew().isEmpty() && !user.isAuthorized("essentials.vanish.see")) {
                     for (final String p : ess.getVanishedPlayersNew()) {
                         final Player toVanish = ess.getServer().getPlayerExact(p);
@@ -328,12 +326,14 @@ public void run() {
                     user.getBase().setSleepingIgnored(true);
                 }
 
+                final String effectiveMessage;
                 if (ess.getSettings().allowSilentJoinQuit() && (user.isAuthorized("essentials.silentjoin") || user.isAuthorized("essentials.silentjoin.vanish"))) {
                     if (user.isAuthorized("essentials.silentjoin.vanish")) {
                         user.setVanished(true);
                     }
+                    effectiveMessage = null;
                 } else if (message == null || hideJoinQuitMessages()) {
-                    //NOOP
+                    effectiveMessage = null;
                 } else if (ess.getSettings().isCustomJoinMessage()) {
                     final String msg = ess.getSettings().getCustomJoinMessage()
                         .replace("{PLAYER}", player.getDisplayName()).replace("{USERNAME}", player.getName())
@@ -345,10 +345,16 @@ public void run() {
                     if (!msg.isEmpty()) {
                         ess.getServer().broadcastMessage(msg);
                     }
+                    effectiveMessage = msg.isEmpty() ? null : msg;
                 } else if (ess.getSettings().allowSilentJoinQuit()) {
                     ess.getServer().broadcastMessage(message);
+                    effectiveMessage = message;
+                } else {
+                    effectiveMessage = message;
                 }
 
+                ess.runTaskAsynchronously(() -> ess.getServer().getPluginManager().callEvent(new AsyncUserDataLoadEvent(user, effectiveMessage)));
+
                 final int motdDelay = ess.getSettings().getMotdDelay() / 50;
                 final DelayMotdTask motdTask = new DelayMotdTask(user);
                 if (motdDelay > 0) {

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

@@ -4,6 +4,7 @@
 import com.earth2me.essentials.api.IJails;
 import com.earth2me.essentials.api.IWarps;
 import com.earth2me.essentials.commands.IEssentialsCommand;
+import com.earth2me.essentials.commands.PlayerNotFoundException;
 import com.earth2me.essentials.perm.PermissionsHandler;
 import com.earth2me.essentials.updatecheck.UpdateChecker;
 import net.ess3.provider.ContainerProvider;
@@ -17,6 +18,7 @@
 import net.ess3.provider.SpawnerItemProvider;
 import net.ess3.provider.SyncCommandsProvider;
 import net.essentialsx.api.v2.services.BalanceTop;
+import org.bukkit.Server;
 import org.bukkit.World;
 import org.bukkit.command.Command;
 import org.bukkit.command.CommandSender;
@@ -52,6 +54,12 @@ public interface IEssentials extends Plugin {
 
     User getUser(Player base);
 
+    User matchUser(Server server, User sourceUser, String searchTerm, Boolean getHidden, boolean getOffline) throws PlayerNotFoundException;
+
+    boolean canInteractWith(CommandSource interactor, User interactee);
+
+    boolean canInteractWith(User interactor, User interactee);
+
     I18n getI18n();
 
     User getOfflineUser(String name);

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

@@ -1,10 +1,12 @@
 package com.earth2me.essentials;
 
 import com.earth2me.essentials.utils.FormatUtil;
+import com.earth2me.essentials.utils.NumberUtil;
 import org.bukkit.ChatColor;
 import org.bukkit.Server;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
@@ -127,4 +129,88 @@ public static String outputFormat(final String group, final String message) {
         return tl("listGroupTag", FormatUtil.replaceFormat(group)) +
             message;
     }
+
+    public static List<String> prepareGroupedList(final IEssentials ess, final String commandLabel, final Map<String, List<User>> playerList) {
+        final List<String> output = new ArrayList<>();
+
+        final Set<String> configGroups = ess.getSettings().getListGroupConfig().keySet();
+        final List<String> asterisk = new ArrayList<>();
+
+        // Loop through the custom defined groups and display them
+        for (final String oConfigGroup : configGroups) {
+            final String groupValue = ess.getSettings().getListGroupConfig().get(oConfigGroup).toString().trim();
+            final String configGroup = oConfigGroup.toLowerCase();
+
+            // If the group value is an asterisk, then skip it, and handle it later
+            if (groupValue.equals("*")) {
+                asterisk.add(oConfigGroup);
+                continue;
+            }
+
+            // If the group value is hidden, we don't need to display it
+            if (groupValue.equalsIgnoreCase("hidden")) {
+                playerList.remove(configGroup);
+                continue;
+            }
+
+            final List<User> outputUserList;
+            final List<User> matchedList = playerList.get(configGroup);
+
+            // If the group value is an int, then we might need to truncate it
+            if (NumberUtil.isInt(groupValue)) {
+                if (matchedList != null && !matchedList.isEmpty()) {
+                    playerList.remove(configGroup);
+                    outputUserList = new ArrayList<>(matchedList);
+                    final int limit = Integer.parseInt(groupValue);
+                    if (matchedList.size() > limit) {
+                        output.add(outputFormat(oConfigGroup, tl("groupNumber", matchedList.size(), commandLabel, FormatUtil.stripFormat(configGroup))));
+                    } else {
+                        output.add(outputFormat(oConfigGroup, listUsers(ess, outputUserList, ", ")));
+                    }
+                    continue;
+                }
+            }
+
+            outputUserList = getMergedList(ess, playerList, configGroup);
+
+            // If we have no users, than we don't need to continue parsing this group
+            if (outputUserList.isEmpty()) {
+                continue;
+            }
+
+            output.add(outputFormat(oConfigGroup, listUsers(ess, outputUserList, ", ")));
+        }
+
+        final Set<String> var = playerList.keySet();
+        String[] onlineGroups = var.toArray(new String[0]);
+        Arrays.sort(onlineGroups, String.CASE_INSENSITIVE_ORDER);
+
+        // If we have an asterisk group, then merge all remaining groups
+        if (!asterisk.isEmpty()) {
+            final List<User> asteriskUsers = new ArrayList<>();
+            for (final String onlineGroup : onlineGroups) {
+                asteriskUsers.addAll(playerList.get(onlineGroup));
+            }
+            for (final String key : asterisk) {
+                playerList.put(key, asteriskUsers);
+            }
+            onlineGroups = asterisk.toArray(new String[0]);
+        }
+
+        // If we have any groups remaining after the custom groups loop through and display them
+        for (final String onlineGroup : onlineGroups) {
+            final List<User> users = playerList.get(onlineGroup);
+            String groupName = asterisk.isEmpty() ? users.get(0).getGroup() : onlineGroup;
+
+            if (ess.getPermissionsHandler().getName().equals("ConfigPermissions")) {
+                groupName = tl("connectedPlayers");
+            }
+            if (users == null || users.isEmpty()) {
+                continue;
+            }
+
+            output.add(outputFormat(groupName, listUsers(ess, users, ", ")));
+        }
+        return output;
+    }
 }

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

@@ -115,7 +115,11 @@ public boolean isAuthorized(final String node) {
 
     @Override
     public boolean isPermissionSet(final String node) {
-        return isPermSetCheck(node);
+        final boolean result = isPermSetCheck(node);
+        if (ess.getSettings().isDebug()) {
+            ess.getLogger().log(Level.INFO, "checking if " + base.getName() + " has " + node + " (set-explicit) - " + result);
+        }
+        return result;
     }
 
     /**

Essentials/src/main/java/com/earth2me/essentials/commands/Commandessentials.java

@@ -58,11 +58,13 @@ public class Commandessentials extends EssentialsCommand {
         "UltraPermissions",
         "PermissionsEx", // permissions (unsupported)
         "GroupManager", // permissions (unsupported)
-        "bPermissions" // permissions (unsupported)
+        "bPermissions", // permissions (unsupported)
+        "DiscordSRV" // potential for issues if EssentialsXDiscord is installed
     );
     private static final List<String> officialPlugins = Arrays.asList(
         "EssentialsAntiBuild",
         "EssentialsChat",
+        "EssentialsDiscord",
         "EssentialsGeoIP",
         "EssentialsProtect",
         "EssentialsSpawn",