Update Dokan wrapper to 1.0.0 #258

Liryna · 2016-07-30T12:45:13Z

No description provided.

Liryna · 2016-07-30T12:59:27Z

@arekbulski I updated regarding your comments.
I have found only 2 print, is there still remaining ?

lurch · 2016-08-01T11:03:04Z

fs/expose/dokan/__init__.py

 DOKAN_OPTION_REMOVABLE = 32
+# Use removable drive


Two different options to "Use removable drive" ?

Liryna · 2016-08-01T11:16:42Z

Thank you for your feedback @lurch I fixed them

lurch · 2016-08-01T11:17:05Z

fs/expose/dokan/__init__.py

 def Cleanup(self, path, info):
+ path = path.replace('\\', '/')


I'm not sure this (and all the other places where you've added this) is correct? Paths in pyfilesystem are defined to always (only) be separated by forward-slashes http://docs.pyfilesystem.org/en/latest/concepts.html#paths
Backslashes in pyfilesystem paths should always be preserved, as they're valid filename characters e.g. on Linux.

See #256 (comment)
I found no other wait to make it work.
Dokan is only Windows FS.

lurch · 2016-08-01T11:35:40Z

I'll try to find time to test this on my Windows7 laptop one evening this week...

lurch · 2016-08-01T11:38:30Z

fs/expose/dokan/__init__.py

@@ -5,19 +5,18 @@
 Expose an FS object to the native filesystem via Dokan.

 This module provides the necessary interfaces to mount an FS object into
-the local filesystem using Dokan on win32::
+the local filesystem using Dokan on win32:


Looks like this double-colon is actually needed? See http://docs.pyfilesystem.org/en/latest/expose/dokan.html

Oh that's whats for 😄 ! I revert it

Liryna · 2016-08-01T12:00:57Z

👍
You will simply need to download and install last Dokan RC
https://github.com/dokan-dev/dokany/releases/download/v1.0.0-RC4/DokanSetup_redist.exe
If it does not found dokan1.dll, you can find it in system32 or syswow64 depending of python version used.

arekbulski · 2016-08-01T13:49:06Z

@Liryna I would like you to look at #241 and #242 and review these two. Either incorporate those into yours or advise to reject them. I will review myself a bit later but this is outside my area.

Liryna · 2016-08-01T17:17:24Z

Thats where a part of my changes comes :)

lurch · 2016-08-01T18:09:15Z

fs/expose/dokan/__init__.py

+ def FindStreams(self, path, callback, info):
+ return STATUS_NOT_IMPLEMENTED
+
+ def _dokanpath2pyfs(self, path):


Inconsistent indentation (tabs vs. spaces).

Liryna · 2016-08-01T18:22:34Z

@lurch fixed 👍

lurch · 2016-08-01T18:31:26Z

fs/expose/dokan/__init__.py

@@ -806,18 +838,22 @@ def _datetime2timestamp(dtime):

 DATETIME_LOCAL_TO_UTC = _datetime2timestamp(datetime.datetime.utcnow()) - _datetime2timestamp(datetime.datetime.now())


Looks like this could be removed?

Liryna · 2016-08-01T18:48:03Z

Done, I hope this will be the last change.

arekbulski · 2016-08-01T19:20:18Z

There is a saying among game developers: "Nothing is e-v-e-r done." ^^

lurch · 2016-08-01T19:45:18Z

fs/expose/dokan/__init__.py

 >>> mp.path
 'Q:\\'
 >>> mp.unmount()
+ >>> fs = MemoryFS()
+ >>> # Mount in a exisiting empty folder


Typo - should be "an existing" (extra n, one less i).
Did you want to add spaces after the commas in your mount examples?

happy-monk · 2016-09-21T18:41:10Z

fs/expose/dokan/libdokan.py

- PDOKAN_FILE_INFO)),
- ("Unmount", CFUNCTYPE(c_int,
- PDOKAN_FILE_INFO)),
+ ("ZwCreateFile", CFUNCTYPE(NTSTATUS,


Callbacks should be WINFUNCTYPE instead of CFUNCTYPE to work with new Dokan versions.

What is the difference between WINFUNCTYPE and CFUNCTYPE ?
I had no issue running with CFUNCTYPE

It's for different calling conventions: stdcall (aka wincall) and cdecl respectively.Probably, you've been testing with 64-bit Python. For x64 programs MSVC ignores calling convention declarations and always uses fastcall, so stdcall and cdecl work identically. On x86, though, the Python process just crashes.

Ok @happy-monk ! you are right only tested on 64-bit !
I made the changes et rebase the pull request 👍

happy-monk · 2016-09-21T18:46:05Z

fs/expose/dokan/__init__.py

 # If no access rights are requestsed, only basic metadata is queried.
 if not access:
 if self.fs.isdir(path):
 info.contents.IsDirectory = True
 elif not self.fs.exists(path):
- raise ResourceNotFoundError(path)
+ return STATUS_OBJECT_NAME_NOT_FOUND
 return


It seems that there should be some more logic in case of opening directory.

what kind of logic have you in head ?

Maybe something like this:

if self.fs.isdir(path): info.contents.IsDirectory = True retun STATUS_SUCCESS

It's weird to try to open directory as file and it generates many exception messages in DebugFS logs.

By the way, I could not create directory through this driver. It created files instead.

You are right it has to return STATUS_SUCCESS.
CreateFile for open directory is normal, it is how windows work 😢

I will try to reproduce the issue you faced. Normally there should be a request with info.contents.IsDirectory == true and a create flag.
I don't have my env with me so it can take some times.

Thank for taking a look at this Pr !

happy-monk · 2016-09-22T12:30:28Z

fs/expose/dokan/libdokan.py

+ PULONGLONG, # TotalNumberOfFreeBytes
+ PDOKAN_FILE_INFO)),
+ ("GetVolumeInformation", WINFUNCTYPE(NTSTATUS,
+ LPWSTR, # VolumeNameBuffer


Apparently, when invoking Python callbacks, ctypes converts all string pointers in parameters to plain Python strings, which will not do for out-parameters. The easiest way to solve this is replace LPWSTR with PVOID.

This is important, because ctypes.memove (which is used in GetVolumeInformation callback) works with Python strings without exceptions, but can crash the whole process.

Does that mean I should just change the LPWSTR to PVOID for GetVolumeInformation ?
👍 you seems to know much more than me on this ! Good to have some analyse on the PR !
I made the changes, correct me if I did it wrong

Yes. Now it works without crashes.

happy-monk · 2016-09-22T12:31:14Z

fs/expose/dokan/__init__.py

+
+ @handle_fs_errors
+ def GetFileSecurity(self, path, securityinformation, securitydescriptor, securitydescriptorlength, neededlength, info):
+ return STATUS_NOT_IMPLEMENTED


STATUS_NOT_IMPLEMENTED is not declared, which leads to unhandled exceptions.

flag added 👍

happy-monk · 2016-09-22T12:55:21Z

fs/expose/dokan/__init__.py

@@ -709,17 +728,18 @@ def GetVolumeInformation(self, vnmBuf, vnmSz, sNum, maxLen, flags, fnmBuf, fnmSz
 maxLen[0] = 255
 if flags:
 flags[0] = 0


The flags probably should be at least FILE_CASE_SENSITIVE_SEARCH | FILE_CASE_PRESERVED_NAMES | FILE_UNICODE_ON_DISK.

Yes, this has been added ! thank you !

Liryna · 2016-09-23T05:22:21Z

@happy-monk Thank you for testing it !
Just to resume the situation, you have issue to create folder for now ? but the device mount without issue, you can read/write a file ?

I will take a look at the CreateFile.

lurch · 2016-09-23T11:49:41Z

Ditto, thanks for looking at this @happy-monk 👍
(makes me glad I didn't prematurely merge it! ;) )

happy-monk · 2016-09-23T14:46:47Z

@Liryna Yes and yes.
@lurch 🤘

jeffswt · 2016-09-25T03:55:12Z

@Liryna There seems to be some major problems in your commit.

First problem: Your filesystem tends to work well on reading and writing, but not creating folders. Any attempt to create a folder instead creates a file with the same name at the target folder. This makes files' hierarchical manipulations impossible. This bug occurs on all filesystems. Screenshot as follows:

Second problem: The dokan wrapper literally removes files, albeit correctly in the filesystem, but it seems to raise exceptions on the way deleting the files. I do not quite understand the specific implementations, but the debugging messages are indeed irritating. This bug occurs on all filesystems. Debugging message as follows:

Traceback (most recent call last):
  File "_ctypes/callbacks.c", line 234, in 'calling callback function'
  File "C:\Programs\Python3\lib\site-packages\fs\expose\dokan\__init__.py", line 291, in wrapper
    return func(self, *args)
  File "C:\Programs\Python3\lib\site-packages\fs\expose\dokan\__init__.py", line 206, in wrapper
    res = func(*args, **kwds)
  File "C:\Programs\Python3\lib\site-packages\fs\errors.py", line 219, in wrapper
    return func(*args,**kwds)
  File "C:\Programs\Python3\lib\site-packages\fs\expose\dokan\__init__.py", line 492, in Cleanup
    self._pending_delete.remove(path)
KeyError: '/New folder'

Third problem: Minor, but sometimes effects overall experience, that drives may not be unmounted after quite a long time. I haven't found out the reason, but the code and the debugging traceback is here.

>>> from fs.osfs import OSFS
>>> from fs.expose import dokan
>>> f = OSFS('D:\\Desktop')
>>> mp = dokan.mount(f, 'G:\\')
>>> mp.unmount()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Programs\Python3\lib\site-packages\fs\expose\dokan\__init__.py", line 1046, in unmount
    raise OSError("the filesystem could not be unmounted: %s" %(self.path,))
OSError: the filesystem could not be unmounted: G:\
>>> dokan.unmount('G:\\')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Programs\Python3\lib\site-packages\fs\expose\dokan\__init__.py", line 1002, in unmount
    raise OSError("filesystem could not be unmounted: %s" % (path,))
OSError: filesystem could not be unmounted: G:\
>>>
^C
C:\Users\Administrator>python
Python 3.5.1 (v3.5.1:37a07cee5969, Dec  6 2015, 01:38:48) [MSC v.1900 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> from fs.expose import dokan
>>> dokan.unmount('G:\\')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Programs\Python3\lib\site-packages\fs\expose\dokan\__init__.py", line 1002, in unmount
    raise OSError("filesystem could not be unmounted: %s" % (path,))
OSError: filesystem could not be unmounted: G:\
>>>

Fourth problem: ZipFS could not be exposed to dokan. I am not sure whether this is a problem, but this could be related to implementation methods which are not yet implemented. Debugging methods as follows:

Python 3.5.1 (v3.5.1:37a07cee5969, Dec  6 2015, 01:38:48) [MSC v.1900 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> from fs.zipfs import ZipFS
>>> from fs.expose import dokan
>>> f = ZipFS('D:\\minetest-0.4.14-win32.zip')
>>> f.listdir()
['minetest-0.4.14']
>>> mp = dokan.mount(f, 'H:\\')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Programs\Python3\lib\site-packages\fs\expose\dokan\__init__.py", line 981, in mount
    mp = MountProcess(fs, path, kwds)
  File "C:\Programs\Python3\lib\site-packages\fs\expose\dokan\__init__.py", line 1039, in __init__
    cmd = cmd % (repr(pickle.dumps((fs, path, dokan_opts, nowait), -1)),)
TypeError: cannot serialize '_io.BufferedReader' object
>>>

Would be grateful if you could solve these problems.

Liryna · 2016-09-25T08:43:59Z

@ht35268 I will fix the create folder issue but other reported problem that you point does not come from my commit and I don't have the knowledge to fix them.

Feel free to create a pull request with the fix 👍

lurch · 2016-09-25T09:19:33Z

Fourth problem: ZipFS could not be exposed to dokan.

I expect this might be a problem with ZipFS, rather than Dokan. (ISTR something similar being mentioned before a long time ago)
IIRC the 'fix' is to use the foreground=True option in the dokan.mount call (as this then means the filesystem being exposed (ZipFS in this case) doesn't need to be pickled).

Liryna · 2016-10-24T08:25:26Z

@ChiBill There was a missing for python 2
I added it in the branch, you can pull and run it.

I made my last test on python 3 & 2. everything work great 👍

lurch · 2016-10-24T10:17:08Z

fs/expose/dokan/libdokan.py

 # All rights reserved; available under the terms of the MIT License.
 """

 fs.expose.dokan.libdokan: low-level ctypes interface to Dokan

 """

+import ctypes
 from ctypes import *


You really shouldn't be using both these import lines.
IMHO you should just pick one or the other, and then modify the rest of the code as necessary (e.g. remove the first import, and then change ctypes.POINTER to just POINTER etc.).

happy-monk · 2016-10-24T12:38:37Z

@Liryna I think, it would be better if you did this the other way around. libdokan heavily uses objects from ctypes, so it's reasonable to user import * there. dokan.__init__ uses them only occasionally, so it's better to use import ctypes there to not pollute the namespace with unnecessary names.

Liryna · 2016-10-24T13:28:53Z

Good for me so 👍 bc2e17c

jeffswt · 2016-10-24T14:03:45Z

@happy-monk Good idea. Though personally I prefer not using from ... import * as it ruins the namespaces.

happy-monk · 2016-10-24T14:31:51Z

@ht35268 I think, the main purpose of libdokan as the separate module is to isolate all ctypes stuff.
@Liryna Good, but your two last commits pretty much cancel each other. So, maybe, you should squash them together? :) (If you did not plan to squash the whole PR at some point).

Liryna · 2016-10-24T15:00:43Z

@happy-monk I am going to rebase all the PR when @lurch say the GO 👍

wgaylord · 2016-11-01T21:08:51Z

Whats the status on this? Is it basically just waiting on a rebase and then it can me pulled?

Liryna · 2016-11-01T21:11:24Z

Yes @ChiBill. We wait @lurch approval, I rebase and merge it.
Otherwise this has been tested by a couple of people and no issue has been found so far 👍

wgaylord · 2016-11-01T21:12:38Z

I have been using it from your repo and have found no errors that is why I am asking. (Want to be able to just install it normally.)

Liryna · 2016-11-01T21:13:30Z

Oh Ok ! Thats a good news 😄 !

happy-monk · 2016-11-10T17:23:59Z

fs/expose/dokan/__init__.py

- res = func(*args,**kwds)
- except OSError, e:
+ res = func(*args, **kwds)
+ except OSError as e:
 if e.errno:
 res = -1 * _errno2syserrcode(e.errno)


Is it right to multiply by -1 here. I think, it scrambles error codes. At least, this may work not the same way in Python as in C/C++.

I tried to open file, which raised PermissionDeniedError in Python, but I did not get any error through Dokan.

happy-monk · 2016-11-10T17:37:46Z

fs/expose/dokan/__init__.py

+ if not self.fs.exists(path):
+ mode = "w+b"
+ else:
+ mode = "r+b"


The mode always contains +, meaning it would open file for write. This doesn't work well with read-only file systems 😕

happy-monk · 2016-11-11T16:13:33Z

fs/expose/dokan/__init__.py

+ return STATUS_ACCESS_DENIED
+
+ retcode = STATUS_SUCCESS
+ if info.contents.IsDirectory:


While toying with Dokan, I had to change it like this:

if self.fs.isdir(path) or info.contents.IsDirectory: info.contents.IsDirectory = True

Otherwise Windows would mistake directories to files and vice versa:

>>> os.path.isfile(r'P:\\') True >>> os.path.isdir(r'P:\\') False

happy-monk · 2016-11-11T16:17:27Z

fs/expose/dokan/__init__.py

 if eno == errno.EACCES:
- return ERROR_ACCESS_DENIED
+ return STATUS_ACCESS_DENIED
 return eno


I think, it's better to return here some STATUS_* constant to clearly indicate error. Dokan/Windows tend to ignore invalid status codes, as far as I understand, and errno values is mostly invalid as status codes.

In my experiments Dokan could irreversibly hang both the FS process and explorer.exe because of such errors, to the point of inability of reboot Windows.

Liryna · 2016-11-19T07:55:58Z

@lurch @willmcgugan any news on this ?
There seems to be already a couple of users using it. It would be great to have it in the pyfs master 👍

Rondom · 2016-12-07T21:27:15Z

Any news on this PR?

wgaylord · 2016-12-07T21:39:50Z

Yeah. I am still using what I cloned from the other one.

…

On Wed, Dec 7, 2016 at 3:27 PM, Andreas Gnau ***@***.***> wrote: Any news on this PR? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#258 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACCNyUazgGQeXtk-fwOA_QJhK70oviV8ks5rFyS0gaJpZM4JYzKp> .

Rondom · 2016-12-07T23:25:21Z

@willmcgugan So, would you prefer this PR to be submitted to pyfilesystem2?

jeffswt · 2016-12-21T16:54:46Z

Really looking forward to having this in master!

wgaylord · 2017-01-07T21:05:56Z

.? Any idea about when this might be merged?

willmcgugan · 2017-01-08T16:02:01Z

Thanks for the work all. I don't have access to a Windows machine, but if you are all happy with this (@lurch?) I'll go ahead and merge.

Liryna · 2017-01-20T14:04:01Z

Thanks @willmcgugan I think this can be merged. It has been tested by a couple of users already. @lurch does not look to have the time to test it.

Like I said before, the current implementation of Dokan in the master is extremely old and can no longer be used.
Here I am proposing a working wrapper of the new Dokan version 👍

jeffswt · 2017-01-20T14:33:45Z

@willmcgugan Tested and secure.

~~I was wondering if we should drop support for Python 2~~

wgaylord · 2017-01-20T14:39:00Z

I can still confirm that it is working on python3 (3.5.2 (out dated abit..)) and python2.(2.7.13) (Both of which i have installed.)

willmcgugan · 2017-01-22T16:41:31Z

Ok, if everyone is confident. Thanks for your work!

Liryna mentioned this pull request Jul 30, 2016

Fixing dokan support discussion... #256

Open

arekbulski mentioned this pull request Jul 30, 2016

We need a commiter, I volunteer #259

Closed

lurch reviewed Aug 1, 2016
View reviewed changes

fs/expose/dokan/__init__.py

DOKAN_OPTION_REMOVABLE = 32

# Use removable drive

Copy link

Contributor

lurch Aug 1, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two different options to "Use removable drive" ?

lurch reviewed Aug 1, 2016
View reviewed changes

happy-monk reviewed Sep 21, 2016

View reviewed changes

happy-monk reviewed Sep 22, 2016

View reviewed changes

Add missing import ctypes

e76d018

lurch reviewed Oct 24, 2016

View reviewed changes

Move to import ctypes

be2afb4

Move to from ctypes import *

bc2e17c

happy-monk reviewed Nov 10, 2016

View reviewed changes

Change handle_fs_errors old error values

3e0a6cb

happy-monk reviewed Nov 11, 2016

View reviewed changes

open as directory if isdir

f43b3a5

willmcgugan merged commit 44573f7 into PyFilesystem:master Jan 22, 2017

		def Cleanup(self, path, info):
		path = path.replace('\\', '/')

		@@ -806,18 +838,22 @@ def _datetime2timestamp(dtime):

		DATETIME_LOCAL_TO_UTC = _datetime2timestamp(datetime.datetime.utcnow()) - _datetime2timestamp(datetime.datetime.now())

Update Dokan wrapper to 1.0.0 #258

Update Dokan wrapper to 1.0.0 #258

Conversation

Liryna commented Jul 30, 2016

Liryna commented Jul 30, 2016

Choose a reason for hiding this comment

Liryna commented Aug 1, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lurch commented Aug 1, 2016 • edited Loading

Choose a reason for hiding this comment

Liryna Aug 1, 2016 • edited Loading

Choose a reason for hiding this comment

Liryna commented Aug 1, 2016

arekbulski commented Aug 1, 2016 • edited Loading

Liryna commented Aug 1, 2016

Choose a reason for hiding this comment

Liryna commented Aug 1, 2016

Choose a reason for hiding this comment

Liryna commented Aug 1, 2016

arekbulski commented Aug 1, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Liryna Sep 22, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

happy-monk Sep 22, 2016 • edited Loading

Choose a reason for hiding this comment

Liryna Sep 22, 2016 • edited Loading

Choose a reason for hiding this comment

Liryna commented Sep 23, 2016

lurch commented Sep 23, 2016

happy-monk commented Sep 23, 2016

jeffswt commented Sep 25, 2016

Liryna commented Sep 25, 2016 • edited Loading

lurch commented Sep 25, 2016

Liryna commented Oct 24, 2016

Choose a reason for hiding this comment

happy-monk commented Oct 24, 2016

Liryna commented Oct 24, 2016 • edited Loading

jeffswt commented Oct 24, 2016 • edited Loading

happy-monk commented Oct 24, 2016

Liryna commented Oct 24, 2016

wgaylord commented Nov 1, 2016

Liryna commented Nov 1, 2016 • edited Loading

wgaylord commented Nov 1, 2016

Liryna commented Nov 1, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Liryna commented Nov 19, 2016

Rondom commented Dec 7, 2016

wgaylord commented Dec 7, 2016 via email

Rondom commented Dec 7, 2016

jeffswt commented Dec 21, 2016

wgaylord commented Jan 7, 2017

willmcgugan commented Jan 8, 2017

Liryna commented Jan 20, 2017

jeffswt commented Jan 20, 2017

wgaylord commented Jan 20, 2017

willmcgugan commented Jan 22, 2017

lurch commented Aug 1, 2016 •

edited

Loading

Liryna Aug 1, 2016 •

edited

Loading

arekbulski commented Aug 1, 2016 •

edited

Loading

Liryna Sep 22, 2016 •

edited

Loading

happy-monk Sep 22, 2016 •

edited

Loading

Liryna Sep 22, 2016 •

edited

Loading

Liryna commented Sep 25, 2016 •

edited

Loading

Liryna commented Oct 24, 2016 •

edited

Loading

jeffswt commented Oct 24, 2016 •

edited

Loading

Liryna commented Nov 1, 2016 •

edited

Loading