Tar Class Reference

Inheritance diagram for Tar:

Public Member Functions
	pack ($source, $destination, $skipRoot=false)
	unpack ($source, $destination)
	extract ($file, $source, $destination)
Public Member Functions inherited from AbstractArchive
	getFilename ($source, $withExtension=false)
Public Member Functions inherited from ArchiveInterface
	pack ($source, $destination)

Data Fields
const	TAR_BLOCK_SIZE = 512

Protected Member Functions
	_initWriter ()
	_destroyWriter ()
	_getWriter ()
	_initReader ()
	_destroyReader ()
	_getReader ()
	_setSkipRoot ($skipRoot)
	_setCurrentFile ($file)
	_setDestinationFilePath ($destinationFilePath)
	_getCurrentFile ()
	_setCurrentPath ($path)
	_getCurrentPath ()
	_createTar ($skipRoot=false, $finalize=false)
	_packAndWriteCurrentFile ()
	_composeHeader ($long=false)
	_unpackCurrentTar ($destination)
	_extractFileHeader ()
	_extractAndWriteFile ($fileHeader, $destination)
Protected Member Functions inherited from AbstractArchive
	_writeFile ($destination, $data)
	_readFile ($source)

Static Protected Member Functions
static	_getFormatParseHeader ()

Protected Attributes
	$_currentFile
	$_currentPath
	$_skipRoot
	$_writer
	$_reader
	$_destinationFilePath

Detailed Description

Definition at line 16 of file Tar.php.

Member Function Documentation

_composeHeader()

_composeHeader (   $long = false )

protected

Compose header for current file in TAR format. If length of file's name greater 100 characters, method breaks header into two pieces. First contains header and data with long name. Second contain only header.

Parameters

bool

$long

Returns

string @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 319 of file Tar.php.

    {
        $file = $this->_getCurrentFile();
        $path = $this->_getCurrentPath();
        $infoFile = stat($file);
        $nameFile = str_replace($path, '', $file);
        $nameFile = str_replace('\\', '/', $nameFile);
        $packedHeader = '';
        $longHeader = '';
        if (!$long && strlen($nameFile) > 100) {
            $longHeader = $this->_composeHeader(true);
            $longHeader .= str_pad($nameFile, floor((strlen($nameFile) + 512 - 1) / 512) * 512, "\0");
        }
        $header = [];
        $header['100-name'] = $long ? '././@LongLink' : substr($nameFile, 0, 100);
        $header['8-mode'] = $long ? '       ' : str_pad(
            substr(sprintf("%07o", $infoFile['mode']), -4),
            6,
            '0',
            STR_PAD_LEFT
        );
        $header['8-uid'] = $long || $infoFile['uid'] == 0 ? "\0\0\0\0\0\0\0" : sprintf("%07o", $infoFile['uid']);
        $header['8-gid'] = $long || $infoFile['gid'] == 0 ? "\0\0\0\0\0\0\0" : sprintf("%07o", $infoFile['gid']);
        $header['12-size'] = $long ? sprintf(
            "%011o",
            strlen($nameFile)
        ) : sprintf(
            "%011o",
            is_dir($file) ? 0 : filesize($file)
        );
        $header['12-mtime'] = $long ? '00000000000' : sprintf("%011o", $infoFile['mtime']);
        $header['8-check'] = sprintf('% 8s', '');
        $header['1-type'] = $long ? 'L' : (is_link($file) ? 2 : (is_dir($file) ? 5 : 0));
        $header['100-symlink'] = is_link($file) ? readlink($file) : '';
        $header['6-magic'] = 'ustar ';
        $header['2-version'] = ' ';
        $a = function_exists('posix_getpwuid') ? posix_getpwuid(fileowner($file)) : ['name' => ''];
        $header['32-uname'] = $a['name'];
        $a = function_exists('posix_getgrgid') ? posix_getgrgid(filegroup($file)) : ['name' => ''];
        $header['32-gname'] = $a['name'];
        $header['8-devmajor'] = '';
        $header['8-devminor'] = '';
        $header['155-prefix'] = '';
        $header['12-closer'] = '';

        $packedHeader = '';
        foreach ($header as $key => $element) {
            $length = explode('-', $key);
            $packedHeader .= pack('a' . $length[0], $element);
        }

        $checksum = 0;
        for ($i = 0; $i < 512; $i++) {
            $checksum += ord(substr($packedHeader, $i, 1));
        }
        $packedHeader = substr_replace($packedHeader, sprintf("%07o", $checksum) . "\0", 148, 8);

        return $longHeader . $packedHeader;
    }

_createTar()

_createTar (   $skipRoot = false,   $finalize = false  )

protected

Recursively walk through file tree and create tarball

Parameters

bool	$skipRoot
bool	$finalize

Returns

void

Exceptions

Definition at line 245 of file Tar.php.

    {
        if (!$skipRoot) {
            $this->_packAndWriteCurrentFile();
        }

        $file = $this->_getCurrentFile();

        if (is_dir($file)) {
            $dirFiles = scandir($file, SCANDIR_SORT_NONE);

            if (false === $dirFiles) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    new \Magento\Framework\Phrase('Can\'t scan dir: %1', [$file])
                );
            }

            array_shift($dirFiles);
            /* remove  './'*/
            array_shift($dirFiles);
            /* remove  '../'*/

            foreach ($dirFiles as $item) {
                $this->_setCurrentFile($file . $item)->_createTar();
            }
        }

        if ($finalize) {
            $this->_getWriter()->write(str_repeat("\0", self::TAR_BLOCK_SIZE * 12));
        }
    }

_destroyReader()

_destroyReader ( )

protected

Destroy tarball reader

Returns

$this

Definition at line 139 of file Tar.php.

    {
        if ($this->_reader instanceof File) {
            $this->_reader->close();
            $this->_reader = null;
        }

        return $this;
    }

_destroyWriter()

_destroyWriter ( )

protected

Destroy tarball writer

Returns

$this

Definition at line 97 of file Tar.php.

    {
        if ($this->_writer instanceof File) {
            $this->_writer->close();
            $this->_writer = null;
        }

        return $this;
    }

_extractAndWriteFile()

_extractAndWriteFile (   $fileHeader,   $destination  )

protected

Extract next file from tarball by its $header information and save it to $destination

Parameters

array	$fileHeader
string	$destination

Returns

void

Definition at line 499 of file Tar.php.

    {
        $fileWriter = new File($destination);
        $fileWriter->open('w', $fileHeader['mode']);

        $archiveReader = $this->_getReader();

        $filesize = $fileHeader['size'];
        $bytesExtracted = 0;

        while ($filesize > $bytesExtracted && !$archiveReader->eof()) {
            $block = $archiveReader->read(self::TAR_BLOCK_SIZE);
            $nonExtractedBytesCount = $filesize - $bytesExtracted;

            $data = substr($block, 0, $nonExtractedBytesCount);
            $fileWriter->write($data);

            $bytesExtracted += strlen($block);
        }
    }

_extractFileHeader()

_extractFileHeader ( )

protected

Read and decode file header information from tarball

Returns

array|bool

Definition at line 441 of file Tar.php.

    {
        $archiveReader = $this->_getReader();

        $headerBlock = $archiveReader->read(self::TAR_BLOCK_SIZE);

        if (strlen($headerBlock) < self::TAR_BLOCK_SIZE) {
            return false;
        }

        $header = unpack(self::_getFormatParseHeader(), $headerBlock);

        $header['mode'] = octdec($header['mode']);
        $header['uid'] = octdec($header['uid']);
        $header['gid'] = octdec($header['gid']);
        $header['size'] = octdec($header['size']);
        $header['mtime'] = octdec($header['mtime']);
        $header['checksum'] = octdec($header['checksum']);

        if ($header['type'] == "5") {
            $header['size'] = 0;
        }

        $checksum = 0;
        $headerBlock = substr_replace($headerBlock, '        ', 148, 8);

        for ($i = 0; $i < 512; $i++) {
            $checksum += ord(substr($headerBlock, $i, 1));
        }

        $checksumOk = $header['checksum'] == $checksum;
        if (isset($header['name']) && $checksumOk) {
            $header['name'] = trim($header['name']);
            if (!($header['name'] == '././@LongLink' && $header['type'] == 'L')) {
                return $header;
            }

            $realNameBlockSize = floor(
                ($header['size'] + self::TAR_BLOCK_SIZE - 1) / self::TAR_BLOCK_SIZE
            ) * self::TAR_BLOCK_SIZE;
            $realNameBlock = $archiveReader->read($realNameBlockSize);
            $realName = substr($realNameBlock, 0, $header['size']);

            $headerMain = $this->_extractFileHeader();
            $headerMain['name'] = trim($realName);
            return $headerMain;
        }

        return false;
    }

_getCurrentFile()

_getCurrentFile ( )

protected

Retrieve file which is packing.

Returns

string

Definition at line 205 of file Tar.php.

    {
        return $this->_currentFile;
    }

_getCurrentPath()

_getCurrentPath ( )

protected

Retrieve path to file which is packing.

Returns

string

Definition at line 232 of file Tar.php.

    {
        return $this->_currentPath;
    }

_getFormatParseHeader()

static _getFormatParseHeader ( )

staticprotected

Returns string that is used for tar's header parsing

Returns

string

Definition at line 86 of file Tar.php.

    {
        return 'a100name/a8mode/a8uid/a8gid/a12size/a12mtime/a8checksum/a1type/a100symlink/a6magic/a2version/' .
            'a32uname/a32gname/a8devmajor/a8devminor/a155prefix/a12closer';
    }

_getReader()

_getReader ( )

protected

Get tarball reader

Returns

File

Definition at line 154 of file Tar.php.

    {
        if (!$this->_reader) {
            $this->_initReader();
        }

        return $this->_reader;
    }

_getWriter()

_getWriter ( )

protected

Get tarball writer

Returns

File

Definition at line 112 of file Tar.php.

    {
        if (!$this->_writer) {
            $this->_initWriter();
        }

        return $this->_writer;
    }

_initReader()

_initReader ( )

protected

Initialize tarball reader

Returns

$this

Definition at line 126 of file Tar.php.

    {
        $this->_reader = new File($this->_getCurrentFile());
        $this->_reader->open('r');

        return $this;
    }

_initWriter()

_initWriter ( )

protected

Initialize tarball writer

Returns

$this

Definition at line 73 of file Tar.php.

    {
        $this->_writer = new File($this->_destinationFilePath);
        $this->_writer->open('w');

        return $this;
    }

_packAndWriteCurrentFile()

_packAndWriteCurrentFile ( )

protected

Write current file to tarball

Returns

void

Definition at line 282 of file Tar.php.

    {
        $archiveWriter = $this->_getWriter();
        $archiveWriter->write($this->_composeHeader());

        $currentFile = $this->_getCurrentFile();

        $fileSize = 0;

        if (is_file($currentFile) && !is_link($currentFile)) {
            $fileReader = new File($currentFile);
            $fileReader->open('r');

            while (!$fileReader->eof()) {
                $archiveWriter->write($fileReader->read());
            }

            $fileReader->close();

            $fileSize = filesize($currentFile);
        }

        $appendZerosCount = (self::TAR_BLOCK_SIZE - $fileSize % self::TAR_BLOCK_SIZE) % self::TAR_BLOCK_SIZE;
        $archiveWriter->write(str_repeat("\0", $appendZerosCount));
    }

_setCurrentFile()

_setCurrentFile (   $file )

protected

Set file which is packing.

Parameters

string

$file

Returns

$this

Definition at line 181 of file Tar.php.

    {
        $file = str_replace('\\', '/', $file);
        $this->_currentFile = $file . (!is_link($file) && is_dir($file) && substr($file, -1) != '/' ? '/' : '');
        return $this;
    }

_setCurrentPath()

_setCurrentPath (   $path )

protected

Set path to file which is packing.

Parameters

string

$path

Returns

$this

Definition at line 216 of file Tar.php.

    {
        $path = str_replace('\\', '/', $path);
        if ($this->_skipRoot && is_dir($path)) {
            $this->_currentPath = $path . (substr($path, -1) != '/' ? '/' : '');
        } else {
            $this->_currentPath = dirname($path) . '/';
        }
        return $this;
    }

_setDestinationFilePath()

_setDestinationFilePath (   $destinationFilePath )

protected

Set path to file where tarball should be placed

Parameters

string

$destinationFilePath

Returns

$this

Definition at line 194 of file Tar.php.

    {
        $this->_destinationFilePath = $destinationFilePath;
        return $this;
    }

_setSkipRoot()

_setSkipRoot (   $skipRoot )

protected

Set option that define ability skip first catalog level.

Parameters

bool

$skipRoot

Returns

$this

Definition at line 169 of file Tar.php.

    {
        $this->_skipRoot = $skipRoot;
        return $this;
    }

_unpackCurrentTar()

_unpackCurrentTar (   $destination )

protected

Read TAR string from file, and unpacked it. Create files and directories information about described in the string.

Parameters

string

$destination

path to file is unpacked

Returns

string[] list of files

Exceptions

Definition at line 389 of file Tar.php.

    {
        $archiveReader = $this->_getReader();
        $list = [];

        while (!$archiveReader->eof()) {
            $header = $this->_extractFileHeader();

            if (!$header) {
                continue;
            }

            $currentFile = $destination . $header['name'];
            $dirname = dirname($currentFile);

            if (in_array($header['type'], ["0", chr(0), ''])) {
                if (!file_exists($dirname)) {
                    $mkdirResult = @mkdir($dirname, 0777, true);

                    if (false === $mkdirResult) {
                        throw new \Magento\Framework\Exception\LocalizedException(
                            new \Magento\Framework\Phrase('Failed to create directory %1', [$dirname])
                        );
                    }
                }

                $this->_extractAndWriteFile($header, $currentFile);
                $list[] = $currentFile;
            } elseif ($header['type'] == '5') {
                if (!file_exists($dirname)) {
                    $mkdirResult = @mkdir($currentFile, $header['mode'], true);

                    if (false === $mkdirResult) {
                        throw new \Magento\Framework\Exception\LocalizedException(
                            new \Magento\Framework\Phrase('Failed to create directory %1', [$currentFile])
                        );
                    }
                }
                $list[] = $currentFile . '/';
            } elseif ($header['type'] == '2') {
                //we do not interrupt unpack process if symlink creation failed as symlinks are not so important
                @symlink($header['symlink'], $currentFile);
            }
        }
        return $list;
    }

extract()

extract	(		$file,
			$source,
			$destination
	)

Extract one file from TAR (Tape Archiver).

Parameters

string	$file
string	$source
string	$destination

Returns

string

Definition at line 568 of file Tar.php.

    {
        $this->_setCurrentFile($source);
        $this->_initReader();

        $archiveReader = $this->_getReader();
        $extractedFile = '';

        while (!$archiveReader->eof()) {
            $header = $this->_extractFileHeader();
            if ($header['name'] == $file) {
                $extractedFile = $destination . basename($header['name']);
                $this->_extractAndWriteFile($header, $extractedFile);
                break;
            }

            if ($header['type'] != 5) {
                $skipBytes = floor(
                    ($header['size'] + self::TAR_BLOCK_SIZE - 1) / self::TAR_BLOCK_SIZE
                ) * self::TAR_BLOCK_SIZE;
                $archiveReader->read($skipBytes);
            }
        }

        $this->_destroyReader();
        return $extractedFile;
    }

pack()

pack	(		$source,
			$destination,
			$skipRoot = false
	)

Pack file to TAR (Tape Archiver).

Parameters

string	$source
string	$destination
bool	$skipRoot

Returns

string @SuppressWarnings(PHPMD.UnusedLocalVariable)

Definition at line 529 of file Tar.php.

    {
        $this->_setSkipRoot($skipRoot);
        $source = realpath($source);
        $tarData = $this->_setCurrentPath($source)->_setDestinationFilePath($destination)->_setCurrentFile($source);

        $this->_initWriter();
        $this->_createTar($skipRoot, true);
        $this->_destroyWriter();

        return $destination;
    }

unpack()

unpack	(		$source,
			$destination
	)

Unpack file from TAR (Tape Archiver).

Parameters

string	$source
string	$destination

Returns

string

Implements ArchiveInterface.

Definition at line 549 of file Tar.php.

    {
        $this->_setCurrentFile($source)->_setCurrentPath($source);

        $this->_initReader();
        $this->_unpackCurrentTar($destination);
        $this->_destroyReader();

        return $destination;
    }

Field Documentation

$_currentFile

$_currentFile

protected

Definition at line 30 of file Tar.php.

$_currentPath

$_currentPath

protected

Definition at line 37 of file Tar.php.

$_destinationFilePath

$_destinationFilePath

protected

Definition at line 66 of file Tar.php.

$_reader

$_reader

protected

Definition at line 59 of file Tar.php.

$_skipRoot

$_skipRoot

protected

Definition at line 45 of file Tar.php.

$_writer

$_writer

protected

Definition at line 52 of file Tar.php.

TAR_BLOCK_SIZE

const TAR_BLOCK_SIZE = 512

Tar block size

@const int

Definition at line 23 of file Tar.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Archive/Tar.php