From 9523d670b090746d05793d024712a326e9e4bb63 Mon Sep 17 00:00:00 2001 From: Pablete1234 Date: Mon, 21 Nov 2022 05:05:17 +0100 Subject: [PATCH 1/2] Fix tab-completion for /msg & cleanup chat dispatcher Signed-off-by: Pablete1234 --- .../tc/oc/pgm/command/SettingCommand.java | 8 + .../tc/oc/pgm/command/util/CommandGraph.java | 2 +- .../tc/oc/pgm/listeners/ChatDispatcher.java | 309 +++++++----------- .../main/java/tc/oc/pgm/util/Audience.java | 10 + 4 files changed, 142 insertions(+), 187 deletions(-) diff --git a/core/src/main/java/tc/oc/pgm/command/SettingCommand.java b/core/src/main/java/tc/oc/pgm/command/SettingCommand.java index ef0799593f..b266bb6fab 100644 --- a/core/src/main/java/tc/oc/pgm/command/SettingCommand.java +++ b/core/src/main/java/tc/oc/pgm/command/SettingCommand.java @@ -21,6 +21,14 @@ // TODO: remove some of these when settings UI is released public final class SettingCommand { + public static final SettingCommand INSTANCE = new SettingCommand(); + + public static SettingCommand getInstance() { + return INSTANCE; + } + + private SettingCommand() {} + @CommandMethod("settings") @CommandDescription("Open the settings menu") public void settings(MatchPlayer player) { diff --git a/core/src/main/java/tc/oc/pgm/command/util/CommandGraph.java b/core/src/main/java/tc/oc/pgm/command/util/CommandGraph.java index 1a181063e9..613f02b4dd 100644 --- a/core/src/main/java/tc/oc/pgm/command/util/CommandGraph.java +++ b/core/src/main/java/tc/oc/pgm/command/util/CommandGraph.java @@ -216,7 +216,7 @@ public void registerCommands() { register(new ModeCommand()); register(new ProximityCommand()); register(new RestartCommand()); - register(new SettingCommand()); + register(SettingCommand.getInstance()); register(new StartCommand()); register(new StatsCommand()); register(new TeamCommand()); diff --git a/core/src/main/java/tc/oc/pgm/listeners/ChatDispatcher.java b/core/src/main/java/tc/oc/pgm/listeners/ChatDispatcher.java index 8e12bff44d..5ef11e76ed 100644 --- a/core/src/main/java/tc/oc/pgm/listeners/ChatDispatcher.java +++ b/core/src/main/java/tc/oc/pgm/listeners/ChatDispatcher.java @@ -6,7 +6,7 @@ import static net.kyori.adventure.text.Component.space; import static net.kyori.adventure.text.Component.text; import static net.kyori.adventure.text.Component.translatable; -import static tc.oc.pgm.util.text.TextTranslations.translate; +import static tc.oc.pgm.util.text.TextException.exception; import cloud.commandframework.annotations.Argument; import cloud.commandframework.annotations.CommandDescription; @@ -16,6 +16,8 @@ import com.google.common.cache.Cache; import com.google.common.cache.CacheBuilder; import com.google.common.collect.Maps; +import java.util.Collection; +import java.util.Collections; import java.util.Map; import java.util.Optional; import java.util.Set; @@ -23,6 +25,7 @@ import java.util.concurrent.TimeUnit; import java.util.function.Predicate; import java.util.stream.Collectors; +import net.kyori.adventure.identity.Identity; import net.kyori.adventure.sound.Sound; import net.kyori.adventure.text.Component; import net.kyori.adventure.text.TextComponent; @@ -34,6 +37,7 @@ import org.bukkit.event.EventPriority; import org.bukkit.event.Listener; import org.bukkit.event.player.AsyncPlayerChatEvent; +import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import tc.oc.pgm.api.PGM; import tc.oc.pgm.api.Permissions; @@ -44,13 +48,14 @@ import tc.oc.pgm.api.player.VanishManager; import tc.oc.pgm.api.setting.SettingKey; import tc.oc.pgm.api.setting.SettingValue; +import tc.oc.pgm.command.SettingCommand; import tc.oc.pgm.ffa.Tribute; import tc.oc.pgm.util.Audience; import tc.oc.pgm.util.Players; -import tc.oc.pgm.util.UsernameFormatUtils; import tc.oc.pgm.util.bukkit.BukkitUtils; import tc.oc.pgm.util.bukkit.OnlinePlayerMapAdapter; import tc.oc.pgm.util.named.NameStyle; +import tc.oc.pgm.util.text.TextException; import tc.oc.pgm.util.text.TextTranslations; public class ChatDispatcher implements Listener { @@ -107,7 +112,7 @@ public void removeMuted(MatchPlayer player) { } public boolean isMuted(MatchPlayer player) { - return player != null ? muted.containsKey(player.getId()) : false; + return player != null && muted.containsKey(player.getId()); } public Set getMutedUUIDs() { @@ -117,34 +122,34 @@ public Set getMutedUUIDs() { @CommandMethod("g|all [message]") @CommandDescription("Send a message to everyone") public void sendGlobal( - Match match, MatchPlayer sender, @Argument("message") @Greedy String message) { - if (sender != null && sender.isVanished()) { + Match match, @NotNull MatchPlayer sender, @Argument("message") @Greedy String message) { + if (sender.isVanished()) { sendAdmin(match, sender, message); return; } + throwMuted(sender); - if (checkMute(sender)) { - send( - match, - sender, - message, - GLOBAL_FORMAT, - getChatFormat(null, sender, message), - viewer -> true, - SettingValue.CHAT_GLOBAL); - } + send( + match, + sender, + message, + GLOBAL_FORMAT, + getChatFormat(null, sender, message), + match.getPlayers(), + viewer -> true, + SettingValue.CHAT_GLOBAL); } @CommandMethod("t [message]") @CommandDescription("Send a message to your team") public void sendTeam( - Match match, MatchPlayer sender, @Argument("message") @Greedy String message) { - if (sender != null && sender.isVanished()) { + Match match, @NotNull MatchPlayer sender, @Argument("message") @Greedy String message) { + if (sender.isVanished()) { sendAdmin(match, sender, message); return; } - final Party party = sender == null ? match.getDefaultParty() : sender.getParty(); + final Party party = sender.getParty(); // No team chat when playing free-for-all or match end, default to global chat if (party instanceof Tribute || match.isFinished()) { @@ -152,28 +157,28 @@ public void sendTeam( return; } - if (checkMute(sender)) { - send( - match, - sender, - message, - TextTranslations.translateLegacy(party.getChatPrefix(), null) + PREFIX_FORMAT, - getChatFormat(party.getChatPrefix(), sender, message), - viewer -> - party.equals(viewer.getParty()) - || (viewer.isObserving() - && viewer.getBukkit().hasPermission(Permissions.ADMINCHAT)), - SettingValue.CHAT_TEAM); - } + throwMuted(sender); + send( + match, + sender, + message, + TextTranslations.translateLegacy(party.getChatPrefix(), null) + PREFIX_FORMAT, + getChatFormat(party.getChatPrefix(), sender, message), + match.getPlayers(), + viewer -> + party.equals(viewer.getParty()) + || (viewer.isObserving() + && viewer.getBukkit().hasPermission(Permissions.ADMINCHAT)), + SettingValue.CHAT_TEAM); } @CommandMethod("a [message]") @CommandDescription("Send a message to operators") @CommandPermission(Permissions.ADMINCHAT) public void sendAdmin( - Match match, MatchPlayer sender, @Argument("message") @Greedy String message) { + Match match, @NotNull MatchPlayer sender, @Argument("message") @Greedy String message) { // If a player managed to send a default message without permissions, reset their chat channel - if (sender != null && !sender.getBukkit().hasPermission(Permissions.ADMINCHAT)) { + if (!sender.getBukkit().hasPermission(Permissions.ADMINCHAT)) { sender.getSettings().resetValue(SettingKey.CHAT); SettingKey.CHAT.update(sender); sender.sendWarning(translatable("misc.noPermission")); @@ -186,6 +191,7 @@ public void sendAdmin( message != null ? BukkitUtils.colorize(message) : null, AC_FORMAT, getChatFormat(ADMIN_CHAT_PREFIX, sender, message), + match.getPlayers(), AC_FILTER, SettingValue.CHAT_ADMIN); @@ -202,60 +208,31 @@ public void sendAdmin( @CommandDescription("Send a direct message to a player") public void sendDirect( Match match, - MatchPlayer sender, - @Argument("player") Player receiver, + @NotNull MatchPlayer sender, + @Argument("player") MatchPlayer receiver, @Argument("message") @Greedy String message) { - if (sender == null) return; + if (vanish.isVanished(sender.getId())) throw exception("vanish.chat.deny"); - if (vanish.isVanished(sender.getId())) { - sender.sendWarning(translatable("vanish.chat.deny")); - return; - } - - if (isMuted(sender) && !receiver.hasPermission(Permissions.STAFF)) { - sendMutedMessage(sender); - return; // Muted players may only message staff - } - - MatchPlayer matchReceiver = manager.getPlayer(receiver); - if (matchReceiver != null) { - - // Vanish Check - Don't allow messages to vanished - if (vanish.isVanished(matchReceiver.getId())) { - sender.sendWarning(translatable("command.playerNotFound")); - return; - } + if (!receiver.getBukkit().hasPermission(Permissions.STAFF)) throwMuted(sender); - SettingValue option = matchReceiver.getSettings().getValue(SettingKey.MESSAGE); + SettingValue option = receiver.getSettings().getValue(SettingKey.MESSAGE); - if (option.equals(SettingValue.MESSAGE_OFF) - && !sender.getBukkit().hasPermission(Permissions.STAFF)) { - Component blocked = - translatable("command.message.blocked", matchReceiver.getName(NameStyle.FANCY)); - sender.sendWarning(blocked); - return; - } + if (!sender.getBukkit().hasPermission(Permissions.STAFF)) { + if (option.equals(SettingValue.MESSAGE_OFF)) + throw exception("command.message.blocked", receiver.getName(NameStyle.FANCY)); - if (isMuted(matchReceiver) && !sender.getBukkit().hasPermission(Permissions.STAFF)) { - Component muted = - translatable("moderation.mute.target", matchReceiver.getName(NameStyle.CONCISE)); - sender.sendWarning(muted); - return; // Only staff can message muted players - } else { - playSound(matchReceiver, DM_SOUND); - } + if (isMuted(receiver)) + throw exception("moderation.mute.target", receiver.getName(NameStyle.CONCISE)); } - if (sender != null) { - lastMessagedBy.put(receiver, sender.getId()); - } + lastMessagedBy.put(receiver.getBukkit(), sender.getId()); // Send message to receiver send( match, sender, message, - formatPrivateMessage("misc.from", matchReceiver.getBukkit()), + formatPrivateMessage("misc.from", receiver.getBukkit()), getChatFormat( text() .append(translatable("misc.from", NamedTextColor.GRAY, TextDecoration.ITALIC)) @@ -263,13 +240,14 @@ public void sendDirect( .build(), sender, message), - viewer -> viewer.getBukkit().equals(receiver), + Collections.singleton(receiver), + r -> true, null); // Send message to the sender send( match, - manager.getPlayer(receiver), // Allow for cross-match messages + receiver, message, formatPrivateMessage("misc.to", sender.getBukkit()), getChatFormat( @@ -277,10 +255,12 @@ public void sendDirect( .append(translatable("misc.to", NamedTextColor.GRAY, TextDecoration.ITALIC)) .append(space()) .build(), - manager.getPlayer(receiver), + receiver, message), - viewer -> viewer.getBukkit().equals(sender.getBukkit()), + Collections.singleton(sender), + s -> true, null); + playSound(receiver, DM_SOUND); } private String formatPrivateMessage(String key, CommandSender viewer) { @@ -292,15 +272,11 @@ private String formatPrivateMessage(String key, CommandSender viewer) { @CommandMethod("reply|r ") @CommandDescription("Reply to a direct message") public void sendReply( - Match match, MatchPlayer sender, @Argument("message") @Greedy String message) { - if (sender == null) return; + Match match, @NotNull MatchPlayer sender, @Argument("message") @Greedy String message) { final MatchPlayer receiver = manager.getPlayer(lastMessagedBy.get(sender.getBukkit())); - if (receiver == null) { - sender.sendWarning(translatable("command.message.noReply", text("/msg"))); - return; - } + if (receiver == null) throw exception("command.message.noReply", text("/msg")); - sendDirect(match, sender, receiver.getBukkit(), message); + sendDirect(match, sender, receiver, message); } @EventHandler(ignoreCancelled = true, priority = EventPriority.MONITOR) @@ -313,22 +289,20 @@ public void onChat(AsyncPlayerChatEvent event) { } final MatchPlayer player = manager.getPlayer(event.getPlayer()); - if (player != null) { - final String message = event.getMessage(); + if (player == null) return; + + final String message = event.getMessage(); + try { if (message.startsWith(GLOBAL_SYMBOL)) { sendGlobal(player.getMatch(), player, message.substring(1)); } else if (message.startsWith(DM_SYMBOL) && message.contains(" ")) { final String target = message.substring(1, message.indexOf(" ")); final MatchPlayer receiver = Players.getMatchPlayer(event.getPlayer(), target); if (receiver == null) { - player.sendWarning(translatable("chat.message.unknownTarget", text(target))); + player.sendWarning(translatable("command.playerNotFound")); } else { - sendDirect( - player.getMatch(), - player, - receiver.getBukkit(), - message.replace(target, "").substring(1)); + sendDirect(player.getMatch(), player, receiver, message.substring(2 + target.length())); } } else if (message.startsWith(ADMIN_CHAT_SYMBOL) && player.getBukkit().hasPermission(Permissions.ADMINCHAT)) { @@ -336,13 +310,14 @@ public void onChat(AsyncPlayerChatEvent event) { } else { sendDefault(player.getMatch(), player, event.getMessage()); } + } catch (TextException e) { + // Allow sub-handlers to throw command exceptions just fine + player.sendWarning(e); } } - public void sendDefault(Match match, MatchPlayer sender, String message) { - switch (sender == null - ? SettingValue.CHAT_GLOBAL - : sender.getSettings().getValue(SettingKey.CHAT)) { + public void sendDefault(Match match, @NotNull MatchPlayer sender, String message) { + switch (sender.getSettings().getValue(SettingKey.CHAT)) { case CHAT_TEAM: sendTeam(match, sender, message); return; @@ -354,99 +329,62 @@ public void sendDefault(Match match, MatchPlayer sender, String message) { } } - public void playSound(MatchPlayer player, Sound sound) { - SettingValue value = player.getSettings().getValue(SettingKey.SOUNDS); - if ((sound.equals(AC_SOUND) && value.equals(SettingValue.SOUNDS_ALL)) - || (sound.equals(DM_SOUND) && !value.equals(SettingValue.SOUNDS_NONE))) { - player.playSound(sound); - } - } - private static final Cache CHAT_EVENT_CACHE = CacheBuilder.newBuilder().weakKeys().expireAfterWrite(15, TimeUnit.SECONDS).build(); public void send( - Match match, - MatchPlayer sender, - @Nullable String text, - String format, - Component componentMsg, - Predicate filter, - @Nullable SettingValue type) { + final @NotNull Match match, + final @NotNull MatchPlayer sender, + final @Nullable String text, + final @NotNull String format, + final @NotNull Component componentMsg, + final @NotNull Collection matchPlayers, + final @NotNull Predicate filter, + final @Nullable SettingValue type) { + final String message = text == null ? null : text.trim(); // When a message is empty, this indicates the player wants to change their default chat channel - if ((text == null || text.isEmpty()) && sender != null) { - // FIXME: there should be a better way to do this - PGM.get() - .getExecutor() - .schedule( - () -> - sender - .getBukkit() - .performCommand("set " + SettingKey.CHAT + " " + type.getName()), - 50, - TimeUnit.MILLISECONDS); // Run sync to stop console spam + if (message == null || message.isEmpty()) { + if (type != null) SettingCommand.getInstance().toggle(sender, SettingKey.CHAT, type); return; } - final String message = text.trim(); - - if (sender != null) { - PGM.get() - .getAsyncExecutor() - .execute( - () -> { - final AsyncPlayerChatEvent event = - new AsyncPlayerChatEvent( - false, - sender.getBukkit(), - message, - match.getPlayers().stream() - .filter(filter) - .map(MatchPlayer::getBukkit) - .collect(Collectors.toSet())); - event.setFormat(format); - CHAT_EVENT_CACHE.put(event, true); - match.callEvent(event); - - if (event.isCancelled()) { - return; - } - - event.getRecipients().stream() - .map(Audience::get) - .forEach(player -> player.sendMessage(identity(sender.getId()), componentMsg)); - }); - return; - } - match.getPlayers().stream() - .filter(filter) - .forEach( - player -> - player.sendMessage( - text( - String.format( - format, - translate( - UsernameFormatUtils.CONSOLE_NAME, - TextTranslations.getLocale(player.getBukkit())), - message)))); - } + final Set players = + matchPlayers.stream() + .filter(filter) + .map(MatchPlayer::getBukkit) + .collect(Collectors.toSet()); - private void sendMutedMessage(MatchPlayer player) { - Component warning = - translatable( - "moderation.mute.message", - text(muted.getOrDefault(player.getId(), ""), NamedTextColor.AQUA)); - player.sendWarning(warning); + PGM.get() + .getAsyncExecutor() + .execute(() -> asyncSendChat(match, sender, message, format, componentMsg, players)); } - private boolean checkMute(MatchPlayer player) { - if (isMuted(player)) { - sendMutedMessage(player); - return false; - } + private void asyncSendChat( + final @NotNull Match match, + final @NotNull MatchPlayer sender, + final @NotNull String message, + final @NotNull String format, + final @NotNull Component componentMsg, + final @NotNull Set players) { + final AsyncPlayerChatEvent event = + new AsyncPlayerChatEvent(false, sender.getBukkit(), message, players); + event.setFormat(format); + CHAT_EVENT_CACHE.put(event, true); + match.callEvent(event); + + if (event.isCancelled()) return; + Identity senderId = identity(sender.getId()); + + event.getRecipients().stream() + .map(Audience::get) + .forEach(player -> player.sendMessage(senderId, componentMsg)); + } - return true; + private void throwMuted(MatchPlayer player) { + if (isMuted(player)) + throw exception( + "moderation.mute.message", + text(muted.getOrDefault(player.getId(), ""), NamedTextColor.AQUA)); } public static void broadcastAdminChatMessage(Component message, Match match) { @@ -461,19 +399,18 @@ public static void broadcastAdminChatMessage( .forEach( mp -> { // If provided a sound, play if setting allows - sound.ifPresent( - s -> { - if (canPlaySound(mp)) { - mp.playSound(s); - } - }); + sound.ifPresent(s -> playSound(mp, s)); mp.sendMessage(formatted); }); Audience.console().sendMessage(formatted); } - private static boolean canPlaySound(MatchPlayer viewer) { - return viewer.getSettings().getValue(SettingKey.SOUNDS).equals(SettingValue.SOUNDS_ALL); + public static void playSound(MatchPlayer player, Sound sound) { + SettingValue value = player.getSettings().getValue(SettingKey.SOUNDS); + if (value.equals(SettingValue.SOUNDS_ALL) + || (sound.equals(DM_SOUND) && value.equals(SettingValue.SOUNDS_DM))) { + player.playSound(sound); + } } private Component getChatFormat(@Nullable Component prefix, MatchPlayer player, String message) { diff --git a/util/src/main/java/tc/oc/pgm/util/Audience.java b/util/src/main/java/tc/oc/pgm/util/Audience.java index 51ee615775..7d370ea09b 100644 --- a/util/src/main/java/tc/oc/pgm/util/Audience.java +++ b/util/src/main/java/tc/oc/pgm/util/Audience.java @@ -4,9 +4,13 @@ import static net.kyori.adventure.sound.Sound.sound; import static net.kyori.adventure.text.Component.text; +import java.util.ArrayList; import java.util.Collection; +import java.util.Collections; import java.util.function.Predicate; +import java.util.stream.Collector; import java.util.stream.Collectors; + import net.kyori.adventure.audience.ForwardingAudience; import net.kyori.adventure.platform.bukkit.BukkitAudiences; import net.kyori.adventure.sound.Sound; @@ -14,6 +18,7 @@ import net.kyori.adventure.text.ComponentLike; import net.kyori.adventure.text.format.NamedTextColor; import org.bukkit.command.CommandSender; +import org.jetbrains.annotations.NotNull; import tc.oc.pgm.util.bukkit.BukkitUtils; /** Receiver of chat messages, sounds, titles, and other media. */ @@ -55,4 +60,9 @@ static Audience filter(Predicate filter, Collection a static Audience empty() { return net.kyori.adventure.audience.Audience::empty; } + + static @NotNull Collector toAudience() { + return Collectors.collectingAndThen(Collectors.toCollection(ArrayList::new), + audiences -> get(Collections.unmodifiableCollection(audiences))); + } } From 2ff5b544cbcbaa9ea83586eda78b35655fd27228 Mon Sep 17 00:00:00 2001 From: Pablete1234 Date: Mon, 21 Nov 2022 13:05:03 +0100 Subject: [PATCH 2/2] Run formatter Signed-off-by: Pablete1234 --- util/src/main/java/tc/oc/pgm/util/Audience.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/util/src/main/java/tc/oc/pgm/util/Audience.java b/util/src/main/java/tc/oc/pgm/util/Audience.java index 7d370ea09b..1aebb71edc 100644 --- a/util/src/main/java/tc/oc/pgm/util/Audience.java +++ b/util/src/main/java/tc/oc/pgm/util/Audience.java @@ -10,7 +10,6 @@ import java.util.function.Predicate; import java.util.stream.Collector; import java.util.stream.Collectors; - import net.kyori.adventure.audience.ForwardingAudience; import net.kyori.adventure.platform.bukkit.BukkitAudiences; import net.kyori.adventure.sound.Sound; @@ -61,8 +60,10 @@ static Audience empty() { return net.kyori.adventure.audience.Audience::empty; } - static @NotNull Collector toAudience() { - return Collectors.collectingAndThen(Collectors.toCollection(ArrayList::new), + static @NotNull Collector + toAudience() { + return Collectors.collectingAndThen( + Collectors.toCollection(ArrayList::new), audiences -> get(Collections.unmodifiableCollection(audiences))); } }