Merge branch 'develop' into release/0.1.0

Author: overheadhunter

src/main/java/org/cryptomator/cloudaccess/CloudAccess.java

@@ -1,15 +1,31 @@
 package org.cryptomator.cloudaccess;
 
+import java.net.URL;
 import java.nio.file.Path;
 
 import org.cryptomator.cloudaccess.api.CloudProvider;
 import org.cryptomator.cloudaccess.localfs.LocalFsCloudProvider;
+import org.cryptomator.cloudaccess.webdav.WebDavCloudProvider;
+import org.cryptomator.cloudaccess.webdav.WebDavCredential;
 
 public class CloudAccess {
 
 	private CloudAccess() {
 	}
 
+	/**
+	 * Creates a new CloudProvider which provides access to the given URL via WebDAV.
+	 *
+	 * @param url Base URL leading to the root resource
+	 * @param username Username used during basic or digest auth challenges
+	 * @param password Password used during basic or digest auth challenges
+	 * @return A cloud access provider that provides access to the given WebDAV URL.
+	 */
+	public static CloudProvider toWebDAV(URL url, String username, CharSequence password) {
+		// TODO can we pass though CharSequence to the auth mechanism?
+		return WebDavCloudProvider.from(WebDavCredential.from(url, username, password.toString()));
+	}
+
 	/**
 	 * Creates a new CloudProvider which provides access to the given <code>folder</code>. Mainly for test purposes.
 	 *

src/main/java/org/cryptomator/cloudaccess/webdav/WebDavClient.java

@@ -16,15 +16,19 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.HttpURLConnection;
+import java.net.MalformedURLException;
+import java.net.URL;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
+import java.util.stream.IntStream;
+import java.util.stream.Stream;
 
 public class WebDavClient {
 
     private final WebDavCompatibleHttpClient httpClient;
-    private final Path baseUrl;
+    private final URL baseUrl;
     private final int HTTP_INSUFFICIENT_STORAGE = 507;
 
     private enum PROPFIND_DEPTH {
@@ -98,7 +102,7 @@ private Response executePropfindRequest(final Path path, final PROPFIND_DEPTH pr
 
         final var builder = new Request.Builder() //
                 .method("PROPFIND", RequestBody.create(body, MediaType.parse(body))) //
-                .url(absolutePathFrom(path)) //
+                .url(absoluteURLFrom(path)) //
                 .header("DEPTH", propfind_depth.value) //
                 .header("Content-Type", "text/xml");
 
@@ -138,8 +142,8 @@ private CloudItemList processDirList(final List<PropfindEntryData> entryData) {
     Path move(final Path from, final Path to, boolean replace) throws CloudProviderException {
         final var builder = new Request.Builder() //
                 .method("MOVE", null) //
-                .url(absolutePathFrom(from)) //
-                .header("Destination", absolutePathFrom(to)) //
+                .url(absoluteURLFrom(from)) //
+                .header("Destination", absoluteURLFrom(to).toExternalForm()) //
                 .header("Content-Type", "text/xml") //
                 .header("Depth", "infinity");
 
@@ -149,7 +153,7 @@ Path move(final Path from, final Path to, boolean replace) throws CloudProviderE
 
         try (final var response = httpClient.execute(builder)) {
             if (response.code() == HttpURLConnection.HTTP_PRECON_FAILED) {
-                throw new AlreadyExistsException(absolutePathFrom(to));
+                throw new AlreadyExistsException(absoluteURLFrom(to).toExternalForm());
             }
 
             checkExecutionSucceeded(response.code());
@@ -163,15 +167,15 @@ Path move(final Path from, final Path to, boolean replace) throws CloudProviderE
     InputStream read(final Path path, final ProgressListener progressListener) throws CloudProviderException {
         final var getRequest = new Request.Builder() //
                 .get() //
-                .url(absolutePathFrom(path));
+                .url(absoluteURLFrom(path));
         return read(getRequest, progressListener);
     }
 
     InputStream read(final Path path, final long offset, final long count, final ProgressListener progressListener) throws CloudProviderException {
         final var getRequest = new Request.Builder() //
                 .header("Range", String.format("bytes=%d-%d", offset, offset + count - 1))
                 .get() //
-                .url(absolutePathFrom(path));
+                .url(absoluteURLFrom(path));
         return read(getRequest, progressListener);
     }
 
@@ -193,7 +197,7 @@ CloudItemMetadata write(final Path file, final boolean replace, final InputStrea
 
         final var countingBody = new ProgressRequestWrapper(InputStreamRequestBody.from(data), progressListener);
         final var requestBuilder = new Request.Builder()
-                .url(absolutePathFrom(file))
+                .url(absoluteURLFrom(file))
                 .put(countingBody);
 
         try (final var response = httpClient.execute(requestBuilder)) {
@@ -215,7 +219,7 @@ private boolean exists(Path path) throws CloudProviderException {
     Path createFolder(final Path path) throws CloudProviderException {
         final var builder = new Request.Builder() //
                 .method("MKCOL", null) //
-                .url(absolutePathFrom(path));
+                .url(absoluteURLFrom(path));
 
         try (final var response = httpClient.execute(builder)) {
             checkExecutionSucceeded(response.code());
@@ -228,7 +232,7 @@ Path createFolder(final Path path) throws CloudProviderException {
     void delete(final Path path) throws CloudProviderException {
         final var builder = new Request.Builder() //
                 .delete() //
-                .url(absolutePathFrom(path));
+                .url(absoluteURLFrom(path));
 
         try (final var response = httpClient.execute(builder)) {
             checkExecutionSucceeded(response.code());
@@ -240,7 +244,7 @@ void delete(final Path path) throws CloudProviderException {
     void checkServerCompatibility() throws ServerNotWebdavCompatibleException  {
         final var optionsRequest = new Request.Builder()
                 .method("OPTIONS", null)
-                .url(baseUrl.toString());
+                .url(baseUrl);
 
         try (final var response = httpClient.execute(optionsRequest)) {
             checkExecutionSucceeded(response.code());
@@ -281,9 +285,15 @@ private void checkExecutionSucceeded(final int status) throws CloudProviderExcep
         }
     }
 
-    private String absolutePathFrom(final Path relativePath) {
-        // TODO improve path appending
-        return baseUrl.toString() + relativePath.toString();
+    // visible for testing
+    URL absoluteURLFrom(final Path relativePath) {
+        var basePath = Path.of(baseUrl.getPath());
+        var fullPath = IntStream.range(0, relativePath.getNameCount()).mapToObj(i -> relativePath.getName(i)).reduce(basePath, Path::resolve);
+        try {
+            return new URL(baseUrl, fullPath.toString());
+        } catch (MalformedURLException e) {
+            throw new IllegalArgumentException("The relative path contains invalid URL elements.");
+        }
     }
 
 }

src/main/java/org/cryptomator/cloudaccess/webdav/WebDavCredential.java

@@ -1,24 +1,24 @@
 package org.cryptomator.cloudaccess.webdav;
 
-import java.nio.file.Path;
+import java.net.URL;
 
 public class WebDavCredential {
 
-    private final Path baseUrl;
+    private final URL baseUrl;
     private final String username;
     private final String password;
 
-    public static WebDavCredential from(final Path baseUrl, final String username, final String password) {
+    public static WebDavCredential from(final URL baseUrl, final String username, final String password) {
         return new WebDavCredential(baseUrl, username, password);
     }
 
-    private WebDavCredential(final Path baseUrl, final String username, final String password) {
+    private WebDavCredential(final URL baseUrl, final String username, final String password) {
         this.baseUrl = baseUrl;
         this.username = username;
         this.password = password;
     }
 
-    public Path getBaseUrl() {
+    public URL getBaseUrl() {
         return baseUrl;
     }
 

src/test/java/org/cryptomator/cloudaccess/webdav/WebDavClientTest.java

@@ -13,13 +13,17 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
 import org.mockito.ArgumentMatchers;
 import org.mockito.Mockito;
 
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.net.MalformedURLException;
+import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.util.List;
@@ -31,7 +35,7 @@ public class WebDavClientTest {
     private final WebDavCompatibleHttpClient webDavCompatibleHttpClient = Mockito.mock(WebDavCompatibleHttpClient.class);
     private WebDavClient webDavClient;
 
-    private final Path baseUrl = Path.of("https://www.nextcloud.com/cloud/remote.php/webdav");
+    private URL baseUrl;
 
     private final CloudItemMetadata testFolderDocuments = new CloudItemMetadata("Documents", Path.of("/cloud/remote.php/webdav/Documents"), CloudItemType.FOLDER, Optional.empty(), Optional.empty());
     private final CloudItemMetadata testFileManual = new CloudItemMetadata("Nextcloud Manual.pdf", Path.of("/cloud/remote.php/webdav/Nextcloud Manual.pdf"), CloudItemType.FILE, Optional.of(TestUtil.toInstant("Thu, 19 Feb 2020 10:24:12 GMT")), Optional.of(6837751L));
@@ -40,11 +44,27 @@ public class WebDavClientTest {
     private final CloudItemMetadata testFolderPhotos = new CloudItemMetadata("Photos", Path.of("/cloud/remote.php/webdav/Photos"), CloudItemType.FOLDER, Optional.empty(), Optional.empty());
 
     @BeforeEach
-    public void setup() {
+    public void setup() throws MalformedURLException {
+    	 baseUrl = new URL("https://www.nextcloud.com/cloud/remote.php/webdav");
         final var webDavCredential = WebDavCredential.from(baseUrl, "foo", "bar");
         webDavClient = new WebDavClient(webDavCompatibleHttpClient, webDavCredential);
     }
 
+    @ParameterizedTest(name = "absoluteURLFrom(\"{0}\") == {1}")
+    @DisplayName("absoluteURLFrom(...)")
+    @CsvSource(value = {
+            "'',/cloud/remote.php/webdav",
+            "/,/cloud/remote.php/webdav",
+            "/foo,/cloud/remote.php/webdav/foo",
+            "foo/bar,/cloud/remote.php/webdav/foo/bar",
+            "//foo///bar/baz,/cloud/remote.php/webdav/foo/bar/baz",
+    })
+    public void testAbsoluteURLFrom(String absPath, String expectedResult) {
+        var result = webDavClient.absoluteURLFrom(Path.of(absPath));
+
+        Assertions.assertEquals(expectedResult, result.getPath());
+    }
+
     @Test
     @DisplayName("get metadata of /Nextcloud Manual.pdf")
     public void testItemMetadata() throws IOException {
@@ -268,18 +288,18 @@ public void testTryAuthenticatedRequest() throws IOException {
         Assertions.assertThrows(UnauthorizedException.class, () -> webDavClient.tryAuthenticatedRequest());
     }
 
-    private Response getInterceptedResponse(final Path path, final String testResource) {
-        return getInterceptedResponse(path, 200, load(testResource));
+    private Response getInterceptedResponse(final URL url, final String testResource) {
+        return getInterceptedResponse(url, 200, load(testResource));
     }
 
-    private Response getInterceptedResponse(final Path path) {
-        return getInterceptedResponse(path, 201, "");
+    private Response getInterceptedResponse(final URL url) {
+        return getInterceptedResponse(url, 201, "");
     }
 
-    private Response getInterceptedResponse(final Path path, int httpCode, final String body) {
+    private Response getInterceptedResponse(final URL url, int httpCode, final String body) {
         return new Response.Builder()
                 .request(new Request.Builder()
-                        .url(path.toString())
+                        .url(url)
                         .build())
                 .protocol(Protocol.HTTP_1_1)
                 .code(httpCode)

src/test/java/org/cryptomator/cloudaccess/webdav/WebDavCloudProviderTestIT.java

@@ -17,6 +17,7 @@
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
+import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.util.List;
@@ -28,7 +29,7 @@ public class WebDavCloudProviderTestIT {
 
     private final MockWebServer server;
     private final CloudProvider provider;
-    private final Path baseUrl;
+    private final URL baseUrl;
 
     private final CloudItemMetadata testFolderDocuments = new CloudItemMetadata("Documents", Path.of("/cloud/remote.php/webdav/Documents"), CloudItemType.FOLDER, Optional.empty(), Optional.empty());
     private final CloudItemMetadata testFileManual = new CloudItemMetadata("Nextcloud Manual.pdf", Path.of("/cloud/remote.php/webdav/Nextcloud Manual.pdf"), CloudItemType.FILE, Optional.of(TestUtil.toInstant("Thu, 19 Feb 2020 10:24:12 GMT")), Optional.of(6837751L));
@@ -42,7 +43,7 @@ public WebDavCloudProviderTestIT() throws IOException, InterruptedException {
         server = new MockWebServer();
         server.start();
 
-        baseUrl = Path.of(String.format("http://%s:%s/cloud/remote.php/webdav", server.getHostName(), server.getPort()));
+        baseUrl = new URL("http", server.getHostName(), server.getPort(), "/cloud/remote.php/webdav");
 
         final var response = getInterceptedResponse("item-meta-data-response.xml");
         server.enqueue(response);
@@ -88,7 +89,7 @@ public void testList() throws InterruptedException {
         RecordedRequest rq = server.takeRequest();
         Assertions.assertEquals("PROPFIND", rq.getMethod());
         Assertions.assertEquals("1", rq.getHeader("DEPTH"));
-        Assertions.assertEquals("/cloud/remote.php/webdav/", rq.getPath());
+        Assertions.assertEquals("/cloud/remote.php/webdav", rq.getPath());
         Assertions.assertEquals(webDavRequestBody, rq.getBody().readUtf8());
     }
 
@@ -115,7 +116,7 @@ public void testListExhaustively() throws InterruptedException {
         RecordedRequest rq = server.takeRequest();
         Assertions.assertEquals("PROPFIND", rq.getMethod());
         Assertions.assertEquals("infinity", rq.getHeader("DEPTH"));
-        Assertions.assertEquals("/cloud/remote.php/webdav/", rq.getPath());
+        Assertions.assertEquals("/cloud/remote.php/webdav", rq.getPath());
         Assertions.assertEquals(webDavRequestBody, rq.getBody().readUtf8());
     }