/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.xsom.parser;
import java.io.IOException;
import java.net.URL;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.*;
import org.xml.sax.helpers.XMLFilterImpl;
import com.sun.xml.xsom.impl.parser.Messages;
/**
* Standard XMLParser implemented by using JAXP.
*
* @author
* Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
*/
public class JAXPParser implements XMLParser {
// not in older JDK, so must be duplicated here, otherwise javax.xml.XMLConstants should be used
private static final String ACCESS_EXTERNAL_SCHEMA = "http://javax.xml.XMLConstants/property/accessExternalSchema";
private static final Logger LOGGER = Logger.getLogger(JAXPParser.class.getName());
private final SAXParserFactory factory;
public JAXPParser( SAXParserFactory factory ) {
factory.setNamespaceAware(true); // just in case
this.factory = factory;
}
/**
* @deprecated Unsafe, use JAXPParser(factory) instead with
* security features initialized by setting
* XMLConstants.FEATURE_SECURE_PROCESSING feature.
*/
public JAXPParser() {
this( SAXParserFactory.newInstance());
}
public void parse( InputSource source, ContentHandler handler,
ErrorHandler errorHandler, EntityResolver entityResolver )
throws SAXException, IOException {
try {
SAXParser saxParser = allowFileAccess(factory.newSAXParser(), false);
XMLReader reader = new XMLReaderEx(saxParser.getXMLReader());
reader.setContentHandler(handler);
if(errorHandler!=null)
reader.setErrorHandler(errorHandler);
if(entityResolver!=null)
reader.setEntityResolver(entityResolver);
reader.parse(source);
} catch( ParserConfigurationException e ) {
// in practice this won't happen
SAXParseException spe = new SAXParseException(e.getMessage(),null,e);
errorHandler.fatalError(spe);
throw spe;
}
}
private static SAXParser allowFileAccess(SAXParser saxParser, boolean disableSecureProcessing) throws SAXException {
// if feature secure processing enabled, nothing to do, file is allowed,
// or user is able to control access by standard JAXP mechanisms
if (disableSecureProcessing) {
return saxParser;
}
try {
saxParser.setProperty(ACCESS_EXTERNAL_SCHEMA, "file");
LOGGER.log(Level.FINE, Messages.format(Messages.JAXP_SUPPORTED_PROPERTY, ACCESS_EXTERNAL_SCHEMA));
} catch (SAXException ignored) {
// nothing to do; support depends on version JDK or SAX implementation
LOGGER.log(Level.CONFIG, Messages.format(Messages.JAXP_UNSUPPORTED_PROPERTY, ACCESS_EXTERNAL_SCHEMA), ignored);
}
return saxParser;
}
/**
* XMLReader with improved error message for entity resolution failure.
*
* TODO: this class is completely stand-alone, so it shouldn't be
* an inner class.
*/
private static class XMLReaderEx extends XMLFilterImpl {
private Locator locator;
XMLReaderEx( XMLReader parent ) {
this.setParent(parent);
}
/**
* Resolves entities and reports user-friendly error messages.
*
* <p>
* Some XML parser (at least Xerces) does not report much information
* when it fails to resolve an entity, which is often quite
* frustrating. For example, if you are behind a firewall and the
* schema contains a reference to www.w3.org, and there is no
* entity resolver, the parser will just throw an IOException
* that doesn't contain any information about where that reference
* occurs nor what it is accessing.
*
* <p>
* By implementing an EntityResolver and resolving the reference
* by ourselves, we can report an error message with all the
* necessary information to fix the problem.
*
* <p>
* Note that we still need to the client-specified entity resolver
* to let the application handle entity resolution. Here we just catch
* an IOException and add more information.
*/
@Override
public InputSource resolveEntity(String publicId, String systemId) throws SAXException {
try {
InputSource is=null;
// ask the client-specified entity resolver first
if( this.getEntityResolver()!=null)
is = this.getEntityResolver().resolveEntity(publicId,systemId);
if( is!=null ) return is; // if that succeeds, fine.
// rather than returning null, resolve it now
// so that we can detect errors.
is = new InputSource( new URL(systemId).openStream() );
is.setSystemId(systemId);
is.setPublicId(publicId);
return is;
} catch( IOException e ) {
// catch this error and provide a nice error message, rather than
// just throwing this IOException.
SAXParseException spe = new SAXParseException(
Messages.format(Messages.ERR_ENTITY_RESOLUTION_FAILURE,
systemId, e.toString()), // use the toString method to get the class name
locator, e );
if(this.getErrorHandler()!=null)
this.getErrorHandler().fatalError(spe);
throw spe;
}
}
@Override
public void setDocumentLocator(Locator locator) {
super.setDocumentLocator(locator);
this.locator = locator;
}
}
}