using System; using System.Collections.Generic; using System.IO; using System.Linq; using static PKHeX.Core.MessageStrings; namespace PKHeX.Core; /// /// Contains extension methods for use with a . /// public static class BoxUtil { /// /// Dumps a folder of files to the . /// /// that is being dumped from. /// Folder to store files. /// Option to save in child folders with the Box Name as the folder name. /// -1 if aborted, otherwise the amount of files dumped. public static int DumpBoxes(this SaveFile sav, string path, bool boxFolders = false) { if (!sav.HasBox) return -1; var boxData = sav.BoxData; int boxSlotCount = sav.BoxSlotCount; var ctr = 0; for (var slot = 0; slot < boxData.Count; slot++) { var pk = boxData[slot]; var box = slot / boxSlotCount; if (pk.Species == 0 || !pk.Valid) continue; var boxFolder = path; if (boxFolders) { string boxName = sav is IBoxDetailName bn ? bn.GetBoxName(box) : BoxDetailNameExtensions.GetDefaultBoxName(box); boxName = Util.CleanFileName(boxName); boxFolder = Path.Combine(path, boxName); Directory.CreateDirectory(boxFolder); } var fileName = Util.CleanFileName(pk.FileName); var fn = Path.Combine(boxFolder, fileName); if (File.Exists(fn)) continue; File.WriteAllBytes(fn, pk.DecryptedPartyData); ctr++; } return ctr; } /// /// Dumps the to a folder with individual decrypted files. /// /// that is being dumped from. /// Folder to store files. /// Box contents to be dumped. /// -1 if aborted, otherwise the amount of files dumped. public static int DumpBox(this SaveFile sav, string path, int currentBox) { if (!sav.HasBox) return -1; var boxData = sav.BoxData; int boxSlotCount = sav.BoxSlotCount; var ctr = 0; for (var slot = 0; slot < boxData.Count; slot++) { var pk = boxData[slot]; var box = slot / boxSlotCount; if (pk.Species == 0 || !pk.Valid || box != currentBox) continue; var fileName = Path.Combine(path, Util.CleanFileName(pk.FileName)); if (File.Exists(fileName)) continue; File.WriteAllBytes(fileName, pk.DecryptedPartyData); ctr++; } return ctr; } /// /// Loads a folder of files to the . /// /// to load folder to. /// Folder to load files from. Files are only loaded from the top directory. /// Result message from the method. /// First box to start loading to. All prior boxes are not modified. /// Instruction to clear boxes after the starting box. /// Overwrite existing full slots. If true, will only overwrite empty slots. /// Bypass option to not modify properties when setting to Save File. /// Enumerate all files even in sub-folders. /// Count of files imported. public static int LoadBoxes(this SaveFile sav, string path, out string result, int boxStart = 0, bool boxClear = false, bool overwrite = false, PKMImportSetting noSetb = PKMImportSetting.UseDefault, bool all = false) { if (string.IsNullOrWhiteSpace(path) || !Directory.Exists(path)) { result = MsgSaveBoxExportPathInvalid; return -1; } var option = all ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly; var files = Directory.EnumerateFiles(path, "*.*", option); return sav.LoadBoxes(files, out result, boxStart, boxClear, overwrite, noSetb); } /// /// Loads a folder of files to the . /// /// to load folder to. /// Files to load files from. /// Result message from the method. /// First box to start loading to. All prior boxes are not modified. /// Instruction to clear boxes after the starting box. /// Overwrite existing full slots. If true, will only overwrite empty slots. /// Bypass option to not modify properties when setting to Save File. /// Count of files imported. public static int LoadBoxes(this SaveFile sav, IEnumerable files, out string result, int boxStart = 0, bool boxClear = false, bool overwrite = false, PKMImportSetting noSetb = PKMImportSetting.UseDefault) { var pks = GetPossiblePKMsFromPaths(sav, files); return sav.LoadBoxes(pks, out result, boxStart, boxClear, overwrite, noSetb); } /// /// Loads a folder of files to the . /// /// to load folder to. /// Encounters to create files from. /// Result message from the method. /// First box to start loading to. All prior boxes are not modified. /// Instruction to clear boxes after the starting box. /// Overwrite existing full slots. If true, will only overwrite empty slots. /// Bypass option to not modify properties when setting to Save File. /// Count of files imported. public static int LoadBoxes(this SaveFile sav, IEnumerable encounters, out string result, int boxStart = 0, bool boxClear = false, bool overwrite = false, PKMImportSetting noSetb = PKMImportSetting.UseDefault) { var pks = encounters.Select(z => z.ConvertToPKM(sav)); return sav.LoadBoxes(pks, out result, boxStart, boxClear, overwrite, noSetb); } /// /// Loads a folder of files to the . /// /// to load folder to. /// Unconverted objects to load. /// Result message from the method. /// First box to start loading to. All prior boxes are not modified. /// Instruction to clear boxes after the starting box. /// Overwrite existing full slots. If true, will only overwrite empty slots. /// Bypass option to not modify properties when setting to Save File. /// True if any files are imported. public static int LoadBoxes(this SaveFile sav, IEnumerable pks, out string result, int boxStart = 0, bool boxClear = false, bool overwrite = false, PKMImportSetting noSetb = PKMImportSetting.UseDefault) { if (!sav.HasBox) { result = MsgSaveBoxFailNone; return -1; } var compat = sav.GetCompatible(pks); if (boxClear) sav.ClearBoxes(boxStart); int ctr = sav.ImportPKMs(compat, overwrite, boxStart, noSetb); if (ctr <= 0) { result = MsgSaveBoxImportNoFiles; return -1; } result = string.Format(MsgSaveBoxImportSuccess, ctr); return ctr; } public static IEnumerable GetPKMsFromPaths(IEnumerable files, EntityContext generation) { foreach (var f in files) { var fi = new FileInfo(f); if (!fi.Exists) continue; if (!EntityDetection.IsSizePlausible(fi.Length)) continue; var data = File.ReadAllBytes(f); var prefer = EntityFileExtension.GetContextFromExtension(fi.Extension, generation); var pk = EntityFormat.GetFromBytes(data, prefer); if (pk?.Species is > 0) yield return pk; } } private static IEnumerable GetPossiblePKMsFromPaths(SaveFile sav, IEnumerable files) { foreach (var f in files) { var obj = FileUtil.GetSupportedFile(f, sav); switch (obj) { case PKM pk: yield return pk; break; case MysteryGift {IsEntity: true} g: yield return g.ConvertToPKM(sav); break; case IEncounterInfo g when g.Species != 0: yield return g.ConvertToPKM(sav); break; case IPokeGroup g: foreach (var p in g.Contents) yield return p; break; case IEnumerable contents: foreach (var pk in contents) yield return pk; break; } } } /// /// Gets box names for all boxes in the save file. /// /// that box names are being dumped for. /// Returns default English box names in the event the save file does not have names (not exportable), or fails to return a box name. public static string[] GetBoxNames(SaveFile sav) { var count = sav.BoxCount; if (count == 0) return []; var result = new string[count]; GetBoxNames(sav, result); return result; } private static void GetBoxNames(SaveFile sav, Span result) { if (!sav.State.Exportable || sav is not IBoxDetailNameRead r) { for (int i = 0; i < result.Length; i++) result[i] = BoxDetailNameExtensions.GetDefaultBoxName(i); return; } for (int i = 0; i < result.Length; i++) { try { result[i] = r.GetBoxName(i); } catch { result[i] = BoxDetailNameExtensions.GetDefaultBoxName(i); } } } }