feat: Add remote game scan

Author: SamHou0

VNGod/Network/WebDAVClient.cs

@@ -4,6 +4,7 @@
 using System.Linq;
 using System.Net;
 using System.Threading.Tasks;
+using System.Windows.Navigation;
 using VNGod.Properties;
 using WebDav;
 
@@ -57,7 +58,18 @@ public async static Task<bool> InitializeClient()
             client = null;
             return false;
         }
-
+        private async static Task<string?> GetBaseUriAsync(string requestUri)
+        {
+            var response = await client!.Propfind(requestUri, new() { Headers = new Dictionary<string, string> { { "Depth", "0" } } });
+            if (response.IsSuccessful)
+            {
+                return response.Resources.First().Uri!.ToString();
+            }
+            else
+            {
+                return null;
+            }
+        }
         /// <summary>
         /// Test WebDAV connection.
         /// </summary>
@@ -70,7 +82,7 @@ public static async Task<bool> TestConnectionAsync(WebDavClient testClient)
                 var response = await testClient.Propfind("");
                 if (response.IsSuccessful)
                 {
-                    Logger.Info("WebDAV connection successful.");
+                    Logger.Debug("WebDAV connection successful.");
                     return true;
                 }
                 else
@@ -85,7 +97,40 @@ public static async Task<bool> TestConnectionAsync(WebDavClient testClient)
                 return false;
             }
         }
-
+        /// <summary>
+        /// List remote directory contents.
+        /// </summary>
+        /// <param name="requestUri">The request uri to search sub dir</param>
+        /// <param name="remoteFileList">The list to add result in</param>
+        /// <returns>If the operation is successful</returns>
+        public static async Task<bool> ListRemoteAsync(string requestUri, List<string> remoteFileList)
+        {
+            try
+            {
+                string? baseUri = await GetBaseUriAsync(requestUri);
+                if (baseUri == null) return false;
+                var response = await client!.Propfind(requestUri);
+                if (response.IsSuccessful)
+                {
+                    foreach (var resource in response.Resources)
+                    {
+                        if (resource.Uri!.ToString() == baseUri) continue; // Skip root dir itself
+                        remoteFileList.Add(resource.Uri!.ToString());
+                    }
+                    Logger.Debug($"Successfully listed files in remote");
+                    return true;
+                }
+                else
+                {
+                    throw new Exception($"Failed to list files in remote. Status code: {response.StatusCode}");
+                }
+            }
+            catch (Exception ex)
+            {
+                Logger.Error($"Exception during listing files: {ex.Message}", ex);
+                return false;
+            }
+        }
         /// <summary>
         /// Delete a file or directory from the WebDAV server.
         /// </summary>
@@ -124,7 +169,7 @@ public static async Task<bool> UploadFileAsync(string localFilePath, string remo
                 var response = await client!.PutFile(remoteFilePath, fileStream);
                 if (response.IsSuccessful)
                 {
-                    Logger.Info($"Successfully uploaded {localFilePath} to {remoteFilePath}");
+                    Logger.Debug($"Successfully uploaded {localFilePath} to {remoteFilePath}");
                     return true;
                 }
                 else
@@ -159,7 +204,7 @@ public static async Task<bool> DownloadFileAsync(string remoteFilePath, string l
                         await response.Stream.CopyToAsync(fileStream);
                     }
                     File.SetLastAccessTime(localFilePath, time ?? throw new NullReferenceException("Null Remote Time."));//Keep the access time consistent
-                    Logger.Info($"Successfully downloaded {remoteFilePath} to {localFilePath}");
+                    Logger.Debug($"Successfully downloaded {remoteFilePath} to {localFilePath}");
                     return true;
                 }
                 else
@@ -170,7 +215,7 @@ public static async Task<bool> DownloadFileAsync(string remoteFilePath, string l
             }
             catch (Exception ex)
             {
-                Logger.Error($"Exception during file download: {ex.Message}", ex);
+                Logger.Error($"Exception during file download {remoteFilePath} to {localFilePath}: {ex.Message}", ex);
                 return false;
             }
         }

VNGod/Resource/Strings/Strings.Designer.cs

@@ -295,4 +295,10 @@
   <data name="About" xml:space="preserve">
     <value>About</value>
   </data>
+  <data name="LocalGames" xml:space="preserve">
+    <value>Local Games</value>
+  </data>
+  <data name="RemoteGames" xml:space="preserve">
+    <value>Remote Games (Re-open the window to refresh)</value>
+  </data>
 </root>

VNGod/Resource/Strings/Strings.resx

@@ -277,4 +277,10 @@
   <data name="About" xml:space="preserve">
     <value>关于</value>
   </data>
+  <data name="LocalGames" xml:space="preserve">
+    <value>本地游戏</value>
+  </data>
+  <data name="RemoteGames" xml:space="preserve">
+    <value>远程游戏（关闭后重新打开此窗口刷新）</value>
+  </data>
 </root>

VNGod/Resource/Strings/Strings.zh-CN.resx

@@ -15,6 +15,7 @@ namespace VNGod.Utils
     static class FileHelper
     {
         private static readonly ILog logger = LogManager.GetLogger(typeof(FileHelper));
+        public static readonly string tmpPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Temp");
         /// <summary>
         /// Initializes a repo at the given path by reading its metadata and scanning for games.
         /// </summary>
@@ -43,7 +44,7 @@ public static void ScanGames(Repo repo)
                     // Check if .vngodignore file exists
                     if (File.Exists(Path.Combine(dir, ".vngodignore")))
                     {
-                        logger.Info($"Directory {dir} is ignored.");
+                        logger.Debug($"Directory {dir} is ignored.");
                         continue;
                     }
                     // Check if .vngod file exists
@@ -114,9 +115,9 @@ public static void AddGameIgnore(Repo repo,Game game)
         /// Load metadata for all games in the repo from their .vngod files.
         /// </summary>
         /// <param name="repo"></param>
-        public static void ReadMetadata(Repo repo)
+        public static void ReadRepoMetadata(Repo repo)
         {
-            logger.Info("Reading metadata from " + repo.LocalPath);
+            logger.Debug("Reading metadata from " + repo.LocalPath);
             for (int i = 0; i < repo.Count; i++)
             {
                 Game game = repo[i];
@@ -139,6 +140,22 @@ public static void ReadMetadata(Repo repo)
             }
 
         }
+        public static Game ReadGameMetadata(string metaDataPath)
+        {
+            try
+            {
+                using StreamReader reader = new(metaDataPath);
+                XmlSerializer serializer = new(typeof(Game));
+                Game game = (Game?)serializer.Deserialize(reader) ?? throw new Exception("Null game");
+                return game;
+            }
+            catch (Exception ex)
+            {
+                Exception readEx = new($"Failed to read .vngod file in {metaDataPath}. Not a valid game directory.\n{ex.Message}");
+                logger.Error(readEx.Message, readEx);
+                throw readEx;
+            }
+        }
         /// <summary>
         /// Read repo metadata from disk.
         /// </summary>

VNGod/Utils/FileHelper.cs

@@ -1,4 +1,5 @@
-using log4net;
+using HandyControl.Controls;
+using log4net;
 using System.IO;
 using VNGod.Data;
 using VNGod.Models;
@@ -36,12 +37,12 @@ public static async Task<bool> SyncMetadataAsync(Repo repo)
                     var localMetaPath = Path.Combine(repo.LocalPath, game.DirectoryName, ".vngod");
                     var remoteMetaPath = $"{game.DirectoryName}/.vngod";
                     var timeComparison = WebDAVClient.CompareFileDate(remoteMetaPath, localMetaPath);
-                    Logger.Info($"Comparing metadata for game {game.DirectoryName}: Time comparison result = {timeComparison}");
+                    Logger.Debug($"Comparing metadata for game {game.DirectoryName}: Time comparison result = {timeComparison}");
                     if (timeComparison == -1 || timeComparison == 404)
                     {
                         if (await WebDAVClient.UploadFileAsync(localMetaPath, remoteMetaPath))
                         {
-                            Logger.Info($"Uploaded metadata for game {game.DirectoryName}.");
+                            Logger.Debug($"Uploaded metadata for game {game.DirectoryName}.");
                         }
                         else
                             throw new Exception("Upload metadata failed.");
@@ -50,14 +51,14 @@ public static async Task<bool> SyncMetadataAsync(Repo repo)
                     {
                         if (await WebDAVClient.DownloadFileAsync(remoteMetaPath, localMetaPath))
                         {
-                            Logger.Info($"Downloaded metadata for game {game.DirectoryName}.");
+                            Logger.Debug($"Downloaded metadata for game {game.DirectoryName}.");
                         }
                         else
                             throw new Exception("Download metadata failed.");
                     }
                     else
                     {
-                        Logger.Info($"Metadata for game {game.DirectoryName} is up to date.");
+                        Logger.Debug($"Metadata for game {game.DirectoryName} is up to date.");
                     }
                 }
                 catch (Exception ex)
@@ -92,7 +93,7 @@ public static async Task<bool> SyncGameAsync(Game game)
                 }
                 if (timeComparison == -1 || timeComparison == 404)
                 {
-                    Logger.Info("Local save is newer or remote not found. Uploading...");
+                    Logger.Debug("Local save is newer or remote not found. Uploading...");
                     // Upload the zip file to WebDAV server
                     var uploadSuccess = await WebDAVClient.UploadFileAsync(tempZipPath, remoteSavePath);
                     if (!uploadSuccess)
@@ -103,7 +104,7 @@ public static async Task<bool> SyncGameAsync(Game game)
                 }
                 else
                 {
-                    Logger.Info("Remote save is newer or same. Downloading...");
+                    Logger.Debug("Remote save is newer or same. Downloading...");
                     var downloadSuccess = await WebDAVClient.DownloadFileAsync(remoteSavePath, tempZipPath);
                     if (!downloadSuccess)
                     {
@@ -133,7 +134,7 @@ public static async Task<bool> UploadGameAsync(Repo repo, Game game, IProgress<S
         {
             try
             {
-                string tmpPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Temp", game.DirectoryName);
+                string tmpPath = Path.Combine(FileHelper.tmpPath, game.DirectoryName);
                 if (Directory.Exists(tmpPath))
                     Directory.Delete(tmpPath, true);
                 if (!await WebDAVClient.DeleteRemoteAsync($"{game.DirectoryName}/game"))
@@ -158,5 +159,31 @@ public static async Task<bool> UploadGameAsync(Repo repo, Game game, IProgress<S
                 return false;
             }
         }
+        public static async Task<Repo> GetRemoteGamesAsync()
+        {
+            Repo games = new() { LocalPath = "WebDAV" };
+            List<string> remotePaths = new();
+            // Get remote directories under root dir, containg games
+            await WebDAVClient.ListRemoteAsync("", remotePaths);
+            string tmpPath = Path.Combine(FileHelper.tmpPath, ".vngodtmp");
+            // Get remote games
+            foreach (var remotePath in remotePaths)
+            {
+                // Skip if no remote game folder
+                if (await WebDAVClient.ListRemoteAsync($"{remotePath}/game", new()))
+                {
+                    if (await WebDAVClient.DownloadFileAsync($"{remotePath}/.vngod", tmpPath))
+                    {
+                        Game game = FileHelper.ReadGameMetadata(tmpPath);
+                        games.Add(game);
+                    }
+                    else
+                    {
+                        Growl.Warning("Error getting remote games");
+                    }
+                }
+            }
+            return games;
+        }
     }
 }

VNGod/Utils/WebDAVHelper.cs

@@ -8,13 +8,14 @@
         xmlns:strings="clr-namespace:VNGod.Resource.Strings"
         xmlns:model="clr-namespace:VNGod.Models"
         mc:Ignorable="d"
-        Closing="Window_Closing"
+        Closing="Window_Closing" IsVisibleChanged="Window_IsVisibleChanged"
         Title="GameStorage" Height="500" Width="800">
     <Window.Resources>
         <model:WindowStatus x:Key="windowStatus"/>
     </Window.Resources>
     <Grid>
         <Grid.RowDefinitions>
+            <RowDefinition Height="30"/>
             <RowDefinition/>
             <RowDefinition Height="30"/>
         </Grid.RowDefinitions>
@@ -23,7 +24,9 @@
             <ColumnDefinition/>
             <ColumnDefinition Width="2*"/>
         </Grid.ColumnDefinitions>
-        <ListBox x:Name="localGameList">
+        <TextBlock Grid.Row="0" Grid.Column="0" HorizontalAlignment="Center" VerticalAlignment="Center" FontWeight="Bold" Text="{x:Static strings:Strings.LocalGames}"/>
+        <TextBlock Grid.Row="0" Grid.Column="2" HorizontalAlignment="Center" VerticalAlignment="Center" FontWeight="Bold" Text="{x:Static strings:Strings.RemoteGames}"/>
+        <ListBox x:Name="localGameList" Grid.Row="1">
             <ListBox.ItemTemplate>
                 <DataTemplate>
                     <Grid Margin="5">
@@ -37,14 +40,14 @@
                 </DataTemplate>
             </ListBox.ItemTemplate>
         </ListBox>
-        <StackPanel Grid.Column="1" VerticalAlignment="Center">
+        <StackPanel Grid.Column="1" Grid.Row="1" VerticalAlignment="Center">
             <Button x:Name="uploadButton" Margin="20" Click="UploadButton_Click" IsEnabled="{DynamicResource WindowStatus.IsBusy}">Upload</Button>
             <Button x:Name="downloadButton" Margin="20" IsEnabled="{DynamicResource WindowStatus.IsBusy}">Download</Button>
             <Button x:Name="deleteLocalButton" Margin="20" IsEnabled="{DynamicResource WindowStatus.IsBusy}">Delete Local</Button>
             <Button x:Name="deleteRemoteButton" Margin="20" IsEnabled="{DynamicResource WindowStatus.IsBusy}">Delete Remote</Button>
             <TextBlock x:Name="statusText" HorizontalAlignment="Center" Margin="20" Text="Status"/>
         </StackPanel>
-        <ListBox x:Name="remoteGameList" Grid.Column="2"></ListBox>
-        <ProgressBar x:Name="workProgress" Grid.Row="1" Grid.ColumnSpan="3" Margin="20,0"/>
+        <ListBox x:Name="remoteGameList" Grid.Column="2" Grid.Row="1"></ListBox>
+        <ProgressBar x:Name="workProgress" Grid.Row="2" Grid.ColumnSpan="3" Margin="20,0"/>
     </Grid>
 </hc:Window>

VNGod/View/GameStorageWindow.xaml

@@ -65,5 +65,13 @@ private void Window_Closing(object sender, System.ComponentModel.CancelEventArgs
             }
             Hide();
         }
+
+        private async void Window_IsVisibleChanged(object sender, DependencyPropertyChangedEventArgs e)
+        {
+            if(e.NewValue is true)
+            {
+                remoteGameList.ItemsSource = await WebDAVHelper.GetRemoteGamesAsync();
+            }
+        }
     }
 }

VNGod/View/GameStorageWindow.xaml.cs

@@ -116,7 +116,7 @@ private async Task SaveAndSync(bool overwrite, bool missingLocal = false)
                     Growl.Success(Strings.WebDAVSyncSuccess);
                 else Growl.Warning(Strings.WebDAVSyncFailed);
                 int index = gameList.SelectedIndex;
-                FileHelper.ReadMetadata(repo);
+                FileHelper.ReadRepoMetadata(repo);
                 if (index >= 0) gameList.SelectedIndex = index;
             }
         }