Importing Archive::Zip 1.16

[archive-zip.git] / lib / Archive / Zip / FAQ.pod

\r
=head1 NAME\r
\r
\r
Archive::Zip::FAQ - Answers to a few frequently asked questions about Archive::Zip\r
\r
=head1 DESCRIPTION\r
\r
\r
It seems that I keep answering the same questions over and over again. I\r
assume that this is because my documentation is deficient, rather than that\r
people don't read the documentation.\r
\r
\r
So this FAQ is an attempt to cut down on the number of personal answers I have\r
to give. At least I can now say "You I<did> read the FAQ, right?".\r
\r
\r
The questions are not in any particular order. The answers assume the current\r
version of Archive::Zip; some of the answers depend on newly added/fixed\r
functionality.\r
\r
=head1 Install problems on RedHat 8 or 9 with Perl 5.8.0\r
\r
\r
B<Q:> Archive::Zip won't install on my RedHat 9 system! It's broke!\r
\r
\r
B<A:> This has become something of a FAQ.\r
Basically, RedHat broke some versions of Perl by setting LANG to UTF8.\r
They apparently have a fixed version out as an update.\r
\r
You might try running CPAN or creating your Makefile after exporting the LANG\r
environment variable as\r
\r
C<LANG=C>\r
\r
L<https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=87682>\r
\r
\r
=head1 Why is my zip file so big?\r
\r
\r
B<Q:> My zip file is actually bigger than what I stored in it! Why?\r
\r
\r
B<A:> Some things to make sure of:\r
\r
=over 4\r
\r
=item Make sure that you are requesting COMPRESSION_DEFLATED if you are storing strings.\r
\r
\r
\r
\r
$member->desiredCompressionMethod( COMPRESSION_DEFLATED );\r
\r
\r
=item Don't make lots of little files if you can help it.\r
\r
\r
\r
Since zip computes the compression tables for each member, small\r
members without much entropy won't compress well.  Instead, if you've\r
got lots of repeated strings in your data, try to combine them into\r
one big member.\r
\r
\r
=item Make sure that you are requesting COMPRESSION_STORED if you are storing things that are already compressed.\r
\r
\r
\r
If you're storing a .zip, .jpg, .mp3, or other compressed file in a zip,\r
then don't compress them again. They'll get bigger.\r
\r
=back\r
\r
=head1 Sample code?\r
\r
\r
B<Q:> Can you send me code to do (whatever)?\r
\r
\r
B<A:> Have you looked in the C<examples/> directory yet? It contains:\r
\r
=over 4\r
\r
=item examples/calcSizes.pl    -- How to find out how big a Zip file will be before writing it\r
\r
\r
\r
=item examples/copy.pl         -- Copies one Zip file to another\r
\r
\r
\r
=item examples/extract.pl      -- extract file(s) from a Zip\r
\r
\r
\r
=item examples/mailZip.pl      -- make and mail a zip file\r
\r
\r
\r
=item examples/mfh.pl          -- demo for use of MockFileHandle\r
\r
\r
\r
=item examples/readScalar.pl   -- shows how to use IO::Scalar as the source of a Zip read\r
\r
\r
\r
=item examples/selfex.pl       -- a brief example of a self-extracting Zip\r
\r
\r
\r
=item examples/unzipAll.pl     -- uses Archive::Zip::Tree to unzip an entire Zip\r
\r
\r
\r
=item examples/updateZip.pl    -- shows how to read/modify/write a Zip\r
\r
\r
\r
=item examples/updateTree.pl   -- shows how to update a Zip in place\r
\r
\r
\r
=item examples/writeScalar.pl  -- shows how to use IO::Scalar as the destination of a Zip write\r
\r
\r
\r
=item examples/writeScalar2.pl -- shows how to use IO::String as the destination of a Zip write\r
\r
\r
\r
=item examples/zip.pl          -- Constructs a Zip file\r
\r
\r
\r
=item examples/zipcheck.pl     -- One way to check a Zip file for validity\r
\r
\r
\r
=item examples/zipinfo.pl      -- Prints out information about a Zip archive file\r
\r
\r
\r
=item examples/zipGrep.pl      -- Searches for text in Zip files\r
\r
\r
\r
=item examples/ziptest.pl      -- Lists a Zip file and checks member CRCs\r
\r
\r
\r
=item examples/ziprecent.pl    -- Puts recent files into a zipfile\r
\r
\r
\r
=item examples/ziptest.pl      -- Another way to check a Zip file for validity\r
\r
\r
\r
=back\r
\r
=head1 Can't Read/modify/write same Zip file\r
\r
\r
B<Q:> Why can't I open a Zip file, add a member, and write it back? I get an\r
error message when I try.\r
\r
\r
B<A:> Because Archive::Zip doesn't (and can't, generally) read file contents into memory,\r
the original Zip file is required to stay around until the writing of the new\r
file is completed.\r
\r
\r
The best way to do this is to write the Zip to a temporary file and then\r
rename the temporary file to have the old name (possibly after deleting the\r
old one).\r
\r
\r
Archive::Zip v1.02 added the archive methods C<overwrite()> and\r
C<overwriteAs()> to do this simply and carefully.\r
\r
\r
See C<examples/updateZip.pl> for an example of this technique.\r
\r
=head1 File creation time not set\r
\r
\r
B<Q:> Upon extracting files, I see that their modification (and access) times are\r
set to the time in the Zip archive. However, their creation time is not set to\r
the same time. Why?\r
\r
\r
B<A:> Mostly because Perl doesn't give cross-platform access to I<creation time>.\r
Indeed, many systems (like Unix) don't support such a concept.\r
However, if yours does, you can easily set it. Get the modification time from\r
the member using C<lastModTime()>.\r
\r
=head1 Can't use Archive::Zip on gzip files\r
\r
\r
B<Q:> Can I use Archive::Zip to extract Unix gzip files?\r
\r
\r
B<A:> No.\r
\r
\r
There is a distinction between Unix gzip files, and Zip archives that \r
also can use the gzip compression.\r
\r
\r
Depending on the format of the gzip file, you can use L<Compress::Zlib>, or\r
L<Archive::Tar> to decompress it (and de-archive it in the case of Tar files).\r
\r
\r
You can unzip PKZIP/WinZip/etc/ archives using Archive::Zip (that's what \r
it's for) as long as any compressed members are compressed using \r
Deflate compression.\r
\r
=head1 Add a directory/tree to a Zip\r
\r
\r
B<Q:> How can I add a directory (or tree) full of files to a Zip?\r
\r
\r
B<A:> You can use the Archive::Zip::addTree*() methods:\r
\r
   use Archive::Zip;\r
   my $zip = Archive::Zip->new();\r
   # add all readable files and directories below . as xyz/*\r
   $zip->addTree( '.', 'xyz' ); \r
   # add all readable plain files below /abc as def/*\r
   $zip->addTree( '/abc', 'def', sub { -f && -r } );    \r
   # add all .c files below /tmp as stuff/*\r
   $zip->addTreeMatching( '/tmp', 'stuff', '\.c$' );\r
   # add all .o files below /tmp as stuff/* if they aren't writable\r
   $zip->addTreeMatching( '/tmp', 'stuff', '\.o$', sub { ! -w } );\r
   # add all .so files below /tmp that are smaller than 200 bytes as stuff/*\r
   $zip->addTreeMatching( '/tmp', 'stuff', '\.o$', sub { -s < 200 } );\r
   # and write them into a file\r
   $zip->writeToFileNamed('xxx.zip');\r
\r
=head1 Extract a directory/tree\r
\r
\r
B<Q:> How can I extract some (or all) files from a Zip into a different\r
directory?\r
\r
\r
B<A:> You can use the Archive::Zip::extractTree() method:\r
??? ||\r
\r
\r
   # now extract the same files into /tmpx\r
   $zip->extractTree( 'stuff', '/tmpx' );\r
\r
=head1 Update a directory/tree\r
\r
\r
B<Q:> How can I update a Zip from a directory tree, adding or replacing only\r
the newer files?\r
\r
\r
B<A:> You can use the Archive::Zip::updateTree() method that was added in version 1.09.\r
\r
=head1 Zip times might be off by 1 second\r
\r
\r
B<Q:> It bothers me greatly that my file times are wrong by one second about half\r
the time. Why don't you do something about it?\r
\r
\r
B<A:> Get over it. This is a result of the Zip format storing times in DOS\r
format, which has a resolution of only two seconds.\r
\r
=head1 Zip times don't include time zone information\r
\r
\r
B<Q:> My file times don't respect time zones. What gives?\r
\r
\r
B<A:> If this is important to you, please submit patches to read the various\r
Extra Fields that encode times with time zones. I'm just using the DOS\r
Date/Time, which doesn't have a time zone.\r
\r
=head1 How do I make a self-extracting Zip\r
\r
\r
B<Q:> I want to make a self-extracting Zip file. Can I do this?\r
\r
\r
B<A:> Yes. You can write a self-extracting archive stub (that is, a version of\r
unzip) to the output filehandle that you pass to writeToFileHandle(). See\r
examples/selfex.pl for how to write a self-extracting archive.\r
\r
\r
However, you should understand that this will only work on one kind of\r
platform (the one for which the stub was compiled).\r
\r
=head1 How can I deal with Zips with prepended garbage (i.e. from Sircam)\r
\r
\r
B<Q:> How can I tell if a Zip has been damaged by adding garbage to the\r
beginning or inside the file?\r
\r
\r
B<A:> I added code for this for the Amavis virus scanner. You can query archives\r
for their 'eocdOffset' property, which should be 0:\r
\r
\r
  if ($zip->eocdOffset > 0)\r
    { warn($zip->eocdOffset . " bytes of garbage at beginning or within Zip") }\r
\r
\r
When members are extracted, this offset will be used to adjust the start of\r
the member if necessary.\r
\r
=head1 Can't extract Shrunk files\r
\r
\r
B<Q:> I'm trying to extract a file out of a Zip produced by PKZIP, and keep\r
getting this error message:\r
\r
\r
  error: Unsupported compression combination: read 6, write 0\r
\r
\r
B<A:> You can't uncompress this archive member. Archive::Zip only supports uncompressed\r
members, and compressed members that are compressed using the compression\r
supported by Compress::Zlib. That means only Deflated and Stored members.\r
\r
\r
Your file is compressed using the Shrink format, which isn't supported by\r
Compress::Zlib.\r
\r
\r
You could, perhaps, use a command-line UnZip program (like the Info-Zip\r
one) to extract this.\r
\r
=head1 Can't do decryption\r
\r
\r
B<Q:> How do I decrypt encrypted Zip members?\r
\r
\r
B<A:> With some other program or library. Archive::Zip doesn't support decryption,\r
and probably never will (unless I<you> write it).\r
\r
=head1 How to test file integrity?\r
\r
\r
B<Q:> How can Archive::Zip can test the validity of a Zip file?\r
\r
\r
B<A:> If you try to decompress the file, the gzip streams will report errors \r
if you have garbage. Most of the time.\r
\r
If you try to open the file and a central directory structure can't be \r
found, an error will be reported.\r
\r
When a file is being read, if we can't find a proper PK.. signature in \r
the right places we report a format error.\r
\r
If there is added garbage at the beginning of a Zip file (as inserted \r
by some viruses), you can find out about it, but Archive::Zip will ignore it, \r
and you can still use the archive. When it gets written back out the \r
added stuff will be gone.\r
\r
\r
There are two ready-to-use utilities in the examples directory that can\r
be used to test file integrity, or that you can use as examples\r
for your own code:\r
\r
=over 4\r
\r
=item examples/zipcheck.pl shows how to use an attempted extraction to test a file.\r
\r
\r
\r
=item examples/ziptest.pl shows how to test CRCs in a file.\r
\r
\r
\r
=back\r
\r
=head1 Duplicate files in Zip?\r
\r
\r
B<Q:> Archive::Zip let me put the same file in my Zip twice! Why don't you prevent this?\r
\r
\r
B<A:> As far as I can tell, this is not disallowed by the Zip spec. If you\r
think it's a bad idea, check for it yourself:\r
\r
\r
  $zip->addFile($someFile, $someName) unless $zip->memberNamed($someName);\r
\r
\r
I can even imagine cases where this might be useful (for instance, multiple\r
versions of files).\r
\r
=head1 File ownership/permissions/ACLS/etc\r
\r
\r
B<Q:> Why doesn't Archive::Zip deal with file ownership, ACLs, etc.?\r
\r
\r
B<A:> There is no standard way to represent these in the Zip file format. If\r
you want to send me code to properly handle the various extra fields that\r
have been used to represent these through the years, I'll look at it.\r
\r
=head1 I can't compile but ActiveState only has an old version of Archive::Zip\r
\r
\r
B<Q:> I've only installed modules using ActiveState's PPM program and\r
repository. But they have a much older version of Archive::Zip than is in CPAN. Will\r
you send me a newer PPM?\r
\r
\r
B<A:> Probably not, unless I get lots of extra time. But there's no reason you\r
can't install the version from CPAN. Archive::Zip is pure Perl, so all you need is\r
NMAKE, which you can get for free from Microsoft (see the FAQ in the\r
ActiveState documentation for details on how to install CPAN modules).\r
\r
=head1 My JPEGs (or MP3's) don't compress when I put them into Zips!\r
\r
\r
B<Q:> How come my JPEGs and MP3's don't compress much when I put them into Zips?\r
\r
\r
B<A:> Because they're already compressed.\r
\r
=head1 Under Windows, things lock up/get damaged\r
\r
\r
B<Q:> I'm using Windows. When I try to use Archive::Zip, my machine locks up/makes\r
funny sounds/displays a BSOD/corrupts data. How can I fix this?\r
\r
\r
B<A:> First, try the newest version of Compress::Zlib. I know of\r
Windows-related problems prior to v1.14 of that library.\r
\r
\r
If that doesn't get rid of the problem, fix your computer or get rid of\r
Windows.\r
\r
=head1 Zip contents in a scalar\r
\r
\r
B<Q:> I want to read a Zip file from (or write one to) a scalar variable instead\r
of a file. How can I do this?\r
\r
\r
B<A:> Use C<IO::Scalar> and the C<readFromFileHandle()> and\r
C<writeToFileHandle()> methods.\r
See C<examples/readScalar.pl> and C<examples/writeScalar.pl>.\r
\r
=head1 Reading from streams\r
\r
\r
B<Q:> How do I read from a stream (like for the Info-Zip C<funzip> program)?\r
\r
\r
B<A:>   This isn't currently supported, though writing to a stream is.\r