Merge branch 'feature/#34-compatibility' into develop

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

@@ -290,7 +290,7 @@ public void mount(Path mountPoint, EnumIntegerSet<MountOption> mountOptions) {
     }
 
     private int execMount(DokanOptions dokanOptions) {
-        return NativeMethods.DokanMain(dokanOptions, this.dokanyOperations);
+        return DokanNativeMethods.DokanMain(dokanOptions, this.dokanyOperations);
     }
 
     @Override
@@ -300,7 +300,7 @@ public final synchronized void unmount() {
         }
 
         if (isMounted.get()) {
-            if (NativeMethods.DokanRemoveMountPoint(new WString(mountPoint.toAbsolutePath().toString()))) {
+            if (DokanNativeMethods.DokanRemoveMountPoint(new WString(mountPoint.toAbsolutePath().toString()))) {
                 isMounted.set(false);
             } else {
                 throw new UnmountFailedException("Unmount of " + volumeName + "(" + mountPoint + ") failed. Try again, shut down JVM or use `dokanctl.exe to unmount manually.");
@@ -311,13 +311,13 @@ public final synchronized void unmount() {
     private boolean volumeIsStillMounted() {
         char[] mntPtCharArray = mountPoint.toAbsolutePath().toString().toCharArray();
         LongByReference length = new LongByReference();
-        Pointer startOfList = NativeMethods.DokanGetMountPointList(false, length);
+        Pointer startOfList = DokanNativeMethods.DokanGetMountPointList(false, length);
         List<DokanControl> list = DokanControl.getDokanControlList(startOfList, length.getValue());
         // It is not enough that the entry.MountPoint contains the actual mount point. It also has to ends afterwards.
         boolean mountPointInList = list.stream().anyMatch(entry ->
                 Arrays.equals(entry.MountPoint, 12, 12 + mntPtCharArray.length, mntPtCharArray, 0, mntPtCharArray.length)
                         && (entry.MountPoint.length == 12 + mntPtCharArray.length || entry.MountPoint[12 + mntPtCharArray.length] == '\0'));
-        NativeMethods.DokanReleaseMountPointList(startOfList);
+        DokanNativeMethods.DokanReleaseMountPointList(startOfList);
         return mountPointInList;
     }
 

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

@@ -0,0 +1,276 @@
+package dev.dokan.dokan_java;
+
+
+import com.sun.jna.Native;
+import com.sun.jna.Pointer;
+import com.sun.jna.WString;
+import com.sun.jna.platform.win32.WinNT;
+import com.sun.jna.ptr.IntByReference;
+import com.sun.jna.ptr.LongByReference;
+import com.sun.jna.win32.StdCallLibrary;
+import dev.dokan.dokan_java.constants.dokany.MountError;
+import dev.dokan.dokan_java.structure.DokanControl;
+import dev.dokan.dokan_java.structure.DokanFileInfo;
+import dev.dokan.dokan_java.structure.DokanOptions;
+
+
+/**
+ * Native API to the kernel Dokan driver.
+ */
+public class DokanNativeMethods implements StdCallLibrary {
+
+	private static final String DOKAN_DLL = "dokan1";
+
+	private static final short MINIMUM_REQUIRED_DOKAN_VERSION = 130;
+
+
+	static {
+		Native.register(DOKAN_DLL);
+	}
+
+	private DokanNativeMethods() {
+
+	}
+
+	/**
+	 * Returns the hard coded minimum required dokan driver version that is needed by this library.
+	 * <p>
+	 * The version is returned in "Dokan" style, i.e. without any dots.
+	 *
+	 * @return the minimum required dokan version without dots.
+	 */
+	public static short getMinimumRequiredDokanVersion() {
+		return MINIMUM_REQUIRED_DOKAN_VERSION;
+	}
+
+	/**
+	 * Mount a new Dokan Volume. This function blocks until the device is unmounted.
+	 * If the mount fails, it will directly return {@link MountError}.
+	 *
+	 * @param options A {@link DokanOptions} object that describes the mount.
+	 * @param operations Instance of {@link DokanyOperations} that will be called for each file system request made by the kernel.
+	 * @return a status code indicating the outcome. For the possible values, see {@link MountError}.
+	 */
+	static native int DokanMain(DokanOptions options, DokanyOperations operations);
+
+	/**
+	 * Get the version of Dokan.
+	 *
+	 * <p>The returned long value is the version number without the dots.</p>
+	 *
+	 * @return The version of Dokan
+	 */
+	static native long DokanVersion();
+
+	/**
+	 * Get the version of the Dokan driver.
+	 *
+	 * <p>The returned long value is the version number without the dots.</p>
+	 *
+	 * @return The version of Dokan driver.
+	 */
+	static native long DokanDriverVersion();
+
+	/**
+	 * Unmount a Dokan device from a driver letter.
+	 *
+	 * @param driveLetter Driver letter to unmount.
+	 * @return {@code true} if device was unmounted or {@code false} in case of failure or device not found.
+	 */
+	static native boolean DokanUnmount(char driveLetter);
+
+	/**
+	 * Unmount a Dokan device from a mount point
+	 *
+	 * @param mountPoint Mount point to unmount
+	 * <ul>
+	 * <li>Z</li>
+	 * <li>Z:</li>
+	 * <li>Z:\\</li>
+	 * <li>Z:\MyMountPoint</li>
+	 * </ul>
+	 * @return {@code true} if device was unmounted or {@code false} in case of failure or device not found.
+	 */
+	static native boolean DokanRemoveMountPoint(WString mountPoint);
+
+
+	/**
+	 * TODO: Does not work. Why?
+	 * static native boolean DokanRemoveMountPointEx(WString mountPoint, boolean safe);
+	 */
+
+	/**
+	 * Extends the time out of the current IO operation in driver.
+	 *
+	 * @param timeout Extended time in milliseconds requested.
+	 * @param dokanFileInfo {@link DokanFileInfo} of the operation to extend.
+	 * @return {@code true} if the operation was successful, otherwise false.
+	 */
+	static native boolean DokanResetTimeout(long timeout, DokanFileInfo dokanFileInfo);
+
+	/**
+	 * Get the handle to Access Token.
+	 *
+	 * <p>
+	 * This method needs be called in <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa363858(v=vs.85).aspx">CreateFile</a> callback.
+	 * The caller must call <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms724211(v=vs.85).aspx">CloseHandle</a> for the returned handle.
+	 * </p>
+	 *
+	 * @param dokanFileInfo {@link DokanFileInfo} of the operation to extend.
+	 * @return A handle to the account token for the user on whose behalf the code is running.
+	 */
+	static native WinNT.HANDLE DokanOpenRequestorToken(DokanFileInfo dokanFileInfo);
+
+	/**
+	 * Convert {@link DokanyOperations.ZwCreateFile} parameters to CreateFile parameters.
+	 * TODO: Improve documentation
+	 *
+	 * @param desiredAccess
+	 * @param fileAttributes FileAttributes
+	 * @param createOptions CreateOptions
+	 * @param createDisposition CreateDisposition
+	 * @param genericDesiredAccess
+	 * @param outFileAttributesAndFlags
+	 * @param outCreationDisposition
+	 */
+	static native void DokanMapKernelToUserCreateFileFlags(
+			long desiredAccess,
+			long fileAttributes,
+			long createOptions,
+			long createDisposition,
+			IntByReference genericDesiredAccess,
+			IntByReference outFileAttributesAndFlags,
+			IntByReference outCreationDisposition);
+
+	/**
+	 * Checks whether name  matches Expression.
+	 * <p>
+	 * Behave like FsRtlIsNameInExpression routine from <a href="https://msdn.microsoft.com/en-us/library/ff546850(v=VS.85).aspx">Microsoft</a>\n
+	 * </p>
+	 * <table class="striped">
+	 * <caption style="display:none">Special character handling</caption>
+	 * <thead>
+	 * <tr>
+	 * <th scope="col">Character</th>
+	 * <th scope="col">Character description</th>
+	 * <th scope="col">Effect</th>
+	 * </tr>
+	 * </thead>
+	 * <tbody>
+	 * <tr>
+	 * <td>*</th>
+	 * <td>asterisk</th>
+	 * <td>Matches zero or more characters.</td>
+	 * </tr>
+	 * <tr>
+	 * <td>?</th>
+	 * <td>question mark</th>
+	 * <td>Matches a single character.</td>
+	 * </tr>
+	 * <tr>
+	 * <td>"</th>
+	 * <td>quotation mark, DOS_DOT</th>
+	 * <td>Matches either a period or zero characters beyond the name string.</td>
+	 * </tr>
+	 * <tr>
+	 * <td>{@literal >}</th>
+	 * <td>greater than, DOS_QM</th>
+	 * <td>Matches any single character or, upon encountering a period or end of name string, advances the expression to the end of the set of contiguous DOS_QMs.</td>
+	 * </tr>
+	 * <tr>
+	 * <td>{@literal <}</th>
+	 * <td>less than, DOS_STAR</th>
+	 * <td>Matches zero or more characters until encountering and matching the final . in the name.</td>
+	 * </tr>
+	 * </tbody>
+	 * </table>
+	 *
+	 * @param expression - Expression, possibly containing any of the above characters
+	 * @param name - Name to check
+	 * @param ignoreCase - Case sensitive or not
+	 * @return {@code true} if name matches the expression, otherwise false
+	 */
+	static native boolean DokanIsNameInExpression(WString expression, WString name, boolean ignoreCase);
+
+	/**
+	 * Get active Dokan mount points.
+	 *
+	 * <p>
+	 * Returned array need to be released by calling {@link #DokanReleaseMountPointList}.
+	 * </p>
+	 *
+	 * @param uncOnly - Get only instances that have UNC Name.
+	 * @param nbRead - Number of instances successfully retrieved
+	 * @return a pointer to the start of the allocated array of {@link DokanControl} elemets.
+	 */
+	static native Pointer DokanGetMountPointList(boolean uncOnly, LongByReference nbRead);
+
+	/**
+	 * Release Mount point list resources from {@link #DokanGetMountPointList}.
+	 *
+	 * <p>
+	 * After {@link #DokanGetMountPointList} call you will receive a dynamically allocated array of {@link DokanControl}.
+	 * This array needs to be released when no longer needed by calling this function.
+	 * </p>
+	 *
+	 * @param startOfList Pointer to the start of the {@link DokanControl} list.
+	 */
+	static native void DokanReleaseMountPointList(Pointer startOfList);
+
+	/**
+	 * Convert Win32 error to NtStatus
+	 *
+	 * @param error - Win32 error to convert
+	 * @return NtStatus associated to the error
+	 * @see <a href="https://support.microsoft.com/en-us/kb/113996">kb113996</a>
+	 */
+	static native long DokanNtStatusFromWin32(int error);
+
+	/**
+	 * Notify Dokan that a file or a directory has been created.
+	 *
+	 * @param FilePath Absolute path to the file or directory, including the mount-point of the file system.
+	 * @param IsDirectory Indicates if the path is a directory.
+	 * @return {@code true} if notification succeeded.
+	 */
+	static native boolean DokanNotifyCreate(WString FilePath, boolean IsDirectory);
+
+	/**
+	 * Notify Dokan that a file or a directory has been deleted.
+	 *
+	 * @param FilePath Absolute path to the file or directory, including the mount-point of the file system.
+	 * @param IsDirectory Indicates if the path was a directory.
+	 * @return {@code true} if notification succeeded.
+	 */
+	static native boolean DokanNotifyDelete(WString FilePath, boolean IsDirectory);
+
+	/**
+	 * Notify Dokan that file or directory attributes have changed.
+	 *
+	 * @param FilePath Absolute path to the file or directory, including the mount-point of the file system.
+	 * @return {@code true} if notification succeeded.
+	 */
+	static native boolean DokanNotifyUpdate(WString FilePath);
+
+	/**
+	 * Notify Dokan that file or directory extended attributes have changed.
+	 *
+	 * @param FilePath Absolute path to the file or directory, including the mount-point of the file system.
+	 * @return {@code true} if notification succeeded.
+	 */
+	static native boolean DokanNotifyXAttrUpdate(WString FilePath);
+
+	/**
+	 * Notify Dokan that a file or a directory has been renamed.
+	 * <p>
+	 * This method supports in-place rename for file/directory within the same parent.
+	 *
+	 * @param OldPath Old, absolute path to the file or directory, including the mount-point of the file system.
+	 * @param NewPath New, absolute path to the file or directory, including the mount-point of the file system.
+	 * @param IsDirectory Indicates if the path is a directory.
+	 * @param IsInSameDirectory Indicates if the file or directory have the same parent directory.
+	 * @return {@code true} if notification succeeded.
+	 */
+	static native boolean DokanNotifyRename(WString OldPath, WString NewPath,
+											boolean IsDirectory, boolean IsInSameDirectory);
+}