Adds support for several compression algorithms

CHANGELOG.md

@@ -1,5 +1,26 @@
 # CHANGELOG
 
+## 06/17/2025
+
+- Added commands supporting several algorithms to compress and decompress strings:
+    - `ConvertFrom-BrotliString` & `ConvertTo-BrotliString` (using to BrotliSharpLib)
+    - `ConvertFrom-DeflateString` & `ConvertTo-DeflateString` (from CLR)
+    - `ConvertFrom-ZlibString` & `ConvertTo-ZlibString` (custom implementation)
+- Added commands for `.tar` entry management with a reduced set of operations compared to `zip` entry management:
+    - `Get-TarEntry`: Lists entries, serving as the main entry point for `TarEntry` cmdlets.
+    - `Get-TarEntryContent`: Retrieves the content of a tar entry.
+    - `Expand-TarEntry`: Extracts a tar entry to a file.
+- Added commands to compress files and folders into `.tar` archives and extract `.tar` archives with various compression algorithms:
+    - `Compress-TarArchive` and `Expand-TarArchive`: Supported compression algorithms include `gz`, `bz2`, `zst`, `lz`, and `none` (no compression).
+- Removed commands:
+    - `Compress-GzipArchive` and `Expand-GzipArchive`: These were deprecated as they only supported single-file compression, which is now better handled by the module’s `.tar` archive functionality.
+
+This update was made possible by the following projects. If you find them helpful, please consider starring their repositories:
+
+- [SharpZipLib](https://github.com/icsharpcode/SharpZipLib)
+- [SharpCompress](https://github.com/adamhathcock/sharpcompress)
+- [BrotliSharpLib](https://github.com/master131/BrotliSharpLib)
+
 ## 01/10/2025
 
 - Code improvements.

build.ps1

@@ -38,7 +38,7 @@ if (-not ('ProjectBuilder.ProjectInfo' -as [type])) {
     }
 }
 
-$projectInfo = [ProjectBuilder.ProjectInfo]::Create($PSScriptRoot, $Configuration)
+$projectInfo = [ProjectBuilder.ProjectInfo]::Create($PSScriptRoot, $Configuration, $PSVersionTable.PSVersion)
 $projectInfo.GetRequirements() | Import-Module -DisableNameChecking -Force
 
 $ErrorActionPreference = $prev

docs/en-US/Get-ZipEntryContent.md

@@ -17,7 +17,7 @@ Gets the content of a zip entry.
 
 ```powershell
 Get-ZipEntryContent
-    -ZipEntry <ZipEntryFile[]>
+    -Entry <ZipEntryFile[]>
     [-Encoding <Encoding>]
     [-Raw]
     [<CommonParameters>]
@@ -27,7 +27,7 @@ Get-ZipEntryContent
 
 ```powershell
 Get-ZipEntryContent
-    -ZipEntry <ZipEntryFile[]>
+    -Entry <ZipEntryFile[]>
     [-Raw]
     [-AsByteStream]
     [-BufferSize <Int32>]
@@ -183,7 +183,7 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ZipEntry
+### -Entry
 
 The entry or entries to get the content from. This parameter can be and is meant to be bound from pipeline however can be also used as a named parameter.
 

module/PSCompression.Format.ps1xml

@@ -4,7 +4,7 @@
     <View>
       <Name>zipentryview</Name>
       <ViewSelectedBy>
-        <TypeName>PSCompression.ZipEntryBase</TypeName>
+        <TypeName>PSCompression.Abstractions.ZipEntryBase</TypeName>
       </ViewSelectedBy>
       <GroupBy>
         <ScriptBlock>[PSCompression.Internal._Format]::GetDirectoryPath($_)</ScriptBlock>
@@ -68,5 +68,60 @@
         </TableRowEntries>
       </TableControl>
     </View>
+    <View>
+      <Name>tarentryview</Name>
+      <ViewSelectedBy>
+        <TypeName>PSCompression.Abstractions.TarEntryBase</TypeName>
+      </ViewSelectedBy>
+      <GroupBy>
+        <ScriptBlock>[PSCompression.Internal._Format]::GetDirectoryPath($_)</ScriptBlock>
+        <Label>Directory</Label>
+      </GroupBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader>
+            <Label>Type</Label>
+            <Width>10</Width>
+            <Alignment>Left</Alignment>
+          </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>LastWriteTime</Label>
+            <Width>26</Width>
+            <Alignment>Right</Alignment>
+          </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>Size</Label>
+            <Width>15</Width>
+            <Alignment>Right</Alignment>
+          </TableColumnHeader>
+          <TableColumnHeader>
+            <Label>Name</Label>
+            <Alignment>Left</Alignment>
+          </TableColumnHeader>
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>Type</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <ScriptBlock>[PSCompression.Internal._Format]::GetFormattedDate($_.LastWriteTime)</ScriptBlock>
+              </TableColumnItem>
+              <TableColumnItem>
+                <ScriptBlock>
+                  if ($_ -is [PSCompression.TarEntryFile]) {
+                    [PSCompression.Internal._Format]::GetFormattedLength($_.Length)
+                  }
+                </ScriptBlock>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Name</PropertyName>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
   </ViewDefinitions>
 </Configuration>

module/PSCompression.psd1

@@ -11,7 +11,7 @@
     RootModule         = 'bin/netstandard2.0/PSCompression.dll'
 
     # Version number of this module.
-    ModuleVersion      = '2.1.0'
+    ModuleVersion      = '3.0.0'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()
@@ -83,24 +83,40 @@
         'Expand-ZipEntry'
         'ConvertTo-GzipString'
         'ConvertFrom-GzipString'
-        'Expand-GzipArchive'
-        'Compress-GzipArchive'
         'Compress-ZipArchive'
         'Rename-ZipEntry'
+        'ConvertFrom-ZLibString'
+        'ConvertTo-ZLibString'
+        'ConvertFrom-DeflateString'
+        'ConvertTo-DeflateString'
+        'ConvertFrom-BrotliString'
+        'ConvertTo-BrotliString'
+        'Compress-TarArchive'
+        'Get-TarEntry'
+        'Get-TarEntryContent'
+        'Expand-TarEntry'
+        'Expand-TarArchive'
     )
 
     # Variables to export from this module
     VariablesToExport  = @()
 
     # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
     AliasesToExport    = @(
-        'gziptofile'
-        'gzipfromfile'
-        'gziptostring'
-        'gzipfromstring'
-        'zip'
-        'ziparchive'
-        'gze'
+        'togzipstring'
+        'fromgzipstring'
+        'zipcompress'
+        'fromzlibstring'
+        'tozlibstring'
+        'fromdeflatestring'
+        'todeflatestring'
+        'frombrotlistring'
+        'tobrotlistring'
+        'zipge'
+        'zipgc'
+        'tarcompress'
+        'targe'
+        'targc'
     )
 
     # DSC resources to export from this module
@@ -122,6 +138,10 @@
                 'zip-compression'
                 'gzip'
                 'gzip-compression'
+                'zlib'
+                'zlib-compression'
+                'deflate'
+                'deflate-compression'
                 'compression'
                 'csharp'
             )

src/PSCompression/CommandWithPathBase.cs → src/PSCompression/Abstractions/CommandWithPathBase.cs

@@ -6,7 +6,7 @@
 using PSCompression.Exceptions;
 using PSCompression.Extensions;
 
-namespace PSCompression;
+namespace PSCompression.Abstractions;
 
 [EditorBrowsable(EditorBrowsableState.Never)]
 public abstract class CommandWithPathBase : PSCmdlet

src/PSCompression/Abstractions/EntryBase.cs

@@ -0,0 +1,31 @@
+using System;
+using System.IO;
+
+namespace PSCompression.Abstractions;
+
+public abstract class EntryBase(string source)
+{
+    protected Stream? _stream;
+
+    protected string? _formatDirectoryPath;
+
+    internal string? FormatDirectoryPath { get => _formatDirectoryPath ??= GetFormatDirectoryPath(); }
+
+    internal bool FromStream { get => _stream is not null; }
+
+    public string Source { get; } = source;
+
+    public abstract string Name { get; protected set; }
+
+    public abstract string RelativePath { get; }
+
+    public abstract DateTime LastWriteTime { get; }
+
+    public abstract long Length { get; internal set; }
+
+    public abstract EntryType Type { get; }
+
+    protected abstract string GetFormatDirectoryPath();
+
+    public override string ToString() => RelativePath;
+}

src/PSCompression/Abstractions/ExpandEntryCommandBase.cs

@@ -0,0 +1,70 @@
+using System;
+using System.IO;
+using System.Management.Automation;
+using PSCompression.Extensions;
+using PSCompression.Exceptions;
+using System.ComponentModel;
+
+namespace PSCompression.Abstractions;
+
+[EditorBrowsable(EditorBrowsableState.Never)]
+public abstract class ExpandEntryCommandBase<T> : PSCmdlet
+    where T : EntryBase
+{
+    [Parameter(Mandatory = true, ValueFromPipeline = true)]
+    public T[] InputObject { get; set; } = null!;
+
+    [Parameter(Position = 0)]
+    [ValidateNotNullOrEmpty]
+    public string? Destination { get; set; }
+
+    [Parameter]
+    public SwitchParameter Force { get; set; }
+
+    [Parameter]
+    public SwitchParameter PassThru { get; set; }
+
+    protected override void BeginProcessing()
+    {
+        Destination = Destination is null
+            // PowerShell is retarded and decided to mix up ProviderPath & Path
+            ? SessionState.Path.CurrentFileSystemLocation.ProviderPath
+            : Destination.ResolvePath(this);
+
+        if (File.Exists(Destination))
+        {
+            ThrowTerminatingError(ExceptionHelper.NotDirectoryPath(
+                Destination, nameof(Destination)));
+        }
+
+        Directory.CreateDirectory(Destination);
+    }
+
+    protected override void ProcessRecord()
+    {
+        Dbg.Assert(Destination is not null);
+
+        foreach (T entry in InputObject)
+        {
+            try
+            {
+                FileSystemInfo info = Extract(entry);
+
+                if (PassThru)
+                {
+                    WriteObject(info.AppendPSProperties());
+                }
+            }
+            catch (Exception _) when (_ is PipelineStoppedException or FlowControlException)
+            {
+                throw;
+            }
+            catch (Exception exception)
+            {
+                WriteError(exception.ToExtractEntryError(entry));
+            }
+        }
+    }
+
+    protected abstract FileSystemInfo Extract(T entry);
+}

src/PSCompression/Abstractions/FromCompressedStringCommandBase.cs

@@ -0,0 +1,65 @@
+using System;
+using System.ComponentModel;
+using System.IO;
+using System.Management.Automation;
+using System.Text;
+using PSCompression.Exceptions;
+using PSCompression.Extensions;
+
+namespace PSCompression.Abstractions;
+
+[EditorBrowsable(EditorBrowsableState.Never)]
+public abstract class FromCompressedStringCommandBase : PSCmdlet
+{
+    protected delegate Stream DecompressionStreamFactory(Stream inputStream);
+
+    [Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0)]
+    public string[] InputObject { get; set; } = null!;
+
+    [Parameter]
+    [ArgumentCompleter(typeof(EncodingCompleter))]
+    [EncodingTransformation]
+    [ValidateNotNullOrEmpty]
+    public Encoding Encoding { get; set; } = new UTF8Encoding();
+
+    [Parameter]
+    public SwitchParameter Raw { get; set; }
+
+    private void Decompress(
+        string base64string,
+        DecompressionStreamFactory decompressionStreamFactory)
+    {
+        using MemoryStream inStream = new(Convert.FromBase64String(base64string));
+        using Stream decompressStream = decompressionStreamFactory(inStream);
+        using StreamReader reader = new(decompressStream, Encoding);
+
+        if (Raw)
+        {
+            reader.WriteAllTextToPipeline(this);
+            return;
+        }
+
+        reader.WriteLinesToPipeline(this);
+    }
+
+    protected abstract Stream CreateDecompressionStream(Stream inputStream);
+
+    protected override void ProcessRecord()
+    {
+        foreach (string line in InputObject)
+        {
+            try
+            {
+                Decompress(line, CreateDecompressionStream);
+            }
+            catch (Exception _) when (_ is PipelineStoppedException or FlowControlException)
+            {
+                throw;
+            }
+            catch (Exception exception)
+            {
+                WriteError(exception.ToEnumerationError(line));
+            }
+        }
+    }
+}