Remove conflicting c9u files on directory listing

Author: infeo

src/main/java/org/cryptomator/cryptofs/common/Constants.java

@@ -8,6 +8,8 @@
  *******************************************************************************/
 package org.cryptomator.cryptofs.common;
 
+import java.util.regex.Pattern;
+
 public final class Constants {
 
 	private Constants() {
@@ -38,4 +40,6 @@ private Constants() {
 	public static final String RECOVERY_DIR_NAME = "LOST+FOUND";
 	public static final int INUSE_DELAY_MILLIS = 5000;
 	public static final int INUSE_CLEARTEXT_SIZE = 1000; //calculation: Create inUse properties with owner consisting of \u2741.repeat(100) and encode it. Plus an additional buffer for future entries.
+
+	public static final Pattern BASE64_PATTERN = Pattern.compile("[a-zA-Z0-9-_]{20}(?:[a-zA-Z0-9-_]{4})*(?:[a-zA-Z0-9-_]{4}|[a-zA-Z0-9-_]{3}=|[a-zA-Z0-9-_]{2}==)");
 }

src/main/java/org/cryptomator/cryptofs/dir/C9rDecryptor.java

@@ -16,11 +16,12 @@
 import java.util.regex.Pattern;
 import java.util.stream.Stream;
 
+import static org.cryptomator.cryptofs.common.Constants.BASE64_PATTERN;
+
 @DirectoryStreamScoped
 class C9rDecryptor {
 
 	// visible for testing:
-	static final Pattern BASE64_PATTERN = Pattern.compile("[a-zA-Z0-9-_]{20}(?:[a-zA-Z0-9-_]{4})*(?:[a-zA-Z0-9-_]{4}|[a-zA-Z0-9-_]{3}=|[a-zA-Z0-9-_]{2}==)");
 	private static final CharMatcher DELIM_MATCHER = CharMatcher.anyOf("_-");
 
 	private final Cryptor cryptor;

src/main/java/org/cryptomator/cryptofs/dir/C9uConflictResolver.java

@@ -0,0 +1,57 @@
+package org.cryptomator.cryptofs.dir;
+
+import jakarta.inject.Inject;
+import org.cryptomator.cryptofs.common.Constants;
+import org.cryptomator.cryptofs.common.StringUtils;
+import org.cryptomator.cryptofs.inuse.InUseManager;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.regex.Matcher;
+import java.util.stream.Stream;
+
+import static org.cryptomator.cryptofs.common.Constants.BASE64_PATTERN;
+
+/**
+ * Resolves in-use file conflicts.
+ */
+@DirectoryStreamScoped
+public class C9uConflictResolver {
+
+	private static final Logger LOG = LoggerFactory.getLogger(C9uConflictResolver.class);
+
+
+	private final InUseManager inUseManager;
+
+	@Inject
+	public C9uConflictResolver(InUseManager inUseManager) {
+		this.inUseManager = inUseManager;
+	}
+
+	/**
+	 * Processes files with {@value Constants#INUSE_FILE_SUFFIX} file extension. (in-use files)
+	 * <p>
+	 * If the in-use file is not valid bas64 encoding, delete the file.
+	 *
+	 * @param node
+	 * @return an empty stream.
+	 */
+	Stream<Node> process(Node node) {
+		String basename = StringUtils.removeEnd(node.fullCiphertextFileName, Constants.INUSE_FILE_SUFFIX);
+		Matcher matcher = BASE64_PATTERN.matcher(basename);
+		matcher.region(0, basename.length());
+		if (!matcher.matches()) { //any rename is considered bad
+			//TODO: close UseToken (if existent)
+			LOG.debug("Found renamed in-use-file {}. Deleting it.", node.ciphertextPath);
+			try {
+				Files.deleteIfExists(node.ciphertextPath);
+			} catch (IOException e) {
+				LOG.debug("Failed to delete in-use-file {}. Retry on next directory listing.", node.ciphertextPath);
+			}
+		}
+		return Stream.empty();
+	}
+
+}

src/main/java/org/cryptomator/cryptofs/dir/C9uProcessor.java

@@ -0,0 +1,24 @@
+package org.cryptomator.cryptofs.dir;
+
+import jakarta.inject.Inject;
+import org.cryptomator.cryptofs.common.Constants;
+
+import java.util.stream.Stream;
+
+/**
+ * Processes in-use files (file extension {@value Constants#INUSE_FILE_SUFFIX}.
+ */
+@DirectoryStreamScoped
+public class C9uProcessor {
+
+	private final C9uConflictResolver conflictRemover;
+
+	@Inject
+	public C9uProcessor(C9uConflictResolver conflictRemover) {
+		this.conflictRemover = conflictRemover;
+	}
+
+	public Stream<Node> process(Node node) {
+		return conflictRemover.process(node);
+	}
+}

src/main/java/org/cryptomator/cryptofs/dir/NodeProcessor.java

@@ -10,12 +10,14 @@ class NodeProcessor {
 
 	private final C9rProcessor c9rProcessor;
 	private final C9sProcessor c9sProcessor;
+	private final C9uProcessor c9uProcessor;
 	private final BrokenDirectoryFilter brokenDirFilter;
 
 	@Inject
-	public NodeProcessor(C9rProcessor c9rProcessor, C9sProcessor c9sProcessor, BrokenDirectoryFilter brokenDirFilter){
+	public NodeProcessor(C9rProcessor c9rProcessor, C9sProcessor c9sProcessor, C9uProcessor c9uProcessor, BrokenDirectoryFilter brokenDirFilter){
 		this.c9rProcessor = c9rProcessor;
 		this.c9sProcessor = c9sProcessor;
+		this.c9uProcessor = c9uProcessor;
 		this.brokenDirFilter = brokenDirFilter;
 	}
 
@@ -24,6 +26,8 @@ public Stream<Node> process(Node node) {
 			return c9rProcessor.process(node).flatMap(brokenDirFilter::process);
 		} else if (node.fullCiphertextFileName.endsWith(Constants.DEFLATED_FILE_SUFFIX)) {
 			return c9sProcessor.process(node).flatMap(brokenDirFilter::process);
+		} else if (node.fullCiphertextFileName.endsWith(Constants.INUSE_FILE_SUFFIX)) {
+			return c9uProcessor.process(node).flatMap(brokenDirFilter::process);
 		} else {
 			return Stream.empty();
 		}

src/test/java/org/cryptomator/cryptofs/dir/C9rDecryptorTest.java

@@ -1,5 +1,6 @@
 package org.cryptomator.cryptofs.dir;
 
+import org.cryptomator.cryptofs.common.Constants;
 import org.cryptomator.cryptolib.api.AuthenticationFailedException;
 import org.cryptomator.cryptolib.api.Cryptor;
 import org.cryptomator.cryptolib.api.FileNameCryptor;
@@ -38,7 +39,7 @@ public void setup() {
 			"aaaaBBBBccccDDDDeeeeFFFFggggHH==",
 	})
 	public void testValidBase64Pattern(String input) {
-		Assertions.assertTrue(C9rDecryptor.BASE64_PATTERN.matcher(input).matches());
+		Assertions.assertTrue(Constants.BASE64_PATTERN.matcher(input).matches());
 	}
 
 	@ParameterizedTest
@@ -53,7 +54,7 @@ public void testValidBase64Pattern(String input) {
 			"aaaaBBBBccccDDDDeeeeFFFF conflict", // only a partial match
 	})
 	public void testInvalidBase64Pattern(String input) {
-		Assertions.assertFalse(C9rDecryptor.BASE64_PATTERN.matcher(input).matches());
+		Assertions.assertFalse(Constants.BASE64_PATTERN.matcher(input).matches());
 	}
 
 	@Test

src/test/java/org/cryptomator/cryptofs/dir/C9uConflictResolverTest.java

@@ -0,0 +1,52 @@
+package org.cryptomator.cryptofs.dir;
+
+import org.cryptomator.cryptofs.common.Constants;
+import org.cryptomator.cryptofs.inuse.InUseManager;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import static org.mockito.Mockito.mock;
+
+public class C9uConflictResolverTest {
+
+	C9uConflictResolver c9uConflictResolver;
+
+	@BeforeEach
+	void beforeEach() {
+		var inUseManager = mock(InUseManager.class);
+		c9uConflictResolver = new C9uConflictResolver(inUseManager);
+	}
+
+	@Test
+	@DisplayName("If filename is valid base64, the file exists")
+	void validBase64KeepsExisting(@TempDir Path tmpDir) throws IOException {
+		var ciphertextPath = tmpDir.resolve("aaaaBBBBccccDDDDeeeeFFFFggggHH=="+ Constants.INUSE_FILE_SUFFIX);
+		Files.createFile(ciphertextPath);
+		var node = new Node(ciphertextPath);
+
+		var result = c9uConflictResolver.process(node);
+
+		Assertions.assertEquals(0, result.count());
+		Assertions.assertTrue(Files.exists(ciphertextPath));
+	}
+
+	@Test
+	@DisplayName("If filename is NOT valid base64, the file is deleted")
+	void InvalidBase64Deleted(@TempDir Path tmpDir) throws IOException {
+		var ciphertextPath = tmpDir.resolve("aaaaBBBBccccDDDDeeeeFFFFggggHH== (conflicted copy)"+ Constants.INUSE_FILE_SUFFIX);
+		Files.createFile(ciphertextPath);
+		var node = new Node(ciphertextPath);
+
+		var result = c9uConflictResolver.process(node);
+
+		Assertions.assertEquals(0, result.count());
+		Assertions.assertTrue(Files.notExists(ciphertextPath));
+	}
+}