DisplayMagician/DisplayMagician/ProgramSettings.cs

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Windows.Forms;


namespace DisplayMagician
{

    public class ProgramSettings
    {
        #region Class Variables
        // Common items to the class
        private static bool _programSettingsLoaded = false;
        // Other constants that are useful
        public static string programSettingsStorageJsonFileName = Path.Combine(Program.AppDataPath, $"Settings_2.0.json");
        private static readonly NLog.Logger logger = NLog.LogManager.GetCurrentClassLogger();
        #endregion

        #region Instance Variables
        private bool _startOnBootUp = false;
        private bool _minimiseOnStart = false;
        private bool _showSplashScreen = true;
        private bool _upgradeToPrereleases = false;
        private int _lastMessageIdRead = 0;
        private List<int> _messagesToMonitor = new List<int>();
        private string _logLevel = NLog.LogLevel.Info.ToString();
        private Keys _hotkeyMainWindow = Keys.None;
        private Keys _hotkeyDisplayProfileWindow = Keys.None;
        private Keys _hotkeyShortcutLibraryWindow = Keys.None;
        #endregion

        #region Class Properties
        public bool StartOnBootUp
        {
            get
            {
                return _startOnBootUp;
            }
            set
            {
                _startOnBootUp = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                    SaveSettings();
            }
        }

        public bool ShowSplashScreen
        {
            get
            {
                return _showSplashScreen;
            }
            set
            {
                _showSplashScreen = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                    SaveSettings();
            }
        }

        public bool UpgradeToPreReleases
        {
            get
            {
                return _upgradeToPrereleases;
            }
            set
            {
                _upgradeToPrereleases = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                    SaveSettings();
            }
        }

        public bool MinimiseOnStart { 
            get
            {
                return _minimiseOnStart;
            }
            set 
            {
                _minimiseOnStart = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                    SaveSettings();
            } 
        }

        public int LastMessageIdRead
        {
            get
            {
                return _lastMessageIdRead;
            }
            set
            {
                _lastMessageIdRead = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                    SaveSettings();
            }
        }

        public List<int> MessagesToMonitor
        {
            get
            {
                return _messagesToMonitor;
            }
            set
            {
                _messagesToMonitor = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                    SaveSettings();
            }
        }

        public string LogLevel
        {
            get
            {
                return _logLevel;
            }
            set
            {

                switch (value.ToLower())
                {
                    case "trace":
                        _logLevel = NLog.LogLevel.Trace.ToString();
                        break;
                    case "debug":
                        _logLevel = NLog.LogLevel.Debug.ToString();
                        break;
                    case "info":
                        _logLevel = NLog.LogLevel.Info.ToString();
                        break;
                    case "warn":
                        _logLevel = NLog.LogLevel.Warn.ToString();
                        break;
                    case "error":
                        _logLevel = NLog.LogLevel.Error.ToString();
                        break;
                    case "fatal":
                        _logLevel = NLog.LogLevel.Fatal.ToString();
                        break;
                    default:
                        _logLevel = NLog.LogLevel.Info.ToString();
                        break;

                }

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                    SaveSettings();
            }
        }

        public Keys HotkeyMainWindow
        {
            get
            {
                return _hotkeyMainWindow;
            }
            set
            {
                _hotkeyMainWindow = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                {
                    SaveSettings();
                }
            }
        }

        public Keys HotkeyDisplayProfileWindow
        {
            get
            {
                return _hotkeyDisplayProfileWindow;
            }
            set
            {
                _hotkeyDisplayProfileWindow = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                {
                    SaveSettings();
                }
            }
        }

        public Keys HotkeyShortcutLibraryWindow
        {
            get
            {
                return _hotkeyShortcutLibraryWindow;
            }
            set
            {
                _hotkeyShortcutLibraryWindow = value;

                // Because a value has changed, we need to save the setting 
                // to remember it for later.
                if (_programSettingsLoaded)
                {
                    SaveSettings();
                }
            }
        }

        #endregion

        #region Class Methods
        public static ProgramSettings LoadSettings()
        {
            // NOTE: This function gets called before NLog has setup the logger, meaning
            // that we can't log to the log file yet. This is because we need to load the
            // loglevel settings so we know what level to configure the logger to write!
            // This means we have to only use console.write in this function....
            ProgramSettings programSettings = null;

            if (File.Exists(programSettingsStorageJsonFileName))
            {
                string json = "";
                try {
                    json = File.ReadAllText(programSettingsStorageJsonFileName, Encoding.Unicode);
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"ProgramSettings/LoadSettings: Tried to read the JSON file {programSettingsStorageJsonFileName} to memory from disk but File.ReadAllText threw an exception. {ex}");
                }

                if (!string.IsNullOrWhiteSpace(json))
                {
                    try
                    {
                        programSettings = JsonConvert.DeserializeObject<ProgramSettings>(json, new JsonSerializerSettings
                        {
                            MissingMemberHandling = MissingMemberHandling.Ignore,
                            NullValueHandling = NullValueHandling.Ignore,
                            DefaultValueHandling = DefaultValueHandling.Include,
                            TypeNameHandling = TypeNameHandling.Auto
                        });
                    }
                    catch (Exception ex)
                    {
                        Console.WriteLine($"ProgramSettings/LoadSettings: Tried to parse the JSON file {programSettingsStorageJsonFileName} but the JsonConvert threw an exception. {ex}");
                    }
                }
            }
            else
            {
                Console.WriteLine($"ProgramSettings/LoadSettings: No ProgramSettings file found. Creating new one at {programSettingsStorageJsonFileName}");
                programSettings = new ProgramSettings();
                programSettings.SaveSettings();
            }

            // If there isn't any settings in the file then create a new ProgramSettings object
            if (programSettings == null)
                programSettings = new ProgramSettings();
            _programSettingsLoaded = true;

            return programSettings ;
        }

        public bool SaveSettings()
        {

            logger.Debug($"ProgramSettings/SaveSettings: Attempting to save the program settings to the {programSettingsStorageJsonFileName}.");

            try
            {
                var json = JsonConvert.SerializeObject(this, Formatting.Indented, new JsonSerializerSettings
                {
                    NullValueHandling = NullValueHandling.Include,
                    DefaultValueHandling = DefaultValueHandling.Populate,
                    TypeNameHandling = TypeNameHandling.Auto

                });


                if (!string.IsNullOrWhiteSpace(json))
                {
                    File.WriteAllText(programSettingsStorageJsonFileName, json, Encoding.Unicode);
                    return true;
                }
            }
            catch (Exception ex)
            {
                logger.Error(ex, $"ProgramSettings/SaveSettings: Exception attempting to save the program settings to {programSettingsStorageJsonFileName}.");
            }

            return false;
        }

        #endregion
    }


}