NAME
Archive::Probe - A generic library to search file within archive
SYNOPSIS
use Archive::Probe;
my $tmpdir = '<temp_dir>';
my $base_dir = '<directory_of_archive_files>';
my $probe = Archive::Probe->new();
$probe->working_dir($tmpdir);
$probe->add_pattern(
'<your_pattern_here>',
sub {
my ($pattern, $file_ref) = @_;
# do something with result files
});
$probe->search($base_dir, 1);DESCRIPTION
Archive::Probe is a generic library to search file within archive.
It allows you to test the existence of a particular file, which can be described in regular expression, and optionally to extract that file and inspect the file content in custom code. It supports common archive types such as .tar, .tgz, .bz2, .rar, .zip, .7z. One archive file can contain archive file of same or other type. And level of nesting is unlimited. This module depends on unrar, 7za and tar which should be in PATH. The 7za is part of open source software 7zip. You can get it from: www.7-zip.org. The unrar is freeware which can be downloaded from: http://www.rarlab.com/rar_add.htm.
METHODS
$probe = Archive::Probe->new()
Creates a new Archive::Probe object.
$probe->add_pattern(regex, coderef)
Register a file pattern to search with in the archive file(s) and the callback code to handle the matched files. The callback will be passed two arguments:
- $pattern
-
This is the pattern of the matched files.
- $file_ref
-
This is the array reference to the files matched the pattern. The existence of the files is controlled by the second argument to the
search()method.
$probe->search(base_dir, extract_matched)
Search registered files under 'base_dir' and invoke the callback. It requires two arguments:
- $base_dir
-
This is the directory containing the archive file(s).
- $extract_matched
-
Extract or copy the matched files to the working directory if this parameter evaluate to true.
$probe->reset_matches()
Reset the matched files list.
ACCESSORS
$probe->working_dir([directory])
Set or get the working directory where the temporary files will be created.
$show_extracting_output->working_dir([BOOL])
Enable or disable the output of command line archive tool.
HOW IT WORKS
Archive::Probe provides plumbing boiler code to search files in nested archive files. It does the heavy lifting to extract mininal files necessary to fulfill the inquiry.
BUG REPORTS
Please report bugs or other issues to <schnell18@rt.cpan.org>.
AUTHOR
This module is developed by Justin Zhang <fgz@cpan.org>.
COPYRIGHT
Copyright (C) 2013 by Justin Zhang
This library is free software; you may redistribute and/or modify it under the same terms as Perl itself.