Merge pull request #599 from cjakeman/menu-option02l

02l: Removes web-server option. Now always available.

Author: cjakeman

Source/Documentation/Manual/options.rst

@@ -142,14 +142,12 @@ Disable TCS scripts
 This option disables the train control system scripts for locomotives where
 these have been implemented.
 
-Enable web server
+Web server port
 -----------------
 
-This option enables an internal web server that can be used to display game and
-train status information in a web browser, intended for use on secondary screens.
-
-When activated, the server can be accessed from a browser on the local machine at
+The web server can be accessed from a browser on the local machine at
 ``http://localhost:<port>``, where ``<port>`` is the specified port number.
+Change the default value of 2150 if it conflicts with other services.
 
 If you `open
 <https://www.howtogeek.com/394735/how-do-i-open-a-port-on-windows-firewall/>`_

Source/Menu/Options.Designer.cs

@@ -150,7 +150,6 @@ public OptionsForm(UserSettings settings, UpdateManager updateManager, bool init
             comboPressureUnit.Text = Settings.PressureUnit;
             comboOtherUnits.Text = settings.Units;
             checkDisableTCSScripts.Checked = Settings.DisableTCSScripts;
-            checkEnableWebServer.Checked = Settings.WebServer;
             numericWebServerPort.Value = Settings.WebServerPort;
 
             // Audio tab
@@ -431,7 +430,7 @@ void buttonOK_Click(object sender, EventArgs e)
             Settings.PressureUnit = comboPressureUnit.SelectedValue.ToString();
             Settings.Units = comboOtherUnits.SelectedValue.ToString();
             Settings.DisableTCSScripts = checkDisableTCSScripts.Checked;
-            Settings.WebServer = checkEnableWebServer.Checked;
+            Settings.WebServerPort = (int)numericWebServerPort.Value;
 
             // Audio tab
             Settings.SoundVolumePercent = (int)numericSoundVolumePercent.Value;
@@ -820,7 +819,6 @@ private void InitializeHelpIcons()
                 (pbPressureUnit, new Control[] { labelPressureUnit, comboPressureUnit }),
                 (pbOtherUnits, new Control[] { labelOtherUnits, comboOtherUnits }),
                 (pbDisableTcsScripts, new[] { checkDisableTCSScripts }),
-                (pbEnableWebServer, new[] { checkEnableWebServer }),
                 (pbOverspeedMonitor, new[] { checkOverspeedMonitor }),
             };
             foreach ((PictureBox pb, Control[] controls) in helpIconControls)
@@ -878,10 +876,6 @@ private void HelpIcon_Click(object sender, EventArgs _)
                     pbDisableTcsScripts,
                     baseUrl + "/options.html#disable-tcs-scripts"
                 },
-                {
-                    pbEnableWebServer,
-                    baseUrl + "/options.html#enable-web-server"
-                },
                 {
                     pbOverspeedMonitor,
                     baseUrl + "/options.html#overspeed-monitor"

Source/Menu/Options.cs

@@ -153,9 +153,6 @@ public enum DirectXFeature
         public bool IsModeActivity { get; set; } // false indicates Timetable mode
 
         // General settings:
-
-        [Default(false)]
-        public bool WebServer { get; set; }
         [Default(2150)]
         public int WebServerPort { get; set; }
 

Source/ORTS.Settings/UserSettings.cs

@@ -26,6 +26,9 @@
 using System.IO;
 using System.Windows.Forms;
 using CancellationTokenSource = System.Threading.CancellationTokenSource;
+using System.Net.Sockets;
+using System.Diagnostics;
+using System;
 
 namespace Orts.Viewer3D.Processes
 {
@@ -60,13 +63,25 @@ void WebServerThread()
         {
             Profiler.SetThread();
             Game.SetThreadLanguage();
-            if (!Game.Settings.WebServer)
-                return;
 
             string myWebContentPath = Path.Combine(Path.GetDirectoryName(Application.ExecutablePath), "Content\\Web");
             EndPointManager.UseIpv6 = true;
-            using (EmbedIO.WebServer server = WebServer.CreateWebServer($"http://*:{Game.Settings.WebServerPort}", myWebContentPath))
-                server.RunAsync(StopServer.Token).Wait();
+            try
+            {
+                using (EmbedIO.WebServer server = WebServer.CreateWebServer($"http://*:{Game.Settings.WebServerPort}", myWebContentPath))
+                    server.RunAsync(StopServer.Token).Wait();
+            }
+            catch(AggregateException ex)
+            {
+                if (ex.InnerException is SocketException)
+                {
+                    Trace.TraceWarning($"Port {Game.Settings.WebServerPort} is already in use. Continuing without webserver");
+                }
+                else
+                {
+                    throw ex;
+                }
+            }
         }
     }
 }