Merge pull request #647 from twpol/feature/binpat-cache-directory

fix: Put all cache files into the designated area away from user files

Author: cjakeman

Source/ORTS.Settings/UserSettings.cs

@@ -20,6 +20,8 @@
 using System.IO;
 using System.Linq;
 using System.Reflection;
+using System.Security.Cryptography;
+using System.Text;
 using System.Windows.Forms;
 using ORTS.Common;
 
@@ -479,6 +481,20 @@ public override object GetDefaultValue(string name)
             throw new InvalidDataException(String.Format("UserSetting {0} has no default value.", property.Name));
         }
 
+        public string GetCacheFilePath(string type, string key)
+        {
+            var hasher = new MD5CryptoServiceProvider();
+            hasher.ComputeHash(Encoding.Default.GetBytes(key));
+            var hash = String.Join("", hasher.Hash.Select(h => h.ToString("x2")));
+
+            var directory = Path.Combine(UserSettings.UserDataFolder, "Cache", type);
+
+            if (!Directory.Exists(directory))
+                Directory.CreateDirectory(directory);
+
+            return Path.Combine(directory, hash + ".cache-or");
+        }
+
         PropertyInfo GetProperty(string name)
         {
             return GetType().GetProperty(name, BindingFlags.Public | BindingFlags.Instance | BindingFlags.FlattenHierarchy);

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

@@ -1193,9 +1193,7 @@ public AIPath LoadPath(string pathstring, out bool validPath)
             {
                 // 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");
+                var formedpathFilefullBinary = simulator.Settings.GetCacheFilePath("Path", formedpathFilefull);
 
                 if (BinaryPaths && File.Exists(formedpathFilefullBinary))
                 {
@@ -1210,14 +1208,22 @@ public AIPath LoadPath(string pathstring, out bool validPath)
                         try
                         {
                             var infpath = new BinaryReader(new FileStream(formedpathFilefullBinary, FileMode.Open, FileAccess.Read));
-                            outPath = new AIPath(simulator.TDB, simulator.TSectionDat, infpath);
-                            infpath.Close();
-
-                            if (outPath.Nodes != null)
+                            var cachePath = infpath.ReadString();
+                            if (cachePath != formedpathFilefull)
                             {
-                                Paths.Add(formedpathFilefull, outPath);
-                                binaryloaded = true;
+                                Trace.TraceWarning($"Expected cache file for '{formedpathFilefull}'; got '{cachePath}' in {formedpathFilefullBinary}");
+                            }
+                            else
+                            {
+                                outPath = new AIPath(simulator.TDB, simulator.TSectionDat, infpath);
+
+                                if (outPath.Nodes != null)
+                                {
+                                    Paths.Add(formedpathFilefull, outPath);
+                                    binaryloaded = true;
+                                }
                             }
+                            infpath.Close();
                         }
                         catch
                         {
@@ -1267,6 +1273,7 @@ public AIPath LoadPath(string pathstring, out bool validPath)
                             try
                             {
                                 var outfpath = new BinaryWriter(new FileStream(formedpathFilefullBinary, FileMode.Create));
+                                outfpath.Write(formedpathFilefull);
                                 outPath.Save(outfpath);
                                 outfpath.Close();
                             }

Source/RunActivity/Viewer3D/Processes/GameStateRunActivity.cs

@@ -33,8 +33,6 @@
 using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
-using System.Security.Cryptography;
-using System.Text;
 using System.Text.RegularExpressions;
 using System.Windows.Forms;
 
@@ -174,27 +172,27 @@ internal override void Load()
                     case "start":
                     case "start-profile":
                         InitLogging(settings, args);
-                        InitLoading(args);
+                        InitLoading(settings, args);
                         Start(settings, acttype, data);
                         break;
                     case "resume":
                         InitLogging(settings, args);
-                        InitLoading(args);
+                        InitLoading(settings, args);
                         Resume(settings, data);
                         break;
                     case "replay":
                         InitLogging(settings, args);
-                        InitLoading(args);
+                        InitLoading(settings, args);
                         Replay(settings, data);
                         break;
                     case "replay_from_save":
                         InitLogging(settings, args);
-                        InitLoading(args);
+                        InitLoading(settings, args);
                         ReplayFromSave(settings, data);
                         break;
                     case "test":
                         InitLogging(settings, args, true);
-                        InitLoading(args);
+                        InitLoading(settings, args);
                         Test(settings, data);
                         break;
 
@@ -816,23 +814,16 @@ void InitLogging(UserSettings settings, string[] args, bool appendLog)
         DateTime LoadingNextSample = DateTime.MinValue;
         float LoadedPercent = -1;
 
-        void InitLoading(string[] args)
+        void InitLoading(UserSettings settings, string[] args)
         {
             // Get the initial bytes; this is subtracted from all further uses of GetProcessBytesLoaded().
             LoadingBytesInitial = GetProcessBytesLoaded();
 
             // We hash together all the appropriate arguments to the program as the key for the loading cache file.
             // Arguments without a '.' in them and those starting '/' are ignored, since they are explore activity
             // configuration (time, season, etc.) or flags like /test which we don't want to change on.
-            LoadingDataKey = String.Join(" ", args.Where(a => a.Contains('.') && !a.StartsWith("-") && !a.StartsWith("/")).ToArray()).ToLowerInvariant();
-            var hash = new MD5CryptoServiceProvider();
-            hash.ComputeHash(Encoding.Default.GetBytes(LoadingDataKey));
-            var loadingHash = String.Join("", hash.Hash.Select(h => h.ToString("x2")).ToArray());
-            var dataPath = Path.Combine(UserSettings.UserDataFolder, "Load Cache");
-            LoadingDataFilePath = Path.Combine(dataPath, loadingHash + ".dat");
-
-            if (!Directory.Exists(dataPath))
-                Directory.CreateDirectory(dataPath);
+            LoadingDataKey = String.Join(" ", args.Where(a => a.Contains('.') && !a.StartsWith("-") && !a.StartsWith("/"))).ToLowerInvariant();
+            LoadingDataFilePath = settings.GetCacheFilePath("Load", LoadingDataKey);
 
             var loadingTime = 0;
             var bytesExpected = new long[LoadingSampleCount];