archive::zip.3

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

\&    my $status = $zip\->writeToFileNamed( \*(Aqxx.zip\*(Aq );
\&    die "error somewhere" if $status != AZ_OK;
.Ve
.Sp
Note that if you use the same name as an existing zip file
that you read in, you will clobber ZipFileMembers. So
instead, write to a different file name, then delete the
original.
If you use the \f(CW\*(C`overwrite()\*(C'\fR or \f(CW\*(C`overwriteAs()\*(C'\fR methods, you can
re-write the original zip in this way.
\&\f(CW$fileName\fR should be a valid file name on your system.
.ie n .IP "writeToFileHandle( $fileHandle\fR [, \f(CW$seekable] )" 4
.el .IP "writeToFileHandle( \f(CW$fileHandle\fR [, \f(CW$seekable\fR] )" 4
.IX Item "writeToFileHandle( $fileHandle [, $seekable] )"
Write a zip archive to a file handle. Return \s-1AZ_OK\s0 on
success. The optional second arg tells whether or not to try
to seek backwards to re-write headers. If not provided, it is
set if the Perl \f(CW\*(C`\-f\*(C'\fR test returns true. This could fail on
some operating systems, though.
.Sp
.Vb 4
\&    my $fh = IO::File\->new( \*(AqsomeFile.zip\*(Aq, \*(Aqw\*(Aq );
\&    unless ( $zip\->writeToFileHandle( $fh ) != AZ_OK ) {
\&        # error handling
\&    }
.Ve
.Sp
If you pass a file handle that is not seekable (like if
you're writing to a pipe or a socket), pass a false second
argument:
.Sp
.Vb 2
\&    my $fh = IO::File\->new( \*(Aq| cat > somefile.zip\*(Aq, \*(Aqw\*(Aq );
\&    $zip\->writeToFileHandle( $fh, 0 );   # fh is not seekable
.Ve
.Sp
If this method fails during the write of a member, that
member and all following it will return false from
\&\f(CW\*(C`wasWritten()\*(C'\fR. See \fIwriteCentralDirectory()\fR for a way to
deal with this.
If you want, you can write data to the file handle before
passing it to \fIwriteToFileHandle()\fR; this could be used (for
instance) for making self-extracting archives. However, this
only works reliably when writing to a real file (as opposed
to \s-1STDOUT\s0 or some other possible non-file).
.Sp
See examples/selfex.pl for how to write a self-extracting
archive.
.ie n .IP "writeCentralDirectory( $fileHandle\fR [, \f(CW$offset ] )" 4
.el .IP "writeCentralDirectory( \f(CW$fileHandle\fR [, \f(CW$offset\fR ] )" 4
.IX Item "writeCentralDirectory( $fileHandle [, $offset ] )"
Writes the central directory structure to the given file
handle.
.Sp
Returns \s-1AZ_OK\s0 on success. If given an \f(CW$offset\fR, will
seek to that point before writing. This can be used for
recovery in cases where writeToFileHandle or writeToFileNamed
returns an \s-1IO\s0 error because of running out of space on the
destination file.
.Sp
You can truncate the zip by seeking backwards and then writing the
directory:
.Sp
.Vb 10
\&    my $fh = IO::File\->new( \*(AqsomeFile.zip\*(Aq, \*(Aqw\*(Aq );
\&        my $retval = $zip\->writeToFileHandle( $fh );
\&    if ( $retval == AZ_IO_ERROR ) {
\&        my @unwritten = grep { not $_\->wasWritten() } $zip\->members();
\&        if (@unwritten) {
\&            $zip\->removeMember( $member ) foreach my $member ( @unwritten );
\&            $zip\->writeCentralDirectory( $fh,
\&            $unwritten[0]\->writeLocalHeaderRelativeOffset());
\&        }
\&    }
.Ve
.ie n .IP "overwriteAs( $newName )" 4
.el .IP "overwriteAs( \f(CW$newName\fR )" 4
.IX Item "overwriteAs( $newName )"
Write the zip to the specified file, as safely as possible.
This is done by first writing to a temp file, then renaming
the original if it exists, then renaming the temp file, then
deleting the renamed original if it exists. Returns \s-1AZ_OK\s0 if
successful.
.IP "\fIoverwrite()\fR" 4
.IX Item "overwrite()"
Write back to the original zip file. See \fIoverwriteAs()\fR above.
If the zip was not ever read from a file, this generates an
error.
.ie n .IP "read( $fileName )" 4
.el .IP "read( \f(CW$fileName\fR )" 4
.IX Item "read( $fileName )"
Read zipfile headers from a zip file, appending new members.
Returns \f(CW\*(C`AZ_OK\*(C'\fR or error code.
.Sp
.Vb 2
\&    my $zipFile = Archive::Zip\->new();
\&    my $status = $zipFile\->read( \*(Aq/some/FileName.zip\*(Aq );
.Ve
.ie n .IP "readFromFileHandle( $fileHandle\fR, \f(CW$filename )" 4
.el .IP "readFromFileHandle( \f(CW$fileHandle\fR, \f(CW$filename\fR )" 4
.IX Item "readFromFileHandle( $fileHandle, $filename )"
Read zipfile headers from an already-opened file handle,
appending new members. Does not close the file handle.
Returns \f(CW\*(C`AZ_OK\*(C'\fR or error code. Note that this requires a
seekable file handle; reading from a stream is not yet
supported.
.Sp
.Vb 5
\&    my $fh = IO::File\->new( \*(Aq/some/FileName.zip\*(Aq, \*(Aqr\*(Aq );
\&    my $zip1 = Archive::Zip\->new();
\&    my $status = $zip1\->readFromFileHandle( $fh );
\&    my $zip2 = Archive::Zip\->new();
\&    $status = $zip2\->readFromFileHandle( $fh );
.Ve
.Sh "Zip Archive Tree operations"
.IX Subsection "Zip Archive Tree operations"
These used to be in Archive::Zip::Tree but got moved into
Archive::Zip. They enable operation on an entire tree of members or
files.
A usage example:
.PP
.Vb 2
\&  use Archive::Zip;
\&  my $zip = Archive::Zip\->new();
\&  
\&  # add all readable files and directories below . as xyz/*
\&  $zip\->addTree( \*(Aq.\*(Aq, \*(Aqxyz\*(Aq );
\&  
\&  # add all readable plain files below /abc as def/*
\&  $zip\->addTree( \*(Aq/abc\*(Aq, \*(Aqdef\*(Aq, sub { \-f && \-r } );
\&  
\&  # add all .c files below /tmp as stuff/*
\&  $zip\->addTreeMatching( \*(Aq/tmp\*(Aq, \*(Aqstuff\*(Aq, \*(Aq\e.c$\*(Aq );
\&  
\&  # add all .o files below /tmp as stuff/* if they aren\*(Aqt writable
\&  $zip\->addTreeMatching( \*(Aq/tmp\*(Aq, \*(Aqstuff\*(Aq, \*(Aq\e.o$\*(Aq, sub { ! \-w } );
\&  
\&  # add all .so files below /tmp that are smaller than 200 bytes as stuff/*
\&  $zip\->addTreeMatching( \*(Aq/tmp\*(Aq, \*(Aqstuff\*(Aq, \*(Aq\e.o$\*(Aq, sub { \-s < 200 } );
\&  
\&  # and write them into a file
\&  $zip\->writeToFileNamed(\*(Aqxxx.zip\*(Aq);
\&  
\&  # now extract the same files into /tmpx
\&  $zip\->extractTree( \*(Aqstuff\*(Aq, \*(Aq/tmpx\*(Aq );
.Ve
.ie n .IP "$zip\fR\->addTree( \f(CW$root\fR, \f(CW$dest [,$pred] ) \*(-- Add tree of files to a zip" 4
.el .IP "\f(CW$zip\fR\->addTree( \f(CW$root\fR, \f(CW$dest\fR [,$pred] ) \*(-- Add tree of files to a zip" 4
.IX Item "$zip->addTree( $root, $dest [,$pred] )  Add tree of files to a zip"
\&\f(CW$root\fR is the root of the tree of files and directories to be
added. It is a valid directory name on your system. \f(CW$dest\fR is
the name for the root in the zip file (undef or blank means
to use relative pathnames). It is a valid \s-1ZIP\s0 directory name
(that is, it uses forward slashes (/) for separating
directory components). \f(CW$pred\fR is an optional subroutine
reference to select files: it is passed the name of the
prospective file or directory using \f(CW$_\fR, and if it returns
true, the file or directory will be included. The default is
to add all readable files and directories. For instance,
using
.Sp
.Vb 2
\&  my $pred = sub { /\e.txt/ };
\&  $zip\->addTree( \*(Aq.\*(Aq, \*(Aq\*(Aq, $pred );
.Ve
.Sp
will add all the .txt files in and below the current
directory, using relative names, and making the names
identical in the zipfile:
.Sp
.Vb 4
\&  original name           zip member name
\&  ./xyz                   xyz
\&  ./a/                    a/
\&  ./a/b                   a/b
.Ve
.Sp
To translate absolute to relative pathnames, just pass them
in: \f(CW$zip\fR\->addTree( '/c/d', 'a' );
.Sp
.Vb 4
\&  original name           zip member name
\&  /c/d/xyz                a/xyz
\&  /c/d/a/                 a/a/
\&  /c/d/a/b                a/a/b
.Ve
.Sp
Returns \s-1AZ_OK\s0 on success. Note that this will not follow
symbolic links to directories. Note also that this does not
check for the validity of filenames.
.Sp
Note that you generally \fIdon't\fR want to make zip archive member names
absolute.
.ie n .IP "$zip\fR\->addTreeMatching( \f(CW$root\fR, \f(CW$dest\fR, \f(CW$pattern [,$pred] )" 4
.el .IP "\f(CW$zip\fR\->addTreeMatching( \f(CW$root\fR, \f(CW$dest\fR, \f(CW$pattern\fR [,$pred] )" 4
.IX Item "$zip->addTreeMatching( $root, $dest, $pattern [,$pred] )"
\&\f(CW$root\fR is the root of the tree of files and directories to be
added \f(CW$dest\fR is the name for the root in the zip file (undef
means to use relative pathnames) \f(CW$pattern\fR is a (non-anchored)
regular expression for filenames to match \f(CW$pred\fR is an
optional subroutine reference to select files: it is passed
the name of the prospective file or directory in \f(CW$_\fR, and
if it returns true, the file or directory will be included.
The default is to add all readable files and directories. To
add all files in and below the current dirctory whose names
end in \f(CW\*(C`.pl\*(C'\fR, and make them extract into a subdirectory
named \f(CW\*(C`xyz\*(C'\fR, do this:
.Sp
.Vb 1
\&  $zip\->addTreeMatching( \*(Aq.\*(Aq, \*(Aqxyz\*(Aq, \*(Aq\e.pl$\*(Aq )
.Ve
.Sp
To add all \fIwritable\fR files in and below the dirctory named
\&\f(CW\*(C`/abc\*(C'\fR whose names end in \f(CW\*(C`.pl\*(C'\fR, and make them extract into
a subdirectory named \f(CW\*(C`xyz\*(C'\fR, do this:
.Sp
.Vb 1
\&  $zip\->addTreeMatching( \*(Aq/abc\*(Aq, \*(Aqxyz\*(Aq, \*(Aq\e.pl$\*(Aq, sub { \-w } )
.Ve
.Sp
Returns \s-1AZ_OK\s0 on success. Note that this will not follow
symbolic links to directories.
.ie n .IP "$zip\fR\->updateTree( \f(CW$root\fR, [ \f(CW$dest\fR, [ \f(CW$pred\fR [, \f(CW$mirror]]] );" 4
.el .IP "\f(CW$zip\fR\->updateTree( \f(CW$root\fR, [ \f(CW$dest\fR, [ \f(CW$pred\fR [, \f(CW$mirror\fR]]] );" 4
.IX Item "$zip->updateTree( $root, [ $dest, [ $pred [, $mirror]]] );"
Update a zip file from a directory tree.
.Sp
\&\f(CW\*(C`updateTree()\*(C'\fR takes the same arguments as \f(CW\*(C`addTree()\*(C'\fR, but first
checks to see whether the file or directory already exists in the zip
file, and whether it has been changed.
.Sp
If the fourth argument \f(CW$mirror\fR is true, then delete all my members
if corresponding files weren't found.
.Sp
Returns an error code or \s-1AZ_OK\s0 if all is well.
.ie n .IP "$zip\fR\->\fIextractTree()" 4
.el .IP "\f(CW$zip\fR\->\fIextractTree()\fR" 4
.IX Item "$zip->extractTree()"
.PD 0
.ie n .IP "$zip\fR\->extractTree( \f(CW$root )" 4
.el .IP "\f(CW$zip\fR\->extractTree( \f(CW$root\fR )" 4
.IX Item "$zip->extractTree( $root )"
.ie n .IP "$zip\fR\->extractTree( \f(CW$root\fR, \f(CW$dest )" 4
.el .IP "\f(CW$zip\fR\->extractTree( \f(CW$root\fR, \f(CW$dest\fR )" 4
.IX Item "$zip->extractTree( $root, $dest )"
.ie n .IP "$zip\fR\->extractTree( \f(CW$root\fR, \f(CW$dest\fR, \f(CW$volume )" 4
.el .IP "\f(CW$zip\fR\->extractTree( \f(CW$root\fR, \f(CW$dest\fR, \f(CW$volume\fR )" 4
.IX Item "$zip->extractTree( $root, $dest, $volume )"
.PD
If you don't give any arguments at all, will extract all the
files in the zip with their original names.
.Sp
If you supply one argument for \f(CW$root\fR, \f(CW\*(C`extractTree\*(C'\fR will extract
all the members whose names start with \f(CW$root\fR into the current
directory, stripping off \f(CW$root\fR first.
\&\f(CW$root\fR is in Zip (Unix) format.
For instance,
.Sp
.Vb 1
\&  $zip\->extractTree( \*(Aqa\*(Aq );
.Ve
.Sp
when applied to a zip containing the files:
a/x a/b/c ax/d/e d/e will extract:
.Sp
a/x as ./x
.Sp
a/b/c as ./b/c
.Sp
If you give two arguments, \f(CW\*(C`extractTree\*(C'\fR extracts all the members
whose names start with \f(CW$root\fR. It will translate \f(CW$root\fR into
\&\f(CW$dest\fR to construct the destination file name.
\&\f(CW$root\fR and \f(CW$dest\fR are in Zip (Unix) format.
For instance,
.Sp
.Vb 1
\&   $zip\->extractTree( \*(Aqa\*(Aq, \*(Aqd/e\*(Aq );
.Ve
.Sp
when applied to a zip containing the files:
a/x a/b/c ax/d/e d/e will extract:
.Sp
a/x to d/e/x
.Sp
a/b/c to d/e/b/c and ignore ax/d/e and d/e
.Sp
If you give three arguments, \f(CW\*(C`extractTree\*(C'\fR extracts all the members
whose names start with \f(CW$root\fR. It will translate \f(CW$root\fR into
\&\f(CW$dest\fR to construct the destination file name, and then it will
convert to local file system format, using \f(CW$volume\fR as the name of
the destination volume.
.Sp
\&\f(CW$root\fR and \f(CW$dest\fR are in Zip (Unix) format.
.Sp
\&\f(CW$volume\fR is in local file system format.
.Sp
For instance, under Windows,
.Sp
.Vb 1
\&   $zip\->extractTree( \*(Aqa\*(Aq, \*(Aqd/e\*(Aq, \*(Aqf:\*(Aq );
.Ve
.Sp
when applied to a zip containing the files:
a/x a/b/c ax/d/e d/e will extract:
.Sp
a/x to f:d/e/x
.Sp
a/b/c to f:d/e/b/c and ignore ax/d/e and d/e
.Sp
If you want absolute paths (the prior example used paths relative to
the current directory on the destination volume, you can specify these
in \f(CW$dest\fR:
.Sp
.Vb 1
\&   $zip\->extractTree( \*(Aqa\*(Aq, \*(Aq/d/e\*(Aq, \*(Aqf:\*(Aq );
.Ve
.Sp
when applied to a zip containing the files:
a/x a/b/c ax/d/e d/e will extract:
.Sp
a/x to f:\ed\ee\ex
.Sp
a/b/c to f:\ed\ee\eb\ec and ignore ax/d/e and d/e
.Sp
Returns an error code or \s-1AZ_OK\s0 if everything worked \s-1OK\s0.
.SH "MEMBER OPERATIONS"
.IX Header "MEMBER OPERATIONS"
.Sh "Member Class Methods"
.IX Subsection "Member Class Methods"
Several constructors allow you to construct members without adding
them to a zip archive. These work the same as the \fIaddFile()\fR,
\&\fIaddDirectory()\fR, and \fIaddString()\fR zip instance methods described above,
but they don't add the new members to a zip.
.ie n .IP "Archive::Zip::Member\->newFromString( $stringOrStringRef\fR [, \f(CW$fileName] )" 4
.el .IP "Archive::Zip::Member\->newFromString( \f(CW$stringOrStringRef\fR [, \f(CW$fileName\fR] )" 4
.IX Item "Archive::Zip::Member->newFromString( $stringOrStringRef [, $fileName] )"
Construct a new member from the given string. Returns undef
on error.
.Sp
.Vb 2
\&    my $member = Archive::Zip::Member\->newFromString( \*(AqThis is a test\*(Aq,
\&                                                 \*(Aqxyz.txt\*(Aq );
.Ve
.ie n .IP "newFromFile( $fileName )" 4
.el .IP "newFromFile( \f(CW$fileName\fR )" 4
.IX Item "newFromFile( $fileName )"
Construct a new member from the given file. Returns undef on
error.
.Sp
.Vb 1
\&    my $member = Archive::Zip::Member\->newFromFile( \*(Aqxyz.txt\*(Aq );
.Ve
.ie n .IP "newDirectoryNamed( $directoryName\fR [, \f(CW$zipname ] )" 4
.el .IP "newDirectoryNamed( \f(CW$directoryName\fR [, \f(CW$zipname\fR ] )" 4
.IX Item "newDirectoryNamed( $directoryName [, $zipname ] )"
Construct a new member from the given directory.
\&\f(CW$directoryName\fR must be a valid name on your file system; it doesn't
have to exist.
.Sp
If given, \f(CW$zipname\fR will be the name of the zip member; it must be a
valid Zip (Unix) name. If not given, it will be converted from
\&\f(CW$directoryName\fR.
.Sp
Returns undef on error.
.Sp
.Vb 1
\&    my $member = Archive::Zip::Member\->newDirectoryNamed( \*(AqCVS/\*(Aq );
.Ve
.Sh "Member Simple accessors"
.IX Subsection "Member Simple accessors"
These methods get (and/or set) member attribute values.
.IP "\fIversionMadeBy()\fR" 4
.IX Item "versionMadeBy()"
Gets the field from the member header.
.IP "fileAttributeFormat( [$format] )" 4
.IX Item "fileAttributeFormat( [$format] )"
Gets or sets the field from the member header. These are