[jira] [Comment Edited] (LANG-859) org.apache.commons.lang.StringEscapeUtils.escapeXml doesn't escape chars which are considered invalid according to W3C specification

["Sergey Bushik (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/LANG-859?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13502104#comment-13502104 ] 

Sergey Bushik edited comment on LANG-859 at 11/21/12 4:32 PM:
--------------------------------------------------------------

Fixed {code}org.apache.commons.lang.Escape.escape(){code} method for XML    

{code}
    protected void escape(Writer writer, String text) throws IOException {
        int len = text.length();
        for (int i = 0; i < len; i++) {
            char c = text.charAt(i);
            String entity = entityName(c);
            if (entity == null) {
                // TODO: add escaping for invalid characters
                if (c > 0x7F || XMLChar.isInvalid(c)) {
                    writer.write("&#");
                    writer.write(Integer.toString(c, 10));
                    writer.write(';');
                } else {
                    writer.write(c);
                }
            } else {
                writer.write('&');
                writer.write(entity);
                writer.write(';');
            }
        }
    }
{code}
                
      was (Author: tazija):
    Fixed org.apache.commons.lang.Escape.escape() method for XML    

    protected void escape(Writer writer, String text) throws IOException {
        int len = text.length();
        for (int i = 0; i < len; i++) {
            char c = text.charAt(i);
            String entity = entityName(c);
            if (entity == null) {
                // TODO: add escaping for invalid characters
                if (c > 0x7F || XMLChar.isInvalid(c)) {
                    writer.write("&#");
                    writer.write(Integer.toString(c, 10));
                    writer.write(';');
                } else {
                    writer.write(c);
                }
            } else {
                writer.write('&');
                writer.write(entity);
                writer.write(';');
            }
        }
    }
                  
> org.apache.commons.lang.StringEscapeUtils.escapeXml doesn't escape chars which are considered invalid according to W3C specification
> ------------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: LANG-859
>                 URL: https://issues.apache.org/jira/browse/LANG-859
>             Project: Commons Lang
>          Issue Type: Bug
>          Components: lang.*
>    Affects Versions: 2.6
>            Reporter: Sergey Bushik
>
> According to specification of XML version 1.0 there are Unicode characters that are not allowed in the content of the XML document http://www.w3.org/TR/xml/#charsets
> StringEscapeUtils.escapeXml(value) should escape such characters as &#x<hex-code>; or &#<dec-code>;
> {code}
> public static void main(String[] args) throws Exception {
>     String xmlValidText = "good";
>     // Passes assertion
>     assertEquals(StringEscapeUtils.escapeXml("good"), "good");
>     
>     char xmlInvalidChar = (char) 0x2;
>     String xmlInvalidText = String.valueOf(xmlInvalidChar);
>     // Fails assertion
>     assertEquals(StringEscapeUtils.escapeXml(xmlInvalidText), "&#x2;");
>     
>     System.out.println("Is valid: " + org.apache.xerces.util.XMLChar.isInvalid(xmlInvalidChar));
>     String xml =
>             "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
>             "<chars>" +
>             "<valid>" + StringEscapeUtils.escapeXml(xmlValidText) + "</valid>" +
>             "<invalid>" + StringEscapeUtils.escapeXml(xmlInvalidText) + "</invalid>" +
>             "</chars>";
>     // An invalid XML character (Unicode: 0x2) was found in the element content of the document
>     Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(new ByteArrayInputStream(xml.getBytes("UTF-8")));
>     System.out.println(document);
> }
> {code}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira