feat(webui): root contains shortcut to the IPFFS WebUI

Author: richardschneider

IpfsMount/IpfsDokan.cs

@@ -51,6 +51,14 @@ public NtStatus CreateFile(string fileName, DokanNet.FileAccess access, FileShar
                 return DokanResult.Success;
             }
 
+            // Predefined files
+            PredefinedFile predefinedFile = null;
+            if (PredefinedFile.All.TryGetValue(fileName, out predefinedFile))
+            {
+                info.Context = predefinedFile;
+                return DokanResult.Success;
+            }
+
             // Get file info from IPFS
             var ipfsFileName = fileName.Replace(@"\", "/");
             try
@@ -112,6 +120,13 @@ public NtStatus GetFileInformation(string fileName, out FileInformation fileInfo
                 return DokanResult.Success;
             }
 
+            var predefinedFile = info.Context as PredefinedFile;
+            if (predefinedFile != null)
+            {
+                fileInfo.Length = predefinedFile.Data.Length;
+                return DokanResult.Success;
+            }
+
             // Root info
             if (fileName == rootName)
             {
@@ -185,6 +200,15 @@ public NtStatus Unmounted(DokanFileInfo info)
         #region File Operations
         public NtStatus ReadFile(string fileName, byte[] buffer, out int bytesRead, long offset, DokanFileInfo info)
         {
+            var predefinedFile = info.Context as PredefinedFile;
+            if (predefinedFile != null)
+            {
+                bytesRead = (int) Math.Min(buffer.LongLength, predefinedFile.Data.LongLength - offset);
+                Buffer.BlockCopy(predefinedFile.Data, (int)offset, buffer, 0, bytesRead);
+                return DokanResult.Success;
+            }
+
+
             var file = (IpfsFile)info.Context;
 
             // TODO: Not very efficient.  Maybe access the merkle dags.
@@ -301,17 +325,26 @@ public NtStatus FindFiles(string fileName, out IList<FileInformation> files, Dok
                 return DokanResult.Success;
             }
 
-            // The root consists only of the root folders.
+            // The root consists of the root folders and the predefined files.
             if (fileName == rootName)
             {
                 files = rootFolders
-                    .Select(name => new FileInformation()
+                    .Select(name => new FileInformation
                     {
                         FileName = name,
                         Attributes = FileAttributes.Directory | FileAttributes.ReadOnly,
                         LastAccessTime = DateTime.Now
                     })
                     .ToList();
+                foreach (var predefinedFile in PredefinedFile.All.Values)
+                {
+                    files.Add(new FileInformation
+                    {
+                        FileName = Path.GetFileName(predefinedFile.Name),
+                        Attributes = FileAttributes.ReadOnly,
+                        Length = predefinedFile.Data.Length
+                    });
+                }
                 return DokanResult.Success;
             }
 

IpfsMount/IpfsMount.csproj

@@ -84,6 +84,7 @@
     <Compile Include="DokanLogger.cs" />
     <Compile Include="IpfsDokan.cs" />
     <Compile Include="IpfsFile.cs" />
+    <Compile Include="PredefinedFile.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
@@ -93,6 +94,7 @@
   </ItemGroup>
   <ItemGroup>
     <Content Include="FodyWeavers.xml" />
+    <EmbeddedResource Include="Resources\PredefineFiles\Manage IPFS.url" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Import Project="..\packages\Fody.1.28.3\build\Fody.targets" Condition="Exists('..\packages\Fody.1.28.3\build\Fody.targets')" />

IpfsMount/PredefinedFile.cs

@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Ipfs.VirtualDisk
+{
+    class PredefinedFile
+    {
+        public static Dictionary<string, PredefinedFile> All { get; private set; }
+
+        static PredefinedFile()
+        {
+            const string prefix = "Ipfs.VirtualDisk.Resources.PredefineFiles.";
+            All = Assembly.GetExecutingAssembly()
+                .GetManifestResourceNames()
+                .Where(name => name.StartsWith(prefix))
+                .Select(name => new PredefinedFile
+                {
+                    Name = @"\" + name.Substring(prefix.Length),
+                    Data = GetData(name)
+                })
+                .ToDictionary(f => f.Name, f => f);
+        }
+
+        public string Name { get; set; }
+        public byte[] Data { get; set; }
+
+        static byte[] GetData(string name)
+        {
+            using (var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(name))
+            using (var ms = new MemoryStream())
+            {
+                stream.CopyTo(ms);
+                return ms.ToArray();
+            }
+        }
+    }
+}

IpfsMount/Resources/PredefineFiles/Manage IPFS.url

@@ -0,0 +1,2 @@
+[InternetShortcut]
+URL=http://localhost:5001/webui

IpfsMountTests/DriveTest.cs

@@ -62,5 +62,14 @@ public void Root_Enumerate_Special_Folders()
             Assert.AreEqual(2, folders.Count());
         }
 
+        [TestMethod]
+        public void Root_has_Shortcut_to_WebUI()
+        {
+            const string shortcut = @"t:\Manage IPFS.url";
+            Assert.IsTrue(File.Exists(shortcut));
+            var lines = File.ReadAllLines(shortcut);
+            Assert.AreEqual("[InternetShortcut]", lines[0]);
+        }
+
     }
 }

README.md

@@ -10,6 +10,7 @@ Mount the [InterPlanetary File System](https://ipfs.io/) as a mapped drive on Wi
 - Mounts IPFS and IPNS on a drive letter, `ipfs-mount z:`
 - Unmounts the drive, `ipfs-mount z: /u`
 - [Pinned files](https://github.com/ipfs/examples/blob/master/examples/pinning/readme.md) are available in `z:\ipfs`
+- Root contains shortcut to the IPFS WebUI
 
 ## Installation