Cube.FileSystem.SevenZip 5.0.0

Install-Package Cube.FileSystem.SevenZip -Version 5.0.0
dotnet add package Cube.FileSystem.SevenZip --version 5.0.0
<PackageReference Include="Cube.FileSystem.SevenZip" Version="5.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Cube.FileSystem.SevenZip --version 5.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Cube.FileSystem.SevenZip, 5.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Cube.FileSystem.SevenZip as a Cake Addin
#addin nuget:?package=Cube.FileSystem.SevenZip&version=5.0.0

// Install Cube.FileSystem.SevenZip as a Cake Tool
#tool nuget:?package=Cube.FileSystem.SevenZip&version=5.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Cube.FileSystem.SevenZip

Package AppVeyor Codecov

Cube.FileSystem.SevenZip is a wrapper library of the 7-Zip via COM interface. The project also has an application for compressing or extracting archives, which name is CubeICE. Libraries and applications are available for .NET Framework 3.5, 4.5 or later. Note that some projects are licensed under the GNU LGPLv3 and the others under the Apache 2.0. See License.md for more information.

Usage

You can install the library through the NuGet package. Add a dependency in your project file using the following syntax:

<PackageReference Include="Cube.FileSystem.SevenZip" Version="5.0.0" />

Or select it from the NuGet packages UI on Visual Studio.

Examples for archiving files

A simple example for archiving files is as follows. Note that the statement "using Cube.FileSystem.SevenZip;" has been omitted in all samples.

// Set only what you need.
var files   = new[] { ".DS_Store", "Thumbs.db", "__MACOSX", "desktop.ini" };
var options = new CompressionOption
{
    CompressionLevel  = CompressionLevel.Ultra,
    CompressionMethod = CompressionMethod.Lzma,
    EncryptionMethod  = EncryptionMethod.Aes256,
    Password          = "password",
    Filter            = new Filter(files).Match,
    CodePage          = CodePage.Utf8,
};

using (var writer = new ArchiveWriter(Format.Zip, options))
{
    writer.Add(@"path\to\file");
    writer.Add(@"path\to\directory_including_files");
    
    var progress = new Progress<Report>(e => DoSomething(e));
    writer.Save(@"path\to\save.zip", progress);
}

You create an ArchiveWriter object with an archiving format (e.g. Zip, SevenZip, ...), add files and/or directories you want to archive, set some additional options, and finally call the Save method. When you create Tar based archives, you can use a TarOption object for selecting a compression method.

var options = new CompressionOption
{
    CompressionLevel  = CompressionLevel.Ultra,
    CompressionMethod = CompressionMethod.BZip2, // GZip, BZip2, XZ or Copy
};

using (var writer = new ArchiveWriter(Format.Tar, options))
{
    writer.Add(@"path\to\file");
    writer.Add(@"path\to\directory_including_files");
    writer.Save(@"path\to\save.tar.gz");
}

Examples for extracting archives

If you want to extract all files from the archive, you create an ArchiveReader object and call the Extract method. The 2nd argument of the constructor, that means the password of the archive, can be set string or Cube.Query<string> object. The latter is mainly used for implementing the interactive mode.

// Set password directly or using Query<string>
var password = new Cube.Query<string>(e =>
{
    e.Result = "password";
    e.Cancel = false;
});

// Supports only the Filter property
var files   = new[] { ".DS_Store", "Thumbs.db", "__MACOSX", "desktop.ini" };
var options = new ArchiveOption
{
    Filter = new Filter(files).Match
};

using (var reader = new ArchiveReader(@"path\to\archive", password, options))
{
    var progress = new Progress<Report>(e => DoSomething(e));
    reader.Save(@"path\to\directory", progress);
}

Note that ArchiveWriter and ArchiveReader classes need to execute in the same thread from constructing to destroying. Use Task.Run() in the whole transaction if you need to archive or extract files asynchronously.

Dependencies

Contributing

  1. Fork Cube.FileSystem.SevenZip repository.
  2. Create a feature branch from the master (e.g. git checkout -b my-new-feature origin/master). Note that the master branch may refer some pre-released NuGet packages. Try the rake clean command when build errors occur.
  3. Commit your changes.
  4. Rebase your local changes against the master branch.
  5. Run the dotnet test command or the Visual Studio (NUnit 3 test adapter) and confirm that it passes.
  6. Create new Pull Request.

License

Copyright © 2010 CubeSoft, Inc. See License.md for more information.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.0 127 10/26/2021
1.15.10 353 6/15/2020
1.15.0 508 4/22/2019
1.14.0 420 2/17/2019
1.13.0 448 11/22/2018
1.12.0 456 10/23/2018
1.11.1 451 10/17/2018
1.11.0 477 10/17/2018