zip

Operations on zip archives https://github.com/mrkkrp/zip

Version on this page:0.1.7
LTS Haskell 8.2:0.1.7
Stackage Nightly 2017-02-20:0.1.7
Latest on Hackage:0.1.7
BSD3 licensed and maintained by Mark Karpov

Module documentation for 0.1.7

Zip

License BSD3 Hackage Stackage Nightly Stackage LTS Build Status Coverage Status

This is a feature-rich, memory-efficient, and type-safe library to manipulate Zip archives in Haskell. The library is the most complete and efficient implementation of .ZIP specification in pure Haskell (at least from open-sourced ones). In particular, it's created with large multimedia data in mind and provides all features users might expect, comparable in terms of feature-set with libraries like libzip in C.

Why this library is written

There are a few libraries to work with Zip archives, yet every one of them provides only subset of all functionality user may need (obviously the libraries provide functionality that their authors needed) and otherwise is flawed in some way so it cannot be easily used in some situations. Let's examine all libraries available on Hackage to understand motivation for this package.

zip-archive

zip-archive is a widely used library. It's quite old, well-known and simple to use. However it creates Zip archives purely, as ByteStringss in memory that you can then write to the file system. This is not acceptable if you work with more-or-less big data. For example, if you have collection of files with total size of 500 MB and you want to pack them into an archive, you can easily consume up to 1 GB of memory (files plus resulting archive). Not always you can afford to do this or do this at scale. Even if you want just to look at list of archive entries it will read it into memory in all its entirety. For my use-case it's not acceptable.

LibZip

This is bindings to C library libzip. There is always certain kind of trouble when you are using bindings. For example, you need to take care that target library is installed and its version is compatible with version of your binding. Yes, this means additional headaches. It should be just “plug and play” (if you're using Stack), but now you need to watch out for compatibility.

It's not that bad with libraries that do not break their API for years, but it's not the case with libzip. As maintainer of LibZip puts it:

libzip 0.10, 0.11, and 1.0 are not binary compatible. If your C library is 0.11.x, then you should use LibZip 0.11. If your C library is 1.0, then you should use LibZip master branch (not yet released to Hackage).

Now, on my machine I have version 1.0. To put the package on Stackage we had to use version 0.10, because Stackage uses Ubuntu to build packages and libraries on Ubuntu are always ancient. This means that I cannot use version of the library from Stackage, and I don't yet know what will be on the server.

After much frustration with all these things I decided to avoid using of LibZip, because after all, this is not that sort of project that shouldn't be done in pure Haskell. By rewriting this in Haskell, I also can make it safer to use.

zip-conduit

This one uses the right approach: leverage good streaming library (conduit) for memory-efficient processing. This is however is not feature-rich and has certain problems (including programming style, it uses error if an entry is missing in archive, among other things), some of them are reported on its issue tracker. It also does not appear to be maintained (last sign of activity was on December 23, 2014).

Features

The library supports all features specified in modern .ZIP specification except for encryption and multi-disk archives. See more about this below.

For reference, here is a copy of the specification.

Compression methods

zip supports the following compression methods:

  • Store (no compression, just store files “as is”)
  • DEFLATE
  • Bzip2

The best way to add new compression method to the library is to write conduit that will do the compression and publish it as a library. zip can then depend on it and add it to the list of supported compression methods. Current list of compression methods reflects what is available on Hackage at the moment.

Encryption

Encryption is currently not supported. Encryption system described in Zip specification is known to be seriously flawed, so it's probably not the best way to protect your data anyway. The encryption method seems to be proprietary technology of PKWARE (at least that's what stated about it in the .ZIP specification), so to hell with it.

Sources of file data

The library gives you many options how to get file contents to compress and how to get extracted data. The following methods are supported:

  • File name. This is an efficient method to perform compression or decompression. You just specify where to get data or where to save it and the rest is handled by the library.

  • Conduit source or sink.

  • ByteString. Use it only with small data.

  • Copy file from another archive. Efficient operation, file is copied “as is” — no re-compression is performed.

ZIP64

When necessary, the ZIP64 extension is automatically used. It's necessary when anything from this list takes place:

  • Total size of archive is greater than 4 GB.

  • Size of compressed/uncompressed file in archive is greater than 4 GB.

  • There are more than 65535 entries in archive.

The library is particularly suited for processing of large files. For example, I've been able to easily create 6.5 GB archive with reasonable speed and without any significant memory consumption.

Filenames

The library has API that makes it impossible to create archive with non-portable or invalid file names in it.

As of .ZIP specification 6.3.2, files with Unicode symbols in their names can be put into Zip archives. The library supports mechanisms for this and uses them automatically when needed. Besides UTF-8, CP437 is also supported as it's required in the specification.

Meta-information about files

The library allows to attach comments to entire archive or individual files, and also gives its user full control over extra fields that are written to file headers, so the user can store arbitrary information about file in the archive.

Quick start

The module Codec.Archive.Zip provides everything you need to manipulate Zip archives. There are three things that should be clarified right away, to avoid confusion in the future.

First, we use EntrySelector type that can be obtained from Path Rel File paths. This method may seem awkward at first, but it will protect you from problems with portability when your archive is unpacked on a different platform. Using of well-typed paths is also something you should consider doing in your projects anyway. Even if you don't want to use Path module in your project, it's easy to marshal FilePath to Path just before using functions from the library.

The second thing, that is rather a consequence of the first, is that there is no way to add directories, or to be precise, empty directories to your archive. This approach is used in Git, and I find it quite sane.

Finally, the third feature of the library is that it does not modify archive instantly, because doing so on every manipulation would often be inefficient. Instead we maintain collection of pending actions that can be turned into optimized procedure that efficiently modifies archive in one pass. Normally this should be of no concern to you, because all actions are performed automatically when you leave the realm of ZipArchive monad. If, however, you ever need to force update, commit function is your friend. There are even “undo” functions, by the way.

Let's take a look at some examples that show how to accomplish most typical tasks with help of the library.

To get full information about archive entries, use getEntries:

λ> withArchive archivePath (M.keys <$> getEntries)

This will return list of all entries in archive at archivePath. It's possible to extract contents of archive as strict ByteString:

λ> withArchive archivePath (getEntry entrySelector)

…to stream them to given sink:

λ> withArchive archivePath (sourceEntry entrySelector mySink)

…to save specific entry to a file:

λ> withArchive archivePath (saveEntry entrySelector pathToFile)

…and finally just unpack entire archive into some directory:

λ> withArchive archivePath (unpackInto destDir)

See also getArchiveComment and getArchiveDescription.

Modifying is also easy, efficient, and powerful. When you want to create new archive use createArchive, otherwise withArchive will do. To add entry from ByteString:

λ> createArchive archivePath (addEntry Store "Hello, World!" entrySelector)

You can stream from Source as well:

λ> createArchive archivePath (sinkEntry Deflate source entrySelector)

To add contents from some file, use loadEntry:

λ> let toSelector = const $ parseRelFile "my-entry.txt" >>= mkEntrySelector
λ> createArchive archivePath (loadEntry BZip2 toSelector myFilePath)

Finally, you can copy entry from another archive without re-compression (unless you use recompress, see below):

λ> createArchive archivePath (copyEntry srcArchivePath selector selector)

It's often desirable to just pack a directory:

λ> let f = stripDir dir >=> mkEntrySelector
λ> createArchive archivePath (packDirRecur Deflate f dir)

It's also possible to:

  • rename an entry with renameEntry
  • delete an entry with deleteEntry
  • change compression method with recompress
  • change comment associated with an entry with setEntryComment
  • delete comment with deleteEntryComment
  • set modification time with setModTime
  • manipulate extra fields with addExtraField and deleteExtraField
  • check if entry is intact with checkEntry
  • undo changes with undoEntryCanges, undoArchiveChanges, and undoAll
  • force changes to be written to file system with commit

This should cover all your needs. Feel free to open an issue if you're missing something.

Contribution

You can contact the maintainer via the issue tracker.

We are open to pull requests, they will be merged quickly if they are good!

License

Copyright © 2016–2017 Mark Karpov

Distributed under BSD 3 clause license.

Changes

Zip 0.1.7

  • Fix literal overflows on 32 bit systems.

Zip 0.1.6

  • Allowed time-1.7.

  • Fixed an issue when empty archives with Zip 64 feature enabled could not be read (the “Parsing of archive structure failed: Cannot locate end of central directory”).

Zip 0.1.5

  • Switched to using withBinaryFile instead of withFile, because the latter does nasty conversions on Windows, see docs for openBinaryFile.

Zip 0.1.4

  • Added several simple code examples in Codec.Archive.Zip.

  • Derived Typeable, Data, Generic for EntrySelector.

  • Derived Typeable for EntryDescription.

  • Derived Show, Ord, Bounded, Data, and Typeable for CompressionMethod.

  • Derived Read, Ord, Typeable, and Data for ArchiveDescription.

Zip 0.1.3

  • Improved speed of detection of invalid archives.

  • Introduced getEntrySource function.

Zip 0.1.2

  • Relaxed dependency on semigroups.

  • Added explicit check of “version needed to extract”, so if archive uses some advanced features that we do not support yet, parsing fails.

  • Value of “version needed to extract” field is now calculated dynamically with respect to actually used features, e.g. if you just store or deflate a not very big file, 2.0 version will be written (previously we wrote 4.6 unconditionally). This is needed to avoid scaring tools that can only handle basic Zip archives.

Zip 0.1.1

  • Make decoding of CP437 faster.

Zip 0.1.0

  • Initial release.
comments powered byDisqus