ILIAS\Filesystem\Util\Archive\Zip Class Reference

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

Public Member Functions
	__construct (protected ZipOptions $options,... $streams)
	get ()
	addPath (string $path, ?string $path_inside_zip=null)
	addStream (FileStream $stream, string $path_inside_zip)

Data Fields
const	DOT_EMPTY = '.empty'

Protected Attributes
ZipArchive	$zip

Private Member Functions
	buildTempPath ()
	registerShutdownFunction (\Closure $c)
	storeZIPtoFilesystem ()

Private Attributes
string	$zip_output_file = ''
int	$iteration_limit
int	$store_counter = 1
int	$path_counter = 1
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,
			$streams
	)

Definition at line 46 of file Zip.php.

References ILIAS\Filesystem\Util\Archive\Zip\buildTempPath(), ILIAS\Filesystem\Util\Archive\ZipOptions\getZipOutputName(), ILIAS\Filesystem\Util\Archive\ZipOptions\getZipOutputPath(), ILIAS\Repository\int(), null, and ILIAS\Filesystem\Util\Archive\Zip\registerShutdownFunction().

      {
        $this->streams = array_filter($streams, fn($stream): bool => $stream instanceof FileStream);

        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 {
                if (file_exists($this->zip_output_file)) {
                    unlink($this->zip_output_file);
                }
            });
        }
        $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);
        }
        if ($this->zip->open($this->zip_output_file, \ZipArchive::OVERWRITE) !== true) {
            throw new \Exception("cannot open <$this->zip_output_file>\n");
        }
    }

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 147 of file Zip.php.

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

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

                                                                          : void
    {
        $path_inside_zip ??= basename($path);

        // 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
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addStream()

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

Definition at line 160 of file Zip.php.

References Vendor\Package\$d, ILIAS\Filesystem\Util\Archive\Zip\addPath(), null, and ILIAS\Filesystem\Util\Archive\Zip\storeZIPtoFilesystem().

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

                                                                          : void
    {
        // we remove the "empty zip file" now if possible
        if (count($this->streams) === 1 && 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 * 0.9)
        ) {
            $this->storeZIPtoFilesystem();
            $this->streams = [];
            $this->path_counter = 0;
        } else {
            $this->path_counter++;
        }
    }

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 80 of file Zip.php.

References CLIENT_DATA_DIR.

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

                                    : 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;
    }

Here is the caller graph for this function:

get()

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

(

)

Definition at line 132 of file Zip.php.

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

                         : Stream
    {
        $this->storeZIPtoFilesystem();

        $this->zip->close();

        return Streams::ofResource(fopen($this->zip_output_file, 'rb'));
    }

Here is the call graph for this function:

registerShutdownFunction()

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

private

Definition at line 94 of file Zip.php.

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

                                                          : void
    {
        register_shutdown_function($c);
    }

Here is the caller graph for this function:

storeZIPtoFilesystem()

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

private

Definition at line 99 of file Zip.php.

References $path.

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

                                           : void
    {
        foreach ($this->streams as $path_inside_zip => $stream) {
            $path = $stream->getMetadata('uri');
            if ($this->store_counter === 0) {
                $this->zip->open($this->zip_output_file);
            }
            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 * 0.9)
            ) {
                $this->zip->close();
                $this->store_counter = 0;
            } else {
                $this->store_counter++;
            }
        }
    }

Here is the caller graph for this function:

Field Documentation

$iteration_limit

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

private

Definition at line 37 of file Zip.php.

$path_counter

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

private

Definition at line 39 of file Zip.php.

$store_counter

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

private

Definition at line 38 of file Zip.php.

$streams

array ILIAS\Filesystem\Util\Archive\Zip::$streams

private

Definition at line 44 of file Zip.php.

$zip

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

protected

Definition at line 36 of file Zip.php.

$zip_output_file

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

private

Definition at line 35 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().

---

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

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