Merge pull request #538 from pzgulyas/preprocesspaths

Delete binary paths if the ascii version or the tdb was modified. Blueprint: https://blueprints.launchpad.net/or/+spec/binary-timetable-paths

Author: cjakeman

Source/Documentation/Manual/timetable.rst

@@ -303,11 +303,9 @@ Special Rows
   will read that path. If not, it will read the 'normal' path, and will then 
   store this as binary for future use. Binary paths are stored in a subdirectory 
   named ``OpenRails`` which must be created in the Paths directory of the route.
-  
-  **Important:**
 
-    - If a path is edited, the binary version must be deleted manually, otherwise the program will still use this older version.
-    - If a route is edited, such that the .tdb might have been changed, all binary paths must be deleted.
+  Note: If a path or the route is edited, then the binary data will be out of date.
+  If so, it is deleted and re-created automatically when the user starts the route.
 
 - ``#consist`` row 
 

Source/Orts.Formats.Msts/TrackDatabaseFile.cs

@@ -39,6 +39,11 @@ public class TrackDatabaseFile
         /// </summary>
         public TrackDB TrackDB { get; set; }
 
+        /// <summary>
+        /// The .tdb file last modified time is stored for being able to validate derived files such as binary paths.
+        /// </summary>
+        public DateTime LastWriteTime { get; }
+
         /// <summary>
         /// Constructor from file
         /// </summary>
@@ -49,6 +54,8 @@ public TrackDatabaseFile(string filenamewithpath)
                 stf.ParseFile(new STFReader.TokenProcessor[] {
                     new STFReader.TokenProcessor("trackdb", ()=>{ TrackDB = new TrackDB(stf); }),
                 });
+
+            LastWriteTime = File.GetLastWriteTime(filenamewithpath);
         }
 
         /// <summary>

Source/Orts.Simulation/Simulation/Timetables/ProcessTimetable.cs

@@ -1160,7 +1160,7 @@ public bool PreProcessRoutes(CancellationToken cancellation)
             {
                 // read route
                 bool pathValid = true;
-                AIPath newPath = LoadPath(thisRoute, out pathValid);
+                LoadPath(thisRoute, out pathValid);
                 if (!pathValid) allPathsLoaded = false;
                 if (cancellation.IsCancellationRequested)
                     return (false);
@@ -1187,23 +1187,23 @@ public AIPath LoadPath(string pathstring, out bool validPath)
             if (String.IsNullOrEmpty(pathExtension))
                 formedpathFilefull = Path.ChangeExtension(formedpathFilefull, "pat");
 
-            // try to load binary path if required
-            bool binaryloaded = false;
-            AIPath outPath = null;
-
-            if (Paths.ContainsKey(formedpathFilefull))
-            {
-                outPath = new AIPath(Paths[formedpathFilefull]);
-            }
-            else
+            if (!Paths.TryGetValue(formedpathFilefull, out var outPath))
             {
+                // try to load binary path if required
+                bool binaryloaded = false;
                 string formedpathFilefullBinary = Path.Combine(Path.GetDirectoryName(formedpathFilefull), "OpenRails");
                 formedpathFilefullBinary = Path.Combine(formedpathFilefullBinary, Path.GetFileNameWithoutExtension(formedpathFilefull));
                 formedpathFilefullBinary = Path.ChangeExtension(formedpathFilefullBinary, "or-binpat");
 
-                if (BinaryPaths)
+                if (BinaryPaths && File.Exists(formedpathFilefullBinary))
                 {
-                    if (File.Exists(formedpathFilefullBinary))
+                    var binaryLastWriteTime = File.GetLastWriteTime(formedpathFilefullBinary);
+                    if (binaryLastWriteTime < simulator.TDB.LastWriteTime ||
+                        File.Exists(formedpathFilefull) && binaryLastWriteTime < File.GetLastWriteTime(formedpathFilefull))
+                    {
+                        File.Delete(formedpathFilefullBinary);
+                    }
+                    else
                     {
                         try
                         {
@@ -1213,7 +1213,7 @@ public AIPath LoadPath(string pathstring, out bool validPath)
 
                             if (outPath.Nodes != null)
                             {
-                                Paths.Add(formedpathFilefull, new AIPath(outPath));
+                                Paths.Add(formedpathFilefull, outPath);
                                 binaryloaded = true;
                             }
                         }
@@ -1235,7 +1235,7 @@ public AIPath LoadPath(string pathstring, out bool validPath)
                         {
                             try
                             {
-                                Paths.Add(formedpathFilefull, new AIPath(outPath));
+                                Paths.Add(formedpathFilefull, outPath);
                             }
                             catch (Exception e)
                             {