Files
brass-and-sigil/launcher/Services/ManifestSyncService.cs
Matt 4594cb9c00 Add explicit client/server side field to manifest
Bake each file's "side" (client / server / both) into manifest.json at
build time so both the launcher and the server filter deterministically
and offline. This replaces the launcher's previous "download everything"
default and lets the server short-circuit its runtime Modrinth lookup
when a file already has an authoritative tag.

Schema:
- ManifestFile.Side: "client" | "server" | "both" (null = "both" for
  backward compat with manifests pre-dating this field)
- Files marked "both" omit the field entirely to keep the JSON tight

Code changes:
- launcher Manifest.cs + ManifestSyncService: filter out "server" files
  in both the prune+download path and FindMissingFiles
- server Manifest.cs + ManifestSync: drop "client" files outright; only
  fall back to the existing runtime Modrinth lookup for files with no
  explicit side (legacy/un-tagged mods stay protected)
- server LockedMod: side field propagates into manifest at build time
- scripts/Build-Pack.ps1: propagate side from lockfile to manifest
- scripts/Bootstrap-Sides.ps1: one-off populator; queries Modrinth's
  client_side/server_side per project, conservatively marks restricted
  only when one side is "unsupported", leaves ambiguous cases as "both"
- pack/pack.lock.json: bootstrap-populated sides (3 client, 5 server,
  rest both); CurseForge mods default to "both" pending manual review;
  version bumped 0.9.3 -> 0.10.0 since clients must re-sync

Compatibility:
- Old launcher + new manifest: ignores unknown "side", downloads all
- New launcher + old manifest: side null -> "both", installs all
- Old server + new manifest: same -- runtime Modrinth lookup still works
- New server + old manifest: side null -> runtime lookup, same behaviour
2026-05-22 14:17:43 +00:00

275 lines
10 KiB
C#

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using ModpackLauncher.Models;
namespace ModpackLauncher.Services;
public sealed class ManifestSyncService
{
private const string PackVersionFile = "pack-version.json";
private static readonly string[] ManagedRoots =
{
"mods", "config", "resourcepacks", "shaderpacks", "kubejs", "defaultconfigs"
};
private readonly HttpClient _http;
public ManifestSyncService(HttpClient? http = null)
{
_http = http ?? new HttpClient();
_http.Timeout = TimeSpan.FromMinutes(5);
}
/// <summary>Configure HTTP Basic auth for all subsequent requests. Pass null to clear.</summary>
public void SetBasicAuth(string? username, string? password)
{
if (string.IsNullOrEmpty(username))
{
_http.DefaultRequestHeaders.Authorization = null;
return;
}
var raw = $"{username}:{password ?? ""}";
var b64 = Convert.ToBase64String(System.Text.Encoding.UTF8.GetBytes(raw));
_http.DefaultRequestHeaders.Authorization =
new System.Net.Http.Headers.AuthenticationHeaderValue("Basic", b64);
}
public sealed record SyncResult(Manifest Manifest, int Downloaded, int Removed);
/// <summary>Just fetch the manifest JSON without doing the full file sync. Used for "is an update available?" checks on startup.</summary>
public async Task<Manifest> FetchManifestOnlyAsync(string manifestUrl, CancellationToken ct = default)
{
var json = await _http.GetStringAsync(manifestUrl, ct).ConfigureAwait(false);
var manifest = JsonSerializer.Deserialize<Manifest>(json, new JsonSerializerOptions
{
PropertyNameCaseInsensitive = true
});
if (manifest == null) throw new InvalidOperationException("Manifest is empty or invalid.");
manifest.Files ??= new System.Collections.Generic.List<ManifestFile>();
return manifest;
}
/// <summary>
/// Fast check (no hashing): which files listed in the manifest are missing on disk.
/// Used as a pre-launch sanity pass to catch AV quarantines / interrupted installs.
/// </summary>
public System.Collections.Generic.List<ManifestFile> FindMissingFiles(Manifest manifest, string installDir)
{
var missing = new System.Collections.Generic.List<ManifestFile>();
foreach (var file in manifest.Files)
{
if (IsServerOnly(file)) continue; // never expected on disk client-side
var dest = Path.Combine(installDir, file.Path);
if (!File.Exists(dest)) missing.Add(file);
}
return missing;
}
public PackVersionRecord? GetLocalPackVersion(string installDir)
{
var path = Path.Combine(installDir, PackVersionFile);
if (!File.Exists(path)) return null;
try
{
return JsonSerializer.Deserialize<PackVersionRecord>(File.ReadAllText(path));
}
catch
{
return null;
}
}
public async Task<SyncResult> SyncAsync(
string manifestUrl,
string installDir,
IProgress<ProgressReport> progress,
CancellationToken ct = default)
{
progress.Report(new ProgressReport(ProgressKind.Status, "Fetching manifest..."));
var manifestJson = await _http.GetStringAsync(manifestUrl, ct).ConfigureAwait(false);
var manifest = JsonSerializer.Deserialize<Manifest>(manifestJson, new JsonSerializerOptions
{
PropertyNameCaseInsensitive = true
}) ?? throw new InvalidOperationException("Manifest is empty or invalid.");
if (string.IsNullOrWhiteSpace(manifest.Minecraft.Version))
{
throw new InvalidOperationException("Manifest is missing minecraft.version.");
}
Directory.CreateDirectory(installDir);
var local = GetLocalPackVersion(installDir);
progress.Report(new ProgressReport(
ProgressKind.Status,
$"Pack: {manifest.Name ?? "modpack"} v{manifest.Version ?? "?"} (local: {local?.Version ?? "none"})"
));
// Drop server-only files before computing wanted/download sets. Doing
// it once here means the rest of the sync (prune + download) doesn't
// need to know about sides. Unknown/missing/'both' = include on client.
var serverOnlyCount = manifest.Files.Count(f => IsServerOnly(f));
if (serverOnlyCount > 0)
{
manifest.Files = manifest.Files.Where(f => !IsServerOnly(f)).ToList();
progress.Report(new ProgressReport(
ProgressKind.Log,
$"Skipping {serverOnlyCount} server-only file(s) declared in manifest."
));
}
var wantedPaths = new HashSet<string>(
manifest.Files.Select(f => NormalizePath(f.Path)),
StringComparer.OrdinalIgnoreCase
);
// Remove managed files no longer in manifest
var toRemove = new List<string>();
foreach (var root in ManagedRoots)
{
var rootDir = Path.Combine(installDir, root);
if (!Directory.Exists(rootDir)) continue;
foreach (var file in Directory.EnumerateFiles(rootDir, "*", SearchOption.AllDirectories))
{
var rel = NormalizePath(Path.GetRelativePath(installDir, file));
if (!wantedPaths.Contains(rel))
{
toRemove.Add(file);
}
}
}
foreach (var file in toRemove)
{
try
{
File.Delete(file);
progress.Report(new ProgressReport(
ProgressKind.Log,
$"Removed: {Path.GetRelativePath(installDir, file)}"
));
}
catch (Exception ex)
{
progress.Report(new ProgressReport(
ProgressKind.Log,
$"Could not remove {file}: {ex.Message}"
));
}
}
// Determine what to download
var toDownload = new List<ManifestFile>();
foreach (var file in manifest.Files)
{
ct.ThrowIfCancellationRequested();
var dest = Path.Combine(installDir, file.Path);
if (!File.Exists(dest))
{
toDownload.Add(file);
continue;
}
if (!string.IsNullOrEmpty(file.Sha1))
{
var actual = await ComputeSha1Async(dest, ct).ConfigureAwait(false);
if (!string.Equals(actual, file.Sha1, StringComparison.OrdinalIgnoreCase))
{
toDownload.Add(file);
}
}
}
progress.Report(new ProgressReport(
ProgressKind.Status,
toDownload.Count == 0 ? "Already up-to-date." : $"Downloading {toDownload.Count} file(s)..."
));
for (int i = 0; i < toDownload.Count; i++)
{
ct.ThrowIfCancellationRequested();
var file = toDownload[i];
var pct = toDownload.Count == 0 ? 100 : (i * 100.0 / toDownload.Count);
progress.Report(new ProgressReport(
ProgressKind.Progress,
$"Downloading {file.Path}",
Current: i + 1,
Total: toDownload.Count,
Percent: pct
));
var dest = Path.Combine(installDir, file.Path);
await DownloadFileAsync(file.Url, dest, file.Sha1, ct).ConfigureAwait(false);
}
var record = new PackVersionRecord
{
Name = manifest.Name,
Version = manifest.Version,
SyncedAt = DateTime.UtcNow.ToString("o")
};
await File.WriteAllTextAsync(
Path.Combine(installDir, PackVersionFile),
JsonSerializer.Serialize(record, new JsonSerializerOptions { WriteIndented = true }),
ct
).ConfigureAwait(false);
progress.Report(new ProgressReport(ProgressKind.Status, "Sync complete."));
return new SyncResult(manifest, toDownload.Count, toRemove.Count);
}
private async Task DownloadFileAsync(string url, string destPath, string? expectedSha1, CancellationToken ct)
{
Directory.CreateDirectory(Path.GetDirectoryName(destPath)!);
var tmp = destPath + ".part";
using (var response = await _http.GetAsync(url, HttpCompletionOption.ResponseHeadersRead, ct).ConfigureAwait(false))
{
response.EnsureSuccessStatusCode();
await using var src = await response.Content.ReadAsStreamAsync(ct).ConfigureAwait(false);
await using var dst = File.Create(tmp);
await src.CopyToAsync(dst, ct).ConfigureAwait(false);
}
if (!string.IsNullOrEmpty(expectedSha1))
{
var actual = await ComputeSha1Async(tmp, ct).ConfigureAwait(false);
if (!string.Equals(actual, expectedSha1, StringComparison.OrdinalIgnoreCase))
{
File.Delete(tmp);
throw new InvalidOperationException(
$"Hash mismatch for {Path.GetFileName(destPath)} (expected {expectedSha1}, got {actual})"
);
}
}
if (File.Exists(destPath)) File.Delete(destPath);
File.Move(tmp, destPath);
}
private static async Task<string> ComputeSha1Async(string path, CancellationToken ct)
{
using var sha = SHA1.Create();
await using var stream = File.OpenRead(path);
var bytes = await sha.ComputeHashAsync(stream, ct).ConfigureAwait(false);
return Convert.ToHexString(bytes).ToLowerInvariant();
}
private static string NormalizePath(string p) => p.Replace('\\', '/').TrimStart('/');
/// <summary>
/// True if this manifest file is tagged as server-only and therefore
/// should not be installed on the client. Unknown/null/'both' = false
/// (always include) so manifests pre-dating the field still install.
/// </summary>
private static bool IsServerOnly(ManifestFile f)
=> string.Equals(f.Side, "server", StringComparison.OrdinalIgnoreCase);
}