Implementing the "Easy"-Dokan-API

README.md

@@ -75,6 +75,15 @@ To publish to your local Maven repository, execute as the third step `./gradlew.
 ## Examples
 An example user filesystems using this library can be found in the examples package [dev.dokan.dokan_java.examples](https://github.com/dokan-dev/dokan-java/tree/develop/src/main/java/dev/dokan/dokan_java/examples).
 
+## Versioning
+Dokan-Java uses it's own versioning system and therefore doesn't match the versions of Dokany.
+For Dokan-Java to work you need to have a suitable version of Dokany installed on your machine. The following table helps you choose the correct Dokany-version.
+
+| Dokan-Java Version | Minimum Version of Dokany |
+|--------------------|---------------------------|
+| 1.0.0 - 1.1.X      | 1.2.0.1000                |
+| 1.2.0+             | 1.3.0.1000                |
+
 ## Contributing
 You're encouraged to contribute.
  Fork the code and then submit a pull request.

src/main/java/dev/dokan/dokan_java/AbstractDokanFileSystem.java

@@ -157,7 +157,7 @@ private void init(DokanOperations dokanOperations) {
 		}
 	}
 
-	private boolean isImplemented(String funcName) {
+	public boolean isImplemented(String funcName) {
 		return !notImplementedMethods.contains(funcName);
 	}
 

src/main/java/dev/dokan/dokan_java/DokanUtils.java

@@ -4,6 +4,7 @@
 import com.sun.jna.platform.win32.WinNT;
 import dev.dokan.dokan_java.constants.microsoft.CreationDisposition;
 
+import java.nio.file.attribute.FileTime;
 import java.util.Date;
 
 import static dev.dokan.dokan_java.constants.microsoft.CreateDispositions.*;
@@ -38,6 +39,10 @@ public static String trimStrToSize(final String str, final int len) {
         return str.substring(0, Math.min(str.length(), len));
     }
 
+    public static FILETIME toFILETIME(final FileTime time) {
+        return getTime(time.toMillis());
+    }
+
     public static FILETIME getTime(final Date date) {
         return new FILETIME(date);
     }

src/main/java/dev/dokan/dokan_java/NativeName.java

@@ -0,0 +1,15 @@
+package dev.dokan.dokan_java;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.METHOD;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(value = METHOD)
+public @interface NativeName {
+
+	String value();
+
+}

src/main/java/dev/dokan/dokan_java/constants/dokan_java/DefaultFileTimePolicy.java

@@ -0,0 +1,10 @@
+package dev.dokan.dokan_java.constants.dokan_java;
+
+public enum DefaultFileTimePolicy {
+
+	STATIC_YEAR_1601,
+	STATIC_YEAR_1970,
+	INHERIT_ELSE_1601,
+	INHERIT_ELSE_1970
+
+}

src/main/java/dev/dokan/dokan_java/constants/dokany/DokanFileInfoFlag.java

@@ -0,0 +1,30 @@
+package dev.dokan.dokan_java.constants.dokany;
+
+
+import dev.dokan.dokan_java.masking.MaskValueEnum;
+import dev.dokan.dokan_java.masking.MaskValueSet;
+
+public enum DokanFileInfoFlag implements MaskValueEnum {
+
+	DELETE_ON_CLOSE(1),
+	IS_DIRECTORY(2),
+	NO_CACHE(4),
+	PAGING_IO(8),
+	SYNCHRONOUS_IO(16),
+	WRITE_TO_END_OF_FILE(32);
+
+	private final int maskingValue;
+
+	DokanFileInfoFlag(int maskingValue) {
+		this.maskingValue = maskingValue;
+	}
+
+	public static MaskValueSet<DokanFileInfoFlag> maskValueSet(final int mask) {
+		return MaskValueSet.maskValueSet(mask, values());
+	}
+
+	@Override
+	public int intValue() {
+		return this.maskingValue;
+	}
+}

src/main/java/dev/dokan/dokan_java/constants/microsoft/FileShareAccess.java

@@ -0,0 +1,27 @@
+package dev.dokan.dokan_java.constants.microsoft;
+
+
+import dev.dokan.dokan_java.masking.MaskValueEnum;
+import dev.dokan.dokan_java.masking.MaskValueSet;
+
+public enum FileShareAccess implements MaskValueEnum {
+
+	FILE_SHARE_READ(1),
+	FILE_SHARE_WRITE(2),
+	FILE_SHARE_DELETE(4);
+
+	private final int maskingValue;
+
+	FileShareAccess(int maskingValue) {
+		this.maskingValue = maskingValue;
+	}
+
+	public static MaskValueSet<FileShareAccess> maskValueSet(final int mask) {
+		return MaskValueSet.maskValueSet(mask, values());
+	}
+
+	@Override
+	public int intValue() {
+		return this.maskingValue;
+	}
+}

src/main/java/dev/dokan/dokan_java/constants/microsoft/MicrosoftReparsePointTag.java

@@ -0,0 +1,49 @@
+package dev.dokan.dokan_java.constants.microsoft;
+
+
+import dev.dokan.dokan_java.masking.EnumInteger;
+import dev.dokan.dokan_java.structure.ReparsePointTag;
+
+
+public enum MicrosoftReparsePointTag implements ReparsePointTag {
+
+	IO_REPARSE_TAG_CSV(0x80000009),
+	IO_REPARSE_TAG_DEDUP(0x80000013),
+	IO_REPARSE_TAG_DFS(0x8000000A),
+	IO_REPARSE_TAG_DFSR(0x80000012),
+	IO_REPARSE_TAG_HSM(0xC0000004),
+	IO_REPARSE_TAG_HSM2(0x80000006),
+	IO_REPARSE_TAG_MOUNT_POINT(0xA0000003),
+	IO_REPARSE_TAG_NFS(0x80000014),
+	IO_REPARSE_TAG_SIS(0x80000007),
+	IO_REPARSE_TAG_SYMLINK(0xA000000C),
+	IO_REPARSE_TAG_WIM(0x80000008);
+
+	private static final String SOURCE = "WinNT.h";
+	private static final String DEFINED_BY = "Microsoft";
+
+	private final int intValue;
+
+	MicrosoftReparsePointTag(int intValue) {
+		this.intValue = intValue;
+	}
+
+	public static MicrosoftReparsePointTag fromInt(final int value) {
+		return EnumInteger.enumFromInt(value, values());
+	}
+
+	@Override
+	public int intValue() {
+		return this.intValue;
+	}
+
+	@Override
+	public String getSource() {
+		return SOURCE;
+	}
+
+	@Override
+	public String getDefinedBy() {
+		return DEFINED_BY;
+	}
+}

src/main/java/dev/dokan/dokan_java/structure/DokanOptions.java

@@ -79,9 +79,13 @@ public DokanOptions() {
 	}
 
 	public DokanOptions(String mountPoint, @Unsigned short threadCount, MaskValueSet<MountOption> mountOptions, String uncName, @Unsigned int timeout, @Unsigned int allocationUnitSize, @Unsigned int sectorSize) {
+		this(mountPoint, threadCount, mountOptions.intValue(), uncName, timeout, allocationUnitSize, sectorSize);
+	}
+
+	public DokanOptions(String mountPoint, @Unsigned short threadCount, @Unsigned int mountOptions, String uncName, @Unsigned int timeout, @Unsigned int allocationUnitSize, @Unsigned int sectorSize) {
 		MountPoint = new WString(mountPoint);
 		ThreadCount = threadCount;
-		Options = mountOptions.intValue();
+		Options = mountOptions;
 		if (uncName != null) {
 			UNCName = new WString(uncName);
 		} else {

src/main/java/dev/dokan/dokan_java/structure/ReparsePointTag.java

@@ -0,0 +1,13 @@
+package dev.dokan.dokan_java.structure;
+
+
+import dev.dokan.dokan_java.masking.EnumInteger;
+
+
+public interface ReparsePointTag extends EnumInteger {
+
+    String getSource();
+
+    String getDefinedBy();
+
+}

src/main/java/dev/dokan/dokan_java/wrappers/AbstractEasyDokanFileSystem.java

@@ -0,0 +1,69 @@
+package dev.dokan.dokan_java.wrappers;
+
+import dev.dokan.dokan_java.NativeName;
+import dev.dokan.dokan_java.FileSystemInformation;
+import dev.dokan.dokan_java.NotImplemented;
+
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Method;
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+public abstract class AbstractEasyDokanFileSystem implements EasyDokanFileSystem {
+
+	private final Set<String> notImplementedMethods;
+	private final ForwardingFileSystem lowLevelFS;
+
+	public AbstractEasyDokanFileSystem(FileSystemInformation fileSystemInformation) {
+		this.notImplementedMethods = Arrays.stream(getClass().getMethods())
+			.filter(method -> method.getAnnotation(NotImplemented.class) != null)
+			.map((method) -> getNativeName(method))
+			.collect(Collectors.toSet());
+
+		this.lowLevelFS = new ForwardingFileSystem(fileSystemInformation, this.notImplementedMethods, this);
+	}
+
+	private String getNativeName(Method method) {
+		Method annotated = getAnnotatedMethod(NativeName.class, method);
+
+		if(annotated == null) {
+			return method.getName();
+		}
+		return annotated.getAnnotation(NativeName.class).value();
+	}
+
+	private Method getAnnotatedMethod(Class<? extends Annotation> annotation, Method method) {
+		return getAnnotatedMethod(annotation, method.getDeclaringClass(), method.getName(), method.getParameterTypes());
+	}
+
+	private Method getAnnotatedMethod(Class<? extends Annotation> annotation,
+		Class<?> inClass,
+		String methodName,
+		Class<?>... parameterTypes) {
+
+		Method result;
+		try {
+			result = inClass.getMethod(methodName, parameterTypes);
+		} catch(NoSuchMethodException e) {
+			return null;
+		}
+
+		if(result.isAnnotationPresent(annotation)) {
+			return result;
+		}
+
+		Class<?> superClass = inClass.getSuperclass();
+		if(superClass != null) {
+			result = getAnnotatedMethod(annotation, superClass, methodName, parameterTypes);
+		}
+
+		if(result != null) {
+			return result;
+		}
+
+		return Arrays.stream(inClass.getInterfaces())
+			.map((cInterface) -> getAnnotatedMethod(annotation, cInterface, methodName, parameterTypes))
+			.findFirst().orElse(null);
+	}
+}