using System; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Linq; using PKHeX.Core; using static PKHeX.Core.MessageStrings; namespace PKHeX.WinForms { /// /// Contains extension methods for use with a . /// public static class SAVUtil { /// /// Dumps a folder of files to the . /// /// that is being dumped from. /// Folder to store files. /// Result message from the method. /// Option to save in child folders with the Box Name as the folder name. /// public static bool DumpBoxes(this SaveFile SAV, string path, out string result, bool boxFolders = false) { var boxdata = SAV.BoxData; if (boxdata == null) { result = MsgSaveBoxExportInvalid; return false; } int ctr = 0; foreach (PKM pk in boxdata) { if (pk.Species == 0 || !pk.Valid) continue; ctr++; string fileName = Util.CleanFileName(pk.FileName); string boxfolder = string.Empty; if (boxFolders) { boxfolder = SAV.GetBoxName(pk.Box - 1); Directory.CreateDirectory(Path.Combine(path, boxfolder)); } if (!File.Exists(Path.Combine(Path.Combine(path, boxfolder), fileName))) File.WriteAllBytes(Path.Combine(Path.Combine(path, boxfolder), fileName), pk.DecryptedBoxData); } result = string.Format(MsgSaveBoxExportPathCount, ctr) + Environment.NewLine + path; return true; } /// /// Dumps the to a folder with individual decrypted files. /// /// that is being dumped from. /// Folder to store files. /// Result message from the method. /// Box contents to be dumped. /// public static bool DumpBox(this SaveFile SAV, string path, out string result, int currentBox) { var boxdata = SAV.BoxData; if (boxdata == null) { result = MsgSaveBoxExportInvalid; return false; } int ctr = 0; foreach (PKM pk in boxdata) { if (pk.Species == 0 || !pk.Valid || pk.Box - 1 != currentBox) continue; ctr++; string fileName = Util.CleanFileName(pk.FileName); if (!File.Exists(Path.Combine(path, fileName))) File.WriteAllBytes(Path.Combine(path, fileName), pk.DecryptedBoxData); } result = string.Format(MsgSaveBoxExportPathCount, ctr) + Environment.NewLine + path; return true; } /// /// 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. /// Bypass option to not modify properties when setting to Save File. /// Enumerate all files even in sub-folders. /// True if any files are imported. public static bool LoadBoxes(this SaveFile SAV, string path, out string result, int boxStart = 0, bool boxClear = false, bool? noSetb = null, bool all = false) { if (string.IsNullOrWhiteSpace(path) || !Directory.Exists(path)) { result = MsgSaveBoxExportPathInvalid; return false; } var opt = all ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly; var filepaths = Directory.EnumerateFiles(path, "*.*", opt); return SAV.LoadBoxes(filepaths, out result, boxStart, boxClear, 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. /// Bypass option to not modify properties when setting to Save File. /// True if any files are imported. public static bool LoadBoxes(this SaveFile SAV, IEnumerable filepaths, out string result, int boxStart = 0, bool boxClear = false, bool? noSetb = null) { int generation = SAV.Generation; var pks = GetPKMsFromPaths(filepaths, generation); return SAV.LoadBoxes(pks, out result, boxStart, boxClear, noSetb); } /// /// Loads a folder of files to the . /// /// to load folder to. /// Gifts 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. /// Bypass option to not modify properties when setting to Save File. /// True if any files are imported. public static bool LoadBoxes(this SaveFile SAV, IEnumerable gifts, out string result, int boxStart = 0, bool boxClear = false, bool? noSetb = null) { var pks = gifts.Select(z => z.ConvertToPKM(SAV)); return SAV.LoadBoxes(pks, out result, boxStart, boxClear, 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. /// Bypass option to not modify properties when setting to Save File. /// True if any files are imported. public static bool LoadBoxes(this SaveFile SAV, IEnumerable pks, out string result, int boxStart = 0, bool boxClear = false, bool? noSetb = null) { if (!SAV.HasBox) { result = MsgSaveBoxFailNone; return false; } var compat = GetPKMForSaveFile(SAV, pks); if (boxClear) SAV.ClearBoxes(boxStart); int ctr = SAV.ImportPKMs(compat, boxStart, noSetb); if (ctr <= 0) { result = MsgSaveBoxImportNoFiles; return false; } result = string.Format(MsgSaveBoxImportSuccess, ctr); return true; } private static int ImportPKMs(this SaveFile SAV, IEnumerable compat, int boxStart, bool? noSetb) { int startCount = boxStart * SAV.BoxSlotCount; int maxCount = SAV.BoxCount * SAV.BoxSlotCount; int i = startCount; int getbox() => i / SAV.BoxSlotCount; int getslot() => i % SAV.BoxSlotCount; foreach (var pk in compat) { int box = getbox(); int slot = getslot(); while (SAV.IsSlotLocked(box, slot)) { ++i; box = getbox(); slot = getslot(); } int offset = SAV.GetBoxOffset(box) + slot * SAV.SIZE_STORED; SAV.SetStoredSlot(pk, offset, noSetb); if (++i == maxCount) // Boxes full! break; } i -= startCount; // actual imported count return i; } private static IEnumerable GetPKMsFromPaths(IEnumerable filepaths, int generation) { return filepaths .Where(file => PKX.IsPKM(new FileInfo(file).Length)) .Select(File.ReadAllBytes) .Select(data => PKMConverter.GetPKMfromBytes(data, prefer: generation)) .Where(temp => temp != null); } private static IEnumerable GetPKMForSaveFile(this SaveFile SAV, IEnumerable pks) { var savtype = SAV.PKMType; foreach (var temp in pks) { PKM pk = PKMConverter.ConvertToType(temp, savtype, out string c); if (pk == null) { Debug.WriteLine(c); continue; } var compat = SAV.IsPKMCompatible(pk); if (compat.Length > 0) continue; yield return pk; } } /// /// Checks a file for compatibility to the . /// /// that is being checked. /// that is being tested for compatibility. /// public static string[] IsPKMCompatible(this SaveFile SAV, PKM pkm) { // Check if PKM properties are outside of the valid range List errata = new List(); if (SAV.Generation > 1) { ushort held = (ushort)pkm.HeldItem; if (held > GameInfo.Strings.itemlist.Length) errata.Add($"{MsgIndexItemRange} {held}"); else if (held > SAV.MaxItemID) errata.Add($"{MsgIndexItemGame} {GameInfo.Strings.itemlist[held]}"); else if (!pkm.CanHoldItem(SAV.HeldItems)) errata.Add($"{MsgIndexItemHeld} {GameInfo.Strings.itemlist[held]}"); } if (pkm.Species > GameInfo.Strings.specieslist.Length) errata.Add($"{MsgIndexSpeciesRange} {pkm.Species}"); else if (SAV.MaxSpeciesID < pkm.Species) errata.Add($"{MsgIndexSpeciesGame} {GameInfo.Strings.specieslist[pkm.Species]}"); if (!SAV.Personal[pkm.Species].IsFormeWithinRange(pkm.AltForm) && !FormConverter.IsValidOutOfBoundsForme(pkm.Species, pkm.AltForm, pkm.GenNumber)) errata.Add(string.Format(LegalityCheckStrings.V304, Math.Max(0, SAV.Personal[pkm.Species].FormeCount - 1), pkm.AltForm)); if (pkm.Moves.Any(m => m > GameInfo.Strings.movelist.Length)) errata.Add($"{MsgIndexMoveRange} {string.Join(", ", pkm.Moves.Where(m => m > GameInfo.Strings.movelist.Length).Select(m => m.ToString()))}"); else if (pkm.Moves.Any(m => m > SAV.MaxMoveID)) errata.Add($"{MsgIndexMoveGame} {string.Join(", ", pkm.Moves.Where(m => m > SAV.MaxMoveID).Select(m => GameInfo.Strings.movelist[m]))}"); if (pkm.Ability > GameInfo.Strings.abilitylist.Length) errata.Add($"{MsgIndexAbilityRange} {pkm.Ability}"); else if (pkm.Ability > SAV.MaxAbilityID) errata.Add($"{MsgIndexAbilityGame} {GameInfo.Strings.abilitylist[pkm.Ability]}"); return errata.ToArray(); } /// /// Removes the for all in the . /// /// that is being operated on. /// to set. If no argument is supplied, the held item will be removed. public static void SetBoxDataAllHeldItems(this SaveFile SAV, int item = 0) { var boxdata = SAV.BoxData; foreach (PKM pk in boxdata) { pk.HeldItem = item; pk.RefreshChecksum(); } SAV.BoxData = boxdata; } } }