/* (c) 2014 Open Source Geospatial Foundation - all rights reserved
* (c) 2001 - 2013 OpenPlans
* This code is licensed under the GPL 2.0 license, available at the root
* application directory.
*/
package org.vfny.geoserver.global.xml;
import java.io.IOException;
import java.io.Writer;
import java.util.Collections;
import java.util.Iterator;
import java.util.Map;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import org.vfny.geoserver.global.ConfigurationException;
/**
* WriterUtils purpose.
*
* <p>
* Used to provide assitance writing xml to a Writer.
* </p>
*
* <p></p>
*
* @author dzwiers, Refractions Research, Inc.
* @version $Id$
*/
public class WriterHelper {
/** Used internally to create log information to detect errors. */
private static final Logger LOGGER = org.geotools.util.logging.Logging.getLogger("org.vfny.geoserver.global");
/**
* Will find out if a string contains chars that need to be turned into an xml entity, even if
* the string has lineends inside of it (thus the DOTALL flag)
*/
private static final Pattern XML_ENTITIES = Pattern.compile(".*[\"&'<>]+.*", Pattern.DOTALL);
/** The output writer. */
protected Writer writer;
protected int indent;
protected StringBuffer indentBuffer = new StringBuffer();
/**
* WriterUtils constructor.
*
* <p>
* Should never be called.
* </p>
*/
protected WriterHelper() {
}
/**
* WriterUtils constructor.
*
* <p>
* Stores the specified writer to use for output.
* </p>
*
* @param writer the writer which will be used for outputing the xml.
*/
public WriterHelper(Writer writer) {
this.writer = writer;
}
/**
* writeln purpose.
*
* <p>
* Writes the String specified to the stored output writer.
* </p>
*
* @param s The String to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void writeln(String s) throws ConfigurationException {
try {
writer.write(indentBuffer.subSequence(0, indent) + s + "\n");
writer.flush();
} catch (IOException e) {
throw new ConfigurationException("Writeln" + writer, e);
}
}
private void increaseIndent() {
indent += 2;
indentBuffer.append(" ");
}
private void decreaseIndent() {
if (indent > 0) {
indent -= 2;
indentBuffer.setLength(indentBuffer.length() - 2);
}
}
/**
* openTag purpose.
*
* <p>
* Writes an open xml tag with the name specified to the stored output
* writer.
* </p>
*
* @param tagName The tag name to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void openTag(String tagName) throws ConfigurationException {
openTag(tagName, Collections.EMPTY_MAP);
}
/**
* openTag purpose.
*
* <p>
* Writes an open xml tag with the name and attributes specified to the
* stored output writer.
* </p>
*
* @param tagName The tag name to write.
* @param attributes The tag attributes to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void openTag(String tagName, Map attributes)
throws ConfigurationException {
StringBuffer sb = new StringBuffer();
sb.append("<" + tagName + " ");
Iterator i = attributes.keySet().iterator();
while (i.hasNext()) {
String s = (String) i.next();
if (attributes.get(s) != null) {
sb.append(s + " = " + "\"" + escape((attributes.get(s)).toString()) + "\" ");
}
}
sb.append(">");
writeln(sb.toString());
increaseIndent();
}
/**
* closeTag purpose.
*
* <p>
* Writes an close xml tag with the name specified to the stored output
* writer.
* </p>
*
* @param tagName The tag name to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void closeTag(String tagName) throws ConfigurationException {
decreaseIndent();
writeln("</" + tagName + ">");
}
/**
* valueTag purpose.
*
* <p>
* Writes an xml tag with the name and value specified to the stored output
* writer.
* </p>
*
* @param tagName The tag name to write.
* @param value The text data to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void valueTag(String tagName, String value)
throws ConfigurationException {
writeln("<" + tagName + " value = \"" + escape(value) + "\" />");
}
/**
* attrTag purpose.
*
* <p>
* Writes an xml tag with the name and attributes specified to the stored
* output writer.
* </p>
*
* @param tagName The tag name to write.
* @param attributes The tag attributes to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void attrTag(String tagName, Map attributes)
throws ConfigurationException {
StringBuffer sb = new StringBuffer();
sb.append("<" + tagName + " ");
Iterator i = attributes.keySet().iterator();
while (i.hasNext()) {
String s = (String) i.next();
if (attributes.get(s) != null) {
sb.append(s + " = " + "\"" + escape((attributes.get(s)).toString()) + "\" ");
}
}
sb.append("/>");
writeln(sb.toString());
}
/**
* textTag purpose.
*
* <p>
* Writes a text xml tag with the name and text specified to the stored
* output writer.
* </p>
*
* @param tagName The tag name to write.
* @param data The text data to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void textTag(String tagName, String data) throws ConfigurationException {
textTag(tagName, Collections.EMPTY_MAP, data);
}
/**
* textTag purpose.
*
* <p>
* Writes an xml tag with the name, text and attributes specified to the
* stored output writer.
* </p>
*
* @param tagName The tag name to write.
* @param attributes The tag attributes to write.
* @param data The tag text to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void textTag(String tagName, Map attributes, String data)
throws ConfigurationException {
StringBuffer sb = new StringBuffer();
sb.append("<" + tagName + ((attributes.size() > 0) ? " " : ""));
Iterator i = attributes.keySet().iterator();
while (i.hasNext()) {
String s = (String) i.next();
if (attributes.get(s) != null) {
sb.append(s + " = " + "\"" + escape((attributes.get(s)).toString()) + "\" ");
}
}
String escapedData = "";
if(data != null)
escapedData = escape(data);
sb.append(">" + escapedData + "</" + tagName + ">");
writeln(sb.toString());
}
/**
* comment purpose.
*
* <p>
* Writes an xml comment with the text specified to the stored output
* writer.
* </p>
*
* @param comment The comment text to write.
*
* @throws ConfigurationException When an IO exception occurs.
*/
public void comment(String comment) throws ConfigurationException {
writeln("<!--");
increaseIndent();
String ib = indentBuffer.substring(0, indent);
comment = comment.trim();
comment = comment.replaceAll("\n", "\n" + ib);
writeln(comment);
decreaseIndent();
writeln("-->");
}
/**
* Escapes the provided text with XML entities,
* see (http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references#Character_entities_in_XML)
* @param text
* @return
*/
private String escape(String text) {
String s = new String(text);
// All redundant carriage returns should already have been stripped.
s = s.replaceAll("\r\n", "\n");
if(XML_ENTITIES.matcher(s).matches()) {
s = s.replaceAll("&", "&");
s = s.replaceAll("\"", """);
s = s.replaceAll("'", "'");
s = s.replaceAll("<", "<");
s = s.replaceAll(">", ">");
}
return s;
}
}