sharpcompress Wiki Rss Feed

Updated Wiki: Home

adamhathcock — Sun, 07 Apr 2013 10:09:10 GMT

Project Description
SharpCompress is a compression library for .NET/Mono/Silverlight/WP7 that can unrar, un7zip, unzip, untar unbzip2 and ungzip with forward-only reading and file random access APIs. Write support for zip/tar/bzip2/gzip is implemented.

The major feature is support for non-seekable streams so large files can be processed on the fly (i.e. download stream).

Now on GitHub: https://github.com/adamhathcock/sharpcompress

A Simple Request

Hi everyone. I hope you're using SharpCompress and finding it useful. Please give me feedback on what you'd like to see changed especially as far as usability goes. New feature suggestions are always welcome as well. I would also like to know what projects SharpCompress is being used in. I like seeing how it is used to give me ideas for future versions. Thanks!

Want to contribute?

I'm always looking for help or ideas. Please submit code or email with ideas. Unfortunately, just letting me know you'd like to help is not enough because I really have no overall plan of what needs to be done. I'll definitely accept code submissions and add you as a member of the project!

TODOs (always lots):

7Zip writing (started, still need help)
RAR Decryption
Zip64
Multi-volume Zip support.

Supported formats and examples can be found on the Documentation page

Updated Wiki: Home

adamhathcock — Wed, 13 Feb 2013 11:28:12 GMT

A Simple Request

Want to contribute?

TODOs (always lots):

7Zip writing (started, still need help)
RAR Decryption
Zip64
Multi-volume Zip support.

Supported formats and examples can be found on the Documentation page

New Comment on "Documentation"

XRayAdamo — Sat, 02 Feb 2013 16:23:04 GMT

We need more control on compressing to Zip. There is no way to get write stream, and write chunk on data then put new zip entry and do same. It will be very useful for WindowsPhone development. And allows us to cancel any operations. Decompression is excellent and works fine, but not compression. So I forced to use http://slsharpziplib.codeplex.com/ to create Zip file.

New Comment on "Composite API Examples"

HeikkiSiltala — Thu, 13 Dec 2012 09:23:29 GMT

The examples seem to be outdated, but I managed to scratch up a bit of code that makes a zip file, but it is corrupt. Can the author please tell what is wrong with the code below. The intent is to make a zip file ("test.zip"), and add "testfile.txt" into it: CompressionInfo info = new CompressionInfo(); info.Type = CompressionType.Deflate; var zipFile = File.OpenWrite("C:\\test.zip"); var testFile = File.OpenRead("C:\\testfile.txt"); var zipWriter = WriterFactory.Open(zipFile, ArchiveType.Zip, info); zipWriter.Write("testfile.txt", testFile, DateTime.Now); zipFile.Close(); testFile.Close();

Updated Wiki: Home

adamhathcock — Tue, 23 Oct 2012 07:59:03 GMT

A Simple Request

Want to contribute?

Supported formats and examples can be found on the Documentation page

Updated Wiki: Home

adamhathcock — Tue, 23 Oct 2012 07:58:20 GMT

A Simple Request

Want to contribute?

Supported formats and examples can be found on the Documentation page

New Comment on "Documentation"

vijay2345 — Mon, 23 Jul 2012 15:07:49 GMT

hello, I am trying to unrar a file but getting Error 1 The name 'ReaderFactory' does not exist in the current context Error 2 The name 'ExtractOptions' does not exist in the current context Error 3 The name 'ExtractOptions' does not exist in the current context The code is same as one shown in the example, I simply replace path to input and output Also added below assemblies to the solution SharpCompress.3.5 SharpCompress SharpCompress.Silverlight SharpCompress.WP7 I am using VS2010 thanks using (Stream stream = File.OpenRead(@"E:\\BI_analytics\\Data\\Company RCS Cache\\FTP\\COMZIP.rar")) { var reader = ReaderFactory.Open(stream); while (reader.MoveToNextEntry()) { if (!reader.Entry.IsDirectory) { Console.WriteLine(reader.Entry.FilePath); reader.WriteEntryToDirectory(@"E:\\BI_analytics\\Data\\Company RCS Cache\\FTP\\COMZIP2", ExtractOptions.ExtractFullPath | ExtractOptions.Overwrite); } } }

Updated Wiki: Composite API Examples

adamhathcock — Fri, 30 Mar 2012 08:03:53 GMT

Reader (forward-only streams) API Example:

using (Stream stream = File.OpenRead(@"C:\Code\sharpcompress.rar"))
{
	var reader = ReaderFactory.Open(stream);
	while (reader.MoveToNextEntry())
	{
		if (!reader.Entry.IsDirectory)
		{
			Console.WriteLine(reader.Entry.FilePath);
			reader.WriteEntryToDirectory(@"C:\temp", ExtractOptions.ExtractFullPath | ExtractOptions.Overwrite);
		}
	}
}

Archive (random access) API Example:

var archive = ArchiveFactory.Open(@"C:\Code\sharpcompress\TestArchives\sharpcompress.zip");
foreach (var entry in archive.Entries)
{
	if (!entry.IsDirectory)
	{
		Console.WriteLine(entry.FilePath);
		entry.WriteToDirectory(@"C:\temp", ExtractOptions.ExtractFullPath | ExtractOptions.Overwrite);
	}
}

ZipArchive with Writing API Example:

using (var archive = ZipArchive.Create())
{
	archive.AddAllFromDirectoryEntry(@"C:\\source");
	archive.SaveTo("@C:\\new.zip");
}

Creating Zip with Writer API

using (var zip = File.OpenWrite("C:\\test.zip"))
using (var zipWriter = WriterFactory.Open(ArchiveType.Zip, zip))
{
     foreach (var filePath in filesList)
     {
        zipWriter.Write(Path.GetFileName(file), filePath);
     }
}

Creating tar.bz2 with Writer API

using (Stream stream = File.OpenWrite(tarPath))
using (var writer = WriterFactory.Open(ArchiveType.Tar, stream))
{
	writer.WriteAll(filesPath, "*", SearchOption.AllDirectories);
}
using (Stream stream = File.OpenWrite(tarbz2Path))
using (var writer = WriterFactory.Open(ArchiveType.BZip2, stream))
{
	writer.Write("Tar.tar", tarPath);
}

Updated Wiki: Home

adamhathcock — Tue, 27 Mar 2012 12:41:37 GMT

A Simple Request

Want to contribute?

Supported formats and examples can be found on the Documentation page

Updated Wiki: Home

adamhathcock — Fri, 09 Mar 2012 11:29:48 GMT

A Simple Request

Supported formats and examples can be found on the Documentation page

Updated Wiki: Home

adamhathcock — Fri, 09 Mar 2012 11:26:02 GMT

A Simple Request

Supported formats and examples can be found on the Documentation page

NuGet http://nuget.org/List/Packages/sharpcompress

Organization of the library should be akin to Apache Commons Compress (http://commons.apache.org/compress/)

This is a fork of my work from NUnrar (http://nunrar.codeplex.com) to keep nunrar rar-focused.

The Zlib code has been forked from the project (http://dotnetzip.codeplex.com/)
BZip2 implementation taken from http://www.java2s.com/Open-Source/CSharp/PDF/iTextSharp/Org/BouncyCastle/Apache/Bzip2/CatalogBzip2.htm
7zip code is modified from ModReader which was ported to C# by Hugh Perkins http://manageddreams.com

<script type="text/javascript">// <![CDATA[ var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-29849134-1']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); // ]]></script>

Updated Wiki: Home

adamhathcock — Thu, 29 Dec 2011 15:30:05 GMT

A Simple Request

Supported formats and examples can be found on the Documentation page

Updated Wiki: Supported formats

adamhathcock — Wed, 16 Nov 2011 15:00:54 GMT

Supported Format Table

Archive classes allow random access to a seekable stream.
Reader classes allow forward-only reading
Writer classes allow forward-only Writing

Archive Format	Compression Format(s)	Compress/Decompress	Archive API	Reader API	Writer API
Rar	Rar	Decompress⁽¹⁾	RarArchive	RarReader	N/A
Zip⁽²⁾	None, DEFLATE, BZip2, LZMA/LZMA2, PPMd	Both	ZipArchive	ZipReader	ZipWriter
Tar	None, BZip2, GZip	Both	TarArchive	TarReader	TarWriter⁽³⁾
GZip (single file)	GZip	Both	GZipArchive	GZipReader	GZipWriter
7Zip⁽⁴⁾	LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2	Decompress	SevenZipArchive	N/A	N/A

(1) SOLID Rars are only supported in the RarReader API.
(2) Zip format supports pkware and WinzipAES encryption. However, encrypted LZMA is not supported.
(3) The Tar format requires a file size in the header. If no size is specified to the TarWriter and the stream is not seekable, then an exception will be thrown.
(4) The 7Zip format doesn't allow for reading as a forward-only stream so 7Zip is only supported through the Archive API

Compressors

For those who want to directly compress/decompress bits

Compressor	Compress/Decompress
BZip2Stream	Both
GZipStream	Both
DeflateStream	Both
LZMAStream	Both
PPMdStream	Both

Updated Wiki: Home

adamhathcock — Wed, 16 Nov 2011 15:00:39 GMT

Supported Format Table

Archive classes allow random access to a seekable stream.
Reader classes allow forward-only reading
Writer classes allow forward-only Writing

Archive Format	Compression Format(s)	Compress/Decompress	Archive API	Reader API	Writer API
Rar	Rar	Decompress⁽¹⁾	RarArchive	RarReader	N/A
Zip⁽²⁾	None, DEFLATE, BZip2, LZMA/LZMA2, PPMd	Both	ZipArchive	ZipReader	ZipWriter
Tar	None, BZip2, GZip	Both	TarArchive	TarReader	TarWriter⁽³⁾
GZip (single file)	GZip	Both	GZipArchive	GZipReader	GZipWriter
7Zip⁽⁴⁾	LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2	Decompress	SevenZipArchive	N/A	N/A

(1) SOLID Rars are only supported in the RarReader API.
(2) Zip format supports pkware and WinzipAES cryptography . However, encrypted LZMA is not supported. AES cryptography is not available in WP7.
(3) The Tar format requires a file size in the header. If no size is specified to the TarWriter and the stream is not seekable, then an exception will be thrown.
(4) The 7Zip format doesn't allow for reading as a forward-only stream so 7Zip is only supported through the Archive API

Compressors

For those who want to directly compress/decompress bits

Compressor	Compress/Decompress
BZip2Stream	Both
GZipStream	Both
DeflateStream	Both
LZMAStream	Both
PPMdStream	Both

Supported formats and examples can be found on the Documentation page

New Comment on "Composite API Examples"

tsiteb — Tue, 11 Oct 2011 10:40:07 GMT

Unfortunately, I had trouble with several of these examples. The depth of sample code for SharpCompress is very shallow in these documents and on the web and I was forced to abandon usage for Windows Phone 7 after about three hours of testing. I see in one comment and the response that ZipArchive.Create was internal instead of public. I could not get the source code to load in my computer for Windows Phone 7 to compile it either. The project would not load in Visual Studio 2010. This is unfortunate...

Updated Wiki: Home

adamhathcock — Wed, 28 Sep 2011 12:06:37 GMT

Supported Format Table (post 0.6)

Archive classes allow random access to a seekable stream.
Reader classes allow forward-only reading
Writer classes allow forward-only Writing

Archive Format	Compression Format(s)	Compress/Decompress	Archive API	Reader API	Writer API
Rar	Rar	Decompress⁽¹⁾	RarArchive	RarReader	N/A
Zip⁽²⁾	None, DEFLATE, BZip2, LZMA/LZMA2, PPMd	Both	ZipArchive	ZipReader	ZipWriter
Tar	None, BZip2, GZip	Both	TarArchive	TarReader	TarWriter⁽³⁾
GZip (single file)	GZip	Both	GZipArchive	GZipReader	GZipWriter
7Zip⁽⁴⁾	LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2	Decompress	SevenZipArchive	N/A	N/A

Compressors

For those who want to directly compress/decompress bits

Compressor	Compress/Decompress
BZip2Stream	Both
GZipStream	Both
DeflateStream	Both
LZMAStream	Both
PPMdStream	Both

Supported formats and examples can be found on the Documentation page

Updated Wiki: Supported formats

adamhathcock — Wed, 28 Sep 2011 12:06:20 GMT

Supported Format Table (post 0.6)

Archive classes allow random access to a seekable stream.
Reader classes allow forward-only reading
Writer classes allow forward-only Writing

Archive Format	Compression Format(s)	Compress/Decompress	Archive API	Reader API	Writer API
Rar	Rar	Decompress⁽¹⁾	RarArchive	RarReader	N/A
Zip⁽²⁾	None, DEFLATE, BZip2, LZMA/LZMA2, PPMd	Both	ZipArchive	ZipReader	ZipWriter
Tar	None, BZip2, GZip	Both	TarArchive	TarReader	TarWriter⁽³⁾
GZip (single file)	GZip	Both	GZipArchive	GZipReader	GZipWriter
7Zip⁽⁴⁾	LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2	Decompress	SevenZipArchive	N/A	N/A

Compressors

For those who want to directly compress/decompress bits

Compressor	Compress/Decompress
BZip2Stream	Both
GZipStream	Both
DeflateStream	Both
LZMAStream	Both
PPMdStream	Both

Updated Wiki: Supported formats

adamhathcock — Tue, 27 Sep 2011 15:47:26 GMT

API Format Tables

Archive classes allow random access to a seekable stream.
Reader classes allow forward-only reading
Writer classes allow forward-only Writing

Archive Format	Compression Format(s)	Compress/Decompress	Archive API	Reader API	Writer API
Rar	Rar	Decompress⁽¹⁾	RarArchive	RarReader	N/A
Zip⁽²⁾	None, DEFLATE, BZip2, LZMA/LZMA2, PPMd	Both	ZipArchive	ZipReader	ZipWriter
Tar	None, BZip2, GZip	Both	TarArchive	TarReader	TarWriter⁽³⁾
GZip (single file)	GZip	Both	GZipArchive	GZipReader	GZipWriter
7Zip⁽⁴⁾	LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2	Decompress	SevenZipArchive	N/A	N/A

Compressors

For those who want to directly compress/decompress bits

Compressor	Compress/Decompress
BZip2Stream	Both
GZipStream	Both
DeflateStream	Both
LZMAStream	Both
PPMdStream	Both

Updated Wiki: Home

adamhathcock — Tue, 27 Sep 2011 09:33:05 GMT

Currently Supported Formats

Archive classes allow random access to a seekable stream.
Reader classes allow forward-only reading
Writer classes allow forward-only Writing

Archive Format	Compression Format(s)	Compress/Decompress	Archive API	Reader API	Writer API
Rar	Rar	Decompress⁽¹⁾	RarArchive	RarReader	N/A
Zip⁽²⁾	None, DEFLATE, BZip2, LZMA/LZMA2, PPMd	Both	ZipArchive	ZipReader	ZipWriter
Tar	None	Both	TarArchive	TarReader	TarWriter⁽³⁾
Tar	BZip2	Decompress	N/A	TarBZip2Reader	N/A
Tar	GZip	Decompress	N/A	TarGZipReader	N/A
GZip (single file)	GZip	Both	N/A	GZipReader	GZipWriter
BZip2 (no file information)	BZip2	Both	N/A	BZipReader	BZip2Writer
7Zip⁽⁴⁾	LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2	Decompress	SevenZipArchive	N/A	N/A

Compressors

For those who want to directly compress/decompress bits

Compressor	Compress/Decompress
BZip2Stream	Both
GZipStream	Both
DeflateStream	Both
LZMAStream	Both
PPMdStream	Both

Supported formats and examples can be found on the Documentation page

Updated Wiki: Home

adamhathcock — Tue, 27 Sep 2011 09:10:52 GMT

Project Description
SharpCompress is a compression library for .NET/Mono/Silverlight/WP7 that can unrar, unzip, untar unbzip2 and ungzip with forward-only reading and file random access APIs. Write support for zip/tar/bzip2/gzip is implemented.

The major feature is support for non-seekable streams so large files can be processed on the fly (i.e. download stream).

Currently Supported Formats

Archive classes allow random access to a seekable stream.
Reader classes allow forward-only reading
Writer classes allow forward-only Writing

Archive Format	Compression Format(s)	Compress/Decompress	Archive API	Reader API	Writer API
Rar	Rar	Decompress⁽¹⁾	RarArchive	RarReader	N/A
Zip⁽²⁾	None, DEFLATE, BZip2, LZMA/LZMA2, PPMd	Both	ZipArchive	ZipReader	ZipWriter
Tar	None	Both	TarArchive	TarReader	TarWriter⁽³⁾
Tar	BZip2	Decompress	N/A	TarBZip2Reader	N/A
Tar	GZip	Decompress	N/A	TarGZipReader	N/A
GZip (single file)	GZip	Both	N/A	GZipReader	GZipWriter
BZip2 (no file information)	BZip2	Both	N/A	BZipReader	BZip2Writer
7Zip⁽⁴⁾	LZMA, LZMA2, BZip2, PPMd, BCJ, BCJ2	Decompress	SevenZipArchive	N/A	N/A

Compressors

For those who want to directly compress/decompress bits

Compressor	Compress/Decompress
BZip2Stream	Both
GZipStream	Both
DeflateStream	Both
LZMAStream	Both
PPMdStream	Both