Sanitise file paths from AFC service better

Netimobiledevice/Afc/AfcService.cs

@@ -3,6 +3,7 @@
 using Netimobiledevice.Extentions;
 using Netimobiledevice.Lockdown;
 using Netimobiledevice.Plist;
+using Netimobiledevice.Utils;
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -421,8 +422,8 @@ public async Task Pull(string relativeSrc, string dst, CancellationToken cancell
             string[] splitSrc = relativeSrc.Split('/');
             string dstPath = splitSrc.Length > 1 ? Path.Combine(dst, splitSrc[^1]) : Path.Combine(dst, relativeSrc);
             if (OperatingSystem.IsWindows()) {
-                // Windows filesystems can't cope with ':' so we replace these with '-'
-                dstPath = dstPath.Replace(':', '-');
+                // Windows filesystems (NTFS) are more restrictive than unix files systems so we gotta sanitise
+                dstPath = PathSanitiser.SantiseWindowsPath(dstPath);
             }
             Logger?.LogInformation("{src} --> {dst}", src, dst);
 

Netimobiledevice/Netimobiledevice.csproj

@@ -21,7 +21,7 @@
 		<RepositoryUrl>https://github.com/artehe/Netimobiledevice</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
 		<Title>$(AssemblyName)</Title>
-		<Version>2.2.1</Version>
+		<Version>2.2.2</Version>
 	</PropertyGroup>
 
 	<ItemGroup>

Netimobiledevice/Utils/PathSanitiser.cs

@@ -0,0 +1,59 @@
+using System;
+using System.IO;
+using System.Linq;
+using System.Text;
+
+namespace Netimobiledevice.Utils
+{
+    public static class PathSanitiser
+    {
+        private enum WindowsPathParserState
+        {
+            PossibleDriveLetter,
+            PossibleDriveLetterSeparator,
+            Path
+        }
+
+        public static string SantiseWindowsPath(string sourcePath)
+        {
+            if (string.IsNullOrEmpty(sourcePath)) {
+                throw new ArgumentException("sourcePath cannot be null or empty", nameof(sourcePath));
+            }
+
+            // Remove the leading and trailing white spaces so we know we are starting from a sane position
+            sourcePath = sourcePath.Trim();
+
+            StringBuilder output = new StringBuilder(sourcePath.Length);
+            WindowsPathParserState state = WindowsPathParserState.PossibleDriveLetter;
+            foreach (char current in sourcePath) {
+                if (
+                    (current >= 'a' && current <= 'z') ||
+                    (current >= 'A' && current <= 'Z')
+                ) {
+                    output.Append(current);
+                    if (state == WindowsPathParserState.PossibleDriveLetter) {
+                        state = WindowsPathParserState.PossibleDriveLetterSeparator;
+                    }
+                    else {
+                        state = WindowsPathParserState.Path;
+                    }
+                }
+                else if (
+                    current == Path.DirectorySeparatorChar ||
+                    current == Path.AltDirectorySeparatorChar ||
+                    (current == ':' && state == WindowsPathParserState.PossibleDriveLetterSeparator) ||
+                    !Path.GetInvalidFileNameChars().Contains(current)
+                ) {
+
+                    output.Append(current);
+                    state = WindowsPathParserState.Path;
+                }
+                else {
+                    output.Append('_');
+                    state = WindowsPathParserState.Path;
+                }
+            }
+            return output.ToString();
+        }
+    }
+}

NetimobiledeviceTest/Utils/PathSanitiserTests.cs

@@ -0,0 +1,68 @@
+using Netimobiledevice.Utils;
+
+namespace NetimobiledeviceTest.Utils;
+
+[TestClass]
+public class PathSanitiserTests
+{
+    [TestMethod]
+    public void HandleIncorrectWindowsPath()
+    {
+        string sourcePath = @"C:\\Users\\User\\My:Folder*<File>?\\";
+        string resultPath = PathSanitiser.SantiseWindowsPath(sourcePath);
+        string expectedPath = @"C:\\Users\\User\\My_Folder__File__\\";
+        Assert.AreEqual(expectedPath, resultPath);
+    }
+
+    [TestMethod]
+    public void HandleIncorrectWindowsPath2()
+    {
+        string sourcePath = @"C:\path\something\output_at_13:26:43.txt";
+        string resultPath = PathSanitiser.SantiseWindowsPath(sourcePath);
+        string expectedPath = @"C:\path\something\output_at_13_26_43.txt";
+        Assert.AreEqual(expectedPath, resultPath);
+    }
+
+    [TestMethod]
+    public void HandleNormalWindowsPath()
+    {
+        string sourcePath = @"C:\\Users\\User\\MyFolder\\File.txt";
+        string resultPath = PathSanitiser.SantiseWindowsPath(sourcePath);
+        Assert.AreEqual(sourcePath, resultPath);
+    }
+
+    [TestMethod]
+    public void HandleStartingWhiteSpaceWindowsPath()
+    {
+        string sourcePath = @"      C:\\Users\\User\\MyFolder\\File.txt";
+        string resultPath = PathSanitiser.SantiseWindowsPath(sourcePath);
+        string expectedPath = @"C:\\Users\\User\\MyFolder\\File.txt";
+        Assert.AreEqual(expectedPath, resultPath);
+    }
+
+    [TestMethod]
+    public void HandleTrailingWhiteSpaceWindowsPath()
+    {
+        string sourcePath = @"C:\\Users\\User\\MyFolder\\File.txt   ";
+        string resultPath = PathSanitiser.SantiseWindowsPath(sourcePath);
+        string expectedPath = @"C:\\Users\\User\\MyFolder\\File.txt";
+        Assert.AreEqual(expectedPath, resultPath);
+    }
+
+    [TestMethod]
+    public void HandleWhiteSpaceWindowsPath()
+    {
+        string sourcePath = @"      C:\\Users\\User\\MyFolder\\File.txt     ";
+        string resultPath = PathSanitiser.SantiseWindowsPath(sourcePath);
+        string expectedPath = @"C:\\Users\\User\\MyFolder\\File.txt";
+        Assert.AreEqual(expectedPath, resultPath);
+    }
+
+    [TestMethod]
+    public void HandleNoDriveLetterWindowsPath()
+    {
+        string sourcePath = @"Users\\User\\MyFolder\\File.txt";
+        string resultPath = PathSanitiser.SantiseWindowsPath(sourcePath);
+        Assert.AreEqual(sourcePath, resultPath);
+    }
+}