ilCollectFilesJob Class Reference

Description of class class. More...

Inheritance diagram for ilCollectFilesJob:

Collaboration diagram for ilCollectFilesJob:

Public Member Functions
	__construct ()
	Construct. More...
	getInputTypes ()
	@inheritDoc More...
	getOutputType ()
	@inheritDoc More...
	isStateless ()
	@inheritDoc More...
	run (array $input, Observer $observer)
	@inheritDoc More...
	getExpectedTimeOfTaskInSeconds ()
	Returns int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns Value[] More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)
	getOutput ()
	getInput ()
	getType ()
	unfoldTask ()
	Unfold the task. More...
	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...
	getAbortOption ()
	Returns Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible. More...
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()
	run (array $input, Observer $observer)
	isStateless ()
	getInput ()
	getExpectedTimeOfTaskInSeconds ()

Private Member Functions
	getFileDirs ($a_ref_id, string $a_file_name, string $a_temp_dir)
	recurseFolder ($a_ref_id, string $a_folder_name, string $a_temp_dir, int|float $a_num_recursions, $a_initiated_by_folder_action)

Private Attributes
ilLogger	$logger

Static Private Attributes
static array	$targets = []

Additional Inherited Members
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes (array $values)
	extractType ($value)
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array	$input = []
Value	$output

Detailed Description

Description of class class.

Author

Lukas Zehnder lz@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 32 of file class.ilCollectFilesJob.php.

Constructor & Destructor Documentation

__construct()

ilCollectFilesJob::__construct

(

)

Construct.

Definition at line 47 of file class.ilCollectFilesJob.php.

    {
        global $DIC;
        $this->logger = $DIC->logger()->cal();
    }

References $DIC, and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

getExpectedTimeOfTaskInSeconds()

ilCollectFilesJob::getExpectedTimeOfTaskInSeconds

(

)

Returns

int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 238 of file class.ilCollectFilesJob.php.

                                                    : int
    {
        return 30;
    }

getFileDirs()

ilCollectFilesJob::getFileDirs (   $a_ref_id, string  $a_file_name, string  $a_temp_dir  )

private

Returns

bool|array<string, string> Please note that this method must only be called ONCE in order to detect duplicate entries. DO NOT call this method e.g. in an if condition and then again in its body.

Definition at line 143 of file class.ilCollectFilesJob.php.

                                                                                    : false|array
    {
        global $DIC;
 
        $user = $DIC->user();
        $ilAccess = $DIC->access();
        if ($ilAccess->checkAccessOfUser($user->getId(), "read", "", $a_ref_id)) {
            $file = new ilObjFile($a_ref_id);
            $source_dir = $file->getFile();
 
            if (@!is_file($source_dir)) {
                return false;
            }
 
            $filname_with_suffix = $this->ensureSuffix($a_file_name, $file->getFileExtension());
 
            $target_dir = $a_temp_dir . '/' . $filname_with_suffix;
 
            // #25025: allow duplicate filenames by appending an incrementing
            // number per duplicate in brackets to the name.
            // Example: test.txt, test (1).txt, test (2).txt, ...
            if (isset(self::$targets[$target_dir])) {
                $target_info = pathinfo($target_dir);
                $filename = $target_info["filename"];
                $extension = isset($target_info["extension"]) ? "." . $target_info["extension"] : "";
                $target_dir = $a_temp_dir . $filename . " (" . ++self::$targets[$target_dir] . ")" . $extension;
            } else {
                self::$targets[$target_dir] = 0;
            }
 
            return [
                "source_dir" => $source_dir,
                "target_dir" => $target_dir,
            ];
        }
 
        return false;
    }

References $DIC, $filename, and ensureSuffix().

Referenced by recurseFolder(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

getInputTypes()

ilCollectFilesJob::getInputTypes

(

)

@inheritDoc

Implements ILIAS\BackgroundTasks\Task.

Definition at line 57 of file class.ilCollectFilesJob.php.

                                   : array
    {
        return
            [
                new SingleType(ilCopyDefinition::class),
                new SingleType(BooleanValue::class),
            ];
    }

getOutputType()

ilCollectFilesJob::getOutputType

(

)

@inheritDoc

Implements ILIAS\BackgroundTasks\Task.

Definition at line 70 of file class.ilCollectFilesJob.php.

                                   : Type
    {
        return new SingleType(ilCopyDefinition::class);
    }

isStateless()

ilCollectFilesJob::isStateless

(

)

@inheritDoc

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 79 of file class.ilCollectFilesJob.php.

                                 : bool
    {
        return true;
    }

recurseFolder()

ilCollectFilesJob::recurseFolder (   $a_ref_id, string  $a_folder_name, string  $a_temp_dir, int|float  $a_num_recursions,   $a_initiated_by_folder_action  )

private

Parameters

$ref_id
$title
$tmpdir

Returns

mixed[]

Definition at line 190 of file class.ilCollectFilesJob.php.

                                                                                                                                                    : array
    {
        global $DIC;
 
        $num_recursions = $a_num_recursions + 1;
        $tree = $DIC->repositoryTree();
        $ilAccess = $DIC->access();
        $files = [];
 
        // Avoid the duplication of the uppermost folder when the download is initiated via a folder's action drop-down
        // by not including said folders name in the temp_dir path.
        if ($num_recursions <= 1 && $a_initiated_by_folder_action) {
            $temp_dir = $a_temp_dir;
        } else {
            $temp_dir = $a_temp_dir . '/' . ilFileUtils::getASCIIFilename($a_folder_name);
        }
 
        $subtree = $tree->getChildsByTypeFilter($a_ref_id, ["fold", "file"]);
 
        foreach ($subtree as $child) {
            if (!$ilAccess->checkAccess("read", "", $child["ref_id"])) {
                continue;
            }
            if (ilObject::_isInTrash($child["ref_id"])) {
                continue;
            }
            if ($child["type"] == "fold") {
                $files_from_folder = $this->recurseFolder($child["ref_id"], $child['title'], $temp_dir, $num_recursions, $a_initiated_by_folder_action);
                $files = array_merge($files, $files_from_folder);
            } elseif (($child["type"] === "file") && (($dirs = $this->getFileDirs($child["ref_id"], $child['title'], $temp_dir)) !== false)) {
                $files[] = $dirs;
            }
        }
        // ensure that empty folders are also contained in the downloaded zip
        if (empty($subtree)) {
            $files[] = [
                "source_dir" => "",
                "target_dir" => $temp_dir . '/',
            ];
        }
 
        return $files;
    }

References $DIC, ilObject\_isInTrash(), ilFileUtils\getASCIIFilename(), getFileDirs(), and recurseFolder().

Referenced by recurseFolder(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

run()

ilCollectFilesJob::run	(	array	$input,
		Observer	$observer
	)

@inheritDoc

Todo:

use filsystem service

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 89 of file class.ilCollectFilesJob.php.

                                                         : Value
    {
        $this->logger->debug('Start collecting files!');
        $this->logger->dump($input);
        $definition = $input[0];
        $initiated_by_folder_action = $input[1]->getValue();
        $object_ref_ids = $definition->getObjectRefIds();
        $files = [];
 
        foreach ($object_ref_ids as $object_ref_id) {
            $object = ilObjectFactory::getInstanceByRefId($object_ref_id);
            $object_type = $object->getType();
            $object_name = $object->getTitle();
            $object_temp_dir = ""; // empty as content will be added in recurseFolder and getFileDirs
 
            if ($object_type === "fold" || $object_type === "crs") {
                $num_recursions = 0;
                $files_from_folder = $this->recurseFolder($object_ref_id, $object_name, $object_temp_dir, $num_recursions, $initiated_by_folder_action);
                $files = array_merge($files, $files_from_folder);
            } elseif (($object_type === "file") && (($file_dirs = $this->getFileDirs(
                $object_ref_id,
                $object_name,
                $object_temp_dir
            )) !== false)) {
                $files[] = $file_dirs;
            }
        }
        $this->logger->debug('Collected files:');
        $this->logger->dump($files);
 
        $num_files = 0;
        foreach ($files as $file) {
            $definition->addCopyDefinition($file['source_dir'], $file['target_dir']);
            $this->logger->debug('Added new copy definition: ' . $file['source_dir'] . ' -> ' . $file['target_dir']);
 
            // count files only (without empty directories)
            $is_empty_folder = preg_match_all("/\/$/", (string) $file['target_dir']);
            if (!$is_empty_folder) {
                $num_files++;
            }
        }
        $definition->setObjectRefIds($object_ref_ids);
        $definition->setNumFiles($num_files);
 
        return $definition;
    }

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input, getFileDirs(), ilObjectFactory\getInstanceByRefId(), ILIAS\Repository\logger(), and recurseFolder().

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ilCollectFilesJob::$logger

private

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

$targets

array ilCollectFilesJob::$targets = []

staticprivate

Definition at line 42 of file class.ilCollectFilesJob.php.

---

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

• components/ILIAS/BackgroundTasks_/classes/Jobs/class.ilCollectFilesJob.php