feat(file-service): 添加压缩文件任务实现

Author: ruattd

Model/Files/FileItem.cs

@@ -1,7 +1,5 @@
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
-using PCL.Core.Helper;
 using PCL.Core.Service;
 
 namespace PCL.Core.Model.Files;
@@ -57,15 +55,16 @@ public record FileItem(
     public string? TargetDirectory
     {
         get => _targetDirectory;
-        set => _targetDirectory = (value == null) ? null : Path.GetFullPath(Path.Combine(FileService.DefaultDirectory, value));
+        set => _targetDirectory = (value == null) ? null : Path.Combine(FileService.DefaultDirectory, value);
     }
 
     private string? _targetPath;
 
     /// <summary>
     /// The path to storage the file.<br/>
-    /// If <see cref="TargetDirectory"/> has been set, return the path relative to it,
-    /// otherwise return a combined path by <see cref="Type"/> and <see cref="Name"/>
+    /// If <see cref="TargetDirectory"/> has been set, return the path with <see cref="Name"/> relative to it;
+    /// if the value has been set manually, return the value directly;
+    /// otherwise return a combined path depends on <see cref="Type"/> and <see cref="Name"/>.
     /// </summary>
     public string TargetPath
     {
@@ -87,6 +86,7 @@ public string TargetPath
             _targetPath = value;
             return value;
         }
+        set => _targetPath = Path.Combine(FileService.DefaultDirectory, value);
     }
 
     public override int GetHashCode() => TargetPath.GetHashCode();

Model/Files/IFileTask.cs

@@ -14,5 +14,5 @@ public interface IFileTask
 
     public bool OnProcessFinished(FileItem item, object? result);
 
-    public void OnTaskFinished();
+    public void OnTaskFinished(object? result);
 }

PCL.Core.csproj

@@ -194,6 +194,7 @@
     <Compile Include="Utils\ExpandoObjectConverter.cs" />
     <Compile Include="Utils\FileTask\FileTask.cs" />
     <Compile Include="Utils\FileTask\MatchableFileTask.cs" />
+    <Compile Include="Utils\FileTask\ZipFileTask.cs" />
     <Compile Include="Utils\FileVersionControl\FileVersionObjects.cs" />
     <Compile Include="Utils\FileVersionControl\FileVersionObjectsComparer.cs" />
     <Compile Include="Utils\FileVersionControl\IVersionControl.cs" />

Utils/FileTask/FileTask.cs

@@ -35,14 +35,14 @@ public FileTask(bool ignoreResult = false) : this([], ignoreResult) { }
     public FileTask(params FileItem[] items) : this(items.AsEnumerable()) { }
 
     /// <summary>
-    /// Event invoked after a process finished
+    /// Event invoked with the finished item and the result after a process finished
     /// </summary>
     public event Action<FileItem, object?>? ProcessFinished;
 
     /// <summary>
-    /// Event invoked after the task finished
+    /// Event invoked with the result after the task finished
     /// </summary>
-    public event Action? TaskFinished;
+    public event Action<object?>? TaskFinished;
 
     #region Implementation
 
@@ -52,15 +52,14 @@ public FileTask(params FileItem[] items) : this(items.AsEnumerable()) { }
 
     public virtual bool OnProcessFinished(FileItem item, object? result)
     {
-        if (IgnoreResult) return true;
-        if (ProcessFinished == null) return false;
+        if (ProcessFinished == null) return IgnoreResult;
         ProcessFinished.Invoke(item, result);
         return true;
     }
 
-    public virtual void OnTaskFinished()
+    public virtual void OnTaskFinished(object? result)
     {
-        TaskFinished?.Invoke();
+        TaskFinished?.Invoke(result);
     }
 
     #endregion

Utils/FileTask/ZipFileTask.cs

@@ -0,0 +1,77 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using ICSharpCode.SharpZipLib.Zip;
+using PCL.Core.Model.Files;
+
+namespace PCL.Core.Utils.FileTask;
+
+/// <summary>
+/// 若写入压缩文件过程中抛出异常，将会抛出该异常，并将原异常作为 <see cref="Exception.InnerException"/> 提供。
+/// </summary>
+public class ZipFileTaskException(Exception innerException) : Exception(innerException.Message, innerException);
+
+/// <summary>
+/// 用于创建 ZIP 格式归档的文件任务。
+/// </summary>
+/// <param name="zipPath">参考 <see cref="ZipPath"/></param>
+/// <param name="items">归档包含的文件</param>
+public class ZipFileTask(string zipPath, IEnumerable<FileItem> items) : FileTask(items, true)
+{
+    /// <summary>
+    /// ZIP 文件的路径。若该路径已存在，写入时默认直接覆盖原文件，该行为可以通过 <see cref="OpenFileMode"/> 指定。
+    /// </summary>
+    public string ZipPath { get; } = zipPath;
+    
+    /// <summary>
+    /// 压缩等级。取值范围为 0~9，默认为 3。
+    /// </summary>
+    public int ZipLevel { get; set; } = 3;
+    
+    public bool DeleteWhenException { get; set; } = true;
+    
+    /// <summary>
+    /// 写入 ZIP 文件时使用的 <see cref="FileMode"/>。
+    /// </summary>
+    public FileMode OpenFileMode { get; set; } = FileMode.Create;
+    
+    /// <summary>
+    /// 写入 ZIP 文件时使用的 <see cref="FileShare"/>。
+    /// </summary>
+    public FileShare OpenFileShare { get; set; } = FileShare.None;
+    
+    private readonly List<FileItem> _filesToArchive = [];
+    
+    public override bool OnProcessFinished(FileItem item, object? result)
+    {
+        _filesToArchive.Add(item);
+        return base.OnProcessFinished(item, result);
+    }
+
+    public override void OnTaskFinished(object? result)
+    {
+        var fileCreated = false;
+        try
+        {
+            using var zipFile = File.Open(ZipPath, OpenFileMode, FileAccess.Write, OpenFileShare);
+            fileCreated = true;
+            using var zipStream = new ZipOutputStream(zipFile);
+            zipStream.SetLevel(ZipLevel);
+            foreach (var item in _filesToArchive)
+            {
+                var entryName = ZipEntry.CleanName(item.Name);
+                zipStream.PutNextEntry(new ZipEntry(entryName));
+                using var fileInput =
+                    File.Open(item.TargetPath, FileMode.Open, FileAccess.Read, FileShare.Read);
+                fileInput.CopyTo(zipStream);
+                zipStream.CloseEntry();
+            }
+            zipStream.Finish();
+        }
+        catch (Exception ex)
+        {
+            if (fileCreated && DeleteWhenException) File.Delete(ZipPath);
+            throw new ZipFileTaskException(ex);
+        }
+    }
+}