Issue checkstyle#5162: fixed sanitizing ampersand in xml file

rnveach · Sep 29, 2017 · 5718d8e · 5718d8e
1 parent f58e003
commit 5718d8e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 24 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java b/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java
@@ -271,7 +271,7 @@ public static String encode(String value) {
                     sb.append("&quot;");
                     break;
                 case '&':
-                    sb.append(encodeAmpersand(value, i));
+                    sb.append("&amp;");
                     break;
                 case '\r':
                     break;
@@ -327,25 +327,6 @@ else if (ent.charAt(1) == '#') {
         return reference;
     }
 
-    /**
-     * Encodes ampersand in value at required position.
-     * @param value string value, which contains ampersand
-     * @param ampPosition position of ampersand in value
-     * @return encoded ampersand which should be used in xml
-     */
-    private static String encodeAmpersand(String value, int ampPosition) {
-        final int nextSemi = value.indexOf(';', ampPosition);
-        final String result;
-        if (nextSemi == -1
-            || !isReference(value.substring(ampPosition, nextSemi + 1))) {
-            result = "&amp;";
-        }
-        else {
-            result = "&";
-        }
-        return result;
-    }
-
     /**
      * The registered file messages.
      */

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/XMLLoggerTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/XMLLoggerTest.java
@@ -63,11 +63,11 @@ public void testEncode()
             {"'", "&apos;"},
             {"\"", "&quot;"},
             {"&", "&amp;"},
-            {"&lt;", "&lt;"},
+            {"&lt;", "&amp;lt;"},
             {"abc;", "abc;"},
-            {"&#0;", "&#0;"}, //reference
-            {"&#0", "&amp;#0"}, //not reference
-            {"&#X0;", "&amp;#X0;"}, //not reference
+            {"&#0;", "&amp;#0;"},
+            {"&#0", "&amp;#0"},
+            {"&#X0;", "&amp;#X0;"},
         };
         for (String[] encoding : encodings) {
             final String encoded = XMLLogger.encode(encoding[0]);
@@ -84,6 +84,11 @@ public void testIsReference()
         final String[] references = {
             "&#0;",
             "&#x0;",
+            "&lt;",
+            "&gt;",
+            "&apos;",
+            "&quot;",
+            "&amp;",
         };
         for (String reference : references) {
             assertTrue("reference: " + reference,