Merge branch 'master' of https://github.com/rmcrackan/Libation

AppScaffolding/AppScaffolding.csproj

@@ -3,7 +3,7 @@
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
-    <Version>6.7.2.1</Version>
+    <Version>6.7.6.2</Version>
   </PropertyGroup>
 
   <ItemGroup>

AppScaffolding/LibationScaffolding.cs

@@ -230,10 +230,10 @@ namespace AppScaffolding
 				config.InProgress,
 
 				AudibleFileStorage.DownloadsInProgressDirectory,
-				DownloadsInProgressFiles = Directory.EnumerateFiles(AudibleFileStorage.DownloadsInProgressDirectory).Count(),
+				DownloadsInProgressFiles = FileManager.FileUtility.SaferEnumerateFiles(AudibleFileStorage.DownloadsInProgressDirectory).Count(),
 
 				AudibleFileStorage.DecryptInProgressDirectory,
-				DecryptInProgressFiles = Directory.EnumerateFiles(AudibleFileStorage.DecryptInProgressDirectory).Count(),
+				DecryptInProgressFiles = FileManager.FileUtility.SaferEnumerateFiles(AudibleFileStorage.DecryptInProgressDirectory).Count(),
 			});
 		}
 

FileManager/BackgroundFileSystem.cs

@@ -43,7 +43,7 @@ namespace FileManager
             lock (fsCacheLocker)
             {
                 fsCache.Clear();
-                fsCache.AddRange(Directory.EnumerateFiles(RootDirectory, SearchPattern, SearchOption));
+                fsCache.AddRange(FileUtility.SaferEnumerateFiles(RootDirectory, SearchPattern, SearchOption));
             }
         }
 
@@ -52,7 +52,7 @@ namespace FileManager
             Stop();
 
             lock (fsCacheLocker)
-                fsCache.AddRange(Directory.EnumerateFiles(RootDirectory, SearchPattern, SearchOption));
+                fsCache.AddRange(FileUtility.SaferEnumerateFiles(RootDirectory, SearchPattern, SearchOption));
 
             directoryChangesEvents = new BlockingCollection<FileSystemEventArgs>();
 			fileSystemWatcher = new FileSystemWatcher(RootDirectory)
@@ -135,7 +135,7 @@ namespace FileManager
         private void AddPath(string path)
         {
             if (File.GetAttributes(path).HasFlag(FileAttributes.Directory))
-                AddUniqueFiles(Directory.EnumerateFiles(path, SearchPattern, SearchOption));
+                AddUniqueFiles(FileUtility.SaferEnumerateFiles(path, SearchPattern, SearchOption));
             else
                 AddUniqueFile(path);
         }

FileManager/FileUtility.cs

@@ -139,7 +139,7 @@ namespace FileManager
             return path[0] + remainder;
         }
 
-        private static string removeInvalidWhitespace_pattern { get; } = $@"\s*\{Path.DirectorySeparatorChar}\s*";
+        private static string removeInvalidWhitespace_pattern { get; } = $@"[\s\.]*\{Path.DirectorySeparatorChar}\s*";
         private static Regex removeInvalidWhitespace_regex { get; } = new(removeInvalidWhitespace_pattern, RegexOptions.Compiled | RegexOptions.IgnorePatternWhitespace);
 
         /// <summary>no part of the path may begin or end in whitespace</summary>
@@ -149,14 +149,20 @@ namespace FileManager
             // replace whitespace around path slashes
             //    regex (with space added for clarity)
             //    \s*  \\  \s*    =>    \
-            fullfilename = fullfilename.Trim();
-            
-            fullfilename = removeInvalidWhitespace_regex.Replace(fullfilename, @"\");
+            // no ending dots. beginning dots are valid
+
+            // regex is easier by ending with separator
+            fullfilename += Path.DirectorySeparatorChar;
+            fullfilename = removeInvalidWhitespace_regex.Replace(fullfilename, Path.DirectorySeparatorChar.ToString());
+            // take seperator back off
+            fullfilename = RemoveLastCharacter(fullfilename);
 
             fullfilename = removeDoubleSlashes(fullfilename);
             return fullfilename;
         }
 
+        public static string RemoveLastCharacter(this string str) => string.IsNullOrEmpty(str) ? str : str[..^1];
+
         /// <summary>
         /// Move file.
         /// <br/>- Ensure valid file name path: remove invalid chars, ensure uniqueness, enforce max file length
@@ -183,15 +189,19 @@ namespace FileManager
             {
                 try
                 {
-                    if (File.Exists(source))
+                    if (!File.Exists(source))
                     {
-                        File.Delete(source);
-                        Serilog.Log.Logger.Information("File successfully deleted", new { source });
+                        Serilog.Log.Logger.Debug("No file to delete: {@DebugText}", new { source });
+                        return;
                     }
+
+                    Serilog.Log.Logger.Debug("Attempt to delete file: {@DebugText}", new { source });
+                    File.Delete(source);
+                    Serilog.Log.Logger.Information("File successfully deleted: {@DebugText}", new { source });
                 }
                 catch (Exception e)
                 {
-                    Serilog.Log.Logger.Error(e, "Failed to delete file", new { source });
+                    Serilog.Log.Logger.Error(e, "Failed to delete file: {@DebugText}", new { source });
                     throw;
                 }
             });
@@ -202,19 +212,61 @@ namespace FileManager
             {
                 try
                 {
-                    if (File.Exists(source))
+                    if (!File.Exists(source))
                     {
-                        SaferDelete(destination);
-                        Directory.CreateDirectory(Path.GetDirectoryName(destination));
-                        File.Move(source, destination);
-                        Serilog.Log.Logger.Information("File successfully moved", new { source, destination });
+                        Serilog.Log.Logger.Debug("No file to move: {@DebugText}", new { source });
+                        return;
                     }
+
+                    SaferDelete(destination);
+
+                    var dir = Path.GetDirectoryName(destination);
+                    Serilog.Log.Logger.Debug("Attempt to create directory: {@DebugText}", new { dir });
+                    Directory.CreateDirectory(dir);
+
+                    Serilog.Log.Logger.Debug("Attempt to move file: {@DebugText}", new { source, destination });
+                    File.Move(source, destination);
+                    Serilog.Log.Logger.Information("File successfully moved: {@DebugText}", new { source, destination });
                 }
                 catch (Exception e)
                 {
-                    Serilog.Log.Logger.Error(e, "Failed to move file", new { source, destination });
+                    Serilog.Log.Logger.Error(e, "Failed to move file: {@DebugText}", new { source, destination });
                     throw;
                 }
             });
+
+        /// <summary>
+        /// A safer way to get all the files in a directory and sub directory without crashing on UnauthorizedException or PathTooLongException
+        /// </summary>
+        /// <param name="rootPath">Starting directory</param>
+        /// <param name="patternMatch">Filename pattern match</param>
+        /// <param name="searchOption">Search subdirectories or only top level directory for files</param>
+        /// <returns>List of files</returns>
+        public static IEnumerable<string> SaferEnumerateFiles(string path, string searchPattern = "*", SearchOption searchOption = SearchOption.TopDirectoryOnly)
+        {
+            var foundFiles = Enumerable.Empty<string>();
+
+            if (searchOption == SearchOption.AllDirectories)
+            {
+                try
+                {
+                    IEnumerable<string> subDirs = Directory.EnumerateDirectories(path);
+                    // Add files in subdirectories recursively to the list
+                    foreach (string dir in subDirs)
+                        foundFiles = foundFiles.Concat(SaferEnumerateFiles(dir, searchPattern, searchOption));
+                }
+                catch (UnauthorizedAccessException) { }
+                catch (PathTooLongException) { }
+            }
+
+            try
+            {
+                // Add files from the current directory
+                foundFiles = foundFiles.Concat(Directory.EnumerateFiles(path, searchPattern));
+            }
+            catch (UnauthorizedAccessException) { }
+
+            return foundFiles;
+        }
     }
 }

LibationFileManager/AudibleFileStorage.cs

@@ -73,8 +73,8 @@ namespace LibationFileManager
         protected override string GetFilePathCustom(string productId)
         {
             var regex = GetBookSearchRegex(productId);
-            return Directory
-                .EnumerateFiles(DownloadsInProgressDirectory, "*.*", SearchOption.AllDirectories)
+            return FileUtility
+                .SaferEnumerateFiles(DownloadsInProgressDirectory, "*.*", SearchOption.AllDirectories)
                 .FirstOrDefault(s => regex.IsMatch(s));
         }
 

LibationFileManager/TagsPersistence.cs

@@ -54,11 +54,17 @@ namespace LibationFileManager
 
 		private static void ensureCache()
 		{
-			if (cache is null)
-				lock (locker)
-					cache = !File.Exists(TagsFile)
-						? new Dictionary<string, string>()
-						: JsonConvert.DeserializeObject<Dictionary<string, string>>(File.ReadAllText(TagsFile));
+			if (cache is not null)
+				return;
+
+			lock (locker)
+			{
+				if (File.Exists(TagsFile))
+					cache = JsonConvert.DeserializeObject<Dictionary<string, string>>(File.ReadAllText(TagsFile));
+
+				// if file doesn't exist. or if file is corrupt and deserialize returns null
+				cache ??= new Dictionary<string, string>();
+			}
 		}
 	}
 }

README.md

@@ -92,6 +92,26 @@ Or if you have multiple accounts, you'll get to choose whether to scan all accou
 
 ![Import which accounts](images/v40_import.png)
 
+If this is a new installation, or you're scanning an account you haven't scanned before, you'll be prompted to enter your password for the Audible account.
+
+![Login password](images/alt-login1.png)
+
+Enter the password and click Submit. Audible will prompt you with a CAPTCHA image. 
+
+![Login captcha](images/alt-login2.png)
+
+Enter the CAPTCHA answer characters and click Submit. If all has gone well, Libation will start scanning the account. 
+
+In rare instances, the Captcha image/response will fail in an endless loop. If this happens, delete the problem account, and then click Save. Re-add the account and click Save again. Now try to scan the account again. This time, instead of typing your password, click the link that says "Or click here". This will open the Audible External Login dialog shown below.
+
+![Login alternative setup](images/alt-login3.png)
+
+You can either copy the URL shown and paste it into your browser or launch the browser directly by clicking Launch in Browser. Audible will display its standard login page. Login, including answering the CAPTCHA on the next page. In some cases, you might have to approve the login from the email account associated with that login, but once the login is successful, you'll see an error message.
+
+![Login alternative login result](images/alt-login4.png)
+
+This actually means you've successfully logged in. Copy the entire URL shown in your browser and return to Libation. Paste that URL into the text box at the bottom of the Audible External Login window and click Submit.
+
 You'll see this window while it's scanning:
 
 ![Import step 2](images/Import2.png)

_Tests/FileManager.Tests/FileUtilityTests.cs

@@ -113,4 +113,51 @@ namespace FileUtilityTests
 		public void Tests(string input, string expected)
 			=> FileUtility.GetStandardizedExtension(input).Should().Be(expected);
 	}
+
+	[TestClass]
+    public class GetValidFilename
+	{
+		[TestMethod]
+		// dot-files
+		[DataRow(@"C:\a bc\x y z\.f i l e.txt")]
+		// dot-folders
+		[DataRow(@"C:\a bc\.x y z\f i l e.txt")]
+		public void Valid(string input) => Tests(input, input);
+
+		[TestMethod]
+		// folder spaces
+		[DataRow(@"C:\   a bc   \x y z   ", @"C:\a bc\x y z")]
+		// file spaces
+		[DataRow(@"C:\a bc\x y z\   f i l e.txt   ", @"C:\a bc\x y z\f i l e.txt")]
+		// eliminate beginning space and end dots and spaces
+		[DataRow(@"C:\a bc\   . . . x y z . . .   \f i l e.txt", @"C:\a bc\. . . x y z\f i l e.txt")]
+		// file end dots
+		[DataRow(@"C:\a bc\x y z\f i l e.txt . . .", @"C:\a bc\x y z\f i l e.txt")]
+		public void Tests(string input, string expected)
+			=> FileUtility.GetValidFilename(input).Should().Be(expected);
+	}
+
+	[TestClass]
+    public class RemoveLastCharacter
+	{
+		[TestMethod]
+		public void is_null() => Tests(null, null);
+
+		[TestMethod]
+		public void empty() => Tests("", "");
+
+		[TestMethod]
+		public void single_space() => Tests(" ", "");
+
+		[TestMethod]
+		public void multiple_space() => Tests("   ", "  ");
+
+		[TestMethod]
+		[DataRow("1", "")]
+		[DataRow("1 ", "1")]
+		[DataRow("12", "1")]
+		[DataRow("123", "12")]
+		public void Tests(string input, string expected)
+			=> FileUtility.RemoveLastCharacter(input).Should().Be(expected);
+	}
 }