Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add chatbox message filter #619

Merged
merged 14 commits into from
Jun 10, 2024
Merged

Add chatbox message filter #619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
01c907c
add chat hover event filter
zyxkad May 22, 2024
e8221b5
add command filters
zyxkad May 22, 2024
ff336bb
replace the hoverevent with error instead of block to send
zyxkad May 22, 2024
b49b30d
add imports & fix errors
zyxkad May 24, 2024
4c6367f
fix some styles
zyxkad May 24, 2024
30fbaa2
chatBoxNoRunCommand -> chatBoxPreventRunCommand
zyxkad May 24, 2024
a27b770
clearify chatBoxBannedCommands comment
zyxkad May 24, 2024
6a374a0
fix regex pattern escape
zyxkad May 24, 2024
16439fa
update chatBoxDefaultBannedCommands
zyxkad May 27, 2024
41da2ee
add safe exec and wrap commands with it while sending through chatbox
zyxkad May 27, 2024
98b04f4
fix the space between `catch` keyword and the left bracket
zyxkad May 27, 2024
ab05b99
use StringArgumentType.getString instead of context.getArgument
zyxkad May 27, 2024
2b8c5f2
fix forgot to assign the result to variable
zyxkad May 27, 2024
3a51419
Merge branch 'dev/1.19.2' into chatbox-patch
zyxkad Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 197 additions & 32 deletions .../srendi/advancedperipherals/common/addons/computercraft/peripheral/ChatBoxPeripheral.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,28 @@
import de.srendi.advancedperipherals.lib.peripherals.IPeripheralFunction;
import de.srendi.advancedperipherals.network.APNetworking;
import de.srendi.advancedperipherals.network.toclient.ToastToClientPacket;
import net.minecraft.ChatFormatting;
import net.minecraft.network.chat.Component;
import net.minecraft.network.chat.ComponentContents;
import net.minecraft.network.chat.ClickEvent;
import net.minecraft.network.chat.HoverEvent;
import net.minecraft.network.chat.MutableComponent;
import net.minecraft.network.chat.Style;
import net.minecraft.resources.ResourceKey;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.item.TooltipFlag;
import net.minecraft.world.level.Level;
import net.minecraftforge.server.ServerLifecycleHooks;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.List;
import java.util.Optional;
import java.util.UUID;
import java.util.function.Predicate;

import static de.srendi.advancedperipherals.common.commands.APCommands.ROOT_SAFE_EXEC_LITERAL;
import static de.srendi.advancedperipherals.common.addons.computercraft.operations.SimpleFreeOperation.CHAT_MESSAGE;

public class ChatBoxPeripheral extends BasePeripheral<IPeripheralOwner> {
Expand Down Expand Up @@ -69,12 +80,102 @@ protected MethodResult withChatOperation(IPeripheralFunction<Object, MethodResul
return withOperation(CHAT_MESSAGE, null, null, function, null);
}

@Nullable
protected ComponentContents filterComponentContents(@NotNull ComponentContents content) {
return content;
}

private boolean isChatBoxPreventingRunCommand() {
return APConfig.PERIPHERALS_CONFIG.chatBoxPreventRunCommand.get();
}

private List<Predicate<String>> getChatBoxCommandFilters() {
return APConfig.PERIPHERALS_CONFIG.getChatBoxCommandFilters();
}

private boolean shouldWrapCommand(String command) {
return APConfig.PERIPHERALS_CONFIG.chatBoxWrapCommand.get();
}

private boolean isCommandBanned(String command) {
for (Predicate<String> pattern : getChatBoxCommandFilters()) {
if (pattern.test(command)) {
return true;
}
}
return false;
}

private static MutableComponent createFormattedError(String message) {
return Component.literal("[AP] " + message).setStyle(Style.EMPTY.withColor(ChatFormatting.RED).withBold(true));
}

@Nullable
protected Style filterComponentStyle(@NotNull Style style) {
ClickEvent click = style.getClickEvent();
if (click != null) {
if (isChatBoxPreventingRunCommand() && click.getAction() == ClickEvent.Action.RUN_COMMAND) {
style = style
.withClickEvent(null)
.withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT, createFormattedError("'run_command' action is banned")));
} else if (click.getAction() == ClickEvent.Action.RUN_COMMAND || click.getAction() == ClickEvent.Action.SUGGEST_COMMAND) {
String command = click.getValue();
if (command.length() > 0 && command.charAt(0) == '/') {
if (isCommandBanned(command)) {
style = style
.withClickEvent(null)
.withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT, createFormattedError("Command `" + command + "` is banned")));
} else if (shouldWrapCommand(command)) {
style = style.withClickEvent(new ClickEvent(click.getAction(), "/" + ROOT_SAFE_EXEC_LITERAL + " " + command));
}
}
}
}
HoverEvent hover = style.getHoverEvent();
if (hover != null) {
HoverEvent.ItemStackInfo itemInfo = hover.getValue(HoverEvent.Action.SHOW_ITEM);
if (itemInfo != null) {
try {
itemInfo.getItemStack().getTooltipLines(null, TooltipFlag.Default.ADVANCED);
} catch (RuntimeException e) {
style = style.withHoverEvent(new HoverEvent(HoverEvent.Action.SHOW_TEXT, createFormattedError("Invalid item")));
}
}
}
return style;
}

@Nullable
protected MutableComponent filterMessage(@NotNull Component message) {
ComponentContents content = filterComponentContents(message.getContents());
if (content == null) {
return null;
}
MutableComponent out = MutableComponent.create(content);
if (message instanceof MutableComponent mc) {
Style style = filterComponentStyle(mc.getStyle());
if (style == null) {
return null;
}
out.setStyle(style);
}
for (Component comp : message.getSiblings()) {
MutableComponent filtered = filterMessage(comp);
if (filtered == null) {
return null;
}
out.append(filtered);
}
return out;
}

@Nullable
private MutableComponent appendPrefix(String prefix, String brackets, String color) {
Component prefixComponent = Component.literal(APConfig.PERIPHERALS_CONFIG.defaultChatBoxPrefix.get());
if (!prefix.isEmpty()) {
MutableComponent formattablePrefix;
try {
formattablePrefix = MutableComponent.Serializer.fromJson(prefix);
formattablePrefix = Component.Serializer.fromJson(prefix);
prefixComponent = formattablePrefix;
} catch (JsonSyntaxException exception) {
AdvancedPeripherals.debug("Non json prefix, using plain text instead.");
Expand All @@ -83,7 +184,7 @@ private MutableComponent appendPrefix(String prefix, String brackets, String col
}
if (brackets.isEmpty()) brackets = "[]";

return Component.literal(color + brackets.charAt(0) + "\u00a7r").append(prefixComponent).append(color + brackets.charAt(1) + "\u00a7r ");
return filterMessage(Component.literal(color + brackets.charAt(0) + "\u00a7r").append(prefixComponent).append(color + brackets.charAt(1) + "\u00a7r "));
}

/**
Expand Down Expand Up @@ -114,22 +215,34 @@ public final MethodResult sendFormattedMessage(@NotNull IArguments arguments) th
int range = arguments.optInt(4, -1);
ResourceKey<Level> dimension = getLevel().dimension();
MutableComponent component = Component.Serializer.fromJson(message);
if (component == null)
if (component == null) {
return MethodResult.of(null, "incorrect json");
}
component = filterMessage(component);
if (component == null) {
return MethodResult.of(null, "illegal message");
}

if (checkBrackets(arguments.optString(2)))
if (checkBrackets(arguments.optString(2))) {
return MethodResult.of(null, "incorrect bracket string (e.g. [], {}, <>, ...)");
}

MutableComponent preparedMessage = appendPrefix(
StringUtil.convertAndToSectionMark(arguments.optString(1, APConfig.PERIPHERALS_CONFIG.defaultChatBoxPrefix.get())),
arguments.optString(2, "[]"),
StringUtil.convertAndToSectionMark(arguments.optString(3, ""))
).append(component);
);
if (preparedMessage == null) {
return MethodResult.of(null, "illegal prefix");
}
preparedMessage.append(component);
for (ServerPlayer player : ServerLifecycleHooks.getCurrentServer().getPlayerList().getPlayers()) {
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension)
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension) {
continue;
if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange))
}
if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange)) {
player.sendSystemMessage(preparedMessage);
}
}
return MethodResult.of(true);
});
Expand All @@ -142,19 +255,26 @@ public final MethodResult sendMessage(@NotNull IArguments arguments) throws LuaE
int maxRange = APConfig.PERIPHERALS_CONFIG.chatBoxMaxRange.get();
int range = arguments.optInt(4, -1);
ResourceKey<Level> dimension = getLevel().dimension();
if (checkBrackets(arguments.optString(2)))
if (checkBrackets(arguments.optString(2))) {
return MethodResult.of(null, "incorrect bracket string (e.g. [], {}, <>, ...)");
}

MutableComponent preparedMessage = appendPrefix(
StringUtil.convertAndToSectionMark(arguments.optString(1, APConfig.PERIPHERALS_CONFIG.defaultChatBoxPrefix.get())),
arguments.optString(2, "[]"),
StringUtil.convertAndToSectionMark(arguments.optString(3, ""))
).append(message);
);
if (preparedMessage == null) {
return MethodResult.of(null, "illegal prefix");
}
preparedMessage.append(message);
for (ServerPlayer player : ServerLifecycleHooks.getCurrentServer().getPlayerList().getPlayers()) {
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension)
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension) {
continue;
if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange))
}
if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange)) {
player.sendSystemMessage(preparedMessage);
}
}
return MethodResult.of(true);
});
Expand All @@ -169,26 +289,39 @@ public final MethodResult sendFormattedMessageToPlayer(@NotNull IArguments argum
int range = arguments.optInt(5, -1);
ResourceKey<Level> dimension = getLevel().dimension();
ServerPlayer player = getPlayer(playerName);
if (player == null)
if (player == null) {
return MethodResult.of(null, "incorrect player name/uuid");
}

MutableComponent component = Component.Serializer.fromJson(message);
if (component == null)
if (component == null) {
return MethodResult.of(null, "incorrect json");
}
component = filterMessage(component);
if (component == null) {
return MethodResult.of(null, "illegal message");
}

if (checkBrackets(arguments.optString(3)))
if (checkBrackets(arguments.optString(3))) {
return MethodResult.of(null, "incorrect bracket string (e.g. [], {}, <>, ...)");
}

MutableComponent preparedMessage = appendPrefix(
StringUtil.convertAndToSectionMark(arguments.optString(2, APConfig.PERIPHERALS_CONFIG.defaultChatBoxPrefix.get())),
arguments.optString(3, "[]"),
StringUtil.convertAndToSectionMark(arguments.optString(4, ""))
).append(component);
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension)
);
if (preparedMessage == null) {
return MethodResult.of(null, "illegal prefix");
}
preparedMessage.append(component);
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension) {
return MethodResult.of(false, "NOT_SAME_DIMENSION");
}

if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange))
if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange)) {
player.sendSystemMessage(preparedMessage);
}
return MethodResult.of(true);
});
}
Expand All @@ -204,28 +337,45 @@ public final MethodResult sendFormattedToastToPlayer(@NotNull IArguments argumen
int range = arguments.optInt(6, -1);
ResourceKey<Level> dimension = getLevel().dimension();
ServerPlayer player = getPlayer(playerName);
if (player == null)
if (player == null) {
return MethodResult.of(null, "incorrect player name/uuid");
}

MutableComponent messageComponent = Component.Serializer.fromJson(message);
if (messageComponent == null)
if (messageComponent == null) {
return MethodResult.of(null, "incorrect json for message");
}
messageComponent = filterMessage(messageComponent);
if (messageComponent == null) {
return MethodResult.of(null, "illegal message");
}

MutableComponent titleComponent = Component.Serializer.fromJson(title);
if (titleComponent == null)
if (titleComponent == null) {
return MethodResult.of(null, "incorrect json for title");
}
titleComponent = filterMessage(titleComponent);
if (titleComponent == null) {
return MethodResult.of(null, "illegal title");
}

if (checkBrackets(arguments.optString(4)))
if (checkBrackets(arguments.optString(4))) {
return MethodResult.of(null, "incorrect bracket string (e.g. [], {}, <>, ,,,)");
}

MutableComponent preparedMessage = appendPrefix(
StringUtil.convertAndToSectionMark(arguments.optString(3, APConfig.PERIPHERALS_CONFIG.defaultChatBoxPrefix.get())),
arguments.optString(4, "[]"),
StringUtil.convertAndToSectionMark(arguments.optString(5, ""))
).append(messageComponent);
);
if (preparedMessage == null) {
return MethodResult.of(null, "illegal prefix");
}
preparedMessage.append(messageComponent);

if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension)
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension) {
return MethodResult.of(false, "NOT_SAME_DIMENSION");
}

if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange)) {
ToastToClientPacket packet = new ToastToClientPacket(titleComponent, preparedMessage);
Expand All @@ -245,22 +395,30 @@ public final MethodResult sendMessageToPlayer(@NotNull IArguments arguments) thr
int range = arguments.optInt(5, -1);
ResourceKey<Level> dimension = getLevel().dimension();
ServerPlayer player = getPlayer(playerName);
if (player == null)
if (player == null) {
return MethodResult.of(null, "incorrect player name/uuid");
}

if (checkBrackets(arguments.optString(3)))
if (checkBrackets(arguments.optString(3))) {
return MethodResult.of(null, "incorrect bracket string (e.g. [], {}, <>, ...)");
}

MutableComponent preparedMessage = appendPrefix(
StringUtil.convertAndToSectionMark(arguments.optString(2, APConfig.PERIPHERALS_CONFIG.defaultChatBoxPrefix.get())),
arguments.optString(3, "[]"),
StringUtil.convertAndToSectionMark(arguments.optString(4, ""))
).append(message);
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension)
);
if (preparedMessage == null) {
return MethodResult.of(null, "illegal prefix");
}
preparedMessage.append(message);
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension) {
return MethodResult.of(false, "NOT_SAME_DIMENSION");
}

if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange))
if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange)) {
player.sendSystemMessage(preparedMessage, false);
}
return MethodResult.of(true);
});
}
Expand All @@ -275,20 +433,27 @@ public final MethodResult sendToastToPlayer(@NotNull IArguments arguments) throw
int range = arguments.optInt(6, -1);
ResourceKey<Level> dimension = getLevel().dimension();
ServerPlayer player = getPlayer(playerName);
if (player == null)
if (player == null) {
return MethodResult.of(null, "incorrect player name/uuid");
}

if (checkBrackets(arguments.optString(4)))
if (checkBrackets(arguments.optString(4))) {
return MethodResult.of(null, "incorrect bracket string (e.g. [], {}, <>, ...)");
}

MutableComponent preparedMessage = appendPrefix(
StringUtil.convertAndToSectionMark(arguments.optString(3, APConfig.PERIPHERALS_CONFIG.defaultChatBoxPrefix.get())),
arguments.optString(4, "[]"),
StringUtil.convertAndToSectionMark(arguments.optString(5, ""))
).append(message);
);
if (preparedMessage == null) {
return MethodResult.of(null, "illegal prefix");
}
preparedMessage.append(message);

if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension)
if (!APConfig.PERIPHERALS_CONFIG.chatBoxMultiDimensional.get() && player.getLevel().dimension() != dimension) {
return MethodResult.of(false, "NOT_SAME_DIMENSION");
}

if (CoordUtil.isInRange(getPos(), getLevel(), player, range, maxRange)) {
ToastToClientPacket packet = new ToastToClientPacket(Component.literal(title), preparedMessage);
Expand Down
Loading
Loading