Collaboration diagram for ILIAS\Filesystem\Util\Archive\Zip:

Public Member Functions
	__construct (protected ZipOptions $options, FileStream ... $streams)

	get ()

	destroy ()
	@description Explicitly close the zip file and remove the file from the filesystem. More...

	addPath (string $path, ?string $path_inside_zip=null)

	addStream (FileStream $stream, string $path_inside_zip)

Data Fields
const	DOT_EMPTY = '.empty'

const	ITERATION_FACTOR = 0.9

Protected Attributes
ZipArchive	$zip

Private Member Functions
	maybeOpenZip (int $flags=0)

	buildTempPath ()

	registerShutdownFunction (\Closure $c)

	storeZIPtoFilesystem ()

Private Attributes
string	$zip_output_file = ''

int	$iteration_limit

int	$store_counter = 1

int	$path_counter = 1

bool	$zip_opened = false

array	$streams = []

Detailed Description

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 30 of file Zip.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Filesystem\Util\Archive\Zip::__construct	(	protected ZipOptions	$options,
		FileStream ...	$streams
	)

Definition at line 49 of file Zip.php.

      {
        if ($options->getZipOutputPath() !== null && $options->getZipOutputName() !== null) {
            $this->zip_output_file = $this->ensureDirectorySeperator(
                $options->getZipOutputPath()
            ) . $options->getZipOutputName();
        } else {
            $this->zip_output_file = $this->buildTempPath();
            $this->registerShutdownFunction(function (): void {
                $this->destroy();
            });
        }
        $system_limit = (int) shell_exec('ulimit -n') ?: 0;
 
        $this->iteration_limit = $system_limit < 10 ? 100 : min(
            $system_limit / 2,
            5000
        );
 
        $this->zip = new \ZipArchive();
        if (!file_exists($this->zip_output_file)) {
            touch($this->zip_output_file);
        }
 
        $this->maybeOpenZip(\ZipArchive::OVERWRITE);
        foreach ($streams as $path_inside_zip => $stream) {
            $path_inside_zip = is_int($path_inside_zip) ? basename((string) $stream->getMetadata('uri')) : $path_inside_zip;
            $this->addStream($stream, basename($path_inside_zip));
        }
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, ILIAS\Filesystem\Util\Archive\Zip\$streams, ILIAS\Filesystem\Util\Archive\Zip\addStream(), ILIAS\Filesystem\Util\Archive\Zip\buildTempPath(), ILIAS\Filesystem\Util\Archive\Zip\destroy(), ILIAS\Repository\int(), ILIAS\Filesystem\Util\Archive\Zip\maybeOpenZip(), and ILIAS\Filesystem\Util\Archive\Zip\registerShutdownFunction().

Here is the call graph for this function:

Member Function Documentation

◆ addPath()

ILIAS\Filesystem\Util\Archive\Zip::addPath	(	string	$path,
		?string	$path_inside_zip = `null`
	)

Deprecated:: in general, it should be avoided to operate with correct paths in the file system. it is also usually not necessary to zip whole directories, as a ZIP can be seen as an "on-the-fly" compilation of different streams. However, since ILIAS still relies on zipping entire directories in many places, this method is still offered for the moment.

Definition at line 178 of file Zip.php.

                                                                          : void
    {
        $path_inside_zip ??= basename($path);
 
        $this->maybeOpenZip();
 
        // create directory if it does not exist
        $this->zip->addEmptyDir(rtrim(dirname($path_inside_zip), '/') . '/');
 
        $this->addStream(
            Streams::ofResource(fopen($path, 'rb')),
            $path_inside_zip
        );
    }

References $path, ILIAS\Filesystem\Util\Archive\Zip\addStream(), ILIAS\Filesystem\Util\Archive\Zip\maybeOpenZip(), and ILIAS\Filesystem\Stream\Streams\ofResource().

Here is the call graph for this function:

◆ addStream()

ILIAS\Filesystem\Util\Archive\Zip::addStream	(	FileStream	$stream,
		string	$path_inside_zip
	)

Definition at line 193 of file Zip.php.

                                                                          : void
    {
        // we remove the "empty zip file" now if possible
        if (isset($this->streams[self::DOT_EMPTY])) {
            unset($this->streams[self::DOT_EMPTY]);
        }
 
        // we must store the ZIP to e temporary files every 1000 files, otherwise we will get a Too Many Open Files error
        $this->streams[$path_inside_zip] = $stream;
 
        if (
            $this->path_counter === $this->iteration_limit
            || count(get_resources('stream')) > ($this->iteration_limit * self::ITERATION_FACTOR)
        ) {
            $this->storeZIPtoFilesystem();
            $this->streams = [];
            $this->path_counter = 0;
        } else {
            $this->path_counter++;
        }
    }

References ILIAS\Filesystem\Util\Archive\Zip\storeZIPtoFilesystem().

Referenced by ILIAS\Filesystem\Util\Archive\Zip\__construct(), and ILIAS\Filesystem\Util\Archive\Zip\addPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTempPath()

ILIAS\Filesystem\Util\Archive\Zip::buildTempPath ( )

private

Definition at line 96 of file Zip.php.

                                    : string
    {
        $directory = defined('CLIENT_DATA_DIR') ? \CLIENT_DATA_DIR . '/temp' : sys_get_temp_dir();
        $tempnam = tempnam($directory, 'zip');
        if (is_file($tempnam)) {
            return $tempnam;
        }
        if (is_dir($tempnam)) {
            rmdir($tempnam);
            touch($tempnam);
        }
        return $tempnam;
    }

References CLIENT_DATA_DIR.

Referenced by ILIAS\Filesystem\Util\Archive\Zip\__construct().

Here is the caller graph for this function:

◆ destroy()

ILIAS\Filesystem\Util\Archive\Zip::destroy ( )

@description Explicitly close the zip file and remove the file from the filesystem.

In general, temp files are deleted whyle destroying the object. but in cases like migrations, you should call this method explicitly. Please note that also explicitly set paths (non-temp) are deleted if you call this method.

Definition at line 165 of file Zip.php.

                             : void
    {
        if (file_exists($this->zip_output_file)) {
            unlink($this->zip_output_file);
        }
    }

Referenced by ILIAS\Filesystem\Util\Archive\Zip\__construct().

Here is the caller graph for this function:

◆ get()

ILIAS\Filesystem\Util\Archive\Zip::get ( )

Definition at line 149 of file Zip.php.

                         : Stream
    {
        $this->maybeOpenZip();
        $this->storeZIPtoFilesystem();
 
        $this->zip->close();
        $this->zip_opened = false;
 
        return Streams::ofResource(fopen($this->zip_output_file, 'rb'));
    }

References ILIAS\Filesystem\Util\Archive\Zip\maybeOpenZip(), ILIAS\Filesystem\Stream\Streams\ofResource(), and ILIAS\Filesystem\Util\Archive\Zip\storeZIPtoFilesystem().

Here is the call graph for this function:

◆ maybeOpenZip()

ILIAS\Filesystem\Util\Archive\Zip::maybeOpenZip ( int $flags = 0 )

private

Definition at line 82 of file Zip.php.

                                                 : void
    {
        if (!$this->zip_opened) {
            if ($flags === 0) {
                $this->zip_opened = $this->zip->open($this->zip_output_file) === true;
            } else {
                $this->zip_opened = $this->zip->open($this->zip_output_file, $flags) === true;
            }
        }
        if (!$this->zip_opened) {
            throw new \Exception("cannot open <$this->zip_output_file>\n");
        }
    }

Referenced by ILIAS\Filesystem\Util\Archive\Zip\__construct(), ILIAS\Filesystem\Util\Archive\Zip\addPath(), ILIAS\Filesystem\Util\Archive\Zip\get(), and ILIAS\Filesystem\Util\Archive\Zip\storeZIPtoFilesystem().

Here is the caller graph for this function:

◆ registerShutdownFunction()

ILIAS\Filesystem\Util\Archive\Zip::registerShutdownFunction ( \Closure $c )

private

Definition at line 110 of file Zip.php.

                                                          : void
    {
        register_shutdown_function($c);
    }

References $c.

Referenced by ILIAS\Filesystem\Util\Archive\Zip\__construct().

Here is the caller graph for this function:

◆ storeZIPtoFilesystem()

ILIAS\Filesystem\Util\Archive\Zip::storeZIPtoFilesystem ( )

private

Definition at line 115 of file Zip.php.

                                           : void
    {
        foreach ($this->streams as $path_inside_zip => $stream) {
            $path = $stream->getMetadata('uri');
            if ($this->store_counter === 0) {
                $this->maybeOpenZip();
            }
            if (is_int($path_inside_zip)) {
                $path_inside_zip = basename((string) $path);
            }
 
            if ($path === 'php://memory') {
                $this->zip->addFromString($path_inside_zip, (string) $stream);
                $stream->close();
            } elseif (is_file($path)) {
                $this->zip->addFile($path, $path_inside_zip);
                $stream->close();
            } else {
                continue;
            }
 
            if (
                $this->store_counter === $this->iteration_limit
                || count(get_resources('stream')) > ($this->iteration_limit * self::ITERATION_FACTOR)
            ) {
                $this->zip->close();
                $this->zip_opened = false;
                $this->store_counter = 0;
            } else {
                $this->store_counter++;
            }
        }
    }

References $path, and ILIAS\Filesystem\Util\Archive\Zip\maybeOpenZip().

Referenced by ILIAS\Filesystem\Util\Archive\Zip\addStream(), and ILIAS\Filesystem\Util\Archive\Zip\get().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $iteration_limit

int ILIAS\Filesystem\Util\Archive\Zip::$iteration_limit

private

Definition at line 38 of file Zip.php.

◆ $path_counter

int ILIAS\Filesystem\Util\Archive\Zip::$path_counter = 1

private

Definition at line 40 of file Zip.php.

◆ $store_counter

int ILIAS\Filesystem\Util\Archive\Zip::$store_counter = 1

private

Definition at line 39 of file Zip.php.

◆ $streams

array ILIAS\Filesystem\Util\Archive\Zip::$streams = []

private

Definition at line 47 of file Zip.php.

Referenced by ILIAS\Filesystem\Util\Archive\Zip\__construct().

◆ $zip

ZipArchive ILIAS\Filesystem\Util\Archive\Zip::$zip

protected

Definition at line 37 of file Zip.php.

◆ $zip_opened

bool ILIAS\Filesystem\Util\Archive\Zip::$zip_opened = false

private

Definition at line 42 of file Zip.php.

◆ $zip_output_file

string ILIAS\Filesystem\Util\Archive\Zip::$zip_output_file = ''

private

Definition at line 36 of file Zip.php.

◆ DOT_EMPTY

const ILIAS\Filesystem\Util\Archive\Zip::DOT_EMPTY = '.empty'

Definition at line 34 of file Zip.php.

Referenced by ILIAS\Filesystem\Util\Archive\Archives\zip().

◆ ITERATION_FACTOR

const ILIAS\Filesystem\Util\Archive\Zip::ITERATION_FACTOR = 0.9

Definition at line 35 of file Zip.php.

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

components/ILIAS/Filesystem/src/Util/Archive/Zip.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPath()

◆ addStream()

◆ buildTempPath()

◆ destroy()

◆ get()

◆ maybeOpenZip()

◆ registerShutdownFunction()

◆ storeZIPtoFilesystem()

Field Documentation

◆ $iteration_limit

◆ $path_counter

◆ $store_counter

◆ $streams

◆ $zip

◆ $zip_opened

◆ $zip_output_file

◆ DOT_EMPTY

◆ ITERATION_FACTOR