Merge pull request #1001 from twpol/feature/telemetry-menu

Telemetry collection and menu options #or-telemetry-system

Author: cjakeman

Source/Contrib/DataCollector/Program.cs

@@ -29,7 +29,7 @@ class Program
         static void Main(string[] args)
         {
             if (args.Contains("/system", StringComparer.OrdinalIgnoreCase))
-                SystemInfo.WriteSystemDetails(Console.Out);
+                CollectSystem();
             else if (args.Contains("/tile-terrtex", StringComparer.OrdinalIgnoreCase))
                 CollectTileTerrtex(args);
             else
@@ -53,6 +53,12 @@ static void ShowHelp()
             Console.WriteLine("  /help          Show help and usage information");
         }
 
+        static void CollectSystem()
+        {
+            Console.Error.WriteLine("Collecting information...");
+            SystemInfo.WriteSystemDetails(Console.Out);
+        }
+
         struct TileTerrtexDirectory
         {
             public string Path;

Source/Contrib/SimulatorTester/UserSettings.cs

@@ -16,7 +16,7 @@
 // along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
 
 using System.Collections.Generic;
-using ORTS.Settings;
+using ORTS.Common;
 
 namespace SimulatorTester
 {

Source/Documentation/Manual/images/options-general.png

@@ -129,6 +129,40 @@ Otherwise, if the loco has an Overspeed Monitor specified in its ENG file, then
 
 This monitor is enabled by checking the option.
 
+
+.. _telemetry:
+
+Telemetry
+---------
+
+.. image:: images/options-telemetry.png
+
+These options let you choose which (if any) anonymous data collection types you would like to enable, preview the data that will be collected, and visit the `telemetry server and source code <https://telemetry.openrails.org>`_.
+
+Each anonymous data collection type can be set to:
+
+- **Undecided (off)** - (default) no data is collected or sent, but we may ask if you want to participate via :ref:`notifications`
+- **Off** - no data is collected or sent
+- **On** - data is collected and sent automatically
+
+There is no option to allow you to check through the collected data before it is sent.
+
+Application, runtime, operating system, and hardware properties
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+This anonymous data collection type can be previewed to see what will be sent; for example::
+
+  Application = Open Rails U2025.01.31-1152 (X64)
+  Runtime     = .NET Framework 4.8.9290.0
+  System      = Microsoft Windows 11 Home 10.0.26100 (X64; en-GB; en-GB,en-US,ja-JP)
+  Memory      = 32,592 MB
+  CPU         = 12th Gen Intel(R) Core(TM) i7-1255U (GenuineIntel; 12 threads; 2,600 MHz)
+  GPU         = Intel(R) Iris(R) Xe Graphics (Intel Corporation; 128 MB)
+  Direct3D    = 12_1,12_0,11_1,11_0,10_1,10_0,9_3,9_2,9_1
+
+This is also included at the start of every :ref:`log file <driving-logfile>`.
+
+
 Audio Options
 =============
 

Source/Documentation/Manual/images/options-telemetry.png

@@ -1,4 +1,4 @@
-// COPYRIGHT 2009, 2010, 2011, 2012, 2013, 2014, 2015 by the Open Rails project.
+// COPYRIGHT 2009 - 2024 by the Open Rails project.
 // 
 // This file is part of Open Rails.
 // 
@@ -56,6 +56,7 @@ public enum UserAction
 
         bool Initialized;
         UserSettings Settings;
+        TelemetryManager TelemetryManager;
         List<Folder> Folders = new List<Folder>();
         public List<Route> Routes = new List<Route>();
         List<Activity> Activities = new List<Activity>();
@@ -149,6 +150,7 @@ void MainForm_Shown(object sender, EventArgs e)
         {
             var options = Environment.GetCommandLineArgs().Where(a => (a.StartsWith("-") || a.StartsWith("/"))).Select(a => a.Substring(1));
             Settings = new UserSettings(options);
+            TelemetryManager = new TelemetryManager(Settings.Telemetry);
 
             Cursor = Cursors.Default;
 
@@ -266,6 +268,7 @@ orderby tool.Text
             ShowTimetableEnvironment();
 
             CheckForUpdate();
+            CheckForTelemetry();
 
             if (!Initialized)
             {
@@ -345,6 +348,21 @@ public virtual void OnCheckUpdatesAgain(EventArgs e)
             CheckForUpdate();
         }
 
+        void CheckForTelemetry()
+        {
+            // DO NOT await this call as we want it to run in the background
+            _ = TelemetryManager.SubmitIfDue(TelemetryType.System, () => new
+            {
+                SystemInfo.Application,
+                SystemInfo.Runtime,
+                SystemInfo.OperatingSystem,
+                SystemInfo.InstalledMemoryMB,
+                SystemInfo.CPUs,
+                SystemInfo.GPUs,
+                SystemInfo.Direct3DFeatureLevels
+            });
+        }
+
         void LoadLanguage()
         {
             if (Settings.Language.Length > 0)
@@ -543,10 +561,15 @@ void testingToolStripMenuItem_Click(object sender, EventArgs e)
         }
 
         void buttonOptions_Click(object sender, EventArgs e)
+        {
+            ShowOptionsDialog();
+        }
+
+        public void ShowOptionsDialog()
         {
             SaveOptions();
 
-            using (var form = new OptionsForm(Settings, UpdateManager, BaseDocumentationUrl))
+            using (var form = new OptionsForm(Settings, UpdateManager, TelemetryManager, BaseDocumentationUrl))
             {
                 switch (form.ShowDialog(this))
                 {
@@ -560,7 +583,15 @@ void buttonOptions_Click(object sender, EventArgs e)
                 }
             }
         }
-        
+
+        public void ShowTelemetryDialog()
+        {
+            using (var telemetryForm = new TelemetryForm(TelemetryManager))
+            {
+                telemetryForm.ShowDialog(this);
+            }
+        }
+
         void buttonDownloadContent_Click(object sender, EventArgs e)
         {
             using (var form = new ContentForm(Settings, BaseDocumentationUrl))

Source/Documentation/Manual/options.rst

@@ -1,4 +1,4 @@
-// COPYRIGHT 2009 - 2024 by the Open Rails project.
+// COPYRIGHT 2009 - 2024 by the Open Rails project.
 // 
 // This file is part of Open Rails.
 // 
@@ -128,6 +128,7 @@ public void CheckNotifications()
             }
             catch (Exception ex)
             {
+                AppendToLog(ex.ToString());
                 Error = ex;
             }
         }
@@ -224,6 +225,10 @@ public void PopulatePage()
             {
                 PopulateRetryPage();
             }
+            else if (Notifications.NotificationList.Count == 0)
+            {
+                PopulateEmptyPage();
+            }
             else
             {
                 Settings.LastViewNotificationDate = $"{DateTime.Today:yyyy-MM-dd}";
@@ -268,6 +273,15 @@ private void PopulateRetryPage()
             Page.NDetailList.Add(new NRetryControl(Page, "Retry", 140, "Try again to fetch notifications", MainForm));
         }
 
+        private void PopulateEmptyPage()
+        {
+            NewPages.Count = 0;
+
+            // Reports no notifications.
+            var today = DateTime.Now.Date;
+            Page.NDetailList.Add(new NTitleControl(Panel, 1, 1, $"{today:dd-MMM-yy}", "No notifications"));
+        }
+
         #region Process Criteria
         private bool AreNotificationChecksMet(Notification notification)
         {
@@ -356,35 +370,12 @@ private bool CheckAllMatch(List<Criteria> criteriaList)
         {
             foreach (var c in criteriaList)
             {
-                if (c is Contains) // other criteria might be added such as NoLessThan and NoMoreThan.
-                {
-                    if (CheckContains(c, true) == false) return false;
-                }
-                if (c is NotContains)
-                {
-                    if (CheckContains(c, false) == false) return false;
-                }
+                var result = c.IsMatch();
+                AppendToLog($"Check: {result}: '{c.Property}' {c.GetType().Name} '{c.Value}'");
+                if (!result) return false;
             }
             return true;
         }
-
-        /// <summary>
-        /// Returns true if a match is found and sense = true. For NotContains, use sense = false.
-        /// </summary>
-        /// <param name="criteria"></param>
-        /// <param name="sense"></param>
-        /// <returns></returns>
-        private bool CheckContains(Criteria criteria, bool sense)
-        {
-            // If Property was a parameter, then use the expansion
-            var content = ParameterDictionary.ContainsKey(criteria.Property)
-                ? ParameterDictionary[criteria.Property]
-                : criteria.Property;
-
-            var result = content.IndexOf(criteria.Value, StringComparison.OrdinalIgnoreCase) > -1 == sense;
-            LogCheckContains(criteria.Value, sense, content, result);
-            return result;
-        }
         #endregion
 
         private void AddItemToPage(NotificationPage page, Item item)
@@ -401,6 +392,10 @@ private void AddItemToPage(NotificationPage page, Item item)
                     Page.NDetailList.Add(new NLinkControl(Page, item.Label, item.Indent, link.Value, MainForm, url));
                 }
             }
+            else if (item is Dialog dialog)
+            {
+                Page.NDetailList.Add(new NDialogControl(Page, item.Label, item.Indent, dialog.Value, MainForm, dialog.Form));
+            }
             else if (item is Update update)
             {
                 Page.NDetailList.Add(new NUpdateControl(Page, item.Label, item.Indent, update.Value, MainForm));
@@ -586,12 +581,20 @@ private bool ContainsParameter(string field)
         /// <returns></returns>
         string GetSetting(string settingText)
         {
-            var nameArray = settingText.Split('.'); // 2 elements: "Settings.<property>", e.g. "SimpleControlPhysics" 
-            if (nameArray[0] == "Settings" && nameArray.Length == 2)
+            // 2 elements: "Settings.<property>", e.g. "SimpleControlPhysics" 
+            // 3 elements: "Settings.<group>.<property>", e.g. "Telemetry.RandomNumber1000"
+            var nameArray = settingText.Split('.');
+            if (nameArray.Length < 2 || nameArray[0] != "Settings") return "";
+
+            var value = (object)Settings;
+            for (var i = 1; i < nameArray.Length; i++)
             {
-                return Settings.GetType().GetProperty(nameArray[1])?.GetValue(Settings).ToString() ?? "";
+                var prop = value.GetType().GetProperty(nameArray[i]);
+                if (prop == null) return "";
+                value = prop.GetValue(value);
             }
-            return "";
+            if (value is DateTime dateTime) return dateTime.ToString("yyyy-MM-dd");
+            return value?.ToString() ?? "";
         }
 
         private string GetInstalledRoutes()
@@ -648,7 +651,7 @@ public void ChangePage(int step)
         }
 
         #region Logging
-        public void LogOverrideParameters()
+        void LogOverrideParameters()
         {
             if (Log == false) return;
 
@@ -660,7 +663,7 @@ public void LogOverrideParameters()
             }
         }
 
-        public void LogParameters()
+        void LogParameters()
         {
             if (Log == false) return;
 
@@ -672,18 +675,12 @@ public void LogParameters()
             }
         }
 
-        public void LogNotification(Notification n)
+        void LogNotification(Notification n)
         {
             AppendToLog($"\r\nNotification: {n.Title}");
         }
 
-        public void LogCheckContains(string value, bool sense, string content, bool result)
-        {
-            var negation = sense ? "" : "NOT ";
-            AppendToLog($"Check: {result} = '{value}' {negation}contained in '{content}'");
-        }
-
-        public void AppendToLog(string record)
+        void AppendToLog(string record)
         {
             if (Log == false) return;
 

Source/Menu/MainForm.cs

@@ -80,7 +80,8 @@ private void AddPageCountAndArrows(NotificationManager manager)
             Panel.Controls.Add(pageCountControl);
         }
 
-        public class Arrow : Button {
+        public class Arrow : Button
+        {
             public Arrow(Panel panel, Image image, bool visible, bool enabled, int indentRight)
             {
                 Margin = new Padding(0);
@@ -182,8 +183,10 @@ public class NButtonControl : NDetail
         {
             public static int ButtonCount = 0;
             public Button Button;
+            protected MainForm MainForm;
             public NButtonControl(Panel panel, string legend, int width, string description, MainForm mainForm)
             {
+                MainForm = mainForm;
                 var buttonLeft = LeftPaddingIndented;
                 Button = new Button
                 {
@@ -244,6 +247,30 @@ public NLinkControl(NotificationPage page, string legend, int width, string desc
                 ButtonCount++;
             }
         }
+        public class NDialogControl : NButtonControl
+        {
+            public string Form;
+            public NDialogControl(NotificationPage page, string legend, int width, string description, MainForm mainForm, string form)
+            : base(page.Panel, legend, width, description, mainForm)
+            {
+                Form = form;
+                page.ButtonDictionary.Add(ButtonCount, this);
+                ButtonCount++;
+            }
+
+            public void Show()
+            {
+                switch (Form)
+                {
+                    case "OptionsForm":
+                        MainForm.ShowOptionsDialog();
+                        break;
+                    case "TelemetryForm":
+                        MainForm.ShowTelemetryDialog();
+                        break;
+                }
+            }
+        }
         public class NUpdateControl : NButtonControl
         {
             public NUpdateControl(NotificationPage page, string legend, int width, string description, MainForm mainForm)
@@ -267,6 +294,8 @@ public void DoButton(UpdateManager updateManager, int key)
             var button = ButtonDictionary[key];
             if (button is NLinkControl)
                 Process.Start(((NLinkControl)button).Url);
+            else if (button is NDialogControl dialogControl)
+                dialogControl.Show();
             else if (button is NUpdateControl)
                 updateManager.Update();
             else if (button is NRetryControl)