v1.3.4102.0

Author: ITHitBuild

VirtualFileSystem/Framework/Syncronyzation/UserFileSystemMonitor.cs

@@ -32,7 +32,7 @@ internal class UserFileSystemMonitor : Logger, IDisposable
         private FileSystemWatcher watcher = new FileSystemWatcher();
 
         /// <summary>
-        /// User file system root path. Folder to minitor changes in.
+        /// User file system root path. Folder to monitor for changes.
         /// </summary>
         private string userFileSystemRootPath;
 

VirtualFileSystem/Framework/VfsFile.cs

@@ -7,7 +7,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 using VirtualFileSystem.Syncronyzation;
-using Windows.UI.Xaml;
 
 namespace VirtualFileSystem
 {

VirtualFileSystem/Program.cs

@@ -59,9 +59,9 @@ static async Task<int> Main(string[] args)
             XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
 
             log.Info($"\n{System.Diagnostics.Process.GetCurrentProcess().ProcessName}");
-            log.Info("\nPress any other key to exit without unregistering (simulate reboot).");
-            log.Info("\nPress 'q' to unregister file system and exit (simulate uninstall).");
             log.Info("\nPress 'Q' to unregister file system, delete all files/folders and exit (simulate uninstall with full cleanup).");
+            log.Info("\nPress 'q' to unregister file system and exit (simulate uninstall).");
+            log.Info("\nPress any other key to exit without unregistering (simulate reboot).");
             log.Info("\n----------------------\n");
 
             // Typically you will register sync root during your application installation.
@@ -70,7 +70,7 @@ static async Task<int> Main(string[] args)
             {
                 Directory.CreateDirectory(Settings.UserFileSystemRootPath);
                 log.Info($"\nRegistering {Settings.UserFileSystemRootPath} sync root.");
-                await Registrar.RegisterAsync(SyncRootId, Settings.UserFileSystemRootPath, "My Virtual File System");
+                await Registrar.RegisterAsync(SyncRootId, Settings.UserFileSystemRootPath, Settings.ProductName);
             }
             else
             {

VirtualFileSystem/README.md

@@ -21,7 +21,7 @@
 <p>To run the sample open the project in Visual Studio and run the project in a debug mode.&nbsp;In the debug mode this sample provides additional support for the development and testing convenience. When starting in the debug mode, it will automatically create a folder in which the virtual file system will reside, register the user file system with the platform and then open&nbsp;two instances of Windows File Manager, one of which will show a user file system and another a folder simulating remote storage:</p>
 <p>&nbsp;<img id="__mcenew" alt="Virtual File System Sample Initial Run" src="https://www.userfilesystem.com/media/1985/virtualfilesysteminitialrun.png" rel="116795"></p>
 <p>You can start managing and editing files in the <span class="code">\RemoteStorage\</span> folder immediately after the Windows File Managers open and will see all changes being propagated to the user file system. You can also edit documents and manage file structure in the user file system and all changes will automatically appear in the remote storage folder.</p>
-<p>This sample implements on-demand loading. After running the sample all files and folders are marked with a cloud icon<img id="__mcenew" alt="Offline File" src="https://www.userfilesystem.com/media/1988/offilefile.png" rel="116798" data-allowlink="false">, which means that the content of this file or folder is not available locally but instead resides in the remote location. Even though the file shows the correct size in the Size column, the file occupies zero bytes on disk. You can open the file Properties dialog to check the "Size on disk" value. You can see in the console log that only root folder files and folders placeholders are being created when Windows File Manager listed the root folder content. Folders located deeper in the hierarchy is not loaded, until their content is being requested by platform file system calls.&nbsp;</p>
+<p>This sample implements on-demand loading. After running the sample all files and folders are marked with a cloud icon<img id="__mcenew" alt="Offline File" src="https://www.userfilesystem.com/media/1988/offilefile.png" rel="116798" data-allowlink="false">, which means that the content of this file or folder is not available locally but instead resides in the remote location. Even though the file shows the correct size in the Size column, the file occupies zero bytes on the disk. You can open the file Properties dialog to check the "Size on disk" value. You can see in the console log that only root folder files and folders placeholders are being created when Windows File Manager listed the root folder content. Folders located deeper in the hierarchy are not loaded, until their content is being requested by the platform file system calls.&nbsp;</p>
 <p>When any application is accessing the file, located under the <span class="code">\VFS\</span> folder, opening it for reading or writing, the operating system redirects the call to this sample, which loads file content from the remote storage folder. The file becomes marked with a green check-mark on a white background icon<img id="__mcenew" alt="Local File" src="https://www.userfilesystem.com/media/1986/localfile.png" rel="116799" data-allowlink="false">, which means the file content is present on the local disk:</p>
 <p style="text-align: center;"><img id="__mcenew" alt="Local Cloud File. Green check-mark on a white background icon means the file content is present on the local disk." src="https://www.userfilesystem.com/media/1983/localcloudfile.png" rel="116801"></p>
 <p>The Windows File Manager provides the "Always keep on this device" and "Free up space" context menus, which are standard menus provided by Windows OS. If you select the&nbsp;"Always keep on this device" the file or entire folder structure will be recursively loaded to the local disk and all files content will be loaded to local disk and will become available offline. All files and folders are be marked with a pinned file icon<img id="__mcenew" alt="Pinned File" src="https://www.userfilesystem.com/media/1989/pinnedfile.png" rel="116800" data-allowlink="false">. Pinned files will not be deleted from the drive even if it runs low on space.</p>
@@ -32,9 +32,10 @@
 <h2>Microsoft Office Documents Synchronization</h2>
 <p>This sample supports the synchronization of the MS Office documents, avoiding the creation of the temporary files in remote storage. Note that for the sake of simplicity this sample filters MS Office temporary files only during user file system to remote storage synchronization. It is expected that MS Office temporary files are not created in remote storage and you do not need to synchronize them from server to client. Do NOT edit MS Office files directly in the folder simulating the remote storage.</p>
 <h2>Stopping the Sample</h2>
-<p>You can exit the sample running in the debug mode in 2 ways:</p>
+<p>You can exit the sample running in the debug mode in 3 ways:</p>
 <ul>
-<li>If you press 'q' the user file system will be unregistered. All files and folders downloaded on disk will be converted into the regular files and folders. The offline files and folders will disappear. This simulates your application's uninstallation process.</li>
+<li>If you press 'Q' the user file system will be unregistered and all files will be deleted. This simulates uninstall with complete cleanup.&nbsp;</li>
+<li>If you press 'q' the user file system will be unregistered. All files and folders downloaded on disk will be converted into regular files and folders. The offline files and folders will disappear. This simulates your application's uninstallation process.</li>
 <li>If you press any other key, the application will exit without unregistering the user file system. All files and folders placeholders, their attributes, and states remain in the user file system, even though most of the functionality, such as downloading file content or listing folder content for offline folders are unavailable. You can start this sample again to continue managing documents. This simulates the machine reboot or application failure.</li>
 </ul>
 <h2>How the Sample Works</h2>
@@ -57,9 +58,11 @@
 <p>The complete synchronization is performed in the&nbsp;<span class="code">SyncService</span> class. Due to the nature of this sample, this class goes folder-by-folder to synchronize the entire file system. This class first processes moved/renamed files and folders and then creates, deletes, and updates files and folders.</p>
 <p>Because of the simplicity of this sample, the files deleted in the user file system, then this Virtual File System sample application was not running, or during network or server outage, are not synched to remote storage (they are normally deleted inside <span class="code">VfsFileSystemItem</span>.<span class="code">DeleteAsync()</span>&nbsp;call). Instead, the file will be restored in the user file system when the synchronization service runs.</p>
 <p>You can adapt the <span class="code">SyncService</span> class implementation to your needs depending on your remote storage type.</p>
+<h2>File ETags</h2>
+<p>When listing folder content the client reads file ETags and saves them in local file system. When sending modified content to the server, the client attaches the saved etag to the request. The server compares etags to ensure the file was not modified on the server since the file was read by the client. In the case of Microsoft Office documents, etags provide one more level of protection against overwriting server changes in addition to locks.</p>
+<p>Because of the nature of the remote storage simulation, this sample is using file/folder last modification date/time as an ETag. In your real-life storage, you will update ETag during each file modification in your storage and will NOT use the file/folder modification date.</p>
 <h2>In-Sync Status and ETag Usage For Synchronization</h2>
-<p>Synchronization in this Virtual File System sample is based on In-Sync file status as well as on ETag received from the server.</p>
-<p>During remote storage to user file system synchronization, each file/folder receives an ETag from the server and stores it in custom data associated with the file/folder in the user file system. The remote storage to user file system synchronization is performed only if the file on the client is marked as In-Sync (<img id="__mcenew" alt="In-Sync icon" src="https://www.userfilesystem.com/media/1986/localfile.png" rel="118449">&nbsp;or&nbsp;<img id="__mcenew" alt="Pinned file" src="https://www.userfilesystem.com/media/1989/pinnedfile.png" rel="118452">&nbsp;or&nbsp;<img id="__mcenew" alt="Cloud file" src="https://www.userfilesystem.com/media/1988/offilefile.png" rel="118451">)&nbsp;with the server. If the file is modified on the server and is marked as not In-Sync on the client, the files are considered to be in conflict, the conflict icon is displayed.</p>
-<p>When any file or folder in the user file system is updated it is marked as not In-Sync<img id="__mcenew" alt="Not in sync icon" src="https://www.userfilesystem.com/media/1987/notinsyncfile.png" rel="118450">, which means the content must be sent to the server. During the user file system to remote storage synchronization, the ETag stored with the file on the client is compared with the ETag in the remote storage, to avoid the server changes to be overwritten. The file/folder is updated only if the ETags match. Otherwise, the file/folder is considered to be in conflict and marked with the conflict icon.</p>
-<p>Because of the nature of the remote storage simulation, this sample is using file/folder last modification date/time as an ETag. Instead, in your real-life storage, you will update ETag during each file modification in your storage and will NOT use the file/folder modification date.</p>
+<p>Synchronization in this sample is based on In-Sync file status as well as on the ETag received from the server.</p>
+<p>The server to client synchronization is performed only if the file on the client is marked as In-Sync&nbsp;with the server&nbsp;(it is marked with<img id="__mcenew" alt="In-Sync icon" src="https://www.userfilesystem.com/media/1986/localfile.png" rel="118449">&nbsp;or&nbsp;<img id="__mcenew" alt="Pinned file" src="https://www.userfilesystem.com/media/1989/pinnedfile.png" rel="118452">&nbsp;or&nbsp;<img id="__mcenew" alt="Cloud file" src="https://www.userfilesystem.com/media/1988/offilefile.png" rel="118451">icon). If the file is modified on the server and is marked as not In-Sync on the client, the files are considered to be in conflict and the conflict icon is displayed.</p>
+<p>When any file or folder on the client is updated, it is marked as not In-Sync<img id="__mcenew" alt="Not in sync icon" src="https://www.userfilesystem.com/media/1987/notinsyncfile.png" rel="118450">, which means the content must be sent to the server. When the updated file is being sent from client to server, the server compares the ETag sent from the client with the ETag stored on the server, to avoid the server changes to be overwritten. The file/folder is updated only if the ETags match. Otherwise, the file/folder is considered to be in conflict and marked with the conflict icon.</p>
 

VirtualFileSystem/RemoteStorageMonitor.cs

@@ -32,7 +32,7 @@ internal class RemoteStorageMonitor : Logger, IDisposable
         private FileSystemWatcher watcher = new FileSystemWatcher();
 
         /// <summary>
-        /// Remote storage path. Folder to minitor changes in.
+        /// Remote storage path. Folder to monitor for changes.
         /// </summary>
         private string remoteStorageRootPath;
 

VirtualFileSystem/Settings.cs

@@ -1,7 +1,9 @@
 using Microsoft.Extensions.Configuration;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
+using System.Reflection;
 using System.Text;
 using System.Threading.Tasks;
 
@@ -46,6 +48,12 @@ public class Settings
         /// </summary>
         public string IconsFolderPath { get; set; }
 
+        /// <summary>
+        /// Product name. Displayed as a mounted folder name under Desktop as 
+        /// well in every location where product name is required.
+        /// </summary>
+        public string ProductName { get; set; }
+
         /// <summary>
         /// Path to the folder that stores ETags, locks and other data associated with files and folders.
         /// </summary>
@@ -109,13 +117,17 @@ public static Settings ReadSettings(this IConfiguration configuration)
                 Directory.CreateDirectory(settings.UserFileSystemRootPath);
             }
 
+            string assemblyLocation = Assembly.GetEntryAssembly().Location;
+
             // Icons folder.
-            settings.IconsFolderPath = Path.Combine(Path.GetDirectoryName(System.Reflection.Assembly.GetExecutingAssembly().Location), @"Images");
+            settings.IconsFolderPath = Path.Combine(Path.GetDirectoryName(assemblyLocation), @"Images");
 
-            // Folder where eTags and file locks are sored.
-            string localApplicationDataFolderPath = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
-            settings.ServerDataFolderPath = Path.Combine(localApplicationDataFolderPath, settings.UserFileSystemRootPath.Replace(":", ""), "ServerData");
+            // Load product name from entry exe file.
+            settings.ProductName = FileVersionInfo.GetVersionInfo(assemblyLocation).ProductName;
 
+            // Folder where eTags and file locks are stored.
+            string localApplicationDataFolderPath = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
+            settings.ServerDataFolderPath = Path.Combine(localApplicationDataFolderPath, settings.ProductName, settings.UserFileSystemRootPath.Replace(":", ""), "ServerData");
 
             return settings;
         }

VirtualFileSystem/VirtualFileSystem.csproj

@@ -7,6 +7,9 @@
     <Product>Virtual File System</Product>
     <Copyright>IT Hit LTD.</Copyright>
     <Platforms>AnyCPU</Platforms>
+    <Description>A virtual file system with synchronization support, on-demand loading, selective offline files support, upload and download progress, and error reporting. It synchronizes files and folders both from remote storage to the user file system and from the user file system to remote storage. 
+
+To simulate the remote storage, this sample is using a folder in the local file system on the same machine.</Description>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
     <AllowUnsafeBlocks>false</AllowUnsafeBlocks>
@@ -29,7 +32,7 @@
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="3.1.7" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="ITHit.FileSystem.Windows" Version="1.3.4067.0" />
+    <PackageReference Include="ITHit.FileSystem.Windows" Version="1.3.4102.0" />
   </ItemGroup>
   <ItemGroup>
     <None Update="appsettings.json">