franta-hg@128: /**
franta-hg@128:  * SQL-DK
franta-hg@128:  * Copyright © 2014 František Kučera (frantovo.cz)
franta-hg@128:  *
franta-hg@128:  * This program is free software: you can redistribute it and/or modify
franta-hg@128:  * it under the terms of the GNU General Public License as published by
franta-hg@128:  * the Free Software Foundation, either version 3 of the License, or
franta-hg@128:  * (at your option) any later version.
franta-hg@128:  *
franta-hg@128:  * This program is distributed in the hope that it will be useful,
franta-hg@128:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@128:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@128:  * GNU General Public License for more details.
franta-hg@128:  *
franta-hg@128:  * You should have received a copy of the GNU General Public License
franta-hg@128:  * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@128:  */
franta-hg@128: package info.globalcode.sql.dk.formatting;
franta-hg@128: 
franta-hg@128: import info.globalcode.sql.dk.ColorfulPrintWriter;
franta-hg@128: import info.globalcode.sql.dk.ColorfulPrintWriter.TerminalColor;
franta-hg@128: import java.util.Stack;
franta-hg@128: import javax.xml.namespace.QName;
franta-hg@128: import static info.globalcode.sql.dk.Functions.isEmpty;
franta-hg@128: import static info.globalcode.sql.dk.Functions.toHex;
franta-hg@128: import java.nio.charset.Charset;
franta-hg@128: import java.util.EmptyStackException;
franta-hg@128: import java.util.HashMap;
franta-hg@128: import java.util.LinkedHashMap;
franta-hg@128: import java.util.Map;
franta-hg@128: import java.util.Map.Entry;
franta-hg@128: import java.util.logging.Level;
franta-hg@128: import java.util.logging.Logger;
franta-hg@128: 
franta-hg@128: /**
franta-hg@128:  *
franta-hg@128:  * @author Ing. František Kučera (frantovo.cz)
franta-hg@128:  */
franta-hg@128: public abstract class AbstractXmlFormatter extends AbstractFormatter {
franta-hg@128: 
franta-hg@128: 	private static final Logger log = Logger.getLogger(AbstractXmlFormatter.class.getName());
franta-hg@128: 	public static final String PROPERTY_COLORFUL = "color";
franta-hg@128: 	public static final String PROPERTY_INDENT = "indent";
franta-hg@130: 	/**
franta-hg@130: 	 * Whether text with line breaks should be indented (default). Otherwise original whitespace
franta-hg@130: 	 * will be preserved.
franta-hg@130: 	 */
franta-hg@130: 	public static final String PROPERTY_INDENT_TEXT = "indentText";
franta-hg@128: 	private static final TerminalColor ELEMENT_COLOR = TerminalColor.Magenta;
franta-hg@128: 	private static final TerminalColor ATTRIBUTE_NAME_COLOR = TerminalColor.Green;
franta-hg@128: 	private static final TerminalColor ATTRIBUTE_VALUE_COLOR = TerminalColor.Yellow;
franta-hg@128: 	private static final TerminalColor XML_DECLARATION_COLOR = TerminalColor.Red;
franta-hg@128: 	private Stack<QName> treePosition = new Stack<>();
franta-hg@128: 	private final ColorfulPrintWriter out;
franta-hg@128: 	private final String indent;
franta-hg@130: 	private final boolean indentText;
franta-hg@128: 
franta-hg@128: 	public AbstractXmlFormatter(FormatterContext formatterContext) {
franta-hg@128: 		super(formatterContext);
franta-hg@128: 		boolean colorful = formatterContext.getProperties().getBoolean(PROPERTY_COLORFUL, false);
franta-hg@128: 		out = new ColorfulPrintWriter(formatterContext.getOutputStream(), false, colorful);
franta-hg@128: 		indent = formatterContext.getProperties().getString(PROPERTY_INDENT, "\t");
franta-hg@130: 		indentText = formatterContext.getProperties().getBoolean(PROPERTY_INDENT_TEXT, true);
franta-hg@128: 
franta-hg@128: 		if (!indent.matches("\\s*")) {
franta-hg@128: 			log.log(Level.WARNING, "Setting indent to „{0}“ is weird & freaky; in hex: {1}", new Object[]{indent, toHex(indent.getBytes())});
franta-hg@128: 		}
franta-hg@128: 
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected void printStartDocument() {
franta-hg@128: 		out.print(XML_DECLARATION_COLOR, "<?xml version=\"1.0\" encoding=\"" + Charset.defaultCharset().name() + "\"?>");
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected void printEndDocument() {
franta-hg@128: 		out.println();
franta-hg@128: 		out.flush();
franta-hg@128: 		if (!treePosition.empty()) {
franta-hg@128: 			throw new IllegalStateException("Some elements are not closed: " + treePosition);
franta-hg@128: 		}
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected void printStartElement(QName element) {
franta-hg@128: 		printStartElement(element, null);
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected Map<QName, String> singleAttribute(QName name, String value) {
franta-hg@128: 		Map<QName, String> attributes = new HashMap<>(1);
franta-hg@128: 		attributes.put(name, value);
franta-hg@128: 		return attributes;
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected void printStartElement(QName element, Map<QName, String> attributes) {
franta-hg@128: 		printStartElement(element, attributes, false);
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	/**
franta-hg@128: 	 * @param empty whether element should be closed <codfe>… /&gt;</code> (has no content, do not
franta-hg@128: 	 * call {@linkplain #printEndElement()})
franta-hg@128: 	 */
franta-hg@128: 	private void printStartElement(QName element, Map<QName, String> attributes, boolean empty) {
franta-hg@128: 		printIndent();
franta-hg@128: 
franta-hg@128: 		out.print(ELEMENT_COLOR, "<" + toString(element));
franta-hg@128: 
franta-hg@128: 		if (attributes != null) {
franta-hg@128: 			for (Entry<QName, String> attribute : attributes.entrySet()) {
franta-hg@128: 				out.print(" ");
franta-hg@128: 				out.print(ATTRIBUTE_NAME_COLOR, toString(attribute.getKey()));
franta-hg@128: 				out.print("=");
franta-hg@128: 				out.print(ATTRIBUTE_VALUE_COLOR, '"' + escapeXmlAttribute(attribute.getValue()) + '"');
franta-hg@128: 			}
franta-hg@128: 		}
franta-hg@128: 
franta-hg@128: 		if (empty) {
franta-hg@128: 			out.print(ELEMENT_COLOR, "/>");
franta-hg@128: 		} else {
franta-hg@128: 			out.print(ELEMENT_COLOR, ">");
franta-hg@128: 			treePosition.add(element);
franta-hg@128: 		}
franta-hg@128: 
franta-hg@128: 		out.flush();
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	/**
franta-hg@128: 	 * Prints text node wrapped in given element without indenting the text and adding line breaks
franta-hg@128: 	 * (useful for short texts).
franta-hg@128: 	 *
franta-hg@128: 	 * @param attributes use {@linkplain  LinkedHashMap} to preserve attributes order
franta-hg@128: 	 */
franta-hg@128: 	protected void printTextElement(QName element, Map<QName, String> attributes, String text) {
franta-hg@128: 		printStartElement(element, attributes);
franta-hg@130: 
franta-hg@130: 		String[] lines = text.split("\\n");
franta-hg@130: 
franta-hg@130: 		if (indentText && lines.length > 1) {
franta-hg@130: 			for (String line : lines) {
franta-hg@130: 				printText(line, true);
franta-hg@130: 			}
franta-hg@130: 			printEndElement(true);
franta-hg@130: 		} else {
franta-hg@130: 			/*
franta-hg@130: 			 * line breaks at the end of the text will be eaten – if you need them, use indentText = false
franta-hg@130: 			 */
franta-hg@132: 			if (lines.length == 1 && text.endsWith("\n")) {
franta-hg@132: 				text = text.substring(0, text.length() - 1);
franta-hg@132: 			}
franta-hg@132: 
franta-hg@132: 			printText(text, false);
franta-hg@130: 			printEndElement(false);
franta-hg@130: 		}
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected void printEmptyElement(QName element, Map<QName, String> attributes) {
franta-hg@128: 		printStartElement(element, attributes, true);
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected void printEndElement() {
franta-hg@128: 		printEndElement(true);
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	private void printEndElement(boolean indent) {
franta-hg@128: 		try {
franta-hg@128: 			QName name = treePosition.pop();
franta-hg@128: 
franta-hg@128: 			if (indent) {
franta-hg@128: 				printIndent();
franta-hg@128: 			}
franta-hg@128: 
franta-hg@128: 			out.print(ELEMENT_COLOR, "</" + toString(name) + ">");
franta-hg@128: 			out.flush();
franta-hg@128: 
franta-hg@128: 		} catch (EmptyStackException e) {
franta-hg@128: 			throw new IllegalStateException("No more elements to end.", e);
franta-hg@128: 		}
franta-hg@128: 	}
franta-hg@128: 
franta-hg@130: 	protected void printText(String s, boolean indent) {
franta-hg@128: 		if (indent) {
franta-hg@128: 			printIndent();
franta-hg@128: 		}
franta-hg@128: 		out.print(escapeXmlText(s));
franta-hg@128: 		out.flush();
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected void printIndent() {
franta-hg@128: 		out.println();
franta-hg@128: 		for (int i = 0; i < treePosition.size(); i++) {
franta-hg@128: 			out.print(indent);
franta-hg@128: 		}
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected static QName qname(String name) {
franta-hg@128: 		return new QName(name);
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	protected static QName qname(String prefix, String name) {
franta-hg@128: 		return new QName(null, name, prefix);
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	private String toString(QName name) {
franta-hg@128: 		if (isEmpty(name.getPrefix(), true)) {
franta-hg@128: 			return escapeName(name.getLocalPart());
franta-hg@128: 		} else {
franta-hg@128: 			return escapeName(name.getPrefix()) + ":" + escapeName(name.getLocalPart());
franta-hg@128: 		}
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	private String escapeName(String s) {
franta-hg@128: 		// TODO: avoid ugly values in <name name="…"/>		
franta-hg@128: 		return s;
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	private static String escapeXmlText(String s) {
franta-hg@128: 		return s.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;");
franta-hg@128: 		// Not needed:
franta-hg@128: 		// return s.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll("\"", "&quot;").replaceAll("'", "&apos;");
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	/**
franta-hg@128: 	 * Expects attribute values enclosed in "quotes" not 'apostrophes'.
franta-hg@128: 	 */
franta-hg@128: 	private static String escapeXmlAttribute(String s) {
franta-hg@128: 		return s.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll("\"", "&quot;");
franta-hg@128: 	}
franta-hg@128: }