summaryrefslogtreecommitdiff
path: root/src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Other/ApplySaveFixCommand.cs
blob: f31457ed61711fa5bb7d3ebd6411b65911fec421 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
#nullable disable

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using StardewValley;

namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Other
{
    /// <summary>A command which runs one of the game's save migrations.</summary>
    [SuppressMessage("ReSharper", "UnusedMember.Global", Justification = "Loaded using reflection")]
    internal class ApplySaveFixCommand : ConsoleCommand
    {
        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        public ApplySaveFixCommand()
            : base("apply_save_fix", "Apply one of the game's save migrations to the currently loaded save. WARNING: This may corrupt or make permanent changes to your save. DO NOT USE THIS unless you're absolutely sure.\n\nUsage: apply_save_fix list\nList all valid save IDs.\n\nUsage: apply_save_fix <fix ID>\nApply the named save fix.") { }

        /// <summary>Handle the command.</summary>
        /// <param name="monitor">Writes messages to the console and log file.</param>
        /// <param name="command">The command name.</param>
        /// <param name="args">The command arguments.</param>
        public override void Handle(IMonitor monitor, string command, ArgumentParser args)
        {
            // get fix ID
            if (!args.TryGet(0, "fix_id", out string rawFixId, required: false))
            {
                monitor.Log("Invalid usage. Type 'help apply_save_fix' for details.", LogLevel.Error);
                return;
            }
            rawFixId = rawFixId.Trim();


            // list mode
            if (rawFixId == "list")
            {
                monitor.Log("Valid save fix IDs:\n  - " + string.Join("\n  - ", this.GetSaveIds()), LogLevel.Info);
                return;
            }

            // validate fix ID
            if (!Enum.TryParse(rawFixId, ignoreCase: true, out SaveGame.SaveFixes fixId))
            {
                monitor.Log($"Invalid save ID '{rawFixId}'. Type 'help apply_save_fix' for details.", LogLevel.Error);
                return;
            }

            // apply
            monitor.Log("THIS MAY CAUSE PERMANENT CHANGES TO YOUR SAVE FILE. If you're not sure, exit your game without saving to avoid issues.", LogLevel.Warn);
            monitor.Log($"Trying to apply save fix ID: '{fixId}'.", LogLevel.Warn);
            try
            {
                Game1.applySaveFix(fixId);
                monitor.Log("Save fix applied.", LogLevel.Info);
            }
            catch (Exception ex)
            {
                monitor.Log("Applying save fix failed. The save may be in an invalid state; you should exit your game now without saving to avoid issues.", LogLevel.Error);
                monitor.Log($"Technical details: {ex}", LogLevel.Debug);
            }
        }


        /*********
        ** Private methods
        *********/
        /// <summary>Get the valid save fix IDs.</summary>
        private IEnumerable<string> GetSaveIds()
        {
            foreach (SaveGame.SaveFixes id in Enum.GetValues(typeof(SaveGame.SaveFixes)))
            {
                if (id == SaveGame.SaveFixes.MAX)
                    continue;

                yield return id.ToString();
            }
        }
    }
}