Core - Moved startup arguments from CoreService to Constants

Web server - Added setting to disable the web server
Web server - Added --disable-webserver startup argument to disable the web server
UI - Fixed Artemis not bringing existing instances to foreground if already running

src/Artemis.Core/Constants.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.IO;
 using System.Reflection;
 using Artemis.Core.JsonConverters;
@@ -90,6 +91,11 @@ public static class Constants
     /// </summary>
     public static readonly Plugin CorePlugin = new(CorePluginInfo, new DirectoryInfo(ApplicationFolder), null);
 
+    /// <summary>
+    ///     Gets the startup arguments provided to the application
+    /// </summary>
+    public static ReadOnlyCollection<string> StartupArguments { get; set; } = null!;
+
     internal static readonly CorePluginFeature CorePluginFeature = new() {Plugin = CorePlugin, Profiler = CorePlugin.GetProfiler("Feature - Core")};
     internal static readonly EffectPlaceholderPlugin EffectPlaceholderPlugin = new() {Plugin = CorePlugin, Profiler = CorePlugin.GetProfiler("Feature - Effect Placeholder")};
 

src/Artemis.Core/Services/CoreService.cs

@@ -58,7 +58,6 @@ internal class CoreService : ICoreService
         _scriptingService = scriptingService;
         _loggingLevel = settingsService.GetSetting("Core.LoggingLevel", LogEventLevel.Debug);
         _frameStopWatch = new Stopwatch();
-        StartupArguments = new List<string>();
 
         _rgbService.Surface.Updating += SurfaceOnUpdating;
         _loggingLevel.SettingChanged += (sender, args) => ApplyLoggingLevel();
@@ -78,7 +77,7 @@ internal class CoreService : ICoreService
 
     private void ApplyLoggingLevel()
     {
-        string? argument = StartupArguments.FirstOrDefault(a => a.StartsWith("--logging"));
+        string? argument = Constants.StartupArguments.FirstOrDefault(a => a.StartsWith("--logging"));
         if (argument != null)
         {
             // Parse the provided log level
@@ -194,7 +193,6 @@ internal class CoreService : ICoreService
     public int FrameRate { get; private set; }
     public TimeSpan FrameTime { get; private set; }
     public bool ProfileRenderingDisabled { get; set; }
-    public List<string> StartupArguments { get; set; }
     public bool IsElevated { get; set; }
 
     public void Dispose()
@@ -217,7 +215,7 @@ internal class CoreService : ICoreService
             Constants.BuildInfo.BuildNumber,
             Constants.BuildInfo.SourceBranch
         );
-        _logger.Information("Startup arguments: {args}", StartupArguments);
+        _logger.Information("Startup arguments: {args}", Constants.StartupArguments);
         _logger.Information("Elevated permissions: {perms}", IsElevated);
         _logger.Information("Stopwatch high resolution: {perms}", Stopwatch.IsHighResolution);
 
@@ -230,9 +228,9 @@ internal class CoreService : ICoreService
 
         // Initialize the services
         _pluginManagementService.CopyBuiltInPlugins();
-        _pluginManagementService.LoadPlugins(StartupArguments, IsElevated);
+        _pluginManagementService.LoadPlugins(IsElevated);
 
-        _rgbService.ApplyPreferredGraphicsContext(StartupArguments.Contains("--force-software-render"));
+        _rgbService.ApplyPreferredGraphicsContext(Constants.StartupArguments.Contains("--force-software-render"));
         _rgbService.SetRenderPaused(false);
         OnInitialized();
     }

src/Artemis.Core/Services/Interfaces/ICoreService.cs

@@ -27,12 +27,7 @@ public interface ICoreService : IArtemisService, IDisposable
     ///     Gets or sets whether profiles are rendered each frame by calling their Render method
     /// </summary>
     bool ProfileRenderingDisabled { get; set; }
-
-    /// <summary>
-    ///     Gets or sets a list of startup arguments
-    /// </summary>
-    List<string> StartupArguments { get; set; }
-
+    
     /// <summary>
     ///     Gets a boolean indicating whether Artemis is running in an elevated environment (admin permissions)
     /// </summary>

src/Artemis.Core/Services/Interfaces/IPluginManagementService.cs

@@ -26,7 +26,7 @@ public interface IPluginManagementService : IArtemisService, IDisposable
     /// <summary>
     ///     Loads all installed plugins. If plugins already loaded this will reload them all
     /// </summary>
-    void LoadPlugins(List<string> startupArguments, bool isElevated);
+    void LoadPlugins(bool isElevated);
 
     /// <summary>
     ///     Unloads all installed plugins.

src/Artemis.Core/Services/PluginManagementService.cs

@@ -203,17 +203,17 @@ internal class PluginManagementService : IPluginManagementService
 
     #region Plugins
 
-    public void LoadPlugins(List<string> startupArguments, bool isElevated)
+    public void LoadPlugins(bool isElevated)
     {
-        if (startupArguments.Contains("--no-plugins"))
+        if (Constants.StartupArguments.Contains("--no-plugins"))
         {
             _logger.Warning("Artemis launched with --no-plugins, skipping the loading of plugins");
             return;
         }
 
-        bool ignorePluginLock = startupArguments.Contains("--ignore-plugin-lock");
-        bool stayElevated = startupArguments.Contains("--force-elevation");
-        bool droppedAdmin = startupArguments.Contains("--dropped-admin");
+        bool ignorePluginLock = Constants.StartupArguments.Contains("--ignore-plugin-lock");
+        bool stayElevated = Constants.StartupArguments.Contains("--force-elevation");
+        bool droppedAdmin = Constants.StartupArguments.Contains("--dropped-admin");
         if (LoadingPlugins)
             throw new ArtemisCoreException("Cannot load plugins while a previous load hasn't been completed yet.");
 

src/Artemis.Core/Services/WebServer/WebServerService.cs

@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Text;
+using System.Threading;
 using System.Threading.Tasks;
 using Artemis.Core.Modules;
 using EmbedIO;
@@ -17,15 +18,19 @@ internal class WebServerService : IWebServerService, IDisposable
     private readonly List<WebApiControllerRegistration> _controllers;
     private readonly ILogger _logger;
     private readonly List<WebModuleRegistration> _modules;
+    private readonly PluginSetting<bool> _webServerEnabledSetting;
     private readonly PluginSetting<int> _webServerPortSetting;
+    private CancellationTokenSource? _cts;
 
-    public WebServerService(ILogger logger, ISettingsService settingsService, IPluginManagementService pluginManagementService)
+    public WebServerService(ILogger logger, ICoreService coreService, ISettingsService settingsService, IPluginManagementService pluginManagementService)
     {
         _logger = logger;
         _controllers = new List<WebApiControllerRegistration>();
         _modules = new List<WebModuleRegistration>();
 
+        _webServerEnabledSetting = settingsService.GetSetting("WebServer.Enabled", true);
         _webServerPortSetting = settingsService.GetSetting("WebServer.Port", 9696);
+        _webServerEnabledSetting.SettingChanged += WebServerEnabledSettingOnSettingChanged;
         _webServerPortSetting.SettingChanged += WebServerPortSettingOnSettingChanged;
         pluginManagementService.PluginFeatureDisabled += PluginManagementServiceOnPluginFeatureDisabled;
 
@@ -33,9 +38,9 @@ internal class WebServerService : IWebServerService, IDisposable
         StartWebServer();
     }
 
-    protected virtual void OnWebServerStarting()
+    private void WebServerEnabledSettingOnSettingChanged(object? sender, EventArgs e)
     {
-        WebServerStarting?.Invoke(this, EventArgs.Empty);
+        StartWebServer();
     }
 
     private void WebServerPortSettingOnSettingChanged(object? sender, EventArgs e)
@@ -72,14 +77,23 @@ internal class WebServerService : IWebServerService, IDisposable
     public WebServer? Server { get; private set; }
     public PluginsModule PluginsModule { get; }
 
-    public event EventHandler? WebServerStarting;
 
     #region Web server managament
 
     private WebServer CreateWebServer()
     {
-        Server?.Dispose();
-        Server = null;
+        if (Server != null)
+        {
+            if (_cts != null)
+            {
+                _cts.Cancel();
+                _cts = null;
+            }
+
+            Server.Dispose();
+            OnWebServerStopped();
+            Server = null;
+        }
 
         WebApiModule apiModule = new("/", JsonNetSerializer);
         PluginsModule.ServerUrl = $"http://localhost:{_webServerPortSetting.Value}/";
@@ -112,8 +126,20 @@ internal class WebServerService : IWebServerService, IDisposable
     private void StartWebServer()
     {
         Server = CreateWebServer();
+
+        if (!_webServerEnabledSetting.Value)
+            return;
+        
+        if (Constants.StartupArguments.Contains("--disable-webserver"))
+        {
+            _logger.Warning("Artemis launched with --disable-webserver, not enabling the webserver");
+            return;
+        }
+
         OnWebServerStarting();
-        Server.Start();
+        _cts = new CancellationTokenSource();
+        Server.Start(_cts.Token);
+        OnWebServerStarted();
     }
 
     #endregion
@@ -276,4 +302,27 @@ internal class WebServerService : IWebServerService, IDisposable
     }
 
     #endregion
+
+    #region Events
+
+    protected virtual void OnWebServerStopped()
+    {
+        WebServerStopped?.Invoke(this, EventArgs.Empty);
+    }
+
+    protected virtual void OnWebServerStarting()
+    {
+        WebServerStarting?.Invoke(this, EventArgs.Empty);
+    }
+
+    protected virtual void OnWebServerStarted()
+    {
+        WebServerStarted?.Invoke(this, EventArgs.Empty);
+    }
+
+    public event EventHandler? WebServerStopped;
+    public event EventHandler? WebServerStarting;
+    public event EventHandler? WebServerStarted;
+
+    #endregion
 }