fixed metadata path in WebDAV provider, especially during directory listing

Author: tobihagemann

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

@@ -1,23 +1,21 @@
 package org.cryptomator.cloudaccess.webdav;
 
-import org.cryptomator.cloudaccess.api.CloudItemMetadata;
-import org.cryptomator.cloudaccess.api.CloudPath;
+import com.google.common.base.Splitter;
+import com.google.common.collect.Streams;
 
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.Optional;
 import java.util.regex.Pattern;
 
-import static org.cryptomator.cloudaccess.api.CloudItemType.FILE;
-import static org.cryptomator.cloudaccess.api.CloudItemType.FOLDER;
-
 class PropfindEntryData {
+
 	private static final Pattern URI_PATTERN = Pattern.compile("^[a-z]+://[^/]+/(.*)$");
 
-	private CloudPath path;
+	private String path;
 
-	private boolean file = true;
+	private boolean collection = true;
 	private Optional<Instant> lastModified = Optional.empty();
 	private Optional<Long> size = Optional.empty();
 
@@ -32,52 +30,47 @@ private String extractPath(final String pathOrUri) {
 		}
 	}
 
+	private String urlDecode(final String value) {
+		return URLDecoder.decode(value, StandardCharsets.UTF_8);
+	}
+
+	public Optional<Instant> getLastModified() {
+		return lastModified;
+	}
+
 	void setLastModified(final Optional<Instant> lastModified) {
 		this.lastModified = lastModified;
 	}
 
-	public CloudPath getPath() {
+	public String getPath() {
 		return path;
 	}
 
-	public void setPath(final String pathOrUri) {
-		this.path = CloudPath.of(extractPath(pathOrUri));
+	void setPath(final String pathOrUri) {
+		this.path = extractPath(pathOrUri);
 	}
 
 	public Optional<Long> getSize() {
 		return size;
 	}
 
-	public void setSize(final Optional<Long> size) {
+	void setSize(final Optional<Long> size) {
 		this.size = size;
 	}
 
-	private boolean isFile() {
-		return file;
+	public boolean isCollection() {
+		return collection;
 	}
 
-	public void setFile(final boolean file) {
-		this.file = file;
+	void setCollection(final boolean collection) {
+		this.collection = collection;
 	}
 
-	public CloudItemMetadata toCloudItem() {
-		if (isFile()) {
-			return new CloudItemMetadata(getName(), path, FILE, lastModified, size);
-		} else {
-			return new CloudItemMetadata(getName(), path, FOLDER);
-		}
-	}
-
-	private String urlDecode(final String value) {
-		return URLDecoder.decode(value, StandardCharsets.UTF_8);
-	}
-
-	int getDepth() {
-		return path.getNameCount();
+	public long getDepth() {
+		return Splitter.on("/").omitEmptyStrings().splitToStream(path).count();
 	}
 
-	private String getName() {
-		return path.getFileName().toString();
+	public String getName() {
+		return Streams.findLast(Splitter.on("/").omitEmptyStrings().splitToStream(path)).orElse("");
 	}
-
 }

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

@@ -134,7 +134,7 @@ private void assembleEntry() {
 			entry.setLastModified(parseDate(lastModified));
 			entry.setSize(parseLong(contentLength));
 			entry.setPath(href);
-			entry.setFile(!isCollection);
+			entry.setCollection(isCollection);
 
 			entries.add(entry);
 		}

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

@@ -25,9 +25,12 @@
 import java.util.List;
 import java.util.stream.IntStream;
 
+import static org.cryptomator.cloudaccess.api.CloudItemType.FILE;
+import static org.cryptomator.cloudaccess.api.CloudItemType.FOLDER;
+
 public class WebDavClient {
 
-	private static final Comparator<PropfindEntryData> ASCENDING_BY_DEPTH = Comparator.comparingInt(PropfindEntryData::getDepth);
+	private static final Comparator<PropfindEntryData> ASCENDING_BY_DEPTH = Comparator.comparingLong(PropfindEntryData::getDepth);
 
 	private final WebDavCompatibleHttpClient httpClient;
 	private final URL baseUrl;
@@ -39,30 +42,30 @@ public class WebDavClient {
 	}
 
 	CloudItemList list(final CloudPath folder) throws CloudProviderException {
-		try (final var response = executePropfindRequest(folder, PROPFIND_DEPTH.ONE)) {
+		try (final var response = executePropfindRequest(folder, PropfindDepth.ONE)) {
 			checkExecutionSucceeded(response.code());
 
 			final var nodes = getEntriesFromResponse(response);
 
-			return processDirList(nodes);
+			return processDirList(nodes, folder);
 		} catch (IOException | SAXException e) {
 			throw new CloudProviderException(e);
 		}
 	}
 
 	CloudItemMetadata itemMetadata(final CloudPath path) throws CloudProviderException {
-		try (final var response = executePropfindRequest(path, PROPFIND_DEPTH.ZERO)) {
+		try (final var response = executePropfindRequest(path, PropfindDepth.ZERO)) {
 			checkExecutionSucceeded(response.code());
 
 			final var nodes = getEntriesFromResponse(response);
 
-			return processGet(nodes);
+			return processGet(nodes, path);
 		} catch (IOException | SAXException e) {
 			throw new CloudProviderException(e);
 		}
 	}
 
-	private Response executePropfindRequest(final CloudPath path, final PROPFIND_DEPTH propfind_depth) throws IOException {
+	private Response executePropfindRequest(final CloudPath path, final PropfindDepth propfindDepth) throws IOException {
 		final var body = "<d:propfind xmlns:d=\"DAV:\">\n" //
 				+ "<d:prop>\n" //
 				+ "<d:resourcetype />\n" //
@@ -74,7 +77,7 @@ private Response executePropfindRequest(final CloudPath path, final PROPFIND_DEP
 		final var builder = new Request.Builder() //
 				.method("PROPFIND", RequestBody.create(body, MediaType.parse(body))) //
 				.url(absoluteURLFrom(path)) //
-				.header("DEPTH", propfind_depth.value) //
+				.header("Depth", propfindDepth.value) //
 				.header("Content-Type", "text/xml");
 
 		return httpClient.execute(builder);
@@ -86,12 +89,12 @@ private List<PropfindEntryData> getEntriesFromResponse(final Response response)
 		}
 	}
 
-	private CloudItemMetadata processGet(final List<PropfindEntryData> entryData) {
+	private CloudItemMetadata processGet(final List<PropfindEntryData> entryData, final CloudPath path) {
 		entryData.sort(ASCENDING_BY_DEPTH);
-		return entryData.size() >= 1 ? entryData.get(0).toCloudItem() : null;
+		return entryData.size() >= 1 ? toCloudItem(entryData.get(0), path) : null;
 	}
 
-	private CloudItemList processDirList(final List<PropfindEntryData> entryData) {
+	private CloudItemList processDirList(final List<PropfindEntryData> entryData, final CloudPath folder) {
 		var result = new CloudItemList(new ArrayList<>());
 
 		if (entryData.isEmpty()) {
@@ -103,11 +106,19 @@ private CloudItemList processDirList(final List<PropfindEntryData> entryData) {
 		// because it's depth is 1 smaller than the depth
 		// ot the other entries, thus we skip the first entry
 		for (PropfindEntryData childEntry : entryData.subList(1, entryData.size())) {
-			result = result.add(List.of(childEntry.toCloudItem()));
+			result = result.add(List.of(toCloudItem(childEntry, folder.resolve(childEntry.getName()))));
 		}
 		return result;
 	}
 
+	private CloudItemMetadata toCloudItem(final PropfindEntryData data, final CloudPath path) {
+		if (data.isCollection()) {
+			return new CloudItemMetadata(data.getName(), path, FOLDER);
+		} else {
+			return new CloudItemMetadata(data.getName(), path, FILE, data.getLastModified(), data.getSize());
+		}
+	}
+
 	CloudPath move(final CloudPath from, final CloudPath to, boolean replace) throws CloudProviderException {
 		final var builder = new Request.Builder() //
 				.method("MOVE", null) //
@@ -142,7 +153,7 @@ InputStream read(final CloudPath path, final ProgressListener progressListener)
 
 	InputStream read(final CloudPath 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))
+				.header("Range", String.format("bytes=%d-%d", offset, offset + count - 1)) //
 				.get() //
 				.url(absoluteURLFrom(path));
 		return read(getRequest, progressListener);
@@ -156,7 +167,7 @@ private InputStream read(final Request.Builder getRequest, final ProgressListene
 			final var countingBody = new ProgressResponseWrapper(response.body(), progressListener);
 
 			final int UNSATISFIABLE_RANGE = 416;
-			 if(response.code() == UNSATISFIABLE_RANGE) {
+			if (response.code() == UNSATISFIABLE_RANGE) {
 				return new ByteArrayInputStream(new byte[0]);
 			}
 
@@ -178,8 +189,8 @@ CloudItemMetadata write(final CloudPath file, final boolean replace, final Input
 		}
 
 		final var countingBody = new ProgressRequestWrapper(InputStreamRequestBody.from(data, size), progressListener);
-		final var requestBuilder = new Request.Builder()
-				.url(absoluteURLFrom(file))
+		final var requestBuilder = new Request.Builder() //
+				.url(absoluteURLFrom(file)) //
 				.put(countingBody);
 
 		try (final var response = httpClient.execute(requestBuilder)) {
@@ -199,7 +210,7 @@ private boolean exists(CloudPath path) throws CloudProviderException {
 	}
 
 	CloudPath createFolder(final CloudPath path) throws CloudProviderException {
-		if(exists(path)) {
+		if (exists(path)) {
 			throw new AlreadyExistsException(String.format("Folder %s already exists", path.toString()));
 		}
 
@@ -228,8 +239,8 @@ void delete(final CloudPath path) throws CloudProviderException {
 	}
 
 	void checkServerCompatibility() throws ServerNotWebdavCompatibleException {
-		final var optionsRequest = new Request.Builder()
-				.method("OPTIONS", null)
+		final var optionsRequest = new Request.Builder() //
+				.method("OPTIONS", null) //
 				.url(baseUrl);
 
 		try (final var response = httpClient.execute(optionsRequest)) {
@@ -282,19 +293,20 @@ URL absoluteURLFrom(final CloudPath relativePath) {
 		}
 	}
 
-	private enum PROPFIND_DEPTH {
-		ZERO("0"),
-		ONE("1"),
+	private enum PropfindDepth {
+		ZERO("0"), //
+		ONE("1"), //
 		INFINITY("infinity");
 
 		private final String value;
 
-		PROPFIND_DEPTH(final String value) {
+		PropfindDepth(final String value) {
 			this.value = value;
 		}
 	}
 
 	static class WebDavAuthenticator {
+
 		static WebDavClient createAuthenticatedWebDavClient(final WebDavCredential webDavCredential) throws ServerNotWebdavCompatibleException, UnauthorizedException {
 			final var webDavClient = new WebDavClient(new WebDavCompatibleHttpClient(webDavCredential), webDavCredential);