v1.2.3810.0

Author: ITHitBuild

README.md

@@ -0,0 +1,46 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+
+namespace VirtualFileSystem
+{
+    /// <summary>
+    /// Thrown when a file can not be locked. For example when a lock-token file is blocked 
+    /// from another thread, during update, lock and unlock operations.  
+    /// </summary>
+    public class ClientLockFailedException : IOException
+    {
+        /// <summary>
+        /// Creates instance of this class.
+        /// </summary>
+        /// <param name="message">The error message that explains the reason for the exception.</param>
+        public ClientLockFailedException(string message) : base(message)
+        {
+        }
+
+        /// <summary>
+        /// Creates instance of this class with a specified
+        /// error message and a reference to the inner exception that is the cause of this
+        /// exception.
+        /// </summary>
+        /// <param name="message">The error message that explains the reason for the exception.</param>
+        /// <param name="innerException">
+        /// The exception that is the cause of the current exception. If the innerException
+        /// parameter is not null, the current exception is raised in a catch block that
+        /// handles the inner exception.
+        /// </param>
+        public ClientLockFailedException(string message, Exception innerException) : base(message, innerException)
+        {
+        }
+
+        /// <summary>
+        /// Creates instance of this class with a message and HRESULT code.
+        /// </summary>
+        /// <param name="message">The error message that explains the reason for the exception.</param>
+        /// <param name="hresult">An integer identifying the error that has occurred.</param>
+        public ClientLockFailedException(string message, int hresult) : base(message, hresult)
+        {
+        }
+    }
+}

VirtualFileSystem/Framework/ClientLockFailedException.cs

@@ -95,7 +95,8 @@ public static string GetOriginalPath(this PlaceholderItem placeholder)
         }
 
         /// <summary>
-        /// Returns true if the file was moved in the user file system and changes not yet synched to the remote storage.
+        /// Returns true if the file was moved in the user file system and 
+        /// changes not yet synched to the remote storage.
         /// </summary>
         public static bool IsMoved(this PlaceholderItem placeholder)
         {
@@ -110,13 +111,20 @@ public static bool IsMoved(this PlaceholderItem placeholder)
             return !originalPath.Equals(placeholder.Path, StringComparison.InvariantCultureIgnoreCase);
         }
 
+        /// <summary>
+        /// Returns true if the item was created and must be synched to remote storage.
+        /// </summary>
+        /// <returns>
+        /// True if the item was created in the user file system and does not exists 
+        /// in the remote storage. False otherwise.
+        /// </returns>
         public static bool IsNew(this PlaceholderItem placeholder)
         {
-            // ETag presence signals if the item is new.
+            // ETag absence signals that the item is new.
             // However, ETag file may not exists during move operation, 
             // additionally checking OriginalPath presence.
             // Can not rely on OriginalPath only, 
-            // because MS Office transactional save deletes and recreates the file.
+            // because MS Office files are being deleted and re-created during transactional save.
 
             string originalPath = placeholder.GetOriginalPath();
 

VirtualFileSystem/Framework/CustomData.cs

@@ -42,10 +42,10 @@ public static async Task<string> GetETagAsync(string userFileSystemPath)
         /// <summary>
         /// Deletes ETag associated with a file.
         /// </summary>
-        /// <param name="userFileSystemSourcePath">Path in the user file system.</param>
-        public static void DeleteETag(string userFileSystemSourcePath)
+        /// <param name="userFileSystemPath">Path in the user file system.</param>
+        public static void DeleteETag(string userFileSystemPath)
         {
-            File.Delete(GetETagFilePath(userFileSystemSourcePath));
+            File.Delete(GetETagFilePath(userFileSystemPath));
         }
 
         /// <summary>

VirtualFileSystem/Framework/ETag.cs

@@ -114,22 +114,23 @@ public static string GetAttString(string path)
         }
 
         /// <summary>
-        /// Returns true if the file hase a format ~XXXXX.tmp, false - otherwise.
+        /// Returns true if the file is in ~XXXXX.tmp, pptXXXX.tmp format, false - otherwise.
         /// </summary>
-        /// <param name="path">Path to a file or folder.</param>
+        /// <param name="path">Path to a file.</param>
         private static bool IsMsOfficeTemp(string path)
         {
-            return (Path.GetFileName(path).StartsWith('~')   && Path.GetExtension(path).Equals(".tmp", StringComparison.InvariantCultureIgnoreCase))  // Word temp files
-                || (Path.GetFileName(path).StartsWith("ppt") && Path.GetExtension(path).Equals(".tmp", StringComparison.InvariantCultureIgnoreCase)) // PowerPoint temp files
-                || (string.IsNullOrEmpty(Path.GetExtension(path)) && (Path.GetFileName(path).Length == 8)); // Excel temp files
+            return (Path.GetFileName(path).StartsWith('~')   && Path.GetExtension(path).Equals(".tmp", StringComparison.InvariantCultureIgnoreCase))    // Word temp files
+                || (Path.GetFileName(path).StartsWith("ppt") && Path.GetExtension(path).Equals(".tmp", StringComparison.InvariantCultureIgnoreCase))    // PowerPoint temp files
+                || (string.IsNullOrEmpty(Path.GetExtension(path)) && (Path.GetFileName(path).Length == 8))                                              // Excel temp files
+                || ((Path.GetFileNameWithoutExtension(path).Length == 8) && Path.GetExtension(path).Equals(".tmp", StringComparison.InvariantCultureIgnoreCase));   // Excel temp files
         }
 
         /// <summary>
         /// Returns true if file system contains MS Office lock file (~$file.ext) in file 
         /// system that corresponds to the provided path to MS Office file. 
         /// </summary>
         /// <param name="path">Path to MS Office file.</param>
-        private static bool IsMsOfficeLocked(string path)
+        internal static bool IsMsOfficeLocked(string path)
         {
             string lockPath = GetLockPathFromMsOfficePath(path);
             return lockPath != null;
@@ -140,18 +141,18 @@ private static bool IsMsOfficeLocked(string path)
         /// Returns true if the provided path points to MS Office lock file (~$file.ext). 
         /// </summary>
         /// <param name="path">Path to lock file.</param>
-        private static bool IsMsOfficeLockFile(string path)
+        internal static bool IsMsOfficeLockFile(string path)
         {
             return Path.GetFileName(path).StartsWith("~$");
         }
 
-        /*
-        public static string GetMsOfficePathFromLock(string msOfficeLockFilePath)
-        {
-            int separatorIndex = msOfficeLockFilePath.LastIndexOf(Path.DirectorySeparatorChar);
-            return msOfficeLockFilePath.Remove(separatorIndex + 1, "~$".Length);
-        }
-        */
+        
+        //public static string GetMsOfficePathFromLock(string msOfficeLockFilePath)
+        //{
+        //    int separatorIndex = msOfficeLockFilePath.LastIndexOf(Path.DirectorySeparatorChar);
+        //    return msOfficeLockFilePath.Remove(separatorIndex + 1, "~$".Length);
+        //}
+        
 
         /// <summary>
         /// Returns MS Office lock file path if such file exists.
@@ -222,6 +223,15 @@ public static bool AvoidSync(string path)
             return IsMsOfficeLockFile(path) || IsMsOfficeLocked(path) || IsMsOfficeTemp(path) || IsHiddenOrTemp(path);
         }
 
+        /// <summary>
+        /// Returns true if the file or folder should not be automatically locked. False - otherwise.
+        /// </summary>
+        /// <param name="path">Path to a file or folder.</param>
+        public static bool AvoidAutoLock(string path)
+        {
+            return IsMsOfficeLockFile(path) ||                           IsMsOfficeTemp(path) || IsHiddenOrTemp(path);
+        }
+
         /// <summary>
         /// Gets formatted file size or null for folders or if the file is not found.
         /// </summary>
@@ -253,5 +263,27 @@ public static string Size(string path)
             double num = Math.Round(bytes / Math.Pow(1024, place), 1);
             return (Math.Sign(length) * num).ToString() + suf[place];
         }
+
+        /// <summary>
+        /// Returns true if the file is locked for writing, false otherwise.
+        /// </summary>
+        /// <param name="path">Path ot a file.</param>
+        /// <returns>True if the file is locked for writing. False otherwise.</returns>
+        public static bool IsWriteLocked(string path)
+        {
+            try
+            {
+                using (FileStream stream = File.Open(path, FileMode.Open, FileAccess.Read, FileShare.Read | FileShare.Delete))
+                {
+                    stream.Close();
+                }
+            }
+            catch (IOException)
+            {
+                return true;
+            }
+
+            return false;
+        }
     }
 }