From 087142d4cf9cc43f91c9034ee05c9cf020e6b368 Mon Sep 17 00:00:00 2001 From: itaybia Date: Tue, 31 Aug 2021 04:15:23 +0300 Subject: [PATCH] fix wrong HTML start/end tags in strings.xml (#2631) * fix wrong HTML start/end tags in strings.xml --- .../androlib/res/decoder/StringBlock.java | 260 ++++++++++++------ .../testapp/res/values-mcc001/strings.xml | 1 + .../aapt2/testapp/res/values/strings.xml | 1 + 3 files changed, 171 insertions(+), 91 deletions(-) diff --git a/brut.apktool/apktool-lib/src/main/java/brut/androlib/res/decoder/StringBlock.java b/brut.apktool/apktool-lib/src/main/java/brut/androlib/res/decoder/StringBlock.java index e91fed1b..c7bb00fd 100644 --- a/brut.apktool/apktool-lib/src/main/java/brut/androlib/res/decoder/StringBlock.java +++ b/brut.apktool/apktool-lib/src/main/java/brut/androlib/res/decoder/StringBlock.java @@ -19,11 +19,22 @@ package brut.androlib.res.decoder; import brut.androlib.res.xml.ResXmlEncoders; import brut.util.ExtDataInput; import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Splitter; +import com.google.common.base.Splitter.MapSplitter; +import com.google.common.collect.ComparisonChain; import java.io.IOException; import java.nio.ByteBuffer; import java.nio.charset.*; +import java.util.ArrayList; +import java.util.List; +import java.util.StringJoiner; import java.util.logging.Logger; +import java.util.stream.Stream; + +import static com.google.common.collect.Ordering.explicit; +import static java.util.Comparator.naturalOrder; +import static java.util.Comparator.reverseOrder; public class StringBlock { @@ -98,10 +109,164 @@ public class StringBlock { return decodeString(offset, length); } + private static class Tag implements Comparable { + private static final MapSplitter ATTRIBUTES_SPLITTER = + Splitter.on(';').withKeyValueSeparator(Splitter.on('=').limit(2)); + + private final String tag; + private final Type type; + private final int position; + private final int matchingTagPosition; + + Tag(String tag, Type type, int position, int matchingTagPosition) { + this.tag = ResXmlEncoders.escapeXmlChars(tag); + this.type = type; + this.position = position; + this.matchingTagPosition = matchingTagPosition; + } + + /** + * compares this tag and another, returning the order that should be between them. + * order by: + * position + * closing tag has precedence over openning tag (unless it is the same tag) + * tags that are enclosed in others should appear later if openning tag, or first if closing tag + * lexicographical sort. openning tag and closing tag in reverse so that one tag will be contained in the other and not each contain the other partially + * @param o - the other tag object to compare to + * @return the order in between this object and the other + */ + @Override + public int compareTo(Tag o) { + return ComparisonChain.start() + .compare(position, o.position) + // When one tag closes where another starts, we always close before opening. + .compare(type, o.type, this.tag.equals(o.tag) ? explicit(Type.OPEN, Type.CLOSE) : explicit(Type.CLOSE, Type.OPEN)) + // Open first the tag which closes last, and close first the tag which opened last. + .compare(matchingTagPosition, o.matchingTagPosition, reverseOrder()) + // When two tags open and close together, we order alphabetically. When they close, + // we reversed the order. This ensures that the XML tags are properly nested. + .compare(tag, o.tag, type.equals(Type.OPEN) ? naturalOrder() : reverseOrder()) + .result(); + } + + /** + * formats the tag value and attributes according to whether the tag is an openning or closing tag + * @return the formatted tag value as a string + */ + @Override + public String toString() { + // "tag" can either be just the tag or have the form "tag;attr1=value1;attr2=value2;[...]". + int separatorIdx = tag.indexOf(';'); + String actualTag = separatorIdx == -1 ? tag : tag.substring(0, separatorIdx); + + switch (type) { + case OPEN: + if (separatorIdx != -1) { + StringJoiner attributes = new StringJoiner(" "); + ATTRIBUTES_SPLITTER + .split(tag.substring(separatorIdx + 1, tag.endsWith(";") ? tag.length() - 1: tag.length())) + .forEach((key, value) -> attributes.add(String.format("%s=\"%s\"", key, value))); + return String.format("<%s %s>", actualTag, attributes); + } + return String.format("<%s>", actualTag); + case CLOSE: + return String.format("", actualTag); + } + throw new IllegalStateException(); + } + + private enum Type { + OPEN, + CLOSE + } + } + + private static class Span { + private String tag; + private int firstChar, lastChar; + + Span(String val, int firstIndex, int lastIndex) { + this.tag = val; + this.firstChar = firstIndex; + this.lastChar = lastIndex; + } + + String getTag() { + return tag; + } + + int getFirstChar() { + return firstChar; + } + + int getLastChar() { + return lastChar; + } + } + + private static class StyledString { + String val; + int[] styles; + + StyledString(String raw, int[] stylesArr) { + this.val = raw; + this.styles = stylesArr; + } + + String getValue() { + return val; + } + + List getSpanList(StringBlock stringBlock) { + ArrayList spanList = new ArrayList<>(); + for (int i = 0; i != styles.length; i += 3) { + spanList.add(new Span(stringBlock.getString(styles[i]), styles[i + 1], styles[i + 2])); + } + return spanList; + } + } + + /** + * + * @param styledString - the raw string with its corresponding styling tags and their locations + * @return a formatted styled string that contains the styling tag in the correct locations + */ + String processStyledString(StyledString styledString) { + + ArrayList sortedTagsList = new ArrayList<>(); + + styledString.getSpanList(this).stream() + .flatMap( + span -> + Stream.of( + // "+ 1" because the last char is included. + new Tag( + span.getTag(), Tag.Type.OPEN, span.getFirstChar(), span.getLastChar() + 1), + // "+ 1" because the last char is included. + new Tag( + span.getTag(), + Tag.Type.CLOSE, + span.getLastChar() + 1, + span.getFirstChar()))) + // So we can edit the string in place, we need to start from the end. + .sorted(naturalOrder()) + .forEach(tag -> sortedTagsList.add(tag)); + + String raw = styledString.getValue(); + StringBuilder string = new StringBuilder(raw.length() + 32); + int lastIndex = 0; + for (Tag tag : sortedTagsList) { + string.append(ResXmlEncoders.escapeXmlChars(raw.substring(lastIndex, tag.position))); + string.append(tag); + lastIndex = tag.position; + } + string.append(ResXmlEncoders.escapeXmlChars(raw.substring(lastIndex))); + + return string.toString(); + } + /** * Returns string with style tags (html-like). - * @param index int - * @return String */ public String getHTML(int index) { String raw = getString(index); @@ -117,96 +282,9 @@ public class StringBlock { if (style[1] > raw.length()) { return ResXmlEncoders.escapeXmlChars(raw); } - StringBuilder html = new StringBuilder(raw.length() + 32); - int[] opened = new int[style.length / 3]; - boolean[] unclosed = new boolean[style.length / 3]; - int offset = 0, depth = 0; - while (true) { - int i = -1, j; - for (j = 0; j != style.length; j += 3) { - if (style[j + 1] == -1) { - continue; - } - if (i == -1 || style[i + 1] > style[j + 1]) { - i = j; - } - } - int start = ((i != -1) ? style[i + 1] : raw.length()); - for (j = depth - 1; j >= 0; j--) { - int last = opened[j]; - int end = style[last + 2]; - if (end >= start) { - if (style[last + 1] == -1 && end != -1) { - unclosed[j] = true; - } - break; - } - if (offset <= end) { - html.append(ResXmlEncoders.escapeXmlChars(raw.substring(offset, end + 1))); - offset = end + 1; - } - outputStyleTag(getString(style[last]), html, true); - } - depth = j + 1; - if (offset < start) { - html.append(ResXmlEncoders.escapeXmlChars(raw.substring(offset, start))); - if (j >= 0 && unclosed.length >= j && unclosed[j]) { - if (unclosed.length > (j + 1) && unclosed[j + 1] || unclosed.length == 1) { - outputStyleTag(getString(style[opened[j]]), html, true); - } - } - offset = start; - } - if (i == -1) { - break; - } - outputStyleTag(getString(style[i]), html, false); - style[i + 1] = -1; - opened[depth++] = i; - } - return html.toString(); - } - private void outputStyleTag(String tag, StringBuilder builder, boolean close) { - builder.append('<'); - if (close) { - builder.append('/'); - } - - int pos = tag.indexOf(';'); - if (pos == -1) { - builder.append(tag); - } else { - builder.append(tag.substring(0, pos)); - if (!close) { - boolean loop = true; - while (loop) { - int pos2 = tag.indexOf('=', pos + 1); - - // malformed style information will cause crash. so - // prematurely end style tags, if recreation - // cannot be created. - if (pos2 != -1) { - builder.append(' ').append(tag.substring(pos + 1, pos2)).append("=\""); - pos = tag.indexOf(';', pos2 + 1); - - String val; - if (pos != -1) { - val = tag.substring(pos2 + 1, pos); - } else { - loop = false; - val = tag.substring(pos2 + 1); - } - - builder.append(ResXmlEncoders.escapeXmlChars(val)).append('"'); - } else { - loop = false; - } - - } - } - } - builder.append('>'); + StyledString styledString = new StyledString(raw, style); + return processStyledString(styledString); } /** diff --git a/brut.apktool/apktool-lib/src/test/resources/aapt1/testapp/res/values-mcc001/strings.xml b/brut.apktool/apktool-lib/src/test/resources/aapt1/testapp/res/values-mcc001/strings.xml index 58b57eb1..b195f248 100644 --- a/brut.apktool/apktool-lib/src/test/resources/aapt1/testapp/res/values-mcc001/strings.xml +++ b/brut.apktool/apktool-lib/src/test/resources/aapt1/testapp/res/values-mcc001/strings.xml @@ -42,4 +42,5 @@ bar" []Ţåþ ţö ţýþé þåššŵöŕð one two three [Ţåþ ţö ţýþé þåššŵöŕð one two three] 🔆 +
  • aaaaa aa aaaaa – aaaaaaa aaaaaaaaaa aa aaaaaaaa aaaaaa aaaaa (aaaa) aaaa aaaaaaaaa aaaaa aa aaaaaaaaa aaaaaaa aaaa
  • aaaaaaaaa aaaaaaaaaaaaaaa aaaaaaaa – aaaaaaa aaaaaaaaaa aaaaaaaaa aaaa aaaaaa aa aaaa aaaa aaaa aaaa aaaaaaa aaaaaaaaaaaaa, aaaaaa aaa aaaaaaaaaa (aaa) aaaaaaaaaaaaaaa
  • aaaaaaaaaaa aaaaaa aaaaaaaaaa – aaaaaaaaaa aaaa aaaaaa aa a aaa aa aaaaaa aaa aaaaaaa (aaaaa aaaaaaaa) aaaaaaaa aa aaaaaa aaaaa aaa aaaa
 diff --git a/brut.apktool/apktool-lib/src/test/resources/aapt2/testapp/res/values/strings.xml b/brut.apktool/apktool-lib/src/test/resources/aapt2/testapp/res/values/strings.xml index 4452f158..c0a36ad9 100644 --- a/brut.apktool/apktool-lib/src/test/resources/aapt2/testapp/res/values/strings.xml +++ b/brut.apktool/apktool-lib/src/test/resources/aapt2/testapp/res/values/strings.xml @@ -3,4 +3,5 @@ testapp 🔆 +
  • aaaaa aa aaaaa – aaaaaaa aaaaaaaaaa aa aaaaaaaa aaaaaa aaaaa (aaaa) aaaa aaaaaaaaa aaaaa aa aaaaaaaaa aaaaaaa aaaa
  • aaaaaaaaa aaaaaaaaaaaaaaa aaaaaaaa – aaaaaaa aaaaaaaaaa aaaaaaaaa aaaa aaaaaa aa aaaa aaaa aaaa aaaa aaaaaaa aaaaaaaaaaaaa, aaaaaa aaa aaaaaaaaaa (aaa) aaaaaaaaaaaaaaa
  • aaaaaaaaaaa aaaaaa aaaaaaaaaa – aaaaaaaaaa aaaa aaaaaa aa a aaa aa aaaaaa aaa aaaaaaa (aaaaa aaaaaaaa) aaaaaaaa aa aaaaaa aaaaa aaa aaaa