Add ability to remove entry from the bundle

Author: Aeliux

src/EasySign/Bundle.cs

@@ -27,10 +27,12 @@ public class Bundle
         private readonly string _bundleName;
         private byte[] _rawZipContents = [];
 
-        private readonly Dictionary<string, X509Certificate2> _certCache = new();
-        private readonly ConcurrentDictionary<string, byte[]> _newEmbeddedFiles = new();
+        private readonly ConcurrentDictionary<string, X509Certificate2> _certCache = new();
         private readonly ConcurrentDictionary<string, byte[]> _fileCache = new();
 
+        private readonly ConcurrentDictionary<string, byte[]> _pendingForAdd = new();
+        private readonly List<string> _pendingForRemove = new();
+
         /// <summary>
         /// Gets the JSON serializer options.
         /// </summary>
@@ -281,8 +283,35 @@ public void AddEntry(string path, string destinationPath = "./", string? rootPat
 
             if (Manifest.StoreOriginalFiles)
             {
-                Logger.LogDebug("Embedding file: {name} in the bundle", name);
-                _newEmbeddedFiles[name] = File.ReadAllBytes(path);
+                Logger.LogDebug("Pending file: {name} for embedding in the bundle", name);
+                _pendingForAdd[name] = File.ReadAllBytes(path);
+            }
+        }
+
+        /// <summary>
+        /// Deletes an entry from the bundle.
+        /// </summary>
+        /// <param name="entryName">The name of the entry to delete.</param>
+        public void DeleteEntry(string entryName)
+        {
+            EnsureWritable();
+
+            Ensure.String.IsNotNullOrEmpty(entryName.Trim(), nameof(entryName));
+
+            Logger.LogInformation("Deleting entry: {name}", entryName);
+
+            Manifest.DeleteEntry(entryName);
+
+            if (Manifest.StoreOriginalFiles)
+            {
+                Logger.LogDebug("Pending entry: {name} for deletion from the bundle", entryName);
+                _pendingForRemove.Add(entryName);
+
+                if (_pendingForAdd.ContainsKey(entryName))
+                {
+                    Logger.LogDebug("Removing pending entry: {name} from the bundle", entryName);
+                    _pendingForAdd.Remove(entryName, out _);
+                }
             }
         }
 
@@ -314,8 +343,8 @@ public void Sign(X509Certificate2 certificate, RSA privateKey)
             var manifestData = Export(Manifest, SourceGenerationManifestContext.Default);
             var signature = privateKey.SignData(manifestData, HashAlgorithmName.SHA512, RSASignaturePadding.Pkcs1);
 
-            Logger.LogDebug("Embedding file: {name} in the bundle", name);
-            _newEmbeddedFiles[name] = Encoding.UTF8.GetBytes(pemContents);
+            Logger.LogDebug("Pending file: {name} for embedding in the bundle", name);
+            _pendingForAdd[name] = Encoding.UTF8.GetBytes(pemContents);
 
             Logger.LogDebug("Adding signature for certificate: {name} to signatures", name);
             Signatures.Entries[name] = signature;
@@ -590,6 +619,22 @@ public void Update()
 
             using (ZipArchive zip = OpenZipArchive(ZipArchiveMode.Update))
             {
+                Logger.LogDebug("Deleting pending files from the bundle");
+
+                ZipArchiveEntry? tempEntry;
+                foreach (var entryName in _pendingForRemove)
+                {
+                    if ((tempEntry = zip.GetEntry(entryName)) != null)
+                    {
+                        Logger.LogDebug("Deleting entry: {name}", entryName);
+                        tempEntry.Delete();
+                    }
+                    else
+                    {
+                        Logger.LogWarning("Entry {name} not found in the bundle", entryName);
+                    }
+                }
+
                 Logger.LogDebug("Raising OnUpdating event");
                 OnUpdating?.Invoke(zip);
 
@@ -601,8 +646,8 @@ public void Update()
                 var signatureData = Export(Signatures, SourceGenerationSignaturesContext.Default);
                 WriteEntry(zip, ".signatures.ec", signatureData);
 
-                Logger.LogDebug("Writing new files to the bundle");
-                foreach (var newFile in _newEmbeddedFiles)
+                Logger.LogDebug("Writing pending files to the bundle");
+                foreach (var newFile in _pendingForAdd)
                 {
                     WriteEntry(zip, newFile.Key, newFile.Value);
                 }

src/EasySign/Manifest.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
+using System.Data;
 using System.Linq;
 using System.Text;
 using System.Text.Json.Serialization;
@@ -47,20 +48,34 @@ public SortedDictionary<string, byte[]> Entries
 
         /// <summary>
         /// Adds an entry to the manifest.
-        /// if it already exists, an exception will be thrown.
+        /// An exception will be thrown if the entry already exists.
         /// </summary>
         /// <param name="entryName">
         /// The name of the entry to add.
         /// </param>
         /// <param name="hash">
         /// The hash of the entry to add.
         /// </param>
-        /// <exception cref="InvalidOperationException"></exception>
+        /// <exception cref="DuplicateNameException"></exception>
         public void AddEntry(string entryName, byte[] hash)
         {
             if (!entries.TryAdd(entryName, hash))
             {
-                throw new InvalidOperationException($"The entry '{entryName}' is already in the manifest.");
+                throw new DuplicateNameException($"The entry '{entryName}' is already in the manifest.");
+            }
+        }
+
+        /// <summary>
+        /// Deletes an entry from the manifest.
+        /// An exception will be thrown if the entry does not exist.
+        /// </summary>
+        /// <param name="entryName">The name of the entry to delete. </param>
+        /// <exception cref="KeyNotFoundException"></exception>
+        public void DeleteEntry(string entryName)
+        {
+            if (!entries.Remove(entryName, out _))
+            {
+                throw new KeyNotFoundException(entryName);
             }
         }