Archive::Zip::StreamedUnzip - Read Zip Archives in streaming mode
use Archive::Zip::StreamedUnzip qw($StreamedUnzipError) ; my $z = new Archive::Zip::StreamedUnzip "my.zip" or die "Cannot open zip file: $StreamedUnzipError\n" ; # Iterate through a zip archive while (my $member = $z->next) { print $member->name() . "\n" ; } # Archive::Zip::StreamedUnzip::Member my $name = $member->name(); my $content = $member->content(); my $comment = $member->comment(); # open a filehandle to read from a zip member $fh = $member->open("mydata1.txt"); # read blocks of data read($fh, $buffer, 1234) ; # or a line at a time $line = <$fh> ; close $fh; $z->close();
Archive::Zip::StreamedUnzip is a module that allows reading of Zip archives in streaming mode. This is useful if you are processing a zip coming directly off a socket without having to read the complete file into memory and/or store it on disk. Similarly it can be handy when woking with a pipelined command.
Working with a streamed zip file does have limitations, so most of the time Archive::Zip::SimpleUnzip and/or Archive::Zip are a better choice of module for reading file files.
For writing Zip archives, there is a companion module, called Archive::Zip::SimpleZip, that can create Zip archives.
Read zip archive from a file, a filehandle or from an in-memory buffer.
Perl Filehandle interface for reading a zip member.
Supports deflate, store, bzip2, Zstandard (Zstd), Xz and lzma compression.
Supports Zip64, so can read archves larger than 4Gig and/or have greater than 64K members.
$z = new Archive::Zip::StreamedUnzip "myzipfile.zip" [, OPTIONS] ; $z = new Archive::Zip::StreamedUnzip \$buffer [, OPTIONS] ; $z = new Archive::Zip::StreamedUnzip $filehandle [, OPTIONS] ;
The constructor takes one mandatory parameter along with zero or more optional parameters.
The mandatory parameter controls where the zip archive is read from. This can be any one of the following
Input from a Filename
When StreamedUnzip is passed a string, it will read the zip archive from the filename stored in the string.
Input from a String
When StreamedUnzip is passed a string reference, like \$buffer, it will read the in-memory zip archive from that string.
\$buffer
Input from a Filehandle
When StreamedUnzip is passed a filehandle, it will read the zip archive from that filehandle. Note the filehandle must be seekable.
See "Options" for a list of the optional parameters that can be specified when calling the constructor.
None yet.
Returns the next member from the zip archive as a Archive::Zip::StreamedUnzip::Member object. See "Archive::Zip::StreamedUnzip::Member"
Standard usage is
use Archive::Zip::StreamedUnzip qw($StreamedUnzipError) ; my $match = "hello"; my $zipfile = "my.zip"; my $z = new Archive::Zip::StreamedUnzip $zipfile or die "Cannot open zip file: $StreamedUnzipError\n" ; while (my $member = $z->next()) { my $name = $member->name(); my $fh = $member->open(); while (<$fh>) { my $offset = print "$name, line $.\n" if /$match/; } }
Closes the zip file.
The next method returns a member object of type Archive::Zip::StreamedUnzip::Member that has the following methods.
next
Archive::Zip::StreamedUnzip::Member
Returns the name of the member.
Returns the uncompressed content.
Returns a filehandle that can be used to read the uncompressed content.
use Archive::Zip::StreamedUnzip qw($StreamedUnzipError) ; my $zipfile = "my.zip"; my $z = new Archive::Zip::StreamedUnzip $zipfile or die "Cannot open zip file: $StreamedUnzipError\n" ; while (my $member = $z->next()) { print "$member->name()\n"; }
Here is a simple grep, that walks through a zip file and prints matching strings.
Here is a script that will list the contents of a zip file along with any zip files that are embedded in it. In fact it will work with any level of nesting.
sub walk { my $unzip = shift ; my $depth = shift // 1; while (my $member = $unzip->next()) { my $name = $unzip->name(); print " " x $depth . "$name\n" ; if ($name =~ /\.zip$/i) { my $fh = $member->open(); my $newunzip = new Archive::Zip::StreamedUnzip $fh; walk($newunzip, $depth + 1); } } } my $unzip = new Archive::Zip::StreamedUnzip $zipfile or die "Cannot open '$zipfile': $StreamedUnzipError"; print "$zipfile\n" ; walk($unzip) ;
The intention is to be interoperable with zip archives created by other programs, like pkzip or WinZip, but the majority of testing carried out used the Info-Zip zip/unzip programs running on Linux.
This doesn't necessarily mean that there is no interoperability with other zip programs like pkzip and WinZip - it just means that I haven't tested them. Please report any issues you find.
The following compression methods are supported
This is the most common compression used in zip archives.
This is used when no compression has been carried out.
Only if the IO-Compress-Bzip2 module is available.
IO-Compress-Bzip2
Only if the IO-Compress-Lzma module is available.
IO-Compress-Lzma
To read Xz content, the module IO::Uncompress::UnXz must be installed.
IO::Uncompress::UnXz
To read Zstandard content, the module IO::Uncompress::UnZstd must be installed.
IO::Uncompress::UnZstd
This modules supports Zip64, so it can read archves larger than 4Gig and/or have greater than 64K members.
The following features are not currently supported.
Compression methods not listed in "Compression Methods Supported"
Multi-Volume Archives
Encrypted Archives
General feedback/questions/bug reports should be sent to https://github.com/pmqs/Archive-Zip-SimpleZip/issues (preferred) or https://rt.cpan.org/Public/Dist/Display.html?Name=Archive-Zip-SimpleZip.
Archive::Zip::SimpleUnzip, Archive::Zip::SimpleZip, Archive::Zip, IO::Compress::Zip, IO::Uncompress::UnZip
This module was written by Paul Marquess, pmqs@cpan.org.
See the Changes file.
Copyright (c) 2019-2022 Paul Marquess. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Archive::Zip::SimpleZip, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Archive::Zip::SimpleZip
CPAN shell
perl -MCPAN -e shell install Archive::Zip::SimpleZip
For more information on module installation, please visit the detailed CPAN module installation guide.