https://github.com/gitii/community.archives
A collection of libraries that support reading various popular archives.
https://github.com/gitii/community.archives
ar cpio rpm tar
Last synced: 2 months ago
JSON representation
A collection of libraries that support reading various popular archives.
- Host: GitHub
- URL: https://github.com/gitii/community.archives
- Owner: Gitii
- License: mit
- Created: 2022-01-15T10:20:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-30T18:41:13.000Z (about 3 years ago)
- Last Synced: 2025-03-10T23:28:52.361Z (2 months ago)
- Topics: ar, cpio, rpm, tar
- Language: C#
- Homepage:
- Size: 62.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Community.Archives
A collection of libraries that support fast and efficient forward-only reading of various popular archives.
* :rocket: Fast and efficient: Only extracts matched file. Forward-only access. Uses `Task` to offload `IO` to separate threads.
* :grinning: Licensed under MIT. Similar projects are licensed under GPL.
* :heart_eyes: 100% test coverage
## Supported archive formats
| Format | Package | Documentation |
| ------ | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| Ar | [Get `Community.Archives.Ar` on nuget](https://www.nuget.org/packages/Community.Archives.Ar) | [Get started](https://github.com/Gitii/Community.Archives/tree/main/Community.Archives.Ar) |
| Cpio | [Get `Community.Archives.Cpio` on nuget](https://www.nuget.org/packages/Community.Archives.Cpio) | [Get started](https://github.com/Gitii/Community.Archives/tree/main/Community.Archives.Cpio) |
| Rpm | [Get `Community.Archives.Rpm` on nuget](https://www.nuget.org/packages/Community.Archives.Rpm) | [Get started](https://github.com/Gitii/Community.Archives/tree/main/Community.Archives.Rpm) |
| Tar | [Get `Community.Archives.Tar` on nuget](https://www.nuget.org/packages/Community.Archives.Tar) | [Get started](https://github.com/Gitii/Community.Archives/tree/main/Community.Archives.Tar) |
| Apk | [Get `Community.Archives.Apk` on nuget](https://www.nuget.org/packages/Community.Archives.Apk) | [Get started](https://github.com/Gitii/Community.Archives/tree/main/Community.Archives.Apk) |
## Supported frameworks
- .Net Standard 2.1
- .Net 5
- .Net 6
On any platform that's supported by the above frameworks, including Windows, Linux and MacOS.
## Getting started
Each package exports an implementation of [`IArchiveReader`](https://github.com/Gitii/Community.Archives/blob/main/Community.Archives.Core/IArchiveReader.cs).
## Extract all or specific files
```csharp
var reader = new TarArchiveReader(); // or RpmArchiveReader or ...
await foreach (
var entry in reader
.GetFileEntriesAsync(stream, IArchiveReader.MATCH_ALL_FILES)
) {
// entry.Name
// entry.Content
Console.WriteLine($"Found file {entry.Name} ({entry.Content.Length} bytes)")
}
```
## Extract specific files only
```csharp
var reader = new TarArchiveReader(); // or RpmArchiveReader or ...
// use regular expression to match files (path + file name)
await foreach (
var entry in reader
.GetFileEntriesAsync(stream, "[.]md$", "[.]txt$")
) {
// found a Markdown or text file
}
```
## Extract metadata of the archive
```csharp
var reader = new RpmArchiveReader();
var metaData = await reader.GetMetaDataAsync(stream);
Console.WriteLine(metaData.Package); // for example: "gh"
Console.WriteLine(metaData.Version); // for example: "2.4.0"
```
> :exclamation: Only `rpm` archives contain meta data. Check `reader.SupportsMetaData` at runtime or the documentation of the reader before using it.
# Recommended usage
The implementations of `IArchiveReader` allow forward-only access of supported archives.
But why forward-only and not random-access?
All of these archive formats do not have an central index of files. That means that (in worst case) the complete archive needs to be scanned to find a file. In addition, archives like `tar` are usually compressed. Decompressing them is easy but because the `tar` archive as a whole and not individual files are compressed, the whole file needs to be decompressed for random-access.
There are many different archive extractors (for example `7z`) that can easily extract any modern archive.
The purpose of `IArchiveReader` is to quickly and efficiently find and extract one or more files. Without using native or *fat* dependencies like [RecursiveExtractor]([RecursiveExtractor](https://github.com/microsoft/RecursiveExtractor)) or [SharpZipLib](https://github.com/icsharpcode/SharpZipLib).
`IArchiveReader` will only allocate memory (`byte[]`) for matched files.
# Usage with Dependency Injection
You can either register `IArchiveReader` and a single implemenation of it. Or, if you are using multiple implementations in the same project, register the implementation directly. All implementations are using `virtual` functions. You can easily mock the classes using your favorite mocking framework.
# Found a bug? Have a suggestion?
Please [create an issue](https://github.com/Gitii/Community.Archives/issues) and attach the file (if it's not confidental or contains personally identifiable information (PII)).
Pull requests are always welcome :heart_eyes:
## License
This software is released under the [MIT License](https://opensource.org/licenses/MIT).