From 9111b87b8226be40dcf78e2937c5ed903d9a61ee Mon Sep 17 00:00:00 2001 From: _tud <98935832+UnderscoreTud@users.noreply.github.com> Date: Sat, 23 Nov 2024 07:42:20 +0300 Subject: [PATCH] Handle invalid regex pattern in ExprJoinSplit (#7202) * handle invalid regex patterns * missing space in toString Co-authored-by: Efnilite <35348263+Efnilite@users.noreply.github.com> --------- Co-authored-by: Efnilite <35348263+Efnilite@users.noreply.github.com> Co-authored-by: sovdee <10354869+sovdeeth@users.noreply.github.com> --- .../skript/expressions/ExprJoinSplit.java | 67 ++++++++++++++----- .../7159-regex exceptions not handled.sk | 12 ++++ 2 files changed, 61 insertions(+), 18 deletions(-) create mode 100644 src/test/skript/tests/regressions/7159-regex exceptions not handled.sk diff --git a/src/main/java/ch/njol/skript/expressions/ExprJoinSplit.java b/src/main/java/ch/njol/skript/expressions/ExprJoinSplit.java index 8535ca69cb7..c58e13d2953 100644 --- a/src/main/java/ch/njol/skript/expressions/ExprJoinSplit.java +++ b/src/main/java/ch/njol/skript/expressions/ExprJoinSplit.java @@ -19,8 +19,10 @@ package ch.njol.skript.expressions; import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; import ch.njol.skript.SkriptConfig; +import ch.njol.skript.lang.Literal; import org.bukkit.event.Event; import org.jetbrains.annotations.Nullable; @@ -36,14 +38,11 @@ import ch.njol.util.Kleenean; import ch.njol.util.StringUtils; -/** - * @author Peter Güttinger - */ @Name("Join & Split") @Description("Joins several texts with a common delimiter (e.g. \", \"), or splits a text into multiple texts at a given delimiter.") @Examples({ - "message \"Online players: %join all players with \"\" | \"\"%\" # %all players% would use the default \"x, y, and z\"", - "set {_s::*} to the string argument split at \",\"" + "message \"Online players: %join all players' names with \"\" | \"\"%\" # %all players% would use the default \"x, y, and z\"", + "set {_s::*} to the string argument split at \",\"" }) @Since("2.1, 2.5.2 (regex support), 2.7 (case sensitivity)") public class ExprJoinSplit extends SimpleExpression { @@ -61,33 +60,47 @@ public class ExprJoinSplit extends SimpleExpression { private boolean regex; private boolean caseSensitivity; - @SuppressWarnings("null") private Expression strings; - @Nullable - private Expression delimiter; + private @Nullable Expression delimiter; + + private @Nullable Pattern pattern; @Override - @SuppressWarnings({"unchecked", "null"}) public boolean init(Expression[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) { join = matchedPattern == 0; regex = matchedPattern >= 3; caseSensitivity = SkriptConfig.caseSensitive.value() || parseResult.hasTag("case"); + //noinspection unchecked strings = (Expression) exprs[0]; + //noinspection unchecked delimiter = (Expression) exprs[1]; + if (!join && delimiter instanceof Literal) { + String stringPattern = ((Literal) delimiter).getSingle(); + try { + this.pattern = compilePattern(stringPattern); + } catch (PatternSyntaxException e) { + Skript.error("'" + stringPattern + "' is not a valid regular expression"); + return false; + } + } return true; } @Override - @Nullable - protected String[] get(Event event) { + protected String @Nullable [] get(Event event) { String[] strings = this.strings.getArray(event); String delimiter = this.delimiter != null ? this.delimiter.getSingle(event) : ""; if (strings.length == 0 || delimiter == null) return new String[0]; - if (join) { + if (join) return new String[] {StringUtils.join(strings, delimiter)}; - } else { - return strings[0].split(regex ? delimiter : (caseSensitivity ? "" : "(?i)") + Pattern.quote(delimiter), -1); + try { + Pattern pattern = this.pattern; + if (pattern == null) + pattern = compilePattern(delimiter); + return pattern.split(strings[0], -1); + } catch (PatternSyntaxException e) { + return new String[0]; } } @@ -103,10 +116,28 @@ public Class getReturnType() { @Override public String toString(@Nullable Event event, boolean debug) { - if (join) - return "join " + strings.toString(event, debug) + (delimiter != null ? " with " + delimiter.toString(event, debug) : ""); - return (regex ? "regex " : "") + "split " + strings.toString(event, debug) + (delimiter != null ? " at " + delimiter.toString(event, debug) : "") - + (regex ? "" : "(case sensitive: " + caseSensitivity + ")"); + StringBuilder builder = new StringBuilder(); + if (join) { + builder.append("join ").append(strings.toString(event, debug)); + if (delimiter != null) + builder.append(" with ").append(delimiter.toString(event, debug)); + return builder.toString(); + } + + assert delimiter != null; + if (regex) + builder.append("regex "); + builder.append("split ") + .append(strings.toString(event, debug)) + .append(" at ") + .append(delimiter.toString(event, debug)); + if (!regex) + builder.append(" (case sensitive: ").append(caseSensitivity).append(")"); + return builder.toString(); + } + + private Pattern compilePattern(String delimiter) { + return Pattern.compile(regex ? delimiter : (caseSensitivity ? "" : "(?i)") + Pattern.quote(delimiter)); } } diff --git a/src/test/skript/tests/regressions/7159-regex exceptions not handled.sk b/src/test/skript/tests/regressions/7159-regex exceptions not handled.sk new file mode 100644 index 00000000000..691fe8e0da8 --- /dev/null +++ b/src/test/skript/tests/regressions/7159-regex exceptions not handled.sk @@ -0,0 +1,12 @@ +test "regex exceptions not handled": + parse: + set {_split::*} to regex split "test" at "\b{_name}\b" + assert last parse logs is "'\b{_name}\b' is not a valid regular expression" with "regex split did not error with invalid regex literal" + + set {_pattern} to "\b{_name}\b" + set {_split::*} to regex split "test" at {_pattern} + assert {_split::*} is not set with "regex split returned a value with invalid regex expression" + + assert regex split "apple,banana;cherry" at "[,;]" is "apple", "banana" and "cherry" with "regex split did not split correctly with literal" + set {_pattern} to "[,;]" + assert regex split "apple,banana;cherry" at {_pattern} is "apple", "banana" and "cherry" with "regex split did not split correctly with expression"