com.adobe.epubcheck.ctc.XmlDocParser Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of epubcheck Show documentation
Show all versions of epubcheck Show documentation
EPUBCheck is a tool to validate the conformance of EPUB publications against
the EPUB specifications. EPUBCheck can be run as a standalone command-line tool or used
as a Java library.
package com.adobe.epubcheck.ctc;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Hashtable;
import java.util.Stack;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.xml.sax.Attributes;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import com.adobe.epubcheck.api.EPUBLocation;
import com.adobe.epubcheck.api.Report;
import com.adobe.epubcheck.messages.MessageId;
import com.adobe.epubcheck.ocf.EncryptionFilter;
import com.adobe.epubcheck.util.EpubConstants;
import com.adobe.epubcheck.util.NamespaceHelper;
/**
* === WARNING ==========================================
* This class is scheduled to be refactored and integrated
* in another package.
* Please keep changes minimal (bug fixes only) until then.
* ========================================================
*/
class XmlDocParser
{
private final ZipFile zip;
private final Hashtable enc;
private final Report report;
public XmlDocParser(ZipFile zip, Report report)
{
this.zip = zip;
this.enc = new Hashtable();
this.report = report;
}
public Document parseDocument(String fileEntry)
{
Document doc = null;
InputStream is = null;
try
{
is = getInputStream(fileEntry);
if (is == null)
{
String fileName = new File(zip.getName()).getName();
report.message(MessageId.RSC_001, EPUBLocation.create(fileName), fileEntry);
}
else
{
doc = readXML(report, fileEntry, is, EpubConstants.ElementLineNumberAttribute, EpubConstants.ElementColumnNumberAttribute);
}
}
catch (IOException e)
{
// Ignore, should have been reported earlier
// report.message(MessageId.PKG_008, EPUBLocation.create(fileEntry),
// fileEntry);
}
catch (SAXException e)
{
// Ignore, should have been reported earlier
// report.message(MessageId.RSC_005, EPUBLocation.create(fileEntry),
// e.getMessage());
doc = null;
}
finally
{
if (is != null)
{
try
{
is.close();
}
catch (Exception ignore)
{
}
}
}
return doc;
}
InputStream getInputStream(String name) throws
IOException
{
ZipEntry entry = zip.getEntry(name);
if (entry == null)
{
return null;
}
InputStream in = zip.getInputStream(entry);
EncryptionFilter filter = enc.get(name);
if (filter == null)
{
return in;
}
if (filter.canDecrypt())
{
return filter.decrypt(in);
}
return null;
}
private Document readXML(Report report, String fileEntry, InputStream is, final String lineNumAttribName, final String columnNumAttribName) throws
IOException,
SAXException
{
final Document doc;
SAXParser parser;
try
{
SAXParserFactory factory = SAXParserFactory.newInstance();
factory.setFeature("http://xml.org/sax/features/namespaces", true); //default false
factory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);//default true
factory.setFeature("http://xml.org/sax/features/external-general-entities", false);
factory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
parser = factory.newSAXParser();
//tell parser about the lexical handler
DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance();
docBuilderFactory.setFeature("http://xml.org/sax/features/external-general-entities", false);
docBuilderFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder();
doc = docBuilder.newDocument();
}
catch (ParserConfigurationException e)
{
throw new RuntimeException("Can't create SAX parser / DOM builder.", e);
}
MyHandler handler = new MyHandler(doc, report, fileEntry, lineNumAttribName, columnNumAttribName);
parser.parse(is, handler);
return doc;
}
static public int getElementLineNumber(Element element)
{
return getElementAttributeAsInt(element, EpubConstants.ElementLineNumberAttribute);
}
static public int getElementColumnNumber(Element element)
{
return getElementAttributeAsInt(element, EpubConstants.ElementColumnNumberAttribute);
}
static int getElementAttributeAsInt(Element whichElement, String whichAttribute)
{
int result = -1;
String attr = whichElement.getAttribute(whichAttribute);
if (attr != null && attr.length() > 0)
{
result = Integer.parseInt(attr);
}
return result;
}
class MyHandler extends DefaultHandler
{
private Locator locator;
private final NamespaceHelper namespaceHelper = new NamespaceHelper();
private Report report;
private String fileName;
private Document doc;
private String lineNumAttribName;
private String columnNumAttribName;
final Stack elementStack = new Stack();
final StringBuilder textBuffer = new StringBuilder();
public MyHandler(Document doc, Report report, String fileName, String lineNumAttribName, String columnNumAttribName)
{
this.doc = doc;
this.report = report;
this.fileName = fileName;
this.lineNumAttribName = lineNumAttribName;
this.columnNumAttribName = columnNumAttribName;
}
@Override
public void setDocumentLocator(Locator locator)
{
this.locator = locator; //Save the locator, so that it can be used later for line tracking when traversing nodes.
}
public void setReport(Report report)
{
this.report = report;
}
@Override
public void startPrefixMapping (String prefix, String uri) throws SAXException
{
namespaceHelper.declareNamespace(prefix, uri, EPUBLocation.create(fileName, locator.getLineNumber(), locator.getColumnNumber(), prefix), report);
}
@Override
public void startElement(String uri, String localName, String qName, Attributes attributes) throws
SAXException
{
namespaceHelper.onStartElement(fileName, locator, uri, qName, attributes, report);
addTextIfNeeded();
Element el = doc.createElementNS(uri, qName);
for (int i = 0; i < attributes.getLength(); i++)
{
String attributeURI = attributes.getURI(i);
if (attributeURI == null || attributeURI.equals(""))
{
attributeURI = uri;
}
el.setAttributeNS(attributeURI, attributes.getQName(i), attributes.getValue(i));
}
el.setAttribute(lineNumAttribName, String.valueOf(locator.getLineNumber()));
el.setAttribute(columnNumAttribName, String.valueOf(locator.getColumnNumber()));
elementStack.push(el);
}
@Override
public void endElement(String uri, String localName, String qName)
{
addTextIfNeeded();
Element closedEl = elementStack.pop();
if (elementStack.isEmpty())
{ // Is this the root element?
doc.appendChild(closedEl);
}
else
{
Element parentEl = elementStack.peek();
parentEl.appendChild(closedEl);
}
namespaceHelper.onEndElement(report);
}
@Override
public void characters(char ch[], int start, int length) throws
SAXException
{
textBuffer.append(ch, start, length);
}
// Outputs text accumulated under the current node
private void addTextIfNeeded()
{
if (textBuffer.length() > 0)
{
Element el = elementStack.peek();
Node textNode = doc.createTextNode(textBuffer.toString());
el.appendChild(textNode);
textBuffer.delete(0, textBuffer.length());
}
}
};
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy