Archive::Libarchive::Peek - Peek into archives without extracting them
version 0.04
use Archive::Libarchive::Peek; my $peek = Archive::Libarchive::Peek->new( filename => 'archive.tar' ); my @files = $peek->files(); my $contents = $peek->file('README.txt')
This module lets you peek into archives without extracting them. It is based on Archive::Peek, but it uses Archive::Libarchive, and thus all of the many formats supported by libarchive. It also supports some unique features of the various classes that use the "Peek" style interface:
libarchive
compressed tar, Zip, RAR, ISO 9660 images, etc.
You can specify the passphrase or a passphrase callback with the constructor
If filename is an array reference it will be assumed to be a list of filenames representing a single multi-file archive.
my $peek = Archive::Libarchive::Peek->new(%options);
This creates a new instance of the Peek object. One of the "filename" or "memory" option
my $peek = Archive::Libarchive::Peek->new( filename => $filename );
The filename of the archive to read from.
[version 0.03]
my $peek = Archive::Libarchive::Peek->new( memory => \$content );
A reference to the memory region containing the archive. Passing in a plain scalar will throw an exception.
my $peek = Archive::Libarchive::Peek->new( passphrase => $passphrase ); my $peek = Archive::Libarchive::Peek->new( passphrase => sub { ... return $passphrase; });
This option is the passphrase for encrypted zip entries, or a callback which will return the passphrase.
This is the archive filename for the Peek object. This will be undef for in-memory archives.
undef
my @files = $peek->files;
This method returns the filenames of the entries in the archive.
my $content = $peek->file($filename);
This method files the filename in the archive and returns its content.
$peek->iterate(sub ($filename, $content, $e) { ... });
This method iterates over the entries in the archive and calls the callback for each entry. The arguments are:
The filename of the entry
The content of the entry, or '' for non-regular or zero-sized files
''
This is a Archive::Libarchive::Entry instance which has metadata about the file, like the permissions, timestamps and file type.
[version 0.02]
my $hashref = $peek->as_hash;
Returns a hash reference where the keys are entry pathnames and the values are the entry content. This method will attempt to resolve symbolic links as scalar references. Hardlinks will be reference aliased. Directory and other special types will be handled as array reference, the exact format to be determined in the future, although the first element in the array reference will be the file type.
The original!
Another implementation that uses external commands to peek into archives
Another implementation that also relies on libarchive, but doesn't support the file type in iterate mode, encrypted zip entries, or multi-file RAR archives.
A lower-level interface to libarchive which can be used to read/extract and create archives of various formats.
Graham Ollis <plicease@cpan.org>
This software is copyright (c) 2021 by Graham Ollis.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Archive::Libarchive::Peek, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Archive::Libarchive::Peek
CPAN shell
perl -MCPAN -e shell install Archive::Libarchive::Peek
For more information on module installation, please visit the detailed CPAN module installation guide.