This is an automated email from the ASF dual-hosted git repository.
stevel pushed a commit to branch branch-3.3
in repository https://gitbox.apache.org/repos/asf/hadoop.git
The following commit(s) were added to refs/heads/branch-3.3 by this push:
new ada06aa22ec HADOOP-18575: followup: try to avoid repeatedly hitting
exceptions when transformer factories do not support attributes (#5253)
ada06aa22ec is described below
commit ada06aa22ecb7e18772f41a59905dd384a2c4ad6
Author: PJ Fanning <pjfann...@users.noreply.github.com>
AuthorDate: Mon Jan 16 14:15:37 2023 +0100
HADOOP-18575: followup: try to avoid repeatedly hitting exceptions when
transformer factories do not support attributes (#5253)
Part of HADOOP-18469 and the hardening of XML/XSL parsers.
Followup to the main HADOOP-18575 patch, to improve performance when
working with xml/xsl engines which don't support the relevant attributes.
Include this change when backporting.
Contributed by PJ Fanning.
---
.../main/java/org/apache/hadoop/util/XMLUtils.java | 47 ++++++++++++++++------
.../java/org/apache/hadoop/util/TestXMLUtils.java | 15 +++++--
2 files changed, 45 insertions(+), 17 deletions(-)
diff --git
a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/XMLUtils.java
b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/XMLUtils.java
index 7aa4b2bcc58..8a5d2f36615 100644
---
a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/XMLUtils.java
+++
b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/XMLUtils.java
@@ -34,6 +34,7 @@ import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;
import java.io.*;
+import java.util.concurrent.atomic.AtomicBoolean;
/**
* General xml utilities.
@@ -59,6 +60,11 @@ public class XMLUtils {
public static final String VALIDATION =
"http://xml.org/sax/features/validation";;
+ private static final AtomicBoolean CAN_SET_TRANSFORMER_ACCESS_EXTERNAL_DTD =
+ new AtomicBoolean(true);
+ private static final AtomicBoolean
CAN_SET_TRANSFORMER_ACCESS_EXTERNAL_STYLESHEET =
+ new AtomicBoolean(true);
+
/**
* Transform input xml given a stylesheet.
*
@@ -143,8 +149,7 @@ public class XMLUtils {
throws TransformerConfigurationException {
TransformerFactory trfactory = TransformerFactory.newInstance();
trfactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
- bestEffortSetAttribute(trfactory, XMLConstants.ACCESS_EXTERNAL_DTD, "");
- bestEffortSetAttribute(trfactory, XMLConstants.ACCESS_EXTERNAL_STYLESHEET,
"");
+ setOptionalSecureTransformerAttributes(trfactory);
return trfactory;
}
@@ -161,29 +166,45 @@ public class XMLUtils {
throws TransformerConfigurationException {
SAXTransformerFactory trfactory = (SAXTransformerFactory)
SAXTransformerFactory.newInstance();
trfactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
- bestEffortSetAttribute(trfactory, XMLConstants.ACCESS_EXTERNAL_DTD, "");
- bestEffortSetAttribute(trfactory, XMLConstants.ACCESS_EXTERNAL_STYLESHEET,
"");
+ setOptionalSecureTransformerAttributes(trfactory);
return trfactory;
}
+ /**
+ * These attributes are recommended for maximum security but some JAXP
transformers do
+ * not support them. If at any stage, we fail to set these attributes, then
we won't try again
+ * for subsequent transformers.
+ *
+ * @param transformerFactory to update
+ */
+ private static void setOptionalSecureTransformerAttributes(
+ TransformerFactory transformerFactory) {
+ bestEffortSetAttribute(transformerFactory,
CAN_SET_TRANSFORMER_ACCESS_EXTERNAL_DTD,
+ XMLConstants.ACCESS_EXTERNAL_DTD, "");
+ bestEffortSetAttribute(transformerFactory,
CAN_SET_TRANSFORMER_ACCESS_EXTERNAL_STYLESHEET,
+ XMLConstants.ACCESS_EXTERNAL_STYLESHEET, "");
+ }
+
/**
* Set an attribute value on a {@link TransformerFactory}. If the
TransformerFactory
* does not support the attribute, the method just returns
<code>false</code> and
* logs the issue at debug level.
*
* @param transformerFactory to update
+ * @param flag that indicates whether to do the update and the flag can be
set to
+ * <code>false</code> if an update fails
* @param name of the attribute to set
* @param value to set on the attribute
- * @return whether the attribute was successfully set
*/
- static boolean bestEffortSetAttribute(TransformerFactory transformerFactory,
- String name, Object value) {
- try {
- transformerFactory.setAttribute(name, value);
- return true;
- } catch (Throwable t) {
- LOG.debug("Issue setting TransformerFactory attribute {}: {}", name,
t.toString());
+ static void bestEffortSetAttribute(TransformerFactory transformerFactory,
AtomicBoolean flag,
+ String name, Object value) {
+ if (flag.get()) {
+ try {
+ transformerFactory.setAttribute(name, value);
+ } catch (Throwable t) {
+ flag.set(false);
+ LOG.debug("Issue setting TransformerFactory attribute {}: {}", name,
t.toString());
+ }
}
- return false;
}
}
diff --git
a/hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/util/TestXMLUtils.java
b/hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/util/TestXMLUtils.java
index 0ebec96213b..6db16b6c0c5 100644
---
a/hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/util/TestXMLUtils.java
+++
b/hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/util/TestXMLUtils.java
@@ -20,6 +20,7 @@ package org.apache.hadoop.util;
import java.io.InputStream;
import java.io.StringReader;
import java.io.StringWriter;
+import java.util.concurrent.atomic.AtomicBoolean;
import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.SAXParser;
@@ -134,10 +135,16 @@ public class TestXMLUtils extends AbstractHadoopTestBase {
@Test
public void testBestEffortSetAttribute() throws Exception {
TransformerFactory factory = TransformerFactory.newInstance();
- Assert.assertFalse("unexpected attribute results in return of false",
- XMLUtils.bestEffortSetAttribute(factory, "unsupportedAttribute
false", "abc"));
- Assert.assertTrue("expected attribute results in return of false",
- XMLUtils.bestEffortSetAttribute(factory,
XMLConstants.ACCESS_EXTERNAL_DTD, ""));
+ AtomicBoolean flag1 = new AtomicBoolean(true);
+ XMLUtils.bestEffortSetAttribute(factory, flag1, "unsupportedAttribute
false", "abc");
+ Assert.assertFalse("unexpected attribute results in return of false?",
flag1.get());
+ AtomicBoolean flag2 = new AtomicBoolean(true);
+ XMLUtils.bestEffortSetAttribute(factory, flag2,
XMLConstants.ACCESS_EXTERNAL_DTD, "");
+ Assert.assertTrue("expected attribute results in return of true?",
flag2.get());
+ AtomicBoolean flag3 = new AtomicBoolean(false);
+ XMLUtils.bestEffortSetAttribute(factory, flag3,
XMLConstants.ACCESS_EXTERNAL_DTD, "");
+ Assert.assertFalse("expected attribute results in return of false if input
flag is false?",
+ flag3.get());
}
private static InputStream getResourceStream(final String filename) {
---------------------------------------------------------------------
To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org
For additional commands, e-mail: common-commits-h...@hadoop.apache.org
