#! perl -w

# $Revision: 1.39 $

# Copyright (c) 2000 Ned Konz. All rights reserved.  This program is free

# software; you can redistribute it and/or modify it under the same terms

# as Perl itself.

=head1 NAME

Archive::Zip - Provide an interface to ZIP archive files.

=head1 SYNOPSIS

 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );

 my $zip = Archive::Zip->new();

 my $member = $zip->addDirectory( 'dirname/' );

 $member = $zip->addString( 'This is a test', 'stringMember.txt' );

 $member->desiredCompressionMethod( COMPRESSION_DEFLATED );

 $member = $zip->addFile( 'xyz.pl', 'AnotherName.pl' );

 die 'write error' if $zip->writeToFileNamed( 'someZip.zip' ) != AZ_OK;

 $zip = Archive::Zip->new();

 die 'read error' if $zip->read( 'someZip.zip' ) != AZ_OK;

 $member = $zip->memberNamed( 'stringMember.txt' );

 $member->desiredCompressionMethod( COMPRESSION_STORED );

 die 'write error' if $zip->writeToFileNamed( 'someOtherZip.zip' ) != AZ_OK;

=head1 DESCRIPTION

The Archive::Zip module allows a Perl program to create,

manipulate, read, and write Zip archive files.

Zip archives can be created, or you can read from existing zip files.

Once created, they can be written to files, streams, or strings.

Members can be added, removed, extracted, replaced, rearranged,

and enumerated.

They can also be renamed or have their dates, comments,

or other attributes queried or modified.

Their data can be compressed or uncompressed as needed.

Members can be created from members in existing Zip files,

or from existing directories, files, or strings.

This module uses the L<Compress::Zlib|Compress::Zlib> library

to read and write the compressed streams inside the files.

=head1 EXPORTS

=over 4

=item :CONSTANTS

Exports the following constants:

FA_MSDOS FA_UNIX GPBF_ENCRYPTED_MASK

GPBF_DEFLATING_COMPRESSION_MASK GPBF_HAS_DATA_DESCRIPTOR_MASK

COMPRESSION_STORED COMPRESSION_DEFLATED

IFA_TEXT_FILE_MASK IFA_TEXT_FILE IFA_BINARY_FILE

COMPRESSION_LEVEL_NONE

COMPRESSION_LEVEL_DEFAULT

COMPRESSION_LEVEL_FASTEST

COMPRESSION_LEVEL_BEST_COMPRESSION

=item :MISC_CONSTANTS

Exports the following constants (only necessary for extending the module):

FA_AMIGA FA_VAX_VMS FA_VM_CMS FA_ATARI_ST

FA_OS2_HPFS FA_MACINTOSH FA_Z_SYSTEM FA_CPM FA_WINDOWS_NTFS

GPBF_IMPLODING_8K_SLIDING_DICTIONARY_MASK

GPBF_IMPLODING_3_SHANNON_FANO_TREES_MASK

GPBF_IS_COMPRESSED_PATCHED_DATA_MASK COMPRESSION_SHRUNK

DEFLATING_COMPRESSION_NORMAL DEFLATING_COMPRESSION_MAXIMUM

DEFLATING_COMPRESSION_FAST DEFLATING_COMPRESSION_SUPER_FAST

COMPRESSION_REDUCED_1 COMPRESSION_REDUCED_2 COMPRESSION_REDUCED_3

COMPRESSION_REDUCED_4 COMPRESSION_IMPLODED COMPRESSION_TOKENIZED

COMPRESSION_DEFLATED_ENHANCED

COMPRESSION_PKWARE_DATA_COMPRESSION_LIBRARY_IMPLODED

=item :ERROR_CODES

Explained below. Returned from most methods.

AZ_OK AZ_STREAM_END AZ_ERROR AZ_FORMAT_ERROR AZ_IO_ERROR

=back

=head1 OBJECT MODEL

=head2 Inheritance

 Exporter

    Archive::Zip                            Common base class, has defs.

        Archive::Zip::Archive               A Zip archive.

        Archive::Zip::Member                Abstract superclass for all members.

            Archive::Zip::StringMember      Member made from a string

            Archive::Zip::FileMember        Member made from an external file

                Archive::Zip::ZipFileMember Member that lives in a zip file

                Archive::Zip::NewFileMember Member whose data is in a file

            Archive::Zip::DirectoryMember   Member that is a directory

=cut

# ----------------------------------------------------------------------

# class Archive::Zip

# Note that the package Archive::Zip exists only for exporting and

# sharing constants. Everything else is in another package

# in this file.

# Creation of a new Archive::Zip object actually creates a new object

# of class Archive::Zip::Archive.

# ----------------------------------------------------------------------

package Archive::Zip;

require 5.003_96;

use strict;

use Carp ();

use IO::File ();

use IO::Seekable ();

use Compress::Zlib ();

use POSIX qw(_exit);

use vars qw( @ISA @EXPORT_OK %EXPORT_TAGS $VERSION $ChunkSize $ErrorHandler );

if ($Compress::Zlib::VERSION < 1.06)

{

    if ($] < 5.006001)

    {

       print STDERR "Your current perl libraries are too old; please upgrade to Perl 5.6.1\n";

    }

    else

    {

       print STDERR "There is a problem with your perl run time environment.\n An old version of Zlib is in use,\n please check your perl installation (5.6.1 or later) and your perl libraries\n"; 

    }

    STDERR->flush;

    POSIX:_exit(1);

}

# This is the size we'll try to read, write, and (de)compress.

# You could set it to something different if you had lots of memory

# and needed more speed.

$ChunkSize = 32768;

$ErrorHandler = \&Carp::carp;

# BEGIN block is necessary here so that other modules can use the constants.

BEGIN

{

	require Exporter;

	$VERSION = "0.11";

	@ISA = qw( Exporter );

	my @ConstantNames = qw( FA_MSDOS FA_UNIX GPBF_ENCRYPTED_MASK

	GPBF_DEFLATING_COMPRESSION_MASK GPBF_HAS_DATA_DESCRIPTOR_MASK

	COMPRESSION_STORED COMPRESSION_DEFLATED COMPRESSION_LEVEL_NONE

	COMPRESSION_LEVEL_DEFAULT COMPRESSION_LEVEL_FASTEST

	COMPRESSION_LEVEL_BEST_COMPRESSION IFA_TEXT_FILE_MASK IFA_TEXT_FILE

	IFA_BINARY_FILE );

	my @MiscConstantNames = qw( FA_AMIGA FA_VAX_VMS FA_VM_CMS FA_ATARI_ST

	FA_OS2_HPFS FA_MACINTOSH FA_Z_SYSTEM FA_CPM FA_WINDOWS_NTFS

	GPBF_IMPLODING_8K_SLIDING_DICTIONARY_MASK

	GPBF_IMPLODING_3_SHANNON_FANO_TREES_MASK

	GPBF_IS_COMPRESSED_PATCHED_DATA_MASK COMPRESSION_SHRUNK

	DEFLATING_COMPRESSION_NORMAL DEFLATING_COMPRESSION_MAXIMUM

	DEFLATING_COMPRESSION_FAST DEFLATING_COMPRESSION_SUPER_FAST

	COMPRESSION_REDUCED_1 COMPRESSION_REDUCED_2 COMPRESSION_REDUCED_3

	COMPRESSION_REDUCED_4 COMPRESSION_IMPLODED COMPRESSION_TOKENIZED

	COMPRESSION_DEFLATED_ENHANCED

	COMPRESSION_PKWARE_DATA_COMPRESSION_LIBRARY_IMPLODED );

	my @ErrorCodeNames = qw( AZ_OK AZ_STREAM_END AZ_ERROR AZ_FORMAT_ERROR

	AZ_IO_ERROR );

	my @PKZipConstantNames = qw( SIGNATURE_FORMAT SIGNATURE_LENGTH

	LOCAL_FILE_HEADER_SIGNATURE LOCAL_FILE_HEADER_FORMAT

	LOCAL_FILE_HEADER_LENGTH DATA_DESCRIPTOR_FORMAT DATA_DESCRIPTOR_LENGTH

	CENTRAL_DIRECTORY_FILE_HEADER_SIGNATURE

	CENTRAL_DIRECTORY_FILE_HEADER_FORMAT CENTRAL_DIRECTORY_FILE_HEADER_LENGTH

	END_OF_CENTRAL_DIRECTORY_SIGNATURE

	END_OF_CENTRAL_DIRECTORY_SIGNATURE_STRING END_OF_CENTRAL_DIRECTORY_FORMAT

	END_OF_CENTRAL_DIRECTORY_LENGTH );

	my @UtilityMethodNames = qw( _error _ioError _formatError

		_subclassResponsibility _binmode _isSeekable _newFileHandle);

	@EXPORT_OK = ( 'computeCRC32' );

	%EXPORT_TAGS = ( 'CONSTANTS' => \@ConstantNames,

			'MISC_CONSTANTS' => \@MiscConstantNames,

			'ERROR_CODES' => \@ErrorCodeNames,

			# The following two sets are for internal use only

			'PKZIP_CONSTANTS' => \@PKZipConstantNames,

			'UTILITY_METHODS' => \@UtilityMethodNames );

	# Add all the constant names and error code names to @EXPORT_OK

	Exporter::export_ok_tags( 'CONSTANTS', 'ERROR_CODES',

		'PKZIP_CONSTANTS', 'UTILITY_METHODS', 'MISC_CONSTANTS' );

}

# ------------------------- begin exportable error codes -------------------

=head1 ERROR CODES

Many of the methods in Archive::Zip return error codes.

These are implemented as inline subroutines, using the C<use constant> pragma.

They can be imported into your namespace using the C<:CONSTANT>

tag:

    use Archive::Zip qw( :CONSTANTS );

    ...

    die "whoops!" if $zip->read( 'myfile.zip' ) != AZ_OK;

=over 4

=item AZ_OK (0)

Everything is fine.

=item AZ_STREAM_END (1)

The read stream (or central directory) ended normally.

=item AZ_ERROR (2)

There was some generic kind of error.

=item AZ_FORMAT_ERROR (3)

There is a format error in a ZIP file being read.

=item AZ_IO_ERROR (4)

There was an IO error.

=back

=cut

use constant AZ_OK			=> 0;

use constant AZ_STREAM_END	=> 1;

use constant AZ_ERROR		=> 2;

use constant AZ_FORMAT_ERROR => 3;

use constant AZ_IO_ERROR	=> 4;

# ------------------------- end exportable error codes ---------------------

# ------------------------- begin exportable constants ---------------------

# File types

# Values of Archive::Zip::Member->fileAttributeFormat()

use constant FA_MSDOS		=> 0;

use constant FA_UNIX		=> 3;

# general-purpose bit flag masks

# Found in Archive::Zip::Member->bitFlag()

use constant GPBF_ENCRYPTED_MASK						=> 1 << 0;

use constant GPBF_DEFLATING_COMPRESSION_MASK			=> 3 << 1;

use constant GPBF_HAS_DATA_DESCRIPTOR_MASK				=> 1 << 3;

# deflating compression types, if compressionMethod == COMPRESSION_DEFLATED

# ( Archive::Zip::Member->bitFlag() & GPBF_DEFLATING_COMPRESSION_MASK )

use constant DEFLATING_COMPRESSION_NORMAL		=> 0 << 1;

use constant DEFLATING_COMPRESSION_MAXIMUM		=> 1 << 1;

use constant DEFLATING_COMPRESSION_FAST			=> 2 << 1;

use constant DEFLATING_COMPRESSION_SUPER_FAST	=> 3 << 1;

# compression method

=head1 COMPRESSION

Archive::Zip allows each member of a ZIP file to be compressed (using

the Deflate algorithm) or uncompressed. Other compression algorithms

that some versions of ZIP have been able to produce are not supported.

Each member has two compression methods: the one it's stored as (this

is always COMPRESSION_STORED for string and external file members),

and the one you desire for the member in the zip file.

These can be different, of course, so you can make a zip member that

is not compressed out of one that is, and vice versa.

You can inquire about the current compression and set

the desired compression method:

    my $member = $zip->memberNamed( 'xyz.txt' );

    $member->compressionMethod();    # return current compression

    # set to read uncompressed

    $member->desiredCompressionMethod( COMPRESSION_STORED );

    # set to read compressed

    $member->desiredCompressionMethod( COMPRESSION_DEFLATED );

There are two different compression methods:

=over 4

=item COMPRESSION_STORED

file is stored (no compression)

=item COMPRESSION_DEFLATED

file is Deflated

=back

=head2 Compression Levels

If a member's desiredCompressionMethod is COMPRESSION_DEFLATED,

you can choose different compression levels. This choice may

affect the speed of compression and decompression, as well as

the size of the compressed member data.

    $member->desiredCompressionLevel( 9 );

The levels given can be:

=over 4

=item 0 or COMPRESSION_LEVEL_NONE

This is the same as saying

    $member->desiredCompressionMethod( COMPRESSION_STORED );

=item 1 .. 9

1 gives the best speed and worst compression, and 9 gives the best

compression and worst speed.

=item COMPRESSION_LEVEL_FASTEST

This is a synonym for level 1.

=item COMPRESSION_LEVEL_BEST_COMPRESSION

This is a synonym for level 9.

=item COMPRESSION_LEVEL_DEFAULT

This gives a good compromise between speed and compression, and is

currently equivalent to 6 (this is in the zlib code).

This is the level that will be used if not specified.

=back

=cut

# these two are the only ones supported in this module

use constant COMPRESSION_STORED => 0;	# file is stored (no compression)

use constant COMPRESSION_DEFLATED => 8;	# file is Deflated

use constant COMPRESSION_LEVEL_NONE => 0;

use constant COMPRESSION_LEVEL_DEFAULT => -1;

use constant COMPRESSION_LEVEL_FASTEST => 1;

use constant COMPRESSION_LEVEL_BEST_COMPRESSION => 9;

# internal file attribute bits

# Found in Archive::Zip::Member::internalFileAttributes()

use constant IFA_TEXT_FILE_MASK	=> 1;

use constant IFA_TEXT_FILE		=> 1;	# file is apparently text

use constant IFA_BINARY_FILE	=> 0;

# PKZIP file format miscellaneous constants (for internal use only)

use constant SIGNATURE_FORMAT => "V";

use constant SIGNATURE_LENGTH => 4;

use constant LOCAL_FILE_HEADER_SIGNATURE	=> 0x04034b50;

use constant LOCAL_FILE_HEADER_FORMAT		=> "v3 V4 v2";

use constant LOCAL_FILE_HEADER_LENGTH		=> 26;

use constant DATA_DESCRIPTOR_FORMAT	=> "V3";

use constant DATA_DESCRIPTOR_LENGTH	=> 12;

use constant CENTRAL_DIRECTORY_FILE_HEADER_SIGNATURE => 0x02014b50;

use constant CENTRAL_DIRECTORY_FILE_HEADER_FORMAT => "C2 v3 V4 v5 V2";

use constant CENTRAL_DIRECTORY_FILE_HEADER_LENGTH => 42;

use constant END_OF_CENTRAL_DIRECTORY_SIGNATURE => 0x06054b50;

use constant END_OF_CENTRAL_DIRECTORY_SIGNATURE_STRING => pack( "V",

	END_OF_CENTRAL_DIRECTORY_SIGNATURE );

use constant END_OF_CENTRAL_DIRECTORY_FORMAT => "v4 V2 v";

use constant END_OF_CENTRAL_DIRECTORY_LENGTH => 18;

use constant FA_AMIGA		=> 1;

use constant FA_VAX_VMS		=> 2;

use constant FA_VM_CMS		=> 4;

use constant FA_ATARI_ST	=> 5;

use constant FA_OS2_HPFS	=> 6;

use constant FA_MACINTOSH	=> 7;

use constant FA_Z_SYSTEM	=> 8;

use constant FA_CPM			=> 9;

use constant FA_WINDOWS_NTFS => 10;

use constant GPBF_IMPLODING_8K_SLIDING_DICTIONARY_MASK	=> 1 << 1;

use constant GPBF_IMPLODING_3_SHANNON_FANO_TREES_MASK	=> 1 << 2;

use constant GPBF_IS_COMPRESSED_PATCHED_DATA_MASK		=> 1 << 5;

# the rest of these are not supported in this module

use constant COMPRESSION_SHRUNK => 1;	# file is Shrunk

use constant COMPRESSION_REDUCED_1 => 2;# file is Reduced CF=1

use constant COMPRESSION_REDUCED_2 => 3;# file is Reduced CF=2

use constant COMPRESSION_REDUCED_3 => 4;# file is Reduced CF=3

use constant COMPRESSION_REDUCED_4 => 5;# file is Reduced CF=4

use constant COMPRESSION_IMPLODED => 6;	# file is Imploded

use constant COMPRESSION_TOKENIZED => 7;# reserved for Tokenizing compr.

use constant COMPRESSION_DEFLATED_ENHANCED => 9; # reserved for enh. Deflating

use constant COMPRESSION_PKWARE_DATA_COMPRESSION_LIBRARY_IMPLODED => 10;

# ------------------------- end of exportable constants ---------------------

=head1  Archive::Zip methods

The Archive::Zip class (and its invisible subclass Archive::Zip::Archive)

implement generic zip file functionality.

Creating a new Archive::Zip object actually makes an Archive::Zip::Archive

object, but you don't have to worry about this unless you're subclassing.

=cut

=head2 Constructor

=over 4

=cut

use constant ZIPARCHIVECLASS 	=> 'Archive::Zip::Archive';

use constant ZIPMEMBERCLASS		=> 'Archive::Zip::Member';

#--------------------------------

=item new( [$fileName] )

Make a new, empty zip archive.

    my $zip = Archive::Zip->new();

If an additional argument is passed, new() will call read() to read the

contents of an archive:

    my $zip = Archive::Zip->new( 'xyz.zip' );

If a filename argument is passed and the read fails for any reason, new

will return undef. For this reason, it may be better to call read

separately.

=cut

sub new	# Archive::Zip

{

	my $class = shift;

	return $class->ZIPARCHIVECLASS->new( @_ );

}

=back

=head2  Utility Methods

These Archive::Zip methods may be called as functions or as object

methods. Do not call them as class methods:

    $zip = Archive::Zip->new();

    $crc = Archive::Zip::computeCRC32( 'ghijkl' );    # OK

    $crc = $zip->computeCRC32( 'ghijkl' );            # also OK

    $crc = Archive::Zip->computeCRC32( 'ghijkl' );    # NOT OK

=over 4

=cut

#--------------------------------

=item Archive::Zip::computeCRC32( $string [, $crc] )

This is a utility function that uses the Compress::Zlib CRC

routine to compute a CRC-32.

You can get the CRC of a string:

    $crc = Archive::Zip::computeCRC32( $string );

Or you can compute the running CRC:

    $crc = 0;

    $crc = Archive::Zip::computeCRC32( 'abcdef', $crc );

    $crc = Archive::Zip::computeCRC32( 'ghijkl', $crc );

=cut

sub computeCRC32	# Archive::Zip

{

	my $data = shift;

	$data = shift if ref( $data );	# allow calling as an obj method

	my $crc = shift;

	return Compress::Zlib::crc32( $data, $crc );

}

#--------------------------------

=item Archive::Zip::setChunkSize( $number )

Change chunk size used for reading and writing.

Currently, this defaults to 32K.

This is not exportable, so you must call it like:

    Archive::Zip::setChunkSize( 4096 );

or as a method on a zip (though this is a global setting).

Returns old chunk size.

=cut

sub setChunkSize	# Archive::Zip

{

	my $chunkSize = shift;

	$chunkSize = shift if ref( $chunkSize );	# object method on zip?

	my $oldChunkSize = $Archive::Zip::ChunkSize;

	$Archive::Zip::ChunkSize = $chunkSize;

	return $oldChunkSize;

}