add migration logic

Pepperdash Core/Pepperdash Core/Logging/Debug.cs

@@ -1,7 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 using System.Text.RegularExpressions;
 using Crestron.SimplSharp;
 using Crestron.SimplSharp.Reflection;
@@ -13,42 +11,58 @@ using PepperDash.Core.DebugThings;
 
 namespace PepperDash.Core
 {
+    /// <summary>
+    /// Contains debug commands for use in various situations
+    /// </summary>
     public static class Debug
     {
         /// <summary>
         /// Describes the folder location where a given program stores it's debug level memory. By default, the
         /// file written will be named appNdebug where N is 1-10.
         /// </summary>
-        public static string oldFilePathPrefix = @"\nvram\debug\";
+        public static string OldFilePathPrefix = @"\nvram\debug\";
 
-        public static string newFilePathPrefix = @"\user\debug\";
+        /// <summary>
+        /// Describes the new folder location where a given program stores it's debug level memory. By default, the
+        /// file written will be named appNdebug where N is 1-10.
+        /// </summary>
+        public static string NewFilePathPrefix = @"\user\debug\";
 
         /// <summary>
         /// The name of the file containing the current debug settings.
         /// </summary>
         public static string FileName = string.Format(@"app{0}Debug.json", InitialParametersClass.ApplicationNumber);
 
+        /// <summary>
+        /// Debug level to set for a given program.
+        /// </summary>
         public static int Level { get; private set; }
 
+        /// <summary>
+        /// When this is true, the configuration file will NOT be loaded until triggered by either a console command or a signal
+        /// </summary>
         public static bool DoNotLoadOnNextBoot { get; private set; }
 
-        static DebugContextCollection Contexts;
+        private static DebugContextCollection _contexts;
 
-        static int SaveTimeoutMs = 30000;
+        private const int SaveTimeoutMs = 30000;
 
+        /// <summary>
+        /// Version for the currently loaded PepperDashCore dll
+        /// </summary>
         public static string PepperDashCoreVersion { get; private set; } 
 
-        static CTimer SaveTimer;
+        private static CTimer _saveTimer;
 
 		/// <summary>
 		/// When true, the IncludedExcludedKeys dict will contain keys to include. 
 		/// When false (default), IncludedExcludedKeys will contain keys to exclude.
 		/// </summary>
-		static bool ExcludeAllMode;
+		private static bool _excludeAllMode;
 
 		//static bool ExcludeNoKeyMessages;
 
-		static Dictionary<string, object> IncludedExcludedKeys;
+		private static readonly Dictionary<string, object> IncludedExcludedKeys;
 
         static Debug()
         {
@@ -105,7 +119,7 @@ namespace PepperDash.Core
 
             LoadMemory();
 
-            var context = Contexts.GetOrCreateItem("DEFAULT");
+            var context = _contexts.GetOrCreateItem("DEFAULT");
             Level = context.Level;
             DoNotLoadOnNextBoot = context.DoNotLoadOnNextBoot;
 
@@ -137,10 +151,10 @@ namespace PepperDash.Core
         {
             if (programEventType == eProgramStatusEventType.Stopping)
             {
-                if (SaveTimer != null)
+                if (_saveTimer != null)
                 {
-                    SaveTimer.Stop();
+                    _saveTimer.Stop();
-                    SaveTimer = null;
+                    _saveTimer = null;
                 }
                 Console(0, "Saving debug settings");
                 SaveMemory();
@@ -217,12 +231,12 @@ namespace PepperDash.Core
 				if (lkey == "+all")
 				{
 					IncludedExcludedKeys.Clear();
-					ExcludeAllMode = false;
+					_excludeAllMode = false;
 				}
 				else if (lkey == "-all")
 				{
 					IncludedExcludedKeys.Clear();
-					ExcludeAllMode = true;
+					_excludeAllMode = true;
 				}
 				//else if (lkey == "+nokey")
 				//{
@@ -234,12 +248,12 @@ namespace PepperDash.Core
 				//}
 				else
 				{
-					string key = null; ;
+					string key;
 					if (lkey.StartsWith("-"))
 					{
 						key = lkey.Substring(1);
 						// if in exclude all mode, we need to remove this from the inclusions
-						if (ExcludeAllMode)
+						if (_excludeAllMode)
 						{
 							if (IncludedExcludedKeys.ContainsKey(key))
 								IncludedExcludedKeys.Remove(key);
@@ -254,7 +268,7 @@ namespace PepperDash.Core
 					{
 						key = lkey.Substring(1);
 						// if in exclude all mode, we need to add this as inclusion
-						if (ExcludeAllMode)
+						if (_excludeAllMode)
 						{
 
 							IncludedExcludedKeys[key] = new object();
@@ -280,7 +294,7 @@ namespace PepperDash.Core
             if (level <= 2)
             {
                 Level = level;
-                Contexts.GetOrCreateItem("DEFAULT").Level = level;
+                _contexts.GetOrCreateItem("DEFAULT").Level = level;
                 SaveMemoryOnTimeout();
 
                 CrestronConsole.PrintLine("[Application {0}], Debug level set to {1}",
@@ -300,7 +314,7 @@ namespace PepperDash.Core
         /// <returns></returns>
         public static void SetDeviceDebugSettings(string deviceKey, object settings)
         {
-            Contexts.SetDebugSettingsForKey(deviceKey, settings);
+            _contexts.SetDebugSettingsForKey(deviceKey, settings);
             SaveMemoryOnTimeout();
         }
 
@@ -311,7 +325,7 @@ namespace PepperDash.Core
         /// <returns></returns>
         public static object GetDeviceDebugSettingsForKey(string deviceKey)
         {
-            return Contexts.GetDebugSettingsForKey(deviceKey);
+            return _contexts.GetDebugSettingsForKey(deviceKey);
         }  
 
         /// <summary>
@@ -321,7 +335,7 @@ namespace PepperDash.Core
         public static void SetDoNotLoadOnNextBoot(bool state)
         {
             DoNotLoadOnNextBoot = state;
-            Contexts.GetOrCreateItem("DEFAULT").DoNotLoadOnNextBoot = state;
+            _contexts.GetOrCreateItem("DEFAULT").DoNotLoadOnNextBoot = state;
             SaveMemoryOnTimeout();
 
             CrestronConsole.PrintLine("[Application {0}], Do Not Start on Next Boot set to {1}",
@@ -361,6 +375,10 @@ namespace PepperDash.Core
                 Console(level, "[{0}] {1}", dev.Key, string.Format(format, items));
         }
 
+        /// <summary>
+        /// Prints message to console if current debug level is equal to or higher than the level of this message. Always sends message to Error Log.
+        /// Uses CrestronConsole.PrintLine.
+        /// </summary>
         public static void Console(uint level, IKeyed dev, ErrorLogLevel errorLogLevel,
             string format, params object[] items)
         {
@@ -391,9 +409,6 @@ namespace PepperDash.Core
         /// or above the level provided, then the output will be written to both console and the log. Otherwise
         /// it will only be written to the log.
         /// </summary>
-        /// <param name="level"></param>
-        /// <param name="format"></param>
-        /// <param name="items"></param>
         public static void ConsoleWithLog(uint level, string format, params object[] items)
         {
             var str = string.Format(format, items);
@@ -407,10 +422,6 @@ namespace PepperDash.Core
         /// or above the level provided, then the output will be written to both console and the log. Otherwise
         /// it will only be written to the log.
         /// </summary>
-        /// <param name="level"></param>
-        /// <param name="dev"></param>
-        /// <param name="format">String.format string</param>
-        /// <param name="items">Parameters for substitution in the format string.</param>
         public static void ConsoleWithLog(uint level, IKeyed dev, string format, params object[] items)
         {
             var str = string.Format(format, items);
@@ -425,7 +436,7 @@ namespace PepperDash.Core
         /// <param name="str"></param>
         public static void LogError(ErrorLogLevel errorLogLevel, string str)
         {
-            string msg = string.Format("App {0}:{1}", InitialParametersClass.ApplicationNumber, str);
+            var msg = string.Format("App {0}:{1}", InitialParametersClass.ApplicationNumber, str);
             switch (errorLogLevel)
             {
                 case ErrorLogLevel.Error:
@@ -445,14 +456,15 @@ namespace PepperDash.Core
         /// </summary>
         static void SaveMemoryOnTimeout()
         {
-            if (SaveTimer == null)
+            Console(0, "Saving debug settings");
-                SaveTimer = new CTimer(o =>
+            if (_saveTimer == null)
+                _saveTimer = new CTimer(o =>
                 {
-                    SaveTimer = null;
+                    _saveTimer = null;
                     SaveMemory();
                 }, SaveTimeoutMs);
             else
-                SaveTimer.Reset(SaveTimeoutMs);
+                _saveTimer.Reset(SaveTimeoutMs);
         }
 
         /// <summary>
@@ -464,9 +476,9 @@ namespace PepperDash.Core
             //if (!Directory.Exists(dir))
             //    Directory.Create(dir);
 
-            using (StreamWriter sw = new StreamWriter(GetMemoryFileName()))
+            using (var sw = new StreamWriter(GetMemoryFileName()))
             {
-                var json = JsonConvert.SerializeObject(Contexts);
+                var json = JsonConvert.SerializeObject(_contexts);
                 sw.Write(json);
                 sw.Flush();
             }
@@ -480,20 +492,20 @@ namespace PepperDash.Core
             var file = GetMemoryFileName();
             if (File.Exists(file))
             {
-                using (StreamReader sr = new StreamReader(file))
+                using (var sr = new StreamReader(file))
                 {
                     var json = sr.ReadToEnd();
-                    Contexts = JsonConvert.DeserializeObject<DebugContextCollection>(json);
+                    _contexts = JsonConvert.DeserializeObject<DebugContextCollection>(json);
 
-                    if (Contexts != null)
+                    if (_contexts != null)
                     {
-                        Debug.Console(1, "Debug memory restored from file");
+                        Console(1, "Debug memory restored from file");
                         return;
                     }
                 }
             }
 
-            Contexts = new DebugContextCollection();
+            _contexts = new DebugContextCollection();
         }
 
         /// <summary>
@@ -501,7 +513,46 @@ namespace PepperDash.Core
         /// </summary>
         static string GetMemoryFileName()
         {
-            return string.Format(@"\NVRAM\debugSettings\program{0}", InitialParametersClass.ApplicationNumber);
+            CheckForMigration();
+            return string.Format(@"\USER\debugSettings\program{0}", InitialParametersClass.ApplicationNumber);
+        }
+
+        private static void CheckForMigration()
+        {
+            var oldFilePath = string.Format(@"\NVRAM\debugSettings\program{0}", InitialParametersClass.ApplicationNumber);
+            var newFilePath = String.Format(@"\USER\debugSettings\program{0}", InitialParametersClass.ApplicationNumber);
+
+            //check for file at old path
+            if (!File.Exists(oldFilePath))
+            {
+                Console(0, ErrorLogLevel.Notice,
+                    String.Format(
+                        @"Debug settings file not found at \NVRAM\debugSettings\program{0}. Attempting to use file at \USER\debugSettings\program{0}",
+                        InitialParametersClass.ApplicationNumber));
+                return;
+            }
+
+            //create the new directory if it doesn't already exist
+            if (!Directory.Exists(@"\USER\debugSettings"))
+            {
+                Directory.CreateDirectory(@"\USER\debugSettings");
+            }
+
+            Console(0, ErrorLogLevel.Notice,
+                String.Format(
+                    @"File found at \NVRAM\debugSettings\program{0}. Migrating to \USER\debugSettings\program{0}", InitialParametersClass.ApplicationNumber));
+
+            //Copy file from old path to new path, then delete it. This will overwrite the existing file
+            File.Copy(oldFilePath, newFilePath, true);
+            File.Delete(oldFilePath);
+
+            //Check if the old directory is empty, then delete it if it is
+            if (Directory.GetFiles(@"\NVRAM\debugSettings").Length > 0)
+            {
+                return;
+            }
+
+            Directory.Delete(@"\NVRAM\debugSettings");
         }
 
         public enum ErrorLogLevel

Pepperdash Core/Pepperdash Core/Logging/DebugMemory.cs

@@ -1,23 +1,21 @@
-using System;
+using System.Collections.Generic;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 using Crestron.SimplSharp;
 
 using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
 
 namespace PepperDash.Core.DebugThings
 {
+    /// <summary>
+    /// Class to persist current Debug settings across program restarts
+    /// </summary>
 	public class DebugContextCollection
 	{
         /// <summary>
         /// To prevent threading issues with the DeviceDebugSettings collection
         /// </summary>
-        private CCriticalSection DeviceDebugSettingsLock;
+        private readonly CCriticalSection _deviceDebugSettingsLock;
 
-		[JsonProperty("items")]
+		[JsonProperty("items")] private readonly Dictionary<string, DebugContextItem> _items;
-		Dictionary<string, DebugContextItem> Items;
 
         /// <summary>
         /// Collection of the debug settings for each device where the dictionary key is the device key
@@ -26,11 +24,14 @@ namespace PepperDash.Core.DebugThings
         private Dictionary<string, object> DeviceDebugSettings { get; set; }
 
 
+		/// <summary>
+		/// Default constructor
+		/// </summary>
 		public DebugContextCollection()
 		{
-            DeviceDebugSettingsLock = new CCriticalSection();
+            _deviceDebugSettingsLock = new CCriticalSection();
             DeviceDebugSettings = new Dictionary<string, object>();
-			Items = new Dictionary<string, DebugContextItem>();
+			_items = new Dictionary<string, DebugContextItem>();
 		}
 
 		/// <summary>
@@ -39,7 +40,7 @@ namespace PepperDash.Core.DebugThings
 		/// </summary>
 		/// <param name="contextKey"></param>
 		/// <param name="level"></param>
-		/// <returns>True if the 0 <= level <= 2 and the conte </returns>
+		/// <returns>True if level is between 0 & 2 and the conte </returns>
 		public void SetLevel(string contextKey, int level)
 		{
 			if (level < 0 || level > 2)
@@ -54,9 +55,9 @@ namespace PepperDash.Core.DebugThings
 		/// <returns></returns>
 		public DebugContextItem GetOrCreateItem(string contextKey)
 		{
-			if (!Items.ContainsKey(contextKey))
+			if (!_items.ContainsKey(contextKey))
-				Items[contextKey] = new DebugContextItem(this) { Level = 0 };
+				_items[contextKey] = new DebugContextItem { Level = 0 };
-			return Items[contextKey];
+			return _items[contextKey];
 		}
 
 
@@ -68,15 +69,22 @@ namespace PepperDash.Core.DebugThings
         /// <returns></returns>
         public void SetDebugSettingsForKey(string deviceKey, object settings)
         {
-            var existingSettings = DeviceDebugSettings[deviceKey];
+            try
-
-            if (existingSettings != null)
             {
-                existingSettings = settings;
+                _deviceDebugSettingsLock.Enter();
+
+                if (DeviceDebugSettings.ContainsKey(deviceKey))
+                {
+                    DeviceDebugSettings[deviceKey] = settings;
                 }
                 else
                     DeviceDebugSettings.Add(deviceKey, settings);
             }
+            finally
+            {
+                _deviceDebugSettingsLock.Leave();
+            }
+        }
 
         /// <summary>
         /// Gets the device settings for a device by key or returns null
@@ -89,6 +97,9 @@ namespace PepperDash.Core.DebugThings
         }
 	}
 
+	/// <summary>
+	/// Contains information about 
+	/// </summary>
 	public class DebugContextItem
 	{
         /// <summary>
@@ -102,10 +113,5 @@ namespace PepperDash.Core.DebugThings
         /// </summary>
         [JsonProperty("doNotLoadOnNextBoot")]
         public bool DoNotLoadOnNextBoot { get; set; }
-
-		public DebugContextItem(DebugContextCollection parent)
-		{
-
-		}
 	}
 }