ILIAS\Filesystem\Util\Archive\Unzip Class Reference

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

Public Member Functions
	__construct (protected UnzipOptions $options, protected FileStream $stream)
	getPaths ()
	getStreams ()
	getFileStreams ()
	getAmountOfDirectories ()
	getDirectories ()
	Yields the directory-paths of the currently open zip-archive. More...
	getAmountOfFiles ()
	getFiles ()
	Yields the file-paths of the currently open zip-archive. More...
	hasMultipleRootEntriesInZip ()
	extract ()
	hasZipReadingError ()

Data Fields
const	DS_UNIX = "/"
const	DS_WIN = "\\"
const	BASE_DIR = '.'

Protected Member Functions
	pathToStreamGenerator ()

Protected Attributes
const	URI = 'uri'
const	DIRECTORY_SEPARATOR = DIRECTORY_SEPARATOR
ZipArchive	$zip
bool	$error_reading_zip = false
string	$path_to_zip

Private Attributes
int	$amount_of_entries = 0

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 Unzip.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Util\Archive\Unzip::__construct	(	protected UnzipOptions	$options,
		protected FileStream	$stream
	)

Definition at line 44 of file Unzip.php.

      {
        $this->path_to_zip = $this->stream->getMetadata(self::URI);
        $this->zip = new \ZipArchive();
        try {
            $this->zip->open($this->path_to_zip, \ZipArchive::RDONLY);
            $this->amount_of_entries = $this->zip->count();
        } catch (\Throwable) {
            $this->error_reading_zip = true;
        }
    }

Member Function Documentation

extract()

ILIAS\Filesystem\Util\Archive\Unzip::extract

(

)

Definition at line 195 of file Unzip.php.

References $path, ILIAS\Filesystem\Util\Archive\FLAT_STRUCTURE, ILIAS\Filesystem\Util\Archive\Unzip\getPaths(), ILIAS\Filesystem\Util\Archive\Unzip\getStreams(), null, and ILIAS\Filesystem\Util\sanitizeFileName().

                             : bool
    {
        if ($this->error_reading_zip) {
            return false;
        }

        $destination_path = $this->options->getZipOutputPath();
        if ($destination_path === null) {
            return false;
        }

        switch ($this->options->getDirectoryHandling()) {
            case ZipDirectoryHandling::KEEP_STRUCTURE:
                break;
            case ZipDirectoryHandling::ENSURE_SINGLE_TOP_DIR:
                // top directory with same name as the ZIP without suffix
                $zip_path = $this->stream->getMetadata(self::URI);
                $sufix = '.' . pathinfo((string) $zip_path, PATHINFO_EXTENSION);
                $top_directory = basename((string) $zip_path, $sufix);

                // first we check if the ZIP contains the top directory
                $has_top_directory = true;
                foreach ($this->getPaths() as $path) {
                    $has_top_directory = str_starts_with($path, $top_directory) && $has_top_directory;
                }

                // if not, we prepend the top directory to the destination path
                if (!$has_top_directory) {
                    $destination_path .= self::DIRECTORY_SEPARATOR . $top_directory;
                }
                break;
            case ZipDirectoryHandling::FLAT_STRUCTURE:
                if (!is_dir($destination_path) && (!mkdir($destination_path, 0777, true) && !is_dir($destination_path))) {
                    throw new \RuntimeException(sprintf('Directory "%s" was not created', $destination_path));
                }

                foreach ($this->getStreams() as $stream) {
                    $uri = $stream->getMetadata(self::URI);
                    if (substr((string) $uri, -1) === self::DIRECTORY_SEPARATOR) {
                        continue; // Skip directories
                    }
                    $file_name = Util::sanitizeFileName($destination_path . self::DIRECTORY_SEPARATOR . basename((string) $uri));
                    file_put_contents(
                        $file_name,
                        $stream->getContents()
                    );
                }
                return true; // Stop here
        }

        $this->zip->extractTo($destination_path, iterator_to_array($this->getPaths()));

        return true;
    }

Here is the call graph for this function:

getAmountOfDirectories()

ILIAS\Filesystem\Util\Archive\Unzip::getAmountOfDirectories

(

)

Definition at line 112 of file Unzip.php.

References ILIAS\Filesystem\Util\Archive\Unzip\getDirectories().

                                            : int
    {
        return iterator_count($this->getDirectories());
    }

Here is the call graph for this function:

getAmountOfFiles()

ILIAS\Filesystem\Util\Archive\Unzip::getAmountOfFiles

(

)

Definition at line 150 of file Unzip.php.

References ILIAS\Filesystem\Util\Archive\Unzip\getFiles().

                                      : int
    {
        return iterator_count($this->getFiles());
    }

Here is the call graph for this function:

getDirectories()

ILIAS\Filesystem\Util\Archive\Unzip::getDirectories

(

)

Yields the directory-paths of the currently open zip-archive.

This fixes the issue that win and mac zip archives have different directory structures.

Returns

|string[]

Definition at line 122 of file Unzip.php.

References $path, ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ILIAS\Filesystem\Util\Archive\Unzip\getPaths(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by ILIAS\Filesystem\Util\Archive\Unzip\getAmountOfDirectories(), and ILIAS\Filesystem\Util\Archive\Unzip\hasMultipleRootEntriesInZip().

                                    : \Generator
    {
        $directories = [];
        foreach ($this->getPaths() as $path) {
            if (substr($path, -1) === self::DS_UNIX || substr($path, -1) === self::DS_WIN) {
                $directories[] = $path;
                continue;
            }
            if ((str_contains($path, self::DS_UNIX) || str_contains($path, self::DS_WIN))) {
                $directories[] = dirname($path) . self::DIRECTORY_SEPARATOR;
            }
        }

        $directories_with_parents = [];

        foreach ($directories as $directory) {
            $parent = dirname($directory) . self::DIRECTORY_SEPARATOR;
            if ($parent !== self::BASE_DIR . self::DIRECTORY_SEPARATOR && !in_array($parent, $directories, true)) {
                $directories_with_parents[] = $parent;
            }
            $directories_with_parents[] = $directory;
        }

        $directories_with_parents = array_unique($directories_with_parents);
        sort($directories_with_parents);
        yield from $directories_with_parents;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFiles()

ILIAS\Filesystem\Util\Archive\Unzip::getFiles

(

)

Yields the file-paths of the currently open zip-archive.

Returns

|string[]

Definition at line 159 of file Unzip.php.

References $path, ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ILIAS\Filesystem\Util\Archive\Unzip\getPaths(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by ILIAS\Filesystem\Util\Archive\Unzip\getAmountOfFiles(), ILIAS\Filesystem\Util\Archive\Unzip\getFileStreams(), ILIAS\Filesystem\Util\Archive\Unzip\getStreams(), and ILIAS\Filesystem\Util\Archive\Unzip\hasMultipleRootEntriesInZip().

                              : \Generator
    {
        $files = [];
        foreach ($this->getPaths() as $path) {
            if (substr($path, -1) !== self::DS_UNIX && substr($path, -1) !== self::DS_WIN) {
                $files[] = $path;
            }
        }
        sort($files);
        yield from $files;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFileStreams()

ILIAS\Filesystem\Util\Archive\Unzip::getFileStreams

(

)

Returns

|FileStream[]

Definition at line 105 of file Unzip.php.

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ILIAS\Filesystem\Util\Archive\Unzip\getFiles(), and ILIAS\Filesystem\Util\Archive\Unzip\pathToStreamGenerator().

                                    : \Generator
    {
        $paths_to_stream_generator = $this->pathToStreamGenerator();

        yield from $paths_to_stream_generator($this->getFiles());
    }

Here is the call graph for this function:

getPaths()

ILIAS\Filesystem\Util\Archive\Unzip::getPaths

(

)

Returns

<bool|string>

Definition at line 75 of file Unzip.php.

References $path.

Referenced by ILIAS\Filesystem\Util\Archive\Unzip\extract(), ILIAS\Filesystem\Util\Archive\Unzip\getDirectories(), ILIAS\Filesystem\Util\Archive\Unzip\getFiles(), and ILIAS\Filesystem\Util\Archive\Unzip\getStreams().

                              : \Generator
    {
        if (!$this->error_reading_zip) {
            for ($i = 0, $i_max = $this->amount_of_entries; $i < $i_max; $i++) {
                $path = $this->zip->getNameIndex($i, \ZipArchive::FL_UNCHANGED);
                if ($this->isPathIgnored($path, $this->options)) {
                    continue;
                }
                yield $path;
            }
        }
    }

Here is the caller graph for this function:

getStreams()

ILIAS\Filesystem\Util\Archive\Unzip::getStreams

(

)

Returns

|FileStream[]

Definition at line 91 of file Unzip.php.

References ILIAS\Filesystem\Util\Archive\FLAT_STRUCTURE, ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ILIAS\Filesystem\Util\Archive\Unzip\getFiles(), ILIAS\Filesystem\Util\Archive\Unzip\getPaths(), and ILIAS\Filesystem\Util\Archive\Unzip\pathToStreamGenerator().

Referenced by ILIAS\Filesystem\Util\Archive\Unzip\extract().

                                : \Generator
    {
        $paths_to_stream_generator = $this->pathToStreamGenerator();

        if ($this->options->getDirectoryHandling() === ZipDirectoryHandling::FLAT_STRUCTURE) {
            yield from $paths_to_stream_generator($this->getFiles());
        } else {
            yield from $paths_to_stream_generator($this->getPaths());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasMultipleRootEntriesInZip()

ILIAS\Filesystem\Util\Archive\Unzip::hasMultipleRootEntriesInZip

(

)

Definition at line 171 of file Unzip.php.

References ILIAS\Filesystem\Util\Archive\Unzip\getDirectories(), and ILIAS\Filesystem\Util\Archive\Unzip\getFiles().

                                                 : bool
    {
        $amount = 0;
        foreach ($this->getDirectories() as $zip_directory) {
            $dirname = dirname($zip_directory);
            if ($dirname === self::BASE_DIR) {
                $amount++;
            }
            if ($amount > 1) {
                return true;
            }
        }
        foreach ($this->getFiles() as $zip_file) {
            $dirname = dirname($zip_file);
            if ($dirname === self::BASE_DIR) {
                $amount++;
            }
            if ($amount > 1) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

hasZipReadingError()

ILIAS\Filesystem\Util\Archive\Unzip::hasZipReadingError

(

)

Definition at line 250 of file Unzip.php.

References ILIAS\Filesystem\Util\Archive\Unzip\$error_reading_zip.

                                        : bool
    {
        return $this->error_reading_zip;
    }

pathToStreamGenerator()

ILIAS\Filesystem\Util\Archive\Unzip::pathToStreamGenerator ( )

protected

Returns

Definition at line 61 of file Unzip.php.

References $path.

Referenced by ILIAS\Filesystem\Util\Archive\Unzip\getFileStreams(), and ILIAS\Filesystem\Util\Archive\Unzip\getStreams().

                                              : \Closure
    {
        return function (\Generator $paths): \Generator {
            foreach ($paths as $path) {
                $resource = $this->zip->getStream($path);

                yield Streams::ofResource($resource);
            }
        };
    }

Here is the caller graph for this function:

Field Documentation

$amount_of_entries

int ILIAS\Filesystem\Util\Archive\Unzip::$amount_of_entries = 0

private

Definition at line 42 of file Unzip.php.

$error_reading_zip

bool ILIAS\Filesystem\Util\Archive\Unzip::$error_reading_zip = false

protected

Definition at line 40 of file Unzip.php.

Referenced by ILIAS\Filesystem\Util\Archive\Unzip\hasZipReadingError().

$path_to_zip

string ILIAS\Filesystem\Util\Archive\Unzip::$path_to_zip

protected

Definition at line 41 of file Unzip.php.

$zip

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

protected

Definition at line 39 of file Unzip.php.

BASE_DIR

const ILIAS\Filesystem\Util\Archive\Unzip::BASE_DIR = '.'

Definition at line 38 of file Unzip.php.

DIRECTORY_SEPARATOR

const ILIAS\Filesystem\Util\Archive\Unzip::DIRECTORY_SEPARATOR = DIRECTORY_SEPARATOR

protected

Definition at line 35 of file Unzip.php.

DS_UNIX

const ILIAS\Filesystem\Util\Archive\Unzip::DS_UNIX = "/"

Definition at line 36 of file Unzip.php.

DS_WIN

const ILIAS\Filesystem\Util\Archive\Unzip::DS_WIN = "\\"

Definition at line 37 of file Unzip.php.

URI

const ILIAS\Filesystem\Util\Archive\Unzip::URI = 'uri'

protected

Definition at line 34 of file Unzip.php.

---

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

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