Index files from Steam

Abstractions/NexusMods.Abstractions.Steam/DTOs/Depot.cs

@@ -0,0 +1,24 @@
+using NexusMods.Abstractions.Steam.Values;
+
+namespace NexusMods.Abstractions.Steam.DTOs;
+
+/// <summary>
+/// Information about a depot on Steam.
+/// </summary>
+public class Depot
+{
+    /// <summary>
+    /// The OSes that the depot is available on.
+    /// </summary>
+    public required string[] OsList { get; init; }
+
+    /// <summary>
+    /// The id of the depot.
+    /// </summary>
+    public required DepotId DepotId { get; init; }
+
+    /// <summary>
+    /// The manifests associated with the depot, with a key for each available branch
+    /// </summary>
+    public required Dictionary<string, ManifestInfo> Manifests { get; init; }
+}

Abstractions/NexusMods.Abstractions.Steam/DTOs/Manifest.cs

@@ -0,0 +1,93 @@
+using NexusMods.Abstractions.Hashes;
+using NexusMods.Abstractions.Steam.Values;
+using NexusMods.Paths;
+
+namespace NexusMods.Abstractions.Steam.DTOs;
+
+/// <summary>
+/// A full, detailed manifest for a specific manifest id
+/// </summary>
+public class Manifest
+{
+    /// <summary>
+    /// The gid of the manifest
+    /// </summary>
+    public required ManifestId ManifestId { get; init; }
+
+    /// <summary>
+    /// The files in the manifest
+    /// </summary>
+    public required FileData[] Files { get; init; }
+
+    /// <summary>
+    /// The depot id of the manifest
+    /// </summary>
+    public required DepotId DepotId { get; init; }
+
+    /// <summary>
+    /// The time the manifest was created
+    /// </summary>
+    public required DateTimeOffset CreationTime { get; init; }
+
+    /// <summary>
+    /// The size of all files in the manifest, compressed
+    /// </summary>
+    public required Size TotalCompressedSize { get; init; }
+
+    /// <summary>
+    /// The size of all files in the manifest, uncompressed
+    /// </summary>
+    public required Size TotalUncompressedSize { get; init; }
+
+    public class FileData
+    {
+        /// <summary>
+        /// The name of the file
+        /// </summary>
+        public RelativePath Path { get; init; }
+
+        /// <summary>
+        /// The size of the file, compressed
+        /// </summary>
+        public Size Size { get; init; }
+
+        /// <summary>
+        /// The Sha1 hash of the file
+        /// </summary>
+        public required Sha1 Hash { get; init; }
+
+        /// <summary>
+        /// The chunks of the file
+        /// </summary>
+        public required Chunk[] Chunks { get; init; }
+    }
+
+    public class Chunk
+    {
+        /// <summary>
+        /// The id of the chunk
+        /// </summary>
+        public required Sha1 ChunkId { get; init; }
+
+        /// <summary>
+        /// The crc32 checksum of the chunk
+        /// </summary>
+        public required Crc32 Checksum { get; init; }
+
+        /// <summary>
+        /// The offset of the chunk in the resulting file
+        /// </summary>
+        public required ulong Offset { get; init; }
+
+        /// <summary>
+        /// The size of the chunk, compressed
+        /// </summary>
+        public required Size CompressedSize { get; init; }
+
+        /// <summary>
+        /// The size of the chunk, uncompressed
+        /// </summary>
+        public required Size UncompressedSize { get; init; }
+
+    }
+}

Abstractions/NexusMods.Abstractions.Steam/DTOs/ManifestInfo.cs

@@ -0,0 +1,26 @@
+using NexusMods.Abstractions.Steam.Values;
+using NexusMods.Paths;
+
+namespace NexusMods.Abstractions.Steam.DTOs;
+
+/// <summary>
+/// Meta information about a manifest, not the actual contents, just the id
+/// and the size of the files in aggregate.
+/// </summary>
+public class ManifestInfo
+{
+    /// <summary>
+    /// The globally unique identifier of the manifest.
+    /// </summary>
+    public required ManifestId ManifestId { get; init; }
+
+    /// <summary>
+    /// The size of the downloaded files, decompressed
+    /// </summary>
+    public required Size Size { get; init; }
+
+    /// <summary>
+    /// The size of the files, compressed
+    /// </summary>
+    public required Size DownloadSize { get; init; }
+}

Abstractions/NexusMods.Abstractions.Steam/DTOs/ProductInfo.cs

@@ -0,0 +1,24 @@
+using NexusMods.Abstractions.Steam.Values;
+
+namespace NexusMods.Abstractions.Steam.DTOs;
+
+/// <summary>
+/// Information about a product (a game) on Steam.
+/// </summary>
+public class ProductInfo
+{
+    /// <summary>
+    /// The revision number of this product info.
+    /// </summary>
+    public required uint ChangeNumber { get; init; }
+
+    /// <summary>
+    /// The app id of the product.
+    /// </summary>
+    public required AppId AppId { get; init; }
+
+    /// <summary>
+    /// The depots of the product.
+    /// </summary>
+    public required Depot[] Depots { get; init; }
+}

Abstractions/NexusMods.Abstractions.Steam/IAuthInterventionHandler.cs

@@ -0,0 +1,12 @@
+namespace NexusMods.Abstractions.Steam;
+
+/// <summary>
+/// A user intervention handler that can be used to request authorization information from the user.
+/// </summary>
+public interface IAuthInterventionHandler
+{
+    /// <summary>
+    /// Display a QR code to the user for the given uri. When the token is cancelled, the QR code should be hidden.
+    /// </summary>
+    public void ShowQRCode(Uri uri, CancellationToken token);
+}

Abstractions/NexusMods.Abstractions.Steam/IAuthStorage.cs

@@ -0,0 +1,17 @@
+namespace NexusMods.Abstractions.Steam;
+
+/// <summary>
+/// Interface for abstracting away the storage of Steam authentication data.
+/// </summary>
+public interface IAuthStorage
+{
+    /// <summary>
+    /// Tries to load the authentication data, if it does not exist or fails to load, returns false.
+    /// </summary>
+    public Task<(bool Success, byte[] Data)> TryLoad();
+
+    /// <summary>
+    /// Saves the authentication data.
+    /// </summary>
+    public Task SaveAsync(byte[] data);
+}

Abstractions/NexusMods.Abstractions.Steam/ISteamSession.cs

@@ -0,0 +1,26 @@
+using NexusMods.Abstractions.Steam.DTOs;
+using NexusMods.Abstractions.Steam.Values;
+using NexusMods.Paths;
+
+namespace NexusMods.Abstractions.Steam;
+
+/// <summary>
+/// An abstraction for a Steam session.
+/// </summary>
+public interface ISteamSession
+{
+    /// <summary>
+    /// Get the product info for the specified app ID
+    /// </summary>
+    public Task<ProductInfo> GetProductInfoAsync(AppId appId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Get the manifest data for a specific manifest
+    /// </summary>
+    public Task<Manifest> GetManifestContents(AppId appId, DepotId depotId, ManifestId manifestId, string branch, CancellationToken token = default);
+
+    /// <summary>
+    /// Get a readable, seekable, stream for the specified file in the specified manifest
+    /// </summary>
+    public Stream GetFileStream(AppId appId, Manifest manifest, RelativePath file);
+}

Abstractions/NexusMods.Abstractions.Steam/NexusMods.Abstractions.Steam.csproj

@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <Import Project="$([MSBuild]::GetPathOfFileAbove('NuGet.Build.props', '$(MSBuildThisFileDirectory)../'))" />
+
+    <ItemGroup>
+        <PackageReference Include="NexusMods.Paths" />
+        <PackageReference Include="TransparentValueObjects" PrivateAssets="all" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\..\src\Abstractions\NexusMods.Abstractions.Hashes\NexusMods.Abstractions.Hashes.csproj" />
+    </ItemGroup>
+</Project>

Abstractions/NexusMods.Abstractions.Steam/Values/AppId.cs

@@ -0,0 +1,12 @@
+using TransparentValueObjects;
+
+namespace NexusMods.Abstractions.Steam.Values;
+
+/// <summary>
+/// A globally unique identifier for an application on Steam.
+/// </summary>
+[ValueObject<uint>]
+public readonly partial struct AppId : IAugmentWith<JsonAugment>
+{
+
+}

Abstractions/NexusMods.Abstractions.Steam/Values/DepotId.cs

@@ -0,0 +1,12 @@
+using TransparentValueObjects;
+
+namespace NexusMods.Abstractions.Steam.Values;
+
+/// <summary>
+/// A globally unique identifier for a depot, a reference to a collection of files on the Steam CDN.
+/// </summary>
+[ValueObject<uint>]
+public readonly partial struct DepotId : IAugmentWith<JsonAugment>
+{
+
+}

Abstractions/NexusMods.Abstractions.Steam/Values/ManifestId.cs

@@ -0,0 +1,12 @@
+using TransparentValueObjects;
+
+namespace NexusMods.Abstractions.Steam.Values;
+
+/// <summary>
+/// A global unique identifier for a manifest, a specific collection of files that can be downloaded
+/// </summary>
+[ValueObject<ulong>]
+public readonly partial struct ManifestId : IAugmentWith<JsonAugment>
+{
+
+}

Directory.Packages.props

@@ -31,10 +31,12 @@
     <PackageVersion Include="ObservableCollections" Version="3.3.2" />
     <PackageVersion Include="ObservableCollections.R3" Version="3.3.2" />
     <PackageVersion Include="QoiSharp" Version="1.0.0" />
+    <PackageVersion Include="QRCoder" Version="1.6.0" />
     <PackageVersion Include="R3" Version="1.2.9" />
     <PackageVersion Include="R3Extensions.Avalonia" Version="1.2.9" />
     <PackageVersion Include="ReactiveUI" Version="20.1.63" />
     <PackageVersion Include="Spectre.Console.Testing" Version="0.49.1" />
+    <PackageVersion Include="SteamKit2" Version="3.0.0" />
     <PackageVersion Include="StrawberryShake.Server" Version="14.1.0" />
     <PackageVersion Include="System.Linq" Version="4.3.0" />
     <PackageVersion Include="System.Text.Json" Version="9.0.0" VersionOverride="9.0.0" />

NexusMods.App.sln

@@ -278,6 +278,14 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Games.MountAndBla
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Telemetry.Tests", "tests\NexusMods.Telemetry.Tests\NexusMods.Telemetry.Tests.csproj", "{336387F7-3635-43FE-9C23-CBC0CE534989}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Networking.Steam", "src\Networking\NexusMods.Networking.Steam\NexusMods.Networking.Steam.csproj", "{4A501BBB-389C-460C-B0C3-6F2F968773B1}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Abstractions.Steam", "Abstractions\NexusMods.Abstractions.Steam\NexusMods.Abstractions.Steam.csproj", "{24457AAA-8954-4BD6-8EB5-168EAC6EFB1B}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Networking.Steam.Tests", "tests\Networking\NexusMods.Networking.Steam.Tests\NexusMods.Networking.Steam.Tests.csproj", "{17023DB9-8E31-4397-B3E1-141149987865}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Abstractions.Hashes", "src\Abstractions\NexusMods.Abstractions.Hashes\NexusMods.Abstractions.Hashes.csproj", "{AF703852-D7B0-4BAD-8C75-B6046C6F0490}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -728,6 +736,22 @@ Global
 		{336387F7-3635-43FE-9C23-CBC0CE534989}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{336387F7-3635-43FE-9C23-CBC0CE534989}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{336387F7-3635-43FE-9C23-CBC0CE534989}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4A501BBB-389C-460C-B0C3-6F2F968773B1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4A501BBB-389C-460C-B0C3-6F2F968773B1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4A501BBB-389C-460C-B0C3-6F2F968773B1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4A501BBB-389C-460C-B0C3-6F2F968773B1}.Release|Any CPU.Build.0 = Release|Any CPU
+		{24457AAA-8954-4BD6-8EB5-168EAC6EFB1B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{24457AAA-8954-4BD6-8EB5-168EAC6EFB1B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{24457AAA-8954-4BD6-8EB5-168EAC6EFB1B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{24457AAA-8954-4BD6-8EB5-168EAC6EFB1B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{17023DB9-8E31-4397-B3E1-141149987865}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{17023DB9-8E31-4397-B3E1-141149987865}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{17023DB9-8E31-4397-B3E1-141149987865}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{17023DB9-8E31-4397-B3E1-141149987865}.Release|Any CPU.Build.0 = Release|Any CPU
+		{AF703852-D7B0-4BAD-8C75-B6046C6F0490}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{AF703852-D7B0-4BAD-8C75-B6046C6F0490}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{AF703852-D7B0-4BAD-8C75-B6046C6F0490}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{AF703852-D7B0-4BAD-8C75-B6046C6F0490}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -857,6 +881,10 @@ Global
 		{A5A2932D-B3EF-480B-BEBC-793F6FC90EDE} = {52AF9D62-7D5B-4AD0-BA12-86F2AA67428B}
 		{8D7E82BB-2F8D-455A-AF12-C486D9EC3B77} = {70D38D24-79AE-4600-8E83-17F3C11BA81F}
 		{336387F7-3635-43FE-9C23-CBC0CE534989} = {52AF9D62-7D5B-4AD0-BA12-86F2AA67428B}
+		{4A501BBB-389C-460C-B0C3-6F2F968773B1} = {D7E9D8F5-8AC8-4ADA-B219-C549084AD84C}
+		{24457AAA-8954-4BD6-8EB5-168EAC6EFB1B} = {0CB73565-1207-4A56-A79F-6A8E9BBD795C}
+		{17023DB9-8E31-4397-B3E1-141149987865} = {897C4198-884F-448A-B0B0-C2A6D971EAE0}
+		{AF703852-D7B0-4BAD-8C75-B6046C6F0490} = {0CB73565-1207-4A56-A79F-6A8E9BBD795C}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {9F9F8352-34DD-42C0-8564-EE9AF34A3501}

NexusMods.App.sln.DotSettings

@@ -44,6 +44,7 @@
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=MIME/@EntryIndexedValue">MIME</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=NXM/@EntryIndexedValue">NXM</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=OSX/@EntryIndexedValue">OSX</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=QR/@EntryIndexedValue">QR</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=SMAPI/@EntryIndexedValue">SMAPI</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=VM/@EntryIndexedValue">VM</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/XamlNaming/Abbreviations/=LG/@EntryIndexedValue">LG</s:String>

src/Abstractions/NexusMods.Abstractions.Cli/Renderable.cs

@@ -8,17 +8,22 @@
 public static class Renderable
 {
     /// <summary>
     /// Creates a new <see cref="Text"/> renderable.
     /// </summary>
     /// <param name="template"></param>
     /// <returns></returns>
     public static Text Text(string template) => new Text { Template = template };
 
     /// <summary>
     /// Creates a new <see cref="Text"/> renderable out of the given arguments and template.
     /// </summary>
     /// <param name="template"></param>
     /// <returns></returns>
     public static Text Text(string template, string[] args) => new Text { Template = template, Arguments = args};
+
+    /// <summary>
+    /// Creates a new <see cref="Text"/> renderable with a new line at the end.
+    /// </summary>
+    public static Text TextLine(string template) => new Text { Template = template + "\n" };
 
 }