Collaboration diagram for ZipStream\File:

Public Member Functions
	__construct (ZipStream $zip, string $name, ?FileOptions $opt=null)

	processPath (string $path)

	processData (string $data)

	addFileHeader ()
	Create and send zip header for this file. More...

	addFileFooter ()
	Create and send data descriptor footer for this file. More...

	processStream (StreamInterface $stream)

	getCdrFile ()
	Send CDR record for specified file. More...

	getTotalLength ()

Static Public Member Functions
static	filterFilename (string $filename)
	Strip characters that are not legal in Windows filenames to prevent compatibility issues. More...

Data Fields
const	HASH_ALGORITHM = 'crc32b'

const	BIT_ZERO_HEADER = 0x0008

const	BIT_EFS_UTF8 = 0x0800

const	COMPUTE = 1

const	SEND = 2

	$name

	$opt

	$len

	$zlen

	$crc

	$hlen

	$ofs

	$bits

	$version

	$zip

Protected Member Functions
	buildZip64ExtraBlock (bool $force=false)

	processStreamWithZeroHeader (StreamInterface $stream)

	readStream (StreamInterface $stream, ?int $options=null)

	deflateInit ()

	deflateData (StreamInterface $stream, string &$data, ?int $options=null)

	deflateFinish (?int $options=null)

	processStreamWithComputedHeader (StreamInterface $stream)

Static Protected Member Functions
static	dosTime (int $when)
	Convert a UNIX timestamp to a DOS timestamp. More...

Private Attributes
const	CHUNKED_READ_BLOCK_SIZE = 1048576

	$deflate

	$hash

	$method

	$totalLength

Detailed Description

Definition at line 15 of file File.php.

Constructor & Destructor Documentation

◆ __construct()

ZipStream\File::__construct	(	ZipStream	$zip,
		string	$name,
		?FileOptions	$opt = `null`
	)

Definition at line 93 of file File.php.

    {
        $this->zip = $zip;
 
        $this->name = $name;
        $this->opt = $opt ?: new FileOptions();
        $this->method = $this->opt->getMethod();
        $this->version = Version::STORE();
        $this->ofs = new Bigint();
    }

References $name.

Member Function Documentation

◆ addFileFooter()

ZipStream\File::addFileFooter ( )

Create and send data descriptor footer for this file.

Returns: void

Definition at line 303 of file File.php.

                                   : void
    {
 
        if ($this->bits & self::BIT_ZERO_HEADER) {
            // compressed and uncompressed size
            $sizeFormat = 'V';
            if ($this->zip->opt->isEnableZip64()) {
                $sizeFormat = 'P';
            }
            $fields = [
                ['V', ZipStream::DATA_DESCRIPTOR_SIGNATURE],
                ['V', $this->crc],              // CRC32
                [$sizeFormat, $this->zlen],     // Length of compressed data
                [$sizeFormat, $this->len],      // Length of original data
            ];
 
            $footer = ZipStream::packFields($fields);
            $this->zip->send($footer);
        } else {
            $footer = '';
        }
        $this->totalLength = $this->hlen->add($this->zlen)->add(Bigint::init(strlen($footer)));
        $this->zip->addToCdr($this);
    }

References init().

Here is the call graph for this function:

◆ addFileHeader()

ZipStream\File::addFileHeader ( )

Create and send zip header for this file.

Returns: void

Exceptions

ZipStream\Exception\EncodingException

Definition at line 146 of file File.php.

                                   : void
    {
        $name = static::filterFilename($this->name);
 
        // calculate name length
        $nameLength = strlen($name);
 
        // create dos timestamp
        $time = static::dosTime($this->opt->getTime()->getTimestamp());
 
        $comment = $this->opt->getComment();
 
        if (!mb_check_encoding($name, 'ASCII') ||
            !mb_check_encoding($comment, 'ASCII')) {
            // Sets Bit 11: Language encoding flag (EFS).  If this bit is set,
            // the filename and comment fields for this file
            // MUST be encoded using UTF-8. (see APPENDIX D)
            if (!mb_check_encoding($name, 'UTF-8') ||
                !mb_check_encoding($comment, 'UTF-8')) {
                throw new EncodingException(
                    'File name and comment should use UTF-8 ' .
                    'if one of them does not fit into ASCII range.'
                );
            }
            $this->bits |= self::BIT_EFS_UTF8;
        }
 
        if ($this->method->equals(Method::DEFLATE())) {
            $this->version = Version::DEFLATE();
        }
 
        $force = (boolean)($this->bits & self::BIT_ZERO_HEADER) &&
            $this->zip->opt->isEnableZip64();
 
        $footer = $this->buildZip64ExtraBlock($force);
 
        // If this file will start over 4GB limit in ZIP file,
        // CDR record will have to use Zip64 extension to describe offset
        // to keep consistency we use the same value here
        if ($this->zip->ofs->isOver32()) {
            $this->version = Version::ZIP64();
        }
 
        $fields = [
            ['V', ZipStream::FILE_HEADER_SIGNATURE],
            ['v', $this->version->getValue()],      // Version needed to Extract
            ['v', $this->bits],                     // General purpose bit flags - data descriptor flag set
            ['v', $this->method->getValue()],       // Compression method
            ['V', $time],                           // Timestamp (DOS Format)
            ['V', $this->crc],                      // CRC32 of data (0 -> moved to data descriptor footer)
            ['V', $this->zlen->getLowFF($force)],   // Length of compressed data (forced to 0xFFFFFFFF for zero header)
            ['V', $this->len->getLowFF($force)],    // Length of original data (forced to 0xFFFFFFFF for zero header)
            ['v', $nameLength],                     // Length of filename
            ['v', strlen($footer)],                 // Extra data (see above)
        ];
 
        // pack fields and calculate "total" length
        $header = ZipStream::packFields($fields);
 
        // print header and filename
        $data = $header . $name . $footer;
        $this->zip->send($data);
 
        // save header length
        $this->hlen = Bigint::init(strlen($data));
    }

References $comment, $data, $header, $name, $time, and init().

Here is the call graph for this function:

◆ buildZip64ExtraBlock()

ZipStream\File::buildZip64ExtraBlock ( bool $force = false )

protected

Definition at line 265 of file File.php.

                                                                : string
    {
 
        $fields = [];
        if ($this->len->isOver32($force)) {
            $fields[] = ['P', $this->len];          // Length of original data
        }
 
        if ($this->len->isOver32($force)) {
            $fields[] = ['P', $this->zlen];         // Length of compressed data
        }
 
        if ($this->ofs->isOver32()) {
            $fields[] = ['P', $this->ofs];          // Offset of local header record
        }
 
        if (!empty($fields)) {
            if (!$this->zip->opt->isEnableZip64()) {
                throw new OverflowException();
            }
 
            array_unshift(
                $fields,
                ['v', 0x0001],                      // 64 bit extension
                ['v', count($fields) * 8]             // Length of data block
            );
            $this->version = Version::ZIP64();
        }
 
        return ZipStream::packFields($fields);
    }

◆ deflateData()

ZipStream\File::deflateData	(	StreamInterface	$stream,
		string &	$data,
		?int	$options = `null`
	)

protected

Definition at line 378 of file File.php.

                                                                                                : void
    {
        if ($options & self::COMPUTE) {
            $this->len = $this->len->add(Bigint::init(strlen($data)));
            hash_update($this->hash, $data);
        }
        if ($this->deflate) {
            $data = deflate_add(
                $this->deflate,
                $data,
                $stream->eof()
                    ? ZLIB_FINISH
                    : ZLIB_NO_FLUSH
            );
        }
        if ($options & self::COMPUTE) {
            $this->zlen = $this->zlen->add(Bigint::init(strlen($data)));
        }
    }

References $data, PHPMailer\PHPMailer\$options, GuzzleHttp\Psr7\$stream, GuzzleHttp\Psr7\hash(), and init().

Here is the call graph for this function:

◆ deflateFinish()

ZipStream\File::deflateFinish ( ?int $options = null )

protected

Definition at line 398 of file File.php.

                                                          : void
    {
        if ($options & self::COMPUTE) {
            $this->crc = hexdec(hash_final($this->hash));
        }
    }

References PHPMailer\PHPMailer\$options, and GuzzleHttp\Psr7\hash().

Here is the call graph for this function:

◆ deflateInit()

ZipStream\File::deflateInit ( )

protected

Definition at line 367 of file File.php.

                                    : void
    {
        $this->hash = hash_init(self::HASH_ALGORITHM);
        if ($this->method->equals(Method::DEFLATE())) {
            $this->deflate = deflate_init(
                ZLIB_ENCODING_RAW,
                ['level' => $this->opt->getDeflateLevel()]
            );
        }
    }

References GuzzleHttp\Psr7\hash().

Here is the call graph for this function:

◆ dosTime()

static ZipStream\File::dosTime ( int $when )

staticfinalprotected

Convert a UNIX timestamp to a DOS timestamp.

Parameters

int $when

Returns: int DOS Timestamp

Definition at line 235 of file File.php.

                                                      : int
    {
        // get date array for timestamp
        $d = getdate($when);
 
        // set lower-bound on dates
        if ($d['year'] < 1980) {
            $d = array(
                'year' => 1980,
                'mon' => 1,
                'mday' => 1,
                'hours' => 0,
                'minutes' => 0,
                'seconds' => 0
            );
        }
 
        // remove extra years from 1980
        $d['year'] -= 1980;
 
        // return date string
        return
            ($d['year'] << 25) |
            ($d['mon'] << 21) |
            ($d['mday'] << 16) |
            ($d['hours'] << 11) |
            ($d['minutes'] << 5) |
            ($d['seconds'] >> 1);
    }

References $d.

◆ filterFilename()

static ZipStream\File::filterFilename ( string $filename )

static

Strip characters that are not legal in Windows filenames to prevent compatibility issues.

Parameters

string $filename Unprocessed filename

Returns: string

Definition at line 220 of file File.php.

                                                           : string
    {
        // strip leading slashes from file name
        // (fixes bug in windows archive viewer)
        $filename = preg_replace('/^\\/+/', '', $filename);
 
        return str_replace(['\\', ':', '*', '?', '"', '<', '>', '|'], '_', $filename);
    }

References $filename.

◆ getCdrFile()

ZipStream\File::getCdrFile ( )

Send CDR record for specified file.

Returns: string

Definition at line 433 of file File.php.

                                : string
    {
        $name = static::filterFilename($this->name);
 
        // get attributes
        $comment = $this->opt->getComment();
 
        // get dos timestamp
        $time = static::dosTime($this->opt->getTime()->getTimestamp());
 
        $footer = $this->buildZip64ExtraBlock();
 
        $fields = [
            ['V', ZipStream::CDR_FILE_SIGNATURE],   // Central file header signature
            ['v', ZipStream::ZIP_VERSION_MADE_BY],  // Made by version
            ['v', $this->version->getValue()],      // Extract by version
            ['v', $this->bits],                     // General purpose bit flags - data descriptor flag set
            ['v', $this->method->getValue()],       // Compression method
            ['V', $time],                           // Timestamp (DOS Format)
            ['V', $this->crc],                      // CRC32
            ['V', $this->zlen->getLowFF()],         // Compressed Data Length
            ['V', $this->len->getLowFF()],          // Original Data Length
            ['v', strlen($name)],                   // Length of filename
            ['v', strlen($footer)],                 // Extra data len (see above)
            ['v', strlen($comment)],                // Length of comment
            ['v', 0],                               // Disk number
            ['v', 0],                               // Internal File Attributes
            ['V', 32],                              // External File Attributes
            ['V', $this->ofs->getLowFF()]           // Relative offset of local header
        ];
 
        // pack fields, then append name and comment
        $header = ZipStream::packFields($fields);
 
        return $header . $name . $footer . $comment;
    }

References $comment, $header, $name, and $time.

Referenced by ZipStream\ZipStream\addToCdr().

Here is the caller graph for this function:

◆ getTotalLength()

ZipStream\File::getTotalLength ( )

Returns: Bigint

Definition at line 473 of file File.php.

                                    : Bigint
    {
        return $this->totalLength;
    }

Referenced by ZipStream\ZipStream\addToCdr().

Here is the caller graph for this function:

◆ processData()

ZipStream\File::processData ( string $data )

Definition at line 124 of file File.php.

                                             : void
    {
        $this->len = new Bigint(strlen($data));
        $this->crc = crc32($data);
 
        // compress data if needed
        if ($this->method->equals(Method::DEFLATE())) {
            $data = gzdeflate($data);
        }
 
        $this->zlen = new Bigint(strlen($data));
        $this->addFileHeader();
        $this->zip->send($data);
        $this->addFileFooter();
    }

References $data.

◆ processPath()

ZipStream\File::processPath ( string $path )

Definition at line 104 of file File.php.

                                             : void
    {
        if (!is_readable($path)) {
            if (!file_exists($path)) {
                throw new FileNotFoundException($path);
            }
            throw new FileNotReadableException($path);
        }
        if ($this->zip->isLargeFile($path) === false) {
            $data = file_get_contents($path);
            $this->processData($data);
        } else {
            $this->method = $this->zip->opt->getLargeFileMethod();
 
            $stream = new DeflateStream(fopen($path, 'rb'));
            $this->processStream($stream);
            $stream->close();
        }
    }

References $data, $path, and GuzzleHttp\Psr7\$stream.

◆ processStream()

ZipStream\File::processStream ( StreamInterface $stream )

Definition at line 328 of file File.php.

                                                          : void
    {
        $this->zlen = new Bigint();
        $this->len = new Bigint();
 
        if ($this->zip->opt->isZeroHeader()) {
            $this->processStreamWithZeroHeader($stream);
        } else {
            $this->processStreamWithComputedHeader($stream);
        }
    }

References GuzzleHttp\Psr7\$stream.

◆ processStreamWithComputedHeader()

ZipStream\File::processStreamWithComputedHeader ( StreamInterface $stream )

protected

Definition at line 405 of file File.php.

                                                                               : void
    {
        $this->readStream($stream, self::COMPUTE);
        $stream->rewind();
 
        // incremental compression with deflate_add
        // makes this second read unnecessary
        // but it is only available from PHP 7.0
        if (!$this->deflate && $stream instanceof DeflateStream && $this->method->equals(Method::DEFLATE())) {
            $stream->addDeflateFilter($this->opt);
            $this->zlen = new Bigint();
            while (!$stream->eof()) {
                $data = $stream->read(self::CHUNKED_READ_BLOCK_SIZE);
                $this->zlen = $this->zlen->add(Bigint::init(strlen($data)));
            }
            $stream->rewind();
        }
 
        $this->addFileHeader();
        $this->readStream($stream, self::SEND);
        $this->addFileFooter();
    }

References $data, GuzzleHttp\Psr7\$stream, and init().

Here is the call graph for this function:

◆ processStreamWithZeroHeader()

ZipStream\File::processStreamWithZeroHeader ( StreamInterface $stream )

protected

Definition at line 340 of file File.php.

                                                                           : void
    {
        $this->bits |= self::BIT_ZERO_HEADER;
        $this->addFileHeader();
        $this->readStream($stream, self::COMPUTE | self::SEND);
        $this->addFileFooter();
    }

References GuzzleHttp\Psr7\$stream.

◆ readStream()

ZipStream\File::readStream	(	StreamInterface	$stream,
		?int	$options = `null`
	)

protected

Definition at line 348 of file File.php.

                                                                                : void
    {
        $this->deflateInit();
        $total = 0;
        $size = $this->opt->getSize();
        while (!$stream->eof() && ($size === 0 || $total < $size)) {
            $data = $stream->read(self::CHUNKED_READ_BLOCK_SIZE);
            $total += strlen($data);
            if ($size > 0 && $total > $size) {
                $data = substr($data, 0 , strlen($data)-($total - $size));
            }
            $this->deflateData($stream, $data, $options);
            if ($options & self::SEND) {
                $this->zip->send($data);
            }
        }
        $this->deflateFinish($options);
    }

References $data, PHPMailer\PHPMailer\$options, $size, GuzzleHttp\Psr7\$stream, and $total.

Field Documentation

◆ $bits

ZipStream\File::$bits

Definition at line 62 of file File.php.

◆ $crc

ZipStream\File::$crc

Definition at line 47 of file File.php.

◆ $deflate

ZipStream\File::$deflate

private

Definition at line 77 of file File.php.

◆ $hash

ZipStream\File::$hash

private

Definition at line 81 of file File.php.

◆ $hlen

ZipStream\File::$hlen

Definition at line 52 of file File.php.

◆ $len

ZipStream\File::$len

Definition at line 40 of file File.php.

◆ $method

ZipStream\File::$method

private

Definition at line 86 of file File.php.

◆ $name

ZipStream\File::$name

Definition at line 30 of file File.php.

◆ $ofs

ZipStream\File::$ofs

Definition at line 57 of file File.php.

◆ $opt

ZipStream\File::$opt

Definition at line 35 of file File.php.

◆ $totalLength

ZipStream\File::$totalLength

private

Definition at line 91 of file File.php.

◆ $version

ZipStream\File::$version

Definition at line 67 of file File.php.

◆ $zip

ZipStream\File::$zip

Definition at line 72 of file File.php.

◆ $zlen

ZipStream\File::$zlen

Definition at line 44 of file File.php.

◆ BIT_EFS_UTF8

const ZipStream\File::BIT_EFS_UTF8 = 0x0800

Definition at line 20 of file File.php.

◆ BIT_ZERO_HEADER

const ZipStream\File::BIT_ZERO_HEADER = 0x0008

Definition at line 19 of file File.php.

◆ CHUNKED_READ_BLOCK_SIZE

const ZipStream\File::CHUNKED_READ_BLOCK_SIZE = 1048576

private

Definition at line 25 of file File.php.

◆ COMPUTE

const ZipStream\File::COMPUTE = 1

Definition at line 22 of file File.php.

◆ HASH_ALGORITHM

const ZipStream\File::HASH_ALGORITHM = 'crc32b'

Definition at line 17 of file File.php.

◆ SEND

const ZipStream\File::SEND = 2

Definition at line 23 of file File.php.

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

libs/composer/vendor/maennchen/zipstream-php/src/File.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFileFooter()

◆ addFileHeader()

◆ buildZip64ExtraBlock()

◆ deflateData()

◆ deflateFinish()

◆ deflateInit()

◆ dosTime()

◆ filterFilename()

◆ getCdrFile()

◆ getTotalLength()

◆ processData()

◆ processPath()

◆ processStream()

◆ processStreamWithComputedHeader()

◆ processStreamWithZeroHeader()

◆ readStream()

Field Documentation

◆ $bits

◆ $crc

◆ $deflate

◆ $hash

◆ $hlen

◆ $len

◆ $method

◆ $name

◆ $ofs

◆ $opt

◆ $totalLength

◆ $version

◆ $zip

◆ $zlen

◆ BIT_EFS_UTF8

◆ BIT_ZERO_HEADER

◆ CHUNKED_READ_BLOCK_SIZE

◆ COMPUTE

◆ HASH_ALGORITHM

◆ SEND