Dokan .netバインディングの勉強

VMware上でのデバッグ方法がわかったので、実際にコードを書いてみる。
C#スキーなので、Dokanの.netバインディングを使う。

プロジェクトに追加

DokanNetディレクトリにある、"DokanNet.cs", "DokanOperations.cs", "Proxy.cs" をプロジェクトに追加しておく。

まずはDokanOperationsを実装する

Dokan.netで実装しなければいけない機能は、すべてDokan.DokanOperationsというインタフェースにまとめられている。

なので、コンソールプログラムを選択した際に自動生成されたコードを次のように変更する。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Dokan;

namespace DokanTest
{
    class Program : Dokan.DokanOperations
    {

これで、ProgramクラスはDokanOperationsインタフェースを実装することになる。
VisualStudioの機能で、DokanOperationsインタフェースの定義を実装する(メンバ関数定義を自動記述する)ことができるので、この機能を使って一気に関数を記述すると、次のようになる。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Dokan;

namespace DokanTest
{
    class Program : Dokan.DokanOperations
    {
        static void Main(string[] args)
        {
        }

        #region DokanOperations メンバ

        public int CreateFile(string filename, System.IO.FileAccess access, System.IO.FileShare share, System.IO.FileMode mode, System.IO.FileOptions options, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int OpenDirectory(string filename, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int CreateDirectory(string filename, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int Cleanup(string filename, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int CloseFile(string filename, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int ReadFile(string filename, byte[] buffer, ref uint readBytes, long offset, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int WriteFile(string filename, byte[] buffer, ref uint writtenBytes, long offset, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int FlushFileBuffers(string filename, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int GetFileInformation(string filename, FileInformation fileinfo, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int FindFiles(string filename, System.Collections.ArrayList files, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int SetFileAttributes(string filename, System.IO.FileAttributes attr, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int SetFileTime(string filename, DateTime ctime, DateTime atime, DateTime mtime, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int DeleteFile(string filename, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int DeleteDirectory(string filename, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int MoveFile(string filename, string newname, bool replace, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int SetEndOfFile(string filename, long length, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int LockFile(string filename, long offset, long length, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int UnlockFile(string filename, long offset, long length, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int GetDiskFreeSpace(ref ulong freeBytesAvailable, ref ulong totalBytes, ref ulong totalFreeBytes, DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        public int Unmount(DokanFileInfo info)
        {
            throw new NotImplementedException();
        }

        #endregion
    }
}

あとは、これらの関数のうち必要なものを実装していけばよい。

何もしないファイルシステムを作る

まずは、何もしないファイルシステムを作ってみる。

マウントを行うためには、Main()関数でマウントの命令を実行する必要がある。

namespace DokanTest
{
    class Program : Dokan.DokanOperations
    {
        const string default_mount_drive = "x";

        static void Main(string[] args)
        {
            // arg[0]: マウントされるドライブのドライブレター

            // オプション設定
            DokanOptions opt = new DokanOptions();
            opt.DebugMode = true;
            opt.DriveLetter = (args.Length == 1) ? args[0].ToCharArray()[0] : default_mount_drive.ToCharArray()[0];
            opt.ThreadCount = 1;
            opt.VolumeLabel = "DokanTest";

            // マウント実行
            DokanNet.DokanMain(opt, new Program());
        }

そして、各関数にある

throw new NotImplementedException();

をなんとかする。今回はめんどくさいので、全て

return 0;

に置換した。

これで実行してみると、X:ドライブにDokanTestというボリュームラベルを持つドライブが見えるようになる。
実際の関数は全く実装していないため、ファイルの作成や空きディスク領域の取得などは全く機能しないが、ファイルシステムとして動作していることが確認できる。

なお、GetFileInformation()で何もせずreturn 0;しているため、次のようなエラーが出る:

System.ArgumentOutOfRangeException: 有効な Win32 FileTime ではありません。
   場所 System.DateTime.ToFileTimeUtc()
   場所 System.DateTime.ToFileTime()
   場所 Dokan.Proxy.GetFileInformationProxy(IntPtr FileName, BY_HANDLE_FILE_INFORMATION&
   HandleFileInformation, DOKAN_FILE_INFO& FileInfo) 場所 Proxy.cs:行 436

正しい情報を一切返していないので、ある意味当然の結果である。必要な機能は、追々追加していくことにする。

CreateFile()関数はファイル作成以外でも超いっぱい呼ばれる。しかもルートディレクトリ("\")相手でも平気で呼ばれまくる。ヤバい。
しかも無碍に return -DokanNet.DOKAN_ERROR; とかやると「パラメータが間違っています。」とか言われる。これはひどい。
なので、ルートディレクトリ"\"と見せてあげたいファイルそれぞれへのアクセスの場合には、ちゃんと return DokanNet.DOKAN_SUCCESS; してあげないとダメっぽい。

メモ帳やcmd.exeのtypeコマンドなどは、"Hello world!\r\n"の文字数分、つまり14文字分読み込んだらそこで読み込みが終了する。しかし、秀丸やワードパッドなどは、どうも読み込みが行える限り読み込みを行おうとするようで、何も気にせずバッファにコピーすると無限にファイルを読み込もうとしてしまっておもしろいことになってしまう。
そこで、ReadFile()関数でoffsetの値をチェックし、実体のサイズを超えるような場合にはエラーを返すようにすればこの問題は解決するようだ。(これはファイルシステムとしては常識なのかも？)

思いの外手こずってしまった。しかし、ちゃんとファイルの中身が表示されたときは、なんか楽しいものだ。今後もいろいろとDokanで遊んでみよう。

しょんぼり技術メモ

まいにちがしょんぼり

プロジェクトに追加

まずはDokanOperationsを実装する

何もしないファイルシステムを作る

Hello world なファイルシステムを作る