This is an automated email from the ASF dual-hosted git repository.
schultz pushed a commit to branch 8.5.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 7482d9bfdcb7a1d3cd931ff0bf1c21d963c96a05
Author: Christopher Schultz <ch...@christopherschultz.net>
AuthorDate: Sun Mar 17 10:33:00 2024 -0400
Unify comma-separated-value code and optimize the implementation (#707)
Add new StringUtils.splitCommaSeparated utility method which uses a simple
search pattern for comma-separated values instead of a regular expression.
---
java/org/apache/catalina/connector/Connector.java | 3 ++-
.../org/apache/catalina/filters/ExpiresFilter.java | 15 ++++++--------
.../apache/catalina/filters/RemoteCIDRFilter.java | 3 ++-
.../apache/catalina/filters/RemoteIpFilter.java | 15 ++++++--------
java/org/apache/catalina/realm/JNDIRealm.java | 6 ++++--
java/org/apache/catalina/util/NetMaskSet.java | 4 +++-
.../apache/catalina/valves/RemoteCIDRValve.java | 3 ++-
java/org/apache/catalina/valves/RemoteIpValve.java | 18 +++++++---------
java/org/apache/tomcat/util/buf/StringUtils.java | 24 ++++++++++++++++++++++
.../catalina/filters/TestRemoteIpFilter.java | 4 ++--
.../apache/catalina/valves/TestRemoteIpValve.java | 5 +++--
11 files changed, 61 insertions(+), 39 deletions(-)
diff --git a/java/org/apache/catalina/connector/Connector.java
b/java/org/apache/catalina/connector/Connector.java
index e102bac5bb..a1c1244d03 100644
--- a/java/org/apache/catalina/connector/Connector.java
+++ b/java/org/apache/catalina/connector/Connector.java
@@ -45,6 +45,7 @@ import org.apache.tomcat.util.buf.B2CConverter;
import org.apache.tomcat.util.buf.CharsetUtil;
import org.apache.tomcat.util.buf.EncodedSolidusHandling;
import org.apache.tomcat.util.buf.UDecoder;
+import org.apache.tomcat.util.buf.StringUtils;
import org.apache.tomcat.util.net.SSLHostConfig;
import org.apache.tomcat.util.net.openssl.OpenSSLImplementation;
import org.apache.tomcat.util.res.StringManager;
@@ -539,7 +540,7 @@ public class Connector extends LifecycleMBeanBase {
HashSet<String> methodSet = new HashSet<>();
if (null != methods) {
- methodSet.addAll(Arrays.asList(methods.split("\\s*,\\s*")));
+
methodSet.addAll(Arrays.asList(StringUtils.splitCommaSeparated(methods)));
}
if (methodSet.contains("TRACE")) {
diff --git a/java/org/apache/catalina/filters/ExpiresFilter.java
b/java/org/apache/catalina/filters/ExpiresFilter.java
index a4ad475cce..7eb63a7612 100644
--- a/java/org/apache/catalina/filters/ExpiresFilter.java
+++ b/java/org/apache/catalina/filters/ExpiresFilter.java
@@ -28,7 +28,6 @@ import java.util.Locale;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.StringTokenizer;
-import java.util.regex.Pattern;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
@@ -47,6 +46,7 @@ import org.apache.catalina.core.ApplicationMappingImpl;
import org.apache.catalina.core.ApplicationMappingMatch;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
+import org.apache.tomcat.util.buf.StringUtils;
/**
* <p>
@@ -1013,11 +1013,6 @@ public class ExpiresFilter extends FilterBase {
}
- /**
- * {@link Pattern} for a comma delimited string that support whitespace
characters
- */
- private static final Pattern commaSeparatedValuesPattern =
Pattern.compile("\\s*,\\s*");
-
private static final String HEADER_CACHE_CONTROL = "Cache-Control";
private static final String HEADER_EXPIRES = "Expires";
@@ -1042,7 +1037,7 @@ public class ExpiresFilter extends FilterBase {
* @return never {@code null} array
*/
protected static int[] commaDelimitedListToIntArray(String
commaDelimitedInts) {
- String[] intsAsStrings =
commaDelimitedListToStringArray(commaDelimitedInts);
+ String[] intsAsStrings =
StringUtils.splitCommaSeparated(commaDelimitedInts);
int[] ints = new int[intsAsStrings.length];
for (int i = 0; i < intsAsStrings.length; i++) {
String intAsString = intsAsStrings[i];
@@ -1062,10 +1057,12 @@ public class ExpiresFilter extends FilterBase {
* @param commaDelimitedStrings the string to be split
*
* @return array of patterns (non {@code null})
+ *
+ * @deprecated Unused. Will be removed in Tomcat 11.
*/
+ @Deprecated
protected static String[] commaDelimitedListToStringArray(String
commaDelimitedStrings) {
- return (commaDelimitedStrings == null ||
commaDelimitedStrings.length() == 0) ? new String[0] :
- commaSeparatedValuesPattern.split(commaDelimitedStrings);
+ return StringUtils.splitCommaSeparated(commaDelimitedStrings);
}
/**
diff --git a/java/org/apache/catalina/filters/RemoteCIDRFilter.java
b/java/org/apache/catalina/filters/RemoteCIDRFilter.java
index fbd4caf764..5961dd43ae 100644
--- a/java/org/apache/catalina/filters/RemoteCIDRFilter.java
+++ b/java/org/apache/catalina/filters/RemoteCIDRFilter.java
@@ -33,6 +33,7 @@ import javax.servlet.http.HttpServletResponse;
import org.apache.catalina.util.NetMask;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
+import org.apache.tomcat.util.buf.StringUtils;
public final class RemoteCIDRFilter extends FilterBase {
@@ -221,7 +222,7 @@ public final class RemoteCIDRFilter extends FilterBase {
final List<String> messages = new ArrayList<>();
NetMask nm;
- for (final String s : input.split("\\s*,\\s*")) {
+ for (final String s : StringUtils.splitCommaSeparated(input)) {
try {
nm = new NetMask(s);
target.add(nm);
diff --git a/java/org/apache/catalina/filters/RemoteIpFilter.java
b/java/org/apache/catalina/filters/RemoteIpFilter.java
index 5cafd30ab2..64fd0c9f58 100644
--- a/java/org/apache/catalina/filters/RemoteIpFilter.java
+++ b/java/org/apache/catalina/filters/RemoteIpFilter.java
@@ -639,11 +639,6 @@ public class RemoteIpFilter implements Filter {
}
- /**
- * {@link Pattern} for a comma delimited string that support whitespace
characters
- */
- private static final Pattern commaSeparatedValuesPattern =
Pattern.compile("\\s*,\\s*");
-
protected static final String HTTP_SERVER_PORT_PARAMETER =
"httpServerPort";
protected static final String HTTPS_SERVER_PORT_PARAMETER =
"httpsServerPort";
@@ -681,10 +676,12 @@ public class RemoteIpFilter implements Filter {
* @param commaDelimitedStrings The string to split
*
* @return array of patterns (non <code>null</code>)
+ *
+ * @deprecated Unused. Will be removed in Tomcat 11 onwards.
*/
+ @Deprecated
protected static String[] commaDelimitedListToStringArray(String
commaDelimitedStrings) {
- return (commaDelimitedStrings == null ||
commaDelimitedStrings.length() == 0) ? new String[0] :
- commaSeparatedValuesPattern.split(commaDelimitedStrings);
+ return StringUtils.splitCommaSeparated(commaDelimitedStrings);
}
/**
@@ -795,7 +792,7 @@ public class RemoteIpFilter implements Filter {
concatRemoteIpHeaderValue.append(e.nextElement());
}
- String[] remoteIpHeaderValue =
commaDelimitedListToStringArray(concatRemoteIpHeaderValue.toString());
+ String[] remoteIpHeaderValue =
StringUtils.splitCommaSeparated(concatRemoteIpHeaderValue.toString());
int idx;
if (!isInternal) {
proxiesHeaderValue.addFirst(request.getRemoteAddr());
@@ -929,7 +926,7 @@ public class RemoteIpFilter implements Filter {
if (!protocolHeaderValue.contains(",")) {
return
protocolHeaderHttpsValue.equalsIgnoreCase(protocolHeaderValue);
}
- String[] forwardedProtocols =
commaDelimitedListToStringArray(protocolHeaderValue);
+ String[] forwardedProtocols =
StringUtils.splitCommaSeparated(protocolHeaderValue);
if (forwardedProtocols.length == 0) {
return false;
}
diff --git a/java/org/apache/catalina/realm/JNDIRealm.java
b/java/org/apache/catalina/realm/JNDIRealm.java
index c1895d3255..84c342310e 100644
--- a/java/org/apache/catalina/realm/JNDIRealm.java
+++ b/java/org/apache/catalina/realm/JNDIRealm.java
@@ -62,6 +62,7 @@ import javax.net.ssl.SSLSession;
import javax.net.ssl.SSLSocketFactory;
import org.apache.catalina.LifecycleException;
+import org.apache.tomcat.util.buf.StringUtils;
import org.apache.tomcat.util.collections.SynchronizedStack;
import org.ietf.jgss.GSSContext;
import org.ietf.jgss.GSSCredential;
@@ -969,11 +970,12 @@ public class JNDIRealm extends RealmBase {
if (cipherSuites == null || cipherSuitesArray != null) {
return cipherSuitesArray;
}
- if (this.cipherSuites.trim().isEmpty()) {
+ this.cipherSuites = this.cipherSuites.trim();
+ if (this.cipherSuites.isEmpty()) {
containerLog.warn(sm.getString("jndiRealm.emptyCipherSuites"));
this.cipherSuitesArray = null;
} else {
- this.cipherSuitesArray = cipherSuites.trim().split("\\s*,\\s*");
+ this.cipherSuitesArray =
StringUtils.splitCommaSeparated(cipherSuites);
if (containerLog.isTraceEnabled()) {
containerLog.trace(sm.getString("jndiRealm.cipherSuites",
Arrays.toString(this.cipherSuitesArray)));
}
diff --git a/java/org/apache/catalina/util/NetMaskSet.java
b/java/org/apache/catalina/util/NetMaskSet.java
index dfaf23fc11..6365dc8f85 100644
--- a/java/org/apache/catalina/util/NetMaskSet.java
+++ b/java/org/apache/catalina/util/NetMaskSet.java
@@ -25,6 +25,8 @@ import java.util.HashSet;
import java.util.List;
import java.util.Set;
+import org.apache.tomcat.util.buf.StringUtils;
+
/**
* This class maintains a Set of NetMask objects and allows to check if a
given IP address is matched by any of the
@@ -124,7 +126,7 @@ public class NetMaskSet {
List<String> errMessages = new ArrayList<>();
- for (String s : input.split("\\s*,\\s*")) {
+ for (String s : StringUtils.splitCommaSeparated(input)) {
try {
this.add(s);
} catch (IllegalArgumentException e) {
diff --git a/java/org/apache/catalina/valves/RemoteCIDRValve.java
b/java/org/apache/catalina/valves/RemoteCIDRValve.java
index 87931379a7..ad48b6a900 100644
--- a/java/org/apache/catalina/valves/RemoteCIDRValve.java
+++ b/java/org/apache/catalina/valves/RemoteCIDRValve.java
@@ -30,6 +30,7 @@ import org.apache.catalina.connector.Response;
import org.apache.catalina.util.NetMask;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
+import org.apache.tomcat.util.buf.StringUtils;
public final class RemoteCIDRValve extends RequestFilterValve {
@@ -236,7 +237,7 @@ public final class RemoteCIDRValve extends
RequestFilterValve {
final List<String> messages = new ArrayList<>();
NetMask nm;
- for (final String s : input.split("\\s*,\\s*")) {
+ for (final String s : StringUtils.splitCommaSeparated(input)) {
try {
nm = new NetMask(s);
target.add(nm);
diff --git a/java/org/apache/catalina/valves/RemoteIpValve.java
b/java/org/apache/catalina/valves/RemoteIpValve.java
index 4b3a932354..960ed6f408 100644
--- a/java/org/apache/catalina/valves/RemoteIpValve.java
+++ b/java/org/apache/catalina/valves/RemoteIpValve.java
@@ -359,12 +359,6 @@ import org.apache.tomcat.util.http.parser.Host;
* </p>
*/
public class RemoteIpValve extends ValveBase {
-
- /**
- * {@link Pattern} for a comma delimited string that support whitespace
characters
- */
- private static final Pattern commaSeparatedValuesPattern =
Pattern.compile("\\s*,\\s*");
-
/**
* Logger
*/
@@ -375,11 +369,13 @@ public class RemoteIpValve extends ValveBase {
*
* @param commaDelimitedStrings The string to convert
*
- * @return array of String (non <code>null</code>)
+ * @return array of String (non <code>code</code>})
+ *
+ * @deprecated Unused. Will be removed in Tomcat 11.
*/
+ @Deprecated
protected static String[] commaDelimitedListToStringArray(String
commaDelimitedStrings) {
- return (commaDelimitedStrings == null ||
commaDelimitedStrings.length() == 0) ? new String[0]
- : commaSeparatedValuesPattern.split(commaDelimitedStrings);
+ return StringUtils.splitCommaSeparated(commaDelimitedStrings);
}
/**
@@ -638,7 +634,7 @@ public class RemoteIpValve extends ValveBase {
concatRemoteIpHeaderValue.append(e.nextElement());
}
- String[] remoteIpHeaderValue =
commaDelimitedListToStringArray(concatRemoteIpHeaderValue.toString());
+ String[] remoteIpHeaderValue =
StringUtils.splitCommaSeparated(concatRemoteIpHeaderValue.toString());
int idx;
if (!isInternal) {
proxiesHeaderValue.addFirst(originalRemoteAddr);
@@ -799,7 +795,7 @@ public class RemoteIpValve extends ValveBase {
if (!protocolHeaderValue.contains(",")) {
return
protocolHeaderHttpsValue.equalsIgnoreCase(protocolHeaderValue);
}
- String[] forwardedProtocols =
commaDelimitedListToStringArray(protocolHeaderValue);
+ String[] forwardedProtocols =
StringUtils.splitCommaSeparated(protocolHeaderValue);
if (forwardedProtocols.length == 0) {
return false;
}
diff --git a/java/org/apache/tomcat/util/buf/StringUtils.java
b/java/org/apache/tomcat/util/buf/StringUtils.java
index 6e207da874..84360a81bb 100644
--- a/java/org/apache/tomcat/util/buf/StringUtils.java
+++ b/java/org/apache/tomcat/util/buf/StringUtils.java
@@ -103,4 +103,28 @@ public final class StringUtils {
public interface Function<T> {
String apply(T t);
}
+
+ /**
+ * Splits a comma-separated string into an array of String values.
+ *
+ * Whitespace around the commas is removed.
+ *
+ * Null or empty values will return a zero-element array.
+ *
+ * @param s The string to split by commas.
+ *
+ * @return An array of String values.
+ */
+ public static String[] splitCommaSeparated(String s) {
+ if (s == null || s.length() == 0) {
+ return new String[0];
+ }
+
+ String[] splits = s.split(",");
+ for (int i = 0; i < splits.length; ++i) {
+ splits[i] = splits[i].trim();
+ }
+
+ return splits;
+ }
}
diff --git a/test/org/apache/catalina/filters/TestRemoteIpFilter.java
b/test/org/apache/catalina/filters/TestRemoteIpFilter.java
index 8ab924b437..b5c6e4b9fe 100644
--- a/test/org/apache/catalina/filters/TestRemoteIpFilter.java
+++ b/test/org/apache/catalina/filters/TestRemoteIpFilter.java
@@ -640,7 +640,7 @@ public class TestRemoteIpFilter extends TomcatBaseTest {
@Test
public void testListToCommaDelimitedString() {
- String[] actual =
RemoteIpFilter.commaDelimitedListToStringArray("element1, element2, element3");
+ String[] actual = StringUtils.splitCommaSeparated("element1, element2,
element3");
String[] expected = new String[] { "element1", "element2", "element3"
};
Assert.assertEquals(expected.length, actual.length);
for (int i = 0; i < actual.length; i++) {
@@ -650,7 +650,7 @@ public class TestRemoteIpFilter extends TomcatBaseTest {
@Test
public void testListToCommaDelimitedStringMixedSpaceChars() {
- String[] actual =
RemoteIpFilter.commaDelimitedListToStringArray("element1 , element2,\t
element3");
+ String[] actual = StringUtils.splitCommaSeparated("element1 ,
element2,\t element3");
String[] expected = new String[] { "element1", "element2", "element3"
};
Assert.assertEquals(expected.length, actual.length);
for (int i = 0; i < actual.length; i++) {
diff --git a/test/org/apache/catalina/valves/TestRemoteIpValve.java
b/test/org/apache/catalina/valves/TestRemoteIpValve.java
index b5201fd0d0..c0aff98bd7 100644
--- a/test/org/apache/catalina/valves/TestRemoteIpValve.java
+++ b/test/org/apache/catalina/valves/TestRemoteIpValve.java
@@ -32,6 +32,7 @@ import org.apache.catalina.Globals;
import org.apache.catalina.connector.Connector;
import org.apache.catalina.connector.Request;
import org.apache.catalina.connector.Response;
+import org.apache.tomcat.util.buf.StringUtils;
/**
* {@link RemoteIpValve} Tests
@@ -1049,14 +1050,14 @@ public class TestRemoteIpValve {
@Test
public void testCommaDelimitedListToStringArray() {
- String[] actual =
RemoteIpValve.commaDelimitedListToStringArray("element1, element2, element3");
+ String[] actual = StringUtils.splitCommaSeparated("element1, element2,
element3");
String[] expected = new String[] { "element1", "element2", "element3"
};
assertArrayEquals(expected, actual);
}
@Test
public void testCommaDelimitedListToStringArrayMixedSpaceChars() {
- String[] actual =
RemoteIpValve.commaDelimitedListToStringArray("element1 , element2,\t
element3");
+ String[] actual = StringUtils.splitCommaSeparated("element1 ,
element2,\t element3");
String[] expected = new String[] { "element1", "element2", "element3"
};
assertArrayEquals(expected, actual);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
