Feature: Files-in-Use #312
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,14 +11,19 @@ | |||||
| import org.cryptomator.cryptofs.attr.AttributeViewComponent; | ||||||
| import org.cryptomator.cryptofs.dir.DirectoryStreamComponent; | ||||||
| import org.cryptomator.cryptofs.event.FilesystemEvent; | ||||||
| import org.cryptomator.cryptofs.inuse.StubInUseManager; | ||||||
| import org.cryptomator.cryptofs.inuse.InUseManager; | ||||||
| import org.cryptomator.cryptofs.fh.OpenCryptoFileComponent; | ||||||
| import org.cryptomator.cryptofs.inuse.RealInUseManager; | ||||||
| import org.cryptomator.cryptolib.api.Cryptor; | ||||||
| import org.slf4j.Logger; | ||||||
| import org.slf4j.LoggerFactory; | ||||||
|
|
||||||
| import java.io.IOException; | ||||||
| import java.nio.file.FileStore; | ||||||
| import java.nio.file.Files; | ||||||
| import java.nio.file.Path; | ||||||
| import java.util.Objects; | ||||||
| import java.util.Optional; | ||||||
| import java.util.function.Consumer; | ||||||
|
|
||||||
|
|
@@ -50,4 +55,16 @@ public Consumer<FilesystemEvent> provideFilesystemEventConsumer(CryptoFileSystem | |||||
| } | ||||||
| }; | ||||||
| } | ||||||
|
|
||||||
| @Provides | ||||||
| @CryptoFileSystemScoped | ||||||
| public InUseManager provideInUseManager(CryptoFileSystemProperties fsProps, Cryptor cryptor) { | ||||||
| var owner = Objects.requireNonNullElse(fsProps.owner(),""); | ||||||
|
There was a problem hiding this comment. Missing space after comma in
Suggested change
|
||||||
| if(!owner.isBlank() && !fsProps.readonly()) { | ||||||
| return new RealInUseManager(owner, cryptor); | ||||||
| } else { | ||||||
| return new StubInUseManager(); | ||||||
| } | ||||||
|
|
||||||
| } | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -115,6 +115,14 @@ public enum FileSystemFlags { | |
|
|
||
| static final CryptorProvider.Scheme DEFAULT_CIPHER_COMBO = CryptorProvider.Scheme.SIV_GCM; | ||
|
|
||
| /** | ||
| * Key identifying the filesystem owner. | ||
| * | ||
| * @since 2.10.0 | ||
| */ | ||
| public static final String PROPERTY_OWNER = "owner"; | ||
| static final String DEFAULT_OWNER = ""; | ||
|
|
||
| private final Set<Entry<String, Object>> entries; | ||
|
|
||
| private CryptoFileSystemProperties(Builder builder) { | ||
|
|
@@ -126,7 +134,8 @@ private CryptoFileSystemProperties(Builder builder) { | |
| Map.entry(PROPERTY_EVENT_CONSUMER, builder.eventConsumer), // | ||
| Map.entry(PROPERTY_MAX_CLEARTEXT_NAME_LENGTH, builder.maxCleartextNameLength), // | ||
| Map.entry(PROPERTY_SHORTENING_THRESHOLD, builder.shorteningThreshold), // | ||
| Map.entry(PROPERTY_CIPHER_COMBO, builder.cipherCombo), // | ||
| Map.entry(PROPERTY_OWNER, builder.owner) // | ||
| ); | ||
| } | ||
|
|
||
|
|
@@ -169,6 +178,10 @@ Consumer<FilesystemEvent> filesystemEventConsumer() { | |
| return (Consumer<FilesystemEvent>) get(PROPERTY_EVENT_CONSUMER); | ||
| } | ||
|
|
||
| String owner() { | ||
| return (String) get(PROPERTY_OWNER); | ||
| } | ||
|
|
||
| @Override | ||
| public Set<Entry<String, Object>> entrySet() { | ||
| return entries; | ||
|
|
@@ -225,6 +238,7 @@ public static class Builder { | |
| private int maxCleartextNameLength = DEFAULT_MAX_CLEARTEXT_NAME_LENGTH; | ||
| private int shorteningThreshold = DEFAULT_SHORTENING_THRESHOLD; | ||
| private Consumer<FilesystemEvent> eventConsumer = DEFAULT_EVENT_CONSUMER; | ||
| private String owner = DEFAULT_OWNER; | ||
|
|
||
| private Builder() { | ||
| } | ||
|
|
@@ -238,6 +252,7 @@ private Builder(Map<String, ?> properties) { | |
| checkedSet(Integer.class, PROPERTY_SHORTENING_THRESHOLD, properties, this::withShorteningThreshold); | ||
| checkedSet(CryptorProvider.Scheme.class, PROPERTY_CIPHER_COMBO, properties, this::withCipherCombo); | ||
| checkedSet(Consumer.class, PROPERTY_EVENT_CONSUMER, properties, this::withFilesystemEventConsumer); | ||
| checkedSet(String.class, PROPERTY_OWNER, properties, this::withOwner); | ||
| } | ||
|
|
||
| private <T> void checkedSet(Class<T> type, String key, Map<String, ?> properties, Consumer<T> setter) { | ||
|
|
@@ -367,6 +382,23 @@ public Builder withFilesystemEventConsumer(Consumer<FilesystemEvent> eventConsum | |
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the owner of the filesystem. | ||
| * <p> | ||
| * The owners length must be less than or equal to 100. | ||
| * | ||
| * @param owner the owner string used when marking files in-use | ||
| * @return this | ||
| * @since 2.10.0 | ||
| */ | ||
| public Builder withOwner(String owner) { | ||
| if (owner.length() > 100) { | ||
| throw new IllegalArgumentException("owner must have length less than or equal to 100"); | ||
| } | ||
| this.owner = owner; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Validates the values and creates new {@link CryptoFileSystemProperties}. | ||
| * | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,14 +2,12 @@ | |
|
|
||
| import jakarta.inject.Inject; | ||
| import org.cryptomator.cryptofs.common.Constants; | ||
| import org.cryptomator.cryptofs.common.EncryptedChannels; | ||
| import org.cryptomator.cryptolib.api.CryptoException; | ||
| import org.cryptomator.cryptolib.api.Cryptor; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.ByteBuffer; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
|
|
@@ -38,7 +36,7 @@ public DirectoryIdBackup(Cryptor cryptor) { | |
| */ | ||
| public void write(CiphertextDirectory ciphertextDirectory) throws IOException { | ||
| try (var channel = Files.newByteChannel(getBackupFilePath(ciphertextDirectory.path()), StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE); // | ||
| var encryptingChannel = EncryptedChannels.wrapEncryptionAround(channel, cryptor)) { | ||
| encryptingChannel.write(ByteBuffer.wrap(ciphertextDirectory.dirId().getBytes(StandardCharsets.US_ASCII))); | ||
| } | ||
| } | ||
|
|
@@ -72,7 +70,7 @@ public byte[] read(Path ciphertextContentDir) throws IOException, CryptoExceptio | |
| var dirIdBuffer = ByteBuffer.allocate(Constants.MAX_DIR_ID_LENGTH + 1); //a dir id contains at most 36 ascii chars, we add for security checks one more | ||
|
|
||
| try (var channel = Files.newByteChannel(dirIdBackupFile, StandardOpenOption.READ); // | ||
| var decryptingChannel = EncryptedChannels.wrapDecryptionAround(channel, cryptor)) { | ||
| int read = decryptingChannel.read(dirIdBuffer); | ||
| if (read < 0 || read > Constants.MAX_DIR_ID_LENGTH) { | ||
| throw new IllegalStateException("Read directory id exceeds the maximum length of %d characters".formatted(Constants.MAX_DIR_ID_LENGTH)); | ||
|
|
@@ -103,11 +101,4 @@ private static Path getBackupFilePath(Path ciphertextContentDir) { | |
| return ciphertextContentDir.resolve(Constants.DIR_ID_BACKUP_FILE_NAME); | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| package org.cryptomator.cryptofs.common; | ||
|
|
||
| import com.github.benmanes.caffeine.cache.Cache; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.UncheckedIOException; | ||
|
|
||
| public abstract class CacheUtils { | ||
|
|
||
| private CacheUtils() {} | ||
|
|
||
| /** | ||
| * Helper function for caches with IO loading functions. | ||
| * <p> | ||
| * This method implements the famous workaround for (checked) IOExceptions in cache loading functions: | ||
| * {@code | ||
| * try { | ||
| * cache.get(key, k -> { | ||
| * try { | ||
| * return functionThrowingIOException(k) | ||
| * } catch (IOException e) { | ||
| * throw UncheckedIOException(e); | ||
| * } | ||
| * } | ||
| * } catch (UncheckedIOException e) { | ||
| * throw e.getCause() | ||
| * } | ||
| * } | ||
| * | ||
| * @param key The key to load from the cache | ||
| * @param cache The cache to get the value | ||
| * @param loadFunction The load function which can throw an IOException | ||
| * @return the cached value or null, if the loading function returns it. | ||
| * @param <K> The type of keys used in the cache | ||
| * @param <V> the type of values used in the cache | ||
| * @throws IOException if the loading function throws an IOException | ||
| */ | ||
| public static <K, V> V getWithIOWrapped(K key, Cache<K, V> cache, IOFunction<K, V> loadFunction) throws IOException { | ||
| try { | ||
| return cache.get(key, k -> { | ||
| try { | ||
| return loadFunction.apply(k); | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| } | ||
| }); | ||
| } catch (UncheckedIOException e) { | ||
| throw e.getCause(); | ||
| } | ||
| } | ||
infeo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| @FunctionalInterface | ||
| public interface IOFunction<T, R> { | ||
|
|
||
| R apply(T t) throws IOException; | ||
|
There was a problem hiding this comment. The parameter 't' is never used. |
||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This TODO suggests an optimization: usage checks should be skipped when no owner is configured. This would prevent unnecessary work when the in-use feature is disabled.