[tomcat] 01/02: Add a new utility method to test if a path is an absolute URI

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomcat.git

commit ee7335a353e4cdf06b02452cfb5e04a01ef98d82
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Thu Jan 28 17:07:22 2021 +0000

    Add a new utility method to test if a path is an absolute URI
---
 java/org/apache/tomcat/util/buf/UriUtil.java       | 35 ++++++++++
 .../tomcat/util/buf/TestUriUtilIsAbsoluteURI.java  | 77 ++++++++++++++++++++++
 2 files changed, 112 insertions(+)

diff --git a/java/org/apache/tomcat/util/buf/UriUtil.java b/java/org/apache/tomcat/util/buf/UriUtil.java
index f88bc9d..374814b 100644
--- a/java/org/apache/tomcat/util/buf/UriUtil.java
+++ b/java/org/apache/tomcat/util/buf/UriUtil.java
@@ -193,4 +193,39 @@ public final class UriUtil {
     public static String getWarSeparator() {
         return WAR_SEPARATOR;
     }
+
+
+    /**
+     * Does the provided path start with <code>file:/</code> or
+     * <code>&lt;protocol&gt;://</code>.
+     *
+     * @param path The path to test
+     *
+     * @return {@code} if the supplied path starts with once of the recognised
+     *         sequences.
+     */
+    public static boolean isAbsoluteURI(String path) {
+        // Special case as only a single /
+        if (path.startsWith("file:/")) {
+            return true;
+        }
+
+        // Start at the beginning of the path and skip over any valid protocol
+        // characters
+        int i = 0;
+        while (i < path.length() && isSchemeChar(path.charAt(i))) {
+            i++;
+        }
+        // Need at least one protocol character. False positives with Windows
+        // drives such as C:/... will be caught by the later test for "://"
+        if (i == 0) {
+            return false;
+        }
+        // path starts with something that might be a protocol. Look for a
+        // following "://"
+        if (i + 2 < path.length() && path.charAt(i++) == ':' && path.charAt(i++) == '/' && path.charAt(i) == '/') {
+            return true;
+        }
+        return false;
+    }
 }
diff --git a/test/org/apache/tomcat/util/buf/TestUriUtilIsAbsoluteURI.java b/test/org/apache/tomcat/util/buf/TestUriUtilIsAbsoluteURI.java
new file mode 100644
index 0000000..f1ede74
--- /dev/null
+++ b/test/org/apache/tomcat/util/buf/TestUriUtilIsAbsoluteURI.java
@@ -0,0 +1,77 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.tomcat.util.buf;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.junit.runners.Parameterized.Parameter;
+
+
+@RunWith(Parameterized.class)
+public class TestUriUtilIsAbsoluteURI {
+
+    @Parameterized.Parameters(name = "{index}: path[{0}], expected[{1}]")
+    public static Collection<Object[]> parameters() {
+
+        List<Object[]> parameterSets = new ArrayList<>();
+
+        parameterSets.add(new Object[] { "", Boolean.FALSE } );
+
+        parameterSets.add(new Object[] { "h", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "ht", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "htt", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "http", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "http:", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "http:/", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "http://", Boolean.TRUE } );
+        parameterSets.add(new Object[] { "http://foo", Boolean.TRUE } );
+
+        parameterSets.add(new Object[] { "f", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "fi", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "fil", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "file", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "file:", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "file:/", Boolean.TRUE } );
+        parameterSets.add(new Object[] { "file://", Boolean.TRUE } );
+
+        parameterSets.add(new Object[] { "c", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "c:", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "c:/", Boolean.FALSE } );
+        parameterSets.add(new Object[] { "c:/foo", Boolean.FALSE } );
+
+        return parameterSets;
+    }
+
+
+    @Parameter(0)
+    public String path;
+
+    @Parameter(1)
+    public Boolean valid;
+
+    @Test
+    public void test() {
+        boolean result = UriUtil.isAbsoluteURI(path);
+        Assert.assertEquals(path, valid, Boolean.valueOf(result));
+    }
+}


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org