From 8de34a141c3d1867017428b6f50807c8d4dbb373 Mon Sep 17 00:00:00 2001 From: Jonathan Miller Date: Sat, 21 May 2022 13:00:47 -0230 Subject: [PATCH] Export version fixes (#83) * Add file association for .eop, prompt for install dir * Handle .eop or .aip file passed as arg. * VS2022 version bump * Filter neutron stars and black holes from fast spinning criteria. * Adjustments for new "high value" check * Refactor herald cache * Fix element order and namespaces for voice moods. * Add explicit .Stop() between audio player calls. * Use nullsafe member access instead of skipping * Don't queue up a title that's already queued. * Improve body ordinal handling for explorer speech titles. * Escape strings being inserted into xml * Handle flip-flopping JSON type * Converter for flip-flopping property type * Use the converter * Escape characters *before* we wrap it in xml. * Give Eahlstan his clear button. :D * Exclude all stars from fast rotation check. * Close outstanding popup notifications on exit. * TO DONE * [Herald] Suppress duplicate notification titles for spoken notifications If you have notifications from multiple plugins producing notifications with the same title in quick succession (ie. "Body A 1 e" from both Explorer and BioInsights), the title on successive notifications will not be spoken again to save the breath of our friendly Azure speakers. * Doc update * Remove unintended member hiding * Fix export errors when exporting BioInsights data, cleanup Discovered a couple issues with exporting BioInsights data resulting from using two different types of objects in the data grid; improved error handling as well. Also cleaned up some old-style read all code. * Add read-all on launch setting * Updated framework xml * Improve high-value body description text Co-authored-by: Fred Kuipers --- InnoSetup/Elite Observatory.iss | 9 + .../NativeNotification/NativePopup.cs | 9 +- ObservatoryCore/ObservatoryCore.cs | 9 + .../PluginManagement/PluginCore.cs | 5 + .../PluginManagement/PluginManager.cs | 8 +- ObservatoryCore/Properties/Core.Designer.cs | 12 + ObservatoryCore/Properties/Core.settings | 3 + ObservatoryCore/UI/MainApplication.axaml.cs | 5 + .../UI/Models/NotificationModel.cs | 8 +- .../UI/ViewModels/CoreViewModel.cs | 219 +++++++++--------- .../UI/ViewModels/NotificationViewModel.cs | 7 +- ObservatoryCore/UI/Views/BasicUIView.axaml.cs | 23 +- ObservatoryCore/UI/Views/CoreView.axaml | 8 + ObservatoryExplorer/DefaultCriteria.cs | 38 +-- ObservatoryExplorer/Explorer.cs | 23 +- ObservatoryExplorer/ExplorerSettings.cs | 2 +- ObservatoryFramework/EventArgs.cs | 66 +++++- .../MutableStringDoubleConverter.cs | 24 ++ .../Files/Journal/Other/CrewLaunchFighter.cs | 1 - .../Files/Journal/Other/CrewMemberQuits.cs | 4 +- .../Journal/Other/CrewMemberRoleChange.cs | 1 - .../Files/Journal/Other/QuitACrew.cs | 4 +- .../Files/ParameterTypes/Modifiers.cs | 23 +- ObservatoryFramework/ObservatoryFramework.xml | 77 +++++- ObservatoryHerald/HeraldQueue.cs | 42 ++-- .../NetCoreAudio/Interfaces/IPlayer.cs | 2 +- ObservatoryHerald/NetCoreAudio/Player.cs | 4 +- .../NetCoreAudio/Players/UnixPlayerBase.cs | 2 +- .../NetCoreAudio/Players/WindowsPlayer.cs | 8 +- ObservatoryHerald/ObservatoryAPI.Designer.cs | 2 +- ObservatoryHerald/SpeechRequestManager.cs | 63 ++--- 31 files changed, 495 insertions(+), 216 deletions(-) create mode 100644 ObservatoryFramework/Files/Converters/MutableStringDoubleConverter.cs diff --git a/InnoSetup/Elite Observatory.iss b/InnoSetup/Elite Observatory.iss index d5e9291..793ca71 100644 --- a/InnoSetup/Elite Observatory.iss +++ b/InnoSetup/Elite Observatory.iss @@ -19,6 +19,7 @@ AppPublisherURL={#MyAppURL} AppSupportURL={#MyAppURL} AppUpdatesURL={#MyAppURL} DefaultDirName={autopf}\{#MyAppName} +DisableDirPage=false DefaultGroupName={#MyAppName} AllowNoIcons=yes LicenseFile=C:\Users\Xjph\Source\Repos\MIT.txt @@ -32,6 +33,7 @@ Compression=lzma SolidCompression=yes WizardStyle=modern ArchitecturesInstallIn64BitMode=x64 +ChangesAssociations=yes [Languages] Name: "english"; MessagesFile: "compiler:Default.isl" @@ -77,6 +79,13 @@ Name: "{autodesktop}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"; Tasks: de [Run] Filename: "{app}\{#MyAppExeName}"; Description: "{cm:LaunchProgram,{#StringChange(MyAppName, '&', '&&')}}"; Flags: nowait postinstall skipifsilent +[Registry] +Root: HKA; Subkey: "Software\Classes\.eop\OpenWithProgids"; ValueType: string; ValueName: "ObservatoryPlugin.eop"; ValueData: ""; Flags: uninsdeletevalue +Root: HKA; Subkey: "Software\Classes\ObservatoryPlugin.eop"; ValueType: string; ValueName: ""; ValueData: "Elite Observatory Plugin"; Flags: uninsdeletekey +Root: HKA; Subkey: "Software\Classes\ObservatoryPlugin.eop\DefaultIcon"; ValueType: string; ValueName: ""; ValueData: "{app}\{#MyAppExeName},0" +Root: HKA; Subkey: "Software\Classes\ObservatoryPlugin.eop\shell\open\command"; ValueType: string; ValueName: ""; ValueData: """{app}\{#MyAppExeName}"" ""%1""" +Root: HKA; Subkey: "Software\Classes\Applications\{#MyAppExeName}\SupportedTypes"; ValueType: string; ValueName: ".eop"; ValueData: "" + [Code] type diff --git a/ObservatoryCore/NativeNotification/NativePopup.cs b/ObservatoryCore/NativeNotification/NativePopup.cs index 267f6e0..3488ab3 100644 --- a/ObservatoryCore/NativeNotification/NativePopup.cs +++ b/ObservatoryCore/NativeNotification/NativePopup.cs @@ -8,7 +8,6 @@ namespace Observatory.NativeNotification { public class NativePopup { - // TODO: This needs to be cleaned up when the app is closed. private Dictionary notifications; public NativePopup() @@ -67,5 +66,13 @@ namespace Observatory.NativeNotification }); } } + + public void CloseAll() + { + foreach (var notification in notifications) + { + notification.Value?.Close(); + } + } } } diff --git a/ObservatoryCore/ObservatoryCore.cs b/ObservatoryCore/ObservatoryCore.cs index 600cafd..266d36f 100644 --- a/ObservatoryCore/ObservatoryCore.cs +++ b/ObservatoryCore/ObservatoryCore.cs @@ -9,6 +9,15 @@ namespace Observatory [STAThread] static void Main(string[] args) { + if (args.Length > 0 && System.IO.File.Exists(args[0])) + { + var fileInfo = new System.IO.FileInfo(args[0]); + if (fileInfo.Extension == ".eop" || fileInfo.Extension == ".zip") + System.IO.File.Copy( + fileInfo.FullName, + $"{AppDomain.CurrentDomain.BaseDirectory}{System.IO.Path.DirectorySeparatorChar}plugins{System.IO.Path.DirectorySeparatorChar}{fileInfo.Name}"); + } + string version = System.Reflection.Assembly.GetEntryAssembly().GetName().Version.ToString(); try { diff --git a/ObservatoryCore/PluginManagement/PluginCore.cs b/ObservatoryCore/PluginManagement/PluginCore.cs index ea1384a..10443cc 100644 --- a/ObservatoryCore/PluginManagement/PluginCore.cs +++ b/ObservatoryCore/PluginManagement/PluginCore.cs @@ -170,5 +170,10 @@ namespace Observatory.PluginManagement return folderLocation; } } + + internal void Shutdown() + { + NativePopup.CloseAll(); + } } } diff --git a/ObservatoryCore/PluginManagement/PluginManager.cs b/ObservatoryCore/PluginManagement/PluginManager.cs index 37cc377..37e6ce1 100644 --- a/ObservatoryCore/PluginManagement/PluginManager.cs +++ b/ObservatoryCore/PluginManagement/PluginManager.cs @@ -34,6 +34,7 @@ namespace Observatory.PluginManagement public readonly List pluginTables; public readonly List<(IObservatoryWorker plugin, PluginStatus signed)> workerPlugins; public readonly List<(IObservatoryNotifier plugin, PluginStatus signed)> notifyPlugins; + private readonly PluginCore core; private PluginManager() { @@ -48,7 +49,7 @@ namespace Observatory.PluginManagement logMonitor.StatusUpdate += pluginHandler.OnStatusUpdate; logMonitor.LogMonitorStateChanged += pluginHandler.OnLogMonitorStateChanged; - var core = new PluginCore(); + core = new PluginCore(); List errorPlugins = new(); @@ -346,6 +347,11 @@ namespace Observatory.PluginManagement return err; } + internal void Shutdown() + { + core.Shutdown(); + } + private static void LoadPlaceholderPlugin(string dllPath, PluginStatus pluginStatus, List<(IObservatoryNotifier plugin, PluginStatus signed)> notifiers) { PlaceholderPlugin placeholder = new(new FileInfo(dllPath).Name); diff --git a/ObservatoryCore/Properties/Core.Designer.cs b/ObservatoryCore/Properties/Core.Designer.cs index bac2cd4..96eba62 100644 --- a/ObservatoryCore/Properties/Core.Designer.cs +++ b/ObservatoryCore/Properties/Core.Designer.cs @@ -262,5 +262,17 @@ namespace Observatory.Properties { this["ExportFolder"] = value; } } + + [global::System.Configuration.UserScopedSettingAttribute()] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Configuration.DefaultSettingValueAttribute("False")] + public bool StartReadAll { + get { + return ((bool)(this["StartReadAll"])); + } + set { + this["StartReadAll"] = value; + } + } } } diff --git a/ObservatoryCore/Properties/Core.settings b/ObservatoryCore/Properties/Core.settings index 1b29ded..37938c1 100644 --- a/ObservatoryCore/Properties/Core.settings +++ b/ObservatoryCore/Properties/Core.settings @@ -62,5 +62,8 @@ + + False + \ No newline at end of file diff --git a/ObservatoryCore/UI/MainApplication.axaml.cs b/ObservatoryCore/UI/MainApplication.axaml.cs index eb488a2..0564983 100644 --- a/ObservatoryCore/UI/MainApplication.axaml.cs +++ b/ObservatoryCore/UI/MainApplication.axaml.cs @@ -21,6 +21,11 @@ namespace Observatory.UI { DataContext = new MainWindowViewModel(pluginManager) }; + + desktop.MainWindow.Closing += (o, e) => + { + pluginManager.Shutdown(); + }; } base.OnFrameworkInitializationCompleted(); diff --git a/ObservatoryCore/UI/Models/NotificationModel.cs b/ObservatoryCore/UI/Models/NotificationModel.cs index 0881c81..4f9a05b 100644 --- a/ObservatoryCore/UI/Models/NotificationModel.cs +++ b/ObservatoryCore/UI/Models/NotificationModel.cs @@ -1,10 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; - -namespace Observatory.UI.Models +namespace Observatory.UI.Models { public class NotificationModel { diff --git a/ObservatoryCore/UI/ViewModels/CoreViewModel.cs b/ObservatoryCore/UI/ViewModels/CoreViewModel.cs index c2cc381..45427f0 100644 --- a/ObservatoryCore/UI/ViewModels/CoreViewModel.cs +++ b/ObservatoryCore/UI/ViewModels/CoreViewModel.cs @@ -58,19 +58,16 @@ namespace Observatory.UI.ViewModels tabs.Add(new CoreModel() { Name = "Core", UI = new BasicUIViewModel(new ObservableCollection()) { UIType = Framework.PluginUI.UIType.Core } }); if (Properties.Core.Default.StartMonitor) - { ToggleMonitor(); - } + + if (Properties.Core.Default.StartReadAll) + ReadAll(); } public void ReadAll() { - // TODO(fredjk_gh): remove. - SetWorkerReadAllState(true); LogMonitor.GetInstance.ReadAllJournals(); - // TODO(fredjk_gh): remove. - SetWorkerReadAllState(false); } public void ToggleMonitor() @@ -84,12 +81,7 @@ namespace Observatory.UI.ViewModels } else { - // HACK: Find a better way of suppressing notifications when pre-reading. - // TODO(fredjk_gh): remove. - SetWorkerReadAllState(true); logMonitor.Start(); - // TODO(fredjk_gh): remove. - SetWorkerReadAllState(false); ToggleButtonText = "Stop Monitor"; } } @@ -117,100 +109,129 @@ namespace Observatory.UI.ViewModels public async void ExportGrid() { - var exportFolder = Properties.Core.Default.ExportFolder; - - if (string.IsNullOrEmpty(exportFolder)) + try { - exportFolder = System.Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments); - } + var exportFolder = Properties.Core.Default.ExportFolder; - OpenFolderDialog openFolderDialog = new() - { - Directory = exportFolder - }; - - var application = (IClassicDesktopStyleApplicationLifetime)Avalonia.Application.Current.ApplicationLifetime; - - var selectedFolder = await openFolderDialog.ShowAsync(application.MainWindow); - - if (!string.IsNullOrEmpty(selectedFolder)) - { - Properties.Core.Default.ExportFolder = selectedFolder; - Properties.Core.Default.Save(); - exportFolder = selectedFolder; - - foreach (var tab in tabs.Where(t => t.Name != "Core")) + if (string.IsNullOrEmpty(exportFolder)) { - var ui = (BasicUIViewModel)tab.UI; - List selectedData; - bool specificallySelected = ui.SelectedItems?.Count > 1; + exportFolder = System.Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments); + } - if (specificallySelected) + OpenFolderDialog openFolderDialog = new() + { + Directory = exportFolder + }; + + var application = (IClassicDesktopStyleApplicationLifetime)Avalonia.Application.Current.ApplicationLifetime; + + var selectedFolder = await openFolderDialog.ShowAsync(application.MainWindow); + + if (!string.IsNullOrEmpty(selectedFolder)) + { + Properties.Core.Default.ExportFolder = selectedFolder; + Properties.Core.Default.Save(); + exportFolder = selectedFolder; + + foreach (var tab in tabs.Where(t => t.Name != "Core")) { - selectedData = new(); + var ui = (BasicUIViewModel)tab.UI; + List selectedData; + bool specificallySelected = ui.SelectedItems?.Count > 1; - foreach (var item in ui.SelectedItems) - selectedData.Add(item); - } - else - { - selectedData = ui.BasicUIGrid.ToList(); - } - - var columns = selectedData[0].GetType().GetProperties(); - Dictionary colSize = new(); - Dictionary> colContent = new(); - - foreach (var column in columns) - { - colSize.Add(column.Name, 0); - colContent.Add(column.Name, new()); - } - - var lineType = selectedData[0].GetType(); - - foreach (var line in selectedData) - { - foreach (var column in colContent) + if (specificallySelected) { - var cellValue = lineType.GetProperty(column.Key).GetValue(line)?.ToString() ?? string.Empty; - column.Value.Add(cellValue); - if (colSize[column.Key] < cellValue.Length) - colSize[column.Key] = cellValue.Length; + selectedData = new(); + + foreach (var item in ui.SelectedItems) + selectedData.Add(item); } - } - - System.Text.StringBuilder exportData = new(); - - - foreach (var colTitle in colContent.Keys) - { - if (colSize[colTitle] < colTitle.Length) - colSize[colTitle] = colTitle.Length; - - exportData.Append(colTitle.PadRight(colSize[colTitle]) + " "); - } - exportData.AppendLine(); - - for (int i = 0; i < colContent.First().Value.Count; i++) - { - foreach(var column in colContent) + else { - if (column.Value[i].Length > 0 && !char.IsNumber(column.Value[i][0]) && column.Value[i].Count(char.IsLetter) / (float)column.Value[i].Length > 0.25) - exportData.Append(column.Value[i].PadRight(colSize[column.Key]) + " "); - else - exportData.Append(column.Value[i].PadLeft(colSize[column.Key]) + " "); + selectedData = ui.BasicUIGrid.ToList(); + } + + var columns = selectedData[0].GetType().GetProperties(); + Dictionary colSize = new(); + Dictionary> colContent = new(); + + foreach (var column in columns) + { + colSize.Add(column.Name, 0); + colContent.Add(column.Name, new()); + } + + foreach (var line in selectedData) + { + var lineType = line.GetType(); // some plugins have different line types, so don't move this out of loop + foreach (var column in colContent) + { + var cellValue = lineType.GetProperty(column.Key)?.GetValue(line)?.ToString() ?? string.Empty; + column.Value.Add(cellValue); + if (colSize[column.Key] < cellValue.Length) + colSize[column.Key] = cellValue.Length; + } + } + + System.Text.StringBuilder exportData = new(); + + + foreach (var colTitle in colContent.Keys) + { + if (colSize[colTitle] < colTitle.Length) + colSize[colTitle] = colTitle.Length; + + exportData.Append(colTitle.PadRight(colSize[colTitle]) + " "); } exportData.AppendLine(); + + for (int i = 0; i < colContent.First().Value.Count; i++) + { + foreach (var column in colContent) + { + if (column.Value[i].Length > 0 && !char.IsNumber(column.Value[i][0]) && column.Value[i].Count(char.IsLetter) / (float)column.Value[i].Length > 0.25) + exportData.Append(column.Value[i].PadRight(colSize[column.Key]) + " "); + else + exportData.Append(column.Value[i].PadLeft(colSize[column.Key]) + " "); + } + exportData.AppendLine(); + } + + string exportPath = $"{exportFolder}{System.IO.Path.DirectorySeparatorChar}Observatory Export - {DateTime.UtcNow:yyyyMMdd-HHmmss} - {tab.Name}.txt"; + + System.IO.File.WriteAllText(exportPath, exportData.ToString()); } - - string exportPath = $"{exportFolder}{System.IO.Path.DirectorySeparatorChar}Observatory Export - {DateTime.UtcNow:yyyyMMdd-HHmmss} - {tab.Name}.txt"; - - System.IO.File.WriteAllText(exportPath, exportData.ToString()); - - } } + catch (Exception e) + { + ObservatoryCore.LogError(e, "while exporting data"); + ErrorReporter.ShowErrorPopup("Error encountered!", + "An error occurred while exporting; output may be missing or incomplete." + Environment.NewLine + + "Please check the error log (found in your Documents folder) for more details and visit our discord to report it."); + } + } + + public void ClearGrid() + { + foreach (var tab in tabs.Where(t => t.Name != "Core")) + { + var ui = (BasicUIViewModel)tab.UI; + + var rowTemplate = ui.BasicUIGrid.First(); + + foreach (var property in rowTemplate.GetType().GetProperties()) + { + property.SetValue(rowTemplate, null); + } + + ui.BasicUIGrid.Clear(); + ui.BasicUIGrid.Add(rowTemplate); + + // For some reason UIType's change event will properly + // redraw the grid, not BasicUIGrid's. + ui.RaisePropertyChanged(nameof(ui.UIType)); + } } public string ToggleButtonText @@ -241,22 +262,6 @@ namespace Observatory.UI.ViewModels get { return tabs; } } - // TODO(fredjk_gh): remove. - private void SetWorkerReadAllState(bool isReadingAll) - { - foreach (var worker in workers) - { - if (isReadingAll) - { - worker.ReadAllStarted(); - } - else - { - worker.ReadAllFinished(); - } - } - } - private static bool CheckUpdate() { try diff --git a/ObservatoryCore/UI/ViewModels/NotificationViewModel.cs b/ObservatoryCore/UI/ViewModels/NotificationViewModel.cs index a84a085..f2aa0da 100644 --- a/ObservatoryCore/UI/ViewModels/NotificationViewModel.cs +++ b/ObservatoryCore/UI/ViewModels/NotificationViewModel.cs @@ -1,9 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using Observatory.Framework; +using Observatory.Framework; namespace Observatory.UI.ViewModels { diff --git a/ObservatoryCore/UI/Views/BasicUIView.axaml.cs b/ObservatoryCore/UI/Views/BasicUIView.axaml.cs index 1bc5700..72084ca 100644 --- a/ObservatoryCore/UI/Views/BasicUIView.axaml.cs +++ b/ObservatoryCore/UI/Views/BasicUIView.axaml.cs @@ -27,6 +27,11 @@ namespace Observatory.UI.Views { InitializeComponent(); nativePopup = new(); + + this.DetachedFromVisualTree += (o, e) => + { + nativePopup.CloseAll(); + }; } private void InitializeComponent() @@ -666,7 +671,7 @@ namespace Observatory.UI.Views #endregion - #region Monitor On Launch + #region Actions On Launch TextBlock startMonitorLabel = new() { Text = "Start monitor on Observatory launch" }; CheckBox startMonitorCheckbox = new() { IsChecked = Properties.Core.Default.StartMonitor, Content = startMonitorLabel }; @@ -683,6 +688,21 @@ namespace Observatory.UI.Views Properties.Core.Default.Save(); }; + TextBlock startReadAllLabel = new() { Text = "Read All on Observatory launch" }; + CheckBox startReadAllCheckbox = new() { IsChecked = Properties.Core.Default.StartReadAll, Content = startReadAllLabel }; + + startReadAllCheckbox.Checked += (object sender, RoutedEventArgs e) => + { + Properties.Core.Default.StartReadAll = true; + Properties.Core.Default.Save(); + }; + + startReadAllCheckbox.Unchecked += (object sender, RoutedEventArgs e) => + { + Properties.Core.Default.StartReadAll = false; + Properties.Core.Default.Save(); + }; + #endregion #endregion @@ -753,6 +773,7 @@ namespace Observatory.UI.Views gridManager.AddSetting(primeSystemContexCheckbox); gridManager.AddSetting(startMonitorCheckbox); + gridManager.AddSetting(startReadAllCheckbox); gridManager.AddSettingWithLabel(journalPathLabel, journalPath); gridManager.AddSetting(journalBrowse); diff --git a/ObservatoryCore/UI/Views/CoreView.axaml b/ObservatoryCore/UI/Views/CoreView.axaml index bf0cc60..acab29c 100644 --- a/ObservatoryCore/UI/Views/CoreView.axaml +++ b/ObservatoryCore/UI/Views/CoreView.axaml @@ -81,6 +81,14 @@ Content="Export"> Export +