Apache Solr open-source search software
SOLR-16628: Ensure that InputStreams are closed after Xml parsing (#1302)
Michael Gibneye20fcf857a32
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txtindex d5591cd2049..03b0d47abe6 100644--- a/solr/CHANGES.txt+++ b/solr/CHANGES.txt@@ -197,6 +197,8 @@ Bug Fixes* SOLR-16648: NullPointerException when excluding facets in More Like This Handler (Mikhail Khludnev)+* SOLR-16628: Ensure that InputStreams are closed after Xml parsing (Michael Gibney, David Smiley, Kevin Risden)+Build---------------------* Upgrade forbiddenapis to 3.4 (Uwe Schindler)diff --git a/solr/core/src/java/org/apache/solr/core/SolrConfig.java b/solr/core/src/java/org/apache/solr/core/SolrConfig.javaindex d5f9769ada1..f9ffff39e36 100644--- a/solr/core/src/java/org/apache/solr/core/SolrConfig.java+++ b/solr/core/src/java/org/apache/solr/core/SolrConfig.java@@ -173,8 +173,8 @@ public class SolrConfig implements MapSerializable {InputStream in;String fileName;- ResourceProvider(SolrResourceLoader loader, String res) throws IOException {- this.in = loader.openResource(res);+ ResourceProvider(InputStream in) throws IOException {+ this.in = in;if (in instanceof ZkSolrResourceLoader.ZkByteArrayInputStream) {ZkSolrResourceLoader.ZkByteArrayInputStream zkin =(ZkSolrResourceLoader.ZkByteArrayInputStream) in;@@ -401,8 +401,8 @@ public class SolrConfig implements MapSerializable {}private IndexSchemaFactory.VersionedConfig readXml(SolrResourceLoader loader, String name) {- try {- ResourceProvider rp = new ResourceProvider(loader, name);+ try (InputStream in = loader.openResource(name)) {+ ResourceProvider rp = new ResourceProvider(in);XmlConfigFile xml = new XmlConfigFile(loader, rp, name, null, "/config/", null);return new IndexSchemaFactory.VersionedConfig(rp.zkVersion,diff --git a/solr/core/src/java/org/apache/solr/core/XmlConfigFile.java b/solr/core/src/java/org/apache/solr/core/XmlConfigFile.javaindex 080e2ee0bd6..3433635002d 100644--- a/solr/core/src/java/org/apache/solr/core/XmlConfigFile.java+++ b/solr/core/src/java/org/apache/solr/core/XmlConfigFile.java@@ -38,6 +38,7 @@ import javax.xml.xpath.XPathFactory;import org.apache.solr.cloud.ZkSolrResourceLoader;import org.apache.solr.common.SolrException;import org.apache.solr.common.util.DOMUtil;+import org.apache.solr.common.util.IOUtils;import org.apache.solr.util.SafeXMLParsing;import org.apache.solr.util.SystemIdResolver;import org.slf4j.Logger;@@ -119,9 +120,10 @@ public class XmlConfigFile { // formerly simply "Config"this.name = name;this.prefix = (prefix != null && !prefix.endsWith("/")) ? prefix + '/' : prefix;+ InputStream in = null;try {if (is == null && fileSupplier != null) {- InputStream in = fileSupplier.apply(name);+ in = fileSupplier.apply(name);if (in instanceof ZkSolrResourceLoader.ZkByteArrayInputStream) {zkVersion = ((ZkSolrResourceLoader.ZkByteArrayInputStream) in).getStat().getVersion();log.debug("loaded config {} with version {} ", name, zkVersion);@@ -138,6 +140,9 @@ public class XmlConfigFile { // formerly simply "Config"} catch (SAXException e) {SolrException.log(log, "Exception during parsing file: " + name, e);throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, e);+ } finally {+ // XML Parser should close but in exceptional cases might not; so let's be safe+ IOUtils.closeQuietly(in);}if (substituteProps != null) {DOMUtil.substituteProperties(doc, getSubstituteProperties());diff --git a/solr/core/src/java/org/apache/solr/schema/IndexSchemaFactory.java b/solr/core/src/java/org/apache/solr/schema/IndexSchemaFactory.javaindex da5f6966fbf..f688bc1c5ce 100644--- a/solr/core/src/java/org/apache/solr/schema/IndexSchemaFactory.java+++ b/solr/core/src/java/org/apache/solr/schema/IndexSchemaFactory.java@@ -136,8 +136,8 @@ public abstract class IndexSchemaFactory implements NamedListInitializedPlugin {private static VersionedConfig loadConfig(InputStream schemaInputStream, SolrResourceLoader loader, String name) {- try {- InputStream is = (schemaInputStream == null ? loader.openResource(name) : schemaInputStream);+ try (InputStream is =+ (schemaInputStream == null ? loader.openResource(name) : schemaInputStream)) {ConfigNode node = getParsedSchema(is, loader, name);int version =is instanceof ZkSolrResourceLoader.ZkByteArrayInputStreamdiff --git a/solr/core/src/java/org/apache/solr/schema/ManagedIndexSchemaFactory.java b/solr/core/src/java/org/apache/solr/schema/ManagedIndexSchemaFactory.javaindex 7dd6a81ebc9..15db3cd9837 100644--- a/solr/core/src/java/org/apache/solr/schema/ManagedIndexSchemaFactory.java+++ b/solr/core/src/java/org/apache/solr/schema/ManagedIndexSchemaFactory.java@@ -24,6 +24,9 @@ import java.lang.invoke.MethodHandles;import java.nio.file.Files;import java.nio.file.Path;import java.nio.file.Paths;+import java.util.AbstractMap.SimpleImmutableEntry;+import java.util.Map.Entry;+import net.jcip.annotations.NotThreadSafe;import org.apache.commons.io.IOUtils;import org.apache.solr.cloud.ZkController;import org.apache.solr.cloud.ZkSolrResourceLoader;@@ -48,6 +51,7 @@ import org.slf4j.LoggerFactory;import org.xml.sax.InputSource;/** Factory for ManagedIndexSchema */+@NotThreadSafepublic class ManagedIndexSchemaFactory extends IndexSchemaFactory implements SolrCoreAware {private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());public static final String UPGRADED_SCHEMA_EXTENSION = ".bak";@@ -76,7 +80,6 @@ public class ManagedIndexSchemaFactory extends IndexSchemaFactory implements Solprivate SolrCore core;private ZkIndexSchemaReader zkIndexSchemaReader;- private String loadedResource;private boolean shouldUpgrade = false;@Override@@ -197,89 +200,99 @@ public class ManagedIndexSchemaFactory extends IndexSchemaFactory implements Solthis.config = config;this.loader = config.getResourceLoader();InputStream schemaInputStream = null;+ String loadedResource = null;- if (null == resourceName) {- resourceName = IndexSchema.DEFAULT_SCHEMA_FILE;- }-- int schemaZkVersion = -1;- if (!(loader instanceof ZkSolrResourceLoader)) {- schemaInputStream = readSchemaLocally();- } else { // ZooKeeper- final ZkSolrResourceLoader zkLoader = (ZkSolrResourceLoader) loader;- final SolrZkClient zkClient = zkLoader.getZkController().getZkClient();- final String managedSchemaPath = lookupZKManagedSchemaPath();- managedSchemaResourceName =- managedSchemaPath.substring(managedSchemaPath.lastIndexOf("/") + 1); // not loving this- Stat stat = new Stat();- try {- // Attempt to load the managed schema- byte[] data = zkClient.getData(managedSchemaPath, null, stat, true);- schemaZkVersion = stat.getVersion();- schemaInputStream =- new ZkSolrResourceLoader.ZkByteArrayInputStream(data, managedSchemaPath, stat);- loadedResource = managedSchemaResourceName;- warnIfNonManagedSchemaExists();- } catch (InterruptedException e) {- // Restore the interrupted status- Thread.currentThread().interrupt();- log.warn("", e);- } catch (KeeperException.NoNodeException e) {- log.info(- "The schema is configured as managed, but managed schema resource {} not found - loading non-managed schema {} instead",- managedSchemaResourceName,- resourceName);- } catch (KeeperException e) {- String msg = "Error attempting to access " + managedSchemaPath;- log.error(msg, e);- throw new SolrException(ErrorCode.SERVER_ERROR, msg, e);+ try {+ if (null == resourceName) {+ resourceName = IndexSchema.DEFAULT_SCHEMA_FILE;}- if (null == schemaInputStream) {- // The managed schema file could not be found - load the non-managed schema++ int schemaZkVersion = -1;+ if (!(loader instanceof ZkSolrResourceLoader)) {+ Entry<String, InputStream> localSchemaInput = readSchemaLocally();+ loadedResource = localSchemaInput.getKey();+ schemaInputStream = localSchemaInput.getValue();+ } else { // ZooKeeper+ final ZkSolrResourceLoader zkLoader = (ZkSolrResourceLoader) loader;+ final SolrZkClient zkClient = zkLoader.getZkController().getZkClient();+ final String managedSchemaPath = lookupZKManagedSchemaPath();+ managedSchemaResourceName =+ managedSchemaPath.substring(managedSchemaPath.lastIndexOf("/") + 1); // not loving this+ Stat stat = new Stat();try {- schemaInputStream = loader.openResource(resourceName);- loadedResource = resourceName;- shouldUpgrade = true;- } catch (IOException e) {+ // Attempt to load the managed schema+ byte[] data = zkClient.getData(managedSchemaPath, null, stat, true);+ schemaZkVersion = stat.getVersion();+ schemaInputStream =+ new ZkSolrResourceLoader.ZkByteArrayInputStream(data, managedSchemaPath, stat);+ loadedResource = managedSchemaResourceName;+ warnIfNonManagedSchemaExists();+ } catch (InterruptedException e) {+ // Restore the interrupted status+ Thread.currentThread().interrupt();+ log.warn("", e);+ } catch (KeeperException.NoNodeException e) {+ log.info(+ "The schema is configured as managed, but managed schema resource {} not found - loading non-managed schema {} instead",+ managedSchemaResourceName,+ resourceName);+ } catch (KeeperException e) {+ String msg = "Error attempting to access " + managedSchemaPath;+ log.error(msg, e);+ throw new SolrException(ErrorCode.SERVER_ERROR, msg, e);+ }+ if (null == schemaInputStream) {+ // The managed schema file could not be found - load the non-managed schematry {- // Retry to load the managed schema, in case it was created since the first attempt- byte[] data = zkClient.getData(managedSchemaPath, null, stat, true);- schemaZkVersion = stat.getVersion();- schemaInputStream = new ByteArrayInputStream(data);- loadedResource = managedSchemaPath;- warnIfNonManagedSchemaExists();- } catch (Exception e1) {- if (e1 instanceof InterruptedException) {- Thread.currentThread().interrupt(); // Restore the interrupted status+ schemaInputStream = loader.openResource(resourceName);+ loadedResource = resourceName;+ shouldUpgrade = true;+ } catch (IOException e) {+ try {+ // Retry to load the managed schema, in case it was created since the first attempt+ byte[] data = zkClient.getData(managedSchemaPath, null, stat, true);+ schemaZkVersion = stat.getVersion();+ schemaInputStream = new ByteArrayInputStream(data);+ loadedResource = managedSchemaPath;+ warnIfNonManagedSchemaExists();+ } catch (Exception e1) {+ if (e1 instanceof InterruptedException) {+ Thread.currentThread().interrupt(); // Restore the interrupted status+ }+ final String msg =+ "Error loading both non-managed schema '"+ + resourceName+ + "' and managed schema '"+ + managedSchemaResourceName+ + "'";+ log.error(msg, e);+ throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, msg, e);}- final String msg =- "Error loading both non-managed schema '"- + resourceName- + "' and managed schema '"- + managedSchemaResourceName- + "'";- log.error(msg, e);- throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, msg, e);}}}+ assert loadedResource != null;+ InputSource inputSource = new InputSource(schemaInputStream);+ inputSource.setSystemId(SystemIdResolver.createSystemIdFromResourceName(loadedResource));+ try {+ schema =+ new ManagedIndexSchema(+ config,+ loadedResource,+ IndexSchemaFactory.getConfigResource(+ configSetService, schemaInputStream, loader, managedSchemaResourceName),+ isMutable,+ managedSchemaResourceName,+ schemaZkVersion,+ getSchemaUpdateLock());+ } catch (Exception e) {+ throw new SolrException(ErrorCode.SERVER_ERROR, "Error loading parsing schema", e);+ }+ } finally {+ // XML Parser should close but in exceptional cases might not; so let's be safe+ IOUtils.closeQuietly(schemaInputStream);}- InputSource inputSource = new InputSource(schemaInputStream);- inputSource.setSystemId(SystemIdResolver.createSystemIdFromResourceName(loadedResource));- try {- schema =- new ManagedIndexSchema(- config,- loadedResource,- IndexSchemaFactory.getConfigResource(- configSetService, schemaInputStream, loader, managedSchemaResourceName),- isMutable,- managedSchemaResourceName,- schemaZkVersion,- getSchemaUpdateLock());- } catch (Exception e) {- throw new SolrException(ErrorCode.SERVER_ERROR, "Error loading parsing schema", e);- }+if (shouldUpgrade) {// Persist the managed schema if it doesn't already existsynchronized (schema.getSchemaUpdateLock()) {@@ -290,8 +303,9 @@ public class ManagedIndexSchemaFactory extends IndexSchemaFactory implements Solreturn schema;}- private InputStream readSchemaLocally() {+ private Entry<String, InputStream> readSchemaLocally() {InputStream schemaInputStream = null;+ String loadedResource = null;try {// Attempt to load the managed schemafinal Path managedSchemaPath = lookupLocalManagedSchemaPath();@@ -323,7 +337,8 @@ public class ManagedIndexSchemaFactory extends IndexSchemaFactory implements Solthrow new SolrException(SolrException.ErrorCode.SERVER_ERROR, msg, e);}}- return schemaInputStream;+ assert loadedResource != null;+ return new SimpleImmutableEntry<>(loadedResource, schemaInputStream);}/** Return whether a non-managed schema exists, either in local storage or on ZooKeeper. */