v3.1.7115.0-Beta

Author: ITHitBuild

Common/Common.csproj

@@ -8,6 +8,6 @@
     <Description>Contains functionality common for all Virtual Drive samples, both for Windows and macOS.</Description>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="ITHit.FileSystem" Version="3.0.7021.0-Beta" />
+    <PackageReference Include="ITHit.FileSystem" Version="3.1.7115.0-Beta" />
   </ItemGroup>
 </Project>

Common/FileSystemItemMetadataExt.cs

@@ -12,6 +12,9 @@ namespace ITHit.FileSystem.Samples.Common
     /// </summary>
     public class FileSystemItemMetadataExt : IFileSystemItemMetadata
     {
+        /// <inheritdoc/>
+        public string ItemId { get; set; }
+
         ///<inheritdoc/>
         public string Name { get; set; }
 

README.md

@@ -31,7 +31,7 @@ This sample implements a virtual file system for Mac with synchronization suppor
 
 <a href="https://github.com/ITHit/UserFileSystemSamples/tree/master/Windows/VirtualDrive/">
 <p>
-This is a virtual drive implementation with Microsoft Office documents editing support and automatic Microsoft Office documents locking. It also demonstrates custom column support in Windows File Manager.&nbsp;To simulate the remote storage, this sample i                                            <span>...</span>
+This is a virtual drive implementation with thumbnail support, Microsoft Office documents editing support, and automatic Microsoft Office documents locking. It also demonstrates custom column support in Windows File Manager.&nbsp;To simulate the remote st                                            <span>...</span>
 </p>
 </a>
 </li>

Windows/Common/Common.Windows.csproj

@@ -12,7 +12,7 @@
     <PackageReference Include="Microsoft.Windows.SDK.Contracts" Version="10.0.19041.1" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="ITHit.FileSystem.Windows" Version="3.0.7021.0-Beta" />
+    <PackageReference Include="ITHit.FileSystem.Windows" Version="3.1.7115.0-Beta" />
     <ProjectReference Include="..\..\Common\Common.csproj" />
   </ItemGroup>
 </Project>

Windows/Common/CustomDataManager.cs renamed to Windows/Common/ExternalDataManager.cs

@@ -11,13 +11,16 @@
 namespace ITHit.FileSystem.Samples.Common.Windows
 {
     /// <summary>
-    /// Manages custom data associated with the item. 
+    /// Manages custom data associated with the item stored outside of the item, 
+    /// such as item ID, custom Windows Explorer columns, locks, ETags.
     /// </summary>
     /// <remarks>
-    /// We can not store custom data inside placeholder because of the MS Office transactional save, 
-    /// which renames and deletes the file, so all custom data is lost with it.
+    /// This class stores all custom data associated with the item outside of the placeholder.
+    /// We can not store item ID and custom data inside placeholder (using <see cref="IFileSystemItemMetadata.CustomData"/> 
+    /// and <see cref="ITHit.FileSystem.Windows.PlaceholderItem.GetCustomData"/>) because of the MS Office transactional save, 
+    /// which renames and deletes the file, so all custom data is lost.
     /// </remarks>
-    public class CustomDataManager
+    public class ExternalDataManager
     {
         /// <summary>
         /// Path in user file system with which this custom data corresponds.
@@ -57,7 +60,7 @@ public class CustomDataManager
         /// <summary>
         /// Creates instance of this class.
         /// </summary>
-        public CustomDataManager(
+        public ExternalDataManager(
             string userFileSystemPath, 
             string serverDataFolderPath, 
             string userFileSystemRootPath, 
@@ -77,8 +80,9 @@ public CustomDataManager(
         /// Indicates if the item was saved to the remote storage.
         /// </summary>
         /// <remarks>
+        /// MS Office transactional save, deletes and recreates the file.
         /// To detect if this is a new file we must store some marker ouside of the file, 
-        /// for the marker to survive MS Office transactional save, which deletes and recreates the file.
+        /// for the marker to survive the transactional save operation.
         /// </remarks>
         public bool IsNew
         {

Windows/VirtualDrive/README.md

@@ -1,6 +1,6 @@
 
 <h1 class="d-xl-block d-none">Virtual Drive Sample in .NET, C#</h1>
-<p>This is a virtual drive implementation with Microsoft Office documents editing support and automatic Microsoft Office documents locking. It also demonstrates custom column support in Windows File Manager.&nbsp;To simulate the remote storage, this sample is using a folder in the local file system on the same machine.&nbsp;This sample supports all basic synchronization features provided that is provided by the <a title="Virtual File System Sample for Windows" href="https://www.userfilesystem.com/examples/virtual_file_system/">Virtual File System</a> sample: folders&nbsp;on-demand listing, files on-demand content loading, selective offline files support, hydration progress. The sample is written in C#/.NET.</p>
+<p>This is a virtual drive implementation with thumbnail support, Microsoft Office documents editing support, and automatic Microsoft Office documents locking. It also demonstrates custom column support in Windows File Manager.&nbsp;To simulate the remote storage, this sample is using a folder in the local file system on the same machine.&nbsp;This sample supports all basic synchronization features provided that is provided by the <a title="Virtual File System Sample for Windows" href="https://www.userfilesystem.com/examples/virtual_file_system/">Virtual File System</a> sample: folders&nbsp;on-demand listing, files on-demand content loading, selective offline files support, hydration progress. The sample is written in C#/.NET.</p>
 <p><span>You can download this sample and a trial license in the&nbsp;</span><a title="Download" href="https://www.userfilesystem.com/download/">product download area</a>&nbsp;as well as you can clone it from<span>&nbsp;</span><a title="Virtual Drive Sample in .NET, C#" href="https://github.com/ITHit/UserFileSystemSamples/tree/master/Windows/VirtualDrive">GitHub</a><span>.&nbsp;</span></p>
 <p><span class="warn">This sample is provided with IT Hit User File System v3 Beta and later versions.</span></p>
 <h2 class="heading-link" id="nav_requirements">Requirements<a class="list-link d-inline" href="https://www.userfilesystem.com/examples/virtual_file_system/#nav_requirements"></a></h2>
@@ -17,10 +17,12 @@
 <p>To run the example, you will need a valid IT Hit User File System Engine for .NET License. You can download the license in&nbsp;the&nbsp;<a title="IT Hit User File System for .NET Download" href="https://www.userfilesystem.com/download/">product download area</a>.&nbsp;Note that the Engine is fully functional with a trial license and does not have any limitations. The trial license is valid for one month and the engine will stop working after this. You can check the expiration date inside the license file.&nbsp;Download the license file and specify its content in&nbsp;<span class="code">License</span>&nbsp;field in&nbsp;<span class="code">appsettings.json</span>&nbsp;file.</p>
 <p>You can also run the sample&nbsp;without explicitly specifying a license&nbsp;for 5 days. In this case,&nbsp;the&nbsp;Engine will automatically request the trial license from the IT Hit website https://www.userfilesystem.com. Make sure it is accessible via firewalls if any. After 5 days the Engine will stop working. To extend the trial period you will need to download a license in a&nbsp;<a title="IT Hit User File System for .NET Download" href="https://www.userfilesystem.com/download/">product download area</a>&nbsp;and specify it in&nbsp;<span class="code">appsettings.json</span></p>
 <h2 class="heading-link" id="nav_runningthesample">Running the Sample<a class="list-link d-inline" href="https://www.userfilesystem.com/examples/virtual_file_system/#nav_runningthesample"></a></h2>
-<p>To run the sample open the project in Visual Studio and run the project in a debug mode. When starting in the debug mode, it will automatically create a folder in which the virtual file system will reside, register the virtual drive with the platform and then open&nbsp;two instances of Windows File Manager, one of which will show a virtual drive and another a folder simulating remote storage.&nbsp;</p>
+<p>To run the sample open the project in Visual Studio and run the project in debug mode. When starting in the debug mode, it will automatically create a folder in which the virtual file system will reside, register the virtual drive with the platform and then open&nbsp;two instances of Windows File Manager, one of which will show a virtual drive and another a folder simulating remote storage.&nbsp;</p>
 <p>You can find more about running and stopping the sample as well as about basic synchronization features in the&nbsp;<a title="Virtual File System Sample for Windows" href="https://www.userfilesystem.com/examples/virtual_file_system/">Virtual File System</a>&nbsp;sample description.&nbsp;</p>
+<h2>Thumbnails Support</h2>
+<p><span>The Virtual Drive sample provides a separate project with thumbnail provider implementation in the COM object. It loads thumbnails from files located in the remote storage simulation folder and displays them in Windows Explorer. You will adapt this project to load thumbnails from your real remote storage.</span></p>
 <h2>Microsoft Office Editing Support</h2>
-<p>The major difference between the Virtual Drive sample and the <a title="Virtual File System Sample for Windows" href="https://www.userfilesystem.com/examples/virtual_file_system/">Virtual File System</a> sample is its support for Microsoft Office Documents editing. This sample<span>&nbsp;supports synchronization of the MS Office documents, avoiding the creation of the temporary files in the remote storage as well as it does not rename or delete the document in your remote storage during MS Office transactional save operation, preserving all data associated with a file in your remote storage.</span></p>
+<p>Another major difference between the Virtual Drive sample and the <a title="Virtual File System Sample for Windows" href="https://www.userfilesystem.com/examples/virtual_file_system/">Virtual File System</a> sample is its support for Microsoft Office Documents editing. This sample<span>&nbsp;supports synchronization of the MS Office documents, avoiding the creation of the temporary files in the remote storage as well as it does not rename or delete the document in your remote storage during MS Office transactional save operation, preserving all data associated with a file in your remote storage.</span></p>
 <p><span>This sample automatically locks the Microsoft Office document in the remote storage when a document is being opened for editing and automatically unlocks the document when the file is closed. When the document is opened you will see the lock icon&nbsp;<img id="__mcenew" alt="Lock icon" src="https://www.userfilesystem.com/media/2071/locked.png" rel="120785"> in the Status column in Windows File Manager:</span></p>
 <p><span>&nbsp;<img id="__mcenew" alt="Virtual Drive sample shows lock icon for Microsoft Office documents" src="https://www.userfilesystem.com/media/2133/virtualdrivemsoffice.png" rel="122441"></span></p>
 <p><span>The information about the lock (lock-token, etc.) is being saved on the client machine when the document is locked.</span>&nbsp;When a document is modified on the client,&nbsp;all changes to the document are being saved on the local drive, without being sent to the remote storage. You will see the not In-Sync icon&nbsp;<img id="__mcenew" alt="" src="https://www.userfilesystem.com/media/1987/notinsyncfile.png" rel="118450"> being displayed when you modify and save the document. The updated document content is sent to the remote storage when the document is closed, together with the lock-token and eTag.&nbsp;</p>

Windows/VirtualDrive/VirtualDrive/MsOfficeDocsMonitor.cs

@@ -102,10 +102,9 @@ private async void DeletedAsync(object sender, FileSystemEventArgs e)
         /// </summary>
         private async void RenamedAsync(object sender, RenamedEventArgs e)
         {
-            // If the item and was previusly filtered by EngineWindows.FilterAsync(),
-            // for example temp MS Office file was renamed SGE4274H->file.xlsx,
+            // If the item was previously filtered by EngineWindows.FilterAsync(),
+            // for example temp MS Office file was renamed SGE4274H -> file.xlsx,
             // we need to convert the file to a pleaceholder and upload it to the remote storage.
-            // We must also 
 
             LogMessage("Renamed", e.OldFullPath, e.FullPath);
 
@@ -125,7 +124,7 @@ private async void RenamedAsync(object sender, RenamedEventArgs e)
                         else
                         {
                             LogMessage("Converting to placeholder", userFileSystemNewPath);
-                            PlaceholderItem.ConvertToPlaceholder(userFileSystemNewPath, null, false);
+                            PlaceholderItem.ConvertToPlaceholder(userFileSystemNewPath, null, null, false);
                             await engine.ClientNotifications(userFileSystemNewPath, this).UpdateAsync();
                             await engine.CustomDataManager(userFileSystemNewPath).RefreshCustomColumnsAsync();
                         }

Windows/VirtualDrive/VirtualDrive/Program.cs

@@ -34,7 +34,7 @@ class Program
         /// </summary>
         public static VirtualEngine Engine;
 
-        static async Task<int> Main(string[] args)
+        static async Task Main(string[] args)
         {
             // Load Settings.
             IConfiguration configuration = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true).Build();
@@ -63,6 +63,9 @@ static async Task<int> Main(string[] args)
 
                 await Registrar.RegisterAsync(SyncRootId, Settings.UserFileSystemRootPath, Settings.ProductName,
                     Path.Combine(Settings.IconsFolderPath, "Drive.ico"));
+
+                // Register thumbnail provider.
+                ThumbnailInstaller.Register();
             }
             else
             {
@@ -88,9 +91,6 @@ await Registrar.RegisterAsync(SyncRootId, Settings.UserFileSystemRootPath, Setti
                 // Start processing OS file system calls.
                 await Engine.StartAsync();
 
-                // Register thumbnail provider
-                ThumbnailInstaller.Register();
-
 #if DEBUG
                 // Opens Windows File Manager with user file system folder and remote storage folder.
                 ShowTestEnvironment();
@@ -143,8 +143,6 @@ await Registrar.RegisterAsync(SyncRootId, Settings.UserFileSystemRootPath, Setti
             {
                 log.Info("\n\nAll downloaded file / folder placeholders remain in file system. Restart the application to continue managing files.\n");
             }
-
-            return 1;
         }
 
 #if DEBUG