[ новости /+++ | форум | теги | ]

NAME

Archive::Tar - module for manipulations of tar archives
 

SYNOPSIS

    use Archive::Tar;
    my $tar = Archive::Tar->new;

    $tar->read('origin.tgz',1);
    $tar->extract();

    $tar->add_files('file/foo.pl', 'docs/README');
    $tar->add_data('file/baz.txt', 'This is the contents now');

    $tar->rename('oldname', 'new/file/name');

    $tar->write('files.tar');

DESCRIPTION

An object of class Archive::Tar represents a .tar(.gz) archive full of files and things.  

Object Methods

Archive::Tar->new( [$file, $compressed] )

If "new()" is invoked with arguments and the "read()" method fails for any reason, "new()" returns undef.  

$tar->read ( $filename|$handle, $compressed, {opt => 'val'} )

The "read" will replace any previous content in $tar!

The second argument may be considered optional if IO::Zlib is installed, since it will transparently Do The Right Thing. Archive::Tar will warn if you try to pass a compressed file if IO::Zlib is not available and simply return.

Note that you can currently not pass a "gzip" compressed filehandle, which is not opened with "IO::Zlib", nor a string containing the full archive information (either compressed or uncompressed). These are worth while features, but not currently implemented. See the "TODO" section.

The third argument can be a hash reference with options. Note that all options are case-sensitive.

limit

Do not read more than "limit" files. This is useful if you have very big archives, and are only interested in the first few files.

extract

If set to true, immediately extract entries when reading them. This gives you the same memory break as the "extract_archive" function. Note however that entries will not be read into memory, but written straight to disk.

All files are stored internally as "Archive::Tar::File" objects. Please consult the Archive::Tar::File documentation for details.

Returns the number of files read in scalar context, and a list of "Archive::Tar::File" objects in list context.  

$tar->contains_file( $filename )

Note however, that this function does an exact match using "eq" on the full path. So it cannot compensate for case-insensitive file- systems or compare 2 paths to see if they would point to the same underlying file.  

$tar->extract( [@filenames] )

If "extract" is called without a list of file names, the entire contents of the archive are extracted.

Returns a list of filenames extracted.  

$tar->extract_file( $file, [$extract_path] )

For example:

    $tar->extract_file( 'name/in/archive', 'name/i/want/to/give/it' );

    $tar->extract_file( $at_file_object,   'name/i/want/to/give/it' );

Returns true on success, false on failure.  

$tar->list_files( [\@properties] )

If "list_files()" is passed an array reference as its first argument it returns a list of hash references containing the requested properties of each file. The following list of properties is supported: name, size, mtime (last modified date), mode, uid, gid, linkname, uname, gname, devmajor, devminor, prefix.

Passing an array reference containing only one element, 'name', is special cased to return a list of names rather than a list of hash references, making it equivalent to calling "list_files" without arguments.  

$tar->get_files( [@filenames] )

Please refer to the "Archive::Tar::File" documentation on how to handle these objects.  

$tar->get_content( $file )

$tar->replace_content( $file, $content )

$tar->rename( $file, $new_name )

Note that you must specify a Unix path for $new_name, since per tar standard, all files in the archive must be Unix paths.

Returns true on success and false on failure.  

$tar->remove (@filenamelist)

$tar->clear

$tar->write ( [$file, $compressed, $prefix] )

Note that when you pass in a filehandle, the compression argument is ignored, as all files are printed verbatim to your filehandle. If you wish to enable compression with filehandles, use an "IO::Zlib" filehandle instead.

Specific levels of compression can be chosen by passing the values 2 through 9 as the second parameter.

The third argument is an optional prefix. All files will be tucked away in the directory you specify as prefix. So if you have files 'a' and 'b' in your archive, and you specify 'foo' as prefix, they will be written to the archive as 'foo/a' and 'foo/b'.

If no arguments are given, "write" returns the entire formatted archive as a string, which could be useful if you'd like to stuff the archive into a socket or a pipe to gzip or something.  

$tar->add_files( @filenamelist )

The path to the file is automatically converted to a Unix like equivalent for use in the archive, and, if on MacOS, the file's modification time is converted from the MacOS epoch to the Unix epoch. So tar archives created on MacOS with Archive::Tar can be read both with tar on Unix and applications like suntar or Stuffit Expander on MacOS.

Be aware that the file's type/creator and resource fork will be lost, which is usually what you want in cross-platform archives.

Returns a list of "Archive::Tar::File" objects that were just added.  

$tar->add_data ( $filename, $data, [$opthashref] )

Will add a file to the in-memory archive, with name $filename and content $data. Specific properties can be set using $opthashref. The following list of properties is supported: name, size, mtime (last modified date), mode, uid, gid, linkname, uname, gname, devmajor, devminor, prefix, type. (On MacOS, the file's path and modification times are converted to Unix equivalents.)

Valid values for the file type are the following constants defined in Archive::Tar::Constants:

FILE

Regular file.

HARDLINK

SYMLINK

Hard and symbolic (``soft'') links; linkname should specify target.

CHARDEV

BLOCKDEV

Character and block devices. devmajor and devminor should specify the major and minor device numbers.

DIR

Directory.

FIFO

FIFO (named pipe).

SOCKET

Socket.

Returns the "Archive::Tar::File" object that was just added, or "undef" on failure.  

$tar->error( [$BOOL] )

For backwards compatibility, this error is also available as $Archive::Tar::error although it is much recommended you use the method call instead.  

$tar->setcwd( $cwd );

Since "Archive::Tar" doesn't change the current directory internally while it is extracting the items in a tarball, all calls to "Cwd::cwd()" can be avoided if we can guarantee that the current directory doesn't get changed externally.

To use this performance boost, set the current directory via

    use Cwd;
    $tar->setcwd( cwd() );

once before calling a function like "extract_file" and "Archive::Tar" will use the current directory setting from then on and won't call "Cwd::cwd()" internally.

To switch back to the default behaviour, use

    $tar->setcwd( undef );

and "Archive::Tar" will call "Cwd::cwd()" internally again.

If you're using "Archive::Tar"'s "exract()" method, "setcwd()" will be called for you.  

$bool = $tar->has_io_string

Either "IO::String" or "perlio" support is needed to support writing stringified archives. Currently, "perlio" is the preferred method, if available.

See the "GLOBAL VARIABLES" section to see how to change this preference.  

$bool = $tar->has_perlio

This requires "perl-5.8" or higher, compiled with "perlio"

Either "IO::String" or "perlio" support is needed to support writing stringified archives. Currently, "perlio" is the preferred method, if available.

See the "GLOBAL VARIABLES" section to see how to change this preference.  

Class Methods

Archive::Tar->create_archive($file, $compression, @filelist)

Note that when you pass in a filehandle, the compression argument is ignored, as all files are printed verbatim to your filehandle. If you wish to enable compression with filehandles, use an "IO::Zlib" filehandle instead.

The remaining arguments list the files to be included in the tar file. These files must all exist. Any files which don't exist or can't be read are silently ignored.

If the archive creation fails for any reason, "create_archive" will return false. Please use the "error" method to find the cause of the failure.

Note that this method does not write "on the fly" as it were; it still reads all the files into memory before writing out the archive. Consult the FAQ below if this is a problem.  

Archive::Tar->list_archive ($file, $compressed, [\@properties])

If "list_archive()" is passed an array reference as its third argument it returns a list of hash references containing the requested properties of each file. The following list of properties is supported: full_path, name, size, mtime (last modified date), mode, uid, gid, linkname, uname, gname, devmajor, devminor, prefix.

See "Archive::Tar::File" for details about supported properties.

Passing an array reference containing only one element, 'name', is special cased to return a list of names rather than a list of hash references.  

Archive::Tar->extract_archive ($file, $gzip)

"extract_archive" will return a list of files it extracted. If the archive extraction fails for any reason, "extract_archive" will return false. Please use the "error" method to find the cause of the failure.  

Archive::Tar->can_handle_compressed_files

You can use this as a shortcut to determine whether "Archive::Tar" will do what you think before passing compressed archives to its "read" method.  

GLOBAL VARIABLES

$Archive::Tar::FOLLOW_SYMLINK

This option is checked when you write out the tarfile using "write" or "create_archive".

This works just like "/bin/tar"'s "-h" option.  

$Archive::Tar::CHOWN

The default is 1.  

$Archive::Tar::CHMOD

The default is 1.  

$Archive::Tar::DO_NOT_USE_PREFIX

Note that clients who do not support the "GNU Extended Header" feature will not be able to read these archives. Such clients include tars on "Solaris", "Irix" and "AIX".

The default is 0.  

$Archive::Tar::DEBUG

    $tar->error(1);

Defaults to 0.  

$Archive::Tar::WARN

Defaults to 1.  

$Archive::Tar::error

    warn $tar->error unless $tar->extract;

$Archive::Tar::INSECURE_EXTRACT_MODE

Allowing this could have security implications, as a malicious tar archive could alter or replace any file the extracting user has permissions to. Therefor, the default is to not allow insecure extractions.

If you trust the archive, or have other reasons to allow the archive to write files outside your current working directory, set this variable to "true".

Note that this is a backwards incompatible change from version 1.36 and before.  

$Archive::Tar::HAS_PERLIO

If you feel strongly about disabling it, set this variable to "false". Note that you will then need "IO::String" installed to support writing stringified archives.

Don't change this variable unless you really know what you're doing.  

$Archive::Tar::HAS_IO_STRING

If you feel strongly about disabling it, set this variable to "false". Note that you will then need "perlio" support from your perl to be able to write stringified archives.

Don't change this variable unless you really know what you're doing.  

FAQ

What's the minimum perl version required to run Archive::Tar?

You will need perl version 5.005_03 or newer.

Isn't Archive::Tar slow?

Yes it is. It's pure perl, so it's a lot slower then your "/bin/tar" However, it's very portable. If speed is an issue, consider using "/bin/tar" instead.

Isn't Archive::Tar heavier on memory than /bin/tar?

Yes it is, see previous answer. Since "Compress::Zlib" and therefore "IO::Zlib" doesn't support "seek" on their filehandles, there is little choice but to read the archive into memory. This is ok if you want to do in-memory manipulation of the archive. If you just want to extract, use the "extract_archive" class method instead. It will optimize and write to disk immediately.

Can't you lazy-load data instead?

No, not easily. See previous question.

How much memory will an X kb tar file need?

Probably more than X kb, since it will all be read into memory. If this is a problem, and you don't need to do in memory manipulation of the archive, consider using "/bin/tar" instead.

What do you do with unsupported filetypes in an archive?

"Unix" has a few filetypes that aren't supported on other platforms, like "Win32". If we encounter a "hardlink" or "symlink" we'll just try to make a copy of the original file, rather than throwing an error.

This does require you to read the entire archive in to memory first, since otherwise we wouldn't know what data to fill the copy with. (This means that you cannot use the class methods on archives that have incompatible filetypes and still expect things to work).

For other filetypes, like "chardevs" and "blockdevs" we'll warn that the extraction of this particular item didn't work.

I'm using WinZip, or some other non-POSIX client, and files are not being extracted properly!

By default, "Archive::Tar" is in a completely POSIX-compatible mode, which uses the POSIX-specification of "tar" to store files. For paths greather than 100 characters, this is done using the "POSIX header prefix". Non-POSIX-compatible clients may not support this part of the specification, and may only support the "GNU Extended Header" functionality. To facilitate those clients, you can set the $Archive::Tar::DO_NOT_USE_PREFIX variable to "true". See the "GLOBAL VARIABLES" section for details on this variable.

Note that GNU tar earlier than version 1.14 does not cope well with the "POSIX header prefix". If you use such a version, consider setting the $Archive::Tar::DO_NOT_USE_PREFIX variable to "true".

How do I extract only files that have property X from an archive?

Sometimes, you might not wish to extract a complete archive, just the files that are relevant to you, based on some criteria.

You can do this by filtering a list of "Archive::Tar::File" objects based on your criteria. For example, to extract only files that have the string "foo" in their title, you would use:

    $tar->extract( 
        grep { $_->full_path =~ /foo/ } $tar->get_files
    );

This way, you can filter on any attribute of the files in the archive. Consult the "Archive::Tar::File" documentation on how to use these objects.

How do I access .tar.Z files?

The "Archive::Tar" module can optionally use "Compress::Zlib" (via the "IO::Zlib" module) to access tar files that have been compressed with "gzip". Unfortunately tar files compressed with the Unix "compress" utility cannot be read by "Compress::Zlib" and so cannot be directly accesses by "Archive::Tar".

If the "uncompress" or "gunzip" programs are available, you can use one of these workarounds to read ".tar.Z" files from "Archive::Tar"

Firstly with "uncompress"

    use Archive::Tar;

    open F, "uncompress -c $filename |";
    my $tar = Archive::Tar->new(*F);
    ...

and this with "gunzip"

    use Archive::Tar;

    open F, "gunzip -c $filename |";
    my $tar = Archive::Tar->new(*F);
    ...

Similarly, if the "compress" program is available, you can use this to write a ".tar.Z" file

    use Archive::Tar;
    use IO::File;

    my $fh = new IO::File "| compress -c >$filename";
    my $tar = Archive::Tar->new();
    ...
    $tar->write($fh);
    $fh->close ;

How do I handle Unicode strings?

"Archive::Tar" uses byte semantics for any files it reads from or writes to disk. This is not a problem if you only deal with files and never look at their content or work solely with byte strings. But if you use Unicode strings with character semantics, some additional steps need to be taken.

For example, if you add a Unicode string like

    # Problem
    $tar->add_data('file.txt', "Euro: \x{20AC}");

then there will be a problem later when the tarfile gets written out to disk via "$tar-"write()>:

    Wide character in print at .../Archive/Tar.pm line 1014.

The data was added as a Unicode string and when writing it out to disk, the ":utf8" line discipline wasn't set by "Archive::Tar", so Perl tried to convert the string to ISO-8859 and failed. The written file now contains garbage.

For this reason, Unicode strings need to be converted to UTF-8-encoded bytestrings before they are handed off to "add_data()":

    use Encode;
    my $data = "Accented character: \x{20AC}";
    $data = encode('utf8', $data);

    $tar->add_data('file.txt', $data);

A opposite problem occurs if you extract a UTF8-encoded file from a tarball. Using "get_content()" on the "Archive::Tar::File" object will return its content as a bytestring, not as a Unicode string.

If you want it to be a Unicode string (because you want character semantics with operations like regular expression matching), you need to decode the UTF8-encoded content and have Perl convert it into a Unicode string:

    use Encode;
    my $data = $tar->get_content();

    # Make it a Unicode string
    $data = decode('utf8', $data);

There is no easy way to provide this functionality in "Archive::Tar", because a tarball can contain many files, and each of which could be encoded in a different way.

TODO

Check if passed in handles are open for read/write

Currently I don't know of any portable pure perl way to do this. Suggestions welcome.

Allow archives to be passed in as string

Currently, we only allow opened filehandles or filenames, but not strings. The internals would need some reworking to facilitate stringified archives.

Facilitate processing an opened filehandle of a compressed archive

Currently, we only support this if the filehandle is an IO::Zlib object. Environments, like apache, will present you with an opened filehandle to an uploaded file, which might be a compressed archive.

SEE ALSO

The GNU tar specification

"http://www.gnu.org/software/tar/manual/tar.html"

The PAX format specication

The specifcation which tar derives from; " http://www.opengroup.org/onlinepubs/007904975/utilities/pax.html"

A comparison of GNU and POSIX tar standards; http://www.delorie.com/gnu/docs/tar/tar_114.html

GNU tar intends to switch to POSIX compatibility

GNU Tar authors have expressed their intention to become completely POSIX-compatible; "http://www.gnu.org/software/tar/manual/html_node/Formats.html"

A Comparison between various tar implementations

Lists known issues and incompatibilities; "http://gd.tuwien.ac.at/utils/archivers/star/README.otherbugs"

AUTHOR

Please reports bugs to <bug-archive-tar@rt.cpan.org>.  

ACKNOWLEDGEMENTS

COPYRIGHT

This library is free software; you may redistribute and/or modify it under the same terms as Perl itself.

Index

NAME

SYNOPSIS

DESCRIPTION

Object Methods

Archive::Tar->new( [$file, $compressed] )

$tar->read ( $filename|$handle, $compressed, {opt => 'val'} )

$tar->contains_file( $filename )

$tar->extract( [@filenames] )

$tar->extract_file( $file, [$extract_path] )

$tar->list_files( [\@properties] )

$tar->get_files( [@filenames] )

$tar->get_content( $file )

$tar->replace_content( $file, $content )

$tar->rename( $file, $new_name )

$tar->remove (@filenamelist)

$tar->clear

$tar->write ( [$file, $compressed, $prefix] )

$tar->add_files( @filenamelist )

$tar->add_data ( $filename, $data, [$opthashref] )

$tar->error( [$BOOL] )

$tar->setcwd( $cwd );

$bool = $tar->has_io_string

$bool = $tar->has_perlio

Class Methods

Archive::Tar->create_archive($file, $compression, @filelist)

Archive::Tar->list_archive ($file, $compressed, [\@properties])

Archive::Tar->extract_archive ($file, $gzip)

Archive::Tar->can_handle_compressed_files

GLOBAL VARIABLES

$Archive::Tar::FOLLOW_SYMLINK

$Archive::Tar::CHOWN

$Archive::Tar::CHMOD

$Archive::Tar::DO_NOT_USE_PREFIX

$Archive::Tar::DEBUG

$Archive::Tar::WARN

$Archive::Tar::error

$Archive::Tar::INSECURE_EXTRACT_MODE

$Archive::Tar::HAS_PERLIO

$Archive::Tar::HAS_IO_STRING

FAQ

TODO

SEE ALSO

AUTHOR

ACKNOWLEDGEMENTS

COPYRIGHT

---

Поиск по тексту MAN-ов: 

Партнёры:

Хостинг:

Закладки на сайте Проследить за страницей

Created 1996-2024 by Maxim Chirkov Добавить, Поддержать, Вебмастеру