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 HTML escape of a given template fragment. Specifically,
063: * < > " and & are all turned into entities.
064: *
065: * <p>Usage:<br />
066: * From java:</p>
067: * <pre>
068: * SimpleHash root = new SimpleHash();
069: *
070: * root.put( "htmlEscape", new freemarker.template.utility.HtmlEscape() );
071: *
072: * ...
073: * </pre>
074: *
075: * <p>From your FreeMarker template:</p>
076: * <pre>
077: *
078: * The following is HTML-escaped:
079: * <transform htmlEscape>
080: * <p>This paragraph has all HTML special characters escaped.</p>
081: * </transform>
082: *
083: * ...
084: * </pre>
085: *
086: * @version $Id: HtmlEscape.java,v 1.29 2003/02/25 00:28:16 revusky Exp $
087: * @see freemarker.template.utility.XmlEscape
088: */
089: public class HtmlEscape implements TemplateTransformModel {
090:
091: private static final char[] LT = "<".toCharArray();
092: private static final char[] GT = ">".toCharArray();
093: private static final char[] AMP = "&".toCharArray();
094: private static final char[] QUOT = """.toCharArray();
095:
096: public Writer getWriter(final Writer out, Map args) {
097: return new Writer() {
098: public void write(char c) throws IOException {
099: switch (c) {
100: case '<':
101: out.write(LT, 0, 4);
102: break;
103: case '>':
104: out.write(GT, 0, 4);
105: break;
106: case '&':
107: out.write(AMP, 0, 5);
108: break;
109: case '"':
110: out.write(QUOT, 0, 6);
111: break;
112: default:
113: out.write(c);
114: }
115: }
116:
117: public void write(char cbuf[], int off, int len)
118: throws IOException {
119: int lastoff = off;
120: int lastpos = off + len;
121: for (int i = off; i < lastpos; i++) {
122: switch (cbuf[i]) {
123: case '<':
124: out.write(cbuf, lastoff, i - lastoff);
125: out.write(LT, 0, 4);
126: lastoff = i + 1;
127: break;
128: case '>':
129: out.write(cbuf, lastoff, i - lastoff);
130: out.write(GT, 0, 4);
131: lastoff = i + 1;
132: break;
133: case '&':
134: out.write(cbuf, lastoff, i - lastoff);
135: out.write(AMP, 0, 5);
136: lastoff = i + 1;
137: break;
138: case '"':
139: out.write(cbuf, lastoff, i - lastoff);
140: out.write(QUOT, 0, 6);
141: lastoff = i + 1;
142: break;
143: }
144: }
145: int remaining = lastpos - lastoff;
146: if (remaining > 0) {
147: out.write(cbuf, lastoff, remaining);
148: }
149: }
150:
151: public void flush() throws IOException {
152: out.flush();
153: }
154:
155: public void close() {
156: }
157: };
158: }
159: }
|