gui: add compress and decompress for lz4 and zst, decompress for xz

mahoshojoHCG · mahoshojoHCG · commit bfdb87b7c8aa · 2024-06-27T23:19:06.000+08:00
diff --git a/WinPartFlash.Gui/Compression/CompressionStreamCopierExtension.cs b/WinPartFlash.Gui/Compression/CompressionStreamCopierExtension.cs
@@ -8,7 +8,12 @@ public static IServiceCollection AddCompressionStreamCopier(this IServiceCollect
     {
         services.AddSingleton<RawStreamCopier>();
         services.AddSingleton<GzipCompressionStreamCopier>();
-        services.AddSingleton<GzipDeCompressionStreamCopier>();
+        services.AddSingleton<GzipDecompressionStreamCopier>();
+        services.AddSingleton<XzDecompressionStreamCopier>();
+        services.AddSingleton<ZstandardCompressionStreamCopier>();
+        services.AddSingleton<ZstandardDecompressionStreamCopier>();
+        services.AddSingleton<Lz4CompressionStreamCopier>();
+        services.AddSingleton<Lz4DecompressionStreamCopier>();
         services.AddSingleton<ICompressionStreamCopierFactory, CompressionStreamCopierFactory>();
         return services;
     }
diff --git a/WinPartFlash.Gui/Compression/CompressionStreamCopierFactory.cs b/WinPartFlash.Gui/Compression/CompressionStreamCopierFactory.cs
@@ -11,10 +11,13 @@ public ICompressionStreamCopier GetCopier(CompressionType compressionType)
         {
             CompressionType.Raw => serviceProvider.GetRequiredService<RawStreamCopier>(),
             CompressionType.GzipCompress => serviceProvider.GetRequiredService<GzipCompressionStreamCopier>(),
-            CompressionType.GzipDecompress => serviceProvider.GetRequiredService<GzipDeCompressionStreamCopier>(),
-            // TODO: Support following methods
-            CompressionType.Lz4Compress => throw new NotSupportedException(),
-            CompressionType.Lz4Decompress => throw new NotSupportedException(),
+            CompressionType.GzipDecompress => serviceProvider.GetRequiredService<GzipDecompressionStreamCopier>(),
+            CompressionType.Lz4Compress => serviceProvider.GetRequiredService<Lz4CompressionStreamCopier>(),
+            CompressionType.Lz4Decompress => serviceProvider.GetRequiredService<Lz4DecompressionStreamCopier>(),
+            CompressionType.XzDecompress => serviceProvider.GetRequiredService<XzDecompressionStreamCopier>(),
+            CompressionType.ZstandardCompress => serviceProvider.GetRequiredService<ZstandardCompressionStreamCopier>(),
+            CompressionType.ZstandardDecompress => serviceProvider
+                .GetRequiredService<ZstandardDecompressionStreamCopier>(),
             _ => throw new ArgumentOutOfRangeException(nameof(compressionType), compressionType, null)
         };
     }
diff --git a/WinPartFlash.Gui/Compression/CompressionType.cs b/WinPartFlash.Gui/Compression/CompressionType.cs
@@ -6,5 +6,8 @@ public enum CompressionType
     GzipCompress,
     GzipDecompress,
     Lz4Compress,
-    Lz4Decompress
+    Lz4Decompress,
+    ZstandardCompress,
+    ZstandardDecompress,
+    XzDecompress
 }
diff --git a/WinPartFlash.Gui/Compression/GzipDecompressionStreamCopier.cs b/WinPartFlash.Gui/Compression/GzipDecompressionStreamCopier.cs
@@ -4,11 +4,11 @@
 
 namespace WinPartFlash.Gui.Compression;
 
-public class GzipDeCompressionStreamCopier : ICompressionStreamCopier
+public class GzipDecompressionStreamCopier : ICompressionStreamCopier
 {
     public async ValueTask CopyToStreamAsync(Stream sourceStream, Stream outputStream)
     {
-        await using var compressionStream = new GZipStream(outputStream, CompressionMode.Decompress);
-        await compressionStream.CopyToAsync(sourceStream);
+        await using var decompressionStream = new GZipStream(sourceStream, CompressionMode.Decompress);
+        await decompressionStream.CopyToAsync(outputStream);
     }
 }
diff --git a/WinPartFlash.Gui/Compression/Lz4CompressionStreamCopier.cs b/WinPartFlash.Gui/Compression/Lz4CompressionStreamCopier.cs
@@ -0,0 +1,14 @@
+using System.IO;
+using System.Threading.Tasks;
+using K4os.Compression.LZ4.Streams;
+
+namespace WinPartFlash.Gui.Compression;
+
+public class Lz4CompressionStreamCopier : ICompressionStreamCopier
+{
+    public async ValueTask CopyToStreamAsync(Stream sourceStream, Stream outputStream)
+    {
+        await using var compressionStream = LZ4Stream.Encode(outputStream);
+        await sourceStream.CopyToAsync(compressionStream);
+    }
+}
diff --git a/WinPartFlash.Gui/Compression/Lz4DecompressionStreamCopier.cs b/WinPartFlash.Gui/Compression/Lz4DecompressionStreamCopier.cs
@@ -0,0 +1,14 @@
+using System.IO;
+using System.Threading.Tasks;
+using K4os.Compression.LZ4.Streams;
+
+namespace WinPartFlash.Gui.Compression;
+
+public class Lz4DecompressionStreamCopier : ICompressionStreamCopier
+{
+    public async ValueTask CopyToStreamAsync(Stream sourceStream, Stream outputStream)
+    {
+        await using var decompressionStream = LZ4Stream.Decode(sourceStream);
+        await decompressionStream.CopyToAsync(outputStream);
+    }
+}
diff --git a/WinPartFlash.Gui/Compression/XzDecompressionStreamCopier.cs b/WinPartFlash.Gui/Compression/XzDecompressionStreamCopier.cs
@@ -0,0 +1,14 @@
+using System.IO;
+using System.Threading.Tasks;
+using SharpCompress.Compressors.Xz;
+
+namespace WinPartFlash.Gui.Compression;
+
+public class XzDecompressionStreamCopier : ICompressionStreamCopier
+{
+    public async ValueTask CopyToStreamAsync(Stream sourceStream, Stream outputStream)
+    {
+        await using var decompressionStream = new XZStream(sourceStream);
+        await decompressionStream.CopyToAsync(outputStream);
+    }
+}
diff --git a/WinPartFlash.Gui/Compression/ZstandardCompressionStreamCopier.cs b/WinPartFlash.Gui/Compression/ZstandardCompressionStreamCopier.cs
@@ -0,0 +1,14 @@
+using System.IO;
+using System.Threading.Tasks;
+using ZstdSharp;
+
+namespace WinPartFlash.Gui.Compression;
+
+public class ZstandardCompressionStreamCopier : ICompressionStreamCopier
+{
+    public async ValueTask CopyToStreamAsync(Stream sourceStream, Stream outputStream)
+    {
+        await using var compressionStream = new CompressionStream(outputStream);
+        await sourceStream.CopyToAsync(compressionStream);
+    }
+}
diff --git a/WinPartFlash.Gui/Compression/ZstandardDecompressionStreamCopier.cs b/WinPartFlash.Gui/Compression/ZstandardDecompressionStreamCopier.cs
@@ -0,0 +1,14 @@
+using System.IO;
+using System.Threading.Tasks;
+using ZstdSharp;
+
+namespace WinPartFlash.Gui.Compression;
+
+public class ZstandardDecompressionStreamCopier : ICompressionStreamCopier
+{
+    public async ValueTask CopyToStreamAsync(Stream sourceStream, Stream outputStream)
+    {
+        await using var decompressionStream = new DecompressionStream(sourceStream);
+        await decompressionStream.CopyToAsync(outputStream);
+    }
+}
diff --git a/WinPartFlash.Gui/FileOpenHelper/FileOpenHelper.cs b/WinPartFlash.Gui/FileOpenHelper/FileOpenHelper.cs
@@ -5,6 +5,7 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using WinPartFlash.Gui.Compression;
+using WinPartFlash.Gui.Utils;
 
 namespace WinPartFlash.Gui.FileOpenHelper;
 
@@ -13,8 +14,11 @@ public class FileOpenHelper(IHttpClientFactory clientFactory) : IFileOpenHelper
     private static readonly Dictionary<string, CompressionType> ContentTypeMapping =
         new()
         {
-            { "application/gzip", CompressionType.GzipDecompress },
-            { "application/x-gzip", CompressionType.GzipDecompress }
+            { FileNameHelpers.ContentTypeGzip, CompressionType.GzipDecompress },
+            { FileNameHelpers.ContentTypeGzipDeprecated, CompressionType.GzipDecompress },
+            { FileNameHelpers.ContentTypeXz, CompressionType.XzDecompress },
+            { FileNameHelpers.ContentTypeLz4, CompressionType.Lz4Compress },
+            { FileNameHelpers.ContentTypeZstandard, CompressionType.ZstandardDecompress }
         };
 
     private readonly IReadOnlyList<IFileOpenHelper> _helpers =
@@ -26,10 +30,16 @@ public class FileOpenHelper(IHttpClientFactory clientFactory) : IFileOpenHelper
     private static CompressionType DetectFromFileName(string fileName)
     {
         fileName = fileName.Trim('\"');
-        if (fileName.EndsWith(".gz"))
+        if (fileName.EndsWith(FileNameHelpers.FileExtensionGzip))
             return CompressionType.GzipDecompress;
-        if (fileName.EndsWith(".lz4"))
+        if (fileName.EndsWith(FileNameHelpers.FileExtensionLz4))
             return CompressionType.Lz4Decompress;
+        if (fileName.EndsWith(FileNameHelpers.FileExtensionXz))
+            return CompressionType.XzDecompress;
+        if (fileName.EndsWith(FileNameHelpers.FileExtensionLz4))
+            return CompressionType.Lz4Decompress;
+        if (fileName.EndsWith(FileNameHelpers.FileExtensionZstandard))
+            return CompressionType.ZstandardDecompress;
 
         return CompressionType.Raw;
     }
diff --git a/WinPartFlash.Gui/Utils/FileNameHelpers.cs b/WinPartFlash.Gui/Utils/FileNameHelpers.cs
@@ -0,0 +1,18 @@
+namespace WinPartFlash.Gui.Utils;
+
+public static class FileNameHelpers
+{
+    public const string FileExtensionGzip = ".gz";
+    public const string FileExtensionXz = ".xz";
+    public const string FileExtensionLz4 = ".lz4";
+    public const string FileExtensionZstandard = ".zst";
+
+    public const string FileExtensionImage = ".img";
+
+
+    public const string ContentTypeGzip = "application/gzip";
+    public const string ContentTypeGzipDeprecated = "application/x-gzip";
+    public const string ContentTypeXz = "application/x-xz";
+    public const string ContentTypeLz4 = "application/x-lz4";
+    public const string ContentTypeZstandard = "application/x-zstd";
+}
diff --git a/WinPartFlash.Gui/ViewModels/MainWindowViewModel.cs b/WinPartFlash.Gui/ViewModels/MainWindowViewModel.cs
@@ -21,24 +21,38 @@ namespace WinPartFlash.Gui.ViewModels;
 
 public class MainWindowViewModel : ViewModelBase
 {
-    private static readonly List<string> RawTrimEndings = [".gz", ".lz4"];
+    private static readonly List<string> RawTrimEndings =
+    [
+        FileNameHelpers.FileExtensionGzip,
+        FileNameHelpers.FileExtensionLz4,
+        FileNameHelpers.FileExtensionZstandard
+    ];
 
     private static readonly FilePickerFileType DiskImage = new(Strings.FileTypeNameDiskImages)
     {
-        Patterns = ["*.img", "*.img.gz"]
+        Patterns =
+        [
+            "*" + FileNameHelpers.FileExtensionImage,
+            "*" + FileNameHelpers.FileExtensionImage + FileNameHelpers.FileExtensionGzip,
+            "*" + FileNameHelpers.FileExtensionImage + FileNameHelpers.FileExtensionLz4,
+            "*" + FileNameHelpers.FileExtensionImage + FileNameHelpers.FileExtensionZstandard
+        ]
     };
 
     private readonly IPartitionDetector _partitionDetector;
     private readonly ICompressionStreamCopierFactory _streamCopierFactory;
     private readonly IFileOpenHelper _fileOpenHelper;
 
-    private readonly ObservableAsPropertyHelper<CompressionType> _compressionType;
     private readonly ObservableAsPropertyHelper<bool> _isMainWindowEnabled;
     private readonly ObservableAsPropertyHelper<bool> _isSaveButtonEnabled;
     private readonly ObservableAsPropertyHelper<bool> _isFlashButtonEnabled;
 
+    private CompressionType _compressionType;
+
     private bool _isSaveGzipFileChecked;
     private bool _isSaveRawFileChecked = true;
+    private bool _isSaveZstandardFileChecked;
+    private bool _isSaveLz4FileChecked;
     private bool _isBackgroundTaskRunning;
 
     private int _progress;
@@ -64,51 +78,76 @@ public MainWindowViewModel(
         SavePartitionCommand = ReactiveCommand.CreateFromTask<Visual?>(SavePartition);
         FlashPartitionCommand = ReactiveCommand.CreateFromTask<Visual?>(FlashPartition);
 
-        _compressionType = this
-            .WhenAnyValue(vm => vm.IsSaveRawFileChecked,
-                vm => vm.IsSaveGzipFileChecked)
-            .Select(tuple =>
+        // Subscribe to update compression type by clicking button
+        this
+            .WhenAnyValue(vm => vm.IsSaveRawFileChecked)
+            .Subscribe(enabled =>
             {
-                var (rawChecked, gzipChecked) = tuple;
-                if (rawChecked)
-                    return CompressionType.Raw;
-                if (gzipChecked)
-                    return CompressionType.GzipCompress;
-                return CompressionType.Raw;
-            })
-            .ToProperty(this, vm => vm.CompressionType);
+                if (enabled) CompressionType = CompressionType.Raw;
+            });
+
+        this
+            .WhenAnyValue(vm => vm.IsSaveGzipFileChecked)
+            .Subscribe(enabled =>
+            {
+                if (enabled) CompressionType = CompressionType.GzipCompress;
+            });
 
+        this
+            .WhenAnyValue(vm => vm.IsSaveLz4FileChecked)
+            .Subscribe(enabled =>
+            {
+                if (enabled) CompressionType = CompressionType.Lz4Compress;
+            });
+
+        this
+            .WhenAnyValue(vm => vm.IsSaveZstandardFileChecked)
+            .Subscribe(enabled =>
+            {
+                if (enabled) CompressionType = CompressionType.ZstandardCompress;
+            });
+
+        //Subscribe to update file name after compression type updated
         this
             .WhenAnyValue(vm => vm.CompressionType)
             .Subscribe(type =>
             {
                 var ending = RawTrimEndings.FirstOrDefault(e => SavePartitionFileName.EndsWith(e));
                 var rawFileName = ending == null ? SavePartitionFileName : SavePartitionFileName[..^ending.Length];
-                switch (CompressionType)
+                switch (type)
                 {
                     case CompressionType.Raw:
                         if (!string.IsNullOrWhiteSpace(rawFileName))
                             SavePartitionFileName = rawFileName;
                         break;
                     case CompressionType.GzipCompress:
                         if (!string.IsNullOrWhiteSpace(rawFileName))
-                            SavePartitionFileName = rawFileName + ".gz";
+                            SavePartitionFileName = rawFileName + FileNameHelpers.FileExtensionGzip;
                         break;
                     case CompressionType.Lz4Compress:
                         if (!string.IsNullOrWhiteSpace(rawFileName))
-                            SavePartitionFileName = rawFileName + ".lz4";
+                            SavePartitionFileName = rawFileName + FileNameHelpers.FileExtensionLz4;
+                        break;
+                    case CompressionType.ZstandardCompress:
+                        if (!string.IsNullOrWhiteSpace(rawFileName))
+                            SavePartitionFileName = rawFileName + FileNameHelpers.FileExtensionZstandard;
                         break;
                     default:
                         throw new ArgumentOutOfRangeException();
                 }
             });
 
+        // Subscribe to update button status after file name updated
         this
             .WhenAnyValue(vm => vm.SavePartitionFileName)
             .Subscribe(name =>
             {
-                if (name.EndsWith(".gz"))
+                if (name.EndsWith(FileNameHelpers.FileExtensionGzip))
                     IsSaveGzipFileChecked = true;
+                else if (name.EndsWith(FileNameHelpers.FileExtensionLz4))
+                    IsSaveLz4FileChecked = true;
+                else if (name.EndsWith(FileNameHelpers.FileExtensionZstandard))
+                    IsSaveZstandardFileChecked = true;
                 else
                     IsSaveRawFileChecked = true;
             });
@@ -139,6 +178,18 @@ public MainWindowViewModel(
             .ToProperty(this, vm => vm.IsFlashButtonEnabled);
     }
 
+    public bool IsSaveZstandardFileChecked
+    {
+        get => _isSaveZstandardFileChecked;
+        set => this.RaiseAndSetIfChanged(ref _isSaveZstandardFileChecked, value);
+    }
+
+    public bool IsSaveLz4FileChecked
+    {
+        get => _isSaveLz4FileChecked;
+        set => this.RaiseAndSetIfChanged(ref _isSaveLz4FileChecked, value);
+    }
+
     public bool IsFlashButtonEnabled => _isFlashButtonEnabled.Value;
 
     public int Progress
@@ -198,7 +249,11 @@ public List<PartitionItemViewModel> PartitionItems
     public ReactiveCommand<Visual?, Unit> SavePartitionCommand { get; }
     public ReactiveCommand<Visual?, Unit> FlashPartitionCommand { get; }
 
-    private CompressionType CompressionType => _compressionType.Value;
+    private CompressionType CompressionType
+    {
+        get => _compressionType;
+        set => this.RaiseAndSetIfChanged(ref _compressionType, value);
+    }
 
     private static Window? GetVisualTopWindow(Visual? visual)
     {
diff --git a/WinPartFlash.Gui/Views/MainWindow.axaml b/WinPartFlash.Gui/Views/MainWindow.axaml
@@ -59,7 +59,8 @@
                     <!-- Below are image file types and should not localize. -->
                     <RadioButton Content="raw" IsChecked="{Binding IsSaveRawFileChecked}" />
                     <RadioButton Content="gz" IsChecked="{Binding IsSaveGzipFileChecked}" />
-                    <RadioButton Content="lz4" IsEnabled="False" />
+                    <RadioButton Content="lz4" IsChecked="{Binding IsSaveLz4FileChecked}" />
+                    <RadioButton Content="zst" IsChecked="{Binding IsSaveZstandardFileChecked}" />
                 </StackPanel>
 
                 <ProgressBar Margin="0 0 0 10"
diff --git a/WinPartFlash.Gui/WinPartFlash.Gui.csproj b/WinPartFlash.Gui/WinPartFlash.Gui.csproj

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,12 @@ public static IServiceCollection AddCompressionStreamCopier(this IServiceCollect`
`8`	`8`	`{`
`9`	`9`	`services.AddSingleton<RawStreamCopier>();`
`10`	`10`	`services.AddSingleton<GzipCompressionStreamCopier>();`
`11`		`- services.AddSingleton<GzipDeCompressionStreamCopier>();`
	`11`	`+ services.AddSingleton<GzipDecompressionStreamCopier>();`
	`12`	`+ services.AddSingleton<XzDecompressionStreamCopier>();`
	`13`	`+ services.AddSingleton<ZstandardCompressionStreamCopier>();`
	`14`	`+ services.AddSingleton<ZstandardDecompressionStreamCopier>();`
	`15`	`+ services.AddSingleton<Lz4CompressionStreamCopier>();`
	`16`	`+ services.AddSingleton<Lz4DecompressionStreamCopier>();`
`12`	`17`	`services.AddSingleton<ICompressionStreamCopierFactory, CompressionStreamCopierFactory>();`
`13`	`18`	`return services;`
`14`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,11 @@`
`4`	`4`
`5`	`5`	`namespace WinPartFlash.Gui.Compression;`
`6`	`6`
`7`		`-public class GzipDeCompressionStreamCopier : ICompressionStreamCopier`
	`7`	`+public class GzipDecompressionStreamCopier : ICompressionStreamCopier`
`8`	`8`	`{`
`9`	`9`	`public async ValueTask CopyToStreamAsync(Stream sourceStream, Stream outputStream)`
`10`	`10`	`{`
`11`		`- await using var compressionStream = new GZipStream(outputStream, CompressionMode.Decompress);`
`12`		`- await compressionStream.CopyToAsync(sourceStream);`
	`11`	`+ await using var decompressionStream = new GZipStream(sourceStream, CompressionMode.Decompress);`
	`12`	`+ await decompressionStream.CopyToAsync(outputStream);`
`13`	`13`	`}`
`14`	`14`	`}`