org.htmlcleaner.DomSerializer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of extractor Show documentation
Show all versions of extractor Show documentation
Web Data Extractor - Extract data from common web format. like HTML,XML,JSON.
The newest version!
/* Copyright (c) 2006-2013, the HtmlCleaner Project
All rights reserved.
Redistribution and use of this software in source and binary forms,
with or without modification, are permitted provided that the following
conditions are met:
* Redistributions of source code must retain the above
copyright notice, this list of conditions and the
following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other
materials provided with the distribution.
* The name of HtmlCleaner may not be used to endorse or promote
products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
package org.htmlcleaner;
import org.w3c.dom.*;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* DOM serializer - creates xml DOM.
*/
public class DomSerializer {
/**
* The HTML Cleaner properties set by the user to control the HTML cleaning.
*/
protected CleanerProperties props;
/**
* Whether XML entities should be escaped or not.
*/
protected boolean escapeXml = true;
/**
* @param props the HTML Cleaner properties set by the user to control the HTML cleaning.
* @param escapeXml if true then escape XML entities
*/
public DomSerializer(CleanerProperties props, boolean escapeXml) {
this.props = props;
this.escapeXml = escapeXml;
}
/**
* @param props the HTML Cleaner properties set by the user to control the HTML cleaning.
*/
public DomSerializer(CleanerProperties props) {
this(props, true);
}
/**
* @param rootNode the HTML Cleaner root node to serialize
* @return the W3C Document object
* @throws ParserConfigurationException if there's an error during serialization
*/
public Document createDOM(TagNode rootNode) throws ParserConfigurationException {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
DOMImplementation impl = builder.getDOMImplementation();
Document document;
//
// Where a DOCTYPE is supplied in the input, ensure that this is in the output DOM. See issue #27
//
// Note that we may want to fix incorrect DOCTYPEs in future; there are some fairly
// common patterns for errors with the older HTML4 doctypes.
//
if (rootNode.getDocType() != null) {
String qualifiedName = rootNode.getDocType().getPart1();
String publicId = rootNode.getDocType().getPublicId();
String systemId = rootNode.getDocType().getSystemId();
//
// If there is no qualified name, set it to html. See bug #153.
//
if (qualifiedName == null) qualifiedName = "html";
DocumentType documentType = impl.createDocumentType(qualifiedName, publicId, systemId);
//
// While the qualified name is "HTML" for some DocTypes, we want the actual document root name to be "html". See bug #116
//
if (qualifiedName.equals("HTML")) qualifiedName = "html";
document = impl.createDocument(rootNode.getNamespaceURIOnPath(""), qualifiedName, documentType);
} else {
document = builder.newDocument();
Element rootElement = document.createElement(rootNode.getName());
document.appendChild(rootElement);
}
//
// Copy across root node attributes - see issue 127. Thanks to rasifiel for the patch
//
Map attributes = rootNode.getAttributes();
Iterator> entryIterator = attributes.entrySet().iterator();
while (entryIterator.hasNext()) {
Map.Entry entry = entryIterator.next();
String attrName = entry.getKey();
String attrValue = entry.getValue();
if (escapeXml) {
attrValue = Utils.escapeXml(attrValue, props, true);
}
document.getDocumentElement().setAttribute(attrName, attrValue);
//
// Flag the attribute as an ID attribute if appropriate. Thanks to Chris173
//
if (attrName.equalsIgnoreCase("id")) {
document.getDocumentElement().setIdAttribute(attrName, true);
}
}
createSubnodes(document, (Element) document.getDocumentElement(), rootNode.getAllChildren());
return document;
}
/**
* @param element the element to check
* @return true if the passed element is a script or style element
*/
protected boolean isScriptOrStyle(Element element) {
String tagName = element.getNodeName();
return "script".equalsIgnoreCase(tagName) || "style".equalsIgnoreCase(tagName);
}
/**
* encapsulate content with <[CDATA[ ]]> for things like script and style elements
*
* @param element
* @return true if <[CDATA[ ]]> should be used.
*/
protected boolean dontEscape(Element element) {
// make sure doesn't get turned into
return props.isUseCdataFor(element.getNodeName()) && (!element.hasChildNodes() || element.getTextContent() == null || element.getTextContent().trim().length() == 0);
}
protected String outputCData(CData cdata) {
return cdata.getContentWithoutStartAndEndTokens();
}
/**
* Serialize a given HTML Cleaner node.
*
* @param document the W3C Document to use for creating new DOM elements
* @param element the W3C element to which we'll add the subnodes to
* @param tagChildren the HTML Cleaner nodes to serialize for that node
*/
private void createSubnodes(Document document, Element element, List tagChildren) {
if (tagChildren != null) {
for (Object item : tagChildren) {
if (item instanceof CommentNode) {
CommentNode commentNode = (CommentNode) item;
Comment comment = document.createComment(commentNode.getContent());
element.appendChild(comment);
} else if (item instanceof CData) {
//
// Only include CData inside Script and Style tags
//
if (props.isUseCdataFor(element.getNodeName())) {
element.appendChild(document.createCDATASection(outputCData((CData) item)));
}
} else if (item instanceof ContentNode) {
ContentNode contentNode = (ContentNode) item;
String content = contentNode.getContent();
boolean specialCase = dontEscape(element);
if (escapeXml && !specialCase) {
content = Utils.escapeXml(content, props, true);
}
element.appendChild(specialCase ? document.createCDATASection(content) : document.createTextNode(content));
} else if (item instanceof TagNode) {
TagNode subTagNode = (TagNode) item;
Element subelement = document.createElement(subTagNode.getName());
Map attributes = subTagNode.getAttributes();
Iterator> entryIterator = attributes.entrySet().iterator();
while (entryIterator.hasNext()) {
Map.Entry entry = (Map.Entry) entryIterator.next();
String attrName = (String) entry.getKey();
String attrValue = (String) entry.getValue();
if (escapeXml) {
attrValue = Utils.escapeXml(attrValue, props, true);
}
subelement.setAttribute(attrName, attrValue);
//
// Flag the attribute as an ID attribute if appropriate. Thanks to Chris173
//
if (attrName.equalsIgnoreCase("id")) {
subelement.setIdAttribute(attrName, true);
}
}
// recursively create subnodes
createSubnodes(document, subelement, subTagNode.getAllChildren());
element.appendChild(subelement);
} else if (item instanceof List) {
List sublist = (List) item;
createSubnodes(document, element, sublist);
}
}
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy