Skip to content

Add ARJ, ARC, and ACE archive decompression support #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 8 commits into
base: main
Choose a base branch
from
+630 −20
Draft

Add ARJ, ARC, and ACE archive decompression support #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b3482f9
Initial plan
Copilot Feb 6, 2026
5d90944
Add ARJ, ARC, ACE support and update agent instructions for NBGV deep…
Copilot Feb 6, 2026
e03db48
Fix ACE test data file CRC and restore nuget.config
Copilot Feb 6, 2026
4f47643
Improve ACE resource governor check to validate before decompression
Copilot Feb 6, 2026
fba41e2
Fix DetectFileType regression: read min(length, buffer) bytes and gat…
Copilot Feb 6, 2026
9444f82
Fix encrypted 7z stream position after SharpCompress 0.44.5 upgrade
Copilot Feb 6, 2026
ac4537f
Add FailedArchive status assertions to count-only test methods
Copilot Feb 6, 2026
755b17e
Refactor entry stream handling in ACE, ARC, and ARJ extractors to use…
gfs Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ RecursiveExtractor is a cross-platform .NET library and CLI tool for parsing arc

## Building and Testing

### Git Clone Depth

⚠️ **Important**: This repository uses [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning) (NBGV) to calculate version numbers from git history. Shallow clones will cause the build to fail with a `GitException: Shallow clone lacks the objects required to calculate version height` error. If you encounter this, deepen the clone:
```bash
git fetch --unshallow
# or if that fails:
git fetch --depth=100
```

### Build Commands
```bash
# Build the entire solution
Expand Down
23 changes: 17 additions & 6 deletions RecursiveExtractor.Tests/ExtractorTests/ExpectedNumFilesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ public static TheoryData<string, int> ArchiveData
{ "TestDataArchivesNested.Zip", 54 },
{ "UdfTest.iso", 3 },
{ "UdfTestWithMultiSystem.iso", 3 },
{ "TestData.arj", 1 },
{ "TestData.arc", 1 },
{ "TestData.ace", 1 },
// { "HfsSampleUDCO.dmg", 2 }
};
}
Expand Down Expand Up @@ -75,6 +78,9 @@ public static TheoryData<string, int> NoRecursionData
{ "EmptyFile.txt", 1 },
{ "TestDataArchivesNested.Zip", 14 },
{ "UdfTestWithMultiSystem.iso", 3 },
{ "TestData.arj", 1 },
{ "TestData.arc", 1 },
{ "TestData.ace", 1 },
// { "HfsSampleUDCO.dmg", 2 }
};
}
Expand Down Expand Up @@ -193,8 +199,7 @@ public void ExtractArchiveParallel(string fileName, int expectedNumFiles)
var extractor = new Extractor();
var path = Path.Combine(Directory.GetCurrentDirectory(), "TestData", "TestDataArchives", fileName);
var results = extractor.Extract(path, GetExtractorOptions(true)).ToList();
var names = results.Select(x => x.FullPath);
var stringOfNames = string.Join("\n", names);
Assert.DoesNotContain(results, r => r.EntryStatus == FileEntryStatus.FailedArchive);
Assert.Equal(expectedNumFiles, results.Count);
}

Expand Down Expand Up @@ -223,17 +228,22 @@ public async Task ExtractArchiveAsync(string fileName, int expectedNumFiles)
[MemberData(nameof(ArchiveData))]
public async Task ExtractArchiveFromStreamAsync(string fileName, int expectedNumFiles)
{
var extractor = new Extractor();
var extractor = new Extractor();
var path = Path.Combine(Directory.GetCurrentDirectory(), "TestData", "TestDataArchives", fileName);
using var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read);
var results = extractor.ExtractAsync(path, stream, new ExtractorOptions());
var numFiles = 0;
var numFailed = 0;
await foreach (var result in results)
{
numFiles++;
if (result.EntryStatus == FileEntryStatus.FailedArchive)
{
numFailed++;
}
}
Assert.Equal(0, numFailed);
Assert.Equal(expectedNumFiles, numFiles);
stream.Close();
}

[Theory]
Expand All @@ -243,8 +253,9 @@ public void ExtractArchiveFromStream(string fileName, int expectedNumFiles)
var extractor = new Extractor();
var path = Path.Combine(Directory.GetCurrentDirectory(), "TestData", "TestDataArchives", fileName);
using var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read);
var results = extractor.Extract(path, stream, GetExtractorOptions());
Assert.Equal(expectedNumFiles, results.Count());
var resultsList = extractor.Extract(path, stream, GetExtractorOptions()).ToList();
Assert.DoesNotContain(resultsList, r => r.EntryStatus == FileEntryStatus.FailedArchive);
Assert.Equal(expectedNumFiles, resultsList.Count);
stream.Close();
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Redundant stream.Close() call: the stream is already disposed by the using var stream = new FileStream(...). Removing the explicit close reduces noise and avoids confusion about ownership/lifetime.

Suggested change
stream.Close();

Copilot uses AI. Check for mistakes.
}

Expand Down
3 changes: 3 additions & 0 deletions RecursiveExtractor.Tests/ExtractorTests/MiniMagicTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ public class MiniMagicTests
[InlineData("Empty.vmdk", ArchiveFileType.VMDK)]
[InlineData("HfsSampleUDCO.dmg", ArchiveFileType.DMG)]
[InlineData("EmptyFile.txt", ArchiveFileType.UNKNOWN)]
[InlineData("TestData.arj", ArchiveFileType.ARJ)]
[InlineData("TestData.arc", ArchiveFileType.ARC)]
[InlineData("TestData.ace", ArchiveFileType.ACE)]
public void TestMiniMagic(string fileName, ArchiveFileType expectedArchiveFileType)
{
var path = Path.Combine(Directory.GetCurrentDirectory(), "TestData", "TestDataArchives", fileName);
Expand Down
9 changes: 9 additions & 0 deletions RecursiveExtractor.Tests/RecursiveExtractor.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,15 @@
<None Update="TestData\TestDataArchives\UdfTestWithMultiSystem.iso">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Update="TestData\TestDataArchives\TestData.arj">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Update="TestData\TestDataArchives\TestData.arc">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Update="TestData\TestDataArchives\TestData.ace">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Update="TestData\Bombs\zoneinfo-2010g.tar">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
Expand Down
Binary file added RecursiveExtractor.Tests/TestData/TestDataArchives/TestData.ace
View file
Open in desktop
Binary file not shown.
Binary file added RecursiveExtractor.Tests/TestData/TestDataArchives/TestData.arc
View file
Open in desktop
Binary file not shown.
Binary file added RecursiveExtractor.Tests/TestData/TestDataArchives/TestData.arj
View file
Open in desktop
Binary file not shown.
3 changes: 3 additions & 0 deletions RecursiveExtractor/Extractor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ public void SetDefaultExtractors()
SetExtractor(ArchiveFileType.VMDK, new VmdkExtractor(this));
SetExtractor(ArchiveFileType.XZ, new XzExtractor(this));
SetExtractor(ArchiveFileType.ZIP, new ZipExtractor(this));
SetExtractor(ArchiveFileType.ARJ, new ArjExtractor(this));
SetExtractor(ArchiveFileType.ARC, new ArcExtractor(this));
SetExtractor(ArchiveFileType.ACE, new AceExtractor(this));
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
SetExtractor(ArchiveFileType.WIM, new WimExtractor(this));
Expand Down
173 changes: 173 additions & 0 deletions RecursiveExtractor/Extractors/AceExtractor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
using SharpCompress.Readers;
using SharpCompress.Readers.Ace;
using System;
using System.Collections.Generic;
using System.IO;

namespace Microsoft.CST.RecursiveExtractor.Extractors
{
/// <summary>
/// The ACE Archive extractor implementation
/// </summary>
public class AceExtractor : AsyncExtractorInterface
{
/// <summary>
/// The constructor takes the Extractor context for recursion.
/// </summary>
/// <param name="context">The Extractor context.</param>
public AceExtractor(Extractor context)
{
Context = context;
}
private readonly NLog.Logger Logger = NLog.LogManager.GetCurrentClassLogger();

internal Extractor Context { get; }

/// <summary>
/// Extracts an ACE archive
/// </summary>
///<inheritdoc />
public async IAsyncEnumerable<FileEntry> ExtractAsync(FileEntry fileEntry, ExtractorOptions options, ResourceGovernor governor, bool topLevel = true)
{
AceReader? aceReader = null;
try
{
aceReader = AceReader.Open(fileEntry.Content, new ReaderOptions()
{
LeaveStreamOpen = true
});
Comment on lines +33 to +38
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reset fileEntry.Content.Position = 0 before calling AceReader.Open(...) (in both async and sync methods). This matches the established extractor pattern (e.g., Zip/GZip) and avoids failures when the stream position isn’t at the beginning.

Copilot uses AI. Check for mistakes.
}
catch (Exception e)
{
Logger.Debug(Extractor.FAILED_PARSING_ERROR_MESSAGE_STRING, ArchiveFileType.ACE, fileEntry.FullPath, string.Empty, e.GetType());
}

if (aceReader != null)
{
using (aceReader)
{
while (aceReader.MoveToNextEntry())
{
var entry = aceReader.Entry;
if (entry.IsDirectory)
{
continue;
}

var name = entry.Key?.Replace('/', Path.DirectorySeparatorChar);
if (string.IsNullOrEmpty(name))
{
Logger.Debug(Extractor.ENTRY_MISSING_NAME_ERROR_MESSAGE_STRING, ArchiveFileType.ACE, fileEntry.FullPath);
continue;
}

governor.CheckResourceGovernor(entry.Size);
using var entryStream = aceReader.OpenEntryStream()
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using var entryStream = aceReader.OpenEntryStream() is followed by a block ({ ... }), which is invalid syntax for a using-declaration and will not compile. Convert this to a using (...) { ... } statement or remove the braces and terminate the declaration with ;.

This issue also appears on line 131 of the same file.

Suggested change
using var entryStream = aceReader.OpenEntryStream()
using (var entryStream = aceReader.OpenEntryStream())

Copilot uses AI. Check for mistakes.
{
var newFileEntry = await FileEntry.FromStreamAsync(name, entryStream, fileEntry, entry.CreatedTime, entry.LastModifiedTime, entry.LastAccessedTime, memoryStreamCutoff: options.MemoryStreamCutoff).ConfigureAwait(false);
if (newFileEntry != null)
{
if (options.Recurse || topLevel)
{
await foreach (var innerEntry in Context.ExtractAsync(newFileEntry, options, governor, false))
{
yield return innerEntry;
}
}
else
{
yield return newFileEntry;
}
}
}
}
}
}
else
{
if (options.ExtractSelfOnFail)
{
fileEntry.EntryStatus = FileEntryStatus.FailedArchive;
yield return fileEntry;
}
}
}

/// <summary>
/// Extracts an ACE archive
/// </summary>
///<inheritdoc />
public IEnumerable<FileEntry> Extract(FileEntry fileEntry, ExtractorOptions options, ResourceGovernor governor, bool topLevel = true)
{
AceReader? aceReader = null;
try
{
aceReader = AceReader.Open(fileEntry.Content, new ReaderOptions()
{
LeaveStreamOpen = true
});
}
catch (Exception e)
{
Logger.Debug(Extractor.FAILED_PARSING_ERROR_MESSAGE_STRING, ArchiveFileType.ACE, fileEntry.FullPath, string.Empty, e.GetType());
}

if (aceReader != null)
{
using (aceReader)
{
while (aceReader.MoveToNextEntry())
{
var entry = aceReader.Entry;
if (entry.IsDirectory)
{
continue;
}

FileEntry? newFileEntry = null;
try
{
governor.CheckResourceGovernor(entry.Size);
using var stream = aceReader.OpenEntryStream()
{
var name = entry.Key?.Replace('/', Path.DirectorySeparatorChar);
if (string.IsNullOrEmpty(name))
{
Logger.Debug(Extractor.ENTRY_MISSING_NAME_ERROR_MESSAGE_STRING, ArchiveFileType.ACE, fileEntry.FullPath);
continue;
}
newFileEntry = new FileEntry(name, stream, fileEntry, false, entry.CreatedTime, entry.LastModifiedTime, entry.LastAccessedTime, memoryStreamCutoff: options.MemoryStreamCutoff);
}
}
catch (Exception e)
{
Logger.Debug(Extractor.FAILED_PARSING_ERROR_MESSAGE_STRING, ArchiveFileType.ACE, fileEntry.FullPath, entry.Key, e.GetType());
}
if (newFileEntry != null)
{
if (options.Recurse || topLevel)
{
foreach (var innerEntry in Context.Extract(newFileEntry, options, governor, false))
{
yield return innerEntry;
}
}
else
{
yield return newFileEntry;
}
}
}
}
}
else
{
if (options.ExtractSelfOnFail)
{
fileEntry.EntryStatus = FileEntryStatus.FailedArchive;
yield return fileEntry;
}
}
}
}
}
Loading
Loading