Store installer logos in the payload (#126)

Author: SuperJMN

src/DotnetPackaging.Exe.Installer/Core/BrandingLogoFactory.cs

@@ -0,0 +1,25 @@
+using Avalonia.Media.Imaging;
+using Zafiro.DivineBytes;
+
+namespace DotnetPackaging.Exe.Installer.Core;
+
+internal static class BrandingLogoFactory
+{
+    public static IBitmap? FromBytes(IByteSource? bytes)
+    {
+        if (bytes is null)
+        {
+            return null;
+        }
+
+        try
+        {
+            using var stream = bytes.ToStreamSeekable();
+            return new Bitmap(stream);
+        }
+        catch
+        {
+            return null;
+        }
+    }
+}

src/DotnetPackaging.Exe.Installer/Core/DefaultInstallerPayload.cs

@@ -1,4 +1,5 @@
 using CSharpFunctionalExtensions;
+using Zafiro.DivineBytes;
 using Zafiro.ProgressReporting;
 
 namespace DotnetPackaging.Exe.Installer.Core;
@@ -14,6 +15,9 @@ public Task<Result<InstallerMetadata>> GetMetadata(CancellationToken ct = defaul
     public Task<Result<long>> GetContentSize(CancellationToken ct = default)
         => EnsureLoaded(ct).Map(p => p.ContentSizeBytes);
 
+    public Task<Result<Maybe<IByteSource>>> GetLogo(CancellationToken ct = default)
+        => EnsureLoaded(ct).Map(p => p.Logo);
+
     public Task<Result> CopyContents(string targetDirectory, IObserver<Progress>? progressObserver = null, CancellationToken ct = default)
         => EnsureLoaded(ct).Bind(p => Task.Run(() =>
             PayloadExtractor.CopyContentTo(p, targetDirectory, progressObserver), ct));

src/DotnetPackaging.Exe.Installer/Core/IInstallerPayload.cs

@@ -1,4 +1,5 @@
 using CSharpFunctionalExtensions;
+using Zafiro.DivineBytes;
 using Zafiro.ProgressReporting;
 
 namespace DotnetPackaging.Exe.Installer.Core;
@@ -9,6 +10,8 @@ public interface IInstallerPayload
 
     Task<Result<long>> GetContentSize(CancellationToken ct = default);
 
+    Task<Result<Maybe<IByteSource>>> GetLogo(CancellationToken ct = default);
+
     Task<Result> CopyContents(
         string targetDirectory,
         IObserver<Progress>? progressObserver = null,

src/DotnetPackaging.Exe.Installer/Core/InstallerMetadata.cs

@@ -6,4 +6,5 @@ public sealed record InstallerMetadata(
     string Version,
     string Vendor,
     string? Description = null,
-    string? ExecutableName = null);
+    string? ExecutableName = null,
+    bool HasLogo = false);

src/DotnetPackaging.Exe.Installer/Core/MetadataFilePayload.cs

@@ -1,5 +1,6 @@
 using System.Text.Json;
 using CSharpFunctionalExtensions;
+using Zafiro.DivineBytes;
 using Zafiro.ProgressReporting;
 
 namespace DotnetPackaging.Exe.Installer.Core;
@@ -54,6 +55,11 @@ public Task<Result<long>> GetContentSize(CancellationToken ct = default)
         return Task.FromResult(Result.Failure<long>("Disk-only payload does not provide installation content."));
     }
 
+    public Task<Result<Maybe<IByteSource>>> GetLogo(CancellationToken ct = default)
+    {
+        return Task.FromResult(Result.Success(Maybe<IByteSource>.None));
+    }
+
     public Task<Result> CopyContents(string targetDirectory, IObserver<Progress>? progressObserver = null, CancellationToken ct = default)
     {
         return Task.FromResult(Result.Failure("Disk-only payload does not provide installation content."));

src/DotnetPackaging.Exe.Installer/Core/PayloadExtractor.cs

@@ -12,6 +12,7 @@ namespace DotnetPackaging.Exe.Installer.Core;
 internal static class PayloadExtractor
 {
     private const string Magic = "DPACKEXE1"; // legacy footer (concat mode)
+    private const string BrandingLogoEntry = "Branding/logo";
 
     public static Result<InstallerPayload> LoadPayload()
     {
@@ -220,7 +221,8 @@ private static Result<InstallerPayload> CreatePayload(PayloadLocation location)
                     payloadMetadata.Metadata,
                     ByteSource.FromBytes(bytes),
                     location.TempDir,
-                    payloadMetadata.ContentSizeBytes)));
+                    payloadMetadata.ContentSizeBytes,
+                    ExtractLogo(bytes))));
 
         TryDeleteFile(location.ZipPath);
 
@@ -251,6 +253,29 @@ private static Result<PayloadMetadata> ReadMetadata(byte[] zipBytes)
         }, ex => $"Error reading payload metadata: {ex.Message}");
     }
 
+    private static Maybe<IByteSource> ExtractLogo(byte[] zipBytes)
+    {
+        try
+        {
+            using var stream = new MemoryStream(zipBytes, writable: false);
+            using var archive = new ZipArchive(stream, ZipArchiveMode.Read, leaveOpen: false);
+            var entry = archive.GetEntry(BrandingLogoEntry);
+            if (entry is null)
+            {
+                return Maybe<IByteSource>.None;
+            }
+
+            using var entryStream = entry.Open();
+            using var buffer = new MemoryStream();
+            entryStream.CopyTo(buffer);
+            return Maybe<IByteSource>.From(ByteSource.FromBytes(buffer.ToArray()));
+        }
+        catch
+        {
+            return Maybe<IByteSource>.None;
+        }
+    }
+
     private sealed record PayloadMetadata(InstallerMetadata Metadata, long ContentSizeBytes);
 
     private static Maybe<PayloadLocation> TryExtractFromManagedResource()
@@ -613,10 +638,10 @@ private static Result<InstallerPayload> CreateDebugPayload()
 
             var payloadMetadata = payloadMetadataResult.Value;
 
-            return new InstallerPayload(metadata, ByteSource.FromBytes(payloadBytes), tempDir, payloadMetadata.ContentSizeBytes);
+            return new InstallerPayload(metadata, ByteSource.FromBytes(payloadBytes), tempDir, payloadMetadata.ContentSizeBytes, Maybe<IByteSource>.None);
         }, ex => $"Failed to create debug payload: {ex.Message}");
     }
 #endif
 }
 
-public sealed record InstallerPayload(InstallerMetadata Metadata, IByteSource Content, string WorkingDirectory, long ContentSizeBytes);
+public sealed record InstallerPayload(InstallerMetadata Metadata, IByteSource Content, string WorkingDirectory, long ContentSizeBytes, Maybe<IByteSource> Logo);

src/DotnetPackaging.Exe.Installer/Installation/Wizard/Welcome/IWelcomeViewModel.cs

@@ -1,12 +1,17 @@
 using System.Reactive;
+using Avalonia.Media.Imaging;
 using CSharpFunctionalExtensions;
 using DotnetPackaging.Exe.Installer.Core;
+using Reactive.Bindings;
 using ReactiveUI;
+using Zafiro.DivineBytes;
 
 namespace DotnetPackaging.Exe.Installer.Installation.Wizard.Welcome;
 
 public interface IWelcomeViewModel
 {
     Reactive.Bindings.ReactiveProperty<InstallerMetadata?> Metadata { get; }
     ReactiveCommand<Unit, Result<InstallerMetadata>> LoadMetadata { get; }
+    ReactiveCommand<Unit, Result<Maybe<IByteSource>>> LoadLogo { get; }
+    ReadOnlyReactivePropertySlim<IBitmap?> Logo { get; }
 }

src/DotnetPackaging.Exe.Installer/Installation/Wizard/Welcome/WelcomeView.axaml

@@ -13,11 +13,17 @@
     <Interaction.Behaviors>
         <LoadedTrigger>
             <InvokeCommandAction Command="{Binding LoadMetadata}" />
+            <InvokeCommandAction Command="{Binding LoadLogo}" />
         </LoadedTrigger>
     </Interaction.Behaviors>
 
     <Loading IsLoading="{Binding LoadMetadata.IsExecuting^}">
         <DockPanel VerticalSpacing="12">
+            <Image DockPanel.Dock="Right"
+                   Width="96"
+                   Height="96"
+                   Source="{Binding Logo}"
+                   Stretch="Uniform" />
             <TextBlock DockPanel.Dock="Top" TextWrapping="Wrap" Text="{Binding Metadata.Value.ApplicationName, StringFormat='Welcome to the {0} installation wizard'}" FontSize="20" FontWeight="Bold" />
             <TextBlock DockPanel.Dock="Bottom" HorizontalAlignment="Right" Text="{Binding Metadata.Value.Version, StringFormat='Version {0}'}" />
             <TextBlock DockPanel.Dock="Top" Text="{Binding Metadata.Value.ApplicationName, StringFormat='This wizard will help you install {0} on this system'}" />

src/DotnetPackaging.Exe.Installer/Installation/Wizard/Welcome/WelcomeViewModel.cs

@@ -1,10 +1,15 @@
-using System.Reactive;
+using System.Reactive;
+using System.Reactive.Linq;
+using Avalonia.Media.Imaging;
 using CSharpFunctionalExtensions;
 using DotnetPackaging.Exe.Installer.Core;
+using Reactive.Bindings;
+using Reactive.Bindings.Extensions;
 using ReactiveUI;
 using ReactiveUI.Validation.Extensions;
 using ReactiveUI.Validation.Helpers;
 using Zafiro.CSharpFunctionalExtensions;
+using Zafiro.DivineBytes;
 using Zafiro.UI;
 
 namespace DotnetPackaging.Exe.Installer.Installation.Wizard.Welcome;
@@ -17,13 +22,24 @@ public WelcomeViewModel(IInstallerPayload payload)
     {
         this.payload = payload;
         LoadMetadata = ReactiveCommand.CreateFromTask(() => this.payload.GetMetadata());
-        Metadata = new Reactive.Bindings.ReactiveProperty<InstallerMetadata?>(LoadMetadata.Successes());
+        Metadata = new ReactiveProperty<InstallerMetadata?>(LoadMetadata.Successes());
         this.ValidationRule(model => model.Metadata.Value, m => m is not null, "Metadata is required");
+
+        LoadLogo = ReactiveCommand.CreateFromTask(() => payload.GetLogo());
+
+        Logo = LoadLogo
+            .Successes()
+            .Select(logoBytes => logoBytes.Match(BrandingLogoFactory.FromBytes, () => (IBitmap?)null))
+            .ToReadOnlyReactivePropertySlim();
     }
 
-    public Reactive.Bindings.ReactiveProperty<InstallerMetadata?> Metadata { get; }
+    public ReactiveProperty<InstallerMetadata?> Metadata { get; }
 
     public ReactiveCommand<Unit, Result<InstallerMetadata>> LoadMetadata { get; }
 
+    public ReactiveCommand<Unit, Result<Maybe<IByteSource>>> LoadLogo { get; }
+
+    public ReadOnlyReactivePropertySlim<IBitmap?> Logo { get; }
+
     public IObservable<bool> IsValid => this.IsValid();
 }

src/DotnetPackaging.Exe.Installer/Installation/Wizard/Welcome/WelcomeViewModelMock.cs

@@ -1,22 +1,48 @@
+using System;
 using System.Reactive;
+using Avalonia.Media.Imaging;
 using CSharpFunctionalExtensions;
 using DotnetPackaging.Exe.Installer.Core;
+using Reactive.Bindings;
+using Reactive.Bindings.Extensions;
 using ReactiveUI;
+using Zafiro.DivineBytes;
 
 namespace DotnetPackaging.Exe.Installer.Installation.Wizard.Welcome;
 
 public class WelcomeViewModelMock : IWelcomeViewModel
 {
+    private static readonly byte[] SampleLogo = Convert.FromBase64String("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAoMBgNkHFN0AAAAASUVORK5CYII=");
+
     public WelcomeViewModelMock()
     {
-        Metadata = new Reactive.Bindings.ReactiveProperty<InstallerMetadata>(new InstallerMetadata(
+        Metadata = new ReactiveProperty<InstallerMetadata>(new InstallerMetadata(
             "com.example.app",
             "Example App",
             "1.0.0",
-            "Example, Inc.", Description: "This is an example app. It does nothing. It's just a demo."));
+            "Example, Inc.",
+            Description: "This is an example app. It does nothing. It's just a demo.",
+            HasLogo: true));
+
+        LoadLogo = ReactiveCommand.Create(() => Result.Success(Maybe<IByteSource>.From(ByteSource.FromBytes(SampleLogo))));
+
+        Logo = LoadLogo
+            .Successes()
+            .Select(logoBytes => logoBytes.Match(BrandingLogoFactory.FromBytes, () => (IBitmap?)null))
+            .ToReadOnlyReactivePropertySlim();
     }
 
-    public Reactive.Bindings.ReactiveProperty<InstallerMetadata?> Metadata { get; }
+    public ReactiveProperty<InstallerMetadata?> Metadata { get; }
+
+    public ReactiveCommand<Unit, Result<InstallerMetadata>> LoadMetadata { get; } = ReactiveCommand.Create(() => Result.Success(new InstallerMetadata(
+        "com.example.app",
+        "Example App",
+        "1.0.0",
+        "Example, Inc.",
+        Description: "This is an example app. It does nothing. It's just a demo.",
+        HasLogo: true)));
+
+    public ReactiveCommand<Unit, Result<Maybe<IByteSource>>> LoadLogo { get; }
 
-    public ReactiveCommand<Unit, Result<InstallerMetadata>> LoadMetadata { get; }
-}
+    public ReadOnlyReactivePropertySlim<IBitmap?> Logo { get; }
+}