com.jaeksoft.searchlib.util.DomUtils Maven / Gradle / Ivy

Go to download
/**   
 * License Agreement for OpenSearchServer
 *
 * Copyright (C) 2008-2014 Emmanuel Keller / Jaeksoft
 * 
 * http://www.open-search-server.com
 * 
 * This file is part of OpenSearchServer.
 *
 * OpenSearchServer is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 * OpenSearchServer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with OpenSearchServer. 
 *  If not, see .
 **/

package com.jaeksoft.searchlib.util;

import java.io.File;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.List;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;

import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;

public class DomUtils {

	final private static void getNodes(final Node parent, final int pos,
			final String[] path, final List nodes) {
		if (pos == path.length) {
			nodes.add(parent);
			return;
		}
		NodeList childrens = parent.getChildNodes();
		int l = childrens.getLength();
		int nextPos = pos + 1;
		for (int i = 0; i < l; i++) {
			Node node = childrens.item(i);
			switch (node.getNodeType()) {
			case Node.ELEMENT_NODE:
				if (node.getNodeName().equals(path[pos]))
					getNodes(node, nextPos, path, nodes);
				break;
			default:
				continue;
			}
		}
	}

	final public static void getNodes(final List nodes,
			final Node parent, final String... path) {
		if (path == null)
			return;
		if (path.length == 0)
			return;
		getNodes(parent, 0, path, nodes);
	}

	final public static String getFirstTextNode(final Node parent,
			final String... path) {
		List nodes = DomUtils.getNodes(parent, path);
		if (nodes == null)
			return null;
		if (nodes.size() < 1)
			return null;
		return DomUtils.getText(nodes.get(0));
	}

	final public static List getNodes(final Node parent,
			final String... path) {
		if (path == null)
			return null;
		if (path.length == 0)
			return null;
		List nodes = new ArrayList();
		getNodes(nodes, parent, path);
		return nodes;
	}

	final public static Node getFirstNode(final Node parent,
			final String... path) {
		List nodes = getNodes(parent, path);
		if (nodes == null)
			return null;
		if (nodes.size() == 0)
			return null;
		return nodes.get(0);
	}

	final private static void getText(final Node parent, final StringBuilder sb) {
		switch (parent.getNodeType()) {
		case Node.TEXT_NODE:
		case Node.CDATA_SECTION_NODE:
			sb.append(parent.getNodeValue());
			break;
		}
		NodeList childrens = parent.getChildNodes();
		int l = childrens.getLength();
		for (int i = 0; i < l; i++)
			getText(childrens.item(i), sb);
	}

	final public static String getText(final Node node) {
		StringBuilder sb = new StringBuilder();
		getText(node, sb);
		return sb.toString();
	}

	final public static int countElements(final Node parent) {
		int counter = 0;
		NodeList childrens = parent.getChildNodes();
		int l = childrens.getLength();
		for (int i = 0; i < l; i++) {
			Node node = childrens.item(i);
			switch (node.getNodeType()) {
			case Node.ELEMENT_NODE:
				counter++;
				counter += countElements(node);
				break;
			default:
				continue;
			}
		}
		return counter;
	}

	final public static String getAttributeText(final Node node,
			final String name) {
		NamedNodeMap nnm = node.getAttributes();
		if (nnm == null)
			return null;
		Node attr = nnm.getNamedItem(name);
		if (attr == null)
			return null;
		return attr.getNodeValue();
	}

	final public static String getAttributeText(final Node node,
			final String name, final String defaultValue) {
		String attr = getAttributeText(node, name);
		return attr == null ? defaultValue : attr;
	}

	final public static > E getAttributeEnum(final Node node,
			final String name, final E[] enums, final E defaultEnum) {
		String attr = getAttributeText(node, name);
		if (attr == null)
			return defaultEnum;
		for (E e : enums)
			if (e.name().equalsIgnoreCase(attr))
				return e;
		return defaultEnum;
	}

	final public static double getAttributeDouble(final Node node,
			final String name) {
		return getAttributeDouble(node, name, 0);
	}

	final public static double getAttributeDouble(final Node node,
			final String name, final double defaultValue) {
		String value = getAttributeText(node, name);
		return value == null ? defaultValue : Double.parseDouble(value);
	}

	final public static Float getAttributeFloat(final Node node,
			final String name) {
		String value = getAttributeText(node, name);
		return StringUtils.isEmpty(value) ? null : Float.parseFloat(value);
	}

	final public static Boolean getAttributeBoolean(final Node node,
			final String name, final Boolean defaultValue) {
		String value = getAttributeText(node, name);
		if (value == null)
			return defaultValue;
		if ("yes".equalsIgnoreCase(value))
			return true;
		if ("no".equalsIgnoreCase(value))
			return false;
		return Boolean.parseBoolean(value);
	}

	final public static Integer getAttributeInteger(final Node node,
			final String name, final Integer defaultValue) {
		String value = getAttributeText(node, name);
		if (value == null)
			return defaultValue;
		return Integer.parseInt(value);
	}

	final public static void updateAttributeText(final Node node,
			final String name, final String value) {
		NamedNodeMap nnm = node.getAttributes();
		if (nnm == null)
			return;
		Node attr = nnm.getNamedItem(name);
		if (attr == null)
			return;
		attr.setNodeValue(value);
	}

	final private static void getAllNodes(final Node parent,
			final String[] tags, final List nodes) {
		for (String tag : tags) {
			if (parent.getNodeName().equals(tag)) {
				nodes.add(parent);
				break;
			}
		}
		NodeList childrens = parent.getChildNodes();
		int l = childrens.getLength();
		for (int i = 0; i < l; i++)
			getAllNodes(childrens.item(i), tags, nodes);

	}

	final public static List getAllNodes(final Node parent,
			final String... tags) {
		List nodes = new ArrayList();
		getAllNodes(parent, tags, nodes);
		return nodes;
	}

	private final static SimpleLock dbfLock = new SimpleLock();

	private static final DocumentBuilderFactory getDocumentBuilderFactory() {
		DocumentBuilderFactory dbf = null;
		dbfLock.rl.lock();
		try {
			dbf = DocumentBuilderFactory.newInstance();
		} finally {
			dbfLock.rl.unlock();
		}
		return dbf;
	}

	private static final DocumentBuilder getDocumentBuilder(
			final boolean errorSilent) throws ParserConfigurationException {
		DocumentBuilderFactory dbf = getDocumentBuilderFactory();

		dbf.setValidating(false);
		dbf.setIgnoringComments(false);
		dbf.setIgnoringElementContentWhitespace(true);
		dbf.setNamespaceAware(false);

		DocumentBuilder db = null;
		db = dbf.newDocumentBuilder();
		db.setEntityResolver(new NullResolver());

		db.setErrorHandler(errorSilent ? ParserErrorHandler.SILENT_ERROR_HANDLER
				: ParserErrorHandler.STANDARD_ERROR_HANDLER);
		return db;
	}

	public static final Document readXml2(final InputSource source)
			throws ParserConfigurationException, SAXException, IOException {
		DocumentBuilderFactory factory = getDocumentBuilderFactory();
		factory.setValidating(false);
		factory.setFeature(
				"http://xml.org/sax/features/external-parameter-entities",
				false);
		factory.setFeature(
				"http://apache.org/xml/features/nonvalidating/load-external-dtd",
				false);
		DocumentBuilder db = null;
		db = factory.newDocumentBuilder();
		return db.parse(source);
	}

	public static final Document readXml(final StreamSource source,
			final boolean errorSilent) throws SAXException, IOException,
			ParserConfigurationException {

		InputSource is2 = new InputSource();
		is2.setSystemId(source.getSystemId());
		is2.setByteStream(source.getInputStream());
		is2.setCharacterStream(source.getReader());

		return getDocumentBuilder(errorSilent).parse(is2);
	}

	public static final Document readXml(final InputSource source,
			final boolean errorSilent) throws SAXException, IOException,
			ParserConfigurationException {
		return getDocumentBuilder(errorSilent).parse(source);
	}

	public static class NullResolver implements EntityResolver {
		@Override
		public InputSource resolveEntity(String publicId, String systemId)
				throws SAXException, IOException {
			return new InputSource(new StringReader(""));
		}
	}

	public final static void xslt(final Source xmlSource, final String xsl,
			final Result xmlResult) throws TransformerException {
		StreamSource xslSource = new StreamSource(new StringReader(xsl));
		TransformerFactory tf = TransformerFactory.newInstance();
		tf.setErrorListener(ParserErrorHandler.STANDARD_ERROR_HANDLER);
		Transformer trans = tf.newTransformer(xslSource);
		trans.setErrorListener(ParserErrorHandler.STANDARD_ERROR_HANDLER);
		trans.transform(xmlSource, xmlResult);
	}

	public final static Result xslt(final Source xmlSource, final String xsl,
			final File destination) throws TransformerException {
		StreamResult xmlResult = new StreamResult(destination);
		xslt(xmlSource, xsl, xmlResult);
		return xmlResult;
	}

	public final static String xslt(final Source xmlSource, final String xsl)
			throws TransformerException {
		StringWriter sw = null;
		try {
			sw = new StringWriter();
			StreamResult xmlResult = new StreamResult(sw);
			xslt(xmlSource, xsl, xmlResult);
			return sw.toString();
		} finally {
			IOUtils.close(sw);
		}
	}

	public final static void removeChildren(final Node node) {
		if (node == null)
			return;
		NodeList nodeList = node.getChildNodes();
		if (nodeList == null)
			return;
		int l = nodeList.getLength();
		for (int i = 0; i < l; i++) {
			Node n = nodeList.item(i);
			if (n != null)
				node.removeChild(n);
		}

	}

}