001: /*
002: * Copyright (c) 2003 The Visigoth Software Society. All rights
003: * reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions
007: * are met:
008: *
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: *
012: * 2. Redistributions in binary form must reproduce the above copyright
013: * notice, this list of conditions and the following disclaimer in
014: * the documentation and/or other materials provided with the
015: * distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowledgement:
019: * "This product includes software developed by the
020: * Visigoth Software Society (http://www.visigoths.org/)."
021: * Alternately, this acknowledgement may appear in the software itself,
022: * if and wherever such third-party acknowledgements normally appear.
023: *
024: * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
025: * project contributors may be used to endorse or promote products derived
026: * from this software without prior written permission. For written
027: * permission, please contact visigoths@visigoths.org.
028: *
029: * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
030: * nor may "FreeMarker" or "Visigoth" appear in their names
031: * without prior written permission of the Visigoth Software Society.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of the Visigoth Software Society. For more
049: * information on the Visigoth Software Society, please see
050: * http://www.visigoths.org/
051: */
052:
053: package freemarker.template.utility;
054:
055: import java.io.IOException;
056: import java.io.Writer;
057: import java.util.Map;
058:
059: import freemarker.template.TemplateTransformModel;
060:
061: /**
062: * Performs an XML escaping of a given template fragment. Specifically,
063: * < > " ' and & are all turned into entity references.
064: *
065: * <p>An instance of this tarnsform is initially visible as shared
066: * variable called <tt>xml_escape</tt>.</p>
067: *
068: * @version $Id: XmlEscape.java,v 1.29 2004/11/27 14:49:57 ddekany Exp $
069: */
070: public class XmlEscape implements TemplateTransformModel {
071:
072: private static final char[] LT = "<".toCharArray();
073: private static final char[] GT = ">".toCharArray();
074: private static final char[] AMP = "&".toCharArray();
075: private static final char[] QUOT = """.toCharArray();
076: private static final char[] APOS = "'".toCharArray();
077:
078: public Writer getWriter(final Writer out, Map args) {
079: return new Writer() {
080: public void write(char c) throws IOException {
081: switch (c) {
082: case '<':
083: out.write(LT, 0, 4);
084: break;
085: case '>':
086: out.write(GT, 0, 4);
087: break;
088: case '&':
089: out.write(AMP, 0, 5);
090: break;
091: case '"':
092: out.write(QUOT, 0, 6);
093: break;
094: case '\'':
095: out.write(APOS, 0, 6);
096: break;
097: default:
098: out.write(c);
099: }
100: }
101:
102: public void write(char cbuf[], int off, int len)
103: throws IOException {
104: int lastoff = off;
105: int lastpos = off + len;
106: for (int i = off; i < lastpos; i++) {
107: switch (cbuf[i]) {
108: case '<':
109: out.write(cbuf, lastoff, i - lastoff);
110: out.write(LT, 0, 4);
111: lastoff = i + 1;
112: break;
113: case '>':
114: out.write(cbuf, lastoff, i - lastoff);
115: out.write(GT, 0, 4);
116: lastoff = i + 1;
117: break;
118: case '&':
119: out.write(cbuf, lastoff, i - lastoff);
120: out.write(AMP, 0, 5);
121: lastoff = i + 1;
122: break;
123: case '"':
124: out.write(cbuf, lastoff, i - lastoff);
125: out.write(QUOT, 0, 6);
126: lastoff = i + 1;
127: break;
128: case '\'':
129: out.write(cbuf, lastoff, i - lastoff);
130: out.write(APOS, 0, 6);
131: lastoff = i + 1;
132: break;
133: }
134: }
135: int remaining = lastpos - lastoff;
136: if (remaining > 0) {
137: out.write(cbuf, lastoff, remaining);
138: }
139: }
140:
141: public void flush() throws IOException {
142: out.flush();
143: }
144:
145: public void close() {
146: }
147: };
148: }
149: }
|