Allow a regex as upload URI to support URL parameters (issue #11)

Author: tomdesair

src/main/java/me/desair/tus/server/TusFileUploadService.java

@@ -68,7 +68,7 @@ protected void initFeatures() {
     }
 
     public TusFileUploadService withUploadURI(String uploadURI) {
-        Validate.notBlank(uploadURI, "The upload URI cannot be blank");
+        Validate.notBlank(uploadURI, "The upload URI pattern cannot be blank");
         this.idFactory.setUploadURI(uploadURI);
         return this;
     }

src/main/java/me/desair/tus/server/creation/validation/PostURIValidator.java

@@ -1,25 +1,31 @@
 package me.desair.tus.server.creation.validation;
 
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
 import javax.servlet.http.HttpServletRequest;
 
 import me.desair.tus.server.HttpMethod;
 import me.desair.tus.server.RequestValidator;
 import me.desair.tus.server.exception.PostOnInvalidRequestURIException;
 import me.desair.tus.server.exception.TusException;
 import me.desair.tus.server.upload.UploadStorageService;
-import org.apache.commons.lang3.StringUtils;
 
 /**
  * The Client MUST send a POST request against a known upload creation URL to request a new upload resource.
  */
 public class PostURIValidator implements RequestValidator {
 
+    private Pattern uploadUriPattern = null;
+
     @Override
     public void validate(HttpMethod method, HttpServletRequest request,
                          UploadStorageService uploadStorageService, String ownerKey)
             throws TusException {
 
-        if (!StringUtils.equals(request.getRequestURI(), uploadStorageService.getUploadURI())) {
+        Matcher uploadUriMatcher = getUploadUriPattern(uploadStorageService).matcher(request.getRequestURI());
+
+        if (!uploadUriMatcher.matches()) {
             throw new PostOnInvalidRequestURIException("POST requests have to be send to "
                     + uploadStorageService.getUploadURI());
         }
@@ -30,4 +36,12 @@ public boolean supports(HttpMethod method) {
         return HttpMethod.POST.equals(method);
     }
 
+    private Pattern getUploadUriPattern(UploadStorageService uploadStorageService) {
+        if (uploadUriPattern == null) {
+            //A POST request should match the full URI
+            uploadUriPattern = Pattern.compile("^" + uploadStorageService.getUploadURI() + "$");
+        }
+        return uploadUriPattern;
+    }
+
 }

src/main/java/me/desair/tus/server/upload/UploadIdFactory.java

@@ -1,21 +1,26 @@
 package me.desair.tus.server.upload;
 
 import java.util.UUID;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.Validate;
 
 public class UploadIdFactory {
 
     private String uploadURI = "/";
+    private Pattern uploadUriPattern = null;
 
     public void setUploadURI(String uploadURI) {
-        Validate.notNull(uploadURI, "The upload URI cannot be null");
+        Validate.notNull(uploadURI, "The upload URI pattern cannot be null");
         this.uploadURI = uploadURI;
+        this.uploadUriPattern = null;
     }
 
     public UUID readUploadId(String url) {
-        String pathId = StringUtils.substringAfter(url, uploadURI + (StringUtils.endsWith(uploadURI, "/") ? "" : "/"));
+        Matcher uploadUriMatcher = getUploadUriPattern().matcher(StringUtils.trimToEmpty(url));
+        String pathId = uploadUriMatcher.replaceFirst("");
         UUID id = null;
 
         if (StringUtils.isNotBlank(pathId)) {
@@ -36,4 +41,14 @@ public String getUploadURI() {
     public synchronized UUID createId() {
         return UUID.randomUUID();
     }
+
+    private Pattern getUploadUriPattern() {
+        if (uploadUriPattern == null) {
+            //We will extract the upload ID's by removing the upload URI from the start of the request URI
+            uploadUriPattern = Pattern.compile("^.*"
+                    + uploadURI
+                    + (StringUtils.endsWith(uploadURI, "/") ? "" : "/?"));
+        }
+        return uploadUriPattern;
+    }
 }

src/test/java/me/desair/tus/server/upload/UploadIdFactoryTest.java

@@ -43,6 +43,14 @@ public void readUploadId() throws Exception {
                 hasToString("1911e8a4-6939-490c-b58b-a5d70f8d91fb"));
     }
 
+    @Test
+    public void readUploadIdRegex() throws Exception {
+        idFactory.setUploadURI("/users/[0-9]+/files/upload");
+
+        assertThat(idFactory.readUploadId("/users/1337/files/upload/1911e8a4-6939-490c-b58b-a5d70f8d91fb"),
+                hasToString("1911e8a4-6939-490c-b58b-a5d70f8d91fb"));
+    }
+
     @Test
     public void readUploadIdTrailingSlash() throws Exception {
         idFactory.setUploadURI("/test/upload/");
@@ -51,13 +59,29 @@ public void readUploadIdTrailingSlash() throws Exception {
                 hasToString("1911e8a4-6939-490c-b58b-a5d70f8d91fb"));
     }
 
+    @Test
+    public void readUploadIdRegexTrailingSlash() throws Exception {
+        idFactory.setUploadURI("/users/[0-9]+/files/upload/");
+
+        assertThat(idFactory.readUploadId("/users/123456789/files/upload/1911e8a4-6939-490c-b58b-a5d70f8d91fb"),
+                hasToString("1911e8a4-6939-490c-b58b-a5d70f8d91fb"));
+    }
+
     @Test
     public void readUploadIdNoUUID() throws Exception {
         idFactory.setUploadURI("/test/upload");
 
         assertThat(idFactory.readUploadId("/test/upload/not-a-uuid-value"), is(nullValue()));
     }
 
+    @Test
+    public void readUploadIdRegexNoMatch() throws Exception {
+        idFactory.setUploadURI("/users/[0-9]+/files/upload");
+
+        assertThat(idFactory.readUploadId("/users/files/upload/1911e8a4-6939-490c-b58b-a5d70f8d91fb"),
+                is(nullValue()));
+    }
+
     @Test
     public void createId() throws Exception {
         assertThat(idFactory.createId(), not(nullValue()));