Handle HTTP status code in each WebDAV-method separately

Author: SailReal

src/main/java/org/cryptomator/cloudaccess/api/CloudProvider.java

@@ -130,6 +130,7 @@ default CompletionStage<InputStream> read(CloudPath file, ProgressListener progr
 	 *     <li>{@link org.cryptomator.cloudaccess.api.exceptions.NotFoundException} If the parent directory of this file doesn't exist</li>
 	 *     <li>{@link org.cryptomator.cloudaccess.api.exceptions.TypeMismatchException} If the path points to a node that isn't a file</li>
 	 *     <li>{@link org.cryptomator.cloudaccess.api.exceptions.AlreadyExistsException} If a node with the given path already exists and <code>replace</code> is false</li>
+	 *     <li>{@link org.cryptomator.cloudaccess.api.exceptions.ParentFolderDoesNotExistException} If the parent folder of a node doesn't exists</li>
 	 *     <li>{@link CloudProviderException} in case of generic I/O errors</li>
 	 * </ul>
 	 *
@@ -200,6 +201,7 @@ default CompletionStage<CloudPath> createFolderIfNonExisting(CloudPath folder) {
 	 * <ul>
 	 *     <li>{@link org.cryptomator.cloudaccess.api.exceptions.NotFoundException} If no item exists for the given source path</li>
 	 *     <li>{@link org.cryptomator.cloudaccess.api.exceptions.AlreadyExistsException} If a node with the given target path already exists and <code>replace</code> is false</li>
+	 *     <li>{@link org.cryptomator.cloudaccess.api.exceptions.ParentFolderDoesNotExistException} If the parent folder of a node doesn't exists</li>
 	 *     <li>{@link CloudProviderException} in case of generic I/O errors</li>
 	 * </ul>
 	 *

src/main/java/org/cryptomator/cloudaccess/api/exceptions/ParentFolderDoesNotExistException.java

@@ -0,0 +1,4 @@
+package org.cryptomator.cloudaccess.api.exceptions;
+
+public class ParentFolderDoesNotExistException extends CloudProviderException {
+}

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

@@ -14,6 +14,8 @@
 import org.cryptomator.cloudaccess.api.exceptions.CloudProviderException;
 import org.cryptomator.cloudaccess.api.exceptions.InsufficientStorageException;
 import org.cryptomator.cloudaccess.api.exceptions.NotFoundException;
+import org.cryptomator.cloudaccess.api.exceptions.ParentFolderDoesNotExistException;
+import org.cryptomator.cloudaccess.api.exceptions.TypeMismatchException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.xml.sax.SAXException;
@@ -48,19 +50,17 @@ public class WebDavClient {
 	CloudItemMetadata itemMetadata(final CloudPath path) throws CloudProviderException {
 		LOG.trace("itemMetadata {}", path);
 		try (final var response = executePropfindRequest(path, PropfindDepth.ZERO)) {
-			checkExecutionSucceeded(response.code());
+			checkPropfindExecutionSucceeded(response.code());
 
-			final var nodes = getEntriesFromResponse(response);
-
-			return processGet(nodes, path);
+			return processGet(getEntriesFromResponse(response), path);
 		} catch (IOException | SAXException e) {
 			throw new CloudProviderException(e);
 		}
 	}
 
 	Quota quota(final CloudPath folder) throws CloudProviderException {
 		LOG.trace("quota {}", folder);
-		final var body = "<?xml version=\"1.0\" ?>\n" //
+		final var body = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" //
 				+ "<d:propfind xmlns:d=\"DAV:\">\n" //
 				+ "<d:prop>\n" //
 				+ "<d:quota-available-bytes/>\n" //
@@ -75,7 +75,7 @@ Quota quota(final CloudPath folder) throws CloudProviderException {
 				.header("Content-Type", "text/xml");
 
 		try (final var response = httpClient.execute(builder)) {
-			checkExecutionSucceeded(response.code());
+			checkPropfindExecutionSucceeded(response.code());
 
 			try (final var responseBody = response.body()) {
 				return new PropfindResponseParser().parseQuta(responseBody.byteStream());
@@ -88,7 +88,7 @@ Quota quota(final CloudPath folder) throws CloudProviderException {
 	CloudItemList list(final CloudPath folder) throws CloudProviderException {
 		LOG.trace("list {}", folder);
 		try (final var response = executePropfindRequest(folder, PropfindDepth.ONE)) {
-			checkExecutionSucceeded(response.code());
+			checkPropfindExecutionSucceeded(response.code());
 
 			final var nodes = getEntriesFromResponse(response);
 
@@ -98,8 +98,24 @@ CloudItemList list(final CloudPath folder) throws CloudProviderException {
 		}
 	}
 
+	private void checkPropfindExecutionSucceeded(int responseCode) {
+		switch (responseCode) {
+			case HttpURLConnection.HTTP_UNAUTHORIZED:
+				throw new UnauthorizedException();
+			case HttpURLConnection.HTTP_FORBIDDEN:
+				throw new ForbiddenException();
+			case HttpURLConnection.HTTP_NOT_FOUND:
+				throw new NotFoundException();
+		}
+
+		if (responseCode < 199 || responseCode > 300) {
+			throw new CloudProviderException("Response code isn't between 200 and 300: " + responseCode);
+		}
+	}
+
 	private Response executePropfindRequest(final CloudPath path, final PropfindDepth propfindDepth) throws IOException {
-		final var body = "<d:propfind xmlns:d=\"DAV:\">\n" //
+		final var body = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" //
+				+ "<d:propfind xmlns:d=\"DAV:\">\n" //
 				+ "<d:prop>\n" //
 				+ "<d:resourcetype />\n" //
 				+ "<d:getcontentlength />\n" //
@@ -166,13 +182,26 @@ CloudPath move(final CloudPath from, final CloudPath to, boolean replace) throws
 		}
 
 		try (final var response = httpClient.execute(builder)) {
-			if (response.code() == HttpURLConnection.HTTP_PRECON_FAILED) {
-				throw new AlreadyExistsException(absoluteURLFrom(to).toExternalForm());
+			if (response.isSuccessful()) {
+				return to;
+			} else {
+				switch (response.code()) {
+					case HttpURLConnection.HTTP_UNAUTHORIZED:
+						throw new UnauthorizedException();
+					case HttpURLConnection.HTTP_FORBIDDEN:
+						throw new ForbiddenException();
+					case HttpURLConnection.HTTP_NOT_FOUND:
+						throw new NotFoundException();
+					case HttpURLConnection.HTTP_CONFLICT:
+						throw new ParentFolderDoesNotExistException();
+					case HttpURLConnection.HTTP_PRECON_FAILED:
+						throw new AlreadyExistsException(absoluteURLFrom(to).toExternalForm());
+					case HTTP_INSUFFICIENT_STORAGE:
+						throw new InsufficientStorageException();
+					default:
+						throw new CloudProviderException("Response code isn't between 200 and 300: " + response.code());
+				}
 			}
-
-			checkExecutionSucceeded(response.code());
-
-			return to;
 		} catch (IOException e) {
 			throw new CloudProviderException(e);
 		}
@@ -201,15 +230,23 @@ private InputStream read(final Request.Builder getRequest, final ProgressListene
 		try {
 			response = httpClient.execute(getRequest);
 			final var countingBody = new ProgressResponseWrapper(response.body(), progressListener);
-
-			final int UNSATISFIABLE_RANGE = 416;
-			if (response.code() == UNSATISFIABLE_RANGE) {
-				return new ByteArrayInputStream(new byte[0]);
+			if (response.isSuccessful()) {
+				success = true;
+				return countingBody.byteStream();
+			} else {
+				switch (response.code()) {
+					case HttpURLConnection.HTTP_UNAUTHORIZED:
+						throw new UnauthorizedException();
+					case HttpURLConnection.HTTP_FORBIDDEN:
+						throw new ForbiddenException();
+					case HttpURLConnection.HTTP_NOT_FOUND:
+						throw new NotFoundException();
+					case 416: // UNSATISFIABLE_RANGE
+						return new ByteArrayInputStream(new byte[0]);
+					default:
+						throw new CloudProviderException("Response code isn't between 200 and 300: " + response.code());
+				}
 			}
-
-			checkExecutionSucceeded(response.code());
-			success = true;
-			return countingBody.byteStream();
 		} catch (IOException e) {
 			throw new CloudProviderException(e);
 		} finally {
@@ -233,7 +270,22 @@ void write(final CloudPath file, final boolean replace, final InputStream data,
 		lastModified.ifPresent(instant -> requestBuilder.addHeader("X-OC-Mtime", String.valueOf(instant.getEpochSecond())));
 
 		try (final var response = httpClient.execute(requestBuilder)) {
-			checkExecutionSucceeded(response.code());
+			if (!response.isSuccessful()) {
+				switch (response.code()) {
+					case HttpURLConnection.HTTP_UNAUTHORIZED:
+						throw new UnauthorizedException();
+					case HttpURLConnection.HTTP_FORBIDDEN:
+						throw new ForbiddenException();
+					case HttpURLConnection.HTTP_BAD_METHOD:
+						throw new TypeMismatchException();
+					case HttpURLConnection.HTTP_CONFLICT:
+						throw new ParentFolderDoesNotExistException();
+					case HTTP_INSUFFICIENT_STORAGE:
+						throw new InsufficientStorageException();
+					default:
+						throw new CloudProviderException("Response code isn't between 200 and 300: " + response.code());
+				}
+			}
 		} catch (IOException e) {
 			throw new CloudProviderException(e);
 		}
@@ -249,17 +301,29 @@ private boolean exists(CloudPath path) throws CloudProviderException {
 
 	CloudPath createFolder(final CloudPath path) throws CloudProviderException {
 		LOG.trace("createFolder {}", path);
-		if (exists(path)) {
-			throw new AlreadyExistsException(String.format("Folder %s already exists", path.toString()));
-		}
-
 		final var builder = new Request.Builder() //
 				.method("MKCOL", null) //
 				.url(absoluteURLFrom(path));
 
 		try (final var response = httpClient.execute(builder)) {
-			checkExecutionSucceeded(response.code());
-			return path;
+			if (response.isSuccessful()) {
+				return path;
+			} else {
+				switch (response.code()) {
+					case HttpURLConnection.HTTP_UNAUTHORIZED:
+						throw new UnauthorizedException();
+					case HttpURLConnection.HTTP_FORBIDDEN:
+						throw new ForbiddenException();
+					case HttpURLConnection.HTTP_BAD_METHOD:
+						throw new AlreadyExistsException(String.format("Folder %s already exists", path.toString()));
+					case HttpURLConnection.HTTP_CONFLICT:
+						throw new ParentFolderDoesNotExistException();
+					case HTTP_INSUFFICIENT_STORAGE:
+						throw new InsufficientStorageException();
+					default:
+						throw new CloudProviderException("Response code isn't between 200 and 300: " + response.code());
+				}
+			}
 		} catch (IOException e) {
 			throw new CloudProviderException(e);
 		}
@@ -272,7 +336,18 @@ void delete(final CloudPath path) throws CloudProviderException {
 				.url(absoluteURLFrom(path));
 
 		try (final var response = httpClient.execute(builder)) {
-			checkExecutionSucceeded(response.code());
+			if (!response.isSuccessful()) {
+				switch (response.code()) {
+					case HttpURLConnection.HTTP_UNAUTHORIZED:
+						throw new UnauthorizedException();
+					case HttpURLConnection.HTTP_FORBIDDEN:
+						throw new ForbiddenException();
+					case HttpURLConnection.HTTP_NOT_FOUND:
+						throw new NotFoundException(String.format("Node %s doesn't exists", path.toString()));
+					default:
+						throw new CloudProviderException("Response code isn't between 200 and 300: " + response.code());
+				}
+			}
 		} catch (IOException e) {
 			throw new CloudProviderException(e);
 		}
@@ -285,10 +360,20 @@ void checkServerCompatibility() throws ServerNotWebdavCompatibleException {
 				.url(baseUrl);
 
 		try (final var response = httpClient.execute(optionsRequest)) {
-			checkExecutionSucceeded(response.code());
-			final var containsDavHeader = response.headers().names().contains("DAV");
-			if (!containsDavHeader) {
-				throw new ServerNotWebdavCompatibleException();
+			if (response.isSuccessful()) {
+				final var containsDavHeader = response.headers().names().contains("DAV");
+				if (!containsDavHeader) {
+					throw new ServerNotWebdavCompatibleException();
+				}
+			} else {
+				switch (response.code()) {
+					case HttpURLConnection.HTTP_UNAUTHORIZED:
+						throw new UnauthorizedException();
+					case HttpURLConnection.HTTP_FORBIDDEN:
+						throw new ForbiddenException();
+					default:
+						throw new CloudProviderException("Response code isn't between 200 and 300: " + response.code());
+				}
 			}
 		} catch (IOException e) {
 			throw new CloudProviderException(e);
@@ -297,37 +382,13 @@ void checkServerCompatibility() throws ServerNotWebdavCompatibleException {
 
 	void tryAuthenticatedRequest() throws UnauthorizedException {
 		LOG.trace("tryAuthenticatedRequest");
-		try {
-			itemMetadata(CloudPath.of("/"));
-		} catch (Exception e) {
-			if (e instanceof UnauthorizedException) {
-				throw e;
-			}
-		}
-	}
-
-	private void checkExecutionSucceeded(final int status) throws CloudProviderException {
-		switch (status) {
-			case HttpURLConnection.HTTP_UNAUTHORIZED:
-				throw new UnauthorizedException();
-			case HttpURLConnection.HTTP_FORBIDDEN:
-				throw new ForbiddenException();
-			case HttpURLConnection.HTTP_NOT_FOUND: // fall through
-			case HttpURLConnection.HTTP_CONFLICT: //
-				throw new NotFoundException();
-			case HTTP_INSUFFICIENT_STORAGE:
-				throw new InsufficientStorageException();
-		}
-
-		if (status < 199 || status > 300) {
-			throw new CloudProviderException("Response code isn't between 200 and 300: " + status);
-		}
+		itemMetadata(CloudPath.of("/"));
 	}
 
 	// visible for testing
 	URL absoluteURLFrom(final CloudPath relativePath) {
 		var basePath = CloudPath.of(baseUrl.getPath()).toAbsolutePath();
-		var fullPath = IntStream.range(0, relativePath.getNameCount()).mapToObj(i -> relativePath.getName(i)).reduce(basePath, CloudPath::resolve);
+		var fullPath = IntStream.range(0, relativePath.getNameCount()).mapToObj(relativePath::getName).reduce(basePath, CloudPath::resolve);
 		try {
 			return new URL(baseUrl, fullPath.toString());
 		} catch (MalformedURLException e) {

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

@@ -189,8 +189,6 @@ public void testWriteToAndReplaceExistingFile() throws IOException {
 				.thenReturn(getInterceptedResponse(baseUrl, "item-write-response.xml"))
 				.thenReturn(getInterceptedResponse(baseUrl, "item-write-response.xml"));
 
-		final var writtenItemMetadata = new CloudItemMetadata("foo.txt", CloudPath.of("/foo.txt"), CloudItemType.FILE, Optional.of(TestUtil.toInstant("Thu, 07 Jul 2020 16:55:50 GMT")), Optional.of(8193L));
-
 		InputStream inputStream = getClass().getResourceAsStream("/progress-request-text.txt");
 		webDavClient.write(CloudPath.of("/foo.txt"), true, inputStream, inputStream.available(), Optional.empty(), ProgressListener.NO_PROGRESS_AWARE);
 	}
@@ -199,7 +197,6 @@ public void testWriteToAndReplaceExistingFile() throws IOException {
 	@DisplayName("create /foo")
 	public void testCreateFolder() throws IOException {
 		Mockito.when(webDavCompatibleHttpClient.execute(ArgumentMatchers.any()))
-				.thenReturn(getInterceptedResponse(baseUrl, 404, ""))
 				.thenReturn(getInterceptedResponse(baseUrl));
 
 		final var path = webDavClient.createFolder(CloudPath.of("/foo"));

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

@@ -36,9 +36,8 @@ public class WebDavCloudProviderTestIT {
 	private final CloudItemMetadata testFilePng = new CloudItemMetadata("Nextcloud.png", CloudPath.of("/Nextcloud.png"), CloudItemType.FILE, Optional.of(TestUtil.toInstant("Thu, 19 Feb 2020 10:24:12 GMT")), Optional.of(37042L));
 	private final CloudItemMetadata testFolderPhotos = new CloudItemMetadata("Photos", CloudPath.of("/Photos"), CloudItemType.FOLDER, Optional.empty(), Optional.empty());
 
-	private final String webDavRequestBody = "<d:propfind xmlns:d=\"DAV:\">\n<d:prop>\n<d:resourcetype />\n<d:getcontentlength />\n<d:getlastmodified />\n</d:prop>\n</d:propfind>";
+	private final String webDavRequestBody = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<d:propfind xmlns:d=\"DAV:\">\n<d:prop>\n<d:resourcetype />\n<d:getcontentlength />\n<d:getlastmodified />\n</d:prop>\n</d:propfind>";
 
-	//TODO: add timeout to webserver if it fails to start/handle the requests
 	public WebDavCloudProviderTestIT() throws IOException, InterruptedException {
 		server = new MockWebServer();
 		server.start();
@@ -222,18 +221,13 @@ public void testWriteAndTrySetModDate() throws InterruptedException, IOException
 	@Test
 	@DisplayName("create /foo")
 	public void testCreateFolder() throws InterruptedException {
-		server.enqueue(getInterceptedResponse(404, ""));
 		server.enqueue(getInterceptedResponse());
 
 		final var path = Assertions.assertTimeoutPreemptively(timeout, () -> provider.createFolder(CloudPath.of("/foo")).toCompletableFuture().join());
 
 		Assertions.assertEquals(path, CloudPath.of("/foo"));
 
 		var rq = Assertions.assertTimeoutPreemptively(timeout, () -> server.takeRequest());
-		Assertions.assertEquals("PROPFIND", rq.getMethod());
-		Assertions.assertEquals("/cloud/remote.php/webdav/foo", rq.getPath());
-
-		rq = Assertions.assertTimeoutPreemptively(timeout, () -> server.takeRequest());
 		Assertions.assertEquals("MKCOL", rq.getMethod());
 		Assertions.assertEquals("/cloud/remote.php/webdav/foo", rq.getPath());
 	}