Merge branch 'main' into 4-add-mail-functionality

Author: zefir-git

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "weekly"

src/main/java/pro/cloudnode/smp/cloudnodemsg/CloudnodeMSG.java

@@ -49,6 +49,7 @@ public void onEnable() {
         Objects.requireNonNull(getCommand("ignore")).setExecutor(new IgnoreCommand());
         Objects.requireNonNull(getCommand("unignore")).setExecutor(new UnIgnoreCommand());
         Objects.requireNonNull(getCommand("togglemsg")).setExecutor(new ToggleMessageCommand());
+        Objects.requireNonNull(getCommand("teammsg")).setExecutor(new TeamMessageCommand());
         Objects.requireNonNull(getCommand("mail")).setExecutor(new MailCommand());
 
         getServer().getPluginManager().registerEvents(new AsyncChatListener(), this);

src/main/java/pro/cloudnode/smp/cloudnodemsg/Message.java

@@ -110,6 +110,7 @@ else if (sender.isOnline())
 
     public static final @NotNull NamespacedKey IGNORED_PLAYERS = new NamespacedKey(CloudnodeMSG.getInstance(), "ignored");
     public static final @NotNull NamespacedKey CHANNEL_RECIPIENT = new NamespacedKey(CloudnodeMSG.getInstance(), "channel-recipient");
+    public static final @NotNull NamespacedKey CHANNEL_TEAM = new NamespacedKey(CloudnodeMSG.getInstance(), "channel-team");
 
     /**
      * Get UUID set of ignored players from PDC string
@@ -193,6 +194,7 @@ public static boolean isIncomingEnabled(final @NotNull Player player) {
      */
     public static void createChannel(final @NotNull Player player, final @NotNull OfflinePlayer recipient) {
         player.getPersistentDataContainer().set(CHANNEL_RECIPIENT, PersistentDataType.STRING, recipient.getUniqueId().toString());
+        player.getPersistentDataContainer().remove(CHANNEL_TEAM);
     }
 
     /**
@@ -224,4 +226,32 @@ public static boolean hasChannel(final @NotNull Player player, final @NotNull Of
         final @NotNull Optional<@NotNull OfflinePlayer> channel = getChannel(player);
         return channel.isPresent() && channel.get().getUniqueId().equals(recipient.getUniqueId());
     }
+
+    /**
+     * Team message channel
+     *
+     * @param player The player
+     */
+    public static void createTeamChannel(final @NotNull Player player) {
+        player.getPersistentDataContainer().set(CHANNEL_TEAM, PersistentDataType.BOOLEAN, true);
+        player.getPersistentDataContainer().remove(CHANNEL_RECIPIENT);
+    }
+
+    /**
+     * Exit team message channel
+     *
+     * @param player The player
+     */
+    public static void exitTeamChannel(final @NotNull Player player) {
+        player.getPersistentDataContainer().remove(CHANNEL_TEAM);
+    }
+
+    /**
+     * Check whether player has a team message channel
+     *
+     * @param player The player
+     */
+    public static boolean hasTeamChannel(final @NotNull Player player) {
+        return player.getPersistentDataContainer().getOrDefault(CHANNEL_TEAM, PersistentDataType.BOOLEAN, false);
+    }
 }

src/main/java/pro/cloudnode/smp/cloudnodemsg/Permission.java

@@ -8,6 +8,11 @@ public final class Permission {
      */
     public final static @NotNull String USE = "cloudnodemsg.use";
 
+    /**
+     * Allow using the team message command (/teammsg)
+     */
+    public final static @NotNull String USE_TEAM = "cloudnodemsg.use.team";
+
     /**
      * Allows reloading the plugin
      */

src/main/java/pro/cloudnode/smp/cloudnodemsg/PluginConfig.java

@@ -6,6 +6,7 @@
 import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
 import org.bukkit.OfflinePlayer;
 import org.bukkit.configuration.file.FileConfiguration;
+import org.bukkit.scoreboard.Team;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.HashMap;
@@ -87,6 +88,28 @@ public PluginConfig(final @NotNull FileConfiguration config) {
         );
     }
 
+    /**
+     * Team message
+     * <p>Uses the vanilla teams from `/team`</p>
+     * <p>Placeholders:</p>
+     * <ul>
+     *     <li>{@code <sender>} - the username of the message sender</li>
+     *     <li>{@code <team>} - team</li>
+     *     <li>{@code <message>} - the message text</li>
+     * </ul>
+     *
+     * @param sender The username of the message sender
+     * @param team The team
+     * @param message The message text
+     */
+    public @NotNull Component team(final @NotNull String sender, final @NotNull Team team, final @NotNull Component message) {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("team"))
+                        .replace("<sender>", sender),
+                Placeholder.component("team", team.displayName()),
+                Placeholder.component("message", message)
+        );
+    }
+
     /**
      * Private message format as seen by people with the spy permission and console
      * <p>Placeholders:</p>
@@ -108,6 +131,27 @@ public PluginConfig(final @NotNull FileConfiguration config) {
         );
     }
 
+    /**
+     * Team message format as seen by people with the spy permission and console
+     * <p>Placeholders:</p>
+     * <ul>
+     *     <li>{@code <sender>} - the username of the message sender</li>
+     *     <li>{@code <team>} - team</li>
+     *     <li>{@code <message>} - the message text</li>
+     * </ul>
+     *
+     * @param sender The username of the message sender
+     * @param team The team
+     * @param message The message text
+     */
+    public @NotNull Component teamSpy(final @NotNull String sender, final @NotNull Team team, final @NotNull Component message) {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("team-spy"))
+                        .replace("<sender>", sender),
+                Placeholder.component("team", team.displayName()),
+                Placeholder.component("message", message)
+        );
+    }
+
     /**
      * Player has successfully been ignored
      * <p>Placeholders:</p>
@@ -191,6 +235,40 @@ public PluginConfig(final @NotNull FileConfiguration config) {
                         .replace("<recipient>", Message.name(recipient)));
     }
 
+    /**
+     * Team chat channel created
+     * <p>Placeholders:</p>
+     * <ul>
+     *     <li>{@code <sender>} - the username of the message sender</li>
+     *     <li>{@code <team>} - team</li>
+     * </ul>
+     *
+     * @param sender The username of the message sender
+     * @param team The team@
+     */
+    public @NotNull Component channelTeamCreated(final @NotNull String sender, final @NotNull Team team) {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("channel.team-created"))
+                        .replace("<sender>", sender),
+                Placeholder.component("team", team.displayName()));
+    }
+
+    /**
+     * Team chat channel closed
+     * <p>Placeholders:</p>
+     * <ul>
+     *     <li>{@code <sender>} - the username of the message sender</li>
+     *     <li>{@code <team>} - team</li>
+     * </ul>
+     *
+     * @param sender The username of the message sender
+     * @param team The team
+     */
+    public @NotNull Component channelTeamClosed(final @NotNull String sender, final @NotNull Team team) {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("channel.team-closed"))
+                        .replace("<sender>", sender),
+                Placeholder.component("team", team.displayName()));
+    }
+
     /**
      * Command usage format
      * <p>Placeholders:</p>
@@ -419,5 +497,12 @@ public int mailNotifyInterval() {
                 Placeholder.unparsed("player", Message.name(player))
         );
     }
+
+    /**
+     * Trying to message a team, but not in one
+     */
+    public @NotNull Component notInTeam() {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("errors.not-in-team")));
+    }
 }
 

src/main/java/pro/cloudnode/smp/cloudnodemsg/command/TeamMessageCommand.java

@@ -0,0 +1,59 @@
+package pro.cloudnode.smp.cloudnodemsg.command;
+
+import net.kyori.adventure.text.Component;
+import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
+import org.bukkit.scoreboard.Team;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
+import pro.cloudnode.smp.cloudnodemsg.Message;
+import pro.cloudnode.smp.cloudnodemsg.Permission;
+import pro.cloudnode.smp.cloudnodemsg.error.NoPermissionError;
+import pro.cloudnode.smp.cloudnodemsg.error.NotPlayerError;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+
+public class TeamMessageCommand extends Command {
+    @Override
+    public boolean run(@NotNull CommandSender sender, @NotNull String label, @NotNull String[] args) {
+        if (!sender.hasPermission(Permission.USE_TEAM)) return new NoPermissionError().send(sender);
+        if (!(sender instanceof Player player)) return new NotPlayerError().send(sender);
+        final @NotNull Optional<@NotNull Team> team = Optional.ofNullable(player.getScoreboard().getPlayerTeam(player));
+        if (team.isEmpty()) return sendMessage(player, CloudnodeMSG.getInstance().config().notInTeam());
+        if (args.length == 0) {
+            if (Message.hasTeamChannel(player)) {
+                Message.exitTeamChannel(player);
+                return sendMessage(player, CloudnodeMSG.getInstance().config().channelTeamClosed(player.getName(), team.get()));
+            }
+            else {
+                Message.createTeamChannel(player);
+                return sendMessage(player, CloudnodeMSG.getInstance().config().channelTeamCreated(player.getName(), team.get()));
+            }
+        }
+        return sendTeamMessage(player, team.get(), Component.text(String.join(" ", args)));
+    }
+
+    @Override
+    public @Nullable List<String> onTabComplete(@NotNull CommandSender sender, org.bukkit.command.@NotNull Command command, @NotNull String label, @NotNull String[] args) {
+        return new ArrayList<>();
+    }
+
+    /**
+     * Send message to online team members
+     */
+    public static boolean sendTeamMessage(final @NotNull Player sender, final @NotNull Team team, final @NotNull Component message) {
+        for (final @NotNull Player player : sender.getServer().getOnlinePlayers()) {
+            if (Optional.ofNullable(player.getScoreboard().getPlayerTeam(player)).map(t -> t.equals(team)).orElse(false))
+                sendMessage(player, CloudnodeMSG.getInstance().config().team(sender.getName(), team, message));
+            else if (player.hasPermission(Permission.SPY)) sendMessage(player, CloudnodeMSG.getInstance().config().teamSpy(sender.getName(), team, message));
+        }
+        sender.getServer().getConsoleSender().sendMessage(CloudnodeMSG.getInstance().config().teamSpy(sender.getName(), team, message));
+
+        return true;
+    }
+}

src/main/java/pro/cloudnode/smp/cloudnodemsg/error/NotInTeamError.java

@@ -0,0 +1,15 @@
+package pro.cloudnode.smp.cloudnodemsg.error;
+
+import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
+
+/**
+ * Only players can use this command
+ */
+public final class NotInTeamError extends Error {
+    /**
+     * Only players can use this command
+     */
+    public NotInTeamError() {
+        super(CloudnodeMSG.getInstance().config().notInTeam());
+    }
+}

src/main/java/pro/cloudnode/smp/cloudnodemsg/listener/AsyncChatListener.java

@@ -8,9 +8,11 @@
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.EventPriority;
 import org.bukkit.event.Listener;
+import org.bukkit.scoreboard.Team;
 import org.jetbrains.annotations.NotNull;
 import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
 import pro.cloudnode.smp.cloudnodemsg.Permission;
+import pro.cloudnode.smp.cloudnodemsg.command.TeamMessageCommand;
 import pro.cloudnode.smp.cloudnodemsg.error.InvalidPlayerError;
 import pro.cloudnode.smp.cloudnodemsg.Message;
 
@@ -57,4 +59,18 @@ public void channels(final @NotNull AsyncChatEvent event) {
             e.log().send(sender);
         }
     }
+
+    @EventHandler (priority = EventPriority.HIGHEST)
+    public void teamChannel(final @NotNull AsyncChatEvent event) {
+        final @NotNull Player sender = event.getPlayer();
+        if (!Message.hasTeamChannel(sender)) return;
+        event.setCancelled(true);
+        final @NotNull Optional<@NotNull Team> team = Optional.ofNullable(sender.getScoreboard().getPlayerTeam(sender));
+        if (team.isEmpty()) {
+            Message.exitTeamChannel(sender);
+            sender.sendMessage(CloudnodeMSG.getInstance().config().notInTeam());
+            return;
+        }
+        TeamMessageCommand.sendTeamMessage(sender, team.get(), event.message());
+    }
 }

src/main/resources/config.yml

@@ -41,10 +41,22 @@ incoming: '<click:suggest_command:/msg <sender> ><dark_gray>[<#60a5fa><sender></
 # Same placeholders as incoming
 outgoing: '<click:suggest_command:/msg <recipient> ><dark_gray>[<#93c5fd>me</#93c5fd> <white>-></white> <#60a5fa><recipient></#60a5fa>]</dark_gray></click> <reset><#dbeafe><message></#dbeafe>'
 
+# Team message
+# Uses the vanilla teams from `/team`
+# Placeholders:
+#  <sender> - the username of the message sender
+#  <team> - team display name
+#  <message> - the message text
+team: '<click:suggest_command:/tm ><dark_gray>[<white><team></white>] <gray><sender></gray>:</dark_gray> <white><message></white></click>'
+
 # Private message format as seen by people with the spy permission and console
 # Same placeholders as incoming
 spy: '<dark_gray>[SPY] [<click:suggest_command:/msg <sender> ><gray><sender></gray></click> -> <click:suggest_command:/msg <recipient> ><gray><recipient></gray></click>] <gray><message></gray></dark_gray>'
 
+# Team message format as seen by people with the spy permission and console
+# Same placeholders as team
+team-spy: '<dark_gray>[SPY]</dark_gray> <dark_gray>[<white><team></white>] <gray><click:suggest_command:/msg <sender> ><sender></click></gray>:</dark_gray> <gray><message></gray>'
+
 # Player has successfully been ignored
 # Placeholders:
 #  <player> - the player's username
@@ -72,6 +84,16 @@ channel:
     #  <recipient> - the username of the message recipient
     offline: <red>(!) Player <gray><recipient></gray> is offline. Your chat messages have been switched back to <gray>public</gray>.</red>
 
+    # Team chat channel created
+    # Placeholders:
+    #  <sender> - the username of the message sender
+    #  <team> - team display name
+    team-created: <green>(!) Your chat messages will now be sent as private team messages in <gray><team></gray>. To re-enable public messages, run <click:suggest_command:/teammsg><gray>/teammsg</gray></click></green>
+
+    # Team chat channel closed
+    # Same placeholders as created
+    team-closed: <yellow>(!) Your chat messages will now be <gray>public</gray>.</yellow>
+
 # Name for console/server that should appear as <sender> or <recipient> in messages
 console-name: "Server"
 
@@ -166,3 +188,6 @@ errors:
     # Placeholders:
     #  <player> - the player's username
     incoming-disabled: "<red>(!) You cannot message <gray><player></gray> because they have disabled private messages.</red>"
+
+    # Trying to message a team, but not in one
+    not-in-team: "<red>(!) You are not in a team.</red>"

src/main/resources/plugin.yml

@@ -27,6 +27,10 @@ commands:
         description: Toggles private messages from a player
         usage: /<command> <player>
         aliases: [ "toggledms", "togglepms" ]
+    teammsg:
+        description: Send a private message to your teammates
+        usage: /<command> <message>
+        aliases: [ "tmsg", "teamchat" , "tm" ]
     mail:
         description: Send and receive offline messages
         usage: /<command>