/* Copyright 2016 Zoey (Zoryn) */ using System; using System.IO; using System.Linq; using System.Reflection; using Newtonsoft.Json; using Newtonsoft.Json.Linq; namespace StardewModdingAPI { public partial class Config { [JsonIgnore] public virtual string ConfigLocation { get; protected internal set; } [JsonIgnore] public virtual string ConfigDir => Path.GetDirectoryName(ConfigLocation); public virtual Config Instance() where T : Config => Activator.CreateInstance(); /// /// Should never be used for anything. /// public Config() { } /// /// Loads the config from the json blob on disk, updating and re-writing to the disk if needed. /// /// /// public virtual T LoadConfig() where T : Config { if (string.IsNullOrEmpty(ConfigLocation)) { Log.Error("A config tried to load without specifying a location on the disk."); return null; } T ret = null; if (!File.Exists(ConfigLocation)) { //no config exists, generate default values var c = this.GenerateBaseConfig(); c.ConfigLocation = ConfigLocation; ret = c; } else { try { //try to load the config from a json blob on disk T c = JsonConvert.DeserializeObject(File.ReadAllText(ConfigLocation)); c.ConfigLocation = ConfigLocation; //update the config with default values if needed ret = c.UpdateConfig(); c = null; } catch (Exception ex) { Log.Error("Invalid JSON Config: {0} \n{1}", ConfigLocation, ex); return GenerateBaseConfig(); } } ret.WriteConfig(); return ret; } /// /// MUST be implemented in inheriting class! /// public virtual T GenerateDefaultConfig() where T : Config { return null; } /// /// Use the public GenerateDefaultConfig insteaad /// [Obsolete] protected virtual T GenerateBaseConfig() where T : Config { return GenerateDefaultConfig(); } /// /// Merges a default-value config with the user-config on disk. /// /// /// public virtual T UpdateConfig() where T : Config { try { //default config var b = JObject.FromObject(Instance().GenerateBaseConfig()); //user config var u = JObject.FromObject(this); //overwrite default values with user values b.Merge(u, new JsonMergeSettings {MergeArrayHandling = MergeArrayHandling.Replace}); //cast json object to config T c = b.ToObject(); //re-write the location on disk to the object c.ConfigLocation = ConfigLocation; return c; } catch (Exception ex) { Log.Error("An error occured when updating a config: " + ex); return this as T; } } } public static class ConfigExtensions { /// /// Initializes an instance of any class that inherits from Config. /// This method performs the loading, saving, and merging of the config on the disk and in memory at a default state. /// This method should not be used to re-load or to re-save a config. /// public static T InitializeConfig(this T baseConfig, string configLocation) where T : Config { if (baseConfig == null) { baseConfig = Activator.CreateInstance(); /* Log.Error("A config tried to initialize whilst being null."); return null; */ } if (string.IsNullOrEmpty(configLocation)) { Log.Error("A config tried to initialize without specifying a location on the disk."); return null; } baseConfig.ConfigLocation = configLocation; T c = baseConfig.LoadConfig(); return c; } /// /// Writes a config to a json blob on the disk specified in the config's properties. /// public static void WriteConfig(this T baseConfig) where T : Config { if (string.IsNullOrEmpty(baseConfig?.ConfigLocation) || string.IsNullOrEmpty(baseConfig.ConfigDir)) { Log.Error("A config attempted to save when it itself or it's location were null."); return; } string s = JsonConvert.SerializeObject(baseConfig, typeof (T), Formatting.Indented, new JsonSerializerSettings()); if (!Directory.Exists(baseConfig.ConfigDir)) Directory.CreateDirectory(baseConfig.ConfigDir); if (!File.Exists(baseConfig.ConfigLocation) || !File.ReadAllText(baseConfig.ConfigLocation).SequenceEqual(s)) File.WriteAllText(baseConfig.ConfigLocation, s); } /// /// Re-reads the json blob on the disk and merges its values with a default config /// public static T ReloadConfig(this T baseConfig) where T : Config { return baseConfig.UpdateConfig(); } [Obsolete] public static void WriteConfig(this Config baseConfig) { Log.Error("A config has been written through an obsolete way.\n\tThis method of writing configs will not be supported in future versions."); WriteConfig(baseConfig); } [Obsolete] public static Config ReloadConfig(this Config baseConfig) { Log.Error("A config has been reloaded through an obsolete way.\n\tThis method of loading configs will not be supported in future versions."); return baseConfig.ReloadConfig(); } } public partial class Config { [Obsolete] public static int invalids = 0; [JsonIgnore] [Obsolete] public virtual JObject JObject { get; protected set; } [Obsolete] public static Config InitializeConfig(string configLocation, Config baseConfig) { invalids++; if (string.IsNullOrEmpty(configLocation)) { Log.Verbose("The location to save the config to must not be empty."); return null; } if (baseConfig == null) { Log.Verbose("A config must be instantiated before being passed to Initialize.\n\t" + configLocation); return null; } baseConfig.ConfigLocation = configLocation; return baseConfig.LoadConfig(baseConfig); } [Obsolete] public virtual Config GenerateBaseConfig(Config baseConfig) { //Must be implemented in sub-class return null; } [Obsolete] public virtual Config LoadConfig(Config baseConfig) { if (!File.Exists(baseConfig.ConfigLocation)) { var v = (Config) baseConfig.GetType().GetMethod("GenerateBaseConfig", BindingFlags.Public | BindingFlags.Instance).Invoke(baseConfig, new object[] {baseConfig}); v.WriteConfig(); } else { var p = baseConfig.ConfigLocation; try { var j = JObject.Parse(File.ReadAllText(baseConfig.ConfigLocation)); baseConfig = (Config) j.ToObject(baseConfig.GetType()); baseConfig.ConfigLocation = p; baseConfig.JObject = j; baseConfig = UpdateConfig(baseConfig); baseConfig.ConfigLocation = p; baseConfig.JObject = j; baseConfig.WriteConfig(); } catch { Log.Verbose("Invalid JSON: " + p); } } return baseConfig; } [Obsolete] public virtual Config UpdateConfig(Config baseConfig) { try { //default config with all standard values var b = JObject.FromObject(baseConfig.GetType().GetMethod("GenerateBaseConfig", BindingFlags.Public | BindingFlags.Instance).Invoke(baseConfig, new object[] {baseConfig})); //user config with their values var u = baseConfig.JObject; b.Merge(u, new JsonMergeSettings {MergeArrayHandling = MergeArrayHandling.Replace}); return (Config) b.ToObject(baseConfig.GetType()); } catch (Exception ex) { Log.Error(ex.ToString()); } return baseConfig; } /// /// NOTICE: THIS IS OBSOLETE AND WILL BE REMOVED IN THE FUTURE. 'BaseConfigPath' IS NOW A PROPERTY IN A MOD /// /// /// [Obsolete] public static string GetBasePath(Mod theMod) { return theMod.BaseConfigPath; } } }