StringEscapeUtils: escape/unescape Java/JavaScript/HTML
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137278 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Alex Chaffee
parent
5b83eb9358
commit
4b0aeca9f2
|
|
@ -1 +1,5 @@
|
|||
target
|
||||
*.iws
|
||||
*.ipr
|
||||
*.iml
|
||||
dist
|
||||
|
|
|
|||
|
|
@ -0,0 +1,500 @@
|
|||
/* ====================================================================
|
||||
* The Apache Software License, Version 1.1
|
||||
*
|
||||
* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
|
||||
* reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
*
|
||||
* 3. The end-user documentation included with the redistribution, if
|
||||
* any, must include the following acknowlegement:
|
||||
* "This product includes software developed by the
|
||||
* Apache Software Foundation (http://www.apache.org/)."
|
||||
* Alternately, this acknowlegement may appear in the software itself,
|
||||
* if and wherever such third-party acknowlegements normally appear.
|
||||
*
|
||||
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
|
||||
* Foundation" must not be used to endorse or promote products derived
|
||||
* from this software without prior written permission. For written
|
||||
* permission, please contact apache@apache.org.
|
||||
*
|
||||
* 5. Products derived from this software may not be called "Apache"
|
||||
* nor may "Apache" appear in their names without prior written
|
||||
* permission of the Apache Software Foundation.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
||||
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
||||
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
||||
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
* SUCH DAMAGE.
|
||||
* ====================================================================
|
||||
*
|
||||
* This software consists of voluntary contributions made by many
|
||||
* individuals on behalf of the Apache Software Foundation. For more
|
||||
* information on the Apache Software Foundation, please see
|
||||
* <http://www.apache.org/>.
|
||||
*/
|
||||
package org.apache.commons.lang;
|
||||
|
||||
import java.util.StringTokenizer;
|
||||
import java.util.Iterator;
|
||||
import java.util.Map;
|
||||
import java.util.HashMap;
|
||||
import java.io.IOException;
|
||||
import java.io.Writer;
|
||||
import java.io.StringWriter;
|
||||
|
||||
import org.apache.commons.lang.exception.NestableRuntimeException;
|
||||
|
||||
/**
|
||||
* <p>Common <code>String</code> escaping routines.</p>
|
||||
*
|
||||
* <p>Originally from
|
||||
* <a href="http://jakarta.apache.org/turbine/">Turbine</a> and the
|
||||
* GenerationJavaCore library and from
|
||||
* <a href="http://www.purpletech.com/code/">Purple Technology</a>
|
||||
* </p>
|
||||
*
|
||||
* @author original author of escape and unescape=?
|
||||
* @author <a href="mailto:alex@purpletech.com">Alexander Day Chaffee</a>
|
||||
* @author <a href="mailto:cybertiger@cyberiantiger.org">cybertiger@cyberiantiger.org</a>
|
||||
* @author Helge Tesgaard
|
||||
* @author <a href="sean@boohai.com">Sean Brown</a>
|
||||
* @since 2.0
|
||||
* @version $Id: StringEscapeUtils.java,v 1.1 2003/03/31 03:53:52 alex Exp $
|
||||
*/
|
||||
public class StringEscapeUtils {
|
||||
|
||||
/**
|
||||
* <p><code>StringEscapeUtils<code> instances should NOT be constructed in
|
||||
* standard programming. Instead, the class should be used as
|
||||
* <code>StringEscapeUtils.escapeJava("foo");</code>.</p>
|
||||
*
|
||||
* <p>This constructor is public to permit tools that require a JavaBean
|
||||
* instance to operate.</p>
|
||||
*/
|
||||
public StringEscapeUtils() {
|
||||
}
|
||||
|
||||
// Java and JavaScript
|
||||
//--------------------------------------------------------------------------
|
||||
/**
|
||||
* <p>Escapes any values it finds into their Java String form.
|
||||
* Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) </p>
|
||||
*
|
||||
* <p>So a tab becomes the characters <code>'\\'</code> and
|
||||
* <code>'t'</code>.</p>
|
||||
*
|
||||
* <p>The only difference between Java strings and JavaScript strings
|
||||
* is that in JavaScript, a single quote must be escaped.</p>
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>
|
||||
* input string: He didn't say, "Stop!"
|
||||
* output string: He didn't say, \"Stop!\"
|
||||
* </pre>
|
||||
* </p>
|
||||
*
|
||||
* @param str String to escape values in
|
||||
* @return String with escaped values
|
||||
* @throws NullPointerException if str is <code>null</code>
|
||||
*/
|
||||
public static String escapeJava(String str) {
|
||||
return escapeJavaStyleString(str, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see #escapeJava(java.lang.String)
|
||||
* @param out Writer to write escaped string into
|
||||
* @param str String to escape values in
|
||||
* @throws NullPointerException if str is <code>null</code>
|
||||
* @throws IOException if error occurs on undelying Writer
|
||||
*/
|
||||
public static void escapeJava(Writer out, String str) throws IOException {
|
||||
escapeJavaStyleString(out, str, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Escapes any values it finds into their JavaScript String form.
|
||||
* Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.) </p>
|
||||
*
|
||||
* <p>So a tab becomes the characters <code>'\\'</code> and
|
||||
* <code>'t'</code>.</p>
|
||||
*
|
||||
* <p>The only difference between Java strings and JavaScript strings
|
||||
* is that in JavaScript, a single quote must be escaped.</p>
|
||||
*
|
||||
* <p>Example:
|
||||
* <pre>
|
||||
* input string: He didn't say, "Stop!"
|
||||
* output string: He didn\'t say, \"Stop!\"
|
||||
* </pre>
|
||||
* </p>
|
||||
*
|
||||
* @param str String to escape values in
|
||||
* @return String with escaped values
|
||||
* @throws NullPointerException if str is <code>null</code>
|
||||
*/
|
||||
public static String escapeJavaScript(String str) {
|
||||
return escapeJavaStyleString(str, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* @see #escapeJavaScript(java.lang.String)
|
||||
* @param out Writer to write escaped string into
|
||||
* @param str String to escape values in
|
||||
* @throws NullPointerException if str is <code>null</code>
|
||||
* @throws IOException if error occurs on undelying Writer
|
||||
**/
|
||||
public static void escapeJavaScript(Writer out, String str) throws IOException {
|
||||
escapeJavaStyleString(out, str, true);
|
||||
}
|
||||
|
||||
private static String escapeJavaStyleString(String str, boolean escapeSingleQuotes) {
|
||||
try {
|
||||
StringPrintWriter writer = new StringPrintWriter(str.length() * 2);
|
||||
escapeJavaStyleString(writer, str, escapeSingleQuotes);
|
||||
return writer.getString();
|
||||
}
|
||||
catch (IOException ioe) {
|
||||
// this should never ever happen while writing to a StringWriter
|
||||
ioe.printStackTrace();
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private static void escapeJavaStyleString(Writer out, String str, boolean escapeSingleQuote) throws IOException {
|
||||
int sz;
|
||||
sz = str.length();
|
||||
for (int i = 0; i < sz; i++) {
|
||||
char ch = str.charAt(i);
|
||||
|
||||
// handle unicode
|
||||
if (ch > 0xfff) {
|
||||
out.write("\\u" + Integer.toHexString(ch));
|
||||
} else if (ch > 0xff) {
|
||||
out.write("\\u0" + Integer.toHexString(ch));
|
||||
} else if (ch > 0x7f) {
|
||||
out.write("\\u00" + Integer.toHexString(ch));
|
||||
} else if (ch < 32) {
|
||||
switch (ch) {
|
||||
case '\b' :
|
||||
out.write('\\');
|
||||
out.write('b');
|
||||
break;
|
||||
case '\n' :
|
||||
out.write('\\');
|
||||
out.write('n');
|
||||
break;
|
||||
case '\t' :
|
||||
out.write('\\');
|
||||
out.write('t');
|
||||
break;
|
||||
case '\f' :
|
||||
out.write('\\');
|
||||
out.write('f');
|
||||
break;
|
||||
case '\r' :
|
||||
out.write('\\');
|
||||
out.write('r');
|
||||
break;
|
||||
default :
|
||||
if (ch > 0xf) {
|
||||
out.write("\\u00" + Integer.toHexString(ch));
|
||||
} else {
|
||||
out.write("\\u000" + Integer.toHexString(ch));
|
||||
}
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
switch (ch) {
|
||||
case '\'' :
|
||||
if (escapeSingleQuote) out.write('\\');
|
||||
out.write('\'');
|
||||
break;
|
||||
case '"' :
|
||||
out.write('\\');
|
||||
out.write('"');
|
||||
break;
|
||||
case '\\' :
|
||||
out.write('\\');
|
||||
out.write('\\');
|
||||
break;
|
||||
default :
|
||||
out.write(ch);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Unescapes any Java literals found in the String. For example,
|
||||
* it will turn a sequence of '\' and 'n' into a newline character,
|
||||
* unless the '\' is preceded by another '\'.
|
||||
*/
|
||||
public static String unescapeJava(String str) {
|
||||
try {
|
||||
StringPrintWriter writer = new StringPrintWriter(str.length());
|
||||
unescapeJava(writer, str);
|
||||
return writer.getString();
|
||||
}
|
||||
catch (IOException ioe) {
|
||||
// this should never ever happen while writing to a StringWriter
|
||||
ioe.printStackTrace();
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
public static void unescapeJava(Writer out, String str) throws IOException {
|
||||
int sz = str.length();
|
||||
StringBuffer unicode = new StringBuffer(4);
|
||||
boolean hadSlash = false;
|
||||
boolean inUnicode = false;
|
||||
for (int i = 0; i < sz; i++) {
|
||||
char ch = str.charAt(i);
|
||||
if(inUnicode) {
|
||||
// if in unicode, then we're reading unicode
|
||||
// values in somehow
|
||||
if(unicode.length() == 4) {
|
||||
// unicode now contains the four hex digits
|
||||
// which represents our unicode chacater
|
||||
try {
|
||||
int value = Integer.parseInt(unicode.toString(), 16);
|
||||
out.write( (char)value );
|
||||
unicode.setLength(0);
|
||||
unicode.setLength(4);
|
||||
inUnicode = false;
|
||||
hadSlash = false;
|
||||
} catch(NumberFormatException nfe) {
|
||||
throw new NestableRuntimeException("Unable to parse unicode value: "+unicode, nfe);
|
||||
}
|
||||
} else {
|
||||
unicode.append(ch);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
if(hadSlash) {
|
||||
// handle an escaped value
|
||||
hadSlash = false;
|
||||
switch(ch) {
|
||||
case '\\': out.write('\\'); break;
|
||||
case '\'': out.write('\''); break;
|
||||
case '\"': out.write('"'); break;
|
||||
case 'r': out.write('\r'); break;
|
||||
case 'f': out.write('\f'); break;
|
||||
case 't': out.write('\t'); break;
|
||||
case 'n': out.write('\n'); break;
|
||||
case 'b': out.write('\b'); break;
|
||||
case 'u': {
|
||||
// uh-oh, we're in unicode country....
|
||||
inUnicode=true;
|
||||
break;
|
||||
}
|
||||
default :
|
||||
out.write(ch);
|
||||
break;
|
||||
}
|
||||
continue;
|
||||
} else
|
||||
if(ch == '\\') {
|
||||
hadSlash = true;
|
||||
continue;
|
||||
}
|
||||
out.write(ch);
|
||||
}
|
||||
if(hadSlash) {
|
||||
// then we're in the weird case of a \ at the end of the
|
||||
// string, let's output it anyway.
|
||||
out.write('\\');
|
||||
}
|
||||
}
|
||||
|
||||
public static String unescapeJavaScript(String str) {
|
||||
return unescapeJava(str);
|
||||
}
|
||||
|
||||
public static void unescapeJavaScript(Writer out, String str) throws IOException {
|
||||
unescapeJava(out,str);
|
||||
}
|
||||
|
||||
// HTML and XML
|
||||
//--------------------------------------------------------------------------
|
||||
|
||||
// see http://hotwired.lycos.com/webmonkey/reference/special_characters/
|
||||
//todo: initialize these lazily (on first request, rather than at classload time)
|
||||
static Object[][] entities = {
|
||||
// {"#39", new Integer(39)}, // ' - apostrophe
|
||||
{"quot", new Integer(34)}, // " - double-quote
|
||||
{"amp", new Integer(38)}, // & - ampersand
|
||||
{"lt", new Integer(60)}, // < - less-than
|
||||
{"gt", new Integer(62)}, // > - greater-than
|
||||
{"nbsp", new Integer(160)}, // non-breaking space
|
||||
{"copy", new Integer(169)}, // © - copyright
|
||||
{"reg", new Integer(174)}, // ® - registered trademark
|
||||
{"Agrave", new Integer(192)}, // À - uppercase A, grave accent
|
||||
{"Aacute", new Integer(193)}, // Á - uppercase A, acute accent
|
||||
{"Acirc", new Integer(194)}, // Â - uppercase A, circumflex accent
|
||||
{"Atilde", new Integer(195)}, // Ã - uppercase A, tilde
|
||||
{"Auml", new Integer(196)}, // Ä - uppercase A, umlaut
|
||||
{"Aring", new Integer(197)}, // Å - uppercase A, ring
|
||||
{"AElig", new Integer(198)}, // Æ - uppercase AE
|
||||
{"Ccedil", new Integer(199)}, // Ç - uppercase C, cedilla
|
||||
{"Egrave", new Integer(200)}, // È - uppercase E, grave accent
|
||||
{"Eacute", new Integer(201)}, // É - uppercase E, acute accent
|
||||
{"Ecirc", new Integer(202)}, // Ê - uppercase E, circumflex accent
|
||||
{"Euml", new Integer(203)}, // Ë - uppercase E, umlaut
|
||||
{"Igrave", new Integer(204)}, // Ì - uppercase I, grave accent
|
||||
{"Iacute", new Integer(205)}, // Í - uppercase I, acute accent
|
||||
{"Icirc", new Integer(206)}, // Î - uppercase I, circumflex accent
|
||||
{"Iuml", new Integer(207)}, // Ï - uppercase I, umlaut
|
||||
{"ETH", new Integer(208)}, // Ð - uppercase Eth, Icelandic
|
||||
{"Ntilde", new Integer(209)}, // Ñ - uppercase N, tilde
|
||||
{"Ograve", new Integer(210)}, // Ò - uppercase O, grave accent
|
||||
{"Oacute", new Integer(211)}, // Ó - uppercase O, acute accent
|
||||
{"Ocirc", new Integer(212)}, // Ô - uppercase O, circumflex accent
|
||||
{"Otilde", new Integer(213)}, // Õ - uppercase O, tilde
|
||||
{"Ouml", new Integer(214)}, // Ö - uppercase O, umlaut
|
||||
{"Oslash", new Integer(216)}, // Ø - uppercase O, slash
|
||||
{"Ugrave", new Integer(217)}, // Ù - uppercase U, grave accent
|
||||
{"Uacute", new Integer(218)}, // Ú - uppercase U, acute accent
|
||||
{"Ucirc", new Integer(219)}, // Û - uppercase U, circumflex accent
|
||||
{"Uuml", new Integer(220)}, // Ü - uppercase U, umlaut
|
||||
{"Yacute", new Integer(221)}, // Ý - uppercase Y, acute accent
|
||||
{"THORN", new Integer(222)}, // Þ - uppercase THORN, Icelandic
|
||||
{"szlig", new Integer(223)}, // ß - lowercase sharps, German
|
||||
{"agrave", new Integer(224)}, // à - lowercase a, grave accent
|
||||
{"aacute", new Integer(225)}, // á - lowercase a, acute accent
|
||||
{"acirc", new Integer(226)}, // â - lowercase a, circumflex accent
|
||||
{"atilde", new Integer(227)}, // ã - lowercase a, tilde
|
||||
{"auml", new Integer(228)}, // ä - lowercase a, umlaut
|
||||
{"aring", new Integer(229)}, // å - lowercase a, ring
|
||||
{"aelig", new Integer(230)}, // æ - lowercase ae
|
||||
{"ccedil", new Integer(231)}, // ç - lowercase c, cedilla
|
||||
{"egrave", new Integer(232)}, // è - lowercase e, grave accent
|
||||
{"eacute", new Integer(233)}, // é - lowercase e, acute accent
|
||||
{"ecirc", new Integer(234)}, // ê - lowercase e, circumflex accent
|
||||
{"euml", new Integer(235)}, // ë - lowercase e, umlaut
|
||||
{"igrave", new Integer(236)}, // ì - lowercase i, grave accent
|
||||
{"iacute", new Integer(237)}, // í - lowercase i, acute accent
|
||||
{"icirc", new Integer(238)}, // î - lowercase i, circumflex accent
|
||||
{"iuml", new Integer(239)}, // ï - lowercase i, umlaut
|
||||
{"igrave", new Integer(236)}, // ì - lowercase i, grave accent
|
||||
{"iacute", new Integer(237)}, // í - lowercase i, acute accent
|
||||
{"icirc", new Integer(238)}, // î - lowercase i, circumflex accent
|
||||
{"iuml", new Integer(239)}, // ï - lowercase i, umlaut
|
||||
{"eth", new Integer(240)}, // ð - lowercase eth, Icelandic
|
||||
{"ntilde", new Integer(241)}, // ñ - lowercase n, tilde
|
||||
{"ograve", new Integer(242)}, // ò - lowercase o, grave accent
|
||||
{"oacute", new Integer(243)}, // ó - lowercase o, acute accent
|
||||
{"ocirc", new Integer(244)}, // ô - lowercase o, circumflex accent
|
||||
{"otilde", new Integer(245)}, // õ - lowercase o, tilde
|
||||
{"ouml", new Integer(246)}, // ö - lowercase o, umlaut
|
||||
{"oslash", new Integer(248)}, // ø - lowercase o, slash
|
||||
{"ugrave", new Integer(249)}, // ù - lowercase u, grave accent
|
||||
{"uacute", new Integer(250)}, // ú - lowercase u, acute accent
|
||||
{"ucirc", new Integer(251)}, // û - lowercase u, circumflex accent
|
||||
{"uuml", new Integer(252)}, // ü - lowercase u, umlaut
|
||||
{"yacute", new Integer(253)}, // ý - lowercase y, acute accent
|
||||
{"thorn", new Integer(254)}, // þ - lowercase thorn, Icelandic
|
||||
{"yuml", new Integer(255)}, // ÿ - lowercase y, umlaut
|
||||
{"euro", new Integer(8364)}, // Euro symbol
|
||||
};
|
||||
static Map e2i = new HashMap();
|
||||
static Map i2e = new HashMap();
|
||||
static {
|
||||
for (int i=0; i<entities.length; ++i) {
|
||||
e2i.put(entities[i][0], entities[i][1]);
|
||||
i2e.put(entities[i][1], entities[i][0]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Turns funky characters into HTML entity equivalents<p>
|
||||
* e.g. <tt>"bread" & "butter"</tt> => <tt>&quot;bread&quot; &amp; &quot;butter&quot;</tt>.
|
||||
* Supports all known HTML entities, including funky accents. See the source code for more detail.
|
||||
* see http://hotwired.lycos.com/webmonkey/reference/special_characters/
|
||||
* @see #unescapeHtml(String)
|
||||
**/
|
||||
public static String escapeHtml(String str)
|
||||
{
|
||||
StringBuffer buf = new StringBuffer(str.length() * 2);
|
||||
int i;
|
||||
for (i=0; i<str.length(); ++i) {
|
||||
char ch = str.charAt(i);
|
||||
String entity = (String)i2e.get( new Integer((int)ch) );
|
||||
if (entity == null) {
|
||||
if (((int)ch) > 128) {
|
||||
int intValue = ((int)ch);
|
||||
buf.append("&#" + intValue + ";");
|
||||
}
|
||||
else {
|
||||
buf.append(ch);
|
||||
}
|
||||
}
|
||||
else {
|
||||
buf.append("&" + entity + ";");
|
||||
}
|
||||
}
|
||||
return buf.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a string containing entity escapes, returns a string
|
||||
* containing the actual Unicode characters corresponding to the
|
||||
* escapes.
|
||||
*
|
||||
* @see #escapeHtml(String)
|
||||
**/
|
||||
public static String unescapeHtml(String str) {
|
||||
StringBuffer buf = new StringBuffer(str.length());
|
||||
int i;
|
||||
for (i=0; i<str.length(); ++i) {
|
||||
char ch = str.charAt(i);
|
||||
if (ch == '&') {
|
||||
int semi = str.indexOf(';', i+1);
|
||||
if (semi == -1) {
|
||||
buf.append(ch);
|
||||
continue;
|
||||
}
|
||||
String entity = str.substring(i+1, semi);
|
||||
Integer iso;
|
||||
if (entity.charAt(0) == '#') {
|
||||
iso = new Integer(entity.substring(1));
|
||||
}
|
||||
else {
|
||||
iso = (Integer)e2i.get(entity);
|
||||
}
|
||||
if (iso == null) {
|
||||
buf.append("&" + entity + ";");
|
||||
}
|
||||
else {
|
||||
buf.append((char)(iso.intValue()));
|
||||
}
|
||||
i = semi;
|
||||
}
|
||||
else {
|
||||
buf.append(ch);
|
||||
}
|
||||
}
|
||||
return buf.toString();
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
/* ====================================================================
|
||||
* The Apache Software License, Version 1.1
|
||||
*
|
||||
* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
|
||||
* reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
*
|
||||
* 3. The end-user documentation included with the redistribution, if
|
||||
* any, must include the following acknowlegement:
|
||||
* "This product includes software developed by the
|
||||
* Apache Software Foundation (http://www.apache.org/)."
|
||||
* Alternately, this acknowlegement may appear in the software itself,
|
||||
* if and wherever such third-party acknowlegements normally appear.
|
||||
*
|
||||
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
|
||||
* Foundation" must not be used to endorse or promote products derived
|
||||
* from this software without prior written permission. For written
|
||||
* permission, please contact apache@apache.org.
|
||||
*
|
||||
* 5. Products derived from this software may not be called "Apache"
|
||||
* nor may "Apache" appear in their names without prior written
|
||||
* permission of the Apache Software Foundation.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
||||
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
||||
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
||||
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
* SUCH DAMAGE.
|
||||
* ====================================================================
|
||||
*
|
||||
* This software consists of voluntary contributions made by many
|
||||
* individuals on behalf of the Apache Software Foundation. For more
|
||||
* information on the Apache Software Foundation, please see
|
||||
* <http://www.apache.org/>.
|
||||
*/
|
||||
package org.apache.commons.lang;
|
||||
|
||||
import java.io.*;
|
||||
|
||||
/**
|
||||
* A PrintWriter that maintains a String as its backing store.
|
||||
* Usage: <pre>
|
||||
* StringPrintWriter out = new StringPrintWriter();
|
||||
* printTo(out);
|
||||
* System.out.println( out.getString() );
|
||||
* </pre>
|
||||
* @author Alex Chaffee
|
||||
* @author Scott Stanchfield
|
||||
**/
|
||||
public class StringPrintWriter extends PrintWriter {
|
||||
public StringPrintWriter() {
|
||||
super(new StringWriter());
|
||||
}
|
||||
|
||||
public StringPrintWriter(int initialSize) {
|
||||
super(new StringWriter(initialSize));
|
||||
}
|
||||
|
||||
/**
|
||||
* Since toString() returns information *about* this object, we
|
||||
* want a separate method to extract just the contents of the
|
||||
* internal buffer as a String.
|
||||
* @return the contents of the internal string buffer
|
||||
*/
|
||||
public String getString() {
|
||||
flush();
|
||||
return ((StringWriter) out).toString();
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -63,7 +63,7 @@ import junit.textui.TestRunner;
|
|||
*
|
||||
* @author Stephen Colebourne
|
||||
* @author <a href="mailto:ridesmet@users.sourceforge.net">Ringo De Smet</a>
|
||||
* @version $Id: LangTestSuite.java,v 1.13 2003/03/23 21:49:13 scolebourne Exp $
|
||||
* @version $Id: LangTestSuite.java,v 1.14 2003/03/31 03:53:52 alex Exp $
|
||||
*/
|
||||
public class LangTestSuite extends TestCase {
|
||||
|
||||
|
|
@ -101,6 +101,7 @@ public class LangTestSuite extends TestCase {
|
|||
suite.addTest(StringUtilsSubstringTest.suite());
|
||||
suite.addTest(StringUtilsEqualsIndexOfTest.suite());
|
||||
suite.addTest(StringUtilsIsTest.suite());
|
||||
suite.addTest(StringEscapeUtilsTest.suite());
|
||||
return suite;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,182 @@
|
|||
/* ====================================================================
|
||||
* The Apache Software License, Version 1.1
|
||||
*
|
||||
* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
|
||||
* reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
*
|
||||
* 3. The end-user documentation included with the redistribution, if
|
||||
* any, must include the following acknowlegement:
|
||||
* "This product includes software developed by the
|
||||
* Apache Software Foundation (http://www.apache.org/)."
|
||||
* Alternately, this acknowlegement may appear in the software itself,
|
||||
* if and wherever such third-party acknowlegements normally appear.
|
||||
*
|
||||
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
|
||||
* Foundation" must not be used to endorse or promote products derived
|
||||
* from this software without prior written permission. For written
|
||||
* permission, please contact apache@apache.org.
|
||||
*
|
||||
* 5. Products derived from this software may not be called "Apache"
|
||||
* nor may "Apache" appear in their names without prior written
|
||||
* permission of the Apache Software Foundation.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
||||
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
||||
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
||||
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
* SUCH DAMAGE.
|
||||
* ====================================================================
|
||||
*
|
||||
* This software consists of voluntary contributions made by many
|
||||
* individuals on behalf of the Apache Software Foundation. For more
|
||||
* information on the Apache Software Foundation, please see
|
||||
* <http://www.apache.org/>.
|
||||
*/
|
||||
package org.apache.commons.lang;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.io.IOException;
|
||||
|
||||
import junit.framework.Test;
|
||||
import junit.framework.TestCase;
|
||||
import junit.framework.TestSuite;
|
||||
import junit.textui.TestRunner;
|
||||
|
||||
/**
|
||||
* Unit tests {@link StringUtils}.
|
||||
*
|
||||
* @author of original StringUtilsTest.testEscape = ?
|
||||
* @author <a href="mailto:alex@purpletech.com">Alexander Day Chaffee</a>
|
||||
* @version $Id: StringEscapeUtilsTest.java,v 1.1 2003/03/31 03:53:52 alex Exp $
|
||||
*/
|
||||
public class StringEscapeUtilsTest extends TestCase {
|
||||
private final static String FOO = "foo";
|
||||
|
||||
public StringEscapeUtilsTest(String name) {
|
||||
super(name);
|
||||
}
|
||||
|
||||
public static void main(String[] args) {
|
||||
TestRunner.run(suite());
|
||||
}
|
||||
|
||||
public static Test suite() {
|
||||
TestSuite suite = new TestSuite(StringEscapeUtilsTest.class);
|
||||
suite.setName("StringEscapeUtilsTest Tests");
|
||||
return suite;
|
||||
}
|
||||
|
||||
//-----------------------------------------------------------------------
|
||||
|
||||
public void testEscapeJava() throws IOException {
|
||||
assertEscapeJava("empty string", "", "");
|
||||
assertEscapeJava(FOO, FOO);
|
||||
assertEscapeJava("tab", "\\t", "\t");
|
||||
assertEscapeJava("backslash", "\\\\", "\\");
|
||||
assertEscapeJava("single quote should not be escaped", "'", "'");
|
||||
assertEscapeJava("\\\\\\b\\t\\r", "\\\b\t\r");
|
||||
assertEscapeJava("\\u1234", "\u1234");
|
||||
assertEscapeJava("\\u0234", "\u0234");
|
||||
assertEscapeJava("\\u00fd", "\u00fd");
|
||||
|
||||
assertEscapeJava("He didn't say, \\\"stop!\\\"",
|
||||
"He didn't say, \"stop!\"");
|
||||
assertEscapeJava("non-breaking space", "This space is non-breaking:" + "\\u00a0",
|
||||
"This space is non-breaking:\u00a0");
|
||||
assertEscapeJava("\\uabcd\\u1234\\u012c",
|
||||
"\uABCD\u1234\u012C");
|
||||
}
|
||||
|
||||
private void assertEscapeJava(String escaped, String original) throws IOException {
|
||||
assertEscapeJava(null, escaped, original);
|
||||
}
|
||||
|
||||
private void assertEscapeJava(String message, String expected, String original) throws IOException {
|
||||
String converted = StringEscapeUtils.escapeJava(original);
|
||||
message = "escapeJava(String) failed" + (message == null ? "" : (": " + message));
|
||||
assertEquals(message, expected, converted);
|
||||
|
||||
StringPrintWriter writer = new StringPrintWriter();
|
||||
StringEscapeUtils.escapeJava(writer, original);
|
||||
assertEquals(expected, writer.getString());
|
||||
}
|
||||
|
||||
public void testUnescapeJava() throws IOException {
|
||||
assertUnescapeJava("", "");
|
||||
assertUnescapeJava("test", "test");
|
||||
assertUnescapeJava("\ntest\b", "\\ntest\\b");
|
||||
assertUnescapeJava("\u123425foo\ntest\b", "\\u123425foo\\ntest\\b");
|
||||
}
|
||||
|
||||
private void assertUnescapeJava(String unescaped, String original) throws IOException {
|
||||
assertEquals("unescape(String) failed",
|
||||
unescaped, StringUtils.unescape(original));
|
||||
|
||||
StringPrintWriter writer = new StringPrintWriter();
|
||||
StringEscapeUtils.unescapeJava(writer, original);
|
||||
assertEquals(unescaped, writer.getString());
|
||||
|
||||
}
|
||||
|
||||
public void testEscapeJavaScript() {
|
||||
assertEquals("He didn\\'t say, \\\"stop!\\\"", StringEscapeUtils.escapeJavaScript("He didn't say, \"stop!\""));
|
||||
}
|
||||
|
||||
|
||||
// HTML
|
||||
//--------------------------------------------------------------
|
||||
String[][] htmlEscapes = {
|
||||
{"no escaping", "plain text", "plain text"},
|
||||
{"no escaping", "plain text", "plain text"},
|
||||
{"empty string", "", ""},
|
||||
{"ampersand", "bread & butter", "bread & butter"},
|
||||
{"quotes", ""bread" & butter", "\"bread\" & butter"},
|
||||
{"final character only", "greater than >", "greater than >"},
|
||||
{"first character only", "< less than", "< less than"},
|
||||
{"apostrophe", "Huntington's chorea", "Huntington's chorea"},
|
||||
{"languages", "English,Français,日本語 (nihongo)", "English,Français,\u65E5\u672C\u8A9E (nihongo)"},
|
||||
};
|
||||
|
||||
public void testEscapeHtml() {
|
||||
for (int i = 0; i < htmlEscapes.length; ++i) {
|
||||
assertEquals(htmlEscapes[i][0], htmlEscapes[i][1], StringEscapeUtils.escapeHtml(htmlEscapes[i][2]));
|
||||
// todo: add test for (and implement) Writer-based version
|
||||
}
|
||||
}
|
||||
|
||||
public void testHtmlunescape() {
|
||||
for (int i = 0; i < htmlEscapes.length; ++i) {
|
||||
assertEquals(htmlEscapes[i][0], htmlEscapes[i][2], StringEscapeUtils.unescapeHtml(htmlEscapes[i][1]));
|
||||
// todo: add test for (and implement) Writer-based version
|
||||
}
|
||||
// should we unicode-escape the cedilla here, for 7-bit cleanliness?
|
||||
assertEquals("funny chars pass through OK", "Français", StringEscapeUtils.unescapeHtml("Français"));
|
||||
}
|
||||
|
||||
// SQL
|
||||
// see http://www.jguru.com/faq/view.jsp?EID=8881
|
||||
//--------------------
|
||||
// public void testEscapeSQL() throws Exception {
|
||||
// sql doubles-up single-quotes
|
||||
// }
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue