Repo Guidelines

Mainly responsible for this repository is jaanpeeter. Please request a review in every single PR from him.

He will try to review the PRs within 1 week and merge applied PRs within 2 weeks with a new release. Main review day is thursday.

Yaapii.ZIP

Object oriented tools for handling ZIP archives. Based on Yaapii.Atoms.

It follows all the rules suggested in the two "Elegant Objects" books.

For password protected ZIPs it uses "DotNetZip".

Usage

There are different Decorator classes which accept a input. A input might come from a file or a memorystream or any other stream. You can use Atoms InputOf to get an input which you can use with this library. Important: Since we are working with streams, which are expensive to copy in certain cases, the input zip stream will also be altered. If this is undesired, the input stream must be copied beforehand.

Only for Zip Archives

This library works with common zip archives, which have a table of contents. It does not work with simple compressed streams of data.

Zip contents

You can create a new ZIP archive like this:

var file =
    new ZipExtracted(
        new Zipped(
            "small.dat", new InputOf("I feel so compressed")
        ),
        "small.dat"
    ).Stream();

or with multiple files

new Zipped(
    new Dictionary<string, IInput>()
    {
        {"small.dat", new InputOf("I feel so compressed") },
        {"smaller.dat", new InputOf("I'm so compressed") }
    }
);

new Zipped(
    new KeyValuePair<string, IInput>("small.dat", new InputOf("I feel so compressed")),
    new KeyValuePair<string, IInput>("smaller.dat", new InputOf("I'm so compressed"))
);

Update a file in the ZIP:

var updated =
    new ZipUpdated(
        new Zipped("Brave Citizens.txt", new InputOf("nobody")),
        "Brave Citizens.txt", new InputOf("Edward Snowden")
    ).Stream();

or add a file to the ZIP if it doesn't exist

var updated =
    new ZipUpdated(
        new Zipped("Brave Citizens.txt", new InputOf("Edward Snowden")),
        "Concerned Citizens.txt", new InputOf("Donald")
    ).Stream();

Extract a file in the zip:

var extracted =
    new ZipExtracted(
        new InputOf(File.OpenRead("c:/some-zip-archive.zip")),
        "root/dir/some-file.txt",
        false //do not leave the archive open
    ).Stream();

List the contents (directories and files) of an archive:

IEnumerable<string> contents =
    new ZipPaths(
        new InputOf(File.OpenRead("c:/some-zip-archive.zip")),
    );

List all files only of an archive:

IEnumerable<string> files =
    new ZipFiles(
        new InputOf(File.OpenRead("c:/some-zip-archive.zip")),
    );

Remove a file from the archive:

var updated =
    new ZipWithout(
        "root/some-file.txt",
        new InputOf(File.OpenRead("c:/some-zip-archive.zip"))
    ).Stream();

Change the paths in an archive:

var updated =
    new ZipMapped(
        path => "a-prefix" + path,
        new InputOf(File.OpenRead("c:/some-zip-archive.zip"))
    ).Stream();

Test if a stream is a valid zip archive:

var isZip =
    new IsZipArchive(
        new InputOf(File.OpenRead("c:/some-zip-archive.zip"))
    ).Value();

Test if a file exists in a zip:

var exists =
    new ZipContains(
        new InputOf(File.OpenRead("c:/some-zip-archive.zip")),
        "with/path/someFileInTheZip.txt"
    ).Value();

Test if a file in a zip is protected with a password:

var hasPassword =
    new HasPassword(
        new InputOf(File.OpenRead("c:/some-zip-archive.zip")),
        "someFileInTheZip.txt"
    ).Value();

Extract a file with a password in the zip:

var extracted =
    new ZipPasswordExtracted(
        new InputOf(File.OpenRead("c:/some-zip-archive.zip")),
        "root/dir/some-file.txt",
        "password"
    ).Stream();

Create a file with a password in a zip:

var zipArchiveWithPassword =
    new ZipWithPassword(
        "small.dat",
        new InputOf("I feel so compressed"),
        "password"
    );