net.sf.jasperreports.engine.xml.JRXmlDigester Maven / Gradle / Ivy
Show all versions of jasperreports Show documentation
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2022 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see
* By default the property is set to false.
*/
@Property(
category = PropertyConstants.CATEGORY_OTHER,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT},
sinceVersion = PropertyConstants.VERSION_6_2_1,
valueType = Boolean.class
)
public static final String PROPERTY_LOAD_UNKNOWN_ENTITIES =
JRPropertiesUtil.PROPERTY_PREFIX + "xml.load.unknown.entities";
/**
*
*/
//private static boolean wasWarning;
private Map internalEntityResources;
private Set entityURLs;
private boolean loadUnknownEntities;
private String lastNamespacePrefix;
private Object lastPopped;
/**
*
*/
public JRXmlDigester()
{
super();
initInternalResources();
}
/**
*
*/
public JRXmlDigester(XMLReader xmlReader)
{
super(xmlReader);
initInternalResources();
}
public JRXmlDigester(SAXParser parser)
{
super(parser);
initInternalResources();
}
private void initInternalResources()
{
internalEntityResources = new HashMap<>();
entityURLs = new HashSet<>();
//FIXME only add entities relevant to the current document type (report, print, template)
addEntityResource(JRXmlConstants.JASPERREPORT_SYSTEM_ID,
JRXmlConstants.JASPERREPORT_DTD);
addEntityResource(JRXmlConstants.JASPERPRINT_SYSTEM_ID,
JRXmlConstants.JASPERPRINT_DTD);
addEntityResource(JRXmlConstants.JASPERTEMPLATE_SYSTEM_ID,
JRXmlConstants.JASPERTEMPLATE_DTD);
addEntityResource(JRXmlConstants.JASPERREPORT_XSD_SYSTEM_ID,
JRXmlConstants.JASPERREPORT_XSD_RESOURCE);
addEntityResource(null,
JRXmlConstants.JASPERREPORT_XSD_DTD_COMPAT_RESOURCE);
addEntityResource(JRXmlConstants.JASPERPRINT_XSD_SYSTEM_ID,
JRXmlConstants.JASPERPRINT_XSD_RESOURCE);
addEntityResource(null,
JRXmlConstants.JASPERPRINT_XSD_DTD_COMPAT_RESOURCE);
addEntityResource(JRXmlConstants.JASPERTEMPLATE_XSD_SYSTEM_ID,
JRXmlConstants.JASPERTEMPLATE_XSD_RESOURCE);
addEntityResource(null,
JRXmlConstants.JASPERTEMPLATE_XSD_DTD_COMPAT_RESOURCE);
loadUnknownEntities = JRPropertiesUtil.getInstance(DefaultJasperReportsContext.getInstance()).getBooleanProperty(
PROPERTY_LOAD_UNKNOWN_ENTITIES, false);
}
/**
* Adds a mapping of an entity system ID to an internal/classloader resource
* name.
*
*
* This mapping is used by {@link #resolveEntity(String, String)} to
* resolve a system ID to a classloader resource.
*
* @param systemId the system ID
* @param resource the resource name
*/
public void addInternalEntityResource(String systemId, String resource)
{
if (resource == null)
{
if (log.isDebugEnabled())
{
log.debug("adding entity URL " + systemId);
}
entityURLs.add(systemId);
}
else
{
addEntityResource(systemId, resource);
}
}
private void addEntityResource(String systemId, String resource)
{
URL resourceURL = JRLoader.getResource(resource);
if (resourceURL == null)
{
log.warn("Could not find entity resource " + resource);
return;
}
if (log.isDebugEnabled())
{
log.debug("Entity " + systemId + " resolved to " + resourceURL);
}
if (systemId != null)
{
internalEntityResources.put(systemId, resourceURL);
}
entityURLs.add(resourceURL.toExternalForm());
}
@Override
public InputSource resolveEntity(
String pubId,
String systemId
)
{
InputSource inputSource = null;
if (systemId != null)
{
URL resourceURL = internalEntityResources.get(systemId);
if (resourceURL == null)
{
if (entityURLs.contains(systemId) || loadUnknownEntities)
{
if (log.isDebugEnabled())
{
log.debug("loading entity " + systemId);
}
//FIXME load from resource URLs?
inputSource = new InputSource(systemId);
}
else
{
throw new JRRuntimeException(EXCEPTION_MESSAGE_UNKOWN_ENTITY_NOT_LOADING,
new Object[]{systemId});
}
}
else
{
try
{
// load the data into the memory
byte[] resourceData = JRLoader.loadBytes(resourceURL);
InputStream memoryStream = new ByteArrayInputStream(resourceData);
inputSource = new InputSource(memoryStream);
}
catch (JRException e)
{
throw
new JRRuntimeException(
EXCEPTION_MESSAGE_KEY_ENTITY_LOADING_ERROR,
new Object[]{systemId},
e);
}
}
}
return inputSource;
}
@Override
public void endElement(String namespaceURI, String localName, String qName)
throws SAXException
{
lastNamespacePrefix = getNamespacePrefix(qName);
super.endElement(namespaceURI, localName, qName);
}
protected String getNamespacePrefix(String qName)
{
String prefix;
if (qName == null)
{
prefix = null;
}
else
{
int sepIdx = qName.indexOf(':');
if (sepIdx > 0)
{
prefix = qName.substring(0, sepIdx);
}
else
{
prefix = null;
}
}
return prefix;
}
public String getLastNamespacePrefix()
{
return lastNamespacePrefix;
}
@Override
public Object pop()
{
// remember the last popped object
lastPopped = super.pop();
return lastPopped;
}
/**
* Clears the last popped object.
*
* @see #lastPopped()
*/
public void clearLastPopped()
{
lastPopped = null;
}
/**
* Returns the previously popped object.
*
* This method can be used by rules that need to know the object was added and
* popped to the stack by an inner element.
*
* @return the previously popped object
*/
public Object lastPopped()
{
return lastPopped;
}
}