refactor: Make youngest failed save store full version number

Author: twpol

Source/Menu/ResumeForm.cs

@@ -90,7 +90,7 @@ public class Save
             public bool IsMultiplayer { get; private set; }
             public bool DbfEval { get; private set; } //Debrief Eval
 
-            public Save(string fileName, string currentBuild, int youngestFailedToResume)
+            public Save(string fileName, string youngestVersionFailedToRestore)
             {
                 File = fileName;
                 System.Threading.Thread.Sleep(10);
@@ -101,7 +101,7 @@ public Save(string fileName, string currentBuild, int youngestFailedToResume)
                         var version = inf.ReadString().Replace("\0", ""); // e.g. "0.9.0.1648" or "X1321" or "" (if compiled locally)
                         var build = inf.ReadString().Replace("\0", ""); // e.g. 0.0.5223.24629 (2014-04-20 13:40:58Z)
                         var versionOrBuild = version.Length > 0 ? version : build;
-                        var valid = VersionInfo.GetValidity(version, build, youngestFailedToResume);
+                        var valid = VersionInfo.GetValidity(version, build, youngestVersionFailedToRestore);
                         // Read in multiplayer flag/ route/activity/path/player data.
                         // Done so even if not elegant to be compatible with existing save files
                         var routeNameOrMultipl = inf.ReadString();
@@ -213,7 +213,6 @@ void LoadSaves()
             {
                 var saves = new List<Save>();
                 var directory = UserSettings.UserDataFolder;
-                var build = VersionInfo.Build.Contains(" ") ? VersionInfo.Build.Substring(VersionInfo.Build.IndexOf(" ") + 1) : null;
                 var prefix = String.Empty;
 
                 if (SelectedAction == MainForm.UserAction.SinglePlayerTimetableGame)
@@ -244,7 +243,7 @@ void LoadSaves()
                             // SavePacks are all in the same folder and activities may have the same name 
                             // (e.g. Short Passenger Run shrtpass.act) but belong to a different route,
                             // so pick only the activities for the current route.
-                            var save = new Save(saveFile, build, Settings.YoungestFailedToRestore);
+                            var save = new Save(saveFile, Settings.YoungestVersionFailedToRestore);
                             if (save.RouteName == Route.Name)
                             {
                                 if (!save.IsMultiplayer ^ Multiplayer)
@@ -447,11 +446,10 @@ void buttonDeleteInvalid_Click(object sender, EventArgs e)
             var directory = UserSettings.UserDataFolder;
             if (Directory.Exists(directory))
             {
-                var build = VersionInfo.Build.Contains(" ") ? VersionInfo.Build.Substring(VersionInfo.Build.IndexOf(" ") + 1) : null;
                 var deletes = 0;
                 foreach (var saveFile in Directory.GetFiles(directory, "*.save"))
                 {
-                    var save = new Save(saveFile, build, Settings.YoungestFailedToRestore);
+                    var save = new Save(saveFile, Settings.YoungestVersionFailedToRestore);
                     if (save.Valid == false)
                     {
                         foreach (var fileName in new[] { 

Source/ORTS.Common/VersionInfo.cs

@@ -29,76 +29,42 @@ namespace ORTS.Common
     public static class VersionInfo
     {
         static readonly string ApplicationPath = Path.GetDirectoryName(Process.GetCurrentProcess().MainModule.FileName);
-        // GetRevision() must come before GetVersion()
-        /// <summary>Revision number, e.g. Release: "1648",       experimental: "1649",   local: ""</summary>
-        public static readonly string Revision = GetRevision("Revision.txt");
-        /// <summary>Full version number, e.g. Release: "0.9.0.1648", experimental: "X.1649", local: ""</summary>
-        public static readonly string Version = GetVersion("Version.txt");
-        /// <summary>Full build number, e.g. "0.0.5223.24629 (2014-04-20 13:40:58Z)"</summary>
-        public static readonly string Build = GetBuild("ORTS.Common.dll", "OpenRails.exe", "Menu.exe", "RunActivity.exe");
+
+        /// <summary>Full version, e.g. stable: "1.4", testing: "T1.4-1-g1234567", unstable: "U2021.01.01-0000", local: ""</summary>
+        public static readonly string Version = GetVersion("OpenRails.exe");
+
+        /// <summary>Full build, e.g. "0.0.5223.24629 (2014-04-20 13:40:58Z)"</summary>
+        public static readonly string Build = GetBuild("OpenRails.exe");
+
         /// <summary>Version, but if "", returns Build</summary>
         public static readonly string VersionOrBuild = GetVersionOrBuild();
 
-        static string GetRevision(string fileName)
-        {
-            try
-            {
-                using (var f = new StreamReader(Path.Combine(ApplicationPath, fileName)))
-                {
-                    var revision = f.ReadLine().Trim();
-                    if (revision.StartsWith("$Revision:") && revision.EndsWith("$"))
-                    {
-                        if (!revision.Contains(" 000 "))
-                            return revision.Substring(10, revision.Length - 11).Trim();
-                    }
-                    else
-                    {
-                        return revision;
-                    }
-                }
-            }
-            catch
-            {
-            }
-            return "";
-        }
-
         static string GetVersion(string fileName)
         {
             try
             {
-                using (var f = new StreamReader(Path.Combine(ApplicationPath, fileName)))
-                {
-                    var version = f.ReadLine().Trim();
-                    if (!String.IsNullOrEmpty(Revision))
-                        return version + "-" + Revision;
-                }
+                var version = FileVersionInfo.GetVersionInfo(Path.Combine(ApplicationPath, fileName));
+                if (version.ProductVersion != version.FileVersion)
+                    return version.ProductVersion;
             }
             catch
             {
             }
             return "";
         }
 
-        static string GetBuild(params string[] fileNames)
+        static string GetBuild(string fileName)
         {
             var builds = new Dictionary<TimeSpan, string>();
-            foreach (var fileName in fileNames)
+            try
             {
-                try
-                {
-                    var version = FileVersionInfo.GetVersionInfo(Path.Combine(ApplicationPath, fileName));
-                    builds.Add(new TimeSpan(version.ProductBuildPart, 0, 0, version.ProductPrivatePart * 2), version.ProductVersion);
-                }
-                catch
-                {
-                }
+                var version = FileVersionInfo.GetVersionInfo(Path.Combine(ApplicationPath, fileName));
+                var datetime = new DateTime(2000, 1, 1, 0, 0, 0, DateTimeKind.Utc);
+                var timespan = new TimeSpan(version.FileBuildPart, 0, 0, version.FilePrivatePart * 2);
+                return String.Format("{0} ({1:u})", version.FileVersion, datetime + timespan);
             }
-            if (builds.Count > 0)
+            catch
             {
-                var datetime = new DateTime(2000, 1, 1, 0, 0, 0, DateTimeKind.Utc);
-                var timespan = builds.Keys.OrderBy(ts => ts).Last();
-                return String.Format("{0} ({1:u})", builds[timespan], datetime + timespan);
             }
             return "";
         }
@@ -109,70 +75,62 @@ static string GetVersionOrBuild()
         }
 
         /// <summary>
-        /// Find whether a requested version and build are valid for this build 
+        /// Compares a version and build with the youngest version which failed to restore, to see if that version/build is likely to restore successfully
         /// </summary>
-        /// <param name="version">version to test again</param>
-        /// <param name="build">build to test again</param>
-        /// <param name="youngestFailedToResume">youngest build that failed to resume</param>
+        /// <param name="version">version to test</param>
+        /// <param name="build">build to test</param>
+        /// <param name="youngestVersionFailedToRestore">youngest version that failed to restore</param>
         /// <returns>true or false when able to determine validity, null otherwise</returns>
-        public static bool? GetValidity(string version, string build, int youngestFailedToResume)
+        public static bool? GetValidity(string version, string build, string youngestVersionFailedToRestore)
         {
-            int revision = GetRevisionFromVersion(version);
-            int programRevision = 0;
-            try  // as Convert.ToInt32() can fail and version may be ""
-            {
-                programRevision = Convert.ToInt32(VersionInfo.Revision);
-            }
-            catch { } // ignore errors
-            //MessageBox.Show(String.Format("VersionInfo.Build = {0}, build = {1}, version = {2}, youngestFailedToResume = {3}", VersionInfo.Build, build, Version, youngestFailedToResume));
-            if (revision != 0)  // compiled remotely by Open Rails
-            {
-                if (revision == programRevision)
-                {
-                    return true;
-                }
-                else
-                {
-                    if (revision > youngestFailedToResume        // 1. Normal situation
-                    || programRevision < youngestFailedToResume) // 2. If an old version of OR is used, then attempt to load Saves
-                                                                 //    which would be blocked by the current version of OR
-                    {
-                        return null;
-                    }
-                }
-            }
-            else  // compiled locally
-            {
-                if (build.EndsWith(VersionInfo.Build))
-                {
-                    return true;
-                }
-                else
-                {
-                    return null;
-                }
-            }
-            return false; // default validity
+            // Validity rules:
+            //  - Same version and build --> yes
+            //  - Same non-empty version --> yes
+            //  - Unable to parse save or program version --> maybe
+            //  - Save version > setting --> maybe
+            //  - Program version < setting --> maybe
+            //  - Default --> no
+
+            if (Version == version && Build == build) return true;
+            if (Version.Length > 0 && version.Length > 0 && Version == version) return true;
+            var saveVersion = ParseVersion(version);
+            var programVersion = ParseVersion(Version);
+            var settingVersion = ParseVersion(youngestVersionFailedToRestore);
+            if (saveVersion.Major == 0 || programVersion.Major == 0) return null;
+            if (saveVersion > settingVersion) return null;
+            if (programVersion < settingVersion) return null;
+            return false;
         }
 
         /// <summary>
-        /// Find the revision number (e.g. 1648) from the full version (e.g. 0.9.0.1648 or X.1648 or X1648)
+        /// Converts many possible Open Rails versions into a standard Version struct
         /// </summary>
-        /// <param name="version">full version</param>
-        public static int GetRevisionFromVersion(string fullVersion)
+        /// <param name="version">text version to parse</param>
+        public static Version ParseVersion(string version)
         {
-            var versionParts = fullVersion.Split('.');
-            var revision = 0;
-            try
-            {
-                var version = versionParts[versionParts.Length - 1];
-                if (version.StartsWith("X"))
-                    version = version.Substring(1);
-                // Might throw an error if it isn't a number like we expect.
-                revision = Convert.ToInt32(version);
-            }
-            catch { }
-            return revision;
+            // Version numbers which we do parse:
+            //  - 0.9.0.1648            --> 0.9
+            //  - 1.3.1.4328            --> 1.3.1
+            //  - T1.3.1-241-g6ff150c21 --> 1.3.1.241
+            //  - X1.3.1-370-g7df5318c2 --> 1.3.1.370
+            //  - 1.4                   --> 1.4
+            //  - 1.4-rc1               --> 1.4
+            //  - T1.4-2-g7db094316     --> 1.4.0.2
+            // Version numbers which we do NOT parse:
+            //  - U2019.07.25-2200
+            //  - U2021.06.25-0406
+            //  - X.1648
+            //  - X1648
+
+            if (version.StartsWith("T") || version.StartsWith("X")) version = version.Substring(1);
+
+            var versionParts = version.Split('-');
+            if (!System.Version.TryParse(versionParts[0], out var parsedVersion)) return new Version();
+
+            var commits = 0;
+            if (versionParts.Length > 1) int.TryParse(versionParts[1], out commits);
+            // parsedVersion.Build will be -1 if the version only has major and minor, but we need the build number >= 0 here
+            return new Version(parsedVersion.Major, parsedVersion.Minor, Math.Max(0, parsedVersion.Build), commits);
         }
     }
 }

Source/ORTS.Settings/UserSettings.cs

@@ -329,8 +329,8 @@ public enum Menu_SelectionIndex
         public string AvatarURL { get; set; }
         [Default(false)]
         public bool ShowAvatar { get; set; }
-        [Default(0)] // Do not offer to restore/resume any saves this age or older. Updated whenever a younger save fails to restore.
-        public int YoungestFailedToRestore { get; set; }
+        [Default("0.0")] // Do not offer to restore/resume any saves this version or older. Updated whenever a younger save fails to restore.
+        public string YoungestVersionFailedToRestore { get; set; }
 
         // Internal settings:
         [Default(false)]

Source/RunActivity/Viewer3D/Processes/GameStateRunActivity.cs

@@ -420,14 +420,12 @@ void Resume(UserSettings settings, string[] args)
 
             // First use the .save file to check the validity and extract the route and activity.
             var saveFile = GetSaveFile(args);
-            var versionOrBuild = "";
-            var saveRevision = 0;
+            var versionAndBuild = new[] { "", "", "" };
             using (BinaryReader inf = new BinaryReader(new FileStream(saveFile, FileMode.Open, FileAccess.Read)))
             {
                 try // Because Restore() methods may try to read beyond the end of an out of date file.
                 {
-                    versionOrBuild = GetValidSaveVersionOrBuild(settings, saveFile, inf);
-                    saveRevision = VersionInfo.GetRevisionFromVersion(versionOrBuild);
+                    versionAndBuild = GetValidSaveVersionAndBuild(settings, saveFile, inf);
 
                     var values = GetSavedValues(inf);
                     Acttype = values.acttype;
@@ -486,23 +484,25 @@ void Resume(UserSettings settings, string[] args)
                 }
                 catch (Exception error)
                 {
-                    if (versionOrBuild == VersionInfo.VersionOrBuild)
+                    if (versionAndBuild[2] == VersionInfo.VersionOrBuild)
                     {
                         // If the save version is the same as the program version, we can't be an incompatible save - it's just a bug.
                         throw;
                     }
                     else
                     {
-                        if (saveRevision > settings.YoungestFailedToRestore)
+                        var parsedSaveVersion = VersionInfo.ParseVersion(versionAndBuild[0]);
+                        var parsedSettingVersion = VersionInfo.ParseVersion(settings.YoungestVersionFailedToRestore);
+                        if (parsedSaveVersion > parsedSettingVersion)
                         {
-                            settings.YoungestFailedToRestore = saveRevision;
-                            settings.Save("YoungestFailedToRestore");
-                            Trace.TraceInformation("YoungestFailedToRestore set to Save's revision: {0}", saveRevision);
+                            settings.YoungestVersionFailedToRestore = versionAndBuild[0];
+                            settings.Save("YoungestVersionFailedToRestore");
+                            Trace.TraceInformation("YoungestVersionFailedToRestore set to Save version: {0}", versionAndBuild[0]);
                         }
                         // Rethrow the existing error if it is already an IncompatibleSaveException.
                         if (error is IncompatibleSaveException)
                             throw;
-                        throw new IncompatibleSaveException(saveFile, versionOrBuild, error);
+                        throw new IncompatibleSaveException(saveFile, versionAndBuild[2], error);
                     }
                 }
 
@@ -610,7 +610,7 @@ void ReplayFromSave(UserSettings settings, string[] args)
                 // Resume from previous SaveFile and then replay
                 using (var inf = new BinaryReader(new FileStream(previousSaveFile, FileMode.Open, FileAccess.Read)))
                 {
-                    GetValidSaveVersionOrBuild(settings, saveFile, inf);
+                    GetValidSaveVersionAndBuild(settings, saveFile, inf);
 
                     var values = GetSavedValues(inf);
                     InitSimulator(settings, values.args, "Resume", values.acttype);
@@ -629,12 +629,12 @@ void ReplayFromSave(UserSettings settings, string[] args)
             Game.ReplaceState(new GameStateViewer3D(Viewer));
         }
 
-        static string GetValidSaveVersionOrBuild(UserSettings settings, string saveFile, BinaryReader inf)
+        static string[] GetValidSaveVersionAndBuild(UserSettings settings, string saveFile, BinaryReader inf)
         {
             var version = inf.ReadString().Replace("\0", ""); // e.g. "0.9.0.1648" or "X1321" or "" (if compiled locally)
             var build = inf.ReadString().Replace("\0", ""); // e.g. 0.0.5223.24629 (2014-04-20 13:40:58Z)
             var versionOrBuild = version.Length > 0 ? version : build;
-            var valid = VersionInfo.GetValidity(version, build, settings.YoungestFailedToRestore);
+            var valid = VersionInfo.GetValidity(version, build, settings.YoungestVersionFailedToRestore);
             if (valid == false) // This is usually detected in ResumeForm.cs but a Resume can also be launched from the command line.
                 throw new IncompatibleSaveException(saveFile, versionOrBuild);
             if (valid == null)
@@ -645,7 +645,7 @@ static string GetValidSaveVersionOrBuild(UserSettings settings, string saveFile,
                     + "Please do not report any problems that may result.\n",
                     Application.ProductName, versionOrBuild, VersionInfo.VersionOrBuild);
             }
-            return versionOrBuild;
+            return new[] { version, build, versionOrBuild };
         }
 
         /// <summary>