Automatic merge of T1.5.1-791-gffaeec028 and 13 pull requests

- Pull request #570 at 3539862: Experimental glTF 2.0 support with PBR lighting
- Pull request #839 at d00beb9: First phase of https://blueprints.launchpad.net/or/+spec/additional-cruise-control-parameters
- Pull request #876 at f92de76: docs: add source for documents previously on website to source Documentation folder
- Pull request #882 at a055bca: Blueprint/train car operations UI window
- Pull request #885 at d9ce84b: feat: Add notifications to Menu
- Pull request #886 at 6c0785b: Scene viewer extension to TrackViewer
- Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH
- Pull request #893 at bf8876b: Signal errors
- Pull request #896 at 5866028: First implementation of https://blueprints.launchpad.net/or/+spec/specific-sounds-for-ai-trains
- Pull request #897 at 0a9d939: feat: Improved system information collection
- Pull request #903 at d5b3639: Downloading route content from Github
- Pull request #906 at 0e0aa8b: Bug fix for https://bugs.launchpad.net/or/+bug/2047299 Crash loading a 3Dcab-only loco
- Pull request #907 at 9b0b04f: Bug fix for https://bugs.launchpad.net/or/+bug/2047300 Dynamic tracks disappear after long tunnel

Author: openrails-bot

Source/Menu/DownloadContentForm.cs

@@ -26,12 +26,13 @@
 using System.Linq;
 using System.Diagnostics;
 using System.Threading;
+using System.ComponentModel;
 
 namespace ORTS
 {
     public partial class DownloadContentForm : Form
     {
-        private readonly GettextResourceManager Catalog = new GettextResourceManager("Menu");
+        private readonly GettextResourceManager Catalog;
         private readonly UserSettings Settings;
         private readonly IDictionary<string, RouteSettings.Route> Routes;
 
@@ -41,35 +42,23 @@ public DownloadContentForm(UserSettings settings)
         {
             InitializeComponent();
 
+            Catalog = new GettextResourceManager("Menu");
             Settings = settings;
-            Routes = settings.Routes.Routes;
 
+            Settings.Routes.LoadContentAndInstalled();
+            Routes = settings.Routes.Routes;
             for (int index = 0; index < Routes.Count; index++)
             {
                 string routeName = Routes.ElementAt(index).Key;
                 RouteSettings.Route route = Routes.ElementAt(index).Value;
                 dataGridViewDownloadContent.Rows.Add(new string[] { routeName, route.DateInstalled, route.Url });
             }
 
-            Add("OR CPV", "https://github.com/cpvirtual/OR_CPV.git", "");
-            Add("NewForest Route V3", "https://github.com/rickloader/NewForestRouteV3.git", "");
-            Add("MidEast Coast", "https://github.com/MECoast/MECoast.git", "");
-            Add("Demo Model 1", "https://github.com/cjakeman/Demo-Model-1.git", "Demo Model 1");
-            Add("Chiltern Route V2", "https://github.com/DocMartin7644/Chiltern-Route-v2.git", "");
+            dataGridViewDownloadContent.Sort(dataGridViewDownloadContent.Columns[0], ListSortDirection.Ascending);
 
             InstallPathTextBox.Text = settings.Content.InstallPath;
         }
 
-        public void Add(string routeName, string url, string subDirectory)
-        {
-            RouteSettings.Route route = Routes.ContainsKey(routeName) ? Routes[routeName] : null;
-            if (route == null)
-            {
-                dataGridViewDownloadContent.Rows.Add(new string[] { routeName, "", url });
-                Routes.Add(routeName, new RouteSettings.Route("", url, subDirectory));
-            }
-        }
-
         void dataGridViewDownloadContent_SelectionChanged(object sender, EventArgs e)
         {
             RouteName = dataGridViewDownloadContent.CurrentRow.Cells[0].Value.ToString();
@@ -82,7 +71,7 @@ private void InstallPathButton_Click(object sender, EventArgs e)
             using (FolderBrowserDialog folderBrowser = new FolderBrowserDialog())
             {
                 folderBrowser.SelectedPath = InstallPathTextBox.Text;
-                folderBrowser.Description = "Main Path where route is to be installed";
+                folderBrowser.Description = Catalog.GetString("Main Path where route is to be installed");
                 folderBrowser.ShowNewFolderButton = true;
                 if (folderBrowser.ShowDialog(this) == DialogResult.OK)
                 {
@@ -141,10 +130,6 @@ private void DownloadContentButton_Click(object sender, EventArgs e)
 
             Settings.Content.InstallPath = installPath;
 
-            // check if filesystem is case sensitive
-            // ok, this check will be wrong if both upper- and lowercase named route directories exist
-            bool directoryCaseInsensitive = Directory.Exists(installPathRoute.ToUpper()) && Directory.Exists(installPathRoute.ToLower());
-
             // set json route filename
 
             Settings.Content.RouteJsonName = Path.Combine(installPath, "ORRoute.json");
@@ -156,58 +141,16 @@ private void DownloadContentButton_Click(object sender, EventArgs e)
             dataGridViewDownloadContent.CurrentRow.Cells[1].Value = Catalog.GetString("Installing...");
             Refresh();
 
-            // actual download
-
             if (!downloadRoute(installPathRoute))
             {
                 return;
             }
 
             // insert row in Options, tab Content
 
-            if (!string.IsNullOrWhiteSpace(Routes[RouteName].SubDirectory))
-            {
-                installPathRoute = Path.Combine(installPathRoute, Routes[RouteName].SubDirectory);
-            }
-
-            bool updated = false;
-            int index = 0;
-            while (!updated)
+            if (!insertRowInOptions(installPathRoute))
             {
-                string routeName = "";
-                bool routeNameFound = false;
-                foreach (KeyValuePair<string, string> folderSetting in Settings.Folders.Folders)
-                {
-                    if (index == 0) {
-                        routeName = RouteName;
-                    } else
-                    {
-                        routeName = string.Format("{0} ({1})", RouteName, index);
-                    }
-                    if (folderSetting.Key == routeName) {
-                        if (folderSetting.Value.Equals(installPathRoute, 
-                            directoryCaseInsensitive ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal))
-                        {
-                           updated = true;
-                        }
-                        else
-                        {
-                           routeNameFound = true;
-                        }
-                    }
-                }
-                if (!updated)
-                {
-                    if (routeNameFound)
-                    {
-                        index++;
-                    }
-                    else
-                    {
-                        Settings.Folders.Folders[routeName] = installPathRoute;
-                        updated = true;
-                    }
-                }
+                return;
             }
 
             string dateTimeNowStr = DateTime.Now.ToString(CultureInfo.CurrentCulture.DateTimeFormat);
@@ -275,14 +218,92 @@ private void sumMB(string path)
         {
             foreach (string fileName in Directory.GetFiles(path))
             {
-                TotalBytes += new System.IO.FileInfo(fileName).Length;
+                TotalBytes += new FileInfo(fileName).Length;
             }
 
             foreach (string directoryName in Directory.GetDirectories(path))
             {
                 sumMB(directoryName);
             }
         }
+
+        private bool insertRowInOptions(string installPathRoute)
+        {
+            // check if filesystem is case sensitive
+            // ok, this check will be wrong if both upper- and lowercase named route directories exist
+            bool directoryCaseInsensitive = Directory.Exists(installPathRoute.ToUpper()) && Directory.Exists(installPathRoute.ToLower());
+
+            // sometimes the route is located one directory level deeper, determine real installPathRoute
+            string installPathRouteReal;
+
+            if (Directory.Exists(Path.Combine(installPathRoute, "routes"))) {
+                installPathRouteReal = installPathRoute;
+            } 
+            else
+            {
+                string[] directories = Directory.GetDirectories(installPathRoute);
+                int indexDirectories = 0;
+                while ((indexDirectories < directories.Length) &&
+                    !Directory.Exists(Path.Combine(directories[indexDirectories], "routes")))
+                {
+                    indexDirectories++;
+                }
+                if (indexDirectories < directories.Length)
+                {
+                    installPathRouteReal = Path.Combine(installPathRoute, directories[indexDirectories]);
+                }
+                else
+                { 
+                    string message = Catalog.GetString("Incorrect route, directory \"routes\" not found");
+                    MessageBox.Show(message, Catalog.GetString("Attention"), MessageBoxButtons.OK, MessageBoxIcon.Error);
+                    return false;
+                }
+            }
+
+            bool updated = false;
+            int index = 0;
+            while (!updated)
+            {
+                string routeName = "";
+                bool routeNameFound = false;
+                foreach (KeyValuePair<string, string> folderSetting in Settings.Folders.Folders)
+                {
+                    if (index == 0)
+                    {
+                        routeName = RouteName;
+                    }
+                    else
+                    {
+                        routeName = string.Format("{0} ({1})", RouteName, index);
+                    }
+                    if (folderSetting.Key == routeName)
+                    {
+                        if (folderSetting.Value.Equals(installPathRouteReal,
+                            directoryCaseInsensitive ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal))
+                        {
+                            updated = true;
+                        }
+                        else
+                        {
+                            routeNameFound = true;
+                        }
+                    }
+                }
+                if (!updated)
+                {
+                    if (routeNameFound)
+                    {
+                        index++;
+                    }
+                    else
+                    {
+                        Settings.Folders.Folders[routeName] = installPathRouteReal;
+                        updated = true;
+                    }
+                }
+            }
+            return true;
+        }
     }
 
 }

Source/Menu/MainForm.cs

@@ -572,11 +572,8 @@ void buttonOptions_Click(object sender, EventArgs e)
 
         void buttonDownloadContent_Click(object sender, EventArgs e)
         {
-            SaveOptions();
-
             using (var form = new DownloadContentForm(Settings))
             {
-                Cursor.Current = Cursors.WaitCursor;
                 form.ShowDialog(this);
             }
         }

Source/ORTS.Settings/ORTS.Settings.csproj

@@ -26,6 +26,7 @@
     <ProjectReference Include="..\ORTS.Common\ORTS.Common.csproj" />
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="LibGit2Sharp" Version="0.29.0" />
     <PackageReference Include="Microsoft.DotNet.UpgradeAssistant.Extensions.Default.Analyzers" Version="0.4.355802">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

Source/ORTS.Settings/RouteSettings.cs

@@ -18,9 +18,14 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using LibGit2Sharp;
+using static ORTS.Settings.RouteSettings;
+using System.Windows.Forms;
 
 namespace ORTS.Settings
 {
@@ -30,35 +35,120 @@ public class Route
         {
             public string DateInstalled { get; set; }
             public string Url { get; set; }
-            public string SubDirectory { get; set; }
 
-            public Route(string dateInstalled, string url, string subDirectory)
+            public Route(string dateInstalled, string url)
             { 
                 DateInstalled = dateInstalled;
                 Url = url;
-                SubDirectory = subDirectory;
             }
         }
 
-        private ContentSettings Content;
+        private readonly ContentSettings Content;
 
-        public IDictionary<string, Route> Routes = new Dictionary<string, Route>();
+        public IDictionary<string, Route> Routes { get; private set; }
 
         public RouteSettings(ContentSettings content)
         {
             Content = content;
+            Routes = new Dictionary<string, Route>();
+
             Load();
         }
 
         public void Load() 
+        {
+            // left empty
+        }
+
+        public void LoadContentAndInstalled()
         {
             if (!string.IsNullOrWhiteSpace(Content.RouteJsonName))
             {
                 if (File.Exists(Content.RouteJsonName))
                 {
-                    string json = File.ReadAllText(Content.RouteJsonName);
-                    Routes = JsonConvert.DeserializeObject<IDictionary<string, Route>>(json);
+                    try
+                    {
+                        string json = File.ReadAllText(Content.RouteJsonName);
+                        Routes = JsonConvert.DeserializeObject<IDictionary<string, Route>>(json);
+                    }
+                    catch (Exception error)
+                    {
+                        throw new Exception("Error during reading " + Content.RouteJsonName + ": " + error.Message, error);
+                    }
+                }
+            }
+
+            string definedContentJsonName = @"d:\content\routes.json";
+            string definedContentJsonDirectoryName = Path.Combine(UserSettings.UserDataFolder, "ContentJson");
+            string githubUrl = "https://github.com/openrails/content.git";
+
+            if (Environment.GetEnvironmentVariable("TstLoadContentAndInstalled") == null)
+            {
+                try
+                {
+                    // normal non test behaviour, retrieve json file from github
+
+                    directoryDelete(definedContentJsonDirectoryName);
+
+                    Repository.Clone(githubUrl, definedContentJsonDirectoryName);
+
+                    definedContentJsonName = Path.Combine(definedContentJsonDirectoryName, "routes.json");
                 }
+                catch (Exception error) 
+                { 
+                    throw new Exception("Error during retrieving routes.json from \"" + githubUrl + "\":" + error.Message, error); 
+                }  
+            }
+
+            if (File.Exists(definedContentJsonName))
+            {
+                try
+                {
+                    var json = File.ReadAllText(definedContentJsonName);
+
+                    IList<JToken> results = JsonConvert.DeserializeObject<JToken>(json) as IList<JToken>;
+                    foreach (JToken result in results)
+                    {
+                        if (result["url"].ToString().EndsWith(".git"))
+                        {
+                            string routeName = result["name"].ToString();
+                            if (!Routes.ContainsKey(routeName))
+                            {
+                                Routes.Add(routeName, new RouteSettings.Route("", result["url"].ToString()));
+                            }
+                        }
+                    }
+
+                    directoryDelete(definedContentJsonDirectoryName);
+                }
+                catch (Exception error)
+                {
+                    throw new Exception("Error during reading \"" +  definedContentJsonName + "\": " + error.Message, error);
+                }
+            }
+
+            return;
+        }
+
+        private void directoryDelete(string directoryName)
+        {
+            if (Directory.Exists(directoryName))
+            {
+                directoryRemoveReadOnlyFlags(directoryName);
+                Directory.Delete(directoryName, true);
+            }
+        }
+
+        private void directoryRemoveReadOnlyFlags(string directoryName)
+        {
+            foreach (string filename in Directory.GetFiles(directoryName))
+            {
+                FileInfo file = new FileInfo(filename);
+                file.IsReadOnly = false;
+            }
+            foreach (string subDirectoryName in Directory.GetDirectories(directoryName))
+            {
+                directoryRemoveReadOnlyFlags(subDirectoryName);
             }
         }