Merge pull request LogExperts#384 from LogExperts/373-v1120---importing-highlighting-config-is-broken

Fixing the import problem, adapted the import process, now only the highlightgroups and entries are imported from this file.

if other data is present, it will not be able to import

rename the property, this is a breaking change, as older settings will not be importable, unless the names in the json will be changed from "Hilight" to "Highlight"

Export functionality added for the Highlight dialog, this does only export the currently configured highlights to a JSON File.

Author: Hirogen

src/LogExpert/Classes/PaintHelper.cs

@@ -44,7 +44,7 @@ public static void CellPainting(ILogPaintContext logPaintCtx, BufferedDataGridVi
             ILogLine line = logPaintCtx.GetLogLine(rowIndex);
             if (line != null)
             {
-                HilightEntry entry = logPaintCtx.FindHighlightEntry(line, true);
+                HighlightEntry entry = logPaintCtx.FindHighlightEntry(line, true);
                 e.Graphics.SetClip(e.CellBounds);
                 if ((e.State & DataGridViewElementStates.Selected) == DataGridViewElementStates.Selected)
                 {
@@ -290,12 +290,12 @@ public static Rectangle BorderWidths(DataGridViewAdvancedBorderStyle advancedBor
 
         #region Private Methods
 
-        private static void PaintCell(ILogPaintContext logPaintCtx, DataGridViewCellPaintingEventArgs e, BufferedDataGridView gridView, bool noBackgroundFill, HilightEntry groundEntry)
+        private static void PaintCell(ILogPaintContext logPaintCtx, DataGridViewCellPaintingEventArgs e, BufferedDataGridView gridView, bool noBackgroundFill, HighlightEntry groundEntry)
         {
             PaintHighlightedCell(logPaintCtx, e, gridView, noBackgroundFill, groundEntry);
         }
 
-        private static void PaintHighlightedCell(ILogPaintContext logPaintCtx, DataGridViewCellPaintingEventArgs e, BufferedDataGridView gridView, bool noBackgroundFill, HilightEntry groundEntry)
+        private static void PaintHighlightedCell(ILogPaintContext logPaintCtx, DataGridViewCellPaintingEventArgs e, BufferedDataGridView gridView, bool noBackgroundFill, HighlightEntry groundEntry)
         {
             object value = e.Value ?? string.Empty;
 
@@ -314,7 +314,7 @@ private static void PaintHighlightedCell(ILogPaintContext logPaintCtx, DataGridV
                     hme.StartPos = 0;
                     hme.Length = column.FullValue.Length;
 
-                    var he = new HilightEntry
+                    var he = new HighlightEntry
                     {
                         SearchText = column.FullValue,
                         ForegroundColor = groundEntry?.ForegroundColor ?? ColorMode.ForeColor,
@@ -427,7 +427,7 @@ private static void PaintHighlightedCell(ILogPaintContext logPaintCtx, DataGridV
         private static IList<HilightMatchEntry> MergeHighlightMatchEntries(IList<HilightMatchEntry> matchList, HilightMatchEntry groundEntry)
         {
             // Fill an area with lenth of whole text with a default hilight entry
-            HilightEntry[] entryArray = new HilightEntry[groundEntry.Length];
+            HighlightEntry[] entryArray = new HighlightEntry[groundEntry.Length];
             for (int i = 0; i < entryArray.Length; ++i)
             {
                 entryArray[i] = groundEntry.HilightEntry;
@@ -455,7 +455,7 @@ private static IList<HilightMatchEntry> MergeHighlightMatchEntries(IList<Hilight
             IList<HilightMatchEntry> mergedList = new List<HilightMatchEntry>();
             if (entryArray.Length > 0)
             {
-                HilightEntry currentEntry = entryArray[0];
+                HighlightEntry currentEntry = entryArray[0];
                 int lastStartPos = 0;
                 int pos = 0;
                 for (; pos < entryArray.Length; ++pos)

src/LogExpert/Config/ConfigManager.cs

@@ -89,12 +89,23 @@ public static void Export(FileInfo fileInfo)
             Instance.Save(fileInfo, Settings);
         }
 
+        public static void Export(FileInfo fileInfo, SettingsFlags flags)
+        {
+            Instance.Save(fileInfo, Settings, flags);
+        }
+
         public static void Import(FileInfo fileInfo, ExportImportFlags flags)
         {
             Instance._settings = Instance.Import(Instance._settings, fileInfo, flags);
             Save(SettingsFlags.All);
         }
 
+        public static void ImportHighlightSettings(FileInfo fileInfo, ExportImportFlags flags)
+        {
+            Instance._settings.Preferences.HighlightGroupList = Instance.Import(Instance._settings.Preferences.HighlightGroupList, fileInfo, flags);
+            Save(SettingsFlags.All);
+        }
+
         #endregion
 
         #region Private Methods
@@ -144,7 +155,7 @@ private Settings Load()
         /// </summary>
         /// <param name="fileInfo">file that has settings saved</param>
         /// <returns>loaded or created settings</returns>
-        private Settings LoadOrCreateNew(FileSystemInfo fileInfo)
+        private Settings LoadOrCreateNew(FileInfo fileInfo)
         {
             lock (_loadSaveLock)
             {
@@ -212,17 +223,9 @@ private Settings LoadOrCreateNew(FileSystemInfo fileInfo)
                     filterParams.Init();
                 }
 
-                if (settings.hilightGroupList == null)
+                if (settings.Preferences.HighlightGroupList == null)
                 {
-                    settings.hilightGroupList = [];
-                    // migrate old non-grouped entries
-                    HilightGroup defaultGroup = new()
-                    {
-                        GroupName = "[Default]",
-                        HilightEntryList = settings.hilightEntryList
-                    };
-
-                    settings.hilightGroupList.Add(defaultGroup);
+                    settings.Preferences.HighlightGroupList = [];
                 }
 
                 settings.Preferences.highlightMaskList ??= [];
@@ -248,8 +251,6 @@ private Settings LoadOrCreateNew(FileSystemInfo fileInfo)
 
                 SetBoundsWithinVirtualScreen(settings);
 
-                ConvertSettings(settings);
-
                 return settings;
             }
         }
@@ -292,7 +293,19 @@ private void Save(FileInfo fileInfo, Settings settings)
             SaveAsJSON(fileInfo, settings);
         }
 
-        private void SaveAsJSON(FileInfo fileInfo, Settings settings)
+        private void Save(FileInfo fileInfo, Settings settings, SettingsFlags flags)
+        {
+            switch (flags)
+            {
+                case SettingsFlags.HighlightSettings:
+                    SaveHighlightgroupsAsJSON(fileInfo, settings.Preferences.HighlightGroupList);
+                    break;
+            }
+
+            OnConfigChanged(flags);
+        }
+
+        private static void SaveAsJSON(FileInfo fileInfo, Settings settings)
         {
             settings.versionBuild = Assembly.GetExecutingAssembly().GetName().Version.Build;
 
@@ -301,55 +314,39 @@ private void SaveAsJSON(FileInfo fileInfo, Settings settings)
             serializer.Serialize(sw, settings);
         }
 
-        /// <summary>
-        /// Convert settings loaded from previous versions.
-        /// </summary>
-        /// <param name="settings"></param>
-        private void ConvertSettings(Settings settings)
+        private static void SaveHighlightgroupsAsJSON(FileInfo fileInfo, List<HighlightGroup> groups)
         {
-            //int oldBuildNumber = settings.versionBuild;
-
-            //// All Versions before 3583
-            //if (oldBuildNumber < 3584)
-            //{
-            //    // External tools
-            //    List<ToolEntry> newList = [];
-            //    foreach (ToolEntry tool in settings.preferences.toolEntries)
-            //    {
-            //        // set favourite to true only when name is empty, because there are always version released without this conversion fx
-            //        // remove empty tool entries (there were always 3 entries before, which can be empty if not used)
-            //        if (Util.IsNull(tool.name))
-            //        {
-            //            if (!Util.IsNull(tool.cmd))
-            //            {
-            //                tool.name = tool.cmd;
-            //                tool.isFavourite = true;
-            //                newList.Add(tool);
-            //            }
-            //        }
-            //        else
-            //        {
-            //            newList.Add(tool);
-            //        }
-            //        if (Util.IsNull(tool.iconFile))
-            //        {
-            //            tool.iconFile = tool.cmd;
-            //            tool.iconIndex = 0;
-            //        }
-            //    }
-            //    settings.preferences.toolEntries = newList;
-            //}
-
-            //if (oldBuildNumber < 3584)
-            //{
-            //    // Set the color for the FilterList entries to default (black)
-            //    foreach (FilterParams filterParam in settings.filterList)
-            //    {
-            //        filterParam.color = Color.FromKnownColor(KnownColor.Black);
-            //    }
-            //}
+            using StreamWriter sw = new(fileInfo.Create());
+            JsonSerializer serializer = new();
+            serializer.Serialize(sw, groups);
         }
 
+        private List<HighlightGroup> Import(List<HighlightGroup> currentGroups, FileInfo fileInfo, ExportImportFlags flags)
+        {
+            List<HighlightGroup> newGroups;
+
+            try
+            {
+                newGroups = JsonConvert.DeserializeObject<List<HighlightGroup>>(File.ReadAllText($"{fileInfo.FullName}"));
+            }
+            catch (Exception e)
+            {
+                _logger.Error($"Error while deserializing config data: {e}");
+                newGroups = [];
+            }
+
+            if (flags.HasFlag(ExportImportFlags.KeepExisting))
+            {
+                currentGroups.AddRange(newGroups);
+            }
+            else
+            {
+                currentGroups.Clear();
+                currentGroups.AddRange(newGroups);
+            }
+
+            return currentGroups;
+        }
 
         /// <summary>
         /// Imports all or some of the settings/prefs stored in the input stream.
@@ -371,7 +368,7 @@ private Settings Import(Settings currentSettings, FileInfo fileInfo, ExportImpor
                 newSettings.Preferences = ObjectClone.Clone(importSettings.Preferences);
                 newSettings.Preferences.columnizerMaskList = ownSettings.Preferences.columnizerMaskList;
                 newSettings.Preferences.highlightMaskList = ownSettings.Preferences.highlightMaskList;
-                newSettings.hilightGroupList = ownSettings.hilightGroupList;
+                newSettings.Preferences.HighlightGroupList = ownSettings.Preferences.HighlightGroupList;
                 newSettings.Preferences.toolEntries = ownSettings.Preferences.toolEntries;
             }
             else
@@ -389,7 +386,7 @@ private Settings Import(Settings currentSettings, FileInfo fileInfo, ExportImpor
             }
             if ((flags & ExportImportFlags.HighlightSettings) == ExportImportFlags.HighlightSettings)
             {
-                newSettings.hilightGroupList = ReplaceOrKeepExisting(flags, ownSettings.hilightGroupList, importSettings.hilightGroupList);
+                newSettings.Preferences.HighlightGroupList = ReplaceOrKeepExisting(flags, ownSettings.Preferences.HighlightGroupList, importSettings.Preferences.HighlightGroupList);
             }
             if ((flags & ExportImportFlags.ToolEntries) == ExportImportFlags.ToolEntries)
             {
@@ -424,13 +421,7 @@ private void SetBoundsWithinVirtualScreen(Settings settings)
 
         protected void OnConfigChanged(SettingsFlags flags)
         {
-            ConfigChangedEventHandler handler = ConfigChanged;
-
-            if (handler != null)
-            {
-                _logger.Info("Fire config changed event");
-                handler(this, new ConfigChangedEventArgs(flags));
-            }
+            ConfigChanged?.Invoke(this, new ConfigChangedEventArgs(flags));
         }
 
         public delegate void ConfigChangedEventHandler(object sender, ConfigChangedEventArgs e);

src/LogExpert/Controls/LogTabWindow/LogTabWindow.cs

@@ -89,7 +89,7 @@ public LogTabWindow(string[] fileNames, int instanceNumber, bool showInstanceNum
             Load += OnLogTabWindowLoad;
 
             ConfigManager.Instance.ConfigChanged += OnConfigChanged;
-            HilightGroupList = ConfigManager.Settings.hilightGroupList;
+            HighlightGroupList = ConfigManager.Settings.Preferences.HighlightGroupList;
 
             Rectangle led = new(0, 0, 8, 2);
 
@@ -297,7 +297,7 @@ public LogWindow.LogWindow CurrentLogWindow
 
         public Preferences Preferences => ConfigManager.Settings.Preferences;
 
-        public List<HilightGroup> HilightGroupList { get; private set; } = [];
+        public List<HighlightGroup> HighlightGroupList { get; private set; } = [];
 
         //public Settings Settings
         //{
@@ -312,11 +312,11 @@ public LogWindow.LogWindow CurrentLogWindow
 
         #region Internals
 
-        internal HilightGroup FindHighlightGroup(string groupName)
+        internal HighlightGroup FindHighlightGroup(string groupName)
         {
-            lock (HilightGroupList)
+            lock (HighlightGroupList)
             {
-                foreach (HilightGroup group in HilightGroupList)
+                foreach (HighlightGroup group in HighlightGroupList)
                 {
                     if (group.GroupName.Equals(groupName))
                     {

src/LogExpert/Controls/LogTabWindow/LogTabWindowEventHandlers.cs

@@ -481,7 +481,7 @@ private void OnLogWindowFilterListChanged(object sender, FilterListChangedEventA
         private void OnLogWindowCurrentHighlightGroupChanged(object sender, CurrentHighlightGroupChangedEventArgs e)
         {
             OnHighlightSettingsChanged();
-            ConfigManager.Settings.hilightGroupList = HilightGroupList;
+            ConfigManager.Settings.Preferences.HighlightGroupList = HighlightGroupList;
             ConfigManager.Save(SettingsFlags.HighlightSettings);
         }
 

src/LogExpert/Controls/LogTabWindow/LogTabWindowPrivate.cs

@@ -341,17 +341,17 @@ private void ShowHighlightSettingsDialog()
                 KeywordActionList = PluginRegistry.PluginRegistry.Instance.RegisteredKeywordActions,
                 Owner = this,
                 TopMost = TopMost,
-                HighlightGroupList = HilightGroupList,
+                HighlightGroupList = HighlightGroupList,
                 PreSelectedGroupName = groupsComboBoxHighlightGroups.Text
             };
 
             DialogResult res = dlg.ShowDialog();
 
             if (res == DialogResult.OK)
             {
-                HilightGroupList = dlg.HighlightGroupList;
+                HighlightGroupList = dlg.HighlightGroupList;
                 FillHighlightComboBox();
-                ConfigManager.Settings.hilightGroupList = HilightGroupList;
+                ConfigManager.Settings.Preferences.HighlightGroupList = HighlightGroupList;
                 ConfigManager.Save(SettingsFlags.HighlightSettings);
                 OnHighlightSettingsChanged();
             }
@@ -361,7 +361,7 @@ private void FillHighlightComboBox()
         {
             string currentGroupName = groupsComboBoxHighlightGroups.Text;
             groupsComboBoxHighlightGroups.Items.Clear();
-            foreach (HilightGroup group in HilightGroupList)
+            foreach (HighlightGroup group in HighlightGroupList)
             {
                 groupsComboBoxHighlightGroups.Items.Add(group.GroupName);
                 if (group.GroupName.Equals(currentGroupName))
@@ -956,7 +956,7 @@ private void NotifyWindowsForChangedPrefs(SettingsFlags flags)
 
             _bookmarkWindow.PreferencesChanged(ConfigManager.Settings.Preferences, false, flags);
 
-            HilightGroupList = ConfigManager.Settings.hilightGroupList;
+            HighlightGroupList = ConfigManager.Settings.Preferences.HighlightGroupList;
             if ((flags & SettingsFlags.HighlightSettings) == SettingsFlags.HighlightSettings)
             {
                 OnHighlightSettingsChanged();

src/LogExpert/Controls/LogTabWindow/LogTabWindowPublic.cs

@@ -259,7 +259,7 @@ public ILogLineColumnizer FindColumnizerByFileMask(string fileName)
             return null;
         }
 
-        public HilightGroup FindHighlightGroupByFileMask(string fileName)
+        public HighlightGroup FindHighlightGroupByFileMask(string fileName)
         {
             foreach (HighlightMaskEntry entry in ConfigManager.Settings.Preferences.highlightMaskList)
             {
@@ -269,7 +269,7 @@ public HilightGroup FindHighlightGroupByFileMask(string fileName)
                     {
                         if (Regex.IsMatch(fileName, entry.mask))
                         {
-                            HilightGroup group = FindHighlightGroup(entry.highlightGroupName);
+                            HighlightGroup group = FindHighlightGroup(entry.highlightGroupName);
                             return group;
                         }
                     }
@@ -333,9 +333,9 @@ public void FollowTailChanged(LogWindow.LogWindow logWindow, bool isEnabled, boo
             }
         }
 
-        public void NotifySettingsChanged(object cookie, SettingsFlags flags)
+        public void NotifySettingsChanged(object sender, SettingsFlags flags)
         {
-            if (cookie != this)
+            if (sender != this)
             {
                 NotifyWindowsForChangedPrefs(flags);
             }

src/LogExpert/Controls/LogWindow/LogWindow.cs

@@ -92,7 +92,7 @@ public partial class LogWindow : DockContent, ILogPaintContext, ILogView
         private ILogLineColumnizer _currentColumnizer;
 
         //List<HilightEntry> currentHilightEntryList = new List<HilightEntry>();
-        private HilightGroup _currentHighlightGroup = new();
+        private HighlightGroup _currentHighlightGroup = new();
 
         private SearchParams _currentSearchParams;
 
@@ -131,7 +131,7 @@ public partial class LogWindow : DockContent, ILogPaintContext, ILogView
         private bool _shouldCancel;
         private bool _shouldTimestampDisplaySyncingCancel;
         private bool _showAdvanced;
-        private List<HilightEntry> _tempHighlightEntryList = [];
+        private List<HighlightEntry> _tempHighlightEntryList = [];
         private int _timeShiftSyncLine = 0;
 
         private bool _waitingForClose;