use our own StringUtils.substringBefore()

rbri · rbri · commit b117b86ad4da · 2025-10-29T17:50:29.000+01:00
diff --git a/src/main/java/org/htmlunit/WebClient.java b/src/main/java/org/htmlunit/WebClient.java
@@ -1392,7 +1392,7 @@ private static WebResponse makeWebResponseForAboutUrl(final WebRequest webReques
             return new StringWebResponse("", UrlUtils.URL_ABOUT_BLANK);
         }
 
-        final String urlWithoutQuery = org.apache.commons.lang3.StringUtils.substringBefore(urlString, "?");
+        final String urlWithoutQuery = StringUtils.substringBefore(urlString, "?");
         if (!"blank".equalsIgnoreCase(org.apache.commons.lang3.StringUtils
                                         .substringAfter(urlWithoutQuery, UrlUtils.ABOUT_SCHEME))) {
             throw new MalformedURLException(url + " is not supported, only about:blank is supported at the moment.");
diff --git a/src/main/java/org/htmlunit/html/HtmlForm.java b/src/main/java/org/htmlunit/html/HtmlForm.java
@@ -298,8 +298,8 @@ public WebRequest getWebRequest(final SubmittableElement submitElement) {
             queryFormFields = HttpUtils.toQueryFormFields(parameters, enc);
 
             // action may already contain some query parameters: they have to be removed
-            actionUrl = StringUtils.substringBefore(actionUrl, "#");
-            actionUrl = StringUtils.substringBefore(actionUrl, "?");
+            actionUrl = org.htmlunit.util.StringUtils.substringBefore(actionUrl, "#");
+            actionUrl = org.htmlunit.util.StringUtils.substringBefore(actionUrl, "?");
             parameters.clear(); // parameters have been added to query
         }
 
diff --git a/src/main/java/org/htmlunit/html/XmlSerializer.java b/src/main/java/org/htmlunit/html/XmlSerializer.java
@@ -340,7 +340,8 @@ protected Map<String, DomAttr> getAttributesFor(final HtmlImage image) {
     private static String getSuffix(final WebResponse response) {
         // first try to take the one from the requested file
         final String url = response.getWebRequest().getUrl().toString();
-        final String fileName = StringUtils.substringAfterLast(StringUtils.substringBefore(url, "?"), "/");
+        final String fileName =
+                StringUtils.substringAfterLast(org.htmlunit.util.StringUtils.substringBefore(url, "?"), "/");
         // if there is a suffix with 2-4 letters, the take it
         final String suffix = StringUtils.substringAfterLast(fileName, ".");
         if (suffix.length() > 1 && suffix.length() < 5) {
@@ -387,8 +388,8 @@ protected boolean isExcluded(final DomElement element) {
     private File createFile(final String url, final String extension) throws IOException {
         String name = url.replaceFirst("/$", "");
         name = CREATE_FILE_PATTERN.matcher(name).replaceAll("");
-        name = StringUtils.substringBefore(name, "?"); // remove query
-        name = StringUtils.substringBefore(name, ";"); // remove additional info
+        name = org.htmlunit.util.StringUtils.substringBefore(name, "?"); // remove query
+        name = org.htmlunit.util.StringUtils.substringBefore(name, ";"); // remove additional info
         name = StringUtils.substring(name, 0, 30); // many file systems have a limit at 255, let's limit it
         name = org.htmlunit.util.StringUtils.sanitizeForFileName(name);
         if (!name.endsWith(extension)) {
diff --git a/src/main/java/org/htmlunit/javascript/DebugFrameImpl.java b/src/main/java/org/htmlunit/javascript/DebugFrameImpl.java
@@ -263,7 +263,7 @@ private static String getSourceName(final Context cx) {
         // only the file name is interesting the rest of the url is mostly noise
         source = StringUtils.substringAfterLast(source, "/");
         // embedded scripts have something like "foo.html from (3, 10) to (10, 13)"
-        source = StringUtils.substringBefore(source, " ");
+        source = org.htmlunit.util.StringUtils.substringBefore(source, " ");
         return source;
     }
 
diff --git a/src/main/java/org/htmlunit/javascript/host/Navigator.java b/src/main/java/org/htmlunit/javascript/host/Navigator.java
@@ -114,7 +114,7 @@ public Scriptable getLanguages() {
         final String[] parts = StringUtils.splitAtComma(acceptLang);
         for (final String part : parts) {
             if (!StringUtils.isEmptyOrNull(part)) {
-                final String lang = org.apache.commons.lang3.StringUtils.substringBefore(part, ";").trim();
+                final String lang = StringUtils.substringBefore(part, ";").trim();
                 if (!StringUtils.isEmptyOrNull(part)) {
                     res.add(lang);
                 }
diff --git a/src/main/java/org/htmlunit/javascript/host/URL.java b/src/main/java/org/htmlunit/javascript/host/URL.java
@@ -394,7 +394,7 @@ public void setProtocol(final String protocol) throws MalformedURLException {
             return;
         }
 
-        final String bareProtocol = StringUtils.substringBefore(protocol, ":").trim();
+        final String bareProtocol = org.htmlunit.util.StringUtils.substringBefore(protocol, ":").trim();
         if (!UrlUtils.isValidScheme(bareProtocol)) {
             return;
         }
diff --git a/src/main/java/org/htmlunit/javascript/host/html/HTMLAnchorElement.java b/src/main/java/org/htmlunit/javascript/host/html/HTMLAnchorElement.java
@@ -482,7 +482,7 @@ public String getProtocol() {
             if (anchor.getHrefAttribute().startsWith("http")) {
                 return ":";
             }
-            return StringUtils.substringBefore(anchor.getHrefAttribute(), "/");
+            return org.htmlunit.util.StringUtils.substringBefore(anchor.getHrefAttribute(), "/");
         }
     }
 
@@ -498,7 +498,7 @@ public void setProtocol(final String protocol) throws Exception {
             return;
         }
 
-        final String bareProtocol = StringUtils.substringBefore(protocol, ":").trim();
+        final String bareProtocol = org.htmlunit.util.StringUtils.substringBefore(protocol, ":").trim();
         if (!UrlUtils.isValidScheme(bareProtocol)) {
             return;
         }
diff --git a/src/main/java/org/htmlunit/javascript/host/worker/WorkerNavigator.java b/src/main/java/org/htmlunit/javascript/host/worker/WorkerNavigator.java
@@ -19,7 +19,6 @@
 
 import java.util.ArrayList;
 
-import org.apache.commons.lang3.StringUtils;
 import org.htmlunit.BrowserVersion;
 import org.htmlunit.corejs.javascript.Scriptable;
 import org.htmlunit.javascript.HtmlUnitScriptable;
@@ -28,6 +27,7 @@
 import org.htmlunit.javascript.configuration.JsxConstructor;
 import org.htmlunit.javascript.configuration.JsxGetter;
 import org.htmlunit.javascript.host.network.NetworkInformation;
+import org.htmlunit.util.StringUtils;
 
 /**
  * A JavaScript object for WorkerNavigator.
@@ -111,16 +111,16 @@ public String getLanguage() {
     @JsxGetter
     public Scriptable getLanguages() {
         final String acceptLang = getBrowserVersion().getAcceptLanguageHeader();
-        if (org.htmlunit.util.StringUtils.isEmptyOrNull(acceptLang)) {
+        if (StringUtils.isEmptyOrNull(acceptLang)) {
             return JavaScriptEngine.newArray(this, 0);
         }
 
         final ArrayList<String> res = new ArrayList<>();
-        final String[] parts = org.htmlunit.util.StringUtils.splitAtComma(acceptLang);
+        final String[] parts = StringUtils.splitAtComma(acceptLang);
         for (final String part : parts) {
-            if (!org.htmlunit.util.StringUtils.isEmptyOrNull(part)) {
+            if (!StringUtils.isEmptyOrNull(part)) {
                 final String lang = StringUtils.substringBefore(part, ";").trim();
-                if (!org.htmlunit.util.StringUtils.isEmptyOrNull(part)) {
+                if (!StringUtils.isEmptyOrNull(part)) {
                     res.add(lang);
                 }
             }
diff --git a/src/main/java/org/htmlunit/protocol/data/DataUrlDecoder.java b/src/main/java/org/htmlunit/protocol/data/DataUrlDecoder.java
@@ -124,7 +124,7 @@ private static Charset extractCharset(final String beforeData) {
     private static String extractMediaType(final String beforeData) {
         if (beforeData.contains("/")) {
             if (beforeData.contains(";")) {
-                return StringUtils.substringBefore(beforeData, ";");
+                return org.htmlunit.util.StringUtils.substringBefore(beforeData, ";");
             }
             return beforeData;
         }
diff --git a/src/main/java/org/htmlunit/util/DebuggingWebConnection.java b/src/main/java/org/htmlunit/util/DebuggingWebConnection.java
@@ -271,8 +271,8 @@ private void appendToJSFile(final String str) throws IOException {
      */
     private File createFile(final URL url, final String extension) throws IOException {
         String name = url.getPath().replaceFirst("/$", "").replaceAll(".*/", "");
-        name = StringUtils.substringBefore(name, "?"); // remove query
-        name = StringUtils.substringBefore(name, ";"); // remove additional info
+        name = org.htmlunit.util.StringUtils.substringBefore(name, "?"); // remove query
+        name = org.htmlunit.util.StringUtils.substringBefore(name, ";"); // remove additional info
         name = StringUtils.substring(name, 0, 30); // avoid exceptions due to too long file names
         name = org.htmlunit.util.StringUtils.sanitizeForFileName(name);
         if (!name.endsWith(extension)) {
diff --git a/src/main/java/org/htmlunit/util/StringUtils.java b/src/main/java/org/htmlunit/util/StringUtils.java
@@ -822,4 +822,30 @@ public static String[] splitAtCommaOrBlank(final String str) {
         }
         return parts;
     }
+
+    /**
+     * Gets the substring before the first occurrence of a separator. The separator is not returned.
+     * A {@code null} string input will return {@code null}.
+     * An empty ("") string input will return the empty string.
+     * A {@code null} or empty separator is not allowed (will throw).
+     *
+     * @param str the String to get a substring from, may be null.
+     * @param find the String to find, not null and not empty
+     * @return the substring before the first occurrence of the specified string, {@code null} if null String input.
+     */
+    public static String substringBefore(final String str, final String find) {
+        if (isEmptyOrNull(find)) {
+            throw new IllegalArgumentException("'find' string parameter has to be not empty and not null");
+        }
+
+        if (isEmptyString(str)) {
+            return str;
+        }
+
+        final int pos = str.indexOf(find);
+        if (pos == -1) {
+            return str;
+        }
+        return str.substring(0, pos);
+    }
 }
diff --git a/src/main/java/org/htmlunit/util/UrlUtils.java b/src/main/java/org/htmlunit/util/UrlUtils.java
@@ -231,7 +231,7 @@ public static URL toUrlSafe(final String url) {
     public static URL toUrlUnsafe(final String url) throws MalformedURLException {
         WebAssert.notNull("url", url);
 
-        final String protocol = org.apache.commons.lang3.StringUtils.substringBefore(url, ":").toLowerCase(Locale.ROOT);
+        final String protocol = StringUtils.substringBefore(url, ":").toLowerCase(Locale.ROOT);
 
         if (protocol.isEmpty() || UrlUtils.isNormalUrlProtocol(protocol)) {
             final URL response = new URL(url);
diff --git a/src/test/java/org/htmlunit/archunit/ArchitectureTest.java b/src/test/java/org/htmlunit/archunit/ArchitectureTest.java
@@ -112,6 +112,20 @@ public class ArchitectureTest {
     public static final ArchRule apacheStringUtilsIsNotBlankRule = noClasses()
         .should().callMethod(org.apache.commons.lang3.StringUtils.class, "isNotBlank", CharSequence.class);
 
+    /**
+     * Do not use org.apache.commons.lang3.StringUtils.toRootLowerCase(String).
+     */
+    @ArchTest
+    public static final ArchRule apacheStringUtilstoRootLowerCaseRule = noClasses()
+        .should().callMethod(org.apache.commons.lang3.StringUtils.class, "toRootLowerCase", String.class);
+
+    /**
+     * Do not use org.apache.commons.lang3.StringUtils.toRootLowerCase(String).
+     */
+    @ArchTest
+    public static final ArchRule apacheStringUtilsSubstringBeforeRule = noClasses()
+        .should().callMethod(org.apache.commons.lang3.StringUtils.class, "substringBefore", String.class, String.class);
+
     /**
      * Do not use org.apache.commons.lang3.Strings.startsWith(CharSequence, CharSequence).
      */
@@ -133,13 +147,6 @@ public class ArchitectureTest {
     public static final ArchRule apacheStringsContainsRule = noClasses()
         .should().callMethod(org.apache.commons.lang3.Strings.class, "contains", CharSequence.class, CharSequence.class);
 
-    /**
-     * Do not use org.apache.commons.lang3.StringUtils.toRootLowerCase(String).
-     */
-    @ArchTest
-    public static final ArchRule apacheStringstoRootLowerCaseRule = noClasses()
-        .should().callMethod(org.apache.commons.lang3.StringUtils.class, "toRootLowerCase", String.class);
-
 
     /**
      * The jetty websocket stuff is only used by one class.
diff --git a/src/test/java/org/htmlunit/util/StringUtilsTest.java b/src/test/java/org/htmlunit/util/StringUtilsTest.java
@@ -18,6 +18,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import org.htmlunit.html.impl.Color;
@@ -480,4 +481,19 @@ public void escapeXmlBorderCases() throws Exception {
 
         // [#x10000-#x10FFFF]
     }
+
+    /**
+     * @throws Exception if the test fails
+     */
+    @Test
+    public void substringBefore() throws Exception {
+        assertThrows(IllegalArgumentException.class, () -> StringUtils.substringBefore(null, null));
+        assertThrows(IllegalArgumentException.class, () -> StringUtils.substringBefore(null, ""));
+
+        assertEquals("", StringUtils.substringBefore("", "a"));
+        assertEquals("xyz", StringUtils.substringBefore("xyz", "a"));
+        assertEquals("", StringUtils.substringBefore("a", "a"));
+        assertEquals("x", StringUtils.substringBefore("xaba", "a"));
+        assertEquals(" ", StringUtils.substringBefore(" a", "a"));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1392,7 +1392,7 @@ private static WebResponse makeWebResponseForAboutUrl(final WebRequest webReques`
`1392`	`1392`	`return new StringWebResponse("", UrlUtils.URL_ABOUT_BLANK);`
`1393`	`1393`	`}`
`1394`	`1394`
`1395`		`- final String urlWithoutQuery = org.apache.commons.lang3.StringUtils.substringBefore(urlString, "?");`
	`1395`	`+ final String urlWithoutQuery = StringUtils.substringBefore(urlString, "?");`
`1396`	`1396`	`if (!"blank".equalsIgnoreCase(org.apache.commons.lang3.StringUtils`
`1397`	`1397`	`.substringAfter(urlWithoutQuery, UrlUtils.ABOUT_SCHEME))) {`
`1398`	`1398`	`throw new MalformedURLException(url + " is not supported, only about:blank is supported at the moment.");`
Original file line number	Diff line number	Diff line change
`@@ -298,8 +298,8 @@ public WebRequest getWebRequest(final SubmittableElement submitElement) {`
`298`	`298`	`queryFormFields = HttpUtils.toQueryFormFields(parameters, enc);`
`299`	`299`
`300`	`300`	`// action may already contain some query parameters: they have to be removed`
`301`		`- actionUrl = StringUtils.substringBefore(actionUrl, "#");`
`302`		`- actionUrl = StringUtils.substringBefore(actionUrl, "?");`
	`301`	`+ actionUrl = org.htmlunit.util.StringUtils.substringBefore(actionUrl, "#");`
	`302`	`+ actionUrl = org.htmlunit.util.StringUtils.substringBefore(actionUrl, "?");`
`303`	`303`	`parameters.clear(); // parameters have been added to query`
`304`	`304`	`}`
`305`	`305`
Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,7 @@ private static String getSourceName(final Context cx) {`
`263`	`263`	`// only the file name is interesting the rest of the url is mostly noise`
`264`	`264`	`source = StringUtils.substringAfterLast(source, "/");`
`265`	`265`	`// embedded scripts have something like "foo.html from (3, 10) to (10, 13)"`
`266`		`- source = StringUtils.substringBefore(source, " ");`
	`266`	`+ source = org.htmlunit.util.StringUtils.substringBefore(source, " ");`
`267`	`267`	`return source;`
`268`	`268`	`}`
`269`	`269`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ public Scriptable getLanguages() {`
`114`	`114`	`final String[] parts = StringUtils.splitAtComma(acceptLang);`
`115`	`115`	`for (final String part : parts) {`
`116`	`116`	`if (!StringUtils.isEmptyOrNull(part)) {`
`117`		`- final String lang = org.apache.commons.lang3.StringUtils.substringBefore(part, ";").trim();`
	`117`	`+ final String lang = StringUtils.substringBefore(part, ";").trim();`
`118`	`118`	`if (!StringUtils.isEmptyOrNull(part)) {`
`119`	`119`	`res.add(lang);`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -394,7 +394,7 @@ public void setProtocol(final String protocol) throws MalformedURLException {`
`394`	`394`	`return;`
`395`	`395`	`}`
`396`	`396`
`397`		`- final String bareProtocol = StringUtils.substringBefore(protocol, ":").trim();`
	`397`	`+ final String bareProtocol = org.htmlunit.util.StringUtils.substringBefore(protocol, ":").trim();`
`398`	`398`	`if (!UrlUtils.isValidScheme(bareProtocol)) {`
`399`	`399`	`return;`
`400`	`400`	`}`
Original file line number	Diff line number	Diff line change
`@@ -482,7 +482,7 @@ public String getProtocol() {`
`482`	`482`	`if (anchor.getHrefAttribute().startsWith("http")) {`
`483`	`483`	`return ":";`
`484`	`484`	`}`
`485`		`- return StringUtils.substringBefore(anchor.getHrefAttribute(), "/");`
	`485`	`+ return org.htmlunit.util.StringUtils.substringBefore(anchor.getHrefAttribute(), "/");`
`486`	`486`	`}`
`487`	`487`	`}`
`488`	`488`
`@@ -498,7 +498,7 @@ public void setProtocol(final String protocol) throws Exception {`
`498`	`498`	`return;`
`499`	`499`	`}`
`500`	`500`
`501`		`- final String bareProtocol = StringUtils.substringBefore(protocol, ":").trim();`
	`501`	`+ final String bareProtocol = org.htmlunit.util.StringUtils.substringBefore(protocol, ":").trim();`
`502`	`502`	`if (!UrlUtils.isValidScheme(bareProtocol)) {`
`503`	`503`	`return;`
`504`	`504`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ private static Charset extractCharset(final String beforeData) {`
`124`	`124`	`private static String extractMediaType(final String beforeData) {`
`125`	`125`	`if (beforeData.contains("/")) {`
`126`	`126`	`if (beforeData.contains(";")) {`
`127`		`- return StringUtils.substringBefore(beforeData, ";");`
	`127`	`+ return org.htmlunit.util.StringUtils.substringBefore(beforeData, ";");`
`128`	`128`	`}`
`129`	`129`	`return beforeData;`
`130`	`130`	`}`