From: Mathieu Baudier <mbaudier@argeo.org>
Date: Wed, 4 May 2022 10:18:11 +0000 (+0200)
Subject: Introduce XML normaliser
X-Git-Tag: v2.3.10~240
X-Git-Url: https://git.argeo.org/?a=commitdiff_plain;h=ab4418c37af65497a533d1b258fcaf55fb1610a6;p=lgpl%2Fargeo-commons.git

Introduce XML normaliser
---

diff --git a/org.argeo.cms/src/org/argeo/cms/acr/xml/XmlNormalizer.java b/org.argeo.cms/src/org/argeo/cms/acr/xml/XmlNormalizer.java
new file mode 100644
index 000000000..c2f0346dd
--- /dev/null
+++ b/org.argeo.cms/src/org/argeo/cms/acr/xml/XmlNormalizer.java
@@ -0,0 +1,112 @@
+package org.argeo.cms.acr.xml;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.lang.System.Logger;
+import java.lang.System.Logger.Level;
+import java.nio.file.DirectoryStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.transform.OutputKeys;
+import javax.xml.transform.Transformer;
+import javax.xml.transform.TransformerConfigurationException;
+import javax.xml.transform.TransformerException;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.TransformerFactoryConfigurationError;
+import javax.xml.transform.dom.DOMSource;
+import javax.xml.transform.stream.StreamResult;
+import javax.xml.transform.stream.StreamSource;
+
+import org.w3c.dom.DOMException;
+import org.w3c.dom.Document;
+import org.xml.sax.SAXException;
+
+/**
+ * Consistently normalises an XML in order to ease diff (typically in a
+ * versioning system).
+ */
+public class XmlNormalizer {
+	private final static Logger logger = System.getLogger(XmlNormalizer.class.getName());
+
+	private DocumentBuilder documentBuilder;
+	private Transformer transformer;
+
+	public XmlNormalizer() {
+		this(2);
+	}
+
+	public XmlNormalizer(int indent) {
+		try {
+			documentBuilder = DocumentBuilderFactory.newNSInstance().newDocumentBuilder();
+			TransformerFactory transformerFactory = TransformerFactory.newInstance();
+			transformerFactory.setAttribute("indent-number", indent);
+			try (InputStream in = XmlNormalizer.class.getResourceAsStream("stripSpaces.xsl")) {
+				transformer = transformerFactory.newTransformer(new StreamSource(in));
+			}
+		} catch (TransformerConfigurationException | ParserConfigurationException | TransformerFactoryConfigurationError
+				| IOException e) {
+			throw new IllegalStateException("Cannot initialise document builder and transformer", e);
+		}
+	}
+
+	public void normalizeXmlFiles(DirectoryStream<Path> ds) throws IOException {
+		for (Path path : ds) {
+			normalizeXmlFile(path);
+		}
+	}
+
+	public void normalizeXmlFile(Path path) throws IOException {
+		byte[] bytes = Files.readAllBytes(path);
+		try (ByteArrayInputStream in = new ByteArrayInputStream(bytes);
+				OutputStream out = Files.newOutputStream(path)) {
+			normalizeAndIndent(in, out);
+			logger.log(Level.DEBUG, () -> "Normalized XML " + path);
+		}
+	}
+
+	public void normalizeAndIndent(InputStream in, OutputStream out) throws IOException {
+		normalizeAndIndent(in, out, 2);
+	}
+
+	public void normalizeAndIndent(InputStream in, OutputStream out, int indent) throws IOException {
+		try {
+			Document document = documentBuilder.parse(in);
+
+			// clear whitespaces outside tags
+			document.normalize();
+//			XPath xPath = XPathFactory.newInstance().newXPath();
+//			NodeList nodeList = (NodeList) xPath.evaluate("//text()[normalize-space()='']", document,
+//					XPathConstants.NODESET);
+//
+//			for (int i = 0; i < nodeList.getLength(); ++i) {
+//				Node node = nodeList.item(i);
+//				node.getParentNode().removeChild(node);
+//			}
+
+			transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
+			// transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
+			transformer.setOutputProperty(OutputKeys.INDENT, "yes");
+
+			transformer.transform(new DOMSource(document), new StreamResult(out));
+		} catch (DOMException | IllegalArgumentException | SAXException | TransformerFactoryConfigurationError
+				| TransformerException e) {
+			throw new RuntimeException("Cannot normalise and indent XML", e);
+		}
+	}
+
+	public static void main(String[] args) throws IOException {
+		XmlNormalizer xmlNormalizer = new XmlNormalizer();
+		DirectoryStream<Path> ds = Files.newDirectoryStream(
+				Paths.get("/mnt/mbaudier/dev/git/unstable/argeo-suite/org.argeo.app.theme.default/icons/types/svg"),
+				"*.svg");
+		xmlNormalizer.normalizeXmlFiles(ds);
+
+	}
+}
diff --git a/org.argeo.cms/src/org/argeo/cms/acr/xml/stripSpaces.xsl b/org.argeo.cms/src/org/argeo/cms/acr/xml/stripSpaces.xsl
new file mode 100644
index 000000000..c1d265f6d
--- /dev/null
+++ b/org.argeo.cms/src/org/argeo/cms/acr/xml/stripSpaces.xsl
@@ -0,0 +1,12 @@
+<xsl:stylesheet version="1.0"
+	xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+	<xsl:strip-space elements="*" />
+	<xsl:output method="xml" encoding="UTF-8" />
+
+	<xsl:template match="@*|node()">
+		<xsl:copy>
+			<xsl:apply-templates select="@*|node()" />
+		</xsl:copy>
+	</xsl:template>
+
+</xsl:stylesheet>
\ No newline at end of file