Source for file Tar.php
Documentation is available at Tar.php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
* Copyright (c) 1997-2008,
* Vincent Blavet <vincent@phpconcept.net>
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* @author Vincent Blavet <vincent@phpconcept.net>
* @copyright 1997-2010 The Authors
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @link http://pear.php.net/package/Archive_Tar
define('ARCHIVE_TAR_ATT_SEPARATOR', 90001 );
define('ARCHIVE_TAR_END_BLOCK', pack ("a512", ''));
* Creates a (compressed) Tar archive
* @author Vincent Blavet <vincent@phpconcept.net>
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @var string Name of the Tar
* @var boolean if true, the Tar file will be gzipped
* @var string Type of compression : 'none', 'gz' or 'bz2'
var $_compress_type= 'none';
* @var string Explode separator
* @var string Local Tar name of a remote Tar (http:// or ftp://)
* @var string regular expression for ignoring files or directories
* @var object PEAR_Error object
* Archive_Tar Class constructor. This flavour of the constructor only
* declare a new Archive_Tar object, identifying it by the name of the
* If the compress argument is set the tar will be read or created as a
* gzip or bz2 compressed TAR file.
* @param string $p_tarname The name of the tar archive to create
* @param string $p_compress can be null, 'gz' or 'bz2'. This
* parameter indicates if gzip or bz2 compression
* is required. For compatibility reason the
* boolean value 'true' means 'gz'.
$this->_compress = false;
$this->_compress_type = 'none';
if (($p_compress === null ) || ($p_compress == '')) {
if ($fp = @fopen($p_tarname, "rb")) {
// look for gzip magic cookie
if ($data == "\37\213") {
$this->_compress_type = 'gz';
// No sure it's enought for a magic code ....
} elseif ($data == "BZ") {
$this->_compress_type = 'bz2';
// probably a remote file or some file accessible
// through a stream interface
if (substr($p_tarname, -2 ) == 'gz') {
$this->_compress_type = 'gz';
} elseif ((substr($p_tarname, -3 ) == 'bz2') ||
(substr($p_tarname, -2 ) == 'bz')) {
$this->_compress_type = 'bz2';
if (($p_compress === true ) || ($p_compress == 'gz')) {
$this->_compress_type = 'gz';
} else if ($p_compress == 'bz2') {
$this->_compress_type = 'bz2';
$this->_error (" Unsupported compression type '$p_compress'\n".
"Supported types are 'gz' and 'bz2'.\n");
$this->_tarname = $p_tarname;
if ($this->_compress) { // assert zlib or bz2 extension support
if ($this->_compress_type == 'gz')
else if ($this->_compress_type == 'bz2')
PEAR ::loadExtension ($extname);
$this->_error (" The extension '$extname' couldn't be found.\n".
"Please make sure your version of PHP was built ".
" with '$extname' support.\n" );
// ----- Look for a local copy to delete
if ($this->_temp_tarname != '')
@unlink($this->_temp_tarname);
* This method creates the archive file and add the files / directories
* that are listed in $p_filelist.
* If a file with the same name exist and is writable, it is replaced
* The method return false and a PEAR error text.
* The $p_filelist parameter can be an array of string, each string
* representing a filename or a directory name with their path if
* needed. It can also be a single string with names separated by a
* For each directory added in the archive, the files and
* sub-directories are also added.
* See also createModify() method for more details.
* @param array $p_filelist An array of filenames and directory names, or a
* single string with names separated by a single
* @return true on success, false on error.
* This method add the files / directories that are listed in $p_filelist in
* the archive. If the archive does not exist it is created.
* The method return false and a PEAR error text.
* The files and directories listed are only added at the end of the archive,
* even if a file with the same name is already archived.
* See also createModify() method for more details.
* @param array $p_filelist An array of filenames and directory names, or a
* single string with names separated by a single
* @return true on success, false on error.
function add($p_filelist)
return $this->addModify($p_filelist, '', '');
function extract($p_path= '', $p_preserve=false )
$v_list_detail = array ();
if ($this->_openRead ()) {
if (!$this->_extractList ('', $v_list_detail, "list", '', '')) {
* This method creates the archive file and add the files / directories
* that are listed in $p_filelist.
* If the file already exists and is writable, it is replaced by the
* new tar. It is a create and not an add. If the file exists and is
* read-only or is a directory it is not replaced. The method return
* false and a PEAR error text.
* The $p_filelist parameter can be an array of string, each string
* representing a filename or a directory name with their path if
* needed. It can also be a single string with names separated by a
* The path indicated in $p_remove_dir will be removed from the
* memorized path of each file / directory listed when this path
* exists. By default nothing is removed (empty path '')
* The path indicated in $p_add_dir will be added at the beginning of
* the memorized path of each file / directory listed. However it can
* be set to empty ''. The adding of a path is done after the removing
* The path add/remove ability enables the user to prepare an archive
* for extraction in a different path than the origin files are.
* See also addModify() method for file adding properties.
* @param array $p_filelist An array of filenames and directory names,
* or a single string with names separated by
* @param string $p_add_dir A string which contains a path to be added
* to the memorized path of each element in
* @param string $p_remove_dir A string which contains a path to be
* removed from the memorized path of each
* element in the list, when relevant.
* @return boolean true on success, false on error.
function createModify($p_filelist, $p_add_dir, $p_remove_dir= '')
if (!$this->_openWrite ())
$v_list = explode($this->_separator, $p_filelist);
$this->_error ('Invalid file list');
$v_result = $this->_addList ($v_list, $p_add_dir, $p_remove_dir);
* This method add the files / directories listed in $p_filelist at the
* end of the existing archive. If the archive does not yet exists it
* The $p_filelist parameter can be an array of string, each string
* representing a filename or a directory name with their path if
* needed. It can also be a single string with names separated by a
* The path indicated in $p_remove_dir will be removed from the
* memorized path of each file / directory listed when this path
* exists. By default nothing is removed (empty path '')
* The path indicated in $p_add_dir will be added at the beginning of
* the memorized path of each file / directory listed. However it can
* be set to empty ''. The adding of a path is done after the removing
* The path add/remove ability enables the user to prepare an archive
* for extraction in a different path than the origin files are.
* If a file/dir is already in the archive it will only be added at the
* end of the archive. There is no update of the existing archived
* file/dir. However while extracting the archive, the last file will
* replace the first one. This results in a none optimization of the
* If a file/dir does not exist the file/dir is ignored. However an
* error text is send to PEAR error.
* If a file/dir is not readable the file/dir is ignored. However an
* error text is send to PEAR error.
* @param array $p_filelist An array of filenames and directory
* names, or a single string with names
* separated by a single blank space.
* @param string $p_add_dir A string which contains a path to be
* added to the memorized path of each
* @param string $p_remove_dir A string which contains a path to be
* removed from the memorized path of
* each element in the list, when
* @return true on success, false on error.
function addModify($p_filelist, $p_add_dir, $p_remove_dir= '')
if (!$this->_isArchive ())
$v_list = explode($this->_separator, $p_filelist);
$this->_error ('Invalid file list');
$v_result = $this->_append ($v_list, $p_add_dir, $p_remove_dir);
* This method add a single string as a file at the
* end of the existing archive. If the archive does not yet exists it
* @param string $p_filename A string which contains the full
* filename path that will be associated
* @param string $p_string The content of the file added in
* @param int $p_datetime A custom date/time (unix timestamp)
* for the file (optional).
* @return true on success, false on error.
function addString($p_filename, $p_string, $p_datetime = false )
if (!$this->_isArchive ()) {
if (!$this->_openWrite ()) {
if (!$this->_openAppend ())
// Need to check the get back to the temporary file ? ....
$v_result = $this->_addString ($p_filename, $p_string, $p_datetime);
* This method extract all the content of the archive in the directory
* indicated by $p_path. When relevant the memorized path of the
* files/dir can be modified by removing the $p_remove_path path at the
* beginning of the file/dir path.
* While extracting a file, if the directory path does not exists it is
* While extracting a file, if the file already exists it is replaced
* without looking for last modification date.
* While extracting a file, if the file already exists and is write
* protected, the extraction is aborted.
* While extracting a file, if a directory with the same name already
* exists, the extraction is aborted.
* While extracting a directory, if a file with the same name already
* exists, the extraction is aborted.
* While extracting a file/directory if the destination directory exist
* and is write protected, or does not exist but can not be created,
* the extraction is aborted.
* If after extraction an extracted file does not show the correct
* stored file size, the extraction is aborted.
* When the extraction is aborted, a PEAR error text is set and false
* is returned. However the result can be a partial extraction that may
* need to be manually cleaned.
* @param string $p_path The path of the directory where the
* files/dir need to by extracted.
* @param string $p_remove_path Part of the memorized path that can be
* removed if present at the beginning of
* @param boolean $p_preserve Preserve user/group ownership of files
* @return boolean true on success, false on error.
function extractModify($p_path, $p_remove_path, $p_preserve=false )
$v_list_detail = array ();
if ($v_result = $this->_openRead ()) {
$v_result = $this->_extractList ($p_path, $v_list_detail,
"complete", 0 , $p_remove_path, $p_preserve);
* This method extract from the archive one file identified by $p_filename.
* The return value is a string with the file content, or NULL on error.
* @param string $p_filename The path of the file to extract in a string.
* @return a string with the file content or NULL.
if ($this->_openRead ()) {
$v_result = $this->_extractInString ($p_filename);
* This method extract from the archive only the files indicated in the
* $p_filelist. These files are extracted in the current directory or
* in the directory indicated by the optional $p_path parameter.
* If indicated the $p_remove_path can be used in the same way as it is
* used in extractModify() method.
* @param array $p_filelist An array of filenames and directory names,
* or a single string with names separated
* by a single blank space.
* @param string $p_path The path of the directory where the
* files/dir need to by extracted.
* @param string $p_remove_path Part of the memorized path that can be
* removed if present at the beginning of
* @param boolean $p_preserve Preserve user/group ownership of files
* @return true on success, false on error.
function extractList($p_filelist, $p_path= '', $p_remove_path= '', $p_preserve=false )
$v_list_detail = array ();
$v_list = explode($this->_separator, $p_filelist);
$this->_error ('Invalid string list');
if ($v_result = $this->_openRead ()) {
$v_result = $this->_extractList ($p_path, $v_list_detail, "partial",
$v_list, $p_remove_path, $p_preserve);
* This method set specific attributes of the archive. It uses a variable
* list of parameters, in the format attribute code + attribute values :
* $arch->setAttribute(ARCHIVE_TAR_ATT_SEPARATOR, ',');
* @param mixed $argv variable list of attributes and values
* @return true on success, false on error.
// ----- Get the number of variable list of arguments
// ----- Get the arguments
// ----- Read the attributes
// ----- Look for next option
switch ($v_att_list[$i]) {
// ----- Look for options that request a string value
// ----- Check the number of parameters
$this->_error ('Invalid number of parameters for '
. 'attribute ARCHIVE_TAR_ATT_SEPARATOR');
$this->_separator = $v_att_list[$i+1 ];
$this->_error ('Unknow attribute code '. $v_att_list[$i]. '');
* This method sets the regular expression for ignoring files and directories
* at import, for example:
* $arch->setIgnoreRegexp("#CVS|\.svn#");
* @param string $regexp regular expression defining which files or directories to ignore
$this->_ignore_regexp = $regexp;
* This method sets the regular expression for ignoring all files and directories
* matching the filenames in the array list at import, for example:
* $arch->setIgnoreList(array('CVS', '.svn', 'bin/tool'));
* @param array $list a list of file or directory names to ignore
$regexp = str_replace(array ('#', '.', '^', '$'), array ('\#', '\.', '\^', '\$'), $list);
$regexp = '#/'. join('$|/', $list). '#';
function _error ($p_message)
function _warning ($p_message)
function _isArchive ($p_filename=null )
if ($p_filename == null ) {
$p_filename = $this->_tarname;
$this->_file = @gzopen($this->_tarname, "wb9");
$this->_file = @bzopen ($this->_tarname, "w");
else if ($this->_compress_type == 'none')
$this->_file = @fopen($this->_tarname, "wb");
$this->_error ('Unknown or missing compression type ('
. $this->_compress_type. ')');
$this->_error ('Unable to open in write mode \''
// ----- Look if a local copy need to be done
if ($this->_temp_tarname == '') {
$this->_temp_tarname = uniqid('tar'). '.tmp';
if (!$v_file_from = @fopen($this->_tarname, 'rb')) {
$this->_error ('Unable to open in read mode \''
$this->_temp_tarname = '';
if (!$v_file_to = @fopen($this->_temp_tarname, 'wb')) {
$this->_error ('Unable to open in write mode \''
. $this->_temp_tarname. '\'');
$this->_temp_tarname = '';
while ($v_data = @fread($v_file_from, 1024 ))
// ----- File to open if the local copy
$v_filename = $this->_temp_tarname;
// ----- File to open if the normal Tar file
$v_filename = $this->_tarname;
$this->_file = @gzopen($v_filename, "rb");
$this->_file = @bzopen ($v_filename, "r");
else if ($this->_compress_type == 'none')
$this->_file = @fopen($v_filename, "rb");
$this->_error ('Unknown or missing compression type ('
. $this->_compress_type. ')');
$this->_error ('Unable to open in read mode \''. $v_filename. '\'');
function _openReadWrite ()
if ($this->_compress_type == 'gz')
$this->_file = @gzopen($this->_tarname, "r+b");
else if ($this->_compress_type == 'bz2') {
$this->_error ('Unable to open bz2 in read/write mode \''
. $this->_tarname. '\' (limitation of bz2 extension)');
} else if ($this->_compress_type == 'none')
$this->_file = @fopen($this->_tarname, "r+b");
$this->_error ('Unknown or missing compression type ('
. $this->_compress_type. ')');
$this->_error ('Unable to open in read/write mode \''
//if (isset($this->_file)) {
if ($this->_compress_type == 'gz')
else if ($this->_compress_type == 'bz2')
else if ($this->_compress_type == 'none')
$this->_error ('Unknown or missing compression type ('
. $this->_compress_type. ')');
// ----- Look if a local copy need to be erase
// Note that it might be interesting to keep the url for a time : ToDo
if ($this->_temp_tarname != '') {
@unlink($this->_temp_tarname);
$this->_temp_tarname = '';
// ----- Look for a local copy
if ($this->_temp_tarname != '') {
// ----- Remove the local copy but not the remote tarname
@unlink($this->_temp_tarname);
$this->_temp_tarname = '';
// ----- Remove the local tarname file
function _writeBlock ($p_binary_data, $p_len=null )
if ($this->_compress_type == 'gz')
@gzputs($this->_file, $p_binary_data);
else if ($this->_compress_type == 'bz2')
@bzwrite ($this->_file, $p_binary_data);
else if ($this->_compress_type == 'none')
@fputs($this->_file, $p_binary_data);
$this->_error ('Unknown or missing compression type ('
. $this->_compress_type. ')');
if ($this->_compress_type == 'gz')
@gzputs($this->_file, $p_binary_data, $p_len);
else if ($this->_compress_type == 'bz2')
@bzwrite ($this->_file, $p_binary_data, $p_len);
else if ($this->_compress_type == 'none')
@fputs($this->_file, $p_binary_data, $p_len);
$this->_error ('Unknown or missing compression type ('
. $this->_compress_type. ')');
if ($this->_compress_type == 'gz')
$v_block = @gzread($this->_file, 512 );
else if ($this->_compress_type == 'bz2')
$v_block = @bzread ($this->_file, 512 );
else if ($this->_compress_type == 'none')
$v_block = @fread($this->_file, 512 );
$this->_error ('Unknown or missing compression type ('
. $this->_compress_type. ')');
function _jumpBlock ($p_len=null )
if ($this->_compress_type == 'gz') {
else if ($this->_compress_type == 'bz2') {
// ----- Replace missing bztell() and bzseek()
for ($i=0; $i< $p_len; $i++ )
} else if ($this->_compress_type == 'none')
@fseek($this->_file, $p_len*512 , SEEK_CUR );
$this->_error ('Unknown or missing compression type ('
. $this->_compress_type. ')');
// ----- Write the last 0 filled block for end of archive
$v_binary_data = pack('a1024', '');
$this->_writeBlock ($v_binary_data);
function _addList ($p_list, $p_add_dir, $p_remove_dir)
// ----- Remove potential windows directory separator
$p_add_dir = $this->_translateWinPath ($p_add_dir);
$p_remove_dir = $this->_translateWinPath ($p_remove_dir, false );
$this->_error ('Invalid file descriptor');
foreach ($p_list as $v_filename) {
// ----- Skip the current tar name
if ($v_filename == $this->_tarname)
// ----- ignore files and directories matching the ignore regular expression
if ($this->_ignore_regexp && preg_match($this->_ignore_regexp, '/'. $v_filename)) {
$this->_warning (" File '$v_filename' ignored" );
$this->_warning (" File '$v_filename' does not exist" );
// ----- Add the file or directory header
if (!$this->_addFile ($v_filename, $v_header, $p_add_dir, $p_remove_dir))
if (!($p_hdir = opendir($v_filename))) {
$this->_warning (" Directory '$v_filename' can not be read" );
while (false !== ($p_hitem = readdir($p_hdir))) {
if (($p_hitem != '.') && ($p_hitem != '..')) {
$p_temp_list[0 ] = $v_filename. '/'. $p_hitem;
$p_temp_list[0 ] = $p_hitem;
$v_result = $this->_addList ($p_temp_list,
function _addFile ($p_filename, &$p_header, $p_add_dir, $p_remove_dir)
$this->_error ('Invalid file descriptor');
$this->_error ('Invalid file name');
// ----- Calculate the stored filename
$p_filename = $this->_translateWinPath ($p_filename, false );;
$v_stored_filename = $p_filename;
if (strcmp($p_filename, $p_remove_dir) == 0 ) {
if ($p_remove_dir != '') {
if (substr($p_remove_dir, -1 ) != '/')
if (substr($p_filename, 0 , strlen($p_remove_dir)) == $p_remove_dir)
$v_stored_filename = substr($p_filename, strlen($p_remove_dir));
$v_stored_filename = $this->_translateWinPath ($v_stored_filename);
if (substr($p_add_dir, -1 ) == '/')
$v_stored_filename = $p_add_dir. $v_stored_filename;
$v_stored_filename = $p_add_dir. '/'. $v_stored_filename;
$v_stored_filename = $this->_pathReduction ($v_stored_filename);
if ($this->_isArchive ($p_filename)) {
if (($v_file = @fopen($p_filename, "rb")) == 0 ) {
$this->_warning ("Unable to open file '". $p_filename
. "' in binary read mode");
if (!$this->_writeHeader ($p_filename, $v_stored_filename))
while (($v_buffer = fread($v_file, 512 )) != '') {
$v_binary_data = pack("a512", " $v_buffer" );
$this->_writeBlock ($v_binary_data);
// ----- Only header for dir
if (!$this->_writeHeader ($p_filename, $v_stored_filename))
function _addString ($p_filename, $p_string, $p_datetime = false )
$this->_error ('Invalid file descriptor');
$this->_error ('Invalid file name');
// ----- Calculate the stored filename
$p_filename = $this->_translateWinPath ($p_filename, false );;
// ----- If datetime is not specified, set current time
if ($p_datetime === false ) {
if (!$this->_writeHeaderBlock ($p_filename, strlen($p_string),
$p_datetime, 384 , "", 0 , 0 ))
while (($v_buffer = substr($p_string, (($i++ )*512 ), 512 )) != '') {
$v_binary_data = pack("a512", $v_buffer);
$this->_writeBlock ($v_binary_data);
function _writeHeader ($p_filename, $p_stored_filename)
if ($p_stored_filename == '')
$p_stored_filename = $p_filename;
$v_reduce_filename = $this->_pathReduction ($p_stored_filename);
if (strlen($v_reduce_filename) > 99 ) {
if (!$this->_writeLongHeader ($v_reduce_filename))
$v_info = lstat($p_filename);
$v_uid = sprintf("%07s", DecOct ($v_info[4 ]));
$v_gid = sprintf("%07s", DecOct ($v_info[5 ]));
$v_perms = sprintf("%07s", DecOct ($v_info['mode'] & 000777 ));
$v_mtime = sprintf("%011s", DecOct ($v_info['mtime']));
$v_size = sprintf("%011s", DecOct (0 ));
} elseif (@is_dir($p_filename)) {
$v_size = sprintf("%011s", DecOct (0 ));
$v_size = sprintf("%011s", DecOct ($v_info['size']));
$v_uname = $userinfo['name'];
$v_gname = $groupinfo['name'];
$v_binary_data_first = pack("a100a8a8a8a12a12",
$v_reduce_filename, $v_perms, $v_uid,
$v_gid, $v_size, $v_mtime);
$v_binary_data_last = pack("a1a100a6a2a32a32a8a8a155a12",
$v_typeflag, $v_linkname, $v_magic,
$v_version, $v_uname, $v_gname,
$v_devmajor, $v_devminor, $v_prefix, '');
// ----- Calculate the checksum
// ..... First part of the header
$v_checksum += ord(substr($v_binary_data_first,$i,1 ));
// ..... Ignore the checksum value and replace it by ' ' (space)
for ($i=148; $i<156; $i++ )
// ..... Last part of the header
for ($i=156 , $j=0; $i<512; $i++ , $j++ )
$v_checksum += ord(substr($v_binary_data_last,$j,1 ));
// ----- Write the first 148 bytes of the header in the archive
$this->_writeBlock ($v_binary_data_first, 148 );
// ----- Write the calculated checksum
$v_checksum = sprintf("%06s ", DecOct ($v_checksum));
$v_binary_data = pack("a8", $v_checksum);
$this->_writeBlock ($v_binary_data, 8 );
// ----- Write the last 356 bytes of the header in the archive
$this->_writeBlock ($v_binary_data_last, 356 );
// {{{ _writeHeaderBlock()
function _writeHeaderBlock ($p_filename, $p_size, $p_mtime=0 , $p_perms=0 ,
$p_type= '', $p_uid=0 , $p_gid=0 )
$p_filename = $this->_pathReduction ($p_filename);
if (strlen($p_filename) > 99 ) {
if (!$this->_writeLongHeader ($p_filename))
$v_size = sprintf("%011s", DecOct (0 ));
$v_size = sprintf("%011s", DecOct ($p_size));
$v_uid = sprintf("%07s", DecOct ($p_uid));
$v_gid = sprintf("%07s", DecOct ($p_gid));
$v_perms = sprintf("%07s", DecOct ($p_perms & 000777 ));
$v_mtime = sprintf("%11s", DecOct ($p_mtime));
$v_uname = $userinfo['name'];
$v_gname = $groupinfo['name'];
$v_binary_data_first = pack("a100a8a8a8a12A12",
$p_filename, $v_perms, $v_uid, $v_gid,
$v_binary_data_last = pack("a1a100a6a2a32a32a8a8a155a12",
$p_type, $v_linkname, $v_magic,
$v_version, $v_uname, $v_gname,
$v_devmajor, $v_devminor, $v_prefix, '');
// ----- Calculate the checksum
// ..... First part of the header
$v_checksum += ord(substr($v_binary_data_first,$i,1 ));
// ..... Ignore the checksum value and replace it by ' ' (space)
for ($i=148; $i<156; $i++ )
// ..... Last part of the header
for ($i=156 , $j=0; $i<512; $i++ , $j++ )
$v_checksum += ord(substr($v_binary_data_last,$j,1 ));
// ----- Write the first 148 bytes of the header in the archive
$this->_writeBlock ($v_binary_data_first, 148 );
// ----- Write the calculated checksum
$v_checksum = sprintf("%06s ", DecOct ($v_checksum));
$v_binary_data = pack("a8", $v_checksum);
$this->_writeBlock ($v_binary_data, 8 );
// ----- Write the last 356 bytes of the header in the archive
$this->_writeBlock ($v_binary_data_last, 356 );
// {{{ _writeLongHeader()
function _writeLongHeader ($p_filename)
$v_binary_data_first = pack("a100a8a8a8a12a12",
'././@LongLink', 0 , 0 , 0 , $v_size, 0 );
$v_binary_data_last = pack("a1a100a6a2a32a32a8a8a155a12",
$v_typeflag, $v_linkname, $v_magic,
$v_version, $v_uname, $v_gname,
$v_devmajor, $v_devminor, $v_prefix, '');
// ----- Calculate the checksum
// ..... First part of the header
$v_checksum += ord(substr($v_binary_data_first,$i,1 ));
// ..... Ignore the checksum value and replace it by ' ' (space)
for ($i=148; $i<156; $i++ )
// ..... Last part of the header
for ($i=156 , $j=0; $i<512; $i++ , $j++ )
$v_checksum += ord(substr($v_binary_data_last,$j,1 ));
// ----- Write the first 148 bytes of the header in the archive
$this->_writeBlock ($v_binary_data_first, 148 );
// ----- Write the calculated checksum
$v_checksum = sprintf("%06s ", DecOct ($v_checksum));
$v_binary_data = pack("a8", $v_checksum);
$this->_writeBlock ($v_binary_data, 8 );
// ----- Write the last 356 bytes of the header in the archive
$this->_writeBlock ($v_binary_data_last, 356 );
// ----- Write the filename as content of the block
while (($v_buffer = substr($p_filename, (($i++ )*512 ), 512 )) != '') {
$v_binary_data = pack("a512", " $v_buffer" );
$this->_writeBlock ($v_binary_data);
function _readHeader ($v_binary_data, &$v_header)
if (strlen($v_binary_data)==0 ) {
$v_header['filename'] = '';
if (strlen($v_binary_data) != 512 ) {
$v_header['filename'] = '';
$this->_error ('Invalid block size : '. strlen($v_binary_data));
// ----- Calculate the checksum
// ..... First part of the header
$v_checksum+= ord(substr($v_binary_data,$i,1 ));
// ..... Ignore the checksum value and replace it by ' ' (space)
for ($i=148; $i<156; $i++ )
// ..... Last part of the header
for ($i=156; $i<512; $i++ )
$v_checksum+= ord(substr($v_binary_data,$i,1 ));
$fmt = "a100filename/a8mode/a8uid/a8gid/a12size/a12mtime/" .
"a8checksum/a1typeflag/a100link/a6magic/a2version/" .
"a32uname/a32gname/a8devmajor/a8devminor/a131prefix";
$fmt = "Z100filename/Z8mode/Z8uid/Z8gid/Z12size/Z12mtime/" .
"Z8checksum/Z1typeflag/Z100link/Z6magic/Z2version/" .
"Z32uname/Z32gname/Z8devmajor/Z8devminor/Z131prefix";
$v_data = unpack($fmt, $v_binary_data);
if (strlen($v_data["prefix"]) > 0 ) {
$v_data["filename"] = " $v_data[prefix]/$v_data[filename]";
// ----- Extract the checksum
$v_header['checksum'] = OctDec (trim($v_data['checksum']));
if ($v_header['checksum'] != $v_checksum) {
$v_header['filename'] = '';
// ----- Look for last block (empty block)
if (($v_checksum == 256 ) && ($v_header['checksum'] == 0 ))
$this->_error ('Invalid checksum for file "'. $v_data['filename']
. '" : '. $v_checksum. ' calculated, '
. $v_header['checksum']. ' expected');
// ----- Extract the properties
$v_header['filename'] = $v_data['filename'];
if ($this->_maliciousFilename ($v_header['filename'])) {
$this->_error ('Malicious .tar detected, file "' . $v_header['filename'] .
'" will not install in desired directory tree');
$v_header['mode'] = OctDec (trim($v_data['mode']));
$v_header['uid'] = OctDec (trim($v_data['uid']));
$v_header['gid'] = OctDec (trim($v_data['gid']));
$v_header['size'] = OctDec (trim($v_data['size']));
$v_header['mtime'] = OctDec (trim($v_data['mtime']));
if (($v_header['typeflag'] = $v_data['typeflag']) == "5") {
$v_header['link'] = trim($v_data['link']);
/* ----- All these fields are removed form the header because
they do not carry interesting info
$v_header[magic] = trim($v_data[magic]);
$v_header[version] = trim($v_data[version]);
$v_header[uname] = trim($v_data[uname]);
$v_header[gname] = trim($v_data[gname]);
$v_header[devmajor] = trim($v_data[devmajor]);
$v_header[devminor] = trim($v_data[devminor]);
// {{{ _maliciousFilename()
* Detect and report a malicious file name
function _maliciousFilename ($file)
if (strpos($file, '/../') !== false ) {
if (strpos($file, '../') === 0 ) {
function _readLongHeader (&$v_header)
$n = floor($v_header['size']/512 );
for ($i=0; $i< $n; $i++ ) {
$v_content = $this->_readBlock ();
$v_filename .= $v_content;
if (($v_header['size'] % 512 ) != 0 ) {
$v_content = $this->_readBlock ();
$v_filename .= trim($v_content);
// ----- Read the next header
$v_binary_data = $this->_readBlock ();
if (!$this->_readHeader ($v_binary_data, $v_header))
$v_filename = trim($v_filename);
$v_header['filename'] = $v_filename;
if ($this->_maliciousFilename ($v_filename)) {
$this->_error ('Malicious .tar detected, file "' . $v_filename .
'" will not install in desired directory tree');
// {{{ _extractInString()
* This method extract from the archive one file identified by $p_filename.
* The return value is a string with the file content, or null on error.
* @param string $p_filename The path of the file to extract in a string.
* @return a string with the file content or null.
function _extractInString ($p_filename)
While (strlen($v_binary_data = $this->_readBlock ()) != 0 )
if (!$this->_readHeader ($v_binary_data, $v_header))
if ($v_header['filename'] == '')
// ----- Look for long filename
if ($v_header['typeflag'] == 'L') {
if (!$this->_readLongHeader ($v_header))
if ($v_header['filename'] == $p_filename) {
if ($v_header['typeflag'] == "5") {
$this->_error ('Unable to extract in string a directory '
. 'entry {'. $v_header['filename']. '}');
$n = floor($v_header['size']/512 );
for ($i=0; $i< $n; $i++ ) {
$v_result_str .= $this->_readBlock ();
if (($v_header['size'] % 512 ) != 0 ) {
$v_content = $this->_readBlock ();
$v_result_str .= substr($v_content, 0 ,
($v_header['size'] % 512 ));
$this->_jumpBlock (ceil(($v_header['size']/512 )));
function _extractList ($p_path, &$p_list_detail, $p_mode,
$p_file_list, $p_remove_path, $p_preserve=false )
$p_path = $this->_translateWinPath ($p_path, false );
if ($p_path == '' || (substr($p_path, 0 , 1 ) != '/'
&& substr($p_path, 0 , 3 ) != "../" && !strpos($p_path, ':'))) {
$p_remove_path = $this->_translateWinPath ($p_remove_path);
// ----- Look for path to remove format (should end by /)
if (($p_remove_path != '') && (substr($p_remove_path, -1 ) != '/'))
$p_remove_path_size = strlen($p_remove_path);
$this->_error ('Invalid extract mode ('. $p_mode. ')');
while (strlen($v_binary_data = $this->_readBlock ()) != 0 )
$v_extraction_stopped = 0;
if (!$this->_readHeader ($v_binary_data, $v_header))
if ($v_header['filename'] == '') {
// ----- Look for long filename
if ($v_header['typeflag'] == 'L') {
if (!$this->_readLongHeader ($v_header))
if ((!$v_extract_all) && (is_array($p_file_list))) {
// ----- By default no unzip if the file is not found
for ($i=0; $i< sizeof($p_file_list); $i++ ) {
// ----- Look if it is a directory
if (substr($p_file_list[$i], -1 ) == '/') {
// ----- Look if the directory is in the filename path
if ((strlen($v_header['filename']) > strlen($p_file_list[$i]))
&& (substr($v_header['filename'], 0 , strlen($p_file_list[$i]))
// ----- It is a file, so compare the file names
elseif ($p_file_list[$i] == $v_header['filename']) {
// ----- Look if this file need to be extracted
if (($v_extract_file) && (!$v_listing))
if (($p_remove_path != '')
&& (substr($v_header['filename']. '/', 0 , $p_remove_path_size)
$v_header['filename'] = substr($v_header['filename'],
if( $v_header['filename'] == '' ){
if (($p_path != './') && ($p_path != '/')) {
while (substr($p_path, -1 ) == '/')
if (substr($v_header['filename'], 0 , 1 ) == '/')
$v_header['filename'] = $p_path. $v_header['filename'];
$v_header['filename'] = $p_path. '/'. $v_header['filename'];
if ( (@is_dir($v_header['filename']))
&& ($v_header['typeflag'] == '')) {
$this->_error ('File '. $v_header['filename']
. ' already exists as a directory');
if ( ($this->_isArchive ($v_header['filename']))
&& ($v_header['typeflag'] == "5")) {
$this->_error ('Directory '. $v_header['filename']
. ' already exists as a file');
$this->_error ('File '. $v_header['filename']
. ' already exists and is write protected');
if (filemtime($v_header['filename']) > $v_header['mtime']) {
// To be completed : An error or silent no replace ?
// ----- Check the directory availability and create it if necessary
= $this->_dirCheck (($v_header['typeflag'] == "5"
: dirname($v_header['filename'])))) != 1 ) {
$this->_error ('Unable to create path for '. $v_header['filename']);
if ($v_header['typeflag'] == "5") {
if (!@mkdir($v_header['filename'], 0777 )) {
$this->_error ('Unable to create directory {'
. $v_header['filename']. '}');
} elseif ($v_header['typeflag'] == "2") {
@unlink($v_header['filename']);
if (!@symlink($v_header['link'], $v_header['filename'])) {
$this->_error ('Unable to extract symbolic link {'
. $v_header['filename']. '}');
if (($v_dest_file = @fopen($v_header['filename'], "wb")) == 0 ) {
$this->_error ('Error while opening {'. $v_header['filename']
. '} in write binary mode');
$n = floor($v_header['size']/512 );
for ($i=0; $i< $n; $i++ ) {
$v_content = $this->_readBlock ();
fwrite($v_dest_file, $v_content, 512 );
if (($v_header['size'] % 512 ) != 0 ) {
$v_content = $this->_readBlock ();
fwrite($v_dest_file, $v_content, ($v_header['size'] % 512 ));
@chown($v_header['filename'], $v_header['uid']);
@chgrp($v_header['filename'], $v_header['gid']);
// ----- Change the file mode, mtime
@touch($v_header['filename'], $v_header['mtime']);
if ($v_header['mode'] & 0111 ) {
// make file executable, obey umask
@chmod($v_header['filename'], $mode);
// ----- Check the file size
if (!is_file($v_header['filename'])) {
$this->_error ('Extracted file '. $v_header['filename']
. 'does not exist. Archive may be corrupted.');
$filesize = filesize($v_header['filename']);
if ($filesize != $v_header['size']) {
$this->_error ('Extracted file '. $v_header['filename']
. ' does not have the correct file size \''
. '\' ('. $v_header['size']
. ' expected). Archive may be corrupted.');
$this->_jumpBlock (ceil(($v_header['size']/512 )));
$this->_jumpBlock (ceil(($v_header['size']/512 )));
/* TBC : Seems to be unused ...
$v_end_of_file = @gzeof($this->_file);
$v_end_of_file = @feof($this->_file);
if ($v_listing || $v_extract_file || $v_extraction_stopped) {
// ----- Log extracted files
if (($v_file_dir = dirname($v_header['filename']))
== $v_header['filename'])
if ((substr($v_header['filename'], 0 , 1 ) == '/') && ($v_file_dir == ''))
$p_list_detail[$v_nb++ ] = $v_header;
return $this->_openWrite ();
if (!@rename($this->_tarname, $this->_tarname. ".tmp")) {
$this->_error ('Error while renaming \''. $this->_tarname
. '\' to temporary file \''. $this->_tarname
if ($this->_compress_type == 'gz')
$v_temp_tar = @gzopen($this->_tarname. ".tmp", "rb");
elseif ($this->_compress_type == 'bz2')
$v_temp_tar = @bzopen ($this->_tarname. ".tmp", "r");
$this->_error ('Unable to open file \''. $this->_tarname
. '.tmp\' in binary read mode');
@rename($this->_tarname. ".tmp", $this->_tarname);
if (!$this->_openWrite ()) {
@rename($this->_tarname. ".tmp", $this->_tarname);
if ($this->_compress_type == 'gz') {
while (!@gzeof($v_temp_tar)) {
$v_buffer = @gzread($v_temp_tar, 512 );
// do not copy end blocks, we will re-make them
} elseif ($end_blocks > 0 ) {
for ($i = 0; $i < $end_blocks; $i++ ) {
$v_binary_data = pack("a512", $v_buffer);
$this->_writeBlock ($v_binary_data);
elseif ($this->_compress_type == 'bz2') {
while (strlen($v_buffer = @bzread ($v_temp_tar, 512 )) > 0 ) {
// do not copy end blocks, we will re-make them
} elseif ($end_blocks > 0 ) {
for ($i = 0; $i < $end_blocks; $i++ ) {
$v_binary_data = pack("a512", $v_buffer);
$this->_writeBlock ($v_binary_data);
if (!@unlink($this->_tarname. ".tmp")) {
$this->_error ('Error while deleting temporary file \''
. $this->_tarname. '.tmp\'');
// ----- For not compressed tar, just add files before the last
// one or two 512 bytes block
if (!$this->_openReadWrite ())
// We might have zero, one or two end blocks.
// The standard is two, but we should try to handle
fseek($this->_file, $v_size - 1024 );
fseek($this->_file, $v_size - 1024 );
fseek($this->_file, $v_size - 512 );
function _append ($p_filelist, $p_add_dir= '', $p_remove_dir= '')
if (!$this->_openAppend ())
if ($this->_addList ($p_filelist, $p_add_dir, $p_remove_dir))
* Check if a directory exists and create it (including parent
* @param string $p_dir directory to check
* @return bool true if the directory exists or was created
function _dirCheck ($p_dir)
if ((@is_dir($p_dir)) || ($p_dir == ''))
if (($p_parent_dir != $p_dir) &&
(!$this->_dirCheck ($p_parent_dir)))
if (!@mkdir($p_dir, 0777 )) {
$this->_error (" Unable to create directory '$p_dir'" );
* Compress path by changing for example "/dir/foo/../bar" to "/dir/bar",
* rand emove double slashes.
* @param string $p_dir path to reduce
* @return string reduced path
function _pathReduction ($p_dir)
// ----- Look for not empty path
// ----- Explode path by directory names
// ----- Study directories from last to first
for ($i= sizeof($v_list)-1; $i>=0; $i-- ) {
// ----- Look for current path
if ($v_list[$i] == ".") {
// ----- Ignore this directory
// Should be the first $i=0, but no check is done
else if ($v_list[$i] == "..") {
// ----- Ignore it and ignore the $i-1
else if ( ($v_list[$i] == '')
// ----- Ignore only the double '//' in path,
// but not the first and last /
$v_result = $v_list[$i]. ($i!= (sizeof($v_list)-1 )? '/'
if (defined('OS_WINDOWS') && OS_WINDOWS ) {
$v_result = strtr($v_result, '\\', '/');
// {{{ _translateWinPath()
function _translateWinPath ($p_path, $p_remove_disk_letter=true )
if (defined('OS_WINDOWS') && OS_WINDOWS ) {
// ----- Look for potential disk letter
if ( ($p_remove_disk_letter)
&& (($v_position = strpos($p_path, ':')) != false )) {
$p_path = substr($p_path, $v_position+1 );
// ----- Change potential windows directory separator
if ((strpos($p_path, '\\') > 0 ) || (substr($p_path, 0 ,1 ) == '\\')) {
$p_path = strtr($p_path, '\\', '/');
Documentation generated on Sat, 09 Feb 2013 12:00:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.
|