FileUtils.cs 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503
  1. using Newtonsoft.Json.Linq;
  2. using System.IO.Compression;
  3. namespace MeloongCore;
  4. public static class FileUtils {
  5. #region 读取
  6. /// <summary>
  7. /// 打开指定文件的只读 <see cref="Stream"/>。
  8. /// <para/>若指定了 <paramref name="type"/>,则会改为从该类型的程序集中读取嵌入的资源。
  9. /// </summary>
  10. public static Stream ReadAsStream(string filePath, Type? type = null) {
  11. if (type is null) {
  12. return ResilientUtils.RetryOn<IOException, Stream>(() => new FileStream(PathUtils.ForApi(filePath), FileMode.Open, FileAccess.Read, FileShare.ReadWrite));
  13. } else {
  14. return type.Assembly.GetManifestResourceStream(filePath) ?? throw new FileNotFoundException($"Embedded resource \"{filePath}\" was not found.");
  15. }
  16. }
  17. /// <summary>
  18. /// 读取文件中的所有内容。
  19. /// <para/>若指定了 <paramref name="type"/>,则会改为从该类型的程序集中读取嵌入的资源。
  20. /// </summary>
  21. public static byte[] ReadAsBytes(string filePath, Type? type = null) {
  22. using Stream fs = FileUtils.ReadAsStream(filePath, type); // 不能使用 File.ReadAllBytes,它不指定 FileShare.ReadWrite,会在文件被占用时抛出异常
  23. using MemoryStream ms = new();
  24. fs.CopyTo(ms);
  25. return ms.ToArray();
  26. }
  27. /// <summary>
  28. /// 读取文件中的所有内容。
  29. /// <para/>若指定了 <paramref name="type"/>,则会改为从该类型的程序集中读取嵌入的资源。
  30. /// </summary>
  31. public static string ReadAsString(string filePath, Encoding? encoding = null, Type? type = null)
  32. => FileUtils.ReadAsBytes(filePath, type).GetString(encoding);
  33. /// <summary>
  34. /// 读取文件中的所有内容。
  35. /// <para/>若文件不存在或读取失败,返回 <see langword="null"/>,而不是抛出异常。
  36. /// <para/>若指定了 <paramref name="type"/>,则会改为从该类型的程序集中读取嵌入的资源。
  37. /// </summary>
  38. public static string? TryReadAsString(string filePath, Encoding? encoding = null, Type? type = null) {
  39. try {
  40. if (type != null && !FileUtils.Exists(filePath)) return null;
  41. return FileUtils.ReadAsBytes(filePath, type).GetString(encoding);
  42. } catch {
  43. return null;
  44. }
  45. }
  46. /// <summary>
  47. /// 读取文件中的所有内容,并按行分割。
  48. /// <para/>若指定了 <paramref name="type"/>,则会改为从该类型的程序集中读取嵌入的资源。
  49. /// </summary>
  50. public static string[] ReadAsLines(string filePath, bool skipEmptyLines = false, Encoding? encoding = null, Type? type = null)
  51. => FileUtils.ReadAsString(filePath, encoding, type).SplitLines(skipEmptyLines);
  52. /// <summary>
  53. /// 读取文件中的所有内容,并按行分割。
  54. /// <para/>若文件不存在或读取失败,返回空数组,而不是抛出异常。
  55. /// <para/>若指定了 <paramref name="type"/>,则会改为从该类型的程序集中读取嵌入的资源。
  56. /// </summary>
  57. public static string[] TryReadAsLines(string filePath, bool skipEmptyLines = false, Encoding? encoding = null, Type? type = null)
  58. => FileUtils.TryReadAsString(filePath, encoding, type)?.SplitLines(skipEmptyLines) ?? [];
  59. /// <summary>
  60. /// 读取 JSON 文件中的所有内容。
  61. /// <para/>若指定了 <paramref name="type"/>,则会改为从该类型的程序集中读取嵌入的资源。
  62. /// </summary>
  63. public static JToken? ReadAsJson(string filePath, Encoding? encoding = null, Type? type = null)
  64. => FileUtils.ReadAsString(filePath, encoding, type).DeserializeJson();
  65. #endregion
  66. #region 创建 / 写入
  67. /// <summary>
  68. /// 创建文件,并将 <paramref name="text" /> 写入文件。
  69. /// 若文件已存在,则会覆盖原文件。
  70. /// </summary>
  71. public static void Write(string filePath, string text, Encoding? encoding = null)
  72. => FileUtils.Write(filePath, (encoding ?? new UTF8Encoding()).GetBytes(text));
  73. /// <summary>
  74. /// 创建文件,并将 <paramref name="content" /> 写入文件。
  75. /// 若文件已存在,则会覆盖原文件。
  76. /// </summary>
  77. public static void Write(string filePath, IEnumerable<byte> content)
  78. => FileUtils.Write(filePath, [.. content]);
  79. /// <summary>
  80. /// 创建文件,并将 <paramref name="content" /> 写入文件。
  81. /// 若文件已存在,则会覆盖原文件。
  82. /// </summary>
  83. public static void Write(string filePath, byte[] content) {
  84. DirectoryUtils.Create(PathUtils.RemoveLastPart(filePath));
  85. Logger.Trace($"写入文件:{filePath}({content.Length} 字节)");
  86. ResilientUtils.RetryOn<IOException>(() => {
  87. FileUtils.Delete(filePath);
  88. File.WriteAllBytes(PathUtils.ForApi(filePath), content);
  89. });
  90. }
  91. /// <summary>
  92. /// 创建文件,并将 <paramref name="stream" /> 写入文件。
  93. /// 会将流的位置主动重置到开头。
  94. /// 若文件已存在,则会覆盖原文件。
  95. /// </summary>
  96. public static void Write(string filePath, Stream stream) {
  97. ResilientUtils.RetryOn<IOException>(() => {
  98. FileUtils.Delete(filePath);
  99. using FileStream fileStream = FileUtils.CreateAsStream(filePath);
  100. if (stream.CanSeek && stream.Position != 0) stream.Seek(0, SeekOrigin.Begin);
  101. Logger.Trace($"写入文件:{filePath}({stream.GetType().Name}{(stream.CanSeek ? $" {stream.Length} 字节" : "")})");
  102. stream.CopyTo(fileStream);
  103. });
  104. }
  105. /// <summary>
  106. /// 创建文件,并打开 <see cref="FileStream"/>。
  107. /// 若文件已存在,则会覆盖原文件。
  108. /// </summary>
  109. public static FileStream CreateAsStream(string filePath) {
  110. DirectoryUtils.Create(PathUtils.RemoveLastPart(filePath));
  111. Logger.Trace($"创建文件流:{filePath}");
  112. return ResilientUtils.RetryOn<IOException, FileStream>(() => {
  113. FileUtils.Delete(filePath);
  114. return new FileStream(PathUtils.ForApi(filePath), FileMode.Create);
  115. });
  116. }
  117. /// <summary>
  118. /// 在临时文件夹下创建一个随机名称的文件,并返回其路径。
  119. /// </summary>
  120. public static string CreateRandom()
  121. => ResilientUtils.RetryOn<IOException, string>(Path.GetTempFileName);
  122. #endregion
  123. #region 复制 / 剪切
  124. /// <summary>
  125. /// 复制文件。
  126. /// 会创建对应文件夹、覆盖已有的文件。
  127. /// 若复制自身到自身,则不执行操作;若仅大小写不同,则重命名此文件。
  128. /// </summary>
  129. public static void Copy(string sourceFilePath, string destFilePath) {
  130. sourceFilePath = PathUtils.ForCompare(sourceFilePath);
  131. destFilePath = PathUtils.ForCompare(destFilePath);
  132. if (string.Compare(sourceFilePath, destFilePath, ignoreCase:false) == 0) {
  133. // 复制自身到自身,则不执行操作
  134. Logger.Trace($"复制文件到自身,不执行操作:{sourceFilePath} → {destFilePath}");
  135. } else if (string.Compare(sourceFilePath, destFilePath, ignoreCase:true) == 0) {
  136. // 路径仅大小写不同,等效于重命名
  137. Logger.Trace($"复制文件到自身,但大小写不同,等效于重命名文件:{sourceFilePath} → {destFilePath}");
  138. FileUtils.Move(sourceFilePath, destFilePath);
  139. } else {
  140. // 实际的复制
  141. DirectoryUtils.Create(PathUtils.RemoveLastPart(destFilePath));
  142. Logger.Trace($"复制文件:{sourceFilePath} → {destFilePath}");
  143. ResilientUtils.RetryOn<IOException>(()
  144. => File.Copy(PathUtils.ForApi(sourceFilePath), PathUtils.ForApi(destFilePath), true));
  145. }
  146. }
  147. /// <summary>
  148. /// 剪切文件。
  149. /// 会创建对应文件夹、覆盖已有的文件。
  150. /// </summary>
  151. public static void Move(string sourceFilePath, string destFilePath) {
  152. sourceFilePath = PathUtils.ForCompare(sourceFilePath);
  153. destFilePath = PathUtils.ForCompare(destFilePath);
  154. if (string.Compare(sourceFilePath, destFilePath, ignoreCase: false) == 0) {
  155. // 剪切自身到自身,则不执行操作
  156. Logger.Trace($"剪切文件到自身,不执行操作:{sourceFilePath} → {destFilePath}");
  157. } else if (string.Compare(sourceFilePath, destFilePath, ignoreCase: true) == 0) {
  158. // 路径仅大小写不同
  159. Logger.Trace($"剪切文件到自身,但大小写不同:{sourceFilePath} → {destFilePath}");
  160. ResilientUtils.RetryOn<IOException>(() => {
  161. var temp = Path.Combine(PathUtils.RemoveLastPart(sourceFilePath), Path.GetRandomFileName());
  162. File.Move(PathUtils.ForApi(sourceFilePath), PathUtils.ForApi(temp));
  163. File.Move(PathUtils.ForApi(temp), PathUtils.ForApi(destFilePath));
  164. });
  165. } else {
  166. // 实际的剪切
  167. DirectoryUtils.Create(PathUtils.RemoveLastPart(destFilePath));
  168. FileUtils.Delete(destFilePath);
  169. Logger.Trace($"剪切文件:{sourceFilePath} → {destFilePath}");
  170. ResilientUtils.RetryOn<IOException>(()
  171. => File.Move(PathUtils.ForApi(sourceFilePath), PathUtils.ForApi(destFilePath)));
  172. }
  173. }
  174. #endregion
  175. #region 删除
  176. /// <summary>
  177. /// 删除文件。
  178. /// <para/>若指定了 <paramref name="toRecycleBin"/>,则会尝试删除到回收站,但如果失败则会回退到永久删除。
  179. /// </summary>
  180. /// <returns>
  181. /// 如果文件不存在,返回 <see langword="null"/>。
  182. /// <para/>如果成功删除到回收站,返回 <see langword="true"/>。
  183. /// <para/>如果永久删除,返回 <see langword="false"/>。
  184. /// </returns>
  185. public static bool? Delete(string filePath, bool toRecycleBin = false) {
  186. if (!FileUtils.Exists(filePath)) return null;
  187. Logger.Trace($"{(toRecycleBin ? "将文件删除到回收站" : "删除文件")}:{filePath}");
  188. // 删除到回收站
  189. if (toRecycleBin) {
  190. try {
  191. DeleteToRecycleBin(filePath);
  192. return true;
  193. } catch (Exception ex) {
  194. Logger.Warn(ex, $"无法将文件删除到回收站,回退到永久删除:{filePath}");
  195. }
  196. }
  197. // 永久删除
  198. ResilientUtils.RetryOn<IOException>(()
  199. => File.Delete(PathUtils.ForApi(filePath)));
  200. return false;
  201. }
  202. /// <summary>
  203. /// 将文件或文件夹删除到回收站。
  204. /// </summary>
  205. internal static void DeleteToRecycleBin(string target) {
  206. // 实际的删除方法
  207. void Run() {
  208. IShellItem? item = null;
  209. IFileOperation? op = null;
  210. try {
  211. var iid = typeof(IShellItem).GUID;
  212. Marshal.ThrowExceptionForHR(SHCreateItemFromParsingName(PathUtils.RemoveExtendedPrefix(target), IntPtr.Zero, ref iid, out item));
  213. op = (IFileOperation) new FileOperation();
  214. op.SetOperationFlags(0x0040 | 0x0010 | 0x0004); // FOF_ALLOWUNDO | FOF_NOCONFIRMATION | FOF_SILENT
  215. op.DeleteItem(item, IntPtr.Zero);
  216. op.PerformOperations();
  217. op.GetAnyOperationsAborted(out bool aborted);
  218. if (aborted) throw new OperationCanceledException("Delete operation was aborted.");
  219. } finally {
  220. if (op != null && Marshal.IsComObject(op)) Marshal.FinalReleaseComObject(op);
  221. if (item != null && Marshal.IsComObject(item)) Marshal.FinalReleaseComObject(item);
  222. }
  223. }
  224. // 在 STA 线程中执行删除方法
  225. if (Thread.CurrentThread.GetApartmentState() == ApartmentState.STA) {
  226. ResilientUtils.RetryOn<IOException>(Run);
  227. } else {
  228. System.Runtime.ExceptionServices.ExceptionDispatchInfo? internalEx = null; // 捕获内部异常
  229. var thread = new Thread(() => {
  230. try {
  231. ResilientUtils.RetryOn<IOException>(Run);
  232. } catch (Exception ex) {
  233. internalEx = System.Runtime.ExceptionServices.ExceptionDispatchInfo.Capture(ex);
  234. }
  235. }) { IsBackground = true, Name = nameof(DeleteToRecycleBin) };
  236. thread.SetApartmentState(ApartmentState.STA);
  237. thread.Start();
  238. thread.Join();
  239. internalEx?.Throw();
  240. }
  241. }
  242. // API
  243. [DllImport("shell32.dll", CharSet = CharSet.Unicode)]
  244. static extern int SHCreateItemFromParsingName([MarshalAs(UnmanagedType.LPWStr)] string pszPath, IntPtr pbc, ref Guid riid, [MarshalAs(UnmanagedType.Interface)] out IShellItem ppv);
  245. [ComImport, Guid("43826D1E-E718-42EE-BC55-A1E261C37BFE"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
  246. interface IShellItem { }
  247. [ComImport, Guid("3AD05575-8857-4850-9277-11B85BDB8E09")]
  248. class FileOperation { }
  249. [ComImport, Guid("947AAB5F-0A5C-4C13-B4D6-4BF7836FC9F8"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
  250. interface IFileOperation {
  251. void Advise(IntPtr pfops, out uint pdwCookie);
  252. void Unadvise(uint dwCookie);
  253. void SetOperationFlags(uint dwOperationFlags);
  254. void SetProgressMessage([MarshalAs(UnmanagedType.LPWStr)] string pszMessage);
  255. void SetProgressDialog(IntPtr popd);
  256. void SetProperties(IntPtr pproparray);
  257. void SetOwnerWindow(IntPtr hwndOwner);
  258. void ApplyPropertiesToItem(IShellItem psiItem);
  259. void ApplyPropertiesToItems(IntPtr punkItems);
  260. void RenameItem(IShellItem psiItem, [MarshalAs(UnmanagedType.LPWStr)] string pszNewName, IntPtr pfopsItem);
  261. void RenameItems(IntPtr pUnkItems, [MarshalAs(UnmanagedType.LPWStr)] string pszNewName);
  262. void MoveItem(IShellItem psiItem, IShellItem psiDestinationFolder, [MarshalAs(UnmanagedType.LPWStr)] string pszNewName, IntPtr pfopsItem);
  263. void MoveItems(IntPtr punkItems, IShellItem psiDestinationFolder);
  264. void CopyItem(IShellItem psiItem, IShellItem psiDestinationFolder, [MarshalAs(UnmanagedType.LPWStr)] string pszCopyName, IntPtr pfopsItem);
  265. void CopyItems(IntPtr punkItems, IShellItem psiDestinationFolder);
  266. void DeleteItem(IShellItem psiItem, IntPtr pfopsItem);
  267. void DeleteItems(IntPtr punkItems);
  268. void NewItem(IShellItem psiDestinationFolder, uint dwFileAttributes, [MarshalAs(UnmanagedType.LPWStr)] string pszName, [MarshalAs(UnmanagedType.LPWStr)] string pszTemplateName, IntPtr pfopsItem);
  269. void PerformOperations();
  270. void GetAnyOperationsAborted([MarshalAs(UnmanagedType.Bool)] out bool pfAnyOperationsAborted);
  271. }
  272. #endregion
  273. #region 压缩 / 解压
  274. /// <summary>
  275. /// 以只读模式打开压缩文件。
  276. /// 会先尝试 UTF8 编码,失败后换用 GB18030 编码。
  277. /// </summary>
  278. public static ZipArchive OpenZip(string zipFilePath) {
  279. ZipArchive TryOpen(Encoding encoding) {
  280. Logger.Trace($"尝试以 {encoding.EncodingName} 编码打开压缩包:{zipFilePath}");
  281. var result = ZipFile.Open(PathUtils.ForApi(zipFilePath), ZipArchiveMode.Read, encoding);
  282. try {
  283. _ = result.Entries; // 如果编码有误,会在这里抛出 DecoderFallbackException;如果文件异常,会在这里抛出 InvalidDataException
  284. return result;
  285. } catch {
  286. result.Dispose();
  287. throw;
  288. }
  289. }
  290. try {
  291. try { // 尝试两种编码
  292. return TryOpen(new UTF8Encoding(false, true));
  293. } catch (DecoderFallbackException) {
  294. return TryOpen(Encoding.GetEncoding("GB18030"));
  295. }
  296. } catch (InvalidDataException ex) {
  297. throw new InvalidDataException($"文件不是压缩包,或者文件已损坏({zipFilePath})", ex);
  298. }
  299. }
  300. /// <summary>
  301. /// 尝试根据后缀名判断文件种类并解压文件,支持 gz 与 zip,会尝试将 jar 以 zip 方式解压。
  302. /// 会自动创建文件夹。会覆盖已有文件,但不会删除多余文件。
  303. /// </summary>
  304. /// <param name="progressHandler">参数为已完成的总比例(0~1)。</param>
  305. public static void ExtractToDirectory(string compressionFile, string outputDirectory, Action<double>? progressHandler = null) {
  306. compressionFile = PathUtils.ForApi(compressionFile);
  307. DirectoryUtils.Create(outputDirectory);
  308. // 解压 gz(gz 不需要考虑编码)
  309. if (compressionFile.EndsWithF(".gz", true)) {
  310. string outFilePath = Path.Combine(outputDirectory, PathUtils.GetFileNameWithoutExtension(compressionFile));
  311. Logger.Trace($"解压 gz 文件:{compressionFile} → {outFilePath}");
  312. using var fileStream = FileUtils.ReadAsStream(compressionFile);
  313. using var gzipStream = new GZipStream(fileStream, CompressionMode.Decompress);
  314. FileUtils.Write(outFilePath, gzipStream);
  315. progressHandler?.Invoke(1);
  316. return;
  317. }
  318. // 解压 zip
  319. using var archive = FileUtils.OpenZip(compressionFile);
  320. int totalCount = archive.Entries.Count;
  321. int doneCount = 0;
  322. Logger.Trace($"解压 zip 文件:{compressionFile} → {outputDirectory}(共 {totalCount} 项)");
  323. foreach (var entry in archive.Entries) {
  324. doneCount++;
  325. if (totalCount > 0) progressHandler?.Invoke((double) doneCount / totalCount);
  326. if (string.IsNullOrEmpty(entry.Name)) continue; // 跳过文件夹条目(ZipArchive 会将文件夹也作为一个 entry,但它们的 Name 为空)
  327. // ZipSlip 修复
  328. string outputFilePath = PathUtils.ForCompare(Path.Combine(outputDirectory, entry.FullName));
  329. if (!outputFilePath.StartsWithF(PathUtils.AddSlashSuffix(PathUtils.ForCompare(outputDirectory)), ignoreCase:true))
  330. throw new ZipSlipException($"Zip 文件项 {entry.FullName} 的路径在压缩包之外,这可能导致安全问题");
  331. // 实际的解压
  332. using var entryStream = entry.Open();
  333. FileUtils.Write(outputFilePath, entryStream);
  334. }
  335. }
  336. public class ZipSlipException(string message) : Exception(message) {}
  337. /// <summary>
  338. /// 将指定文件夹的内容打包为 zip 文件。
  339. /// 会自动创建文件夹。会覆盖已有文件。
  340. /// </summary>
  341. public static void CreateZipFromDirectory(string outputFullPath, string sourceDirectory) {
  342. DirectoryUtils.Create(PathUtils.RemoveLastPart(outputFullPath));
  343. FileUtils.Delete(outputFullPath);
  344. Logger.Trace($"将文件夹中的内容压缩为 zip 文件:{sourceDirectory} → {outputFullPath}");
  345. ResilientUtils.RetryOn<IOException>(()
  346. => ZipFile.CreateFromDirectory(PathUtils.ForApi(sourceDirectory), PathUtils.ForApi(outputFullPath)));
  347. }
  348. /// <summary>
  349. /// 将多个文件打包为 zip 文件,所有文件都会被放在压缩文件的根目录。
  350. /// 会自动创建文件夹。会覆盖已有文件。
  351. /// </summary>
  352. public static void CreateZipFromFiles(string outputFullPath, params string[] sourceFiles) {
  353. var sources = new Dictionary<string, string>();
  354. foreach (var source in sourceFiles) {
  355. string fileName = PathUtils.GetLastPart(source);
  356. if (sources.ContainsKey(fileName)) throw new ArgumentException($"尝试将多个同文件名的文件放进压缩包中({fileName})", nameof(sourceFiles));
  357. sources.Add(fileName, source);
  358. }
  359. FileUtils.CreateZipFromFiles(outputFullPath, sources);
  360. }
  361. /// <summary>
  362. /// 将多个文件打包为 zip 文件。
  363. /// 会自动创建文件夹。会覆盖已有文件。
  364. /// </summary>
  365. /// <param name="sources">键为 zip 文件下的路径,值为文件的本地路径。</param>
  366. public static void CreateZipFromFiles(string outputFullPath, IDictionary<string, string> sources) {
  367. DirectoryUtils.Create(PathUtils.RemoveLastPart(outputFullPath));
  368. FileUtils.Delete(outputFullPath);
  369. using var archive = ResilientUtils.RetryOn<IOException, ZipArchive>(()
  370. => ZipFile.Open(PathUtils.ForApi(outputFullPath), ZipArchiveMode.Create));
  371. Logger.Trace($"创建 zip 文件:{sources.Count} 个文件 → {outputFullPath}\n{sources.Select(p => $"- {p.Value} → {p.Key}").Join('\n')}");
  372. foreach (var pair in sources) archive.CreateEntryFromFile(PathUtils.ForApi(pair.Value), pair.Key.Replace('\\', '/'), CompressionLevel.Optimal);
  373. }
  374. #endregion
  375. /// <summary>
  376. /// 确定指定的文件是否存在。
  377. /// </summary>
  378. public static bool Exists(string filePath)
  379. => File.Exists(PathUtils.ForApi(filePath));
  380. /// <summary>
  381. /// 获取 <see cref="FileInfo"/> 对象。
  382. /// </summary>
  383. public static FileInfo GetInfo(string path)
  384. => new(PathUtils.ForApi(path));
  385. }
  386. /// <summary>
  387. /// 检查文件是否符合校验规则,包括大小、Hash 值、是否为 JSON 文件。
  388. /// </summary>
  389. public class FileChecker {
  390. /// <summary>
  391. /// 文件的准确大小。
  392. /// <para/>不检查则为 -1。
  393. /// </summary>
  394. public long ActualSize = -1;
  395. /// <summary>
  396. /// 文件的最小大小。
  397. /// <para/>不检查则为 -1。
  398. /// </summary>
  399. public long MinSize = -1;
  400. /// <summary>
  401. /// 文件的 MD5、SHA1、SHA256 或 SHA512。会根据输入字符串的长度自动判断种类。
  402. /// <para/>不检查则为 <c>null</c>。
  403. /// </summary>
  404. public string? Hash = null;
  405. /// <summary>
  406. /// 是否要求为 JSON 文件。
  407. /// </summary>
  408. public bool IsJson = false;
  409. /// <summary>
  410. /// 检查文件。
  411. /// <para/>若成功则返回 <c>null</c>,失败则返回错误的描述文本(文本不以句号结尾)。
  412. /// <para/>不会抛出异常。
  413. /// </summary>
  414. public string? Check(string localPath) {
  415. try {
  416. var info = FileUtils.GetInfo(localPath);
  417. if (!info.Exists) return "文件不存在:" + localPath;
  418. long fileSize = info.Length;
  419. if (ActualSize >= 0 && ActualSize != fileSize) {
  420. return $"文件大小应为 {ActualSize} B,实际为 {fileSize} B" +
  421. (fileSize < 2000 ? ",内容为:" + FileUtils.ReadAsString(localPath) : "");
  422. }
  423. if (MinSize >= 0 && MinSize > fileSize) {
  424. return $"文件大小应至少为 {MinSize} B,实际为 {fileSize} B" +
  425. (fileSize < 2000 ? ",内容为:" + FileUtils.ReadAsString(localPath) : "");
  426. }
  427. string? hash = Hash;
  428. if (!string.IsNullOrEmpty(hash)) {
  429. hash = hash!.Lower();
  430. switch (hash.Length) {
  431. case 32:
  432. string md5 = CryptographyUtils.ComputeFileHash(localPath, CryptographyUtils.HashMethod.Md5);
  433. if (hash != md5) return "文件 MD5 应为 " + hash + ",实际为 " + md5;
  434. break;
  435. case 40:
  436. string sha1 = CryptographyUtils.ComputeFileHash(localPath, CryptographyUtils.HashMethod.Sha1);
  437. if (hash != sha1) return "文件 SHA1 应为 " + hash + ",实际为 " + sha1;
  438. break;
  439. case 64:
  440. string sha256 = CryptographyUtils.ComputeFileHash(localPath, CryptographyUtils.HashMethod.Sha256);
  441. if (hash != sha256) return "文件 SHA256 应为 " + hash + ",实际为 " + sha256;
  442. break;
  443. case 128:
  444. string sha512 = CryptographyUtils.ComputeFileHash(localPath, CryptographyUtils.HashMethod.Sha512);
  445. if (hash != sha512) return "文件 SHA512 应为 " + hash + ",实际为 " + sha512;
  446. break;
  447. default:
  448. return $"无法识别的 Hash 类型(长度为 {hash.Length}):{hash}";
  449. }
  450. }
  451. if (IsJson) {
  452. string content = FileUtils.ReadAsString(localPath);
  453. if (content == "") return "读取到的文件为空";
  454. content.DeserializeJson();
  455. }
  456. return null;
  457. } catch (Exception ex) {
  458. Logger.Warn(ex, "检查文件出错");
  459. return ex.GetDisplay(false);
  460. }
  461. }
  462. }