diff --git a/ObservatoryCore/ErrorReporter.cs b/ObservatoryCore/ErrorReporter.cs new file mode 100644 index 0000000..7de3c82 --- /dev/null +++ b/ObservatoryCore/ErrorReporter.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Observatory +{ + public static class ErrorReporter + { + public static void ShowErrorPopup(string title, string message) + { + if (Avalonia.Application.Current.ApplicationLifetime is Avalonia.Controls.ApplicationLifetimes.IClassicDesktopStyleApplicationLifetime desktop) + { + var errorMessage = MessageBox.Avalonia.MessageBoxManager + .GetMessageBoxStandardWindow(new MessageBox.Avalonia.DTO.MessageBoxStandardParams + { + ContentTitle = title, + ContentMessage = message, + Topmost = true + }); + errorMessage.Show(); + } + } + } +} diff --git a/ObservatoryCore/LogMonitor.cs b/ObservatoryCore/LogMonitor.cs index 2bcf4aa..11f3eba 100644 --- a/ObservatoryCore/LogMonitor.cs +++ b/ObservatoryCore/LogMonitor.cs @@ -318,18 +318,7 @@ namespace Observatory } } - if (Avalonia.Application.Current.ApplicationLifetime is Avalonia.Controls.ApplicationLifetimes.IClassicDesktopStyleApplicationLifetime desktop) - { - var errorMessage = MessageBox.Avalonia.MessageBoxManager - .GetMessageBoxStandardWindow(new MessageBox.Avalonia.DTO.MessageBoxStandardParams - { - ContentTitle = $"Journal Read Error{(readErrors.Count > 1 ? "s" : "")}", - ContentMessage = errorContent.ToString() - }); - errorMessage.ShowDialog(desktop.MainWindow); - - } - + ErrorReporter.ShowErrorPopup($"Journal Read Error{(readErrors.Count > 1 ? "s" : "")}", errorContent.ToString()); } } diff --git a/ObservatoryCore/NativeNotification/NativeVoice.cs b/ObservatoryCore/NativeNotification/NativeVoice.cs index cf601c6..dfa5d8d 100644 --- a/ObservatoryCore/NativeNotification/NativeVoice.cs +++ b/ObservatoryCore/NativeNotification/NativeVoice.cs @@ -85,36 +85,12 @@ namespace Observatory.NativeNotification XmlNamespaceManager ssmlNs = new(ssmlDoc.NameTable); ssmlNs.AddNamespace("ssml", ssmlNamespace); - //If the SSML already has a voice element leave it alone. - if (ssmlDoc.SelectSingleNode("/ssml:speak/ssml:voice", ssmlNs) == null) - { - //Preserve existing content to place it in new voice element - string speakContent = ssmlDoc.DocumentElement.InnerXml; - speakContent = speakContent.Replace($"xmlns=\"{ssmlNs.LookupNamespace("ssml")}\"", string.Empty); - //Crete new voice element and name attribute objects - var voiceElement = ssmlDoc.CreateElement("voice", ssmlNs.LookupNamespace("ssml")); - var voiceAttribute = ssmlDoc.CreateAttribute("name"); + var voiceNode = ssmlDoc.SelectSingleNode("/ssml:speak/ssml:voice", ssmlNs); - //Update content of new element - voiceAttribute.Value = voiceName; - voiceElement.Attributes.Append(voiceAttribute); - voiceElement.InnerXml = speakContent; - - //Clear existing content and insert new element - ssmlDoc.DocumentElement.InnerText = string.Empty; - ssmlDoc.DocumentElement.AppendChild(voiceElement); + voiceNode.Attributes.GetNamedItem("name").Value = voiceName; - ssml = ssmlDoc.OuterXml; - } - - //If I leave the namespace in speakContent above it's left behind as a redundant - //attribute which breaks the speech generation. - //If I remove it then the XmlDoc explicitly adds an empty namespace which *also* - //breaks speech generation. - //The empty one is easier to remove later, so that's what I'm doing, but if someone - //has a better suggestion I'm all for it. - return ssml.Replace("xmlns=\"\"", string.Empty); + return ssmlDoc.OuterXml; } } } diff --git a/ObservatoryCore/PluginManagement/PluginEventHandler.cs b/ObservatoryCore/PluginManagement/PluginEventHandler.cs index 3507e48..b273bde 100644 --- a/ObservatoryCore/PluginManagement/PluginEventHandler.cs +++ b/ObservatoryCore/PluginManagement/PluginEventHandler.cs @@ -14,18 +14,32 @@ namespace Observatory.PluginManagement { private IEnumerable observatoryWorkers; private IEnumerable observatoryNotifiers; + private List errorList; public PluginEventHandler(IEnumerable observatoryWorkers, IEnumerable observatoryNotifiers) { this.observatoryWorkers = observatoryWorkers; this.observatoryNotifiers = observatoryNotifiers; + errorList = new(); } public void OnJournalEvent(object source, JournalEventArgs journalEventArgs) { foreach (var worker in observatoryWorkers) { - worker.JournalEvent((JournalBase)journalEventArgs.journalEvent); + try + { + worker.JournalEvent((JournalBase)journalEventArgs.journalEvent); + } + catch (PluginException ex) + { + RecordError(ex); + } + catch (Exception ex) + { + RecordError(ex, worker.Name, journalEventArgs.journalType.Name); + } + ReportErrorsIfAny(); } } @@ -33,7 +47,19 @@ namespace Observatory.PluginManagement { foreach (var worker in observatoryWorkers) { - worker.StatusChange((Status)journalEventArgs.journalEvent); + try + { + worker.StatusChange((Status)journalEventArgs.journalEvent); + } + catch (PluginException ex) + { + RecordError(ex); + } + catch (Exception ex) + { + RecordError(ex, worker.Name, journalEventArgs.journalType.Name); + } + ReportErrorsIfAny(); } } @@ -41,7 +67,39 @@ namespace Observatory.PluginManagement { foreach (var notifier in observatoryNotifiers) { - notifier.OnNotificationEvent(notificationArgs); + try + { + notifier.OnNotificationEvent(notificationArgs); + } + catch (PluginException ex) + { + RecordError(ex); + } + catch (Exception ex) + { + RecordError(ex, notifier.Name, notificationArgs.Title); + } + ReportErrorsIfAny(); + } + } + + private void RecordError(PluginException ex) + { + errorList.Add($"Error in {ex.PluginName}: {ex.Message}"); + } + + private void RecordError(Exception ex, string plugin, string eventType) + { + errorList.Add($"Error in {plugin} while handling {eventType}: {ex.Message}"); + } + + private void ReportErrorsIfAny() + { + if (errorList.Any()) + { + ErrorReporter.ShowErrorPopup($"Plugin Error{(errorList.Count > 1 ? "s" : "")}", string.Join(Environment.NewLine, errorList)); + + errorList.Clear(); } } } diff --git a/ObservatoryCore/PluginManagement/PluginManager.cs b/ObservatoryCore/PluginManagement/PluginManager.cs index c874240..628d74c 100644 --- a/ObservatoryCore/PluginManagement/PluginManager.cs +++ b/ObservatoryCore/PluginManagement/PluginManager.cs @@ -6,7 +6,7 @@ using System.Reflection; using System.Data; using Observatory.Framework.Interfaces; using System.IO; -using System.Configuration; +using Observatory.Framework; using System.Text.Json; namespace Observatory.PluginManagement @@ -39,11 +39,6 @@ namespace Observatory.PluginManagement { errorList = LoadPlugins(out workerPlugins, out notifyPlugins); - foreach (var error in errorList) - { - Console.WriteLine(error); - } - var pluginHandler = new PluginEventHandler(workerPlugins.Select(p => p.plugin), notifyPlugins.Select(p => p.plugin)); var logMonitor = LogMonitor.GetInstance; pluginPanels = new(); @@ -54,24 +49,53 @@ namespace Observatory.PluginManagement var core = new PluginCore(); + List errorPlugins = new(); + foreach (var plugin in workerPlugins.Select(p => p.plugin)) { - LoadSettings(plugin); - plugin.Load(core); + try + { + LoadSettings(plugin); + plugin.Load(core); + } + catch (PluginException ex) + { + errorList.Add(FormatErrorMessage(ex)); + errorPlugins.Add(plugin); + } } + + workerPlugins.RemoveAll(w => errorPlugins.Contains(w.plugin)); + errorPlugins.Clear(); + foreach (var plugin in notifyPlugins.Select(p => p.plugin)) { // Notifiers which are also workers need not be loaded again (they are the same instance). if (!plugin.GetType().IsAssignableTo(typeof(IObservatoryWorker))) { - LoadSettings(plugin); - plugin.Load(core); + try + { + LoadSettings(plugin); + plugin.Load(core); + } + catch (PluginException ex) + { + errorList.Add(FormatErrorMessage(ex)); + errorPlugins.Add(plugin); + } } } + notifyPlugins.RemoveAll(n => errorPlugins.Contains(n.plugin)); + core.Notification += pluginHandler.OnNotificationEvent; } + private static string FormatErrorMessage(PluginException ex) + { + return $"{ex.PluginName}: {ex.UserMessage}"; + } + private void LoadSettings(IObservatoryPlugin plugin) { string savedSettings = Properties.Core.Default.PluginSettings; diff --git a/ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs b/ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs index 0a5935e..8f45863 100644 --- a/ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs +++ b/ObservatoryCore/UI/ViewModels/MainWindowViewModel.cs @@ -1,6 +1,6 @@ using System; using System.Collections.Generic; -using System.Text; +using System.Linq; namespace Observatory.UI.ViewModels { @@ -9,6 +9,9 @@ namespace Observatory.UI.ViewModels public MainWindowViewModel(PluginManagement.PluginManager pluginManager) { core = new CoreViewModel(pluginManager.workerPlugins, pluginManager.notifyPlugins); + + if (pluginManager.errorList.Any()) + ErrorReporter.ShowErrorPopup("Plugin Load Error", string.Join(Environment.NewLine, pluginManager.errorList)); } public CoreViewModel core { get; } diff --git a/ObservatoryCore/UI/Views/BasicUIView.axaml.cs b/ObservatoryCore/UI/Views/BasicUIView.axaml.cs index ebe142a..8ea7c2f 100644 --- a/ObservatoryCore/UI/Views/BasicUIView.axaml.cs +++ b/ObservatoryCore/UI/Views/BasicUIView.axaml.cs @@ -535,7 +535,7 @@ namespace Observatory.UI.Views NotificationArgs args = new() { Title = "Speech Synthesis Test", - TitleSsml = "Speech Synthesis Test", + TitleSsml = "Speech Synthesis Test", Detail = harvardSentences.OrderBy(s => new Random().NextDouble()).First() }; @@ -943,6 +943,46 @@ namespace Observatory.UI.Views settingsGrid.AddControl(actionButton, settingsGrid.RowDefinitions.Count - 1, 0); + break; + case Dictionary dictSetting: + + var backingValueName = (SettingBackingValue)Attribute.GetCustomAttribute(setting.Key, typeof(SettingBackingValue)); + + var backingValue = from s in displayedSettings + where s.Value == backingValueName.BackingProperty + select s.Key; + + if (backingValue.Count() != 1) + throw new($"{plugin.ShortName}: Dictionary settings must have exactly one backing value."); + + label.Text += ": "; + + ComboBox selectionDropDown = new() + { + MinWidth = 200 + }; + + selectionDropDown.Items = from s in dictSetting + orderby s.Key + select s.Key; + + string currentSelection = backingValue.First().GetValue(plugin.Settings)?.ToString(); + + if (currentSelection?.Length > 0) + { + selectionDropDown.SelectedItem = currentSelection; + } + + selectionDropDown.SelectionChanged += (object sender, SelectionChangedEventArgs e) => + { + var comboBox = (ComboBox)sender; + backingValue.First().SetValue(plugin.Settings, comboBox.SelectedItem.ToString()); + PluginManagement.PluginManager.GetInstance.SaveSettings(plugin, plugin.Settings); + }; + + settingsGrid.AddControl(label, settingsGrid.RowDefinitions.Count - 1, 0); + settingsGrid.AddControl(selectionDropDown, settingsGrid.RowDefinitions.Count - 1, 1); + break; } } diff --git a/ObservatoryCore/UI/Views/MainWindow.axaml.cs b/ObservatoryCore/UI/Views/MainWindow.axaml.cs index 02ea9b3..76fcd37 100644 --- a/ObservatoryCore/UI/Views/MainWindow.axaml.cs +++ b/ObservatoryCore/UI/Views/MainWindow.axaml.cs @@ -15,17 +15,43 @@ namespace Observatory.UI.Views #endif Height = Properties.Core.Default.MainWindowSize.Height; Width = Properties.Core.Default.MainWindowSize.Width; - Position = new PixelPoint(Properties.Core.Default.MainWindowPosition.X, Properties.Core.Default.MainWindowPosition.Y); + + var savedPosition = new System.Drawing.Point(Properties.Core.Default.MainWindowPosition.X, Properties.Core.Default.MainWindowPosition.Y); + if (PointWithinDesktopWorkingArea(savedPosition)) + Position = new PixelPoint(Properties.Core.Default.MainWindowPosition.X, Properties.Core.Default.MainWindowPosition.Y); + Closing += (object sender, System.ComponentModel.CancelEventArgs e) => { var size = new System.Drawing.Size((int)System.Math.Round(Width), (int)System.Math.Round(Height)); - var position = new System.Drawing.Point(Position.X, Position.Y); Properties.Core.Default.MainWindowSize = size; - Properties.Core.Default.MainWindowPosition = position; + + var position = new System.Drawing.Point(Position.X, Position.Y); + if (PointWithinDesktopWorkingArea(position)) + Properties.Core.Default.MainWindowPosition = position; + Properties.Core.Default.Save(); }; } + private bool PointWithinDesktopWorkingArea(System.Drawing.Point position) + { + bool inBounds = false; + + foreach (var screen in Screens.All) + { + if (screen.WorkingArea.TopLeft.X <= position.X + && screen.WorkingArea.TopLeft.Y <= position.Y + && screen.WorkingArea.BottomRight.X > position.X + && screen.WorkingArea.BottomRight.Y > position.Y) + { + inBounds = true; + break; + } + } + + return inBounds; + } + private void InitializeComponent() { AvaloniaXamlLoader.Load(this); diff --git a/ObservatoryExplorer/Explorer.cs b/ObservatoryExplorer/Explorer.cs index 07e6115..7fbf474 100644 --- a/ObservatoryExplorer/Explorer.cs +++ b/ObservatoryExplorer/Explorer.cs @@ -239,7 +239,7 @@ namespace Observatory.Explorer NotificationArgs args = new() { Title = bodyLabel + bodyAffix, - TitleSsml = $"{bodyLabel} {spokenAffix}", + TitleSsml = $"{bodyLabel} {spokenAffix}", Detail = notificationDetail.ToString() }; diff --git a/ObservatoryFramework/Attributes.cs b/ObservatoryFramework/Attributes.cs index 4f2e2ba..05bf691 100644 --- a/ObservatoryFramework/Attributes.cs +++ b/ObservatoryFramework/Attributes.cs @@ -6,15 +6,26 @@ using System.Threading.Tasks; namespace Observatory.Framework { + /// + /// Specifies text to display as the name of the setting in the UI instead of the property name. + /// + [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)] public class SettingDisplayName : Attribute { private string name; + /// + /// Specifies text to display as the name of the setting in the UI instead of the property name. + /// + /// Name to display public SettingDisplayName(string name) { this.name = name; } + /// + /// Accessor to get/set displayed name. + /// public string DisplayName { get => name; @@ -22,18 +33,63 @@ namespace Observatory.Framework } } + /// + /// Indicates that the property should not be displayed to the user in the UI. + /// + [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)] public class SettingIgnore : Attribute { } + /// + /// Indicates numeric properly should use a slider control instead of a numeric textbox with roller. + /// + [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)] public class SettingNumericUseSlider : Attribute { } + /// + /// Specify backing value used by Dictionary<string, object> to indicate selected option. + /// + [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)] + public class SettingBackingValue : Attribute + { + private string property; + + /// + /// Specify backing value used by Dictionary<string, object> to indicate selected option. + /// + /// Property name for backing value. + public SettingBackingValue(string property) + { + this.property = property; + } + + /// + /// Accessor to get/set backing value property name. + /// + public string BackingProperty + { + get => property; + set => property = value; + } + } + + /// + /// Specify bounds for numeric inputs. + /// + [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)] public class SettingNumericBounds : Attribute { private double minimum; private double maximum; private double increment; + /// + /// Specify bounds for numeric inputs. + /// + /// Minimum allowed value. + /// Maximum allowed value. + /// Increment between allowed values in slider/roller inputs. public SettingNumericBounds(double minimum, double maximum, double increment = 1.0) { this.minimum = minimum; @@ -41,16 +97,27 @@ namespace Observatory.Framework this.increment = increment; } + /// + /// Minimum allowed value. + /// public double Minimum { get => minimum; set => minimum = value; } + + /// + /// Maxunyn allowed value. + /// public double Maximum { get => maximum; set => maximum = value; } + + /// + /// Increment between allowed values in slider/roller inputs. + /// public double Increment { get => increment; diff --git a/ObservatoryFramework/Exceptions.cs b/ObservatoryFramework/Exceptions.cs new file mode 100644 index 0000000..f030f0a --- /dev/null +++ b/ObservatoryFramework/Exceptions.cs @@ -0,0 +1,34 @@ +using System; + +namespace Observatory.Framework +{ + /// + /// Container for exceptions within plugins which cannot be gracefully handled in context, + /// but benefit from having a context-specific user message. + /// + public class PluginException : Exception + { + /// + /// Initialze new PluginException with details of the originating plugin and a specific user-facing message for display. + /// + /// + /// + /// + public PluginException(string pluginName, string userMessage, Exception innerException) : base(innerException.Message, innerException) + { + PluginName = pluginName; + UserMessage = userMessage; + } + + /// + /// Name of plugin from which the exception was thrown. + /// + public string PluginName { get; } + + /// + /// Message to be displayed to user. + /// + public string UserMessage { get; } + + } +} diff --git a/ObservatoryFramework/Files/ParameterTypes/Enumerations.cs b/ObservatoryFramework/Files/ParameterTypes/Enumerations.cs index adcdd31..913f8da 100644 --- a/ObservatoryFramework/Files/ParameterTypes/Enumerations.cs +++ b/ObservatoryFramework/Files/ParameterTypes/Enumerations.cs @@ -301,7 +301,8 @@ namespace Observatory.Framework.Files.ParameterTypes ActiveFighter, JumpImminent, RestrictedAccess, - NoReason + NoReason, + DockOffline } public enum ScanOrganicType diff --git a/ObservatoryFramework/Files/ShipyardFile.cs b/ObservatoryFramework/Files/ShipyardFile.cs index 313c156..1dd56e6 100644 --- a/ObservatoryFramework/Files/ShipyardFile.cs +++ b/ObservatoryFramework/Files/ShipyardFile.cs @@ -3,13 +3,35 @@ using System.Collections.Immutable; namespace Observatory.Framework.Files { + /// + /// Elite Dangerous shipyard.json file. + /// public class ShipyardFile : Journal.JournalBase { + /// + /// Unique ID of market. + /// public long MarketID { get; init; } + /// + /// Name of station where shipyard is located. + /// public string StationName { get; init; } + /// + /// Starsystem where shipyard is located. + /// public string StarSystem { get; init; } + /// + /// Whether player has access to Horizons content. + /// public bool Horizons { get; init; } + /// + /// Whether player has access to the Cobra MkIV. + /// Will never be set to true for CMDR Nuse. + /// public bool AllowCobraMkIV { get; init; } + /// + /// List of all ships and prices for them at the current shipyard. + /// public ImmutableList PriceList { get; init; } } } diff --git a/ObservatoryFramework/Files/Status.cs b/ObservatoryFramework/Files/Status.cs index ad86366..bc070f0 100644 --- a/ObservatoryFramework/Files/Status.cs +++ b/ObservatoryFramework/Files/Status.cs @@ -4,30 +4,98 @@ using Observatory.Framework.Files.ParameterTypes; namespace Observatory.Framework.Files { + /// + /// Elite Dangerous status.json file. + /// public class Status : Journal.JournalBase { + /// + /// Set of flags representing current player state. + /// public StatusFlags Flags { get; init; } + /// + /// Additional set of flags representing current player state. + /// Added in later versions of Elite Dangerous. + /// public StatusFlags2 Flags2 { get; init; } + /// + /// Current allocation of power distribution (pips) between SYS, ENG, and WEP, in "half pip" increments. + /// [JsonConverter(typeof(PipConverter))] public (int Sys, int Eng, int Wep) Pips { get; init; } + /// + /// Currently selected fire group. + /// public int Firegroup { get; init; } + /// + /// UI component currently focused by the player. + /// public FocusStatus GuiFocus { get; init; } + /// + /// Fuel remaining in the current ship. + /// public FuelType Fuel { get; init; } + /// + /// Amount of cargo currently carried. + /// public float Cargo { get; init; } + /// + /// Legal status in the current jurisdiction. + /// [JsonConverter(typeof(JsonStringEnumConverter))] public LegalStatus LegalState { get; init; } + /// + /// Current altitude. + /// Check if RadialAltitude is set in StatusFlags to determine if altitude is based on planetary radius (set) or raycast to ground (unset). + /// public int Altitude { get; init; } + /// + /// Latitude of current surface location. + /// public double Latitude { get; init; } + /// + /// Longitude of current surface location. + /// public double Longitude { get; init; } + /// + /// Current heading for surface direction. + /// public int Heading { get; init; } + /// + /// Body name of current location. + /// public string BodyName { get; init; } + /// + /// Radius of current planet. + /// public double PlanetRadius { get; init; } + /// + /// Oxygen remaining on foot, range from 0.0 - 1.0. + /// public float Oxygen { get; init; } + /// + /// Health remaining on foot, range from 0.0 - 1.0. + /// public float Health { get; init; } + /// + /// Current environmental temperature in K while on foot. + /// public float Temperature { get; init; } + /// + /// Name of currently selected personal weapon. + /// public string SelectedWeapon { get; init; } + /// + /// Current strength of gravity while on foot, in g. + /// public float Gravity { get; init; } + /// + /// Current credit balance of player. + /// public long Balance { get; init; } + /// + /// Currently set destination. + /// public Destination Destination { get; init; } } } diff --git a/ObservatoryFramework/Interfaces.cs b/ObservatoryFramework/Interfaces.cs index 948dc94..d1720b2 100644 --- a/ObservatoryFramework/Interfaces.cs +++ b/ObservatoryFramework/Interfaces.cs @@ -41,7 +41,7 @@ namespace Observatory.Framework.Interfaces public PluginUI PluginUI { get; } /// - /// Accessors for plugin settings object. Should be initialized in a default state. + /// Accessors for plugin settings object. Should be initialized with a default state during the plugin constructor. /// Saving and loading of settings is handled by Observatory Core, and any previously saved settings will be set after plugin instantiation, but before Load() is called. /// A plugin's settings class is expected to consist of properties with public getters and setters. The settings UI will be automatically generated based on each property type.
/// The [SettingDisplayName(string name)] attribute can be used to specify a display name, otherwise the name of the property will be used.
diff --git a/ObservatoryFramework/ObservatoryFramework.xml b/ObservatoryFramework/ObservatoryFramework.xml index 5d8abb0..6a276b6 100644 --- a/ObservatoryFramework/ObservatoryFramework.xml +++ b/ObservatoryFramework/ObservatoryFramework.xml @@ -4,6 +4,76 @@ ObservatoryFramework + + + Specifies text to display as the name of the setting in the UI instead of the property name. + + + + + Specifies text to display as the name of the setting in the UI instead of the property name. + + Name to display + + + + Accessor to get/set displayed name. + + + + + Indicates that the property should not be displayed to the user in the UI. + + + + + Indicates numeric properly should use a slider control instead of a numeric textbox with roller. + + + + + Specify backing value used by Dictionary<string, object> to indicate selected option. + + + + + Specify backing value used by Dictionary<string, object> to indicate selected option. + + Property name for backing value. + + + + Accessor to get/set backing value property name. + + + + + Specify bounds for numeric inputs. + + + + + Specify bounds for numeric inputs. + + Minimum allowed value. + Maximum allowed value. + Increment between allowed values in slider/roller inputs. + + + + Minimum allowed value. + + + + + Maxunyn allowed value. + + + + + Increment between allowed values in slider/roller inputs. + + Provides data for Elite Dangerous journal events. @@ -63,6 +133,30 @@ Specify window Y position as a percentage from upper left corner (overrides Core setting). Default -1.0 (use Core setting). + + + Container for exceptions within plugins which cannot be gracefully handled in context, + but benefit from having a context-specific user message. + + + + + Initialze new PluginException with details of the originating plugin and a specific user-facing message for display. + + + + + + + + Name of plugin from which the exception was thrown. + + + + + Message to be displayed to user. + + This property is indicated with strikethrough in Frontier's documentation and may be deprecated. @@ -320,6 +414,154 @@ Altitude above average radius (sea level) when set. Altitude raycast to ground when unset. + + + Elite Dangerous shipyard.json file. + + + + + Unique ID of market. + + + + + Name of station where shipyard is located. + + + + + Starsystem where shipyard is located. + + + + + Whether player has access to Horizons content. + + + + + Whether player has access to the Cobra MkIV. + Will never be set to true for CMDR Nuse. + + + + + List of all ships and prices for them at the current shipyard. + + + + + Elite Dangerous status.json file. + + + + + Set of flags representing current player state. + + + + + Additional set of flags representing current player state. + Added in later versions of Elite Dangerous. + + + + + Current allocation of power distribution (pips) between SYS, ENG, and WEP, in "half pip" increments. + + + + + Currently selected fire group. + + + + + UI component currently focused by the player. + + + + + Fuel remaining in the current ship. + + + + + Amount of cargo currently carried. + + + + + Legal status in the current jurisdiction. + + + + + Current altitude. + Check if RadialAltitude is set in StatusFlags to determine if altitude is based on planetary radius (set) or raycast to ground (unset). + + + + + Latitude of current surface location. + + + + + Longitude of current surface location. + + + + + Current heading for surface direction. + + + + + Body name of current location. + + + + + Radius of current planet. + + + + + Oxygen remaining on foot, range from 0.0 - 1.0. + + + + + Health remaining on foot, range from 0.0 - 1.0. + + + + + Current environmental temperature in K while on foot. + + + + + Name of currently selected personal weapon. + + + + + Current strength of gravity while on foot, in g. + + + + + Current credit balance of player. + + + + + Currently set destination. + + Base plugin interface containing methods common to both notifiers and workers. @@ -357,7 +599,7 @@ - Accessors for plugin settings object. Should be initialized in a default state. + Accessors for plugin settings object. Should be initialized with a default state during the plugin constructor. Saving and loading of settings is handled by Observatory Core, and any previously saved settings will be set after plugin instantiation, but before Load() is called. A plugin's settings class is expected to consist of properties with public getters and setters. The settings UI will be automatically generated based on each property type.
The [SettingDisplayName(string name)] attribute can be used to specify a display name, otherwise the name of the property will be used.
diff --git a/ObservatoryHerald/AzureSpeechManager.cs b/ObservatoryHerald/AzureSpeechManager.cs new file mode 100644 index 0000000..fe06a2e --- /dev/null +++ b/ObservatoryHerald/AzureSpeechManager.cs @@ -0,0 +1,242 @@ +using System; +using System.IO; +using System.Linq; +using System.Collections.Generic; +using System.Net.Http; +using System.Xml; +using Microsoft.CognitiveServices.Speech; +using System.Collections.ObjectModel; +using Observatory.Framework; + +namespace Observatory.Herald +{ + internal class VoiceSpeechManager + { + private string azureKey; + private DirectoryInfo cacheLocation; + private SpeechConfig speechConfig; + private SpeechSynthesizer speech; + + internal VoiceSpeechManager(HeraldSettings settings, HttpClient httpClient) + { + cacheLocation = new(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + + $"{Path.DirectorySeparatorChar}ObservatoryCore{Path.DirectorySeparatorChar}ObservatoryHerald{Path.DirectorySeparatorChar}"); + + if (!Directory.Exists(cacheLocation.FullName)) + { + Directory.CreateDirectory(cacheLocation.FullName); + } + + try + { + azureKey = GetAzureKey(settings, httpClient); + } + catch (Exception ex) + { + throw new PluginException("Herald", "Unable to retrieve Azure API key.", ex); + } + + try + { + speechConfig = SpeechConfig.FromSubscription(azureKey, "eastus"); + } + catch (Exception ex) + { + throw new PluginException("Herald", "Error retrieving Azure account details.", ex); + } + + speech = new(speechConfig, null); + + settings.Voices = PopulateVoiceSettingOptions(); + } + + private Dictionary PopulateVoiceSettingOptions() + { + ReadOnlyCollection voices; + + try + { + voices = speech.GetVoicesAsync().Result.Voices; + } + catch (Exception ex) + { + throw new PluginException("Herald", "Unable to retrieve voice list from Azure.", ex); + } + + var voiceOptions = new Dictionary(); + + var englishSpeakingVoices = from v in voices + where v.Locale.StartsWith("en-") + select v; + + foreach (var voice in englishSpeakingVoices) + { + string demonym = GetDemonymFromLocale(voice.Locale); + + if (voice.StyleList.Length > 1) + { + foreach (var style in voice.StyleList) + { + voiceOptions.Add( + $"{demonym} - {voice.LocalName} - {style}", + voice); + } + } + else + voiceOptions.Add( + $"{demonym} - {voice.LocalName}", + voice); + } + + return voiceOptions; + } + + private static string GetDemonymFromLocale(string locale) + { + string demonym; + + switch (locale) + { + case "en-AU": + demonym = "Australian"; + break; + case "en-CA": + demonym = "Canadian"; + break; + case "en-GB": + demonym = "British"; + break; + case "en-HK": + demonym = "Hong Konger"; + break; + case "en-IE": + demonym = "Irish"; + break; + case "en-IN": + demonym = "Indian"; + break; + case "en-KE": + demonym = "Kenyan"; + break; + case "en-NG": + demonym = "Nigerian"; + break; + case "en-NZ": + demonym = "Kiwi"; + break; + case "en-PH": + demonym = "Filipino"; + break; + case "en-SG": + demonym = "Singaporean"; + break; + case "en-TZ": + demonym = "Tanzanian"; + break; + case "en-US": + demonym = "American"; + break; + case "en-ZA": + demonym = "South African"; + break; + default: + demonym = locale; + break; + } + + return demonym; + } + + internal string GetAudioFileFromSsml(string ssml, string voice, string style) + { + ssml = AddVoiceToSsml(ssml, voice, style); + string ssmlHash = FNV64(ssml).ToString("X"); + + string audioFile = cacheLocation + ssmlHash + ".wav"; + + if (!File.Exists(audioFile)) + { + using var stream = RequestFromAzure(ssml); + stream.SaveToWaveFileAsync(audioFile).Wait(); + } + + return audioFile; + } + + private static ulong FNV64(string data) + { + string lower_data = data.ToLower(); + ulong hash = 0xcbf29ce484222325uL; + for (int i = 0; i < lower_data.Length; i++) + { + byte b = (byte)lower_data[i]; + hash *= 1099511628211uL; + hash ^= b; + } + return hash; + } + + private AudioDataStream RequestFromAzure(string ssml) + { + try + { + var result = speech.SpeakSsmlAsync(ssml).Result; + return AudioDataStream.FromResult(result); + } + catch (Exception ex) + { + throw new PluginException("Herald", "Unable to retrieve audio from Azure.", ex); + } + } + + private static string AddVoiceToSsml(string ssml, string voiceName, string styleName) + { + XmlDocument ssmlDoc = new(); + ssmlDoc.LoadXml(ssml); + + var ssmlNamespace = ssmlDoc.DocumentElement.NamespaceURI; + XmlNamespaceManager ssmlNs = new(ssmlDoc.NameTable); + ssmlNs.AddNamespace("ssml", ssmlNamespace); + + + var voiceNode = ssmlDoc.SelectSingleNode("/ssml:speak/ssml:voice", ssmlNs); + + voiceNode.Attributes.GetNamedItem("name").Value = voiceName; + + string ssmlResult; + + if (!string.IsNullOrWhiteSpace(styleName)) + { + voiceNode.InnerText = $"" + voiceNode.InnerText + ""; + + // This is a kludge but I don't feel like dealing with System.Xml and namespaces + ssmlResult = ssmlDoc.OuterXml + .Replace(" xmlns=", " xmlns:mstts=\"https://www.w3.org/2001/mstts\" xmlns=") + .Replace($"<mstts:express-as style=\"{styleName}\">", $"") + .Replace("</mstts:express-as>", ""); + } + else + { + ssmlResult = ssmlDoc.OuterXml; + } + + return ssmlResult; + } + + private static string GetAzureKey(HeraldSettings settings, HttpClient httpClient) + { + string azureKey; + + if (string.IsNullOrWhiteSpace(settings.AzureAPIKeyOverride)) + { + azureKey = httpClient.GetStringAsync("https://xjph.net/Observatory/ObservatoryHeraldAzureKey").Result; + } + else + { + azureKey = settings.AzureAPIKeyOverride; + } + + return azureKey; + } + } +} diff --git a/ObservatoryHerald/HeraldNotifier.cs b/ObservatoryHerald/HeraldNotifier.cs new file mode 100644 index 0000000..35091b4 --- /dev/null +++ b/ObservatoryHerald/HeraldNotifier.cs @@ -0,0 +1,77 @@ +using Microsoft.CognitiveServices.Speech; +using Observatory.Framework; +using Observatory.Framework.Interfaces; +using System; + +namespace Observatory.Herald +{ + public class HeraldNotifier : IObservatoryNotifier + { + public HeraldNotifier() + { + heraldSettings = new() + { + SelectedVoice = "American - Christopher", + AzureAPIKeyOverride = string.Empty, + Enabled = true + }; + } + + public string Name => "Observatory Herald"; + + public string ShortName => "Herald"; + + public string Version => typeof(HeraldNotifier).Assembly.GetName().Version.ToString(); + + public PluginUI PluginUI => new (PluginUI.UIType.None, null); + + public object Settings { get => heraldSettings; set => heraldSettings = (HeraldSettings)value; } + + public void Load(IObservatoryCore observatoryCore) + { + var azureManager = new VoiceSpeechManager(heraldSettings, observatoryCore.HttpClient); + heraldSpeech = new HeraldQueue(azureManager); + heraldSettings.Test = TestVoice; + } + + private void TestVoice() + { + heraldSpeech.Enqueue( + new NotificationArgs() + { + Title = "Herald voice testing", + Detail = $"This is {heraldSettings.SelectedVoice.Split(" - ")[1]}." + }, + GetAzureNameFromSetting(heraldSettings.SelectedVoice), + GetAzureStyleNameFromSetting(heraldSettings.SelectedVoice)); + } + + public void OnNotificationEvent(NotificationArgs notificationEventArgs) + { + if (heraldSettings.Enabled) + heraldSpeech.Enqueue( + notificationEventArgs, + GetAzureNameFromSetting(heraldSettings.SelectedVoice), + GetAzureStyleNameFromSetting(heraldSettings.SelectedVoice)); + } + + private string GetAzureNameFromSetting(string settingName) + { + var voiceInfo = (VoiceInfo)heraldSettings.Voices[settingName]; + return voiceInfo.Name; + } + + private string GetAzureStyleNameFromSetting(string settingName) + { + string[] settingParts = settingName.Split(" - "); + + if (settingParts.Length == 3) + return settingParts[2]; + else + return string.Empty; + } + + private HeraldSettings heraldSettings; + private HeraldQueue heraldSpeech; + } +} diff --git a/ObservatoryHerald/HeraldQueue.cs b/ObservatoryHerald/HeraldQueue.cs new file mode 100644 index 0000000..39642b1 --- /dev/null +++ b/ObservatoryHerald/HeraldQueue.cs @@ -0,0 +1,94 @@ +using Observatory.Framework; +using System.Collections.Generic; +using System.Threading.Tasks; +using System.Linq; +using NetCoreAudio; +using System.Threading; + +namespace Observatory.Herald +{ + class HeraldQueue + { + private Queue notifications; + private bool processing; + private string voice; + private string style; + private VoiceSpeechManager azureCacheManager; + private Player audioPlayer; + + public HeraldQueue(VoiceSpeechManager azureCacheManager) + { + this.azureCacheManager = azureCacheManager; + processing = false; + notifications = new(); + audioPlayer = new(); + } + + + internal void Enqueue(NotificationArgs notification, string selectedVoice, string selectedStyle = "") + { + voice = selectedVoice; + style = selectedStyle; + notifications.Enqueue(notification); + + if (!processing) + { + processing = true; + ProcessQueueAsync(); + } + } + + private async void ProcessQueueAsync() + { + await Task.Factory.StartNew(ProcessQueue); + } + + private void ProcessQueue() + { + while (notifications.Any()) + { + var notification = notifications.Dequeue(); + + if (string.IsNullOrWhiteSpace(notification.TitleSsml)) + { + Speak(notification.Title); + } + else + { + SpeakSsml(notification.TitleSsml); + } + + if (string.IsNullOrWhiteSpace(notification.DetailSsml)) + { + Speak(notification.Detail); + } + else + { + SpeakSsml(notification.DetailSsml); + } + } + + processing = false; + } + + private void Speak(string text) + { + SpeakSsml($"{text}"); + } + + private void SpeakSsml(string ssml) + { + string file = azureCacheManager.GetAudioFileFromSsml(ssml, voice, style); + + // For some reason .Wait() concludes before audio playback is complete. + audioPlayer.Play(file); + while (audioPlayer.Playing) + { + Thread.Sleep(20); + } + } + + + + } +} diff --git a/ObservatoryHerald/HeraldSettings.cs b/ObservatoryHerald/HeraldSettings.cs new file mode 100644 index 0000000..398ccec --- /dev/null +++ b/ObservatoryHerald/HeraldSettings.cs @@ -0,0 +1,29 @@ +using Observatory.Framework; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Observatory.Herald +{ + public class HeraldSettings + { + [SettingDisplayName("API Key Override: ")] + public string AzureAPIKeyOverride { get; set; } + + [SettingDisplayName("Voice")] + [SettingBackingValue("SelectedVoice")] + [System.Text.Json.Serialization.JsonIgnore] + public Dictionary Voices { get; internal set; } + + [SettingIgnore] + public string SelectedVoice { get; set; } + + [System.Text.Json.Serialization.JsonIgnore] + public Action Test { get; internal set; } + + [SettingDisplayName("Enabled")] + public bool Enabled { get; set; } + } +} diff --git a/ObservatoryHerald/ObservatoryHerald.csproj b/ObservatoryHerald/ObservatoryHerald.csproj new file mode 100644 index 0000000..81c64d7 --- /dev/null +++ b/ObservatoryHerald/ObservatoryHerald.csproj @@ -0,0 +1,40 @@ + + + + net5.0 + true + + + + 0.0.$([System.DateTime]::UtcNow.DayOfYear.ToString()).$([System.DateTime]::UtcNow.ToString(HHmm)) + 0.0.0.1 + $(VersionSuffix) + 0.0.1.0 + $(VersionSuffix) + + + + + + + + + ..\..\NetCoreAudio\NetCoreAudio\bin\Release\netstandard2.0\NetCoreAudio.dll + + + ..\ObservatoryFramework\bin\Release\net5.0\ObservatoryFramework.dll + + + + + + + + + + + + + + + diff --git a/ObservatoryHerald/ObservatoryHerald.sln b/ObservatoryHerald/ObservatoryHerald.sln new file mode 100644 index 0000000..a1adc78 --- /dev/null +++ b/ObservatoryHerald/ObservatoryHerald.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.31205.134 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ObservatoryHerald", "ObservatoryHerald.csproj", "{BC57225F-D89B-4853-A816-9AB4865E7AC5}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {BC57225F-D89B-4853-A816-9AB4865E7AC5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {BC57225F-D89B-4853-A816-9AB4865E7AC5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {BC57225F-D89B-4853-A816-9AB4865E7AC5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {BC57225F-D89B-4853-A816-9AB4865E7AC5}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {3466BC38-6B4F-459C-9292-DD2D77F8B8E4} + EndGlobalSection +EndGlobal