Codec.Archive.Zip

The zip-archive library provides functions for creating, modifying, and extracting files from zip archives.

Certain simplifying assumptions are made about the zip archives: in particular, there is no support for encryption, zip files that span multiple disks, ZIP64, OS-specific file attributes, or compression methods other than Deflate. However, the library should be able to read the most common zip archives, and the archives it produces should be readable by all standard unzip programs.

As an example of the use of the library, a standalone zip archiver and extracter, Zip.hs, is provided in the source distribution.

For more information on the format of zip archives, consult http://www.pkware.com/documents/casestudies/APPNOTE.TXT

Data structures

data Archive

Structured representation of a zip archive, including directory information and contents (in lazy bytestrings).

Constructors

Archive

Fields

• zEntries :: [Entry]

  Files in zip archive

• zSignature :: Maybe ByteString

  Digital signature

• zComment :: ByteString

  Comment for whole zip archive

Instances

Read Archive

Methods

readsPrec :: Int -> ReadS Archive

readList :: ReadS [Archive]

readPrec :: ReadPrec Archive

readListPrec :: ReadPrec [Archive]

Show Archive

Methods

showsPrec :: Int -> Archive -> ShowS

show :: Archive -> String

showList :: [Archive] -> ShowS

Binary Archive

Methods

put :: Archive -> Put

get :: Get Archive

putList :: [Archive] -> Put

data Entry

Representation of an archived file, including content and metadata.

Constructors

Entry

Fields

• eRelativePath :: FilePath

  Relative path, using / as separator

• eCompressionMethod :: CompressionMethod

  Compression method

• eLastModified :: Integer

  Modification time (seconds since unix epoch)

• eCRC32 :: Word32

  CRC32 checksum

• eCompressedSize :: Word32

  Compressed size in bytes

• eUncompressedSize :: Word32

  Uncompressed size in bytes

• eExtraField :: ByteString

  Extra field - unused by this library

• eFileComment :: ByteString

  File comment - unused by this library

• eVersionMadeBy :: Word16

  Version made by field

• eInternalFileAttributes :: Word16

  Internal file attributes - unused by this library

• eExternalFileAttributes :: Word32

  External file attributes (system-dependent)

• eCompressedData :: ByteString

  Compressed contents of file

Instances

Eq Entry

Methods

(==) :: Entry -> Entry -> Bool

(/=) :: Entry -> Entry -> Bool

Read Entry

Methods

readsPrec :: Int -> ReadS Entry

readList :: ReadS [Entry]

readPrec :: ReadPrec Entry

readListPrec :: ReadPrec [Entry]

Show Entry

Methods

showsPrec :: Int -> Entry -> ShowS

show :: Entry -> String

showList :: [Entry] -> ShowS

data CompressionMethod

Compression methods.

Constructors

Deflate

NoCompression

Instances

Eq CompressionMethod

Methods

(==) :: CompressionMethod -> CompressionMethod -> Bool

(/=) :: CompressionMethod -> CompressionMethod -> Bool

Read CompressionMethod

Methods

readsPrec :: Int -> ReadS CompressionMethod

readList :: ReadS [CompressionMethod]

readPrec :: ReadPrec CompressionMethod

readListPrec :: ReadPrec [CompressionMethod]

Show CompressionMethod

Methods

showsPrec :: Int -> CompressionMethod -> ShowS

show :: CompressionMethod -> String

showList :: [CompressionMethod] -> ShowS

data ZipOption

Options for addFilesToArchive and extractFilesFromArchive.

Constructors

OptRecursive

Recurse into directories when adding files

OptVerbose

Print information to stderr

OptDestination FilePath

Directory in which to extract

OptLocation FilePath Bool

Where to place file when adding files and whether to append current path

Instances

Eq ZipOption

Methods

(==) :: ZipOption -> ZipOption -> Bool

(/=) :: ZipOption -> ZipOption -> Bool

Read ZipOption

Methods

readsPrec :: Int -> ReadS ZipOption

readList :: ReadS [ZipOption]

readPrec :: ReadPrec ZipOption

readListPrec :: ReadPrec [ZipOption]

Show ZipOption

Methods

showsPrec :: Int -> ZipOption -> ShowS

show :: ZipOption -> String

showList :: [ZipOption] -> ShowS

data ZipException

Constructors

CRC32Mismatch FilePath

Instances

Data ZipException

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ZipException -> c ZipException

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ZipException

toConstr :: ZipException -> Constr

dataTypeOf :: ZipException -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ZipException)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ZipException)

gmapT :: (forall b. Data b => b -> b) -> ZipException -> ZipException

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ZipException -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ZipException -> r

gmapQ :: (forall d. Data d => d -> u) -> ZipException -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ZipException -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ZipException -> m ZipException

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ZipException -> m ZipException

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ZipException -> m ZipException

Show ZipException

Methods

showsPrec :: Int -> ZipException -> ShowS

show :: ZipException -> String

showList :: [ZipException] -> ShowS

Exception ZipException

Methods

toException :: ZipException -> SomeException

fromException :: SomeException -> Maybe ZipException

displayException :: ZipException -> String

emptyArchive :: Archive

A zip archive with no contents.

Pure functions for working with zip archives

toArchive :: ByteString -> Archive

Reads an Archive structure from a raw zip archive (in a lazy bytestring).

toArchiveOrFail :: ByteString -> Either String Archive

Like toArchive, but returns an Either value instead of raising an error if the archive cannot be decoded. NOTE: This function only works properly when the library is compiled against binary >= 0.7. With earlier versions, it will always return a Right value, raising an error if parsing fails.

fromArchive :: Archive -> ByteString

Writes an Archive structure to a raw zip archive (in a lazy bytestring).

filesInArchive :: Archive -> [FilePath]

Returns a list of files in a zip archive.

addEntryToArchive :: Entry -> Archive -> Archive

Adds an entry to a zip archive, or updates an existing entry.

deleteEntryFromArchive :: FilePath -> Archive -> Archive

Deletes an entry from a zip archive.

findEntryByPath :: FilePath -> Archive -> Maybe Entry

Returns Just the zip entry with the specified path, or Nothing.

fromEntry :: Entry -> ByteString

Returns uncompressed contents of zip entry.

toEntry

Arguments

:: FilePath

File path for entry

-> Integer

Modification time for entry (seconds since unix epoch)

-> ByteString

Contents of entry

-> Entry

Create an Entry with specified file path, modification time, and contents.

IO functions for working with zip archives

readEntry :: [ZipOption] -> FilePath -> IO Entry

Generates a Entry from a file or directory.

writeEntry :: [ZipOption] -> Entry -> IO ()

Writes contents of an Entry to a file. Throws a CRC32Mismatch exception if the CRC32 checksum for the entry does not match the uncompressed data.

addFilesToArchive :: [ZipOption] -> Archive -> [FilePath] -> IO Archive

Add the specified files to an Archive. If OptRecursive is specified, recursively add files contained in directories. If OptVerbose is specified, print messages to stderr.

extractFilesFromArchive :: [ZipOption] -> Archive -> IO ()

Extract all files from an Archive, creating directories as needed. If OptVerbose is specified, print messages to stderr. Note that the last-modified time is set correctly only in POSIX, not in Windows.