2014-08-07 11:25:17 -04:00
|
|
|
/* ====================================================================
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
==================================================================== */
|
|
|
|
|
|
|
|
package org.apache.poi.util;
|
|
|
|
|
|
|
|
import java.io.IOException;
|
|
|
|
import java.io.InputStream;
|
|
|
|
import java.io.StringReader;
|
|
|
|
import java.lang.reflect.Method;
|
|
|
|
|
|
|
|
import org.dom4j.Document;
|
|
|
|
import org.dom4j.DocumentException;
|
|
|
|
import org.dom4j.io.SAXReader;
|
2014-08-13 19:13:43 -04:00
|
|
|
import javax.xml.parsers.ParserConfigurationException;
|
|
|
|
import javax.xml.parsers.SAXParserFactory;
|
|
|
|
|
2014-08-07 11:25:17 -04:00
|
|
|
import org.xml.sax.EntityResolver;
|
|
|
|
import org.xml.sax.InputSource;
|
|
|
|
import org.xml.sax.SAXException;
|
2014-08-13 19:13:43 -04:00
|
|
|
import org.xml.sax.XMLReader;
|
2014-08-07 11:25:17 -04:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Provides handy methods for working with SAX parsers and readers
|
|
|
|
*/
|
|
|
|
public final class SAXHelper {
|
|
|
|
private static POILogger logger = POILogFactory.getLogger(SAXHelper.class);
|
2014-08-13 19:13:43 -04:00
|
|
|
|
|
|
|
private SAXHelper() {}
|
|
|
|
|
2014-08-07 11:25:17 -04:00
|
|
|
/**
|
2014-08-13 19:13:43 -04:00
|
|
|
* Creates a new SAX XMLReader, with sensible defaults
|
2014-08-07 11:25:17 -04:00
|
|
|
*/
|
2014-08-13 19:13:43 -04:00
|
|
|
public static synchronized XMLReader newXMLReader() throws SAXException, ParserConfigurationException {
|
|
|
|
XMLReader xmlReader = saxFactory.newSAXParser().getXMLReader();
|
|
|
|
xmlReader.setEntityResolver(IGNORING_ENTITY_RESOLVER);
|
2014-08-10 10:29:45 -04:00
|
|
|
trySetSAXFeature(xmlReader, FEATURE_SECURE_PROCESSING, true);
|
2014-08-07 11:25:17 -04:00
|
|
|
trySetXercesSecurityManager(xmlReader);
|
|
|
|
return xmlReader;
|
|
|
|
}
|
2014-08-13 19:13:43 -04:00
|
|
|
|
|
|
|
static final EntityResolver IGNORING_ENTITY_RESOLVER = new EntityResolver() {
|
|
|
|
// not in Java 5: @Override
|
|
|
|
public InputSource resolveEntity(String publicId, String systemId)
|
|
|
|
throws SAXException, IOException {
|
|
|
|
return new InputSource(new StringReader(""));
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
private static final SAXParserFactory saxFactory;
|
|
|
|
static {
|
|
|
|
saxFactory = SAXParserFactory.newInstance();
|
|
|
|
saxFactory.setValidating(false);
|
|
|
|
saxFactory.setNamespaceAware(true);
|
|
|
|
}
|
|
|
|
|
|
|
|
// remove this constant once on Java 6 and stax-api.jar was removed (which is missing this constant):
|
|
|
|
static final String FEATURE_SECURE_PROCESSING = "http://javax.xml.XMLConstants/feature/secure-processing";
|
|
|
|
|
|
|
|
private static void trySetSAXFeature(XMLReader xmlReader, String feature, boolean enabled) {
|
2014-08-07 11:25:17 -04:00
|
|
|
try {
|
|
|
|
xmlReader.setFeature(feature, enabled);
|
|
|
|
} catch (Exception e) {
|
|
|
|
logger.log(POILogger.INFO, "SAX Feature unsupported", feature, e);
|
|
|
|
}
|
|
|
|
}
|
2014-08-13 19:13:43 -04:00
|
|
|
|
|
|
|
private static void trySetXercesSecurityManager(XMLReader xmlReader) {
|
2014-08-07 11:25:17 -04:00
|
|
|
// Try built-in JVM one first, standalone if not
|
|
|
|
for (String securityManagerClassName : new String[] {
|
|
|
|
"com.sun.org.apache.xerces.internal.util.SecurityManager",
|
|
|
|
"org.apache.xerces.util.SecurityManager"
|
|
|
|
}) {
|
|
|
|
try {
|
|
|
|
Object mgr = Class.forName(securityManagerClassName).newInstance();
|
|
|
|
Method setLimit = mgr.getClass().getMethod("setEntityExpansionLimit", Integer.TYPE);
|
|
|
|
setLimit.invoke(mgr, 4096);
|
|
|
|
xmlReader.setProperty("http://apache.org/xml/properties/security-manager", mgr);
|
|
|
|
// Stop once one can be setup without error
|
|
|
|
return;
|
|
|
|
} catch (Exception e) {
|
|
|
|
logger.log(POILogger.INFO, "SAX Security Manager could not be setup", e);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-08-13 19:13:43 -04:00
|
|
|
/**
|
|
|
|
* Creates a new DOM4J SAXReader, with sensible defaults
|
|
|
|
*/
|
|
|
|
public static SAXReader getSAXReader() throws DocumentException {
|
|
|
|
try {
|
|
|
|
SAXReader reader = new SAXReader(newXMLReader(), false);
|
|
|
|
reader.setEntityResolver(IGNORING_ENTITY_RESOLVER);
|
|
|
|
return reader;
|
|
|
|
} catch (SAXException saxe) {
|
|
|
|
throw new DocumentException(saxe);
|
|
|
|
} catch (ParserConfigurationException pce) {
|
|
|
|
throw new DocumentException(pce);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-08-07 11:25:17 -04:00
|
|
|
/**
|
|
|
|
* Parses the given stream via the default (sensible)
|
|
|
|
* SAX Reader
|
|
|
|
* @param inp Stream to read the XML data from
|
|
|
|
* @return the SAX processed Document
|
|
|
|
*/
|
|
|
|
public static Document readSAXDocument(InputStream inp) throws DocumentException {
|
|
|
|
return getSAXReader().read(inp);
|
|
|
|
}
|
|
|
|
}
|