Class ilObjFileAbstractZipProcessor. More...

Inheritance diagram for ilObjFileAbstractZipProcessor:

Collaboration diagram for ilObjFileAbstractZipProcessor:

Public Member Functions
	__construct (ResourceStakeholder $stakeholder, ilObjFileGUI $gui_object, Services $storage, ilFileServicesSettings $settings, private $tree)

Public Member Functions inherited from ilObjFileAbstractProcessor
	__construct (protected ResourceStakeholder $stakeholder, protected ilObjFileGUI $gui_object, protected Services $storage, protected ilFileServicesSettings $settings)

	getInvalidFileNames ()

Public Member Functions inherited from ilObjFileProcessorInterface
	process (ResourceIdentification $rid, ?string $title=null, ?string $description=null, ?string $copyright_id=null)
	Processes a given resource for the given arguments. More...

Protected Member Functions
	createSurroundingContainer (ResourceIdentification $rid)

	createContainerObj (string $dir_name, int $parent_id)
	Creates a container object depending on the parent's node type and returns it. More...

	openZip (ResourceIdentification $rid)
	Opens the zip archive of the given resource. More...

	getZipFiles ()
	Yields the file-paths of the currently open zip-archive. More...

	hasMultipleRootEntriesInZip ()

	getZipDirectories ()
	Yields the directory-paths of the currently open zip-archive. More...

	storeZippedFile (string $file_path)
	Creates an IRSS resource from the given filepath. More...

	closeZip ()
	Closes the currently open zip-archive. More...

	isWorkspace ()
	Returns whether the current context is workspace. More...

Protected Member Functions inherited from ilObjFileAbstractProcessor
	createFileObj (ResourceIdentification $rid, int $parent_id, ?string $title=null, ?string $description=null, ?string $copyright_id=null, bool $create_reference=false)
	Creates an ilObjFile instance for the provided information. More...

Protected Attributes
bool	$create_base_container_for_multiple_root_entries = false
	Unzip on operating systems may behave differently when unzipping if there are only one or more root nodes in the zip. More...

Protected Attributes inherited from ilObjFileAbstractProcessor
ilFileServicesPolicy	$policy

ilCountPDFPages	$page_counter

array	$invalid_file_names = []

Private Member Functions
	getZipPaths ()
	Yields all paths of the currently open zip-archive (without some macos stuff). More...

	getPossibleContainerObj (int $parent_id)
	Returns a container object that is possible for the given parent. More...

Private Attributes
const	IRSS_FILEPATH_KEY = 'uri'

ZipArchive	$archive = null

int	$id_type

Detailed Description

Class ilObjFileAbstractZipProcessor.

Author: Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 29 of file class.ilObjFileAbstractZipProcessor.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileAbstractZipProcessor::__construct	(	ResourceStakeholder	$stakeholder,
		ilObjFileGUI	$gui_object,
		Services	$storage,
		ilFileServicesSettings	$settings,
		private	$tree
	)

Parameters

ilTree | ilWorkspaceTree $tree

Definition at line 51 of file class.ilObjFileAbstractZipProcessor.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ilObject2GUI\getIdType().

       {
         parent::__construct($stakeholder, $gui_object, $storage, $settings);
 
         $this->id_type = $gui_object->getIdType();
     }

Here is the call graph for this function:

Member Function Documentation

◆ closeZip()

ilObjFileAbstractZipProcessor::closeZip ( )

protected

Closes the currently open zip-archive.

Definition at line 223 of file class.ilObjFileAbstractZipProcessor.php.

Referenced by ilObjFileUnzipFlatProcessor\process(), and ilObjFileUnzipRecursiveProcessor\process().

                                  : void
     {
         if ($this->archive instanceof \ZipArchive) {
             $this->archive->close();
         }
     }

Here is the caller graph for this function:

◆ createContainerObj()

ilObjFileAbstractZipProcessor::createContainerObj	(	string	$dir_name,
		int	$parent_id
	)

protected

Creates a container object depending on the parent's node type and returns it.

Definition at line 77 of file class.ilObjFileAbstractZipProcessor.php.

References getPossibleContainerObj().

Referenced by createSurroundingContainer(), and ilObjFileUnzipRecursiveProcessor\process().

                                                                            : ilObject
     {
         $container_obj = $this->getPossibleContainerObj($parent_id);
         $container_obj->setTitle($dir_name);
 
         $container_obj->create();
         $container_obj->createReference();
 
         $this->gui_object->putObjectInTree($container_obj, $parent_id);
 
         return $container_obj;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSurroundingContainer()

ilObjFileAbstractZipProcessor::createSurroundingContainer ( ResourceIdentification $rid )

protected

Definition at line 63 of file class.ilObjFileAbstractZipProcessor.php.

References $info, and createContainerObj().

Referenced by ilObjFileUnzipFlatProcessor\process(), and ilObjFileUnzipRecursiveProcessor\process().

                                                                               : int
     {
         // create one base container with the name of the zip itself, all other containers will be created inside this one
         $zip_name = $this->storage->manage()->getCurrentRevision($rid)->getInformation()->getTitle();
         $info = new SplFileInfo($zip_name);
         $base_path = $info->getBasename("." . $info->getExtension());
         $base_container = $this->createContainerObj($base_path, $this->gui_object->getParentId());
 
         return (int) $base_container->getRefId();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossibleContainerObj()

ilObjFileAbstractZipProcessor::getPossibleContainerObj ( int $parent_id )

private

Returns a container object that is possible for the given parent.

Definition at line 241 of file class.ilObjFileAbstractZipProcessor.php.

References ilObject\_lookupType(), and isWorkspace().

Referenced by createContainerObj().

                                                             : ilObject
     {
         $type = ($this->isWorkspace()) ?
             ilObject::_lookupType($this->tree->lookupObjectId($parent_id)) :
             ilObject::_lookupType($parent_id, true);
 
         return match ($type) {
             'wfld', 'wsrt' => new ilObjWorkspaceFolder(),
             'cat', 'root' => new ilObjCategory(),
             default => new ilObjFolder(),
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getZipDirectories()

ilObjFileAbstractZipProcessor::getZipDirectories ( )

protected

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: Generator|string[]

Definition at line 173 of file class.ilObjFileAbstractZipProcessor.php.

References $path, ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), getZipPaths(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by hasMultipleRootEntriesInZip(), and ilObjFileUnzipRecursiveProcessor\process().

                                           : Generator
     {
         $directories = [];
         foreach ($this->getZipPaths() as $path) {
             if (str_ends_with($path, "/") || str_ends_with($path, "\\")) {
                 $directories[] = $path;
                 continue;
             }
             // add all parent directories of files, too. depending on the OS used to create the zip,
             // these directories may not be present as explicit directory entries in the zip
             $dir_name = dirname($path) . '/';
             if ($dir_name !== './' && $dir_name !== '/' && !in_array($dir_name, $directories, true)) {
                 $directories[] = $dir_name;
             }
         }
 
         $directories_with_parents = [];
 
         foreach ($directories as $directory) {
             $parent = dirname($directory) . '/';
             if ($parent !== './' && !in_array($parent, $directories)) {
                 $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:

◆ getZipFiles()

ilObjFileAbstractZipProcessor::getZipFiles ( )

protected

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

Returns: Generator|string[]

Definition at line 131 of file class.ilObjFileAbstractZipProcessor.php.

References $path, and getZipPaths().

Referenced by hasMultipleRootEntriesInZip(), ilObjFileUnzipFlatProcessor\process(), and ilObjFileUnzipRecursiveProcessor\process().

                                     : Generator
     {
         foreach ($this->getZipPaths() as $path) {
             if (str_ends_with($path, "/")) {
                 continue;
             }
             if (str_ends_with($path, "\\")) {
                 continue;
             }
             yield $path;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getZipPaths()

ilObjFileAbstractZipProcessor::getZipPaths ( )

private

Yields all paths of the currently open zip-archive (without some macos stuff).

Returns: Generator|string[]

Definition at line 108 of file class.ilObjFileAbstractZipProcessor.php.

References $path.

Referenced by getZipDirectories(), and getZipFiles().

                                   : Generator
     {
         if (!$this->archive instanceof \ZipArchive) {
             throw new LogicException("cannot read content of unopened zip archive");
         }
 
         for ($i = 0, $i_max = $this->archive->count(); $i < $i_max; $i++) {
             $path = $this->archive->getNameIndex($i, ZipArchive::FL_UNCHANGED);
             if (str_contains($path, '__MACOSX')) {
                 continue;
             }
             if (str_contains($path, '.DS_')) {
                 continue;
             }
 
             yield $path;
         }
     }

Here is the caller graph for this function:

◆ hasMultipleRootEntriesInZip()

ilObjFileAbstractZipProcessor::hasMultipleRootEntriesInZip ( )

protected

Definition at line 144 of file class.ilObjFileAbstractZipProcessor.php.

References getZipDirectories(), and getZipFiles().

Referenced by ilObjFileUnzipRecursiveProcessor\process().

                                                     : bool
     {
         $amount = 0;
         foreach ($this->getZipDirectories() as $zip_directory) {
             $dirname = dirname($zip_directory);
             if ($dirname === '.') {
                 $amount++;
             }
             if ($amount > 1) {
                 return true;
             }
         }
         foreach ($this->getZipFiles() as $zip_file) {
             $dirname = dirname($zip_file);
             if ($dirname === '.') {
                 $amount++;
             }
             if ($amount > 1) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isWorkspace()

ilObjFileAbstractZipProcessor::isWorkspace ( )

protected

Returns whether the current context is workspace.

Definition at line 233 of file class.ilObjFileAbstractZipProcessor.php.

References ilObject2GUI\WORKSPACE_NODE_ID.

Referenced by getPossibleContainerObj().

                                     : bool
     {
         return (ilObject2GUI::WORKSPACE_NODE_ID === $this->id_type);
     }

Here is the caller graph for this function:

◆ openZip()

ilObjFileAbstractZipProcessor::openZip ( ResourceIdentification $rid )

protected

Opens the zip archive of the given resource.

Definition at line 93 of file class.ilObjFileAbstractZipProcessor.php.

Referenced by ilObjFileUnzipFlatProcessor\process(), and ilObjFileUnzipRecursiveProcessor\process().

                                                            : void
     {
         if ($this->archive instanceof \ZipArchive) {
             throw new LogicException("openZip() can only be called once, yet it was called again.");
         }
 
         $file_uri = $this->storage->consume()->stream($rid)->getStream()->getMetadata(self::IRSS_FILEPATH_KEY);
         $this->archive = new ZipArchive();
         $this->archive->open($file_uri);
     }

Here is the caller graph for this function:

◆ storeZippedFile()

ilObjFileAbstractZipProcessor::storeZippedFile ( string $file_path )

protected

Creates an IRSS resource from the given filepath.

Definition at line 207 of file class.ilObjFileAbstractZipProcessor.php.

Referenced by ilObjFileUnzipFlatProcessor\process(), and ilObjFileUnzipRecursiveProcessor\process().

                                                          : ResourceIdentification
     {
         if (!$this->archive instanceof \ZipArchive) {
             throw new LogicException("No archive has been opened yet, call openZip() first in order to read files.");
         }
 
         return $this->storage->manage()->stream(
             Streams::ofString($this->archive->getFromName($file_path)),
             $this->stakeholder,
             basename($file_path)
         );
     }

Here is the caller graph for this function:

Field Documentation

◆ $archive

ZipArchive ilObjFileAbstractZipProcessor::$archive = null

private

Definition at line 36 of file class.ilObjFileAbstractZipProcessor.php.

◆ $create_base_container_for_multiple_root_entries

bool ilObjFileAbstractZipProcessor::$create_base_container_for_multiple_root_entries = false

protected

Unzip on operating systems may behave differently when unzipping if there are only one or more root nodes in the zip.

Currently, the behavior is the same as in ILIAS 7 and earlier, that in any case the zip structure is checked out directly at the current location in the magazine. If this value is set to true here, another category/folder will be placed around the files and folders of the zip when unpacking if more than one root-node is present. For example, macOS behaves in exactly this way.

Definition at line 46 of file class.ilObjFileAbstractZipProcessor.php.

◆ $id_type

int ilObjFileAbstractZipProcessor::$id_type

private

Definition at line 37 of file class.ilObjFileAbstractZipProcessor.php.

◆ IRSS_FILEPATH_KEY

const ilObjFileAbstractZipProcessor::IRSS_FILEPATH_KEY = 'uri'

private

Definition at line 34 of file class.ilObjFileAbstractZipProcessor.php.

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

components/ILIAS/File/classes/Processors/class.ilObjFileAbstractZipProcessor.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ closeZip()

◆ createContainerObj()

◆ createSurroundingContainer()

◆ getPossibleContainerObj()

◆ getZipDirectories()

◆ getZipFiles()

◆ getZipPaths()

◆ hasMultipleRootEntriesInZip()

◆ isWorkspace()

◆ openZip()

◆ storeZippedFile()

Field Documentation

◆ $archive

◆ $create_base_container_for_multiple_root_entries

◆ $id_type

◆ IRSS_FILEPATH_KEY