XmlEntity.java

  1. package org.owasp.dependencycheck.xml;

  3. import java.util.Collections;
  4. import java.util.HashMap;
  5. import java.util.Map;
  6. import javax.annotation.concurrent.ThreadSafe;

  8. /**
  9.  * This is a utility class to convert named XML Entities (such as ø) into
  10.  * its HTML encoded Unicode code point (i.e. ø). This is a slightly
  11.  * modified (class/method rename) from an SO answer:
  12.  * https://stackoverflow.com/questions/7286428/help-the-java-sax-parser-to-understand-bad-xml
  13.  *
  14.  * @author https://stackoverflow.com/users/823393/oldcurmudgeon
  15.  */
  16. @ThreadSafe
  17. public final class XmlEntity {

  19.     /**
  20.      * The map of HTML entities.
  21.      */
  22.     private static final Map<String, Integer> SPECIALS;

  24.     //<editor-fold defaultstate="collapsed" desc="Initialize SPECIALS">
  25.     /*
  26.      * Create a map HTML Named Entities to their numeric equivalent. Derived
  27.      * from Wikipedia
  28.      * http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
  29.      */
  30.     static {
  31.         final Map<String, Integer> map = new HashMap<>();
  32.         map.put("quot", 34);
  33.         map.put("amp", 38);
  34.         map.put("apos", 39);
  35.         map.put("lt", 60);
  36.         map.put("gt", 62);
  37.         map.put("nbsp", 160);
  38.         map.put("iexcl", 161);
  39.         map.put("cent", 162);
  40.         map.put("pound", 163);
  41.         map.put("curren", 164);
  42.         map.put("yen", 165);
  43.         map.put("brvbar", 166);
  44.         map.put("sect", 167);
  45.         map.put("uml", 168);
  46.         map.put("copy", 169);
  47.         map.put("ordf", 170);
  48.         map.put("laquo", 171);
  49.         map.put("not", 172);
  50.         map.put("shy", 173);
  51.         map.put("reg", 174);
  52.         map.put("macr", 175);
  53.         map.put("deg", 176);
  54.         map.put("plusmn", 177);
  55.         map.put("sup2", 178);
  56.         map.put("sup3", 179);
  57.         map.put("acute", 180);
  58.         map.put("micro", 181);
  59.         map.put("para", 182);
  60.         map.put("middot", 183);
  61.         map.put("cedil", 184);
  62.         map.put("sup1", 185);
  63.         map.put("ordm", 186);
  64.         map.put("raquo", 187);
  65.         map.put("frac14", 188);
  66.         map.put("frac12", 189);
  67.         map.put("frac34", 190);
  68.         map.put("iquest", 191);
  69.         map.put("Agrave", 192);
  70.         map.put("Aacute", 193);
  71.         map.put("Acirc", 194);
  72.         map.put("Atilde", 195);
  73.         map.put("Auml", 196);
  74.         map.put("Aring", 197);
  75.         map.put("AElig", 198);
  76.         map.put("Ccedil", 199);
  77.         map.put("Egrave", 200);
  78.         map.put("Eacute", 201);
  79.         map.put("Ecirc", 202);
  80.         map.put("Euml", 203);
  81.         map.put("Igrave", 204);
  82.         map.put("Iacute", 205);
  83.         map.put("Icirc", 206);
  84.         map.put("Iuml", 207);
  85.         map.put("ETH", 208);
  86.         map.put("Ntilde", 209);
  87.         map.put("Ograve", 210);
  88.         map.put("Oacute", 211);
  89.         map.put("Ocirc", 212);
  90.         map.put("Otilde", 213);
  91.         map.put("Ouml", 214);
  92.         map.put("times", 215);
  93.         map.put("Oslash", 216);
  94.         map.put("Ugrave", 217);
  95.         map.put("Uacute", 218);
  96.         map.put("Ucirc", 219);
  97.         map.put("Uuml", 220);
  98.         map.put("Yacute", 221);
  99.         map.put("THORN", 222);
  100.         map.put("szlig", 223);
  101.         map.put("agrave", 224);
  102.         map.put("aacute", 225);
  103.         map.put("acirc", 226);
  104.         map.put("atilde", 227);
  105.         map.put("auml", 228);
  106.         map.put("aring", 229);
  107.         map.put("aelig", 230);
  108.         map.put("ccedil", 231);
  109.         map.put("egrave", 232);
  110.         map.put("eacute", 233);
  111.         map.put("ecirc", 234);
  112.         map.put("euml", 235);
  113.         map.put("igrave", 236);
  114.         map.put("iacute", 237);
  115.         map.put("icirc", 238);
  116.         map.put("iuml", 239);
  117.         map.put("eth", 240);
  118.         map.put("ntilde", 241);
  119.         map.put("ograve", 242);
  120.         map.put("oacute", 243);
  121.         map.put("ocirc", 244);
  122.         map.put("otilde", 245);
  123.         map.put("ouml", 246);
  124.         map.put("divide", 247);
  125.         map.put("oslash", 248);
  126.         map.put("ugrave", 249);
  127.         map.put("uacute", 250);
  128.         map.put("ucirc", 251);
  129.         map.put("uuml", 252);
  130.         map.put("yacute", 253);
  131.         map.put("thorn", 254);
  132.         map.put("yuml", 255);
  133.         map.put("OElig", 338);
  134.         map.put("oelig", 339);
  135.         map.put("Scaron", 352);
  136.         map.put("scaron", 353);
  137.         map.put("Yuml", 376);
  138.         map.put("fnof", 402);
  139.         map.put("circ", 710);
  140.         map.put("tilde", 732);
  141.         map.put("Alpha", 913);
  142.         map.put("Beta", 914);
  143.         map.put("Gamma", 915);
  144.         map.put("Delta", 916);
  145.         map.put("Epsilon", 917);
  146.         map.put("Zeta", 918);
  147.         map.put("Eta", 919);
  148.         map.put("Theta", 920);
  149.         map.put("Iota", 921);
  150.         map.put("Kappa", 922);
  151.         map.put("Lambda", 923);
  152.         map.put("Mu", 924);
  153.         map.put("Nu", 925);
  154.         map.put("Xi", 926);
  155.         map.put("Omicron", 927);
  156.         map.put("Pi", 928);
  157.         map.put("Rho", 929);
  158.         map.put("Sigma", 931);
  159.         map.put("Tau", 932);
  160.         map.put("Upsilon", 933);
  161.         map.put("Phi", 934);
  162.         map.put("Chi", 935);
  163.         map.put("Psi", 936);
  164.         map.put("Omega", 937);
  165.         map.put("alpha", 945);
  166.         map.put("beta", 946);
  167.         map.put("gamma", 947);
  168.         map.put("delta", 948);
  169.         map.put("epsilon", 949);
  170.         map.put("zeta", 950);
  171.         map.put("eta", 951);
  172.         map.put("theta", 952);
  173.         map.put("iota", 953);
  174.         map.put("kappa", 954);
  175.         map.put("lambda", 955);
  176.         map.put("mu", 956);
  177.         map.put("nu", 957);
  178.         map.put("xi", 958);
  179.         map.put("omicron", 959);
  180.         map.put("pi", 960);
  181.         map.put("rho", 961);
  182.         map.put("sigmaf", 962);
  183.         map.put("sigma", 963);
  184.         map.put("tau", 964);
  185.         map.put("upsilon", 965);
  186.         map.put("phi", 966);
  187.         map.put("chi", 967);
  188.         map.put("psi", 968);
  189.         map.put("omega", 969);
  190.         map.put("thetasym", 977);
  191.         map.put("upsih", 978);
  192.         map.put("piv", 982);
  193.         map.put("ensp", 8194);
  194.         map.put("emsp", 8195);
  195.         map.put("thinsp", 8201);
  196.         map.put("zwnj", 8204);
  197.         map.put("zwj", 8205);
  198.         map.put("lrm", 8206);
  199.         map.put("rlm", 8207);
  200.         map.put("ndash", 8211);
  201.         map.put("mdash", 8212);
  202.         map.put("lsquo", 8216);
  203.         map.put("rsquo", 8217);
  204.         map.put("sbquo", 8218);
  205.         map.put("ldquo", 8220);
  206.         map.put("rdquo", 8221);
  207.         map.put("bdquo", 8222);
  208.         map.put("dagger", 8224);
  209.         map.put("Dagger", 8225);
  210.         map.put("bull", 8226);
  211.         map.put("hellip", 8230);
  212.         map.put("permil", 8240);
  213.         map.put("prime", 8242);
  214.         map.put("Prime", 8243);
  215.         map.put("lsaquo", 8249);
  216.         map.put("rsaquo", 8250);
  217.         map.put("oline", 8254);
  218.         map.put("frasl", 8260);
  219.         map.put("euro", 8364);
  220.         map.put("image", 8465);
  221.         map.put("weierp", 8472);
  222.         map.put("real", 8476);
  223.         map.put("trade", 8482);
  224.         map.put("alefsym", 8501);
  225.         map.put("larr", 8592);
  226.         map.put("uarr", 8593);
  227.         map.put("rarr", 8594);
  228.         map.put("darr", 8595);
  229.         map.put("harr", 8596);
  230.         map.put("crarr", 8629);
  231.         map.put("lArr", 8656);
  232.         map.put("uArr", 8657);
  233.         map.put("rArr", 8658);
  234.         map.put("dArr", 8659);
  235.         map.put("hArr", 8660);
  236.         map.put("forall", 8704);
  237.         map.put("part", 8706);
  238.         map.put("exist", 8707);
  239.         map.put("empty", 8709);
  240.         map.put("nabla", 8711);
  241.         map.put("isin", 8712);
  242.         map.put("notin", 8713);
  243.         map.put("ni", 8715);
  244.         map.put("prod", 8719);
  245.         map.put("sum", 8721);
  246.         map.put("minus", 8722);
  247.         map.put("lowast", 8727);
  248.         map.put("radic", 8730);
  249.         map.put("prop", 8733);
  250.         map.put("infin", 8734);
  251.         map.put("ang", 8736);
  252.         map.put("and", 8743);
  253.         map.put("or", 8744);
  254.         map.put("cap", 8745);
  255.         map.put("cup", 8746);
  256.         map.put("int", 8747);
  257.         map.put("there4", 8756);
  258.         map.put("sim", 8764);
  259.         map.put("cong", 8773);
  260.         map.put("asymp", 8776);
  261.         map.put("ne", 8800);
  262.         map.put("equiv", 8801);
  263.         map.put("le", 8804);
  264.         map.put("ge", 8805);
  265.         map.put("sub", 8834);
  266.         map.put("sup", 8835);
  267.         map.put("nsub", 8836);
  268.         map.put("sube", 8838);
  269.         map.put("supe", 8839);
  270.         map.put("oplus", 8853);
  271.         map.put("otimes", 8855);
  272.         map.put("perp", 8869);
  273.         map.put("sdot", 8901);
  274.         map.put("lceil", 8968);
  275.         map.put("rceil", 8969);
  276.         map.put("lfloor", 8970);
  277.         map.put("rfloor", 8971);
  278.         map.put("lang", 10216);
  279.         map.put("rang", 10217);
  280.         map.put("loz", 9674);
  281.         map.put("spades", 9824);
  282.         map.put("clubs", 9827);
  283.         map.put("hearts", 9829);
  284.         map.put("diams", 9830);
  285.         SPECIALS = Collections.unmodifiableMap(map);
  286.     }
  287.     //</editor-fold>

  289.     /**
  290.      * Private constructor for a utility class.
  291.      */
  292.     private XmlEntity() {
  293.     }

  295.     /**
  296.      * Converts a named XML entity into its HTML encoded Unicode code point.
  297.      *
  298.      * @param s the named entity (note, this should not include the leading
  299.      * '&amp;' or trailing ';'
  300.      * @return the HTML encoded Unicode code point representation of the named
  301.      * entity
  302.      */
  303.     public static String fromNamedReference(CharSequence s) {
  304.         if (s == null) {
  305.             return null;
  306.         }
  307.         final Integer code = SPECIALS.get(s.toString());
  308.         if (code != null) {
  309.             return "&#" + code + ";";
  310.         }
  311.         return null;
  312.     }
  313. }
Created with JaCoCo 0.8.12.202403310830