Implements an option to toggle private messages (#26)

Author: Dviih

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

@@ -10,6 +10,7 @@
 import pro.cloudnode.smp.cloudnodemsg.command.ReplyCommand;
 import pro.cloudnode.smp.cloudnodemsg.command.UnIgnoreCommand;
 import pro.cloudnode.smp.cloudnodemsg.listener.AsyncChatListener;
+import pro.cloudnode.smp.cloudnodemsg.command.ToggleMessageCommand;
 
 import java.util.Objects;
 
@@ -33,6 +34,7 @@ public void onEnable() {
         Objects.requireNonNull(getCommand("reply")).setExecutor(new ReplyCommand());
         Objects.requireNonNull(getCommand("ignore")).setExecutor(new IgnoreCommand());
         Objects.requireNonNull(getCommand("unignore")).setExecutor(new UnIgnoreCommand());
+        Objects.requireNonNull(getCommand("togglemsg")).setExecutor(new ToggleMessageCommand());
 
         getServer().getPluginManager().registerEvents(new AsyncChatListener(), this);
     }

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

@@ -27,4 +27,19 @@ public final class Permission {
      * Player's messages are immune to ignoring
      */
     public final static @NotNull String IGNORE_BYPASS = "cloudnodemsg.ignore.bypass";
+
+    /**
+     * Allows using the /togglemsg command
+     */
+    public final static @NotNull String TOGGLE = "cloudnodemsg.toggle";
+
+    /**
+     * Allows using the /togglemsg command for others
+     */
+    public final static @NotNull String TOGGLE_OTHER = "cloudnodemsg.toggle.other";
+
+    /**
+     * Allows to send private message even when the target have their private messages toggled
+     */
+    public final static @NotNull String TOGGLE_BYPASS = "cloudnodemsg.toggle.bypass";
 }

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

@@ -115,6 +115,40 @@ public PluginConfig(final @NotNull FileConfiguration config) {
         return Objects.requireNonNull(config.getString("console-name"));
     }
 
+    public @NotNull Component toggleDisable() {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("toggle.disable.message")));
+    }
+
+    /**
+     * Player's private messages have been toggled off
+     * <p>Placeholders:</p>
+     * <ul><li>{@code <player>} - the player's username</li></ul>
+     *
+     * @param player the player's username
+     */
+    public @NotNull Component toggleDisableOther(final @NotNull String player) {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("toggle.disable.other")),
+                Placeholder.unparsed("player", player)
+        );
+    }
+
+    public @NotNull Component toggleEnable() {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("toggle.enable.message")));
+    }
+
+    /**
+     * Player's private messages have been toggled on
+     * <p>Placeholders:</p>
+     * <ul><li>{@code <player>} - the player's username</li></ul>
+     *
+     * @param player the player's username
+     */
+    public @NotNull Component toggleEnableOther(final @NotNull String player) {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("toggle.enable.other")),
+                Placeholder.unparsed("player", player)
+        );
+    }
+
     /**
      * No permission
      */
@@ -208,5 +242,18 @@ public PluginConfig(final @NotNull FileConfiguration config) {
                 Placeholder.unparsed("player", player)
         );
     }
+
+    /**
+     * Target player have disabled their incoming private messages.
+     * <p>Placeholders:</p>
+     * <ul><li>{@code <player>} - the player's username</li></ul>
+     *
+     * @param player The player's username
+     */
+    public @NotNull Component incomingDisabled(final @NotNull String player) {
+        return MiniMessage.miniMessage().deserialize(Objects.requireNonNull(config.getString("errors.incoming-disabled")),
+                Placeholder.unparsed("player", player)
+        );
+    }
 }
 

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

@@ -10,6 +10,7 @@
 import pro.cloudnode.smp.cloudnodemsg.error.MessageYourselfError;
 import pro.cloudnode.smp.cloudnodemsg.error.NoPermissionError;
 import pro.cloudnode.smp.cloudnodemsg.error.PlayerNotFoundError;
+import pro.cloudnode.smp.cloudnodemsg.error.PlayerHasIncomingDisabledError;
 import pro.cloudnode.smp.cloudnodemsg.message.Message;
 
 import java.util.ArrayList;
@@ -32,6 +33,7 @@ public boolean run(final @NotNull CommandSender sender, final @NotNull String la
         if (recipient.isEmpty() || (CloudnodeMSG.isVanished(recipient.get()) && !sender.hasPermission(Permission.SEND_VANISHED))) return new PlayerNotFoundError(args[0]).send(sender);
         if (sender instanceof final @NotNull Player player && recipient.get().getUniqueId().equals(player.getUniqueId()))
             return new MessageYourselfError().send(sender);
+        if (!Message.isIncomingEnabled(recipient.get()) && !sender.hasPermission(Permission.TOGGLE_BYPASS)) return new PlayerHasIncomingDisabledError(recipient.get().getName()).send(sender);
 
         try {
             new Message(Message.offlinePlayer(sender), recipient.get(), String.join(" ", Arrays.copyOfRange(args, 1, args.length))).send();

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

@@ -9,6 +9,7 @@
 import pro.cloudnode.smp.cloudnodemsg.error.NoPermissionError;
 import pro.cloudnode.smp.cloudnodemsg.error.NobodyReplyError;
 import pro.cloudnode.smp.cloudnodemsg.error.ReplyOfflineError;
+import pro.cloudnode.smp.cloudnodemsg.error.PlayerHasIncomingDisabledError;
 import pro.cloudnode.smp.cloudnodemsg.message.Message;
 
 import java.util.ArrayList;
@@ -26,6 +27,7 @@ public boolean run(final @NotNull CommandSender sender, final @NotNull String la
 
         final @NotNull Optional<@NotNull OfflinePlayer> recipient = Message.getReplyTo(Message.offlinePlayer(sender));
         if (recipient.isEmpty()) return new NobodyReplyError().send(sender);
+        if (!Message.isIncomingEnabled(Objects.requireNonNull(recipient.get().getPlayer())) && !sender.hasPermission(Permission.TOGGLE_BYPASS)) return new PlayerHasIncomingDisabledError(Objects.requireNonNull(recipient.get().getName())).send(sender);
         if (
             !recipient.get().getUniqueId().equals(Message.console.getUniqueId())
             && (

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

@@ -0,0 +1,55 @@
+package pro.cloudnode.smp.cloudnodemsg.command;
+
+import org.bukkit.OfflinePlayer;
+import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
+import pro.cloudnode.smp.cloudnodemsg.Permission;
+import pro.cloudnode.smp.cloudnodemsg.error.NeverJoinedError;
+import pro.cloudnode.smp.cloudnodemsg.error.NoPermissionError;
+import pro.cloudnode.smp.cloudnodemsg.error.NotPlayerError;
+import pro.cloudnode.smp.cloudnodemsg.message.Message;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+
+public final class ToggleMessageCommand extends Command {
+    @Override
+    public boolean run(@NotNull CommandSender sender, @NotNull String label, @NotNull String[] args) {
+        if (!sender.hasPermission(Permission.TOGGLE) || (args.length == 1 && !sender.hasPermission(Permission.TOGGLE_OTHER)))
+            return new NoPermissionError().send(sender);
+        if (args.length == 1) {
+            final @NotNull OfflinePlayer recipient = CloudnodeMSG.getInstance().getServer().getOfflinePlayer(args[0]);
+
+            if (recipient.getPlayer() == null)
+                return new NeverJoinedError(Optional.ofNullable(recipient.getName()).orElse("Unknown Player")).send(sender);
+
+            if (Message.isIncomingEnabled(recipient.getPlayer())) {
+                Message.incomingDisable(recipient.getPlayer());
+                return sendMessage(sender, CloudnodeMSG.getInstance().config().toggleDisableOther(Optional.of(recipient.getPlayer().getName()).orElse("Unknown Player")));
+            }
+
+            Message.incomingEnable(recipient.getPlayer());
+            return sendMessage(sender, CloudnodeMSG.getInstance().config().toggleEnableOther(Optional.of(recipient.getPlayer().getName()).orElse("Unknown Player")));
+        }
+        if (!(sender instanceof final @NotNull Player player)) return new NotPlayerError().send(sender);
+
+        if (Message.isIncomingEnabled(player)) {
+            Message.incomingDisable(player);
+            return sendMessage(sender, CloudnodeMSG.getInstance().config().toggleDisable());
+        }
+
+        Message.incomingEnable(player);
+        return sendMessage(sender, CloudnodeMSG.getInstance().config().toggleEnable());
+    }
+
+    @Override
+    public @Nullable List<String> onTabComplete(@NotNull CommandSender sender, org.bukkit.command.@NotNull Command command, @NotNull String s, @NotNull String[] strings) {
+        if (sender.hasPermission(Permission.TOGGLE_OTHER))
+            return null;
+        return new ArrayList<>();
+    }
+}

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

@@ -0,0 +1,10 @@
+package pro.cloudnode.smp.cloudnodemsg.error;
+
+import org.jetbrains.annotations.NotNull;
+import pro.cloudnode.smp.cloudnodemsg.CloudnodeMSG;
+
+public class PlayerHasIncomingDisabledError extends Error {
+    public PlayerHasIncomingDisabledError(final @NotNull String player) {
+        super(CloudnodeMSG.getInstance().config().incomingDisabled(player));
+    }
+}

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

@@ -5,7 +5,6 @@
 import org.bukkit.OfflinePlayer;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
-import org.bukkit.persistence.PersistentDataContainer;
 import org.bukkit.persistence.PersistentDataType;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -134,4 +133,33 @@ public static void unignore(final @NotNull Player player, final @NotNull Offline
         ignoredPlayers.remove(ignored.getUniqueId());
         player.getPersistentDataContainer().set(IGNORED_PLAYERS, PersistentDataType.STRING, String.join(";", ignoredPlayers.stream().map(UUID::toString).toList()));
     }
+
+    public static final @NotNull NamespacedKey INCOMING_ENABLED = new NamespacedKey(CloudnodeMSG.getInstance(), "incoming_enabled");
+
+    /**
+     * Allows player to receive private messages
+     *
+     * @param player The player
+     */
+    public static void incomingEnable(final @NotNull Player player) {
+        player.getPersistentDataContainer().set(INCOMING_ENABLED, PersistentDataType.BOOLEAN, true);
+    }
+
+    /**
+     * Denies player to receive private messages
+     *
+     * @param player The player
+     */
+    public static void incomingDisable(final @NotNull Player player) {
+        player.getPersistentDataContainer().set(INCOMING_ENABLED, PersistentDataType.BOOLEAN, false);
+    }
+
+    /**
+     * Check if a player allows private messages
+     *
+     * @param player The player
+     */
+    public static boolean isIncomingEnabled(final @NotNull Player player) {
+        return player.getPersistentDataContainer().getOrDefault(INCOMING_ENABLED, PersistentDataType.BOOLEAN, true);
+    }
 }

src/main/resources/config.yml

@@ -30,6 +30,20 @@ usage: "<yellow>(!) Usage:</yellow> <white>/<command> <usage></white>"
 # Plugin reloaded
 reloaded: "<green>(!) Plugin successfully reloaded.</green>"
 
+toggle:
+    disable:
+        # Disable private messages
+        message: "<yellow>(!) You've disabled private messages. Run again to re-enable.</yellow>"
+        # Placeholders:
+        #  <player> - the player's username
+        other: "<green>(!) Disabled private messages for <gray><player></gray>.</green>"
+    enable:
+        # Enable private messages
+        message: "<green>(!) You can now receive private messages again.</green>"
+        # Placeholders:
+        #  <player> - the player's username
+        other: "<green>(!) Re-enabled private messages for <gray><player></gray>.</green>"
+
 # Error messages
 errors:
     # No permission
@@ -69,3 +83,8 @@ errors:
     # Placeholders:
     #  <player> - the player's username
     never-joined: "<red>(!) <gray><player></gray> has never joined this server.</red>"
+
+    # Target player have disabled their incoming private messages.
+    # Placeholders:
+    #  <player> - the player's username
+    incoming-disabled: "<red>(!) You cannot message <gray><player></gray> because they have disabled private messages.</red>"

src/main/resources/plugin.yml

@@ -23,3 +23,7 @@ commands:
         description: Unignore a player
         usage: /<command> <player>
         aliases: [ "unblock" ]
+    togglemsg:
+        description: Toggles private messages from a player
+        usage: /<command> <player>
+        aliases: [ "toggledms", "togglepms" ]