using System.IO.Compression; namespace MeloongCore; public static class FileUtils { #region 写入 /// /// 写入文件。 /// 如果文件或文件夹不存在,则会自动创建。若已存在,则会覆盖原文件。 /// public static void Write(string filePath, string text, Encoding? encoding = null) { Write(filePath, (encoding ?? new UTF8Encoding()).GetBytes(text)); } /// /// 写入文件。 /// 如果文件或文件夹不存在,则会自动创建。若已存在,则会覆盖原文件。 /// public static void Write(string filePath, IEnumerable content) { Write(filePath, [..content]); } /// /// 写入文件。 /// 如果文件或文件夹不存在,则会自动创建。若已存在,则会覆盖原文件。 /// public static void Write(string filePath, byte[] content) { DirectoryUtils.Create(filePath, isFilePath: true); Logger.Trace(() => $"写入文件:{filePath}({content.Length} 字节)"); File.WriteAllBytes(PathUtils.WithLongPath(filePath), content); } /// /// 将 写入文件。 /// 会将流的位置主动重置到开头。 /// 如果文件或文件夹不存在,则会自动创建。若已存在,则会覆盖原文件。 /// public static void Write(string filePath, Stream stream) { using FileStream fileStream = CreateAsStream(PathUtils.WithLongPath(filePath)); if (stream.CanSeek && stream.Position != 0) stream.Seek(0, SeekOrigin.Begin); Logger.Trace(() => $"写入文件:{filePath}({stream.GetType().Name} {stream.Length} 字节)"); stream.CopyTo(fileStream); } #endregion #region 删除 /// /// 删除文件。 /// public static void Delete(string filePath, bool toRecycleBin = false) { if (!Exists(filePath)) return; Logger.Trace($"{(toRecycleBin ? "将文件删除到回收站" : "删除文件")}:{filePath}"); if (toRecycleBin) { DeleteToRecycleBin(filePath); } else { File.Delete(PathUtils.WithLongPath(filePath)); } } /// /// 将文件或文件夹删除到回收站。 /// internal static void DeleteToRecycleBin(string target) { // 实际的删除方法 static void Run(string filePath) { IShellItem? item = null; IFileOperation? op = null; try { var iid = typeof(IShellItem).GUID; Marshal.ThrowExceptionForHR(SHCreateItemFromParsingName(PathUtils.WithoutLongPath(filePath), IntPtr.Zero, ref iid, out item)); op = (IFileOperation) new FileOperation(); op.SetOperationFlags(0x0040 | 0x0010 | 0x0004); // FOF_ALLOWUNDO | FOF_NOCONFIRMATION | FOF_SILENT op.DeleteItem(item, IntPtr.Zero); op.PerformOperations(); op.GetAnyOperationsAborted(out bool aborted); if (aborted) throw new OperationCanceledException("Delete operation was aborted."); } finally { if (op != null && Marshal.IsComObject(op)) Marshal.FinalReleaseComObject(op); if (item != null && Marshal.IsComObject(item)) Marshal.FinalReleaseComObject(item); } } // 在 STA 线程中执行删除方法 if (Thread.CurrentThread.GetApartmentState() == ApartmentState.STA) { Run(target); } else { System.Runtime.ExceptionServices.ExceptionDispatchInfo? internalEx = null; // 捕获内部异常 var thread = new Thread(() => { try { Run(target); } catch (Exception ex) { internalEx = System.Runtime.ExceptionServices.ExceptionDispatchInfo.Capture(ex); } }); thread.SetApartmentState(ApartmentState.STA); thread.Start(); thread.Join(); internalEx?.Throw(); } } // 用于删除到回收站的接口 [DllImport("shell32.dll", CharSet = CharSet.Unicode)] static extern int SHCreateItemFromParsingName([MarshalAs(UnmanagedType.LPWStr)] string pszPath, IntPtr pbc, ref Guid riid, [MarshalAs(UnmanagedType.Interface)] out IShellItem ppv); [ComImport, Guid("43826D1E-E718-42EE-BC55-A1E261C37BFE"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] interface IShellItem { } [ComImport, Guid("3AD05575-8857-4850-9277-11B85BDB8E09")] class FileOperation { } [ComImport, Guid("947AAB5F-0A5C-4C13-B4D6-4BF7836FC9F8"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] interface IFileOperation { void Advise(IntPtr pfops, out uint pdwCookie); void Unadvise(uint dwCookie); void SetOperationFlags(uint dwOperationFlags); void SetProgressMessage([MarshalAs(UnmanagedType.LPWStr)] string pszMessage); void SetProgressDialog(IntPtr popd); void SetProperties(IntPtr pproparray); void SetOwnerWindow(IntPtr hwndOwner); void ApplyPropertiesToItem(IShellItem psiItem); void ApplyPropertiesToItems(IntPtr punkItems); void RenameItem(IShellItem psiItem, [MarshalAs(UnmanagedType.LPWStr)] string pszNewName, IntPtr pfopsItem); void RenameItems(IntPtr pUnkItems, [MarshalAs(UnmanagedType.LPWStr)] string pszNewName); void MoveItem(IShellItem psiItem, IShellItem psiDestinationFolder, [MarshalAs(UnmanagedType.LPWStr)] string pszNewName, IntPtr pfopsItem); void MoveItems(IntPtr punkItems, IShellItem psiDestinationFolder); void CopyItem(IShellItem psiItem, IShellItem psiDestinationFolder, [MarshalAs(UnmanagedType.LPWStr)] string pszCopyName, IntPtr pfopsItem); void CopyItems(IntPtr punkItems, IShellItem psiDestinationFolder); void DeleteItem(IShellItem psiItem, IntPtr pfopsItem); void DeleteItems(IntPtr punkItems); void NewItem(IShellItem psiDestinationFolder, uint dwFileAttributes, [MarshalAs(UnmanagedType.LPWStr)] string pszName, [MarshalAs(UnmanagedType.LPWStr)] string pszTemplateName, IntPtr pfopsItem); void PerformOperations(); void GetAnyOperationsAborted([MarshalAs(UnmanagedType.Bool)] out bool pfAnyOperationsAborted); } #endregion #region FileStream /// /// 打开该文件的只读 。 /// public static FileStream ReadAsStream(string filePath) { return new(PathUtils.WithLongPath(filePath), FileMode.Open, FileAccess.Read, FileShare.ReadWrite); } /// /// 在指定路径创建文件,并打开 。 /// public static FileStream CreateAsStream(string filePath) { DirectoryUtils.Create(filePath, isFilePath: true); Logger.Trace($"创建文件流:{filePath}"); return new(PathUtils.WithLongPath(filePath), FileMode.Create); } #endregion #region 压缩包 /// /// 以只读模式打开压缩文件。 /// 会先尝试 UTF8 编码,失败后换用 GB18030 编码。 /// public static ZipArchive OpenZip(string zipFilePath) { ZipArchive TryOpen(Encoding encoding) { Logger.Trace(() => $"尝试以 {encoding.EncodingName} 编码打开压缩包:{zipFilePath}"); var result = ZipFile.Open(PathUtils.WithLongPath(zipFilePath), ZipArchiveMode.Read, encoding); try { _ = result.Entries; // 如果编码有误,会在这里抛出 DecoderFallbackException;如果文件异常,会在这里抛出 InvalidDataException return result; } catch { result.Dispose(); throw; } } try { try { // 尝试两种编码 return TryOpen(new UTF8Encoding(false, true)); } catch (DecoderFallbackException) { return TryOpen(Encoding.GetEncoding("GB18030")); } } catch (InvalidDataException ex) { throw new InvalidDataException($"文件不是压缩包,或者文件已损坏({zipFilePath})", ex); } } /// /// 尝试根据后缀名判断文件种类并解压文件,支持 gz 与 zip,会尝试将 jar 以 zip 方式解压。 /// 会自动创建文件夹。会覆盖已有文件,但不会删除多余文件。 /// /// 参数为已完成的总比例(0~1)。 public static void ExtractToDirectory(string compressionFile, string outputDirectory, Action? progressHandler = null) { compressionFile = PathUtils.WithLongPath(compressionFile); DirectoryUtils.Create(outputDirectory); // 解压 gz(gz 不需要考虑编码) if (compressionFile.EndsWithF(".gz", true)) { string outFilePath = Path.Combine(outputDirectory, Path.GetFileNameWithoutExtension(compressionFile)); Logger.Trace($"解压 gz 文件:{compressionFile} → {outFilePath}"); using var fileStream = FileUtils.ReadAsStream(compressionFile); using var gzipStream = new GZipStream(fileStream, CompressionMode.Decompress); FileUtils.Write(outFilePath, gzipStream); progressHandler?.Invoke(1); return; } // 解压 zip using var archive = FileUtils.OpenZip(compressionFile); int totalCount = archive.Entries.Count; int doneCount = 0; Logger.Trace($"解压 zip 文件:{compressionFile} → {outputDirectory}(共 {totalCount} 项)"); foreach (var entry in archive.Entries) { doneCount++; if (totalCount > 0) progressHandler?.Invoke((double) doneCount / totalCount); if (string.IsNullOrEmpty(entry.Name)) continue; // 跳过文件夹条目(ZipArchive 会将文件夹也作为一个 entry,但它们的 Name 为空) // ZipSlip 修复 string outputFilePath = PathUtils.WithLongPath(Path.GetFullPath(Path.Combine(outputDirectory, entry.FullName))); if (!outputFilePath.StartsWithF(PathUtils.WithSeparator(PathUtils.WithLongPath(Path.GetFullPath(outputDirectory))), ignoreCase:true)) throw new ZipSlipException($"Zip 文件项 {entry.FullName} 的路径在压缩包之外,这可能导致安全问题"); // 实际的解压 using var entryStream = entry.Open(); FileUtils.Write(outputFilePath, entryStream); } } public class ZipSlipException(string message) : Exception(message) {} /// /// 将指定文件夹的内容打包为 zip 文件。 /// 会自动创建文件夹。会覆盖已有文件。 /// public static void CreateZipFromDirectory(string outputFullPath, string sourceDirectory) { outputFullPath = PathUtils.WithLongPath(outputFullPath); sourceDirectory = PathUtils.WithLongPath(sourceDirectory); DirectoryUtils.Create(outputFullPath, isFilePath: true); FileUtils.Delete(outputFullPath); Logger.Trace($"将文件夹中的内容压缩为 zip 文件:{sourceDirectory} → {outputFullPath}"); ZipFile.CreateFromDirectory(sourceDirectory, outputFullPath); } /// /// 将多个文件打包为 zip 文件,所有文件都会被放在压缩文件的根目录。 /// 会自动创建文件夹。会覆盖已有文件。 /// public static void CreateZipFromFiles(string outputFullPath, params string[] sourceFiles) { var sources = new Dictionary(); foreach (var source in sourceFiles) { string fileName = Path.GetFileName(source); if (sources.ContainsKey(fileName)) throw new ArgumentException($"尝试将多个同文件名的文件放进压缩包中({fileName})", nameof(sourceFiles)); sources.Add(fileName, source); } CreateZipFromFiles(outputFullPath, sources); } /// /// 将多个文件打包为 zip 文件。 /// 会自动创建文件夹。会覆盖已有文件。 /// /// 键为 zip 文件下的路径,值为文件的本地路径。 public static void CreateZipFromFiles(string outputFullPath, IDictionary sources) { outputFullPath = PathUtils.WithLongPath(outputFullPath); DirectoryUtils.Create(outputFullPath, isFilePath: true); FileUtils.Delete(outputFullPath); using var archive = ZipFile.Open(outputFullPath, ZipArchiveMode.Create); Logger.Trace(() => $"创建 zip 文件:{sources.Count} 个文件 → {outputFullPath}\n{sources.Select(p => $"- {p.Value} → {p.Key}").Join('\n')}"); foreach (var pair in sources) archive.CreateEntryFromFile(PathUtils.WithLongPath(pair.Value), pair.Key.Replace('\\', '/'), CompressionLevel.Optimal); } #endregion /// /// 确定指定的文件是否存在。 /// public static bool Exists(string filePath) { return File.Exists(PathUtils.WithLongPath(filePath)); } /// /// 创建 对象。 /// public static FileInfo GetInfo(string path) { return new(PathUtils.WithLongPath(path)); } /// /// 复制文件。 /// 会创建对应文件夹、覆盖已有的文件。 /// public static void Copy(string sourceFilePath, string destFilePath) { if (sourceFilePath == destFilePath) return; // 如果复制同一个文件则跳过 DirectoryUtils.Create(destFilePath, isFilePath: true); Logger.Trace($"复制文件:{sourceFilePath} → {destFilePath}"); File.Copy(PathUtils.WithLongPath(sourceFilePath), PathUtils.WithLongPath(destFilePath), true); } /// /// 剪切文件。 /// 会创建对应文件夹、覆盖已有的文件。 /// public static void Move(string sourceFilePath, string destFilePath) { if (sourceFilePath == destFilePath) return; // 如果移动同一个文件则跳过 DirectoryUtils.Create(destFilePath, isFilePath: true); Logger.Trace($"剪切文件:{sourceFilePath} → {destFilePath}"); File.Move(PathUtils.WithLongPath(sourceFilePath), PathUtils.WithLongPath(destFilePath)); } }