Add XZ/Lzw support to TarReader and detection for compressed TAR in TarArchive

Co-authored-by: adamhathcock <527620+adamhathcock@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-11-11 14:01:18 +00:00
parent ea8fcb9370
commit c8ca687dc2
2 changed files with 172 additions and 2 deletions

View File

@@ -4,9 +4,17 @@ using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SharpCompress.Archives.GZip;
using SharpCompress.Common;
using SharpCompress.Common.Tar;
using SharpCompress.Common.Tar.Headers;
using SharpCompress.Compressors;
using SharpCompress.Compressors.BZip2;
using SharpCompress.Compressors.Deflate;
using SharpCompress.Compressors.LZMA;
using SharpCompress.Compressors.Lzw;
using SharpCompress.Compressors.Xz;
using SharpCompress.Compressors.ZStandard;
using SharpCompress.IO;
using SharpCompress.Readers;
using SharpCompress.Readers.Tar;
@@ -36,6 +44,76 @@ public class TarArchive : AbstractWritableArchive<TarArchiveEntry, TarVolume>
public static TarArchive Open(FileInfo fileInfo, ReaderOptions? readerOptions = null)
{
fileInfo.NotNull(nameof(fileInfo));
// Check if the file extension suggests it's a compressed TAR file
var extension = fileInfo.Extension.ToLowerInvariant();
if (
extension is ".gz" or ".bz2" or ".xz" or ".zst" or ".lz" or ".z"
|| fileInfo.Name.ToLowerInvariant().Contains(".tar.")
)
{
// Open the file to check for compression
using var testStream = fileInfo.OpenRead();
var rewindableStream = SharpCompressStream.Create(testStream, leaveOpen: false);
var streamStack = (IStreamStack)rewindableStream;
var startPos = streamStack.GetPosition();
string? detectedCompression = null;
if (GZipArchive.IsGZipFile(rewindableStream))
{
detectedCompression = "GZip";
}
else
{
streamStack.StackSeek(startPos);
if (BZip2Stream.IsBZip2(rewindableStream))
{
detectedCompression = "BZip2";
}
else
{
streamStack.StackSeek(startPos);
if (ZStandardStream.IsZStandard(rewindableStream))
{
detectedCompression = "ZStandard";
}
else
{
streamStack.StackSeek(startPos);
if (LZipStream.IsLZipFile(rewindableStream))
{
detectedCompression = "LZip";
}
else
{
streamStack.StackSeek(startPos);
if (XZStream.IsXZStream(rewindableStream))
{
detectedCompression = "XZ";
}
else
{
streamStack.StackSeek(startPos);
if (LzwStream.IsLzwStream(rewindableStream))
{
detectedCompression = "LZW";
}
}
}
}
}
}
if (detectedCompression is not null)
{
throw new InvalidFormatException(
$"Compressed TAR archives ({detectedCompression}) are not supported by TarArchive.Open(). "
+ "Please use TarReader.Open() instead for forward-only reading of compressed TAR files."
);
}
}
return new TarArchive(
new SourceStream(
fileInfo,
@@ -98,9 +176,75 @@ public class TarArchive : AbstractWritableArchive<TarArchiveEntry, TarVolume>
throw new ArgumentException("Stream must be seekable", nameof(stream));
}
return new TarArchive(
new SourceStream(stream, i => null, readerOptions ?? new ReaderOptions())
readerOptions ??= new ReaderOptions();
// Wrap in SharpCompressStream to enable rewindable reading for compression detection
var rewindableStream = SharpCompressStream.Create(
stream,
leaveOpen: readerOptions.LeaveStreamOpen
);
var streamStack = (IStreamStack)rewindableStream;
var startPos = streamStack.GetPosition();
// Detect if the TAR file is compressed
string? detectedCompression = null;
if (GZipArchive.IsGZipFile(rewindableStream))
{
detectedCompression = "GZip";
}
else
{
streamStack.StackSeek(startPos);
if (BZip2Stream.IsBZip2(rewindableStream))
{
detectedCompression = "BZip2";
}
else
{
streamStack.StackSeek(startPos);
if (ZStandardStream.IsZStandard(rewindableStream))
{
detectedCompression = "ZStandard";
}
else
{
streamStack.StackSeek(startPos);
if (LZipStream.IsLZipFile(rewindableStream))
{
detectedCompression = "LZip";
}
else
{
streamStack.StackSeek(startPos);
if (XZStream.IsXZStream(rewindableStream))
{
detectedCompression = "XZ";
}
else
{
streamStack.StackSeek(startPos);
if (LzwStream.IsLzwStream(rewindableStream))
{
detectedCompression = "LZW";
}
}
}
}
}
}
if (detectedCompression is not null)
{
throw new InvalidFormatException(
$"Compressed TAR archives ({detectedCompression}) are not supported by TarArchive.Open(Stream). "
+ "Please use TarReader.Open(Stream) instead for forward-only reading of compressed TAR files."
);
}
// No compression detected, treat as plain tar file
streamStack.StackSeek(startPos);
return new TarArchive(new SourceStream(rewindableStream, i => null, readerOptions));
}
public static bool IsTarFile(string filePath) => IsTarFile(new FileInfo(filePath));

View File

@@ -111,6 +111,32 @@ public class TarReader : AbstractReader<TarEntry, TarVolume>
throw new InvalidFormatException("Not a tar file.");
}
((IStreamStack)rewindableStream).StackSeek(pos);
if (XZStream.IsXZStream(rewindableStream))
{
((IStreamStack)rewindableStream).StackSeek(pos);
var testStream = new XZStream(rewindableStream);
if (TarArchive.IsTarFile(testStream))
{
((IStreamStack)rewindableStream).StackSeek(pos);
return new TarReader(rewindableStream, options, CompressionType.Xz);
}
throw new InvalidFormatException("Not a tar file.");
}
((IStreamStack)rewindableStream).StackSeek(pos);
if (LzwStream.IsLzwStream(rewindableStream))
{
((IStreamStack)rewindableStream).StackSeek(pos);
var testStream = new LzwStream(rewindableStream);
if (TarArchive.IsTarFile(testStream))
{
((IStreamStack)rewindableStream).StackSeek(pos);
return new TarReader(rewindableStream, options, CompressionType.Lzw);
}
throw new InvalidFormatException("Not a tar file.");
}
((IStreamStack)rewindableStream).StackSeek(pos);
return new TarReader(rewindableStream, options, CompressionType.None);
}