Module org.cryptomator.frontend.dokany

Package org.cryptomator.frontend.dokany.adapter

Class ReadWriteAdapter

java.lang.Object

org.cryptomator.frontend.dokany.adapter.ReadWriteAdapter

All Implemented Interfaces:

DokanyFileSystem

public class ReadWriteAdapter
extends Object
implements DokanyFileSystem

Constructor Summary

Constructors

Constructor	Description
ReadWriteAdapter(Path root, LockManager lockManager, VolumeInformation volumeInformation)
ReadWriteAdapter(Path fileSystemRoot, LockManager lockManager, VolumeInformation volumeInfo, AtomicReference<SafeUnmountCheck> safeUnmountCheck)	Creates a new ReadWriteAdapter with the given Path as root and adds to the OpenHandleCheckBuilder the check if the OpenHandleFactory is empty or not.

Method Summary

Modifier and Type	Method	Description
void	cleanup(com.sun.jna.WString rawPath, DokanyFileInfo dokanyFileInfo)	The handle is closed in this method, due to the requirements of the dokany implementation to delete a file in the cleanUp method
void	closeFile(com.sun.jna.WString rawPath, DokanyFileInfo dokanyFileInfo)	CloseFile is called at the end of the life of the context.
int	deleteDirectory(com.sun.jna.WString rawPath, DokanyFileInfo dokanyFileInfo)	Check if it is possible to delete a directory.
int	deleteFile(com.sun.jna.WString rawPath, DokanyFileInfo dokanyFileInfo)	Check if it is possible to delete a file.
void	fillWin32FindData(com.sun.jna.platform.win32.WinBase.WIN32_FIND_DATA rawFillFindData, DokanyFileInfo dokanyFileInfo)
int	findFiles(com.sun.jna.WString rawPath, DokanyOperations.FillWin32FindData rawFillFindData, DokanyFileInfo dokanyFileInfo)	List all files in the path requested.
int	findFilesWithPattern(com.sun.jna.WString fileName, com.sun.jna.WString searchPattern, DokanyOperations.FillWin32FindData rawFillFindData, DokanyFileInfo dokanyFileInfo)	Same as DokanyFileSystem.findFiles(WString, DokanyOperations.FillWin32FindData, DokanyFileInfo) but with a search pattern to filter the result.
int	findStreams(com.sun.jna.WString rawPath, DokanyOperations.FillWin32FindStreamData rawFillFindData, DokanyFileInfo dokanyFileInfo)	Retrieve all NTFS Streams informations on the file.
int	flushFileBuffers(com.sun.jna.WString rawPath, DokanyFileInfo dokanyFileInfo)	Clears buffers for this context and causes any buffered data to be written to the file.
int	getDiskFreeSpace(com.sun.jna.ptr.LongByReference freeBytesAvailable, com.sun.jna.ptr.LongByReference totalNumberOfBytes, com.sun.jna.ptr.LongByReference totalNumberOfFreeBytes, DokanyFileInfo dokanyFileInfo)	Retrieves information about the amount of space that is available on a disk volume, which is the total amount of space, the total amount of free space, and the total amount of free space available to the user that is associated with the calling thread.
int	getFileInformation(com.sun.jna.WString fileName, ByHandleFileInfo handleFileInfo, DokanyFileInfo dokanyFileInfo)	Get specific informations on a file.
int	getFileSecurity(com.sun.jna.WString rawPath, int rawSecurityInformation, com.sun.jna.Pointer rawSecurityDescriptor, int rawSecurityDescriptorLength, com.sun.jna.ptr.IntByReference rawSecurityDescriptorLengthNeeded, DokanyFileInfo dokanyFileInfo)	Not implemented, handled in proxy.
int	getVolumeInformation(com.sun.jna.Pointer rawVolumeNameBuffer, int rawVolumeNameSize, com.sun.jna.ptr.IntByReference rawVolumeSerialNumber, com.sun.jna.ptr.IntByReference rawMaximumComponentLength, com.sun.jna.ptr.IntByReference rawFileSystemFlags, com.sun.jna.Pointer rawFileSystemNameBuffer, int rawFileSystemNameSize, DokanyFileInfo dokanyFileInfo)	TODO: this method is copy pasta.
int	lockFile(com.sun.jna.WString rawPath, long rawByteOffset, long rawLength, DokanyFileInfo dokanyFileInfo)	Lock file at a specific offset and data length.
int	mounted(DokanyFileInfo dokanyFileInfo)	Is called when Dokany succeeded mounting the volume.
int	moveFile(com.sun.jna.WString rawPath, com.sun.jna.WString rawNewFileName, boolean rawReplaceIfExisting, DokanyFileInfo dokanyFileInfo)	Move a file or directory to a new location.
int	readFile(com.sun.jna.WString rawPath, com.sun.jna.Pointer rawBuffer, int rawBufferLength, com.sun.jna.ptr.IntByReference rawReadLength, long rawOffset, DokanyFileInfo dokanyFileInfo)	ReadFile callback on the file previously opened in DokanyFileSystem.zwCreateFile(WString, WinBase.SECURITY_ATTRIBUTES, int, int, int, int, int, DokanyFileInfo).
int	setAllocationSize(com.sun.jna.WString rawPath, long rawLength, DokanyFileInfo dokanyFileInfo)	SetAllocationSize is used to truncate or extend a file.
int	setEndOfFile(com.sun.jna.WString rawPath, long rawByteOffset, DokanyFileInfo dokanyFileInfo)	SetEndOfFile is used to truncate or extend a file (physical file size).
int	setFileAttributes(com.sun.jna.WString rawPath, int rawAttributes, DokanyFileInfo dokanyFileInfo)	Set file attributes on a specific file.
int	setFileSecurity(com.sun.jna.WString rawPath, int rawSecurityInformation, com.sun.jna.Pointer rawSecurityDescriptor, int rawSecurityDescriptorLength, DokanyFileInfo dokanyFileInfo)	Sets the security of a file or directory object.
int	setFileTime(com.sun.jna.WString rawPath, com.sun.jna.platform.win32.WinBase.FILETIME rawCreationTime, com.sun.jna.platform.win32.WinBase.FILETIME rawLastAccessTime, com.sun.jna.platform.win32.WinBase.FILETIME rawLastWriteTime, DokanyFileInfo dokanyFileInfo)	Set file times on a specific file.
int	unlockFile(com.sun.jna.WString rawPath, long rawByteOffset, long rawLength, DokanyFileInfo dokanyFileInfo)	Unlock file at a specific offset and data length.
int	unmounted(DokanyFileInfo dokanyFileInfo)	Is called when Dokany succeeded unmounting the volume.
int	writeFile(com.sun.jna.WString rawPath, com.sun.jna.Pointer rawBuffer, int rawNumberOfBytesToWrite, com.sun.jna.ptr.IntByReference rawNumberOfBytesWritten, long rawOffset, DokanyFileInfo dokanyFileInfo)	WriteFile callback on the file previously opened in DokanyFileSystem.zwCreateFile(WString, WinBase.SECURITY_ATTRIBUTES, int, int, int, int, int, DokanyFileInfo) It can be called by different thread at the same time, therefore the write/context has to be thread safe.
int	zwCreateFile(com.sun.jna.WString rawPath, com.sun.jna.platform.win32.WinBase.SECURITY_ATTRIBUTES securityContext, int rawDesiredAccess, int rawFileAttributes, int rawShareAccess, int rawCreateDisposition, int rawCreateOptions, DokanyFileInfo dokanyFileInfo)	CreateFile Dokan API callback.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReadWriteAdapter

public ReadWriteAdapter(Path root,
 LockManager lockManager,
 VolumeInformation volumeInformation)

ReadWriteAdapter

public ReadWriteAdapter(Path fileSystemRoot,
 LockManager lockManager,
 VolumeInformation volumeInfo,
 AtomicReference<SafeUnmountCheck> safeUnmountCheck)

Creates a new ReadWriteAdapter with the given Path as root and adds to the OpenHandleCheckBuilder the check if the OpenHandleFactory is empty or not.

Parameters:

fileSystemRoot -

lockManager -

volumeInfo -

safeUnmountCheck -

Method Details

zwCreateFile

public int zwCreateFile(com.sun.jna.WString rawPath,
 com.sun.jna.platform.win32.WinBase.SECURITY_ATTRIBUTES securityContext,
 int rawDesiredAccess,
 int rawFileAttributes,
 int rawShareAccess,
 int rawCreateDisposition,
 int rawCreateOptions,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

CreateFile Dokan API callback. CreateFile is called each time a request is made on a file system object. In case OPEN_ALWAYS & CREATE_ALWAYS are successfully opening an existing file, STATUS_OBJECT_NAME_COLLISION should be returned instead of STATUS_SUCCESS . This will inform Dokan that the file has been opened and not created during the request. If the file is a directory, CreateFile is also called. In this case, CreateFile should return NtStatus.SUCCESS when that directory can be opened and DokanyFileInfo.IsDirectory has to be set to TRUE. On the other hand, if DokanyFileInfo.IsDirectory is set to TRUE but the path targets a file, NtStatus.NOT_A_DIRECTORY must be returned. DokanyFileInfo.Context can be used to store Data (like a filehandle) that can be retrieved in all other requests related to the Context. To avoid memory leak, Context needs to be released in DokanyFileSystem.cleanup(WString, DokanyFileInfo) .

Specified by:

zwCreateFile in interface DokanyFileSystem

Parameters:

rawPath - Path requested by the Kernel on the File System. TODO: rewrite this parameter description to link to winBase

securityContext - the security context of the kernel (see also in the windows driver API IO_SECURITY_CONTEXT)

rawDesiredAccess - Permissions for file or directory. (see also in the windows API ACCESS_MASK

rawFileAttributes - Provides attributes for files and directories. (see also in the .NET API System.IO.FileAttributes}

rawShareAccess - Type of share access to other threads. Device and intermediate drivers usually set ShareAccess to zero, which gives the caller exclusive access to the open file.

rawCreateDisposition - Specifies the action to perform if the file does or does not exist. Can be translated into a readable thing via CreationDisposition

rawCreateOptions - Specifies the options to apply when the driver creates or opens the file. (see also in the .NET API System.IO.FileOptions)

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

integer code of a NtStatus

See Also:

• Dokany documentation of ZwCreateFile
• Microsoft documentation of zwCreateFile
• Microsoft FileManagement documentation of CreateFile

cleanup

public void cleanup(com.sun.jna.WString rawPath,
 DokanyFileInfo dokanyFileInfo)

The handle is closed in this method, due to the requirements of the dokany implementation to delete a file in the cleanUp method

Specified by:

cleanup in interface DokanyFileSystem

Parameters:

rawPath -

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

closeFile

public void closeFile(com.sun.jna.WString rawPath,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

CloseFile is called at the end of the life of the context. Receipt of this request indicates that the last handle of the file object that is associated with the target device object has been closed and released. All outstanding I/O requests have been completed or canceled.

CloseFile is requested after DokanyFileSystem.cleanup(WString, DokanyFileInfo) is called. Anything remaining in DokanyFileInfo.Context has to be cleared before return.

Specified by:

closeFile in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

readFile

public int readFile(com.sun.jna.WString rawPath,
 com.sun.jna.Pointer rawBuffer,
 int rawBufferLength,
 com.sun.jna.ptr.IntByReference rawReadLength,
 long rawOffset,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

ReadFile callback on the file previously opened in DokanyFileSystem.zwCreateFile(WString, WinBase.SECURITY_ATTRIBUTES, int, int, int, int, int, DokanyFileInfo). It can be called by different thread at the same time, therefore the read has to be thread safe.

Specified by:

readFile in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

writeFile

public int writeFile(com.sun.jna.WString rawPath,
 com.sun.jna.Pointer rawBuffer,
 int rawNumberOfBytesToWrite,
 com.sun.jna.ptr.IntByReference rawNumberOfBytesWritten,
 long rawOffset,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

WriteFile callback on the file previously opened in DokanyFileSystem.zwCreateFile(WString, WinBase.SECURITY_ATTRIBUTES, int, int, int, int, int, DokanyFileInfo) It can be called by different thread at the same time, therefore the write/context has to be thread safe.

Specified by:

writeFile in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

flushFileBuffers

public int flushFileBuffers(com.sun.jna.WString rawPath,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Clears buffers for this context and causes any buffered data to be written to the file.

Specified by:

flushFileBuffers in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

getFileInformation

public int getFileInformation(com.sun.jna.WString fileName,
 ByHandleFileInfo handleFileInfo,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Get specific informations on a file.

Specified by:

getFileInformation in interface DokanyFileSystem

Parameters:

fileName -

handleFileInfo -

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

findFiles

public int findFiles(com.sun.jna.WString rawPath,
 DokanyOperations.FillWin32FindData rawFillFindData,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

List all files in the path requested.

Specified by:

findFiles in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

findFilesWithPattern

public int findFilesWithPattern(com.sun.jna.WString fileName,
 com.sun.jna.WString searchPattern,
 DokanyOperations.FillWin32FindData rawFillFindData,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Same as DokanyFileSystem.findFiles(WString, DokanyOperations.FillWin32FindData, DokanyFileInfo) but with a search pattern to filter the result.

Specified by:

findFilesWithPattern in interface DokanyFileSystem

Parameters:

fileName -

searchPattern -

rawFillFindData -

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

setFileAttributes

public int setFileAttributes(com.sun.jna.WString rawPath,
 int rawAttributes,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Set file attributes on a specific file.

Specified by:

setFileAttributes in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

setFileTime

public int setFileTime(com.sun.jna.WString rawPath,
 com.sun.jna.platform.win32.WinBase.FILETIME rawCreationTime,
 com.sun.jna.platform.win32.WinBase.FILETIME rawLastAccessTime,
 com.sun.jna.platform.win32.WinBase.FILETIME rawLastWriteTime,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Set file times on a specific file.

Specified by:

setFileTime in interface DokanyFileSystem

Parameters:

rawPath - path to file or directory

rawCreationTime - time of creation

rawLastAccessTime - time of last access

rawLastWriteTime - time of last modification

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

deleteFile

public int deleteFile(com.sun.jna.WString rawPath,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Check if it is possible to delete a file.

You should NOT delete the file in this method, but instead you must only check whether you can delete the file or not, and return NtStatus.SUCCESS (when you can delete it) or appropriate error codes such as NtStatus.ACCESS_DENIED, NtStatus.OBJECT_NO_LONGER_EXISTS, NtStatus.OBJECT_NAME_NOT_FOUND.

DokanyFileSystem.deleteFile(WString, DokanyFileInfo) will also be called with DokanyFileInfo.DeleteOnClose set to false to notify the driver when the file is no longer requested to be deleted.

When you return NtStatus.SUCCESS, you get a DokanyFileSystem.cleanup(WString, DokanyFileInfo) call afterwards with DokanyFileInfo.DeleteOnClose set to true and only then you have to actually delete the file being closed.

Specified by:

deleteFile in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file.

Returns:

NtStatus

See Also:

• DokanyFileSystem.deleteDirectory(WString, DokanyFileInfo)

deleteDirectory

public int deleteDirectory(com.sun.jna.WString rawPath,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Check if it is possible to delete a directory.

Specified by:

deleteDirectory in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the directory.

Returns:

NtStatus

See Also:

• DokanyFileSystem.deleteFile(WString, DokanyFileInfo)

moveFile

public int moveFile(com.sun.jna.WString rawPath,
 com.sun.jna.WString rawNewFileName,
 boolean rawReplaceIfExisting,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Move a file or directory to a new location.

Specified by:

moveFile in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

setEndOfFile

public int setEndOfFile(com.sun.jna.WString rawPath,
 long rawByteOffset,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

SetEndOfFile is used to truncate or extend a file (physical file size).

Specified by:

setEndOfFile in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

setAllocationSize

public int setAllocationSize(com.sun.jna.WString rawPath,
 long rawLength,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

SetAllocationSize is used to truncate or extend a file.

Specified by:

setAllocationSize in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

lockFile

public int lockFile(com.sun.jna.WString rawPath,
 long rawByteOffset,
 long rawLength,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Lock file at a specific offset and data length. This is only used if DokanOption.FILELOCK_USER_MODE is enabled.

Specified by:

lockFile in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

unlockFile

public int unlockFile(com.sun.jna.WString rawPath,
 long rawByteOffset,
 long rawLength,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Unlock file at a specific offset and data length. This is only used if DokanOption.FILELOCK_USER_MODE is enabled.

Specified by:

unlockFile in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

getDiskFreeSpace

public int getDiskFreeSpace(com.sun.jna.ptr.LongByReference freeBytesAvailable,
 com.sun.jna.ptr.LongByReference totalNumberOfBytes,
 com.sun.jna.ptr.LongByReference totalNumberOfFreeBytes,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Retrieves information about the amount of space that is available on a disk volume, which is the total amount of space, the total amount of free space, and the total amount of free space available to the user that is associated with the calling thread.

Neither this method nor DokanyFileSystem.getVolumeInformation(Pointer, int, IntByReference, IntByReference, IntByReference, Pointer, int, DokanyFileInfo) save the DokanyFileInfo.Context. Before these methods are called, DokanyFileSystem.zwCreateFile(WString, WinBase.SECURITY_ATTRIBUTES, int, int, int, int, int, DokanyFileInfo) may not be called. (ditto @{link DokanyOperations.CloseFile} and @{link DokanyOperations.Cleanup}).

Specified by:

getDiskFreeSpace in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

getVolumeInformation

public int getVolumeInformation(com.sun.jna.Pointer rawVolumeNameBuffer,
 int rawVolumeNameSize,
 com.sun.jna.ptr.IntByReference rawVolumeSerialNumber,
 com.sun.jna.ptr.IntByReference rawMaximumComponentLength,
 com.sun.jna.ptr.IntByReference rawFileSystemFlags,
 com.sun.jna.Pointer rawFileSystemNameBuffer,
 int rawFileSystemNameSize,
 DokanyFileInfo dokanyFileInfo)

TODO: this method is copy pasta. Check it!

Specified by:

getVolumeInformation in interface DokanyFileSystem

Parameters:

rawVolumeNameBuffer -

rawVolumeNameSize -

rawVolumeSerialNumber -

rawMaximumComponentLength -

rawFileSystemFlags -

rawFileSystemNameBuffer -

rawFileSystemNameSize -

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

mounted

public int mounted(DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Is called when Dokany succeeded mounting the volume.

Specified by:

mounted in interface DokanyFileSystem

unmounted

public int unmounted(DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Is called when Dokany succeeded unmounting the volume.

Specified by:

unmounted in interface DokanyFileSystem

getFileSecurity

public int getFileSecurity(com.sun.jna.WString rawPath,
 int rawSecurityInformation,
 com.sun.jna.Pointer rawSecurityDescriptor,
 int rawSecurityDescriptorLength,
 com.sun.jna.ptr.IntByReference rawSecurityDescriptorLengthNeeded,
 DokanyFileInfo dokanyFileInfo)

Not implemented, handled in proxy.

Specified by:

getFileSecurity in interface DokanyFileSystem

Parameters:

rawPath -

rawSecurityInformation -

rawSecurityDescriptor -

rawSecurityDescriptorLength -

rawSecurityDescriptorLengthNeeded -

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

setFileSecurity

public int setFileSecurity(com.sun.jna.WString rawPath,
 int rawSecurityInformation,
 com.sun.jna.Pointer rawSecurityDescriptor,
 int rawSecurityDescriptorLength,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Sets the security of a file or directory object.

Supported since version 0.6.0. You must specify the version in DeviceOptions.Version.

Specified by:

setFileSecurity in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus

fillWin32FindData

public void fillWin32FindData(com.sun.jna.platform.win32.WinBase.WIN32_FIND_DATA rawFillFindData,
 DokanyFileInfo dokanyFileInfo)

Specified by:

fillWin32FindData in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

findStreams

public int findStreams(com.sun.jna.WString rawPath,
 DokanyOperations.FillWin32FindStreamData rawFillFindData,
 DokanyFileInfo dokanyFileInfo)

Description copied from interface: DokanyFileSystem

Retrieve all NTFS Streams informations on the file. This is only called if DokanOption.ALT_STREAM is enabled.

Specified by:

findStreams in interface DokanyFileSystem

dokanyFileInfo - DokanyFileInfo with information about the file or directory.

Returns:

NtStatus