Add some client helper classes

SabreTools.RedumpLib/Web/DelayHelper.cs

@@ -0,0 +1,21 @@
+using System;
+using System.Threading;
+
+namespace SabreTools.RedumpLib.Web
+{
+    /// <summary>
+    /// Helper class for delaying
+    /// </summary>
+    internal static class DelayHelper
+    {
+        /// <summary>
+        /// Delay a random amount of time up to 5 seconds
+        /// </summary>
+        public static void DelayRandom()
+        {
+            var r = new Random();
+            int delay = r.Next(0, 50);
+            Thread.Sleep(delay * 100);
+        }
+    }
+}

SabreTools.RedumpLib/Web/Discs.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Threading.Tasks;
+using SabreTools.RedumpLib.Data;
+
+namespace SabreTools.RedumpLib.Web
+{
+    /// <summary>
+    /// Contains logic for dealing with disc pages
+    /// </summary>
+    public static class Discs
+    {
+        /// <summary>
+        /// Download the last modified disc pages, until first failure
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        /// <param name="force">Force continuation of download</param>
+        public static async Task<bool> DownloadLastModified(RedumpClient rc, string? outDir, bool force)
+        {
+            // Keep getting last modified pages until there are none left
+            int pageNumber = 1;
+            while (true)
+            {
+                if (!await rc.CheckSingleSitePage(string.Format(Constants.LastModifiedUrl, pageNumber++), outDir, !force))
+                    break;
+            }
+
+            return true;
+        }
+
+        /// <summary>
+        /// Download the specified range of site disc pages
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        /// <param name="minId">Starting ID for the range</param>
+        /// <param name="maxId">Ending ID for the range (inclusive)</param>
+        public static async Task<bool> DownloadSiteRange(RedumpClient rc, string? outDir, int minId = 0, int maxId = 0)
+        {
+            if (!rc.LoggedIn)
+            {
+                Console.WriteLine("Site download functionality is only available to Redump members");
+                return false;
+            }
+
+            for (int id = minId; id <= maxId; id++)
+            {
+                if (await rc.DownloadSingleSiteID(id, outDir, true))
+                    DelayHelper.DelayRandom(); // Intentional sleep here so we don't flood the server
+            }
+
+            return true;
+        }
+    }
+}

SabreTools.RedumpLib/Web/Packs.cs

@@ -0,0 +1,73 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using SabreTools.RedumpLib.Data;
+
+namespace SabreTools.RedumpLib.Web
+{
+    /// <summary>
+    /// Contains logic for dealing with packs
+    /// </summary>
+    internal static class Packs
+    {
+        /// <summary>
+        /// Download premade packs
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        /// <param name="useSubfolders">True to use named subfolders to store downloads, false to store directly in the output directory</param>
+        public static async Task<bool> DownloadPacks(RedumpClient rc, string? outDir, bool useSubfolders)
+        {
+#if NETFRAMEWORK || NETCOREAPP3_1
+            var systems = Enum.GetValues(typeof(RedumpSystem)).OfType<RedumpSystem>().Select(s => new Nullable<RedumpSystem>(s));
+#else
+            var systems = Enum.GetValues<RedumpSystem>().Select(s => new RedumpSystem?(s));
+#endif
+
+            await rc.DownloadPacks(Constants.PackCuesUrl, systems.Where(s => s.HasCues()).ToArray(), "CUEs", outDir, useSubfolders ? "cue" : null);
+            await rc.DownloadPacks(Constants.PackDatfileUrl, systems.Where(s => s.HasDat()).ToArray(), "DATs", outDir, useSubfolders ? "dat" : null);
+            await rc.DownloadPacks(Constants.PackDkeysUrl, systems.Where(s => s.HasDkeys()).ToArray(), "Decrypted KEYS", outDir, useSubfolders ? "dkey" : null);
+            await rc.DownloadPacks(Constants.PackGdiUrl, systems.Where(s => s.HasGdi()).ToArray(), "GDIs", outDir, useSubfolders ? "gdi" : null);
+            await rc.DownloadPacks(Constants.PackKeysUrl, systems.Where(s => s.HasKeys()).ToArray(), "KEYS", outDir, useSubfolders ? "keys" : null);
+            await rc.DownloadPacks(Constants.PackLsdUrl, systems.Where(s => s.HasLsd()).ToArray(), "LSD", outDir, useSubfolders ? "lsd" : null);
+            await rc.DownloadPacks(Constants.PackSbiUrl, systems.Where(s => s.HasSbi()).ToArray(), "SBIs", outDir, useSubfolders ? "sbi" : null);
+
+            return true;
+        }
+
+        /// <summary>
+        /// Download premade packs for an individual system
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="system">RedumpSystem to get all possible packs for</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        /// <param name="useSubfolders">True to use named subfolders to store downloads, false to store directly in the output directory</param>
+        public static async Task<bool> DownloadPacksForSystem(RedumpClient rc, RedumpSystem? system, string? outDir, bool useSubfolders)
+        {
+            var systemAsArray = new RedumpSystem?[] { system };
+
+            if (system.HasCues())
+                await rc.DownloadPacks(Constants.PackCuesUrl, systemAsArray, "CUEs", outDir, useSubfolders ? "cue" : null);
+
+            if (system.HasDat())
+                await rc.DownloadPacks(Constants.PackDatfileUrl, systemAsArray, "DATs", outDir, useSubfolders ? "dat" : null);
+
+            if (system.HasDkeys())
+                await rc.DownloadPacks(Constants.PackDkeysUrl, systemAsArray, "Decrypted KEYS", outDir, useSubfolders ? "dkey" : null);
+
+            if (system.HasGdi())
+                await rc.DownloadPacks(Constants.PackGdiUrl, systemAsArray, "GDIs", outDir, useSubfolders ? "gdi" : null);
+
+            if (system.HasKeys())
+                await rc.DownloadPacks(Constants.PackKeysUrl, systemAsArray, "KEYS", outDir, useSubfolders ? "keys" : null);
+
+            if (system.HasLsd())
+                await rc.DownloadPacks(Constants.PackLsdUrl, systemAsArray, "LSD", outDir, useSubfolders ? "lsd" : null);
+
+            if (system.HasSbi())
+                await rc.DownloadPacks(Constants.PackSbiUrl, systemAsArray, "SBIs", outDir, useSubfolders ? "sbi" : null);
+
+            return true;
+        }
+    }
+}

SabreTools.RedumpLib/Web/Search.cs

@@ -0,0 +1,93 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using SabreTools.RedumpLib.Data;
+
+namespace SabreTools.RedumpLib.Web
+{
+    /// <summary>
+    /// Contains logic for dealing with searches
+    /// </summary>
+    internal static class Search
+    {
+        /// <summary>
+        /// List the disc IDs associated with a given quicksearch query
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="query">Query string to attempt to search for</param>
+        /// <returns>All disc IDs for the given query, null on error</returns>
+        public static async Task<List<int>?> ListSearchResults(RedumpClient rc, string? query)
+        {
+            // If the query is invalid
+            if (string.IsNullOrEmpty(query))
+                return null;
+
+            List<int> ids = [];
+
+            // Strip quotes
+            query = query!.Trim('"', '\'');
+
+            // Special characters become dashes
+            query = query.Replace(' ', '-');
+            query = query.Replace('/', '-');
+            query = query.Replace('\\', '/');
+
+            // Lowercase is defined per language
+            query = query.ToLowerInvariant();
+
+            // Keep getting quicksearch pages until there are none left
+            try
+            {
+                int pageNumber = 1;
+                while (true)
+                {
+                    List<int> pageIds = await rc.CheckSingleSitePage(string.Format(Constants.QuickSearchUrl, query, pageNumber++));
+                    ids.AddRange(pageIds);
+                    if (pageIds.Count <= 1)
+                        break;
+                }
+            }
+            catch (Exception ex)
+            {
+                Console.WriteLine($"An exception occurred while trying to log in: {ex}");
+                return null;
+            }
+
+            return ids;
+        }
+
+        /// <summary>
+        /// Download the disc pages associated with a given quicksearch query
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="query">Query string to attempt to search for</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        public static async Task<bool> DownloadSearchResults(RedumpClient rc, string? query, string? outDir)
+        {
+            // If the query is invalid
+            if (string.IsNullOrEmpty(query))
+                return false;
+
+            // Strip quotes
+            query = query!.Trim('"', '\'');
+
+            // Special characters become dashes
+            query = query.Replace(' ', '-');
+            query = query.Replace('/', '-');
+            query = query.Replace('\\', '/');
+
+            // Lowercase is defined per language
+            query = query.ToLowerInvariant();
+
+            // Keep getting quicksearch pages until there are none left
+            int pageNumber = 1;
+            while (true)
+            {
+                if (!await rc.CheckSingleSitePage(string.Format(Constants.QuickSearchUrl, query, pageNumber++), outDir, false))
+                    break;
+            }
+
+            return true;
+        }
+    }
+}

SabreTools.RedumpLib/Web/User.cs

@@ -0,0 +1,100 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using SabreTools.RedumpLib.Data;
+
+namespace SabreTools.RedumpLib.Web
+{
+    /// <summary>
+    /// Contains logic for dealing with users
+    /// </summary>
+    public static class User
+    {
+        /// <summary>
+        /// Download the disc pages associated with the given user
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="username">Username to check discs for</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        public static async Task<bool> DownloadUser(RedumpClient rc, string? username, string? outDir)
+        {
+            if (!rc.LoggedIn || string.IsNullOrEmpty(username))
+            {
+                Console.WriteLine("User download functionality is only available to Redump members");
+                return false;
+            }
+
+            // Keep getting user pages until there are none left
+            int pageNumber = 1;
+            while (true)
+            {
+                if (!await rc.CheckSingleSitePage(string.Format(Constants.UserDumpsUrl, username, pageNumber++), outDir, false))
+                    break;
+            }
+
+            return true;
+        }
+
+        /// <summary>
+        /// Download the last modified disc pages associated with the given user, until first failure
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="username">Username to check discs for</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        public static async Task<bool> DownloadUserLastModified(RedumpClient rc, string? username, string? outDir)
+        {
+            if (!rc.LoggedIn || string.IsNullOrEmpty(username))
+            {
+                Console.WriteLine("User download functionality is only available to Redump members");
+                return false;
+            }
+
+            // Keep getting last modified user pages until there are none left
+            int pageNumber = 1;
+            while (true)
+            {
+                if (!await rc.CheckSingleSitePage(string.Format(Constants.UserDumpsLastModifiedUrl, username, pageNumber++), outDir, true))
+                    break;
+            }
+
+            return true;
+        }
+    
+        /// <summary>
+        /// List the disc IDs associated with the given user
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="username">Username to check discs for</param>
+        /// <returns>All disc IDs for the given user, null on error</returns>
+        public static async Task<List<int>?> ListUser(RedumpClient rc, string? username)
+        {
+            List<int> ids = [];
+
+            if (!rc.LoggedIn || string.IsNullOrEmpty(username))
+            {
+                Console.WriteLine("User download functionality is only available to Redump members");
+                return ids;
+            }
+
+            // Keep getting user pages until there are none left
+            try
+            {
+                int pageNumber = 1;
+                while (true)
+                {
+                    List<int> pageIds = await rc.CheckSingleSitePage(string.Format(Constants.UserDumpsUrl, username, pageNumber++));
+                    ids.AddRange(pageIds);
+                    if (pageIds.Count <= 1)
+                        break;
+                }
+            }
+            catch (Exception ex)
+            {
+                Console.WriteLine($"An exception occurred while trying to log in: {ex}");
+                return null;
+            }
+
+            return ids;
+        }
+    }
+}

SabreTools.RedumpLib/Web/WIP.cs

@@ -0,0 +1,46 @@
+using System;
+using System.Threading.Tasks;
+using SabreTools.RedumpLib.Data;
+
+namespace SabreTools.RedumpLib.Web
+{
+    /// <summary>
+    /// Contains logic for dealing with WIP queue
+    /// </summary>
+    public static class WIP
+    {
+        /// <summary>
+        /// Download the last submitted WIP disc pages
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        public static async Task<bool> DownloadLastSubmitted(RedumpClient rc, string? outDir)
+        {
+            return await rc.CheckSingleWIPPage(Constants.WipDumpsUrl, outDir, false);
+        }
+
+        /// <summary>
+        /// Download the specified range of WIP disc pages
+        /// </summary>
+        /// <param name="rc">RedumpClient for connectivity</param>
+        /// <param name="outDir">Output directory to save data to</param>
+        /// <param name="minId">Starting ID for the range</param>
+        /// <param name="maxId">Ending ID for the range (inclusive)</param>
+        public static async Task<bool> DownloadWIPRange(RedumpClient rc, string? outDir, int minId = 0, int maxId = 0)
+        {
+            if (!rc.LoggedIn || !rc.IsStaff)
+            {
+                Console.WriteLine("WIP download functionality is only available to Redump moderators");
+                return false;
+            }
+
+            for (int id = minId; id <= maxId; id++)
+            {
+                if (await rc.DownloadSingleWIPID(id, outDir, true))
+                    DelayHelper.DelayRandom(); // Intentional sleep here so we don't flood the server
+            }
+
+            return true;
+        }
+    }
+}