feat: optional import extras from gog and humble

Author: Rast1234

source/Libraries/GogLibrary/GogLibrary.cs

@@ -298,7 +298,45 @@ internal List<GameMetadata> GetLibraryGames()
                     Logger.Warn("Failed to obtain library stats data.");
                 }
 
-                return LibraryGamesToGames(libGames).ToList();
+                var result = LibraryGamesToGames(libGames).ToList();
+
+                if (SettingsViewModel.Settings.ImportGameExtras)
+                {
+                    var extras = new List<GameMetadata>();
+                    foreach (var game in result)
+                    {
+                        try
+                        {
+                            var gogExtras = api.GetOwnedGameDetails(game.GameId).Extras;
+                            foreach (var x in gogExtras)
+                            {
+                                var id = x.ManualUrl.Split('/').Last();
+                                if (!long.TryParse(id, out _))
+                                {
+                                    continue;
+                                }
+
+                                var extraAsGame = new GameMetadata()
+                                {
+                                    GameId = $"{game.GameId}_{id}",
+                                    Source = new MetadataNameProperty("GOG"),
+                                    Name = $"{game.Name} {x.Name.RemoveTrademarks()}",
+                                    Categories = new HashSet<MetadataProperty>(){new MetadataNameProperty("extras")}, // TODO customizable category across plugins?
+                                    Links = new List<Link>(){new Link("Download_me", $"https://www.gog.com{x.ManualUrl}")} // TODO use install action to launch browser or DL with playnite itself?
+                                    // TODO any way to ignore post-actions from other plugins, eg search for metadata?
+                                };
+                                extras.Add(extraAsGame);
+                            }
+                        }
+                        catch (Exception e)
+                        {
+                            logger.Error(e, $"Failed to get extras for gog game: {game.GameId} {game.Name}.");
+                        }
+                    }
+                    result.AddRange(extras);
+                }
+
+                return result;
             }
         }
 

source/Libraries/GogLibrary/GogLibrary.csproj

@@ -177,6 +177,7 @@
     <Compile Include="Models\GogGameTaskInfo.cs" />
     <Compile Include="Models\GetOwnedGamesResult.cs" />
     <Compile Include="Models\LibraryGameResponse.cs" />
+    <Compile Include="Models\OwnedGameDetailsResponse.cs" />
     <Compile Include="Models\PagedResponse.cs" />
     <Compile Include="Models\ProductApiDetail.cs" />
     <Compile Include="Models\StoreGamesFilteredListResponse.cs" />

source/Libraries/GogLibrary/GogLibrarySettingsView.xaml

@@ -1,8 +1,8 @@
 <UserControl x:Class="GogLibrary.GogLibrarySettingsView"
              xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
              xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
-             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
-             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
+             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
              xmlns:local="clr-namespace:GogLibrary"
              xmlns:sys="clr-namespace:System;assembly=mscorlib"
              xmlns:pcon="clr-namespace:Playnite.Converters"
@@ -36,7 +36,7 @@
                       Content="{DynamicResource LOCGOGSettingsImportUninstalledLabel}"/>
 
             <StackPanel Orientation="Horizontal" Margin="0,10,0,10">
-                <Button Content="{DynamicResource LOCGOGAuthenticateLabel}" HorizontalAlignment="Left"                         
+                <Button Content="{DynamicResource LOCGOGAuthenticateLabel}" HorizontalAlignment="Left"
                         Command="{Binding LoginCommand}" Margin="0,5,5,5"/>
                 <TextBlock VerticalAlignment="Center" Margin="10,5,5,5">
                     <TextBlock.Tag>
@@ -72,6 +72,8 @@
                   Visibility="{Binding IsFirstRunUse, Converter={pcon:InvertedBooleanToVisibilityConverter}}"/>
         <CheckBox IsChecked="{Binding Settings.UseVerticalCovers}" DockPanel.Dock="Top"
                   Content="{DynamicResource LOCGOGSettingsUseVerticalCovers}"/>
+        <CheckBox IsChecked="{Binding Settings.ImportGameExtras}" DockPanel.Dock="Top"
+                  Content="{DynamicResource LOCGOGSettingsImportGameExtras}"/>
 
         <StackPanel Orientation="Horizontal" Margin="0,10,0,0"
                     Visibility="{Binding IsFirstRunUse, Converter={pcon:InvertedBooleanToVisibilityConverter}}">

source/Libraries/GogLibrary/GogLibrarySettingsViewModel.cs

@@ -14,6 +14,7 @@ public class GogLibrarySettings
         public bool StartGamesUsingGalaxy { get; set; } = false;
         public bool UseAutomaticGameInstalls { get; set; } = false;
         public bool UseVerticalCovers { get; set; } = true;
+        public bool ImportGameExtras { get; set; } = false;
         public string Locale { get; set; } = "en";
     }
     public class GogLibrarySettingsViewModel : PluginSettingsViewModel<GogLibrarySettings, GogLibrary>

source/Libraries/GogLibrary/Localization/en_US.xaml

@@ -23,12 +23,13 @@
   <!--GOG-->
   <sys:String x:Key="LOCGOGUseLogin">Account Login</sys:String>
   <sys:String x:Key="LOCGOGUseAccountName">Account Name</sys:String>
-  <sys:String x:Key="LOCGOGAccountSyncDescription" xml:space="preserve">Login to your account or use your public account name to sync your full library.
+  <sys:String x:Key="LOCGOGAccountSyncDescription" xml:space="preserve">Login to your account or use your public account name to sync your full library.
 Note that the Account Name option only works for accounts whose game libraries have been set in GOG's privacy settings to be publicly visible.</sys:String>
   <sys:String x:Key="LOCSettingsGOGUseGalaxy">Launch games using GOG Galaxy client</sys:String>
   <sys:String x:Key="LOCSettingsGOGUseGalaxyTooltip">This will enable GOG Galaxy features like cloud saves, game time tracking, etc.</sys:String>
   <sys:String x:Key="LOCGOGSettingsUseAutomaticGameInstalls">Automatically initiate the install process when installing games on GOG Galaxy</sys:String>
-  <sys:String x:Key="LOCGOGSettingsUseAutomaticGameInstallsTooltip" xml:space="preserve">If enabled, the install process will be automatically started without needing user interaction to the configured default install location.
+  <sys:String x:Key="LOCGOGSettingsUseAutomaticGameInstallsTooltip" xml:space="preserve">If enabled, the install process will be automatically started without needing user interaction to the configured default install location.
 If disabled, the game page will be opened to manually start the install process.</sys:String>
   <sys:String x:Key="LOCGOGSettingsUseVerticalCovers">Use vertical covers</sys:String>
-</ResourceDictionary>
+  <sys:String x:Key="LOCGOGSettingsImportGameExtras">Also import game extras</sys:String>
+</ResourceDictionary>

source/Libraries/GogLibrary/LocalizationKeys.cs

@@ -1,6 +1,6 @@
 ///
 /// DO NOT MODIFY! Automatically generated via UpdateLocExtFiles.ps1 script.
-/// 
+///
 namespace System
 {
     public static class LOC
@@ -121,5 +121,9 @@ public static class LOC
         /// Use vertical covers
         /// </summary>
         public const string GOGSettingsUseVerticalCovers = "LOCGOGSettingsUseVerticalCovers";
+        /// <summary>
+        /// Import game extras (soundtracks, artwork, guides, ...) when importing games
+        /// </summary>
+        public const string GOGSettingsImportGameExtras = "LOCGOGSettingsImportGameExtras";
     }
 }

source/Libraries/GogLibrary/Models/OwnedGameDetailsResponse.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+
+namespace GogLibrary.Models
+{
+    public class OwnedGameDetailsResponse
+    {
+        /// <example>The Witcher 3: Wild Hunt - Complete Edition</example>>
+        public string Title { get; set; }
+
+        public List<Extra> Extras { get; set; }
+    }
+
+    public class Extra
+    {
+        /// <example>/downloads/the_witcher_3_wild_hunt_game_of_the_year_edition_game/70003</example>
+        public string ManualUrl { get; set; }
+
+        /// <example>soundtrack (MP3)</example>
+        public string Name { get; set; }
+
+        /// <example>audio</example>
+        public string Type { get; set; }
+
+        /// <summary>
+        /// number of items in downloaded archive, displayed in UI like "paper toys (6)". not shown when equals 1 or 2.
+        /// </summary>
+        /// <example>1</example>
+        public long Info { get; set; }
+
+        /// <example>206 MB</example>
+        /// <example>4096 MB</example>
+        public string Size { get; set; }
+    }
+}

source/Libraries/GogLibrary/Services/GogAccountClient.cs

@@ -151,5 +151,13 @@ public List<LibraryGameResponse> GetOwnedGames()
 
             return games;
         }
+
+        public OwnedGameDetailsResponse GetOwnedGameDetails(string gameId)
+        {
+            webView.NavigateAndWait($@"https://www.gog.com/account/gameDetails/{gameId}.json");
+            var stringInfo = webView.GetPageText();
+            var response = Serialization.FromJson<OwnedGameDetailsResponse>(stringInfo);
+            return response;
+        }
     }
 }

source/Libraries/HumbleLibrary/HumbleLibrary.cs

@@ -171,24 +171,8 @@ public List<ImportableTroveGame> GetTroveGames()
             return games.OrderBy(a => a.Name).ToList();
         }
 
-        public List<Order.SubProduct> GetLibraryGames()
+        public List<Order.SubProduct> GetLibraryGames(List<Order> orders)
         {
-            var libraryGames = new List<Game>();
-            var orders = new List<Order>();
-            using (var view = PlayniteApi.WebViews.CreateOffscreenView(
-                new WebViewSettings
-                {
-                    JavaScriptEnabled = false,
-                    UserAgent = UserAgent
-                }))
-            {
-                var api = new HumbleAccountClient(view);
-                var keys = api.GetLibraryKeys();
-                orders = api.GetOrders(keys);
-            }
-
-            // Humble will return null items in library response on some accounts
-            orders = orders.Where(a => a != null).ToList();
             var selectedProducts = new List<Order.SubProduct>();
             var allTpks = orders.SelectMany(a => a.tpkd_dict?.all_tpks).ToList();
 
@@ -230,6 +214,97 @@ public List<ImportableTroveGame> GetTroveGames()
             return selectedProducts;
         }
 
+        public List<GameMetadata> GetLibraryExtras(List<Order> orders)
+        {
+            var extras = new List<GameMetadata>();
+            foreach (var order in orders)
+            {
+                var gameKey = order.gamekey;
+                if (!order.subproducts.HasItems())
+                {
+                    continue;
+                }
+
+                foreach (var product in order.subproducts)
+                {
+                    var productName = product.human_name.RemoveTrademarks();
+                    if (!product.downloads.HasItems())
+                    {
+                        continue;
+                    }
+
+                    foreach (var download in product.downloads)
+                    {
+                        var downloadName = download.machine_name;
+                        if (!download.download_struct.HasItems())
+                        {
+                            continue;
+                        }
+
+                        switch (download.platform)
+                        {
+                            case "windows":
+                            case "mac":
+                            case "linux":
+                                continue;
+                            case "asmjs":
+                                var extraAsGame = new GameMetadata()
+                                {
+                                    GameId = $"{productName}_{downloadName}",
+                                    Source = new MetadataNameProperty("Humble"),
+                                    Name = $"{productName} asm.js version",
+                                    Categories = new HashSet<MetadataProperty>(){new MetadataNameProperty("extras")}, // TODO customizable category across plugins?
+                                    Links = new List<Link>(){new Link("Run_me", $"https://www.humblebundle.com/play/asmjs/{downloadName}/{gameKey}")} // TODO use install action to launch browser?
+                                    // TODO any way to ignore post-actions from other plugins, eg search for metadata?
+                                };
+                                extras.Add(extraAsGame);
+                                continue;
+                        }
+
+                        foreach (var actualDownload in download.download_struct)
+                        {
+                            var url = actualDownload.url.web;
+                            if (string.IsNullOrWhiteSpace(url))
+                            {
+                                continue;
+                            }
+                            var extraAsGame = new GameMetadata()
+                            {
+                                GameId = $"{productName}_{downloadName}_{actualDownload.name}",
+                                Source = new MetadataNameProperty("Humble"),
+                                Name = $"{productName} {download.platform} {actualDownload.name}",
+                                Categories = new HashSet<MetadataProperty>(){new MetadataNameProperty("extras")}, // TODO customizable category across plugins?
+                                Links = new List<Link>(){new Link("Download_me", url)} // TODO use install action to launch browser or DL with playnite itself?
+                                // TODO any way to ignore post-actions from other plugins, eg search for metadata?
+                            };
+                            extras.Add(extraAsGame);
+                        }
+
+
+                    }
+                }
+            }
+
+            return extras;
+        }
+
+        private List<Order> GetAllOrders()
+        {
+            using (var view = PlayniteApi.WebViews.CreateOffscreenView(
+                       new WebViewSettings
+                       {
+                           JavaScriptEnabled = false,
+                           UserAgent = UserAgent
+                       }))
+            {
+                var api = new HumbleAccountClient(view);
+                var keys = api.GetLibraryKeys();
+                var orders = api.GetOrders(keys);
+                // Humble will return null items in library response on some accounts
+                return orders.Where(a => a != null).ToList();
+            }
+        }
+
         public override IEnumerable<Game> ImportGames(LibraryImportGamesArgs args)
         {
             var importedGames = new List<Game>();
@@ -245,8 +320,9 @@ public override IEnumerable<Game> ImportGames(LibraryImportGamesArgs args)
                 {
                     if (SettingsViewModel.Settings.ImportGeneralLibrary)
                     {
-                        var selectedProducts = GetLibraryGames();
-                        foreach (var product in selectedProducts)
+                        var orders = GetAllOrders();
+                        var gameProducts = GetLibraryGames(orders);
+                        foreach (var product in gameProducts)
                         {
                             var gameId = GetGameId(product);
                             if (PlayniteApi.ApplicationSettings.GetGameExcludedFromImport(gameId, Id))
@@ -266,6 +342,19 @@ public override IEnumerable<Game> ImportGames(LibraryImportGamesArgs args)
                                 }, this));
                             }
                         }
+
+                        if (SettingsViewModel.Settings.ImportGameExtras)
+                        {
+                            var extras = GetLibraryExtras(orders);
+                            foreach (var extra in extras)
+                            {
+                                var alreadyImported = PlayniteApi.Database.Games.FirstOrDefault(a => a.PluginId == Id && a.GameId == extra.GameId);
+                                if (alreadyImported == null)
+                                {
+                                    importedGames.Add(PlayniteApi.Database.ImportGame(extra, this));
+                                }
+                            }
+                        }
                     }
                 }
             }
@@ -420,4 +509,4 @@ public override IEnumerable<UninstallController> GetUninstallActions(GetUninstal
             yield return new HumbleUninstallController(args.Game, this);
         }
     }
-}
+}

source/Libraries/HumbleLibrary/HumbleLibrarySettingsView.xaml

@@ -28,6 +28,10 @@
                       IsChecked="{Binding Settings.ImportGeneralLibrary}"
                       Content="{DynamicResource LOCHumbleGeneralLibrary}"
                       ToolTip="{DynamicResource LOCHumbleGeneralLibraryTooltip}" />
+            <CheckBox Margin="0,10,0,0" Name="HumbleImportGameExtras"
+                      IsChecked="{Binding Settings.ImportGameExtras}"
+                      Content="{DynamicResource LOCHumbleImportGameExtras}"
+                      ToolTip="{DynamicResource LOCHumbleImportGameExtrasTooltip}" />
             <StackPanel IsEnabled="{Binding IsChecked, ElementName=HumbleImportGeneralLibrary}">
                 <CheckBox Margin="20,10,0,0" Name="HumbleThirdPartyImport"
                       IsChecked="{Binding Settings.IgnoreThirdPartyStoreGames}"
@@ -40,7 +44,7 @@
                       ToolTip="{DynamicResource LOCHumbleImportThirdPartyDrmFreeTooltip}"/>
             </StackPanel>
             <StackPanel Orientation="Horizontal" Margin="0,10,0,0">
-                <Button Content="{DynamicResource LOCHumbleAuthenticateLabel}" HorizontalAlignment="Left"                         
+                <Button Content="{DynamicResource LOCHumbleAuthenticateLabel}" HorizontalAlignment="Left"
                         Command="{Binding LoginCommand}" Margin="0,5,5,5"/>
                 <TextBlock VerticalAlignment="Center" Margin="10,5,5,5">
                     <TextBlock.Tag>
@@ -81,4 +85,4 @@
             </Hyperlink>
         </TextBlock>
     </StackPanel>
-</UserControl>
+</UserControl>