Refactor deb packaging to DivineBytes and fix tar integrity (#142)

* Refactor deb packaging to DivineBytes and fix tar integrity

* Stream ar byte source instead of buffering

Author: SuperJMN

src/DotnetPackaging.Deb/Archives/Ar/ArFile.cs

@@ -1,8 +1,8 @@
-
-using Zafiro.FileSystem.Readonly;
+using DotnetPackaging.Deb.Archives.Tar;
+using Zafiro.DivineBytes;
 
 namespace DotnetPackaging.Deb.Archives.Ar;
 
-public record ArFile(params Entry[] Entries);
+public record ArFile(params ArEntry[] Entries);
 
-public record Entry(IFile File, Properties Properties);
+public record ArEntry(string Name, IByteSource Content, UnixFileProperties Properties);

src/DotnetPackaging.Deb/Archives/Ar/ArFileExtensions.cs

@@ -0,0 +1,57 @@
+using System.Linq;
+using System.Reactive.Linq;
+using System.Text;
+using Zafiro.DivineBytes;
+using Zafiro.Mixins;
+
+namespace DotnetPackaging.Deb.Archives.Ar;
+
+public static class ArFileExtensions
+{
+    private const string Signature = "!<arch>\n";
+
+    public static IByteSource ToByteSource(this ArFile arFile)
+    {
+        var parts = new List<IObservable<byte[]>> { ByteSource.FromString(Signature, Encoding.ASCII).Bytes };
+
+        foreach (var entry in arFile.Entries)
+        {
+            var size = entry.Content.GetSize().GetAwaiter().GetResult();
+            var header = BuildHeader(entry, size);
+
+            parts.Add(ByteSource.FromString(header, Encoding.ASCII).Bytes);
+            parts.Add(entry.Content.Bytes);
+
+            if (size % 2 != 0)
+            {
+                parts.Add(ByteSource.FromBytes(new[] { (byte)'\n' }).Bytes);
+            }
+        }
+
+        return ByteSource.FromByteObservable(parts.Aggregate(Observable.Concat));
+    }
+
+    private static string BuildHeader(ArEntry entry, long size)
+    {
+        var modeOctal = Convert.ToString(entry.Properties.Mode, 8);
+
+        return
+            $"{Field(entry.Name, 16)}" +
+            $"{Field(entry.Properties.LastModification.ToUnixTimeSeconds().ToString(), 12)}" +
+            $"{Field(entry.Properties.OwnerId.ToString(), 6)}" +
+            $"{Field(entry.Properties.GroupId.ToString(), 6)}" +
+            $"{Field($"100{modeOctal}", 8)}" +
+            $"{Field(size.ToString(), 10)}" +
+            "`\n";
+    }
+
+    private static string Field(string value, int width)
+    {
+        if (value.Length > width)
+        {
+            return value[..width];
+        }
+
+        return value.PadRight(width);
+    }
+}

src/DotnetPackaging.Deb/Archives/Ar/ArFileMixin.cs

@@ -1,70 +1,47 @@
 using CSharpFunctionalExtensions;
 using DotnetPackaging.Deb.Archives.Ar;
 using DotnetPackaging.Deb.Archives.Tar;
-using Zafiro.DataModel;
-using Zafiro.FileSystem.Unix;
-using File = Zafiro.FileSystem.Readonly.File;
+using Zafiro.DivineBytes;
+using Zafiro.Mixins;
 
 namespace DotnetPackaging.Deb.Archives.Deb;
 
 public static class DebMixin
 {
-    public static IData ToData(this DebFile debFile)
+    public static IByteSource ToByteSource(this DebFile debFile)
     {
         ArFile arFile = new ArFile(Signature(debFile), ControlTar(debFile), DataTar(debFile));
-        return arFile.ToData();
+        return arFile.ToByteSource();
     }
 
-    private static Entry DataTar(DebFile debFile)
+    private static ArEntry DataTar(DebFile debFile)
     {
         TarFile dataTarFile = new TarFile(debFile.Entries);
-        var properties = new Properties()
-        {
-            FileMode = "644".ToFileMode(),
-            GroupId = 0,
-            LastModification = debFile.Metadata.ModificationTime,
-            OwnerId = 0,
-        };
-        return new Entry(new File("data.tar", dataTarFile.ToData()), properties);
+        var properties = DefaultProperties(debFile);
+        return new ArEntry("data.tar", dataTarFile.ToByteSource(), properties);
     }
 
-    private static Entry Signature(DebFile debFile)
+    private static ArEntry Signature(DebFile debFile)
     {
-        var properties = new Properties()
-        {
-            FileMode = "644".ToFileMode(),
-            GroupId = 0,
-            LastModification = debFile.Metadata.ModificationTime,
-            OwnerId = 0,
-        };
-
-        var signature = """
-                        2.0
+        var properties = DefaultProperties(debFile);
 
-                        """.FromCrLfToLf();
+        var signature = "2.0\n";
 
-        return new Entry(new File("debian-binary", Data.FromString(signature)), properties);
+        return new ArEntry("debian-binary", ByteSource.FromString(signature), properties);
     }
 
-    private static Entry ControlTar(DebFile debFile)
+    private static ArEntry ControlTar(DebFile debFile)
     {
-        var properties = new Properties()
-        {
-            FileMode = "644".ToFileMode(),
-            GroupId = 0,
-            LastModification = debFile.Metadata.ModificationTime,
-            OwnerId = 0,
-        };
-
+        var properties = DefaultProperties(debFile);
         var controlTarFile = ControlTarFile(debFile);
-        return new Entry(new File("control.tar", controlTarFile.ToData()), properties);
+        return new ArEntry("control.tar", controlTarFile.ToByteSource(), properties);
     }
 
     private static TarFile ControlTarFile(DebFile deb)
     {
         var fileProperties = new TarFileProperties()
         {
-            FileMode = "644".ToFileMode(),
+            Mode = UnixPermissions.Parse("644"),
             GroupId = 0,
             GroupName = "root",
             OwnerId = 0,
@@ -74,7 +51,7 @@ private static TarFile ControlTarFile(DebFile deb)
 
         var dirProperties = new TarDirectoryProperties()
         {
-            FileMode = "755".ToFileMode(),
+            Mode = UnixPermissions.Parse("755"),
             GroupId = 0,
             GroupName = "root",
             OwnerId = 0,
@@ -95,7 +72,7 @@ private static TarFile ControlTarFile(DebFile deb)
 
         var content = items.Compose() + "\n";
 
-        var file = new File("control", Data.FromString(content));
+        var file = ByteSource.FromString(content);
 
         var entries = new TarEntry[]
         {
@@ -114,4 +91,17 @@ private static TarFile ControlTarFile(DebFile deb)
         var controlTarFile = new TarFile(entries.ToArray());
         return controlTarFile;
     }
-}
+
+    private static UnixFileProperties DefaultProperties(DebFile debFile)
+    {
+        return new UnixFileProperties
+        {
+            Mode = UnixPermissions.Parse("644"),
+            GroupId = 0,
+            OwnerId = 0,
+            GroupName = "root",
+            OwnerUsername = "root",
+            LastModification = debFile.Metadata.ModificationTime
+        };
+    }
+}

src/DotnetPackaging.Deb/Archives/Ar/EntryMixin.cs

@@ -1,13 +1,13 @@
-using Zafiro.DataModel;
+using Zafiro.DivineBytes;
 
 namespace DotnetPackaging.Deb.Archives.Tar;
 
 public record FileTarEntry : TarEntry
 {
-    public IData Content { get; }
+    public IByteSource Content { get; }
 
-    public FileTarEntry(string path, IData content, TarFileProperties properties) : base(path, properties)
+    public FileTarEntry(string path, IByteSource content, TarFileProperties properties) : base(path, properties)
     {
         Content = content;
     }
-}
+}

src/DotnetPackaging.Deb/Archives/Ar/Properties.cs

@@ -1,18 +1,16 @@
-using Zafiro.FileSystem.Unix;
+namespace DotnetPackaging.Deb.Archives.Tar;
 
-namespace DotnetPackaging.Deb.Archives.Tar;
-
-public class Misc
+public static class Misc
 {
     public static TarFileProperties RegularFileProperties() => new()
     {
-        FileMode = "644".ToFileMode(),
+        Mode = UnixPermissions.Parse("644"),
         GroupId = 1000,
         OwnerId = 1000,
         GroupName = "root",
         OwnerUsername = "root",
         LastModification = DateTimeOffset.Now
     };
 
-    public static TarFileProperties ExecutableFileProperties() => RegularFileProperties() with { FileMode = "755".ToFileMode() };
-}
+    public static TarFileProperties ExecutableFileProperties() => RegularFileProperties() with { Mode = UnixPermissions.Parse("755") };
+}